@aikidosec/safe-chain 1.0.0 → 1.0.10

package/src/shell-integration/removeAlias.js

@@ -0,0 +1,61 @@
+import fs from "fs";
+import path from "path";
+import { getAliases } from "./helpers.js";
+import { ui } from "../environment/userInteraction.js";
+import { EOL } from "os";
+
+export function isRemoveAliasCommand(args) {
+  if (args[0] === "remove-aikido-aliases") {
+    return true;
+  }
+
+  if (args[0] === "remove-aikido-npm-alias") {
+    // not in the documenation anymore, but still here for backwards compatibility
+    return true;
+  }
+
+  return false;
+}
+
+export function removeAlias(args) {
+  if (!isRemoveAliasCommand(args)) {
+    return;
+  }
+
+  if (args.length < 2) {
+    ui.writeError("Please specify the file to remove the alias from.");
+    return;
+  }
+
+  const filePath = path.resolve(args[1]);
+  const aliases = getAliases(filePath);
+
+  if (!fs.existsSync(filePath)) {
+    ui.writeError(`File ${filePath} does not exist.`);
+    return;
+  }
+
+  for (const alias of aliases) {
+    const fileContent = fs.readFileSync(filePath, "utf-8");
+    if (!fileContent.includes(alias)) {
+      ui.writeInformation(`Alias "${alias}" does not exist in ${filePath}`);
+      continue;
+    }
+
+    ui.writeInformation(`Removing alias "${alias}" from ${filePath}...`);
+
+    // Remove the alias from the file.
+    // Make sure to remove the added newlines as well, but also make sure to remove aliases if they don't have newlines
+    const updatedContent = fileContent
+      .replaceAll(`${EOL}${alias}${EOL}`, "")
+      .replaceAll(`${alias}${EOL}`, "")
+      .replaceAll(`${EOL}${alias}`, "")
+      .replaceAll(alias, "");
+
+    fs.writeFileSync(filePath, updatedContent, "utf-8");
+    ui.writeInformation(`Alias "${alias}" removed from ${filePath}`);
+  }
+  ui.writeInformation(
+    `Please restart your terminal for the changes to take effect.`
+  );
+}

package/src/shell-integration/shellIntegration.spec.js

