Update Sentry client to get project list

1 files changed, 129 insertions, 30 deletions

diff --git a/spec/lib/sentry/client_spec.rb b/spec/lib/sentry/client_spec.rb
index b36be0fd9c1..6fbf60a6222 100644
--- a/spec/lib/sentry/client_spec.rb
+++ b/spec/lib/sentry/client_spec.rb
@@ -3,30 +3,76 @@
 require 'spec_helper'
 
 describe Sentry::Client do
-  let(:issue_status) { 'unresolved' }
-  let(:limit) { 20 }
   let(:sentry_url) { 'https://sentrytest.gitlab.com/api/0/projects/sentry-org/sentry-project' }
   let(:token) { 'test-token' }
 
-  let(:sample_response) do
+  let(:issues_sample_response) do
     Gitlab::Utils.deep_indifferent_access(
-      JSON.parse(File.read(Rails.root.join('spec/fixtures/sentry/issues_sample_response.json')))
+      JSON.parse(fixture_file('sentry/issues_sample_response.json'))
+    )
+  end
+
+  let(:projects_sample_response) do
+    Gitlab::Utils.deep_indifferent_access(
+      JSON.parse(fixture_file('sentry/list_projects_sample_response.json'))
     )
   end
 
   subject(:client) { described_class.new(sentry_url, token) }
 
-  describe '#list_issues' do
-    subject { client.list_issues(issue_status: issue_status, limit: limit) }
+  # Requires sentry_api_url and subject to be defined
+  shared_examples 'no redirects' do
+    let(:redirect_to) { 'https://redirected.example.com' }
+    let(:other_url) { 'https://other.example.org' }
+
+    let!(:redirected_req_stub) { stub_sentry_request(other_url) }
+
+    let!(:redirect_req_stub) do
+      stub_sentry_request(
+        sentry_api_url,
+        status: 302,
+        headers: { location: redirect_to }
+      )
+    end
 
-    before do
-      stub_sentry_request(sentry_url + '/issues/?limit=20&query=is:unresolved', body: sample_response)
+    it 'does not follow redirects' do
+      expect { subject }.to raise_exception(Sentry::Client::Error, 'Sentry response error: 302')
+      expect(redirect_req_stub).to have_been_requested
+      expect(redirected_req_stub).not_to have_been_requested
     end
+  end
 
-    it 'returns objects of type ErrorTracking::Error' do
-      expect(subject.length).to eq(1)
-      expect(subject[0]).to be_a(Gitlab::ErrorTracking::Error)
+  shared_examples 'has correct return type' do |klass|
+    it "returns objects of type #{klass}" do
+      expect(subject).to all( be_a(klass) )
     end
+  end
+
+  shared_examples 'has correct length' do |length|
+    it { expect(subject.length).to eq(length) }
+  end
+
+  # Requires sentry_api_request and subject to be defined
+  shared_examples 'calls sentry api' do
+    it 'calls sentry api' do
+      subject
+
+      expect(sentry_api_request).to have_been_requested
+    end
+  end
+
+  describe '#list_issues' do
+    let(:issue_status) { 'unresolved' }
+    let(:limit) { 20 }
+
+    let!(:sentry_api_request) { stub_sentry_request(sentry_url + '/issues/?limit=20&query=is:unresolved', body: issues_sample_response) }
+
+    subject { client.list_issues(issue_status: issue_status, limit: limit) }
+
+    it_behaves_like 'calls sentry api'
+
+    it_behaves_like 'has correct return type', Gitlab::ErrorTracking::Error
+    it_behaves_like 'has correct length', 1
 
     context 'error object created from sentry response' do
       using RSpec::Parameterized::TableSyntax
@@ -50,7 +96,7 @@ describe Sentry::Client do
       end
 
       with_them do
-        it { expect(subject[0].public_send(error_object)).to eq(sample_response[0].dig(*sentry_response)) }
+        it { expect(subject[0].public_send(error_object)).to eq(issues_sample_response[0].dig(*sentry_response)) }
       end
 
       context 'external_url' do
@@ -61,24 +107,9 @@ describe Sentry::Client do
     end
 
     context 'redirects' do
-      let(:redirect_to) { 'https://redirected.example.com' }
-      let(:other_url) { 'https://other.example.org' }
-
-      let!(:redirected_req_stub) { stub_sentry_request(other_url) }
-
-      let!(:redirect_req_stub) do
-        stub_sentry_request(
-          sentry_url + '/issues/?limit=20&query=is:unresolved',
-          status: 302,
-          headers: { location: redirect_to }
-        )
-      end
+      let(:sentry_api_url) { sentry_url + '/issues/?limit=20&query=is:unresolved' }
 
-      it 'does not follow redirects' do
-        expect { subject }.to raise_exception(Sentry::Client::Error, 'Sentry response error: 302')
-        expect(redirect_req_stub).to have_been_requested
-        expect(redirected_req_stub).not_to have_been_requested
-      end
+      it_behaves_like 'no redirects'
     end
 
     # Sentry API returns 404 if there are extra slashes in the URL!
@@ -99,7 +130,75 @@ describe Sentry::Client do
           anything
         ).and_call_original
 
-        client.list_issues(issue_status: issue_status, limit: limit)
+        subject
+
+        expect(valid_req_stub).to have_been_requested
+      end
+    end
+  end
+
+  describe '#list_projects' do
+    let(:sentry_list_projects_url) { 'https://sentrytest.gitlab.com/api/0/projects/' }
+
+    let!(:sentry_api_request) { stub_sentry_request(sentry_list_projects_url, body: projects_sample_response) }
+
+    subject { client.list_projects }
+
+    it_behaves_like 'calls sentry api'
+
+    it_behaves_like 'has correct return type', Gitlab::ErrorTracking::Project
+    it_behaves_like 'has correct length', 2
+
+    context 'keys missing in API response' do
+      it 'raises exception' do
+        projects_sample_response[0].delete(:slug)
+
+        stub_sentry_request(sentry_list_projects_url, body: projects_sample_response)
+
+        expect { subject }.to raise_error(Sentry::Client::SentryError, 'Sentry API response is missing keys. key not found: "slug"')
+      end
+    end
+
+    context 'error object created from sentry response' do
+      using RSpec::Parameterized::TableSyntax
+
+      where(:sentry_project_object, :sentry_response) do
+        :id                | :id
+        :name              | :name
+        :status            | :status
+        :slug              | :slug
+        :organization_name | [:organization, :name]
+        :organization_id   | [:organization, :id]
+        :organization_slug | [:organization, :slug]
+      end
+
+      with_them do
+        it { expect(subject[0].public_send(sentry_project_object)).to eq(projects_sample_response[0].dig(*sentry_response)) }
+      end
+    end
+
+    context 'redirects' do
+      let(:sentry_api_url) { sentry_list_projects_url }
+
+      it_behaves_like 'no redirects'
+    end
+
+    # Sentry API returns 404 if there are extra slashes in the URL!
+    context 'extra slashes in URL' do
+      let(:sentry_url) { 'https://sentrytest.gitlab.com/api//0/projects//' }
+      let(:client) { described_class.new(sentry_url, token) }
+
+      let!(:valid_req_stub) do
+        stub_sentry_request(sentry_list_projects_url)
+      end
+
+      it 'removes extra slashes in api url' do
+        expect(Gitlab::HTTP).to receive(:get).with(
+          URI(sentry_list_projects_url),
+          anything
+        ).and_call_original
+
+        subject
 
         expect(valid_req_stub).to have_been_requested
       end