Hi Chunjee,
As promised some further observations which I've gone ahead and added these to a copy of export.ahk that I downloaded on 02-Apr-24:
Code: Select all
class expect {
__New() {
this.testTotal := 0
this.failTotal := 0
this.successTotal := 0
this.log := []
this.groupVar := ""
this.labelVar := ""
this.lastlabel := ""
this.finalTrigger := false
;;Q8 Added so output can identify what each test was (equal, undefined, etc)
this.TestType := ""
}
/**
* checks if param_actual and param_expected inputs are the same or equal. The comparison is always case-sensitive.
* @param {number|string|object} param_actual - The actual value.
* @param {number|string|object} param_expected - The expected value.
* @param {string} param_note - (Optional) Additional notes for the test.
*
* @returns {boolean} Returns true if the values are equal, else false.
*
* @example expect.equal([1, 2, 3], [1, 2, 3])
*
* @alias .test
* @example
* ### Example usage
* You can use like so:
* ```autohotkey
* expect.equal(inStr("String", "ing"), 4)
* ```
*/
equal(param_actual:="_Missing_Parameter_", param_expected:="_Missing_Parameter_", param_note:="") {
if (A_IsCompiled) {
return 0
}
; create
;;Q8a
this.TestType := "equal"
return this.test(param_actual, param_expected, param_note)
}
/**
* checks if actual and expected inputs are NOT the same or equal. The comparison is always case-sensitive.
* @param {number|string|object} param_actual - The actual value computed.
* @param {number|string|object} param_expected - The expected value.
* @param {string} param_note - Additional notes for the test (Optional).
*
* @returns {boolean} Returns true if the values are different, else false.
*
* @example expect.notEqual({ "a":1 }, { "a":false })
*/
notEqual(param_actual:="_Missing_Parameter_", param_expected:="_Missing_Parameter_", param_note:="") {
if (A_IsCompiled) {
return 0
}
if (param_note == "" && this.lastlabel == "") {
param_note := "Expected to be different"
}
; prepare
param_actual := this._print(param_actual)
param_expected := this._print(param_expected)
; create
;;Q8b
this.TestType := "notEqual"
this.testTotal += 1
if (param_actual != param_expected) {
this.successTotal++
return true
} else {
this._logTestFail(param_actual, param_expected, param_note)
return false
}
}
/**
* checks if actual and expected inputs are the same or equal. The comparison is always case-sensitive.
* @param {number|string|object} param_actual - The actual value computed.
* @param {number|string|object} param_expected - The expected value.
* @param {string} param_note - Additional notes for the test (Optional).
* @returns {boolean} Returns true if the values are equal, else false.
*/
test(param_actual:="_Missing_Parameter_", param_expected:="_Missing_Parameter_", param_note:="") {
if (A_IsCompiled) {
return 0
}
; prepare
if (isObject(param_actual)) {
param_actual := this._print(param_actual)
}
if (isObject(param_expected)) {
param_expected := this._print(param_expected)
}
; create
this.testTotal++
if (param_actual == param_expected) {
this._stdOut("ok " this.testTotal)
this.successTotal++
return true
} else {
this._logTestFail(param_actual, param_expected, param_note)
return false
}
}
/**
* checks if actual value is true.
* @param {number|string} param_actual - The actual value computed.
* @param {string} param_note - Additional notes for the test (Optional).
*
* @returns {boolean} Returns true if the values are different, else false.
*
* @example expect.true((1 == 1))
*/
true(param_actual:="_Missing_Parameter_", param_note:="") {
if (A_IsCompiled) {
return 0
}
; create
;;Q8c
this.TestType := "true"
this.test(param_actual, true, param_note)
return false
}
/**
* checks if actual input is false.
* @param {number|string|object} param_actual - The actual value computed.
* @param {string} param_note - Additional notes for the test (Optional).
*
* @returns {boolean} returns true if the value is false, else false
*
* @example expect.false((99 < 3))
*/
false(param_actual:="_Missing_Parameter_", param_note:="") {
if (A_IsCompiled) {
return 0
}
; create
;;Q8d
this.TestType := "false"
if (param_actual == false) {
this.test("false", "false", param_note)
return true
}
if (param_actual == true){
this.test("true", "false", param_note)
return false
}
this.test(param_actual, "true", param_note)
return false
}
/**
* checks if actual is undefined (`""`).
* @param {number|string} param_actual - The actual value computed.
* @param {string} param_note - Additional notes for the test (Optional).
*
* @returns {boolean} returns true if the value is `""`, else false
*
* @example expect.undefined("")
*/
undefined(param_actual:="_Missing_Parameter_", param_note:="") {
if (A_IsCompiled) {
return 0
}
; create
;;Q8e
this.TestType := "undefined"
this.test(param_actual, "", param_note)
return false
}
/**
* appends the label to a group of following tests for logs and readability
* @param {string} param_label - A human readable label prepend for the next test(s) in sequence
*
* @example expect.group("Object Tests")
*/
group(param_label) {
if (A_IsCompiled) {
return 0
}
this.groupVar := param_label
this.labelVar := ""
this.lastlabel := "_"
this._stdOut("# " param_label)
return
}
/**
* labels the following tests for logs and readability
* @param {string} param_label - A human readable label for the next test(s) in sequence
*
* @example expect.label("myInterestingLabel")
*/
label(param_label) {
if (A_IsCompiled) {
return 0
}
this.labelVar := param_label
return
}
_buildReport() {
if (A_IsCompiled) {
return 0
}
; create
this.percentsuccess := floor( ( this.successTotal / this.testTotal ) * 100 )
returntext := this.testTotal " tests completed with " this.percentsuccess "% success (" this.failTotal " failures)"
if (this.failTotal = 1) {
returntext := strReplace(returntext, "failures", "failure")
}
if (this.testTotal = 1) {
returntext := strReplace(returntext, "tests", "test")
}
;;Q2b I've added underlining here and commented out in the 1 other place.
;;So the underlining is added to both the messagebox and output to file.
;;Add underlining to report top line.
returntext .= "`n=================================`n"
return returntext
}
_final() {
if (A_IsCompiled) {
return 0
}
; create
;;Q5 Code suggests this produces the 1-line test summary report to stdOut.
;;I don't understand why the stdout output needs to have hard coded
;;"1.." or "# "! So I've commented these out, but left the generation
;;of the 1-line test summary in.
;this._stdOut("1.." this.testTotal)
;this._stdOut("# " this._buildReport())
this.finalTrigger := true
return true
}
_logTestFail(param_actual, param_expected, param_msg:="") {
if (A_IsCompiled) {
return 0
}
; create
this.failTotal++
;;Q1 Commenting out the next 3 lines means that the test label
;;text is not replaced with the test note text.
;;if (param_msg != "") {
;; this.labelVar := param_msg
;;}
if (this.labelVar != this.lastlabel) {
this.lastlabel := this.labelVar
if (this.groupVar) {
this.log.push("== " this.groupVar " - " this.labelVar " ==")
} else {
this.log.push("== " this.labelVar " ==")
}
}
;;Q6 So if Label is not defined, make marker text for the output.
;;so it's visually easier to see each test.
else
this.log.push("== Label: ==")
;;Q7 Done a lot of 'fiddling' to improve the output.
;;I've made msg for stdout and a new msg1 for reporting in msgboxs and to file.
;;I've included a new var this.TestType - see Q8
;msg := "not ok " this.testTotal " - " this.labelVar "`n"
msg := "Test " this.testTotal " not ok (""" this.labelVar """)`n"
msg1 := "This (should be " this.TestType ") test failed`n"
msg .= " Should be: " this.TestType "`n"
;;Q7 I cant see what this adds. So removed to declutter output.
;msg .= " ---`n"
msg .= " Expected: " param_expected "`n"
msg1 .= " Expected: " param_expected "`n"
msg .= " Got: " param_actual "`n"
msg1 .= " Got: " param_actual "`n"
;;Q7 I cant see what this adds. So removed to declutter output.
;msg .= " ..."
;;Q7
if (param_msg != "")
{
msg .= " Note: " param_msg "`n"
msg1 .= " Note: " param_msg "`n"
}
this._stdOut(msg)
this.log.push(msg1)
}
_print(param_value) {
if (isObject(param_value)) {
for key, value in param_value {
if key is not number
{
output .= """" . key . """:"
} else {
output .= key . ":"
}
if (isObject(value)) {
output .= "[" . this._print(value) . "]"
} else if value is not number
{
output .= """" . value . """"
}
else {
output .= value
}
output .= ", "
}
return subStr(output, 2)
}
return param_value
}
_stdOut(output:="") {
try {
fileAppend, % output, *
} catch error {
return false
}
return true
}
/**
* Writes the report to a file and optionally opens the file.
* @param {string} param_filepath - The path of the file where the report will be written. If not provided, the default logResultPath will be used.
* @throws {exception} If there is an error writing the report to the disk.
*
* @returns {string} The report that was written to the file.
*
* @example expect.writeResultsToFile(".\myLogFile.tap")
*/
writeResultsToFile(param_filepath:=".\result.tests.log") {
if (A_IsCompiled) {
return 0
}
; prepare
if (subStr(param_filepath, 1, 2) == ".\") {
param_filepath := A_WorkingDir subStr(param_filepath, 2)
}
; create
try {
fileDelete, % param_filepath
} catch {
; do nothing
}
msgReport := this._buildReport() "`n"
;;Q3 this.logObj doesn't exist so no output written to file.
;;But this.log does exist and produces output for writing to file.
;;for key, value in this.logObj {
for key, value in this.log {
msgReport .= value "`n"
}
fileAppend, % msgReport, % param_filepath
if (errorlevel == 1) {
throw exception("Failed to write report to disk")
}
return msgReport
}
/**
* returns the full test results. This should be used with to integrate with Continuous Integration (CI) Systems
* @param {}
*
* @returns {string} returns a string containing all the test results.
*
* @example expect.report()
*/
report() {
if (A_IsCompiled) {
return 0
}
; create
if (!this.finalTrigger) {
this._final()
}
;;Q4 This method does nothing - according to the docs is supposed to produce a
;;msgbox with a 1-line summary of all the test results.
;;So have added msgbox code and commented out the return options as this is no longer needed.
;;Note this 'block' is same as in fullReport() apart from var name
;;of text to output. So could potentially be made into an internal method.
; choose the msgbox icon
if (this.failTotal > 0)
l_options := 48
else
l_options := 64
msgbox, % l_options, expect.ahk, % this._buildReport()
;;Q4 return this._buildReport()
}
/**
* Uses msgbox to display the results of all tests with details of any failures
* @param {}
*
* @returns {string} The generated full report message.
*
* @example expect.fullReport()
*/
fullReport() {
if (A_IsCompiled) {
return 0
}
; create
if (!this.finalTrigger) {
this._final()
}
msgReport := this._buildReport()
if (this.failTotal > 0) {
;;Q2a Commented this out as have added it to the _buildReport.
;;msgReport .= "================================="
loop % this.log.Count() {
msgReport .= "`n" this.log[A_Index]
}
}
; choose the msgbox icon
if (this.failTotal > 0) {
l_options := 48
} else {
l_options := 64
}
msgbox, % l_options, expect.ahk, % msgReport
return msgReport
}
;; end of expect.ahk
}
Each code difference has
;;Qn added to the code to describe the change in more detail. Each of these are also described below:
;;Q1 Commenting out the next 3 lines means that the test label text is not replaced with the test note text.
;;Q2 Changes to the underlining of the 1-line summary of tests constructed in
this._buildReport().
;;Q2a Commented the underlining out here as have added it to
_buildReport.
;;Q2b I've added underlining here and commented out in the 1 other place. So the underlining is added to both the msgbox and output to file.
;;Q3 this.logObj doesn't exist so no output written to file. But
this.log does exist and produces output for writing to file.
;;Q4 .report() does nothing - according to the docs is supposed to produce a msgbox with a 1-line summary of all the test results. So have added msgbox code and commented out the return options as this is no longer needed. (Note this 'block' is same as in
.fullReport() apart from var name of text to output. So could potentially be made into an internal method).
;;Q5 Code suggests
_report() produces the 1-line test summary report to
stdOut. But I don't understand why the stdout output needs to have hard coded "1.." or "# ". So I've commented these out, but left the generation of the 1-line test summary in.
;;Q6 By adding this code if a test in this class is called without a
.label(), still add “== ===” in the place where the label would have been. If no labels at all are defined then adding this creates an improved visual demarking each test in the output. If some, but not all, tests use labels, then adding this means all tests are demarked thus, rather than a mix of some with and some without.
;;Q7 Done a lot of 'fiddling' to improve the output. I've made
msg apply to stdout and a new
msg1 for reporting in msgboxs and to file. I've included a new var
this.TestType - see Q8. Also added
param_msg to the output when it exists.
;;Q8 Added
this.TestType so output can identify what each test was (equal, undefined, etc).
Hopefully I haven't busted any functionality or rode rough-shot over what you'd been working towards as output.
Look forward to hearing what you think in due course.
