exec.test.js

import { resolve } from "path";
import test from "ava";
import { stub } from "sinon";
import { WritableStreamBuffer } from "stream-buffers";
import exec from "../lib/exec.js";

test.beforeEach((t) => {
  t.context.stdout = new WritableStreamBuffer();
  t.context.stderr = new WritableStreamBuffer();
  // Mock logger
  t.context.log = stub();
  t.context.error = stub();
  t.context.logger = {
    log: t.context.log,
    error: t.context.error,
    warn: t.context.warn,
  };
});

test("Pipe script output to stdout and stderr", async (t) => {
  const pluginConfig = {
    publishCmd: '>&2 echo "write to stderr" && echo "write to stdout"',
  };
  const context = {
    stdout: t.context.stdout,
    stderr: t.context.stderr,
    logger: t.context.logger,
    options: {},
  };

  const result = await exec("publishCmd", pluginConfig, context);

  t.is(result, "write to stdout");
  t.is(t.context.stdout.getContentsAsString("utf8").trim(), "write to stdout");
  t.is(t.context.stderr.getContentsAsString("utf8").trim(), "write to stderr");
});

test("Generate command with template", async (t) => {
  const pluginConfig = {
    publishCmd: `./test/fixtures/echo-args.sh \${config.conf} \${lastRelease.version}`,
    conf: "confValue",
  };
  const context = {
    stdout: t.context.stdout,
    stderr: t.context.stderr,
    lastRelease: { version: "1.0.0" },
    logger: t.context.logger,
  };

  const result = await exec("publishCmd", pluginConfig, context);
  t.is(result, "confValue 1.0.0");
});

test("Generate command with env variables", async (t) => {
  const pluginConfig = {
    publishCmd: {
      cmd: `./test/fixtures/echo-args.sh \${config.conf} \${lastRelease.version}`,
      env: {
        NEXT_RELEASE_NOTES: "${nextRelease.notes}",
      },
    },
    conf: "confValue",
  };
  const context = {
    stdout: t.context.stdout,
    stderr: t.context.stderr,
    lastRelease: { version: "1.0.0" },
    nextRelease: { notes: "notes &\"'" },
    logger: t.context.logger,
  };

  const result = await exec("publishCmd", pluginConfig, context);
  t.is(result, "confValue 1.0.0 notes &\"'");
});

test('Execute the script with the specified "shell"', async (t) => {
  const context = {
    stdout: t.context.stdout,
    stderr: t.context.stderr,
    logger: t.context.logger,
  };

  let result = await exec(
    "publishCmd",
    { publishCmd: "echo $0", shell: "bash" },
    context,
  );
  t.is(result, "bash");

  result = await exec(
    "publishCmd",
    { publishCmd: "echo $0", shell: "sh" },
    context,
  );
  t.is(result, "sh");
});

test('Execute the script in "cmd" if no step specific command is passed', async (t) => {
  const context = {
    stdout: t.context.stdout,
    stderr: t.context.stderr,
    logger: t.context.logger,
  };

  const result = await exec("publishCmd", { cmd: "echo run cmd" }, context);
  t.is(result, "run cmd");
});

test('Exececute the script in cmd from the relative in "execCwd"', async (t) => {
  const pluginConfig = {
    publishCmd: `./fixtures/echo-args.sh $PWD`,
    execCwd: "test",
  };
  const context = {
    stdout: t.context.stdout,
    stderr: t.context.stderr,
    logger: t.context.logger,
    cwd: process.cwd(),
  };

  const result = await exec("publishCmd", pluginConfig, context);
  t.is(result, resolve(process.cwd(), "test"));
});