added base for adding unit tests

Author: Sv443

.gitignore

@@ -16,6 +16,7 @@ node_modules/
 dev/madge/
 dependency-graph.html
 test.js
+!tools/test.js
 
 # Docs:
 docs/documentation.html

package.json

@@ -6,7 +6,7 @@
   "homepage": "https://sv443.net/jokeapi/v2",
   "scripts": {
     "start": "node . && exit $?",
-    "test": "snyk test && echo \"No test script specified\" && exit 0",
+    "test": "snyk test && node tools/test",
     "reformat": "node tools/reformat",
     "reassign-ids": "node tools/reassign-ids",
     "validate-jokes": "node tools/validate-jokes",

settings.js

@@ -188,11 +188,13 @@ const settings = {
         tokenValidHeader: "Token-Valid",     // the name of the token validity response header (normal case, not lower case)
         daemonInterval: 20, // after how many seconds the auth tokens should be refreshed
     },
-    languages:
-    {
+    languages: {
         langFilePath: "./data/languages.json",        // file containing all language codes and corresponding language information
         defaultLanguage: "en",                        // default language (two character code, lowercase)
         translationsFile: "./data/translations.json", // translations file
+    },
+    tests: { // unit tests
+        location: "./tests/",  // folder where unit tests are located - requires trailing slash
     }
 }
 

tests/joke-endpoint.js

@@ -0,0 +1,26 @@
+const settings = require("../settings");
+
+const meta = {
+    name: "Joke",
+    category: "Endpoints",
+    endpointURL: "/joke"
+};
+
+/**
+ * @typedef {Object} UnitTestResult
+ * @prop {String} name
+ * @prop {Boolean} success
+ */
+
+/**
+ * Runs this unit test
+ * @returns {Promise<Array<UnitTestResult>, String>}
+ */
+function run()
+{
+    return new Promise((resolve, reject) => {
+
+    });
+}
+
+module.exports = { meta, run };

tools/test.js

@@ -0,0 +1,15 @@
+const settings = require("../settings");
+
+
+
+function getAllTests()
+{
+
+}
+
+function runAllTests()
+{
+    let tests = getAllTests();
+}
+
+runAllTests();