A unit test framework for AutoHotkey
In a terminal or command line navigated to your project folder:
npm install unit-testing.ahkIn your code:
#Include %A_ScriptDir%\node_modules
#Include unit-testing.ahk\export.ahk
assert := new unittesting.ahk
testVar := 2 + 2
assert.equal(testVar, 4)
assert.fullReport()You may also review or copy the library from ./export.ahk on GitHub; #Include as you would normally when manually downloading.
Grants access to a class named unittesting with the following methods: .equal, .notEqual, .true, .false, .label, .group, .report, .fullReport, and .writeTestResultsToFile
assert := new unittesting()
; .equal checks and logs whether or not both arguments are the same
assert.label("string comparison")
assert.equal("StringExample", "StringExample")
assert.label("value testing")
assert.equal((1 > 0 ), true)
assert.label("true/false testing")
assert.true((1 == 1))
assert.false((1 != 1))
assert.notEqual(true,false)
assert.report()
assert.fullReport()
assert.writeTestResultsToFile()Alias: .test
checks if actual and expected are the same or equal. The comparison is case-insensitive when ahk is inStringCaseSense, Off (default ahk behavior)
- actual (*): The actual value computed
- expected (*): The expected value
(boolean): returns true if the values were the same, else false
assert.equal("string", "tsring")
; => false
assert.equal((1 > 0 ), true)
; => truechecks if actual value is true.
- actual (*): The actual value computed
(boolean): returns true if the value is true, else false
assert.true((1 == 1))
; => true
assert.true(InStr("String", "S"))
; => truechecks if actual value is false.
- actual (*): The actual value computed
(boolean): returns true if the value is false, else false
assert.false((1 != 1))
; => true
assert.false(InStr("String", "X"))
; => truechecks if actual and expected are NOT the same or equal. The comparison is case-insensitive when ahk is inStringCaseSense, Off (default ahk behavior)
- actual (*): The actual value computed
- expected (*): The expected value
(boolean): returns true if the value is false, else false
assert.notEqual((1 != 1))
; => true
assert.notEqual(InStr("String", "X"))
; => truechecks if actual is undefined ("").
- actual (*): The actual value computed
(boolean): returns true if the value is "", else false
assert.false((1 != 1))
; => true
assert.false(InStr("String", "X"))
; => truelabels the following tests for logs and readability
- label (string): A human readable label for the next test(s) in sequence
assert.label("string comparisons")
assert.equal("String", "s")
assert.fullReport()
/*---------------------------
1 tests completed with 0% success (1 failure)
=================================
== string comparisons ==
Test Number: 1
Expected: s
Actual: String
---------------------------*/appends the label to a group of following tests for logs and readability
This may be useful when one has a lot of tests; and doesn't want to type out a repeatative label
- label (string): A human readable label prepend for the next test(s) in sequence
assert.group("strings")
assert.label("comparison")
assert.equal("String", "s")
assert.label("length")
assert.equal(strLen("String"), 9)
assert.fullReport()
/*---------------------------
2 tests completed with 0% success (2 failures)
=================================
== strings - comparisons ==
Test Number: 1
Expected: s
Actual: String
== strings - length ==
Test Number: 2
Expected: 99
Actual: 6
---------------------------*/Uses msgbox to display the results of all tests
assert.true(InStr("String", "S"))
assert.report()
/*---------------------------
1 test completed with 100% success
---------------------------*/Uses msgbox to display the results of all tests with details of any failures
assert.true(InStr("String", "X"))
assert.fullReport()
/*---------------------------
1 tests completed with 0% success (1 failure)
=================================
Test Number: 1
Expected: true
Actual: false
---------------------------*/writes test results to a file
-
filepath (string): Optional, The file path to write all tests results to, the default is
A_ScriptDir "\result.tests.log" -
fileopen (bool): Optional, Open the file if true. Default: false
assert.true(InStr("String", "X"))
assert.writeTestResultsToFile()
/*
1 test completed with 0% success (1 failure)
Test Number: 1
Expected: true
Actual: false*/
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent