/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.jdo.tck.lifecycle;

import java.util.Iterator;
import javax.jdo.Extent;
import javax.jdo.Transaction;
import org.apache.jdo.tck.JDO_Test;
import org.apache.jdo.tck.pc.lifecycle.StateTransitionObj;
import org.apache.jdo.tck.util.BatchTestRunner;

/**
 * <B>Title:</B> Test that ObjectId is not modified even if ObjectId returned by GetObjectId() is
 * modified <br>
 * <B>Keywords:</B> lifecycle GetObjectId <br>
 * <B>Assertion IDs:</B> A5.4-6 <br>
 * <B>Assertion Description: </B> The object returned by any call to getObjectId might be modified
 * by the user, but that modification does not affect the identity of the object that was originally
 * referred.
 */
public class ObjectIdNotModifiedWhenObjectIdInstanceModified extends JDO_Test {

  /** */
  private static final String ASSERTION_FAILED =
      "Assertion A5.4-6 (ObjectIdNotModifiedWhenObjectIdInstanceModified) failed: ";

  private static final int NUM_OBJECTS = 50;

  /** The persistent instances of this test. */
  private Object[] obj;

  /**
   * The <code>main</code> is called when the class is directly executed from the command line.
   *
   * @param args The arguments passed to the program.
   */
  public static void main(String[] args) {
    BatchTestRunner.run(ObjectIdNotModifiedWhenObjectIdInstanceModified.class);
  }

  /**
   * @see org.apache.jdo.tck.JDO_Test#localSetUp()
   */
  @Override
  protected void localSetUp() {
    pm = getPM();
    addTearDownClass(StateTransitionObj.class);
    obj = generatePersistentInstances();
  }

  public void test() throws Exception {
    pm.currentTransaction().begin();
    try {
      Extent<StateTransitionObj> extent = pm.getExtent(StateTransitionObj.class, false);
      Iterator<StateTransitionObj> iter = extent.iterator();
      if (!iter.hasNext()) {
        fail(ASSERTION_FAILED, "Extent for StateTransitionObj should not be empty");
      }
      extent.close(iter);
      int failures = 0;
      StringBuilder report = new StringBuilder("Failures comparing oids.\n");
      for (int i = 0; i < NUM_OBJECTS; i++) {
        Object objId1 = pm.getObjectId(obj[i]);
        String before = objId1.toString();
        int objId1HashCode = objId1.hashCode();
        Object objId2 = pm.getObjectId(obj[i]);
        if (!mangleObject(objId2)) {
          /* The object id class is immutable, so the test succeeds. */
          break;
        }
        int objId2HashCode = objId2.hashCode();
        Object objId3 = pm.getObjectId(obj[i]); // get another ObjectId copy
        if (!(objId1.equals(objId3) && objId1HashCode != objId2HashCode)) {
          /* The object id obtained after mangling the second object id
           * must equal the original object id, and the mangling must
           * have changed the mangled id.
           */
          report.append("Index= ");
          report.append(i);
          report.append("\n");
          report.append(" before= ");
          report.append(before);
          report.append("\n");
          report.append("mangled= ");
          report.append(objId2);
          report.append("\n");
          report.append("  after= ");
          report.append(objId3.toString());
          report.append("\n");
          ++failures;
        }
      }
      if (failures != 0) {
        if (debug) {
          logger.debug(report.toString());
        }
        fail(ASSERTION_FAILED, "Failed to compare " + failures + " object ids.");
      }
      pm.currentTransaction().commit();
    } finally {
      if (pm != null && pm.currentTransaction().isActive()) {
        pm.currentTransaction().rollback();
      }
    }
  }

  private Object[] generatePersistentInstances() {
    StateTransitionObj[] objects = new StateTransitionObj[NUM_OBJECTS];
    try {
      Transaction t = pm.currentTransaction();
      t.begin();
      for (int i = 0; i < NUM_OBJECTS; ++i) {
        objects[i] = new StateTransitionObj(i);
        objects[i].writeField(i);
        pm.makePersistent(objects[i]);
      }
      t.commit();
      return objects;
    } finally {
      Transaction tx = pm.currentTransaction();
      if (tx.isActive()) {
        tx.rollback();
      }
    }
  }
}