/*
 * 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 org.apache.jdo.tck.JDO_Test;
import org.apache.jdo.tck.pc.mylib.PCPoint;
import org.apache.jdo.tck.pc.mylib.PCRect;
import org.apache.jdo.tck.util.BatchTestRunner;

/**
 * <B>Title:</B> Test that Hollow Instances maintains PK <br>
 * <B>Keywords:</B> lifecycle hollow instance PK <br>
 * <B>Assertion IDs:</B> A5.5.4-3 <br>
 * <B>Assertion Description: </B> If the instance is of a class using application identity, the
 * hollow instance maintains its primary key fields.
 */
public class HollowInstanceMaintainsPK extends JDO_Test {

  /** */
  private static final String ASSERTION_FAILED =
      "Assertion A5.5.4-3 (HollowInstanceMaintainsPK) failed: ";

  /**
   * 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(HollowInstanceMaintainsPK.class);
  }

  /**
   * @see org.apache.jdo.tck.JDO_Test#localSetUp()
   */
  @Override
  protected void localSetUp() {
    addTearDownClass(PCRect.class);
    addTearDownClass(PCPoint.class);
  }

  /** */
  public void test() {
    if (!isApplicationIdentitySupported()) {
      printUnsupportedOptionalFeatureNotTested(
          getClass().getName(), "javax.jdo.option.ApplicationIdentity");
    } else if (!runsWithApplicationIdentity()) {
      printNonApplicableIdentityType(getClass().getName(), "javax.jdo.option.ApplicationIdentity");
    } else {
      pm = getPM();
      pm.currentTransaction().begin();

      PCRect obj = getPersistentNewInstance();
      long beforeValue = obj.getId();
      pm.currentTransaction().commit(); // obj should transition to HOLLOW
      // The next call obj.getId() is a primary key access.
      // The method must not be called inside a transaction,
      // because a JDO implementation must allow primary key accesses
      // outside of transactions.
      long afterValue = obj.getId();
      if (beforeValue != afterValue) {
        fail(
            ASSERTION_FAILED,
            "Key field value incorrect after commit. Expected: "
                + beforeValue
                + " Found: "
                + afterValue);
      }
    }
  }

  /** */
  private PCRect getPersistentNewInstance() {
    PCRect obj = new PCRect(0, new PCPoint(1, 5), new PCPoint(7, 3));
    pm.makePersistent(obj); // obj should transition to persistent-new
    int curr = currentState(obj);
    if (curr != PERSISTENT_NEW) {
      fail(
          ASSERTION_FAILED,
          "StateTransitions: Unable to create persistent-new instance "
              + "from transient instance via makePersistent(), state is "
              + states[curr]);
    }
    return obj;
  }
}