BigW Consortium Gitlab

branches_spec.rb 19.1 KB
Newer Older
1 2
require 'spec_helper'

3
describe API::Branches do
4
  set(:user) { create(:user) }
5
  let(:project) { create(:project, :repository, creator: user, path: 'my.project') }
6
  let(:guest) { create(:user).tap { |u| project.add_guest(u) } }
7 8 9 10 11 12 13 14 15 16 17
  let(:branch_name) { 'feature' }
  let(:branch_sha) { '0b4bc9a49b562e85de7cc9e834518ea6828729b9' }
  let(:branch_with_dot) { project.repository.find_branch('ends-with.json') }
  let(:branch_with_slash) { project.repository.find_branch('improve/awesome') }

  let(:project_id) { project.id }
  let(:current_user) { nil }

  before do
    project.add_master(user)
  end
18 19

  describe "GET /projects/:id/repository/branches" do
20
    let(:route) { "/projects/#{project_id}/repository/branches" }
21

22 23 24
    shared_examples_for 'repository branches' do
      it 'returns the repository branches' do
        get api(route, current_user), per_page: 100
25

26 27
        expect(response).to have_gitlab_http_status(200)
        expect(response).to match_response_schema('public_api/v4/branches')
28 29 30 31 32 33 34 35 36 37 38 39
        expect(response).to include_pagination_headers
        branch_names = json_response.map { |x| x['name'] }
        expect(branch_names).to match_array(project.repository.branch_names)
      end

      context 'when repository is disabled' do
        include_context 'disabled repository'

        it_behaves_like '403 response' do
          let(:request) { get api(route, current_user) }
        end
      end
40 41
    end

42
    context 'when unauthenticated', 'and project is public' do
43 44 45
      before do
        project.update(visibility_level: Gitlab::VisibilityLevel::PUBLIC)
      end
46 47

      it_behaves_like 'repository branches'
48
    end
49

50 51 52 53 54
    context 'when unauthenticated', 'and project is private' do
      it_behaves_like '404 response' do
        let(:request) { get api(route) }
        let(:message) { '404 Project Not Found' }
      end
55 56
    end

57 58 59 60 61 62 63 64 65
    context 'when authenticated', 'as a master' do
      let(:current_user) { user }

      it_behaves_like 'repository branches'

      context 'requesting with the escaped project full path' do
        let(:project_id) { CGI.escape(project.full_path) }

        it_behaves_like 'repository branches'
66 67
      end
    end
68

69 70 71 72
    context 'when authenticated', 'as a guest' do
      it_behaves_like '403 response' do
        let(:request) { get api(route, guest) }
      end
73
    end
74 75 76
  end

  describe "GET /projects/:id/repository/branches/:branch" do
77
    let(:route) { "/projects/#{project_id}/repository/branches/#{branch_name}" }
78

79
    shared_examples_for 'repository branch' do
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
      context 'HEAD request' do
        it 'returns 204 No Content' do
          head api(route, user)

          expect(response).to have_gitlab_http_status(204)
          expect(response.body).to be_empty
        end

        it 'returns 404 Not Found' do
          head api("/projects/#{project_id}/repository/branches/unknown", user)

          expect(response).to have_gitlab_http_status(404)
          expect(response.body).to be_empty
        end
      end

96 97
      it 'returns the repository branch' do
        get api(route, current_user)
98

99 100 101
        expect(response).to have_gitlab_http_status(200)
        expect(response).to match_response_schema('public_api/v4/branch')
        expect(json_response['name']).to eq(CGI.unescape(branch_name))
102 103 104 105 106 107 108 109 110 111 112
      end

      context 'when branch does not exist' do
        let(:branch_name) { 'unknown' }

        it_behaves_like '404 response' do
          let(:request) { get api(route, current_user) }
          let(:message) { '404 Branch Not Found' }
        end
      end

113 114 115 116 117 118 119 120 121
      context 'when the branch refname is invalid' do
        let(:branch_name) { 'branch*' }
        let(:message) { 'The branch refname is invalid' }

        it_behaves_like '400 response' do
          let(:request) { get api(route, current_user) }
        end
      end

122 123 124 125 126 127
      context 'when repository is disabled' do
        include_context 'disabled repository'

        it_behaves_like '403 response' do
          let(:request) { get api(route, current_user) }
        end
128 129 130
      end
    end

131
    context 'when unauthenticated', 'and project is public' do
132 133 134
      before do
        project.update(visibility_level: Gitlab::VisibilityLevel::PUBLIC)
      end
135 136

      it_behaves_like 'repository branch'
137 138
    end

139 140 141 142 143 144 145
    context 'when unauthenticated', 'and project is private' do
      it_behaves_like '404 response' do
        let(:request) { get api(route) }
        let(:message) { '404 Project Not Found' }
      end
    end

146
    context 'when authenticated', 'as a master' do
147
      let(:current_user) { user }
148

149 150 151 152 153 154 155 156
      it_behaves_like 'repository branch'

      context 'when branch contains a dot' do
        let(:branch_name) { branch_with_dot.name }

        it_behaves_like 'repository branch'
      end

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
      context 'when branch contains a slash' do
        let(:branch_name) { branch_with_slash.name }

        it_behaves_like '404 response' do
          let(:request) { get api(route, current_user) }
        end
      end

      context 'when branch contains an escaped slash' do
        let(:branch_name) { CGI.escape(branch_with_slash.name) }

        it_behaves_like 'repository branch'
      end

      context 'requesting with the escaped project full path' do
        let(:project_id) { CGI.escape(project.full_path) }

        it_behaves_like 'repository branch'
175

176 177 178 179 180
        context 'when branch contains a dot' do
          let(:branch_name) { branch_with_dot.name }

          it_behaves_like 'repository branch'
        end
181 182 183 184 185 186 187
      end
    end

    context 'when authenticated', 'as a guest' do
      it_behaves_like '403 response' do
        let(:request) { get api(route, guest) }
      end
188 189 190
    end
  end

191
  describe 'PUT /projects/:id/repository/branches/:branch/protect' do
192
    let(:route) { "/projects/#{project_id}/repository/branches/#{branch_name}/protect" }
193

194 195 196
    shared_examples_for 'repository new protected branch' do
      it 'protects a single branch' do
        put api(route, current_user)
197

198 199 200
        expect(response).to have_gitlab_http_status(200)
        expect(response).to match_response_schema('public_api/v4/branch')
        expect(json_response['name']).to eq(CGI.unescape(branch_name))
201 202 203
        expect(json_response['protected']).to eq(true)
      end

204
      it 'protects a single branch and developers can push' do
205
        put api(route, current_user), developers_can_push: true
206

207 208 209
        expect(response).to have_gitlab_http_status(200)
        expect(response).to match_response_schema('public_api/v4/branch')
        expect(json_response['name']).to eq(CGI.unescape(branch_name))
210 211 212 213
        expect(json_response['protected']).to eq(true)
        expect(json_response['developers_can_push']).to eq(true)
        expect(json_response['developers_can_merge']).to eq(false)
      end
214

215
      it 'protects a single branch and developers can merge' do
216
        put api(route, current_user), developers_can_merge: true
217

218 219 220
        expect(response).to have_gitlab_http_status(200)
        expect(response).to match_response_schema('public_api/v4/branch')
        expect(json_response['name']).to eq(CGI.unescape(branch_name))
221 222 223 224
        expect(json_response['protected']).to eq(true)
        expect(json_response['developers_can_push']).to eq(false)
        expect(json_response['developers_can_merge']).to eq(true)
      end
225

226
      it 'protects a single branch and developers can push and merge' do
227
        put api(route, current_user), developers_can_push: true, developers_can_merge: true
228

229 230 231
        expect(response).to have_gitlab_http_status(200)
        expect(response).to match_response_schema('public_api/v4/branch')
        expect(json_response['name']).to eq(CGI.unescape(branch_name))
