diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0b15481..91532d5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,7 +11,7 @@ assignees: '' A clear and concise description of what the bug is. **Area Affected** -[ ] BaliTestRunner code +[ ] VoltScriptTesting code [ ] Documentation [ ] Samples diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index fd00b2b..6860796 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -10,7 +10,7 @@ assignees: '' **Additional assertions will be carefully vetted and may be refused. Simplicity is a major focus.** **Area Affected** -[ ] BalitestRunner code +[ ] VoltScriptTesting code [ ] Documentation [ ] Samples diff --git a/README.md b/README.md index 5735b3c..8fa6010 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,20 @@ -# Bali Unit Testing Framework +# VoltScript Testing Framework -Bali Unit Testing Framework is a framework for testing code written using VoltScript, the evolution of LotusScript delivered as part of HCL Volt MX Go. The framework can also be used for LotusScript, with modifications (see below on new language functions used). There are deliberately no dependencies on any LSXs (e.g nlsxbe.dll). None should be added, it will make it dependent on a particular implementation. Create separate classes derived from BaliCustomTester to test individual LSXs or custom classes. +VoltScript Testing Framework is a framework for testing code written using VoltScript, the evolution of LotusScript delivered as part of HCL Volt MX Go. The framework can also be used for LotusScript, with modifications (see below on new language functions used). There are deliberately no dependencies on any LSXs (e.g nlsxbe.dll). None should be added, it will make it dependent on a particular implementation. Create separate classes derived from CustomTester to test individual LSXs or custom classes. This fork is adapted to compile with LotusScript in Notes/Domino 12.0.x. ## Downloading -To download the code, go to [Releases](/releases). The script is in BaliTestRUnner.bss, in the Assets for each release. This can be copied into a Script Library in your NSF. This corresponds to [src/BaliTestRunner.bss](/src/BaliTestRunner.bss) at the time of the specific release. +To download the code, go to [Releases](/releases). The script is in VoltScriptTesting.bss, in the Assets for each release. This can be copied into a Script Library in your NSF. This corresponds to [src/VoltScriptTesting.bss](/src/VoltScriptTesting.bss) at the time of the specific release. -## Writing BaliUnit Tests +## Writing VoltScriptTesting Tests -See [Writing Units Tests](/docs/Writing-Unit-Tests/index.md). +See [Writing Units Tests](/docs/howto/writingtests.md). ## Core Functions Used -Obviously the code runs certain core language functions. These are documented in [Core Functions](/docs/CoreFunctions.md). - -There are three new VoltScript language functions used - Try/Catch/Finally and GetThreadInfo(12) in BaliTestRunner.bss and ++/-- in SampleBeforeAfterTester.bss. +Obviously the code runs certain core language functions. These are documented in [Core Functions](/docs/references/CoreFunctions.md). ### Documentation diff --git a/SampleBeforeAfterTester.bss b/SampleBeforeAfterTester.bss index ed3e104..6b6dbda 100644 --- a/SampleBeforeAfterTester.bss +++ b/SampleBeforeAfterTester.bss @@ -18,7 +18,7 @@ %END REM Option Public Option Declare -Use "./src/BaliTestRunner" +Use "./src/VoltScriptTesting" Private a As Integer Private b As Integer @@ -37,10 +37,10 @@ Private b As Integer See the License for the specific language governing permissions and limitations under the License %END REM %REM - BaliCustomBeforeAfter to set up integers before the start of the test, + CustomBeforeAfter to set up integers before the start of the test, increment a before each test, increment b after each test and msgbox both after all tests %END REM -Class IntegerIncrementBeforeAfter As AbstractBaliCustomBeforeAfter +Class IntegerIncrementBeforeAfter As AbstractCustomBeforeAfter %REM Sub beforeAll @@ -101,7 +101,7 @@ End Class Class CustomTesterOneLess Description: Custom tester to test a > b %END REM -Class CustomTesterGreaterThan As AbstractBaliCustomTester +Class CustomTesterGreaterThan As AbstractCustomTester %REM Function runTests @@ -130,7 +130,7 @@ Sub Initialize 'Core tests - Dim testSuite As New BaliTestSuite(|Custom BeforeAfter Tester|) + Dim testSuite As New TestSuite(|Custom BeforeAfter Tester|) Dim beforeAfter As New IntegerIncrementBeforeAfter Call testSuite.addCustomBeforeAfter(beforeAfter) diff --git a/SampleCustomTester.bss b/SampleCustomTester.bss index b1fbfc0..3d5d031 100644 --- a/SampleCustomTester.bss +++ b/SampleCustomTester.bss @@ -18,12 +18,12 @@ %END REM Option Public Option Declare -Use "./src/BaliTestRunner" +Use "./src/VoltScriptTesting" %REM Class DateTimeTester Description: Example a custom tests class %END REM -Private Class DateTimeTester As AbstractBaliCustomTester +Private Class DateTimeTester As AbstractCustomTester %REM Function runTests @@ -39,7 +39,7 @@ Private Class DateTimeTester As AbstractBaliCustomTester Me.testSuite.checkStarted - ' No custom before/after code, so no need to call BaliUnit.beforeEach and BaliUnit.afterEach + ' No custom before/after code, so no need to call TestSuite.beforeEach and TestSuite.afterEach dateTime = CDat("01/30/2022") print datatype(datetime) @@ -51,7 +51,7 @@ Private Class DateTimeTester As AbstractBaliCustomTester Call Me.testSuite.describe(|Check dateTime is before Now|).assertIsLessThan(Now(), CDbl(dateTime)) - ' Delete function of BaliUnit will run afterAll function + ' Delete function of TestSuite will run afterAll function End Function @@ -98,10 +98,10 @@ errCatch: End Class Sub Initialize - Dim BaliTestSuite As New BaliTestSuite(|DateTime Tests|) + Dim testSuite As New TestSuite(|DateTime Tests|) Dim DateTimeTester As New DateTimeTester - Call DateTimeTester.addTestSuite(BaliTestSuite).runTests() + Call DateTimeTester.addTestSuite(testSuite).runTests() End Sub diff --git a/TestBootstrap.bss b/TestBootstrap.bss index aff1e10..c2bf5ad 100644 --- a/TestBootstrap.bss +++ b/TestBootstrap.bss @@ -19,12 +19,12 @@ %END REM Option Public Option Declare -Use "./src/BaliTestRunner" +Use "./src/VoltScriptTesting" Sub Initialize - Dim testRunner As BaliTestRunner + Dim testRunner As TestRunner Dim results As Integer - Set testRunner = New BaliTestRunner(|ENTER NAME|) + Set testRunner = New TestRunner(|ENTER NAME|) ' BEGIN CODE HERE Call test(testRunner) @@ -35,9 +35,9 @@ End Sub Function **UPDATE NAME** Description: unit tests for **ADD DESCRIPTION** %END REM -Function test(testRunner As BaliTestRunner) As Boolean +Function test(testRunner As TestRunner) As Boolean - Dim testSuite As New BaliTestSuite(|**UPDATE NAME**|) + Dim testSuite As New TestSuite(|**UPDATE NAME**|) Call testRunner.addTestSuite(testSuite) diff --git a/atlas.json b/atlas.json index c8f570f..c2d26d0 100644 --- a/atlas.json +++ b/atlas.json @@ -1,7 +1,7 @@ { "name": "Bali-Unit", - "displayName": "BaliUnit", - "description": "Bali Unit Testing", + "displayName": "VoltScriptTesting", + "description": "VoltScript Testing", "library": "bali-unit", "license": "Apache 2.0", "version": "1.0.0", @@ -9,13 +9,13 @@ "Paul Withers" ], "publisher": "HCL America, Inc.", - "repo": "https://github01.hclpnp.com/hcl-janus/bali-unit.git", + "repo": "https://github.com/openntf/bali-unit.git", "sourceDir": "src", "testDir": "test", "libsDir": "", "lsxsDir": "", "mainScripts": [ - "BaliTestRunner.bss" + "VoltScriptTesting.bss" ], "unitTestScripts": [ "BasicTester.bss" diff --git a/test/BasicTester.bss b/test/BasicTester.bss index 1274293..637797e 100644 --- a/test/BasicTester.bss +++ b/test/BasicTester.bss @@ -14,7 +14,7 @@ %REM Agent BasicTester Created Mar 14, 2022 by Paul Withers/UK/PNPHCL - Description: Tests core functionality of a BaliUnit, no custom tester, no before/after code + Description: Tests core functionality of a TestSuite, no custom tester, no before/after code %END REM Option Public Option Declare @@ -217,7 +217,7 @@ Sub testVariants(runner As TestRunner) End Sub %REM Sub testBooleansAndStrings - Description: Tests BaliUnit against booleans and strings + Description: Tests VoltScriptTesting against booleans and strings %END REM Sub testBooleansAndStrings(runner As TestRunner) Dim testSuite As New TestSuite(|Boolean and String Tests|)