Skip to content

Fix archive extraction to ensure it always extracts to the given path #524

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

Open
eregon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix archive extraction to ensure it always extracts to the given path #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 share/ruby-install/functions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ function verify_ruby()
function extract_ruby()
{
log "Extracting $ruby_archive to $ruby_build_dir ..."
extract "$src_dir/$ruby_archive" "$src_dir" || return $?
extract "$src_dir/$ruby_archive" "$ruby_build_dir" || return $?
}

#
Expand Down
1 change: 0 additions & 1 deletion share/ruby-install/jruby/functions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/usr/bin/env bash

ruby_archive="${ruby_archive:-jruby-dist-$ruby_version-bin.tar.gz}"
ruby_dir_name="jruby-$ruby_version"
ruby_mirror="${ruby_mirror:-https://repo1.maven.org/maven2/org/jruby/jruby-dist}"
ruby_url="${ruby_url:-$ruby_mirror/$ruby_version/$ruby_archive}"

Expand Down
1 change: 0 additions & 1 deletion share/ruby-install/mruby/functions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/usr/bin/env bash

ruby_archive="${ruby_archive:-mruby-$ruby_version.tar.gz}"
ruby_dir_name="mruby-$ruby_version"
ruby_mirror="${ruby_mirror:-https://github.com/mruby/mruby/archive}"
ruby_url="${ruby_url:-$ruby_mirror/$ruby_version/$ruby_archive}"

Expand Down
2 changes: 1 addition & 1 deletion share/ruby-install/ruby-install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ function init()

ruby_cache_dir="$ruby_install_cache_dir/$ruby"
install_dir="${install_dir:-$rubies_dir/$ruby-$ruby_version}"
ruby_build_dir="$src_dir/$ruby_dir_name"
ruby_build_dir="$src_dir/$ruby-$ruby_version"

ruby_md5="${ruby_md5:-$(ruby_checksum_for "$ruby" md5 "$ruby_archive")}"
ruby_sha1="${ruby_sha1:-$(ruby_checksum_for "$ruby" sha1 "$ruby_archive")}"
Expand Down
1 change: 0 additions & 1 deletion share/ruby-install/ruby/functions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ else
fi

ruby_archive="${ruby_archive:-ruby-$ruby_version.$ruby_archive_ext}"
ruby_dir_name="ruby-$ruby_version"
ruby_mirror="${ruby_mirror:-https://cache.ruby-lang.org/pub/ruby}"
ruby_url="${ruby_url:-$ruby_mirror/$ruby_version_family/$ruby_archive}"

Expand Down
3 changes: 0 additions & 3 deletions share/ruby-install/truffleruby-graalvm/functions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,14 @@ if [[ "$ruby_version" == "23.0.0" ]]; then
log "TruffleRuby-GraalVM 23.0 and later installed by ruby-install use the faster Oracle GraalVM distribution"
log "Oracle GraalVM uses the GFTC license, which is free for development and production use, see https://medium.com/graalvm/161527df3d76"

ruby_dir_name="graalvm-jdk-17.0.7+8.1"
ruby_archive="${ruby_archive:-graalvm-jdk-17.0.7_${graalvm_platform/darwin/macos}-${graalvm_arch/amd64/x64}_bin.tar.gz}"
ruby_mirror="${ruby_mirror:-https://download.oracle.com/graalvm/17/archive}"
ruby_url="${ruby_url:-$ruby_mirror/$ruby_archive}"
elif (( truffleruby_major > 23 || (truffleruby_major == 23 && truffleruby_minor >= 1) )); then # 23.1+
ruby_dir_name="truffleruby-$ruby_version-${graalvm_platform/darwin/macos}-$graalvm_arch"
ruby_archive="${ruby_archive:-truffleruby-jvm-$ruby_version-${graalvm_platform/darwin/macos}-$graalvm_arch.tar.gz}"
ruby_mirror="${ruby_mirror:-https://github.com/truffleruby/truffleruby/releases/download}"
ruby_url="${ruby_url:-$ruby_mirror/graal-$ruby_version/$ruby_archive}"
else
ruby_dir_name="graalvm-ce-java11-$ruby_version"
ruby_archive="${ruby_archive:-graalvm-ce-java11-$graalvm_platform-$graalvm_arch-$ruby_version.tar.gz}"
ruby_mirror="${ruby_mirror:-https://github.com/graalvm/graalvm-ce-builds/releases/download}"
ruby_url="${ruby_url:-$ruby_mirror/vm-$ruby_version/$ruby_archive}"
Expand Down
3 changes: 1 addition & 2 deletions share/ruby-install/truffleruby/functions.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ case "$os_arch" in
*) fail "Unsupported platform $os_arch" ;;
esac

ruby_dir_name="truffleruby-$ruby_version-$truffleruby_platform-$truffleruby_arch"
ruby_archive="${ruby_archive:-$ruby_dir_name.tar.gz}"
ruby_archive="${ruby_archive:-truffleruby-$ruby_version-$truffleruby_platform-$truffleruby_arch.tar.gz}"
truffleruby_major="${ruby_version%%.*}"