232 233 234 235
        expect(json_response['protected']).to eq(true)
        expect(json_response['developers_can_push']).to eq(true)
        expect(json_response['developers_can_merge']).to eq(true)
      end
236 237 238 239 240 241 242 243 244 245

      context 'when branch does not exist' do
        let(:branch_name) { 'unknown' }

        it_behaves_like '404 response' do
          let(:request) { put api(route, current_user) }
          let(:message) { '404 Branch Not Found' }
        end
      end

246 247 248 249 250 251 252 253 254
      context 'when the branch refname is invalid' do
        let(:branch_name) { 'branch*' }
        let(:message) { 'The branch refname is invalid' }

        it_behaves_like '400 response' do
          let(:request) { put api(route, current_user) }
        end
      end

255 256 257 258 259 260 261
      context 'when repository is disabled' do
        include_context 'disabled repository'

        it_behaves_like '403 response' do
          let(:request) { put api(route, current_user) }
        end
      end
262 263
    end

264 265 266 267
    context 'when unauthenticated', 'and project is private' do
      it_behaves_like '404 response' do
        let(:request) { put api(route) }
        let(:message) { '404 Project Not Found' }
268
      end
269 270 271 272 273 274 275 276 277 278
    end

    context 'when authenticated', 'as a guest' do
      it_behaves_like '403 response' do
        let(:request) { put api(route, guest) }
      end
    end

    context 'when authenticated', 'as a master' do
      let(:current_user) { user }
279

280 281
      context "when a protected branch doesn't already exist" do
        it_behaves_like 'repository new protected branch'
282

283 284
        context 'when branch contains a dot' do
          let(:branch_name) { branch_with_dot.name }
285

286
          it_behaves_like 'repository new protected branch'
287 288
        end

289 290
        context 'when branch contains a slash' do
          let(:branch_name) { branch_with_slash.name }
291

292 293 294
          it_behaves_like '404 response' do
            let(:request) { put api(route, current_user) }
          end
295 296
        end

297 298
        context 'when branch contains an escaped slash' do
          let(:branch_name) { CGI.escape(branch_with_slash.name) }
299

300 301 302 303 304 305 306 307 308 309 310 311 312
          it_behaves_like 'repository new protected branch'
        end

        context 'requesting with the escaped project full path' do
          let(:project_id) { CGI.escape(project.full_path) }

          it_behaves_like 'repository new protected branch'

          context 'when branch contains a dot' do
            let(:branch_name) { branch_with_dot.name }

            it_behaves_like 'repository new protected branch'
          end
313 314 315
        end
      end

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
      context 'when protected branch already exists' do
        before do
          project.repository.add_branch(user, protected_branch.name, 'master')
        end

        context 'when developers can push and merge' do
          let(:protected_branch) { create(:protected_branch, :developers_can_push, :developers_can_merge, project: project, name: 'protected_branch') }

          it 'updates that a developer cannot push or merge' do
            put api("/projects/#{project.id}/repository/branches/#{protected_branch.name}/protect", user),
                developers_can_push: false, developers_can_merge: false

            expect(response).to have_gitlab_http_status(200)
            expect(response).to match_response_schema('public_api/v4/branch')
            expect(json_response['name']).to eq(protected_branch.name)
            expect(json_response['protected']).to eq(true)
            expect(json_response['developers_can_push']).to eq(false)
            expect(json_response['developers_can_merge']).to eq(false)
            expect(protected_branch.reload.push_access_levels.first.access_level).to eq(Gitlab::Access::MASTER)
            expect(protected_branch.reload.merge_access_levels.first.access_level).to eq(Gitlab::Access::MASTER)
          end
        end

        context 'when developers cannot push or merge' do
          let(:protected_branch) { create(:protected_branch, project: project, name: 'protected_branch') }
341

342 343 344
          it 'updates that a developer can push and merge' do
            put api("/projects/#{project.id}/repository/branches/#{protected_branch.name}/protect", user),
                developers_can_push: true, developers_can_merge: true
