Add acceptance tests for all options in settings api

Author: javierbrea

src/Plugin.js

@@ -20,7 +20,8 @@ const {
   ADMIN_API_DEPRECATED_PATHS_OPTION,
   DEFAULT_API_PATH,
   PLUGIN_NAME,
-  SETTINGS_API_PATH
+  SETTINGS_API_PATH,
+  DEPRECATED_API_PATH
 } = require("./constants");
 
 class Plugin {
@@ -43,21 +44,55 @@ class Plugin {
       description: `Disable deprecated paths of ${PLUGIN_NAME}`,
       default: true
     });
+
+    this._onChangeSettings = this._onChangeSettings.bind(this);
   }
 
   async init() {
-    if (this._settings.get(ADMIN_API_DEPRECATED_PATHS_OPTION) === true) {
-      await this._deprecatedApi.init();
-    }
+    await this._deprecatedApi.init();
+    this._core.onChangeSettings(this._onChangeSettings);
+    this._initRouter();
+    this._addDeprecatedRouter();
     this._addRouter();
   }
 
-  _addRouter() {
+  _initRouter() {
     this._router = express.Router();
     this._router.use(SETTINGS_API_PATH, this._settingsApi.router);
+  }
+
+  _addDeprecatedRouter() {
+    if (
+      this._settings.get(ADMIN_API_DEPRECATED_PATHS_OPTION) === false &&
+      this._addedDeprecatedRouter
+    ) {
+      this._core.removeRouter(DEPRECATED_API_PATH, this._deprecatedApi.router);
+      this._addedDeprecatedRouter = false;
+    }
+    if (
+      this._settings.get(ADMIN_API_DEPRECATED_PATHS_OPTION) === true &&
+      !this._addedDeprecatedRouter
+    ) {
+      this._core.addRouter(DEPRECATED_API_PATH, this._deprecatedApi.router);
+      this._addedDeprecatedRouter = true;
+    }
+  }
 
-    this._core.addRouter(this._settings.get(ADMIN_API_PATH_OPTION), this._router);
-    return Promise.resolve();
+  _addRouter() {
+    if (this._previousRoutersPath) {
+      this._core.removeRouter(this._previousRoutersPath, this._router);
+    }
+    this._previousRoutersPath = this._settings.get(ADMIN_API_PATH_OPTION);
+    this._core.addRouter(this._previousRoutersPath, this._router);
+  }
+
+  _onChangeSettings(newSettings) {
+    if (newSettings.hasOwnProperty(ADMIN_API_DEPRECATED_PATHS_OPTION)) {
+      this._addDeprecatedRouter();
+    }
+    if (newSettings.hasOwnProperty(ADMIN_API_PATH_OPTION)) {
+      this._addRouter();
+    }
   }
 }
 

src/constants.js

@@ -13,5 +13,6 @@ module.exports = {
   ADMIN_API_DEPRECATED_PATHS_OPTION: "adminApiDeprecatedPaths",
   DEFAULT_API_PATH: "/admin",
   PLUGIN_NAME: "plugin-admin-api",
-  SETTINGS_API_PATH: "/settings"
+  SETTINGS_API_PATH: "/settings",
+  DEPRECATED_API_PATH: "/mocks"
 };

src/deprecated/Api.js

@@ -9,16 +9,12 @@ 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 express = require("express");
 
 const Behaviors = require("./Behaviors");
 const Settings = require("./Settings");
 
-const MOCKS_PATH = "/mocks";
-
-const { DEFAULT_API_PATH, PLUGIN_NAME } = require("../constants");
+const { DEFAULT_API_PATH, DEPRECATED_API_PATH, PLUGIN_NAME } = require("../constants");
 
 // TODO, deprecate mocks router
 
@@ -32,16 +28,20 @@ class Api {
     const behaviorsRouter = new Behaviors(this._core).router;
     this._router = express.Router();
     this._router.use((req, res, next) => {
-      this._core.tracer.deprecationWarn(`"${MOCKS_PATH}" ${PLUGIN_NAME} path`, DEFAULT_API_PATH);
+      this._core.tracer.deprecationWarn(
+        `"${DEPRECATED_API_PATH}" ${PLUGIN_NAME} path`,
+        DEFAULT_API_PATH
+      );
       next();
     });
 
     this._router.use("/features", behaviorsRouter);
     this._router.use("/behaviors", behaviorsRouter);
     this._router.use("/settings", new Settings(this._core.settings, this._tracer).router);
+  }
 
