From a559b30fd827e6ef70c1fc2636af458d6eb11dd7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mislav=20Marohni=C4=87?= <git@mislav.net>
Date: Tue, 17 Oct 2023 00:18:14 +0200
Subject: [PATCH] Improve `cached_tarball` test helper

- Now only generates a `configure` script if explicitly specified
- Add ability to add arbitrary files to the tarball
- Cache most common tarballs in fixtures directory to speed up tests
---
 test/arguments.bats                 |  14 ++-
 test/build.bats                     | 136 +++++++++++++++++-----------
 test/cache.bats                     |   9 +-
 test/fixtures/jruby-9000.dev.tar.gz | Bin 0 -> 164 bytes
 test/fixtures/ruby-2.0.0.tar.gz     | Bin 0 -> 222 bytes
 test/fixtures/yaml-0.1.6.tar.gz     | Bin 0 -> 222 bytes
 test/installer.bats                 |   4 +
 test/test_helper.bash               |   4 +-
 8 files changed, 100 insertions(+), 67 deletions(-)
 create mode 100644 test/fixtures/jruby-9000.dev.tar.gz
 create mode 100644 test/fixtures/ruby-2.0.0.tar.gz
 create mode 100644 test/fixtures/yaml-0.1.6.tar.gz

diff --git a/test/arguments.bats b/test/arguments.bats
index efd642713b..2f91ea973b 100644
--- a/test/arguments.bats
+++ b/test/arguments.bats
@@ -3,21 +3,19 @@
 load test_helper
 
 @test "not enough arguments for ruby-build" {
+  mkdir -p "$TMP"
   # use empty inline definition so nothing gets built anyway
-  local definition="${TMP}/build-definition"
-  echo '' > "$definition"
-
-  run ruby-build "$definition"
+  touch "${TMP}/empty-definition"
+  run ruby-build "${TMP}/empty-definition"
   assert_failure
   assert_output_contains 'Usage: ruby-build'
 }
 
 @test "extra arguments for ruby-build" {
+  mkdir -p "$TMP"
   # use empty inline definition so nothing gets built anyway
-  local definition="${TMP}/build-definition"
-  echo '' > "$definition"
-
-  run ruby-build "$definition" "${TMP}/install" ""
+  touch "${TMP}/empty-definition"
+  run ruby-build "${TMP}/empty-definition" "${TMP}/install" ""
   assert_failure
   assert_output_contains 'Usage: ruby-build'
 }
diff --git a/test/build.bats b/test/build.bats
index aa31041c00..2ab941b7c2 100755
--- a/test/build.bats
+++ b/test/build.bats
@@ -21,30 +21,63 @@ executable() {
 }
 
 cached_tarball() {
-  mkdir -p "$RUBY_BUILD_CACHE_PATH"
-  pushd "$RUBY_BUILD_CACHE_PATH" >/dev/null
-  tarball "$@"
-  popd >/dev/null
+  local save_to_fixtures
+  case "$*" in
+  "ruby-2.0.0 configure" | "yaml-0.1.6 configure" | "jruby-9000.dev bin/jruby" )
+    save_to_fixtures=1
+    ;;
+  esac
+
+  local tarball="${1}.tar.gz"
+  local fixture_tarball="${FIXTURE_ROOT}/${tarball}"
+  local cached_tarball="${RUBY_BUILD_CACHE_PATH}/${tarball}"
+  shift 1
+  
+  if [ -n "$save_to_fixtures" ] && [ -e "$fixture_tarball" ]; then
+    mkdir -p "$(dirname "$cached_tarball")"
+    cp "$fixture_tarball" "$cached_tarball"
+    return 0
+  fi
+
+  generate_tarball "$cached_tarball" "$@"
+  [ -z "$save_to_fixtures" ] || cp "$cached_tarball" "$fixture_tarball"
 }
 
