Align single-ABI packaging with rake-compiler API

Author: Gira Chawda

.github/actions/cibuildgem/action.yml

@@ -54,7 +54,7 @@ runs:
         path: |
           ${{ inputs.working-directory }}/tmp/**/*.so
           ${{ inputs.working-directory }}/tmp/**/*.bundle
-          ${{ inputs.working-directory }}/pkg/**/*.gem
+          ${{ inputs.working-directory }}/pkg/*.gem
         if-no-files-found: error
         retention-days: 1
     - name: "Download compiled binaries"
@@ -68,13 +68,22 @@ runs:
       working-directory: ${{ inputs.working-directory }}
       shell: bash
       run: |
-        ruby_abi="$(ruby -e 'print RUBY_VERSION.split(".").first(2).join(".")')"
-        single_abi_gems=(pkg/"${ruby_abi}"/*.gem)
-        if [[ ! -e "${single_abi_gems[0]}" ]]; then
-          echo "No single-ABI gem found for Ruby ${ruby_abi}" >&2
-          exit 1
-        fi
-        gem install "${single_abi_gems[@]}"
+        ruby <<'RUBY' > /tmp/single-abi-gems
+        require "rubygems/package"
+
+        ruby_abi = RUBY_VERSION.split(".").first(2).join(".")
+        expected_requirement = Gem::Requirement.new("~> #{ruby_abi}.0")
+        gems = Dir["pkg/*.gem"].select do |path|
+          spec = Gem::Package.new(path).spec
+          spec.platform != Gem::Platform::RUBY && spec.required_ruby_version == expected_requirement
+        end
+
+        abort "No single-ABI gem found for Ruby #{ruby_abi}" if gems.empty?
+
+        puts gems
+        RUBY
+
+        xargs gem install < /tmp/single-abi-gems
     - name: "Copy staging binary to the libdir"
       if: "${{ inputs.step == 'test_cross' }}"
       working-directory: ${{ inputs.working-directory }}
@@ -110,8 +119,8 @@ runs:
     - name: "Push the gems to RubyGems"
       if: "${{ inputs.step == 'release' }}"
       shell: bash
-      run: cibuildgem release --glob "pkg/**/*.gem"
+      run: cibuildgem release --glob "pkg/*"
     - name: "Waiting for RubyGems to fully index the new gems"
       if: "${{ inputs.step == 'release' }}"
       shell: bash
