Add jest-environments.

Summary:Supersedes jestjs#873.

Moved a bunch more things around, moved common helpers to `jest-util`, added resolution for the `testEnvironment` config option and added documentation.
Closes jestjs#881

Differential Revision: D3162251

fb-gh-sync-id: 721b201e089ac5043367d52150f0c0e9f012217f
fbshipit-source-id: 721b201e089ac5043367d52150f0c0e9f012217f

Author: cpojer

CHANGELOG.md

@@ -7,7 +7,8 @@
   [#599](https://github.com/facebook/jest/pull/599)
 * Jasmine 2 is now the default test runner. To keep using Jasmine 1, put
   `testRunner: "jasmine1"` into your configuration.
-* Added `jest-util`, `jest-mock`, `jest-jasmine1`, `jest-jasmine2` packages.
+* Added `jest-util`, `jest-mock`, `jest-jasmine1`, `jest-jasmine2`,
+  `jest-environment-node`, `jest-environment-jsdom` packages.
 * Added `babel-jest-preset` and `babel-jest` as packages. `babel-jest` is now
   being auto-detected.
 * Added `babel-plugin-jest-hoist` which hoists `jest.unmock`, `jest.mock` and
@@ -41,6 +42,7 @@
 * Improved `toBeCalled` Jasmine 2 custom matcher messages.
 * Improved error reporting when a syntax error occurs.
 * Renamed HasteModuleLoader to Runtime.
+* Updated jsdom to 8.3.x.
 * Jest now properly reports pending tests disabled with `xit` and `xdescribe`.
 * Added a `testEnvironment` option to customize the sandbox environment.
 * Added support for `@scoped/name` npm packages.

VERSION

@@ -1 +1 @@
-10.0.0
+10.0.2

docs/API.md

@@ -64,6 +64,7 @@ Jest uses Jasmine 2 by default. An introduction to Jasmine 2 can be found
   - [`config.setupFiles` [array]](#config-setupfiles-array)
   - [`config.setupTestFrameworkScriptFile` [string]](#config-setuptestframeworkscriptfile-string)
   - [`config.testDirectoryName` [string]](#config-testdirectoryname-string)
+  - [`config.testEnvironment` [string]](#config-testenvironment-string)
   - [`config.testFileExtensions` [array<string>]](#config-testfileextensions-array-string)
   - [`config.testPathDirs` [array<string>]](#config-testpathdirs-array-string)
   - [`config.testPathIgnorePatterns` [array<string>]](#config-testpathignorepatterns-array-string)
@@ -483,6 +484,11 @@ The name of directories that Jest should expect to find tests in.
 
 For example, many node projects prefer to put their tests in a `tests` directory.
 
+### `config.testEnvironment` [string]
+(default: `'jsdom'`)
+
+The test environment that will be used for testing. The default environment in Jest is a browser-like environment through [jsdom](https://github.com/tmpvar/jsdom). If you are building a node service, you can use the `node` option to use a node-like environment instead.
+
 ### `config.testFileExtensions` [array<string>]
 (default: `['js']`)
 

package.json

@@ -9,11 +9,12 @@
     "diff": "^2.1.1",
     "graceful-fs": "^4.1.3",
     "istanbul": "^0.4.2",
+    "jest-environment-jsdom": "^10.0.1",
+    "jest-environment-node": "^10.0.1",
     "jest-jasmine1": "^10.0.1",
     "jest-jasmine2": "^10.0.1",
     "jest-mock": "^10.0.1",
     "jest-util": "^10.0.1",
-    "jsdom": "^7.2.0",
     "json-stable-stringify": "^1.0.0",
     "lodash.template": "^3.6.2",
     "mkdirp": "^0.5.1",
@@ -50,7 +51,7 @@
   "jest": {
     "rootDir": "src",
     "testPathIgnorePatterns": ["/__tests__/[^/]*/.+"],
-    "testEnvironment": "<rootDir>/environments/NodeEnvironment",
+    "testEnvironment": "jest-environment-node",
     "globals": {
       "CACHE_DIRECTORY": "<rootDir>/../.haste_cache"
     }

packages/babel-jest/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-jest",
-  "version": "10.0.1",
+  "version": "10.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/jest.git"
@@ -9,6 +9,6 @@
   "main": "src/index.js",
   "dependencies": {
     "babel-core": "^6.0.0",
-    "babel-preset-jest": "^10.0.1"
+    "babel-preset-jest": "^10.0.2"
   }
 }

packages/babel-plugin-jest-hoist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babel-plugin-jest-hoist",
-  "version": "10.0.1",
+  "version": "10.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/jest.git"
@@ -13,7 +13,7 @@
   },
   "jest": {
     "scriptPreprocessor": "../babel-jest",
-    "testEnvironment": "<rootDir>/../../src/environments/NodeEnvironment"
+    "testEnvironment": "../jest-environment-node"
   },
   "scripts": {
     "prepublish": "npm test",

packages/babel-preset-jest/package.json

@@ -1,13 +1,13 @@
 {
   "name": "babel-preset-jest",
-  "version": "10.0.1",
+  "version": "10.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/jest.git"
   },
   "license": "BSD-3-Clause",
   "main": "index.js",
   "dependencies": {
-    "babel-plugin-jest-hoist": "^10.0.1"
+    "babel-plugin-jest-hoist": "^10.0.2"
   }
 }

packages/jest-environment-jsdom/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "jest-environment-jsdom",
+  "version": "10.0.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/jest.git"
+  },
+  "license": "BSD-3-Clause",
+  "main": "src/index.js",
+  "dependencies": {
+    "jsdom": "^8.3.1",
+    "jest-util": "^10.0.2"
+  }
+}

src/environments/__mocks__/JSDOMEnvironment.js renamed to packages/jest-environment-jsdom/src/__mocks__/index.js

@@ -1,11 +1,15 @@
-// Copyright 2004-present Facebook. All Rights Reserved.
-
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
 'use strict';
 
-const utils = require.requireActual('jest-util');
 const vm = require.requireActual('vm');
 
-const JSDOMEnvironment = jest.genMockFromModule('../JSDOMEnvironment');
+const JSDOMEnvironment = jest.genMockFromModule('../index');
 
 JSDOMEnvironment.mockImplementation(function(config) {
   this.global = {
@@ -14,7 +18,7 @@ JSDOMEnvironment.mockImplementation(function(config) {
     JSON,
   };
 
-  const globalValues = utils.deepCopy(config.globals);
+  const globalValues = Object.assign({}, config.globals);
   for (const customGlobalKey in globalValues) {
     this.global[customGlobalKey] = globalValues[customGlobalKey];
   }

src/environments/JSDOMEnvironment.js renamed to packages/jest-environment-jsdom/src/index.js

@@ -7,8 +7,8 @@
  */
 'use strict';
 
-const FakeTimers = require('../lib/FakeTimers');
-const installCommonGlobals = require('./installCommonGlobals');
+const FakeTimers = require('jest-util/lib/FakeTimers');
+const installCommonGlobals = require('jest-util/lib/installCommonGlobals');
 
 class JSDOMEnvironment {
 

packages/jest-environment-node/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "jest-environment-node",
+  "version": "10.0.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/jest.git"
+  },
+  "license": "BSD-3-Clause",
+  "main": "src/index.js",
+  "dependencies": {
+    "jest-util": "^10.0.2"
+  },
+  "scripts": {
+    "test": "../../bin/jest.js"
+  }
+}

src/environments/__tests__/NodeEnvironment-test.js renamed to packages/jest-environment-node/src/__tests__/NodeEnvironment-test.js

@@ -1,10 +1,15 @@
-// Copyright 2004-present Facebook. All Rights Reserved.
-
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
 'use strict';
 
 jest.disableAutomock();
 
-const NodeEnvironment = require.requireActual('../NodeEnvironment');
+const NodeEnvironment = require.requireActual('../');
 
 describe('NodeEnvironment', () => {
 

src/environments/NodeEnvironment.js renamed to packages/jest-environment-node/src/index.js

@@ -7,8 +7,8 @@
  */
 'use strict';
 
-const FakeTimers = require('../lib/FakeTimers');
-const installCommonGlobals = require('./installCommonGlobals');
+const FakeTimers = require('jest-util/lib/FakeTimers');
+const installCommonGlobals = require('jest-util/lib/installCommonGlobals');
 const vm = require('vm');
 
 class NodeEnvironment {

packages/jest-jasmine1/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-jasmine1",
-  "version": "10.0.1",
+  "version": "10.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/jest.git"
@@ -9,12 +9,12 @@
   "main": "src/index.js",
   "dependencies": {
     "graceful-fs": "^4.1.3",
-    "jest-util": "^10.0.1"
+    "jest-util": "^10.0.2"
   },
   "scripts": {
     "test": "../../bin/jest.js"
   },
   "jest": {
-    "testEnvironment": "<rootDir>/../../src/environments/NodeEnvironment"
+    "testEnvironment": "node"
   }
 }

packages/jest-jasmine2/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-jasmine2",
-  "version": "10.0.1",
+  "version": "10.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/jest.git"
@@ -9,12 +9,12 @@
   "main": "src/index.js",
   "dependencies": {
     "graceful-fs": "^4.1.3",
-    "jest-util": "^10.0.1"
+    "jest-util": "^10.0.2"
   },
   "scripts": {
     "test": "../../bin/jest.js"
   },
   "jest": {
-    "testEnvironment": "<rootDir>/../../src/environments/NodeEnvironment"
+    "testEnvironment": "node"
   }
 }

packages/jest-mock/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-mock",
-  "version": "10.0.1",
+  "version": "10.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/jest.git"
@@ -9,5 +9,8 @@
   "main": "src/index.js",
   "scripts": {
     "test": "../../bin/jest.js"
+  },
+  "jest": {
+    "testEnvironment": "node"
   }
 }

packages/jest-util/index.js

@@ -22,21 +22,7 @@ function replacePathSepForRegex(str) {
   return str;
 }
 
-function deepCopy(obj) {
-  const newObj = {};
-  let value;
-  for (const key in obj) {
-    value = obj[key];
-    if (typeof value === 'object' && value !== null) {
-      value = deepCopy(value);
-    }
-    newObj[key] = value;
-  }
-  return newObj;
-}
-
 exports.cleanStackTrace = formatMessages.cleanStackTrace;
-exports.deepCopy = deepCopy;
 exports.escapeStrForRegex = escapeStrForRegex;
 exports.formatFailureMessage = formatMessages.formatFailureMessage;
 exports.replacePathSepForRegex = replacePathSepForRegex;

src/lib/FakeTimers.js renamed to packages/jest-util/lib/FakeTimers.js

@@ -46,7 +46,7 @@ class FakeTimers {
     // If there's a process.nextTick on the global, mock it out
     // (only applicable to node/node-emulating environments)
     if (typeof global.process === 'object'
-        && typeof global.process.nextTick === 'function') {
+      && typeof global.process.nextTick === 'function') {
       this._originalTimerAPIs.nextTick = global.process.nextTick;
       this._fakeTimerAPIs.nextTick = mocks.getMockFn().mockImpl(
         this._fakeNextTick.bind(this)
@@ -57,7 +57,7 @@ class FakeTimers {
     if (typeof global.setImmediate === 'function') {
       this._originalTimerAPIs.setImmediate = global.setImmediate;
       this._fakeTimerAPIs.setImmediate = mocks.getMockFn().mockImpl(
-          this._fakeSetImmediate.bind(this)
+        this._fakeSetImmediate.bind(this)
       );
       this._originalTimerAPIs.clearImmediate = global.clearImmediate;
       this._fakeTimerAPIs.clearImmediate = mocks.getMockFn().mockImpl(

packages/jest-util/lib/JasmineFormatter.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
  */
-
 'use strict';
 
 const diff = require('diff');

src/lib/__tests__/FakeTimers-test.js renamed to packages/jest-util/lib/__tests__/FakeTimers-test.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
  */
-
 'use strict';
 
 const chalk = require('chalk');

packages/jest-util/lib/formatMessages.js

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+'use strict';
+
+function deepCopy(obj) {
+  const newObj = {};
+  let value;
+  for (const key in obj) {
+    value = obj[key];
+    if (typeof value === 'object' && value !== null) {
+      value = deepCopy(value);
+    }
+    newObj[key] = value;
+  }
+  return newObj;
+}
+
+module.exports = (global, globals) => {
+  // Forward some APIs
+  global.Buffer = Buffer;
+
+  // `global.process` is mutated by FakeTimers. Make a copy of the
+  // object for the jsdom environment to prevent memory leaks.
+  global.process = Object.assign({}, process);
+  global.process.setMaxListeners = process.setMaxListeners.bind(process);
+  global.process.getMaxListeners = process.getMaxListeners.bind(process);
+  global.process.emit = process.emit.bind(process);
+  global.process.addListener = process.addListener.bind(process);
+  global.process.on = process.on.bind(process);
+  global.process.once = process.once.bind(process);
+  global.process.removeListener = process.removeListener.bind(process);
+  global.process.removeAllListeners = process.removeAllListeners.bind(process);
+  global.process.listeners = process.listeners.bind(process);
+  global.process.listenerCount = process.listenerCount.bind(process);
+
+  global.setImmediate = setImmediate;
+  global.clearImmediate = clearImmediate;
+
+  Object.assign(global, deepCopy(globals));
+};