Merge pull request #3 from AikidoSec/zsh-safe-chain-detection

Zsh and bash: Use functions to wrap package managers and detect if the aikido commands are available
This commit is contained in:
Sander Declerck 2025-08-04 10:27:49 +02:00 committed by GitHub
commit d9942854f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 472 additions and 232 deletions

View file

@ -2,6 +2,10 @@ import chalk from "chalk";
import { ui } from "../environment/userInteraction.js"; import { ui } from "../environment/userInteraction.js";
import { detectShells } from "./shellDetection.js"; import { detectShells } from "./shellDetection.js";
import { knownAikidoTools } from "./helpers.js"; import { knownAikidoTools } from "./helpers.js";
import fs from "fs";
import os from "os";
import path from "path";
import { fileURLToPath } from "url";
/** /**
* Loops over the detected shells and calls the setup function for each. * Loops over the detected shells and calls the setup function for each.
@ -13,6 +17,8 @@ export async function setup() {
); );
ui.emptyLine(); ui.emptyLine();
copyStartupFiles();
try { try {
const shells = detectShells(); const shells = detectShells();
if (shells.length === 0) { if (shells.length === 0) {
@ -73,3 +79,22 @@ function setupShell(shell) {
return success; return success;
} }
function copyStartupFiles() {
const startupFiles = ["init-posix.sh", "init-pwsh.ps1", "init-fish.fish"];
for (const file of startupFiles) {
const targetDir = path.join(os.homedir(), ".safe-chain", "scripts");
const targetPath = path.join(os.homedir(), ".safe-chain", "scripts", file);
if (!fs.existsSync(targetDir)) {
fs.mkdirSync(targetDir, { recursive: true });
}
// Use absolute path for source
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const sourcePath = path.resolve(__dirname, "startup-scripts", file);
fs.copyFileSync(sourcePath, targetPath);
}
}

View file

@ -0,0 +1,58 @@
function printSafeChainWarning
set original_cmd $argv[1]
# Fish equivalent of ANSI color codes: yellow background, black text for "Warning:"
set_color -b yellow black
printf "Warning:"
set_color normal
printf " safe-chain is not available to protect you from installing malware. %s will run without it.\n" $original_cmd
# Cyan text for the install command
printf "Install safe-chain by using "
set_color cyan
printf "npm install -g @aikidosec/safe-chain"
set_color normal
printf ".\n"
end
function wrapSafeChainCommand
set original_cmd $argv[1]
set aikido_cmd $argv[2]
set cmd_args $argv[3..-1]
if type -q $aikido_cmd
# If the aikido command is available, just run it with the provided arguments
$aikido_cmd $cmd_args
else
# If the aikido command is not available, print a warning and run the original command
printSafeChainWarning $original_cmd
command $original_cmd $cmd_args
end
end
function npx
wrapSafeChainCommand "npx" "aikido-npx" $argv
end
function yarn
wrapSafeChainCommand "yarn" "aikido-yarn" $argv
end
function pnpm
wrapSafeChainCommand "pnpm" "aikido-pnpm" $argv
end
function pnpx
wrapSafeChainCommand "pnpx" "aikido-pnpx" $argv
end
function npm
if test (count $argv) -eq 1 -a \( "$argv[1]" = "-v" -o "$argv[1]" = "--version" \)
# If args is just -v or --version and nothing else, just run the npm version command
# This is because nvm uses this to check the version of npm
command npm $argv
return
end
wrapSafeChainCommand "npm" "aikido-npm" $argv
end

View file

@ -0,0 +1,54 @@
function printSafeChainWarning() {
# \033[43;30m is used to set the background color to yellow and text color to black
# \033[0m is used to reset the text formatting
printf "\033[43;30mWarning:\033[0m safe-chain is not available to protect you from installing malware. %s will run without it.\n" "$1"
# \033[36m is used to set the text color to cyan
printf "Install safe-chain by using \033[36mnpm install -g @aikidosec/safe-chain\033[0m.\n"
}
function wrapSafeChainCommand() {
local original_cmd="$1"
local aikido_cmd="$2"
# Remove the first 2 arguments (original_cmd and aikido_cmd) from $@
# so that "$@" now contains only the arguments passed to the original command
shift 2
if command -v "$aikido_cmd" > /dev/null 2>&1; then
# If the aikido command is available, just run it with the provided arguments
"$aikido_cmd" "$@"
else
# If the aikido command is not available, print a warning and run the original command
printSafeChainWarning "$original_cmd"
command "$original_cmd" "$@"
fi
}
function npx() {
wrapSafeChainCommand "npx" "aikido-npx" "$@"
}
function yarn() {
wrapSafeChainCommand "yarn" "aikido-yarn" "$@"
}
function pnpm() {
wrapSafeChainCommand "pnpm" "aikido-pnpm" "$@"
}
function pnpx() {
wrapSafeChainCommand "pnpx" "aikido-pnpx" "$@"
}
function npm() {
if [[ "$1" == "-v" || "$1" == "--version" ]] && [[ $# -eq 1 ]]; then
# If args is just -v or --version and nothing else, just run the npm version command
# This is because nvm uses this to check the version of npm
command npm "$@"
return
fi
wrapSafeChainCommand "npm" "aikido-npm" "$@"
}

View file

@ -0,0 +1,80 @@
function Write-SafeChainWarning {
param([string]$Command)
# PowerShell equivalent of ANSI color codes: yellow background, black text for "Warning:"
Write-Host "Warning:" -BackgroundColor Yellow -ForegroundColor Black -NoNewline
Write-Host " safe-chain is not available to protect you from installing malware. $Command will run without it."
# Cyan text for the install command
Write-Host "Install safe-chain by using " -NoNewline
Write-Host "npm install -g @aikidosec/safe-chain" -ForegroundColor Cyan -NoNewline
Write-Host "."
}
function Test-CommandAvailable {
param([string]$Command)
try {
Get-Command $Command -ErrorAction Stop | Out-Null
return $true
}
catch {
return $false
}
}
function Invoke-RealCommand {
param(
[string]$Command,
[string[]]$Arguments
)
# Find the real executable to avoid calling our wrapped functions
$realCommand = Get-Command -Name $Command -CommandType Application | Select-Object -First 1
if ($realCommand) {
& $realCommand.Source @Arguments
}
}
function Invoke-WrappedCommand {
param(
[string]$OriginalCmd,
[string]$AikidoCmd,
[string[]]$Arguments
)
if (Test-CommandAvailable $AikidoCmd) {
& $AikidoCmd @Arguments
}
else {
Write-SafeChainWarning $OriginalCmd
Invoke-RealCommand $OriginalCmd $Arguments
}
}
function npx {
Invoke-WrappedCommand "npx" "aikido-npx" $args
}
function yarn {
Invoke-WrappedCommand "yarn" "aikido-yarn" $args
}
function pnpm {
Invoke-WrappedCommand "pnpm" "aikido-pnpm" $args
}
function pnpx {
Invoke-WrappedCommand "pnpx" "aikido-pnpx" $args
}
function npm {
# If args is just -v or --version and nothing else, just run the npm version command
# This is because nvm uses this to check the version of npm
if (($args.Length -eq 1) -and (($args[0] -eq "-v") -or ($args[0] -eq "--version"))) {
Invoke-RealCommand "npm" $args
return
}
Invoke-WrappedCommand "npm" "aikido-npm" $args
}

View file

@ -21,18 +21,22 @@ function teardown(tools) {
removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`)); removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`));
} }
// Removes the line that sources the safe-chain bash initialization script (~/.aikido/scripts/init-posix.sh)
removeLinesMatchingPattern(
startupFile,
/^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/
);
return true; return true;
} }
function setup(tools) { function setup() {
const startupFile = getStartupFile(); const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) { addLineToFile(
addLineToFile( startupFile,
startupFile, `source ~/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script`
`alias ${tool}="${aikidoCommand}" # Safe-chain alias for ${tool}` );
);
}
return true; return true;
} }

View file

@ -66,37 +66,16 @@ describe("Bash shell integration", () => {
}); });
describe("setup", () => { describe("setup", () => {
it("should add aliases for all provided tools", () => { it("should add source line for bash initialization script", () => {
const tools = [ const result = bash.setup();
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = bash.setup(tools);
assert.strictEqual(result, true); assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok( assert.ok(
content.includes('alias npm="aikido-npm" # Safe-chain alias for npm') content.includes(
"source ~/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script"
)
); );
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 = bash.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");
assert.strictEqual(content.trim(), "");
}
}); });
}); });
@ -174,14 +153,14 @@ describe("Bash shell integration", () => {
// Setup // Setup
bash.setup(tools); bash.setup(tools);
let content = fs.readFileSync(mockStartupFile, "utf-8"); let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('alias npm="aikido-npm"')); assert.ok(content.includes("source ~/.safe-chain/scripts/init-posix.sh"));
assert.ok(content.includes('alias yarn="aikido-yarn"'));
// Teardown // Teardown
bash.teardown(tools); bash.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8"); content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("alias npm=")); assert.ok(
assert.ok(!content.includes("alias yarn=")); !content.includes("source ~/.safe-chain/scripts/init-posix.sh")
);
}); });
it("should handle multiple setup calls", () => { it("should handle multiple setup calls", () => {
@ -192,8 +171,29 @@ describe("Bash shell integration", () => {
bash.setup(tools); bash.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/alias npm="/g) || []).length; const sourceMatches = (content.match(/source.*init-posix\.sh/g) || [])
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases"); .length;
assert.strictEqual(sourceMatches, 1, "Should not duplicate source lines");
});
it("should handle mixed content with aliases and source lines", () => {
const initialContent = [
"#!/bin/bash",
"alias npm='old-npm'",
"source ~/.safe-chain/scripts/init-posix.sh",
"alias ls='ls --color=auto'",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
// Teardown should remove both aliases and source line
bash.teardown(knownAikidoTools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("alias npm="));
assert.ok(
!content.includes("source ~/.safe-chain/scripts/init-posix.sh")
);
assert.ok(content.includes("alias ls="));
}); });
}); });
}); });

View file

@ -24,18 +24,22 @@ function teardown(tools) {
); );
} }
// Removes the line that sources the safe-chain fish initialization script (~/.safe-chain/scripts/init-fish.fish)
removeLinesMatchingPattern(
startupFile,
/^source\s+~\/\.safe-chain\/scripts\/init-fish\.fish/
);
return true; return true;
} }
function setup(tools) { function setup() {
const startupFile = getStartupFile(); const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) { addLineToFile(
addLineToFile( startupFile,
startupFile, `source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script`
`alias ${tool} "${aikidoCommand}" # Safe-chain alias for ${tool}` );
);
}
return true; return true;
} }

View file

@ -66,47 +66,34 @@ describe("Fish shell integration", () => {
}); });
describe("setup", () => { describe("setup", () => {
it("should add aliases for all provided tools", () => { it("should add source line for safe-chain fish initialization script", () => {
const tools = [ const result = fish.setup();
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = fish.setup(tools);
assert.strictEqual(result, true); assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok( assert.ok(
content.includes('alias npm "aikido-npm" # Safe-chain alias for npm') content.includes('source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script')
);
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", () => { it("should not duplicate source lines on multiple calls", () => {
const result = fish.setup([]); fish.setup();
assert.strictEqual(result, true); fish.setup();
// File should be created during teardown call even if no tools are provided const content = fs.readFileSync(mockStartupFile, "utf-8");
if (fs.existsSync(mockStartupFile)) { const sourceMatches = (content.match(/source ~\/\.safe-chain\/scripts\/init-fish\.fish/g) || []).length;
const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.strictEqual(sourceMatches, 2, "Should allow multiple source lines (helper doesn't dedupe)");
assert.strictEqual(content.trim(), "");
}
}); });
}); });
describe("teardown", () => { describe("teardown", () => {
it("should remove npm, npx, and yarn aliases", () => { it("should remove npm, npx, yarn aliases and source line", () => {
const initialContent = [ const initialContent = [
"#!/usr/bin/env fish", "#!/usr/bin/env fish",
"alias npm 'aikido-npm'", "alias npm 'aikido-npm'",
"alias npx 'aikido-npx'", "alias npx 'aikido-npx'",
"alias yarn 'aikido-yarn'", "alias yarn 'aikido-yarn'",
"source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script",
"alias ls 'ls --color=auto'", "alias ls 'ls --color=auto'",
"alias grep 'grep --color=auto'", "alias grep 'grep --color=auto'",
].join("\n"); ].join("\n");
@ -120,6 +107,7 @@ describe("Fish shell integration", () => {
assert.ok(!content.includes("alias npm ")); assert.ok(!content.includes("alias npm "));
assert.ok(!content.includes("alias npx ")); assert.ok(!content.includes("alias npx "));
assert.ok(!content.includes("alias yarn ")); assert.ok(!content.includes("alias yarn "));
assert.ok(!content.includes("source ~/.safe-chain/scripts/init-fish.fish"));
assert.ok(content.includes("alias ls ")); assert.ok(content.includes("alias ls "));
assert.ok(content.includes("alias grep ")); assert.ok(content.includes("alias grep "));
}); });
@ -133,7 +121,7 @@ describe("Fish shell integration", () => {
assert.strictEqual(result, true); assert.strictEqual(result, true);
}); });
it("should handle file with no relevant aliases", () => { it("should handle file with no relevant aliases or source lines", () => {
const initialContent = [ const initialContent = [
"#!/usr/bin/env fish", "#!/usr/bin/env fish",
"alias ls 'ls --color=auto'", "alias ls 'ls --color=auto'",
@ -172,28 +160,24 @@ describe("Fish shell integration", () => {
]; ];
// Setup // Setup
fish.setup(tools); fish.setup();
let content = fs.readFileSync(mockStartupFile, "utf-8"); let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('alias npm "aikido-npm"')); assert.ok(content.includes('source ~/.safe-chain/scripts/init-fish.fish'));
assert.ok(content.includes('alias yarn "aikido-yarn"'));
// Teardown // Teardown
fish.teardown(tools); fish.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8"); content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("alias npm ")); assert.ok(!content.includes("source ~/.safe-chain/scripts/init-fish.fish"));
assert.ok(!content.includes("alias yarn "));
}); });
it("should handle multiple setup calls", () => { it("should handle multiple setup calls", () => {
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }]; fish.setup();
fish.teardown(knownAikidoTools);
fish.setup(tools); fish.setup();
fish.teardown(tools);
fish.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/alias npm "/g) || []).length; const sourceMatches = (content.match(/source ~\/\.safe-chain\/scripts\/init-fish\.fish/g) || []).length;
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases"); assert.strictEqual(sourceMatches, 1, "Should have exactly one source line after setup-teardown-setup cycle");
}); });
}); });
}); });

View file

@ -24,18 +24,22 @@ function teardown(tools) {
); );
} }
// Remove the line that sources the safe-chain PowerShell initialization script
removeLinesMatchingPattern(
startupFile,
/^\.\s+["']?\$HOME[/\\].safe-chain[/\\]scripts[/\\]init-pwsh\.ps1["']?/
);
return true; return true;
} }
function setup(tools) { function setup() {
const startupFile = getStartupFile(); const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) { addLineToFile(
addLineToFile( startupFile,
startupFile, `. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script`
`Set-Alias ${tool} ${aikidoCommand} # Safe-chain alias for ${tool}` );
);
}
return true; return true;
} }

View file

@ -69,49 +69,47 @@ describe("PowerShell Core shell integration", () => {
}); });
describe("setup", () => { describe("setup", () => {
it("should add aliases for all provided tools", () => { it("should add init-pwsh.ps1 source line", () => {
const tools = [ const result = powershell.setup();
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = powershell.setup(tools);
assert.strictEqual(result, true); assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8"); 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( assert.ok(
content.includes( content.includes(
"Set-Alias yarn aikido-yarn # Safe-chain alias for yarn" '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script'
) )
); );
}); });
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");
assert.strictEqual(content.trim(), "");
}
});
}); });
describe("teardown", () => { describe("teardown", () => {
it("should remove npm, npx, and yarn aliases", () => { it("should remove init-pwsh.ps1 source line", () => {
const initialContent = [ const initialContent = [
"# PowerShell profile", "# PowerShell profile",
"Set-Alias npm aikido-npm", '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script',
"Set-Alias npx aikido-npx", "Set-Alias ls Get-ChildItem",
"Set-Alias yarn aikido-yarn", "Set-Alias grep Select-String",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = powershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(
!content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"')
);
assert.ok(content.includes("Set-Alias ls "));
assert.ok(content.includes("Set-Alias grep "));
});
it("should remove old-style aliases from earlier versions", () => {
const initialContent = [
"# PowerShell profile",
"Set-Alias npm aikido-npm # Safe-chain alias for npm",
"Set-Alias npx aikido-npx # Safe-chain alias for npx",
"Set-Alias yarn aikido-yarn # Safe-chain alias for yarn",
"Set-Alias ls Get-ChildItem", "Set-Alias ls Get-ChildItem",
"Set-Alias grep Select-String", "Set-Alias grep Select-String",
].join("\n"); ].join("\n");
@ -138,7 +136,7 @@ describe("PowerShell Core shell integration", () => {
assert.strictEqual(result, true); assert.strictEqual(result, true);
}); });
it("should handle file with no relevant aliases", () => { it("should handle file with no relevant content", () => {
const initialContent = [ const initialContent = [
"# PowerShell profile", "# PowerShell profile",
"Set-Alias ls Get-ChildItem", "Set-Alias ls Get-ChildItem",
@ -171,34 +169,32 @@ describe("PowerShell Core shell integration", () => {
describe("integration tests", () => { describe("integration tests", () => {
it("should handle complete setup and teardown cycle", () => { it("should handle complete setup and teardown cycle", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
// Setup // Setup
powershell.setup(tools); powershell.setup();
let content = fs.readFileSync(mockStartupFile, "utf-8"); let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes("Set-Alias npm aikido-npm")); assert.ok(
assert.ok(content.includes("Set-Alias yarn aikido-yarn")); content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"')
);
// Teardown // Teardown
powershell.teardown(tools); powershell.teardown(knownAikidoTools);
content = fs.readFileSync(mockStartupFile, "utf-8"); content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("Set-Alias npm ")); assert.ok(
assert.ok(!content.includes("Set-Alias yarn ")); !content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"')
);
}); });
it("should handle multiple setup calls", () => { it("should handle multiple setup calls", () => {
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }]; powershell.setup();
powershell.teardown(knownAikidoTools);
powershell.setup(tools); powershell.setup();
powershell.teardown(tools);
powershell.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/Set-Alias npm /g) || []).length; const sourceMatches = (
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases"); content.match(/\. "\$HOME\\.safe-chain\\scripts\\init-pwsh\.ps1"/g) ||
[]
).length;
assert.strictEqual(sourceMatches, 1, "Should not duplicate source lines");
}); });
}); });
}); });

View file

@ -24,18 +24,22 @@ function teardown(tools) {
); );
} }
// Remove the line that sources the safe-chain PowerShell initialization script
removeLinesMatchingPattern(
startupFile,
/^\.\s+["']?\$HOME[/\\].safe-chain[/\\]scripts[/\\]init-pwsh\.ps1["']?/
);
return true; return true;
} }
function setup(tools) { function setup() {
const startupFile = getStartupFile(); const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) { addLineToFile(
addLineToFile( startupFile,
startupFile, `. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script`
`Set-Alias ${tool} ${aikidoCommand} # Safe-chain alias for ${tool}` );
);
}
return true; return true;
} }

View file

@ -69,49 +69,47 @@ describe("Windows PowerShell shell integration", () => {
}); });
describe("setup", () => { describe("setup", () => {
it("should add aliases for all provided tools", () => { it("should add init-pwsh.ps1 source line", () => {
const tools = [ const result = windowsPowershell.setup();
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = windowsPowershell.setup(tools);
assert.strictEqual(result, true); assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8"); 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( assert.ok(
content.includes( content.includes(
"Set-Alias yarn aikido-yarn # Safe-chain alias for yarn" '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script'
) )
); );
}); });
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");
assert.strictEqual(content.trim(), "");
}
});
}); });
describe("teardown", () => { describe("teardown", () => {
it("should remove npm, npx, and yarn aliases", () => { it("should remove init-pwsh.ps1 source line", () => {
const initialContent = [ const initialContent = [
"# Windows PowerShell profile", "# Windows PowerShell profile",
"Set-Alias npm aikido-npm", '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script',
"Set-Alias npx aikido-npx", "Set-Alias ls Get-ChildItem",
"Set-Alias yarn aikido-yarn", "Set-Alias grep Select-String",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = windowsPowershell.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(
!content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"')
);
assert.ok(content.includes("Set-Alias ls "));
assert.ok(content.includes("Set-Alias grep "));
});
it("should remove old-style aliases from earlier versions", () => {
const initialContent = [
"# Windows PowerShell profile",
"Set-Alias npm aikido-npm # Safe-chain alias for npm",
"Set-Alias npx aikido-npx # Safe-chain alias for npx",
"Set-Alias yarn aikido-yarn # Safe-chain alias for yarn",
"Set-Alias ls Get-ChildItem", "Set-Alias ls Get-ChildItem",
"Set-Alias grep Select-String", "Set-Alias grep Select-String",
].join("\n"); ].join("\n");
@ -138,7 +136,7 @@ describe("Windows PowerShell shell integration", () => {
assert.strictEqual(result, true); assert.strictEqual(result, true);
}); });
it("should handle file with no relevant aliases", () => { it("should handle file with no relevant content", () => {
const initialContent = [ const initialContent = [
"# Windows PowerShell profile", "# Windows PowerShell profile",
"Set-Alias ls Get-ChildItem", "Set-Alias ls Get-ChildItem",
@ -171,34 +169,32 @@ describe("Windows PowerShell shell integration", () => {
describe("integration tests", () => { describe("integration tests", () => {
it("should handle complete setup and teardown cycle", () => { it("should handle complete setup and teardown cycle", () => {
const tools = [
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
// Setup // Setup
windowsPowershell.setup(tools); windowsPowershell.setup();
let content = fs.readFileSync(mockStartupFile, "utf-8"); let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes("Set-Alias npm aikido-npm")); assert.ok(
assert.ok(content.includes("Set-Alias yarn aikido-yarn")); content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"')
);
// Teardown // Teardown
windowsPowershell.teardown(tools); windowsPowershell.teardown(knownAikidoTools);
content = fs.readFileSync(mockStartupFile, "utf-8"); content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("Set-Alias npm ")); assert.ok(
assert.ok(!content.includes("Set-Alias yarn ")); !content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"')
);
}); });
it("should handle multiple setup calls", () => { it("should handle multiple setup calls", () => {
const tools = [{ tool: "npm", aikidoCommand: "aikido-npm" }]; windowsPowershell.setup();
windowsPowershell.teardown(knownAikidoTools);
windowsPowershell.setup(tools); windowsPowershell.setup();
windowsPowershell.teardown(tools);
windowsPowershell.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/Set-Alias npm /g) || []).length; const sourceMatches = (
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases"); content.match(/\. "\$HOME\\.safe-chain\\scripts\\init-pwsh\.ps1"/g) ||
[]
).length;
assert.strictEqual(sourceMatches, 1, "Should not duplicate source lines");
}); });
}); });
}); });

View file

@ -21,18 +21,22 @@ function teardown(tools) {
removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`)); removeLinesMatchingPattern(startupFile, new RegExp(`^alias\\s+${tool}=`));
} }
// Removes the line that sources the safe-chain zsh initialization script (~/.aikido/scripts/init-posix.sh)
removeLinesMatchingPattern(
startupFile,
/^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/
);
return true; return true;
} }
function setup(tools) { function setup() {
const startupFile = getStartupFile(); const startupFile = getStartupFile();
for (const { tool, aikidoCommand } of tools) { addLineToFile(
addLineToFile( startupFile,
startupFile, `source ~/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script`
`alias ${tool}="${aikidoCommand}" # Safe-chain alias for ${tool}` );
);
}
return true; return true;
} }

View file

@ -66,37 +66,24 @@ describe("Zsh shell integration", () => {
}); });
describe("setup", () => { describe("setup", () => {
it("should add aliases for all provided tools", () => { it("should add source line for zsh initialization script", () => {
const tools = [ const result = zsh.setup();
{ tool: "npm", aikidoCommand: "aikido-npm" },
{ tool: "npx", aikidoCommand: "aikido-npx" },
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
];
const result = zsh.setup(tools);
assert.strictEqual(result, true); assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok( assert.ok(
content.includes('alias npm="aikido-npm" # Safe-chain alias for npm') content.includes(
); "source ~/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script"
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", () => { it("should handle empty startup file", () => {
const result = zsh.setup([]); const result = zsh.setup();
assert.strictEqual(result, true); assert.strictEqual(result, true);
// File should be created during teardown call even if no tools are provided const content = fs.readFileSync(mockStartupFile, "utf-8");
if (fs.existsSync(mockStartupFile)) { assert.ok(content.includes("source ~/.safe-chain/scripts/init-posix.sh"));
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.strictEqual(content.trim(), "");
}
}); });
}); });
@ -124,6 +111,25 @@ describe("Zsh shell integration", () => {
assert.ok(content.includes("alias grep=")); assert.ok(content.includes("alias grep="));
}); });
it("should remove zsh initialization script source line", () => {
const initialContent = [
"#!/bin/zsh",
"source ~/.safe-chain/scripts/init-posix.sh",
"alias ls='ls --color=auto'",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
const result = zsh.teardown(knownAikidoTools);
assert.strictEqual(result, true);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(
!content.includes("source ~/.safe-chain/scripts/init-posix.sh")
);
assert.ok(content.includes("alias ls="));
});
it("should handle file that doesn't exist", () => { it("should handle file that doesn't exist", () => {
if (fs.existsSync(mockStartupFile)) { if (fs.existsSync(mockStartupFile)) {
fs.unlinkSync(mockStartupFile); fs.unlinkSync(mockStartupFile);
@ -133,7 +139,7 @@ describe("Zsh shell integration", () => {
assert.strictEqual(result, true); assert.strictEqual(result, true);
}); });
it("should handle file with no relevant aliases", () => { it("should handle file with no relevant aliases or source lines", () => {
const initialContent = [ const initialContent = [
"#!/bin/zsh", "#!/bin/zsh",
"alias ls='ls --color=auto'", "alias ls='ls --color=auto'",
@ -172,16 +178,16 @@ describe("Zsh shell integration", () => {
]; ];
// Setup // Setup
zsh.setup(tools); zsh.setup();
let content = fs.readFileSync(mockStartupFile, "utf-8"); let content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(content.includes('alias npm="aikido-npm"')); assert.ok(content.includes("source ~/.safe-chain/scripts/init-posix.sh"));
assert.ok(content.includes('alias yarn="aikido-yarn"'));
// Teardown // Teardown
zsh.teardown(tools); zsh.teardown(tools);
content = fs.readFileSync(mockStartupFile, "utf-8"); content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("alias npm=")); assert.ok(
assert.ok(!content.includes("alias yarn=")); !content.includes("source ~/.safe-chain/scripts/init-posix.sh")
);
}); });
it("should handle multiple setup calls", () => { it("should handle multiple setup calls", () => {
@ -192,8 +198,29 @@ describe("Zsh shell integration", () => {
zsh.setup(tools); zsh.setup(tools);
const content = fs.readFileSync(mockStartupFile, "utf-8"); const content = fs.readFileSync(mockStartupFile, "utf-8");
const npmMatches = (content.match(/alias npm="/g) || []).length; const sourceMatches = (content.match(/source.*init-posix\.sh/g) || [])
assert.strictEqual(npmMatches, 1, "Should not duplicate aliases"); .length;
assert.strictEqual(sourceMatches, 1, "Should not duplicate source lines");
});
it("should handle mixed content with aliases and source lines", () => {
const initialContent = [
"#!/bin/zsh",
"alias npm='old-npm'",
"source ~/.safe-chain/scripts/init-posix.sh",
"alias ls='ls --color=auto'",
].join("\n");
fs.writeFileSync(mockStartupFile, initialContent, "utf-8");
// Teardown should remove both aliases and source line
zsh.teardown(knownAikidoTools);
const content = fs.readFileSync(mockStartupFile, "utf-8");
assert.ok(!content.includes("alias npm="));
assert.ok(
!content.includes("source ~/.safe-chain/scripts/init-posix.sh")
);
assert.ok(content.includes("alias ls="));
}); });
}); });
}); });