Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

installShellFiles: ensure shell completion has more than 256 bytes #247099

Draft
wants to merge 2 commits into
base: staging
Choose a base branch
from
Draft

installShellFiles: ensure shell completion has more than 256 bytes #247099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
684bc07
installShellFiles: ensure shell completion has more than 256 bytes
otavio Jun 24, 2023
32c275a
terraform: override installShellCompletion check to allow 32 bytes
otavio Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkgs/applications/networking/cluster/terraform/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ let

postInstall = ''
# https://github.com/posener/complete/blob/9a4745ac49b29530e07dc2581745a218b646b7a3/cmd/install/bash.go#L8
installShellCompletion --bash --name terraform <(echo complete -C terraform terraform)
installShellCompletion --size-check 32 --bash --name terraform <(echo complete -C terraform terraform)
'';

preCheck = ''
Expand Down
19 changes: 18 additions & 1 deletion pkgs/build-support/setup-hooks/install-shell-files.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ installManPage() {
#
# If any argument is `--` the remaining arguments will be treated as paths.
installShellCompletion() {
local shell='' name='' cmdname='' retval=0 parseArgs=1 arg
local shell='' name='' cmdname='' size_check=256 retval=0 parseArgs=1 arg
while { arg=$1; shift; }; do
# Parse arguments
if (( parseArgs )); then
Expand All @@ -122,6 +122,17 @@ installShellCompletion() {
return 1
}
continue;;
--size-check)
size_check=$1
shift || {
echo 'installShellCompletion: error: --size-check flag expected an argument' >&2
return 1
}
continue;;
--size-check=*)
# treat `--size-check=foo` the same as `--size-check foo`
size_check=${arg#--size-check=}
continue;;
--cmd=*)
# treat `--cmd=foo` the same as `--cmd foo`
cmdname=${arg#--cmd=}
Expand Down Expand Up @@ -219,6 +230,12 @@ installShellCompletion() {
else
install -Dm644 -T "$arg" "$outPath"
fi || return
# Sanity check file size to avoid assuming completion has succeed but it generate an invalid file.
local fileSize=$(stat -c%s "$outPath")
if (( fileSize < size_check )); then
echo "installShellCompletion: error: $outPath is too small ($fileSize only), use '--size-check $fileSize' to override" >&2
return 1
fi
# Clear the per-path flags
name=
done
Expand Down
11 changes: 6 additions & 5 deletions pkgs/test/install-shell-files/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ recurseIntoAttrs {
echo qux > qux.zsh
echo quux > quux

installShellCompletion --bash foo bar --zsh baz qux.zsh --fish quux
installShellCompletion --size-check 4 --bash foo bar --zsh baz qux.zsh --fish quux

cmp foo $out/share/bash-completion/completions/foo
cmp bar $out/share/bash-completion/completions/bar
Expand All @@ -68,7 +68,7 @@ recurseIntoAttrs {
} ''
echo foo > foo

installShellCompletion --bash foo
installShellCompletion --size-check 4 --bash foo

# assert it didn't go into $out
[[ ! -f $out/share/bash-completion/completions/foo ]]
Expand All @@ -82,7 +82,7 @@ recurseIntoAttrs {
echo bar > bar
echo baz > baz

installShellCompletion --bash --name foobar.bash foo --zsh --name _foobar bar --fish baz
installShellCompletion --size-check 4 --bash --name foobar.bash foo --zsh --name _foobar bar --fish baz

cmp foo $out/share/bash-completion/completions/foobar.bash
cmp bar $out/share/zsh/site-functions/_foobar
Expand All @@ -93,7 +93,7 @@ recurseIntoAttrs {
echo bar > bar.zsh
echo baz > baz.fish

installShellCompletion foo.bash bar.zsh baz.fish
installShellCompletion --size-check 4 foo.bash bar.zsh baz.fish

cmp foo.bash $out/share/bash-completion/completions/foo.bash
cmp bar.zsh $out/share/zsh/site-functions/_bar
Expand All @@ -105,7 +105,7 @@ recurseIntoAttrs {
echo baz > baz.fish
echo qux > qux.fish

installShellCompletion --cmd foobar --bash foo.bash --zsh bar.zsh --fish baz.fish --name qux qux.fish
installShellCompletion --size-check 4 --cmd foobar --bash foo.bash --zsh bar.zsh --fish baz.fish --name qux qux.fish

cmp foo.bash $out/share/bash-completion/completions/foobar.bash
cmp bar.zsh $out/share/zsh/site-functions/_foobar
Expand All @@ -114,6 +114,7 @@ recurseIntoAttrs {
'';
install-completion-fifo = runTest "install-completion-fifo" {} ''
installShellCompletion \
--size-check 4 \
--bash --name foo.bash <(echo foo) \
--zsh --name _foo <(echo bar) \
--fish --name foo.fish <(echo baz)
Expand Down