BigW Consortium Gitlab

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

Douwe Maan committed
3
describe Commit, models: true 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 22 23 24 25 26 27 28 29 30 31 32 33 34 35
  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

    it 'caches the author' do
      user = create(:user, email: commit.author_email)
      expect(RequestStore).to receive(:active?).twice.and_return(true)
      expect_any_instance_of(Commit).to receive(:find_author_by_any_email).and_call_original

      expect(commit.author).to eq(user)
      key = "commit_author:#{commit.author_email}"
      expect(RequestStore.store[key]).to eq(user)

      expect(commit.author).to eq(user)
      RequestStore.store.clear
    end
  end

36
  describe '#to_reference' do
37
    let(:project) { create(:project, :repository, path: 'sample-project') }
38 39
    let(:commit)  { project.commit }

40
    it 'returns a String reference to the object' do
41
      expect(commit.to_reference).to eq commit.id
42 43 44
    end

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

  describe '#reference_link_text' do
51
    let(:project) { create(:project, :repository, path: 'sample-project') }
52 53
    let(:commit)  { project.commit }

54 55 56 57 58
    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
59
      another_project = build(:project, :repository, name: 'another-project', namespace: project.namespace)
60
      expect(commit.reference_link_text(another_project)).to eq "sample-project@#{commit.short_id}"
61 62
    end
  end
63

64 65
  describe '#title' do
    it "returns no_commit_message when safe_message is blank" do
66 67
      allow(commit).to receive(:safe_message).and_return('')
      expect(commit.title).to eq("--no commit message")
68
    end
69

70
    it "truncates a message without a newline at 80 characters" do
Dmitriy Zaporozhets committed
71
      message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sodales id felis id blandit. Vivamus egestas lacinia lacus, sed rutrum mauris.'
72

73
      allow(commit).to receive(:safe_message).and_return(message)
74
      expect(commit.title).to eq("#{message[0..79]}…")
75
    end
76

77 78
    it "truncates a message with a newline before 80 characters at the newline" do
      message = commit.safe_message.split(" ").first
79

80 81
      allow(commit).to receive(:safe_message).and_return(message + "\n" + message)
      expect(commit.title).to eq(message)
82
    end
83

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

90 91
      allow(commit).to receive(:safe_message).and_return(message)
      expect(commit.title).to eq(message.split("\n").first)
92 93
    end
  end
94

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
  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

116 117 118
  describe "delegation" do
    subject { commit }

119 120 121 122 123 124 125 126 127 128 129
    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) }
130
  end
131 132 133

  describe '#closes_issues' do
    let(:issue) { create :issue, project: project }
134
    let(:other_project) { create(:empty_project, :public) }
135
    let(:other_issue) { create :issue, project: other_project }
136 137 138 139 140 141
    let(:commiter) { create :user }

    before do
      project.team << [commiter, :developer]
      other_project.team << [commiter, :developer]
    end
142 143

    it 'detects issues that this commit is marked as closing' do
144
      ext_ref = "#{other_project.path_with_namespace}##{other_issue.iid}"
145 146 147 148 149 150

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

Douwe Maan committed
151 152
      expect(commit.closes_issues).to include(issue)
      expect(commit.closes_issues).to include(other_issue)
153
    end
154 155 156
  end

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

Douwe Maan committed
159
    let(:author) { create(:user, email: subject.author_email) }
160
    let(:backref_text) { "commit #{subject.id}" }
161 162 163
    let(:set_mentionable_text) do
      ->(txt) { allow(subject).to receive(:safe_message).and_return(txt) }
    end
164 165 166 167

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

  describe '#hook_attrs' do
Valery Sizov committed
170
    let(:data) { commit.hook_attrs(with_changed_files: true) }
171 172

    it { expect(data).to be_a(Hash) }
173 174 175 176
    it { expect(data[:message]).to include('adds bar folder and branch-test text file to check Repository merged_to_root_ref method') }
    it { expect(data[:timestamp]).to eq('2016-09-27T14:37:46+00:00') }
    it { expect(data[:added]).to eq(["bar/branch-test.txt"]) }
    it { expect(data[:modified]).to eq([]) }
177 178
    it { expect(data[:removed]).to eq([]) }
  end
179 180 181

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

184
    it { expect(commit.reverts_commit?(another_commit, user)).to be_falsy }
185 186 187 188

    context 'commit has no description' do
      before { allow(commit).to receive(:description?).and_return(false) }

189
      it { expect(commit.reverts_commit?(another_commit, user)).to be_falsy }
190 191 192 193 194
    end

    context "another_commit's description does not revert commit" do
      before { allow(commit).to receive(:description).and_return("Foo Bar") }

195
      it { expect(commit.reverts_commit?(another_commit, user)).to be_falsy }
196 197 198 199 200
    end

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

201
      it { expect(commit.reverts_commit?(another_commit, user)).to be_truthy }
202 203 204 205 206 207 208 209 210
    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

211
      it { expect(commit.reverts_commit?(another_commit, user)).to be_truthy }
212 213
    end
  end
214 215

  describe '#status' do
216
    context 'without ref argument' do
217
      before do
218
        %w[success failed created pending].each do |status|
219 220 221
          create(:ci_empty_pipeline,
                 project: project,
                 sha: commit.sha,
222
                 status: status)
223 224
        end
      end
225

226
      it 'gives compound status from latest pipelines' do
227
        expect(commit.status).to eq(Ci::Pipeline.latest_status)
228
        expect(commit.status).to eq('pending')
229
      end
230 231
    end

232 233 234 235 236 237 238 239
    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
240

241 242 243 244 245 246 247
      let!(:pipeline_from_fix) do
        create(:ci_empty_pipeline,
               project: project,
               sha: commit.sha,
               ref: 'fix',
               status: 'success')
      end
248

249 250 251 252
      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
253

254
      it 'gives compound status from latest pipelines if ref is nil' do
255
        expect(commit.status(nil)).to eq(Ci::Pipeline.latest_status)
256
        expect(commit.status(nil)).to eq('failed')
257
      end
258
    end
259
  end
Yorick Peterse committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295

  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
296 297 298 299 300

  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)
301
      expect(project.commit('video').uri_type('files/videos/intro.mp4')).to be(:raw)
302 303 304 305 306 307 308
      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
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325

  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
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

  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
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371

  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
372
end