FWD » Core Development » Conversion Tools

**     VVT 2022xxxx JUnit5 dependencies updated to support both existing tests and custom test engine.

**                  See #6237.

    // Adding JUnit5 jar both to client and server, so it will be also deployed to converted projects

    fwdClientServer group: 'org.junit.platform',

                    name: 'junit-platform-engine',

                    version: '1.9.0'

    fwdAllTest group: 'org.junit.platform',

                    name: 'junit-platform-suite-engine',

                    version: '1.9.0'

    fwdAllTest group: 'org.junit.platform',

                    name: 'junit-platform-console',

                    version: '1.9.0'

    fwdAllTest group: 'org.junit.platform',

                    name: 'junit-platform-engine',

                    version: '1.9.0'

**     VVT 2022xxxx          Two more rulesets processed: unit_test_support and legacy_annotations_post.

**                           See #6237.

   <rule-set name="annotations/unit_test_support" />

   <rule-set name="annotations/legacy_annotations_post" />

**     VVT 2022xxxx Changes in revs. 14243,14241,14239 restored. See #6237.

               <action>ref = execLib("create_java_annotation", pref, "LegacyServiceParameter", -1)</action>

               <!-- Do NOT remove unsupported annotations here, they will be removed in legacy_annotations_post.rules -->

               <!-- <action on="false">ref.remove()</action> -->

         <action>ref = execLib("create_java_annotation", copy, "LegacyService", 1)</action>

            <action>ref = execLib("create_java_annotation", copy, "LegacyService", 1)</action>

         <action>ref = execLib("create_java_annotation", copy, "LegacyService", 1)</action>

            <action>ref = execLib("create_java_annotation", pref, "LegacyWebPath", -1)</action>

**     VVT 2022xxxx Custom test engine annotations are now used instead of that

**                  from the Jupiter test engine. See #6237.

   <worker class="com.goldencode.p2j.uast.UastHintsWorker"       namespace="hints" />

         <!-- Get required unit test legacy type configuration (hints) -->

         <variable name="unitTestType" type="java.lang.String" />

         <action>unitTestType = hints.getUnitTestType()</action>

         <rule>unitTestType == null

            <action>compileError(223, "No unit test legacy type is configured")</action>

         </rule>

         <variable name="isABLUnit" type="java.lang.Boolean" />

         <action>isABLUnit = unitTestType.equals("ABLUnit")</action>

         <variable name="methodNode" type="com.goldencode.ast.Aast" />

         <action>methodNode = parent.firstChild</action>

         <!-- FIXME: Add similar support for procedures -->

         <action>printfln("method %s is ABL unit test type %s annoName @%s", methodNode.getAnnotation("name"), isABLUnit, annoName)</action>

         <!-- Replace OEUnit/ABLUnit annotation names by corresponding JUnit5 names -->

         <rule>annoName.equalsIgnoreCase("Test")

            <action>newName = "com.goldencode.p2j.testengine.api.Test"</action>

            <!-- Note: the meaning of @Before and @After is opposite in ABLUnit and OEUnit -->

            <rule on="false">annoName.equalsIgnoreCase("Before")

               <rule>isABLUnit

                  <action>newName = "com.goldencode.p2j.testengine.api.BeforeAll"</action>

                  <action on="false">newName = "com.goldencode.p2j.testengine.api.BeforeEach"</action>

               </rule>

               <rule on="false">annoName.equalsIgnoreCase("After")

                  <rule>isABLUnit

                     <action>newName = "com.goldencode.p2j.testengine.api.AfterAll"</action>

                     <action on="false">newName = "com.goldencode.p2j.testengine.api.AfterEach"</action>

                  </rule>

                  <rule on="false">annoName.equalsIgnoreCase("BeforeClass")

                     <action>newName = "com.goldencode.p2j.testengine.api.BeforeAll"</action>

                     <rule on="false">annoName.equalsIgnoreCase("AfterClass")

                        <action>newName = "com.goldencode.p2j.testengine.api.AfterAll"</action>

                        <rule on="false">annoName.equalsIgnoreCase("Ignore")

                           <action>newName = "com.goldencode.p2j.testengine.api.Disabled"</action>

                        </rule>

                        <rule on="false">annoName.equalsIgnoreCase("Setup")

                           <action>newName = "com.goldencode.p2j.testengine.api.BeforeEach"</action>

                           <rule on="false">annoName.equalsIgnoreCase("TearDown")

                              <action>newName = "com.goldencode.p2j.testengine.api.AfterEach"</action>

                           </rule>

            <action>printfln("newName %s", newName)</action>

            <!-- Write it back... -->

            <action>copy.putAnnotation("javaname", newName)</action>

            <!-- ...and mark "our" annotations as preserved -->

            <action>copy.putAnnotation("fwd", true)</action>

