Welcome to mirror list, hosted at ThFree Co, Russian Federation.

merge_commit_message_spec.rb « merge_requests « gitlab « lib « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 884f8df5e562c76e34d7fece6f23776ec4c63568 (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::MergeRequests::MergeCommitMessage do
  let(:merge_commit_template) { nil }
  let(:project) { create(:project, :public, :repository, merge_commit_template: merge_commit_template) }
  let(:user) { project.creator }
  let(:merge_request_description) { "Merge Request Description\nNext line" }
  let(:merge_request_title) { 'Bugfix' }
  let(:merge_request) do
    create(
      :merge_request,
      :simple,
      source_project: project,
      target_project: project,
      author: user,
      description: merge_request_description,
      title: merge_request_title
    )
  end

  subject { described_class.new(merge_request: merge_request) }

  it 'returns nil when template is not set in target project' do
    expect(subject.message).to be_nil
  end

  context 'when project has custom merge commit template' do
    let(:merge_commit_template) { <<~MSG.rstrip }
      %{title}

      See merge request %{reference}
    MSG

    it 'uses custom template' do
      expect(subject.message).to eq <<~MSG.rstrip
        Bugfix

        See merge request #{merge_request.to_reference(full: true)}
      MSG
    end
  end

  context 'when project has merge commit template with closed issues' do
    let(:merge_commit_template) { <<~MSG.rstrip }
      Merge branch '%{source_branch}' into '%{target_branch}'

      %{title}

      %{issues}

      See merge request %{reference}
    MSG

    it 'omits issues and new lines when no issues are mentioned in description' do
      expect(subject.message).to eq <<~MSG.rstrip
        Merge branch 'feature' into 'master'

        Bugfix

        See merge request #{merge_request.to_reference(full: true)}
      MSG
    end

    context 'when MR closes issues' do
      let(:issue_1) { create(:issue, project: project) }
      let(:issue_2) { create(:issue, project: project) }
      let(:merge_request_description) { "Description\n\nclosing #{issue_1.to_reference}, #{issue_2.to_reference}" }

      it 'includes them and keeps new line characters' do
        expect(subject.message).to eq <<~MSG.rstrip
          Merge branch 'feature' into 'master'

          Bugfix

          Closes #{issue_1.to_reference} and #{issue_2.to_reference}

          See merge request #{merge_request.to_reference(full: true)}
        MSG
      end
    end
  end

  context 'when project has merge commit template with description' do
    let(:merge_commit_template) { <<~MSG.rstrip }
      Merge branch '%{source_branch}' into '%{target_branch}'

      %{title}

      %{description}

      See merge request %{reference}
    MSG

    it 'uses template' do
      expect(subject.message).to eq <<~MSG.rstrip
        Merge branch 'feature' into 'master'

        Bugfix

        Merge Request Description
        Next line

        See merge request #{merge_request.to_reference(full: true)}
      MSG
    end

    context 'when description is empty string' do
      let(:merge_request_description) { '' }

      it 'skips description placeholder and removes new line characters before it' do
        expect(subject.message).to eq <<~MSG.rstrip
          Merge branch 'feature' into 'master'

          Bugfix

          See merge request #{merge_request.to_reference(full: true)}
        MSG
      end
    end

    context 'when description is nil' do
      let(:merge_request_description) { nil }

      it 'skips description placeholder and removes new line characters before it' do
        expect(subject.message).to eq <<~MSG.rstrip
          Merge branch 'feature' into 'master'

          Bugfix

          See merge request #{merge_request.to_reference(full: true)}
        MSG
      end
    end

    context 'when description is blank string' do
      let(:merge_request_description) { "\n\r  \n" }

      it 'skips description placeholder and removes new line characters before it' do
        expect(subject.message).to eq <<~MSG.rstrip
          Merge branch 'feature' into 'master'

          Bugfix

          See merge request #{merge_request.to_reference(full: true)}
        MSG
      end
    end
  end

  context 'when custom merge commit template contains placeholder in the middle or beginning of the line' do
    let(:merge_commit_template) { <<~MSG.rstrip }
      Merge branch '%{source_branch}' into '%{target_branch}'

      %{description} %{title}

      See merge request %{reference}
    MSG

    it 'uses custom template' do
      expect(subject.message).to eq <<~MSG.rstrip
        Merge branch 'feature' into 'master'

        Merge Request Description
        Next line Bugfix

        See merge request #{merge_request.to_reference(full: true)}
      MSG
    end

    context 'when description is empty string' do
      let(:merge_request_description) { '' }

      it 'does not remove new line characters before empty placeholder' do
        expect(subject.message).to eq <<~MSG.rstrip
          Merge branch 'feature' into 'master'

           Bugfix

          See merge request #{merge_request.to_reference(full: true)}
        MSG
      end
    end
  end

  context 'when project has template with CRLF newlines' do
    let(:merge_commit_template) do
      "Merge branch '%{source_branch}' into '%{target_branch}'\r\n\r\n%{title}\r\n\r\n%{description}\r\n\r\nSee merge request %{reference}"
    end

    it 'converts it to LF newlines' do
      expect(subject.message).to eq <<~MSG.rstrip
        Merge branch 'feature' into 'master'

        Bugfix

        Merge Request Description
        Next line

        See merge request #{merge_request.to_reference(full: true)}
      MSG
    end

    context 'when description is empty string' do
      let(:merge_request_description) { '' }

      it 'skips description placeholder and removes new line characters before it' do
        expect(subject.message).to eq <<~MSG.rstrip
          Merge branch 'feature' into 'master'

          Bugfix

          See merge request #{merge_request.to_reference(full: true)}
        MSG
      end
    end
  end
end