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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 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 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe API::Environments, feature_category: :continuous_delivery do
let_it_be(:user) { create(:user) }
let_it_be(:developer) { create(:user) }
let_it_be(:non_member) { create(:user) }
let_it_be(:reporter) { create(:user) }
let_it_be(:project) { create(:project, :private, :repository, namespace: user.namespace, maintainers: user, developers: developer, reporters: reporter) }
let_it_be_with_reload(:environment) { create(:environment, project: project, description: 'description') }
describe 'GET /projects/:id/environments', :aggregate_failures do
context 'as member of the project' do
it 'returns project environments' do
get api("/projects/#{project.id}/environments", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environments')
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.size).to eq(1)
expect(json_response.first['name']).to eq(environment.name)
expect(json_response.first['tier']).to eq(environment.tier)
expect(json_response.first['description']).to eq(environment.description)
expect(json_response.first['external_url']).to eq(environment.external_url)
expect(json_response.first['project']).to match_schema('public_api/v4/project')
expect(json_response.first).not_to have_key('last_deployment')
end
it 'returns 200 HTTP status when using JOB-TOKEN auth' do
job = create(:ci_build, :running, project: project, user: user)
get api("/projects/#{project.id}/environments"), params: { job_token: job.token }
expect(response).to have_gitlab_http_status(:ok)
end
context 'when filtering' do
let_it_be(:stopped_environment) { create(:environment, :stopped, project: project) }
it 'returns environment by name' do
get api("/projects/#{project.id}/environments?name=#{environment.name}", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.size).to eq(1)
expect(json_response.first['name']).to eq(environment.name)
end
it 'returns no environment by non-existent name' do
get api("/projects/#{project.id}/environments?name=test", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.size).to eq(0)
end
it 'returns environments by name_like' do
get api("/projects/#{project.id}/environments?search=envir", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.size).to eq(2)
end
it 'returns no environment by non-existent name_like' do
get api("/projects/#{project.id}/environments?search=test", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.size).to eq(0)
end
context "when params[:search] is less than #{described_class::MIN_SEARCH_LENGTH} characters" do
it 'returns with status 400' do
get api("/projects/#{project.id}/environments?search=ab", user)
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to include("Search query is less than #{described_class::MIN_SEARCH_LENGTH} characters")
end
end
it 'returns environment by valid state' do
get api("/projects/#{project.id}/environments?states=available", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.size).to eq(1)
expect(json_response.first['name']).to eq(environment.name)
end
it 'returns all environments when state is not specified' do
get api("/projects/#{project.id}/environments", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.size).to eq(2)
expect(json_response.first['name']).to eq(environment.name)
expect(json_response.last['name']).to eq(stopped_environment.name)
end
it 'returns a 400 when filtering by invalid state' do
get api("/projects/#{project.id}/environments?states=test", user)
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq('states does not have a valid value')
end
end
end
context 'as non member' do
it 'returns a 404 status code' do
get api("/projects/#{project.id}/environments", non_member)
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
describe 'POST /projects/:id/environments' do
context 'as a member' do
it 'creates an environment with valid params' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", tier: 'staging', description: 'description' }
expect(response).to have_gitlab_http_status(:created)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['name']).to eq('mepmep')
expect(json_response['description']).to eq('description')
expect(json_response['slug']).to eq('mepmep')
expect(json_response['tier']).to eq('staging')
expect(json_response['external']).to be nil
end
context 'when associating a cluster agent' do
let_it_be(:cluster_agent) { create(:cluster_agent, project: project) }
let_it_be(:foreign_cluster_agent) { create(:cluster_agent) }
it 'creates an environment with associated cluster agent' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", cluster_agent_id: cluster_agent.id }
expect(response).to have_gitlab_http_status(:created)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).to be_present
end
it 'creates an environment with associated kubernetes namespace' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", cluster_agent_id: cluster_agent.id, kubernetes_namespace: 'flux-system' }
expect(response).to have_gitlab_http_status(:created)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).to be_present
expect(json_response['kubernetes_namespace']).to eq('flux-system')
end
it 'creates an environment with associated flux resource path' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", cluster_agent_id: cluster_agent.id, kubernetes_namespace: 'flux-system', flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:created)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).to be_present
expect(json_response['kubernetes_namespace']).to eq('flux-system')
expect(json_response['flux_resource_path']).to eq('HelmRelease/flux-system')
end
it 'fails to create environment with kubernetes namespace but no cluster agent' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", kubernetes_namespace: 'flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['kubernetes_namespace']).to eq(['cannot be set without a cluster agent'])
end
it 'fails to create environment with flux resource path but no cluster agent and kubernetes namespace' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['flux_resource_path']).to eq(['cannot be set without a kubernetes namespace'])
end
it 'fails to create environment with flux resource path but no cluster agent' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", kubernetes_namespace: 'flux-system', flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['kubernetes_namespace']).to eq(['cannot be set without a cluster agent'])
end
it 'fails to create environment with cluster agent and flux resource path but no kubernetes namespace' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", cluster_agent: cluster_agent.id, flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['flux_resource_path']).to eq(['cannot be set without a kubernetes namespace'])
end
it 'fails to create environment with a non existing cluster agent' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", cluster_agent_id: non_existing_record_id }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq("400 Bad request - cluster agent doesn't exist or cannot be associated with this environment")
end
it 'fails to create environment with a foreign cluster agent' do
post api("/projects/#{project.id}/environments", user), params: { name: "mepmep", cluster_agent_id: foreign_cluster_agent.id }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq("400 Bad request - cluster agent doesn't exist or cannot be associated with this environment")
end
end
it 'returns 200 HTTP status when using JOB-TOKEN auth' do
job = create(:ci_build, :running, project: project, user: user)
post api("/projects/#{project.id}/environments"), params: { name: "mepmep", job_token: job.token }
expect(response).to have_gitlab_http_status(:created)
end
it 'requires name to be passed' do
post api("/projects/#{project.id}/environments", user), params: { external_url: 'test.gitlab.com' }
expect(response).to have_gitlab_http_status(:bad_request)
end
it 'returns a 400 if environment already exists' do
post api("/projects/#{project.id}/environments", user), params: { name: environment.name }
expect(response).to have_gitlab_http_status(:bad_request)
end
it 'returns a 400 if slug is specified' do
post api("/projects/#{project.id}/environments", user), params: { name: "foo", slug: "foo" }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response["error"]).to eq("slug is automatically generated and cannot be changed")
end
end
context 'a non member' do
it 'rejects the request' do
post api("/projects/#{project.id}/environments", non_member), params: { name: 'gitlab.com' }
expect(response).to have_gitlab_http_status(:not_found)
end
it 'returns a 400 when the required params are missing' do
post api("/projects/#{non_existing_record_id}/environments", non_member), params: { external_url: 'http://env.git.com' }
end
end
end
describe 'POST /projects/:id/environments/stop_stale' do
context 'as a maintainer' do
it 'returns a 200' do
post api("/projects/#{project.id}/environments/stop_stale", user), params: { before: 1.week.ago.to_date.to_s }
expect(response).to have_gitlab_http_status(:ok)
end
it 'returns 200 HTTP status when using JOB-TOKEN auth' do
job = create(:ci_build, :running, project: project, user: user)
post api("/projects/#{project.id}/environments/stop_stale"),
params: { before: 1.week.ago.to_date.to_s, job_token: job.token }
expect(response).to have_gitlab_http_status(:ok)
end
it 'returns a 400 for bad input date' do
post api("/projects/#{project.id}/environments/stop_stale", user), params: { before: 1.day.ago.to_date.to_s }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq('400 Bad request - Invalid Date')
end
it 'returns a 400 for service error' do
expect_next_instance_of(::Environments::StopStaleService) do |service|
expect(service).to receive(:execute).and_return(ServiceResponse.error(message: 'Test Error'))
end
post api("/projects/#{project.id}/environments/stop_stale", user), params: { before: 1.week.ago.to_date.to_s }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq('Test Error')
end
end
context 'a non member' do
it 'rejects the request' do
post api("/projects/#{project.id}/environments/stop_stale", non_member), params: { before: 1.week.ago.to_date.to_s }
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'a developer' do
it 'rejects the request' do
post api("/projects/#{project.id}/environments/stop_stale", developer), params: { before: 1.week.ago.to_date.to_s }
expect(response).to have_gitlab_http_status(:forbidden)
end
end
end
describe 'PUT /projects/:id/environments/:environment_id' do
let_it_be(:url) { 'https://mepmep.whatever.ninja' }
it 'returns a 200 if external_url is changed' do
put api("/projects/#{project.id}/environments/#{environment.id}", user),
params: { external_url: url }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['external_url']).to eq(url)
end
it 'returns a 200 if description is changed' do
put api("/projects/#{project.id}/environments/#{environment.id}", user),
params: { description: 'new description' }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['description']).to eq('new description')
end
it 'returns a 200 if tier is changed' do
put api("/projects/#{project.id}/environments/#{environment.id}", user),
params: { tier: 'production' }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['tier']).to eq('production')
end
it 'returns 200 HTTP status when using JOB-TOKEN auth' do
job = create(:ci_build, :running, project: project, user: user)
put api("/projects/#{project.id}/environments/#{environment.id}"),
params: { tier: 'production', job_token: job.token }
expect(response).to have_gitlab_http_status(:ok)
end
context 'when associating a cluster agent' do
let_it_be(:cluster_agent) { create(:cluster_agent, project: project) }
let_it_be(:foreign_cluster_agent) { create(:cluster_agent) }
it 'updates an environment with associated cluster agent' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: cluster_agent.id }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).to be_present
end
it 'updates an environment to remove cluster agent' do
environment.update!(cluster_agent_id: cluster_agent.id)
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: nil }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).not_to be_present
end
it 'updates an environment with associated kubernetes namespace' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: cluster_agent.id, kubernetes_namespace: 'flux-system' }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).to be_present
expect(json_response['kubernetes_namespace']).to eq('flux-system')
end
it 'updates an environment with associated flux resource path' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: cluster_agent.id, kubernetes_namespace: 'flux-system', flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).to be_present
expect(json_response['kubernetes_namespace']).to eq('flux-system')
expect(json_response['flux_resource_path']).to eq('HelmRelease/flux-system')
end
it 'fails to update environment with kubernetes namespace but no cluster agent' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { kubernetes_namespace: 'flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['kubernetes_namespace']).to eq(['cannot be set without a cluster agent'])
end
it 'fails to update environment with flux resource path but no cluster agent and kubernetes namespace' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['flux_resource_path']).to eq(['cannot be set without a kubernetes namespace'])
end
it 'fails to update environment with flux resource path but no cluster agent' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { kubernetes_namespace: 'flux-system', flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['kubernetes_namespace']).to eq(['cannot be set without a cluster agent'])
end
it 'fails to update environment with cluster agent and flux resource path but no kubernetes namespace' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: cluster_agent.id, flux_resource_path: 'HelmRelease/flux-system' }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['flux_resource_path']).to eq(['cannot be set without a kubernetes namespace'])
end
it 'fails to update environment by removing cluster agent when kubernetes namespace is still associated' do
environment.update!(cluster_agent_id: cluster_agent.id, kubernetes_namespace: 'flux-system')
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: nil }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['kubernetes_namespace']).to eq(['cannot be set without a cluster agent'])
end
it 'fails to update environment by removing kubernetes namespace when flux_resource_path is still associated' do
environment.update!(cluster_agent_id: cluster_agent.id, kubernetes_namespace: 'flux-system', flux_resource_path: 'HelmRelease/flux-system')
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { kubernetes_namespace: nil }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['flux_resource_path']).to eq(['cannot be set without a kubernetes namespace'])
end
it 'leaves cluster agent unchanged when not specified in update' do
environment.update!(cluster_agent_id: cluster_agent.id)
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { external_url: url }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).to be_present
end
it 'fails to create environment with a non existing cluster agent' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: non_existing_record_id }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq("400 Bad request - cluster agent doesn't exist or cannot be associated with this environment")
end
it 'fails to create environment with a foreign cluster agent' do
put api("/projects/#{project.id}/environments/#{environment.id}", user), params: { cluster_agent_id: foreign_cluster_agent.id }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq("400 Bad request - cluster agent doesn't exist or cannot be associated with this environment")
end
end
it "won't allow slug to be changed" do
slug = environment.slug
api_url = api("/projects/#{project.id}/environments/#{environment.id}", user)
put api_url, params: { slug: slug + "-foo" }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response["error"]).to eq("slug is automatically generated and cannot be changed")
end
it 'returns a 404 if the environment does not exist' do
put api("/projects/#{project.id}/environments/#{non_existing_record_id}", user)
expect(response).to have_gitlab_http_status(:not_found)
end
end
describe 'DELETE /projects/:id/environments/:environment_id' do
context 'as a maintainer' do
it "rejects the requests in environment isn't stopped" do
delete api("/projects/#{project.id}/environments/#{environment.id}", user)
expect(response).to have_gitlab_http_status(:forbidden)
end
it 'returns a 204 for stopped environment' do
environment.stop
delete api("/projects/#{project.id}/environments/#{environment.id}", user)
expect(response).to have_gitlab_http_status(:no_content)
end
it 'returns 204 HTTP status when using JOB-TOKEN auth' do
environment.stop
job = create(:ci_build, :running, project: project, user: user)
delete api("/projects/#{project.id}/environments/#{environment.id}"),
params: { job_token: job.token }
expect(response).to have_gitlab_http_status(:no_content)
end
it 'returns a 404 for non existing id' do
delete api("/projects/#{project.id}/environments/#{non_existing_record_id}", user)
expect(response).to have_gitlab_http_status(:not_found)
expect(json_response['message']).to eq('404 Not found')
end
it_behaves_like '412 response' do
before do
environment.stop
end
let(:request) { api("/projects/#{project.id}/environments/#{environment.id}", user) }
end
end
context 'a non member' do
it 'rejects the request' do
delete api("/projects/#{project.id}/environments/#{environment.id}", non_member)
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
describe 'POST /projects/:id/environments/:environment_id/stop' do
context 'as a maintainer' do
context 'with a stoppable environment' do
before do
environment.update!(state: :available)
end
it 'returns a 200' do
post api("/projects/#{project.id}/environments/#{environment.id}/stop", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(environment.reload).to be_stopped
end
it 'returns 200 HTTP status when using JOB-TOKEN auth' do
job = create(:ci_build, :running, project: project, user: user)
post api("/projects/#{project.id}/environments/#{environment.id}/stop"),
params: { job_token: job.token }
expect(response).to have_gitlab_http_status(:ok)
end
end
it 'returns a 404 for non existing id' do
post api("/projects/#{project.id}/environments/#{non_existing_record_id}/stop", user)
expect(response).to have_gitlab_http_status(:not_found)
expect(json_response['message']).to eq('404 Not found')
end
end
context 'a non member' do
it 'rejects the request' do
post api("/projects/#{project.id}/environments/#{environment.id}/stop", non_member)
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
describe 'GET /projects/:id/environments/:environment_id' do
let_it_be(:bridge_job) { create(:ci_bridge, :running, project: project, user: user) }
let_it_be(:build_job) { create(:ci_build, :running, project: project, user: user) }
context 'as member of the project' do
shared_examples "returns project environments" do
it 'returns expected response' do
create(
:deployment,
:success,
project: project,
environment: environment,
deployable: job
)
environment.update!(
cluster_agent: create(:cluster_agent, project: project),
kubernetes_namespace: 'flux-system',
flux_resource_path: 'HelmRelease/flux-system'
)
get api("/projects/#{project.id}/environments/#{environment.id}", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['last_deployment']).to be_present
expect(json_response['cluster_agent']).to be_present
expect(json_response['kubernetes_namespace']).to eq('flux-system')
expect(json_response['flux_resource_path']).to eq('HelmRelease/flux-system')
end
end
context "when the deployable is a bridge" do
it_behaves_like "returns project environments" do
let(:job) { bridge_job }
end
# No test for Ci::Bridge JOB-TOKEN auth because it doesn't implement the `.token` method.
end
context "when the deployable is a build" do
it_behaves_like "returns project environments" do
let(:job) { build_job }
end
it 'returns 200 HTTP status when using JOB-TOKEN auth' do
get(
api("/projects/#{project.id}/environments/#{environment.id}"),
params: { job_token: build_job.token }
)
expect(response).to have_gitlab_http_status(:ok)
end
end
context "when auto_stop_at is present" do
before do
environment.update!(auto_stop_at: Time.current)
end
it "returns the expected response" do
get api("/projects/#{project.id}/environments/#{environment.id}", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['auto_stop_at']).to be_present
end
end
context "when auto_stop_at is not present" do
before do
environment.update!(auto_stop_at: nil)
end
it "returns the expected response" do
get api("/projects/#{project.id}/environments/#{environment.id}", user)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['auto_stop_at']).to be_nil
end
end
end
context 'as a reporter' do
it 'does not expose the cluster agent and related fields' do
environment.update!(
cluster_agent: create(:cluster_agent, project: project),
kubernetes_namespace: 'flux-system',
flux_resource_path: 'HelmRelease/flux-system'
)
get api("/projects/#{project.id}/environments/#{environment.id}", reporter)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to match_response_schema('public_api/v4/environment')
expect(json_response['cluster_agent']).not_to be_present
expect(json_response['kubernetes_namespace']).not_to be_present
expect(json_response['flux_resource_path']).not_to be_present
end
end
context 'as non member' do
shared_examples 'environment will not be found' do
it 'returns a 404 status code' do
get api("/projects/#{project.id}/environments/#{environment.id}", non_member)
expect(response).to have_gitlab_http_status(:not_found)
end
end
context "when the deployable is a bridge" do
it_behaves_like "environment will not be found" do
let(:job) { bridge_job }
end
end
context "when the deployable is a build" do
it_behaves_like "environment will not be found" do
let(:job) { build_job }
end
end
end
end
describe "DELETE /projects/:id/environments/review_apps" do
shared_examples "delete stopped review environments" do
around do |example|
freeze_time { example.run }
end
it "deletes the old stopped review apps" do
old_stopped_review_env = create(:environment, :with_review_app, :stopped, created_at: 31.days.ago, project: project)
new_stopped_review_env = create(:environment, :with_review_app, :stopped, project: project)
old_active_review_env = create(:environment, :with_review_app, :available, created_at: 31.days.ago, project: project)
old_stopped_other_env = create(:environment, :stopped, created_at: 31.days.ago, project: project)
new_stopped_other_env = create(:environment, :stopped, project: project)
old_active_other_env = create(:environment, :available, created_at: 31.days.ago, project: project)
delete api("/projects/#{project.id}/environments/review_apps", current_user), params: { dry_run: false }
project.environments.reload
expect(response).to have_gitlab_http_status(:ok)
expect(json_response["scheduled_entries"].size).to eq(1)
expect(json_response["scheduled_entries"].first["id"]).to eq(old_stopped_review_env.id)
expect(json_response["unprocessable_entries"].size).to eq(0)
expect(json_response["scheduled_entries"]).to match_schema('public_api/v4/basic_environments')
expect(json_response["unprocessable_entries"]).to match_schema('public_api/v4/basic_environments')
expect(old_stopped_review_env.reload.auto_delete_at).to eq(1.week.from_now)
expect(new_stopped_review_env.reload.auto_delete_at).to be_nil
expect(old_active_review_env.reload.auto_delete_at).to be_nil
expect(old_stopped_other_env.reload.auto_delete_at).to be_nil
expect(new_stopped_other_env.reload.auto_delete_at).to be_nil
expect(old_active_other_env.reload.auto_delete_at).to be_nil
end
end
context "as a maintainer" do
it_behaves_like "delete stopped review environments" do
let(:current_user) { user }
end
end
context "as a developer" do
let(:developer) { create(:user) }
before do
project.add_developer(developer)
end
it_behaves_like "delete stopped review environments" do
let(:current_user) { developer }
end
end
context "as a reporter" do
it "rejects the request" do
delete api("/projects/#{project.id}/environments/review_apps", reporter)
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
context "as a non member" do
it "rejects the request" do
delete api("/projects/#{project.id}/environments/review_apps", non_member)
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
end
|