repository_spec.rb 41.1 KB
Newer Older
R
Robert Speicher 已提交
1 2 3
require "spec_helper"

describe Gitlab::Git::Repository, seed_helper: true do
4
  include Gitlab::EncodingHelper
R
Robert Speicher 已提交
5

6 7 8 9 10 11 12 13 14 15 16 17 18 19
  shared_examples 'wrapping gRPC errors' do |gitaly_client_class, gitaly_client_method|
    it 'wraps gRPC not found error' do
      expect_any_instance_of(gitaly_client_class).to receive(gitaly_client_method)
        .and_raise(GRPC::NotFound)
      expect { subject }.to raise_error(Gitlab::Git::Repository::NoRepository)
    end

    it 'wraps gRPC unknown error' do
      expect_any_instance_of(gitaly_client_class).to receive(gitaly_client_method)
        .and_raise(GRPC::Unknown)
      expect { subject }.to raise_error(Gitlab::Git::CommandError)
    end
  end

20
  let(:repository) { Gitlab::Git::Repository.new('default', TEST_REPO_PATH) }
R
Robert Speicher 已提交
21 22 23 24 25 26 27 28 29

  describe "Respond to" do
    subject { repository }

    it { is_expected.to respond_to(:rugged) }
    it { is_expected.to respond_to(:root_ref) }
    it { is_expected.to respond_to(:tags) }
  end

30 31
  describe '#root_ref' do
    context 'with gitaly disabled' do
32 33 34
      before do
        allow(Gitlab::GitalyClient).to receive(:feature_enabled?).and_return(false)
      end
35 36 37 38 39 40 41

      it 'calls #discover_default_branch' do
        expect(repository).to receive(:discover_default_branch)
        repository.root_ref
      end
    end

J
Jacob Vosmaer 已提交
42
    it 'returns UTF-8' do
J
Jacob Vosmaer 已提交
43
      expect(repository.root_ref).to be_utf8
J
Jacob Vosmaer 已提交
44 45
    end

J
Jacob Vosmaer 已提交
46
    it 'gets the branch name from GitalyClient' do
A
Andrew Newdigate 已提交
47
      expect_any_instance_of(Gitlab::GitalyClient::RefService).to receive(:default_branch_name)
J
Jacob Vosmaer 已提交
48 49
      repository.root_ref
    end
50

A
Andrew Newdigate 已提交
51
    it_behaves_like 'wrapping gRPC errors', Gitlab::GitalyClient::RefService, :default_branch_name do
52
      subject { repository.root_ref }
53
    end
54 55
  end

56
  describe "#rugged" do
57 58 59 60 61 62 63 64 65 66 67 68 69 70
    describe 'when storage is broken', broken_storage: true  do
      it 'raises a storage exception when storage is not available' do
        broken_repo = described_class.new('broken', 'a/path.git')

        expect { broken_repo.rugged }.to raise_error(Gitlab::Git::Storage::Inaccessible)
      end
    end

    it 'raises a no repository exception when there is no repo' do
      broken_repo = described_class.new('default', 'a/path.git')

      expect { broken_repo.rugged }.to raise_error(Gitlab::Git::Repository::NoRepository)
    end

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    context 'with no Git env stored' do
      before do
        expect(Gitlab::Git::Env).to receive(:all).and_return({})
      end

      it "whitelist some variables and pass them via the alternates keyword argument" do
        expect(Rugged::Repository).to receive(:new).with(repository.path, alternates: [])

        repository.rugged
      end
    end

    context 'with some Git env stored' do
      before do
        expect(Gitlab::Git::Env).to receive(:all).and_return({
          'GIT_OBJECT_DIRECTORY' => 'foo',
          'GIT_ALTERNATE_OBJECT_DIRECTORIES' => 'bar',
          'GIT_OTHER' => 'another_env'
        })
      end

      it "whitelist some variables and pass them via the alternates keyword argument" do
        expect(Rugged::Repository).to receive(:new).with(repository.path, alternates: %w[foo bar])

        repository.rugged
      end
    end
  end

R
Robert Speicher 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
  describe "#discover_default_branch" do
    let(:master) { 'master' }
    let(:feature) { 'feature' }
    let(:feature2) { 'feature2' }

    it "returns 'master' when master exists" do
      expect(repository).to receive(:branch_names).at_least(:once).and_return([feature, master])
      expect(repository.discover_default_branch).to eq('master')
    end

    it "returns non-master when master exists but default branch is set to something else" do
      File.write(File.join(repository.path, 'HEAD'), 'ref: refs/heads/feature')
      expect(repository).to receive(:branch_names).at_least(:once).and_return([feature, master])
      expect(repository.discover_default_branch).to eq('feature')
      File.write(File.join(repository.path, 'HEAD'), 'ref: refs/heads/master')
    end

    it "returns a non-master branch when only one exists" do
      expect(repository).to receive(:branch_names).at_least(:once).and_return([feature])
      expect(repository.discover_default_branch).to eq('feature')
    end

    it "returns a non-master branch when more than one exists and master does not" do
      expect(repository).to receive(:branch_names).at_least(:once).and_return([feature, feature2])
      expect(repository.discover_default_branch).to eq('feature')
    end

    it "returns nil when no branch exists" do
      expect(repository).to receive(:branch_names).at_least(:once).and_return([])
      expect(repository.discover_default_branch).to be_nil
    end
  end

133
  describe '#branch_names' do
R
Robert Speicher 已提交
134 135 136 137 138
    subject { repository.branch_names }

    it 'has SeedRepo::Repo::BRANCHES.size elements' do
      expect(subject.size).to eq(SeedRepo::Repo::BRANCHES.size)
    end
J
Jacob Vosmaer 已提交
139 140

    it 'returns UTF-8' do
J
Jacob Vosmaer 已提交
141
      expect(subject.first).to be_utf8
J
Jacob Vosmaer 已提交
142 143
    end

R
Robert Speicher 已提交
144 145
    it { is_expected.to include("master") }
    it { is_expected.not_to include("branch-from-space") }
146

J
Jacob Vosmaer 已提交
147
    it 'gets the branch names from GitalyClient' do
