Make specs faster

Author: MatheusRich

spec/lib/rails/diff/rails_repo_spec.rb

@@ -1,7 +1,7 @@
 # Helper indices for commits:
-#   git_repo.commits[0] => 'add railties dir' (initial commit)
-#   git_repo.commits[1] => 'commit1'
-#   git_repo.commits.last => 'commit2'
+#   @git_repo.commits[0] => 'add railties dir' (initial commit)
+#   @git_repo.commits[1] => 'commit1'
+#   @git_repo.commits.last => 'commit2'
 
 require "rails/diff/rails_repo"
 require "fileutils"
@@ -11,39 +11,40 @@
   let(:logger) { spy }
   let(:cache_dir) { Dir.mktmpdir }
   let(:rails_path) { File.join(cache_dir, "rails") }
-  let(:git_repo) do
-    GitRepo.new.tap do |repo|
+
+  before(:all) do
+    @git_repo = GitRepo.new.tap do |repo|
       repo.add_commit("commit1")
       repo.add_commit("commit2")
     end
   end
 
   after do
     FileUtils.rm_rf(cache_dir)
-    git_repo.cleanup
+    @git_repo.cleanup
   end
 
   describe "#up_to_date?" do
     it "returns false when repo is not cloned yet" do
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       result = repo.up_to_date?
 
       expect(result).to eq false
     end
 
     it "returns true when repo is on the latest commit" do
-      git_repo.clone_at_commit(git_repo.commits.last, rails_path)
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      @git_repo.clone_at_commit(@git_repo.commits.last, rails_path)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       result = repo.up_to_date?
 
       expect(result).to eq true
     end
 
     it "returns false and removes the repo when repo is on an old commit" do
-      git_repo.clone_at_commit(git_repo.commits.first, rails_path)
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      @git_repo.clone_at_commit(@git_repo.commits.first, rails_path)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       result = repo.up_to_date?
 
@@ -54,16 +55,16 @@
 
   describe "#latest_commit" do
     it "returns the latest commit SHA from the remote repo" do
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       latest = repo.latest_commit
 
-      expect(latest).to eq git_repo.commits.last
+      expect(latest).to eq @git_repo.commits.last
     end
 
     it "returns the new latest commit after a new commit is pushed" do
-      new_commit = git_repo.add_commit("commit3")
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      new_commit = @git_repo.add_commit("commit3")
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       latest = repo.latest_commit
 
@@ -73,32 +74,32 @@
 
   describe "#checkout" do
     it "checks out the given commit in the repo" do
-      git_repo.clone_at_commit(git_repo.commits.last, rails_path)
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      @git_repo.clone_at_commit(@git_repo.commits.last, rails_path)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       # Checkout the first file commit (not the initial railties commit)
-      repo.checkout(git_repo.commits[1])
+      repo.checkout(@git_repo.commits[1])
 
       # Verify HEAD is now at the first file commit
       current = Dir.chdir(rails_path) { `git rev-parse HEAD`.strip }
-      expect(current).to eq git_repo.commits[1]
+      expect(current).to eq @git_repo.commits[1]
     end
 
     it "logs the checkout info message" do
-      git_repo.clone_at_commit(git_repo.commits.last, rails_path)
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      @git_repo.clone_at_commit(@git_repo.commits.last, rails_path)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
-      repo.checkout(git_repo.commits[1])
+      repo.checkout(@git_repo.commits[1])
 
       expect(logger).to have_received(:info)