-    this._core.addCustomRouter(MOCKS_PATH, this._router);
-    return Promise.resolve();
+  get router() {
+    return this._router;
   }
 }
 

test/acceptance/settings.spec.js test/acceptance/settings-api.spec.jstest/acceptance/settings.spec.js renamed to test/acceptance/settings-api.spec.js

@@ -153,35 +153,100 @@ describe("settings api", () => {
         await request("/admin/settings", {
           method: "PATCH",
           body: {
-            port: 3001
+            port: 3101
           }
         });
         await wait(1000);
       });
 
       afterAll(async () => {
         await request("/admin/settings", {
+          port: 3101,
           method: "PATCH",
           body: {
-            port: 3000
+            port: 3100
           }
         });
         await wait(1000);
       });
 
       it("should return new port option when getting settings, using new port", async () => {
         const settingsResponse = await request("/admin/settings", {
-          port: 3001
+          port: 3101
         });
-        expect(settingsResponse.port).toEqual(3001);
+        expect(settingsResponse.port).toEqual(3101);
       });
 
       it("should serve user 2 under the /api/users/1 path using new port", async () => {
         const users = await request("/api/users/1", {
-          port: 3001
+          port: 3101
         });
         expect(users).toEqual({ id: 2, name: "Jane Doe" });
       });
     });
+
+    describe("when changing adminApiPath option", () => {
+      beforeAll(async () => {
+        await request("/admin/settings", {
+          method: "PATCH",
+          body: {
+            adminApiPath: "/administration"
+          }
+        });
+        await wait(1000);
+      });
+
+      afterAll(async () => {
+        await request("/administration/settings", {
+          method: "PATCH",
+          body: {
+            adminApiPath: "/admin"
+          }
+        });
+        await wait(1000);
+      });
+
+      it("should return new port adminApiPath when getting settings, using new admin api path", async () => {
+        const settingsResponse = await request("/administration/settings");
+        expect(settingsResponse.adminApiPath).toEqual("/administration");
+      });
+
+      it("should return not found adminApiPath when getting settings in old admin api path", async () => {
+        const settingsResponse = await request("/admin/settings", {
+          resolveWithFullResponse: true,
+          simple: false
+        });
+        expect(settingsResponse.statusCode).toEqual(404);
+      });
+    });
+
+    describe("without changing adminApiDeprecatedPaths option", () => {
+      it("should return current delay option in deprecated api path", async () => {
+        const settingsResponse = await request("/mocks/settings");
+        expect(settingsResponse).toEqual({
+          delay: 0
+        });
+      });
+    });
+
+    describe("when changing adminApiDeprecatedPaths option", () => {
+      beforeAll(async () => {
+        await request("/admin/settings", {
+          method: "PATCH",
+          body: {
+            adminApiDeprecatedPaths: false
+          }
+        });
+        await wait(1000);
+      });
+
+      it("should return not found when getting settings in deprecated admin api path", async () => {
+        const settingsResponse = await request("/mocks/settings", {
+          resolveWithFullResponse: true,
+          simple: false
+        });
+        expect(settingsResponse.statusCode).toEqual(404);
+      });
+    });
   });
 });

test/acceptance/settings-logs-api.spec.js