if [[ "$ruby_version" == "23.0.0" ]]; then
Expand Down
24 changes: 17 additions & 7 deletions share/ruby-install/util.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,29 +74,39 @@ function download()
function extract()
{
local archive="$1"
local dest="${2:-${archive%/*}}"
local dest="$2"
local dest_dir="$(dirname "$2")"
Copy link
Copy Markdown
Collaborator

@havenwood havenwood May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dirname "$dest" might be nice? "$2" and "$dest" are same here, so just an optional nit.

local tmp="$dest_dir/tmp"

mkdir -p "$dest" || return $?
rm -rf "$dest"
Copy link
Copy Markdown
Collaborator

@havenwood havenwood May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably have a trailing || return $? in case the rm fails. (Just to match project convention, and if it carries on after this rm fails the mv below might confusingly move into $dest instead of renaming.)

mkdir -p "$tmp" || return $?

case "$archive" in
*.tgz|*.tar.gz)
run tar -xzf "$archive" -C "$dest" || return $?
run tar -xzf "$archive" -C "$tmp" || return $?
;;
*.tbz|*.tbz2|*.tar.bz2)
run tar -xjf "$archive" -C "$dest" || return $?
run tar -xjf "$archive" -C "$tmp" || return $?
;;
*.txz|*.tar.xz)
debug "xzcat $archive | tar -xf - -C $dest"
xzcat "$archive" | tar -xf - -C "$dest" || return $?
debug "xzcat $archive | tar -xf - -C $tmp"
xzcat "$archive" | tar -xf - -C "$tmp" || return $?
;;
*.zip)
run unzip "$archive" -d "$dest" || return $?
run unzip "$archive" -d "$tmp" || return $?
;;
*)
error "Unknown archive format: $archive"
return 1
;;
esac

