BigW Consortium Gitlab

commit_spec.rb 15.5 KB
Newer Older
1 2
require 'spec_helper'

3
describe Commit do
4
  let(:project) { create(:project, :public, :repository) }
5 6 7 8 9 10 11 12 13 14 15
  let(:commit)  { project.commit }

  describe 'modules' do
    subject { described_class }

    it { is_expected.to include_module(Mentionable) }
    it { is_expected.to include_module(Participable) }
    it { is_expected.to include_module(Referable) }
    it { is_expected.to include_module(StaticModel) }
  end

16 17 18 19 20 21
  describe '#author' do
    it 'looks up the author in a case-insensitive way' do
      user = create(:user, email: commit.author_email.upcase)
      expect(commit.author).to eq(user)
    end

22
    it 'caches the author', :request_store do
23
      user = create(:user, email: commit.author_email)
24
      expect(User).to receive(:find_by_any_email).and_call_original
25 26

      expect(commit.author).to eq(user)
27
      key = "Commit:author:#{commit.author_email.downcase}"
28 29 30 31 32 33
      expect(RequestStore.store[key]).to eq(user)

      expect(commit.author).to eq(user)
    end
  end

34
  describe '#to_reference' do
35
    let(:project) { create(:project, :repository, path: 'sample-project') }
36

37
    it 'returns a String reference to the object' do
38
      expect(commit.to_reference).to eq commit.id
39 40 41
    end

    it 'supports a cross-project reference' do
42
      another_project = build(:project, :repository, name: 'another-project', namespace: project.namespace)
43
      expect(commit.to_reference(another_project)).to eq "sample-project@#{commit.id}"
44 45 46 47
    end
  end

  describe '#reference_link_text' do
48
    let(:project) { create(:project, :repository, path: 'sample-project') }
49

50 51 52 53 54
    it 'returns a String reference to the object' do
      expect(commit.reference_link_text).to eq commit.short_id
    end

    it 'supports a cross-project reference' do
55
      another_project = build(:project, :repository, name: 'another-project', namespace: project.namespace)
56
      expect(commit.reference_link_text(another_project)).to eq "sample-project@#{commit.short_id}"
57 58
    end
  end
59

60 61
  describe '#title' do
    it "returns no_commit_message when safe_message is blank" do
62 63
      allow(commit).to receive(:safe_message).and_return('')
      expect(commit.title).to eq("--no commit message")
64
    end
65

66
    it 'truncates a message without a newline at natural break to 80 characters' do
Dmitriy Zaporozhets committed
67
      message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit. Vivamus egestas lacinia lacus, sed rutrum mauris.'
68

69
      allow(commit).to receive(:safe_message).and_return(message)
70
      expect(commit.title).to eq('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis…')
71
    end
72

73 74
    it "truncates a message with a newline before 80 characters at the newline" do
      message = commit.safe_message.split(" ").first
75

76 77
      allow(commit).to receive(:safe_message).and_return(message + "\n" + message)
      expect(commit.title).to eq(message)
78
    end
79

Dmitriy Zaporozhets committed
80
    it "does not truncates a message with a newline after 80 but less 100 characters" do
81
      message = <<eos
Dmitriy Zaporozhets committed
82 83 84
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit.
Vivamus egestas lacinia lacus, sed rutrum mauris.
eos
85

86 87
      allow(commit).to receive(:safe_message).and_return(message)
      expect(commit.title).to eq(message.split("\n").first)
88 89
    end
  end
90

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
  describe '#full_title' do
    it "returns no_commit_message when safe_message is blank" do
      allow(commit).to receive(:safe_message).and_return('')
      expect(commit.full_title).to eq("--no commit message")
    end

    it "returns entire message if there is no newline" do
      message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit. Vivamus egestas lacinia lacus, sed rutrum mauris.'

      allow(commit).to receive(:safe_message).and_return(message)
      expect(commit.full_title).to eq(message)
    end

    it "returns first line of message if there is a newLine" do
      message = commit.safe_message.split(" ").first

      allow(commit).to receive(:safe_message).and_return(message + "\n" + message)
      expect(commit.full_title).to eq(message)
    end
  end

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
  describe 'description' do
    it 'returns description of commit message if title less than 100 characters' do
      message = <<eos
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit.
Vivamus egestas lacinia lacus, sed rutrum mauris.
eos

      allow(commit).to receive(:safe_message).and_return(message)
      expect(commit.description).to eq('Vivamus egestas lacinia lacus, sed rutrum mauris.')
    end

    it 'returns full commit message if commit title more than 100 characters' do
      message = <<eos
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit. Vivamus egestas lacinia lacus, sed rutrum mauris.
Vivamus egestas lacinia lacus, sed rutrum mauris.
eos

      allow(commit).to receive(:safe_message).and_return(message)
      expect(commit.description).to eq(message)
    end
  end

