@flowscripter/dynamic-cli-framework 1.0.0

package/tests/service/printer/DefaultPrinterService.test.ts

@@ -0,0 +1,409 @@
+import { describe, test } from "bun:test";
+import {
+  expectBytesEquals,
+  expectStringEquals,
+  expectStringIncludes,
+  sleep,
+  write,
+} from "../../fixtures/util.ts";
+import DefaultPrinterService from "../../../src/service/printer/DefaultPrinterService.ts";
+import { Icon, Level } from "../../../src/api/service/core/PrinterService.ts";
+import TtyTerminal from "../../../src/service/printer/terminal/TtyTerminal.ts";
+import TtyStyler from "../../../src/service/printer/terminal/TtyStyler.ts";
+import StreamString from "../../fixtures/StreamString.ts";
+
+describe("DefaultPrinterService Tests", () => {
+  test("Color disabled works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await printerService.info(`hello ${printerService.blue("world")}`);
+
+    expectStringEquals(dummyStderr.getString(), "hello world");
+  });
+
+  test("Color enabled works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = true;
+    printerService.darkMode = true;
+    await printerService.info(`hello ${printerService.blue("world")}`);
+    expectBytesEquals(
+      dummyStderr.getString(),
+      new Uint8Array([
+        27,
+        91,
+        51,
+        56,
+        59,
+        50,
+        59,
+        49,
+        51,
+        49,
+        59,
+        49,
+        52,
+        56,
+        59,
+        49,
+        53,
+        48,
+        109,
+        104,
+        101,
+        108,
+        108,
+        111,
+        32,
+        27,
+        91,
+        51,
+        56,
+        59,
+        50,
+        59,
+        51,
+        56,
+        59,
+        49,
+        51,
+        57,
+        59,
+        50,
+        49,
+        48,
+        109,
+        119,
+        111,
+        114,
+        108,
+        100,
+        27,
+        91,
+        51,
+        57,
+        109,
+        27,
+        91,
+        51,
+        57,
+        109,
+      ]),
+    );
+  });
+
+  test("stdout writable accessible", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await write(printerService.stdoutWritable, "hello world");
+
+    expectStringEquals(dummyStdout.getString(), "hello world");
+  });
+
+  test("stderr writable accessible", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await write(printerService.stderrWritable, "hello world");
+
+    expectStringEquals(dummyStderr.getString(), "hello world");
+  });
+
+  test("Printing to stdout and stderr works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await printerService.print("hello stdout\n");
+    await printerService.info("hello stderr\n");
+
+    expectStringEquals(
+      dummyStdout.getString(),
+      "hello stdout\n",
+    );
+    expectStringEquals(
+      dummyStderr.getString(),
+      "hello stderr\n",
+    );
+  });
+
+  test("Level filtering works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await printerService.debug("hello debug 1\n");
+    await printerService.info("hello info 1\n");
+    await printerService.warn("hello warn 1\n");
+
+    expectStringEquals(
+      dummyStderr.getString(),
+      "hello info 1\nhello warn 1\n",
+    );
+
+    await printerService.setLevel(Level.WARN);
+
+    await printerService.debug("hello debug 2\n");
+    await printerService.info("hello info 2\n");
+    await printerService.warn("hello warn 2\n");
+
+    expectStringEquals(
+      dummyStderr.getString(),
+      "hello info 1\nhello warn 1\nhello warn 2\n",
+    );
+
+    await printerService.setLevel(Level.DEBUG);
+
+    await printerService.debug("hello debug 3\n");
+    await printerService.info("hello info 3\n");
+    await printerService.warn("hello warn 3\n");
+
+    expectStringEquals(
+      dummyStderr.getString(),
+      "hello info 1\nhello warn 1\nhello warn 2\nhello debug 3\nhello info 3\nhello warn 3\n",
+    );
+  });
+
+  test("Icons work on stderr", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await printerService.info("hello info", Icon.INFORMATION);
+
+    expectStringEquals(
+      dummyStderr.getString(),
+      "ℹ hello info",
+    );
+
+    await printerService.info("hello success", Icon.SUCCESS);
+
+    expectStringEquals(
+      dummyStderr.getString(),
+      "ℹ hello info✔ hello success",
+    );
+  });
+
+  test("Icons work on stdout", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await printerService.print("hello info", Icon.INFORMATION);
+
+    expectStringEquals(
+      dummyStdout.getString(),
+      "ℹ hello info",
+    );
+
+    await printerService.print("hello success", Icon.SUCCESS);
+
+    expectStringEquals(
+      dummyStdout.getString(),
+      "ℹ hello info✔ hello success",
+    );
+  });
+
+  test("Spinner works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    await printerService.showSpinner("hello world");
+    await sleep(150);
+    await printerService.hideSpinner();
+
+    expectBytesEquals(
+      dummyStderr.getString(),
+      new Uint8Array([
+        27,
+        91,
+        63,
+        50,
+        53,
+        108,
+        27,
+        91,
+        50,
+        75,
+        27,
+        91,
+        71,
+        226,
+        160,
+        139,
+        32,
+        104,
+        101,
+        108,
+        108,
+        111,
+        32,
+        119,
+        111,
+        114,
+        108,
+        100,
+        27,
+        91,
+        50,
+        75,
+        27,
+        91,
+        71,
+        27,
+        91,
+        63,
+        50,
+        53,
+        104,
+      ]),
+    );
+  });
+
+  test("Progress bar works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    const handle = await printerService.showProgressBar("bits", "foo", 150, 35);
+    await sleep(50);
+    printerService.updateProgressBar(handle, 50);
+    await sleep(50);
+    await printerService.hideProgressBar(handle);
+    expectStringIncludes(
+      dummyStderr.getString(),
+      "foo",
+    );
+    expectStringIncludes(
+      dummyStderr.getString(),
+      "bits",
+    );
+  });
+
+  test("Multiple progress bars work", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = false;
+
+    const handle1 = await printerService.showProgressBar("bits", "foo");
+    await sleep(50);
+    const handle2 = await printerService.showProgressBar("megaflops", "bar");
+    await sleep(50);
+    printerService.updateProgressBar(handle1, 25, "foo1");
+    await sleep(50);
+    printerService.updateProgressBar(handle2, 50, "bar1");
+    await sleep(50);
+    await printerService.hideProgressBar(handle1);
+    await printerService.hideProgressBar(handle2);
+    expectStringIncludes(
+      dummyStderr.getString(),
+      "bits",
+    );
+    expectStringIncludes(
+      dummyStderr.getString(),
+      "megaflops",
+    );
+    expectStringIncludes(
+      dummyStderr.getString(),
+      "foo1",
+    );
+    expectStringIncludes(
+      dummyStderr.getString(),
+      "bar1",
+    );
+  });
+});

