TestSuite.java
/*
** Module : TestSuite.java
** Abstract : Implementation of the OEUnit.Runner.TestSuite class.
**
** Copyright (c) 2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description------------------------------------------------
** 001 VVT 20230407 Created initial version
** 002 CA 20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
** dropped if is a no-op.
*/
/*
** 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.oo.oeunit.runner;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.oo.lang._BaseObject_;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.util.InternalEntry.Type;
import java.util.*;
/**
* Implementation for OEUnit.Runner.TestSuite class.
*/
@LegacyResource(resource = "OEUnit.Runner.TestSuite")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class TestSuite
extends BaseObject
{
/** The tests */
final List<_BaseObject_> tests = new ArrayList<>();
/**
* The static constructor.
*/
@LegacySignature(type = Type.CONSTRUCTOR)
public static void __oeunit_runner_TestSuite_constructor__static__()
{
externalProcedure(TestSuite.class, new Block((Body) () -> {
onRoutineLevel(Condition.ERROR, Action.THROW);
}));
}
/**
* The constructor
*/
@LegacySignature(type = Type.CONSTRUCTOR)
public void __oeunit_runner_TestSuite_constructor__()
{
internalProcedure(TestSuite.class, this, "__oeunit_runner_testSuite_constructor__",
new Block((Body) () -> {
__lang_BaseObject_constructor__();
}));
}
/**
* The destructor.
*
* Destroys all tests
*
*/
@LegacySignature(type = Type.DESTRUCTOR)
public void __oeunit_runner_TestSuite_destructor__()
{
internalProcedure(TestSuite.class, this, "__oeunit_runner_TestSuite_destructor__",
new Block((Body) () -> {
// FIXME
// for (final _BaseObject_ test : tests)
// {
// ObjectOps.delete(test);
// }
}));
}
/**
* The procedure 'execute' method
*/
@LegacySignature(type = Type.EXECUTE)
public void __oeunit_runner_TestSuite_execute__()
{
onRoutineLevel(Condition.ERROR, Action.THROW);
}
/**
* Add a test to this suite.
*
* FIXME: this method must be re-designed
*
* @param _test
* the test to add
*/
@LegacySignature(type = Type.METHOD, name = "AddTest", parameters = {
@LegacyParameter(name = "test", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT")
})
public void addTest(final object<? extends _BaseObject_> _test)
{
final object<? extends _BaseObject_> test = TypeFactory.initInput(_test);
internalProcedure(TestSuite.class, this, "AddTest", new Block(
(Body) () -> {
tests.add(test.ref());
}));
}
/**
* Returns the test at the given index.
*
* @param _indx
* the test index (1-based?)
*
* @return see above
*/
@LegacySignature(type = Type.METHOD, name = "GetTest", returns = "OBJECT", qualified = "progress.lang.object", parameters = {
@LegacyParameter(name = "indx", type = "INTEGER", mode = "INPUT")
})
public object<? extends _BaseObject_> getTest(final integer _indx)
{
return function(TestSuite.class, this, "GetTest", object.class, new Block((Body) () -> {
// FIXME: check index is valid
// FIXME: create an object
// final _BaseObject_ o = tests.get(_indx.intValue() -1);
// storeReturnValue(TODO o);
}));
}
/**
* Get number of unit test classes.
*
* @return see above
*/
@LegacySignature(type = Type.GETTER, name = "TestCount", returns = "INTEGER")
public integer getTestCount()
{
return function(TestSuite.class, this, "TestCount", integer.class, new Block((Body) () -> {
storeReturnValue(tests.size());
}));
}
/**
* Get suite tests.
*
* This method is assumed to be used internally by test engine.
*
* @return the tests
*/
public final List<_BaseObject_> getTests()
{
return tests;
}
}