**     VVT 2022xxxx          Changes in revs. 14243,14241,14239 restored. See #6237.

      <rule-set name="convert/unit_test_support" />

**     VVT 2022xxxx  Custom test engine annotations are now used instead of that

**                   from the Jupiter test engine. See #6237.

            annoName.equals("com.goldencode.p2j.testengine.api.Test") or

            annoName.equals("com.goldencode.p2j.testengine.api.BeforeEach") or

            annoName.equals("com.goldencode.p2j.testengine.api.AfterEach")  or

            annoName.equals("com.goldencode.p2j.testengine.api.BeforeAll")  or

            annoName.equals("com.goldencode.p2j.testengine.api.AfterAll")   or

            annoName.equals("com.goldencode.p2j.testengine.api.Disabled")

            <action>copy.putAnnotation("javaname", annoName.substring(34))</action>

         <action>help.createImport("com.goldencode.p2j.testengine.api.*")</action>

**     VVT 2022xxxx          Constant added: default legacy unit test framework type. See #6237. 

   /** Default legacy unit test type */

   public static final String DEF_UNIT_TEST_TYPE = "ABLUnit";

/*

** Module   : FWDClassTestDescriptor.java

** Abstract : Test descriptor for a Java class.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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.annotation.*;

import java.lang.reflect.*;

import java.util.*;

import org.junit.platform.commons.support.*;

import org.junit.platform.commons.util.*;

import org.junit.platform.engine.*;

import org.junit.platform.engine.support.descriptor.*;

import org.junit.platform.engine.support.hierarchical.*;

import com.goldencode.p2j.testengine.api.*;

/**

 * Test descriptor for a Java class.

 */

public class FWDClassTestDescriptor

extends AbstractTestDescriptor

implements Node<FWDEngineExecutionContext>

