Merge pull request #125 from microservices-suite/repo-engineering/universal-cli

Repo engineering/universal cli

Author: GAndanje

.suite-cli/cli/cli.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 
+const ora = require('ora')
 const { Command } = require('commander');
 const { createPromptModule } = require('inquirer');
-const figlet = require('figlet');
+const { execSync } = require('node:child_process')
 const actionHandlers = require('./scripts')
 const { logInfo } = require('./scripts/scripts.module');
 const program = new Command()
@@ -78,7 +79,36 @@ program
 program
   .command('generate')
   .description('Generate a new monorepo resource')
-  .action(() => {
+  .action(async () => {
+    try {
+      // Check if Yarn is installed
+      execSync('yarn --version', { stdio: 'ignore' });
+    } catch (error) {
+      const spinner = ora().fail('Yarn is not installed.');
+
+      const { installYarn } = await prompt([
+        {
+          type: 'confirm',
+          name: 'installYarn',
+          message: 'Would you like to install it now?',
+          default: true
+        }
+      ]);
+
+      if (installYarn) {
+        try {
+          spinner.start('Installing Yarn...');
+          execSync('npm install -g yarn', { stdio: 'inherit' });
+          spinner.succeed('Yarn installed successfully.');
+        } catch (installError) {
+          spinner.fail('Failed to install Yarn. Please install it manually and try again.');
+          process.exit(1);
+        }
+      } else {
+        spinner.fail('Yarn is required to proceed. Exiting.');
+        process.exit(1);
+      }
+    }
     prompt([
       {
         type: 'list',
@@ -120,13 +150,13 @@ program
                 message: 'Select license:',
                 choices: ['ISC', 'MIT'],
                 default: 'ISC'
-              },{
+              }, {
                 type: 'input',
                 name: 'service_name',
                 message: 'Initial service:',
                 default: 'microservice1'
               }
-              
+
             ])
               .then(answers => {
                 //   find out if this separater works on windows

.suite-cli/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microservices-suite/cli",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "This is the CLI tool for running the microservices-suite monorepo. It contains functionalities and tools required for automation and managing the repo across supported platforms. Works on Windows,MacOS and Linux as well as support to some extend other variants like SunOS, IBM AIX, FreeBSD, OpenBSD and more",
   "main": "cli.js",
   "repository": "https://github.com/microservices-suite/node-microservices-suite.git",

.suite-cli/cli/scripts/assets/defaultConfContent.asset.js

@@ -0,0 +1,16 @@
+module.exports = ({ services }) => `
+${services.map(({ service, port }) => `
+upstream ${service} {
+    server ${service}:${port};
+}`).join('')}
+
+server {
+    listen 80;
+
+${services.map(({ service }) => `
+    location /${service} {
+        rewrite /${service}/(.*) /$1 break;
+        proxy_pass http://${service};
+    }`).join('')}
+}
+`.trim();

.suite-cli/cli/scripts/assets/dockerComposeContent.asset.js

@@ -0,0 +1,29 @@
+module.exports = ({ services }) => `
+version: '3.8'
+services:
+  mongodb:
+    image: mongo:latest
+    container_name: mongodb
+    ports:
+      - '27017:27017'
+  rabbitmq:
+    image: rabbitmq:3.8
+    container_name: rabbitmq
+    ports:
+      - '5672:5672'
+      - '15672:15672'
+${services.map(({ service, ports, prerequisites }) => `
+  ${service}:
+    depends_on:
+${prerequisites.map((prerequisite) => `      - ${prerequisite}`).join('\n')}
+    container_name: ${service}
+    restart: always
+    build:
+      context: ../../../microservices/${service}
+      dockerfile: DockerFile.dev
+    ports:
+${ports.map((p) => `      - '${p}:${p}'`).join('\n')}
+    volumes:
+      - /app/node_modules
+      - ../../../microservices/${service}:/app`).join('\n')}
+`.trim();

.suite-cli/cli/scripts/assets/nginxDockerfile.asset.js

@@ -0,0 +1,3 @@
+module.exports = () =>`
+FROM nginx
+COPY ./default.conf /etc/nginx/conf.d/default.conf`

.suite-cli/cli/scripts/assets/serverContent.asset.js

@@ -21,7 +21,7 @@ const app = express();
 app.use(express.json());
 
 app.get('/', (req, res) => {
-res.json({ messae: 'hello from ${answers.project_base}/${answers.service_name}' });
+res.json({ message: 'hello from ${answers.project_base}/${answers.service_name}' });
 });
 
 const server = http.createServer(app);

.suite-cli/cli/scripts/scripts.module.js

@@ -726,10 +726,10 @@ const resetRepo = ({ targetDir }) => {
         } else {
             // Unix-like commands
             commands = [
-                `find ${targetDir} -type d -name 'node_modules' -exec rm -rf {} +`,
-                `find ${targetDir} -type f -name 'package-lock.json' -delete`,
-                `find ${targetDir} -type f -name 'yarn.lock' -delete`,
-                `find ${targetDir} -type d -name 'yarn-*' -exec rm -rf {} +`
+                `find ${targetDir} -maxdepth 3 -type d -name 'node_modules' -exec rm -rf {} +`,
+                `find ${targetDir} -maxdepth 3 -type f -name 'package-lock.json' -delete`,
+                `find ${targetDir} -maxdepth 3 -type f -name 'yarn.lock' -delete`,
+                `find ${targetDir} -maxdepth 3 -type d -name 'yarn-*' -exec rm -rf {} +`
             ];
         }
 
@@ -849,6 +849,7 @@ const addPackageJson = async ({ project_root, answers }) => {
     // Add a package.json 
     writeFileSync(join(project_root, 'package.json'), JSON.stringify(assets.rootPackageJsonContent({ answers, os }), null, 2));
 
+    // TODO: move these dependencies to assets
     const dependencies = [
         `${answers.project_base}/config@1.0.0`,
         `${answers.project_base}/errors@1.0.0`,
@@ -861,7 +862,7 @@ const addPackageJson = async ({ project_root, answers }) => {
         "winston",
         "mongoose"
     ];
-    const devDependencies = ["nodemon"];
+    const devDependencies = ["nodemon","jest"];
     const configDependencies = ['dotenv', 'joi', 'morgan', 'winston']
     const utilitiesDependencies = ['joi']
     // Join dependencies into a single string for the command
@@ -920,14 +921,14 @@ const addPackageJson = async ({ project_root, answers }) => {
     childProcess.on('error', error => {
         spinner.fail('Failed to execute command');
     });
-
+    // TODO: check if yarn is installed first
     childProcess.on('exit', (code, signal) => {
         if (code !== 0) {
             spinner.fail('Command failed to complete successfully');
             return;
         }
         spinner.succeed('Dependencies installed successfully');
-        spinner.info(`To start the project, run 'cd ${answers.repo_name} && yarn dev'`)
+        spinner.info(`To start the project, run 'cd ${answers.repo_name} && suite start -v ${answers.service_name}'`)
     });
 }
 
@@ -1060,7 +1061,6 @@ const addMicroservice = ({ project_root, answers }) => {
  * @returns {void}
  */
 const scaffoldNewRepo = async ({ answers }) => {
-    let project_root;
     try {
         project_root = generatRootPath({ currentDir: cwd() });
     } catch (error) {
@@ -1220,16 +1220,15 @@ const releasePackage = async ({ package }) => {
         const package_json_path = join(cwd(), 'package.json');
 
         // Read the package.json file
-        console.log({ package_json_path })
         const { workspace_name } = retrieveWorkSpaceName({ package_json_path });
         if (package) {
             logInfo({ message: `Looking for package: ${workspace_name}/${package}` });
-            await executeCommand('yarn', ['workspace', `${workspace_name}/${package}`, 'release']);
+            await executeCommand('yarn', ['workspace', `${workspace_name}/${package}`, 'release'],{stdio:'inherit',shell:true});
         } else {
-            await executeCommand('yarn', ['generate:release'], { cwd: cwd() });
+            await executeCommand('yarn', ['generate:release'], { cwd: cwd(),stdio:'inherit',shell:true });
         }
     } catch (error) {
-        console.error('Error occurred:', error);
+       ora().fail('Command failed to run');
     }
 }
 

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
 
+## v1.6.5
+
+[compare changes](https://github.com/microservices-suite/node-microservices-suite/compare/v1.6.4...v1.6.5)
+
+## v1.6.4
+
+[compare changes](https://github.com/microservices-suite/node-microservices-suite/compare/v2.0.4...v1.6.4)
+
 ## v1.6.3
 
 [compare changes](https://github.com/microservices-suite/node-microservices-suite/compare/v2.0.2...v1.6.3)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microservices-suite/microservices",
-  "version": "1.6.3",
+  "version": "1.6.5",
   "description": "This is the central orchestration point for our microservices-based platform, encompassing user management, email communications, file upload handling, and role-based access control services. It serves as the backbone of our application's backend, facilitating seamless interaction, development, and scaling of individual microservices. The workspace is designed to streamline the development process, ensuring dependency consistency, and simplifying the build and deployment workflows across all services.\nThis root workspace enables our development teams to:\n- Manage dependencies for all services in a unified manner, reducing conflicts and easing updates.\n- Utilize shared configurations, such as ESLint rules, TypeScript configurations, and shared utility libraries, to maintain coding standards and reduce redundancy across services.\n- Implement global scripts for tasks like testing, linting, and deployment that can run across all services, ensuring consistency and efficiency in our development pipeline.\n- Leverage the workspace's structure for local development, allowing for easy testing of interactions between services without the need for deploying or configuring external environments.",
   "keywords": [],
   "author": "Gilbert Andanje",

tests/cli/scripts/retrieveWorkspaceName.test.js

@@ -0,0 +1,49 @@
+const fs = require('fs');
+const { retrieveWorkSpaceName } = require('./your-module-file');
+
+// Mock the fs module to simulate file reading
+jest.mock('fs');
+
+describe('retrieveWorkSpaceName', () => {
+  test('should retrieve the workspace name from package.json', () => {
+    // Mock the content of package.json
+    const packageJsonContent = JSON.stringify({ name: 'your-workspace-name/workspace' });
+    const packageJsonPath = '/path/to/package.json';
+
+    // Mock fs.readFileSync to return package.json content
+    fs.readFileSync.mockReturnValue(packageJsonContent);
+
+    // Call the function with mocked parameters
+    const result = retrieveWorkSpaceName({ package_json_path: packageJsonPath });
+
+    // Assert that the result matches the expected workspace name
+    expect(result).toEqual({ workspace_name: 'your-workspace-name' });
+  });
+
+  test('should throw an error when parsing package.json fails', () => {
+    // Mock the content of package.json with invalid JSON
+    const packageJsonContent = '{ invalid_json }';
+    const packageJsonPath = '/path/to/package.json';
+
+    // Mock fs.readFileSync to return package.json content
+    fs.readFileSync.mockReturnValue(packageJsonContent);
+
+    // Assert that the function throws an error
+    expect(() => {
+      retrieveWorkSpaceName({ package_json_path: packageJsonPath });
+    }).toThrowError('Unexpected token i in JSON at position 2');
+    // Adjust the error message to match the specific error thrown when parsing fails
+  });
+
+  test('should handle missing package.json file', () => {
+    // Mock fs.readFileSync to throw an error indicating that the file doesn't exist
+    fs.readFileSync.mockImplementation(() => {
+      throw new Error('ENOENT: no such file or directory');
+    });
+
+    // Assert that the function throws an error
+    expect(() => {
+      retrieveWorkSpaceName({ package_json_path: '/nonexistent/path/to/package.json' });
+    }).toThrowError('ENOENT: no such file or directory');
+  });
+});