Add behaviors api and acceptance tests

Author: javierbrea

src/Behaviors.js

@@ -0,0 +1,64 @@
+/*
+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 express = require("express");
+const Boom = require("@hapi/boom");
+
+const { PLUGIN_NAME } = require("./constants");
+
+class BehaviorsApi {
+  constructor(core) {
+    this._core = core;
+    this._tracer = core.tracer;
+    this._behaviors = this._core.behaviors;
+    this._router = express.Router();
+    this._router.get("/", this.getCollection.bind(this));
+    this._router.get("/:name", this.getModel.bind(this));
+  }
+
+  _parseModel(behavior) {
+    return {
+      name: behavior.name,
+      fixtures: behavior.fixtures.map(fixture => fixture.id),
+      extendedFrom: behavior.extendedFrom
+    };
+  }
+
+  _parseCollection() {
+    return this._behaviors.collection.map(this._parseModel);
+  }
+
+  getCollection(req, res) {
+    this._tracer.verbose(`${PLUGIN_NAME}: Sending behaviors | ${req.id}`);
+    res.status(200);
+    res.send(this._parseCollection());
+  }
+
+  getModel(req, res, next) {
+    const name = req.params.name;
+    this._tracer.verbose(`${PLUGIN_NAME}: Sending behavior ${name} | ${req.id}`);
+    const foundBehavior = this._behaviors.collection.find(behavior => behavior.name === name);
+    if (foundBehavior) {
+      res.status(200);
+      res.send(this._parseModel(foundBehavior));
+    } else {
+      next(Boom.notFound(`Behavior with name "${name}" was not found`));
+    }
+  }
+
+  get router() {
+    return this._router;
+  }
+}
+
+module.exports = BehaviorsApi;

src/Plugin.js

@@ -14,13 +14,15 @@ const express = require("express");
 const DeprecatedApi = require("./deprecated/Api");
 
 const Settings = require("./Settings");
+const Behaviors = require("./Behaviors");
 
 const {
   ADMIN_API_PATH_OPTION,
   ADMIN_API_DEPRECATED_PATHS_OPTION,
   DEFAULT_API_PATH,
   PLUGIN_NAME,
   SETTINGS_API_PATH,
+  BEHAVIORS_API_PATH,
   DEPRECATED_API_PATH
 } = require("./constants");
 
@@ -31,6 +33,7 @@ class Plugin {
     this._settings = this._core.settings;
     this._deprecatedApi = new DeprecatedApi(core);
     this._settingsApi = new Settings(this._core);
+    this._behaviorsApi = new Behaviors(this._core);
     core.addSetting({
       name: ADMIN_API_PATH_OPTION,
       type: "string",
@@ -59,6 +62,7 @@ class Plugin {
   _initRouter() {
     this._router = express.Router();
     this._router.use(SETTINGS_API_PATH, this._settingsApi.router);
+    this._router.use(BEHAVIORS_API_PATH, this._behaviorsApi.router);
   }
 
   _addDeprecatedRouter() {

src/constants.js

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

test/acceptance/behaviors-api.spec.js

@@ -0,0 +1,90 @@
+/*
+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 { startServer, stopServer, request } = require("./utils");
+
+describe("behaviors api", () => {
+  let server;
+  beforeAll(async () => {
+    server = await startServer("web-tutorial");
+  });
+
+  afterAll(() => {
+    stopServer(server);
+  });
+
+  describe("get /", () => {
+    it("should return current behaviors", async () => {
+      const settingsResponse = await request("/admin/behaviors");
+      expect(settingsResponse).toEqual([
+        {
+          extendedFrom: null,
+          fixtures: ["12e5f429b92f67d4ec2bf90940ec1135", "0dbc954f9d9c9f3f7996c60e63384c9e"],
+          name: "standard"
+        },
+        {
+          extendedFrom: "standard",
+          fixtures: [
+            "bd5292849ee3fda9fa8383837bb908e7",
+            "12e5f429b92f67d4ec2bf90940ec1135",
+            "0dbc954f9d9c9f3f7996c60e63384c9e"
+          ],
+          name: "user2"
+        },
+        {
+          extendedFrom: "standard",
+          fixtures: [
+            "e82af88532da929b0592925899eb056e",
+            "12e5f429b92f67d4ec2bf90940ec1135",
+            "0dbc954f9d9c9f3f7996c60e63384c9e"
+          ],
+          name: "dynamic"
+        }
+      ]);
+    });
+  });
+
+  describe("get /standard", () => {
+    it("should return standard behavior", async () => {
+      const settingsResponse = await request("/admin/behaviors/standard");
+      expect(settingsResponse).toEqual({
+        extendedFrom: null,
+        fixtures: ["12e5f429b92f67d4ec2bf90940ec1135", "0dbc954f9d9c9f3f7996c60e63384c9e"],
+        name: "standard"
+      });
+    });
+  });
+
+  describe("get /dynamic", () => {
+    it("should return standard behavior", async () => {
+      const settingsResponse = await request("/admin/behaviors/dynamic");
+      expect(settingsResponse).toEqual({
+        extendedFrom: "standard",
+        fixtures: [
+          "e82af88532da929b0592925899eb056e",
+          "12e5f429b92f67d4ec2bf90940ec1135",
+          "0dbc954f9d9c9f3f7996c60e63384c9e"
+        ],
+        name: "dynamic"
+      });
+    });
+  });
+
+  describe("get unexistant behavior", () => {
+    it("should return a not found error", async () => {
+      const settingsResponse = await request("/admin/behaviors/foo", {
+        resolveWithFullResponse: true,
+        simple: false
+      });
+      expect(settingsResponse.statusCode).toEqual(404);
+      expect(settingsResponse.body.message).toEqual('Behavior with name "foo" was not found');
+    });
+  });
+});