134 135 136
  describe "delegation" do
    subject { commit }

137 138 139 140 141 142 143 144 145 146 147
    it { is_expected.to respond_to(:message) }
    it { is_expected.to respond_to(:authored_date) }
    it { is_expected.to respond_to(:committed_date) }
    it { is_expected.to respond_to(:committer_email) }
    it { is_expected.to respond_to(:author_email) }
    it { is_expected.to respond_to(:parents) }
    it { is_expected.to respond_to(:date) }
    it { is_expected.to respond_to(:diffs) }
    it { is_expected.to respond_to(:tree) }
    it { is_expected.to respond_to(:id) }
    it { is_expected.to respond_to(:to_patch) }
148
  end
149 150 151

  describe '#closes_issues' do
    let(:issue) { create :issue, project: project }
152
    let(:other_project) { create(:project, :public) }
153
    let(:other_issue) { create :issue, project: other_project }
154 155 156 157 158 159
    let(:commiter) { create :user }

    before do
      project.team << [commiter, :developer]
      other_project.team << [commiter, :developer]
    end
160 161

    it 'detects issues that this commit is marked as closing' do
162
      ext_ref = "#{other_project.full_path}##{other_issue.iid}"
163 164 165 166 167 168

      allow(commit).to receive_messages(
        safe_message: "Fixes ##{issue.iid} and #{ext_ref}",
        committer_email: commiter.email
      )

Douwe Maan committed
169 170
      expect(commit.closes_issues).to include(issue)
      expect(commit.closes_issues).to include(other_issue)
171
    end
172 173 174
  end

  it_behaves_like 'a mentionable' do
175
    subject { create(:project, :repository).commit }
176

Douwe Maan committed
177
    let(:author) { create(:user, email: subject.author_email) }
178
    let(:backref_text) { "commit #{subject.id}" }
179 180 181
    let(:set_mentionable_text) do
      ->(txt) { allow(subject).to receive(:safe_message).and_return(txt) }
    end
182 183 184 185

    # Include the subject in the repository stub.
    let(:extra_commits) { [subject] }
  end
186 187

  describe '#hook_attrs' do
Valery Sizov committed
188
    let(:data) { commit.hook_attrs(with_changed_files: true) }
189 190

    it { expect(data).to be_a(Hash) }
191
    it { expect(data[:message]).to include('adds bar folder and branch-test text file to check Repository merged_to_root_ref method') }
192
    it { expect(data[:timestamp]).to eq('2016-09-27T14:37:46Z') }
193 194
    it { expect(data[:added]).to eq(["bar/branch-test.txt"]) }
    it { expect(data[:modified]).to eq([]) }
195 196
    it { expect(data[:removed]).to eq([]) }
  end
197

198
  describe '#cherry_pick_message' do
199
    let(:user) { create(:user) }
200 201

    context 'of a regular commit' do
202 203 204
      let(:commit) { project.commit('video') }

      it { expect(commit.cherry_pick_message(user)).to include("\n\n(cherry picked from commit 88790590ed1337ab189bccaa355f068481c90bec)") }
205 206 207
    end

    context 'of a merge commit' do
208 209
      let(:repository) { project.repository }

210 211 212 213 214 215 216
      let(:merge_request) do
        create(:merge_request,
               source_branch: 'video',
               target_branch: 'master',
               source_project: project,
               author: user)
      end
217

218
      let(:merge_commit) do
219 220 221
        merge_commit_id = repository.merge(user,
                                           merge_request.diff_head_sha,
                                           merge_request,
222
                                           'Test message')
