init from jest-runner-mocha

rogeliog · rogeliog · commit 7edb0fdfd6d4 · 2017-09-08T13:19:05.000-07:00
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,13 @@
+{
+  "presets": [
+    [
+      "env",
+      {
+        "useBuiltIns": true,
+        "targets": {
+          "node": "4"
+        }
+      }
+    ]
+  ]
+}
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1 @@
+undefined
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+**/node_modules
+build
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,18 @@
+{
+  "extends": ["airbnb-base", "prettier"],
+  "plugins": ["prettier", "jest"],
+  "rules": {
+    "no-underscore-dangle": 0,
+    "arrow-body-style": 0,
+    "prettier/prettier": [
+      "error",
+      {
+        "singleQuote": true,
+        "trailingComma": "all"
+      }
+    ]
+  },
+  "env": {
+    "jest/globals": true
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+node_modules
+projects
+yarn-error.log
+build
+coverage
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "8"
+  - "6"
+  - "4"
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,15 @@
+{
+    "editor.rulers": [80],
+    "files.exclude": {
+      "**/.git": true,
+      "**/node_modules": true,
+      "**/build": true
+    },
+    "prettier.parser": "flow",
+    "prettier.printWidth": 80,
+    "prettier.singleQuote": true,
+    "prettier.trailingComma": "all",
+    "prettier.semi": true,
+    "editor.formatOnSave": true,
+    "prettier.eslintIntegration": true
+  }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+### Setup up your dev environment
+
+1. Fork the repo and create your branch from `master`.
+   A guide on how to fork a repository: https://help.github.com/articles/fork-a-repo/
+   
+   Open terminal (e.g. Terminal, iTerm, Git Bash or Git Shell) and type:
+   ```sh
+   git clone https://github.com/<your_username>/jest-runner-utils
+   cd jest
+   git checkout -b my_branch
+   ```
+   Note:
+   Replace `<your_username>` with your GitHub username
+
+2. jest-runner-utils uses [Yarn](https://code.facebook.com/posts/1840075619545360)
+   for running development scripts. If you haven't already done so,
+   please [install yarn](https://yarnpkg.com/en/docs/install).
+
+3. Run `yarn`.
+   
+     ```sh
+    yarn
+    ```
+
+5. If you've changed APIs, update the documentation.
+
+6. Ensure the test suite passes via `yarn test`. To run the test suite you
+
+   ```sh
+   yarn test
+   ```
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,14 @@
+ARG NODE_VERSION=8
+FROM node:${NODE_VERSION}
+
+WORKDIR /app
+
+COPY package.json yarn.lock /app/
+
+RUN yarn --ignore-scripts
+
+COPY . .
+
+RUN yarn build
+
+CMD ["yarn", "test"]
diff --git a/README.md b/README.md
@@ -0,0 +1,83 @@
+# jest-runner-mocha
+
+[![Build Status](https://travis-ci.org/rogeliog/jest-runner-mocha.svg?branch=master)](https://travis-ci.org/rogeliog/jest-runner-mocha) [![npm version](https://badge.fury.io/js/jest-runner-mocha.svg)](https://badge.fury.io/js/jest-runner-mocha)
+
+An experimental Mocha runner for Jest
+
+This makes it easy to integrate existing Mocha projects with Jest.
+
+![runner](https://user-images.githubusercontent.com/574806/30088955-728bf97e-925e-11e7-9b25-6aac237085ca.gif)
+
+
+## Usage
+
+### Install
+
+Install `jest`_(it needs Jest 21+)_ and `jest-runner-mocha`
+
+```bash
+yarn add --dev jest jest-runner-mocha
+
+# or with NPM
+
+npm install --save-dev jest jest-runner-mocha
+
+```
+
+### Add it to your Jest config
+
+In your `package.json`
+```json
+{
+  "jest": {
+    "runner": "jest-runner-mocha"
+  }
+}
+```
+
+Or in `jest.config.js`
+```js
+module.exports = {
+  runner: 'jest-runner-mocha',
+}
+```
+
+### Run Jest
+```bash
+yarn jest
+```
+
+### Coverage
+
+Coverage works outside of the box, simply `yarn jest -- --coverage`
+
+You can also use other Jest options like [coveragePathIgnorePatterns](http://facebook.github.io/jest/docs/en/configuration.html#coveragepathignorepatterns-array-string) and [coverageReporters](http://facebook.github.io/jest/docs/en/configuration.html#coveragereporters-array-string)
+
+## Custom config options
+
+Create a `jest-runner-mocha.config.js` at the `<rootDir>` or your Jest project.
+
+- `ui`: (Optional) the UI used by mocha
+```js
+// example
+module.exports = {
+  ui: 'tdd',
+}
+```
+
+- `compiler`: (Optional) the used for adding a compile step to your mocha tests
+
+```js
+// example
+module.exports = {
+  compiler: '/absolute/path/to/babel-register/or/other/compiler',
+}
+```
+
+_NOTE: Eventually Jest will eventually have an option for configuring runners that will eliminate the need for `jest-runner-mocha.config.js`_
+
+
+## Known issues
+- It does not support any Mocha options except for `ui` and `compiler`
+- Support for compilers is very limited.
+- Does not support `jest --runInBand`
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1 @@
+module.exports = {};
diff --git a/lib/getRunner.js b/lib/getRunner.js
@@ -0,0 +1,98 @@
+require('babel-polyfill');
+const throat = require('throat');
+const pify = require('pify');
+const workerFarm = require('worker-farm');
+
+class CancelRun extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'CancelRun';
+  }
+}
+
+const getRunner = ({ testWorkerPath, extraOptions }) => {
+  class BaseTestRunner {
+    constructor(globalConfig) {
+      this._globalConfig = globalConfig;
+    }
+
+    // eslint-disable-next-line
+    async runTests(tests, watcher, onStart, onResult, onFailure, options) {
+      const farm = workerFarm(
+        {
+          autoStart: true,
+          maxConcurrentCallsPerWorker: 1,
+          maxConcurrentWorkers: this._globalConfig.maxWorkers,
+          maxRetries: 2, // Allow for a couple of transient errors.
+        },
+        testWorkerPath,
+      );
+
+      const mutex = throat(this._globalConfig.maxWorkers);
+      const worker = pify(farm);
+
+      const runTestInWorker = test =>
+        mutex(async () => {
+          if (watcher.isInterrupted()) {
+            throw new CancelRun();
+          }
+          await onStart(test);
+          const baseOptions = {
+            config: test.context.config,
+            globalConfig: this._globalConfig,
+            testPath: test.path,
+            rawModuleMap: watcher.isWatchMode()
+              ? test.context.moduleMap.getRawModuleMap()
+              : null,
+            options,
+          };
+
+          if (extraOptions) {
+            return Object.assign(
+              {},
+              baseOptions,
+              extraOptions(baseOptions, tests),
+            );
+          }
+
+          return worker(baseOptions);
+        });
+
+      const onError = async (err, test) => {
+        await onFailure(test, err);
+        if (err.type === 'ProcessTerminatedError') {
+          // eslint-disable-next-line no-console
+          console.error(
+            'A worker process has quit unexpectedly! ' +
+              'Most likely this is an initialization error.',
+          );
+          process.exit(1);
+        }
+      };
+
+      const onInterrupt = new Promise((_, reject) => {
+        watcher.on('change', state => {
+          if (state.interrupted) {
+            reject(new CancelRun());
+          }
+        });
+      });
+
+      const runAllTests = Promise.all(
+        tests.map(test =>
+          runTestInWorker(test)
+            .then(testResult => onResult(test, testResult))
+            .catch(error => onError(error, test)),
+        ),
+      );
+
+      const cleanup = () => workerFarm.end(farm);
+
+      return Promise.race([runAllTests, onInterrupt]).then(cleanup, cleanup);
+    }
+  }
+
+  return BaseTestRunner;
+};
+
+module.exports = getRunner;
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,5 @@
+import getRunner from './getRunner';
+
+module.exports = {
+  getRunner,
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,48 @@
+{
+  "name": "jest-runner-utils",
+  "version": "0.2.1",
+  "main": "build/index.js",
+  "author": "Rogelio Guzman <rogelioguzmanh@gmail.com>",
+  "description": "A set of utility functions for Jest runners",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rogeliog/jest-runner-utils.git"
+  },
+  "homepage": "https://github.com/rogeliog/jest-runner-utils",
+  "files": ["build/"],
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint .",
+    "watch": "babel lib -w --ignore **/*.test.js,integration -d build",
+    "build": "babel lib --ignore **/*.test.js,integration -d build",
+    "prepublish": "yarn build",
+    "format": "prettier --single-quote --trailing-comma all --write \"!(build)/**/*.js\""
+  },
+  "dependencies": {
+    "babel-plugin-istanbul": "4.1.4",
+    "babel-polyfill": "^6.26.0",
+    "babel-register": "6.26.0",
+    "lodash": "4.17.4",
+    "minimatch": "3.0.4",
+    "mocha": "3.5.0",
+    "pify": "3.0.0",
+    "throat": "4.1.0",
+    "worker-farm": "1.5.0"
+  },
+  "devDependencies": {
+    "babel-cli": "6.26.0",
+    "babel-jest": "21.0.0",
+    "babel-polyfill": "^6.26.0",
+    "babel-preset-env": "1.6.0",
+    "eslint": "4.5.0",
+    "eslint-config-airbnb-base": "11.3.2",
+    "eslint-config-prettier": "2.3.0",
+    "eslint-plugin-import": "2.7.0",
+    "eslint-plugin-jest": "20.0.3",
+    "eslint-plugin-prettier": "2.2.0",
+    "execa": "0.8.0",
+    "jest": "21.0.1",
+    "prettier": "1.5.3"
+  }
+}
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +language: node_js
 +node_js:
 +  - "8"
 +  - "6"
 +  - "4"