345

346 347 348 349 350 351 352
            expect(response).to have_gitlab_http_status(200)
            expect(response).to match_response_schema('public_api/v4/branch')
            expect(json_response['name']).to eq(protected_branch.name)
            expect(json_response['protected']).to eq(true)
            expect(json_response['developers_can_push']).to eq(true)
            expect(json_response['developers_can_merge']).to eq(true)
          end
353 354 355
        end
      end
    end
356
  end
357

358 359
  describe 'PUT /projects/:id/repository/branches/:branch/unprotect' do
    let(:route) { "/projects/#{project_id}/repository/branches/#{branch_name}/unprotect" }
360

361 362 363 364 365 366 367 368
    shared_examples_for 'repository unprotected branch' do
      it 'unprotects a single branch' do
        put api(route, current_user)

        expect(response).to have_gitlab_http_status(200)
        expect(response).to match_response_schema('public_api/v4/branch')
        expect(json_response['name']).to eq(CGI.unescape(branch_name))
        expect(json_response['protected']).to eq(false)
369 370
      end

371 372
      context 'when branch does not exist' do
        let(:branch_name) { 'unknown' }
373

374 375 376 377
        it_behaves_like '404 response' do
          let(:request) { put api(route, current_user) }
          let(:message) { '404 Branch Not Found' }
        end
378 379
      end

380 381 382 383 384 385 386 387 388
      context 'when the branch refname is invalid' do
        let(:branch_name) { 'branch*' }
        let(:message) { 'The branch refname is invalid' }

        it_behaves_like '400 response' do
          let(:request) { put api(route, current_user) }
        end
      end

389 390
      context 'when repository is disabled' do
        include_context 'disabled repository'
391

392 393 394
        it_behaves_like '403 response' do
          let(:request) { put api(route, current_user) }
        end
395
      end
396 397
    end

398 399 400 401 402
    context 'when unauthenticated', 'and project is private' do
      it_behaves_like '404 response' do
        let(:request) { put api(route) }
        let(:message) { '404 Project Not Found' }
      end
403 404
    end

405 406 407 408
    context 'when authenticated', 'as a guest' do
      it_behaves_like '403 response' do
        let(:request) { put api(route, guest) }
      end
409 410
    end

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    context 'when authenticated', 'as a master' do
      let(:current_user) { user }

      context "when a protected branch doesn't already exist" do
        it_behaves_like 'repository unprotected branch'

        context 'when branch contains a dot' do
          let(:branch_name) { branch_with_dot.name }

          it_behaves_like 'repository unprotected branch'
        end

        context 'when branch contains a slash' do
          let(:branch_name) { branch_with_slash.name }

          it_behaves_like '404 response' do
            let(:request) { put api(route, current_user) }
          end
        end

        context 'when branch contains an escaped slash' do
          let(:branch_name) { CGI.escape(branch_with_slash.name) }
433

434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
          it_behaves_like 'repository unprotected branch'
        end

        context 'requesting with the escaped project full path' do
          let(:project_id) { CGI.escape(project.full_path) }

          it_behaves_like 'repository unprotected branch'

          context 'when branch contains a dot' do
            let(:branch_name) { branch_with_dot.name }

            it_behaves_like 'repository unprotected branch'
          end
        end
      end
449
    end
450
  end
451

452 453
  describe 'POST /projects/:id/repository/branches' do
    let(:route) { "/projects/#{project_id}/repository/branches" }
454

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
    shared_examples_for 'repository new branch' do
      it 'creates a new branch' do
        post api(route, current_user), branch: 'feature1', ref: branch_sha

        expect(response).to have_gitlab_http_status(201)
        expect(response).to match_response_schema('public_api/v4/branch')
        expect(json_response['name']).to eq('feature1')
        expect(json_response['commit']['id']).to eq(branch_sha)
      end

      context 'when repository is disabled' do
        include_context 'disabled repository'

        it_behaves_like '403 response' do
          let(:request) { post api(route, current_user) }
        end
      end
