plugins/org.eclipse.emf.cdo.tests/src/org/eclipse/emf/cdo/tests/SavePointTest.java

/*
 * Copyright (c) 2008-2012, 2019 Eike Stepper (Loehne, Germany) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Simon McDuff - initial API and implementation
 *    Eike Stepper - maintenance
 */
package org.eclipse.emf.cdo.tests;

import org.eclipse.emf.cdo.eresource.CDOResource;
import org.eclipse.emf.cdo.session.CDOSession;
import org.eclipse.emf.cdo.tests.model1.Category;
import org.eclipse.emf.cdo.tests.model1.Company;
import org.eclipse.emf.cdo.tests.util.TestAdapter;
import org.eclipse.emf.cdo.transaction.CDOTransaction;
import org.eclipse.emf.cdo.transaction.CDOUserSavepoint;
import org.eclipse.emf.cdo.util.CDOUtil;
import org.eclipse.emf.cdo.view.CDOView;

import org.eclipse.emf.spi.cdo.FSMUtil;

/**
 * @author Simon McDuff
 */
/**
 * @author Eike Stepper
 */
public class SavePointTest extends AbstractCDOTest
{
  public void testRollbackWithNewObject_Collection() throws Exception
  {
    CDOSession session = openSession();
    session.getPackageRegistry().putEPackage(getModel1Package());

    CDOTransaction transaction1 = session.openTransaction();
    // Client1
    CDOResource resource1 = transaction1.createResource(getResourcePath("/test1"));

    Company company1 = getModel1Factory().createCompany();
    resource1.getContents().add(company1);
    Category category1 = getModel1Factory().createCategory();
    company1.getCategories().add(category1);

    assertEquals(0, CDOUtil.getCDOObject(company1).cdoRevision().getVersion());
    transaction1.setSavepoint();
    assertEquals(0, CDOUtil.getCDOObject(company1).cdoRevision().getVersion());

    Category category2 = getModel1Factory().createCategory();
    company1.getCategories().add(category2);

    CDOUserSavepoint savePoint2 = transaction1.setSavepoint();
    assertEquals(0, CDOUtil.getCDOObject(company1).cdoRevision().getVersion());

    Category category3 = getModel1Factory().createCategory();
    company1.getCategories().add(category3);

    transaction1.setSavepoint();
    assertEquals(0, CDOUtil.getCDOObject(company1).cdoRevision().getVersion());
    savePoint2.rollback();
    assertEquals(0, CDOUtil.getCDOObject(company1).cdoRevision().getVersion());

    assertNew(category1, transaction1);
    assertNew(company1, transaction1);
    assertNew(resource1, transaction1);
    assertEquals(2, company1.getCategories().size());

    transaction1.commit();
    assertEquals(1, CDOUtil.getCDOObject(company1).cdoRevision().getVersion());
  }

  public void testRollbackWithNewObject_Commit() throws Exception
  {
    flow1(false, true);
  }

  public void testRollbackWithNewObject_Rollback() throws Exception
  {
    flow1(false, false);
  }

  public void testRollbackWithPersistedObject_Commit() throws Exception
  {
    flow1(true, true);
  }

  public void testRollbackWithPersistedObject_Rollback() throws Exception
  {
    flow1(true, false);
  }

  public void testWrongSavePoint() throws Exception
  {
    CDOSession session = openSession();
    session.getPackageRegistry().putEPackage(getModel1Package());

    CDOTransaction transaction1 = session.openTransaction();
    // Client1
    CDOResource resource1 = transaction1.createResource(getResourcePath("/test1"));
    Company company1 = getModel1Factory().createCompany();
    resource1.getContents().add(company1);
    Category category1 = getModel1Factory().createCategory();
    company1.getCategories().add(category1);

    CDOUserSavepoint savePoint1 = transaction1.setSavepoint();
    CDOUserSavepoint savePoint2 = transaction1.setSavepoint();
    savePoint1.rollback();

    try
    {
      savePoint2.rollback();
      fail("IllegalArgumentException expected");
    }
    catch (IllegalArgumentException expected)
    {
      // SUCCESS
    }
  }

