A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
RSpec.describe GitUtils do
let(:temp_dir) { Dir.mktmpdir }
before { GitUtils.instance_variable_set(:@filesystem_overrides, nil) }
after { FileUtils.remove_entry(temp_dir) }
def run(command)
system(command, exception: true)
end
def within_temp_git_repo(&block)
Dir.chdir(temp_dir) do
run("git init --quiet")
run("git config user.email '[email protected]'")
run("git config user.name 'Test User'")
run("git config commit.gpgsign false")
run("git checkout --quiet -b main")
yield
end
end
def create_commit(filename = "test.txt")
File.write(filename, "content")
run("git add #{filename}")
run("git commit --quiet -m 'Commit #{filename}'")
end
it "returns git version, branch, full_version, and last_commit_date" do
within_temp_git_repo do
create_commit
run("git checkout --quiet -b feature-branch")
run("git tag -a v1.0.0 -m 'Version 1.0.0'")
expect(GitUtils.git_version).to eq(`git rev-parse HEAD`.strip)
expect(GitUtils.git_branch).to eq("feature-branch")
expect(GitUtils.full_version).to start_with("v1.0.0")
expect(GitUtils.last_commit_date).to be_within(60).of(DateTime.now)
end
end
it "ignores working tree changes in full_version" do
within_temp_git_repo do
create_commit
run("git tag -a v1.0.0 -m 'Version 1.0.0'")
File.write("test.txt", "changed")
expect(GitUtils.full_version).to eq("v1.0.0")
end
end
it "returns fallback values when missing data" do
within_temp_git_repo do
create_commit
run("git checkout --quiet --detach HEAD")
expect(GitUtils.git_branch).to eq("unknown")
end
end
it "falls back to user.discourse-version when in detached HEAD" do
within_temp_git_repo do
create_commit
run("git config user.discourse-version 'v3.2.0'")
run("git checkout --quiet --detach HEAD")
expect(GitUtils.git_branch).to eq("v3.2.0")
end
end
describe ".last_commit_date" do
it "reads the commit timestamp without commit headers" do
timestamp = "1786671289"
GitUtils
.expects(:try_git)
.with("git rev-list -1 --no-commit-header --format=%ct HEAD", nil)
.returns(timestamp)
expect(GitUtils.last_commit_date).to eq(DateTime.strptime(timestamp, "%s"))
end
end
describe ".has_commit?" do
before { GitUtils.instance_variable_set(:@has_commit, nil) }
it "validates commit existence and format" do
within_temp_git_repo do
create_commit
first_sha = `git rev-parse HEAD`.strip
create_commit("test2.txt")
expect(GitUtils.has_commit?(first_sha)).to eq(true)
expect(GitUtils.has_commit?("a" * 40)).to eq(false)
expect(GitUtils.has_commit?("invalid")).to eq(false)
end
end
it "only shells out once per hash" do
within_temp_git_repo do
create_commit
sha = `git rev-parse HEAD`.strip
GitUtils.expects(:try_git).once.returns("0")
expect(GitUtils.has_commit?(sha)).to eq(true)
expect(GitUtils.has_commit?(sha)).to eq(true)
end
end
it "does not lazily fetch a commit missing from a partial clone" do
clone_dir = File.join(temp_dir, "partial")
within_temp_git_repo do
create_commit
run("git config uploadpack.allowfilter true")
run("git clone --quiet --filter=tree:0 file://#{temp_dir} #{clone_dir}")
end
Dir.chdir(clone_dir) do
# An unroutable promisor remote: reaching for it would stall until the
# command timeout rather than fail fast.
run("git remote set-url origin https://10.255.255.1/unreachable.git")
elapsed = Benchmark.realtime { expect(GitUtils.has_commit?("a" * 40)).to eq(false) }
expect(elapsed).to be < GitUtils::COMMAND_TIMEOUT_SECONDS
end
end
it "does not memoize a result when git is unavailable" do
GitUtils.expects(:try_git).twice.returns(nil)
expect(GitUtils.has_commit?("a" * 40)).to eq(false)
expect(GitUtils.has_commit?("a" * 40)).to eq(false)
end
end
describe ".try_git" do
it "returns the fallback value and kills the process when it times out" do
expect(GitUtils.try_git("sleep 5; echo nope", "fallback", timeout: 0.1)).to eq("fallback")
end
it "does not include stderr in the returned value" do
expect(GitUtils.try_git("echo oops 1>&2; echo out", "fallback")).to eq("out")
end
it "passes the given environment to the command" do
expect(GitUtils.try_git("echo $SOME_VAR", "fallback", env: { "SOME_VAR" => "set" })).to eq(
"set",
)
end
it "returns the fallback value when the command does not exist" do
expect(GitUtils.try_git("definitely-not-a-real-command-xyz 2> /dev/null", "fallback")).to eq(
"fallback",
)
end
end
describe ".filesystem_overrides" do
it "reads overrides from JSON file and applies them to git methods" do
FileUtils.mkdir_p(File.join(temp_dir, "config"))
File.write(
File.join(temp_dir, "config", "git-utils-overrides.json"),
{
"git_version" => "override-sha",
"git_branch" => "override-branch",
"full_version" => "override-full",
}.to_json,
)
GitUtils.stubs(:rails_root).returns(Pathname.new(temp_dir))
within_temp_git_repo do
create_commit
expect(GitUtils.git_version).to eq("override-sha")
expect(GitUtils.git_branch).to eq("override-branch")
expect(GitUtils.full_version).to eq("override-full")
end
end
it "returns regular info when file does not exist" do
GitUtils.stubs(:rails_root).returns(Pathname.new(temp_dir))
within_temp_git_repo do
create_commit
expect(GitUtils.git_version).to eq(`git rev-parse HEAD`.strip)
expect(GitUtils.git_branch).to eq("main")
expect(GitUtils.full_version).to eq("unknown")
end
end
end
it "calculates rails root correctly" do
expected = Rails.root
Rails.stubs(:root).raises "Rails.root might not be available during GitUtils initialization"
expect(GitUtils.send(:rails_root)).to eq(expected)
ensure
# This will get unstubbed automatically by rails_helper, but we gotta do it
# even earlier, since some other test cleanup code calls Rails.root
Rails.unstub(:root)
end
end