@gnar-engine/cli 1.0.4 → 1.0.5

package/src/scaffolder/scaffolder.handler.js

@@ -3,8 +3,11 @@ import fs from 'fs';
 import yaml from 'js-yaml';
 import { profiles } from '../profiles/profiles.client.js';
 import { helpers } from '../helpers/helpers.js';
+import { directories } from '../cli.js';
 import Handlebars from 'handlebars';
 
+
+
 /**
  * Gnar Engine Scaffolder
  */
@@ -32,10 +35,9 @@ export const scaffolder = {
         fs.mkdirSync(serviceDir, { recursive: true });
 
         // Get all files in the templates directory
-        const templatesDir = path.join(import.meta.dirname, '../../templates/service');
         const templateFiles = scaffolder.getAllTemplateFiles({
-            dir: templatesDir,
-            baseDir: templatesDir
+            dir: directories.scaffolderTemplates,
+            baseDir: directories.scaffolderTemplates
         }); 
 
         // Register Handlebars helpers
@@ -136,6 +138,25 @@ export const scaffolder = {
 
         // Create the service directory
         fs.mkdirSync(serviceDir, { recursive: true });
+
+        // Add to deploy.yml
+        scaffolder.scaffoldServiceDeployYml({
+            deployPath: path.join(projectDir, 'deploy.localdev.yml'),
+            serviceName: serviceName,
+            database: null
+        });
+        
+        // Scaffold secrets
+        scaffolder.scaffoldServiceSecrets({
+            secretsPath: path.join(projectDir, 'secrets.localdev.yml'),
+            serviceName: serviceName,
+            database: null
+        });
+
+        return {
+            message: `Front-end service "${serviceName}" created successfully at ${serviceDir}`,
+            servicePath: serviceDir
+        };
     },
 
     /**
@@ -284,13 +305,17 @@ export const scaffolder = {
         const parsedSecrets = yaml.load(rawSecrets);
 
         // generate random passwords
-        Object.keys(parsedSecrets.services).forEach(serviceName => {
-            Object.keys(parsedSecrets.services[serviceName]).forEach(key => {
-                if (key.toLowerCase().includes('pass')) {
-                    parsedSecrets.services[serviceName][key] = helpers.generateRandomString(16);
-                }
+        try {
+            Object.keys(parsedSecrets.services).forEach(serviceName => {
+                Object.keys(parsedSecrets.services[serviceName]).forEach(key => {
+                    if (key.toLowerCase().includes('pass')) {
+                        parsedSecrets.services[serviceName][key] = helpers.generateRandomString(16);
+                    }
+                });
             });
-        });
+        } catch (error) {
+            throw new Error('Error generating random passwords for project secrets: ' + error.message);
+        }
 
         // set random root api key
         const cliApiKey = helpers.generateRandomString(32);
@@ -328,15 +353,14 @@ export const scaffolder = {
                 parsedSecrets.services[serviceName]['MYSQL_USER'] = serviceName + '_user';
                 parsedSecrets.services[serviceName]['MYSQL_PASSWORD'] = helpers.generateRandomString(16);
                 parsedSecrets.services[serviceName]['MYSQL_DATABASE'] = serviceName + '_db';
-                parsedSecrets.services[serviceName]['MYSQL_HOST'] = serviceName + '-db';
-                parsedSecrets.services[serviceName]['MYSQL_RANDOM_ROOT_PASSWORD'] = helpers.generateRandomString(16);
+                parsedSecrets.services[serviceName]['MYSQL_HOST'] = 'db-mysql';
                 break;
             case 'mongodb':
                 const mongoPassword = helpers.generateRandomString(16);
                 const mongoRootPassword = helpers.generateRandomString(16);
                 const mongoUser = serviceName + '_user';
                 const mongoDatabase = serviceName + '_db';
-                const mongoHost = serviceName + '-db';
+                const mongoHost = 'db-mongo';
                 const mongoUrl = `mongodb://${mongoUser}:${mongoPassword}@${mongoHost}:27017/${mongoDatabase}`;
 
                 parsedSecrets.services[serviceName]['MONGO_URL'] = mongoUrl;
@@ -347,8 +371,9 @@ export const scaffolder = {
                 parsedSecrets.services[serviceName]['MONGO_HOST'] = mongoHost;
                 break;
             default:
-                throw new Error(`Unsupported database type in secret scaffolder: ${database}`);
-        }
+                // no db
+                break;
+            }
 
         // save updated secrets file
         const newSecretsContent = yaml.dump(parsedSecrets);
@@ -411,7 +436,7 @@ export const scaffolder = {
         // add database service if required
         if (database) {
             serviceConfig.depends_on = [
-                `${serviceName}-db`
+                `db-${database}`
             ]
         }
 

package/templates/service/src/app.js.hbs

@@ -1,4 +1,4 @@
-import { message, http, logger, db } from '@gnar-engine/core';
+import { message, http, logger, db, registerService, webSockets, test } from '@gnar-engine/core';
 import { config } from './config.js';
 import { messageHandlers } from './controllers/message.controller.js';
 import { httpController as {{lowerCase serviceName}}PlatformHttpController } from './controllers/http.controller.js';
@@ -26,6 +26,9 @@ export const initService = async () => {
 		handlers: messageHandlers
 	});
 
+    // Initialise websocket client & server
+    await webSockets.init(config.webSockets, config.serviceName);
+
 	// Register http routes
 	await http.registerRoutes({
 		controllers: [
@@ -36,7 +39,15 @@ export const initService = async () => {
 	// Start the HTTP server
 	await http.start();
 
+    // Register service with control service
+    await registerService();
+
 	logger.info('G n a r  E n g i n e | {{capitaliseFirstLetter serviceName}} Service initialised successfully.');
+
+    // Tests
+    if (config.environment === 'test' && config.runTests) {
+        test.runCommandTests({config});
+    }
 }
 
 initService();

package/templates/service/src/commands/{{serviceName}}.handler.js.hbs

@@ -80,7 +80,7 @@ commands.register('{{serviceName}}Service.update{{pascalCase serviceName}}', asy
     
     return await {{serviceName}}.update({
         id: id,
-        ...new{{pascalCase serviceName}}Data
+        updatedData: new{{pascalCase serviceName}}Data
     });
 });
 

package/templates/service/src/mongodb.config.js.hbs

@@ -25,7 +25,11 @@ export const config = {
         type: 'mongodb',
 
         // MongoDB
-        connectionUrl: process.env.{{upperCase serviceName}}_MONGO_URL,
+        host: process.env.{{upperCase serviceName}}_MONGO_HOST,
+        database: process.env.{{upperCase serviceName}}_MONGO_DATABASE,
+        user: process.env.{{upperCase serviceName}}_MONGO_USER,
+        password: process.env.{{upperCase serviceName}}_MONGO_PASSWORD,
+        port: process.env.{{upperCase serviceName}}_MONGO_PORT || 27017,
         connectionArgs: {},
     },
 

package/templates/service/src/mysql.config.js.hbs

@@ -5,6 +5,10 @@ export const config = {
     // service name
     serviceName: '{{serviceName}}Service',
 
+    // environment
+    environment: process.env.{{upperCase serviceName}}_NODE_ENV || 'dev',
+    runTests: process.env.{{upperCase serviceName}}_RUN_TESTS || false,
+
     // microservice | modular-monolith
     architecture: process.env.GLOBAL_ARCHITECTURE || 'microservice',
 

package/bootstrap/services/user/src/tests/user.test.js

@@ -1,126 +0,0 @@
-const request = require('supertest');
-const url = 'http://localhost';
-
-describe('User API', () => {
-
-    let adminAuthToken;
-    let customerAuthToken;
-    let userId;
-    let testCustomerEmail;
-
-    beforeAll(async () => {
-        // check we are not in production mode
-        if (process.env.NODE_ENV === 'production') {
-            throw new Error('Do not run tests in production mode!');
-        }
-
-        testCustomerEmail = 'customertest13@gnar.co.uk';
-    });
-
-    // Test authenticate with email and password
-    it('POST /authenticate (as admin)', async () => {
-        const response = await request(url).post('/authenticate')
-        .set('Content-Type', 'application/json')
-        .send({
-            username: 'root@gnar.co.uk',
-            password: 'gn4rlyR00tP0rt4lP4ss'
-        });
-        console.log(response.body);
-        expect(response.status).toBe(200);
-        expect(response.body).toHaveProperty('token');
-
-        adminAuthToken = response.body.token;
-    });
-
-    // Create new customer user (success no auth required)
-    it('POST /users (create new customer user no auth required)', async () => {
-        const response = await request(url).post('/users')
-        .set('Content-Type', 'application/json')
-        .send({
-            user: 
-                {
-                    email: testCustomerEmail,
-                    password: 'password1234'
-                }
-        })
-        console.log(response.body);
-        expect(response.status).toBe(200);
-        expect(response.body.users[0].email).toBe(testCustomerEmail);
-
-        // Save the new user id
-        userId = response.body.users[0].id;
-        console.log('New user id: ' + userId);
-    });
-
-    // Test authenticate with new user
-    it('POST /authenticate (as new customer user)', async () => {
-        const response = await request(url).post('/authenticate')
-        .set('Content-Type', 'application/json')
-        .send({
-            username: testCustomerEmail,
-            password: 'password1234'
-        });
-        console.log(response.body);
-        expect(response.status).toBe(200);
-        expect(response.body).toHaveProperty('token');
-
-        customerAuthToken = response.body.token;
-    });
-
-    // Fetch single customer user (as customer)
-    it('GET /users/{id} (as customer)', async () => {
-        const response = await request(url).get('/users/' + userId)
-        .set('Authorization', 'Bearer ' + customerAuthToken);
-        console.log(response.body);
-        expect(response.status).toBe(200);
-    });
-
-    // Fetch all users (not authorised as customer)
-    it('GET /users (not authorised as customer)', async () => {
-        const response = await request(url).get('/users')
-        .set('Authorization', 'Bearer ' + customerAuthToken);
-        console.log(response.body);
-        expect(response.status).toBe(403);
-    });
-
-    // Fetch all users (success as admin)
-    it('GET /users (as admin)', async () => {
-        const response = await request(url).get('/users')
-        .set('Authorization', 'Bearer ' + adminAuthToken);
-        console.log(response.body);
-        expect(response.status).toBe(200);
-    });
-
-    // Update customer user (as customer)
-    it('POST /users/{id} (as customer)', async () => {
-        const response = await request(url).post('/users/' + userId)
-        .set('Authorization', 'Bearer ' + customerAuthToken)
-        .set('Content-Type', 'application/json')
-        .send({
-            email: 'changedcustomeremail2@gnar.co.uk'
-        });
-        console.log(response.body);
-        expect(response.status).toBe(200);
-        expect(response.body.user.email).toBe('changedcustomeremail2@gnar.co.uk');
-    });
-
-    // Update customer user (check cannot elevate role to admin)
-    it('POST /users/{id} (as customer)', async () => {
-        const response = await request(url).post('/users/' + userId)
-        .set('Authorization', 'Bearer ' + customerAuthToken)
-        .set('Content-Type', 'application/json')
-        .send({
-            role: 'service_admin'
-        });
-        console.log(response.body);
-        expect(response.status).toBe(403);
-    });-
-
-    // Delete customer user (as admin)
-    it('DELETE /users/{id} (as admin)', async () => {
-        const response = await request(url).delete('/users/' + userId)
-        .set('Authorization', 'Bearer ' + adminAuthToken);
-        console.log(response.body);
-        expect(response.status).toBe(200);
-    });
-});