milliways-infosec/AikidoSec-safe-chain
7
0
Fork 0
mirror of https://github.com/AikidoSec/safe-chain.git synced 2026-05-26 20:20:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'main' into zsh-safe-chain-detection

Browse source
This commit is contained in:
Sander Declerck 2025-07-18 15:15:38 +02:00
commit 6b1b21c670
No known key found for this signature in database
27 changed files with 672 additions and 224 deletions
Download patch file Download diff file Expand all files Collapse all files

30
src/shell-integration/helpers.js
View file

@ -1,4 +1,4 @@
import { execSync, spawnSync } from "child_process";
import { spawnSync } from "child_process";
import * as os from "os";
import fs from "fs";
@ -6,29 +6,19 @@ export const knownAikidoTools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
// When adding a new tool here, also update the expected alias in the tests (shellIntegration.spec.js)
{ tool: "pnpm", aikidoCommand: "aikido-pnpm" },
{ tool: "pnpx", aikidoCommand: "aikido-pnpx" },
// When adding a new tool here, also update the expected alias in the tests (setup.spec.js, teardown.spec.js)
// and add the documentation for the new tool in the README.md
];
export function doesExecutableExistOnSystem(executableName) {
try {
if (os.platform() === "win32") {
const result = spawnSync("where", [executableName], { stdio: "ignore" });
return result.status === 0;
} else {
const result = spawnSync("which", [executableName], { stdio: "ignore" });
return result.status === 0;
}
} catch {
return false;
}
}
export function execAndGetOutput(command, shell) {
try {
return execSync(command, { encoding: "utf8", shell }).trim();
} catch (error) {
throw new Error(`Command failed: ${command}. Error: ${error.message}`);
if (os.platform() === "win32") {
const result = spawnSync("where", [executableName], { stdio: "ignore" });
return result.status === 0;
} else {
const result = spawnSync("which", [executableName], { stdio: "ignore" });
return result.status === 0;
}
}

1
src/shell-integration/setup.js
View file

@ -57,6 +57,7 @@ export async function setup() {
function setupShell(shell) {
let success = false;
try {
shell.teardown(knownAikidoTools); // First, tear down to prevent duplicate aliases
success = shell.setup(knownAikidoTools);
} catch {
success = false;

14
src/shell-integration/shellDetection.js
View file

@ -3,15 +3,23 @@ import bash from "./supported-shells/bash.js";
import powershell from "./supported-shells/powershell.js";
import windowsPowershell from "./supported-shells/windowsPowershell.js";
import fish from "./supported-shells/fish.js";
import { ui } from "../environment/userInteraction.js";
export function detectShells() {
let possibleShells = [zsh, bash, powershell, windowsPowershell, fish];
let availableShells = [];
for (const shell of possibleShells) {
if (shell.isInstalled()) {
availableShells.push(shell);
try {
for (const shell of possibleShells) {
if (shell.isInstalled()) {
availableShells.push(shell);
}
}
} catch (error) {
ui.writeError(
`We were not able to detect which shells are installed on your system. Please check your shell configuration. Error: ${error.message}`
);
return [];
}
return availableShells;

29
src/shell-integration/supported-shells/bash.js
View file

@ -1,9 +1,9 @@
import {
addLineToFile,
doesExecutableExistOnSystem,
execAndGetOutput,
removeLinesMatchingPattern,
} from "../helpers.js";
import { execSync } from "child_process";
const shellName = "Bash";
const executableName = "bash";
@ -13,19 +13,19 @@ function isInstalled() {
return doesExecutableExistOnSystem(executableName);
}
function teardown() {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
function teardown(tools) {
const startupFile = getStartupFile();
// Removes all aliases starting with "alias npm=", "alias npx=", or "alias yarn="
// This will remove the safe-chain aliases for npm, npx, and yarn commands.
removeLinesMatchingPattern(startupFile, /^alias\s+(npm|npx|yarn)=/);
for (const { tool } of tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`));
}
return true;
}
function setup(tools) {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
teardown();
const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) {
addLineToFile(
@ -37,6 +37,19 @@ function setup(tools) {
return true;
}
function getStartupFile() {
try {
return execSync(startupFileCommand, {
encoding: "utf8",
shell: executableName,
}).trim();
} catch (error) {
throw new Error(
`Command failed: ${startupFileCommand}. Error: ${error.message}`
);
}
}
export default {
name: shellName,
isInstalled,

38
src/shell-integration/supported-shells/bash.spec.js
View file

@ -3,6 +3,7 @@ import assert from "node:assert";
import { tmpdir } from "node:os";
import fs from "node:fs";
import path from "path";
import { knownAikidoTools } from "../helpers.js";
describe("Bash shell integration", () => {
let mockStartupFile;
@ -15,7 +16,6 @@ describe("Bash shell integration", () => {
// Mock the helpers module
mock.module("../helpers.js", {
namedExports: {
execAndGetOutput: () => mockStartupFile,
doesExecutableExistOnSystem: () => true,
addLineToFile: (filePath, line) => {
if (!fs.existsSync(filePath)) {
@ -33,6 +33,13 @@ describe("Bash shell integration", () => {
},
});
// Mock child_process execSync
mock.module("child_process", {
namedExports: {
execSync: () => mockStartupFile,
},
});
// Import bash module after mocking
bash = (await import("./bash.js")).default;
});
@ -63,7 +70,7 @@ describe("Bash shell integration", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = bash.setup(tools);
@ -81,22 +88,6 @@ describe("Bash shell integration", () => {
);
});
it("should call teardown before setup", () => {
// Pre-populate file with existing aliases
fs.writeFileSync(
mockStartupFile,
'alias npm="old-npm"\nalias npx="old-npx"\n',
"utf-8"
);
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
bash.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes('alias npm="old-npm"'));
assert.ok(content.includes('alias npm="aikido-npm"'));
});
it("should handle empty tools array", () => {
const result = bash.setup([]);
assert.strictEqual(result, true);
@ -122,7 +113,7 @@ describe("Bash shell integration", () => {
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = bash.teardown();
const result = bash.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -138,7 +129,7 @@ describe("Bash shell integration", () => {
fs.unlinkSync(mockStartupFile);
}
const result = bash.teardown();
const result = bash.teardown(knownAikidoTools);
assert.strictEqual(result, true);
});
@ -151,7 +142,7 @@ describe("Bash shell integration", () => {
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = bash.teardown();
const result = bash.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -177,7 +168,7 @@ describe("Bash shell integration", () => {
it("should handle complete setup and teardown cycle", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
// Setup
@ -187,7 +178,7 @@ describe("Bash shell integration", () => {
assert.ok(content.includes('alias yarn="aikido-yarn"'));
// Teardown
bash.teardown();
bash.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("alias npm="));
assert.ok(!content.includes("alias yarn="));
@ -197,6 +188,7 @@ describe("Bash shell integration", () => {
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
bash.setup(tools);
bash.teardown(tools);
bash.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");

32
src/shell-integration/supported-shells/fish.js
View file

@ -1,9 +1,9 @@
import {
addLineToFile,
doesExecutableExistOnSystem,
execAndGetOutput,
removeLinesMatchingPattern,
} from "../helpers.js";
import { execSync } from "child_process";
const shellName = "Fish";
const executableName = "fish";
@ -13,19 +13,22 @@ function isInstalled() {
return doesExecutableExistOnSystem(executableName);
}
function teardown() {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
function teardown(tools) {
const startupFile = getStartupFile();
// Removes all aliases starting with "alias npm=", "alias npx=", or "alias yarn="
// This will remove the safe-chain aliases for npm, npx, and yarn commands.
removeLinesMatchingPattern(startupFile, /^alias\s+(npm|npx|yarn)\s+/);
for (const { tool } of tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(
startupFile,
new RegExp(`^alias\\s+${tool}\\s+`)
);
}
return true;
}
function setup(tools) {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
teardown();
const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) {
addLineToFile(
@ -37,6 +40,19 @@ function setup(tools) {
return true;
}
function getStartupFile() {
try {
return execSync(startupFileCommand, {
encoding: "utf8",
shell: executableName,
}).trim();
} catch (error) {
throw new Error(
`Command failed: ${startupFileCommand}. Error: ${error.message}`
);
}
}
export default {
name: shellName,
isInstalled,

66
src/shell-integration/supported-shells/fish.spec.js
View file

@ -3,6 +3,7 @@ import assert from "node:assert";
import { tmpdir } from "node:os";
import fs from "node:fs";
import path from "path";
import { knownAikidoTools } from "../helpers.js";
describe("Fish shell integration", () => {
let mockStartupFile;
@ -11,11 +12,10 @@ describe("Fish shell integration", () => {
beforeEach(async () => {
// Create temporary startup file for testing
mockStartupFile = path.join(tmpdir(), `test-fish-config-${Date.now()}`);
// Mock the helpers module
mock.module("../helpers.js", {
namedExports: {
execAndGetOutput: () => mockStartupFile,
doesExecutableExistOnSystem: () => true,
addLineToFile: (filePath, line) => {
if (!fs.existsSync(filePath)) {
@ -27,10 +27,17 @@ describe("Fish shell integration", () => {
if (!fs.existsSync(filePath)) return;
const content = fs.readFileSync(filePath, "utf-8");
const lines = content.split("\n");
const filteredLines = lines.filter(line => !pattern.test(line));
const filteredLines = lines.filter((line) => !pattern.test(line));
fs.writeFileSync(filePath, filteredLines.join("\n"), "utf-8");
}
}
},
},
});
// Mock child_process execSync
mock.module("child_process", {
namedExports: {
execSync: () => mockStartupFile,
},
});
// Import fish module after mocking
@ -42,7 +49,7 @@ describe("Fish shell integration", () => {
if (fs.existsSync(mockStartupFile)) {
fs.unlinkSync(mockStartupFile);
}
// Reset mocks
mock.reset();
});
@ -63,34 +70,28 @@ describe("Fish shell integration", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = fish.setup(tools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('alias npm "aikido-npm" # Safe-chain alias for npm'));
assert.ok(content.includes('alias npx "aikido-npx" # Safe-chain alias for npx'));
assert.ok(content.includes('alias yarn "aikido-yarn" # Safe-chain alias for yarn'));
});
it("should call teardown before setup", () => {
// Pre-populate file with existing aliases
fs.writeFileSync(mockStartupFile, 'alias npm "old-npm"\nalias npx "old-npx"\n', "utf-8");
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
fish.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes('alias npm "old-npm"'));
assert.ok(content.includes('alias npm "aikido-npm"'));
assert.ok(
content.includes('alias npm "aikido-npm" # Safe-chain alias for npm')
);
assert.ok(
content.includes('alias npx "aikido-npx" # Safe-chain alias for npx')
);
assert.ok(
content.includes('alias yarn "aikido-yarn" # Safe-chain alias for yarn')
);
});
it("should handle empty tools array", () => {
const result = fish.setup([]);
assert.strictEqual(result, true);
// File should be created during teardown call even if no tools are provided
if (fs.existsSync(mockStartupFile)) {
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -107,12 +108,12 @@ describe("Fish shell integration", () => {
"alias npx 'aikido-npx'",
"alias yarn 'aikido-yarn'",
"alias ls 'ls --color=auto'",
"alias grep 'grep --color=auto'"
"alias grep 'grep --color=auto'",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = fish.teardown();
const result = fish.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -128,7 +129,7 @@ describe("Fish shell integration", () => {
fs.unlinkSync(mockStartupFile);
}
const result = fish.teardown();
const result = fish.teardown(knownAikidoTools);
assert.strictEqual(result, true);
});
@ -136,12 +137,12 @@ describe("Fish shell integration", () => {
const initialContent = [
"#!/usr/bin/env fish",
"alias ls 'ls --color=auto'",
"set PATH $PATH ~/bin"
"set PATH $PATH ~/bin",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = fish.teardown();
const result = fish.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -167,7 +168,7 @@ describe("Fish shell integration", () => {
it("should handle complete setup and teardown cycle", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
// Setup
@ -177,7 +178,7 @@ describe("Fish shell integration", () => {
assert.ok(content.includes('alias yarn "aikido-yarn"'));
// Teardown
fish.teardown();
fish.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("alias npm "));
assert.ok(!content.includes("alias yarn "));
@ -187,11 +188,12 @@ describe("Fish shell integration", () => {
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
fish.setup(tools);
fish.teardown(tools);
fish.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/alias npm "/g) || []).length;
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases");
});
});
});
});

32
src/shell-integration/supported-shells/powershell.js
View file

@ -1,9 +1,9 @@
import {
addLineToFile,
doesExecutableExistOnSystem,
execAndGetOutput,
removeLinesMatchingPattern,
} from "../helpers.js";
import { execSync } from "child_process";
const shellName = "PowerShell Core";
const executableName = "pwsh";
@ -13,19 +13,22 @@ function isInstalled() {
return doesExecutableExistOnSystem(executableName);
}
function teardown() {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
function teardown(tools) {
const startupFile = getStartupFile();
// Removes all aliases starting with "Set-Alias npm=", "Set-Alias npx=", or "Set-Alias yarn="
// This will remove the safe-chain aliases for npm, npx, and yarn commands.
removeLinesMatchingPattern(startupFile, /^Set-Alias\s+(npm|npx|yarn)\s+/);
for (const { tool } of tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(
startupFile,
new RegExp(`^Set-Alias\\s+${tool}\\s+`)
);
}
return true;
}
function setup(tools) {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
teardown();
const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) {
addLineToFile(
@ -37,6 +40,19 @@ function setup(tools) {
return true;
}
function getStartupFile() {
try {
return execSync(startupFileCommand, {
encoding: "utf8",
shell: executableName,
}).trim();
} catch (error) {
throw new Error(
`Command failed: ${startupFileCommand}. Error: ${error.message}`
);
}
}
export default {
name: shellName,
isInstalled,

77
src/shell-integration/supported-shells/powershell.spec.js
View file

@ -3,6 +3,7 @@ import assert from "node:assert";
import { tmpdir } from "node:os";
import fs from "node:fs";
import path from "path";
import { knownAikidoTools } from "../helpers.js";
describe("PowerShell Core shell integration", () => {
let mockStartupFile;
@ -10,12 +11,14 @@ describe("PowerShell Core shell integration", () => {
beforeEach(async () => {
// Create temporary startup file for testing
mockStartupFile = path.join(tmpdir(), `test-powershell-profile-${Date.now()}.ps1`);
mockStartupFile = path.join(
tmpdir(),
`test-powershell-profile-${Date.now()}.ps1`
);
// Mock the helpers module
mock.module("../helpers.js", {
namedExports: {
execAndGetOutput: () => mockStartupFile,
doesExecutableExistOnSystem: () => true,
addLineToFile: (filePath, line) => {
if (!fs.existsSync(filePath)) {
@ -27,10 +30,17 @@ describe("PowerShell Core shell integration", () => {
if (!fs.existsSync(filePath)) return;
const content = fs.readFileSync(filePath, "utf-8");
const lines = content.split("\n");
const filteredLines = lines.filter(line => !pattern.test(line));
const filteredLines = lines.filter((line) => !pattern.test(line));
fs.writeFileSync(filePath, filteredLines.join("\n"), "utf-8");
}
}
},
},
});
// Mock child_process execSync
mock.module("child_process", {
namedExports: {
execSync: () => mockStartupFile,
},
});
// Import powershell module after mocking
@ -42,7 +52,7 @@ describe("PowerShell Core shell integration", () => {
if (fs.existsSync(mockStartupFile)) {
fs.unlinkSync(mockStartupFile);
}
// Reset mocks
mock.reset();
});
@ -63,34 +73,30 @@ describe("PowerShell Core shell integration", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = powershell.setup(tools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('Set-Alias npm aikido-npm # Safe-chain alias for npm'));
assert.ok(content.includes('Set-Alias npx aikido-npx # Safe-chain alias for npx'));
assert.ok(content.includes('Set-Alias yarn aikido-yarn # Safe-chain alias for yarn'));
});
it("should call teardown before setup", () => {
// Pre-populate file with existing aliases
fs.writeFileSync(mockStartupFile, 'Set-Alias npm old-npm\nSet-Alias npx old-npx\n', "utf-8");
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
powershell.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes('Set-Alias npm old-npm'));
assert.ok(content.includes('Set-Alias npm aikido-npm'));
assert.ok(
content.includes("Set-Alias npm aikido-npm # Safe-chain alias for npm")
);
assert.ok(
content.includes("Set-Alias npx aikido-npx # Safe-chain alias for npx")
);
assert.ok(
content.includes(
"Set-Alias yarn aikido-yarn # Safe-chain alias for yarn"
)
);
});
it("should handle empty tools array", () => {
const result = powershell.setup([]);
assert.strictEqual(result, true);
// File should be created during teardown call even if no tools are provided
if (fs.existsSync(mockStartupFile)) {
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -107,12 +113,12 @@ describe("PowerShell Core shell integration", () => {
"Set-Alias npx aikido-npx",
"Set-Alias yarn aikido-yarn",
"Set-Alias ls Get-ChildItem",
"Set-Alias grep Select-String"
"Set-Alias grep Select-String",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = powershell.teardown();
const result = powershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -128,7 +134,7 @@ describe("PowerShell Core shell integration", () => {
fs.unlinkSync(mockStartupFile);
}
const result = powershell.teardown();
const result = powershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
});
@ -136,12 +142,12 @@ describe("PowerShell Core shell integration", () => {
const initialContent = [
"# PowerShell profile",
"Set-Alias ls Get-ChildItem",
"$env:PATH += ';C:\\Tools'"
"$env:PATH += ';C:\\Tools'",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = powershell.teardown();
const result = powershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -167,17 +173,17 @@ describe("PowerShell Core shell integration", () => {
it("should handle complete setup and teardown cycle", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
// Setup
powershell.setup(tools);
let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('Set-Alias npm aikido-npm'));
assert.ok(content.includes('Set-Alias yarn aikido-yarn'));
assert.ok(content.includes("Set-Alias npm aikido-npm"));
assert.ok(content.includes("Set-Alias yarn aikido-yarn"));
// Teardown
powershell.teardown();
powershell.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("Set-Alias npm "));
assert.ok(!content.includes("Set-Alias yarn "));
@ -187,11 +193,12 @@ describe("PowerShell Core shell integration", () => {
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
powershell.setup(tools);
powershell.teardown(tools);
powershell.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/Set-Alias npm /g) || []).length;
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases");
});
});
});
});

32
src/shell-integration/supported-shells/windowsPowershell.js
View file

@ -1,9 +1,9 @@
import {
addLineToFile,
doesExecutableExistOnSystem,
execAndGetOutput,
removeLinesMatchingPattern,
} from "../helpers.js";
import { execSync } from "child_process";
const shellName = "Windows PowerShell";
const executableName = "powershell";
@ -13,19 +13,22 @@ function isInstalled() {
return doesExecutableExistOnSystem(executableName);
}
function teardown() {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
function teardown(tools) {
const startupFile = getStartupFile();
// Removes all aliases starting with "Set-Alias npm=", "Set-Alias npx=", or "Set-Alias yarn="
// This will remove the safe-chain aliases for npm, npx, and yarn commands.
removeLinesMatchingPattern(startupFile, /^Set-Alias\s+(npm|npx|yarn)\s+/);
for (const { tool } of tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(
startupFile,
new RegExp(`^Set-Alias\\s+${tool}\\s+`)
);
}
return true;
}
function setup(tools) {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
teardown();
const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) {
addLineToFile(
@ -37,6 +40,19 @@ function setup(tools) {
return true;
}
function getStartupFile() {
try {
return execSync(startupFileCommand, {
encoding: "utf8",
shell: executableName,
}).trim();
} catch (error) {
throw new Error(
`Command failed: ${startupFileCommand}. Error: ${error.message}`
);
}
}
export default {
name: shellName,
isInstalled,

77
src/shell-integration/supported-shells/windowsPowershell.spec.js
View file

@ -3,6 +3,7 @@ import assert from "node:assert";
import { tmpdir } from "node:os";
import fs from "node:fs";
import path from "path";
import { knownAikidoTools } from "../helpers.js";
describe("Windows PowerShell shell integration", () => {
let mockStartupFile;
@ -10,12 +11,14 @@ describe("Windows PowerShell shell integration", () => {
beforeEach(async () => {
// Create temporary startup file for testing
mockStartupFile = path.join(tmpdir(), `test-windows-powershell-profile-${Date.now()}.ps1`);
mockStartupFile = path.join(
tmpdir(),
`test-windows-powershell-profile-${Date.now()}.ps1`
);
// Mock the helpers module
mock.module("../helpers.js", {
namedExports: {
execAndGetOutput: () => mockStartupFile,
doesExecutableExistOnSystem: () => true,
addLineToFile: (filePath, line) => {
if (!fs.existsSync(filePath)) {
@ -27,10 +30,17 @@ describe("Windows PowerShell shell integration", () => {
if (!fs.existsSync(filePath)) return;
const content = fs.readFileSync(filePath, "utf-8");
const lines = content.split("\n");
const filteredLines = lines.filter(line => !pattern.test(line));
const filteredLines = lines.filter((line) => !pattern.test(line));
fs.writeFileSync(filePath, filteredLines.join("\n"), "utf-8");
}
}
},
},
});
// Mock child_process execSync
mock.module("child_process", {
namedExports: {
execSync: () => mockStartupFile,
},
});
// Import windowsPowershell module after mocking
@ -42,7 +52,7 @@ describe("Windows PowerShell shell integration", () => {
if (fs.existsSync(mockStartupFile)) {
fs.unlinkSync(mockStartupFile);
}
// Reset mocks
mock.reset();
});
@ -63,34 +73,30 @@ describe("Windows PowerShell shell integration", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = windowsPowershell.setup(tools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('Set-Alias npm aikido-npm # Safe-chain alias for npm'));
assert.ok(content.includes('Set-Alias npx aikido-npx # Safe-chain alias for npx'));
assert.ok(content.includes('Set-Alias yarn aikido-yarn # Safe-chain alias for yarn'));
});
it("should call teardown before setup", () => {
// Pre-populate file with existing aliases
fs.writeFileSync(mockStartupFile, 'Set-Alias npm old-npm\nSet-Alias npx old-npx\n', "utf-8");
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
windowsPowershell.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes('Set-Alias npm old-npm'));
assert.ok(content.includes('Set-Alias npm aikido-npm'));
assert.ok(
content.includes("Set-Alias npm aikido-npm # Safe-chain alias for npm")
);
assert.ok(
content.includes("Set-Alias npx aikido-npx # Safe-chain alias for npx")
);
assert.ok(
content.includes(
"Set-Alias yarn aikido-yarn # Safe-chain alias for yarn"
)
);
});
it("should handle empty tools array", () => {
const result = windowsPowershell.setup([]);
assert.strictEqual(result, true);
// File should be created during teardown call even if no tools are provided
if (fs.existsSync(mockStartupFile)) {
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -107,12 +113,12 @@ describe("Windows PowerShell shell integration", () => {
"Set-Alias npx aikido-npx",
"Set-Alias yarn aikido-yarn",
"Set-Alias ls Get-ChildItem",
"Set-Alias grep Select-String"
"Set-Alias grep Select-String",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = windowsPowershell.teardown();
const result = windowsPowershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -128,7 +134,7 @@ describe("Windows PowerShell shell integration", () => {
fs.unlinkSync(mockStartupFile);
}
const result = windowsPowershell.teardown();
const result = windowsPowershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
});
@ -136,12 +142,12 @@ describe("Windows PowerShell shell integration", () => {
const initialContent = [
"# Windows PowerShell profile",
"Set-Alias ls Get-ChildItem",
"$env:PATH += ';C:\\Tools'"
"$env:PATH += ';C:\\Tools'",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = windowsPowershell.teardown();
const result = windowsPowershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -167,17 +173,17 @@ describe("Windows PowerShell shell integration", () => {
it("should handle complete setup and teardown cycle", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" }
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
// Setup
windowsPowershell.setup(tools);
let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('Set-Alias npm aikido-npm'));
assert.ok(content.includes('Set-Alias yarn aikido-yarn'));
assert.ok(content.includes("Set-Alias npm aikido-npm"));
assert.ok(content.includes("Set-Alias yarn aikido-yarn"));
// Teardown
windowsPowershell.teardown();
windowsPowershell.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("Set-Alias npm "));
assert.ok(!content.includes("Set-Alias yarn "));
@ -187,11 +193,12 @@ describe("Windows PowerShell shell integration", () => {
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
windowsPowershell.setup(tools);
windowsPowershell.teardown(tools);
windowsPowershell.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/Set-Alias npm /g) || []).length;
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases");
});
});
});
});

31
src/shell-integration/supported-shells/zsh.js
View file

@ -1,9 +1,9 @@
import {
addLineToFile,
doesExecutableExistOnSystem,
execAndGetOutput,
removeLinesMatchingPattern,
} from "../helpers.js";
import { execSync } from "child_process";
const shellName = "Zsh";
const executableName = "zsh";
@ -13,12 +13,13 @@ function isInstalled() {
return doesExecutableExistOnSystem(executableName);
}
function teardown() {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
function teardown(tools) {
const startupFile = getStartupFile();
// Removes all aliases starting with "alias npm=", "alias npx=", or "alias yarn="
// This will remove the safe-chain aliases for npm, npx, and yarn commands.
removeLinesMatchingPattern(startupFile, /^alias\s+(npm|npx|yarn)=/);
for (const { tool } of tools) {
// Remove any existing alias for the tool
removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`));
}
// Removes the line that sources the safe-chain zsh initialization script (~/.aikido/scripts/init-zsh.sh)
removeLinesMatchingPattern(
@ -29,9 +30,8 @@ function teardown() {
return true;
}
function setup() {
const startupFile = execAndGetOutput(startupFileCommand, executableName);
teardown();
function setup(tools) {
const startupFile = getStartupFile();
addLineToFile(
startupFile,
@ -41,6 +41,19 @@ function setup() {
return true;
}
function getStartupFile() {
try {
return execSync(startupFileCommand, {
encoding: "utf8",
shell: executableName,
}).trim();
} catch (error) {
throw new Error(
`Command failed: ${startupFileCommand}. Error: ${error.message}`
);
}
}
export default {
name: shellName,
isInstalled,

45
src/shell-integration/supported-shells/zsh.spec.js
View file

@ -3,6 +3,7 @@ import assert from "node:assert";
import { tmpdir } from "node:os";
import fs from "node:fs";
import path from "path";
import { knownAikidoTools } from "../helpers.js";
describe("Zsh shell integration", () => {
let mockStartupFile;
@ -15,7 +16,6 @@ describe("Zsh shell integration", () => {
// Mock the helpers module
mock.module("../helpers.js", {
namedExports: {
execAndGetOutput: () => mockStartupFile,
doesExecutableExistOnSystem: () => true,
addLineToFile: (filePath, line) => {
if (!fs.existsSync(filePath)) {
@ -33,6 +33,13 @@ describe("Zsh shell integration", () => {
},
});
// Mock child_process execSync
mock.module("child_process", {
namedExports: {
execSync: () => mockStartupFile,
},
});
// Import zsh module after mocking
zsh = (await import("./zsh.js")).default;
});
@ -71,22 +78,6 @@ describe("Zsh shell integration", () => {
);
});
it("should call teardown before setup", () => {
// Pre-populate file with existing source line
fs.writeFileSync(
mockStartupFile,
"source ~/.safe-chain/scripts/init-zsh.sh\n",
"utf-8"
);
zsh.setup();
const content = fs.readFileSync(mockStartupFile, "utf-8");
const sourceMatches = (content.match(/source.*init-zsh\.sh/g) || [])
.length;
assert.strictEqual(sourceMatches, 1, "Should not duplicate source lines");
});
it("should handle empty startup file", () => {
const result = zsh.setup();
assert.strictEqual(result, true);
@ -109,7 +100,7 @@ describe("Zsh shell integration", () => {
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = zsh.teardown();
const result = zsh.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -142,7 +133,7 @@ describe("Zsh shell integration", () => {
fs.unlinkSync(mockStartupFile);
}
const result = zsh.teardown();
const result = zsh.teardown(knownAikidoTools);
assert.strictEqual(result, true);
});
@ -155,7 +146,7 @@ describe("Zsh shell integration", () => {
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = zsh.teardown();
const result = zsh.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
@ -179,20 +170,28 @@ describe("Zsh shell integration", () => {
describe("integration tests", () => {
it("should handle complete setup and teardown cycle", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
// Setup
zsh.setup();
let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes("source ~/.safe-chain/scripts/init-zsh.sh"));
// Teardown
zsh.teardown();
zsh.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("source ~/.safe-chain/scripts/init-zsh.sh"));
});
it("should handle multiple setup calls", () => {
zsh.setup();
zsh.setup();
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }];
zsh.setup(tools);
zsh.teardown(tools);
zsh.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
const sourceMatches = (content.match(/source.*init-zsh\.sh/g) || [])

3
src/shell-integration/teardown.js
View file

@ -1,6 +1,7 @@
import chalk from "chalk";
import { ui } from "../environment/userInteraction.js";
import { detectShells } from "./shellDetection.js";
import { knownAikidoTools } from "./helpers.js";
export async function teardown() {
ui.writeInformation(
@ -26,7 +27,7 @@ export async function teardown() {
for (const shell of shells) {
let success = false;
try {
success = shell.teardown();
success = shell.teardown(knownAikidoTools);
} catch {
success = false;
}