airbrake-ruby 3.2.2-java

data/spec/code_hunk_spec.rb

@@ -0,0 +1,118 @@
+RSpec.describe Airbrake::CodeHunk do
+  let(:config) { Airbrake::Config.new }
+
+  after do
+    %w[empty_file.rb code.rb banana.rb short_file.rb long_line.txt].each do |f|
+      Airbrake::FileCache[project_root_path(f)] = nil
+    end
+  end
+
+  describe "#to_h" do
+    context "when file is empty" do
+      subject do
+        described_class.new(config).get(project_root_path('empty_file.rb'), 1)
+      end
+
+      it { is_expected.to eq(1 => '') }
+    end
+
+    context "when line is nil" do
+      subject { described_class.new(config).get(project_root_path('code.rb'), nil) }
+
+      it { is_expected.to be_nil }
+    end
+
+    context "when a file doesn't exist" do
+      subject { described_class.new(config).get(project_root_path('banana.rb'), 1) }
+
+      it { is_expected.to be_nil }
+    end
+
+    context "when a file has less than NLINES lines before start line" do
+      subject { described_class.new(config).get(project_root_path('code.rb'), 1) }
+
+      it do
+        is_expected.to(
+          eq(
+            1 => 'module Airbrake',
+            2 => '  ##',
+            # rubocop:disable Metrics/LineLength
+            3 => '  # Represents a chunk of information that is meant to be either sent to',
+            # rubocop:enable Metrics/LineLength
+          )
+        )
+      end
+    end
+
+    context "when a file has less than NLINES lines after end line" do
+      subject { described_class.new(config).get(project_root_path('code.rb'), 222) }
+
+      it do
+        is_expected.to(
+          eq(
+            220 => '  end',
+            221 => 'end'
+          )
+        )
+      end
+    end
+
+    context "when a file has less than NLINES lines before and after" do
+      subject do
+        described_class.new(config).get(project_root_path('short_file.rb'), 2)
+      end
+
+      it do
+        is_expected.to(
+          eq(
+            1 => 'module Banana',
+            2 => '  attr_reader :bingo',
+            3 => 'end'
+          )
+        )
+      end
+    end
+
+    context "when a file has enough lines before and after" do
+      subject { described_class.new(config).get(project_root_path('code.rb'), 100) }
+
+      it do
+        is_expected.to(
+          eq(
+            98 => '          return json if json && json.bytesize <= MAX_NOTICE_SIZE',
+            99 => '        end',
+            100 => '',
+            101 => '        break if truncate == 0',
+            102 => '      end'
+          )
+        )
+      end
+    end
+
+    context "when a line exceeds the length limit" do
+      subject do
+        described_class.new(config).get(project_root_path('long_line.txt'), 1)
+      end
+
+      it "strips the line" do
+        expect(subject[1]).to eq('l' + 'o' * 196 + 'ng')
+      end
+    end
+
+    context "when an error occurrs while fetching code" do
+      before do
+        expect(Airbrake::FileCache).to receive(:[]).and_raise(Errno::EACCES)
+      end
+
+      it "logs error and returns nil" do
+        out = StringIO.new
+        config = Airbrake::Config.new
+        config.logger = Logger.new(out)
+        expect(described_class.new(config).get(project_root_path('code.rb'), 1)).to(
+          eq(1 => '')
+        )
+        expect(out.string).to match(/can't read code hunk.+Permission denied/)
+      end
+    end
+  end
+end

data/spec/config/validator_spec.rb

@@ -0,0 +1,189 @@
+RSpec.describe Airbrake::Config::Validator do
+  subject { described_class.new(config) }
+
+  describe "#valid_project_id?" do
+    context "when project id is zero" do
+      let(:config) { Airbrake::Config.new(project_id: 0) }
+
+      it "returns false" do
+        expect(subject.valid_project_id?).to be false
+      end
+
+      it "sets correct error message" do
+        expect { subject.valid_project_id? }.to(
+          change { subject.error_message }.to(/:project_id is required/)
+        )
+      end
+    end
+
+    context "when project_id is a String" do
+      let(:config) { Airbrake::Config.new(project_id: '000') }
+
+      context "and when it's zero" do
+        it "returns false" do
+          expect(subject.valid_project_id?).to be false
+        end
+
+        it "sets correct error message" do
+          expect { subject.valid_project_id? }.
+            to(
+              change { subject.error_message }.to(/:project_id is required/)
+            )
+        end
+      end
+
+      context "and when it consists of letters" do
+        let(:config) { Airbrake::Config.new(project_id: 'bingo') }
+
+        it "returns false" do
+          expect(subject.valid_project_id?).to be false
+        end
+
+        it "sets correct error message" do
+          expect { subject.valid_project_id? }.to(
+            change { subject.error_message }.to(/:project_id is required/)
+          )
+        end
+      end
+
+      context "and when it's numerical" do
+        let(:config) { Airbrake::Config.new(project_id: '123') }
+
+        it "returns true" do
+          expect(subject.valid_project_id?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_project_id? }.not_to(change { subject.error_message })
+        end
+      end
+    end
+
+    context "when project id is non-zero" do
+      let(:config) { Airbrake::Config.new(project_id: 123) }
+
+      it "returns true" do
+        expect(subject.valid_project_id?).to be true
+      end
+
+      it "doesn't set the error message" do
+        expect { subject.valid_project_id? }.not_to(change { subject.error_message })
+      end
+    end
+  end
+
+  describe "#valid_project_key?" do
+    context "when it's a String" do
+      context "and when it's empty" do
+        let(:config) { Airbrake::Config.new(project_key: '') }
+
+        it "returns false" do
+          expect(subject.valid_project_key?).to be false
+        end
+
+        it "sets correct error message" do
+          expect { subject.valid_project_key? }.
+            to change { subject.error_message }.
+            to(/:project_key is required/)
+        end
+      end
+
+      context "and when it's non-empty" do
+        let(:config) { Airbrake::Config.new(project_key: '123abc') }
+
+        it "returns true" do
+          expect(subject.valid_project_key?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_project_key? }.not_to(change { subject.error_message })
+        end
+      end
+    end
+
+    context "when it's not a String" do
+      let(:config) { Airbrake::Config.new(project_key: 123) }
+
+      it "returns false" do
+        expect(subject.valid_project_key?).to be false
+      end
+
+      it "sets correct error message" do
+        expect { subject.valid_project_key? }.to(
+          change { subject.error_message }.to(/:project_key is required/)
+        )
+      end
+    end
+  end
+
+  describe "#valid_environment?" do
+    context "when config.environment is not set" do
+      let(:config) { Airbrake::Config.new }
+
+      it "returns true" do
+        expect(subject.valid_environment?).to be true
+      end
+
+      it "doesn't set the error message" do
+        expect { subject.valid_environment? }.not_to(change { subject.error_message })
+      end
+    end
+
+    context "when config.environment is set" do
+      context "and when it is not a Symbol or String" do
+        let(:config) { Airbrake::Config.new(environment: 123) }
+
+        it "returns false" do
+          expect(subject.valid_environment?).to be false
+        end
+
+        it "sets the error message" do
+          expect { subject.valid_environment? }.to(
+            change { subject.error_message }.
+              to(/the 'environment' option must be configured with a Symbol/)
+          )
+        end
+      end
+
+      context "and when it is a Symbol" do
+        let(:config) { Airbrake::Config.new(environment: :bingo) }
+
+        it "returns true" do
+          expect(subject.valid_environment?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_environment? }.not_to(change { subject.error_message })
+        end
+      end
+
+      context "and when it is a String" do
+        let(:config) { Airbrake::Config.new(environment: 'bingo') }
+
+        it "returns true" do
+          expect(subject.valid_environment?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_environment? }.not_to(change { subject.error_message })
+        end
+      end
+
+      context "and when it is kind of a String" do
+        let(:string_inquirer) { Class.new(String) }
+
+        let(:config) do
+          Airbrake::Config.new(environment: string_inquirer.new('bingo'))
+        end
+
+        it "returns true" do
+          expect(subject.valid_environment?).to be true
+        end
+
+        it "doesn't set the error message" do
+          expect { subject.valid_environment? }.not_to(change { subject.error_message })
+        end
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,281 @@
+RSpec.describe Airbrake::Config do
+  let(:config) { described_class.new }
+
+  describe "#new" do
+    describe "options" do
+      it "doesn't set the default project_id" do
+        expect(config.project_id).to be_nil
+      end
+
+      it "doesn't set the default project_key" do
+        expect(config.project_key).to be_nil
+      end
+
+      it "doesn't set the default proxy" do
+        expect(config.proxy).to be_empty
+      end
+
+      it "sets the default logger" do
+        expect(config.logger).to be_a Logger
+      end
+
+      it "doesn't set the default app_version" do
+        expect(config.app_version).to be_nil
+      end
+
+      it "sets the default versions" do
+        expect(config.versions).to be_empty
+      end
+
+      it "sets the default host" do
+        expect(config.host).to eq('https://api.airbrake.io')
+      end
+
+      it "sets the default endpoint" do
+        expect(config.endpoint).not_to be_nil
+      end
+
+      it "creates a new Config and merges it with the user config" do
+        cfg = described_class.new(logger: StringIO.new)
+        expect(cfg.logger).to be_a StringIO
+      end
+
+      it "raises error on unknown config options" do
+        expect { described_class.new(unknown_option: true) }.
+          to raise_error(Airbrake::Error, /unknown option/)
+      end
+
+      it "sets the default number of workers" do
+        expect(config.workers).to eq(1)
+      end
+
+      it "sets the default number of queue size" do
+        expect(config.queue_size).to eq(100)
+      end
+
+      it "sets the default root_directory" do
+        expect(config.root_directory).to eq Bundler.root.realpath.to_s
+      end
+
+      it "doesn't set the default environment" do
+        expect(config.environment).to be_nil
+      end
+
+      it "doesn't set default notify_environments" do
+        expect(config.ignore_environments).to be_empty
+      end
+
+      it "doesn't set default timeout" do
+        expect(config.timeout).to be_nil
+      end
+
+      it "doesn't set default blacklist" do
+        expect(config.blacklist_keys).to be_empty
+      end
+
+      it "doesn't set default whitelist" do
+        expect(config.whitelist_keys).to be_empty
+      end
+
+      it "disables route stats by default (deprecated)" do
+        out = StringIO.new
+        config.logger = Logger.new(out)
+        expect(config.route_stats).to be_falsey
+        expect(out.string).to match(/'route_stats'.+is deprecated/)
+      end
+
+      it "disables performance stats by default" do
+        expect(config.performance_stats).to be_falsey
+      end
+
+      it "sets the default route_stats_flush_period (deprecated)" do
+        out = StringIO.new
+        config.logger = Logger.new(out)
+        expect(config.route_stats_flush_period).to eq(15)
+        expect(out.string).to match(/'route_stats_flush_period'.+is deprecated/)
+      end
+
+      it "sets the default performance_stats_flush_period" do
+        expect(config.performance_stats_flush_period).to eq(15)
+      end
+    end
+  end
+
+  describe "#valid?" do
+    context "when project_id is nil" do
+      it "returns false" do
+        config.project_id = nil
+        config.project_key = '123'
+
+        expect(config).not_to be_valid
+      end
+    end
+
+    context "when project_key is nil" do
+      it "returns false" do
+        config.project_id = 123
+        config.project_key = nil
+
+        expect(config).not_to be_valid
+      end
+    end
+
+    context "when the current environment is ignored" do
+      context "and when the notifier misconfigures configure project_key & project_id" do
+        it "returns true" do
+          config.project_id = Object.new
+          config.project_key = Object.new
+          config.environment = :bingo
+          config.ignore_environments = [:bingo]
+
+          expect(config).to be_valid
+        end
+      end
+
+      context "and when the notifier configures project_key & project_id" do
+        it "returns true" do
+          config.project_id = 123
+          config.project_key = '321'
+          config.environment = :bingo
+          config.ignore_environments = [:bingo]
+
+          expect(config).to be_valid
+        end
+      end
+    end
+
+    context "when the project_id value is not a number" do
+      it "returns false" do
+        config.project_id = 'bingo'
+        config.project_key = '321'
+
+        expect(config).not_to be_valid
+      end
+    end
+
+    context "when the project_id value is a String number" do
+      it "returns true" do
+        config.project_id = '123'
+        config.project_key = '321'
+
+        expect(config).to be_valid
+      end
+    end
+
+    context "when the project_key value is not a String" do
+      it "returns false" do
+        config.project_id = 123
+        config.project_key = 321
+
+        expect(config).not_to be_valid
+      end
+    end
+
+    context "when the project_key value is an empty String" do
+      it "returns false" do
+        config.project_id = 123
+        config.project_key = ''
+
+        expect(config).not_to be_valid
+      end
+    end
+
+    context "when the environment value is not a String" do
+      let(:out) { StringIO.new }
+      let(:config) { described_class.new(logger: Logger.new(out)) }
+
+      before do
+        config.project_id = 123
+        config.project_key = '321'
+
+        config.environment = ['bingo']
+      end
+
+      it "returns false" do
+        expect(config).not_to be_valid
+      end
+    end
+  end
+
+  describe "#ignored_environment?" do
+    describe "warnings" do
+      let(:out) { StringIO.new }
+      let(:config) { described_class.new(logger: Logger.new(out)) }
+
+      context "when 'ignore_environments' is set and 'environment' isn't" do
+        it "prints a warning" do
+          config.ignore_environments = [:bingo]
+
+          expect(config.ignored_environment?).to be_falsey
+          expect(out.string).to match(/ignore_environments' has no effect/)
+        end
+      end
+
+      context "when 'ignore_environments' is set along with 'environment'" do
+        it "doesn't print a warning" do
+          config.environment = :bango
+          config.ignore_environments = [:bingo]
+
+          expect(config.ignored_environment?).to be_falsey
+          expect(out.string).to be_empty
+        end
+      end
+
+      context "when 'ignore_environments' isn't set and 'environment' isn't set too" do
+        it "doesn't print a warning" do
+          expect(config.ignored_environment?).to be_falsey
+          expect(out.string).to be_empty
+        end
+      end
+    end
+
+    describe "environment value types" do
+      context "when 'environment' is a String" do
+        context "and when 'ignore_environments' contains Symbols" do
+          it "returns true" do
+            config.environment = 'bango'
+            config.ignore_environments = [:bango]
+
+            expect(config.ignored_environment?).to be_truthy
+          end
+        end
+      end
+
+      context "when 'environment' is a Symbol" do
+        context "and when 'ignore_environments' contains Strings" do
+          it "returns true" do
+            config.environment = :bango
+            config.ignore_environments = %w[bango]
+
+            expect(config.ignored_environment?).to be_truthy
+          end
+        end
+      end
+    end
+  end
+
+  describe "#endpoint" do
+    context "when host is configured with a URL with a slug" do
+      before do
+        config.project_id = 1
+        config.project_key = '2'
+      end
+
+      context "and with a trailing slash" do
+        it "sets the endpoint with the slug" do
+          config.host = 'https://localhost/bingo/'
+          expect(config.endpoint.to_s).
+            to eq('https://localhost/bingo/api/v3/projects/1/notices')
+        end
+      end
+
+      context "and without a trailing slash" do
+        it "sets the endpoint without the slug" do
+          config.host = 'https://localhost/bingo'
+          expect(config.endpoint.to_s).
+            to eq('https://localhost/api/v3/projects/1/notices')
+        end
+      end
+    end
+  end
+end