{

   /**

    * The Java class, referenced by child descriptors.

    */

   final Class<?> clazz;

   /**

    * The methods marked as {@link AfterAll}.

    */

   private final List<Method> afterAll;

   /**

    * The methods marked as {@link BeforeAll}.

    */

   private final List<Method> beforeAll;

   /**

    * Test a Java class candidate for existent tests methods. If found, create a new class

    * test descriptor.

    * 

    * @param clazz

    *        the class under test 

    * @param parentDescriptor

    *        the parent descriptor

    * @param explicitMethods

    *        the explicit method list or {@code null} to scan the class for all test methods

    *        

    * @return  the class test descriptor or {@code null} if this class has no test methods.

    */

   public static FWDClassTestDescriptor testAndCreate(final Class<?> clazz,

            final TestDescriptor parentDescriptor, List<Method> explicitMethods)

   {

      // FIXME: find out if the test for abstract classes is really necessary.

      // For example, Eclipse does not run abstract classes as JUnit test

      if (Modifier.isAbstract(clazz.getModifiers()))

      {

         return null;

      }

      final List<Method> test = explicitMethods != null ? explicitMethods

               : collectAnnotatedMethods(clazz, Test.class);

      if (test.isEmpty())

      {

         return null;

      }

      return new FWDClassTestDescriptor(clazz, parentDescriptor, test,

               collectAnnotatedMethods(clazz, BeforeEach.class),

               collectAnnotatedMethods(clazz, AfterEach.class),

               collectAnnotatedMethods(clazz, BeforeAll.class),

               collectAnnotatedMethods(clazz, AfterAll.class));

   }

   /**

    * Collect all methods annotated with the given class, but not annotated as disabled.

    * 

    * @param clazz

    *        the class to scan for methods

    * @param annoClass

    *        the annotation class to match

    * @return

    *        the list of methods found; never {@code null}

    */

   private static List<Method> collectAnnotatedMethods(final Class<?> clazz,

            final Class<? extends Annotation> annoClass)

   {

      return ReflectionUtils.findMethods(clazz, m -> AnnotationUtils.isAnnotated(m, annoClass)

               && !AnnotationUtils.isAnnotated(m, Disabled.class));

   }

   /**

    * Private constructor.

    * 

    * @param clazz

    *        the Java class

    * @param parent

    *        the parent descriptor

    * @param test

    *        class methods marked as tests  

    * @param beforeEach

    *        class methods marked to execute before each test  

    * @param afterEach

    *        class methods marked to execute after each test  

    * @param beforeAll

    *        class methods marked to execute before all tests  

    * @param afterAll

    *        class methods marked to execute aftger all tests  

    */

   private FWDClassTestDescriptor(final Class<?> clazz, final TestDescriptor parent,

            List<Method> test, List<Method> beforeEach, List<Method> afterEach,

            List<Method> beforeAll, List<Method> afterAll)

   {

      super(parent.getUniqueId().append("class", clazz.getName()), clazz.getSimpleName(),

               ClassSource.from(clazz));

      setParent(parent);

      this.clazz = clazz;

      this.beforeAll = beforeAll;

      this.afterAll = afterAll;

      test.stream().map(m -> new FWDMethodTestDescriptor(this, clazz, m, beforeEach, afterEach))

               .forEach(this::addChild);

   }

   /**

    * Execute the <em>after</em> behavior of this node.

    *

    * <p>This method will be called once <em>after</em> {@linkplain #execute

    * execution} of this node.

    *

    * <p>The default implementation does nothing.

    *

    * @param context the context to execute in

    */

   @Override

   public void after(final FWDEngineExecutionContext context) throws Exception

   {

      for (Method m : afterAll)

      {

         // System.err.println("executing after class method " + m);

         ReflectionSupport.invokeMethod(m, null);

      }

   }

   /**

    * Execute the <em>before</em> behavior of this node.

    *

    * <p>This method will be called once <em>before</em> {@linkplain #execute

    * execution} of this node.

    *

    * <p>The default implementation returns the supplied {@code context} unmodified.

    *

    * @param context the context to execute in

    * @return the new context to be used for children of this node; never

    * {@code null}

    */

   @Override

   public FWDEngineExecutionContext before(FWDEngineExecutionContext context) throws Exception

   {

      for (Method m : beforeAll)

      {

         // System.err.println("executing before class method " + m);

         ReflectionSupport.invokeMethod(m, null);

      }

      return context;

   }

   /**

    * Execute the <em>behavior</em> of this node.

    *

    * <p>Containers typically do not implement this method since the

    * {@link HierarchicalTestEngine} handles execution of their children.

    *

    * <p>The supplied {@code dynamicTestExecutor} may be used to submit

    * additional dynamic tests for immediate execution.

    *

    * <p>The default implementation returns the supplied {@code context} unmodified.

    *

    * @param context the context to execute in

    * @param dynamicTestExecutor the executor to submit dynamic tests to

    * @return the new context to be used for children of this node and for the

    * <em>after</em> behavior of the parent of this node, if any

    */

   @Override

   public FWDEngineExecutionContext execute(FWDEngineExecutionContext context,

            DynamicTestExecutor dynamicTestExecutor) throws Exception

   {

      return context;

   }

   /**

    * Determine the {@link org.junit.platform.engine.TestDescriptor.Type} of this descriptor.

    *

    * @return the descriptor type; never {@code null}.

    * @see #isContainer()

    * @see #isTest()

    */

   @Override

   public Type getType()

   {

      return Type.CONTAINER;

   }

}

