yeoman-test 5.1.0 → 6.3.0

package/README.md

@@ -22,7 +22,7 @@ $ npm install --save-dev yeoman-generator@xxx yeoman-environment@xxx
 
 Usage:
 
-```
+```js
 describe('generator test', () => {
   describe('test', () => {
     let runResult;
@@ -66,7 +66,10 @@ describe('generator test', () => {
 });
 ```
 
-[See our api documentation](https://yeoman.github.io/yeoman-test)
+[See our api documentation](https://yeoman.github.io/yeoman-test) for latest yeoman-test release.
+
+[See our api documentation](https://yeoman.github.io/yeoman-test/5.0.1) for yeoman-test 5.0.1. Use 5.x for yeoman-environment 2.x support.
+
 [See our api documentation](https://yeoman.github.io/yeoman-test/2.x) for yeoman-test 2.x.
 
 [See our documentation](http://yeoman.io/authoring/testing.html) for yeoman-test 2.x.

package/lib/index.js

@@ -1,7 +1,13 @@
 /* eslint-disable max-params */
 
 'use strict';
-const fs = require('fs');
+const {
+  writeFile,
+  mkdirSync,
+  existsSync,
+  rmdirSync,
+  rmSync = rmdirSync
+} = require('fs');
 const _ = require('lodash');
 const path = require('path');
 const sinon = require('sinon');
@@ -59,7 +65,7 @@ YeomanTest.prototype.gruntfile = function (options, done) {
 
   const out = ['module.exports = function (grunt) {', config, '};'];
 
-  fs.writeFile('Gruntfile.js', out.join('\n'), done);
+  writeFile('Gruntfile.js', out.join('\n'), done);
 };
 
 /**
@@ -85,11 +91,11 @@ YeomanTest.prototype.testDirectory = function (dir, cb) {
   process.chdir('/');
 
   try {
-    if (fs.existsSync(dir)) {
-      fs.rmdirSync(dir, {recursive: true});
+    if (existsSync(dir)) {
+      rmSync(dir, {recursive: true});
     }
 
-    fs.mkdirSync(dir, {recursive: true});
+    mkdirSync(dir, {recursive: true});
     process.chdir(dir);
     cb();
   } catch (error) {

package/lib/run-context.js

@@ -1,12 +1,13 @@
 'use strict';
 const crypto = require('crypto');
-const fs = require('fs');
+const {existsSync, rmdirSync, rmSync = rmdirSync} = require('fs');
 const path = require('path');
-const os = require('os');
 const assert = require('assert');
 const _ = require('lodash/string');
 const util = require('util');
 const {EventEmitter} = require('events');
+const tempDirectory = require('temp-dir');
+
 const RunResult = require('./run-result');
 
 /**
@@ -137,16 +138,25 @@ RunContext.prototype.build = function (callback = () => {}) {
     this.env.registerStub(this.Generator, namespace, this.settings.resolved);
   }
 
-  this.generator = this.env.create(namespace, {
-    arguments: this.args,
-    options: this.options
+  this._generatorPromise = Promise.resolve(
+    this.env.create(namespace, {
+      arguments: this.args,
+      options: this.options
+    })
+  );
+
+  this._generatorPromise.then((generator) => {
+    this.generator = generator;
   });
 
   this.helpers.mockPrompt(this.env, this.answers, this.promptOptions);
 
   if (this.localConfig) {
     // Only mock local config when withLocalConfig was called
-    this.helpers.mockLocalConfig(this.generator, this.localConfig);
+    this._generatorPromise = this._generatorPromise.then((generator) => {
+      this.helpers.mockLocalConfig(generator, this.localConfig);
+      return generator;
+    });
   }
 
   callback(this);
@@ -162,7 +172,8 @@ RunContext.prototype._run = function () {
   this.buildAsync = true;
   if (this.build() === false) return false;
 
-  this.emit('ready', this.generator);
+  this._generatorPromise.then((generator) => this.emit('ready', generator));
+
   this.run()
     .catch((error) => {
       if (
@@ -187,8 +198,8 @@ RunContext.prototype._run = function () {
 };
 
 /**
- * Run the generator on the environment and returns the promise.
- * @return {Promise} Promise
+ * Run the generator on the environment and promises a RunResult instance.
+ * @return {Promise<RunResult>} Promise a RunResult instance.
  */
 RunContext.prototype.run = function () {
   if (!this.settings.runEnvironment && this.buildAsync === undefined) {
@@ -199,17 +210,20 @@ RunContext.prototype.run = function () {
     this.build();
   }
 
-  return this.env
-    .runGenerator(this.generator)
-    .then(() => new RunResult(this._createRunResultOptions()))
-    .finally(() => {
-      this.helpers.restorePrompt(this.env);
-    });
+  return this._generatorPromise.then((generator) =>
+    this.env
+      .runGenerator(generator)
+      .then(() => new RunResult(this._createRunResultOptions()))
+      .finally(() => {
+        this.helpers.restorePrompt(this.env);
+      })
+  );
 };
 
 RunContext.prototype._createRunResultOptions = function () {
   return {
     env: this.env,
+    generator: this.generator,
     memFs: this.env.sharedFs,
     settings: {
       ...this.settings
@@ -344,7 +358,7 @@ RunContext.prototype.cd = function (dirPath) {
  */
 RunContext.prototype.inTmpDir = function (cb) {
   return this.inDir(
-    path.join(os.tmpdir(), crypto.randomBytes(20).toString('hex')),
+    path.join(tempDirectory, crypto.randomBytes(20).toString('hex')),
     cb
   );
 };
@@ -408,8 +422,8 @@ RunContext.prototype.cleanTestDirectory = function (force = false) {
     throw new Error('Cleanup test dir called with false tmpdir option.');
   }
 
-  if (this.targetDirectory && fs.existsSync(this.targetDirectory)) {
-    fs.rmdirSync(this.targetDirectory, {recursive: true});
+  if (this.targetDirectory && existsSync(this.targetDirectory)) {
+    rmSync(this.targetDirectory, {recursive: true});
   }
 };
 

package/lib/run-result.js

@@ -1,6 +1,6 @@
 'use strict';
 const assert = require('assert');
-const fs = require('fs');
+const {existsSync, readFileSync, rmdirSync, rmSync = rmdirSync} = require('fs');
 const MemFsEditor = require('mem-fs-editor');
 const path = require('path');
 
@@ -18,9 +18,14 @@ function convertArgs(args) {
   return Array.isArray(arg) ? arg : [arg];
 }
 
-module.exports = class RunResult {
+/**
+ * This class provides utilities for testing generated content.
+ */
+
+class RunResult {
   constructor(options = {cwd: process.cwd()}) {
     this.env = options.env;
+    this.generator = options.generator;
     this.cwd = options.cwd;
     this.oldCwd = options.oldCwd;
     this.memFs = options.memFs;
@@ -49,6 +54,28 @@ module.exports = class RunResult {
     );
   }
 
+  /**
+   * Return an object with fs changes.
+   * @param {Function} filter - parameter forwarded to mem-fs-editor#dump
+   * @returns {Object}
+   */
+  getSnapshot(filter) {
+    return this.fs.dump(this.cwd, filter);
+  }
+
+  /**
+   * Return an object with filenames with state.
+   * @param {Function} filter - parameter forwarded to mem-fs-editor#dump
+   * @returns {Object}
+   */
+  getStateSnapshot(filter) {
+    const snapshot = this.getSnapshot(filter);
+    Object.values(snapshot).forEach((dump) => {
+      delete dump.contents;
+    });
+    return snapshot;
+  }
+
   /**
    * Prints files names and contents from mem-fs
    * @param {...string} files - Files to print or empty for entire mem-fs
@@ -97,7 +124,7 @@ module.exports = class RunResult {
    */
   cleanup() {
     process.chdir(this.oldCwd);
-    fs.rmdirSync(this.cwd, {recursive: true});
+    rmSync(this.cwd, {recursive: true});
     return this;
   }
 
@@ -115,7 +142,7 @@ module.exports = class RunResult {
     if (this.fs) {
       file = this.fs.read(filename, 'utf8');
     } else {
-      file = fs.readFileSync(filename, 'utf8');
+      file = readFileSync(filename, 'utf8');
     }
 
     return json ? JSON.parse(file) : file;
@@ -127,7 +154,7 @@ module.exports = class RunResult {
       return this.fs.exists(filename);
     }
 
-    return fs.existsSync(filename);
+    return existsSync(filename);
   }
 
   /**
@@ -340,4 +367,6 @@ module.exports = class RunResult {
   assertNoJsonFileContent(filename, content) {
     this.assertNoObjectContent(this._readFile(filename, true), content);
   }
-};
+}
+
+module.exports = RunResult;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yeoman-test",
-  "version": "5.1.0",
+  "version": "6.3.0",
   "description": "Test utilities for Yeoman generators",
   "homepage": "http://yeoman.io/authoring/testing.html",
   "author": "The Yeoman Team",
@@ -23,25 +23,27 @@
   "devDependencies": {
     "coveralls": "^3.1.0",
     "husky": "^4.2.5",
-    "jsdoc": "^3.6.6",
+    "jsdoc": "^3.6.10",
     "lint-staged": "^10.2.11",
-    "mem-fs": "^1.2.0",
-    "mocha": "^8.0.1",
+    "mem-fs": "^2.1.0",
+    "mocha": "^9.2.0",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
     "tui-jsdoc-template": "^1.2.2",
     "xo": "^0.32.1",
-    "yeoman-environment": "^3.0.0",
+    "yeoman-environment": "^3.3.0",
     "yeoman-generator": "^5.0.0"
   },
   "dependencies": {
-    "inquirer": "^7.3.3",
-    "lodash": "^4.17.19",
-    "mem-fs-editor": "^8.0.0",
-    "sinon": "^9.0.2"
+    "inquirer": "^8.0.0",
+    "lodash": "^4.17.21",
+    "mem-fs-editor": "^9.0.0",
+    "sinon": "^10.0.0",
+    "temp-dir": "^2.0.0"
   },
   "peerDependencies": {
-    "yeoman-environment": "^3.0.0 || ^2.10.3",
+    "mem-fs": "^2.1.0",
+    "yeoman-environment": "^3.3.0",
     "yeoman-generator": "*"
   },
   "scripts": {