FWDProcedureTestDescriptor.java
/*
** Module : FWDProcedureTestDescriptor.java
** Abstract : Test descriptor for a legacy procedure.
**
** Copyright (c) 2023-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description---------------------------------
** 001 VVT 20230318 Created initial version.
** 002 VVT 20230428 Source formatting fixed. Full paths to legacy procedures and fully qualified
** legacy class names are now used as JUnit5 test display names. See #3827-360,
** item 3. Minor non-functional fixes.
** 003 VVT 20240321 Different procedure instances are now used in the test life-cycle. See #8406.
** The @Test methods ordered before method test descriptors are created. See #8440.
** 004 VVT 20240405 Partly reverted/fixed the previous change. See #8406-58, #8406-64.
** 005 VVT 20240614 ABLUnit test procedure should be deleted after the test life cycle is complete.
** See #8874.
** 006 VVT 20240716 Additional fix for #8874: not all test procedures were deleted; the @After
** code was not always executed.
** 007 VVT 20240718 This class is now an ancestor of a class tree. See #8874.
** 008 VVT 20240826 SourceNameMapper.convertJavaProg() renamed. See #8613-16.
*/
/*
** 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.testengine.api.*;
import com.goldencode.p2j.util.*;
/**
* Test descriptor for a legacy procedure.
*/
public abstract class FWDProcedureTestDescriptor
extends AbstractClassTestDescriptor
{
/**
* Compute the display name as the relative path to the procedure source file.
*
* @param clazz
* the Java class
*
* @return see above
*/
private final static String displayName(final Class<?> clazz)
{
return SourceNameMapper.getLegacySourceName(clazz.getName());
}
/**
* Default constructor, required for de-serialization
*/
public FWDProcedureTestDescriptor()
{
// no-op
}
/**
* The 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 after all tests
*/
FWDProcedureTestDescriptor(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)
{
super(clazz, displayName(clazz), parent, beforeAll, afterAll);
for (final Method m : sort(test))
{
final Test annotation = m.getAnnotation(Test.class);
final String expectedException = annotation.expected();
addChild(FWDDescriptorFactory.newProcedureMethodTestDescriptor(this, clazz, m, beforeEach, afterEach,
expectedException));
}
}
/**
* Execute a method.
*
* @param method
* the method to execute
* @param o
* the object to use, can be {@code null} for "static" methods.
*
* @return always {@code null}
*/
@Override
protected BaseDataType callMethodImpl(final Method method,
final Object o,
final CallParameter[] args)
{
TestExecutionSupport.callProcedureMethod(method, (handle) o);
return null;
}
/**
* Create a new persistent procedure.
*
* @return the new procedure handle
*/
protected final handle createProcedureInstance()
{
try
{
// Locate the execute() method
final Method m = clazz.getDeclaredMethod("execute");
final LegacySignature annotation = m.getAnnotation(LegacySignature.class);
final String name = annotation.name();
final handle h = new handle();
new InvokeConfig(name).persistent().setProcedureHandle(h).run();
return h;
}
catch (final NoSuchMethodException | SecurityException e)
{
throw new RuntimeException(e);
}
}
}