/*

** Module   : FWDEngineDescriptor.java

** Abstract : Test engine descriptor.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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 org.junit.platform.engine.*;

import org.junit.platform.engine.support.descriptor.*;

import org.junit.platform.engine.support.hierarchical.*;

import org.junit.platform.engine.support.hierarchical.Node.*;

/**

 * Test engine descriptor. Provides this engine unique ID and same thread execution mode. 

 */

public class FWDEngineDescriptor

extends EngineDescriptor

implements Node<FWDEngineExecutionContext>

{

   /**

    * The constructor.

    * 

    * @param uniqueId the {@code UniqueId} for the described {@code TestEngine};

    * never {@code null}

    */

   public FWDEngineDescriptor(final UniqueId uniqueId)

   {

      super(uniqueId, "FWD Test");

   }

   /**

    * Get the preferred of {@linkplain ExecutionMode execution mode} for

    * parallel execution of this node.

    *

    * @return the preferred execution mode of this node; never {@code null}

    * @see ExecutionMode

    */

   @Override

   public ExecutionMode getExecutionMode() {

      // No concurrent execution is planned yet

      return ExecutionMode.SAME_THREAD;

   }

}

/*

** Module   : FWDEngineExecutionContext.java

** Abstract : Test engine execution context.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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 org.junit.platform.engine.support.hierarchical.*;

/**

 * Test engine execution context.

 */

public class FWDEngineExecutionContext

implements EngineExecutionContext

{

   // for now empty

}

/*

** Module   : FWDMethodTestDescriptor.java

** Abstract : Test descriptor for a Java method.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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 org.junit.platform.commons.support.*;

import org.junit.platform.engine.support.descriptor.*;

import org.junit.platform.engine.support.hierarchical.*;

/**

 * Test descriptor for a Java method.

 */

public class FWDMethodTestDescriptor

extends AbstractTestDescriptor

implements Node<FWDEngineExecutionContext>

{

   /**

    * The Java class to create instances of.

    * 

    */

   final Class<?> clazz;

   /**

    * Methods to execute after the main method, if any 

    */

   private final Iterable<Method> after;

   /**

    * Methods to execute before the main method, if any 

    */

   private final Iterable<Method> before;

   /**

    * Main method to execute

    */

   private final Method method;

   /**

    * The test class instance. Is created before each test life cycle begins,

    * and dropped after test life cycle ends.

    */

   private Object testInstance;

   /**

    * Constructor.

    * @param parent 

    *        the parent descriptor

    * @param clazz

    *        the Java class to create instances

    * @param execute

    *        the method to execute

    * @param beforeMethods

    *        methods to execute before the execute method

    * @param afterMethods

    *        methods to execute after the execute method

    */

   FWDMethodTestDescriptor(final FWDClassTestDescriptor parent,

            final Class<?> clazz,

            final Method execute,

            final Iterable<Method> beforeMethods,

            final Iterable<Method> afterMethods)

   {

      super(parent.getUniqueId().append("method", execute.getName()), execute.getName(),

               new FWDMethodTestSource());

      this.clazz = clazz;

      this.method = execute;

      this.before = beforeMethods;

      this.after = afterMethods;

      setParent(parent);

   }

   /**

    * Execute the <em>after</em> behavior of this node.

    *

    * <p>This method will be called once <em>after</em> {@linkplain #execute

    * execution} of this node.

    *

    * @param context

    *        the context to execute in

    * 

    */

   @Override

   public void after(final FWDEngineExecutionContext context) throws Exception

   {

      for (final Method m : after)

      {

         ReflectionSupport.invokeMethod(m, testInstance);

      }

   }

   /**

    * Execute the <em>before</em> behavior of this node.

    *

    * <p>This method will be called once <em>before</em> {@linkplain #execute

    * execution} of this node.

    *

    * @param context

    *        the context to execute in

    * @return the new context to be used for children of this node; never

    * {@code null}

    */

   @Override

   public FWDEngineExecutionContext before(FWDEngineExecutionContext context) throws Exception

   {

      for (final Method m : before)

      {

         ReflectionSupport.invokeMethod(m, testInstance);

      }

      return context;

   }

   /**

    * Clean up the supplied {@code context} after execution.

    * 

    * Reset the test class instance.

    *

    * @param context

    *        the context to execute in

    * @see #prepare

    */

   @Override

   public void cleanUp(final FWDEngineExecutionContext context) throws Exception

   {

      testInstance = null;

   }

   /**

    * Execute the <em>behavior</em> of this node.

    *

    * <p>Containers typically do not implement this method since the

    * {@link HierarchicalTestEngine} handles execution of their children.

    *

    * <p>The supplied {@code dynamicTestExecutor} may be used to submit

    * additional dynamic tests for immediate execution.

    *

    * @param context

    *         the context to execute in

    * @param dynamicTestExecutor

    *        the executor to submit dynamic tests to

    *        

    * @return the new context to be used for children of this node and for the

    * <em>after</em> behavior of the parent of this node, if any

    */

   @Override

   public FWDEngineExecutionContext execute(final FWDEngineExecutionContext context,

            DynamicTestExecutor dynamicTestExecutor) throws Exception

   {

      // System.err.println("executing method " + method + " on " + testInstance);

      ReflectionSupport.invokeMethod(method, testInstance);

      return context;

   }

   /**

    * Determine the {@link org.junit.platform.engine.TestDescriptor.Type} of this descriptor.

    *

    * @return the descriptor type; never {@code null}.

    * @see #isContainer()

    * @see #isTest()

    */

   @Override

   public Type getType()

   {

      return Type.TEST;

   }

   /**

    * Prepare the supplied {@code context} prior to execution.

    * 

    * Create test class instance.

    *

    * @see #cleanUp

    */

   @Override

   public FWDEngineExecutionContext prepare(FWDEngineExecutionContext context) throws Exception

   {

      testInstance = ReflectionSupport.newInstance(clazz);

      return context;

   }

   /**

    * Get the method.

    * 

    * @return the method, never {@code null}

    */

   final Method getMethod()

   {

      return method;

   }

}

