feat: Add concurrency option to integration-browser

Add a `-c` option to integration-browser
that will increase the number of browsers tested.
This speeds up the integration tests considerably.

The -c option, takes a number or the string ‘cpu’.
The string will set the concurrency
to the number of cpus - 1.

Author: seebees

modules/integration-browser/karma.conf.js

@@ -1,14 +1,21 @@
 // Karma configuration
 process.env.CHROME_BIN = require('puppeteer').executablePath()
+const { readFileSync } = require('fs')
 
 module.exports = function (config) {
+  // karma-parallel will use the number CPUs as the default number of browsers to spawn
+  // But ideally this would be a command line option.
+  // Since I'm already using these files to pass information back and forth,
+  // I'm just coopting the path.
+  const concurrency = JSON.parse(readFileSync('./fixtures/concurrency.json'))
   config.set({
     basePath: '',
-    frameworks: ['jasmine'],
+    frameworks: ['parallel', 'jasmine'],
     files: [
       'fixtures/decrypt_tests.json',
       'fixtures/encrypt_tests.json',
       'fixtures/decrypt_oracle.json',
+      '/fixtures/concurrency.json',
       { pattern: 'fixtures/*.json', included: false, served: true, watched: false, nocache: true },
       'build/module/integration.decrypt.test.js',
       'build/module/integration.encrypt.test.js',
@@ -18,8 +25,8 @@ module.exports = function (config) {
       'build/module/integration.encrypt.test.js': ['webpack', 'credentials'],
       './fixtures/decrypt_tests.json': ['json_fixtures'],
       './fixtures/encrypt_tests.json': ['json_fixtures'],
-      './fixtures/decrypt_oracle.json': ['json_fixtures']
-
+      './fixtures/decrypt_oracle.json': ['json_fixtures'],
+      './fixtures/concurrency.json': ['json_fixtures'],
     },
     webpack: {
       mode: 'development',
@@ -32,6 +39,7 @@ module.exports = function (config) {
       devtool: 'inline-source-map'
     },
     plugins: [
+      'karma-parallel',
       '@aws-sdk/karma-credential-loader',
       'karma-webpack',
       'karma-json-fixtures-preprocessor',
@@ -52,6 +60,9 @@ module.exports = function (config) {
     },
     singleRun: true,
     concurrency: Infinity,
-    exclude: ['**/*.d.ts']
+    exclude: ['**/*.d.ts'],
+    parallelOptions: {
+      executors: concurrency
+    }
   })
 }

modules/integration-browser/package.json

@@ -31,6 +31,7 @@
     "karma-jasmine": "^3.1.1",
     "karma-json-fixtures-preprocessor": "0.0.6",
     "karma-webpack": "^4.0.2",
+    "karma-parallel": "^0.3.1",
     "puppeteer": "^2.1.1",
     "stream-to-promise": "^2.2.0",
     "tslib": "^1.9.3",

modules/integration-browser/src/cli.ts

@@ -16,6 +16,8 @@
 
 import yargs from 'yargs'
 import { spawnSync } from 'child_process'
+import { cpus } from 'os'
+import { needs } from '@aws-crypto/client-browser'
 
 import { join } from 'path'
 import { existsSync, mkdirSync, writeFileSync } from 'fs'
@@ -65,6 +67,19 @@ const cli = yargs
     describe: 'start karma and run the tests',
     type: 'boolean'
   })
+  .option('concurrency', {
+    alias: 'c',
+    describe: `an optional concurrency for running tests, pass 'cpu' to maximize`,
+    default: 1,
+    coerce: (value: any) => {
+      if (typeof value === 'string') {
+        needs(value.toLowerCase() === 'cpu', `The only supported string is 'cpu'`)
+        return cpus().length - 1
+      }
+      needs(typeof value === 'number' && value > 0, `Must be a number greater than 0`)
+      return value
+    }
+  })
   .demandCommand()
 const fixtures = join(__dirname, '../../fixtures')
 /* Sad side effect. */
@@ -73,10 +88,11 @@ if (!existsSync(fixtures)) {
 }
 
 ;(async (argv) => {
-  const { _: [ command ], testName, slice, karma } = argv
+  const { _: [ command ], testName, slice, karma, concurrency } = argv
 
   writeFileSync(`${fixtures}/decrypt_tests.json`, JSON.stringify([]))
   writeFileSync(`${fixtures}/encrypt_tests.json`, JSON.stringify([]))
+  writeFileSync(`${fixtures}/concurrency.json`, JSON.stringify(concurrency))
 
   if (command === 'decrypt') {
     // It is not clear how to get yargs/typescript to play nicely with sub commands

modules/integration-browser/src/integration.decrypt.test.ts

@@ -27,24 +27,36 @@ const notSupportedMessages = [
   '192-bit AES keys are not supported',
   'Unsupported right now'
 ]
-describe('browser decryption vectors', function () {
-  const tests: string[] = __fixtures__['fixtures/decrypt_tests']
-
-  for (const testName of tests) {
-    it(testName, async () => {
-      console.log(`start: ${testName}`)
-      const response = await fetch(`base/fixtures/${testName}.json`)
-      const { keysInfo, cipherText, plainText } = await response.json()
-
-      const cipher = fromBase64(cipherText)
-      const good = fromBase64(plainText)
-      try {
-        const cmm = await decryptMaterialsManagerWebCrypto(keysInfo)
-        const { plaintext } = await decrypt(cmm, cipher)
-        expect(good).toEqual(plaintext)
-      } catch (e) {
-        if (!notSupportedMessages.includes(e.message)) throw e
-      }
-    })
-  }
-})
+
+const tests: string[] = __fixtures__['fixtures/decrypt_tests']
+const chunk = __fixtures__['fixtures/concurrency'] || 1
+
+for (let i = 0, j = tests.length; i < j; i += chunk) {
+  aGroup(chunk, tests.slice(i, i + chunk))
+}
+
+function aGroup (groupNumber: number, tests: string[]) {
+  describe(`browser decryption vectors: ${groupNumber}`, () => {
+    for (const testName of tests) {
+      aTest(testName)
+    }
+  })
+}
+
+function aTest (testName: string) {
+  it(testName, async () => {
+    console.log(`start: ${testName}`)
+    const response = await fetch(`base/fixtures/${testName}.json`)
+    const { keysInfo, cipherText, plainText } = await response.json()
+
+    const cipher = fromBase64(cipherText)
+    const good = fromBase64(plainText)
+    try {
+      const cmm = await decryptMaterialsManagerWebCrypto(keysInfo)
+      const { plaintext } = await decrypt(cmm, cipher)
+      expect(good).toEqual(plaintext)
+    } catch (e) {
+      if (!notSupportedMessages.includes(e.message)) throw e
+    }
+  })
+}

modules/integration-browser/src/integration.encrypt.test.ts

@@ -29,34 +29,46 @@ const notSupportedMessages = [
   'frameLength out of bounds: 0 > frameLength >= 4294967295',
   'Unsupported right now'
 ]
-describe('browser encrypt tests', function () {
-  const tests = __fixtures__['fixtures/encrypt_tests']
-  const decryptOracle = __fixtures__['fixtures/decrypt_oracle']
-
-  for (const testName of tests) {
-    it(testName, async () => {
-      console.log(`start: ${testName}`)
-      const response = await fetch(`base/fixtures/${testName}.json`)
-      const { keysInfo, plainTextData, encryptOp } = await response.json()
-
-      const plainText = fromBase64(plainTextData)
-      try {
-        const cmm = await encryptMaterialsManagerWebCrypto(keysInfo)
-        const { result } = await encrypt(cmm, plainText, encryptOp)
-        const response = await fetch(decryptOracle, {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/octet-stream',
-            'Accept': 'application/octet-stream'
-          },
-          body: result
-        })
-        const body = await response.arrayBuffer()
-        needs(response.ok, `Failed to decrypt: ${toUtf8(body)}`)
-        expect(plainText).toEqual(new Uint8Array(body))
-      } catch (e) {
-        if (!notSupportedMessages.includes(e.message)) throw e
-      }
-    })
-  }
-})
+
+const tests = __fixtures__['fixtures/encrypt_tests']
+const decryptOracle = __fixtures__['fixtures/decrypt_oracle']
+const chunk = __fixtures__['fixtures/concurrency'] || 1
+
+for (let i = 0, j = tests.length; i < j; i += chunk) {
+  aGroup(chunk, tests.slice(i, i + chunk), decryptOracle)
+}
+
+function aGroup (groupNumber: number, tests: string[], decryptOracle: string) {
+  describe(`'browser encrypt tests': ${groupNumber}`, () => {
+    for (const testName of tests) {
+      aTest(testName, decryptOracle)
+    }
+  })
+}
+
+function aTest (testName: string, decryptOracle: string) {
+  it(testName, async () => {
+    console.log(`start: ${testName}`)
+    const response = await fetch(`base/fixtures/${testName}.json`)
+    const { keysInfo, plainTextData, encryptOp } = await response.json()
+
+    const plainText = fromBase64(plainTextData)
+    try {
+      const cmm = await encryptMaterialsManagerWebCrypto(keysInfo)
+      const { result } = await encrypt(cmm, plainText, encryptOp)
+      const response = await fetch(decryptOracle, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/octet-stream',
+          'Accept': 'application/octet-stream'
+        },
+        body: result
+      })
+      const body = await response.arrayBuffer()
+      needs(response.ok, `Failed to decrypt: ${toUtf8(body)}`)
+      expect(plainText).toEqual(new Uint8Array(body))
+    } catch (e) {
+      if (!notSupportedMessages.includes(e.message)) throw e
+    }
+  })
+}