genlayer 0.2.0 → 0.3.0

package/esbuild.config.dev

@@ -10,6 +10,7 @@ module.exports = {
     banner: {
       js: "const _importMetaUrl=require('url').pathToFileURL(__filename)",
     },
+    external: ['ssh2'],
   },
   watch: true,
 };

package/esbuild.config.prod

@@ -10,6 +10,7 @@ module.exports = {
     banner: {
       js: "const _importMetaUrl=require('url').pathToFileURL(__filename)",
     },
+    external: ['ssh2'],
   },
   watch: false,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genlayer",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "GenLayer Command Line Tool",
   "main": "src/index.ts",
   "bin": {
@@ -34,6 +34,7 @@
   "homepage": "https://github.com/yeagerai/genlayer-cli#readme",
   "devDependencies": {
     "@release-it/conventional-changelog": "^8.0.1",
+    "@types/dockerode": "^3.3.31",
     "@types/inquirer": "^9.0.7",
     "@types/node": "^20.12.7",
     "@types/sinon": "^17.0.3",
@@ -55,6 +56,7 @@
   },
   "dependencies": {
     "commander": "^12.0.0",
+    "dockerode": "^4.0.2",
     "dotenv": "^16.4.5",
     "inquirer": "^9.2.19",
     "node-fetch": "^2.7.0",

package/src/commands/general/init.ts

@@ -226,9 +226,9 @@ export async function initAction(options: InitActionOptions, simulatorService: I
   }
 
   // Simulator ready
-  console.log(
-    `GenLayer simulator initialized successfully! Go to ${simulatorService.getFrontendUrl()} in your browser to access it.`,
-  );
+  let successMessage = "GenLayer simulator initialized successfully! "
+  successMessage += options.headless ? '' :  `Go to ${simulatorService.getFrontendUrl()} in your browser to access it.`;
+  console.log(successMessage);
   try {
     if(!options.headless){
       await simulatorService.openFrontend();

package/src/commands/general/start.ts

@@ -98,9 +98,9 @@ export async function startAction(options: StartActionOptions, simulatorService:
   }
 
   // Simulator ready
-  console.log(
-    `GenLayer simulator initialized successfully! Go to ${simulatorService.getFrontendUrl()} in your browser to access it.`,
-  );
+  let successMessage = "GenLayer simulator initialized successfully! "
+  successMessage += headless ? '' :  `Go to ${simulatorService.getFrontendUrl()} in your browser to access it.`;
+  console.log(successMessage);
   try {
     if(!headless) {
       await simulatorService.openFrontend();

package/src/lib/clients/system.ts

@@ -1,5 +1,5 @@
 import util from "node:util";
-import {ChildProcess, PromiseWithChild, exec} from "child_process";
+import {ChildProcess, exec} from "child_process";
 import open from "open";
 
 import {RunningPlatform, AVAILABLE_PLATFORMS} from "../config/simulator";
@@ -68,47 +68,3 @@ export async function getVersion(toolName: string): Promise<string> {
 
   return "";
 }
-
-export async function listDockerContainers(): Promise<string[]> {
-  try {
-    const dockerResponse = await util.promisify(exec)("docker ps -a --format '{{.Names}}'");
-    const dockerContainers = dockerResponse.stdout.split("\n");
-    return dockerContainers;
-  } catch (error) {
-    throw new Error("Error listing Docker containers.");
-  }
-}
-
-export async function listDockerImages(): Promise<string[]> {
-  try {
-    const dockerResponse = await util.promisify(exec)("docker images --format '{{.Repository}}'");
-    const dockerImages = dockerResponse.stdout.split("\n");
-    return dockerImages;
-  } catch (error) {
-    throw new Error("Error listing Docker images.");
-  }
-}
-
-export async function stopDockerContainer(containerName: string): Promise<void> {
-  try {
-    await util.promisify(exec)(`docker stop ${containerName}`);
-  } catch (error) {
-    throw new Error(`Error stopping Docker container ${containerName}.`);
-  }
-}
-
-export async function removeDockerContainer(containerName: string) {
-  try {
-    await util.promisify(exec)(`docker rm ${containerName}`);
-  } catch (error) {
-    throw new Error(`Error removing container ${containerName}.`);
-  }
-}
-
-export async function removeDockerImage(imageName: string) {
-  try {
-    await util.promisify(exec)(`docker rmi ${imageName}`);
-  } catch (error) {
-    throw new Error(`Error removing image ${imageName}.`);
-  }
-}

package/src/lib/config/simulator.ts

@@ -1,16 +1,11 @@
 export const DEFAULT_JSON_RPC_URL = "http://localhost:4000/api";
 export const DEFAULT_REPO_GH_URL = "https://github.com/yeagerai/genlayer-simulator.git";
-export const DOCKER_IMAGES_AND_CONTAINERS_NAME_PREFIX = "genlayer-simulator-";
+export const DOCKER_IMAGES_AND_CONTAINERS_NAME_PREFIX = "/genlayer-simulator-";
 export const DEFAULT_RUN_SIMULATOR_COMMAND = (simulatorLocation: string, options: string) => ({
   darwin: `osascript -e 'tell application "Terminal" to do script "cd ${simulatorLocation} && docker compose build && docker compose up ${options}"'`,
   win32: `start cmd.exe /c "cd /d ${simulatorLocation} && docker compose build && docker compose up && pause ${options}"`,
   linux: `nohup bash -c 'cd ${simulatorLocation} && docker compose build && docker compose up -d ${options}'`,
 });
-export const DEFAULT_PULL_OLLAMA_COMMAND = (simulatorLocation: string) => ({
-  darwin: `cd ${simulatorLocation} && docker exec ollama ollama pull llama3`,
-  win32: `cd /d ${simulatorLocation} && docker exec ollama ollama pull llama3`,
-  linux: `cd ${simulatorLocation} && docker exec ollama ollama pull llama3`,
-});
 export const DEFAULT_RUN_DOCKER_COMMAND = {
   darwin: "open -a Docker",
   win32: 'start "" "C:\\Program Files\\Docker\\Docker\\Docker Desktop.exe"',

package/src/lib/services/simulator.ts

@@ -1,3 +1,4 @@
+import Docker from "dockerode"
 import * as fs from "fs";
 import * as dotenv from "dotenv";
 import * as path from "path";
@@ -9,7 +10,6 @@ import {
   DOCKER_IMAGES_AND_CONTAINERS_NAME_PREFIX,
   DEFAULT_RUN_SIMULATOR_COMMAND,
   DEFAULT_RUN_DOCKER_COMMAND,
-  DEFAULT_PULL_OLLAMA_COMMAND,
   STARTING_TIMEOUT_WAIT_CYLCE,
   STARTING_TIMEOUT_ATTEMPTS,
   AI_PROVIDERS_CONFIG,
@@ -21,11 +21,6 @@ import {
   getVersion,
   executeCommand,
   openUrl,
-  listDockerContainers,
-  stopDockerContainer,
-  removeDockerContainer,
-  listDockerImages,
-  removeDockerImage,
 } from "../clients/system";
 import {MissingRequirementError} from "../errors/missingRequirement";
 
@@ -36,17 +31,20 @@ import {
 } from "../interfaces/ISimulatorService";
 import {VersionRequiredError} from "../errors/versionRequired";
 
+
 function sleep(millliseconds: number): Promise<void> {
   return new Promise(resolve => setTimeout(resolve, millliseconds));
 }
 
 export class SimulatorService implements ISimulatorService {
   private composeOptions: string
+  private docker: Docker;
   public simulatorLocation: string;
 
   constructor() {
     this.simulatorLocation = "";
     this.composeOptions = "";
+    this.docker = new Docker();
   }
 
   public setSimulatorLocation(location: string): void {
@@ -122,7 +120,7 @@ export class SimulatorService implements ISimulatorService {
 
     if (requirementsInstalled.docker) {
       try {
-        await checkCommand("docker ps", "docker");
+        await this.docker.ping()
       } catch (error: any) {
         await executeCommand(DEFAULT_RUN_DOCKER_COMMAND);
       }
@@ -205,8 +203,10 @@ export class SimulatorService implements ISimulatorService {
   }
 
   public async pullOllamaModel(): Promise<boolean> {
-    const cmdsByPlatform = DEFAULT_PULL_OLLAMA_COMMAND(this.simulatorLocation);
-    await executeCommand(cmdsByPlatform);
+    const ollamaContainer = this.docker.getContainer("ollama");
+    await ollamaContainer.exec({
+      Cmd: ["ollama", "pull", "llama3"],
+    });
     return true;
   }
 
@@ -287,30 +287,33 @@ export class SimulatorService implements ISimulatorService {
   }
 
   public async resetDockerContainers(): Promise<boolean> {
-    const containers = await listDockerContainers();
-    const genlayerContainers = containers.filter((container: string) =>
-      container.startsWith(DOCKER_IMAGES_AND_CONTAINERS_NAME_PREFIX),
-    );
-    const containersStopPromises = genlayerContainers.map((container: string) =>
-      stopDockerContainer(container),
-    );
-    await Promise.all(containersStopPromises);
-
-    const containersRemovePromises = genlayerContainers.map((container: string) =>
-      removeDockerContainer(container),
+    const containers = await this.docker.listContainers({ all: true });
+    const genlayerContainers = containers.filter(container =>
+      container.Names.some(name =>
+        name.startsWith(DOCKER_IMAGES_AND_CONTAINERS_NAME_PREFIX)
+      )
     );
-    await Promise.all(containersRemovePromises);
 
+    for (const containerInfo of genlayerContainers) {
+      const container = this.docker.getContainer(containerInfo.Id);
+      if (containerInfo.State === "running") {
+        await container.stop();
+      }
+      await container.remove();
+    }
     return true;
   }
 
   public async resetDockerImages(): Promise<boolean> {
-    const images = await listDockerImages();
-    const genlayerImages = images.filter((image: string) =>
-      image.startsWith(DOCKER_IMAGES_AND_CONTAINERS_NAME_PREFIX),
+    const images = await this.docker.listImages();
+    const genlayerImages = images.filter(image =>
+      image.RepoTags?.some(tag => tag.startsWith(DOCKER_IMAGES_AND_CONTAINERS_NAME_PREFIX))
     );
-    const imagesRemovePromises = genlayerImages.map((image: string) => removeDockerImage(image));
-    await Promise.all(imagesRemovePromises);
+
+    for (const imageInfo of genlayerImages) {
+      const image = this.docker.getImage(imageInfo.Id);
+      await image.remove({force: true});
+    }
 
     return true;
   }

package/tests/actions/init.test.ts

@@ -1,4 +1,4 @@
-import { vi, describe, beforeEach, afterEach, test, expect } from "vitest";
+import {vi, describe, beforeEach, afterEach, test, expect} from "vitest";
 import inquirer from "inquirer";
 import simulatorService from "../../src/lib/services/simulator";
 import { initAction } from "../../src/commands/general/init";
@@ -50,6 +50,15 @@ describe("init action", () => {
     simServCreateRandomValidators = vi.spyOn(simulatorService, "createRandomValidators");
     simServOpenFrontend = vi.spyOn(simulatorService, "openFrontend");
     simGetSimulatorUrl = vi.spyOn(simulatorService, "getFrontendUrl")
+
+    simServCheckVersionRequirements.mockResolvedValue({
+      node: '',
+      docker: '',
+    });
+    simServCheckInstallRequirements.mockResolvedValue({
+      git: true,
+      docker: true,
+    })
   });
 
   afterEach(() => {
@@ -168,6 +177,8 @@ describe("init action", () => {
     simServCreateRandomValidators.mockResolvedValue(true);
     simServOpenFrontend.mockResolvedValue(true);
     simGetSimulatorUrl.mockResolvedValue('http://localhost:8080/');
+    simServResetDockerContainers.mockResolvedValue(true);
+    simServResetDockerImages.mockResolvedValue(true);
 
     await initAction(defaultActionOptions, simulatorService);
 
@@ -177,9 +188,68 @@ describe("init action", () => {
     );
   });
 
+  test("should open the frontend if everything went well (headless mode)", async () => {
+    inquirerPrompt.mockResolvedValue({
+      confirmReset: true,
+      confirmDownload: true,
+      selectedLlmProviders: ["openai", "heuristai"],
+      openai: "API_KEY1",
+      heuristai: "API_KEY2",
+    });
+    simServgetAiProvidersOptions.mockReturnValue([
+      { name: "OpenAI", value: "openai" },
+      { name: "Heurist", value: "heuristai" },
+    ]);
+    simServConfigSimulator.mockResolvedValue(true);
+    simServRunSimulator.mockResolvedValue(true);
+    simServWaitForSimulator.mockResolvedValue({ initialized: true });
+    simServPullOllamaModel.mockResolvedValue(true);
+    simServDeleteAllValidators.mockResolvedValue(true);
+    simServCreateRandomValidators.mockResolvedValue(true);
+    simServOpenFrontend.mockResolvedValue(true);
+    simGetSimulatorUrl.mockResolvedValue('http://localhost:8080/');
+    simServResetDockerContainers.mockResolvedValue(true);
+    simServResetDockerImages.mockResolvedValue(true);
+
+    await initAction({...defaultActionOptions, headless: true}, simulatorService);
+
+    expect(log).toHaveBeenCalledWith(
+      `GenLayer simulator initialized successfully! `
+    );
+  });
+
+  test("should throw an error if validator are not initialized", async () => {
+    inquirerPrompt.mockResolvedValue({
+      confirmReset: true,
+      confirmDownload: true,
+      selectedLlmProviders: ["openai", "heuristai"],
+      openai: "API_KEY1",
+      heuristai: "API_KEY2",
+    });
+    simServgetAiProvidersOptions.mockReturnValue([
+      { name: "OpenAI", value: "openai" },
+      { name: "Heurist", value: "heuristai" },
+    ]);
+    simServConfigSimulator.mockResolvedValue(true);
+    simServRunSimulator.mockResolvedValue(true);
+    simServWaitForSimulator.mockResolvedValue({ initialized: true });
+    simServPullOllamaModel.mockResolvedValue(true);
+    simServDeleteAllValidators.mockResolvedValue(true);
+    simServCreateRandomValidators.mockRejectedValue();
+    simServOpenFrontend.mockResolvedValue(true);
+
+    await initAction({...defaultActionOptions, headless: true}, simulatorService);
+
+    expect(log).toHaveBeenCalledWith('Initializing validators...');
+    expect(error).toHaveBeenCalledWith('Unable to initialize the validators.');
+  });
+
+
   test("if configSimulator fails, then the execution aborts", async () => {
     inquirerPrompt.mockResolvedValue({ confirmReset: true, confirmDownload: true, selectedLlmProviders: [] });
     simServConfigSimulator.mockRejectedValue(new Error("Error"));
+    simServResetDockerContainers.mockResolvedValue(true);
+    simServResetDockerImages.mockResolvedValue(true);
 
     await initAction(defaultActionOptions, simulatorService);
 
@@ -189,6 +259,8 @@ describe("init action", () => {
   test("if runSimulator fails, then the execution aborts", async () => {
     inquirerPrompt.mockResolvedValue({ confirmReset: true, confirmDownload: true, selectedLlmProviders: [] });
     simServRunSimulator.mockRejectedValue(new Error("Error"));
+    simServResetDockerContainers.mockResolvedValue(true);
+    simServResetDockerImages.mockResolvedValue(true);
 
     await initAction(defaultActionOptions, simulatorService);
 
@@ -214,6 +286,8 @@ describe("init action", () => {
     simServWaitForSimulator.mockResolvedValue({ initialized: true });
     simServPullOllamaModel.mockResolvedValue(true);
     simServDeleteAllValidators.mockResolvedValue(true);
+    simServResetDockerContainers.mockResolvedValue(true);
+    simServResetDockerImages.mockResolvedValue(true);
 
     await initAction(defaultActionOptions, simulatorService);
 

package/tests/actions/start.test.ts

@@ -59,6 +59,20 @@ describe("startAction - Additional Tests", () => {
     expect(simulatorService.openFrontend).toHaveBeenCalled();
   });
 
+  test("runs successfully with default options and keeps existing validators (headless)", async () => {
+    await startAction({...defaultOptions, headless: true}, simulatorService);
+
+    expect(simulatorService.updateSimulator).toHaveBeenCalledWith("main");
+    expect(simulatorService.runSimulator).toHaveBeenCalled();
+    expect(simulatorService.waitForSimulatorToBeReady).toHaveBeenCalled();
+
+    expect(logSpy).toHaveBeenCalledWith("Starting GenLayer simulator keeping the existing validators");
+    expect(logSpy).toHaveBeenCalledWith("Updating GenLayer Simulator...");
+    expect(logSpy).toHaveBeenCalledWith("Running the GenLayer Simulator...");
+    expect(logSpy).toHaveBeenCalledWith("Simulator is running!");
+    expect(logSpy).toHaveBeenCalledWith("GenLayer simulator initialized successfully! ");
+  });
+
   test("logs error and stops if updateSimulator fails", async () => {
     const errorMsg = new Error("updateSimulator error");
     (simulatorService.updateSimulator as Mock).mockRejectedValueOnce(errorMsg);

package/tests/libs/system.test.ts

@@ -4,12 +4,7 @@ import {
   checkCommand,
   executeCommand,
   openUrl,
-  getVersion,
-  listDockerContainers,
-  listDockerImages,
-  stopDockerContainer,
-  removeDockerContainer,
-  removeDockerImage
+  getVersion
 } from "../../src/lib/clients/system";
 import { MissingRequirementError } from "../../src/lib/errors/missingRequirement";
 import open from "open";
@@ -59,48 +54,6 @@ describe("System Functions - Success Paths", () => {
     expect(result.stdout).toBe("echo linux");
     platformSpy.mockRestore();
   });
-
-  test("listDockerContainers retrieves a list of containers", async () => {
-    vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.resolve({
-      stdout: "container1\ncontainer2",
-      stderr: ""
-    }));
-    const containers = await listDockerContainers();
-    expect(containers).toEqual(["container1", "container2"]);
-  });
-
-  test("listDockerImages retrieves a list of images", async () => {
-    vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.resolve({
-      stdout: "image1\nimage2",
-      stderr: ""
-    }));
-    const images = await listDockerImages();
-    expect(images).toEqual(["image1", "image2"]);
-  });
-
-  test("stopDockerContainer stops a container", async () => {
-    const containerId = "container123";
-    const execMock = vi.fn().mockResolvedValue({ stdout: "", stderr: "" });
-    vi.mocked(util.promisify).mockReturnValue(execMock);
-    await stopDockerContainer(containerId);
-    expect(execMock).toHaveBeenCalledWith(`docker stop ${containerId}`);
-  });
-
-  test("removeDockerContainer removes a container", async () => {
-    const containerId = "container123";
-    const execMock = vi.fn().mockResolvedValue({ stdout: "", stderr: "" });
-    vi.mocked(util.promisify).mockReturnValue(execMock);
-    await removeDockerContainer(containerId);
-    expect(execMock).toHaveBeenCalledWith(`docker rm ${containerId}`);
-  });
-
-  test("removeDockerImage removes an image", async () => {
-    const imageId = "image123";
-    const execMock = vi.fn().mockResolvedValue({ stdout: "", stderr: "" });
-    vi.mocked(util.promisify).mockReturnValue(execMock);
-    await removeDockerImage(imageId);
-    expect(execMock).toHaveBeenCalledWith(`docker rmi ${imageId}`);
-  });
 });
 
 describe("System Functions - Error Paths", () => {
@@ -153,34 +106,6 @@ describe("System Functions - Error Paths", () => {
       "echo")).rejects.toThrow("Execution failed");
   });
 
-  test("stopDockerContainer throws an error if stopping fails", async () => {
-    const containerId = "container123";
-    vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.reject(new Error("")));
-    await expect(stopDockerContainer(containerId)).rejects.toThrow("Error stopping Docker container container123");
-  });
-
-  test("removeDockerContainer throws an error if removal fails", async () => {
-    const containerId = "container123";
-    vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.reject(new Error("")));
-    await expect(removeDockerContainer(containerId)).rejects.toThrow("Error removing container container123.");
-  });
-
-  test("removeDockerImage throws an error if image removal fails", async () => {
-    const imageId = "image123";
-    vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.reject(new Error("")));
-    await expect(removeDockerImage(imageId)).rejects.toThrow("Error removing image image123.");
-  });
-
-  test("throws error when command fails", async () => {
-    vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.reject(new Error("")));
-    await expect(listDockerContainers()).rejects.toThrow("Error listing Docker containers.");
-  });
-
-  test("throws error when command fails", async () => {
-    vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.reject(new Error("")));
-    await expect(listDockerImages()).rejects.toThrow("Error listing Docker images.");
-  });
-
   test("throws error when command execution fails", async () => {
     vi.mocked(util.promisify).mockReturnValueOnce(() => Promise.reject(new Error("Execution error.")));
     await expect(executeCommand({