summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/reference_extractor_spec.rb
blob: c9fb62b61ae7a8218efc464484e362baf4685e60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
require 'spec_helper'

describe Gitlab::ReferenceExtractor do
  let(:project) { create(:project) }
  subject { Gitlab::ReferenceExtractor.new(project, project.creator) }

  it 'extracts username references' do
    subject.analyze('this contains a @user reference')
    expect(subject.references[:user]).to eq([[project, 'user']])
  end

  it 'extracts issue references' do
    subject.analyze('this one talks about issue #1234')
    expect(subject.references[:issue]).to eq([[project, '1234']])
  end

  it 'extracts JIRA issue references' do
    subject.analyze('this one talks about issue JIRA-1234')
    expect(subject.references[:issue]).to eq([[project, 'JIRA-1234']])
  end

  it 'extracts merge request references' do
    subject.analyze("and here's !43, a merge request")
    expect(subject.references[:merge_request]).to eq([[project, '43']])
  end

  it 'extracts snippet ids' do
    subject.analyze('snippets like $12 get extracted as well')
    expect(subject.references[:snippet]).to eq([[project, '12']])
  end

  it 'extracts commit shas' do
    subject.analyze('commit shas 98cf0ae3 are pulled out as Strings')
    expect(subject.references[:commit]).to eq([[project, '98cf0ae3']])
  end

  it 'extracts commit ranges' do
    subject.analyze('here you go, a commit range: 98cf0ae3...98cf0ae4')
    expect(subject.references[:commit_range]).to eq([[project, '98cf0ae3...98cf0ae4']])
  end

  it 'extracts multiple references and preserves their order' do
    subject.analyze('@me and @you both care about this')
    expect(subject.references[:user]).to eq([
      [project, 'me'],
      [project, 'you']
    ])
  end

  it 'leaves the original note unmodified' do
    text = 'issue #123 is just the worst, @user'
    subject.analyze(text)
    expect(text).to eq('issue #123 is just the worst, @user')
  end

  it 'extracts no references for <pre>..</pre> blocks' do
    subject.analyze("<pre>def puts '#1 issue'\nend\n</pre>```")
    expect(subject.issues).to be_blank
  end

  it 'extracts no references for <code>..</code> blocks' do
    subject.analyze("<code>def puts '!1 request'\nend\n</code>```")
    expect(subject.merge_requests).to be_blank
  end

  it 'extracts no references for code blocks with language' do
    subject.analyze("this code:\n```ruby\ndef puts '#1 issue'\nend\n```")
    expect(subject.issues).to be_blank
  end

  it 'extracts issue references for invalid code blocks' do
    subject.analyze('test: ```this one talks about issue #1234```')
    expect(subject.references[:issue]).to eq([[project, '1234']])
  end

  it 'handles all possible kinds of references' do
    accessors = Gitlab::Markdown::TYPES.map { |t| "#{t}s".to_sym }
    expect(subject).to respond_to(*accessors)
  end

  it 'accesses valid user objects' do
    @u_foo = create(:user, username: 'foo')
    @u_bar = create(:user, username: 'bar')
    @u_offteam = create(:user, username: 'offteam')

    project.team << [@u_foo, :reporter]
    project.team << [@u_bar, :guest]

    subject.analyze('@foo, @baduser, @bar, and @offteam')
    expect(subject.users).to eq([@u_foo, @u_bar, @u_offteam])
  end

  it 'accesses valid issue objects' do
    @i0 = create(:issue, project: project)
    @i1 = create(:issue, project: project)

    subject.analyze("##{@i0.iid}, ##{@i1.iid}, and #999.")
    expect(subject.issues).to eq([@i0, @i1])
  end

  it 'accesses valid merge requests' do
    @m0 = create(:merge_request, source_project: project, target_project: project, source_branch: 'aaa')
    @m1 = create(:merge_request, source_project: project, target_project: project, source_branch: 'bbb')

    subject.analyze("!999, !#{@m1.iid}, and !#{@m0.iid}.")
    expect(subject.merge_requests).to eq([@m1, @m0])
  end

  it 'accesses valid snippets' do
    @s0 = create(:project_snippet, project: project)
    @s1 = create(:project_snippet, project: project)
    @s2 = create(:project_snippet)

    subject.analyze("$#{@s0.id}, $999, $#{@s2.id}, $#{@s1.id}")
    expect(subject.snippets).to eq([@s0, @s1])
  end

  it 'accesses valid commits' do
    commit = project.repository.commit('master')

    subject.analyze("this references commits #{commit.sha[0..6]} and 012345")
    extracted = subject.commits
    expect(extracted.size).to eq(1)
    expect(extracted[0].sha).to eq(commit.sha)
    expect(extracted[0].message).to eq(commit.message)
  end

  it 'accesses valid commit ranges' do
    commit = project.repository.commit('master')
    earlier_commit = project.repository.commit('master~2')

    subject.analyze("this references commits #{earlier_commit.sha[0..6]}...#{commit.sha[0..6]}")
    extracted = subject.commit_ranges
    expect(extracted.size).to eq(1)
    expect(extracted[0][0].sha).to eq(earlier_commit.sha)
    expect(extracted[0][0].message).to eq(earlier_commit.message)
    expect(extracted[0][1].sha).to eq(commit.sha)
    expect(extracted[0][1].message).to eq(commit.message)
  end

  context 'with a project with an underscore' do
    let(:other_project) { create(:project, path: 'test_project') }
    let(:issue) { create(:issue, project: other_project) }

    before do
      other_project.team << [project.creator, :developer]
    end

    it 'handles project issue references' do
      subject.analyze("this refers issue #{other_project.path_with_namespace}##{issue.iid}")
      extracted = subject.issues
      expect(extracted.size).to eq(1)
      expect(extracted).to eq([issue])
    end
  end
end