Release/0.0.10 (#4)

Author: hlambda

CHANGELOG.md

@@ -1,10 +1,9 @@
-Release 0.0.10
+# Release 0.0.10
 
-- [WIP] Tests
-- [WIP] Git sync options
-- [WIP] Shell command execution
+- Tests
+- Shell command execution
 
-Release 0.0.9
+# Release 0.0.9
 
 - Environments, and env management
 - Override values from yaml from .env using {{}} pattern
@@ -14,7 +13,7 @@ Release 0.0.9
 - Check for new version and updates
 - Shell command execution on metadata apply as post apply script
 
-Release 0.0.8
+# Release 0.0.8
 
 - New initialization template
 - Init command flags, force and force-remove

README.md

@@ -4,33 +4,52 @@ hlambda-cli - CLI tool for managing Hlambda server.
 
 [![NPM](https://nodei.co/npm/hlambda-cli.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/hlambda-cli )
 
-## Installation
+## 🧰 Install Hlambda CLI
 
-### npm
 ```bash
 $ npm install -g hlambda-cli
 ```
 
-This will add Hlambda CLI to your arsenal, now you can use `hl`, `hla` or `hlambda` to check if CLI is working as expected.
+This will add Hlambda CLI to your arsenal, now you can use `hl`, `hla` or `hlambda`.
+
+## 📚 Using Hlambda CLI
+
+Check if the console is installed globally, in your terminal you can now run
 
 ````console
-$ hlambda
+$ hl
 ````
 
-## Example
+You can get the snippet for running Hlambda docker image directly from the CLI
+
+````console
+$ hl snippets docker
+````
 
-First you will need to get hlambda server running, either in docker or locally.
+Example output:
+
+```
+docker run -d -p 8081:1331 --env HLAMBDA_ADMIN_SECRET=demo --name hlambda-server --restart=always -v hlambda_metadata:/usr/src/app/metadata hlambda/hlambda-core:latest
+```
+
+You can even run it directly via additional flag --run
 
 ````console
-$ hlambda --version
+$ hl snip docker --run
 ````
 
+## 🧙🏻‍♂️ Quich start
+
+Initialize new configuration in the new folder `test`
+
 ````console
-$ hlambda init my-first-hlambda-app
+$ hl i test
 ````
 
+change working directory to `test`
+
 ````console
-$ cd my-first-hlambda-app
+$ cd test
 ````
 
 Change the admin_secret in the config.yaml manually or just run
@@ -39,7 +58,8 @@ Change the admin_secret in the config.yaml manually or just run
 $ hlambda config save --admin-secret "demo"
 ````
 
-this will edit the config.yaml file and save admin secret value in that file (please take extra care when commiting config.yaml file to not leak secrets)
+this will edit the config.yaml file and save admin secret value in that file (**🧨 please take extra care when commiting `config.yaml` file to not leak secrets**
+**, check Environments section for more details but we suggest you to use `env replacer syntax` like `{{ENV_HLAMBDA_ADMIN_SECRET}}` and keeping your secrets in the environemnt variables**)
 
 You can then export the existing metadata from the running server use
 
@@ -86,3 +106,58 @@ If you want to clear all the metadata from the server
 ````console
 $ hlambda metadata clear
 ````
+
+## 📦 Environments
+
+If you have multiple deployments of the same app you can now add environments to your hlambda config using `hlambda-cli`
+
+To add `dev` environment use
+
+````console
+$ hl env add dev
+````
+
+this will add new `dev` folder environment in `./environments/dev` with `config.yaml`
+
+example content of the `./environments/dev/config.yaml`
+
+```
+version: 1
+endpoint: "{{ENV_DEV_HLAMBDA_ENDPOINT}}"
+admin_secret: "{{ENV_DEV_HLAMBDA_ADMIN_SECRET}}"
+```
+
+this will be used instead of the values in root `config.yaml` file.
+
+🧨 Important! - You can hardcode but it is the best practice to use `env replacer syntax` `{{ENV_DEV_HLAMBDA_ADMIN_SECRET}}` the value will be the one provided in the `ENV_DEV_HLAMBDA_ADMIN_SECRET` environment variable at the CLI command run-time.
+
+✨ Hlambda cli also supports .env file 😄 
+so you can create `.env` file in the root
+```
+ENV_DEV_HLAMBDA_ENDPOINT="http://localhost:8081"
+ENV_DEV_HLAMBDA_ADMIN_SECRET="demo"
+```
+
+Any hlambda CLI command can now be excuted for different environment, example
+
+````console
+$ hl server logs --env dev
+````
+
+````console
+$ hl metadata apply --env dev
+````
+
+to add `custom_name` environemnt use
+
+````console
+$ hl env add custom_name
+````
+
+to delete environment named "staging"
+
+````console
+$ hl env delete staging
+````
+
+this will remove the whole environment folder.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "hlambda-cli",
   "type": "module",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "CLI for hlambda server.",
   "main": "src/index.js",
   "bin": {

src/commands/metadata.js

@@ -11,6 +11,7 @@ import { errors } from './../errors/index.js';
 
 import CLIErrorHandler from './../utils/CLIErrorHandler.js';
 import { loadConfigFromYAML } from './../utils/loadConfigFromYAML.js';
+import executeShellCommandClass from './../utils/executeShellCommandClass.js';
 
 export const serverReload = async (options, program) => {
   await (async () => {
@@ -159,25 +160,9 @@ export const metadataApply = async (options, program) => {
     }
     console.log(response.status);
 
-    // Check if there are scripts to run after applying
-    const executeShellCommand = async (command) => {
-      const headers = {
-        'x-hlambda-admin-secret': adminSecret,
-      };
-      const response = await fetch(`${endpoint}/console/api/v1/command-request`, {
-        method: 'POST',
-        body: {
-          command,
-        },
-        headers,
-      });
-
-      if (response.status === 200) {
-        console.log(`Shell command`.green, `${command}`.red, `executed!`.green);
-      }
-      console.log(response.status);
-    };
+    const executeShellCommand = executeShellCommandClass(adminSecret, endpoint);
 
+    // Check if there are scripts to run after applying
     if (metadataPostApplyCommandList.length > 0) {
       for (let i = 0; i < metadataPostApplyCommandList.length; i += 1) {
         // eslint-disable-next-line no-await-in-loop

src/commands/server.js

@@ -1,12 +1,15 @@
 import path from 'path';
 import fetch from 'node-fetch';
-// import FormData from 'form-data';
+import * as readline from 'node:readline/promises';
+import { stdin as input, stdout as output } from 'node:process';
+
 import { FormData, File } from 'formdata-node';
 
 import { errors } from './../errors/index.js';
 
 import CLIErrorHandler from './../utils/CLIErrorHandler.js';
 import { loadConfigFromYAML } from './../utils/loadConfigFromYAML.js';
+import executeShellCommandClass from './../utils/executeShellCommandClass.js';
 
 export const serverGetLogs = async (options, program) => {
   await (async () => {
@@ -126,8 +129,68 @@ export const serverShell = async (options, program) => {
     const endpoint = configuration?.endpoint ?? 'http://localhost:8081';
     const adminSecret = options?.adminSecret ?? configuration?.admin_secret ?? '';
 
-    // TODO: Implement this
-    throw new Error(errors.FUNCTIONALITY_NOT_IMPLEMENTED);
+    const headers = {
+      'x-hlambda-admin-secret': adminSecret,
+    };
+    const response = await fetch(`${endpoint}/console/api/v1/command-cwd`, {
+      method: 'GET',
+      headers,
+    });
+
+    if (response.status === 200) {
+      console.log('Connection valid!'.green);
+    } else {
+      throw new Error(errors.ERROR_INVALID_HLAMBDA_ADMIN_SECRET);
+    }
+    console.log(response.status);
+    const cwdCommandResult = await response.json();
+
+    const executeShellCommand = executeShellCommandClass(adminSecret, endpoint, true);
+
+    let workingDirectory = cwdCommandResult?.cwd ?? './';
+
+    const writePwdConsole = () => {
+      process.stdout.write(`<${'hlambda-server'}@${endpoint}> ${workingDirectory} # `.yellow);
+    };
+    writePwdConsole();
+
+    // Register linebyline listener
+    const rl = readline.createInterface({ input, output });
+
+    // const answer = await rl.question('What do you think of Node.js? ');
+    // console.log(`Thank you for your valuable feedback: ${answer}`);
+
+    rl.on('line', async (terminalInput) => {
+      if (terminalInput === 'exit' || terminalInput === 'quit') {
+        rl.close();
+        return;
+      }
+      if (terminalInput.toLowerCase().startsWith('cd')) {
+        // Change working dir for the command...
+        const t = terminalInput.match(/cd\s(.+)/);
+        const responseCd = await fetch(`${endpoint}/console/api/v1/command-change-dir`, {
+          method: 'POST',
+          headers: {
+            'x-hlambda-admin-secret': adminSecret,
+            Accept: 'application/json',
+            'Content-Type': 'application/json', // Important
+          },
+          body: JSON.stringify({
+            path: t[1],
+          }),
+        });
+        const responseJson = await responseCd.json();
+        const outputString = responseJson;
+        // console.log(outputString);
+        workingDirectory = outputString?.cwd;
+        writePwdConsole();
+        return;
+      }
+      const result = await executeShellCommand(terminalInput, workingDirectory);
+      const data = await result.json();
+      process.stdout.write(data?.data);
+      writePwdConsole();
+    });
   })()
     .then(() => {})
     .catch(CLIErrorHandler(program));

src/commands/snippet/docker-compose.js

@@ -1,4 +1,5 @@
 import path from 'path';
+import { exec } from 'child_process';
 
 import CLIErrorHandler from './../../utils/CLIErrorHandler.js';
 
@@ -9,7 +10,26 @@ export const dockerComposeSnippet = async (options, program) => {
     const cwd = path.resolve(process.cwd());
     console.log('Executing in cwd:'.green, `${cwd}`.yellow);
 
-    console.log(dockerComposeInstallSnippet.yellow);
+    if (options.run) {
+      const command = dockerComposeInstallSnippet(true);
+      const childPid = exec(command);
+
+      childPid.stdout.on('data', (data) => {
+        console.log(`${data.toString()}`);
+      });
+
+      childPid.stderr.on('data', (data) => {
+        console.log(`${data.toString()}`);
+      });
+
+      childPid.on('exit', (code) => {
+        console.log(`Process exited with code ${code.toString()}`);
+      });
+    } else if (options.clean) {
+      console.log(dockerComposeInstallSnippet(true));
+    } else {
+      console.log(dockerComposeInstallSnippet().yellow);
+    }
   })()
     .then(() => {})
     .catch(CLIErrorHandler(program));

src/commands/snippet/docker.js

@@ -1,4 +1,5 @@
 import path from 'path';
+import { exec } from 'child_process';
 
 import CLIErrorHandler from './../../utils/CLIErrorHandler.js';
 
@@ -9,7 +10,26 @@ export const dockerSnippet = async (options, program) => {
     const cwd = path.resolve(process.cwd());
     console.log('Executing in cwd:'.green, `${cwd}`.yellow);
 
-    console.log(dockerInstallSnippet.yellow);
+    if (options.run) {
+      const command = dockerInstallSnippet(true);
+      const childPid = exec(command);
+
+      childPid.stdout.on('data', (data) => {
+        console.log(`${data.toString()}`);
+      });
+
+      childPid.stderr.on('data', (data) => {
+        console.log(`${data.toString()}`);
+      });
+
+      childPid.on('exit', (code) => {
+        console.log(`Process exited with code ${code.toString()}`);
+      });
+    } else if (options.clean) {
+      console.log(dockerInstallSnippet(true));
+    } else {
+      console.log(dockerInstallSnippet().yellow);
+    }
   })()
     .then(() => {})
     .catch(CLIErrorHandler(program));