gitlab-org--gitlab-foss/spec/requests/api/graphql/mutations/metrics/dashboard/annotations/create_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Mutations::Metrics::Dashboard::Annotations::Create do
  include GraphqlHelpers

  let_it_be(:current_user) { create(:user) }
  let_it_be(:project) { create(:project, :private, :repository) }
  let_it_be(:environment) { create(:environment, project: project) }
  let_it_be(:cluster) { create(:cluster, projects: [project]) }
  let(:dashboard_path) { 'config/prometheus/common_metrics.yml' }
  let(:starting_at) { Time.current.iso8601 }
  let(:ending_at) { 1.hour.from_now.iso8601 }
  let(:description) { 'test description' }

  def mutation_response
    graphql_mutation_response(:create_annotation)
  end

  specify { expect(described_class).to require_graphql_authorizations(:create_metrics_dashboard_annotation) }

  context 'when annotation source is environment' do
    let(:mutation) do
      variables = {
        environment_id: GitlabSchema.id_from_object(environment).to_s,
        starting_at: starting_at,
        ending_at: ending_at,
        dashboard_path: dashboard_path,
        description: description
      }

      graphql_mutation(:create_annotation, variables)
    end

    context 'when the user does not have permission' do
      before do
        project.add_reporter(current_user)
      end

      it_behaves_like 'a mutation that returns top-level errors',
                      errors: [Gitlab::Graphql::Authorize::AuthorizeResource::RESOURCE_ACCESS_ERROR]

      it 'does not create the annotation' do
        expect do
          post_graphql_mutation(mutation, current_user: current_user)
        end.not_to change { Metrics::Dashboard::Annotation.count }
      end
    end

    context 'when the user has permission' do
      before do
        project.add_developer(current_user)
      end

      it 'creates the annotation' do
        expect do
          post_graphql_mutation(mutation, current_user: current_user)
        end.to change { Metrics::Dashboard::Annotation.count }.by(1)
      end

      it 'returns the created annotation' do
        post_graphql_mutation(mutation, current_user: current_user)

        annotation = Metrics::Dashboard::Annotation.first
        annotation_id = GitlabSchema.id_from_object(annotation).to_s

        expect(mutation_response['annotation']['description']).to match(description)
        expect(mutation_response['annotation']['startingAt'].to_time).to match(starting_at.to_time)
        expect(mutation_response['annotation']['endingAt'].to_time).to match(ending_at.to_time)
        expect(mutation_response['annotation']['id']).to match(annotation_id)
        expect(annotation.environment_id).to eq(environment.id)
      end

      context 'when environment_id is missing' do
        let(:mutation) do
          variables = {
            environment_id: nil,
            starting_at: starting_at,
            ending_at: ending_at,
            dashboard_path: dashboard_path,
            description: description
          }

          graphql_mutation(:create_annotation, variables)
        end

        it_behaves_like 'a mutation that returns top-level errors', errors: [described_class::ANNOTATION_SOURCE_ARGUMENT_ERROR]
      end

      context 'when environment_id is invalid' do
        let(:mutation) do
          variables = {
            environment_id: 'invalid_id',
            starting_at: starting_at,
            ending_at: ending_at,
            dashboard_path: dashboard_path,
            description: description
          }

          graphql_mutation(:create_annotation, variables)
        end

        it_behaves_like 'a mutation that returns top-level errors' do
          let(:match_errors) { include(/is not a valid Global ID/) }
        end
      end
    end
  end

  context 'when annotation source is cluster' do
    let(:mutation) do
      variables = {
        cluster_id: cluster.to_global_id.to_s,
        starting_at: starting_at,
        ending_at: ending_at,
        dashboard_path: dashboard_path,
        description: description
      }

      graphql_mutation(:create_annotation, variables)
    end

    context 'with permission' do
      before do
        project.add_developer(current_user)
      end

      it 'creates the annotation' do
        expect do
          post_graphql_mutation(mutation, current_user: current_user)
        end.to change { Metrics::Dashboard::Annotation.count }.by(1)
      end

      it 'returns the created annotation' do
        post_graphql_mutation(mutation, current_user: current_user)

        annotation = Metrics::Dashboard::Annotation.first
        annotation_id = GitlabSchema.id_from_object(annotation).to_s

        expect(mutation_response['annotation']['description']).to match(description)
        expect(mutation_response['annotation']['startingAt'].to_time).to match(starting_at.to_time)
        expect(mutation_response['annotation']['endingAt'].to_time).to match(ending_at.to_time)
        expect(mutation_response['annotation']['id']).to match(annotation_id)
        expect(annotation.cluster_id).to eq(cluster.id)
      end

      context 'when cluster_id is missing' do
        let(:mutation) do
          variables = {
            cluster_id: nil,
            starting_at: starting_at,
            ending_at: ending_at,
            dashboard_path: dashboard_path,
            description: description
          }

          graphql_mutation(:create_annotation, variables)
        end

        it_behaves_like 'a mutation that returns top-level errors', errors: [described_class::ANNOTATION_SOURCE_ARGUMENT_ERROR]
      end
    end

    context 'without permission' do
      before do
        project.add_guest(current_user)
      end

      it_behaves_like 'a mutation that returns top-level errors',
                    errors: [Gitlab::Graphql::Authorize::AuthorizeResource::RESOURCE_ACCESS_ERROR]

      it 'does not create the annotation' do
        expect do
          post_graphql_mutation(mutation, current_user: current_user)
        end.not_to change { Metrics::Dashboard::Annotation.count }
      end
    end

    context 'when cluster_id is invalid' do
      let(:mutation) do
        variables = {
          cluster_id: 'invalid_id',
          starting_at: starting_at,
          ending_at: ending_at,
          dashboard_path: dashboard_path,
          description: description
        }

        graphql_mutation(:create_annotation, variables)
      end

      it_behaves_like 'a mutation that returns top-level errors' do
        let(:match_errors) { include(/is not a valid Global ID/) }
      end
    end
  end

  context 'when both environment_id and cluster_id are provided' do
    let(:mutation) do
      variables = {
        environment_id: environment.to_global_id.to_s,
        cluster_id: cluster.to_global_id.to_s,
        starting_at: starting_at,
        ending_at: ending_at,
        dashboard_path: dashboard_path,
        description: description
      }

      graphql_mutation(:create_annotation, variables)
    end

    it_behaves_like 'a mutation that returns top-level errors', errors: [described_class::ANNOTATION_SOURCE_ARGUMENT_ERROR]
  end

  context 'when a non-cluster or environment id is provided' do
    let(:gid) { { environment_id: project.to_global_id.to_s } }
    let(:mutation) do
      variables = {
        starting_at: starting_at,
        ending_at: ending_at,
        dashboard_path: dashboard_path,
        description: description
      }.merge!(gid)

      graphql_mutation(:create_annotation, variables)
    end

    before do
      project.add_developer(current_user)
    end

    describe 'non-environment id' do
      it_behaves_like 'a mutation that returns top-level errors' do
        let(:match_errors) { include(/does not represent an instance of Environment/) }
      end
    end

    describe 'non-cluster id' do
      let(:gid) { { cluster_id: project.to_global_id.to_s } }

      it_behaves_like 'a mutation that returns top-level errors' do
        let(:match_errors) { include(/does not represent an instance of Clusters::Cluster/) }
      end
    end
  end
end