Merge pull request #14 from shopify-playground/ec-spec-task

Allow to run the test suite when rspec is used:

Author: Edouard-chin

.github/actions/easy_compile/action.yml

@@ -70,7 +70,7 @@ runs:
       if: "${{ startsWith(inputs.step, 'test') }}"
       working-directory: ${{ inputs.working-directory }}
       shell: bash
-      run: bundle exec rake test # TODO This should be configurable
+      run: easy_compile test # TODO This should be configurable
     - name: "Download tarball for platform"
       if: "${{ inputs.step == 'install' }}"
       uses: actions/download-artifact@v5

lib/easy_compile/cli.rb

@@ -25,7 +25,7 @@ def self.exit_on_failure?
       to the compilation.
     MSG
     def compile
-      run_rake_tasks!(:compile)
+      run_rake_tasks!("easy_compile:setup", :compile)
     end
 
     desc "package", "Compile and package a 'fat gem'.", hide: true
@@ -44,12 +44,20 @@ def compile
     def package
       ENV["RUBY_CC_VERSION"] ||= compilation_task.ruby_cc_version
 
-      run_rake_tasks!(:cross, :native, :gem)
+      run_rake_tasks!("easy_compile:setup", :cross, :native, :gem)
+    end
+
+    desc "test", "Run the test suites of the target gem"
+    long_desc <<~EOM
+      EasyCompile will run the test suite of the gem. It either expects a `spec` or `test` task defined.
+    EOM
+    def test
+      run_rake_tasks!(:test)
     end
 
     desc "copy_from_staging_to_lib", "Copy the staging binary. For internal usage.", hide: true
     def copy_from_staging_to_lib
-      run_rake_tasks!("copy:stage:lib")
+      run_rake_tasks!("easy_compile:setup", "copy:stage:lib")
     end
 
     desc "clean", "Cleanup temporary compilation artifacts."
@@ -60,7 +68,7 @@ def copy_from_staging_to_lib
       to cleanup by adding files to the vanilla CLEAN rake list.
     MSG
     def clean
-      run_rake_tasks!(:clean)
+      run_rake_tasks!("easy_compile:setup", :clean)
     end
 
     desc "clobber", "Remove compiled binaries."
@@ -71,7 +79,7 @@ def clean
       to remove by adding files to the vanilla CLOBBER rake list.
     MSG
     def clobber
-      run_rake_tasks!(:clobber)
+      run_rake_tasks!("easy_compile:setup", :clobber)
     end
 
     desc "ci_template", "Generate CI template files."

lib/easy_compile/tasks/wrapper.rake

@@ -3,7 +3,10 @@
 require_relative "../compilation_tasks"
 
 task = EasyCompile::CompilationTasks.new(!Rake::Task.task_defined?(:package))
-task.setup
+
+task "easy_compile:setup" do
+  task.setup
+end
 
 task "copy:stage:lib" do
   version = RUBY_VERSION.match(/(\d\.\d)/)[1]
@@ -12,3 +15,11 @@ task "copy:stage:lib" do
 
   cp_r(src, dest, remove_destination: true)
 end
+
+unless Rake::Task.task_defined?(:test)
+  task(:test) do
+    raise(RuntimeError, "Don't know how to build task 'test'") unless Rake::Task.task_defined?(:spec)
+
+    Rake::Task[:spec].invoke
+  end
+end

test/cli_test.rb

@@ -150,6 +150,40 @@ def test_when_cli_runs_in_project_with_no_native_extension
       MSG
     end
 
+    def test_cli_test_command_when_a_test_rake_task_is_defined
+      out = nil
+
+      Dir.chdir("test/fixtures/test_task_defined") do
+        out, _ = capture_subprocess_io do
+          CLI.start(["test"])
+        end
+      end
+
+      assert_equal("The test task was called.", out)
+    end
+
+    def test_cli_test_command_when_a_spec_rake_task_is_defined
+      out = nil
+
+      Dir.chdir("test/fixtures/spec_task_defined") do
+        out, _ = capture_subprocess_io do
+          CLI.start(["test"])
+        end
+      end
+
+      assert_equal("The spec task was called.", out)
+    end
+
+    def test_cli_test_command_when_no_test_or_spec_rake_task_is_defined
+      Dir.chdir("test/fixtures/no_test_task_defined") do
+        capture_subprocess_io do
+          assert_raises(RuntimeError) do
+            CLI.start(["test"])
+          end
+        end
+      end
+    end
+
     private
 
     def raise_instead_of_exit(&block)

test/fixtures/no_test_task_defined/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "foo"
+  spec.version = '0.0.1'
+  spec.authors = ["John Doe"]
+  spec.email = ["john@example.com"]
+
+  spec.summary = "Not important"
+  spec.description = "Not important"
+  spec.homepage = "https://github.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.files = []
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/foo.rb"]
+end

test/fixtures/no_test_task_defined/foo.gemspec

@@ -0,0 +1,3 @@
+task :spec do
+  print "The spec task was called."
+end

test/fixtures/spec_task_defined/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "foo"
+  spec.version = '0.0.1'
+  spec.authors = ["John Doe"]
+  spec.email = ["john@example.com"]
+
+  spec.summary = "Not important"
+  spec.description = "Not important"
+  spec.homepage = "https://github.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.files = []
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/foo.rb"]
+end

test/fixtures/spec_task_defined/foo.gemspec

@@ -0,0 +1,3 @@
+task :test do
+  print "The test task was called."
+end

test/fixtures/test_task_defined/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "foo"
+  spec.version = '0.0.1'
+  spec.authors = ["John Doe"]
+  spec.email = ["john@example.com"]
+
+  spec.summary = "Not important"
+  spec.description = "Not important"
+  spec.homepage = "https://github.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.files = []
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/foo.rb"]
+end