@@ -0,0 +1,60 @@
+/*
+Copyright 2019 Javier Brea
+
+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.
+*/
+const path = require("path");
+const fsExtra = require("fs-extra");
+
+const { CliRunner, request, fixturesFolder, wait } = require("./utils");
+
+describe("log option modified through api", () => {
+  let cli;
+  beforeAll(async () => {
+    cli = new CliRunner(["node", "start.js", "--path=web-tutorial", "--log=info"], {
+      cwd: path.resolve(__dirname, "fixtures")
+    });
+    await wait(1000);
+  });
+
+  afterAll(async () => {
+    await cli.kill();
+  });
+
+  describe("when started", () => {
+    it("should return log level when getting settings", async () => {
+      const settingsResponse = await request("/admin/settings");
+      expect(settingsResponse.log).toEqual("info");
+    });
+
+    it("should not have logged any log with verbose level", async () => {
+      expect(cli.logs).toEqual(expect.not.stringContaining("Mocks verbose"));
+    });
+  });
+
+  describe("when log level is changed to verbose", () => {
+    beforeAll(async () => {
+      await request("/admin/settings", {
+        method: "PATCH",
+        body: {
+          log: "verbose"
+        }
+      });
+      fsExtra.copySync(fixturesFolder("files-modification"), fixturesFolder("files-watch"));
+      await wait(1000);
+    });
+
+    it("should return new log level when getting settings", async () => {
+      const settingsResponse = await request("/admin/settings");
+      expect(settingsResponse.log).toEqual("verbose");
+    });
+
+    it("should have logged logs with verbose level", async () => {
+      expect(cli.logs).toEqual(expect.stringContaining("Mocks verbose"));
+    });
+  });
+});

test/acceptance/settings-watch-api.spec.js

@@ -0,0 +1,96 @@
+/*
+Copyright 2019 Javier Brea
+
+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.
+*/
+const path = require("path");
+const fsExtra = require("fs-extra");
+
+const { CliRunner, request, fixturesFolder, wait } = require("./utils");
+
+describe("watch option modified through api", () => {
+  let cli;
+  beforeAll(async () => {
+    fsExtra.removeSync(fixturesFolder("files-watch"));
+    fsExtra.copySync(fixturesFolder("web-tutorial"), fixturesFolder("files-watch"));
+    cli = new CliRunner(["node", "start.js", "--path=files-watch", "--watch=false"], {
+      cwd: path.resolve(__dirname, "fixtures")
+    });
+    await wait(1000);
+  });
+
+  afterAll(async () => {
+    await cli.kill();
+  });
+
+  describe("when started", () => {
+    it("should return watch disabled when getting settings", async () => {
+      const settingsResponse = await request("/admin/settings");
+      expect(settingsResponse.watch).toEqual(false);
+    });
+
+    it("should serve users collection mock under the /api/users path", async () => {
+      const users = await request("/api/users");
+      expect(users).toEqual([
+        { id: 1, name: "John Doe" },
+        { id: 2, name: "Jane Doe" }
+      ]);
+    });
+  });
+
+  describe("when watch is enabled and files are modified", () => {
+    beforeAll(async () => {
+      await request("/admin/settings", {
+        method: "PATCH",
+        body: {
+          watch: true
+        }
+      });
+      fsExtra.copySync(fixturesFolder("files-modification"), fixturesFolder("files-watch"));
+      await wait(1000);
+    });
+
+    it("should return watch enabled when getting settings", async () => {
+      const settingsResponse = await request("/admin/settings");
+      expect(settingsResponse.watch).toEqual(true);
+    });
+
+    it("should serve new users collection mock under the /api/users path", async () => {
+      const users = await request("/api/users");
+      expect(users).toEqual([
+        { id: 1, name: "John Doe modified" },
+        { id: 2, name: "Jane Doe modified" }
+      ]);
+    });
+  });
+
+  describe("when watch is disabled and files are modified", () => {
+    beforeAll(async () => {
+      await request("/admin/settings", {
+        method: "PATCH",
+        body: {
+          watch: false
+        }
+      });
+      fsExtra.copySync(fixturesFolder("web-tutorial"), fixturesFolder("files-watch"));
+      await wait(1000);
+    });
+
+    it("should return watch disabled when getting settings", async () => {
+      const settingsResponse = await request("/admin/settings");
+      expect(settingsResponse.watch).toEqual(false);
+    });
+
+    it("should serve new users collection mock under the /api/users path", async () => {
+      const users = await request("/api/users");
+      expect(users).toEqual([
+        { id: 1, name: "John Doe modified" },
+        { id: 2, name: "Jane Doe modified" }
+      ]);
+    });
+  });
+});