AbstractClassTestDescriptor.java
/*
** Module : AbstractClassTestDescriptor.java
** Abstract : Common ancestor for legacy class and legacy procedure test descriptors.
**
** Copyright (c) 2023-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description---------------------------------
** 001 VVT 20230318 Created initial version.
** 002 VVT 20230428 Source formatting fixed. Printing advanced.
** getSource() implementaion added. See #3827-360, item 4.
** Full paths to legacy procedures and fully qualified legacy class names are
** now used as JUnit5 test display names. See #3827-360, item 3.
** Tags support added to FWD engine (FWD extension).
** 003 VVT 20240325 Unused 'test', 'beforeEach' and 'afterEach' constructor parameters removed.
** The 'sort() method added. See #8440.
** 004 VVT 20240408 Minor style fixes. See #8406-70.
*/
/*
** 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.io.*;
import java.lang.reflect.*;
import java.util.*;
import org.junit.platform.engine.*;
import org.junit.platform.engine.support.descriptor.*;
import com.goldencode.p2j.testengine.api.*;
import com.goldencode.p2j.util.*;
import com.goldencode.util.*;
/**
* Common ancestor for legacy class and legacy procedure test descriptors.
*/
public abstract class AbstractClassTestDescriptor
extends AbstractBranchTestDescriptor
{
/**
* Class methods marked to execute after all tests
*/
List<Method> afterAll;
/**
* Class methods marked to execute before all tests
*/
List<Method> beforeAll;
/**
* The Java class.
*/
Class clazz;
/**
* Sort methods by the 'order' annotation attribute.
*
* @param methods
* the methods to sort
*
* @return an array containing original methods sorted
*/
protected static final Method[] sort(final List<Method> methods)
{
// Order methods by the 'oder' annotation parameter value
final Method[] ordered = methods.toArray(new Method[methods.size()]);
Arrays.sort(ordered, Comparator
.comparingInt(m -> m.getAnnotation(Test.class).order()));
return ordered;
}
/**
* Default constructor. Required for serialization. Not to be used in application code.
*/
protected AbstractClassTestDescriptor()
{
super(null, null, null);
this.clazz = null;
this.beforeAll = null;
this.afterAll = null;
}
/**
* The constructor.
*
* @param clazz
* the Java class
* @param displayName
* the display name
* @param parent
* the parent descriptor
* @param beforeAll
* class methods marked to execute before all tests
* @param afterAll
* class methods marked to execute after all tests
*/
protected AbstractClassTestDescriptor(final Class<?> clazz,
final String displayName,
final TestDescriptor parent,
final List<Method> beforeAll,
final List<Method> afterAll)
{
super(parent.getUniqueId().append("class", clazz.getName()), displayName, getTags(clazz));
this.clazz = clazz;
this.beforeAll = beforeAll;
this.afterAll = 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
{
callLFMethodsImpl(afterAll);
}
/**
* 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
{
callLFMethodsImpl(beforeAll);
}
/**
* Get the {@linkplain TestSource source} of the test or container described
* by this descriptor, if available.
*
* @see TestSource
*/
@Override
public Optional<TestSource> getSource()
{
return Optional.of(ClassSource.from(clazz));
}
/**
* Print all class-specific fields.
*
* @param printer
* the string printer to print into
*/
@Override
public void print(final PrintHelper printer)
{
printer.print(clazz.getName());
if (!beforeAll.isEmpty())
{
printer.print("beforeAll", beforeAll.size());
}
if (!afterAll.isEmpty())
{
printer.print("afterAll", afterAll.size());
}
}
/**
* The object implements the readExternal method to restore its
* contents by calling the methods of DataInput for primitive
* types and readObject for objects, strings and arrays. The
* readExternal method must read the values in the same sequence
* and with the same types as were written by writeExternal.
*
* @param in the stream to read data from in order to restore the object
*
* @exception IOException if I/O errors occur
* @exception ClassNotFoundException If the class for an object being
* restored cannot be found.
*/
@Override
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
{
super.readExternal(in);
clazz = (Class<?>) in.readObject();
beforeAll = SerializationSupport.readMethods(in);
afterAll = SerializationSupport.readMethods(in);
}
/**
* The object implements the writeExternal method to save its contents
* by calling the methods of DataOutput for its primitive values or
* calling the writeObject method of ObjectOutput for objects, strings,
* and arrays.
*
* @serialData Overriding methods should use this tag to describe
* the data layout of this Externalizable object.
* List the sequence of element types and, if possible,
* relate the element to a public/protected field and/or
* method of this Externalizable class.
*
* @param out the stream to write the object to
*
* @exception IOException Includes any I/O exceptions that may occur
*/
@Override
public void writeExternal(ObjectOutput out)
throws IOException
{
super.writeExternal(out);
out.writeObject(clazz);
SerializationSupport.writeMethods(beforeAll, out);
SerializationSupport.writeMethods(afterAll, out);
}
}