Impl GoGem::RakeTask

Author: sue445

_gem/lib/go_gem/rake_task.rb

@@ -0,0 +1,112 @@
+require "rake"
+require "rake/tasklib"
+
+module GoGem
+  # Provides rake tasks for `go test` with CRuby
+  #
+  # @example Without config
+  #   # Rakefile
+  #   require "go_gem/rake_task"
+  #
+  #   GoGem::RakeTask.new("gem_name")
+  #
+  # @example With config
+  #   # Rakefile
+  #   require "go_gem/rake_task"
+  #
+  #   GoGem::RakeTask.new("gem_name") do |config|
+  #     config.task_namespace = "go5"
+  #     config.go_bin_path = "/path/to/go"
+  #     config.go_test_args = "#{GoGem::RakeTask::DEFAULT_GO_TEST_ARGS} -race"
+  #   end
+  class RakeTask < ::Rake::TaskLib
+    # @!attribute [r] gem_name
+    # @return [String]
+    attr_reader :gem_name
+
+    # @!attribute task_namespace
+    #   @return [Symbol] task namespace (default: `:go`)
+    attr_accessor :task_namespace
+
+    # @!attribute go_bin_path
+    #   @return [String] path to go binary (default: `"go"`)
+    attr_accessor :go_bin_path
+
+    # @!attribute go_test_args
+    #   @return [String] argument passed to `go test` (default: `"-mod=readonly -count=1"`)
+    attr_accessor :go_test_args
+
+    # @param gem_name [String]
+    # @yield configuration of {RakeTask}
+    # @yieldparam config [RakeTask]
+    def initialize(gem_name)
+      super()
+
+      @gem_name = gem_name
+
+      @task_namespace = :go
+      @go_bin_path = "go"
+      @go_test_args = "-mod=readonly -count=1"
+
+      yield(self) if block_given?
+
+      namespace(task_namespace) do
+        desc "Run go test"
+        task(:test) do
+          within_ext_dir do
+            sh RakeTask.build_env_vars, "#{go_bin_path} test #{go_test_args} ./..."
+          end
+        end
+      end
+    end
+
+    # Generate environment variables to build go programs in the Go gem
+    #
+    # @return [Hash<String, String>]
+    def self.build_env_vars
+      ldflags = "-L#{RbConfig::CONFIG["libdir"]} -l#{RbConfig::CONFIG["RUBY_SO_NAME"]}"
+
+      case `#{RbConfig::CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
+      when /Free Software Foundation/
+        ldflags << " -Wl,--unresolved-symbols=ignore-all"
+      when /clang/
+        ldflags << " -undefined dynamic_lookup"
+      end
+
+      cflags = "#{RbConfig::CONFIG["CFLAGS"]} -I#{RbConfig::CONFIG["rubyarchhdrdir"]} -I#{RbConfig::CONFIG["rubyhdrdir"]}"
+
+      # FIXME: Workaround for GitHub Actions
+      if ENV["GITHUB_ACTIONS"]
+        cflags.gsub!("-Wno-self-assign", "")
+        cflags.gsub!("-Wno-parentheses-equality", "")
+        cflags.gsub!("-Wno-constant-logical-operand", "")
+        cflags.gsub!("-Wsuggest-attribute=format", "")
+        cflags.gsub!("-Wold-style-definition", "")
+        cflags.gsub!("-Wsuggest-attribute=noreturn", "")
+        ldflags.gsub!("-Wl,--unresolved-symbols=ignore-all", "")
+      end
+
+      ld_library_path = RbConfig::CONFIG["libdir"]
+
+      {
+        "CGO_CFLAGS"      => cflags,
+        "CGO_LDFLAGS"     => ldflags,
+        "LD_LIBRARY_PATH" => ld_library_path,
+      }
+    end
+
+    private
+
+    # @yield
+    def within_ext_dir
+      Dir.chdir(ext_dir) do
+        yield
+      end
+    end
+
+    # @return [String]
+    def ext_dir
+      File.join("ext", gem_name)
+    end
+  end
+end

_gem/spec/go_gem/rake_task_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe GoGem::RakeTask do
+  before { Rake::Task.clear }
+
+  after { Rake::Task.clear }
+
+  describe "defining tasks" do
+    context "with default params" do
+      let(:gem_name) { "my_gem" }
+
+      subject do
+        GoGem::RakeTask.new(gem_name)
+        Rake::Task
+      end
+
+      it { should be_task_defined("go:test") }
+    end
+  end
+end

_gem/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 require "go_gem"
 require "go_gem/mkmf"
+require "go_gem/rake_task"
 
 require "tmpdir"
 require "serverspec"