diff options
Diffstat (limited to 'spec/support/shared_examples/graphql')
4 files changed, 123 insertions, 0 deletions
diff --git a/spec/support/shared_examples/graphql/members_shared_examples.rb b/spec/support/shared_examples/graphql/members_shared_examples.rb index a58e716efd2..3a046c3feec 100644 --- a/spec/support/shared_examples/graphql/members_shared_examples.rb +++ b/spec/support/shared_examples/graphql/members_shared_examples.rb @@ -20,3 +20,64 @@ RSpec.shared_examples 'a working membership object query' do |model_option| ).to eq('DEVELOPER') end end + +RSpec.shared_examples 'querying members with a group' do + let_it_be(:root_group) { create(:group, :private) } + let_it_be(:group_1) { create(:group, :private, parent: root_group, name: 'Main Group') } + let_it_be(:group_2) { create(:group, :private, parent: root_group) } + + let_it_be(:user_1) { create(:user, name: 'test user') } + let_it_be(:user_2) { create(:user, name: 'test user 2') } + let_it_be(:user_3) { create(:user, name: 'another user 1') } + let_it_be(:user_4) { create(:user, name: 'another user 2') } + + let_it_be(:root_group_member) { create(:group_member, user: user_4, group: root_group) } + let_it_be(:group_1_member) { create(:group_member, user: user_2, group: group_1) } + let_it_be(:group_2_member) { create(:group_member, user: user_3, group: group_2) } + + let(:args) { {} } + + subject do + resolve(described_class, obj: resource, args: args, ctx: { current_user: user_4 }) + end + + describe '#resolve' do + before do + group_1.add_maintainer(user_4) + end + + it 'finds all resource members' do + expect(subject).to contain_exactly(resource_member, group_1_member, root_group_member) + end + + context 'with search' do + context 'when the search term matches a user' do + let(:args) { { search: 'test' } } + + it 'searches users by user name' do + expect(subject).to contain_exactly(resource_member, group_1_member) + end + end + + context 'when the search term does not match any user' do + let(:args) { { search: 'nothing' } } + + it 'is empty' do + expect(subject).to be_empty + end + end + end + + context 'when user can not see resource members' do + let_it_be(:other_user) { create(:user) } + + subject do + resolve(described_class, obj: resource, args: args, ctx: { current_user: other_user }) + end + + it 'raises an error' do + expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable) + end + end + end +end diff --git a/spec/support/shared_examples/graphql/mutation_shared_examples.rb b/spec/support/shared_examples/graphql/mutation_shared_examples.rb index 86d2bb6c747..b67cac94547 100644 --- a/spec/support/shared_examples/graphql/mutation_shared_examples.rb +++ b/spec/support/shared_examples/graphql/mutation_shared_examples.rb @@ -19,6 +19,13 @@ RSpec.shared_examples 'a mutation that returns top-level errors' do |errors: []| end end +# There must be a method or let called `mutation` defined that executes +# the mutation. +RSpec.shared_examples 'a mutation that returns a top-level access error' do + include_examples 'a mutation that returns top-level errors', + errors: [Gitlab::Graphql::Authorize::AuthorizeResource::RESOURCE_ACCESS_ERROR] +end + RSpec.shared_examples 'an invalid argument to the mutation' do |argument_name:| it_behaves_like 'a mutation that returns top-level errors' do let(:match_errors) do diff --git a/spec/support/shared_examples/graphql/sorted_paginated_query_shared_examples.rb b/spec/support/shared_examples/graphql/sorted_paginated_query_shared_examples.rb index 2ef71d275a2..7627a7b4d59 100644 --- a/spec/support/shared_examples/graphql/sorted_paginated_query_shared_examples.rb +++ b/spec/support/shared_examples/graphql/sorted_paginated_query_shared_examples.rb @@ -84,6 +84,9 @@ RSpec.shared_examples 'sorted paginated query' do cursored_query = pagination_query([sort_argument, "after: \"#{end_cursor}\""].compact.join(','), page_info) post_graphql(cursored_query, current_user: current_user) + + expect(response).to have_gitlab_http_status(:ok) + response_data = graphql_dig_at(Gitlab::Json.parse(response.body), :data, *data_path, :edges) expect(pagination_results_data(response_data)).to eq expected_results.drop(first_param) diff --git a/spec/support/shared_examples/graphql/types/gitlab_style_deprecations_shared_examples.rb b/spec/support/shared_examples/graphql/types/gitlab_style_deprecations_shared_examples.rb new file mode 100644 index 00000000000..ed139e638bf --- /dev/null +++ b/spec/support/shared_examples/graphql/types/gitlab_style_deprecations_shared_examples.rb @@ -0,0 +1,52 @@ +# frozen_string_literal: true + +RSpec.shared_examples 'Gitlab-style deprecations' do + describe 'validations' do + it 'raises an informative error if `deprecation_reason` is used' do + expect { subject(deprecation_reason: 'foo') }.to raise_error( + ArgumentError, + 'Use `deprecated` property instead of `deprecation_reason`. ' \ + 'See https://docs.gitlab.com/ee/development/api_graphql_styleguide.html#deprecating-fields-and-enum-values' + ) + end + + it 'raises an error if a required property is missing', :aggregate_failures do + expect { subject(deprecated: { milestone: '1.10' }) }.to raise_error( + ArgumentError, + 'Please provide a `reason` within `deprecated`' + ) + expect { subject(deprecated: { reason: 'Deprecation reason' }) }.to raise_error( + ArgumentError, + 'Please provide a `milestone` within `deprecated`' + ) + end + + it 'raises an error if milestone is not a String', :aggregate_failures do + expect { subject(deprecated: { milestone: 1.10, reason: 'Deprecation reason' }) }.to raise_error( + ArgumentError, + '`milestone` must be a `String`' + ) + end + end + + it 'adds a formatted `deprecated_reason` to the subject' do + deprecable = subject(deprecated: { milestone: '1.10', reason: 'Deprecation reason' }) + + expect(deprecable.deprecation_reason).to eq('Deprecation reason. Deprecated in 1.10') + end + + it 'appends to the description if given' do + deprecable = subject( + deprecated: { milestone: '1.10', reason: 'Deprecation reason' }, + description: 'Deprecable description' + ) + + expect(deprecable.description).to eq('Deprecable description. Deprecated in 1.10: Deprecation reason') + end + + it 'does not append to the description if it is absent' do + deprecable = subject(deprecated: { milestone: '1.10', reason: 'Deprecation reason' }) + + expect(deprecable.description).to be_nil + end +end |