MapBasicUnit

An Unit Test System for MapBasic

MapBasic is language for automating MapInfo, which is a desktop GIS.

MapBasicUnit aims to give MapBasic developers a structured way of testing their code that can be automated.

Usage

1. Create a testrunner .mb file
2. Include the MapBasicUnit.mb
3. Include the .mb file that you want to test
4. Start writing unit test with assertions

Hopefully this process will be simplified in later versions

Create a testrunner .mb file

The basic testrunner:

Declare Sub Main

Sub Main
Print "-----------"
Print "new testrun." + Time(24)
Print "-----------"
End Sub

Save the file. The suggested naming convention is test_.mb.

Include the MapBasicUnit.mb

If MapBasicUnit is located in the same directory as the testrunner: Include "MapBasicUnit.mb"

Declare Sub Main

Sub Main
Print "-----------"
Print "new testrun." + Time(24)
Print "-----------"
End Sub

Include the .mb file that you want to test

If the .mb that you want to test is located in the same directory as the testrunner: Include "MapBasicUnit.mb" Include ".mb"

Declare Sub Main

Sub Main
Print "-----------"
Print "new testrun." + Time(24)
Print "-----------"
End Sub

Start writing unit test with assertions

Let's say that you have a mb file called Trim.mb with the following content:

Declare Function Trim(Byval word As String) As String

Function Trim(Byval word As String) As String
Trim = LTrim$(RTrim$(word))
End Function

Then you can write a unit test like this:

Include "Trim.mb"
Include "MapBasicUnit.mb"

Declare Sub Main

Sub Main
Print "-----------"
Print "new testrun." + Time(24)
Print "-----------"

Call AssertStringEqual("TestThatStringIsTrimmed", "trimmed string", Trim(" trimmed string  "))

End Sub

In MapInfo the Message window will show:

-----------
new testrun.22:09:07
-----------
Test: TestThatStringIsTrimmed has passed.

Features

The following assertions are currently available in the MapBasicUnit.mb:

(Call) AssertTrue(Byval testName As String, ByVal actual As Logical)
(Call) AssertStringEqual(Byval testName As String, Byval expected As String, Byval actual As String)
(Call) AssertIntegerEqual(Byval testName As String, Byval expected As Integer, Byval actual As Integer)
(Call) AssertSmallIntEqual(Byval testName As String, Byval expected As SmallInt, Byval actual As SmallInt)
(Call) AssertFloatEqual(Byval testName As String, Byval expected As Float, Byval actual As Float, Byval within As Float)

Assertions are always takes a testName argument for identification of the assertion. It is strongly recommended that the testName is unique.

AssertFloatEqual takes a within argument so that inaccuracies in the Float calculus can be accounted for.

Example:

Fails

Dim almostZero as Float
almostZero = (1.00000000000001 - 1) - 0.00000000000001
Call AssertFloatEqual("AssertFloatEqualFailsWhenRoundingIsTested", 0.0, almostZero, 0.0)

Passes

Dim almostZero as Float
almostZero = (1.00000000000001 - 1) - 0.00000000000001
Call AssertFloatEqual("AssertFloatEqualPassesWhenWithinRoundingNegativeIsTested", 0.0, almostZero, 0.000001)

Currently test runs are reported through the MapInfo message window, but this may be configurable in the future to enable writing test failures and passes to a file to allow integration with a continues integration system.