223

224 225
        repository.commit(merge_commit_id)
      end
226

227 228 229 230 231
      context 'that is found' do
        before do
          # Artificially mark as completed.
          merge_request.update(merge_commit_sha: merge_commit.id)
        end
232

233 234
        it do
          expected_appended_text = <<~STR.rstrip
235

236
            (cherry picked from commit #{merge_commit.sha})
237

238 239 240
            467dc98f Add new 'videos' directory
            88790590 Upload new video file
          STR
241

242 243 244
          expect(merge_commit.cherry_pick_message(user)).to include(expected_appended_text)
        end
      end
245

246 247
      context "that is existing but not found" do
        it 'does not include details of the merged commits' do
248 249
          expect(merge_commit.cherry_pick_message(user)).to end_with("(cherry picked from commit #{merge_commit.sha})")
        end
250 251 252 253
      end
    end
  end

254 255
  describe '#reverts_commit?' do
    let(:another_commit) { double(:commit, revert_description: "This reverts commit #{commit.sha}") }
256
    let(:user) { commit.author }
257

258
    it { expect(commit.reverts_commit?(another_commit, user)).to be_falsy }
259 260

    context 'commit has no description' do
261 262 263
      before do
        allow(commit).to receive(:description?).and_return(false)
      end
264

265
      it { expect(commit.reverts_commit?(another_commit, user)).to be_falsy }
266 267 268
    end

    context "another_commit's description does not revert commit" do
269 270 271
      before do
        allow(commit).to receive(:description).and_return("Foo Bar")
      end
272

273
      it { expect(commit.reverts_commit?(another_commit, user)).to be_falsy }
274 275 276
    end

    context "another_commit's description reverts commit" do
277 278 279
      before do
        allow(commit).to receive(:description).and_return("Foo #{another_commit.revert_description} Bar")
      end
280

281
      it { expect(commit.reverts_commit?(another_commit, user)).to be_truthy }
282 283 284 285 286 287 288 289 290
    end

    context "another_commit's description reverts merged merge request" do
      before do
        revert_description = "This reverts merge request !foo123"
        allow(another_commit).to receive(:revert_description).and_return(revert_description)
        allow(commit).to receive(:description).and_return("Foo #{another_commit.revert_description} Bar")
      end

291
      it { expect(commit.reverts_commit?(another_commit, user)).to be_truthy }
292 293
    end
  end
294

295
  describe '#last_pipeline' do
296 297 298 299 300 301 302 303 304 305 306 307 308
    let!(:first_pipeline) do
      create(:ci_empty_pipeline,
        project: project,
        sha: commit.sha,
        status: 'success')
    end
    let!(:second_pipeline) do
      create(:ci_empty_pipeline,
        project: project,
        sha: commit.sha,
        status: 'success')
    end

309 310
    it 'returns last pipeline' do
      expect(commit.last_pipeline).to eq second_pipeline
311 312 313
    end
  end

314
  describe '#status' do
315
    context 'without ref argument' do
316
      before do
317
        %w[success failed created pending].each do |status|
318 319 320
          create(:ci_empty_pipeline,
                 project: project,
                 sha: commit.sha,
321
                 status: status)
322 323
        end
      end
324

325
      it 'gives compound status from latest pipelines' do
326
        expect(commit.status).to eq(Ci::Pipeline.latest_status)
327
        expect(commit.status).to eq('pending')
328
      end
329 330
    end

331 332 333 334 335 336 337 338
    context 'when a particular ref is specified' do
      let!(:pipeline_from_master) do
        create(:ci_empty_pipeline,
               project: project,
               sha: commit.sha,
               ref: 'master',
               status: 'failed')
      end
339

340 341 342 343 344 345 346
      let!(:pipeline_from_fix) do
        create(:ci_empty_pipeline,
               project: project,
               sha: commit.sha,
               ref: 'fix',
               status: 'success')
      end
347

348 349 350 351
      it 'gives pipelines from a particular branch' do
        expect(commit.status('master')).to eq(pipeline_from_master.status)
        expect(commit.status('fix')).to eq(pipeline_from_fix.status)
      end
352

353
      it 'gives compound status from latest pipelines if ref is nil' do
354
        expect(commit.status(nil)).to eq(pipeline_from_fix.status)
355
      end
356
    end
357
  end
Yorick Peterse committed
358

359 360 361 362 363 364 365 366
  describe '#set_status_for_ref' do
    it 'sets the status for a given reference' do
      commit.set_status_for_ref('master', 'failed')

      expect(commit.status('master')).to eq('failed')
    end
  end

Yorick Peterse committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
  describe '#participants' do
    let(:user1) { build(:user) }
    let(:user2) { build(:user) }

    let!(:note1) do
      create(:note_on_commit,
             commit_id: commit.id,
             project: project,
             note: 'foo')
    end

    let!(:note2) do
      create(:note_on_commit,
             commit_id: commit.id,
             project: project,
             note: 'bar')
    end

    before do
      allow(commit).to receive(:author).and_return(user1)
      allow(commit).to receive(:committer).and_return(user2)
    end

    it 'includes the commit author' do
      expect(commit.participants).to include(commit.author)
    end

    it 'includes the committer' do
      expect(commit.participants).to include(commit.committer)
    end

    it 'includes the authors of the commit notes' do
      expect(commit.participants).to include(note1.author, note2.author)
    end
  end
402 403 404 405 406

  describe '#uri_type' do
    it 'returns the URI type at the given path' do
      expect(commit.uri_type('files/html')).to be(:tree)
      expect(commit.uri_type('files/images/logo-black.png')).to be(:raw)
407
      expect(project.commit('video').uri_type('files/videos/intro.mp4')).to be(:raw)
408 409 410 411 412 413 414
      expect(commit.uri_type('files/js/application.js')).to be(:blob)
    end

    it "returns nil if the path doesn't exists" do
      expect(commit.uri_type('this/path/doesnt/exist')).to be_nil
    end
  end
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431

  describe '.from_hash' do
    let(:new_commit) { described_class.from_hash(commit.to_hash, project) }

    it 'returns a Commit' do
      expect(new_commit).to be_an_instance_of(described_class)
    end

    it 'wraps a Gitlab::Git::Commit' do
      expect(new_commit.raw).to be_an_instance_of(Gitlab::Git::Commit)
    end

    it 'stores the correct commit fields' do
      expect(new_commit.id).to eq(commit.id)
      expect(new_commit.message).to eq(commit.message)
    end
  end
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459

  describe '#work_in_progress?' do
    ['squash! ', 'fixup! ', 'wip: ', 'WIP: ', '[WIP] '].each do |wip_prefix|
      it "detects the '#{wip_prefix}' prefix" do
        commit.message = "#{wip_prefix}#{commit.message}"

        expect(commit).to be_work_in_progress
      end
    end

    it "detects WIP for a commit just saying 'wip'" do
      commit.message = "wip"

      expect(commit).to be_work_in_progress
    end

    it "doesn't detect WIP for a commit that begins with 'FIXUP! '" do
      commit.message = "FIXUP! #{commit.message}"

      expect(commit).not_to be_work_in_progress
    end

    it "doesn't detect WIP for words starting with WIP" do
      commit.message = "Wipout #{commit.message}"

      expect(commit).not_to be_work_in_progress
    end
  end
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477

  describe '.valid_hash?' do
    it 'checks hash contents' do
      expect(described_class.valid_hash?('abcdef01239ABCDEF')).to be true
      expect(described_class.valid_hash?("abcdef01239ABCD\nEF")).to be false
      expect(described_class.valid_hash?(' abcdef01239ABCDEF ')).to be false
      expect(described_class.valid_hash?('Gabcdef01239ABCDEF')).to be false
      expect(described_class.valid_hash?('gabcdef01239ABCDEF')).to be false
      expect(described_class.valid_hash?('-abcdef01239ABCDEF')).to be false
    end

    it 'checks hash length' do
      expect(described_class.valid_hash?('a' * 6)).to be false
      expect(described_class.valid_hash?('a' * 7)).to be true
      expect(described_class.valid_hash?('a' * 40)).to be true
      expect(described_class.valid_hash?('a' * 41)).to be false
    end
  end
478
end