feat: add basic browser support (#26)

- use shims + browser field to support
- add registerTestcaseResult to communicate end of test with a node runner when running in-browser
- Expose getEnvParameters to let a client gather and move testground variables (used for browser support).
- Supersede #25, having applies all the previous feedback.

package.json

@@ -51,6 +51,11 @@
   "engines": {
     "node": ">=14.0.0"
   },
+  "browser": {
+    "os": "./src/shims/os.js",
+    "./src/env/env": "./src/shims/env/env.js",
+    "./src/runtime/logger": "./src/shims/runtime/logger.js"
+  },
   "aegir": {
     "test": {
       "target": [
@@ -66,6 +71,7 @@
   },
   "contributors": [
     "Henrique Dias <[email protected]>",
-    "Laurent Senta <[email protected]>"
+    "Laurent Senta <[email protected]>",
+    "Glen De Cauwsemaecker <[email protected]>"
   ]
 }

src/env/env.js

@@ -0,0 +1,24 @@
+'use strict'
+
+/**
+ * Gets the environment that can be used by the environment
+ * to create the runtime.
+ *
+ * @returns {Record<string, string|undefined>}
+ */
+function getProcessEnv () {
+  return process.env
+}
+
+/**
+ * @param {unknown} _result
+ */
+function registerTestcaseResult (_result) {
+  // function is used in the browser shim
+  // to gain the ability to wait until invokeMap is finished
+}
+
+module.exports = {
+  getProcessEnv,
+  registerTestcaseResult
+}

src/env/index.js

@@ -0,0 +1,46 @@
+'use strict'
+
+const runtime = require('./runtime')
+const sync = require('./sync')
+const { getProcessEnv } = require('./env')
+
+const ENV_TEST_PARAMETERS = [
+  runtime.ENV_TEST_BRANCH,
+  runtime.ENV_TEST_CASE,
+  runtime.ENV_TEST_GROUP_ID,
+  runtime.ENV_TEST_GROUP_INSTANCE_COUNT,
+  runtime.ENV_TEST_INSTANCE_COUNT,
+  runtime.ENV_TEST_INSTANCE_PARAMS,
+  runtime.ENV_TEST_INSTANCE_ROLE,
+  runtime.ENV_TEST_OUTPUTS_PATH,
+  runtime.ENV_TEST_PLAN,
+  runtime.ENV_TEST_REPO,
+  runtime.ENV_TEST_RUN,
+  runtime.ENV_TEST_SIDECAR,
+  runtime.ENV_TEST_START_TIME,
+  runtime.ENV_TEST_SUBNET,
+  runtime.ENV_TEST_TAG,
+
+  sync.ENV_SYNC_SERVICE_HOST,
+  sync.ENV_SYNC_SERVICE_PORT
+]
+
+/**
+ * Gets the parameters from the environment
+ * that can be used by the environment to create the runtime.
+ *
+ * @returns {Record<string, string|undefined>}
+ */
+function getEnvParameters () {
+  const env = getProcessEnv()
+  return Object.keys(env)
+    .filter(key => ENV_TEST_PARAMETERS.includes(key))
+    .reduce((/** @type {Record<string, string|undefined>} */params, key) => {
+      params[key] = env[key]
+      return params
+    }, {})
+}
+
+module.exports = {
+  getEnvParameters
+}

src/env/runtime.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const ENV_TEST_BRANCH = 'TEST_BRANCH'
+const ENV_TEST_CASE = 'TEST_CASE'
+const ENV_TEST_GROUP_ID = 'TEST_GROUP_ID'
+const ENV_TEST_GROUP_INSTANCE_COUNT = 'TEST_GROUP_INSTANCE_COUNT'
+const ENV_TEST_INSTANCE_COUNT = 'TEST_INSTANCE_COUNT'
+const ENV_TEST_INSTANCE_PARAMS = 'TEST_INSTANCE_PARAMS'
+const ENV_TEST_INSTANCE_ROLE = 'TEST_INSTANCE_ROLE'
+const ENV_TEST_OUTPUTS_PATH = 'TEST_OUTPUTS_PATH'
+const ENV_TEST_PLAN = 'TEST_PLAN'
+const ENV_TEST_REPO = 'TEST_REPO'
+const ENV_TEST_RUN = 'TEST_RUN'
+const ENV_TEST_SIDECAR = 'TEST_SIDECAR'
+const ENV_TEST_START_TIME = 'TEST_START_TIME'
+const ENV_TEST_SUBNET = 'TEST_SUBNET'
+const ENV_TEST_TAG = 'TEST_TAG'
+
+module.exports = {
+  ENV_TEST_BRANCH,
+  ENV_TEST_CASE,
+  ENV_TEST_GROUP_ID,
+  ENV_TEST_GROUP_INSTANCE_COUNT,
+  ENV_TEST_INSTANCE_COUNT,
+  ENV_TEST_INSTANCE_PARAMS,
+  ENV_TEST_INSTANCE_ROLE,
+  ENV_TEST_OUTPUTS_PATH,
+  ENV_TEST_PLAN,
+  ENV_TEST_REPO,
+  ENV_TEST_RUN,
+  ENV_TEST_SIDECAR,
+  ENV_TEST_START_TIME,
+  ENV_TEST_SUBNET,
+  ENV_TEST_TAG
+}

src/env/sync.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const ENV_SYNC_SERVICE_HOST = 'SYNC_SERVICE_HOST'
+const ENV_SYNC_SERVICE_PORT = 'SYNC_SERVICE_PORT'
+
+module.exports = {
+  ENV_SYNC_SERVICE_HOST,
+  ENV_SYNC_SERVICE_PORT
+}

src/index.js

@@ -3,6 +3,9 @@
 const runtime = require('./runtime')
 const sync = require('./sync')
 const network = require('./network')
+const env = require('./env')
+
+const { registerTestcaseResult } = require('./env/env')
 
 /** @typedef {import('./runtime').RunEnv} RunEnv */
 /** @typedef {import('./sync').SyncClient} SyncClient */
@@ -17,12 +20,28 @@ async function invokeMap (cases) {
   const runenv = runtime.currentRunEnv()
 
   if (cases[runenv.testCase]) {
-    await invokeHelper(runenv, cases[runenv.testCase])
+    try {
+      await invokeHelper(runenv, cases[runenv.testCase])
+    } catch (err) {
+      registerAndMessageTestcaseResult(err, runenv)
+      throw err
+    }
   } else {
-    throw new Error(`unrecognized test case: ${runenv.testCase}`)
+    const err = new Error(`unrecognized test case: ${runenv.testCase}`)
+    registerAndMessageTestcaseResult(err, runenv)
+    throw err
   }
 }
 
+/**
+ * @param {unknown} result
+ * @param {RunEnv} runenv
+ */
+function registerAndMessageTestcaseResult (result, runenv) {
+  runenv.recordMessage(`registerTestcaseResult: ${result}`)
+  registerTestcaseResult(result)
+}
+
 /**
  * Runs the passed test-case and reports the result.
  *
@@ -47,22 +66,26 @@ async function invokeHelper (runenv, fn) {
 
   await runenv.recordStart()
 
+  let /** @type {unknown} */ testResult = true
   try {
     await fn(runenv, client)
     await runenv.recordSuccess()
   } catch (err) {
     await runenv.recordFailure(err)
+    testResult = err
   } finally {
     if (client) {
       client.close()
     }
+    registerAndMessageTestcaseResult(testResult, runenv)
   }
 }
 
 module.exports = {
   invoke,
   invokeMap,
 
+  env,
   network,
   runtime,
   sync

src/runtime/events.js

@@ -47,6 +47,7 @@ function newEvents (runParams, logger, getSignalEmitter) {
 
       logger.info('', { event })
       return emitEvent(event)
+      // eslint-disable-next-line no-warning-comments
       // TODO(metrics): re.metrics.recordEvent(&evt)
     },
     recordSuccess: () => {
@@ -58,6 +59,7 @@ function newEvents (runParams, logger, getSignalEmitter) {
 
       logger.info('', { event })
       return emitEvent(event)
+      // eslint-disable-next-line no-warning-comments
       // TODO(metrics): re.metrics.recordEvent(&evt)
     },
     recordFailure: (err) => {
@@ -70,6 +72,7 @@ function newEvents (runParams, logger, getSignalEmitter) {
 
       logger.info('', { event })
       return emitEvent(event)
+      // eslint-disable-next-line no-warning-comments
       // TODO(metrics): re.metrics.recordEvent(&evt)
     },
     recordCrash: (err) => {
@@ -83,6 +86,7 @@ function newEvents (runParams, logger, getSignalEmitter) {
 
       logger.info('', { event })
       return emitEvent(event)
+      // eslint-disable-next-line no-warning-comments
       // TODO(metrics): re.metrics.recordEvent(&evt)
     }
   }

src/runtime/index.js

@@ -3,6 +3,7 @@
 const { getLogger } = require('./logger')
 const { newEvents } = require('./events')
 const { parseRunParams } = require('./params')
+const { getEnvParameters } = require('../env')
 
 /** @typedef {import('./types').RunParams} RunParams */
 /** @typedef {import('./types').SignalEmitter} SignalEmitter */
@@ -14,7 +15,8 @@ const { parseRunParams } = require('./params')
  * @returns {RunEnv}
  */
 function currentRunEnv () {
-  return parseRunEnv(process.env)
+  const env = getEnvParameters()
+  return parseRunEnv(env)
 }
 
 /**
@@ -52,5 +54,6 @@ function newRunEnv (params) {
 module.exports = {
   newRunEnv,
   currentRunEnv,
-  parseRunEnv
+  parseRunEnv,
+  getEnvParameters
 }

src/runtime/params.js

@@ -2,23 +2,25 @@
 
 const ipaddr = require('ipaddr.js')
 
-/** @typedef {import('./types').RunParams} RunParams */
+const {
+  ENV_TEST_BRANCH,
+  ENV_TEST_CASE,
+  ENV_TEST_GROUP_ID,
+  ENV_TEST_GROUP_INSTANCE_COUNT,
+  ENV_TEST_INSTANCE_COUNT,
+  ENV_TEST_INSTANCE_PARAMS,
+  ENV_TEST_INSTANCE_ROLE,
+  ENV_TEST_OUTPUTS_PATH,
+  ENV_TEST_PLAN,
+  ENV_TEST_REPO,
+  ENV_TEST_RUN,
+  ENV_TEST_SIDECAR,
+  ENV_TEST_START_TIME,
+  ENV_TEST_SUBNET,
+  ENV_TEST_TAG
+} = require('../env/runtime')
 
-const ENV_TEST_BRANCH = 'TEST_BRANCH'
-const ENV_TEST_CASE = 'TEST_CASE'
-const ENV_TEST_GROUP_ID = 'TEST_GROUP_ID'
-const ENV_TEST_GROUP_INSTANCE_COUNT = 'TEST_GROUP_INSTANCE_COUNT'
-const ENV_TEST_INSTANCE_COUNT = 'TEST_INSTANCE_COUNT'
-const ENV_TEST_INSTANCE_PARAMS = 'TEST_INSTANCE_PARAMS'
-const ENV_TEST_INSTANCE_ROLE = 'TEST_INSTANCE_ROLE'
-const ENV_TEST_OUTPUTS_PATH = 'TEST_OUTPUTS_PATH'
-const ENV_TEST_PLAN = 'TEST_PLAN'
-const ENV_TEST_REPO = 'TEST_REPO'
-const ENV_TEST_RUN = 'TEST_RUN'
-const ENV_TEST_SIDECAR = 'TEST_SIDECAR'
-const ENV_TEST_START_TIME = 'TEST_START_TIME'
-const ENV_TEST_SUBNET = 'TEST_SUBNET'
-const ENV_TEST_TAG = 'TEST_TAG'
+/** @typedef {import('./types').RunParams} RunParams */
 
 /**
  * @param {Record<string, string|undefined>} env

src/shims/env/env.js

@@ -0,0 +1,29 @@
+'use strict'
+
+/**
+ * Gets the environment that can be used by the environment
+ * to create the runtime.
+ *
+ * @returns {Record<string, string|undefined>}
+ */
+function getProcessEnv () {
+  // @ts-ignore
+  return (window.testground || {}).env
+}
+/**
+ * @param {unknown} result
+ */
+function registerTestcaseResult (result) {
+  // @ts-ignore
+  if (!window.testground) {
+    // @ts-ignore
+    window.testground = {}
+  }
+  // @ts-ignore
+  window.testground.result = result
+}
+
+module.exports = {
+  getProcessEnv,
+  registerTestcaseResult
+}

src/shims/os.js

@@ -0,0 +1,20 @@
+'use strict'
+
+/**
+ * @returns {any[]}
+ */
+function networkInterfaces () {
+  return []
+}
+
+/**
+ * @returns {string}
+ */
+function hostname () {
+  return 'browser'
+}
+
+module.exports = {
+  networkInterfaces,
+  hostname
+}