# FWDProcedureMethodTestDescriptor_11_6.java

    /*
    ** Module   : FWDProcedureMethodTestDescriptor.java
    ** Abstract : Test descriptor for a legacy internal procedure, compatible wit OE 11.6.
    **
    ** Copyright (c) 2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ----------------Description---------------------------------------------------------------
    ** 001 VVT 20240717 Created initial version.
    */
    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */
    package com.goldencode.p2j.testengine;

    import java.lang.reflect.*;
    import java.util.*;

    import com.goldencode.p2j.util.*;

    /**
     * Test descriptor for a legacy internal procedure, compatible wit OE 11.6.
     *
     * One procedure instance is created per each @Setup/@Test/@TearDown cycle.
     * If this test procedure instance is deleted by:
     *
     * <li>the @Before code, then the @Test/@TearDown procedures are not executed, and the test is marked as failed.
     * <li>the @Test code, then the @TearDown procedure is not executed, and the test is marked as failed.
     * <li>the @TearDown procedure, there is no visible impact.
     */
    public class FWDProcedureMethodTestDescriptor_11_6
    extends FWDProcedureMethodTestDescriptor
    {

       /**
        * The procedure instance used in @Setup, @Test and @TearDown procedures.
        */
       private transient handle procedure;

       /**
        * Constructor.
        * <p>
        * The unique ID and display name for the descriptor are calculated based on
        * the parent descriptor ID and the method name.
        *
        * @param parent
        *        the parent descriptor
        * @param clazz
        *        the Java class to create instances
        * @param execute
        *        the method to execute
        * @param beforeEach
        *        methods to execute before the execute method
        * @param afterEach
        *        methods to execute after the execute method
        * @param expectedException
        *        if not {@code null}, the expected exception legacy class name
        */
       FWDProcedureMethodTestDescriptor_11_6(final AbstractClassTestDescriptor parent,
                                        final Class<?> clazz,
                                        final Method execute,
                                        final List<Method> beforeEach,
                                        final List<Method> afterEach,
                                        final String expectedException)
       {
          super (parent, clazz, execute, beforeEach, afterEach, expectedException);
       }

       /**
        * Default constructor, required for de-serialization
        */
       public FWDProcedureMethodTestDescriptor_11_6()
       {
          // no-op
       }

       /**
        * Check the procedure instance is valid.
        */
       private void checkInstance()
       {
          ((FWDProcedureTestDescriptor) parent).checkInstance(procedure);
       }

       /**
        * Get test object. The test object is either a legacy class instance if tests are implemented
        * as legacy class methods or a persistent procedure instance it tests are implemented as
        * internal procedures.
        * <p>
        * The value should be {@code null} if the test method is a static legacy class method.
        *
        * @return the test object or {@code null}
        */
       @Override
       protected Object getTestObject()
       {
          return procedure;
       }

       /**
        * Execute the <em>after</em> behavior of this node implementation.
        * <p>
        * This method will be called once <em>after</em> {@linkplain #executeImpl() execution}
        * of this node.
        */
       @Override
       public void afterImpl()
       throws ErrorConditionException
       {
          // Silently ignore at this stage
          if (procedure._isValid())
          {
             super.afterImpl();
          }
       }

       /**
        * Execute the implementation <em>behavior</em> of this node.
        */
       @Override
       public void executeImpl()
       throws ErrorConditionException
       {
          checkInstance();

          super.executeImpl();

          checkInstance();
       }

       /**
        * Prepare the supplied {@code context} prior to execution implementation.
        *
        * @throws ErrorConditionException
        *         remote code may throw this
        * @throws org.opentest4j.AssertionFailedError
        *         legacy errors are converted to this exception
        *
        * @see    #cleanUpImpl
        */
       @Override
       public void prepareImpl()
       throws ErrorConditionException
       {
          procedure = ((FWDProcedureTestDescriptor) parent).createProcedureInstance();
       }

    }