wip test fix against CI

alexcrocha · alexcrocha · commit 3540c7c9f6e1 · 2025-01-22T13:42:42.000-08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -71,7 +71,7 @@ jobs:
           bundler-cache: true
           rubygems: ${{ matrix.rubygems }}
       - name: Run tests
-        run: bin/test
+        run: bin/test spec/tapioca/ruby_lsp/run_gem_rbi_check_spec.rb --seed 13598
         continue-on-error: ${{ !!matrix.experimental }}
 
   buildall:
diff --git a/lib/ruby_lsp/tapioca/run_gem_rbi_check.rb b/lib/ruby_lsp/tapioca/run_gem_rbi_check.rb
@@ -27,7 +27,9 @@ def initialize
       sig { params(project_path: String).returns(GemRbiCheckResult) }
       def run(project_path = ".")
         FileUtils.chdir(project_path) do
+          $stderr.puts "Inside Run Method"
           if git_repo?
+            $stderr.puts "Inside git_repo? Check"
             lockfile_changed? ? generate_gem_rbis : cleanup_orphaned_rbis
           else
             log_message("Not a git repository")
@@ -49,25 +51,30 @@ def git_repo?
 
       sig { returns(T::Boolean) }
       def lockfile_changed?
+        $stdout.puts "Inside lockfile_changed? Method"
         fetch_lockfile_diff
-        !T.must(@lockfile_diff).empty?
+        $stdout.puts "fetch_lockfile_diff = #{fetch_lockfile_diff}"
+        !@lockfile_diff.empty?
       end
 
       sig { returns(String) }
       def fetch_lockfile_diff
-        @lockfile_diff = %x(git diff HEAD Gemfile.lock).strip
+        @lockfile_diff = File.exist?("Gemfile.lock") ? %x(git diff Gemfile.lock).strip : ""
       end
 
       sig { void }
       def generate_gem_rbis
+        $stdout.puts "Inside generate_gem_rbis Method"
         parser = Tapioca::LockfileDiffParser.new(@lockfile_diff)
         removed_gems = parser.removed_gems
         added_or_modified_gems = parser.added_or_modified_gems
 
         if added_or_modified_gems.any?
+          $stdout.puts "Inside if added_or_modified_gems.any? Check"
           log_message("Identified lockfile changes, attempting to generate gem RBIs...")
           execute_tapioca_gem_command(added_or_modified_gems)
         elsif removed_gems.any?
+          $stdout.puts "Inside elsif removed_gems.any? Check"
           remove_rbis(removed_gems)
         end
       end
