A while back, I spent a afternoon converting some C# NUnit documentation into COBOL .Net, so I thought I would share the document with the world, with the hope that it will help any one interested in using NUnit and COBOL.<\/p>\n
Enjoy!<\/p>\n
Let\u2019s start with a simple example. Suppose we are writing a bank application and we have a basic domain class \u2013 Account. Account supports operations to deposit, withdraw, and transfer funds. The Account class may look like this:<\/p>\n
method-id. \"Deposit\". method-id. \"Withdraw\". method-id. \"TransferFunds\". Now let\u2019s write a test for this class \u2013 AccountTest. The first method we will test is TransferFunds.<\/p>\n environment division. class cls-Account as \"Account\" class-attributes. static. object. set dest to cls-Account::\"New\" invoke src::\"TransferFunds\"(dest, 100);<\/p>\n invoke Assert::\"AreEqual\"(250 as sys-single,dest::\"Balance\") <\/code><\/p>\n The first thing to notice about this class is that it has a TestFixture attribute associated with it \u2013 this is the way to indicate that the class contains test code (this attribute can be inherited). The class has to be public and there are no restrictions on its superclass. The class also has to have a default constructor.<\/p>\n The only method in the class \u2013 TransferFunds, has a Test attribute associated with it \u2013 this is an indication that it is a test method. Test methods have to return void and take no parameters. In our test method we do the usual initialization of the required test objects, execute the tested business method and check the state of the business objects. The Assert class defines a collection of methods used to check the post-conditions and in our example we use the AreEqual method to make sure that after the transfer both accounts have the correct balances (there are several overloadings of this method, the version that was used in this example has the following parameters : the first parameter is an expected value and the second parameter is the actual value).<\/p>\n Compile and run this example. Assume that you have compiled your test code into a Example1.dll. Start the NUnit Gui (the installer will have created a shortcut on your desktop and in the \u201cProgram Files\u201d folder), after the GUI starts, select the File->Open menu item, navigate to the location of your bank.dll and select it in the \u201cOpen\u201d dialog box. When the bank.dll is loaded you will see a test tree structure in the left panel and a collection of status panels on the right. Click the Run button, the status bar and the TransferFunds node in the test tree turn red \u2013 our test has failed. The \u201cErrors and Failures\u201d panel displayed the following message \u2013 \u201cTransferFunds : expected <250> but was <150>\u201d and the stack trace panel right below it reported where in the test code the failure has occurred \u201cat AccountTest.TransferFunds() in xxxxExample1Example1AccountTest.cbl:line 42\u201d<\/p>\n That is expected behavior; the test has failed because we have not implemented the TransferFunds method yet. Now let\u2019s get it to work. Don\u2019t close the GUI and go back to your IDE and fix the code, make your TransferFunds method look like this:<\/p>\n Now recompile your code and click the run button in GUI again \u2013 the status bar and the test tree turn green. (Note how the GUI has reloaded the assembly automatically for you; we will keep the GUI open all the time and continue working with our code in IDE and write more tests).<\/p>\n Let\u2019s add some error checking to our Account code. We are adding the minimum balance requirement for the account to make sure that banks continue to make their money by charging your minimal overdraft protection fee. Let\u2019s add the minimum balance property to our Account class:<\/p>\n We will use an exception to indicate an overdraft:<\/p>\n repository. end class InsufficientFundsException. Add two new classes reference to the repository:<\/p>\n Add a new test method to our AccountTest class:<\/p>\n set dest to cls-Account::\"New\" invoke src::\"TransferFunds\"(dest, 300); <\/code><\/p>\n This test method in addition to Test attribute has an ExpectedException attribute associated with it \u2013 this is the way to indicate that the test code is expecting an exception of a certain type; if such an exception is not thrown during the execution \u2013 the test will fail. <\/p>\n Compile your code and go back to the GUI. As you compiled your test code, the GUI has grayed out and collapsed the test tree as if the tests were not run yet (GUI watches for the changes made to the test assemblies and updates itself when the structure of the test tree has changed \u2013 e.g. new test is added). Click the \u201cRun\u201d button \u2013 we have a red status bar again. We got the following Failure : \u201cTransferWithInsufficentFunds : InsufficientFundsException was expected\u201d. Let\u2019s fix our Account code again, modify the TransferFunds method this way:\n<\/p>\n invoke lnk-Account::\"Deposit\"(lnk-amount) Compile and run the tests \u2013 green bar. Success! But wait, looking at the code we\u2019ve just written we can see that the bank may be loosing money on every unsuccessful funds Transfer operation. Let\u2019s write a test to confirm our suspicions. Add this test method:<\/p>\n set dest to cls-Account::\"New\" try invoke Assert::\"AreEqual\"(200 as sys-single,src::\"Balance\") exit method. We are testing the transactional property of our business method \u2013 all operations are successful or none. Compile and run \u2013 red bar. OK, we\u2019ve made $300.00 out of a thin air (1999.com d\u00e9j\u00e0 vu?) \u2013 the source account has the correct balance of 150.00 but the destination account shows : $450.00. How do we fix this? Can we just move the minimum balance check call in front of the updates:<\/p>\n if balance - lnk-amount < minimumBalance\n raise InsufficientFundsException::\"New\"()\n end-if\n \n invoke lnk-Account::\"Deposit\"(lnk-amount)\n \n invoke self::\"Withdraw\"(lnk-amount)\n exit method. \n end method \"TransferFunds\". \n<\/code><\/p>\n What if the Withdraw() method throws another exception? Should we execute a compensating transaction in the catch block or rely on our transaction manager to restore the state of the objects? We need to answer those questions at some point, but not now; but what do we do with the failing test in the meantime \u2013 remove it? A better way is to temporarily ignore it, add the following attribute to your test method<\/p>\n Compile and run \u2013 yellow bar. Click on \u201cTests Not Run\u201d tab and you will see AccountTest.TransferWithInsufficientFundsAtomicity() in the list along with the Reason this test is ignored.<\/p>\n Looking at our test code we can see that some refactoring is in order. All test methods share a common set of test objects. Let\u2019s extract this initialization code into a setup method and reuse it in all of our tests. The refactored version of our test class looks like this:<\/p>\n environment division. class cls-Account\t\t\t\t\tas class-attributes. object. method-id. \"Init\" invoke src::\"Deposit\"(200) method-id. \"TransferFunds\" method-id. \"TransferWithInsufficientFunds\" method-id. \"TransferWithInsufficientFundsAtomicity\" invoke NUnit-Assert::\"AreEqual\"( end object. <\/code><\/p>\n Note that Init method has the common initialization code, it has void return type, no parameters, and it is marked with SetUp attribute. Compile and run \u2013 same yellow bar!<\/p>\n","protected":false},"excerpt":{"rendered":" A while back, I spent a afternoon converting some C# NUnit documentation into COBOL .Net, so I thought I would share the document with the world, with the hope that it will help any one interested in using NUnit and … Continue reading class-id. Account as \"Account\".
\n environment division.
\n configuration section.
\n repository.
\n object.
\n data division.
\n working-storage section.
\n\t 01 balance comp-2 value 0 property as \"Balance\".<\/p>\n
\n local-storage section.
\n linkage section.
\n 01 lnk-amount comp-2.
\n procedure division using by value lnk-amount.
\n add lnk-amount to balance
\n exit method.
\n end method \"Deposit\".<\/p>\n
\n local-storage section.
\n linkage section.
\n 01 lnk-amount comp-2.
\n procedure division using by value lnk-amount.
\n subtract lnk-amount from balance
\n exit method.
\n end method \"Withdraw\".<\/p>\n
\n local-storage section.
\n linkage section.
\n 01 lnk-Account\tobject reference Account.
\n 01 lnk-amount comp-2.
\n procedure division using by value lnk-Account,
\n by value lnk-amount.
\n exit method.
\n end method \"TransferFunds\".
\n end object.
\n end class Account.
\n<\/code><\/p>\n $set preservecase
\n class-id. AccountTest as \"AccountTest\".<\/p>\n
\n configuration section.
\n repository.
\n class sys-single\tas \"System.Single\"
\n class cls-TestFixture as \"NUnit.Framework.TestFixtureAttribute\"
\n class cls-Test\t\t as \"NUnit.Framework.TestAttribute\"
\n class Assert as \"NUnit.Framework.Assert\"<\/p>\n
\n .<\/p>\n
\n custom-attribute is cls-TestFixture.<\/p>\n
\n data division.
\n working-storage section.
\n end static.<\/p>\n
\n method-id. \"TransferFunds\" custom-attribute is cls-Test.
\n local-storage section.
\n 01 src\tobject reference cls-Account.
\n 01 dest\tobject reference cls-Account.
\n procedure division.
\n set src to cls-Account::\"New\"
\n invoke src::\"Deposit\"(200)<\/p>\n
\n invoke dest::\"Deposit\"(150)<\/p>\n
\n invoke Assert::\"AreEqual\"(100 as sys-single,src::\"Balance\")
\n exit method.
\n end method \"TransferFunds\".
\n end object.
\n end program AccountTest.<\/p>\n method-id. \"TransferFunds\".
\n local-storage section.
\n linkage section.
\n 01 lnk-Account\tobject reference Account.
\n 01 lnk-amount comp-2.
\n procedure division using by value lnk-Account,
\n by value lnk-amount.
\n invoke lnk-Account::\"Deposit\"(lnk-amount)
\n invoke self::\"Withdraw\"(lnk-amount)
\n exit method.
\n end method \"TransferFunds\".
\n<\/code><\/p>\n
\n\t 01 minimumBalance\tcomp-2 value 10
\n\t\t\t\t\tproperty as \"MinimumBalance\".
\n<\/code><\/p>\n
\n class-id. InsufficientFundsException
\n as \"InsufficientFundsException\"
\n inherits cls-exception.<\/p>\n
\n class cls-exception as \"System.ApplicationException\".
\n object.
\n object-storage section.
\n end object.<\/p>\n
\n<\/code><\/p>\n
\n class ExpectedException
\n as \"NUnit.Framework.ExpectedExceptionAttribute\"
\n class InsufficientFundsException
\n as \"InsufficientFundsException\"
\n<\/code><\/p>\n
\n method-id. \"TransferWithInsufficientFunds\"
\n custom-attribute is cls-Test
\n custom-attribute is ExpectedException(
\n type of InsufficientFundsException)
\n\t .
\n local-storage section.
\n 01 src\tobject reference cls-Account.
\n 01 dest\tobject reference cls-Account.
\n procedure division.
\n set src to cls-Account::\"New\"
\n invoke src::\"Deposit\"(200)<\/p>\n
\n invoke dest::\"Deposit\"(150)<\/p>\n
\n exit method.
\n end method \"TransferWithInsufficientFunds\".<\/p>\n
\n method-id. \"TransferFunds\".
\n local-storage section.
\n linkage section.
\n 01 lnk-Account\tobject reference Account.
\n 01 lnk-amount comp-2.
\n procedure division using by value lnk-Account,
\n by value lnk-amount.<\/p>\n
\n if balance - lnk-amount < minimumBalance\n raise InsufficientFundsException::\"New\"()\n end-if\n \n invoke self::\"Withdraw\"(lnk-amount)\n exit method. \n end method \"TransferFunds\". \n<\/code><\/p>\n
\n method-id. \"TransferWithInsufficientFundsAtomicity\"
\n custom-attribute is cls-Test
\n .
\n local-storage section.
\n 01 src\tobject reference cls-Account.
\n 01 dest\tobject reference cls-Account.
\n 01 obj-InsufficientFundsException
\n object reference InsufficientFundsException.
\n procedure division.
\n set src to cls-Account::\"New\"
\n invoke src::\"Deposit\"(200)<\/p>\n
\n invoke dest::\"Deposit\"(150)<\/p>\n
\n invoke src::\"TransferFunds\"(dest, 300)
\n catch obj-InsufficientFundsException
\n continue
\n end-try<\/p>\n
\n invoke Assert::\"AreEqual\"(150 as sys-single,dest::\"Balance\")<\/p>\n
\n end method \"TransferWithInsufficientFundsAtomicity\".
\n<\/code><\/p>\n
\n method-id. \"TransferFunds\".
\n local-storage section.
\n linkage section.
\n 01 lnk-Account\tobject reference Account.
\n 01 lnk-amount comp-2.
\n procedure division using by value lnk-Account,
\n by value lnk-amount.<\/p>\n
\n method-id. \"TransferWithInsufficientFundsAtomicity\"
\n custom-attribute is cls-Test
\n custom-attribute is
\n IgnoreTest(\"Need to decide how to implement transaction management in the application\")
\n<\/code><\/p>\n
\n $set preservecase sourceformat\"free\"
\n class-id. AccountTest as \"AccountTest\".<\/p>\n
\n configuration section.
\n repository.
\n class sys-single\tas \"System.Single\"
\n class NUnit-TestFixture\t\t\t\tas
\n \"NUnit.Framework.TestFixtureAttribute\"
\n class NUnit-Test\t\t\t\t\tas
\n \"NUnit.Framework.TestAttribute\"
\n class NUnit-Setup\t\t\t\t\tas
\n \"NUnit.Framework.SetUpAttribute\"
\n class NUnit-Assert\t\t\t\t\tas
\n \"NUnit.Framework.Assert\"
\n class NUnit-IgnoreTest\t\t\t\tas
\n \"NUnit.Framework.IgnoreAttribute\"
\n class NUnit-ExpectedException\t\t as
\n \"NUnit.Framework.ExpectedExceptionAttribute\"<\/p>\n
\n \"Account\"
\n class InsufficientFundsException\t as
\n \"InsufficientFundsException\"
\n .<\/p>\n
\n custom-attribute is NUnit-TestFixture.<\/p>\n
\n working-storage section.
\n 01 src\tobject reference cls-Account.
\n 01 dest\tobject reference cls-Account.<\/p>\n
\n\t\tcustom-attribute is NUnit-Setup.
\n\t procedure division.
\n set src to cls-Account::\"New\"
\n set dest to cls-Account::\"New\"<\/p>\n
\n invoke dest::\"Deposit\"(150)
\n exit method.
\n end method \"Init\".<\/p>\n
\n\t\tcustom-attribute is NUnit-Test.
\n procedure division.
\n invoke src::\"TransferFunds\"(dest, 100);
\n invoke NUnit-Assert::\"AreEqual\"(250,dest::\"Balance\")
\n invoke NUnit-Assert::\"AreEqual\"(100,src::\"Balance\")
\n exit method.
\n end method \"TransferFunds\".<\/p>\n
\n custom-attribute is NUnit-Test
\n\t\tcustom-attribute is
\n NUnit-ExpectedException(
\n type of InsufficientFundsException).
\n procedure division.
\n invoke src::\"TransferFunds\"(dest, 300)
\n exit method.
\n end method \"TransferWithInsufficientFunds\".<\/p>\n
\n\t\tcustom-attribute is NUnit-Test
\n custom-attribute is NUnit-IgnoreTest(
\n \"Need to decide how to implement transaction management in the application\").
\n local-storage section.
\n 01 obj-InsufficientFundsException
\n object reference InsufficientFundsException.
\n procedure division.
\n try
\n invoke src::\"TransferFunds\"(dest, 300)
\n catch obj-InsufficientFundsException
\n continue
\n end-try<\/p>\n
\n 200 as sys-single,src::\"Balance\")
\n invoke NUnit-Assert::\"AreEqual\"(
\n 150 as sys-single,dest::\"Balance\")
\n exit method.
\n end method \"TransferWithInsufficientFundsAtomicity\". <\/p>\n
\n end program AccountTest.<\/p>\n