genlayer 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 
 
+## 0.12.0 (2025-02-05)
+
+
+### Features
+
+* Add `stop` Command and Improve Docker Container Management ([#178](https://github.com/yeagerai/genlayer-cli/issues/178)) ([dbae62c](https://github.com/yeagerai/genlayer-cli/commit/dbae62cd6ea0c90ee7fb6953112006f9dff729c3))
+
+## 0.11.1 (2025-02-05)
+
 ## 0.11.0 (2025-01-31)
 
 

package/dist/index.js

@@ -54537,7 +54537,7 @@ var {
 } = import_index.default;
 
 // package.json
-var version = "0.11.0";
+var version = "0.12.0";
 var package_default = {
   name: "genlayer",
   version,
@@ -55272,6 +55272,32 @@ var SimulatorService = class {
     this.composeOptions = "";
     this.docker = new import_dockerode.default();
   }
+  readEnvConfigValue(key) {
+    const envFilePath = path2.join(this.location, ".env");
+    const envConfig = dotenv.parse(fs5.readFileSync(envFilePath, "utf8"));
+    return envConfig[key];
+  }
+  async getGenlayerContainers() {
+    const containers = await this.docker.listContainers({ all: true });
+    return containers.filter(
+      (container) => container.Names.some(
+        (name) => name.startsWith(CONTAINERS_NAME_PREFIX) || name.includes("ollama")
+      )
+    );
+  }
+  async stopAndRemoveContainers(remove = false) {
+    const genlayerContainers = await this.getGenlayerContainers();
+    for (const containerInfo of genlayerContainers) {
+      const container = this.docker.getContainer(containerInfo.Id);
+      if (containerInfo.State === "running") {
+        await container.stop();
+      }
+      const isOllamaContainer = containerInfo.Names.some((name) => name.includes("ollama"));
+      if (remove && !isOllamaContainer) {
+        await container.remove();
+      }
+    }
+  }
   addConfigToEnvFile(newConfig) {
     const envFilePath = path2.join(this.location, ".env");
     const envConfig = dotenv.parse(fs5.readFileSync(envFilePath, "utf8"));
@@ -55289,11 +55315,6 @@ var SimulatorService = class {
   getComposeOptions() {
     return this.composeOptions;
   }
-  readEnvConfigValue(key) {
-    const envFilePath = path2.join(this.location, ".env");
-    const envConfig = dotenv.parse(fs5.readFileSync(envFilePath, "utf8"));
-    return envConfig[key];
-  }
   async checkCliVersion() {
     const update = await (0, import_update_check.default)(package_default);
     if (update && update.latest !== package_default.version) {
@@ -55402,21 +55423,11 @@ Run npm install -g genlayer to update
     await openUrl(this.getFrontendUrl());
     return true;
   }
+  async stopDockerContainers() {
+    await this.stopAndRemoveContainers(false);
+  }
   async resetDockerContainers() {
-    const containers = await this.docker.listContainers({ all: true });
-    const genlayerContainers = containers.filter(
-      (container) => container.Names.some(
-        (name) => name.startsWith(CONTAINERS_NAME_PREFIX)
-      )
-    );
-    for (const containerInfo of genlayerContainers) {
-      const container = this.docker.getContainer(containerInfo.Id);
-      if (containerInfo.State === "running") {
-        await container.stop();
-      }
-      await container.remove();
-    }
-    return true;
+    await this.stopAndRemoveContainers(true);
   }
   async resetDockerImages() {
     const images = await this.docker.listImages();
@@ -55427,7 +55438,6 @@ Run npm install -g genlayer to update
       const image = this.docker.getImage(imageInfo.Id);
       await image.remove({ force: true });
     }
-    return true;
   }
   async cleanDatabase() {
     try {
@@ -57752,7 +57762,7 @@ async function initAction(options, simulatorService) {
     {
       type: "confirm",
       name: "confirmReset",
-      message: `This command is going to reset GenLayer docker images and containers, providers API Keys, and GenLayer database (accounts, transactions, and validators). Do you want to continue?`,
+      message: `This command is going to reset GenLayer docker images and containers, providers API Keys, and GenLayer database (accounts, transactions, validators and logs). Contract code (gpy files) will be kept. Do you want to continue?`,
       default: true
     }
   ]);
@@ -57948,10 +57958,53 @@ async function startAction(options, simulatorService) {
   }
 }
 
+// src/lib/actions/BaseAction.ts
+var BaseAction = class {
+  async confirmPrompt(message) {
+    const answer = await lib_default.prompt([
+      {
+        type: "confirm",
+        name: "confirmAction",
+        message,
+        default: true
+      }
+    ]);
+    if (!answer.confirmAction) {
+      console.log("Operation aborted!");
+      process.exit(0);
+    }
+  }
+};
+
+// src/commands/general/stop.ts
+var StopAction = class extends BaseAction {
+  constructor() {
+    super();
+    __publicField(this, "simulatorService");
+    this.simulatorService = new SimulatorService();
+  }
+  async stop() {
+    try {
+      await this.confirmPrompt(
+        "Are you sure you want to stop all running GenLayer containers? This will halt all active processes."
+      );
+      console.log(`Stopping Docker containers...`);
+      await this.simulatorService.stopDockerContainers();
+      console.log(`All running GenLayer containers have been successfully stopped.`);
+    } catch (error) {
+      console.error("An error occurred while stopping the containers:", error);
+    }
+  }
+};
+
 // src/commands/general/index.ts
 function initializeGeneralCommands(program2) {
   program2.command("init").description("Initialize the GenLayer Environment").option("--numValidators <numValidators>", "Number of validators", "5").option("--headless", "Headless mode", false).option("--reset-db", "Reset Database", false).option("--localnet-version <localnetVersion>", "Select a specific localnet version", localnetCompatibleVersion).action((options) => initAction(options, simulator_default));
   program2.command("up").description("Starts GenLayer's simulator").option("--reset-validators", "Remove all current validators and create new random ones", false).option("--numValidators <numValidators>", "Number of validators", "5").option("--headless", "Headless mode", false).option("--reset-db", "Reset Database", false).action((options) => startAction(options, simulator_default));
+  program2.command("stop").description("Stop all running localnet services.").action(async () => {
+    const stopAction = new StopAction();
+    await stopAction.stop();
+  });
   return program2;
 }
 
@@ -86824,24 +86877,6 @@ function initializeConfigCommands(program2) {
   return program2;
 }
 
-// src/lib/actions/BaseAction.ts
-var BaseAction = class {
-  async confirmPrompt(message) {
-    const answer = await lib_default.prompt([
-      {
-        type: "confirm",
-        name: "confirmAction",
-        message,
-        default: true
-      }
-    ]);
-    if (!answer.confirmAction) {
-      console.log("Operation aborted!");
-      process.exit(0);
-    }
-  }
-};
-
 // src/commands/validators/validators.ts
 var ValidatorsAction = class extends BaseAction {
   async getValidator(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genlayer",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "GenLayer Command Line Tool",
   "main": "src/index.ts",
   "bin": {

package/src/commands/general/index.ts

@@ -4,6 +4,7 @@ import simulatorService from "../../lib/services/simulator";
 import { initAction, InitActionOptions } from "./init";
 import { startAction, StartActionOptions } from "./start";
 import {localnetCompatibleVersion} from "../../lib/config/simulator";
+import {StopAction} from "./stop";
 
 export function initializeGeneralCommands(program: Command) {
   program
@@ -24,5 +25,13 @@ export function initializeGeneralCommands(program: Command) {
     .option("--reset-db", "Reset Database", false)
     .action((options: StartActionOptions) => startAction(options, simulatorService));
 
+  program
+    .command("stop")
+    .description("Stop all running localnet services.")
+    .action(async () => {
+      const stopAction = new StopAction();
+      await stopAction.stop();
+    });
+
   return program;
 }

package/src/commands/general/init.ts

@@ -77,7 +77,7 @@ export async function initAction(options: InitActionOptions, simulatorService: I
     {
       type: "confirm",
       name: "confirmReset",
-      message: `This command is going to reset GenLayer docker images and containers, providers API Keys, and GenLayer database (accounts, transactions, and validators). Do you want to continue?`,
+      message: `This command is going to reset GenLayer docker images and containers, providers API Keys, and GenLayer database (accounts, transactions, validators and logs). Contract code (gpy files) will be kept. Do you want to continue?`,
       default: true,
     },
   ]);

package/src/commands/general/stop.ts

@@ -0,0 +1,25 @@
+import { BaseAction } from "../../lib/actions/BaseAction";
+import { SimulatorService } from "../../lib/services/simulator";
+import { ISimulatorService } from "../../lib/interfaces/ISimulatorService";
+
+export class StopAction extends BaseAction {
+  private simulatorService: ISimulatorService;
+
+  constructor() {
+    super();
+    this.simulatorService = new SimulatorService();
+  }
+
+  public async stop(): Promise<void> {
+    try{
+      await this.confirmPrompt(
+        "Are you sure you want to stop all running GenLayer containers? This will halt all active processes."
+      );
+      console.log(`Stopping Docker containers...`);
+      await this.simulatorService.stopDockerContainers();
+      console.log(`All running GenLayer containers have been successfully stopped.`);
+    }catch (error) {
+      console.error("An error occurred while stopping the containers:", error)
+    }
+  }
+}

package/src/lib/interfaces/ISimulatorService.ts

@@ -12,8 +12,9 @@ export interface ISimulatorService {
   getAiProvidersOptions(withHint: boolean): Array<{name: string; value: string}>;
   getFrontendUrl(): string;
   openFrontend(): Promise<boolean>;
-  resetDockerContainers(): Promise<boolean>;
-  resetDockerImages(): Promise<boolean>;
+  stopDockerContainers(): Promise<void>;
+  resetDockerContainers(): Promise<void>;
+  resetDockerImages(): Promise<void>;
   checkCliVersion(): Promise<void>;
   cleanDatabase(): Promise<boolean>;
   addConfigToEnvFile(newConfig: Record<string, string>): void;

package/src/lib/services/simulator.ts

@@ -1,4 +1,4 @@
-import Docker from "dockerode"
+import Docker, {ContainerInfo} from "dockerode";
 import * as fs from "fs";
 import * as dotenv from "dotenv";
 import * as path from "path";
@@ -48,6 +48,39 @@ export class SimulatorService implements ISimulatorService {
     this.docker = new Docker();
   }
 
+  private readEnvConfigValue(key: string): string {
+    const envFilePath = path.join(this.location, ".env");
+    // Transform the config string to object
+    const envConfig = dotenv.parse(fs.readFileSync(envFilePath, "utf8"));
+    return envConfig[key];
+  }
+
+  private async getGenlayerContainers(): Promise<ContainerInfo[]> {
+    const containers = await this.docker.listContainers({ all: true });
+    return containers.filter(container =>
+      container.Names.some(name =>
+        name.startsWith(CONTAINERS_NAME_PREFIX) || name.includes("ollama")
+      )
+    );
+  }
+
+  private async stopAndRemoveContainers(remove: boolean = false): Promise<void> {
+    const genlayerContainers = await this.getGenlayerContainers();
+
+    for (const containerInfo of genlayerContainers) {
+      const container = this.docker.getContainer(containerInfo.Id);
+      if (containerInfo.State === "running") {
+        await container.stop();
+      }
+
+      const isOllamaContainer = containerInfo.Names.some(name => name.includes("ollama"));
+
+      if (remove && !isOllamaContainer) {
+        await container.remove();
+      }
+    }
+  }
+
   public addConfigToEnvFile(newConfig: Record<string, string>): void {
     const envFilePath = path.join(this.location, ".env");
 
@@ -76,13 +109,6 @@ export class SimulatorService implements ISimulatorService {
     return this.composeOptions;
   }
 
-  private readEnvConfigValue(key: string): string {
-    const envFilePath = path.join(this.location, ".env");
-    // Transform the config string to object
-    const envConfig = dotenv.parse(fs.readFileSync(envFilePath, "utf8"));
-    return envConfig[key];
-  }
-
   public async checkCliVersion(): Promise<void> {
     const update = await updateCheck(pkg);
     if (update && update.latest !== pkg.version) {
@@ -218,25 +244,15 @@ export class SimulatorService implements ISimulatorService {
     return true;
   }
 
-  public async resetDockerContainers(): Promise<boolean> {
-    const containers = await this.docker.listContainers({ all: true });
-    const genlayerContainers = containers.filter(container =>
-      container.Names.some(name =>
-        name.startsWith(CONTAINERS_NAME_PREFIX)
-      )
-    );
+  public async stopDockerContainers(): Promise<void> {
+    await this.stopAndRemoveContainers(false);
+  }
 
-    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 resetDockerContainers(): Promise<void> {
+    await this.stopAndRemoveContainers(true);
   }
 
-  public async resetDockerImages(): Promise<boolean> {
+  public async resetDockerImages(): Promise<void> {
     const images = await this.docker.listImages();
     const genlayerImages = images.filter(image =>
       image.RepoTags?.some(tag => tag.startsWith(IMAGES_NAME_PREFIX))
@@ -246,8 +262,6 @@ export class SimulatorService implements ISimulatorService {
       const image = this.docker.getImage(imageInfo.Id);
       await image.remove({force: true});
     }
-
-    return true;
   }
 
   public async cleanDatabase(): Promise<boolean> {

package/tests/actions/stop.test.ts

@@ -0,0 +1,58 @@
+import { describe, test, vi, beforeEach, afterEach, expect } from "vitest";
+import { StopAction } from "../../src/commands/general/stop";
+import { SimulatorService } from "../../src/lib/services/simulator";
+import { ISimulatorService } from "../../src/lib/interfaces/ISimulatorService";
+import inquirer from "inquirer";
+
+vi.mock("../../src/lib/services/simulator");
+vi.mock("inquirer");
+
+describe("StopAction", () => {
+  let stopAction: StopAction;
+  let mockSimulatorService: ISimulatorService;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+
+    mockSimulatorService = {
+      stopDockerContainers: vi.fn(),
+    } as unknown as ISimulatorService;
+
+    SimulatorService.prototype.stopDockerContainers = mockSimulatorService.stopDockerContainers;
+
+    stopAction = new StopAction();
+    (stopAction as any).simulatorService = mockSimulatorService;
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  test("should stop containers if user confirms", async () => {
+    vi.mocked(inquirer.prompt).mockResolvedValue({ confirmAction: true });
+
+    await stopAction.stop();
+
+    expect(inquirer.prompt).toHaveBeenCalledWith([
+      {
+        type: "confirm",
+        name: "confirmAction",
+        message: "Are you sure you want to stop all running GenLayer containers? This will halt all active processes.",
+        default: true,
+      },
+    ]);
+    expect(mockSimulatorService.stopDockerContainers).toHaveBeenCalled();
+  });
+
+  test("should abort if user cancels", async () => {
+    vi.mocked(inquirer.prompt).mockResolvedValue({ confirmAction: false });
+
+    console.log = vi.fn();
+
+    await stopAction.stop();
+
+    expect(inquirer.prompt).toHaveBeenCalled();
+    expect(console.log).toHaveBeenCalledWith("Operation aborted!");
+    expect(mockSimulatorService.stopDockerContainers).not.toHaveBeenCalled();
+  });
+});

package/tests/commands/stop.test.ts

@@ -0,0 +1,27 @@
+import { Command } from "commander";
+import { vi, describe, beforeEach, afterEach, test, expect } from "vitest";
+import { initializeGeneralCommands } from "../../src/commands/general";
+import { StopAction } from "../../src/commands/general/stop";
+
+vi.mock("../../src/commands/general/stop");
+
+describe("stop command", () => {
+  let program: Command;
+
+  beforeEach(() => {
+    program = new Command();
+    initializeGeneralCommands(program);
+
+    vi.clearAllMocks();
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  test("doesn't require arguments or options", async () => {
+    expect(() => program.parse(["node", "test", "stop"])).not.toThrow();
+    expect(StopAction).toHaveBeenCalledTimes(1);
+    expect(StopAction.prototype.stop).toHaveBeenCalledWith();
+  });
+});

package/tests/services/simulator.test.ts

@@ -329,7 +329,7 @@ describe("SimulatorService - Docker Tests", () => {
 
     const result = await simulatorService.resetDockerContainers();
 
-    expect(result).toBe(true);
+    expect(result).toBe(undefined);
     expect(mockListContainers).toHaveBeenCalledWith({ all: true });
 
     // Ensure only the relevant containers were stopped and removed
@@ -341,6 +341,36 @@ describe("SimulatorService - Docker Tests", () => {
     expect(mockRemove).toHaveBeenCalledTimes(2);
   });
 
+  test("should stop all running GenLayer containers", async () => {
+    const mockContainers = [
+      {
+        Id: "container1",
+        Names: [`${CONTAINERS_NAME_PREFIX}container1`],
+        State: "running",
+      },
+      {
+        Id: "container2",
+        Names: [`${CONTAINERS_NAME_PREFIX}container2`],
+        State: "exited",
+      },
+    ];
+
+    vi.mocked(Docker.prototype.listContainers).mockResolvedValue(mockContainers as any);
+
+    const mockStop = vi.fn().mockResolvedValue(undefined);
+    const mockGetContainer = vi.mocked(Docker.prototype.getContainer);
+    mockGetContainer.mockImplementation(() => ({
+      stop: mockStop,
+    } as unknown as Docker.Container));
+
+    await simulatorService.stopDockerContainers();
+
+    expect(mockGetContainer).toHaveBeenCalledWith("container1");
+    expect(mockGetContainer).toHaveBeenCalledWith("container2");
+    expect(mockStop).toHaveBeenCalledTimes(1);
+  });
+
+
   test("should remove Docker images with the specified prefix", async () => {
     const mockImages = [
       {
@@ -366,7 +396,7 @@ describe("SimulatorService - Docker Tests", () => {
 
     const result = await simulatorService.resetDockerImages();
 
-    expect(result).toBe(true);
+    expect(result).toBe(undefined);
     expect(mockListImages).toHaveBeenCalled();
     expect(mockGetImage).toHaveBeenCalledWith("image1");
     expect(mockGetImage).toHaveBeenCalledWith("image2");

package/vitest.config.ts

@@ -4,6 +4,7 @@ export default defineConfig({
   test: {
     globals: true,
     environment: 'jsdom',
+    testTimeout: 10000,
     coverage: {
       exclude: [...configDefaults.exclude, '*.js', 'tests/**/*.ts', 'src/types', 'scripts'],
     }