Merge pull request #6 from mattonem/browserstack-sdk

Browserstack sdk

Author: mattonem

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+package-lock.json

README.md

@@ -4,23 +4,33 @@ This project is variant of the [selenium-side-runner](https://github.com/Seleniu
 
 ```sh
 npm install @maxmattone/browserstack-side-runner
-npx @maxmattone/browserstack-side-runner -w 2 test.side
+npx @maxmattone/browserstack-side-runner test.side
 ```
-Don't forget to use the config file `.side.yml` like so:
+Don't forget to use the config file `browserstack.yml` like so:
 ```yml
-# this is how your .side.yml should look like
-capabilities:
-    browserName: "Chrome"
-    'bstack:options': 
-      browserVersion: 'latest'
-      os: "Windows"
-      osVersion: '10'
-      resolution: "3840x2160",
-      projectName: 'My Selenium IDE Project'
-      buildName: "My Seleenium IDE Test Suite"
-      debug: true
-      networkLogs: true
-      consoleLogs: "verbose"
-server: "https://<bs_username>:<bs_accesskey>@hub-cloud.browserstack.com/wd/hub"
+# this is how your browserstack.yml should look like
+userName: username
+accessKey: access_key
+platforms:
+  - os: Windows
+    osVersion: 11
+    browserName: Chrome
+    browserVersion: 103.0
+  - os: Windows
+    osVersion: 10
+    browserName: Firefox
+    browserVersion: 102.0
+  - os: OS X
+    osVersion: Big Sur
+    browserName: Safari
+    browserVersion: 14.1
+parallelsPerPlatform: 3
+browserstackLocal: true
+buildName: bstack-demo
+projectName: BrowserStack Sample
+debug: true
+networkLogs: true
+consoleLogs: info
 ```
 
+You can use [this online tool](https://www.browserstack.com/docs/automate/selenium/sdk-config-generator) to generate your config file based on your needs. 

browserstack-mocha-export.mjs

@@ -0,0 +1,73 @@
+import codeExport from '@seleniumhq/code-export-javascript-mocha';
+import { codeExport as exporter } from '@seleniumhq/side-utils'
+var emitters = codeExport.opts.emitter.emitters
+
+async function emitSetWindowSize(size) {
+    const [width, height] = size.split('x');
+
+    return Promise.resolve(`
+      if(!(await driver.getCapabilities()).get("device") && !(await driver.getCapabilities()).get("deviceName"))
+      {await driver.manage().window().setRect({width: ${width}, height: ${height}})}
+      `);
+}
+
+emitters['setWindowSize'] = emitSetWindowSize;
+
+function beforeEach() {
+    const params = {
+        startingSyntax: ({ capabilities, gridUrl } = {}) => ({
+            commands: [
+                { level: 0, statement: 'beforeEach(async function() {' },
+                {
+                    level: 1,
+                    statement: `driver = await new Builder()
+            .withCapabilities(${JSON.stringify(capabilities)})
+            .usingServer('${gridUrl}')
+            .build()`,
+                },
+                {
+                    level: 1, statement: `if(process.env.BS_A11Y_TEST_RUN_ID)
+            {await driver.sleep(3000);}`
+                },
+                { level: 1, statement: 'vars = {}' },
+            ],
+        }),
+        endingSyntax: {
+            commands: [{ level: 0, statement: '})' }],
+        },
+    }
+    return params
+}
+
+codeExport.opts.hooks.beforeEach = new exporter.hook(beforeEach())
+
+function declareVariables() {
+    const params = {
+        startingSyntax: {
+          commands: [
+            {
+                level: 0,
+                statement: `this.timeout(process.env.testTimeout)`,
+            },
+            {
+              level: 0,
+              statement: `let driver`,
+            },
+            {
+              level: 0,
+              statement: 'let vars',
+            },
+          ],
+        },
+      }
+      return params
+}
+
+codeExport.opts.hooks.declareVariables = new exporter.hook(declareVariables())
+
+function generateTestDeclaration(name) {
+    return `it('test', async function() {`
+}
+
+codeExport.opts.generateTestDeclaration = generateTestDeclaration
+export default codeExport

index.mjs

@@ -3,45 +3,32 @@
 import fs from 'fs'
 import rimraf from "rimraf";
 import path from 'path'
-import { emitTest, emitSuite } from '@maxmattone/code-export-browserstack-mocha'
+import codeExport from './browserstack-mocha-export.mjs'
+import { project as projectProcessor } from '@seleniumhq/side-code-export'
 import pkg from '@seleniumhq/side-utils';
 import commander from 'commander';
 import logger from 'cli-logger';
-import yaml  from 'js-yaml';
-import Mocha from 'mocha';
 import glob from 'glob';
-import createClone from 'rfdc';
-import { fileURLToPath } from 'url';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-
-const clone = createClone();
-
-const { project: projectProcessor } = pkg;
-import { exec } from "child_process";
-
+import spawn from 'cross-spawn';
+import * as dotenv from 'dotenv'; 
+import { exit } from 'process';
+dotenv.config();
 commander
   .usage('[options] project.side [project.side] [*.side]')
   .option('-d, --debug', 'output extra debugging')
   .option('-f, --filter <grep regex>', 'Run tests matching name')
-  .option('-w, --max-workers <number>', 'Maximum amount of workers that will run your tests, defaults to 1')
   .option('--base-url <url>', 'Override the base URL that was set in the IDE')
-  .option('--config, --config-file <filepath>', 'Use specified YAML file for configuration. (default: .side.yml)')
-  .option('--test-timeout <ms>', 'Timeout value for each tests. (default: 30000)')
-  .option('--output-directory <directory>', 'Write test results to files, format is defined by --output-format')
-  .option('--output-format <@mochajs/json-file-reporter|xunit>', 'Format for the output file. (default: @mochajs/json-file-reporter)')
+  .option('--test-timeout <ms>', 'Timeout value for each tests (default: 30000)')
+  .option('--browserstack.config <path>','path to browserstack config file, default to browserstack.yml')
+  .option('--output-format <json|xunit>', 'Format for the output file.')
+  .option('--output-file <path>','path for the report file. required if --output-format provided')
 
 commander.parse(process.argv);
 const options = commander.opts();
-
-options.maxWorkers = options.maxWorkers ? options.maxWorkers : 1
 options.testTimeout = options.testTimeout ? options.testTimeout : 30000
-options.configFile = options.configFile ? options.configFile : '.side.yml'
 options.filter = options.filter ? options.filter : ''
-options.outputFormat = options.outputFormat ? options.outputFormat : '@mochajs/json-file-reporter'
+options.browserstackConfig = options['browserstack.config'] ? options['browserstack.config'] : 'browserstack.yml'
 options.buildFolderPath = '_generated'
-
 var conf = {level: options.debug ? logger.DEBUG :logger.INFO};
 var log = logger(conf);
 
@@ -54,69 +41,60 @@ const sideFiles = [
   }, new Set()),
 ];
 
