Add tests for debug output (#156)

Author: existentialism

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 lib
+test/tmp
 .DS_Store
 *.log
-.vscode
+.vscode

CONTRIBUTING.md

@@ -34,3 +34,22 @@ Until `compat-table` is a standalone npm module for data we are using the git ur
 `"compat-table": "github:kangax/compat-table#gh-pages",`
 
 So we update and then run `npm run build-data`. If there are no changes, then `plugins.json` will be the same.
+
+### Writing Tests
+
+#### General
+
+All the tests for `babel-preset-env` exist in the `test/fixtures` folder. The
+test setup and conventions are exactly the same as testing a Babel plugin, so
+please read our [documentation on writing tests](https://github.com/babel/babel/blob/master/CONTRIBUTING.md#babel-plugin-x).
+
+#### Testing the `debug` option
+
+Testing debug output to `stdout` is similar. Under the `test/debug-fixtures`, 
+create a folder with a descriptive name of your test, and add the following:
+
+* Add a `options.json` file (just as the other tests, this is essentially a 
+`.babelrc`) with the desired test configuration (required)
+* Add a `stdout.txt` file with the expected debug output. For added 
+convenience, if there is no `stdout.txt` present, the test runner will 
+generate one for you.

package.json

@@ -52,14 +52,17 @@
  "devDependencies": {
  "babel-cli": "^6.11.4",
  "babel-eslint": "^7.1.1",
+ "babel-helper-fixtures": "^6.22.0",
  "babel-helper-plugin-test-runner": "^6.18.0",
  "babel-plugin-transform-flow-strip-types": "^6.8.0",
  "babel-preset-es2015": "^6.14.0",
  "babel-register": "^6.14.0",
+ "chai": "^3.0.0",
  "compat-table": "kangax/compat-table#b0cec63ea21f3a7788a8eececcb918de903b7fc5",
  "eslint": "^3.13.1",
  "eslint-config-babel": "^5.0.0",
  "eslint-plugin-flowtype": "^2.29.1",
+ "fs-extra": "^2.0.0",
  "lodash": "^4.15.0",
  "mocha": "^3.0.2",
  "rimraf": "^2.5.4"

src/normalize-options.js

@@ -21,7 +21,12 @@ export const validateIncludesAndExcludes = (opts = [], type) => {
  `Invalid Option: The '${type}' option must be an Array<String> of plugins/built-ins`
  );
 
- const unknownOpts = opts.filter((opt) => !validIncludesAndExcludes.includes(opt));
+ const unknownOpts = [];
+ opts.forEach((opt) => {
+ if (validIncludesAndExcludes.indexOf(opt) === -1) {
+ unknownOpts.push(opt);
+ }
+ });
 
  invariant(
  unknownOpts.length === 0,
@@ -56,7 +61,7 @@ export const validateLooseOption = (looseOpt = false) => {
 
 export const validateModulesOption = (modulesOpt = "commonjs") => {
  invariant(
- modulesOpt === false || Object.keys(moduleTransformations).includes(modulesOpt),
+ modulesOpt === false || Object.keys(moduleTransformations).indexOf(modulesOpt) > -1,
  `Invalid Option: The 'modules' option must be either 'false' to indicate no modules, or a
  module type which can be be one of: 'commonjs' (default), 'amd', 'umd', 'systemjs'.`
  );

test/debug-fixtures.js

@@ -0,0 +1,104 @@
+const chai = require("chai");
+const child = require("child_process");
+const fs = require("fs-extra");
+const helper = require("babel-helper-fixtures");
+const path = require("path");
+
+const fixtureLoc = path.join(__dirname, "debug-fixtures");
+const tmpLoc = path.join(__dirname, "tmp");
+
+const clear = () => {
+ process.chdir(__dirname);
+ if (fs.existsSync(tmpLoc)) fs.removeSync(tmpLoc);
+ fs.mkdirSync(tmpLoc);
+ process.chdir(tmpLoc);
+};
+
+const saveInFiles = (files) => {
+ Object.keys(files).forEach((filename) => {
+ const content = files[filename];
+ fs.outputFileSync(filename, content);
+ });
+};
+
+const assertTest = (stdout, stderr, opts) => {
+ stderr = stderr.trim();
+
+ if (stderr) {
+ throw new Error("stderr:\n" + stderr);
+ }
+
+ stdout = stdout.trim();
+ stdout = stdout.replace(/\\/g, "/");
+
+ if (opts.stdout) {
+ const expectStdout = opts.stdout.trim();
+ chai.expect(stdout).to.equal(expectStdout, "stdout didn't match");
+ } else {
+ const file = path.join(opts.testLoc, "stdout.txt");
+ console.log(`New test file created: ${file}`);
+ fs.outputFileSync(file, stdout);
+ }
+};
+
+const buildTest = (opts) => {
+ const binLoc = path.join(process.cwd(), "node_modules/.bin/babel");
+
+ return (callback) => {
+ clear();
+ saveInFiles(opts.inFiles);
+
+ let args = [binLoc];
+ args = args.concat(opts.args);
+
+ const spawn = child.spawn(process.execPath, args);
+
+ let stdout = "";
+ let stderr = "";
+
+ spawn.stdout.on("data", (chunk) => stdout += chunk);
+ spawn.stderr.on("data", (chunk) => stderr += chunk);
+
+ spawn.on("close", () => {
+ let err;
+
+ try {
+ assertTest(stdout, stderr, opts);
+ } catch (e) {
+ err = e;
+ }
+
+ callback(err);
+ });
+ };
+};
+
+describe("debug output", () => {
+ fs.readdirSync(fixtureLoc).forEach((testName) => {
+ const testLoc = path.join(fixtureLoc, testName);
+
+ const opts = {
+ args: ["src", "--out-dir", "lib"],
+ testLoc: testLoc,
+ };
+
+ const stdoutLoc = path.join(testLoc, "stdout.txt");
+
+ if (fs.existsSync(stdoutLoc)) {
+ opts.stdout = helper.readFile(stdoutLoc);
+ }
+
+ const optionsLoc = path.join(testLoc, "options.json");
+
+ if (!fs.existsSync(optionsLoc)) {
+ throw new Error(`Debug test '${testName}' is missing an options.json file`);
+ }
+
+ opts.inFiles = {
+ "src/in.js": "",
+ ".babelrc": helper.readFile(optionsLoc),
+ };
+
+ it(testName, buildTest(opts));
+ });
+});

test/debug-fixtures/built-ins/options.json

@@ -0,0 +1,12 @@
+{
+ "presets": [
+ ["../../lib", {
+ "debug": true,
+ "targets": {
+ "browsers": "chrome >= 54, ie 10",
+ "node": 6
+ },
+ "useBuiltIns": true
+ }]
+ ]
+}

test/debug-fixtures/built-ins/stdout.txt

@@ -0,0 +1,113 @@
+babel-preset-env: `DEBUG` option
+
+Using targets:
+{
+ "chrome": 54,
+ "ie": 10,
+ "node": 6
+}
+
+Modules transform: commonjs
+
+Using plugins:
+ transform-es2015-arrow-functions {"ie":10}
+ transform-es2015-block-scoped-functions {"ie":10}
+ transform-es2015-block-scoping {"ie":10}
+ transform-es2015-classes {"ie":10}
+ transform-es2015-computed-properties {"ie":10}
+ check-es2015-constants {"ie":10}
+ transform-es2015-destructuring {"ie":10,"node":6}
+ transform-es2015-for-of {"ie":10,"node":6}
+ transform-es2015-function-name {"ie":10,"node":6}
+ transform-es2015-literals {"ie":10}
+ transform-es2015-object-super {"ie":10}
+ transform-es2015-parameters {"ie":10}
+ transform-es2015-shorthand-properties {"ie":10}
+ transform-es2015-spread {"ie":10}
+ transform-es2015-sticky-regex {"ie":10}
+ transform-es2015-template-literals {"ie":10}
+ transform-es2015-typeof-symbol {"ie":10}
+ transform-es2015-unicode-regex {"ie":10}
+ transform-regenerator {"ie":10}
+ transform-exponentiation-operator {"ie":10,"node":6}
+ transform-async-to-generator {"chrome":54,"ie":10,"node":6}
+ syntax-trailing-function-commas {"chrome":54,"ie":10,"node":6}
+
+Using polyfills:
+ es6.typed.uint8-clamped-array {"ie":10}
+ es6.map {"ie":10,"node":6}
+ es6.set {"ie":10,"node":6}
+ es6.weak-map {"ie":10,"node":6}
+ es6.weak-set {"ie":10,"node":6}
+ es6.reflect.apply {"ie":10,"node":6}
+ es6.reflect.construct {"ie":10,"node":6}
+ es6.reflect.define-property {"ie":10,"node":6}
+ es6.reflect.delete-property {"ie":10,"node":6}
+ es6.reflect.get {"ie":10,"node":6}
+ es6.reflect.get-own-property-descriptor {"ie":10,"node":6}
+ es6.reflect.get-prototype-of {"ie":10,"node":6}
+ es6.reflect.has {"ie":10,"node":6}
+ es6.reflect.is-extensible {"ie":10,"node":6}
+ es6.reflect.own-keys {"ie":10,"node":6}
+ es6.reflect.prevent-extensions {"ie":10,"node":6}
+ es6.reflect.set {"ie":10,"node":6}
+ es6.reflect.set-prototype-of {"ie":10,"node":6}
+ es6.promise {"ie":10,"node":6}
+ es6.symbol {"ie":10,"node":6}
+ es6.object.assign {"ie":10}
+ es6.object.is {"ie":10}
+ es6.object.set-prototype-of {"ie":10}
+ es6.function.name {"ie":10,"node":6}
+ es6.string.raw {"ie":10}
+ es6.string.from-code-point {"ie":10}
+ es6.string.code-point-at {"ie":10}
+ es6.string.repeat {"ie":10}
+ es6.string.starts-with {"ie":10}
+ es6.string.ends-with {"ie":10}
+ es6.string.includes {"ie":10}
+ es6.regexp.flags {"ie":10,"node":6}
+ es6.regexp.match {"ie":10}
+ es6.regexp.replace {"ie":10}
+ es6.regexp.split {"ie":10}
+ es6.regexp.search {"ie":10}
+ es6.array.from {"ie":10,"node":6}
+ es6.array.of {"ie":10}
+ es6.array.copy-within {"ie":10}
+ es6.array.find {"ie":10}
+ es6.array.find-index {"ie":10}
+ es6.array.fill {"ie":10}
+ es6.array.iterator {"ie":10}
+ es6.number.is-finite {"ie":10}
+ es6.number.is-integer {"ie":10}
+ es6.number.is-safe-integer {"ie":10}
+ es6.number.is-nan {"ie":10}
+ es6.number.epsilon {"ie":10}
+ es6.number.min-safe-integer {"ie":10}
+ es6.number.max-safe-integer {"ie":10}
+ es6.math.acosh {"ie":10}
+ es6.math.asinh {"ie":10}
+ es6.math.atanh {"ie":10}
+ es6.math.cbrt {"ie":10}
+ es6.math.clz32 {"ie":10}
+ es6.math.cosh {"ie":10}
+ es6.math.expm1 {"ie":10}
+ es6.math.fround {"ie":10}
+ es6.math.hypot {"ie":10}
+ es6.math.imul {"ie":10}
+ es6.math.log1p {"ie":10}
+ es6.math.log10 {"ie":10}
+ es6.math.log2 {"ie":10}
+ es6.math.sign {"ie":10}
+ es6.math.sinh {"ie":10}
+ es6.math.tanh {"ie":10}
+ es6.math.trunc {"ie":10}
+ es7.array.includes {"ie":10,"node":6}
+ es7.object.values {"ie":10,"node":6}
+ es7.object.entries {"ie":10,"node":6}
+ es7.object.get-own-property-descriptors {"ie":10,"node":6}
+ es7.string.pad-start {"chrome":54,"ie":10,"node":6}
+ es7.string.pad-end {"chrome":54,"ie":10,"node":6}
+ web.timers {"chrome":54,"ie":10,"node":6}
+ web.immediate {"chrome":54,"ie":10,"node":6}
+ web.dom.iterable {"chrome":54,"ie":10,"node":6}
+src/in.js -> lib/in.js

test/debug-fixtures/plugins-only/options.json

@@ -0,0 +1,15 @@
+{
+ "presets": [
+ ["../../lib", {
+ "debug": true,
+ "exclude": [
+ "transform-async-to-generator",
+ "transform-regenerator", "transform-es2015-parameters"
+ ],
+ "targets": {
+ "firefox": 52,
+ "node": 7.4
+ }
+ }]
+ ]
+}

test/debug-fixtures/plugins-only/stdout.txt

@@ -0,0 +1,18 @@
+babel-preset-env: `DEBUG` option
+
+Using targets:
+{
+ "firefox": 52,
+ "node": 7.4
+}
+
+Modules transform: commonjs
+
+Using plugins:
+ transform-es2015-destructuring {"firefox":52}
+ transform-es2015-for-of {"firefox":52}
+ transform-es2015-function-name {"firefox":52}
+ transform-es2015-literals {"firefox":52}
+ transform-exponentiation-operator {"node":7.4}
+ syntax-trailing-function-commas {"node":7.4}
+src/in.js -> lib/in.js

test/debug-fixtures/specific-targets/options.json

@@ -0,0 +1,11 @@
+{
+ "presets": [
+ ["../../lib", {
+ "debug": true,
+ "targets": {
+ "browsers": "ie 10, ios 9, safari 7, edge 13, chrome 54, firefox 49"
+ },
+ "useBuiltIns": true
+ }]
+ ]
+}