Unit testing for traditional Synergy

Unit testing for traditional Synergy projects is a pre-release feature. Synergy/DE 11.1.1d or higher is required to create or run traditional Synergy unit test projects.

With SDI you can create and run MSTest unit tests for traditional Synergy OLB and ELB projects. SDI includes a unit test project template, an item template to create a basic unit test file, unit test attributes, a TestProperties class, and an Assert class (along with AssertFailedException and AssertInconclusiveException classes) that are specific to traditional Synergy. For information specific to traditional Synergy unit tests, see the following sections in this topic:

• Creating and running unit tests for traditional Synergy
• Attributes for traditional Synergy unit testing
• Synergex.TestFramework.TestProperties

For more information on the Assert class, see Synergex.TestFramework.Assert.

The following Microsoft unit testing features are supported: Test Explorer, VSTest.Console.exe, and .runsettings files. For information on these features and for basic information on creating and running unit tests, see Microsoft documentation (e.g., Unit test basics). Third-party unit test frameworks are not supported.

Creating and running unit tests for traditional Synergy

To create and run unit tests for traditional Synergy,

• Add a reference to the ELB or OLB project it will test.
• Add a unit test file (.dbl) for each code file or collection of related routines in the referenced project. When you create a unit test project from the "Unit Test (Traditional)" template, the project is created with a UnitTest1.dbl file, which you can use for one of the code files in the referenced project. Use the "Basic Traditional Unit Test" item template to create additional unit test code files.

Note that each traditional Synergy unit test project must reference SYNTRADUT:TestFramework.elb, and each unit test file must import Synergex.TestFramework. Projects created from the "Unit Test (Traditional)" template are created with this reference, and files created from the "Basic Traditional Unit Test" item template include the import.

The following example uses the {TestClass} attribute to mark UnitTest1 as a unit test class, and it uses {TestMethod} to mark the SimpleDivision method as a unit test method. In the test method, the quotient calculated by the traditional Synergy subroutine MyDivSubroutine is tested against an expected value of 2. If MyDivSubroutine returns 2 in the quotient argument, the test will pass. If it returns a different value, the AreEqual method throws an exception.

import Synergex.TestFramework
namespace UnitTest1
    {TestClass}
    public class UnitTest1
        {Owner("Fred")}
        {TestMethod}
        public method SimpleDivision, void
            endparams
        proc
            begin
                data dividend ,i4, 10
                data divisor  ,i4, 5
                data quotient ,i4, 0
                data expected ,i4, 2
                data delta    ,i2, 0

                xcall MyDivSubroutine(dividend, divisor, quotient)
                Assert.AreEqual(expected, quotient, delta)
            end
        endmethod
    endclass
endnamespace

• Use a Visual Studio command prompt to run VSTest.Console.exe.
• Rather than specifying .exe and .dll files, the command-line option for test file names must specify .dbr and .elb files. For example, the following command runs tests in the myTestProject.elb file:

vstest.console.exe myTestProject.elb 

• If you run VSTest.Console.exe from a location other than the location of the .elb or .olb, you must specify the path for the .elb or .olb.

Attributes for traditional Synergy unit testing

The following attributes are supported for traditional Synergy unit testing. They are similar to the MSTest attributes used for .NET unit tests (see Microsoft documentation on MSTest attributes), but they must be enclosed in curly brackets {}. By decorating classes and methods with these attributes, you specify how classes and methods are to be used for unit testing. For example, if you decorate a class with {TestClass}, the methods in that class can be used as unit test methods. See step 4 above and the information on the TestProperty attribute below for examples.

{TestClass}
class Test   
    private fileName, string

    {TestInitialize}  
    public method Init, void
    proc
        fileName = Synergex.TestFramework.TestProperties.GetProperty("fileName")
    endmethod

    {TestProperty("fileName", "..\testfile.txt")}
    {TestMethod}
    public method Fred
    proc
        Assert.AreEqual(this.fileName, (string)"..\testfile.txt")
    endmethod
endclass

Synergex.TestFramework.TestProperties

namespace Synergex.TestFramework
public static class TestProperties

The Synergex.TestFramework.TestProperties class enables you to get and test properties (key value pairs) used for unit tests. This is useful for defining test information that can be used during initialization and cleanup methods to avoid unnecessary code within test methods. See the information on the TestProperty attribute in Attributes for traditional Synergy unit testing above for more information and an example.

Methods

GetProperty

public static method GetProperty(key), String

Returns the value for a property.

key

A property name. (System.String)

TryGetProperty

public static method TryGetProperty(key), boolean

Returns a Boolean value indicating whether or not the property exists. Returns 1 if it exists.

key

A property name. (System.String)