package/tests/service/printer/PrinterServiceProvider.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, test } from "bun:test";
+import DefaultContext from "../../../src/runtime/DefaultContext.ts";
+import { getCLIConfig } from "../../fixtures/CLIConfig.ts";
+import PrinterServiceProvider from "../../../src/service/printer/PrinterServiceProvider.ts";
+import { SHUTDOWN_SERVICE_ID } from "../../../src/api/service/core/ShutdownService.ts";
+import DefaultShutdownService from "../../../src/service/shutdown/DefaultShutdownService.ts";
+import TtyTerminal from "../../../src/service/printer/terminal/TtyTerminal.ts";
+import StreamString from "../../fixtures/StreamString.ts";
+
+describe("PrinterServiceProvider Tests", () => {
+  test("PrinterServiceProvider provide works", async () => {
+    const streamString = new StreamString();
+    const printerServiceProvider = new PrinterServiceProvider(
+      100,
+      streamString.writableStream,
+      new TtyTerminal(streamString.writeStream),
+    );
+    const cliConfig = getCLIConfig();
+    const context = new DefaultContext(cliConfig);
+
+    context.addServiceInstance(
+      SHUTDOWN_SERVICE_ID,
+      new DefaultShutdownService(),
+    );
+
+    const serviceInfo = await printerServiceProvider.provide(cliConfig);
+    expect(serviceInfo.commands.length).toEqual(3);
+  });
+});

package/tests/service/printer/command/LogLevelCommand.test.ts

@@ -0,0 +1,58 @@
+import { describe, expect, test } from "bun:test";
+import DefaultContext from "../../../../src/runtime/DefaultContext.ts";
+import LogLevelCommand from "../../../../src/service/printer/command/LogLevelCommand.ts";
+import { getCLIConfig } from "../../../fixtures/CLIConfig.ts";
+import PrinterServiceProvider from "../../../../src/service/printer/PrinterServiceProvider.ts";
+import { Level } from "../../../../src/api/service/core/PrinterService.ts";
+import ShutdownServiceProvider from "../../../../src/service/shutdown/ShutdownServiceProvider.ts";
+import { SHUTDOWN_SERVICE_ID } from "../../../../src/api/service/core/ShutdownService.ts";
+import TtyTerminal from "../../../../src/service/printer/terminal/TtyTerminal.ts";
+import StreamString from "../../../fixtures/StreamString.ts";
+import DefaultPrinterService from "../../../../src/service/printer/DefaultPrinterService.ts";
+import TtyStyler from "../../../../src/service/printer/terminal/TtyStyler.ts";
+
+describe("LogLevelCommand Tests", () => {
+  test("LogLevelCommand works", async () => {
+    const streamString = new StreamString();
+    const printerService = new DefaultPrinterService(
+      streamString.writableStream,
+      streamString.writableStream,
+      true,
+      true,
+      new TtyTerminal(streamString.writeStream),
+      new TtyStyler(3),
+    );
+    const printerServiceProvider = new PrinterServiceProvider(
+      100,
+      printerService,
+    );
+    const cliConfig = getCLIConfig();
+    const context = new DefaultContext(cliConfig);
+
+    const shutdownServiceProvider = new ShutdownServiceProvider(1);
+    const shutdownService = (await shutdownServiceProvider.provide(cliConfig))
+      .service!;
+
+    context.addServiceInstance(SHUTDOWN_SERVICE_ID, shutdownService);
+
+    await printerServiceProvider.provide(cliConfig);
+
+    const logLevelCommand = new LogLevelCommand(printerServiceProvider, 100);
+
+    expect(
+      printerServiceProvider.printerService!.getLevel(),
+    ).toEqual(
+      Level.INFO,
+    );
+
+    await logLevelCommand.execute(context, "ERROR");
+
+    expect(
+      printerServiceProvider.printerService!.getLevel(),
+    ).toEqual(
+      Level.ERROR,
+    );
+
+    await ShutdownServiceProvider.shutdown();
+  });
+});

