rooibos-roku 5.12.0 → 5.14.0

package/README.md

@@ -1,12 +1,12 @@
 <p align="center">
-  <img src="https://github.com/georgejecook/rooibos/raw/master/images/logo.png" alt="Rooibos test framework" width="200" height="200"/>
+  <img src="https://github.com/rokucommunity/rooibos/raw/master/images/logo.png" alt="Rooibos test framework" width="200" height="200"/>
 </p>
 
-[![build](https://img.shields.io/github/workflow/status/georgejecook/rooibos/build.svg?logo=github)](https://github.com/georgejecook/rooibos/actions?query=workflow%3Abuild)
-[![GitHub](https://img.shields.io/github/release/georgejecook/rooibos.svg?style=flat-square)](https://github.com/georgejecook/rooibos/releases)
+[![build](https://img.shields.io/github/workflow/status/rokucommunity/rooibos/build.svg?logo=github)](https://github.com/rokucommunity/rooibos/actions?query=workflow%3Abuild)
+[![GitHub](https://img.shields.io/github/release/rokucommunity/rooibos.svg?style=flat-square)](https://github.com/rokucommunity/rooibos/releases)
 [![NPM Version](https://badge.fury.io/js/rooibos-roku.svg?style=flat)](https://npmjs.org/package/rooibos-roku)
 
 ## Links
- - **[Documentation](https://github.com/georgejecook/rooibos/blob/master/docs/index.md)**
- - **[API Documentation](https://georgejecook.github.io/rooibos)**
+ - **[Documentation](https://github.com/rokucommunity/rooibos/blob/master/docs/index.md)**
+ - **[API Documentation](https://rokucommunity.github.io/rooibos)**
  - \#roku channel on the [roku developer's slack](https://join.slack.com/t/rokudevelopers/shared_invite/enQtMzgyODg0ODY0NDM5LTc2ZDdhZWI2MDBmYjcwYTk5MmE1MTYwMTA2NGVjZmJiNWM4ZWY2MjY1MDY0MmViNmQ1ZWRmMWUzYTVhNzJiY2M)

package/dist/cli.js

@@ -0,0 +1,109 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const roku_debug_1 = require("roku-debug");
+const brighterscript_1 = require("brighterscript");
+const yargs = require("yargs");
+const roku_deploy_1 = require("roku-deploy");
+const fs = require("fs");
+let options = yargs
+    .usage('$0', 'Rooibos: a simple, flexible, fun Brightscript test framework for Roku Scenegraph apps')
+    .help('help', 'View help information about this tool.')
+    .option('project', { type: 'string', description: 'Path to a bsconfig.json project file.' })
+    .option('host', { type: 'string', description: 'Host of the Roku device to connect to. Overrides value in bsconfig file.' })
+    .option('password', { type: 'string', description: 'Password of the Roku device to connect to. Overrides value in bsconfig file.' })
+    .option('log-level', { type: 'string', defaultDescription: '"log"', description: 'The log level. Value can be "error", "warn", "log", "info", "debug".' })
+    .check((argv) => {
+    if (!argv.host) {
+        return new Error('You must provide a host. (--host)');
+    }
+    if (!argv.password) {
+        return new Error('You must provide a password. (--password)');
+    }
+    if (!argv.project) {
+        console.log('No project file specified. Using "./bsconfig.json"');
+    }
+    let bsconfigPath = argv.project || './bsconfig.json';
+    if (!fs.existsSync(bsconfigPath)) {
+        return new Error(`Unable to load ${bsconfigPath}`);
+    }
+    return true;
+})
+    .argv;
+async function main() {
+    var _a, _b, _c, _d;
+    let currentErrorCode = 0;
+    let bsconfigPath = (_a = options.project) !== null && _a !== void 0 ? _a : 'bsconfig.json';
+    console.log(`Using bsconfig: ${bsconfigPath}`);
+    const rawConfig = brighterscript_1.util.loadConfigFile(bsconfigPath);
+    const bsConfig = brighterscript_1.util.normalizeConfig(rawConfig);
+    const host = (_b = options.host) !== null && _b !== void 0 ? _b : bsConfig.host;
+    const password = (_c = options.password) !== null && _c !== void 0 ? _c : bsConfig.password;
+    const logLevel = (_d = brighterscript_1.LogLevel[options['log-level']]) !== null && _d !== void 0 ? _d : bsConfig.logLevel;
+    const builder = new brighterscript_1.ProgramBuilder();
+    builder.logger.logLevel = logLevel;
+    await builder.run(Object.assign(Object.assign({}, options), { retainStagingDir: true, createPackage: true }));
+    const rokuDeploy = new roku_deploy_1.RokuDeploy();
+    const deviceInfo = await rokuDeploy.getDeviceInfo({ host: host });
+    const rendezvousTracker = new roku_debug_1.RendezvousTracker({ softwareVersion: deviceInfo['software-version'] }, { host: host, remotePort: 8085 });
+    const telnet = new roku_debug_1.TelnetAdapter({ host: options.host }, rendezvousTracker);
+    telnet.logger.logLevel = logLevel;
+    await telnet.activate();
+    await telnet.connect();
+    const failRegex = /RESULT: Fail/g;
+    const endRegex = /\[END TEST REPORT\]/g;
+    async function doExit(emitAppExit = false) {
+        if (emitAppExit) {
+            telnet.beginAppExit();
+        }
+        await rokuDeploy.pressHomeButton(host); // roku-deploy v4: keyPress({ host: options.host, key: 'home' });
+        process.exit(currentErrorCode);
+    }
+    telnet.on('console-output', (output) => {
+        console.log(output);
+        //check for Fails or Crashes
+        let failMatches = failRegex.exec(output);
+        if (failMatches && failMatches.length > 0) {
+            currentErrorCode = 1;
+        }
+        let endMatches = endRegex.exec(output);
+        if (endMatches && endMatches.length > 0) {
+            doExit(true).catch(e => {
+                console.error(e);
+                process.exit(1);
+            });
+        }
+    });
+    telnet.on('runtime-error', (error) => {
+        console.error(`Runtime Error: ${error.errorCode} - ${error.message}`);
+        currentErrorCode = 1;
+        doExit(true).catch(e => {
+            console.error(e);
+            process.exit(1);
+        });
+    });
+    telnet.on('app-exit', () => {
+        doExit(false).catch(e => {
+            console.error(e);
+            process.exit(1);
+        });
+    });
+    // Actually start the unit tests
+    //deploy a .zip package of your project to a roku device
+    async function deployBuiltFiles() {
+        const outFile = bsConfig.outFile;
+        console.log(`Deploying ${outFile} to ${host}`);
+        await rokuDeploy.publish({
+            password: password,
+            host: host,
+            outFile: outFile,
+            outDir: process.cwd()
+        });
+    }
+    await deployBuiltFiles();
+}
+main().catch(e => {
+    console.error(e);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,2CAA8D;AAE9D,mDAAgE;AAChE,+BAA+B;AAC/B,6CAAyC;AACzC,yBAAyB;AAIzB,IAAI,OAAO,GAAG,KAAK;KACd,KAAK,CAAC,IAAI,EAAE,uFAAuF,CAAC;KACpG,IAAI,CAAC,MAAM,EAAE,wCAAwC,CAAC;KACtD,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,uCAAuC,EAAE,CAAC;KAC3F,MAAM,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,0EAA0E,EAAE,CAAC;KAC3H,MAAM,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,8EAA8E,EAAE,CAAC;KACnI,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,WAAW,EAAE,sEAAsE,EAAE,CAAC;KACzJ,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;IACZ,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QACZ,OAAO,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;KACzD;IACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;QAChB,OAAO,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;KACjE;IACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACf,OAAO,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;KAErE;IACD,IAAI,YAAY,GAAG,IAAI,CAAC,OAAO,IAAI,iBAAiB,CAAC;IAErD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;QAC9B,OAAO,IAAI,KAAK,CAAC,kBAAkB,YAAY,EAAE,CAAC,CAAC;KACtD;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;KACD,IAAI,CAAC;AAGV,KAAK,UAAU,IAAI;;IACf,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAI,YAAY,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,eAAe,CAAC;IACtD,OAAO,CAAC,GAAG,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAC;IAE/C,MAAM,SAAS,GAAa,qBAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,qBAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAEjD,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,QAAQ,CAAC,IAAI,CAAC;IAC3C,MAAM,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,QAAQ,CAAC,QAAQ,CAAC;IAEvD,MAAM,QAAQ,GAAG,MAAA,yBAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,mCAAI,QAAQ,CAAC,QAAQ,CAAC;IACrE,MAAM,OAAO,GAAG,IAAI,+BAAc,EAAE,CAAC;IAErC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAGnC,MAAM,OAAO,CAAC,GAAG,CAAC,gCAAU,OAAO,KAAE,gBAAgB,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,GAAE,CAAC,CAAC;IAEpF,MAAM,UAAU,GAAG,IAAI,wBAAU,EAAE,CAAC;IACpC,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,MAAM,iBAAiB,GAAG,IAAI,8BAAiB,CAAC,EAAE,eAAe,EAAE,UAAU,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAS,CAAC,CAAC;IAC9I,MAAM,MAAM,GAAG,IAAI,0BAAa,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,iBAAiB,CAAC,CAAC;IAE5E,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAClC,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;IACxB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IAEvB,MAAM,SAAS,GAAG,eAAe,CAAC;IAClC,MAAM,QAAQ,GAAG,sBAAsB,CAAC;IAExC,KAAK,UAAU,MAAM,CAAC,WAAW,GAAG,KAAK;QACrC,IAAI,WAAW,EAAE;YACZ,MAAc,CAAC,YAAY,EAAE,CAAC;SAClC;QACD,MAAM,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,iEAAiE;QACzG,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE;QACnC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEpB,4BAA4B;QAC5B,IAAI,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YACvC,gBAAgB,GAAG,CAAC,CAAC;SACxB;QAED,IAAI,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBACnB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;SACN;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;QACjC,OAAO,CAAC,KAAK,CAAC,kBAAkB,KAAK,CAAC,SAAS,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACtE,gBAAgB,GAAG,CAAC,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACnB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;QACvB,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,gCAAgC;IAEhC,wDAAwD;IACxD,KAAK,UAAU,gBAAgB;QAC3B,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,OAAO,IAAI,EAAE,CAAC,CAAC;QAC/C,MAAM,UAAU,CAAC,OAAO,CAAC;YACrB,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;SACxB,CAAC,CAAC;IACP,CAAC;IAED,MAAM,gBAAgB,EAAE,CAAC;AAC7B,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;IACb,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC"}

package/dist/lib/framework/BaseTestReporter.bs

@@ -1,4 +1,8 @@
 namespace rooibos
+  interface ITestReporterOnEndEvent
+    stats as rooibos.Stats
+  end interface
+
   class BaseTestReporter
 
     public testRunner = invalid
@@ -11,15 +15,11 @@ namespace rooibos
       m.allStats = runner.stats
     end function
 
-    function reportResults(allStats as dynamic)
-      'override me
-    end function
-
-    function testLogInfo(text as string)
+    function onBegin(ev as dynamic)
       'override me
     end function
 
-    function testLogError(text as string)
+    function onEnd(ev as rooibos.ITestReporterOnEndEvent)
       'override me
     end function
 

package/dist/lib/framework/BaseTestSuite.bs

@@ -199,6 +199,8 @@ namespace rooibos
           m.testRunner.top.unobserveFieldScoped("rooibosGroupFinished")
           ' m.testGroupDone()
           m.onAsyncGroupComplete(group)
+        else if m.testRunner.top.rooibosGroupFinished
+          m.onAsyncGroupComplete(group)
         end if
 
       end if
@@ -1833,7 +1835,7 @@ namespace rooibos
       end if
 
       if not type(stubOrReturnValue).endsWith("Function")
-        throw "Did not provide a stub function"
+        ' throw "Did not provide a stub function"
       end if
 
       ' Store the stub on the component scope
@@ -1906,7 +1908,7 @@ namespace rooibos
       '   m.currentResult.fail("Setting up mock failed: " + error.message, m.currentAssertLineNumber)
       '   return false
       ' end try
-      return false
+      ' return false
     end function
 
     ' /**

package/dist/lib/framework/CommonUtils.bs

@@ -334,7 +334,9 @@ namespace rooibos.common
         'bs:disable-next-line
         isFirst = false
       end if
-      for each key in input
+      keys = input.keys()
+      keys.sort()
+      for each key in keys
         if rooibos.common.canSafelyIterateAAKey(input, key)
           text = text + key + ":" + rooibos.common.asString(input[key], includeType)
         end if

package/dist/lib/framework/ConsoleTestReporter.bs

@@ -13,8 +13,8 @@ namespace rooibos
       end if
     end function
 
-    override function reportResults(allStats)
-      m.allStats = allStats
+    override function onEnd(ev as rooibos.ITestReporterOnEndEvent)
+      m.allStats = ev.stats
       m.startReport()
       for each testSuite in m.testRunner.testSuites
         if not m.allStats.hasFailures or ((not m.config.showOnlyFailures) or testSuite.stats.failedCount > 0 or testSuite.stats.crashedCount > 0)
@@ -186,14 +186,6 @@ namespace rooibos
     '++ printing
     '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-    override function testLogInfo(text)
-      ? "INFO " ; text
-    end function
-
-    override function testLogError(text)
-      ? "ERROR " ; text
-    end function
-
     function printLine(depth = 0, text = "")
       ? " " ; text
     end function

package/dist/lib/framework/JUnitTestReporter.bs

@@ -1,11 +1,7 @@
 namespace rooibos
   class JUnitTestReporter extends rooibos.BaseTestReporter
 
-    function new(testRunner as dynamic)
-      super(testRunner)
-    end function
-
-    override function reportResults(allStats as dynamic)
+    override function onEnd(ev as rooibos.ITestReporterOnEndEvent)
       root = createObject("roXMLElement")
       root.SetName("testsuites")
       properties = root.addElement("properties")

package/dist/lib/framework/Rooibos.bs

@@ -36,6 +36,9 @@ namespace rooibos
         ? "keepAppOpen is false; exiting Rooibos"
         ' End statement will also exit the caller of this function
         ' leading to an instant exit of the application
+
+        ' Give the io port time to finish sending all the logs
+        sleep(400)
         end
       end if
     end if
@@ -91,4 +94,4 @@ namespace rooibos
     return 0
 
   end function
-end namespace
+end namespace

package/dist/lib/framework/RuntimeConfig.bs

@@ -1,16 +1,25 @@
 namespace rooibos
   class RuntimeConfig
 
+    function new()
+      m.testSuites = m.getTestSuiteClassMap()
+    end function
+
     function getVersionText()
     end function
 
     function getRuntimeConfig()
     end function
 
+    function getTestSuiteClassMap()
+    end function
+
     function getTestSuiteClassWithName(name)
+      return m.testSuites[name]
     end function
 
     function getAllTestSuitesNames()
+      return m.testSuites.keys()
     end function
 
     function getIgnoredTestInfo()

package/dist/lib/framework/TestRunner.bs

@@ -11,7 +11,7 @@ namespace rooibos
   '  */
   class TestRunner
     public testScene = invalid
-    public testReporter = invalid
+    public testReporters = []
     public nodeContext = invalid
     public config = invalid
     public testSuites = []
@@ -33,11 +33,7 @@ namespace rooibos
       m.runtimeConfig = new rooibos.RuntimeConfig()
       m.config = m.runtimeConfig.getRuntimeConfig()
 
-      if m.config.reporter = "JUnitTestReporter"
-        m.testReporter = new Rooibos.JUnitTestReporter(m)
-      else
-        m.testReporter = new Rooibos.ConsoleTestReporter(m)
-      end if
+      m.testReporters = m.getTestReporters()
     end function
 
     ' /**
@@ -49,6 +45,12 @@ namespace rooibos
     '  */
     public function run()
 
+      for each reporter in m.testReporters
+        if rooibos.common.isFunction(reporter.onBegin)
+          reporter.onBegin({})
+        end if
+      end for
+
       rooibosTimer = createObject("roTimespan")
       rooibosTimer.mark()
       suiteNames = m.runtimeConfig.getAllTestSuitesNames()
@@ -103,7 +105,11 @@ namespace rooibos
 
       m.stats.time = rooibosTimer.totalMilliseconds()
 
-      m.testReporter.reportResults(m.stats)
+      for each reporter in m.testReporters
+        if rooibos.common.isFunction(reporter.onEnd)
+          reporter.onEnd({ stats: m.stats })
+        end if
+      end for
 
       rooibosResult = {
         stats: m.stats
@@ -157,6 +163,7 @@ namespace rooibos
           ? "Running suite asynchronously!"
           m.nodeContext.top.observeFieldScoped("rooibosSuiteFinished", "Rooibos_onTestSuiteComplete")
           testSuite.run()
+          return invalid
         else
           ? "Running suite synchronously!"
           testSuite.run()
@@ -264,7 +271,7 @@ namespace rooibos
             testSuite.stats.merge(nodeResults.stats)
             m.mergeGroups(testSuite, nodeResults.groups)
           else
-            ? " ERROR! The node test"; testSuite.name; " did not indicate test completion. Did you call m.done() in your test? Did you correctly configure your node test? Please refer to : https://github.com/georgejecook/rooibos/blob/master/docs/index.md#testing-scenegraph-nodes"
+            ? " ERROR! The node test"; testSuite.name; " did not indicate test completion. Did you call m.done() in your test? Did you correctly configure your node test? Please refer to : https://github.com/rokucommunity/rooibos/blob/master/docs/index.md#testing-scenegraph-nodes"
           end if
           m.testScene.removeChild(node)
           return
@@ -307,6 +314,19 @@ namespace rooibos
       ut.PostFromString("")
     end function
 
+    private function getTestReporters()
+      reporters = []
+      for each factory in m.config.reporters
+        if rooibos.common.isFunction(factory)
+          reporters.push(factory(m))
+        end if
+      end for
+      if reporters.isEmpty()
+        reporters.push(new rooibos.ConsoleTestReporter(m))
+      end if
+      return reporters
+    end function
+
   end class
 
   '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -333,4 +353,4 @@ namespace rooibos
   function onTestSuiteComplete()
     m.testRunner.onTestSuiteComplete()
   end function
-end namespace
+end namespace