-tarball() {
-  local name="$1"
-  local path="$PWD/$name"
-  local configure="$path/configure"
+generate_tarball() {
+  local tarfile="$1"
   shift 1
+  local name path
+  name="$(basename "${tarfile%.tar.gz}")"
+  path="$(mktemp -d "$TMP/tarball.XXXXX")/${name}"
 
-  executable "$configure" <<OUT
+  local file target
+  for file; do
+    case "$file" in
+    config | configure )
+      mkdir -p "$(dirname "${path}/${file}")"
+      cat > "${path}/${file}" <<OUT
 #!$BASH
 IFS=,
 echo "$name: [\$*]" \${RUBYOPT:+RUBYOPT=\$RUBYOPT} >> build.log
 OUT
-
-  for file; do
-    mkdir -p "$(dirname "${path}/${file}")"
-    touch "${path}/${file}"
+      chmod +x "${path}/${file}"
+      ;;
+    *:* )
+      target="${file#*:}"
+      file="${file%:*}"
+      mkdir -p "$(dirname "${path}/${file}")"
+      cp "$target" "${path}/${file}"
+      ;;
+    * )
+      mkdir -p "$(dirname "${path}/${file}")"
+      touch "${path}/${file}"
+      ;;
+    esac
   done
 
-  tar czf "${path}.tar.gz" -C "${path%/*}" "$name"
+  mkdir -p "$(dirname "$tarfile")"
+  tar czf "$tarfile" -C "${path%/*}" "$name"
+  rm -rf "$path"
 }
 
 stub_make_install() {
@@ -59,8 +92,8 @@ assert_build_log() {
 }
 
 @test "yaml is installed for ruby" {
-  cached_tarball "yaml-0.1.6"
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "yaml-0.1.6" configure
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo Linux'
   stub_repeated brew false
@@ -85,8 +118,8 @@ OUT
 }
 
 @test "apply ruby patch before building" {
-  cached_tarball "yaml-0.1.6"
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "yaml-0.1.6" configure
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo Linux'
   stub_repeated brew false
@@ -118,8 +151,8 @@ OUT
 }
 
 @test "striplevel ruby patch before building" {
-  cached_tarball "yaml-0.1.6"
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "yaml-0.1.6" configure
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo Linux'
   stub_repeated brew false
@@ -151,8 +184,8 @@ OUT
 }
 
 @test "apply ruby patch from git diff before building" {
-  cached_tarball "yaml-0.1.6"
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "yaml-0.1.6" configure
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo Linux'
   stub_repeated brew false
@@ -185,7 +218,7 @@ OUT
 }
 
 @test "yaml is linked from Homebrew" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   brew_libdir="$TMP/homebrew-yaml"
   mkdir -p "$brew_libdir"
@@ -211,7 +244,7 @@ OUT
 }
 
 @test "gmp is linked from Homebrew" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   gmp_libdir="$TMP/homebrew-gmp"
   mkdir -p "$gmp_libdir"
@@ -235,7 +268,7 @@ OUT
 }
 
 @test "readline is linked from Homebrew" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   readline_libdir="$TMP/homebrew-readline"
   mkdir -p "$readline_libdir"
@@ -259,7 +292,7 @@ OUT
 }
 
 @test "readline is not linked from Homebrew when explicitly defined" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   readline_libdir="$TMP/homebrew-readline"
   mkdir -p "$readline_libdir"
@@ -284,7 +317,7 @@ OUT
 }
 
 @test "forward extra command-line arguments as configure flags" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated brew false
   stub_make_install
@@ -307,7 +340,7 @@ OUT
 }
 
 @test "number of CPU cores defaults to 2" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo Darwin'
   stub sysctl false
@@ -330,7 +363,7 @@ OUT
 }
 
 @test "number of CPU cores is detected on Mac" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo Darwin'
   stub sysctl '-n hw.ncpu : echo 4'
@@ -354,7 +387,7 @@ OUT
 }
 
 @test "number of CPU cores is detected on FreeBSD" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo FreeBSD'
   stub sysctl '-n hw.ncpu : echo 1'
@@ -379,7 +412,7 @@ OUT
 }
 
 @test "using MAKE_INSTALL_OPTS" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   stub_repeated uname '-s : echo Linux'
   stub_make_install