package/tests/service/printer/terminal/Progress.test.ts

@@ -0,0 +1,40 @@
+import { describe, test } from "bun:test";
+import Progress from "../../../../src/service/printer/terminal/Progress.ts";
+import { sleep } from "../../../fixtures/util.ts";
+import TtyTerminal from "../../../../src/service/printer/terminal/TtyTerminal.ts";
+import StreamString from "../../../fixtures/StreamString.ts";
+import TtyStyler from "../../../../src/service/printer/terminal/TtyStyler.ts";
+
+describe("Progress Tests", () => {
+  test("Progress works", async () => {
+    const streamString = new StreamString();
+    const terminal = new TtyTerminal(streamString.writeStream);
+    const progress = new Progress(terminal, new TtyStyler(3));
+
+    const handle = progress.add("foo", "bar", 100, 0);
+    await sleep(150);
+    progress.update(handle, 50, "bar2");
+    await sleep(150);
+    progress.update(handle, 150, "bar3");
+    await sleep(150);
+    await progress.hide(handle);
+  });
+
+  test("Multiple progress works", async () => {
+    const streamString = new StreamString();
+    const terminal = new TtyTerminal(streamString.writeStream);
+    const progress = new Progress(terminal, new TtyStyler(3));
+
+    const handle1 = progress.add("foo1", "bar2", 100, 0);
+    const handle2 = progress.add("foo2", "bar2", 200, 0);
+    await sleep(150);
+    progress.update(handle1, 50, "bar3");
+    await sleep(150);
+    progress.update(handle2, 100, "bar4");
+    await sleep(150);
+    progress.update(handle1, 50, "bar3");
+    progress.update(handle2, 200, "bar5 very long string now");
+    await sleep(150);
+    await progress.hideAll();
+  });
+});

package/tests/service/printer/terminal/Spinner.test.ts

@@ -0,0 +1,57 @@
+import { describe, test } from "bun:test";
+import Spinner from "../../../../src/service/printer/terminal/Spinner.ts";
+import {
+  expectStringEquals,
+  expectStringIncludes,
+  sleep,
+} from "../../../fixtures/util.ts";
+import TtyTerminal from "../../../../src/service/printer/terminal/TtyTerminal.ts";
+import StreamString from "../../../fixtures/StreamString.ts";
+import TtyStyler from "../../../../src/service/printer/terminal/TtyStyler.ts";
+
+describe("Spinner Tests", () => {
+  test("Spinner works", async () => {
+    const streamString = new StreamString();
+    const terminal = new TtyTerminal(streamString.writeStream);
+    const spinner = new Spinner(terminal, new TtyStyler(3));
+
+    await spinner.show();
+    await sleep(250);
+    await spinner.hide();
+
+    expectStringEquals(streamString.getString(), "⠋⠙");
+  });
+
+  test("Calling show and hide multiple times works", async () => {
+    const streamString = new StreamString();
+    const terminal = new TtyTerminal(streamString.writeStream);
+    const spinner = new Spinner(terminal, new TtyStyler(3));
+
+    await spinner.show();
+    await sleep(50);
+    await spinner.show();
+    await sleep(50);
+    await spinner.hide();
+    await sleep(50);
+    await spinner.hide();
+  });
+
+  test("Updating the spinner message works", async () => {
+    const streamString = new StreamString();
+    const terminal = new TtyTerminal(streamString.writeStream);
+    const spinner = new Spinner(terminal, new TtyStyler(3));
+
+    await spinner.show();
+    await sleep(150);
+    await spinner.show("foo");
+    await sleep(120);
+    await spinner.show("bar");
+    await sleep(120);
+    await spinner.show();
+    await sleep(120);
+    await spinner.hide();
+
+    expectStringIncludes(streamString.getString(), "foo");
+    expectStringIncludes(streamString.getString(), "bar");
+  });
+});

package/tests/service/shutdown/ShutdownServiceProvider.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, test } from "bun:test";
+import ShutdownServiceProvider from "../../../src/service/shutdown/ShutdownServiceProvider.ts";
+import { getCLIConfig } from "../../fixtures/CLIConfig.ts";
+
+describe("ShutdownServiceProvider Tests", () => {
+  test("ShutdownServiceProvider provide works", async () => {
+    const shutdownServiceProvider = new ShutdownServiceProvider(100);
+    const serviceInfo = await shutdownServiceProvider.provide(getCLIConfig());
+    expect(serviceInfo.commands.length).toEqual(0);
+
+    await ShutdownServiceProvider.shutdown();
+  });
+});