milestones_shared_examples.rb 13.6 KB
Newer Older
1 2
shared_examples_for 'group and project milestones' do |route_definition|
  let(:resource_route) { "#{route}/#{milestone.id}" }
3 4 5
  let(:label_1) { create(:label, title: 'label_1', project: project, priority: 1) }
  let(:label_2) { create(:label, title: 'label_2', project: project, priority: 2) }
  let(:label_3) { create(:label, title: 'label_3', project: project) }
6 7
  let(:merge_request) { create(:merge_request, source_project: project) }
  let(:another_merge_request) { create(:merge_request, :simple, source_project: project) }
Robert Speicher's avatar
Robert Speicher committed
8

9 10 11
  describe "GET #{route_definition}" do
    it 'returns milestones list' do
      get api(route, user)
12

13
      expect(response).to have_gitlab_http_status(200)
14
      expect(response).to include_pagination_headers
15 16
      expect(json_response).to be_an Array
      expect(json_response.first['title']).to eq(milestone.title)
Robert Speicher's avatar
Robert Speicher committed
17
    end
18

19
    it 'returns a 401 error if user not authenticated' do
20
      get api(route)
21

22
      expect(response).to have_gitlab_http_status(401)
23
    end
24

25
    it 'returns an array of active milestones' do
26
      get api("#{route}/?state=active", user)
27

28
      expect(response).to have_gitlab_http_status(200)
29
      expect(response).to include_pagination_headers
30 31 32 33 34
      expect(json_response).to be_an Array
      expect(json_response.length).to eq(1)
      expect(json_response.first['id']).to eq(milestone.id)
    end

35
    it 'returns an array of closed milestones' do
36
      get api("#{route}/?state=closed", user)
37

38
      expect(response).to have_gitlab_http_status(200)
39
      expect(response).to include_pagination_headers
40 41 42 43
      expect(json_response).to be_an Array
      expect(json_response.length).to eq(1)
      expect(json_response.first['id']).to eq(closed_milestone.id)
    end
44

45
    it 'returns an array of milestones specified by iids' do
46
      other_milestone = create(:milestone, project: try(:project), group: try(:group))
47

48
      get api(route, user), iids: [closed_milestone.iid, other_milestone.iid]
49

50
      expect(response).to have_gitlab_http_status(200)
51 52
      expect(json_response).to be_an Array
      expect(json_response.length).to eq(2)
53
      expect(json_response.map { |m| m['id'] }).to match_array([closed_milestone.id, other_milestone.id])
54 55 56
    end

    it 'does not return any milestone if none found' do
57
      get api(route, user), iids: [Milestone.maximum(:iid).succ]
58

59
      expect(response).to have_gitlab_http_status(200)
60 61 62 63
      expect(json_response).to be_an Array
      expect(json_response.length).to eq(0)
    end

64 65
    it 'returns a milestone by iids array' do
      get api("#{route}?iids=#{closed_milestone.iid}", user)
66

67
      expect(response.status).to eq 200
68 69
      expect(response).to include_pagination_headers
      expect(json_response.size).to eq(1)
70 71 72
      expect(json_response.size).to eq(1)
      expect(json_response.first['title']).to eq closed_milestone.title
      expect(json_response.first['id']).to eq closed_milestone.id
73 74
    end

75 76
    it 'returns a milestone by searching for title' do
      get api(route, user), search: 'version2'
77

78
      expect(response).to have_gitlab_http_status(200)
79
      expect(response).to include_pagination_headers
80 81 82 83 84
      expect(json_response.size).to eq(1)
      expect(json_response.first['title']).to eq milestone.title
      expect(json_response.first['id']).to eq milestone.id
    end

85 86
    it 'returns a milestones by searching for description' do
      get api(route, user), search: 'open'
87

88
      expect(response).to have_gitlab_http_status(200)
89 90
      expect(response).to include_pagination_headers
      expect(json_response.size).to eq(1)
91 92 93
      expect(json_response.first['title']).to eq milestone.title
      expect(json_response.first['id']).to eq milestone.id
    end
94 95
  end

96 97 98 99
  describe "GET #{route_definition}/:milestone_id" do
    it 'returns a milestone by id' do
      get api(resource_route, user)

100
      expect(response).to have_gitlab_http_status(200)
101 102 103 104
      expect(json_response['title']).to eq(milestone.title)
      expect(json_response['iid']).to eq(milestone.iid)
    end

105
    it 'returns 401 error if user not authenticated' do
106
      get api(resource_route)
107

108
      expect(response).to have_gitlab_http_status(401)
109 110
    end

111
    it 'returns a 404 error if milestone id not found' do
112
      get api("#{route}/1234", user)
113

114
      expect(response).to have_gitlab_http_status(404)
115
    end
Robert Speicher's avatar
Robert Speicher committed
116 117
  end

118 119 120
  describe "POST #{route_definition}" do
    it 'creates a new milestone' do
      post api(route, user), title: 'new milestone'
121

122
      expect(response).to have_gitlab_http_status(201)
