feat: add logs debug on post

Signed-off-by: Emilien Escalle <[email protected]>

README.md

@@ -22,6 +22,12 @@
 This action runs your docker-compose file and clean up before action finished
 
 <!-- end description -->
+
+### Post hook
+
+On post hook, the action will run `docker-compose down` to clean up the services.
+In debug mode, the logs of the running services are printed before the cleanup.
+
 <!-- start contents -->
 <!-- end contents -->
 <!-- start usage -->

src/index.test.ts

@@ -1,17 +1,56 @@
-/**
- * Unit tests for the action's entrypoint, src/index.ts
- */
+import * as core from "@actions/core";
+import { DockerComposeService } from "./services/docker-compose.service";
+import { InputService } from "./services/input.service";
+import { LoggerService } from "./services/logger.service";
 
-import * as main from "./main";
-
-// Mock the action's entrypoint
-const runMock = jest.spyOn(main, "run").mockImplementation();
+let setFailedMock: jest.SpiedFunction<typeof core.setFailed>;
+let getInputsMock: jest.SpiedFunction<typeof InputService.prototype.getInputs>;
+let debugMock: jest.SpiedFunction<typeof LoggerService.prototype.debug>;
+let infoMock: jest.SpiedFunction<typeof LoggerService.prototype.info>;
+let upMock: jest.SpiedFunction<typeof DockerComposeService.prototype.up>;
 
 describe("index", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+
+    setFailedMock = jest.spyOn(core, "setFailed").mockImplementation();
+    infoMock = jest.spyOn(LoggerService.prototype, "info").mockImplementation();
+    debugMock = jest.spyOn(LoggerService.prototype, "debug").mockImplementation();
+    getInputsMock = jest.spyOn(InputService.prototype, "getInputs");
+    upMock = jest.spyOn(DockerComposeService.prototype, "up");
+  });
+
   it("calls run when imported", async () => {
+    getInputsMock.mockImplementation(() => ({
+      composeFiles: ["docker-compose.yml"],
+      services: [],
+      composeFlags: [],
+      upFlags: [],
+      downFlags: [],
+      cwd: "/current/working/dir",
+    }));
+
+    upMock.mockResolvedValueOnce();
+
     // eslint-disable-next-line @typescript-eslint/no-require-imports
-    require("../src/index");
+    await require("../src/index");
+
+    // Verify that all of the functions were called correctly
+    expect(debugMock).toHaveBeenNthCalledWith(
+      1,
+      'inputs: {"composeFiles":["docker-compose.yml"],"services":[],"composeFlags":[],"upFlags":[],"downFlags":[],"cwd":"/current/working/dir"}'
+    );
+
+    expect(upMock).toHaveBeenCalledWith({
+      composeFiles: ["docker-compose.yml"],
+      services: [],
+      composeFlags: [],
+      upFlags: [],
+      downFlags: [],
+      cwd: "/current/working/dir",
+    });
 
-    expect(runMock).toHaveBeenCalled();
+    expect(setFailedMock).not.toHaveBeenCalled();
+    expect(infoMock).toHaveBeenCalledWith("compose started");
   });
 });

src/index.ts

@@ -1,7 +1,19 @@
 /**
  * The entrypoint for the action.
  */
-import { run, RunAction } from "./main";
+import { RunCallback, run } from "./runner";
+import { DockerComposeService } from "./services/docker-compose.service";
+import { Inputs } from "./services/input.service";
+import { LoggerService } from "./services/logger.service";
+
+const callback: RunCallback = async (
+  inputs: Inputs,
+  loggerService: LoggerService,
+  dockerComposeService: DockerComposeService
+) => {
+  await dockerComposeService.up(inputs);
+  loggerService.info("compose started");
+};
 
 // eslint-disable-next-line @typescript-eslint/no-floating-promises
-run(RunAction.UP);
+run(callback);