gitlab-ce/spec/requests/api/graphql/project/branch_rules_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'getting list of branch rules for a project', feature_category: :source_code_management do
  include GraphqlHelpers

  let_it_be(:project) { create(:project, :repository, :public) }
  let_it_be(:current_user) { create(:user) }

  let(:variables) { { path: project.full_path } }
  let(:fields) { all_graphql_fields_for('BranchRule') }
  let(:query) do
    <<~GQL
    query($path: ID!, $n: Int, $cursor: String) {
      project(fullPath: $path) {
        branchRules(first: $n, after: $cursor) {
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
          edges {
            cursor
            node {
              #{fields}
            }
          }
        }
      }
    }
    GQL
  end

  context 'when the user does not have read_protected_branch abilities' do
    before do
      project.add_guest(current_user)
      post_graphql(query, current_user: current_user, variables: variables)
    end

    it_behaves_like 'a working graphql query'

    it 'hides branch rules data' do
      expect(branch_rules_data).to be_empty
    end
  end

  context 'when the user does have read_protected_branch abilities' do
    before do
      project.add_maintainer(current_user)
    end

    describe 'queries' do
      include_context 'when user tracking is disabled'

      let(:query) do
        <<~GQL
            query($path: ID!) {
              project(fullPath: $path) {
                branchRules {
                  nodes {
                    matchingBranchesCount
                  }
                }
              }
            }
        GQL
      end

      before do
        create(:protected_branch, project: project)
      end

      it 'avoids N+1 queries', :use_sql_query_cache, :aggregate_failures do
        control = ActiveRecord::QueryRecorder.new(skip_cached: false) do
          post_graphql(query, current_user: current_user, variables: variables)
        end

        # Verify the response includes the field
        expect_n_matching_branches_count_fields(2)

        create(:protected_branch, project: project)
        create(:protected_branch, name: '*', project: project)

        expect do
          post_graphql(query, current_user: current_user, variables: variables)
        end.not_to exceed_all_query_limit(control)

        expect_n_matching_branches_count_fields(4)
      end

      def expect_n_matching_branches_count_fields(count)
        branch_rule_nodes = graphql_data_at('project', 'branchRules', 'nodes')
        expect(branch_rule_nodes.count).to eq(count)
        branch_rule_nodes.each do |node|
          expect(node['matchingBranchesCount']).to be_present
        end
      end
    end

    describe 'response' do
      let_it_be(:branch_name_a) { TestEnv::BRANCH_SHA.each_key.first }
      let(:branch_rule_a_data) { branch_rules_data.dig(2, 'node') }
      let(:branch_rule_b_data) { branch_rules_data.dig(1, 'node') }
      let(:all_branches_rule_data) { branch_rules_data.dig(0, 'node') }
      let_it_be(:branch_name_b) { 'diff-*' }
      let_it_be(:protected_branch_a) do
        create(:protected_branch, project: project, name: branch_name_a)
      end

      let_it_be(:protected_branch_b) do
        create(:protected_branch, project: project, name: branch_name_b)
      end

      let(:branch_rule_a) { Projects::BranchRule.new(project, protected_branch_a) }
      let(:branch_rule_b) { Projects::BranchRule.new(project, protected_branch_b) }
      let(:branch_rules) { [branch_rule_a, branch_rule_b] }

      let(:all_branches_rule) { Projects::AllBranchesRule.new(project) }
      let(:wildcard_count) do
        TestEnv::BRANCH_SHA.keys.count do |branch_name|
          branch_name.starts_with?('diff-')
        end
      end

      before do
        post_graphql(query, current_user: current_user, variables: variables)
      end

      it_behaves_like 'a working graphql query'

      it 'includes all fields', :use_sql_query_cache, :aggregate_failures do
        expect(all_branches_rule_data).to include(
          'id' => all_branches_rule.to_global_id.to_s,
          'name' => 'All branches',
          'isDefault' => false,
          'isProtected' => false,
          'matchingBranchesCount' => project.repository.branch_count,
          'branchProtection' => nil,
          "squashOption" => be_kind_of(Hash),
          'createdAt' => nil,
          'updatedAt' => nil
        )

        expect(branch_rule_a_data).to include(
          'id' => branch_rule_a.to_global_id.to_s,
          'name' => branch_name_a,
          'isDefault' => be_boolean,
          'isProtected' => true,
          'matchingBranchesCount' => 1,
          'branchProtection' => be_kind_of(Hash),
          'createdAt' => be_kind_of(String),
          'updatedAt' => be_kind_of(String)
        )

        expect(branch_rule_b_data).to include(
          'id' => branch_rule_b.to_global_id.to_s,
          'name' => branch_name_b,
          'isDefault' => be_boolean,
          'isProtected' => true,
          'matchingBranchesCount' => wildcard_count,
          'branchProtection' => be_kind_of(Hash),
          'createdAt' => be_kind_of(String),
          'updatedAt' => be_kind_of(String)
        )
      end

      context 'when limiting the number of results' do
        let(:branch_rule_limit) { 2 }
        let(:variables) { { path: project.full_path, n: branch_rule_limit } }
        let(:next_variables) do
          { path: project.full_path, n: branch_rule_limit, cursor: last_cursor }
        end

        it_behaves_like 'a working graphql query'

        it 'returns pagination information' do
          expect(branch_rules_data.size).to eq(branch_rule_limit)
          expect(has_next_page).to be_truthy
          expect(has_prev_page).to be_falsey
          post_graphql(query, current_user: current_user, variables: next_variables)
          expect(branch_rules_data.size).to eq(1)
          expect(has_next_page).to be_falsey
          expect(has_prev_page).to be_truthy
        end

        context 'when no limit is provided' do
          let(:branch_rule_limit) { nil }

          it 'returns all branch_rules' do
            expect(branch_rules_data.map { |br| br.dig('node', 'name') }).to contain_exactly(
              'All branches',
              branch_rule_a.name,
              branch_rule_b.name
            )
          end
        end
      end
    end
  end

  def branch_rules_data
    graphql_data_at('project', 'branchRules', 'edges')
  end

  def pagination_info
    graphql_data_at('project', 'branchRules', 'pageInfo')
  end

  def has_next_page
    pagination_info['hasNextPage']
  end

  def has_prev_page
    pagination_info['hasPreviousPage']
  end

  def last_cursor
    branch_rules_data.last['cursor']
  end
end