Feature/mocha test reporter

bsc-plugin/src/cli.ts

@@ -65,8 +65,8 @@ async function main() {
     await telnet.activate();
     await telnet.connect();
 
-    const failRegex = /RESULT: Fail/g;
-    const endRegex = /\[END TEST REPORT\]/g;
+    const failRegex = /\[Rooibos Result\]: (FAIL|PASS)/g;
+    const endRegex = /\[Rooibos Shutdown\]/g;
 
     async function doExit(emitAppExit = false) {
         if (emitAppExit) {
@@ -82,7 +82,9 @@ async function main() {
         //check for Fails or Crashes
         let failMatches = failRegex.exec(output);
         if (failMatches && failMatches.length > 0) {
-            currentErrorCode = 1;
+            if (failMatches[1] === 'FAIL') {
+                currentErrorCode = 1;
+            }
         }
 
         let endMatches = endRegex.exec(output);

bsc-plugin/src/lib/rooibos/Annotation.ts

@@ -1,5 +1,5 @@
 import type { AnnotationExpression, BrsFile, Statement } from 'brighterscript';
-import { diagnosticIllegalParams, diagnosticNoTestNameDefined, diagnosticMultipleDescribeAnnotations, diagnosticMultipleTestOnFunctionDefined } from '../utils/Diagnostics';
+import { diagnosticIllegalParams, diagnosticNoTestNameDefined, diagnosticMultipleDescribeAnnotations, diagnosticMultipleTestOnFunctionDefined, diagnosticSlowAnnotationRequiresNumber } from '../utils/Diagnostics';
 
 export enum AnnotationType {
     None = 'none',
@@ -9,6 +9,7 @@ export enum AnnotationType {
     Ignore = 'ignore',
     Solo = 'only',
     NodeTest = 'sgnode',
+    Slow = 'slow',
     Setup = 'setup',
     TearDown = 'teardown',
     BeforeEach = 'beforeeach',
@@ -30,6 +31,7 @@ let annotationLookup = {
     only: AnnotationType.Solo,
     sgnode: AnnotationType.NodeTest,
     setup: AnnotationType.Setup,
+    slow: AnnotationType.Slow,
     teardown: AnnotationType.TearDown,
     beforeeach: AnnotationType.BeforeEach,
     aftereach: AnnotationType.AfterEach,
@@ -47,6 +49,8 @@ interface ParsedComment {
     testAnnotation?: RooibosAnnotation;
 }
 
+const defaultSlowDuration = 75;
+
 export class AnnotationParams {
 
     constructor(
@@ -82,7 +86,8 @@ export class RooibosAnnotation {
         public nodeName?: string,
         rawTags: string[] = [],
         public noCatch = false,
-        public noEarlyExit = false
+        public noEarlyExit = false,
+        public slow = defaultSlowDuration
     ) {
         this.tags = new Set<string>(rawTags);
     }
@@ -192,6 +197,20 @@ export class RooibosAnnotation {
                         //error
                     }
                 }
+
+                for (const annotation of getAnnotationsOfType(AnnotationType.Slow)) {
+                    if (testAnnotation) {
+                        let slow = annotation.getArguments().length === 1 ? parseInt(annotation.getArguments()[0] as any) : defaultSlowDuration;
+                        if (isNaN(slow)) {
+                            diagnosticSlowAnnotationRequiresNumber(file, annotation);
+                            testAnnotation.slow = defaultSlowDuration;
+                        } else {
+                            testAnnotation.slow = slow;
+                        }
+                    } else {
+                        //error
+                    }
+                }
             }
         }
         return { blockAnnotation: blockAnnotation, testAnnotation: testAnnotation };

bsc-plugin/src/lib/rooibos/CodeCoverageProcessor.spec.ts

@@ -67,8 +67,8 @@ describe('RooibosPlugin', () => {
             it('adds code coverage to a brs file', async () => {
                 program.setFile('source/code.brs', `
                     function new(a1, a2)
-                    c = 0
-                    text = ""
+                        c = 0
+                        text = ""
                         for i = 0 to 10
                             text = text + "hello"
                             c++

bsc-plugin/src/lib/rooibos/CodeCoverageProcessor.ts

@@ -56,6 +56,7 @@ export class CodeCoverageProcessor {
     private coverageMap: Map<number, number>;
     private fileFactory: FileFactory;
     private processedStatements: Set<Statement>;
+    private addedStatements: Set<Statement>;
     private astEditor: Editor;
 
     public generateMetadata(isUsingCoverage: boolean, program: Program) {
@@ -74,6 +75,7 @@ export class CodeCoverageProcessor {
         this.coverageMap = new Map<number, number>();
         this.executableLines = new Map<number, Statement>();
         this.processedStatements = new Set<Statement>();
+        this.addedStatements = new Set<Statement>();
         this.astEditor = astEditor;
 
         file.ast.walk(createVisitor({
@@ -167,21 +169,25 @@ export class CodeCoverageProcessor {
     }
 
     private convertStatementToCoverageStatement(statement: Statement, coverageType: CodeCoverageLineType, owner: any, key: any) {
-        if (this.processedStatements.has(statement)) {
+        if (this.processedStatements.has(statement) || this.addedStatements.has(statement)) {
             return;
         }
 
         const lineNumber = statement.range.start.line;
         this.coverageMap.set(lineNumber, coverageType);
         const parsed = Parser.parse(this.getFuncCallText(lineNumber, coverageType)).ast.statements[0] as ExpressionStatement;
         this.astEditor.arraySplice(owner, key, 0, parsed);
+        this.addedStatements.add(parsed);
         // store the statement in a set to avoid handling again after inserting statement above
         this.processedStatements.add(statement);
     }
 
     public addBrsAPIText(file: BrsFile, astEditor: Editor) {
         const astCodeToInject = Parser.parse(this.coverageBrsTemplate.replace(/\#ID\#/g, this.fileId.toString().trim())).ast.statements;
         astEditor.arrayPush(file.ast.statements, ...astCodeToInject);
+        for (let statement of astCodeToInject) {
+            this.addedStatements.add(statement);
+        }
     }
 
     private addStatement(statement: Statement, lineNumber?: number) {

bsc-plugin/src/lib/rooibos/RawCodeExpression.ts

@@ -16,6 +16,10 @@ export class RawCodeExpression extends Expression {
         super();
     }
 
+    public clone() {
+        return new RawCodeExpression(this.source, this.sourceFile, this.range);
+    }
+
     public transpile(state: BrsTranspileState) {
         return [new SourceNode(
             this.range.start.line + 1,

bsc-plugin/src/lib/rooibos/RawCodeStatement.ts

@@ -21,6 +21,10 @@ export class RawCodeStatement extends Statement {
         super();
     }
 
+    public clone() {
+        return new RawCodeStatement(this.source, this.sourceFile, this.range);
+    }
+
     public transpile(state: BrsTranspileState) {
         //indent every line with the current transpile indent level (except the first line, because that's pre-indented by bsc)
         let source = this.source.replace(/\r?\n/g, (match, newline) => {

bsc-plugin/src/lib/rooibos/RooibosConfig.ts

@@ -22,6 +22,7 @@ export interface RooibosConfig {
     includeFilters?: string[];
     tags?: string[];
     catchCrashes?: boolean;
+    colorizeOutput?: boolean;
     throwOnFailedAssertion?: boolean;
     sendHomeOnFinish?: boolean;
 

bsc-plugin/src/lib/rooibos/RooibosSession.ts

@@ -146,6 +146,7 @@ export class RooibosSession {
                         "printLcov": ${this.config.printLcov ? 'true' : 'false'}
                         "port": "${this.config.port || 'invalid'}"
                         "catchCrashes": ${this.config.catchCrashes ? 'true' : 'false'}
+                        "colorizeOutput": ${this.config.colorizeOutput ? 'true' : 'false'}
                         "throwOnFailedAssertion": ${this.config.throwOnFailedAssertion ? 'true' : 'false'}
                         "keepAppOpen": ${this.config.keepAppOpen === undefined || this.config.keepAppOpen ? 'true' : 'false'}
                         "isRecordingCodeCoverage": ${this.config.isRecordingCodeCoverage ? 'true' : 'false'}
@@ -174,6 +175,7 @@ export class RooibosSession {
         switch (name.toLowerCase()) {
             case 'console': return 'rooibos_ConsoleTestReporter';
             case 'junit': return 'rooibos_JUnitTestReporter';
+            case 'mocha': return 'rooibos_MochaTestReporter';
         }
         // @todo: check if function name is valid
         return name;

bsc-plugin/src/lib/rooibos/RooibosSessionInfo.ts

@@ -77,7 +77,7 @@ export class SessionInfo {
             } else if (this.hasSoloSuites && !testSuite.isSolo) {
                 testSuite.isIncluded = false;
             } else if (testSuite.isIgnored) {
-                testSuite.isIncluded = false;
+                testSuite.isIncluded = true;
                 this.ignoredTestNames.push(testSuite.name + ' [WHOLE SUITE]');
                 this.ignoredCount++;
             } else {
@@ -88,62 +88,73 @@ export class SessionInfo {
             }
             //'testSuite  ' + testSuite.name);
             for (let testGroup of testSuite.getTestGroups()) {
+                if (testSuite.isIgnored) {
+                    testGroup.isIgnored = true;
+                }
 
                 //'GROUP  ' + testGroup.name);
                 if (testGroup.isIgnored) {
                     this.ignoredCount += testGroup.ignoredTestCases.length;
                     this.ignoredTestNames.push(testGroup.name + ' [WHOLE GROUP]');
-                    testGroup.isIncluded = false;
-                } else {
-                    if (testGroup.ignoredTestCases.length > 0) {
-                        this.ignoredTestNames.push(testGroup.name);
-                        this.ignoredCount += testGroup.ignoredTestCases.length;
-                        for (let ignoredTestCase of testGroup.ignoredTestCases) {
-                            if (!ignoredTestCase.isParamTest) {
-                                this.ignoredTestNames.push(ignoredTestCase.name);
-                            } else if (ignoredTestCase.paramTestIndex === 0) {
-                                let testCaseName = ignoredTestCase.name;
-                                if (testCaseName.length > 1 && testCaseName.substr(testCaseName.length - 1) === '0') {
-                                    testCaseName = testCaseName.substr(0, testCaseName.length - 1);
-                                }
-                                this.ignoredTestNames.push(testCaseName);
+                    testGroup.isIncluded = true;
+                }
+
+                if (testGroup.ignoredTestCases.length > 0) {
+                    this.ignoredTestNames.push(testGroup.name);
+                    this.ignoredCount += testGroup.ignoredTestCases.length;
+                    for (let ignoredTestCase of testGroup.ignoredTestCases) {
+                        if (!ignoredTestCase.isParamTest) {
+                            this.ignoredTestNames.push(ignoredTestCase.name);
+                        } else if (ignoredTestCase.paramTestIndex === 0) {
+                            let testCaseName = ignoredTestCase.name;
+                            if (testCaseName.length > 1 && testCaseName.substr(testCaseName.length - 1) === '0') {
+                                testCaseName = testCaseName.substr(0, testCaseName.length - 1);
                             }
+                            this.ignoredTestNames.push(testCaseName);
                         }
                     }
-                    if (this.isExcludedByTag(testGroup, true)) {
-                        testGroup.isIncluded = false;
-                    } else if (this.hasSoloTests && !testGroup.hasSoloTests) {
-                        testGroup.isIncluded = false;
-                    } else if (this.hasSoloGroups && !testGroup.isSolo) {
-                        testGroup.isIncluded = false;
-                    } else {
-                        testGroup.isIncluded = true;
+                }
+                if (this.isExcludedByTag(testGroup, true)) {
+                    testGroup.isIncluded = false;
+                } else if (this.hasSoloTests && !testGroup.hasSoloTests) {
+                    testGroup.isIncluded = false;
+                } else if (this.hasSoloGroups && !testGroup.isSolo) {
+                    testGroup.isIncluded = false;
+                } else {
+                    testGroup.isIncluded = true;
+                }
+
+                if (testGroup.isIncluded) {
+                    this.groupsCount++;
+                    let testCases = [...testGroup.testCases.values()];
+
+                    for (let testCase of testCases) {
+                        if (testGroup.isIgnored) {
+                            testCase.isIgnored = true;
+                        }
+
+                        if (this.isExcludedByTag(testCase, true)) {
+                            testCase.isIncluded = false;
+                        } else if (testCase.isIgnored) {
+                            testCase.isIncluded = true;
+                        } else if (this.hasSoloTests && !testCase.isSolo) {
+                            testCase.isIncluded = false;
+                        } else {
+                            testCase.isIncluded = testGroup.isIncluded || testCase.isSolo;
+                        }
                     }
 
-                    if (testGroup.isIncluded) {
-                        this.groupsCount++;
-                        let testCases = [...testGroup.testCases.values()];
-
-                        for (let testCase of testCases) {
-                            if (this.isExcludedByTag(testCase, true)) {
-                                testCase.isIncluded = false;
-                            } else if (testCase.isIgnored) {
-                                testCase.isIncluded = false;
-                            } else if (this.hasSoloTests && !testCase.isSolo) {
-                                testCase.isIncluded = false;
-                            } else {
-                                testCase.isIncluded = testGroup.isIncluded || testCase.isSolo;
-                                this.testsCount++;
-                            }
+                    for (let testCase of testGroup.soloTestCases) {
+                        if (this.isExcludedByTag(testCase, true)) {
+                            testCase.isIncluded = false;
+                        } else {
+                            testCase.isIncluded = true;
                         }
+                    }
 
-                        for (let testCase of testGroup.soloTestCases) {
-                            if (this.isExcludedByTag(testCase, true)) {
-                                testCase.isIncluded = false;
-                            } else {
-                                testCase.isIncluded = true;
-                                this.testsCount++;
-                            }
+                    for (let testCase of testCases) {
+                        if (testCase.isIncluded) {
+                            this.testsCount++;
                         }
                     }
                 }

bsc-plugin/src/lib/rooibos/TestCase.ts

@@ -8,13 +8,13 @@ export class TestCase {
         this.isSolo = isSolo;
         this.isAsync = annotation.isAsync;
         this.asyncTimeout = annotation.asyncTimeout;
+        this.slow = annotation.slow;
         this.funcName = funcName;
         this.isIgnored = isIgnored;
         this.name = name;
         this.lineNumber = lineNumber;
         this.paramLineNumber = paramLineNumber;
         this.assertIndex = 0;
-        this.assertLineNumberMap = {};
         this.rawParams = params;
         this.expectedNumberOfParams = expectedNumberOfParams;
         this.paramTestIndex = paramTestIndex;
@@ -30,12 +30,12 @@ export class TestCase {
     public isParamTest: boolean;
     public isAsync: boolean;
     public asyncTimeout: number;
+    public slow: number;
     public name: string;
     public lineNumber: number;
     public paramLineNumber: number;
     public assertIndex: number;
     public expectedNumberOfParams: number;
-    public assertLineNumberMap: any;
     public rawParams: any[];
     public paramTestIndex: number;
 
@@ -50,24 +50,19 @@ export class TestCase {
           isIgnored: ${this.isIgnored}
           isAsync: ${this.isAsync}
           asyncTimeout: ${this.asyncTimeout || 2000}
+          slow: ${this.slow}
           isParamTest: ${this.isParamTest}
           name: ${sanitizeBsJsonString(this.name)}
-          lineNumber: ${this.lineNumber + 2}
-          paramLineNumber: ${this.paramLineNumber}
+          lineNumber: ${this.lineNumber + 1}
+          paramLineNumber: ${this.isParamTest ? this.paramLineNumber + 1 : 0}
           assertIndex: ${this.assertIndex}
-          assertLineNumberMap: ${JSON.stringify(this.assertLineNumberMap)}
           rawParams: ${rawParamsText}
           paramTestIndex: ${this.paramTestIndex}
           expectedNumberOfParams: ${this.expectedNumberOfParams}
           isParamsValid: ${(this.rawParams || []).length === this.expectedNumberOfParams}
         }`;
     }
 
-    public addAssertLine(lineNumber: number) {
-        this.assertLineNumberMap[this.assertIndex.toString().trim()] = lineNumber;
-        this.assertIndex++;
-    }
-
     fixBadJson(o) {
         // In case of an array we'll stringify all objects.
         if (Array.isArray(o)) {

bsc-plugin/src/lib/rooibos/TestGroup.ts

@@ -32,6 +32,7 @@ export class TestGroup extends TestBlock {
         if (testCase.isIgnored) {
             this.ignoredTestCases.push(testCase);
             this.hasIgnoredTests = true;
+            this.soloTestCases.push(testCase);
         } else if (testCase.isSolo) {
             this.hasSoloTests = true;
             this.soloTestCases.push(testCase);
@@ -78,7 +79,7 @@ export class TestGroup extends TestBlock {
                                     const trailingLine = Parser.parse(`if m.currentResult?.isFail = true then m.done() : return ${isSub ? '' : 'invalid'}`).ast.statements[0];
                                     editor.arraySplice(owner, key + 1, 0, trailingLine);
                                 }
-                                const leadingLine = Parser.parse(`m.currentAssertLineNumber = ${callExpression.range.start.line}`).ast.statements[0];
+                                const leadingLine = Parser.parse(`m.currentAssertLineNumber = ${callExpression.range.start.line + 1}`).ast.statements[0];
                                 editor.arraySplice(owner, key, 0, leadingLine);
                             }
                         }
@@ -220,7 +221,7 @@ export class TestGroup extends TestBlock {
                 isSolo: ${this.isSolo}
                 isIgnored: ${this.isIgnored}
                 filename: "${this.pkgPath}"
-                lineNumber: "${this.annotation.annotation.range.start.line}"
+                lineNumber: "${this.annotation.annotation.range.start.line + 1}"
                 setupFunctionName: "${this.setupFunctionName || ''}"
                 tearDownFunctionName: "${this.tearDownFunctionName || ''}"
                 beforeEachFunctionName: "${this.beforeEachFunctionName || ''}"