A
Andrew Newdigate 已提交
148
      expect_any_instance_of(Gitlab::GitalyClient::RefService).to receive(:branch_names)
J
Jacob Vosmaer 已提交
149 150
      subject
    end
151

A
Andrew Newdigate 已提交
152
    it_behaves_like 'wrapping gRPC errors', Gitlab::GitalyClient::RefService, :branch_names
R
Robert Speicher 已提交
153 154
  end

155
  describe '#tag_names' do
R
Robert Speicher 已提交
156 157 158
    subject { repository.tag_names }

    it { is_expected.to be_kind_of Array }
J
Jacob Vosmaer 已提交
159

R
Robert Speicher 已提交
160 161 162 163
    it 'has SeedRepo::Repo::TAGS.size elements' do
      expect(subject.size).to eq(SeedRepo::Repo::TAGS.size)
    end

J
Jacob Vosmaer 已提交
164
    it 'returns UTF-8' do
J
Jacob Vosmaer 已提交
165
      expect(subject.first).to be_utf8
J
Jacob Vosmaer 已提交
166 167
    end

R
Robert Speicher 已提交
168 169 170 171 172 173
    describe '#last' do
      subject { super().last }
      it { is_expected.to eq("v1.2.1") }
    end
    it { is_expected.to include("v1.0.0") }
    it { is_expected.not_to include("v5.0.0") }
174

J
Jacob Vosmaer 已提交
175
    it 'gets the tag names from GitalyClient' do
A
Andrew Newdigate 已提交
176
      expect_any_instance_of(Gitlab::GitalyClient::RefService).to receive(:tag_names)
J
Jacob Vosmaer 已提交
177 178
      subject
    end
179

A
Andrew Newdigate 已提交
180
    it_behaves_like 'wrapping gRPC errors', Gitlab::GitalyClient::RefService, :tag_names
