update modulebuilder with new patterns (#306)

* update modulebuilder with new patterns

Author: geoffhouse

src/modulebuilder/README.md

@@ -4,13 +4,14 @@ This folder is used to provide templates for BUG modulebuilder.
 
 Each folder should contain the following items:
 
--   a `builder.json` file containing metadata for the template
--   a `src` folder containing:
-    -   `container` - optional files to be built into a docker container
-    -   `client` - ReactJS files to be compiled into front-end code
-    -   `module.json` - metadata file for the module
+- a `builder.json` file containing metadata for the template
+- a `src` folder containing:
+    - `container` - optional files to be built into a docker container
+        - `Dockerfile.test` - optional Docker test image definition for module container tests
+    - `client` - ReactJS files to be compiled into front-end code
+    - `module.json` - metadata file for the module
 
-modulebuilder will prompt for the items listed in `fields`, and search `templatedfiles` for matching template tags replacing any that it finds.
+modulebuilder will prompt for the items listed in `fields`, and search `files` for matching template tags replacing any that it finds.
 
 Here's an example `builder.json` file:
 
@@ -20,7 +21,7 @@ Here's an example `builder.json` file:
     "description": "Example Template",
     "version": "1.0.0",
     "author": "Your Name",
-    "templatedfiles": [
+    "files": [
         "module.json"
     ],
     "fields": [

src/modulebuilder/cli.mjs

@@ -1,6 +1,6 @@
 import ejs from "ejs";
 import fs from "fs-extra";
-import glob from "glob";
+import { glob } from "glob";
 import inquirer from "inquirer";
 import path from "path";
 

src/modulebuilder/generic-with-jscontainer/builder.json

@@ -3,7 +3,13 @@
     "description": "Generic module with NodeJS backend container",
     "version": "1.0.0",
     "author": "Geoff House",
-    "files": ["module.json", "container/package.json", "client/components/ExampleList.jsx"],
+    "files": [
+        "module.json",
+        "container/package.json",
+        "container/package-lock.json",
+        "container/Dockerfile.test",
+        "client/components/ExampleList.jsx"
+    ],
     "fields": [
         {
             "name": "name",

src/modulebuilder/generic-with-jscontainer/src/container/jest.config.cjs

@@ -42,4 +42,5 @@ const moduleNameMapper = Object.entries(_moduleAliases).reduce((acc, [alias, tar
 module.exports = {
     testEnvironment: "node",
     moduleNameMapper,
+    testPathIgnorePatterns: ["<rootDir>/core/"],
 };

src/modulebuilder/generic-with-jscontainer/src/container/package.json

@@ -4,7 +4,7 @@
     "scripts": {
         "production": "node ./api/server",
         "development": "nodemon ./api/server",
-        "test": "jest"
+        "test": "docker build -f ./Dockerfile.test -t bug-module-test ../../../.. && docker run --rm --name bug-module-test-run bug-module-test sh -lc 'if find . -path ./node_modules -prune -o -type f -name \"*.test.js\" -print | grep -q . || find . -path ./node_modules -prune -o -type f -name \"*.spec.js\" -print | grep -q .; then if [ -f ./jest.config.cjs ]; then npx jest --runInBand --config ./jest.config.cjs; else npx jest --runInBand; fi; else echo \"No tests found, skipping.\"; fi'"
     },
     "nodemonConfig": {
         "ignore": [

src/modulebuilder/generic-with-jscontainer/src/container/services/example-enable.js

@@ -3,12 +3,13 @@
 const configGet = require("@core/config-get");
 const yourApi = require("@utils/your-api");
 const deviceSetPending = require("@services/device-setpending");
+const logger = require("@core/logger")(module);
 
 module.exports = async (id) => {
     try {
         const config = await configGet();
 
-        console.log(`example-enable: enabling item ${id} ...`);
+        logger.info(`enabling item ${id} ...`);
 
         // enable the item on the device
         await yourApi({
@@ -20,7 +21,7 @@ module.exports = async (id) => {
             commands: ["enable"],
         });
 
-        console.log(`example-enable: success - updating DB`);
+        logger.info("success - updating DB");
 
         // update the DB to reflect enabled interface
         const itemCollection = await mongoCollection("items");
@@ -29,7 +30,7 @@ module.exports = async (id) => {
             { $set: { enabled: true } }
         );
 
-        console.log(`example-enable: ${JSON.stringify(dbResult.result)}`);
+        logger.info(`${JSON.stringify(dbResult.result)}`);
         await deviceSetPending(true);
         return true;
 

src/modulebuilder/generic-with-jscontainer/src/container/workers/worker-example.js

@@ -6,6 +6,7 @@ const register = require("module-alias/register");
 const mongoDb = require("@core/mongo-db");
 const mongoSingle = require("@core/mongo-single");
 const axios = require("axios");
+const logger = require("@core/logger")(module);
 
 // Tell the manager the things you care about
 // make sure you add an array of config fields in 'restartOn' - the worker will restart whenever these are updated
@@ -20,7 +21,7 @@ const main = async () => {
         await mongoDb.connect(workerData.id);
 
         // Kick things off
-        console.log(`worker-example: doing something ...`);
+        logger.debug("doing something ...");
 
         // use an infinite loop
         while (true) {
@@ -33,14 +34,14 @@ const main = async () => {
             await delay(300000);
         }
     } catch (err) {
-        console.error(`worker-example: fatal error`);
-        console.error(err.stack || err.message || err);
+        logger.error("fatal error");
+        logger.error(err.stack || err.message || err);
         process.exit();
     }
 };
 
 main().catch(err => {
-    console.error("worker-example: startup failure");
-    console.error(err.stack || err.message || err);
+    logger.error("startup failure");
+    logger.error(err.stack || err.message || err);
     process.exit(1);
 });

src/modulebuilder/network-switch/builder.json

@@ -3,7 +3,7 @@
     "description": "Generic network switch module",
     "version": "1.0.0",
     "author": "Geoff House",
-    "files": ["module.json", "container/package.json", "client/components/ExampleList.jsx"],
+    "files": ["module.json", "container/package.json", "container/package-lock.json", "container/Dockerfile.test"],
     "fields": [
         {
             "name": "name",

src/modulebuilder/network-switch/src/container/package-lock.json

@@ -4,7 +4,7 @@
     "scripts": {
         "production": "node ./api/server",
         "development": "nodemon ./api/server",
-        "test": "jest"
+        "test": "docker build -f ./Dockerfile.test -t bug-module-test ../../../.. && docker run --rm --name bug-module-test-run bug-module-test sh -lc 'if find . -path ./node_modules -prune -o -type f -name \"*.test.js\" -print | grep -q . || find . -path ./node_modules -prune -o -type f -name \"*.spec.js\" -print | grep -q .; then if [ -f ./jest.config.cjs ]; then npx jest --runInBand --config ./jest.config.cjs; else npx jest --runInBand; fi; else echo \"No tests found, skipping.\"; fi'"
     },
     "nodemonConfig": {
         "ignore": [
@@ -35,7 +35,7 @@
         "jest": "^30.2.0",
         "nodemon": "^3.1.11",
         "superagent": "^10.2.3",
-        "supertest": "^6.1.3"
+        "supertest": "^7.1.4"
     },
     "jest": {
         "testEnvironment": "node",