472 473
    end

474 475 476 477 478
    context 'when unauthenticated', 'and project is private' do
      it_behaves_like '404 response' do
        let(:request) { post api(route) }
        let(:message) { '404 Project Not Found' }
      end
479 480
    end

481 482 483 484
    context 'when authenticated', 'as a guest' do
      it_behaves_like '403 response' do
        let(:request) { post api(route, guest) }
      end
485 486
    end

487 488
    context 'when authenticated', 'as a master' do
      let(:current_user) { user }
489

490 491
      context "when a protected branch doesn't already exist" do
        it_behaves_like 'repository new branch'
492

493 494
        context 'requesting with the escaped project full path' do
          let(:project_id) { CGI.escape(project.full_path) }
495

496 497 498
          it_behaves_like 'repository new branch'
        end
      end
499
    end
500

501
    it 'returns 400 if branch name is invalid' do
502 503 504
      post api(route, user), branch: 'new design', ref: branch_sha

      expect(response).to have_gitlab_http_status(400)
Douglas Barbosa Alexandre committed
505
      expect(json_response['message']).to eq('Branch name is invalid')
506 507
    end

508
    it 'returns 400 if branch already exists' do
509 510 511 512 513 514 515
      post api(route, user), branch: 'new_design1', ref: branch_sha

      expect(response).to have_gitlab_http_status(201)

      post api(route, user), branch: 'new_design1', ref: branch_sha

      expect(response).to have_gitlab_http_status(400)
516
      expect(json_response['message']).to eq('Branch already exists')
517 518
    end

519
    it 'returns 400 if ref name is invalid' do
520 521 522
      post api(route, user), branch: 'new_design3', ref: 'foo'

      expect(response).to have_gitlab_http_status(400)
523
      expect(json_response['message']).to eq('Invalid reference name')
524
    end
525
  end
526

527
  describe 'DELETE /projects/:id/repository/branches/:branch' do
528 529 530
    before do
      allow_any_instance_of(Repository).to receive(:rm_branch).and_return(true)
    end
531

532
    it 'removes branch' do
533
      delete api("/projects/#{project.id}/repository/branches/#{branch_name}", user)
534

535
      expect(response).to have_gitlab_http_status(204)
536 537
    end

538
    it 'removes a branch with dots in the branch name' do
539
      delete api("/projects/#{project.id}/repository/branches/#{branch_with_dot.name}", user)
540

541
      expect(response).to have_gitlab_http_status(204)
542 543
    end

544
    it 'returns 404 if branch not exists' do
545
      delete api("/projects/#{project.id}/repository/branches/foobar", user)
546 547

      expect(response).to have_gitlab_http_status(404)
548
    end
549

550 551 552 553 554 555 556 557 558
    context 'when the branch refname is invalid' do
      let(:branch_name) { 'branch*' }
      let(:message) { 'The branch refname is invalid' }

      it_behaves_like '400 response' do
        let(:request) { delete api("/projects/#{project.id}/repository/branches/#{branch_name}", user) }
      end
    end

559 560 561
    it_behaves_like '412 response' do
      let(:request) { api("/projects/#{project.id}/repository/branches/#{branch_name}", user) }
    end
562
  end
563

564
  describe 'DELETE /projects/:id/repository/merged_branches' do
565 566 567 568
    before do
      allow_any_instance_of(Repository).to receive(:rm_branch).and_return(true)
    end

569
    it 'returns 202 with json body' do
570
      delete api("/projects/#{project.id}/repository/merged_branches", user)
571

572
      expect(response).to have_gitlab_http_status(202)
573
      expect(json_response['message']).to eql('202 Accepted')
574 575 576
    end

    it 'returns a 403 error if guest' do
577
      delete api("/projects/#{project.id}/repository/merged_branches", guest)
578 579

      expect(response).to have_gitlab_http_status(403)
580 581
    end
  end
582
end