Add some tests on the filtering method

Author: otroboe

README.md

@@ -5,7 +5,7 @@ Showing a list of settings on the `/settings` route.
 ## Requirements
 
 ### Global
-* [NodeJS](https://nodejs.org/en/download/)
+* [NodeJS](https://nodejs.org/en/download/) (only tested with `v11.6.0`).
 * [Yarn](https://yarnpkg.com/en/docs/install)
 
 ### Environment file
@@ -33,6 +33,11 @@ You can display the settings on http://localhost:8042/settings.
 yarn lint
 ```
 
+* Run tests
+```bash
+yarn test
+```
+
 * Build for production
 ```bash
 yarn build

package.json

@@ -11,14 +11,16 @@
     "start": "nodemon src/main.js",
     "build": "babel src -d dist",
     "serve": "node dist/main.js",
-    "lint": "eslint src/"
+    "lint": "eslint src/",
+    "test": "jest --coverage"
   },
   "devDependencies": {
     "babel-cli": "^6.26.0",
     "babel-preset-env": "^1.7.0",
     "eslint": "^5.12.0",
     "eslint-config-airbnb-base": "^13.1.0",
     "eslint-plugin-import": "^2.14.0",
+    "jest": "^23.6.0",
     "nodemon": "^1.18.9"
   },
   "dependencies": {
@@ -31,10 +33,14 @@
     "extends": "eslint-config-airbnb-base",
     "env": {
       "node": true,
-      "es6": true
+      "es6": true,
+      "jest": true
     },
     "rules": {
-      "arrow-parens": ["error", "as-needed"],
+      "arrow-parens": [
+        "error",
+        "as-needed"
+      ],
       "no-console": "off"
     }
   }

src/modules/SettingsRouter.test.js

@@ -0,0 +1,58 @@
+import SettingsRouter from './SettingsRouter';
+
+describe('SettingsRouter', () => {
+  describe('filterSettingsList', () => {
+    const settingList = [
+      {
+        name: 'Mixer',
+        requires: ['audio', 'pcb'],
+      }, {
+        name: 'AttractLoop',
+        requires: [],
+      }, {
+        name: 'Volume',
+        requires: ['audio'],
+      }, {
+        name: 'Dummy with no requires key',
+      }, {
+        name: 'Dummy with no listed components',
+        requires: ['component1', 'component2', 'component3'],
+      },
+    ];
+
+    const componentList = [
+      {
+        name: 'audio',
+      },
+      {
+        name: 'LED array',
+      },
+    ];
+
+    test('Should return an empty array with empty inputs', () => {
+      expect(SettingsRouter.filterSettingsList([], [])).toEqual([]);
+    });
+
+    test('Should only return the setting with no requirements if no component listed', () => {
+      expect(SettingsRouter.filterSettingsList(settingList, [])).toEqual([{
+        name: 'AttractLoop',
+        requires: [],
+      }]);
+    });
+
+    test('Should return the right filtered settings', () => {
+      expect(SettingsRouter.filterSettingsList(settingList, componentList)).toEqual([
+        {
+          name: 'Mixer',
+          requires: ['audio', 'pcb'],
+        }, {
+          name: 'AttractLoop',
+          requires: [],
+        }, {
+          name: 'Volume',
+          requires: ['audio'],
+        },
+      ]);
+    });
+  });
+});