  public void testIsDirty() throws Exception
  {
    CDOSession session = openSession();
    session.getPackageRegistry().putEPackage(getModel1Package());

    CDOTransaction transaction = session.openTransaction();
    CDOUserSavepoint savePoint0 = transaction.setSavepoint();

    CDOResource resource = transaction.createResource(getResourcePath("/test1"));
    Company company = getModel1Factory().createCompany();
    resource.getContents().add(company);

    Category categoryA = getModel1Factory().createCategory();
    company.getCategories().add(categoryA);

    CDOUserSavepoint savePoint1 = transaction.setSavepoint();
    Category categoryB = getModel1Factory().createCategory();
    company.getCategories().add(categoryB);

    CDOUserSavepoint savePoint2 = transaction.setSavepoint();
    CDOUserSavepoint savePoint3 = transaction.setSavepoint();

    assertEquals(true, transaction.isDirty());

    savePoint3.rollback();
    assertEquals(true, transaction.isDirty());

    savePoint2.rollback();
    assertEquals(true, transaction.isDirty());

    savePoint1.rollback();
    assertEquals(true, transaction.isDirty());

    // Didn`t make any modification prior to savepoint0
    savePoint0.rollback();
    assertEquals(false, transaction.isDirty());

    transaction.rollback();
    assertEquals(false, transaction.isDirty());
  }

  private void flow1(boolean commitBegin, boolean commitEnd) throws Exception
  {
    CDOSession session = openSession();
    session.getPackageRegistry().putEPackage(getModel1Package());

    CDOTransaction transaction = session.openTransaction();

    // Client1
    CDOResource resource1 = transaction.createResource(getResourcePath("/test1"));
    Category category3, category2, category4;

    Company company1 = getModel1Factory().createCompany();
    resource1.getContents().add(company1);

    Category category1 = getModel1Factory().createCategory();
    company1.getCategories().add(category1);

    CDOUserSavepoint savePoint1 = transaction.setSavepoint();

    // Modification for savePoint1
    Company company2 = getModel1Factory().createCompany();
    resource1.getContents().add(company2);
    company1.setCity("CITY1");

    assertEquals(2, resource1.getContents().size());

    // Rollback
    savePoint1.rollback();

    if (commitBegin)
    {
      transaction.commit();
    }

    {
      assertEquals(null, company1.getCity());
      assertEquals(1, resource1.getContents().size());
      company1.setCity("CITY1");
      category2 = getModel1Factory().createCategory();
      company1.getCategories().add(category2);
    }

    CDOUserSavepoint savePoint2 = transaction.setSavepoint();

    {
      company1.setCity("CITY2");
      category3 = getModel1Factory().createCategory();
      company1.getCategories().add(category3);
    }

    transaction.setSavepoint();

    {
      company1.setCity("CITY3");
      assertEquals(3, company1.getCategories().size());
      category4 = getModel1Factory().createCategory();
      company1.getCategories().add(category4);
    }

    savePoint2.rollback();
    assertEquals(true, transaction.isDirty());

    // Test NEW TO NEW
    assertEquals(false, FSMUtil.isTransient(CDOUtil.getCDOObject(company1)));

    // Test NEW TO TRANSIENT (2 step back)
    assertEquals(true, FSMUtil.isTransient(CDOUtil.getCDOObject(category3)));
    assertEquals(false, transaction.getNewObjects().containsKey(CDOUtil.getCDOObject(category3).cdoID()));

    // Test NEW TO TRANSIENT (1 step back)
    assertEquals(true, FSMUtil.isTransient(CDOUtil.getCDOObject(category4)));
    assertEquals(false, transaction.getNewObjects().containsKey(CDOUtil.getCDOObject(category4).cdoID()));

    // Test NEW TO NEW
    assertEquals(false, FSMUtil.isTransient(CDOUtil.getCDOObject(category2)));
    assertEquals(true, transaction.getNewObjects().containsKey(CDOUtil.getCDOObject(category2).cdoID()));

    // Test rollback NEW
    assertEquals("CITY1", company1.getCity());
    assertEquals(2, company1.getCategories().size());
    if (commitEnd)
    {
      transaction.commit();
      assertClean(company1, transaction);
      assertClean(category2, transaction);
      assertEquals("CITY1", company1.getCity());
      assertEquals(2, company1.getCategories().size());
      assertEquals(null, transaction.getLastSavepoint().getPreviousSavepoint());
    }
    else
    {
      transaction.rollback();
      assertEquals(false, transaction.isDirty());
      assertEquals(null, transaction.getLastSavepoint().getNextSavepoint());
      assertEquals(null, transaction.getLastSavepoint().getPreviousSavepoint());
      assertEquals(commitBegin, !FSMUtil.isTransient(CDOUtil.getCDOObject(company1)));
      assertEquals(commitBegin, !FSMUtil.isTransient(resource1));
    }
  }

