summaryrefslogtreecommitdiff
path: root/spec/requests/api/graphql/mutations/metrics/dashboard/annotations/create_spec.rb
blob: bce57b47aab9f129dcc6789b3eb1a4e0889ef0ce (plain)
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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Mutations::Metrics::Dashboard::Annotations::Create, feature_category: :metrics 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 = {
            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 'an invalid argument to the mutation', argument_name: :environment_id
      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 = {
            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 'an invalid argument to the mutation', argument_name: :cluster_id
    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

  [:environment_id, :cluster_id].each do |arg_name|
    context "when #{arg_name} is given an ID of the wrong type" do
      let(:gid) { global_id_of(project) }
      let(:mutation) do
        variables = {
          starting_at: starting_at,
          ending_at: ending_at,
          dashboard_path: dashboard_path,
          description: description,
          arg_name => gid
        }

        graphql_mutation(:create_annotation, variables)
      end

      before do
        project.add_developer(current_user)
      end

      it_behaves_like 'an invalid argument to the mutation', argument_name: arg_name
    end
  end
end