@@ -0,0 +1,172 @@
+import { describe, it } from "node:test";
+import assert from "node:assert";
+import { EOL, tmpdir } from "node:os";
+import fs from "node:fs";
+import { addAlias } from "./addAlias.js";
+import { removeAlias } from "./removeAlias.js";
+
+describe("Add alias", () => {
+  function runTestsForEnvironment(shell, startupExtension, aliases) {
+    it(`should add alias to ${shell} file`, () => {
+      const lines = [`#!/usr/bin/env ${shell}`, "", "alias cls='clear'"];
+      const filePath = createShellStartupScript(lines, startupExtension);
+
+      addAlias(["add-aikido-aliases", filePath]);
+
+      const fileContent = readAndDeleteFile(filePath);
+      for (const alias of aliases) {
+        assert.ok(fileContent.includes(alias));
+      }
+    });
+
+    it(`should not add alias if it already exists in ${shell} file`, () => {
+      const lines = [`#!/usr/bin/env ${shell}`, "", ...aliases];
+      const filePath = createShellStartupScript(lines, startupExtension);
+
+      addAlias(["add-aikido-aliases", filePath]);
+
+      const fileContent = readAndDeleteFile(filePath);
+      assert.strictEqual(fileContent.length, lines.length);
+    });
+
+    it(`should create file and add alias if file does not exist`, () => {
+      const filePath = `${tmpdir()}/nonexistent-file${startupExtension}`;
+      if (fs.existsSync(filePath)) {
+        fs.rmSync(filePath, { force: true });
+      }
+
+      addAlias(["add-aikido-aliases", filePath]);
+
+      assert.ok(fs.existsSync(filePath));
+      const fileContent = readAndDeleteFile(filePath);
+      for (const alias of aliases) {
+        assert.ok(fileContent.includes(alias));
+      }
+    });
+
+    it(`should add the alias only once in ${shell} file`, () => {
+      const lines = [`#!/usr/bin/env ${shell}`, ""];
+      const filePath = createShellStartupScript(lines, startupExtension);
+
+      addAlias(["add-aikido-aliases", filePath]);
+      addAlias(["add-aikido-aliases", filePath]);
+
+      const fileContent = readAndDeleteFile(filePath);
+      for (const alias of aliases) {
+        assert.strictEqual(countOccurences(fileContent, alias), 1);
+      }
+    });
+
+    it(`should remove one alias from ${shell} file`, () => {
+      const alias = aliases[Math.floor(Math.random() * aliases.length)];
+      const lines = [`#!/usr/bin/env ${shell}`, "", alias];
+      const filePath = createShellStartupScript(lines, startupExtension);
+
+      removeAlias(["remove-aikido-npm-alias", filePath]);
+
+      const fileContent = readAndDeleteFile(filePath);
+      assert.ok(!fileContent.includes(alias));
+    });
+
+    it(`should remove all aliases from ${shell} file`, () => {
+      const lines = [`#!/usr/bin/env ${shell}`, "", ...aliases, ""];
+      const filePath = createShellStartupScript(lines, startupExtension);
+
+      removeAlias(["remove-aikido-npm-alias", filePath]);
+
+      const fileContent = readAndDeleteFile(filePath);
+      for (const alias of aliases) {
+        assert.ok(!fileContent.includes(alias));
+      }
+    });
+
+    it(`should not remove alias if it does not exist in ${shell} file`, () => {
+      const lines = [`#!/usr/bin/env ${shell}`, "", "alias cls='clear'"];
+      const filePath = createShellStartupScript(lines, startupExtension);
+
+      removeAlias(["remove-aikido-npm-alias", filePath]);
+
+      const fileContent = readAndDeleteFile(filePath);
+      assert.ok(fileContent.includes("alias cls='clear'"));
+    });
+
+    it(`should not remove alias if file does not exist`, () => {
+      const filePath = `${tmpdir()}/nonexistent-file${startupExtension}`;
+      if (fs.existsSync(filePath)) {
+        fs.rmSync(filePath, { force: true });
+      }
+
+      removeAlias(["remove-aikido-npm-alias", filePath]);
+
+      assert.ok(!fs.existsSync(filePath));
+    });
+
+    it(`should remove aliases from ${shell} file if duplicated`, () => {
+      const lines = [
+        `#!/usr/bin/env ${shell}`,
+        "",
+        ...aliases,
+        "cls='clear'",
+        ...aliases,
+        ...aliases,
+        "",
+      ];
+      const filePath = createShellStartupScript(lines, startupExtension);
+
+      removeAlias(["remove-aikido-npm-alias", filePath]);
+
+      const fileContent = readAndDeleteFile(filePath);
+      for (const alias of aliases) {
+        assert.ok(!fileContent.includes(alias));
+      }
+    });
+  }
+
+  runTestsForEnvironment("bash", ".bashrc", [
+    "alias npm='aikido-npm'",
+    "alias npx='aikido-npx'",
+    "alias yarn='aikido-yarn'",
+  ]);
+  runTestsForEnvironment("zsh", ".zshrc", [
+    "alias npm='aikido-npm'",
+    "alias npx='aikido-npx'",
+    "alias yarn='aikido-yarn'",
+  ]);
+  runTestsForEnvironment("fish", ".fish", [
+    'alias npm "aikido-npm"',
+    'alias npx "aikido-npx"',
+    'alias yarn "aikido-yarn"',
+  ]);
+  runTestsForEnvironment("pwsh", ".ps1", [
+    "Set-Alias npm aikido-npm",
+    "Set-Alias npx aikido-npx",
+    "Set-Alias yarn aikido-yarn",
+  ]);
+});
+
+function createShellStartupScript(lines, fileExtension) {
+  var randomFileName = Math.random().toString(36).substring(2, 15);
+  var filePath = `${tmpdir()}/${randomFileName}${fileExtension}`;
+  fs.writeFileSync(filePath, lines.join(EOL), "utf-8");
+  return filePath;
+}
+
+function readAndDeleteFile(filePath) {
+  var fileContent = fs.readFileSync(filePath, "utf-8");
+  fs.rm(filePath, { force: true }, (err) => {
+    if (err) {
+      console.error(`Error deleting file: ${err}`);
+    }
+  });
+  return fileContent.split(EOL);
+}
+
+function countOccurences(lines, alias) {
+  let count = 0;
+  for (const line of lines) {
+    if (line.includes(alias)) {
+      count++;
+    }
+  }
+  return count;
+}