Merge branch 'error-tracking-api' into 'master'

Sentry Error Tracking Settings GET API

Closes #34940

See merge request gitlab-org/gitlab!21788

changelogs/unreleased/error-tracking-api.yml

+---
+title: Add API for getting sentry error tracking settings of a project
+merge_request: 21788
+author: raju249
+type: added

doc/api/api_resources.md

@@ -29,6 +29,7 @@ The following API resources are available in the project context:
 | [Deployments](deployments.md)                                       | `/projects/:id/deployments`                                                                                                                                                                           |
 | [Discussions](discussions.md) (threaded comments)                   | `/projects/:id/issues/.../discussions`, `/projects/:id/snippets/.../discussions`, `/projects/:id/merge_requests/.../discussions`, `/projects/:id/commits/.../discussions` (also available for groups) |
 | [Environments](environments.md)                                     | `/projects/:id/environments`                                                                                                                                                                          |
+| [Error Tracking](error_tracking.md)                        | `/projects/:id/error_tracking/settings`                                                                                                                                                |
 | [Events](events.md)                                                 | `/projects/:id/events` (also available for users and standalone)                                                                                                                                      |
 | [Issues](issues.md)                                                 | `/projects/:id/issues` (also available for groups and standalone)                                                                                                                                     |
 | [Issues Statistics](issues_statistics.md)                           | `/projects/:id/issues_statistics` (also available for groups and standalone)                                                                                                                          |

doc/api/error_tracking.md

+# Error Tracking settings API
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/34940) in GitLab 12.7.
+
+## Error Tracking project settings
+
+The project settings API allows you to retrieve the Error Tracking settings for a project. Only for project maintainers.
+
+### Get Error Tracking settings
+
+```
+GET /projects/:id/error_tracking/settings
+```
+
+| Attribute | Type    | Required | Description           |
+| --------- | ------- | -------- | --------------------- |
+| `id`      | integer | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
+
+```bash
+curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/error_tracking/settings
+```
+
+Example response:
+
+```json
+{
+  "project_name": "sample sentry project",
+  "sentry_external_url": "https://sentry.io/myawesomeproject/project",
+  "api_url": "https://sentry.io/api/0/projects/myawesomeproject/project"
+}
+```

lib/api/api.rb

@@ -117,6 +117,7 @@ module API
     mount ::API::DeployKeys
     mount ::API::Deployments
     mount ::API::Environments
+    mount ::API::ErrorTracking
     mount ::API::Events
     mount ::API::Features
     mount ::API::Files

lib/api/entities/error_tracking.rb

+# frozen_string_literal: true
+
+module API
+  module Entities
+    module ErrorTracking
+      class ProjectSetting < Grape::Entity
+        expose :project_name
+        expose :sentry_external_url
+        expose :api_url
+      end
+    end
+  end
+end

lib/api/error_tracking.rb

+# frozen_string_literal: true
+
+module API
+  class ErrorTracking < Grape::API
+    before { authenticate! }
+
+    params do
+      requires :id, type: String, desc: 'The ID of a project'
+    end
+
+    resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
+      desc 'Get error tracking settings for the project' do
+        detail 'This feature was introduced in GitLab 12.7.'
+        success Entities::ErrorTracking::ProjectSetting
+      end
+
+      get ':id/error_tracking/settings' do
+        authorize! :admin_operations, user_project
+
+        setting = user_project.error_tracking_setting
+
+        not_found!('Error Tracking Setting') unless setting
+
+        present setting, with: Entities::ErrorTracking::ProjectSetting
+      end
+    end
+  end
+end

spec/requests/api/error_tracking_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe API::ErrorTracking do
+  describe "GET /projects/:id/error_tracking/settings" do
+    let(:user) { create(:user) }
+    let(:setting) { create(:project_error_tracking_setting) }
+    let(:project) { setting.project }
+
+    def make_request
+      get api("/projects/#{project.id}/error_tracking/settings", user)
+    end
+
+    context 'when authenticated as maintainer' do
+      before do
+        project.add_maintainer(user)
+      end
+
+      it 'returns project settings' do
+        make_request
+
+        expect(response).to have_gitlab_http_status(:ok)
+        expect(json_response).to eq(
+          'project_name' => setting.project_name,
+          'sentry_external_url' => setting.sentry_external_url,
+          'api_url' => setting.api_url
+        )
+      end
+    end
+
+    context 'without a project setting' do
+      let(:project) { create(:project) }
+
+      before do
+        project.add_maintainer(user)
+      end
+
+      it 'returns 404' do
+        make_request
+
+        expect(response).to have_gitlab_http_status(:not_found)
+        expect(json_response['message'])
+          .to eq('404 Error Tracking Setting Not Found')
+      end
+    end
+
+    context 'when authenticated as reporter' do
+      before do
+        project.add_reporter(user)
+      end
+
+      it 'returns 403' do
+        make_request
+
+        expect(response).to have_gitlab_http_status(:forbidden)
+      end
+    end
+
+    context 'when authenticated as non-member' do
+      it 'returns 404' do
+        make_request
+
+        expect(response).to have_gitlab_http_status(:not_found)
+      end
+    end
+
+    context 'when unauthenticated' do
+      let(:user) { nil }
+
+      it 'returns 401' do
+        make_request
+
+        expect(response).to have_gitlab_http_status(:unauthorized)
+      end
+    end
+  end
+end