LotusScript Developer Layer (ls-dl)

Error handling, logging, tracing and unit testing in Lotus Script. Easy, flexible, extensible.

Registering module (library, agent, form,...) name

Important is to register your library, agent, etc in the system to let properly show stack trace, control logging level and do correct tracing. Just do it in "Sub Initialize()" of every module.

	registerModule "YOURMODULENAME"

Error handling

Sub test()
	On Error GoTo catch
	
	'...
	
	GoTo finally
catch:
	throwException
finally:
End Sub

For use in a class - inherit your class from class "Throwable".

Tracing

Sub test()
	traceIn
	On Error GoTo catch
	
	'...
	
	GoTo finally
catch:
	traceOut
	throwException
finally:
	traceOut
End Sub

For use in a class - inherit your class from class "Traceable".

Logging

	logAssert ""
	logError ""
	logWarn ""
	logInfo ""
	logDebug ""
	logVerbose ""

For use in a class - inherit your class from class "Loggable".

Logging provides an interface to send messages to an abstract receiver-Logger. Such a receiver could be:

your existing log storage - you just need to implement a wrapper
status bar - see libLoggerPrint in extentions folder
log.nsf
a file in the file system
java console - unfortunately is buggy as of 9.0.1 FP6 and fails in a complex application (crashes when one agent calls another), but still can be used for testing in some cases during development phase
...

Idea for improvement - implement dynamic switch of Loggers from the UI. I.e. when debugging on a user's client with few clicks, without modifying the code, change Logger to another one as well as logging levels for this particular user to needed ones.

Another idea for improvement - implement logging in a format that is supported by log analysers.

Unit testing

To test your library (UI on Client):

Create a button in your Toolbar with code: @Command([RunAgent]; "agUnitsTester" ). Select your Notes application and use this button when you want to start unit testing.
For every library you want to test create a unit test library with same name as your library + "Test" at end.
Use libTestCase and your library in test library.
Create class with same name as your test library. Inherit this class from "TestCase" class.
Override method "runTest()" in your test class.
For every functionality/routine you want to test create a "testXXX" method. Call all these methods from "runTest".

Library: YOURLIBTest

Use "libTestCase"
Use "YOURLIB"
Class YOURLIBTest As TestCase
	'------------------------------
	Private Function runTest() As Variant
		Call testYOURFUNCTION()
		Call testYOURFUNCTION1()
	End Function
	'------------------------------
	Private Sub testYOURFUNCTION()
		Call assertStringEquals( {123}, YOURFUNCTION( 456 ) )
	End Sub
	'------------------------------
	Private Sub testYOURFUNCTION1()
		Call assertIsNotNothing( YOURFUNCTION1() )
		Call assertTrue( Not YOURFUNCTION1() Is Nothing )
	End Sub
	'------------------------------
End Class

Unit testing passed: