Merge branch '211460-annotations-clusters-endpoint' into 'master'

Create cluster annotations API endpoint

Closes #211460

See merge request gitlab-org/gitlab!29502

changelogs/unreleased/211460-annotations-clusters-endpoint.yml

+---
+title: Create cluster annotations API endpoint
+merge_request: 29502
+author:
+type: added

lib/api/metrics/dashboard/annotations.rb

@@ -18,15 +18,23 @@ module API
           requires :description, type: String, desc: 'The description of the annotation'
         end
 
-        resource :environments do
+        ANNOTATIONS_SOURCES = [
+          { class: ::Environment, resource: :environments, create_service_param_key: :environment },
+          { class: Clusters::Cluster, resource: :clusters, create_service_param_key: :cluster }
+        ].freeze
+
+        ANNOTATIONS_SOURCES.each do |annotations_source|
+          resource annotations_source[:resource] do
             post ':id/metrics_dashboard/annotations' do
-            environment = ::Environment.find(params[:id])
+              annotations_source_object = annotations_source[:class].find(params[:id])
+
+              not_found! unless Feature.enabled?(:metrics_dashboard_annotations, annotations_source_object.project)
 
-            not_found! unless Feature.enabled?(:metrics_dashboard_annotations, environment.project)
+              forbidden! unless can?(current_user, :create_metrics_dashboard_annotation, annotations_source_object)
 
-            forbidden! unless can?(current_user, :create_metrics_dashboard_annotation, environment)
+              create_service_params = declared(params).merge(annotations_source[:create_service_param_key] => annotations_source_object)
 
-            result = ::Metrics::Dashboard::Annotations::CreateService.new(current_user, declared(params).merge(environment: environment)).execute
+              result = ::Metrics::Dashboard::Annotations::CreateService.new(current_user, create_service_params).execute
 
               if result[:status] == :success
                 present result[:annotation], with: Entities::Metrics::Dashboard::Annotation
@@ -38,4 +46,5 @@ module API
         end
       end
     end
+  end
 end

spec/requests/api/metrics/dashboard/annotations_spec.rb

@@ -11,23 +11,27 @@ describe API::Metrics::Dashboard::Annotations do
   let(:ending_at) { 1.hour.from_now.iso8601 }
   let(:params) { attributes_for(:metrics_dashboard_annotation, environment: environment, starting_at: starting_at, ending_at: ending_at, dashboard_path: dashboard)}
 
-  describe 'POST /environments/:environment_id/metrics_dashboard/annotations' do
-    before :all do
+  shared_examples 'POST /:source_type/:id/metrics_dashboard/annotations' do |source_type|
+    let(:url) { "/#{source_type.pluralize}/#{source.id}/metrics_dashboard/annotations" }
+
+    before do
       project.add_developer(user)
     end
 
+    context "with :source_type == #{source_type.pluralize}" do
       context 'feature flag metrics_dashboard_annotations' do
         context 'is on' do
           before do
             stub_feature_flags(metrics_dashboard_annotations: { enabled: true, thing: project })
           end
+
           context 'with correct permissions' do
             context 'with valid parameters' do
               it 'creates a new annotation', :aggregate_failures do
-              post api("/environments/#{environment.id}/metrics_dashboard/annotations", user), params: params
+                post api(url, user), params: params
 
                 expect(response).to have_gitlab_http_status(:created)
-              expect(json_response['environment_id']).to eq(environment.id)
+                expect(json_response["#{source_type}_id"]).to eq(source.id)
                 expect(json_response['starting_at'].to_time).to eq(starting_at.to_time)
                 expect(json_response['ending_at'].to_time).to eq(ending_at.to_time)
                 expect(json_response['description']).to eq(params[:description])
@@ -37,8 +41,7 @@ describe API::Metrics::Dashboard::Annotations do
 
             context 'with invalid parameters' do
               it 'returns error messsage' do
-              post api("/environments/#{environment.id}/metrics_dashboard/annotations", user),
-                  params: { dashboard_path: nil, starting_at: nil, description: nil }
+                post api(url, user), params: { dashboard_path: nil, starting_at: nil, description: nil }
 
                 expect(response).to have_gitlab_http_status(:bad_request)
                 expect(json_response['message']).to include({ "starting_at" => ["can't be blank"], "description" => ["can't be blank"], "dashboard_path" => ["can't be blank"] })
@@ -49,10 +52,11 @@ describe API::Metrics::Dashboard::Annotations do
               before do
                 params[:undeclared_param] = 'xyz'
               end
+
               it 'filters out undeclared params' do
                 expect(::Metrics::Dashboard::Annotations::CreateService).to receive(:new).with(user, hash_excluding(:undeclared_param))
 
-              post api("/environments/#{environment.id}/metrics_dashboard/annotations", user), params: params
+                post api(url, user), params: params
               end
             end
           end
@@ -65,23 +69,52 @@ describe API::Metrics::Dashboard::Annotations do
             end
 
             it 'returns error messsage' do
-            post api("/environments/#{environment.id}/metrics_dashboard/annotations", guest), params: params
+              post api(url, guest), params: params
 
               expect(response).to have_gitlab_http_status(:forbidden)
             end
           end
         end
+
         context 'is off' do
           before do
-          stub_feature_flags(metrics_dashboard_annotations: { enabled: false, thing: project })
+            stub_feature_flags(metrics_dashboard_annotations: { enabled: false })
           end
 
           it 'returns error messsage' do
-          post api("/environments/#{environment.id}/metrics_dashboard/annotations", user), params: params
+            post api(url, user), params: params
 
             expect(response).to have_gitlab_http_status(:not_found)
           end
         end
       end
     end
+  end
+
+  describe 'environment' do
+    it_behaves_like 'POST /:source_type/:id/metrics_dashboard/annotations', 'environment' do
+      let(:source) { environment }
+    end
+  end
+
+  describe 'group cluster' do
+    it_behaves_like 'POST /:source_type/:id/metrics_dashboard/annotations', 'cluster' do
+      let_it_be(:group) { create(:group) }
+      let_it_be(:cluster) { create(:cluster_for_group, groups: [group]) }
+
+      before do
+        group.add_developer(user)
+      end
+
+      let(:source) { cluster }
+    end
+  end
+
+  describe 'project cluster' do
+    it_behaves_like 'POST /:source_type/:id/metrics_dashboard/annotations', 'cluster' do
+      let_it_be(:cluster) { create(:cluster, projects: [project]) }
+
+      let(:source) { cluster }
+    end
+  end
 end