123 124
      expect(json_response['title']).to eq('new milestone')
      expect(json_response['description']).to be_nil
Robert Speicher's avatar
Robert Speicher committed
125
    end
126

127 128
    it 'creates a new milestone with description and dates' do
      post api(route, user),
129
        title: 'new milestone', description: 'release', due_date: '2013-03-02', start_date: '2013-02-02'
130

131
      expect(response).to have_gitlab_http_status(201)
132 133
      expect(json_response['description']).to eq('release')
      expect(json_response['due_date']).to eq('2013-03-02')
134
      expect(json_response['start_date']).to eq('2013-02-02')
135 136
    end

137
    it 'returns a 400 error if title is missing' do
138
      post api(route, user)
139

140
      expect(response).to have_gitlab_http_status(400)
141 142 143
    end

    it 'returns a 400 error if params are invalid (duplicate title)' do
144
      post api(route, user),
145 146
        title: milestone.title, description: 'release', due_date: '2013-03-02'

147
      expect(response).to have_gitlab_http_status(400)
148
    end
149

150 151
    it 'creates a new milestone with reserved html characters' do
      post api(route, user), title: 'foo & bar 1.1 -> 2.2'
152

153
      expect(response).to have_gitlab_http_status(201)
154 155 156
      expect(json_response['title']).to eq('foo & bar 1.1 -> 2.2')
      expect(json_response['description']).to be_nil
    end
Robert Speicher's avatar
Robert Speicher committed
157 158
  end

159 160 161
  describe "PUT #{route_definition}/:milestone_id" do
    it 'updates a milestone' do
      put api(resource_route, user),
Robert Speicher's avatar
Robert Speicher committed
162
        title: 'updated title'
163

164
      expect(response).to have_gitlab_http_status(200)
165
      expect(json_response['title']).to eq('updated title')
Robert Speicher's avatar
Robert Speicher committed
166
    end
167

168 169 170
    it 'removes a due date if nil is passed' do
      milestone.update!(due_date: "2016-08-05")

171
      put api(resource_route, user), due_date: nil
172

173
      expect(response).to have_gitlab_http_status(200)
174 175 176
      expect(json_response['due_date']).to be_nil
    end

177
    it 'returns a 404 error if milestone id not found' do
178
      put api("#{route}/1234", user),
179
        title: 'updated title'
180

181
      expect(response).to have_gitlab_http_status(404)
182
    end
183

184 185
    it 'closes milestone' do
      put api(resource_route, user),
186
        state_event: 'close'
187
      expect(response).to have_gitlab_http_status(200)
188

189
      expect(json_response['state']).to eq('closed')
190
    end
191 192 193 194 195 196

    it 'updates milestone with only start date' do
      put api(resource_route, user), start_date: Date.tomorrow

      expect(response).to have_gitlab_http_status(200)
    end
197
  end
198

199 200
  describe "GET #{route_definition}/:milestone_id/issues" do
    let(:issues_route) { "#{route}/#{milestone.id}/issues" }
201

202
    before do
203
      milestone.issues << create(:issue, project: project)
204
    end
205 206
    it 'returns issues for a particular milestone' do
      get api(issues_route, user)
207

208
      expect(response).to have_gitlab_http_status(200)
209
      expect(response).to include_pagination_headers
210 211
      expect(json_response).to be_an Array
      expect(json_response.first['milestone']['title']).to eq(milestone.title)
212 213
    end

214
    it 'returns issues sorted by label priority' do
215 216 217 218
      issue_1 = create(:labeled_issue, project: project, milestone: milestone, labels: [label_3])
      issue_2 = create(:labeled_issue, project: project, milestone: milestone, labels: [label_1])
      issue_3 = create(:labeled_issue, project: project, milestone: milestone, labels: [label_2])

219
      get api(issues_route, user)
220 221 222 223 224 225

      expect(json_response.first['id']).to eq(issue_2.id)
      expect(json_response.second['id']).to eq(issue_3.id)
      expect(json_response.third['id']).to eq(issue_1.id)
    end

226
    it 'matches V4 response schema for a list of issues' do
227
      get api(issues_route, user)
228

229
      expect(response).to have_gitlab_http_status(200)
230 231 232
      expect(response).to match_response_schema('public_api/v4/issues')
    end

233
    it 'returns a 401 error if user not authenticated' do
234
      get api(issues_route)
235

236
      expect(response).to have_gitlab_http_status(401)
237
    end
238

239
    describe 'confidential issues' do
240
      let!(:public_project) { create(:project, :public) }
241 242 243 244 245 246 247 248 249 250 251 252 253
      let!(:context_group) { try(:group) }
      let!(:milestone) do
        context_group ? create(:milestone, group: context_group) : create(:milestone, project: public_project)
      end
      let!(:issue) { create(:issue, project: public_project) }
      let!(:confidential_issue) { create(:issue, confidential: true, project: public_project) }
      let!(:issues_route) do
        if context_group
          "#{route}/#{milestone.id}/issues"
        else
          "/projects/#{public_project.id}/milestones/#{milestone.id}/issues"
        end
      end
