rooibos-roku 5.11.0 → 5.13.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/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/Coverage.bs

@@ -72,7 +72,7 @@ namespace rooibos.Coverage
     ? "+++++++++++++++++++++++++++++++++++++++++++"
   end function
 
-  function createLCovOutput()
+  function createLCovOutput(logToConsole = true as boolean)
     ? "Generating lcov.info file..."
 
     cc = m.global._rbs_ccn
@@ -80,9 +80,10 @@ namespace rooibos.Coverage
     filePathMap = cc.filePathMap
     resolvedMap = cc.resolvedMap
 
-    buffer = ""
+    results = []
 
     for each module in filePathMap.items()
+      buffer = ""
       moduleNumber = module.key
       filePath = module.value
       packageName = "."
@@ -90,33 +91,51 @@ namespace rooibos.Coverage
       relativePath = filePath.replace("pkg:", packageName)
       sanitizedPath = relativePath.replace("\\", "/")
 
-      buffer = buffer + "TN:" + chr(10)
-      buffer = buffer + "SF:" + sanitizedPath + chr(10)
+      buffer += "TN:" + chr(10)
+      buffer += "SF:" + sanitizedPath + chr(10)
 
       for each expected in expectedMap[moduleNumber]
-        lineNumber = expected[0]
+        lineNumber = val(expected)
         SHIFT = 1
 
-        if resolvedMap[moduleNumber] <> invalid and resolvedMap[moduleNumber].doesExist(str(lineNumber))
-          buffer = buffer + "DA:" + str(lineNumber + SHIFT) + ",1" + chr(10)
+        if resolvedMap[moduleNumber] <> invalid and resolvedMap[moduleNumber].doesExist(expected)
+          buffer += "DA:" + str(lineNumber + SHIFT).trim() + "," + str(resolvedMap[moduleNumber][expected]).trim() + chr(10)
         else
-          buffer = buffer + "DA:" + str(lineNumber + SHIFT) + ",0" + chr(10)
+          buffer += "DA:" + str(lineNumber + SHIFT).trim() + ",0" + chr(10)
         end if
       end for
 
-      buffer = buffer + "end_of_record" + chr(10)
+      buffer += "LF:" + str(expectedMap[moduleNumber].count()).trim() + chr(10)
+
+      if resolvedMap[moduleNumber] <> invalid
+        buffer += "LH:" + str(resolvedMap[moduleNumber].count()).trim() + chr(10)
+      else
+        buffer += "LH:0" + chr(10)
+      end if
+
+      buffer += "end_of_record"
+      if logToConsole
+        ? buffer
+        ' When logging to the console it is very possible to flood the buffer and cause the application to exit.
+        ' Sleep for a short amount of time so as to give console scrapers time to empty the buffer
+        sleep(30)
+      else
+        results.push(buffer)
+      end if
     end for
-    return buffer
+
+    return results.join(chr(10))
   end function
 
   function printLCovInfo()
+
     ?
     ? "+++++++++++++++++++++++++++++++++++++++++++"
     ? "LCOV.INFO FILE"
     ? "+++++++++++++++++++++++++++++++++++++++++++"
     ?
     ? "+-=-coverage:start"
-    ? rooibos.coverage.createLCovOutput()
+    rooibos.coverage.createLCovOutput()
     ? "+-=-coverage:end"
   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

@@ -34,7 +34,12 @@ namespace rooibos
 
       if runner.config.keepAppOpen = false
         ? "keepAppOpen is false; exiting Rooibos"
-        return
+        ' 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
 
@@ -89,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
@@ -111,9 +117,7 @@ namespace rooibos
       }
       m.nodeContext.global.testsScene.rooibosTestResult = rooibosResult
 
-      'bs:disable-next-line
-      if rooibos.common.isFunction(rooibos.Coverage.reportCodeCoverage)
-        'bs:disable-next-line
+      if m.config.isRecordingCodeCoverage
         rooibos.Coverage.reportCodeCoverage()
 
         if m.config.printLcov = true
@@ -159,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()
@@ -252,7 +257,13 @@ namespace rooibos
               timeout = testSuite.asyncTimeout = invalid ? 60000 : testSuite.asyncTimeout
 
               ? "Waiting max " timeout "ms for the test suite to finish"
-              m.waitForField(node, "rooibosSuiteFinished", 10, timeout / 10)
+              t = createObject("roTimespan")
+              while node.rooibosSuiteFinished = false
+                m.wait(10)
+                if t.totalMilliseconds() >= timeout
+                  exit while
+                end if
+              end while
             end if
           end if
           nodeResults = node.asyncRooibosTestResult
@@ -260,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
@@ -303,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
 
   '+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -329,4 +353,4 @@ namespace rooibos
   function onTestSuiteComplete()
     m.testRunner.onTestSuiteComplete()
   end function
-end namespace
+end namespace