R
Robert Speicher 已提交
181 182 183 184 185 186 187
  end

  shared_examples 'archive check' do |extenstion|
    it { expect(metadata['ArchivePath']).to match(/tmp\/gitlab-git-test.git\/gitlab-git-test-master-#{SeedRepo::LastCommit::ID}/) }
    it { expect(metadata['ArchivePath']).to end_with extenstion }
  end

188 189 190 191 192 193 194 195 196 197 198 199
  describe '#archive_prefix' do
    let(:project_name) { 'project-name'}

    before do
      expect(repository).to receive(:name).once.and_return(project_name)
    end

    it 'returns parameterised string for a ref containing slashes' do
      prefix = repository.archive_prefix('test/branch', 'SHA')

      expect(prefix).to eq("#{project_name}-test-branch-SHA")
    end
200 201 202 203 204 205

    it 'returns correct string for a ref containing dots' do
      prefix = repository.archive_prefix('test.branch', 'SHA')

      expect(prefix).to eq("#{project_name}-test.branch-SHA")
    end
206 207 208
  end

  describe '#archive' do
R
Robert Speicher 已提交
209 210 211 212 213
    let(:metadata) { repository.archive_metadata('master', '/tmp') }

    it_should_behave_like 'archive check', '.tar.gz'
  end

214
  describe '#archive_zip' do
R
Robert Speicher 已提交
215 216 217 218 219
    let(:metadata) { repository.archive_metadata('master', '/tmp', 'zip') }

    it_should_behave_like 'archive check', '.zip'
  end

220
  describe '#archive_bz2' do
R
Robert Speicher 已提交
221 222 223 224 225
    let(:metadata) { repository.archive_metadata('master', '/tmp', 'tbz2') }

    it_should_behave_like 'archive check', '.tar.bz2'
  end

226
  describe '#archive_fallback' do
R
Robert Speicher 已提交
227 228 229 230 231
    let(:metadata) { repository.archive_metadata('master', '/tmp', 'madeup') }

    it_should_behave_like 'archive check', '.tar.gz'
  end

232
  describe '#size' do
R
Robert Speicher 已提交
233 234 235 236 237
    subject { repository.size }

    it { is_expected.to be < 2 }
  end

238
  describe '#empty?' do
R
Robert Speicher 已提交
239 240 241
    it { expect(repository.empty?).to be_falsey }
  end

242
  describe '#ref_names' do
R
Robert Speicher 已提交
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    let(:ref_names) { repository.ref_names }
    subject { ref_names }

    it { is_expected.to be_kind_of Array }

    describe '#first' do
      subject { super().first }
      it { is_expected.to eq('feature') }
    end

    describe '#last' do
      subject { super().last }
      it { is_expected.to eq('v1.2.1') }
    end
  end

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
  describe '#submodule_url_for' do
    let(:repository) { Gitlab::Git::Repository.new('default', TEST_REPO_PATH) }
    let(:ref) { 'master' }

    def submodule_url(path)
      repository.submodule_url_for(ref, path)
    end

    it { expect(submodule_url('six')).to eq('git://github.com/randx/six.git') }
    it { expect(submodule_url('nested/six')).to eq('git://github.com/randx/six.git') }
    it { expect(submodule_url('deeper/nested/six')).to eq('git://github.com/randx/six.git') }
    it { expect(submodule_url('invalid/path')).to eq(nil) }

    context 'uncommitted submodule dir' do
      let(:ref) { 'fix-existing-submodule-dir' }

      it { expect(submodule_url('submodule-existing-dir')).to eq(nil) }
    end

    context 'tags' do
      let(:ref) { 'v1.2.1' }

      it { expect(submodule_url('six')).to eq('git://github.com/randx/six.git') }
    end

284 285 286 287 288 289 290
    context 'no .gitmodules at commit' do
      let(:ref) { '9596bc54a6f0c0c98248fe97077eb5ccf48a98d0' }

      it { expect(submodule_url('six')).to eq(nil) }
    end

    context 'no gitlink entry' do
291 292 293 294 295 296
      let(:ref) { '6d39438' }

      it { expect(submodule_url('six')).to eq(nil) }
    end
  end

297
  context '#submodules' do
298
    let(:repository) { Gitlab::Git::Repository.new('default', TEST_REPO_PATH) }
R
Robert Speicher 已提交
299 300

    context 'where repo has submodules' do
301
      let(:submodules) { repository.send(:submodules, 'master') }
R
Robert Speicher 已提交
302 303 304 305 306 307 308 309 310
      let(:submodule) { submodules.first }

      it { expect(submodules).to be_kind_of Hash }
      it { expect(submodules.empty?).to be_falsey }

      it 'should have valid data' do
        expect(submodule).to eq([
          "six", {
            "id" => "409f37c4f05865e4fb208c771485f211a22c4c2d",
311
            "name" => "six",
R
Robert Speicher 已提交
312 313 314 315 316 317 318
            "url" => "git://github.com/randx/six.git"
          }
        ])
      end

      it 'should handle nested submodules correctly' do
        nested = submodules['nested/six']
319
        expect(nested['name']).to eq('nested/six')
R
Robert Speicher 已提交
320 321 322 323 324 325
        expect(nested['url']).to eq('git://github.com/randx/six.git')
        expect(nested['id']).to eq('24fb71c79fcabc63dfd8832b12ee3bf2bf06b196')
      end

      it 'should handle deeply nested submodules correctly' do
        nested = submodules['deeper/nested/six']
326
        expect(nested['name']).to eq('deeper/nested/six')
R
Robert Speicher 已提交
327 328 329 330 331 332 333 334 335
        expect(nested['url']).to eq('git://github.com/randx/six.git')
        expect(nested['id']).to eq('24fb71c79fcabc63dfd8832b12ee3bf2bf06b196')
      end

      it 'should not have an entry for an invalid submodule' do
        expect(submodules).not_to have_key('invalid/path')
      end

      it 'should not have an entry for an uncommited submodule dir' do
336
        submodules = repository.send(:submodules, 'fix-existing-submodule-dir')
R
Robert Speicher 已提交
337 338 339 340
        expect(submodules).not_to have_key('submodule-existing-dir')
      end

      it 'should handle tags correctly' do
341
        submodules = repository.send(:submodules, 'v1.2.1')
R
Robert Speicher 已提交
342 343 344 345

        expect(submodules.first).to eq([
          "six", {
            "id" => "409f37c4f05865e4fb208c771485f211a22c4c2d",
346
            "name" => "six",
R
Robert Speicher 已提交
347 348 349 350
            "url" => "git://github.com/randx/six.git"
          }
        ])
      end
351 352 353 354 355 356 357 358 359 360 361 362 363

      it 'should not break on invalid syntax' do
        allow(repository).to receive(:blob_content).and_return(<<-GITMODULES.strip_heredoc)
          [submodule "six"]
          path = six
          url = git://github.com/randx/six.git

          [submodule]
          foo = bar
        GITMODULES

        expect(submodules).to have_key('six')
      end
R
Robert Speicher 已提交
364 365 366
    end

    context 'where repo doesn\'t have submodules' do
367
      let(:submodules) { repository.send(:submodules, '6d39438') }
R
Robert Speicher 已提交
368 369 370 371 372 373
      it 'should return an empty hash' do
        expect(submodules).to be_empty
      end
    end
  end

374
  describe '#commit_count' do
375
    shared_examples 'simple commit counting' do
376 377 378 379 380
      it { expect(repository.commit_count("master")).to eq(25) }
      it { expect(repository.commit_count("feature")).to eq(9) }
    end

    context 'when Gitaly commit_count feature is enabled' do
381
      it_behaves_like 'simple commit counting'
A
Andrew Newdigate 已提交
382
      it_behaves_like 'wrapping gRPC errors', Gitlab::GitalyClient::CommitService, :commit_count do
383 384 385 386 387
        subject { repository.commit_count('master') }
      end
    end

    context 'when Gitaly commit_count feature is disabled', skip_gitaly_mock: true  do
388
      it_behaves_like 'simple commit counting'
389
    end
R
Robert Speicher 已提交
390 391 392 393
  end

  describe "#delete_branch" do
    before(:all) do
394
      @repo = Gitlab::Git::Repository.new('default', TEST_MUTABLE_REPO_PATH)
R
Robert Speicher 已提交
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
      @repo.delete_branch("feature")
    end

    it "should remove the branch from the repo" do
      expect(@repo.rugged.branches["feature"]).to be_nil
    end

    after(:all) do
      FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
      ensure_seeds
    end
  end

  describe "#create_branch" do
    before(:all) do
410
      @repo = Gitlab::Git::Repository.new('default', TEST_MUTABLE_REPO_PATH)
R
Robert Speicher 已提交
411 412 413 414 415 416 417 418 419 420 421 422
    end

    it "should create a new branch" do
      expect(@repo.create_branch('new_branch', 'master')).not_to be_nil
    end

    it "should create a new branch with the right name" do
      expect(@repo.create_branch('another_branch', 'master').name).to eq('another_branch')
    end

    it "should fail if we create an existing branch" do
      @repo.create_branch('duplicated_branch', 'master')
423
      expect {@repo.create_branch('duplicated_branch', 'master')}.to raise_error("Branch duplicated_branch already exists")
R
Robert Speicher 已提交
424 425 426
    end

    it "should fail if we create a branch from a non existing ref" do
427
      expect {@repo.create_branch('branch_based_in_wrong_ref', 'master_2_the_revenge')}.to raise_error("Invalid reference master_2_the_revenge")
R
Robert Speicher 已提交
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    end

    after(:all) do
      FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
      ensure_seeds
    end
  end

  describe "#refs_hash" do
    let(:refs) { repository.refs_hash }

    it "should have as many entries as branches and tags" do
      expected_refs = SeedRepo::Repo::BRANCHES + SeedRepo::Repo::TAGS
      # We flatten in case a commit is pointed at by more than one branch and/or tag
      expect(refs.values.flatten.size).to eq(expected_refs.size)
    end
  end

  describe "#remote_delete" do
    before(:all) do
448
      @repo = Gitlab::Git::Repository.new('default', TEST_MUTABLE_REPO_PATH)
R
Robert Speicher 已提交
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
      @repo.remote_delete("expendable")
    end

    it "should remove the remote" do
      expect(@repo.rugged.remotes).not_to include("expendable")
    end

    after(:all) do
      FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
      ensure_seeds
    end
  end

  describe "#remote_add" do
    before(:all) do
464
      @repo = Gitlab::Git::Repository.new('default', TEST_MUTABLE_REPO_PATH)
465
      @repo.remote_add("new_remote", SeedHelper::GITLAB_GIT_TEST_REPO_URL)
R
Robert Speicher 已提交
466 467 468 469 470 471 472 473 474 475 476 477 478 479
    end

    it "should add the remote" do
      expect(@repo.rugged.remotes.each_name.to_a).to include("new_remote")
    end

    after(:all) do
      FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
      ensure_seeds
    end
  end

  describe "#remote_update" do
    before(:all) do
480
      @repo = Gitlab::Git::Repository.new('default', TEST_MUTABLE_REPO_PATH)
R
Robert Speicher 已提交
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
      @repo.remote_update("expendable", url: TEST_NORMAL_REPO_PATH)
    end

    it "should add the remote" do
      expect(@repo.rugged.remotes["expendable"].url).to(
        eq(TEST_NORMAL_REPO_PATH)
      )
    end

    after(:all) do
      FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
      ensure_seeds
    end
  end

  describe "#log" do
497 498 499 500 501 502 503 504 505
    let(:commit_with_old_name) do
      Gitlab::Git::Commit.decorate(repository, @commit_with_old_name_id)
    end
    let(:commit_with_new_name) do
      Gitlab::Git::Commit.decorate(repository, @commit_with_new_name_id)
    end
    let(:rename_commit) do
      Gitlab::Git::Commit.decorate(repository, @rename_commit_id)
    end
R
Robert Speicher 已提交
506

507
    before(:context) do
R
Robert Speicher 已提交
508
      # Add new commits so that there's a renamed file in the commit history
509
      repo = Gitlab::Git::Repository.new('default', TEST_REPO_PATH).rugged
510 511 512
      @commit_with_old_name_id = new_commit_edit_old_file(repo)
      @rename_commit_id = new_commit_move_file(repo)
      @commit_with_new_name_id = new_commit_edit_new_file(repo)
R
Robert Speicher 已提交
513 514
    end

515 516
    after(:context) do
      # Erase our commits so other tests get the original repo
517
      repo = Gitlab::Git::Repository.new('default', TEST_REPO_PATH).rugged
518 519 520
      repo.references.update("refs/heads/master", SeedRepo::LastCommit::ID)
    end

R
Robert Speicher 已提交
521
    context "where 'follow' == true" do
522
      let(:options) { { ref: "master", follow: true } }
R
Robert Speicher 已提交
523 524

      context "and 'path' is a directory" do
525
        it "does not follow renames" do
526
          log_commits = repository.log(options.merge(path: "encoding"))
R
Robert Speicher 已提交
527

528 529 530 531 532
          aggregate_failures do
            expect(log_commits).to include(commit_with_new_name)
            expect(log_commits).to include(rename_commit)
            expect(log_commits).not_to include(commit_with_old_name)
          end
R
Robert Speicher 已提交
533 534 535 536
        end
      end

      context "and 'path' is a file that matches the new filename" do
537 538
        context 'without offset' do
          it "follows renames" do
539 540 541 542 543 544 545
            log_commits = repository.log(options.merge(path: "encoding/CHANGELOG"))

            aggregate_failures do
              expect(log_commits).to include(commit_with_new_name)
              expect(log_commits).to include(rename_commit)
              expect(log_commits).to include(commit_with_old_name)
            end
546
          end
R
Robert Speicher 已提交
547 548
        end

549 550
        context 'with offset=1' do
          it "follows renames and skip the latest commit" do
551 552 553 554 555 556 557
            log_commits = repository.log(options.merge(path: "encoding/CHANGELOG", offset: 1))

            aggregate_failures do
              expect(log_commits).not_to include(commit_with_new_name)
              expect(log_commits).to include(rename_commit)
              expect(log_commits).to include(commit_with_old_name)
            end
558 559 560 561 562
          end
        end

        context 'with offset=1', 'and limit=1' do
          it "follows renames, skip the latest commit and return only one commit" do
563 564 565
            log_commits = repository.log(options.merge(path: "encoding/CHANGELOG", offset: 1, limit: 1))

            expect(log_commits).to contain_exactly(rename_commit)
566 567 568 569 570
          end
        end

        context 'with offset=1', 'and limit=2' do
          it "follows renames, skip the latest commit and return only two commits" do
571 572 573 574 575
            log_commits = repository.log(options.merge(path: "encoding/CHANGELOG", offset: 1, limit: 2))

            aggregate_failures do
              expect(log_commits).to contain_exactly(rename_commit, commit_with_old_name)
            end
576 577 578 579 580
          end
        end

        context 'with offset=2' do
          it "follows renames and skip the latest commit" do
581 582 583 584 585 586 587
            log_commits = repository.log(options.merge(path: "encoding/CHANGELOG", offset: 2))

            aggregate_failures do
              expect(log_commits).not_to include(commit_with_new_name)
              expect(log_commits).not_to include(rename_commit)
              expect(log_commits).to include(commit_with_old_name)
            end
588 589 590 591 592
          end
        end

        context 'with offset=2', 'and limit=1' do
          it "follows renames, skip the two latest commit and return only one commit" do
593 594 595
            log_commits = repository.log(options.merge(path: "encoding/CHANGELOG", offset: 2, limit: 1))

            expect(log_commits).to contain_exactly(commit_with_old_name)
596 597 598 599 600
          end
        end

        context 'with offset=2', 'and limit=2' do
          it "follows renames, skip the two latest commit and return only one commit" do
601 602 603 604 605 606 607
            log_commits = repository.log(options.merge(path: "encoding/CHANGELOG", offset: 2, limit: 2))

            aggregate_failures do
              expect(log_commits).not_to include(commit_with_new_name)
              expect(log_commits).not_to include(rename_commit)
              expect(log_commits).to include(commit_with_old_name)
            end
608
          end
R
Robert Speicher 已提交
609 610 611 612
        end
      end

      context "and 'path' is a file that matches the old filename" do
613
        it "does not follow renames" do
614
          log_commits = repository.log(options.merge(path: "CHANGELOG"))
R
Robert Speicher 已提交
615

616 617 618 619 620
          aggregate_failures do
            expect(log_commits).not_to include(commit_with_new_name)
            expect(log_commits).to include(rename_commit)
            expect(log_commits).to include(commit_with_old_name)
          end
R
Robert Speicher 已提交
621 622 623 624
        end
      end

      context "unknown ref" do
625 626
        it "returns an empty array" do
          log_commits = repository.log(options.merge(ref: 'unknown'))
R
Robert Speicher 已提交
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684

          expect(log_commits).to eq([])
        end
      end
    end

    context "where 'follow' == false" do
      options = { follow: false }

      context "and 'path' is a directory" do
        let(:log_commits) do
          repository.log(options.merge(path: "encoding"))
        end

        it "should not follow renames" do
          expect(log_commits).to include(commit_with_new_name)
          expect(log_commits).to include(rename_commit)
          expect(log_commits).not_to include(commit_with_old_name)
        end
      end

      context "and 'path' is a file that matches the new filename" do
        let(:log_commits) do
          repository.log(options.merge(path: "encoding/CHANGELOG"))
        end

        it "should not follow renames" do
          expect(log_commits).to include(commit_with_new_name)
          expect(log_commits).to include(rename_commit)
          expect(log_commits).not_to include(commit_with_old_name)
        end
      end

      context "and 'path' is a file that matches the old filename" do
        let(:log_commits) do
          repository.log(options.merge(path: "CHANGELOG"))
        end

        it "should not follow renames" do
          expect(log_commits).to include(commit_with_old_name)
          expect(log_commits).to include(rename_commit)
          expect(log_commits).not_to include(commit_with_new_name)
        end
      end

      context "and 'path' includes a directory that used to be a file" do
        let(:log_commits) do
          repository.log(options.merge(ref: "refs/heads/fix-blob-path", path: "files/testdir/file.txt"))
        end

        it "should return a list of commits" do
          expect(log_commits.size).to eq(1)
        end
      end
    end

    context "compare results between log_by_walk and log_by_shell" do
      let(:options) { { ref: "master" } }
685 686
      let(:commits_by_walk) { repository.log(options).map(&:id) }
      let(:commits_by_shell) { repository.log(options.merge({ disable_walk: true })).map(&:id) }
R
Robert Speicher 已提交
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727

      it { expect(commits_by_walk).to eq(commits_by_shell) }

      context "with limit" do
        let(:options) { { ref: "master", limit: 1 } }

        it { expect(commits_by_walk).to eq(commits_by_shell) }
      end

      context "with offset" do
        let(:options) { { ref: "master", offset: 1 } }

        it { expect(commits_by_walk).to eq(commits_by_shell) }
      end

      context "with skip_merges" do
        let(:options) { { ref: "master", skip_merges: true } }

        it { expect(commits_by_walk).to eq(commits_by_shell) }
      end

      context "with path" do
        let(:options) { { ref: "master", path: "encoding" } }

        it { expect(commits_by_walk).to eq(commits_by_shell) }

        context "with follow" do
          let(:options) { { ref: "master", path: "encoding", follow: true } }

          it { expect(commits_by_walk).to eq(commits_by_shell) }
        end
      end
    end

    context "where provides 'after' timestamp" do
      options = { after: Time.iso8601('2014-03-03T20:15:01+00:00') }

      it "should returns commits on or after that timestamp" do
        commits = repository.log(options)

        expect(commits.size).to be > 0
728
        expect(commits).to satisfy do |commits|
729
          commits.all? { |commit| commit.committed_date >= options[:after] }
R
Robert Speicher 已提交
730 731 732 733 734 735 736 737 738 739 740
        end
      end
    end

    context "where provides 'before' timestamp" do
      options = { before: Time.iso8601('2014-03-03T20:15:01+00:00') }

      it "should returns commits on or before that timestamp" do
        commits = repository.log(options)

        expect(commits.size).to be > 0
741
        expect(commits).to satisfy do |commits|
742
          commits.all? { |commit| commit.committed_date <= options[:before] }
743 744 745 746 747 748 749 750
        end
      end
    end

    context 'when multiple paths are provided' do
      let(:options) { { ref: 'master', path: ['PROCESS.md', 'README.md'] } }

      def commit_files(commit)
751
        commit.rugged_diff_from_parent.deltas.flat_map do |delta|
752 753 754 755 756 757 758 759 760 761
          [delta.old_file[:path], delta.new_file[:path]].uniq.compact
        end
      end

      it 'only returns commits matching at least one path' do
        commits = repository.log(options)

        expect(commits.size).to be > 0
        expect(commits).to satisfy do |commits|
          commits.none? { |commit| (commit_files(commit) & options[:path]).empty? }
R
Robert Speicher 已提交
762 763 764 765 766
        end
      end
    end
  end

767
  describe "#rugged_commits_between" do
R
Robert Speicher 已提交
768 769 770 771 772
    context 'two SHAs' do
      let(:first_sha) { 'b0e52af38d7ea43cf41d8a6f2471351ac036d6c9' }
      let(:second_sha) { '0e50ec4d3c7ce42ab74dda1d422cb2cbffe1e326' }

      it 'returns the number of commits between' do
773
        expect(repository.rugged_commits_between(first_sha, second_sha).count).to eq(3)
R
Robert Speicher 已提交
774 775 776 777 778 779 780 781
      end
    end

    context 'SHA and master branch' do
      let(:sha) { 'b0e52af38d7ea43cf41d8a6f2471351ac036d6c9' }
      let(:branch) { 'master' }

      it 'returns the number of commits between a sha and a branch' do
782
        expect(repository.rugged_commits_between(sha, branch).count).to eq(5)
R
Robert Speicher 已提交
783 784 785
      end

      it 'returns the number of commits between a branch and a sha' do
786
        expect(repository.rugged_commits_between(branch, sha).count).to eq(0) # sha is before branch
R
Robert Speicher 已提交
787 788 789 790 791 792 793 794
      end
    end

    context 'two branches' do
      let(:first_branch) { 'feature' }
      let(:second_branch) { 'master' }

      it 'returns the number of commits between' do
795
        expect(repository.rugged_commits_between(first_branch, second_branch).count).to eq(17)
R
Robert Speicher 已提交
796 797 798 799 800 801 802 803 804 805
      end
    end
  end

  describe '#count_commits_between' do
    subject { repository.count_commits_between('feature', 'master') }

    it { is_expected.to eq(17) }
  end

806
  describe '#count_commits' do
807 808 809 810
    shared_examples 'extended commit counting' do
      context 'with after timestamp' do
        it 'returns the number of commits after timestamp' do
          options = { ref: 'master', limit: nil, after: Time.iso8601('2013-03-03T20:15:01+00:00') }
811

812 813
          expect(repository.count_commits(options)).to eq(25)
        end
814 815
      end

816 817 818
      context 'with before timestamp' do
        it 'returns the number of commits before timestamp' do
          options = { ref: 'feature', limit: nil, before: Time.iso8601('2015-03-03T20:15:01+00:00') }
819

820 821
          expect(repository.count_commits(options)).to eq(9)
        end
822 823
      end

824 825 826
      context 'with path' do
        it 'returns the number of commits with path ' do
          options = { ref: 'master', limit: nil, path: "encoding" }
827

828 829
          expect(repository.count_commits(options)).to eq(2)
        end
830 831
      end
    end
832 833 834 835 836 837 838 839

    context 'when Gitaly count_commits feature is enabled' do
      it_behaves_like 'extended commit counting'
    end

    context 'when Gitaly count_commits feature is disabled', skip_gitaly_mock: true do
      it_behaves_like 'extended commit counting'
    end
840 841
  end

R
Robert Speicher 已提交
842 843 844 845 846 847 848 849 850 851
  describe "branch_names_contains" do
    subject { repository.branch_names_contains(SeedRepo::LastCommit::ID) }

    it { is_expected.to include('master') }
    it { is_expected.not_to include('feature') }
    it { is_expected.not_to include('fix') }
  end

  describe '#autocrlf' do
    before(:all) do
852
      @repo = Gitlab::Git::Repository.new('default', TEST_MUTABLE_REPO_PATH)
R
Robert Speicher 已提交
853 854 855 856 857 858 859 860 861 862 863 864 865 866
      @repo.rugged.config['core.autocrlf'] = true
    end

    it 'return the value of the autocrlf option' do
      expect(@repo.autocrlf).to be(true)
    end

    after(:all) do
      @repo.rugged.config.delete('core.autocrlf')
    end
  end

  describe '#autocrlf=' do
    before(:all) do
867
      @repo = Gitlab::Git::Repository.new('default', TEST_MUTABLE_REPO_PATH)
R
Robert Speicher 已提交
868 869 870 871 872 873
      @repo.rugged.config['core.autocrlf'] = false
    end

    it 'should set the autocrlf option to the provided option' do
      @repo.autocrlf = :input

874
      File.open(File.join(SEED_STORAGE_PATH, TEST_MUTABLE_REPO_PATH, '.git', 'config')) do |config_file|
R
Robert Speicher 已提交
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
        expect(config_file.read).to match('autocrlf = input')
      end
    end

    after(:all) do
      @repo.rugged.config.delete('core.autocrlf')
    end
  end

  describe '#find_branch' do
    it 'should return a Branch for master' do
      branch = repository.find_branch('master')

      expect(branch).to be_a_kind_of(Gitlab::Git::Branch)
      expect(branch.name).to eq('master')
    end

    it 'should handle non-existent branch' do
      branch = repository.find_branch('this-is-garbage')

      expect(branch).to eq(nil)
    end

    it 'should reload Rugged::Repository and return master' do
      expect(Rugged::Repository).to receive(:new).twice.and_call_original

      repository.find_branch('master')
      branch = repository.find_branch('master', force_reload: true)

      expect(branch).to be_a_kind_of(Gitlab::Git::Branch)
      expect(branch.name).to eq('master')
    end
907 908
  end

909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
  describe '#ref_name_for_sha' do
    let(:ref_path) { 'refs/heads' }
    let(:sha) { repository.find_branch('master').dereferenced_target.id }
    let(:ref_name) { 'refs/heads/master' }

    it 'returns the ref name for the given sha' do
      expect(repository.ref_name_for_sha(ref_path, sha)).to eq(ref_name)
    end

    it "returns an empty name if the ref doesn't exist" do
      expect(repository.ref_name_for_sha(ref_path, "000000")).to eq("")
    end

    it "raise an exception if the ref is empty" do
      expect { repository.ref_name_for_sha(ref_path, "") }.to raise_error(ArgumentError)
    end

    it "raise an exception if the ref is nil" do
      expect { repository.ref_name_for_sha(ref_path, nil) }.to raise_error(ArgumentError)
    end
  end

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
  describe '#branches' do
    subject { repository.branches }

    context 'with local and remote branches' do
      let(:repository) do
        Gitlab::Git::Repository.new('default', File.join(TEST_MUTABLE_REPO_PATH, '.git'))
      end

      before do
        create_remote_branch(repository, 'joe', 'remote_branch', 'master')
        repository.create_branch('local_branch', 'master')
      end

      after do
        FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
        ensure_seeds
      end

      it 'returns the local and remote branches' do
        expect(subject.any? { |b| b.name == 'joe/remote_branch' }).to eq(true)
        expect(subject.any? { |b| b.name == 'local_branch' }).to eq(true)
      end
R
Robert Speicher 已提交
953 954
    end

955 956 957 958
    # With Gitaly enabled, Gitaly just doesn't return deleted branches.
    context 'with deleted branch with Gitaly disabled' do
      before do
        allow(Gitlab::GitalyClient).to receive(:feature_enabled?).and_return(false)
959 960 961
      end

      it 'returns no results' do
962 963 964 965 966 967 968
        ref = double()
        allow(ref).to receive(:name) { 'bad-branch' }
        allow(ref).to receive(:target) { raise Rugged::ReferenceError }
        branches = double()
        allow(branches).to receive(:each) { [ref].each }
        allow(repository.rugged).to receive(:branches) { branches }

969 970
        expect(subject).to be_empty
      end
R
Robert Speicher 已提交
971
    end
972 973

    it_behaves_like 'wrapping gRPC errors', Gitlab::GitalyClient::RefService, :branches
R
Robert Speicher 已提交
974 975 976 977
  end

  describe '#branch_count' do
    it 'returns the number of branches' do
978
      expect(repository.branch_count).to eq(10)
R
Robert Speicher 已提交
979
    end
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

    context 'with local and remote branches' do
      let(:repository) do
        Gitlab::Git::Repository.new('default', File.join(TEST_MUTABLE_REPO_PATH, '.git'))
      end

      before do
        create_remote_branch(repository, 'joe', 'remote_branch', 'master')
        repository.create_branch('local_branch', 'master')
      end

      after do
        FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
        ensure_seeds
      end

      it 'returns the count of local branches' do
        expect(repository.branch_count).to eq(repository.local_branches.count)
      end

      context 'with Gitaly disabled' do
        before do
          allow(Gitlab::GitalyClient).to receive(:feature_enabled?).and_return(false)
        end

        it 'returns the count of local branches' do
          expect(repository.branch_count).to eq(repository.local_branches.count)
        end
      end
    end
R
Robert Speicher 已提交
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
  end

  describe "#ls_files" do
    let(:master_file_paths) { repository.ls_files("master") }
    let(:not_existed_branch) { repository.ls_files("not_existed_branch") }

    it "read every file paths of master branch" do
      expect(master_file_paths.length).to equal(40)
    end

    it "reads full file paths of master branch" do
      expect(master_file_paths).to include("files/html/500.html")
    end

1024
    it "does not read submodule directory and empty directory of master branch" do
R
Robert Speicher 已提交
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
      expect(master_file_paths).not_to include("six")
    end

    it "does not include 'nil'" do
      expect(master_file_paths).not_to include(nil)
    end

    it "returns empty array when not existed branch" do
      expect(not_existed_branch.length).to equal(0)
    end
  end

  describe "#copy_gitattributes" do
1038
    let(:attributes_path) { File.join(SEED_STORAGE_PATH, TEST_REPO_PATH, 'info/attributes') }
R
Robert Speicher 已提交
1039 1040 1041 1042 1043 1044

    it "raises an error with invalid ref" do
      expect { repository.copy_gitattributes("invalid") }.to raise_error(Gitlab::Git::Repository::InvalidRef)
    end

    context "with no .gitattrbutes" do
1045
      before do
R
Robert Speicher 已提交
1046 1047 1048 1049 1050 1051 1052
        repository.copy_gitattributes("master")
      end

      it "does not have an info/attributes" do
        expect(File.exist?(attributes_path)).to be_falsey
      end

1053
      after do
R
Robert Speicher 已提交
1054 1055 1056 1057 1058
        FileUtils.rm_rf(attributes_path)
      end
    end

    context "with .gitattrbutes" do
1059
      before do
R
Robert Speicher 已提交
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
        repository.copy_gitattributes("gitattributes")
      end

      it "has an info/attributes" do
        expect(File.exist?(attributes_path)).to be_truthy
      end

      it "has the same content in info/attributes as .gitattributes" do
        contents = File.open(attributes_path, "rb") { |f| f.read }
        expect(contents).to eq("*.md binary\n")
      end

1072
      after do
R
Robert Speicher 已提交
1073 1074 1075 1076 1077
        FileUtils.rm_rf(attributes_path)
      end
    end

    context "with updated .gitattrbutes" do
1078
      before do
R
Robert Speicher 已提交
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
        repository.copy_gitattributes("gitattributes")
        repository.copy_gitattributes("gitattributes-updated")
      end

      it "has an info/attributes" do
        expect(File.exist?(attributes_path)).to be_truthy
      end

      it "has the updated content in info/attributes" do
        contents = File.read(attributes_path)
        expect(contents).to eq("*.txt binary\n")
      end

1092
      after do
R
Robert Speicher 已提交
1093 1094 1095 1096 1097
        FileUtils.rm_rf(attributes_path)
      end
    end

    context "with no .gitattrbutes in HEAD but with previous info/attributes" do
1098
      before do
R
Robert Speicher 已提交
1099 1100 1101 1102 1103 1104 1105 1106
        repository.copy_gitattributes("gitattributes")
        repository.copy_gitattributes("master")
      end

      it "does not have an info/attributes" do
        expect(File.exist?(attributes_path)).to be_falsey
      end

1107
      after do
R
Robert Speicher 已提交
1108 1109 1110 1111 1112 1113
        FileUtils.rm_rf(attributes_path)
      end
    end
  end

  describe '#tag_exists?' do
1114 1115 1116
    shared_examples 'checks the existence of tags' do
      it 'returns true for an existing tag' do
        tag = repository.tag_names.first
R
Robert Speicher 已提交
1117

1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
        expect(repository.tag_exists?(tag)).to eq(true)
      end

      it 'returns false for a non-existing tag' do
        expect(repository.tag_exists?('v9000')).to eq(false)
      end
    end

    context 'when Gitaly ref_exists_tags feature is enabled' do
      it_behaves_like 'checks the existence of tags'
R
Robert Speicher 已提交
1128 1129
    end

1130 1131
    context 'when Gitaly ref_exists_tags feature is disabled', skip_gitaly_mock: true do
      it_behaves_like 'checks the existence of tags'
R
Robert Speicher 已提交
1132 1133 1134 1135
    end
  end

  describe '#branch_exists?' do
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
    shared_examples 'checks the existence of branches' do
      it 'returns true for an existing branch' do
        expect(repository.branch_exists?('master')).to eq(true)
      end

      it 'returns false for a non-existing branch' do
        expect(repository.branch_exists?('kittens')).to eq(false)
      end

      it 'returns false when using an invalid branch name' do
        expect(repository.branch_exists?('.bla')).to eq(false)
      end
R
Robert Speicher 已提交
1148 1149
    end

1150 1151
    context 'when Gitaly ref_exists_branches feature is enabled' do
      it_behaves_like 'checks the existence of branches'
R
Robert Speicher 已提交
1152 1153
    end

1154 1155
    context 'when Gitaly ref_exists_branches feature is disabled', skip_gitaly_mock: true do
      it_behaves_like 'checks the existence of branches'
R
Robert Speicher 已提交
1156 1157 1158 1159 1160
    end
  end

  describe '#local_branches' do
    before(:all) do
1161
      @repo = Gitlab::Git::Repository.new('default', File.join(TEST_MUTABLE_REPO_PATH, '.git'))
R
Robert Speicher 已提交
1162 1163 1164 1165 1166 1167 1168 1169
    end

    after(:all) do
      FileUtils.rm_rf(TEST_MUTABLE_REPO_PATH)
      ensure_seeds
    end

    it 'returns the local branches' do
1170
      create_remote_branch(@repo, 'joe', 'remote_branch', 'master')
R
Robert Speicher 已提交
1171 1172 1173 1174 1175
      @repo.create_branch('local_branch', 'master')

      expect(@repo.local_branches.any? { |branch| branch.name == 'remote_branch' }).to eq(false)
      expect(@repo.local_branches.any? { |branch| branch.name == 'local_branch' }).to eq(true)
    end
1176

J
Jacob Vosmaer 已提交
1177 1178 1179 1180
    it 'returns a Branch with UTF-8 fields' do
      branches = @repo.local_branches.to_a
      expect(branches.size).to be > 0
      branches.each do |branch|
J
Jacob Vosmaer 已提交
1181 1182
        expect(branch.name).to be_utf8
        expect(branch.target).to be_utf8 unless branch.target.nil?
J
Jacob Vosmaer 已提交
1183
      end
J
Jacob Vosmaer 已提交
1184
    end
J
Jacob Vosmaer 已提交
1185

J
Jacob Vosmaer 已提交
1186
    it 'gets the branches from GitalyClient' do
A
Andrew Newdigate 已提交
1187
      expect_any_instance_of(Gitlab::GitalyClient::RefService).to receive(:local_branches)
J
Jacob Vosmaer 已提交
1188 1189 1190
        .and_return([])
      @repo.local_branches
    end
1191

A
Andrew Newdigate 已提交
1192
    it_behaves_like 'wrapping gRPC errors', Gitlab::GitalyClient::RefService, :local_branches do
1193
      subject { @repo.local_branches }
1194
    end
R
Robert Speicher 已提交
1195 1196
  end

1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
  describe '#languages' do
    shared_examples 'languages' do
      it 'returns exactly the expected results' do
        languages = repository.languages('4b4918a572fa86f9771e5ba40fbd48e1eb03e2c6')
        expected_languages = [
          { value: 66.63, label: "Ruby", color: "#701516", highlight: "#701516" },
          { value: 22.96, label: "JavaScript", color: "#f1e05a", highlight: "#f1e05a" },
          { value: 7.9, label: "HTML", color: "#e44b23", highlight: "#e44b23" },
          { value: 2.51, label: "CoffeeScript", color: "#244776", highlight: "#244776" }
        ]

        expect(languages.size).to eq(expected_languages.size)

        expected_languages.size.times do |i|
          a = expected_languages[i]
          b = languages[i]

          expect(a.keys.sort).to eq(b.keys.sort)
          expect(a[:value]).to be_within(0.1).of(b[:value])

          non_float_keys = a.keys - [:value]
          expect(a.values_at(*non_float_keys)).to eq(b.values_at(*non_float_keys))
        end
      end

      it "uses the repository's HEAD when no ref is passed" do
        lang = repository.languages.first

        expect(lang[:label]).to eq('Ruby')
      end
    end

    it_behaves_like 'languages'

    context 'with rugged', skip_gitaly_mock: true do
      it_behaves_like 'languages'
    end
  end

1236 1237 1238
  def create_remote_branch(repository, remote_name, branch_name, source_branch_name)
    source_branch = repository.branches.find { |branch| branch.name == source_branch_name }
    rugged = repository.rugged
R
Robert Speicher 已提交
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
    rugged.references.create("refs/remotes/#{remote_name}/#{branch_name}", source_branch.dereferenced_target.sha)
  end

  # Build the options hash that's passed to Rugged::Commit#create
  def commit_options(repo, index, message)
    options = {}
    options[:tree] = index.write_tree(repo)
    options[:author] = {
      email: "test@example.com",
      name: "Test Author",
      time: Time.gm(2014, "mar", 3, 20, 15, 1)
    }
    options[:committer] = {
      email: "test@example.com",
      name: "Test Author",
      time: Time.gm(2014, "mar", 3, 20, 15, 1)
    }
    options[:message] ||= message
    options[:parents] = repo.empty? ? [] : [repo.head.target].compact
    options[:update_ref] = "HEAD"

    options
  end

  # Writes a new commit to the repo and returns a Rugged::Commit.  Replaces the
  # contents of CHANGELOG with a single new line of text.
  def new_commit_edit_old_file(repo)
    oid = repo.write("I replaced the changelog with this text", :blob)
    index = repo.index
    index.read_tree(repo.head.target.tree)
    index.add(path: "CHANGELOG", oid: oid, mode: 0100644)

    options = commit_options(
      repo,
      index,
      "Edit CHANGELOG in its original location"
    )

    sha = Rugged::Commit.create(repo, options)
    repo.lookup(sha)
  end

  # Writes a new commit to the repo and returns a Rugged::Commit.  Replaces the
  # contents of encoding/CHANGELOG with new text.
  def new_commit_edit_new_file(repo)
    oid = repo.write("I'm a new changelog with different text", :blob)
    index = repo.index
    index.read_tree(repo.head.target.tree)
    index.add(path: "encoding/CHANGELOG", oid: oid, mode: 0100644)

    options = commit_options(repo, index, "Edit encoding/CHANGELOG")

    sha = Rugged::Commit.create(repo, options)
    repo.lookup(sha)
  end

  # Writes a new commit to the repo and returns a Rugged::Commit.  Moves the
  # CHANGELOG file to the encoding/ directory.
  def new_commit_move_file(repo)
    blob_oid = repo.head.target.tree.detect { |i| i[:name] == "CHANGELOG" }[:oid]
    file_content = repo.lookup(blob_oid).content
    oid = repo.write(file_content, :blob)
    index = repo.index
    index.read_tree(repo.head.target.tree)
    index.add(path: "encoding/CHANGELOG", oid: oid, mode: 0100644)
    index.remove("CHANGELOG")

    options = commit_options(repo, index, "Move CHANGELOG to encoding/")

    sha = Rugged::Commit.create(repo, options)
    repo.lookup(sha)
  end
end