Fix acceptance tests

Author: javierbrea

.gitignore

@@ -9,7 +9,7 @@
 # tests
 /coverage
 /mocks
-/test/acceptance/main/fixtures/files-watch
+/test/acceptance/fixtures/files-watch
 
 # misc
 .DS_Store

README.md

@@ -15,7 +15,7 @@ Please refer to the [project documentation website][website-url]:
 
 * [Get started](https://www.mocks-server.org/docs/get-started-intro)
 * [Tutorials](https://www.mocks-server.org/docs/tutorials-static)
-* [Configuration](https://www.mocks-server.org/docs/configuration-command-line-arguments)
+* [Configuration](https://www.mocks-server.org/docs/configuration-options)
 
 ## Why a mocks server?
 

jest.acceptance.config.js

@@ -6,7 +6,6 @@ module.exports = {
   clearMocks: true,
 
   testMatch: ["**/test/acceptance/**/?(*.)+(spec|test).js?(x)"],
-  //testMatch: ["**/test/acceptance/main/programmatic-cli.spec.js"],
 
   // Indicates whether the coverage information should be collected while executing the test
   collectCoverage: false,

package-lock.json

@@ -27,7 +27,7 @@
   ],
   "main": "index.js",
   "scripts": {
-    "lint": "eslint index.js lib test jest.config.js jest.acceptance.config.js",
+    "lint": "eslint index.js src test jest.config.js jest.acceptance.config.js",
     "lint-staged": "lint-staged",
     "test": "jest",
     "test-acceptance": "jest --config=jest.acceptance.config.js --runInBand",
@@ -54,10 +54,12 @@
     "prettier": "^1.19.1",
     "request": "^2.88.0",
     "request-promise": "^4.2.5",
-    "sinon": "^7.5.0"
+    "sinon": "^7.5.0",
+    "strip-ansi": "6.0.0",
+    "tree-kill-sync": "^1.0.0"
   },
   "lint-staged": {
-    "lib/**/*.js": "eslint",
+    "src/**/*.js": "eslint",
     "test/**/*.js": "eslint",
     "index.js": "eslint",
     "jest.config.js": "eslint",

package.json

@@ -0,0 +1,92 @@
+/*
+Copyright 2019 Javier Brea
+Copyright 2019 XbyOrange
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+*/
+
+"use strict";
+
+const childProcess = require("child_process");
+
+const treeKillSync = require("tree-kill-sync");
+const stripAnsi = require("strip-ansi");
+
+const ENCODING_TYPE = "utf8";
+
+module.exports = class CliRunner {
+  constructor(commandToExecute, options = {}) {
+    this._command = this.getCommandToExecute(commandToExecute);
+    this._cwd = options.cwd || process.cwd();
+    this._logs = [];
+
+    this._exitPromise = new Promise(resolve => {
+      this._resolveExitPromise = resolve;
+    });
+
+    this.logData = this.logData.bind(this);
+
+    this.run();
+  }
+
+  getCommandToExecute(command) {
+    return {
+      name: command[0],
+      params: command.splice(1, command.length - 1)
+    };
+  }
+
+  logData(data) {
+    const cleanData = stripAnsi(data.replace(/\x1Bc/, ""));
+    if (cleanData.length) {
+      this._logs.push(cleanData);
+    }
+  }
+
+  run() {
+    if (this._cliProcess) {
+      throw new Error("Cli is already running");
+    } else {
+      this._cliProcess = childProcess.spawn(this._command.name, this._command.params, {
+        cwd: this._cwd
+      });
+      this._cliProcess.stdin.setEncoding(ENCODING_TYPE);
+
+      this._cliProcess.stdout.setEncoding(ENCODING_TYPE);
+      this._cliProcess.stderr.setEncoding(ENCODING_TYPE);
+
+      this._cliProcess.stdout.on("data", this.logData);
+      this._cliProcess.stderr.on("data", this.logData);
+
+      this._cliProcess.on("close", code => {
+        this._exitCode = code;
+        this._resolveExitPromise(true);
+      });
+    }
+  }
+
+  async kill() {
+    treeKillSync(this._cliProcess.pid);
+    return this._exitPromise;
+  }
+
+  async hasExit() {
+    return this._exitPromise;
+  }
+
+  flush() {
+    this._logs = [];
+  }
+
+  get logs() {
+    return this._logs.join("");
+  }
+
+  get exitCode() {
+    return this._exitCode;
+  }
+};

test/acceptance/CliRunner.js

@@ -10,7 +10,7 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 const { startServer, stopServer, request, changeBehavior, getBehaviors } = require("./utils");
 
-describe("web tutorial", () => {
+describe("API for changing current behavior", () => {
   let server;
 
   beforeAll(async () => {

…/acceptance/main/change-behavior.spec.js test/acceptance/change-behavior.spec.jstest/acceptance/main/change-behavior.spec.js renamed to test/acceptance/change-behavior.spec.js test/acceptance/main/change-behavior.spec.js renamed to test/acceptance/change-behavior.spec.js

@@ -11,34 +11,36 @@ Unless required by applicable law or agreed to in writing, software distributed
 const path = require("path");
 const fsExtra = require("fs-extra");
 const {
-  CliRunner,
   request,
   changeBehavior,
   getBehaviors,
   fixturesFolder,
-  wait
+  wait,
+  CliRunner
 } = require("./utils");
-const InteractiveCliRunner = require("./InteractiveCliRunner");
 
-const runTests = interactiveCli => {
-  describe("When started", () => {
+describe("Plugin listening to core events", () => {
+  let cli;
+
+  beforeAll(async () => {
+    fsExtra.removeSync(fixturesFolder("files-watch"));
+    fsExtra.copySync(fixturesFolder("web-tutorial"), fixturesFolder("files-watch"));
+    cli = new CliRunner(["node", "start-files-watch.js"], {
+      cwd: path.resolve(__dirname, "fixtures")
+    });
+    await wait(1000);
+  });
+
+  afterAll(async () => {
+    await cli.kill();
+  });
+
+  describe("When server is started", () => {
     it("should have 3 behaviors available", async () => {
       const behaviors = await getBehaviors();
       expect(behaviors.length).toEqual(3);
     });
 
-    if (interactiveCli) {
-      it("should display available behaviors in CLI", async () => {
-        await wait(500);
-        expect(interactiveCli.cli.logs).toEqual(expect.stringContaining("Behaviors: 3"));
-      });
-      it("should display current behavior in CLI", async () => {
-        expect(interactiveCli.cli.logs).toEqual(
-          expect.stringContaining("Current behavior: standard")
-        );
-      });
-    }
-
     it("should serve users collection mock under the /api/users path", async () => {
       const users = await request("/api/users");
       expect(users).toEqual([
@@ -70,12 +72,6 @@ const runTests = interactiveCli => {
         expect(behaviors.length).toEqual(4);
       });
 
-      if (interactiveCli) {
-        it("should display available behaviors in CLI", async () => {
-          expect(interactiveCli.cli.logs).toEqual(expect.stringContaining("Behaviors: 4"));
-        });
-      }
-
       it("should serve users collection mock under the /api/users path", async () => {
         const users = await request("/api/users");
         expect(users).toEqual([
@@ -100,15 +96,6 @@ const runTests = interactiveCli => {
         await changeBehavior("user2");
       });
 
-      if (interactiveCli) {
-        it("should display current behavior in CLI", async () => {
-          await wait(500);
-          expect(interactiveCli.cli.logs).toEqual(
-            expect.stringContaining("Current behavior: user2")
-          );
-        });
-      }
-
       it("should serve users collection mock under the /api/users path", async () => {
         const users = await request("/api/users");
         expect(users).toEqual([
@@ -133,15 +120,6 @@ const runTests = interactiveCli => {
         await changeBehavior("dynamic");
       });
 
-      if (interactiveCli) {
-        it("should display current behavior in CLI", async () => {
-          await wait(500);
-          expect(interactiveCli.cli.logs).toEqual(
-            expect.stringContaining("Current behavior: dynamic")
-          );
-        });
-      }
-
       it("should serve users collection mock under the /api/users path", async () => {
         const users = await request("/api/users");
         expect(users).toEqual([
@@ -166,15 +144,6 @@ const runTests = interactiveCli => {
         await changeBehavior("newOne");
       });
 
-      if (interactiveCli) {
-        it("should display current behavior in CLI", async () => {
-          await wait(500);
-          expect(interactiveCli.cli.logs).toEqual(
-            expect.stringContaining("Current behavior: newOne")
-          );
-        });
-      }
-
       it("should serve users collection mock under the /api/users path", async () => {
         const users = await request("/api/new-users");
         expect(users).toEqual([
@@ -194,47 +163,4 @@ const runTests = interactiveCli => {
       });
     });
   });
-};
-
-describe("files watcher", () => {
-  const binaryPath = "../../../../bin/mocks-server";
-  const cwdPath = path.resolve(__dirname, "fixtures");
-  const interactiveCli = {
-    cli: null
-  };
-
-  beforeAll(async () => {
-    fsExtra.removeSync(fixturesFolder("files-watch"));
-    fsExtra.copySync(fixturesFolder("web-tutorial"), fixturesFolder("files-watch"));
-    interactiveCli.cli = new InteractiveCliRunner([binaryPath, "--behaviors=files-watch"], {
-      cwd: cwdPath
-    });
-    await wait();
-  });
-
-  afterAll(async () => {
-    await interactiveCli.cli.kill();
-  });
-
-  runTests(interactiveCli);
-});
-
-describe("files watcher started using Server", () => {
-  const cwdPath = fixturesFolder("programmatic-server");
-  let cli;
-
-  beforeAll(async () => {
-    fsExtra.removeSync(fixturesFolder("files-watch"));
-    fsExtra.copySync(fixturesFolder("web-tutorial"), fixturesFolder("files-watch"));
-    cli = new CliRunner("start-watch.js", {
-      cwd: cwdPath
-    });
-    await wait();
-  });
-
-  afterAll(async () => {
-    await cli.kill();
-  });
-
-  runTests();
 });