/*

** Module   : FWDMethodTestSource.java

** Abstract : Test method source data.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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 org.junit.platform.engine.*;

/**

 * Test method source data. Currently empty.

 * 

 * FIXME: probably, will need either to use the

 * {@link org.junit.platform.engine.support.descriptor.MethodSource}

 * or inherit from it.

 */

public class FWDMethodTestSource

implements TestSource

{

   private static final long serialVersionUID = 1L;

}

/*

** Module   : FWDTestEngine.java

** Abstract : Test engine.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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 org.junit.platform.commons.support.*;

import org.junit.platform.engine.*;

import org.junit.platform.engine.discovery.*;

import org.junit.platform.engine.support.hierarchical.*;

import com.goldencode.p2j.testengine.api.*;

/**

 * Test engine.

 *

 */

public class FWDTestEngine

extends HierarchicalTestEngine<FWDEngineExecutionContext>

implements Node<FWDEngineExecutionContext>

{

   /**

    * Scan a class for test methods, declared in the class.

    * 

    * @param engineDescriptor

    *        the engine descriptor to register found test descriptors in

    * @param javaClass

    *        the Java class to scan

    * @param explicitMethods

    *        optional list of explicit test methods to execute, can be {@code null}

    */

   private final static void addOptionally(final TestDescriptor engineDescriptor,

            final Class<?> javaClass, final List<Method> explicitMethods)

   {

      final FWDClassTestDescriptor instance = FWDClassTestDescriptor.testAndCreate(javaClass,

               engineDescriptor, explicitMethods);

      if (instance != null)

      {

         engineDescriptor.addChild(instance);

      }

   }

   /**

    * Scan a class for all test methods, including whose defined in the class and referenced classes,

    * if the class is marked as test suite.

    * 

    * @param engineDescriptor

    *        the engine descriptor to register found test descriptors in

    * @param javaClass

    *        the Java class to scan

    */

   private static void scanClass(final TestDescriptor engineDescriptor, final Class<?> javaClass)

   {

      addOptionally(engineDescriptor, javaClass, null);

      // Add suites

      if (AnnotationSupport.isAnnotated(javaClass, Suite.class))

      {

         for (final Class<?> referencedClass : javaClass.getAnnotation(SelectClasses.class).value())

         {

            addOptionally(engineDescriptor, referencedClass, null);

         }

         // TODO: implement all other suite selectors if ever required...

      }

   }

   /**

    * Discover tests according to the supplied {@link EngineDiscoveryRequest}.

    *

    * <p>The supplied {@link UniqueId} must be used as the unique ID of the

    * returned root {@link TestDescriptor}. In addition, the {@code UniqueId}

    * must be used to create unique IDs for children of the root's descriptor

    * by calling {@link UniqueId#append}.

    *

    * @param discoveryRequest the discovery request; never {@code null}

    * @param uniqueId the unique ID to be used for this test engine's

    * {@code TestDescriptor}; never {@code null}

    * @return the root {@code TestDescriptor} of this engine, typically an

    * instance of {@code EngineDescriptor}

    * @see org.junit.platform.engine.support.descriptor.EngineDescriptor

    */

   @Override

   public TestDescriptor discover(final EngineDiscoveryRequest discoveryRequest, final UniqueId uniqueId)

   {

      final TestDescriptor engineDescriptor = new FWDEngineDescriptor(uniqueId);

      discoveryRequest.getSelectorsByType(MethodSelector.class).forEach(selector -> {

         addOptionally(engineDescriptor, selector.getJavaClass(), Collections.singletonList(selector.getJavaMethod()));

      });

      discoveryRequest.getSelectorsByType(ClassSelector.class).forEach(selector -> {

         scanClass(engineDescriptor, selector.getJavaClass());

      });

      discoveryRequest.getSelectorsByType(PackageSelector.class).forEach(selector -> {

         final List<Class<?>> classes = ReflectionSupport.findAllClassesInPackage(

                  selector.getPackageName(), (Class<?> c) -> true, name -> true);

         for(Class<?> javaClass : classes)

         {

            scanClass(engineDescriptor, javaClass);

         }

      });

      return engineDescriptor;

   }

   /**

    * Get the ID that uniquely identifies this test engine.

    *

    * <p>Each test engine must provide a unique ID. For example, JUnit Vintage

    * and JUnit Jupiter use {@code "junit-vintage"} and {@code "junit-jupiter"},

    * respectively. When in doubt, you may use the fully qualified name of your

    * custom {@code TestEngine} implementation class.

    */

   @Override

   public String getId()

   {

      // Note: "junit-fwd" would be more natural, but the "junit-" prefix

      // is reserved by JUnit5

      return "fwd-junit";

   }

   /**

    * Create the initial execution context for executing the supplied

    * {@linkplain ExecutionRequest request}.

    *

    * @param request the request about to be executed

    * @return the initial context that will be passed to nodes in the hierarchy

    */

   @Override

   protected FWDEngineExecutionContext createExecutionContext(ExecutionRequest request)

   {

      return new FWDEngineExecutionContext();

   }

}

/*

** Module   : AfterAll.java

** Abstract : Mark methods, which should be run after all @Test methods in the class.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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.api;

import java.lang.annotation.*;

/**

 * {@link AfterAll} is used to mark methods, which should be run after all {@link Test} methods in the class.

 */

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

public @interface AfterAll

{

   // no-op

}

/*

** Module   : AfterEach.java

** Abstract : Mark methods, which should be run after each @Test method.

**

** Copyright (c) 2022, Golden Code Development Corporation.

**

** -#- -I- --Date-- ----------------Description----------------------

** 001 VVT 2022xxxx 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.api;

import java.lang.annotation.*;

/**

 * {@link AfterEach} is used to mark methods, which should be run after each {@link Test} method.

 */

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

public @interface AfterEach

{

   // no-op

}

/*

** Module   : BeforeAll.java

** Abstract : Mark methods, which should be run before all @Test methods in the class.

**

** Copyright (c) 2022, Golden Code Development Corporation.