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 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe API::Members, feature_category: :groups_and_projects do
let_it_be(:maintainer) { create(:user, username: 'maintainer_user') }
let_it_be(:maintainer2) { create(:user, username: 'user-with-maintainer-role') }
let_it_be(:developer) { create(:user) }
let_it_be(:access_requester) { create(:user) }
let_it_be(:stranger) { create(:user) }
let_it_be(:user_with_minimal_access) { create(:user) }
let_it_be(:project, refind: true) do
create(:project, :public, creator_id: maintainer.id, group: create(:group, :public)) do |project|
project.add_maintainer(maintainer)
project.add_developer(developer, current_user: maintainer)
project.request_access(access_requester)
end
end
let_it_be(:group, refind: true) do
create(:group, :public) do |group|
group.add_owner(maintainer)
group.add_developer(developer, maintainer)
create(:group_member, :minimal_access, source: group, user: user_with_minimal_access)
group.request_access(access_requester)
end
end
shared_examples 'GET /:source_type/:id/members/(all)' do |source_type, all|
let(:members_url) do
"/#{source_type.pluralize}/#{source.id}/members".tap do |url|
url << "/all" if all
end
end
context "with :source_type == #{source_type.pluralize}" do
it_behaves_like 'a 404 response when source is private' do
let(:route) { get api(members_url, stranger) }
end
%i[maintainer developer access_requester stranger].each do |type|
context "when authenticated as a #{type}" do
it 'returns 200' do
user = public_send(type)
get api(members_url, 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.map { |u| u['id'] }).to match_array [maintainer.id, developer.id]
expect(json_response).to contain_exactly(
a_hash_including('created_by' => a_hash_including('id' => maintainer.id)),
hash_not_including('created_by')
)
end
end
end
it 'avoids N+1 queries' do
# Establish baseline
get api(members_url, maintainer)
control = ActiveRecord::QueryRecorder.new do
get api(members_url, maintainer)
end
project.add_developer(create(:user))
expect do
get api(members_url, maintainer)
end.not_to exceed_query_limit(control)
end
it 'does not return invitees' do
create(:"#{source_type}_member", invite_token: '123', invite_email: 'test@abc.com', source: source, user: nil)
get api(members_url, developer)
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.map { |u| u['id'] }).to match_array [maintainer.id, developer.id]
end
context 'with cross db check disabled' do
around do |example|
allow_cross_joins_across_databases(url: 'https://gitlab.com/gitlab-org/gitlab/-/issues/343305') do
example.run
end
end
it 'finds members with query string' do
get api(members_url, developer), params: { query: maintainer.username }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.count).to eq(1)
expect(json_response.first['username']).to eq(maintainer.username)
end
end
it 'finds members with the given user_ids' do
get api(members_url, developer), params: { user_ids: [maintainer.id, developer.id, stranger.id] }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.map { |u| u['id'] }).to contain_exactly(maintainer.id, developer.id)
end
it 'finds all members with no query specified' do
get api(members_url, developer), params: { query: '' }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.count).to eq(2)
expect(json_response.map { |u| u['id'] }).to match_array [maintainer.id, developer.id]
end
end
end
describe 'GET /:source_type/:id/members/all' do
let(:nested_user) { create(:user) }
let(:project_user) { create(:user) }
let(:linked_group_user) { create(:user) }
let!(:project_group_link) { create(:project_group_link, project: project, group: linked_group) }
let(:invited_group_developer) { create(:user, username: 'invited_group_developer') }
let(:invited_group) do
create(:group) do |group|
group.add_owner(maintainer)
group.add_developer(invited_group_developer, maintainer)
end
end
let(:project) do
create(:project, :public, group: nested_group) do |project|
project.add_developer(project_user, current_user: maintainer)
end
end
let(:linked_group) do
create(:group) do |linked_group|
linked_group.add_owner(maintainer)
linked_group.add_developer(linked_group_user, maintainer)
end
end
let(:nested_group) do
create(:group, parent: group) do |nested_group|
nested_group.add_developer(nested_user, maintainer)
create(:group_group_link, :guest, shared_with_group: invited_group, shared_group: nested_group)
end
end
context 'when invited groups have public visibility' do
it 'finds all project members including inherited members and members shared into ancestor groups' do
get api("/projects/#{project.id}/members/all", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expected_user_ids = [maintainer.id, developer.id, nested_user.id, project_user.id, linked_group_user.id, invited_group_developer.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
end
it 'finds all group members including inherited members and members shared into ancestor groups' do
get api("/groups/#{nested_group.id}/members/all", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expected_user_ids = [maintainer.id, developer.id, nested_user.id, invited_group_developer.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
end
end
context 'when invited groups have private visibility' do
before do
linked_group.update!(visibility_level: Gitlab::VisibilityLevel::PRIVATE)
invited_group.update!(visibility_level: Gitlab::VisibilityLevel::PRIVATE)
end
context 'when current user is a member of the shared source' do
it 'hides the created_by attribute of the invited group members of the current project' do
get api("/projects/#{project.id}/members/all", developer)
expected_user_ids = [maintainer.id, developer.id, nested_user.id, project_user.id, linked_group_user.id, invited_group_developer.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
hidden_created_by_user_ids = [maintainer.id, linked_group_user.id, invited_group_developer.id]
hidden_created_by_members, revealed_created_by_members = json_response
.partition { |u| hidden_created_by_user_ids.include?(u['id']) }
expect(hidden_created_by_members.map { |u| u['created_by'] }).to all(be_nil)
expect(revealed_created_by_members.map { |u| u['created_by'] }).to all(be_present)
end
it 'hides the created_by attribute of the invited group members of the current group' do
get api("/groups/#{nested_group.id}/members/all", developer)
expected_user_ids = [maintainer.id, developer.id, nested_user.id, invited_group_developer.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
hidden_created_by_user_ids = [maintainer.id, invited_group_developer.id]
hidden_created_by_members, revealed_created_by_members = json_response
.partition { |u| hidden_created_by_user_ids.include?(u['id']) }
expect(hidden_created_by_members.map { |u| u['created_by'] }).to all(be_nil)
expect(revealed_created_by_members.map { |u| u['created_by'] }).to all(be_present)
end
context 'when current user is an admin of the shared source' do
it 'reveals the created_by attribute of all the invited group members of the current project' do
get api("/projects/#{project.id}/members/all", maintainer)
expected_user_ids = [maintainer.id, developer.id, nested_user.id, project_user.id, linked_group_user.id, invited_group_developer.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
expect(json_response.reject { |u| u['id'] == maintainer.id }.map { |u| u['created_by'] }).to all(be_present)
end
it 'reveals the created_by attribute of all the invited group members of the current group' do
get api("/groups/#{nested_group.id}/members/all", maintainer)
expected_user_ids = [maintainer.id, developer.id, nested_user.id, invited_group_developer.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
expect(json_response.reject { |u| u['id'] == maintainer.id }.map { |u| u['created_by'] }).to all(be_present)
end
end
end
context 'when current user is a non-member of the shared source' do
it 'does not return the members of the invited private group of the current project' do
get api("/projects/#{project.id}/members/all", create(:user))
expected_user_ids = [maintainer.id, developer.id, nested_user.id, project_user.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
end
it 'does not return the members of the invited private group of the current group' do
get api("/groups/#{nested_group.id}/members/all", create(:user))
expected_user_ids = [maintainer.id, developer.id, nested_user.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
end
end
end
it 'returns only one member for each user without returning duplicated members with correct access levels' do
linked_group.add_developer(developer)
get api("/projects/#{project.id}/members/all", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expected_users_and_access_levels = [
[developer.id, Gitlab::Access::DEVELOPER],
[maintainer.id, Gitlab::Access::OWNER],
[nested_user.id, Gitlab::Access::DEVELOPER],
[project_user.id, Gitlab::Access::DEVELOPER],
[linked_group_user.id, Gitlab::Access::DEVELOPER],
[invited_group_developer.id, Gitlab::Access::GUEST]
]
expect(json_response.map { |u| [u['id'], u['access_level']] }).to match_array(expected_users_and_access_levels)
end
it 'finds all group members including inherited members' do
get api("/groups/#{nested_group.id}/members/all", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expected_user_ids = [maintainer.id, developer.id, nested_user.id, invited_group_developer.id]
expect(json_response.map { |u| u['id'] }).to match_array expected_user_ids
end
context 'with a subgroup' do
let(:group) { create(:group, :private) }
let(:subgroup) { create(:group, :private, parent: group) }
let(:project) { create(:project, group: subgroup) }
before do
subgroup.add_developer(developer)
end
it 'subgroup member cannot get parent group members list' do
get api("/groups/#{group.id}/members/all", developer)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
end
describe 'GET /:source_type/:id/members/all/:user_id' do
let(:nested_user) { create(:user) }
let(:project_user) { create(:user) }
let(:linked_group_user) { create(:user) }
let!(:project_group_link) { create(:project_group_link, project: project, group: linked_group) }
let(:invited_group_developer) { create(:user, username: 'invited_group_developer') }
let(:invited_group) do
create(:group) do |group|
group.add_owner(maintainer)
group.add_developer(invited_group_developer, maintainer)
end
end
let(:project) do
create(:project, :public, group: nested_group) do |project|
project.add_developer(project_user, current_user: maintainer)
end
end
let(:linked_group) do
create(:group) do |linked_group|
linked_group.add_owner(maintainer)
linked_group.add_developer(linked_group_user, maintainer)
end
end
let(:nested_group) do
create(:group, parent: group) do |nested_group|
nested_group.add_developer(nested_user, maintainer)
create(:group_group_link, :guest, shared_with_group: invited_group, shared_group: nested_group)
end
end
context 'when invited groups have public visibility' do
it 'finds all project members including inherited members and members shared into ancestor groups' do
get api("/projects/#{project.id}/members/all/#{linked_group_user.id}", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(linked_group_user.id)
expect(json_response['created_by']).to be_present
end
it 'finds all group members including inherited members and members shared into ancestor groups' do
get api("/groups/#{nested_group.id}/members/all/#{invited_group_developer.id}", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(invited_group_developer.id)
expect(json_response['created_by']).to be_present
end
end
context 'when invited groups have private visibility' do
before do
linked_group.update!(visibility_level: Gitlab::VisibilityLevel::PRIVATE)
invited_group.update!(visibility_level: Gitlab::VisibilityLevel::PRIVATE)
end
context 'when current user is a member of the shared source' do
it 'hides the created_by attribute of the invited group members of the current project' do
get api("/projects/#{project.id}/members/all/#{linked_group_user.id}", developer)
expect(json_response['id']).to eq(linked_group_user.id)
expect(json_response['created_by']).to be_nil
end
it 'hides the created_by attribute of the invited group members of the current group' do
get api("/groups/#{nested_group.id}/members/all/#{invited_group_developer.id}", developer)
expect(json_response['id']).to eq(invited_group_developer.id)
expect(json_response['created_by']).to be_nil
end
context 'when current user is an admin of the shared source' do
it 'reveals the created_by attribute of all the invited group members of the current project' do
get api("/projects/#{project.id}/members/all/#{linked_group_user.id}", maintainer)
expect(json_response['id']).to eq(linked_group_user.id)
expect(json_response['created_by']).to be_present
end
it 'reveals the created_by attribute of all the invited group members of the current group' do
get api("/groups/#{nested_group.id}/members/all/#{invited_group_developer.id}", maintainer)
expect(json_response['id']).to eq(invited_group_developer.id)
expect(json_response['created_by']).to be_present
end
end
end
context 'when current user is a non-member of the shared source' do
it 'does not return the member of the invited private group of the current project' do
get api("/projects/#{project.id}/members/all/#{linked_group_user.id}", create(:user))
expect(response).to have_gitlab_http_status(:not_found)
end
it 'does not return the member of the invited private group of the current group' do
get api("/groups/#{nested_group.id}/members/all/#{invited_group_developer.id}", create(:user))
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
it 'finds the inherited group member' do
get api("/groups/#{nested_group.id}/members/all/#{maintainer.id}", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(maintainer.id)
end
context 'with a subgroup' do
let(:group) { create(:group, :private) }
let(:subgroup) { create(:group, :private, parent: group) }
let(:project) { create(:project, group: subgroup) }
before do
subgroup.add_developer(developer)
end
it 'subgroup member cannot get parent group members list' do
get api("/groups/#{group.id}/members/all/#{maintainer.id}", developer)
expect(response).to have_gitlab_http_status(:forbidden)
end
end
end
shared_examples 'GET /:source_type/:id/members/(all/):user_id' do |source_type, all|
context "with :source_type == #{source_type.pluralize} and all == #{all}" do
it_behaves_like 'a 404 response when source is private' do
let(:route) { get api("/#{source_type.pluralize}/#{source.id}/members/#{all ? 'all/' : ''}#{developer.id}", stranger) }
end
context 'when authenticated as a non-member' do
%i[access_requester stranger].each do |type|
context "as a #{type}" do
it 'returns 200' do
user = public_send(type)
get api("/#{source_type.pluralize}/#{source.id}/members/#{all ? 'all/' : ''}#{developer.id}", user)
expect(response).to have_gitlab_http_status(:ok)
# User attributes
expect(json_response['id']).to eq(developer.id)
expect(json_response['name']).to eq(developer.name)
expect(json_response['username']).to eq(developer.username)
expect(json_response['state']).to eq(developer.state)
expect(json_response['avatar_url']).to eq(developer.avatar_url)
expect(json_response['web_url']).to eq(Gitlab::Routing.url_helpers.user_url(developer))
# Member attributes
expect(json_response['access_level']).to eq(Member::DEVELOPER)
expect(json_response['created_at'].to_time).to be_present
end
end
end
end
context 'with ancestral membership' do
shared_examples 'response with correct access levels' do
it do
get api("/#{source_type.pluralize}/#{source.id}/members/#{all ? 'all/' : ''}#{developer.id}", developer)
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['access_level']).to eq(Member::MAINTAINER)
end
end
before do
source.add_maintainer(developer)
end
include_examples 'response with correct access levels'
context 'having email invite' do
before do
Member
.find_by(source: group, user: developer)
.update!(invite_email: 'email@email.com')
end
include_examples 'response with correct access levels'
end
end
end
end
shared_examples 'POST /:source_type/:id/members' do |source_type|
context "with :source_type == #{source_type.pluralize}" do
it_behaves_like 'a 404 response when source is private' do
let(:route) do
post api("/#{source_type.pluralize}/#{source.id}/members", stranger),
params: { user_id: access_requester.id, access_level: Member::MAINTAINER }
end
end
context 'when authenticated as a non-member or member with insufficient membership management rights' do
context 'when the user does not have rights to manage members' do
%i[access_requester stranger developer].each do |type|
context "as a #{type}" do
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
post api("/#{source_type.pluralize}/#{source.id}/members", public_send(type)),
params: { user_id: access_requester.id, access_level: Member::MAINTAINER }
end
end
end
end
end
context 'when the user has the rights to manage members but tries to manage members with a higher access level' do
# the other 'maintainer' is in fact an owner of the group!
let(:maintainer) { maintainer2 }
before do
source.add_maintainer(maintainer)
end
context 'when an access requester is added as OWNER' do
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: access_requester.id, access_level: Member::OWNER }
end
end
end
context 'when a totally new user is added as OWNER' do
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id, access_level: Member::OWNER }
end
end
end
end
end
context 'when authenticated as a member with membership management rights' do
context 'and new member is already a requester' do
context 'when the requester is of equal or lower access level' do
it 'transforms the requester into a proper member' do
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: access_requester.id, access_level: Member::MAINTAINER }
expect(response).to have_gitlab_http_status(:created)
end.to change { source.members.count }.by(1)
expect(source.requesters.count).to eq(0)
expect(json_response['id']).to eq(access_requester.id)
expect(json_response['access_level']).to eq(Member::MAINTAINER)
end
end
end
it 'creates a new member' do
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id, access_level: Member::DEVELOPER }
expect(response).to have_gitlab_http_status(:created)
end.to change { source.members.count }.by(1)
expect(json_response['id']).to eq(stranger.id)
expect(json_response['access_level']).to eq(Member::DEVELOPER)
end
it 'returns the error message if there was an error adding the member to the group' do
error_message = 'Test CreateService Error Message'
allow_next_instance_of(::Members::CreateService) do |service|
expect(service).to receive(:execute).and_return(status: :error, message: error_message)
allow(service).to receive(:single_member).and_return(
instance_double(Member, invalid?: false)
)
end
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id, access_level: Member::DEVELOPER }
end.not_to change { source.members.count }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['status']).to eq('error')
expect(json_response['message']).to eq(error_message)
end
context 'with invite_source considerations', :snowplow do
let(:params) { { user_id: stranger.id, access_level: Member::DEVELOPER } }
it 'tracks the invite source as api' do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: params
expect_snowplow_event(
category: 'Members::CreateService',
action: 'create_member',
label: 'members-api',
property: 'existing_user',
user: maintainer
)
end
it 'tracks the invite source from params' do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: params.merge(invite_source: '_invite_source_')
expect_snowplow_event(
category: 'Members::CreateService',
action: 'create_member',
label: '_invite_source_',
property: 'existing_user',
user: maintainer
)
end
end
context 'when executing the Members::CreateService for multiple user_ids' do
let(:user_ids) { [stranger.id, access_requester.id].join(',') }
it 'returns success when it successfully create all members' do
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: user_ids, access_level: Member::DEVELOPER }
expect(response).to have_gitlab_http_status(:created)
end.to change { source.members.count }.by(2)
expect(json_response['status']).to eq('success')
end
it 'returns the error message if there was an error adding members to group' do
error_message = 'Unable to find User ID'
allow_next_instance_of(::Members::CreateService) do |service|
expect(service).to receive(:execute).and_return({ status: :error, message: error_message })
end
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: user_ids, access_level: Member::DEVELOPER }
end.not_to change { source.members.count }
expect(json_response['status']).to eq('error')
expect(json_response['message']).to eq(error_message)
end
end
context 'when executing the Members::CreateService for multiple usernames' do
let(:usernames) { [stranger.username, access_requester.username].join(',') }
it 'returns success when it successfully create all members' do
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { username: usernames, access_level: Member::DEVELOPER }
expect(response).to have_gitlab_http_status(:created)
end.to change { source.members.count }.by(2)
expect(json_response['status']).to eq('success')
end
it 'returns the error message if there was an error adding members to group' do
error_message = 'Unable to find Username'
allow_next_instance_of(::Members::CreateService) do |service|
expect(service).to receive(:execute).and_return({ status: :error, message: error_message })
end
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { username: usernames, access_level: Member::DEVELOPER }
end.not_to change { source.members.count }
expect(json_response['status']).to eq('error')
expect(json_response['message']).to eq(error_message)
end
end
end
context 'access levels' do
it 'does not create the member if group level is higher' do
parent = create(:group)
group.update!(parent: parent)
project.update!(group: group)
parent.add_developer(stranger)
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id, access_level: Member::REPORTER }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['access_level'])
.to eq(["should be greater than or equal to Developer inherited membership from group #{parent.name}"])
end
it 'creates the member if group level is lower' do
parent = create(:group)
group.update!(parent: parent)
project.update!(group: group)
parent.add_developer(stranger)
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id, access_level: Member::MAINTAINER }
expect(response).to have_gitlab_http_status(:created)
expect(json_response['id']).to eq(stranger.id)
expect(json_response['access_level']).to eq(Member::MAINTAINER)
end
end
context 'access expiry date' do
subject do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id, access_level: Member::DEVELOPER, expires_at: expires_at }
end
context 'when set to a date in the past' do
let(:expires_at) { 2.days.ago.to_date }
it 'does not create a member' do
expect do
subject
end.not_to change { source.members.count }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq({ 'expires_at' => ['cannot be a date in the past'] })
end
end
context 'when set to a date in the future' do
let(:expires_at) { 2.days.from_now.to_date }
it 'creates a member' do
expect do
subject
end.to change { source.members.count }.by(1)
expect(response).to have_gitlab_http_status(:created)
expect(json_response['id']).to eq(stranger.id)
expect(json_response['expires_at']).to eq(expires_at.to_s)
end
end
end
it "returns 409 if member already exists" do
source.add_guest(stranger)
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: maintainer.id, access_level: Member::MAINTAINER }
expect(response).to have_gitlab_http_status(:conflict)
end
it 'returns 404 when the user_id is not valid' do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: non_existing_record_id, access_level: Member::MAINTAINER }
expect(response).to have_gitlab_http_status(:not_found)
expect(json_response['message']).to eq('404 User Not Found')
end
it 'returns 400 when user_id is not given' do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { access_level: Member::MAINTAINER }
expect(response).to have_gitlab_http_status(:bad_request)
end
it 'returns 400 when access_level is not given' do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id }
expect(response).to have_gitlab_http_status(:bad_request)
end
it 'returns 400 when access_level is not valid' do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: stranger.id, access_level: non_existing_record_access_level }
expect(response).to have_gitlab_http_status(:bad_request)
end
end
context 'adding project bot' do
let_it_be(:project_bot) { create(:user, :project_bot) }
before do
unrelated_project = create(:project)
unrelated_project.add_maintainer(project_bot)
end
it 'returns 400' do
expect do
post api("/#{source_type.pluralize}/#{source.id}/members", maintainer),
params: { user_id: project_bot.id, access_level: Member::DEVELOPER }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']['user_id']).to(
include('project bots cannot be added to other groups / projects'))
end.not_to change { project.members.count }
end
end
end
shared_examples 'PUT /:source_type/:id/members/:user_id' do |source_type|
context "with :source_type == #{source_type.pluralize}" do
it_behaves_like 'a 404 response when source is private' do
let(:route) do
put api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", stranger),
params: { access_level: Member::MAINTAINER }
end
end
context 'when authenticated as a non-member or member with insufficient rights' do
%i[access_requester stranger developer].each do |type|
context "as a #{type}" do
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
put api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", public_send(type)),
params: { access_level: Member::MAINTAINER }
end
end
end
end
context 'as a maintainer updating a member to one with higher access level than themselves' do
# the other 'maintainer' is in fact an owner of the group!
let(:maintainer) { maintainer2 }
before do
# the other 'maintainer' is in fact an owner of the group!
source.add_maintainer(maintainer2)
end
context 'updating a member to OWNER' do
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
put api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer),
params: { access_level: Member::OWNER }
end
end
end
end
end
context 'when authenticated as a maintainer/owner' do
context 'when updating a member with the same or lower access level' do
it 'updates the member' do
put api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer),
params: { access_level: Member::MAINTAINER }
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['id']).to eq(developer.id)
expect(json_response['access_level']).to eq(Member::MAINTAINER)
end
end
context 'when updating a member with higher access level' do
let(:owner) { create(:user) }
# the other 'maintainer' is in fact an owner of the group!
let(:maintainer) { maintainer2 }
before do
source.add_owner(owner)
source.add_maintainer(maintainer)
end
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
put api("/#{source_type.pluralize}/#{source.id}/members/#{owner.id}", maintainer),
params: { access_level: Member::OWNER }
end
end
end
end
context 'access expiry date' do
subject do
put api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer),
params: { expires_at: expires_at, access_level: Member::MAINTAINER }
end
context 'when set to a date in the past' do
let(:expires_at) { 2.days.ago.to_date }
it 'does not update the member' do
subject
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to eq({ 'expires_at' => ['cannot be a date in the past'] })
end
end
context 'when set to a date in the future' do
let(:expires_at) { 2.days.from_now.to_date }
it 'updates the member' do
subject
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['expires_at']).to eq(expires_at.to_s)
end
end
end
it 'returns 409 if member does not exist' do
put api("/#{source_type.pluralize}/#{source.id}/members/#{non_existing_record_id}", maintainer),
params: { access_level: Member::MAINTAINER }
expect(response).to have_gitlab_http_status(:not_found)
end
it 'returns 400 when access_level is not given' do
put api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer)
expect(response).to have_gitlab_http_status(:bad_request)
end
it 'returns 400 when access level is not valid' do
put api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer),
params: { access_level: 15 }
expect(response).to have_gitlab_http_status(:bad_request)
end
end
end
shared_examples 'DELETE /:source_type/:id/members/:user_id' do |source_type|
context "with :source_type == #{source_type.pluralize}" do
it_behaves_like 'a 404 response when source is private' do
let(:route) { delete api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", stranger) }
end
context 'when authenticated as a non-member or member with insufficient rights' do
%i[access_requester stranger].each do |type|
context "as a #{type}" do
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
delete api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", public_send(type))
end
end
end
end
end
context 'when authenticated as a member and deleting themself' do
it 'deletes the member' do
expect do
delete api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", developer)
expect(response).to have_gitlab_http_status(:no_content)
end.to change { source.members.count }.by(-1)
end
end
context 'when authenticated as a maintainer/owner' do
context 'and member is a requester' do
it 'returns 404' do
expect do
delete api("/#{source_type.pluralize}/#{source.id}/members/#{access_requester.id}", maintainer)
expect(response).to have_gitlab_http_status(:not_found)
end.not_to change { source.requesters.count }
end
end
context 'when attempting to delete a member with higher access level' do
let(:owner) { create(:user) }
# the other 'maintainer' is in fact an owner of the group!
let(:maintainer) { maintainer2 }
before do
source.add_owner(owner)
source.add_maintainer(maintainer)
end
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
delete api("/#{source_type.pluralize}/#{source.id}/members/#{owner.id}", maintainer)
end
end
end
it 'deletes the member' do
expect do
delete api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer)
expect(response).to have_gitlab_http_status(:no_content)
end.to change { source.members.count }.by(-1)
end
it_behaves_like 'rate limited endpoint', rate_limit_key: :members_delete do
let(:current_user) { maintainer }
let(:another_member) { create(:user) }
before do
source.add_developer(another_member)
end
# We rate limit scoped by the group / project
let(:delete_paths) do
[
api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer),
api("/#{source_type.pluralize}/#{source.id}/members/#{another_member.id}", maintainer)
]
end
def request
delete_member_path = delete_paths.shift
delete delete_member_path
end
end
it_behaves_like '412 response' do
let(:request) { api("/#{source_type.pluralize}/#{source.id}/members/#{developer.id}", maintainer) }
end
end
it 'returns 404 if member does not exist' do
delete api("/#{source_type.pluralize}/#{source.id}/members/#{non_existing_record_id}", maintainer)
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
describe 'DELETE /groups/:id/members/:user_id' do
let(:other_user) { create(:user) }
let(:nested_group) { create(:group, parent: group) }
before do
nested_group.add_developer(developer)
nested_group.add_developer(other_user)
end
it 'deletes only the member with skip_subresources=true' do
expect do
delete api("/groups/#{group.id}/members/#{developer.id}", maintainer), params: { skip_subresources: true }
expect(response).to have_gitlab_http_status(:no_content)
end.to change { group.members.count }.by(-1)
.and change { nested_group.members.count }.by(0)
end
it 'deletes member and its sub memberships with skip_subresources=false' do
expect do
delete api("/groups/#{group.id}/members/#{developer.id}", maintainer), params: { skip_subresources: false }
expect(response).to have_gitlab_http_status(:no_content)
end.to change { group.members.count }.by(-1)
.and change { nested_group.members.count }.by(-1)
end
end
# rubocop:disable Style/CombinableLoops -- new projects and groups must not be created for specs to pass
[false, true].each do |all|
it_behaves_like 'GET /:source_type/:id/members/(all)', 'project', all do
let(:source) { project }
end
it_behaves_like 'GET /:source_type/:id/members/(all)', 'group', all do
let(:source) { group }
end
end
[false, true].each do |all|
it_behaves_like 'GET /:source_type/:id/members/(all/):user_id', 'project', all do
let(:source) { all ? create(:project, :public, group: group) : project }
end
it_behaves_like 'GET /:source_type/:id/members/(all/):user_id', 'group', all do
let(:source) { all ? create(:group, parent: group) : group }
end
end
# rubocop:enable Style/CombinableLoops
describe 'POST /projects/:id/members' do
context 'adding owner to project' do
it_behaves_like 'a 403 response when user does not have rights to manage members of a specific access level' do
let(:route) do
post api("/projects/#{project.id}/members", maintainer),
params: { user_id: access_requester.id, access_level: Member::OWNER }
end
end
end
context 'add member to project' do
it 'allows adding by username' do
post api("/projects/#{project.id}/members", maintainer),
params: { username: access_requester.username, access_level: Member::DEVELOPER }
expect(response).to have_gitlab_http_status(:created)
expect(json_response['username']).to eq(access_requester.username)
end
it 'returns a 400 if user_id is also provided' do
post api("/projects/#{project.id}/members", maintainer),
params: { username: access_requester.username, user_id: access_requester.id, access_level: Member::DEVELOPER }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to eq('user_id, username are mutually exclusive')
end
it 'returns a 400 if user_id and username is missing' do
post api("/projects/#{project.id}/members", maintainer),
params: { access_level: Member::DEVELOPER }
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['error']).to match('at least one parameter must be provided')
end
end
context 'remove bot from project' do
it 'returns a 403 forbidden' do
project_bot = create(:user, :project_bot)
create(:project_member, project: project, user: project_bot)
expect do
delete api("/projects/#{project.id}/members/#{project_bot.id}", maintainer)
expect(response).to have_gitlab_http_status(:forbidden)
end.not_to change { project.members.count }
end
end
end
it_behaves_like 'POST /:source_type/:id/members', 'project' do
let(:source) { project }
before do
allow(Gitlab::QueryLimiting::Transaction).to receive(:threshold).and_return(102)
end
end
it_behaves_like 'POST /:source_type/:id/members', 'group' do
let(:source) { group }
end
it_behaves_like 'PUT /:source_type/:id/members/:user_id', 'project' do
let(:source) { project }
end
it_behaves_like 'PUT /:source_type/:id/members/:user_id', 'group' do
let(:source) { group }
end
it_behaves_like 'DELETE /:source_type/:id/members/:user_id', 'project' do
let(:source) { project }
end
it_behaves_like 'DELETE /:source_type/:id/members/:user_id', 'group' do
let(:source) { group }
end
end
|