sentry-ruby test cleanup (#1593)

st0012 · web-flow · commit 17836c4ab7f1 · 2021-10-24T00:30:29.000+08:00
* Remove unnecessary cause check

* Remove unnecessary test setup

* Don't activate breadcrumb logger in every test

* SDK logger should be disabled in tests
diff --git a/sentry-ruby/spec/sentry/breadcrumb_spec.rb b/sentry-ruby/spec/sentry/breadcrumb_spec.rb
@@ -16,20 +16,6 @@
     )
   end
 
-  let(:problematic_crumb) do
-    # circular reference
-    a = []
-    b = []
-    a.push(b)
-    b.push(a)
-
-    Sentry::Breadcrumb.new(
-      category: "baz",
-      message: "I cause issues",
-      data: a
-    )
-  end
-
   describe "#initialize" do
     it "limits the maximum size of message" do
       long_message = "a" * Sentry::Event::MAX_MESSAGE_SIZE_IN_BYTES * 2
@@ -50,6 +36,20 @@
   end
 
   describe "#to_hash" do
+    let(:problematic_crumb) do
+      # circular reference
+      a = []
+      b = []
+      a.push(b)
+      b.push(a)
+
+      Sentry::Breadcrumb.new(
+        category: "baz",
+        message: "I cause issues",
+        data: a
+      )
+    end
+
     it "serializes data correctly" do
       result = crumb.to_hash
 
diff --git a/sentry-ruby/spec/sentry/client/event_sending_spec.rb b/sentry-ruby/spec/sentry/client/event_sending_spec.rb
@@ -3,6 +3,7 @@
 RSpec.describe Sentry::Client do
   let(:configuration) do
     Sentry::Configuration.new.tap do |config|
+      config.logger = Logger.new(nil)
       config.dsn = DUMMY_DSN
       config.transport.transport_class = Sentry::DummyTransport
     end
diff --git a/sentry-ruby/spec/sentry/client_spec.rb b/sentry-ruby/spec/sentry/client_spec.rb
@@ -251,22 +251,19 @@ module ExcTag; end
         end
       end
 
-      # Only check causes when they're supported
-      if Exception.new.respond_to? :cause
-        context 'when the exception has a cause' do
-          let(:exception) { build_exception_with_cause }
+      context 'when the exception has a cause' do
+        let(:exception) { build_exception_with_cause }
 
-          it 'captures the cause' do
-            expect(hash[:exception][:values].length).to eq(2)
-          end
+        it 'captures the cause' do
+          expect(hash[:exception][:values].length).to eq(2)
         end
+      end
 
-        context 'when the exception has nested causes' do
-          let(:exception) { build_exception_with_two_causes }
+      context 'when the exception has nested causes' do
+        let(:exception) { build_exception_with_two_causes }
 
-          it 'captures nested causes' do
-            expect(hash[:exception][:values].length).to eq(3)
-          end
+        it 'captures nested causes' do
+          expect(hash[:exception][:values].length).to eq(3)
         end
       end
 
diff --git a/sentry-ruby/spec/sentry/configuration_spec.rb b/sentry-ruby/spec/sentry/configuration_spec.rb
@@ -279,17 +279,9 @@ class MyTestException < RuntimeError; end
             subject.inspect_exception_causes_for_exclusion = true
           end
 
-          if Exception.new.respond_to? :cause
-            context 'when the language version supports exception causes' do
-              it 'returns false' do
-                expect(subject.exception_class_allowed?(incoming_exception)).to eq false
-              end
-            end
-          else
-            context 'when the language version does not support exception causes' do
-              it 'returns true' do
-                expect(subject.exception_class_allowed?(incoming_exception)).to eq true
-              end
+          context 'when the language version supports exception causes' do
+            it 'returns false' do
+              expect(subject.exception_class_allowed?(incoming_exception)).to eq false
             end
           end
         end
diff --git a/sentry-ruby/spec/sentry/rack/capture_exceptions_spec.rb b/sentry-ruby/spec/sentry/rack/capture_exceptions_spec.rb
@@ -159,6 +159,7 @@ def inspect
     describe "state encapsulation" do
       before do
         Sentry.configure_scope { |s| s.set_tags(tag_1: "don't change me") }
+        Sentry.configuration.breadcrumbs_logger = [:sentry_logger]
       end
 
       it "only contains the breadcrumbs of the request" do
diff --git a/sentry-ruby/spec/sentry/transport/http_transport_rate_limiting_spec.rb b/sentry-ruby/spec/sentry/transport/http_transport_rate_limiting_spec.rb
@@ -9,9 +9,8 @@
     Sentry.configuration
   end
   let(:client) { Sentry.get_current_client }
-  let(:event) { client.event_from_message("foobarbaz") }
   let(:data) do
-    subject.encode(event.to_hash)
+    subject.encode(client.event_from_message("foobarbaz").to_hash)
   end
 
   subject { Sentry::HTTPTransport.new(configuration) }
diff --git a/sentry-ruby/spec/sentry_spec.rb b/sentry-ruby/spec/sentry_spec.rb
@@ -522,13 +522,10 @@
     let(:fake_root) { "/tmp/sentry/" }
 
     before do
-      allow(File).to receive(:directory?).and_return(false)
       allow_any_instance_of(Sentry::Configuration).to receive(:project_root).and_return(fake_root)
       ENV["SENTRY_DSN"] = DUMMY_DSN
     end
 
-    subject { described_class.configuration }
-
     it 'defaults to nil' do
       described_class.init
       expect(described_class.configuration.release).to eq(nil)
diff --git a/sentry-ruby/spec/spec_helper.rb b/sentry-ruby/spec/spec_helper.rb
@@ -81,7 +81,7 @@ def build_exception_with_recursive_cause
 
 def perform_basic_setup
   Sentry.init do |config|
-    config.breadcrumbs_logger = [:sentry_logger]
+    config.logger = Logger.new(nil)
     config.dsn = DUMMY_DSN
     config.transport.transport_class = Sentry::DummyTransport
     # so the events will be sent synchronously for testing
