FWDProcedureTestDescriptor_11_7.java
/*
** Module : FWDProcedureTestDescriptor_11_7.java
** Abstract : Test descriptor for a legacy procedure, compatible with OE 11.7.
**
** 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.*;
/**
* Instances of this class provide procedure test descriptor behavior compatible
* with Progress 11.7 ABLUnit library (the exact version tested was 11.7.12).
*
* The 11.7 release of ABLUnit implements the following specific behavior:
*
* <li>One procedure instance is used to run all test code, no other procedure is ever created by ABLUnit;
* <li>If THIS-PROCEDURE was deleted in any test code, the test execution aborted;
* <li>If THIS-PROCEDURE was valid after a @Test method was completed, is is marked as passed,
* otherwise it is marked as failed with 'Test instance is invalid' error.
*/
public class FWDProcedureTestDescriptor_11_7
extends FWDProcedureTestDescriptor
{
/**
* The procedure instance used.
*/
private transient handle procedure;
/**
* Default constructor, required for de-serialization.
*/
public FWDProcedureTestDescriptor_11_7()
{
// 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
*/
public FWDProcedureTestDescriptor_11_7(
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, parent, test, beforeEach, afterEach, beforeAll, afterAll);
}
/**
* 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,
LegacyErrorException
{
if (procedure._isValid())
{
super.afterImpl();
}
}
/**
* Execute the <em>before</em> behavior of this node implementation.
* <p>
* This method will be called once <em>before</em> {@linkplain #executeImpl() execution}
* of this node.
*/
@Override
public void beforeImpl()
throws ErrorConditionException,
LegacyErrorException
{
// Let all the tests fail at the execute stage
if (procedure._isValid())
{
super.beforeImpl();
}
}
/**
* Clean up the supplied {@code context} after execution implementation.
* <p>
* Reset the test class instance.
*
* @throws ErrorConditionException
* remote code may throw this
*
* @see #prepare
*/
@Override
public void cleanUpImpl()
throws ErrorConditionException
{
if (procedure._isValid())
{
HandleOps.delete(procedure);
}
procedure = null;
// assert ProcedureManager.firstProcedure().isUnknown();
}
/**
* 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;
}
/**
* 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 = createProcedureInstance();
}
}