  /**
   * Compare http://www.eclipse.org/newsportal/article.php?id=41697&group=eclipse.tools.emf#41697
   *
   * <pre>
   * Passive update is enabled.
   * client1 sets a save point
   * client1 write locks object1
   * client1 modifies object1
   * client2 modifies object2
   * client2 commits
   * client1 rolls back to save point
   * Result:
   * CDORepositoryInfo: object1 not modified, object2 is modified
   * client1: same as repository
   * client2: same as repository
   * </pre>
   */
  public void _testScenario1() throws Exception
  {
    CDOSession client1 = openSession();
    CDOTransaction transaction1 = client1.openTransaction();
    CDOResource object1X = transaction1.createResource(getResourcePath("/object1"));
    CDOResource object2X = transaction1.createResource(getResourcePath("/object2"));
    transaction1.commit();

    // client1 sets a save point
    CDOUserSavepoint savepoint = transaction1.setSavepoint();

    // client1 write locks object1
    object1X.cdoWriteLock().lock(DEFAULT_TIMEOUT);

    // client1 modifies object1
    object1X.getContents().add(getModel1Factory().createCompany());

    // client2 modifies object2
    CDOSession client2 = openSession();
    CDOTransaction transaction2 = client2.openTransaction();
    CDOResource object2Y = transaction2.getResource(getResourcePath("/object2"));
    object2Y.getContents().add(getModel1Factory().createPurchaseOrder());

    // client2 commits
    transaction2.commit();

    // client1 rolls back to save point
    savepoint.rollback();

    // CDORepositoryInfo: object1 not modified, object2 is modified
    CDOSession client3 = openSession();
    CDOView view = client3.openView();
    CDOResource object1Test = view.getResource(getResourcePath("/object1"));
    assertEquals(0, object1Test.getContents().size());
    CDOResource object2Test = view.getResource(getResourcePath("/object2"));
    assertEquals(1, object2Test.getContents().size());

    // client1: same as repository
    assertEquals(object1Test.getContents().size(), object1X.getContents().size());
    assertEquals(object2Test.getContents().size(), object2X.getContents().size());

    // client2: same as repository
    CDOResource object1Y = transaction2.getResource(getResourcePath("/object1"));
    assertEquals(object1Test.getContents().size(), object1Y.getContents().size());
    assertEquals(object2Test.getContents().size(), object2Y.getContents().size());
  }

  /**
   * Bug 283131
   */
  public void testNotification() throws Exception
  {
    CDOSession session = openSession();
    CDOTransaction transaction = session.openTransaction();
    CDOResource resource = transaction.createResource(getResourcePath("/test1"));

    Company company = getModel1Factory().createCompany();
    resource.getContents().add(company);
    transaction.commit();

    company.setCity("CITY1");
    CDOUserSavepoint savePoint1 = transaction.setSavepoint();

    company.setCity("CITY2");

    TestAdapter adapter = new TestAdapter(company);

    savePoint1.rollback();
    assertEquals("CITY1", company.getCity());
    adapter.assertNotifications(1);
  }
}