-var mocha = new Mocha(
-{
-    reporter: "mocha-multi-reporters",
-    grep: options.filter,
-    parallel: true,
-    jobs: options.maxWorkers,
-    timeout: options.testTimeout,
-    reporterOptions: {
-          "reporterEnabled": "spec" + (options.outputDirectory ? ', ' + options.outputFormat :''),
-          "mochajsJsonFileReporterReporterOptions": {
-            "output": path.join(options.outputDirectory || '', "test-output.json")
-          },
-          "xunitReporterOptions": {
-            "output": path.join(options.outputDirectory || '', "test-output.xunit.xml")
-          },
-      }
-});
-
-
 rimraf.sync(options.buildFolderPath)
 fs.mkdirSync(options.buildFolderPath);
 
-var config
-try {
-  config = yaml.load(fs.readFileSync(options.configFile));
-} catch (e) {
-  log.error(e);
+function readFile(filename) {
+  return JSON.parse(
+    fs.readFileSync(
+      path.join(
+        '.',
+        filename
+      )
+    )
+  )
+}
+
+function normalizeProject(project) {
+  let _project = { ...project }
+  _project.suites.forEach(suite => {
+    projectProcessor.normalizeTestsInSuite({ suite, tests: _project.tests })
+  })
+  _project.url = options.baseUrl ? options.baseUrl : project.url
+  return _project
 }
 
-const projects = sideFiles.map(name => JSON.parse(fs.readFileSync(name)))
-var testFileInc = 1;
-var promises = [];
-projects.forEach(project => {
-  project.tests.forEach(test => {
-    promises.push(new Promise(async (resolve, reject) => {
-    var _config = clone(config);
-    _config.capabilities['name'] = test.name
-    if(_config.capabilities['bstack:options'] == undefined)
+for(const sideFileName of sideFiles)
+{
+  const project = normalizeProject(readFile(sideFileName))
+  for(const aSuite of project.suites)
+  {
+    for(const aTestCase of aSuite.tests)
     {
-      _config.capabilities['bstack:options'] = []
+      const test = project.tests.find(test => test.name === aTestCase);
+      var results = await codeExport.default.emit.test({
+        baseUrl: options.baseUrl ? options.baseUrl : project.url,
+        test: test,
+        tests: project.tests,
+        project: project
+      })
+      fs.writeFileSync( path.join(
+        options.buildFolderPath,
+        results.filename
+      ), results.body);
     }
-    _config.capabilities['bstack:options']['sessionName'] = test.name
-    var packageJson = JSON.parse(fs.readFileSync(__dirname + '/package.json'));
-    _config.capabilities['browserstack-side-runner-version'] = packageJson.version
-    const result = await emitTest({
-      baseUrl: options.baseUrl ? options.baseUrl : project.url,
-      test: test,
-      tests: project.tests,
-      beforeEachOptions: {
-        capabilities: _config.capabilities,
-        gridUrl: _config.server,
-      },});
-    var filename = path.join(options.buildFolderPath, testFileInc + result.filename);
-    testFileInc ++;
-    fs.writeFileSync(filename, result.body);
-    mocha.addFile(filename);
-    resolve()}))
-  })
-});
-Promise.all(promises).then(()=>{
-  mocha.run(function(failures) {
-    process.exitCode = failures ? 1 : 0;  // exit with non-zero status if there were failures
-    if(!options.debug) rimraf.sync(options.buildFolderPath)
-  });
+  }
+
+}
+
+var reporter = []
+if(options.outputFormat && options.outputFile)
+  reporter = [ '--reporter', options.outputFormat, '--reporter-options', 'output=' + options.outputFile]
+
+const testSuiteProcess = spawn.sync('npx', ['browserstack-node-sdk', 'mocha', '_generated', '--timeouts', options.testTimeout, '-g', options.filter, '--browserstack.config', options.browserstackConfig, ...reporter], { stdio: 'inherit', env: { ...process.env, testTimeout: options.testTimeout } });
 
-})
+if(!options.debug)
+{
+  rimraf.sync(options.buildFolderPath)
+}
+exit(testSuiteProcess.status)

package.json

@@ -1,13 +1,12 @@
 {
   "name": "@maxmattone/browserstack-side-runner",
-  "repository": "git@github.com:mattonem/browserstack-side-runner.git",
-  "version": "1.5.0",
-  "main": "index.mjs",
-  "homepage": "https://github.com/mattonem/browserstack-side-runner#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mattonem/browserstack-side-runner.git"
   },
+  "version": "2.0.0",
+  "main": "index.mjs",
+  "homepage": "https://github.com/mattonem/browserstack-side-runner#readme",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -18,10 +17,15 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@maxmattone/code-export-browserstack-mocha": "^1.2.0",
     "@mochajs/json-file-reporter": "^1.3.0",
+    "@seleniumhq/code-export-javascript-mocha": "^4.0.0-alpha.4",
+    "@seleniumhq/side-code-export": "^4.0.0-alpha.3",
+    "@seleniumhq/side-utils": "^3.17.2",
+    "browserstack-node-sdk": "^1.25.2",
     "cli-logger": "^0.5.40",
     "commander": "^8.0.0",
+    "cross-spawn": "^7.0.3",
+    "dotenv": "^16.0.3",
     "glob": "^7.1.7",
     "js-yaml": "^4.1.0",
     "mocha": "^8.4.0",