@@ -77,7 +84,9 @@ def execute_tapioca_gem_command(gems)
         # Resetting BUNDLE_GEMFILE to root folder to use the project's Gemfile instead of Ruby LSP's composed Gemfile
         stdout, stderr, status = T.unsafe(Open3).capture3(
           { "BUNDLE_GEMFILE" => "Gemfile" },
-          "bin/tapioca",
+          "bundle",
+          "exec",
+          "tapioca",
           "gem",
           "--lsp_addon",
           *gems,
@@ -96,27 +105,33 @@ def remove_rbis(gems)
 
       sig { void }
       def cleanup_orphaned_rbis
+        $stdout.puts "Inside cleanup_orphaned_rbis Method"
         untracked_files = %x(git ls-files --others --exclude-standard sorbet/rbi/gems/).lines.map(&:strip)
         deleted_files = %x(git ls-files --deleted sorbet/rbi/gems/).lines.map(&:strip)
+        $stdout.puts "untracked_files = #{untracked_files}"
+        $stdout.puts "deleted_files = #{deleted_files}"
 
         delete_files(untracked_files, "Deleted untracked RBIs")
         restore_files(deleted_files, "Restored deleted RBIs")
       end
 
       sig { params(files: T::Array[String], message: String).void }
       def delete_files(files, message)
+        $stdout.puts "Inside delete_files Method"
         files.each { |file| File.delete(file) }
         log_message("#{message}: #{files.join(", ")}") unless files.empty?
       end
 
       sig { params(files: T::Array[String], message: String).void }
       def restore_files(files, message)
+        $stdout.puts "Inside restore_files Method"
         files.each { |file| %x(git checkout -- #{file}) }
         log_message("#{message}: #{files.join(", ")}") unless files.empty?
       end
 
       sig { params(message: String).void }
       def log_message(message)
+        $stderr.puts message
         @result.stdout += "#{message}\n"
       end
     end
diff --git a/spec/helpers/mock_gem.rb b/spec/helpers/mock_gem.rb
@@ -12,7 +12,7 @@ class MockGem < Spoom::Context
 
     # The gem's version string such as "1.0.0" or ">= 2.0.5"
     sig { returns(String) }
-    attr_reader :version
+    attr_accessor :version
 
     # The dependencies to be added to the gem's gemspec
     sig { returns(T::Array[String]) }
diff --git a/spec/spec_with_project.rb b/spec/spec_with_project.rb
@@ -84,6 +84,13 @@ def mock_gem(name, version, dependencies: [], path: default_gem_path(name), &blo
       gem
     end
 
+    sig { params(gem: MockGem, version: String).returns(MockGem) }
+    def update_gem(gem, version)
+      gem.version = version
+      gem.gemspec(gem.default_gemspec_contents)
+      gem
+    end
+
     # Spec assertions
 
     # Assert that the contents of `path` inside `@project` is equals to `expected`
diff --git a/spec/tapioca/ruby_lsp/run_gem_rbi_check_spec.rb b/spec/tapioca/ruby_lsp/run_gem_rbi_check_spec.rb
@@ -12,140 +12,134 @@ module Foo
         end
       RUBY
 
-      # TODO: understand why this fails with `before(:all)`
-      # before(:all) do
       before do
-        @project.tapioca("configure")
+        @project = mock_project
       end
 
       after do
-        project.write_gemfile!(project.tapioca_gemfile)
-        @project.require_default_gems
-        project.remove!("sorbet/rbi")
-        project.remove!("../gems")
-        project.remove!(".git")
-        project.remove!("sorbet/tapioca/require.rb")
-        project.remove!("config/application.rb")
-      ensure
-        @project.remove!("output")
+        @project.destroy!
       end
 
-      def setup_git_repo
-        @project.exec("git init")
-        @project.exec("touch Gemfile.lock")
-        FileUtils.mkdir_p("#{@project.absolute_path}/sorbet/rbi/gems")
-        @project.exec("git add . && git commit -m 'Initial commit'")
-      end
-
-      it "does nothing if there is no git repo" do
-        foo = mock_gem("foo", "0.0.1") do
-          write!("lib/foo.rb", FOO_RB)
+      describe "without git" do
+        before do
+          @project.bundle_install!
+          @project.tapioca("configure")
         end
-        @project.require_mock_gem(foo)
 
-        @project.bundle_install!
-        check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
-        check.run(@project.absolute_path)
-
-        assert check.result.stdout.include?("Not a git repository")
-      end
+        it "does nothing if there is no git repo" do
+          foo = mock_gem("foo", "0.0.1") do
+            write!("lib/foo.rb", FOO_RB)
+          end
+          @project.require_mock_gem(foo)
 
-      it "creates the RBI for a newly added gem" do
-        setup_git_repo
+          @project.bundle_install!
+          check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
+          check.run(@project.absolute_path)
 
-        foo = mock_gem("foo", "0.0.1") do
-          write!("lib/foo.rb", FOO_RB)
+          assert check.result.stdout.include?("Not a git repository")
         end
-        @project.require_mock_gem(foo)
-        @project.bundle_install!
-
-        check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
-        check.run(@project.absolute_path)
-
-        assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
       end
 
-      it "regenerates RBI when a gem version changes" do
-        setup_git_repo
-
-        foo = mock_gem("foo", "0.0.1") do
-          write!("lib/foo.rb", FOO_RB)
+      describe "with git" do
+        before do
+          @project.bundle_install!
+          @project.tapioca("configure")
+          @project.exec("git init")
+          @project.exec("git config commit.gpgsign false")
+          @project.exec("git add .")
+          @project.exec("git commit -m 'Initial commit'")
         end
-        @project.require_mock_gem(foo)
-        @project.bundle_install!
 
-        check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
-        check.run(@project.absolute_path)
+        it "creates the RBI for a newly added gem" do
+          foo = mock_gem("foo", "0.0.1") do
+            write!("lib/foo.rb", FOO_RB)
+          end
+          @project.require_mock_gem(foo)
+          @project.bundle_install!
 
-        assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
+          check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
+          check.run(@project.absolute_path)
 
-        # Modify the gem
-        foo = mock_gem("foo", "0.0.2") do
-          write!("lib/foo.rb", FOO_RB)
+          assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
         end
-        @project.require_mock_gem(foo)
-        @project.bundle_install!
 
-        check.run(@project.absolute_path)
+        it "regenerates RBI when a gem version changes" do
+          foo = mock_gem("foo", "0.0.1") do
+            write!("lib/foo.rb", FOO_RB)
+          end
+          @project.require_mock_gem(foo)
+          @project.bundle_install!
 
-        assert_project_file_exist("sorbet/rbi/gems/foo@0.0.2.rbi")
-      end
+          check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
+          check.run(@project.absolute_path)
 
-      it "removes RBI file when a gem is removed" do
-        setup_git_repo
+          assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
 
-        foo = mock_gem("foo", "0.0.1") do
-          write!("lib/foo.rb", FOO_RB)
-        end
-        @project.require_mock_gem(foo)
-        @project.bundle_install!
+          # Modify the gem
+          update_gem foo, "0.0.2"
+          @project.bundle_install!
+
+          check.run(@project.absolute_path)
 
-        check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
-        check.run(@project.absolute_path)
+          assert_project_file_exist("sorbet/rbi/gems/foo@0.0.2.rbi")
+        end
 
-        assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
+        it "removes RBI file when a gem is removed" do
+          foo = mock_gem("foo", "0.0.1") do
+            write!("lib/foo.rb", FOO_RB)
+          end
+          @project.require_mock_gem(foo)
+          @project.bundle_install!
 
-        @project.exec("git add Gemfile.lock")
-        @project.exec("git commit -m 'Add foo gem'")
+          check1 = ::RubyLsp::Tapioca::RunGemRbiCheck.new
+          check1.run(@project.absolute_path)
 
-        @project.write_gemfile!(@project.tapioca_gemfile)
-        @project.bundle_install!
+          assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
 
-        check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
-        check.run(@project.absolute_path)
+          @project.exec("git restore Gemfile Gemfile.lock")
 
-        refute_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
-      end
+          check2 = ::RubyLsp::Tapioca::RunGemRbiCheck.new
+          check2.run(@project.absolute_path)
 
-      it "deletes untracked RBI files" do
-        setup_git_repo
+          refute_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
+        end
 
-        # Create an untracked RBI file
-        FileUtils.touch("#{@project.absolute_path}/sorbet/rbi/gems/bar@0.0.1.rbi")
+        it "deletes untracked RBI files" do
+          $stdout.puts @project.exec("git log --oneline")
+          @project.bundle_install!
+          FileUtils.mkdir_p("#{@project.absolute_path}/sorbet/rbi/gems")
+          # Create an untracked RBI file
+          FileUtils.touch("#{@project.absolute_path}/sorbet/rbi/gems/bar@0.0.1.rbi")
 
-        assert_project_file_exist("/sorbet/rbi/gems/bar@0.0.1.rbi")
+          assert_project_file_exist("/sorbet/rbi/gems/bar@0.0.1.rbi")
 
-        check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
-        check.run(@project.absolute_path)
+          check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
+          check.run(@project.absolute_path)
 
-        refute_project_file_exist("sorbet/rbi/gems/bar@0.0.1.rbi")
-      end
+          refute_project_file_exist("sorbet/rbi/gems/bar@0.0.1.rbi")
+        end
 
-      it "restores deleted RBI files" do
-        setup_git_repo
+        it "restores deleted RBI files" do
+          @project.bundle_install!
+          FileUtils.mkdir_p("#{@project.absolute_path}/sorbet/rbi/gems")
+          # Create and delete a tracked RBI file
+          FileUtils.touch("#{@project.absolute_path}/sorbet/rbi/gems/foo@0.0.1.rbi")
+          @project.exec("git add sorbet/rbi/gems/foo@0.0.1.rbi")
+          @project.exec("git commit -m 'Add foo RBI'")
+          FileUtils.rm("#{@project.absolute_path}/sorbet/rbi/gems/foo@0.0.1.rbi")
+          $stdout.puts @project.exec("git log --oneline")
 
-        # Create and delete a tracked RBI file
-        FileUtils.touch("#{@project.absolute_path}/sorbet/rbi/gems/foo@0.0.1.rbi")
-        @project.exec("git add sorbet/rbi/gems/foo@0.0.1.rbi")
-        @project.exec("git commit -m 'Add foo RBI'")
-        FileUtils.rm("#{@project.absolute_path}/sorbet/rbi/gems/foo@0.0.1.rbi")
+          refute_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
 
-        refute_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
+          check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
+          check.run(@project.absolute_path)
 
-        check = ::RubyLsp::Tapioca::RunGemRbiCheck.new
-        check.run(@project.absolute_path)
+          assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
 
-        assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
+          # Clean-up commit
+          @project.exec("git reset --hard HEAD^")
+          $stdout.puts @project.exec("git log --oneline")
+        end
       end
     end
   end