254

255
      before do
256 257 258
        # Add public project to the group in context
        setup_for_group if context_group

259
        public_project.add_developer(user)
260 261 262 263
        milestone.issues << issue << confidential_issue
      end

      it 'returns confidential issues to team members' do
264
        get api(issues_route, user)
265

266
        expect(response).to have_gitlab_http_status(200)
267
        expect(response).to include_pagination_headers
268
        expect(json_response).to be_an Array
269 270
        # 2 for projects, 3 for group(which has another project with an issue)
        expect(json_response.size).to be_between(2, 3)
271 272 273
        expect(json_response.map { |issue| issue['id'] }).to include(issue.id, confidential_issue.id)
      end

274 275
      it 'does not return confidential issues to team members with guest role' do
        member = create(:user)
276
        public_project.add_guest(member)
277

278
        get api(issues_route, member)
279

280
        expect(response).to have_gitlab_http_status(200)
281
        expect(response).to include_pagination_headers
282 283 284 285 286
        expect(json_response).to be_an Array
        expect(json_response.size).to eq(1)
        expect(json_response.map { |issue| issue['id'] }).to include(issue.id)
      end

287
      it 'does not return confidential issues to regular users' do
288
        get api(issues_route, create(:user))
289

290
        expect(response).to have_gitlab_http_status(200)
291
        expect(response).to include_pagination_headers
292 293 294 295
        expect(json_response).to be_an Array
        expect(json_response.size).to eq(1)
        expect(json_response.map { |issue| issue['id'] }).to include(issue.id)
      end
296

297 298 299 300
      it 'returns issues ordered by label priority' do
        issue.labels << label_2
        confidential_issue.labels << label_1

301
        get api(issues_route, user)
302

303
        expect(response).to have_gitlab_http_status(200)
304 305
        expect(response).to include_pagination_headers
        expect(json_response).to be_an Array
306 307
        # 2 for projects, 3 for group(which has another project with an issue)
        expect(json_response.size).to be_between(2, 3)
308 309 310
        expect(json_response.first['id']).to eq(confidential_issue.id)
        expect(json_response.second['id']).to eq(issue.id)
      end
311 312
    end
  end
313

314 315
  describe "GET #{route_definition}/:milestone_id/merge_requests" do
    let(:merge_requests_route) { "#{route}/#{milestone.id}/merge_requests" }
316

317 318 319 320
    before do
      milestone.merge_requests << merge_request
    end

321
    it 'returns merge_requests for a particular milestone' do
322 323
      # eager-load another_merge_request
      another_merge_request
324
      get api(merge_requests_route, user)
325

326
      expect(response).to have_gitlab_http_status(200)
327 328 329 330 331 332
      expect(json_response).to be_an Array
      expect(json_response.size).to eq(1)
      expect(json_response.first['title']).to eq(merge_request.title)
      expect(json_response.first['milestone']['title']).to eq(milestone.title)
    end

333
    it 'returns merge_requests sorted by label priority' do
334 335 336 337
      merge_request_1 = create(:labeled_merge_request, source_branch: 'branch_1', source_project: project, milestone: milestone, labels: [label_2])
      merge_request_2 = create(:labeled_merge_request, source_branch: 'branch_2', source_project: project, milestone: milestone, labels: [label_1])
      merge_request_3 = create(:labeled_merge_request, source_branch: 'branch_3', source_project: project, milestone: milestone, labels: [label_3])

338
      get api(merge_requests_route, user)
339 340 341 342 343 344

      expect(json_response.first['id']).to eq(merge_request_2.id)
      expect(json_response.second['id']).to eq(merge_request_1.id)
      expect(json_response.third['id']).to eq(merge_request_3.id)
    end

345
    it 'returns a 404 error if milestone id not found' do
346 347 348
      not_found_route = "#{route}/1234/merge_requests"

      get api(not_found_route, user)
349

350
      expect(response).to have_gitlab_http_status(404)
351 352 353 354
    end

    it 'returns a 404 if the user has no access to the milestone' do
      new_user = create :user
355
      get api(merge_requests_route, new_user)
356

357
      expect(response).to have_gitlab_http_status(404)
358 359 360
    end

    it 'returns a 401 error if user not authenticated' do
361
      get api(merge_requests_route)
362

363
      expect(response).to have_gitlab_http_status(401)
364
    end
365 366 367

    it 'returns merge_requests ordered by position asc' do
      milestone.merge_requests << another_merge_request
368 369
      another_merge_request.labels << label_1
      merge_request.labels << label_2
370

371
      get api(merge_requests_route, user)
372

373
      expect(response).to have_gitlab_http_status(200)
374 375 376 377 378 379
      expect(response).to include_pagination_headers
      expect(json_response).to be_an Array
      expect(json_response.size).to eq(2)
      expect(json_response.first['id']).to eq(another_merge_request.id)
      expect(json_response.second['id']).to eq(merge_request.id)
    end
380
  end
Robert Speicher's avatar
Robert Speicher committed
381
end