FWDDescriptorFactory.java

/*
** Module   : FWDDescriptorFactory.java
** Abstract : Factory class with static methods to create test descriptor instances compatible with the
**            emulated Progress version.
**
** 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 org.junit.platform.engine.*;

import com.goldencode.p2j.util.*;

/**
 * This class is a factory with all static methods to create test descriptor instances
 * compatible with the emulated Progress version.
 */
public final class FWDDescriptorFactory
{
   
   /**
    * The progress short version number
    */
   private final static float progressVersion = EnvironmentOps.versionNumber();
   
   /**
    * Pre-processed OE 11.6 short version number
    */
   private final static float V11_6 = 11.6f;
   
   /**
    * Create a new procedure test descriptor.
    * 
    * @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 after all tests
    *        
    * @return a new instance of procedure test descriptor.
    */
   static final FWDProcedureTestDescriptor newProcedureTestDescriptor(
            final Class<?> clazz,
            final TestDescriptor parent,
            final List<Method> test,
            final List<Method> beforeEach,
            final List<Method> afterEach,
            final List<Method> beforeAll,
            final List<Method> afterAll)
   {
      if (progressVersion <= V11_6)
      {
         return new FWDProcedureTestDescriptor_11_6(clazz, parent, test, beforeEach, afterEach,
                  beforeAll, afterAll);
      }
         
      return new FWDProcedureTestDescriptor_11_7(clazz, parent, test, beforeEach, afterEach,
                     beforeAll, afterAll);
   }
   
   /**
    * Create a new procedure test descriptor.
    * <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
    *        
    * @return a new instance of procedure method test descriptor.
    */
   static FWDProcedureMethodTestDescriptor newProcedureMethodTestDescriptor(
            final AbstractClassTestDescriptor parent,
            final Class<?> clazz,
            final Method execute,
            final List<Method> beforeEach,
            final List<Method> afterEach,
            final String expectedException)
   {
      if (progressVersion <= V11_6)
      {
         return new FWDProcedureMethodTestDescriptor_11_6(parent, clazz, execute, beforeEach,
                  afterEach, expectedException);
      }

      return new FWDProcedureMethodTestDescriptor_11_7(parent, clazz, execute, beforeEach,
               afterEach, expectedException);
   }
}