@@ -411,7 +444,7 @@ OUT
 }
 
 @test "can use RUBY_CONFIGURE to apply a patch" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   executable "${TMP}/custom-configure" <<CONF
 #!$BASH
@@ -456,8 +489,7 @@ OUT
 }
 
 @test "mruby strategy" {
-  package="$TMP/mruby-1.0"
-  executable "$package/minirake" <<OUT
+  executable "$TMP/minirake" <<OUT
 #!$BASH
 set -e
 IFS=,
@@ -466,11 +498,7 @@ mkdir -p build/host/bin
 touch build/host/bin/{mruby,mirb}
 chmod +x build/host/bin/{mruby,mirb}
 OUT
-  mkdir -p "$package/include"
-  touch "$package/include/mruby.h"
-  mkdir -p "$RUBY_BUILD_CACHE_PATH"
-  tar czf "$RUBY_BUILD_CACHE_PATH/${package##*/}.tar.gz" -C "${package%/*}" "${package##*/}"
-  rm -rf "$package"
+  cached_tarball "mruby-1.0" "minirake:$TMP/minirake" include/mruby.h
 
   stub gem false
   stub rake false
@@ -494,7 +522,7 @@ OUT
 }
 
 @test "rbx uses bundle then rake" {
-  cached_tarball "rubinius-2.0.0" "Gemfile"
+  cached_tarball "rubinius-2.0.0" Gemfile configure
 
   stub gem false
   stub rake false
@@ -519,15 +547,17 @@ OUT
 }
 
 @test "fixes rbx binstubs" {
-  executable "${RUBY_BUILD_CACHE_PATH}/rubinius-2.0.0/gems/bin/rake" <<OUT
+  executable "${TMP}/rbx-rake" <<OUT
 #!rbx
 puts 'rake'
 OUT
-  executable "${RUBY_BUILD_CACHE_PATH}/rubinius-2.0.0/gems/bin/irb" <<OUT
+  executable "${TMP}/rbx-irb" <<OUT
 #!rbx
 print '>>'
 OUT
-  cached_tarball "rubinius-2.0.0" bin/ruby
+  cached_tarball "rubinius-2.0.0" configure bin/ruby \
+    gems/bin/rake:"$TMP"/rbx-rake \
+    gems/bin/irb:"$TMP"/rbx-irb
 
   stub bundle false
   stub rake \
@@ -567,16 +597,18 @@ OUT
 }
 
 @test "JRuby build" {
-  executable "${RUBY_BUILD_CACHE_PATH}/jruby-1.7.9/bin/jruby" <<OUT
+  executable "${TMP}/jruby-bin" <<OUT
 #!${BASH}
 IFS=,
 echo "jruby [\$*]" >> ../build.log
 OUT
-  executable "${RUBY_BUILD_CACHE_PATH}/jruby-1.7.9/bin/gem" <<OUT
+  executable "${TMP}/jruby-gem" <<OUT
 #!/usr/bin/env jruby
 nice gem things
 OUT
-  cached_tarball "jruby-1.7.9" bin/foo.exe bin/bar.dll bin/baz.bat
+  cached_tarball "jruby-1.7.9" bin/foo.exe bin/bar.dll bin/baz.bat \
+    bin/jruby:"$TMP"/jruby-bin \
+    bin/gem:"$TMP"/jruby-gem
 
   run_inline_definition <<DEF
 install_package "jruby-1.7.9" "http://jruby.org/downloads/jruby-bin-1.7.9.tar.gz" jruby
@@ -715,17 +747,17 @@ DEF
 }
 
 @test "TruffleRuby post-install hook" {
-  rmdir "$INSTALL_ROOT"
-  executable "${RUBY_BUILD_CACHE_PATH}/truffleruby-test/lib/truffle/post_install_hook.sh" <<OUT
-echo Running post-install hook
+  executable "${TMP}/hook.sh" <<OUT
+echo Running post-install hook >> build.log
 OUT
-  cached_tarball "truffleruby-test" bin/truffleruby
+  cached_tarball "truffleruby-test" bin/truffleruby lib/truffle/post_install_hook.sh:"$TMP"/hook.sh
 
   run_inline_definition <<DEF
 install_package "truffleruby-test" "URL" truffleruby
 DEF
   assert_success
-  assert_output_contains "Running post-install hook"
+  run cat "$INSTALL_ROOT"/build.log
+  assert_success "Running post-install hook"
 }
 
 @test "non-writable TMPDIR aborts build" {
@@ -749,7 +781,7 @@ DEF
 }
 
 @test "does not initialize LDFLAGS directories" {
-  cached_tarball "ruby-2.0.0"
+  cached_tarball "ruby-2.0.0" configure
 
   export LDFLAGS="-L ${BATS_TEST_DIRNAME}/what/evs"
   run_inline_definition <<DEF
diff --git a/test/cache.bats b/test/cache.bats
index 998f163795..b99dbcdb3e 100644
--- a/test/cache.bats
+++ b/test/cache.bats
@@ -4,14 +4,10 @@ load test_helper
 export RUBY_BUILD_SKIP_MIRROR=1
 export RUBY_BUILD_CACHE_PATH="$TMP/cache"
 
-setup() {
-  mkdir "$RUBY_BUILD_CACHE_PATH"
-}
-
-
 @test "packages are saved to download cache" {
   stub curl "-q -o * -*S* http://example.com/* : cp $FIXTURE_ROOT/\${5##*/} \$3"
 
+  mkdir -p "$RUBY_BUILD_CACHE_PATH"
   install_fixture definitions/without-checksum
 
   assert_success
@@ -24,6 +20,7 @@ setup() {
 @test "cached package without checksum" {
   stub curl
 
+  mkdir -p "$RUBY_BUILD_CACHE_PATH"
   cp "${FIXTURE_ROOT}/package-1.0.0.tar.gz" "$RUBY_BUILD_CACHE_PATH"
 
   install_fixture definitions/without-checksum
@@ -39,6 +36,7 @@ setup() {
   stub shasum true "echo ba988b1bb4250dee0b9dd3d4d722f9c64b2bacfc805d1b6eba7426bda72dd3c5"
   stub curl
 
+  mkdir -p "$RUBY_BUILD_CACHE_PATH"
   cp "${FIXTURE_ROOT}/package-1.0.0.tar.gz" "$RUBY_BUILD_CACHE_PATH"
 
   install_fixture definitions/with-checksum
@@ -60,6 +58,7 @@ setup() {
   stub curl "-*I* : true" \
     "-q -o * -*S* https://?*/$checksum : cp $FIXTURE_ROOT/package-1.0.0.tar.gz \$3"
 
+  mkdir -p "$RUBY_BUILD_CACHE_PATH"
   touch "${RUBY_BUILD_CACHE_PATH}/package-1.0.0.tar.gz"
 
   install_fixture definitions/with-checksum
diff --git a/test/fixtures/jruby-9000.dev.tar.gz b/test/fixtures/jruby-9000.dev.tar.gz
new file mode 100644
index 0000000000000000000000000000000000000000..55582e562afe1722aaf96cc4f936b7be3b49c456
GIT binary patch
literal 164
zcmV;V09*ebiwFSLwJl`;1IsEZO{&zjG%zsGOGz!$XP^ZD8g6cCssN_VAhdyz3513M
z1w#{4Lt|rOBXc7&1p`A910w?l1yh>11`U)Jmn0SeosyeboRe6FTOCkYS{fd6p#Ff<
zLj+`@#(z>~9`(}z8S!swJ{tdY0a)T6EJRH^fQFlyn2-|xre?+_3<?I+bObIi!sCAw
SjDk@xasdF75_q@(3IG6-20D5G

literal 0
HcmV?d00001

diff --git a/test/fixtures/ruby-2.0.0.tar.gz b/test/fixtures/ruby-2.0.0.tar.gz
new file mode 100644
index 0000000000000000000000000000000000000000..0263f58cd3b19a72dccfec35fdabd46e2a4e42a6
GIT binary patch
literal 222
zcmV<403rV$iwFR7wJl`;11l;`s?;^oGte{8XP^}@FfcGTHB|u9W)RxI$OJ+|fr6ol
zsiCp4v5~2nk%EDtv7xaEgMul|T!aKli%SxVfKJKHEY3+R!>taeEG-R>IZ%JV=^+A&
z5b>X!pO==IURsn&Z953Xzafx=8vmvSCI$=&2Gn*4HZa2DUs+K<DKk$$DX}<%%hN5`
zR);G!IU`>|36U<W6rxqMVwDtBs)ItEBK-qGthAvFTNNmyR>96rA*nPoCq*wOKb>o!
Y{WJ<j!6+C7qku2~04STjPyh-50LbT8tN;K2

literal 0
HcmV?d00001

diff --git a/test/fixtures/yaml-0.1.6.tar.gz b/test/fixtures/yaml-0.1.6.tar.gz
new file mode 100644
index 0000000000000000000000000000000000000000..d87e4e0ff7187562d1690907a1772a02b6d7fae9
GIT binary patch
literal 222
zcmV<403rV$iwFR6wJl`;1FKBT&CxZ`Gt@KFXP^}@FfcGTHB|u9W)RxI$OJ+|fr6ol
zsiCp4v5~2nk%EDtv7wO>gMul|T!aKli%SxVfKJKHEY3+R!>taeEG-R>IZ%JV=^+9t
z5%Hg#pO==IURsn&Z953Xzafx=8vmvSMrI5O2Gn*4HZa2DUs+K<DKk$$DX}<%%hN5`
zR);G!IU`>|36U<W6rxqMVwDtBs)ItEBK-qGthAvFTNNmyR>96rA*nPoCq*wOKb>o!
Y{WJ<j!6+C7qku2~04){mMgR%`0L9o?o&W#<

literal 0
HcmV?d00001

diff --git a/test/installer.bats b/test/installer.bats
index 04348bb217..5fb19fe63c 100644
--- a/test/installer.bats
+++ b/test/installer.bats
@@ -3,6 +3,7 @@
 load test_helper
 
 @test "installs ruby-build into PREFIX" {
+  mkdir -p "$TMP"
   cd "$TMP"
   PREFIX="${PWD}/usr" run "${BATS_TEST_DIRNAME}/../install.sh"
   assert_success ""
@@ -18,6 +19,7 @@ load test_helper
 }
 
 @test "build definitions don't have the executable bit" {
+  mkdir -p "$TMP"
   cd "$TMP"
   PREFIX="${PWD}/usr" run "${BATS_TEST_DIRNAME}/../install.sh"
   assert_success ""
@@ -30,6 +32,7 @@ OUT
 }
 
 @test "overwrites old installation" {
+  mkdir -p "$TMP"
   cd "$TMP"
   mkdir -p bin share/ruby-build
   touch bin/ruby-build
@@ -44,6 +47,7 @@ OUT
 }
 
 @test "unrelated files are untouched" {
+  mkdir -p "$TMP"
   cd "$TMP"
   mkdir -p bin share/bananas
   chmod g-w bin
diff --git a/test/test_helper.bash b/test/test_helper.bash
index f0fa95fd32..b90a74c38d 100644
--- a/test/test_helper.bash
+++ b/test/test_helper.bash
@@ -1,4 +1,4 @@
-export TMP="$BATS_TEST_DIRNAME/tmp"
+export TMP="$BATS_TMPDIR"/ruby-build-test
 export RUBY_BUILD_CURL_OPTS=
 export RUBY_BUILD_HTTP_CLIENT="curl"
 export RUBY_BUILD_TESTING=true
@@ -31,7 +31,7 @@ remove_commands_from_path() {
 }
 
 teardown() {
-  rm -fr "${TMP:?}"/*
+  rm -fr "${TMP:?}"
 }
 
 stub() {