-      run: find pkg -type f -name '*.gem' -exec gem exec rubygems-await {} +
+      run: gem exec rubygems-await pkg/*.gem

lib/cibuildgem/cli.rb

@@ -49,17 +49,8 @@ def compile
     method_option "include-single-abi", type: :boolean, required: false, default: false, desc: "Whether to also compile a set of single-ABI gems. Defaults to false."
     def package
       ENV["RUBY_CC_VERSION"] ||= compilation_task.ruby_cc_version
-      run_rake_tasks!("cibuildgem:setup", :cross, :native, :gem)
-      if options["include-single-abi"] == true
-        compilation_task.ruby_versions.each do |ruby_version|
-          ENV["RUBY_CC_VERSION"] = ruby_version.to_s
-          run_rake_tasks!("cibuildgem:setup", :cross, :native, :gem)
-
-          ruby_abi = ruby_version.segments.first(2).join(".")
-          next if Dir.glob(File.join("pkg", ruby_abi, "*.gem")).any?
-
-          raise "Could not build a single-ABI gem for Ruby #{ruby_abi}. Ensure RubyGems and rake-compiler support content-addressable gems."
-        end
+      with_content_addressable_packaging(options["include-single-abi"] == true) do
+        run_rake_tasks!("cibuildgem:setup", :cross, :native, :gem)
       end
     end
 
@@ -151,6 +142,19 @@ def print_normalized_platform
 
     private
 
+    def with_content_addressable_packaging(enabled)
+      previous = ENV[CompilationTasks::CONTENT_ADDRESSABLE_ENV]
+      ENV[CompilationTasks::CONTENT_ADDRESSABLE_ENV] = enabled ? "true" : "false"
+
+      yield
+    ensure
+      if previous.nil?
+        ENV.delete(CompilationTasks::CONTENT_ADDRESSABLE_ENV)
+      else
+        ENV[CompilationTasks::CONTENT_ADDRESSABLE_ENV] = previous
+      end
+    end
+
     def run_rake_tasks!(*tasks)
       all_tasks = tasks.join(" ")
       rakelibdir = [File.expand_path("tasks", __dir__), "rakelib"].join(File::PATH_SEPARATOR)

lib/cibuildgem/compilation_tasks.rb

@@ -7,13 +7,20 @@
 
 module Cibuildgem
   class CompilationTasks
-    attr_reader :gemspec, :native, :create_packaging_task, :extension_task
+    CONTENT_ADDRESSABLE_ENV = "CIBUILDGEM_CONTENT_ADDRESSABLE"
 
-    def initialize(create_packaging_task = false, gemspec = nil)
+    attr_reader :gemspec, :native, :create_packaging_task, :extension_task, :content_addressable
+
+    def initialize(
+      create_packaging_task = false,
+      gemspec = nil,
+      content_addressable: ENV[CONTENT_ADDRESSABLE_ENV] == "true"
+    )
       @gemspec = Bundler.load_gemspec(gemspec || find_gemspec)
       verify_gemspec!
 
       @create_packaging_task = create_packaging_task
+      @content_addressable = content_addressable
     end
 
     def setup
@@ -25,13 +32,11 @@ def setup
       setup_packaging if create_packaging_task
     end
 
-    def ruby_versions
+    def ruby_cc_version
       required_ruby_version = @gemspec.required_ruby_version
-      RubySeries.versions_to_compile_against(required_ruby_version)
-    end
+      selected_rubies = RubySeries.versions_to_compile_against(required_ruby_version)
 
-    def ruby_cc_version
-      ruby_versions.map(&:to_s).join(":")
+      selected_rubies.map(&:to_s).join(":")
     end
 
     def normalized_platform
@@ -47,9 +52,6 @@ def normalized_platform
     private
 
     def setup_packaging
-      # Creates a Gem::PackageTask for the ordinary Ruby gem.
-      # Elsewhere in rake-compiler we also create one for the compiled gem.
-      # Internally in PackageTask, we define the :gem rake task which calls Gem::Package.build.
       Gem::PackageTask.new(gemspec) do |pkg|
         pkg.need_zip = true
         pkg.need_tar = true
@@ -67,6 +69,14 @@ def define_task(path, binary_name)
       @extension_task.cross_platform = normalized_platform
       @extension_task.cross_compile = true
       @extension_task.no_native = true
+      if content_addressable
+        if @extension_task.respond_to?(:content_addressable=)
+          @extension_task.content_addressable = true
+        else
+          warn "WARNING: content-addressable packaging was requested, but rake-compiler does not support it. " \
+            "Upgrade rake-compiler to build single-ABI gems."
+        end
+      end
 
       Rake::ExtensionTask.enable!
       @extension_task.define

test/cli_test.rb

@@ -6,6 +6,8 @@
 
 module Cibuildgem
   class CLITest < Minitest::Test
+    TEST_CONTENT_ADDRESSABLE_ENV = "CIBUILDGEM_CONTENT_ADDRESSABLE"
+
     def setup
       super
 
@@ -14,6 +16,7 @@ def setup
 
     def teardown
       ENV.delete("RUBY_CC_VERSION")
+      ENV.delete(TEST_CONTENT_ADDRESSABLE_ENV)
 
       super
     end
@@ -303,69 +306,42 @@ def test_package_when_a_rakefile_defines_an_extension_task
       assert_predicate($CHILD_STATUS, :success?)
     end
 
-    def test_package_single_abi_runs_rake_tasks_for_each_ruby_version
+    def test_package_single_abi_enables_content_addressable_packaging_for_one_rake_run
       cli = CLI.new([], { "include-single-abi" => true })
-      compilation_task = Struct.new(:ruby_cc_version, :ruby_versions).new("3.3.8:3.2.8", [
-        Gem::Version.new("3.3.8"),
-        Gem::Version.new("3.2.8"),
-      ])
+      compilation_task = Struct.new(:ruby_cc_version).new("3.3.8:3.2.8")
       rake_calls = []
-      gem_globs = []
       run_rake_tasks = proc do |*tasks|
-        rake_calls << [ENV.fetch("RUBY_CC_VERSION"), tasks]
-      end
-      find_built_gems = proc do |glob|
-        gem_globs << glob
-        [glob.sub("*", "built")]
+        rake_calls << [
+          ENV.fetch("RUBY_CC_VERSION"),
+          ENV.fetch(TEST_CONTENT_ADDRESSABLE_ENV),
+          tasks,
+        ]
       end
 
       cli.stub(:compilation_task, compilation_task) do
         cli.stub(:run_rake_tasks!, run_rake_tasks) do
-          Dir.stub(:glob, find_built_gems) do
-            cli.package
-          end
+          cli.package
         end
       end
 
-      expected_tasks = ["cibuildgem:setup", :cross, :native, :gem]
       assert_equal(
-        [
-          ["3.3.8:3.2.8", expected_tasks],
-          ["3.3.8", expected_tasks],
-          ["3.2.8", expected_tasks],
-        ],
+        [["3.3.8:3.2.8", "true", ["cibuildgem:setup", :cross, :native, :gem]]],
         rake_calls,
       )
-      assert_equal(["pkg/3.3/*.gem", "pkg/3.2/*.gem"], gem_globs)
+      assert_nil(ENV[TEST_CONTENT_ADDRESSABLE_ENV])
     end
 
-    def test_package_single_abi_fails_when_no_single_abi_gem_is_built
-      cli = CLI.new([], { "include-single-abi" => true })
-      compilation_task = Struct.new(:ruby_cc_version, :ruby_versions).new(
-        "3.3.8",
-        [Gem::Version.new("3.3.8")],
-      )
-
-      error = cli.stub(:compilation_task, compilation_task) do
-        cli.stub(:run_rake_tasks!, nil) do
-          Dir.stub(:glob, []) do
-            assert_raises(RuntimeError) { cli.package }
-          end
-        end
-      end
-
-      assert_equal(
-        "Could not build a single-ABI gem for Ruby 3.3. Ensure RubyGems and rake-compiler support content-addressable gems.",
-        error.message,
-      )
-    end
-
-    def test_package_defaults_to_multi_abi
+    def test_package_defaults_to_multi_abi_and_preserves_ruby_cc_version_from_environment
+      ENV["RUBY_CC_VERSION"] = "3.1.6"
       cli = CLI.new
       compilation_task = Struct.new(:ruby_cc_version).new("3.3.8:3.2.8")
       rake_calls = []
       run_rake_tasks = proc do |*tasks|
-        rake_calls << [ENV.fetch("RUBY_CC_VERSION"), tasks]
+        rake_calls << [
+          ENV.fetch("RUBY_CC_VERSION"),
+          ENV.fetch(TEST_CONTENT_ADDRESSABLE_ENV),
+          tasks,
+        ]
       end
 
       cli.stub(:compilation_task, compilation_task) do
@@ -375,27 +351,56 @@ def test_package_defaults_to_multi_abi
       end
 
       assert_equal(
-        [["3.3.8:3.2.8", ["cibuildgem:setup", :cross, :native, :gem]]],
+        [["3.1.6", "false", ["cibuildgem:setup", :cross, :native, :gem]]],
         rake_calls,
       )
     end
 
-    def test_package_multi_abi_preserves_ruby_cc_version_from_environment
-      ENV["RUBY_CC_VERSION"] = "3.1.6"
-      cli = CLI.new
-      compilation_task = Struct.new(:ruby_cc_version).new("3.3.8:3.2.8")
-      ruby_cc_versions_used = []
-      run_rake_tasks = proc do |*|
-        ruby_cc_versions_used << ENV.fetch("RUBY_CC_VERSION")
+    def test_compilation_task_enables_content_addressable_extension_task
+      require "cibuildgem/extension_patch"
+
+      extension_task = Class.new do
+        attr_accessor :config_script, :content_addressable, :cross_compile, :cross_platform, :ext_dir, :gem_spec,
+          :lib_dir, :name, :no_native
+
+        def define; end
+      end.new
+      original_current = Rake::ExtensionTask.current
+
+      Dir.chdir("test/fixtures/with_ext") do
+        Rake::ExtensionTask.current = extension_task
+        CompilationTasks.new(false, nil, content_addressable: true).setup
       end
 
-      cli.stub(:compilation_task, compilation_task) do
-        cli.stub(:run_rake_tasks!, run_rake_tasks) do
-          cli.package
+      assert_equal(true, extension_task.content_addressable)
+    ensure
+      Rake::ExtensionTask.current = original_current if Rake::ExtensionTask.respond_to?(:current=)
+      Rake::Task.clear
+    end
+
+    def test_compilation_task_warns_when_rake_compiler_does_not_support_content_addressable
+      require "cibuildgem/extension_patch"
+
+      extension_task = Class.new do
+        attr_accessor :config_script, :cross_compile, :cross_platform, :ext_dir, :gem_spec,
+          :lib_dir, :name, :no_native
+
+        def define; end
+      end.new
+      original_current = Rake::ExtensionTask.current
+
+      _, err = capture_io do
+        Dir.chdir("test/fixtures/with_ext") do
+          Rake::ExtensionTask.current = extension_task
+          CompilationTasks.new(false, nil, content_addressable: true).setup
         end
       end
 
-      assert_equal(["3.1.6"], ruby_cc_versions_used)
+      assert_includes(err, "content-addressable packaging was requested")
+      assert_includes(err, "Upgrade rake-compiler")
+    ensure
+      Rake::ExtensionTask.current = original_current if Rake::ExtensionTask.respond_to?(:current=)
+      Rake::Task.clear
     end
 
     def test_keep_the_extension_task_config_defined_by_the_gem