From 9d4e7b376aaeeea2676ca2691cdc52996bfb3e43 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Rodr=C3=ADguez?= <deivid.rodriguez@riseup.net>
Date: Tue, 24 Sep 2024 12:44:17 +0200
Subject: Make spec file for env helpers more generic

---
 spec/bundler/runtime/env_helpers_spec.rb        | 307 ++++++++++++++++++++++++
 spec/bundler/runtime/with_unbundled_env_spec.rb | 307 ------------------------
 2 files changed, 307 insertions(+), 307 deletions(-)
 create mode 100644 spec/bundler/runtime/env_helpers_spec.rb
 delete mode 100644 spec/bundler/runtime/with_unbundled_env_spec.rb

diff --git a/spec/bundler/runtime/env_helpers_spec.rb b/spec/bundler/runtime/env_helpers_spec.rb
new file mode 100644
index 0000000000..a1607cd057
--- /dev/null
+++ b/spec/bundler/runtime/env_helpers_spec.rb
@@ -0,0 +1,307 @@
+# frozen_string_literal: true
+
+RSpec.describe "env helpers" do
+  def bundle_exec_ruby(args, options = {})
+    build_bundler_context options.dup
+    bundle "exec '#{Gem.ruby}' #{args}", options
+  end
+
+  def build_bundler_context(options = {})
+    bundle "config set path vendor/bundle", options.dup
+    gemfile "source 'https://gem.repo1'"
+    bundle "install", options
+  end
+
+  def run_bundler_script(env, script)
+    system(env, "ruby", "-I#{lib_dir}", "-rbundler", script.to_s)
+  end
+
+  describe "Bundler.original_env" do
+    it "should return the PATH present before bundle was activated" do
+      create_file("source.rb", <<-RUBY)
+        print Bundler.original_env["PATH"]
+      RUBY
+      path = `getconf PATH`.strip + "#{File::PATH_SEPARATOR}/foo"
+      with_path_as(path) do
+        bundle_exec_ruby(bundled_app("source.rb").to_s)
+        expect(last_command.stdboth).to eq(path)
+      end
+    end
+
+    it "should return the GEM_PATH present before bundle was activated" do
+      create_file("source.rb", <<-RUBY)
+        print Bundler.original_env['GEM_PATH']
+      RUBY
+      gem_path = ENV["GEM_PATH"] + "#{File::PATH_SEPARATOR}/foo"
+      with_gem_path_as(gem_path) do
+        bundle_exec_ruby(bundled_app("source.rb").to_s)
+        expect(last_command.stdboth).to eq(gem_path)
+      end
+    end
+
+    it "works with nested bundle exec invocations", :ruby_repo do
+      create_file("exe.rb", <<-'RUBY')
+        count = ARGV.first.to_i
+        exit if count < 0
+        STDERR.puts "#{count} #{ENV["PATH"].end_with?("#{File::PATH_SEPARATOR}/foo")}"
+        if count == 2
+          ENV["PATH"] = "#{ENV["PATH"]}#{File::PATH_SEPARATOR}/foo"
+        end
+        exec(Gem.ruby, __FILE__, (count - 1).to_s)
+      RUBY
+      path = `getconf PATH`.strip + File::PATH_SEPARATOR + File.dirname(Gem.ruby)
+      with_path_as(path) do
+        build_bundler_context
+        bundle_exec_ruby("#{bundled_app("exe.rb")} 2")
+      end
+      expect(err).to eq <<-EOS.strip
+2 false
+1 true
+0 true
+      EOS
+    end
+
+    it "removes variables that bundler added", :ruby_repo do
+      # Simulate bundler has not yet been loaded
+      ENV.replace(ENV.to_hash.delete_if {|k, _v| k.start_with?(Bundler::EnvironmentPreserver::BUNDLER_PREFIX) })
+
+      original = ruby('puts ENV.to_a.map {|e| e.join("=") }.sort.join("\n")', artifice: "fail")
+      create_file("source.rb", <<-RUBY)
+        puts Bundler.original_env.to_a.map {|e| e.join("=") }.sort.join("\n")
+      RUBY
+      bundle_exec_ruby bundled_app("source.rb"), artifice: "fail"
+      expect(out).to eq original
+    end
+  end
+
+  shared_examples_for "an unbundling helper" do
+    it "should delete BUNDLE_PATH" do
+      create_file("source.rb", <<-RUBY)
+        print #{modified_env}.has_key?('BUNDLE_PATH')
+      RUBY
+      ENV["BUNDLE_PATH"] = "./foo"
+      bundle_exec_ruby bundled_app("source.rb")
+      expect(last_command.stdboth).to include "false"
+    end
+
+    it "should remove absolute path to 'bundler/setup' from RUBYOPT even if it was present in original env" do
+      create_file("source.rb", <<-RUBY)
+        print #{modified_env}['RUBYOPT']
+      RUBY
+      setup_require = "-r#{lib_dir}/bundler/setup"
+      ENV["BUNDLER_ORIG_RUBYOPT"] = "-W2 #{setup_require} #{ENV["RUBYOPT"]}"
+      bundle_exec_ruby bundled_app("source.rb")
+      expect(last_command.stdboth).not_to include(setup_require)
+    end
+
+    it "should remove relative path to 'bundler/setup' from RUBYOPT even if it was present in original env" do
+      create_file("source.rb", <<-RUBY)
+        print #{modified_env}['RUBYOPT']
+      RUBY
+      ENV["BUNDLER_ORIG_RUBYOPT"] = "-W2 -rbundler/setup #{ENV["RUBYOPT"]}"
+      bundle_exec_ruby bundled_app("source.rb")
+      expect(last_command.stdboth).not_to include("-rbundler/setup")
+    end
+
+    it "should delete BUNDLER_SETUP even if it was present in original env" do
+      create_file("source.rb", <<-RUBY)
+        print #{modified_env}.has_key?('BUNDLER_SETUP')
+      RUBY
+      ENV["BUNDLER_ORIG_BUNDLER_SETUP"] = system_gem_path("gems/bundler-#{Bundler::VERSION}/lib/bundler/setup").to_s
+      bundle_exec_ruby bundled_app("source.rb")
+      expect(last_command.stdboth).to include "false"
+    end
+
+    it "should restore RUBYLIB", :ruby_repo do
+      create_file("source.rb", <<-RUBY)
+        print #{modified_env}['RUBYLIB']
+      RUBY
+      ENV["RUBYLIB"] = lib_dir.to_s + File::PATH_SEPARATOR + "/foo"
+      ENV["BUNDLER_ORIG_RUBYLIB"] = lib_dir.to_s + File::PATH_SEPARATOR + "/foo-original"
+      bundle_exec_ruby bundled_app("source.rb")
+      expect(last_command.stdboth).to include("/foo-original")
+    end
+
+    it "should restore the original MANPATH" do
+      create_file("source.rb", <<-RUBY)
+        print #{modified_env}['MANPATH']
+      RUBY
+      ENV["MANPATH"] = "/foo"
+      ENV["BUNDLER_ORIG_MANPATH"] = "/foo-original"
+      bundle_exec_ruby bundled_app("source.rb")
+      expect(last_command.stdboth).to include("/foo-original")
+    end
+  end
+
+  describe "Bundler.unbundled_env" do
+    let(:modified_env) { "Bundler.unbundled_env" }
+
+    it_behaves_like "an unbundling helper"
+  end
+
+  describe "Bundler.clean_env", bundler: 2 do
+    let(:modified_env) { "Bundler.clean_env" }
+
+    it_behaves_like "an unbundling helper"
+  end
+
+  describe "Bundler.with_original_env" do
+    it "should set ENV to original_env in the block" do
+      expected = Bundler.original_env
+      actual = Bundler.with_original_env { ENV.to_hash }
+      expect(actual).to eq(expected)
+    end
+
+    it "should restore the environment after execution" do
+      Bundler.with_original_env do
+        ENV["FOO"] = "hello"
+      end
+
+      expect(ENV).not_to have_key("FOO")
+    end
+  end
+
+  describe "Bundler.with_clean_env", bundler: 2 do
+    it "should set ENV to unbundled_env in the block" do
+      expected = Bundler.unbundled_env
+
+      actual = Bundler.ui.silence do
+        Bundler.with_clean_env { ENV.to_hash }
+      end
+
+      expect(actual).to eq(expected)
+    end
+
+    it "should restore the environment after execution" do
+      Bundler.ui.silence do
+        Bundler.with_clean_env { ENV["FOO"] = "hello" }
+      end
+
+      expect(ENV).not_to have_key("FOO")
+    end
+  end
+
+  describe "Bundler.with_unbundled_env" do
+    it "should set ENV to unbundled_env in the block" do
+      expected = Bundler.unbundled_env
+      actual = Bundler.with_unbundled_env { ENV.to_hash }
+      expect(actual).to eq(expected)
+    end
+
+    it "should restore the environment after execution" do
+      Bundler.with_unbundled_env do
+        ENV["FOO"] = "hello"
+      end
+
+      expect(ENV).not_to have_key("FOO")
+    end
+  end
+
+  describe "Bundler.original_system" do
+    before do
+      create_file("source.rb", <<-'RUBY')
+        Bundler.original_system("ruby", "-e", "exit(42) if ENV['BUNDLE_FOO'] == 'bar'")
+
+        exit $?.exitstatus
+      RUBY
+    end
+
+    it "runs system inside with_original_env" do
+      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
+      expect($?.exitstatus).to eq(42)
+    end
+  end
+
+  describe "Bundler.clean_system", bundler: 2 do
+    before do
+      create_file("source.rb", <<-'RUBY')
+        Bundler.ui.silence { Bundler.clean_system("ruby", "-e", "exit(42) unless ENV['BUNDLE_FOO'] == 'bar'") }
+
+        exit $?.exitstatus
+      RUBY
+    end
+
+    it "runs system inside with_clean_env" do
+      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
+      expect($?.exitstatus).to eq(42)
+    end
+  end
+
+  describe "Bundler.unbundled_system" do
+    before do
+      create_file("source.rb", <<-'RUBY')
+        Bundler.unbundled_system("ruby", "-e", "exit(42) unless ENV['BUNDLE_FOO'] == 'bar'")
+
+        exit $?.exitstatus
+      RUBY
+    end
+
+    it "runs system inside with_unbundled_env" do
+      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
+      expect($?.exitstatus).to eq(42)
+    end
+  end
+
+  describe "Bundler.original_exec" do
+    before do
+      create_file("source.rb", <<-'RUBY')
+        Process.fork do
+          exit Bundler.original_exec(%(test "\$BUNDLE_FOO" = "bar"))
+        end
+
+        _, status = Process.wait2
+
+        exit(status.exitstatus)
+      RUBY
+    end
+
+    it "runs exec inside with_original_env" do
+      skip "Fork not implemented" if Gem.win_platform?
+
+      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
+      expect($?.exitstatus).to eq(0)
+    end
+  end
+
+  describe "Bundler.clean_exec", bundler: 2 do
+    before do
+      create_file("source.rb", <<-'RUBY')
+        Process.fork do
+          exit Bundler.ui.silence { Bundler.clean_exec(%(test "\$BUNDLE_FOO" = "bar")) }
+        end
+
+        _, status = Process.wait2
+
+        exit(status.exitstatus)
+      RUBY
+    end
+
+    it "runs exec inside with_clean_env" do
+      skip "Fork not implemented" if Gem.win_platform?
+
+      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
+      expect($?.exitstatus).to eq(1)
+    end
+  end
+
+  describe "Bundler.unbundled_exec" do
+    before do
+      create_file("source.rb", <<-'RUBY')
+        Process.fork do
+          exit Bundler.unbundled_exec(%(test "\$BUNDLE_FOO" = "bar"))
+        end
+
+        _, status = Process.wait2
+
+        exit(status.exitstatus)
+      RUBY
+    end
+
+    it "runs exec inside with_clean_env" do
+      skip "Fork not implemented" if Gem.win_platform?
+
+      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
+      expect($?.exitstatus).to eq(1)
+    end
+  end
+end
diff --git a/spec/bundler/runtime/with_unbundled_env_spec.rb b/spec/bundler/runtime/with_unbundled_env_spec.rb
deleted file mode 100644
index 4662fdad5a..0000000000
--- a/spec/bundler/runtime/with_unbundled_env_spec.rb
+++ /dev/null
@@ -1,307 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "Bundler.with_env helpers" do
-  def bundle_exec_ruby(args, options = {})
-    build_bundler_context options.dup
-    bundle "exec '#{Gem.ruby}' #{args}", options
-  end
-
-  def build_bundler_context(options = {})
-    bundle "config set path vendor/bundle", options.dup
-    gemfile "source 'https://gem.repo1'"
-    bundle "install", options
-  end
-
-  def run_bundler_script(env, script)
-    system(env, "ruby", "-I#{lib_dir}", "-rbundler", script.to_s)
-  end
-
-  describe "Bundler.original_env" do
-    it "should return the PATH present before bundle was activated" do
-      create_file("source.rb", <<-RUBY)
-        print Bundler.original_env["PATH"]
-      RUBY
-      path = `getconf PATH`.strip + "#{File::PATH_SEPARATOR}/foo"
-      with_path_as(path) do
-        bundle_exec_ruby(bundled_app("source.rb").to_s)
-        expect(last_command.stdboth).to eq(path)
-      end
-    end
-
-    it "should return the GEM_PATH present before bundle was activated" do
-      create_file("source.rb", <<-RUBY)
-        print Bundler.original_env['GEM_PATH']
-      RUBY
-      gem_path = ENV["GEM_PATH"] + "#{File::PATH_SEPARATOR}/foo"
-      with_gem_path_as(gem_path) do
-        bundle_exec_ruby(bundled_app("source.rb").to_s)
-        expect(last_command.stdboth).to eq(gem_path)
-      end
-    end
-
-    it "works with nested bundle exec invocations", :ruby_repo do
-      create_file("exe.rb", <<-'RUBY')
-        count = ARGV.first.to_i
-        exit if count < 0
-        STDERR.puts "#{count} #{ENV["PATH"].end_with?("#{File::PATH_SEPARATOR}/foo")}"
-        if count == 2
-          ENV["PATH"] = "#{ENV["PATH"]}#{File::PATH_SEPARATOR}/foo"
-        end
-        exec(Gem.ruby, __FILE__, (count - 1).to_s)
-      RUBY
-      path = `getconf PATH`.strip + File::PATH_SEPARATOR + File.dirname(Gem.ruby)
-      with_path_as(path) do
-        build_bundler_context
-        bundle_exec_ruby("#{bundled_app("exe.rb")} 2")
-      end
-      expect(err).to eq <<-EOS.strip
-2 false
-1 true
-0 true
-      EOS
-    end
-
-    it "removes variables that bundler added", :ruby_repo do
-      # Simulate bundler has not yet been loaded
-      ENV.replace(ENV.to_hash.delete_if {|k, _v| k.start_with?(Bundler::EnvironmentPreserver::BUNDLER_PREFIX) })
-
-      original = ruby('puts ENV.to_a.map {|e| e.join("=") }.sort.join("\n")', artifice: "fail")
-      create_file("source.rb", <<-RUBY)
-        puts Bundler.original_env.to_a.map {|e| e.join("=") }.sort.join("\n")
-      RUBY
-      bundle_exec_ruby bundled_app("source.rb"), artifice: "fail"
-      expect(out).to eq original
-    end
-  end
-
-  shared_examples_for "an unbundling helper" do
-    it "should delete BUNDLE_PATH" do
-      create_file("source.rb", <<-RUBY)
-        print #{modified_env}.has_key?('BUNDLE_PATH')
-      RUBY
-      ENV["BUNDLE_PATH"] = "./foo"
-      bundle_exec_ruby bundled_app("source.rb")
-      expect(last_command.stdboth).to include "false"
-    end
-
-    it "should remove absolute path to 'bundler/setup' from RUBYOPT even if it was present in original env" do
-      create_file("source.rb", <<-RUBY)
-        print #{modified_env}['RUBYOPT']
-      RUBY
-      setup_require = "-r#{lib_dir}/bundler/setup"
-      ENV["BUNDLER_ORIG_RUBYOPT"] = "-W2 #{setup_require} #{ENV["RUBYOPT"]}"
-      bundle_exec_ruby bundled_app("source.rb")
-      expect(last_command.stdboth).not_to include(setup_require)
-    end
-
-    it "should remove relative path to 'bundler/setup' from RUBYOPT even if it was present in original env" do
-      create_file("source.rb", <<-RUBY)
-        print #{modified_env}['RUBYOPT']
-      RUBY
-      ENV["BUNDLER_ORIG_RUBYOPT"] = "-W2 -rbundler/setup #{ENV["RUBYOPT"]}"
-      bundle_exec_ruby bundled_app("source.rb")
-      expect(last_command.stdboth).not_to include("-rbundler/setup")
-    end
-
-    it "should delete BUNDLER_SETUP even if it was present in original env" do
-      create_file("source.rb", <<-RUBY)
-        print #{modified_env}.has_key?('BUNDLER_SETUP')
-      RUBY
-      ENV["BUNDLER_ORIG_BUNDLER_SETUP"] = system_gem_path("gems/bundler-#{Bundler::VERSION}/lib/bundler/setup").to_s
-      bundle_exec_ruby bundled_app("source.rb")
-      expect(last_command.stdboth).to include "false"
-    end
-
-    it "should restore RUBYLIB", :ruby_repo do
-      create_file("source.rb", <<-RUBY)
-        print #{modified_env}['RUBYLIB']
-      RUBY
-      ENV["RUBYLIB"] = lib_dir.to_s + File::PATH_SEPARATOR + "/foo"
-      ENV["BUNDLER_ORIG_RUBYLIB"] = lib_dir.to_s + File::PATH_SEPARATOR + "/foo-original"
-      bundle_exec_ruby bundled_app("source.rb")
-      expect(last_command.stdboth).to include("/foo-original")
-    end
-
-    it "should restore the original MANPATH" do
-      create_file("source.rb", <<-RUBY)
-        print #{modified_env}['MANPATH']
-      RUBY
-      ENV["MANPATH"] = "/foo"
-      ENV["BUNDLER_ORIG_MANPATH"] = "/foo-original"
-      bundle_exec_ruby bundled_app("source.rb")
-      expect(last_command.stdboth).to include("/foo-original")
-    end
-  end
-
-  describe "Bundler.unbundled_env" do
-    let(:modified_env) { "Bundler.unbundled_env" }
-
-    it_behaves_like "an unbundling helper"
-  end
-
-  describe "Bundler.clean_env", bundler: 2 do
-    let(:modified_env) { "Bundler.clean_env" }
-
-    it_behaves_like "an unbundling helper"
-  end
-
-  describe "Bundler.with_original_env" do
-    it "should set ENV to original_env in the block" do
-      expected = Bundler.original_env
-      actual = Bundler.with_original_env { ENV.to_hash }
-      expect(actual).to eq(expected)
-    end
-
-    it "should restore the environment after execution" do
-      Bundler.with_original_env do
-        ENV["FOO"] = "hello"
-      end
-
-      expect(ENV).not_to have_key("FOO")
-    end
-  end
-
-  describe "Bundler.with_clean_env", bundler: 2 do
-    it "should set ENV to unbundled_env in the block" do
-      expected = Bundler.unbundled_env
-
-      actual = Bundler.ui.silence do
-        Bundler.with_clean_env { ENV.to_hash }
-      end
-
-      expect(actual).to eq(expected)
-    end
-
-    it "should restore the environment after execution" do
-      Bundler.ui.silence do
-        Bundler.with_clean_env { ENV["FOO"] = "hello" }
-      end
-
-      expect(ENV).not_to have_key("FOO")
-    end
-  end
-
-  describe "Bundler.with_unbundled_env" do
-    it "should set ENV to unbundled_env in the block" do
-      expected = Bundler.unbundled_env
-      actual = Bundler.with_unbundled_env { ENV.to_hash }
-      expect(actual).to eq(expected)
-    end
-
-    it "should restore the environment after execution" do
-      Bundler.with_unbundled_env do
-        ENV["FOO"] = "hello"
-      end
-
-      expect(ENV).not_to have_key("FOO")
-    end
-  end
-
-  describe "Bundler.original_system" do
-    before do
-      create_file("source.rb", <<-'RUBY')
-        Bundler.original_system("ruby", "-e", "exit(42) if ENV['BUNDLE_FOO'] == 'bar'")
-
-        exit $?.exitstatus
-      RUBY
-    end
-
-    it "runs system inside with_original_env" do
-      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
-      expect($?.exitstatus).to eq(42)
-    end
-  end
-
-  describe "Bundler.clean_system", bundler: 2 do
-    before do
-      create_file("source.rb", <<-'RUBY')
-        Bundler.ui.silence { Bundler.clean_system("ruby", "-e", "exit(42) unless ENV['BUNDLE_FOO'] == 'bar'") }
-
-        exit $?.exitstatus
-      RUBY
-    end
-
-    it "runs system inside with_clean_env" do
-      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
-      expect($?.exitstatus).to eq(42)
-    end
-  end
-
-  describe "Bundler.unbundled_system" do
-    before do
-      create_file("source.rb", <<-'RUBY')
-        Bundler.unbundled_system("ruby", "-e", "exit(42) unless ENV['BUNDLE_FOO'] == 'bar'")
-
-        exit $?.exitstatus
-      RUBY
-    end
-
-    it "runs system inside with_unbundled_env" do
-      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
-      expect($?.exitstatus).to eq(42)
-    end
-  end
-
-  describe "Bundler.original_exec" do
-    before do
-      create_file("source.rb", <<-'RUBY')
-        Process.fork do
-          exit Bundler.original_exec(%(test "\$BUNDLE_FOO" = "bar"))
-        end
-
-        _, status = Process.wait2
-
-        exit(status.exitstatus)
-      RUBY
-    end
-
-    it "runs exec inside with_original_env" do
-      skip "Fork not implemented" if Gem.win_platform?
-
-      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
-      expect($?.exitstatus).to eq(0)
-    end
-  end
-
-  describe "Bundler.clean_exec", bundler: 2 do
-    before do
-      create_file("source.rb", <<-'RUBY')
-        Process.fork do
-          exit Bundler.ui.silence { Bundler.clean_exec(%(test "\$BUNDLE_FOO" = "bar")) }
-        end
-
-        _, status = Process.wait2
-
-        exit(status.exitstatus)
-      RUBY
-    end
-
-    it "runs exec inside with_clean_env" do
-      skip "Fork not implemented" if Gem.win_platform?
-
-      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
-      expect($?.exitstatus).to eq(1)
-    end
-  end
-
-  describe "Bundler.unbundled_exec" do
-    before do
-      create_file("source.rb", <<-'RUBY')
-        Process.fork do
-          exit Bundler.unbundled_exec(%(test "\$BUNDLE_FOO" = "bar"))
-        end
-
-        _, status = Process.wait2
-
-        exit(status.exitstatus)
-      RUBY
-    end
-
-    it "runs exec inside with_clean_env" do
-      skip "Fork not implemented" if Gem.win_platform?
-
-      run_bundler_script({ "BUNDLE_FOO" => "bar" }, bundled_app("source.rb"))
-      expect($?.exitstatus).to eq(1)
-    end
-  end
-end
-- 
cgit v1.2.3