-        .with(/Checking out Rails \(at commit #{git_repo.commits[1][0..6]}\)/)
+        .with(/Checking out Rails \(at commit #{@git_repo.commits[1][0..6]}\)/)
     end
   end
 
   describe "#install_dependencies" do
     it "runs bundle check and bundle install if needed, and logs appropriately" do
-      git_repo.clone_at_commit(git_repo.commits[0], rails_path)
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      @git_repo.clone_at_commit(@git_repo.commits[0], rails_path)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       # Simulate bundle check failing, so bundle install is needed
       allow(Rails::Diff).to receive(:system!).with("bundle check", abort: false, logger: logger).and_return(false)
@@ -111,8 +112,8 @@
     end
 
     it "does not run bundle install if bundle check passes" do
-      git_repo.clone_at_commit(git_repo.commits[0], rails_path)
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      @git_repo.clone_at_commit(@git_repo.commits[0], rails_path)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       # Simulate bundle check passing
       allow(Rails::Diff).to receive(:system!).with("bundle check", abort: false, logger: logger).and_return(true)
@@ -125,8 +126,8 @@
 
   describe "#new_app" do
     it "runs the rails new command with the correct arguments and logs the command" do
-      git_repo.clone_at_commit(git_repo.commits.last, rails_path)
-      repo = described_class.new(logger:, cache_dir:, rails_repo: git_repo.remote_repo)
+      @git_repo.clone_at_commit(@git_repo.commits.last, rails_path)
+      repo = described_class.new(logger:, cache_dir:, rails_repo: @git_repo.remote_repo)
 
       allow(Rails::Diff).to receive(:system!).and_return(true)
       app_name = "myapp"

spec/support/git_repo.rb

@@ -8,45 +8,51 @@ class GitRepo
   def initialize
     @remote_dir = Dir.mktmpdir
     @remote_repo = File.join(@remote_dir, "origin.git")
-    Dir.chdir(@remote_dir) { `git init --bare origin.git > /dev/null 2>&1` }
+    Dir.chdir(@remote_dir) { `git init --bare --initial-branch=main origin.git > /dev/null 2>&1` }
 
     @commits = []
     @work_dir = Dir.mktmpdir
     Dir.chdir(@work_dir) do
       `git clone #{@remote_repo} . > /dev/null 2>&1`
       `git checkout -b main > /dev/null 2>&1`
-      # Always create the 'railties' directory for test convenience
       FileUtils.mkdir_p("railties")
-      File.write("railties/.keep", "keep")
+      File.write("railties/README", "keep")
       `git add railties > /dev/null 2>&1`
-      `git commit -m "add railties dir" > /dev/null 2>&1`
+
+      `git config user.email '[email protected]'`
+      `git config user.name 'Test User'`
+
+      commit_result = `git commit -m "add railties dir" 2>&1`
+      raise "Initial commit failed: #{commit_result}" unless $?.success?
       @commits << `git rev-parse HEAD`.strip
-      `git push origin main > /dev/null 2>&1`
+      `git push -u origin main > /dev/null 2>&1`
     end
   end
 
-  # Adds a commit with the given message and pushes to remote
   def add_commit(message)
     Dir.chdir(@work_dir) do
-      filename = "file#{@commits.size}.txt"
-      File.write(filename, message)
-      `git add . > /dev/null 2>&1`
-      `git commit -m "#{message}" > /dev/null 2>&1`
+      `git commit --allow-empty -n -m "#{message}" > /dev/null 2>&1`
       sha = `git rev-parse HEAD`.strip
       @commits << sha
       `git push origin main > /dev/null 2>&1`
+      `git fetch origin main > /dev/null 2>&1`
     end
 
     @commits.last
   end
 
   def clone_at_commit(commit_sha, dest_path)
     `git clone #{@remote_repo} #{dest_path} > /dev/null 2>&1`
-    Dir.chdir(dest_path) { `git checkout #{commit_sha} > /dev/null 2>&1` }
+    Dir.chdir(dest_path) do
+      `git checkout #{commit_sha} > /dev/null 2>&1`
+      `git fetch origin main > /dev/null 2>&1`
+    end
   end
 
   def cleanup
-    FileUtils.rm_rf(@remote_dir)
-    FileUtils.rm_rf(@work_dir)
+    Dir.chdir(@work_dir) do
+      `git reset --hard main > /dev/null 2>&1`
+      `git clean -fdx > /dev/null 2>&1`
+    end
   end
 end