local extracted=("$tmp"/*)
if (( ${#extracted[@]} != 1 )); then
error "Multiple extracted directories under $tmp"
return 1
fi
mv "${extracted[0]}" "$dest"
Copy link
Copy Markdown
Collaborator

@havenwood havenwood May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be a good idea to add an rm -rf "$tmp" here to clean up the now-empty $tmp dir. (If an rm is added, the mv would need a || return $?.)

}

#
Expand Down
10 changes: 5 additions & 5 deletions test/functions-tests/apply_patches_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
. ./share/ruby-install/functions.sh

src_dir="$test_fixtures_dir/apply_patches_test"
ruby_dir_name="ruby-1.9.3-p448"
ruby_build_dir="$src_dir/$ruby_dir_name"
ruby_and_version="ruby-1.9.3-p448"
ruby_build_dir="$src_dir/$ruby_and_version"

patches=("$ruby_build_dir/falcon-gc.diff")

function setUp()
{
mkdir -p "$ruby_build_dir"
echo "diff -Naur $ruby_dir_name.orig/test $ruby_dir_name/test
--- $ruby_dir_name.orig/test 1970-01-01 01:00:00.000000000 +0100
+++ $ruby_dir_name/test 2013-08-02 20:57:08.055843749 +0200
echo "diff -Naur $ruby_and_version.orig/test $ruby_and_version/test
--- $ruby_and_version.orig/test 1970-01-01 01:00:00.000000000 +0100
+++ $ruby_and_version/test 2013-08-02 20:57:08.055843749 +0200
@@ -0,0 +1 @@
+patch
" > "${patches[0]}"
Expand Down
6 changes: 3 additions & 3 deletions test/functions-tests/download_patches_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
. ./share/ruby-install/functions.sh

src_dir="$test_fixtures_dir/download_patches_test"
ruby_dir_name="ruby-1.9.3-p448"
ruby_build_dir="$src_dir/$ruby_dir_name"
ruby_and_version="ruby-1.9.3-p448"
ruby_build_dir="$src_dir/$ruby_and_version"

patches=("https://gist.github.com/funny-falcon/2981959/raw/ary-queue.diff" "local.patch")

Expand All @@ -18,7 +18,7 @@ function test_download_patches()
{
download_patches 2>/dev/null

assertTrue "did not download patches to \$src_dir/\$ruby_dir_name" \
assertTrue "did not download patches to \$src_dir/\$ruby_and_version" \
'[[ -f "${ruby_build_dir}/ary-queue.diff" ]]'

assertEquals "did not update \$patches" \
Expand Down
9 changes: 1 addition & 8 deletions test/jruby-tests/functions_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,6 @@ function test_ruby_archive_when_its_already_set()
"$ruby_archive"
}

function test_ruby_dir_name()
{
assertEquals "did not correctly set \$ruby_dir_name" \
"jruby-$ruby_version" \
"$ruby_dir_name"
}

function test_ruby_mirror_default_value()
{
assertEquals "did not correctly set \$ruby_mirror" \
Expand Down Expand Up @@ -78,7 +71,7 @@ function test_ruby_url_when_its_already_set()

function tearDown()
{
unset ruby ruby_version ruby_archive ruby_dir_name ruby_mirror ruby_url
unset ruby ruby_version ruby_archive ruby_mirror ruby_url
}

SHUNIT_PARENT=$0 . $SHUNIT2
9 changes: 1 addition & 8 deletions test/mruby-tests/functions_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,6 @@ function test_ruby_archive_when_its_already_set()
"$ruby_archive"
}

function test_ruby_dir_name()
{
assertEquals "did not correctly set \$ruby_dir_name" \
"mruby-$ruby_version" \
"$ruby_dir_name"
}

function test_ruby_mirror_default_value()
{
assertEquals "did not correctly set \$ruby_mirror" \
Expand Down Expand Up @@ -78,7 +71,7 @@ function test_ruby_url_when_its_already_set()

function tearDown()
{
unset ruby ruby_version ruby_archive ruby_dir_name ruby_mirror ruby_url
unset ruby ruby_version ruby_archive ruby_mirror ruby_url
}

SHUNIT_PARENT=$0 . $SHUNIT2
9 changes: 1 addition & 8 deletions test/ruby-tests/functions_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,6 @@ function test_ruby_archive_when_its_already_set()
"$ruby_archive"
}

function test_ruby_dir_name()
{
assertEquals "did not correctly set \$ruby_dir_name" \
"ruby-$ruby_version" \
"$ruby_dir_name"
}

function test_ruby_mirror_default_value()
{
assertEquals "did not correctly set \$ruby_mirror" \
Expand Down Expand Up @@ -104,7 +97,7 @@ function test_ruby_url_when_its_already_set()

function tearDown()
{
unset ruby ruby_version ruby_version_family ruby_archive ruby_dir_name \
unset ruby ruby_version ruby_version_family ruby_archive \
ruby_mirror ruby_url
}

Expand Down
38 changes: 1 addition & 37 deletions test/truffleruby-graalvm-tests/functions_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,42 +113,6 @@ function test_truffleruby_minor()
"$truffleruby_minor"
}

function test_ruby_dir_name_when_ruby_version_is_23_0_0()
{
ruby_version="23.0.0"

source "$ruby_install_dir/functions.sh"
source "$ruby_install_dir/truffleruby-graalvm/functions.sh" >/dev/null

assertEquals "did not correctly set \$ruby_dir_name" \
"graalvm-jdk-17.0.7+8.1" \
"$ruby_dir_name"
}

function test_ruby_dir_name_when_ruby_version_is_greater_or_equal_to_23_1_0()
{
ruby_version="23.1.0"

source "$ruby_install_dir/functions.sh"
source "$ruby_install_dir/truffleruby-graalvm/functions.sh"

assertEquals "did not correctly set \$ruby_dir_name" \
"truffleruby-$ruby_version-${graalvm_platform/darwin/macos}-$graalvm_arch" \
"$ruby_dir_name"
}

function test_ruby_dir_name_when_ruby_version_is_less_than_23_0_0()
{
ruby_version="22.1.0"

source "$ruby_install_dir/functions.sh"
source "$ruby_install_dir/truffleruby-graalvm/functions.sh"

assertEquals "did not correctly set \$ruby_dir_name" \
"graalvm-ce-java11-$ruby_version" \
"$ruby_dir_name"
}

function test_ruby_archive_default_value_when_ruby_version_is_23_0_0()
{
ruby_version="23.0.0"
Expand Down Expand Up @@ -372,7 +336,7 @@ function test_ruby_url_when_its_already_set_and_when_ruby_version_is_less_than_2

function tearDown()
{
unset ruby ruby_version ruby_version_family ruby_archive ruby_dir_name \
unset ruby ruby_version ruby_version_family ruby_archive \
ruby_mirror ruby_url
}

Expand Down
9 changes: 1 addition & 8 deletions test/truffleruby-tests/functions_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,6 @@ function test_ruby_archive_when_its_already_set_and_when_ruby_version_is_less_th
"$ruby_archive"
}

function test_ruby_dir_name()
{
assertEquals "did not correctly set \$ruby_dir_name" \
"truffleruby-$ruby_version-$truffleruby_platform-$truffleruby_arch" \
"$ruby_dir_name"
}

function test_ruby_mirror_default_value_when_ruby_version_is_greater_or_equal_to_23_0_0()
{
ruby_version="23.0.0"
Expand Down Expand Up @@ -244,7 +237,7 @@ function test_ruby_url_when_its_already_set_and_ruby_version_is_less_than_23_0_0

function tearDown()
{
unset ruby ruby_version ruby_version_family ruby_archive ruby_dir_name \
unset ruby ruby_version ruby_version_family ruby_archive \
ruby_mirror ruby_url
}

Expand Down
Loading