appsignal 2.4.3 → 2.5.0.alpha.1

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -260,12 +260,12 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :report => true do
             "Agent diagnostics",
             "  Error while parsing agent diagnostics report:",
             "    Output: invalid agent\njson"
-          expect(output).to match(/Error: \d+: unexpected token at 'invalid agent\njson'/)
+          expect(output).to match(/Error:( \d+:)? unexpected token at 'invalid agent\njson'/)
         end
 
         it "adds the output to the report" do
           expect(received_report["agent"]["error"])
-            .to match(/\d+: unexpected token at 'invalid agent\njson'/)
+            .to match(/unexpected token at 'invalid agent\njson'/)
           expect(received_report["agent"]["output"]).to eq(["invalid agent", "json"])
         end
       end
@@ -652,7 +652,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :report => true do
         it "adds paths to the report" do
           run
           expect(received_report["paths"].keys)
-            .to match_array(%w(root_path working_dir log_dir_path log_file_path))
+            .to match_array(%w[root_path working_dir log_dir_path log_file_path])
         end
       end
 

data/spec/lib/appsignal/cli/notify_of_deploy_spec.rb

@@ -75,7 +75,7 @@ describe Appsignal::CLI::NotifyOfDeploy do
 
       it "requires environment option" do
         expect { run }.to raise_error(SystemExit)
-        expect(output).to include_missing_options(%w(environment))
+        expect(output).to include_missing_options(%w[environment])
         expect(output).to_not include_deploy_notification
       end
     end
@@ -98,7 +98,7 @@ describe Appsignal::CLI::NotifyOfDeploy do
         it "prints a missing required options error" do
           expect { run }.to raise_error(SystemExit)
           expect(output).to_not include_config_error
-          expect(output).to include_missing_options(%w(revision user))
+          expect(output).to include_missing_options(%w[revision user])
           expect(output).to_not include_deploy_notification
         end
 
@@ -108,7 +108,7 @@ describe Appsignal::CLI::NotifyOfDeploy do
           it "prints a missing required option error" do
             expect { run }.to raise_error(SystemExit)
             expect(output).to_not include_config_error
-            expect(output).to include_missing_options(%w(user))
+            expect(output).to include_missing_options(%w[user])
             expect(output).to_not include_deploy_notification
           end
         end
@@ -133,7 +133,7 @@ describe Appsignal::CLI::NotifyOfDeploy do
             it "requires name option" do
               expect { run }.to raise_error(SystemExit)
               expect(output).to_not include_config_error
-              expect(output).to include_missing_options(%w(name))
+              expect(output).to include_missing_options(%w[name])
               expect(output).to_not include_deploy_notification
             end
           end

data/spec/lib/appsignal/config_spec.rb

@@ -222,43 +222,54 @@ describe Appsignal::Config do
       end
     end
 
-    describe "old-style config keys" do
-      describe ":api_key" do
-        subject { config[:push_api_key] }
+    describe "support for old config keys" do
+      let(:config) { project_fixture_config(env, {}, test_logger(log)) }
+      let(:log) { StringIO.new }
 
+      describe ":api_key" do
         context "without :push_api_key" do
-          let(:config) { project_fixture_config("old_config") }
+          let(:env) { "old_config" }
 
           it "sets the :push_api_key with the old :api_key value" do
-            expect(subject).to eq "def"
+            expect(config[:push_api_key]).to eq "def"
+            expect(config.config_hash).to_not have_key :api_key
+            expect(log_contents(log)).to contains_log :warn,
+              "Old configuration key found. Please update the 'api_key' to 'push_api_key'"
           end
         end
 
         context "with :push_api_key" do
-          let(:config) { project_fixture_config("old_config_mixed_with_new_config") }
+          let(:env) { "old_config_mixed_with_new_config" }
 
-          it "ignores the :api_key config" do
-            expect(subject).to eq "ghi"
+          it "ignores the :api_key config and deletes it" do
+            expect(config[:push_api_key]).to eq "ghi"
+            expect(config.config_hash).to_not have_key :api_key
+            expect(log_contents(log)).to contains_log :warn,
+              "Old configuration key found. Please update the 'api_key' to 'push_api_key'"
           end
         end
       end
 
       describe ":ignore_exceptions" do
-        subject { config[:ignore_errors] }
-
         context "without :ignore_errors" do
-          let(:config) { project_fixture_config("old_config") }
+          let(:env) { "old_config" }
 
           it "sets :ignore_errors with the old :ignore_exceptions value" do
-            expect(subject).to eq ["StandardError"]
+            expect(config[:ignore_errors]).to eq ["StandardError"]
+            expect(config.config_hash).to_not have_key :ignore_exceptions
+            expect(log_contents(log)).to contains_log :warn,
+              "Old configuration key found. Please update the 'ignore_exceptions' to 'ignore_errors'"
           end
         end
 
         context "with :ignore_errors" do
-          let(:config) { project_fixture_config("old_config_mixed_with_new_config") }
+          let(:env) { "old_config_mixed_with_new_config" }
 
           it "ignores the :ignore_exceptions config" do
-            expect(subject).to eq ["NoMethodError"]
+            expect(config[:ignore_errors]).to eq ["NoMethodError"]
+            expect(config.config_hash).to_not have_key :ignore_exceptions
+            expect(log_contents(log)).to contains_log :warn,
+              "Old configuration key found. Please update the 'ignore_exceptions' to 'ignore_errors'"
           end
         end
       end
@@ -298,9 +309,9 @@ describe Appsignal::Config do
       expect(config[:active]).to eq(true)
       expect(config[:name]).to eq "App name"
       expect(config[:debug]).to eq(true)
-      expect(config[:ignore_actions]).to eq %w(action1 action2)
-      expect(config[:ignore_errors]).to eq %w(ExampleStandardError AnotherError)
-      expect(config[:ignore_namespaces]).to eq %w(admin private_namespace)
+      expect(config[:ignore_actions]).to eq %w[action1 action2]
+      expect(config[:ignore_errors]).to eq %w[ExampleStandardError AnotherError]
+      expect(config[:ignore_namespaces]).to eq %w[admin private_namespace]
       expect(config[:instrument_net_http]).to eq(false)
       expect(config[:instrument_redis]).to eq(false)
       expect(config[:instrument_sequel]).to eq(false)
@@ -384,13 +395,13 @@ describe Appsignal::Config do
     let(:config) { project_fixture_config(:production) }
     before do
       config[:http_proxy] = "http://localhost"
-      config[:ignore_actions] = %w(action1 action2)
-      config[:ignore_errors] = %w(ExampleStandardError AnotherError)
-      config[:ignore_namespaces] = %w(admin private_namespace)
+      config[:ignore_actions] = %w[action1 action2]
+      config[:ignore_errors] = %w[ExampleStandardError AnotherError]
+      config[:ignore_namespaces] = %w[admin private_namespace]
       config[:log] = "stdout"
       config[:log_path] = "/tmp"
       config[:hostname] = "app1.local"
-      config[:filter_parameters] = %w(password confirm_password)
+      config[:filter_parameters] = %w[password confirm_password]
       config[:running_in_container] = false
       config[:dns_servers] = ["8.8.8.8", "8.8.4.4"]
       config.write_to_environment
@@ -601,4 +612,26 @@ describe Appsignal::Config do
       end
     end
   end
+
+  describe "#validate" do
+    before { config.validate }
+    subject { config.valid? }
+    let(:config) { described_class.new(Dir.pwd, "production", :push_api_key => push_api_key) }
+
+    context "with missing push_api_key" do
+      let(:push_api_key) { nil }
+
+      it "sets valid to false" do
+        is_expected.to eq(false)
+      end
+    end
+
+    context "with push_api_key present" do
+      let(:push_api_key) { "abc" }
+
+      it "sets valid to true" do
+        is_expected.to eq(true)
+      end
+    end
+  end
 end

data/spec/lib/appsignal/extension/jruby_spec.rb

@@ -0,0 +1,43 @@
+if Appsignal::System.jruby?
+  describe Appsignal::Extension::Jruby do
+    let(:extension) { Appsignal::Extension }
+
+    describe "string conversions" do
+      it "keeps the same value during string type conversions" do
+        # UTF-8 string with NULL
+        # Tests if the conversions between the conversions without breaking on
+        # NULL terminated strings in C.
+        string = "Merry Christmas! \u0000 🎄"
+
+        appsignal_string = extension.make_appsignal_string(string)
+        ruby_string = extension.make_ruby_string(appsignal_string)
+
+        expect(ruby_string).to eq("Merry Christmas! \u0000 🎄")
+      end
+    end
+
+    it "loads libappsignal with FFI" do
+      expect(described_class.ffi_libraries.map(&:name).first).to include "libappsignal"
+    end
+
+    describe ".lib_extension" do
+      subject { described_class.lib_extension }
+
+      context "when on a darwin system" do
+        before { expect(Appsignal::System).to receive(:agent_platform).and_return("darwin") }
+
+        it "returns the extension for darwin" do
+          is_expected.to eq "dylib"
+        end
+      end
+
+      context "when on a linux system" do
+        before { expect(Appsignal::System).to receive(:agent_platform).and_return("linux") }
+
+        it "returns the lib extension for linux" do
+          is_expected.to eq "so"
+        end
+      end
+    end
+  end
+end

data/spec/lib/appsignal/extension_spec.rb

@@ -1,6 +1,4 @@
-require "fileutils"
-
-describe "extension loading and operation" do
+describe Appsignal::Extension do
   describe ".agent_config" do
     subject { Appsignal::Extension.agent_config }
 
@@ -11,7 +9,7 @@ describe "extension loading and operation" do
   describe ".agent_version" do
     subject { Appsignal::Extension.agent_version }
 
-    it { is_expected.to_not be_nil }
+    it { is_expected.to be_kind_of(String) }
   end
 
   context "when the extension library can be loaded" do
@@ -21,9 +19,29 @@ describe "extension loading and operation" do
       expect(Appsignal.extension_loaded?).to be_truthy
     end
 
-    it "should have a start and stop method" do
-      subject.start
-      subject.stop
+    context "without valid config" do
+      let(:out_stream) { std_stream }
+      let(:output) { out_stream.read }
+
+      describe ".start" do
+        it "outputs a warning about not starting the extension" do
+          capture_std_streams(out_stream, out_stream) do
+            subject.start
+          end
+
+          expect(output).to include \
+            "WARNING: Error when reading appsignal config, appsignal not starting"
+        end
+      end
+
+      describe ".stop" do
+        it "does nothing" do
+          capture_std_streams(out_stream, out_stream) do
+            subject.stop
+          end
+          expect(output).to be_empty
+        end
+      end
     end
 
     context "with a valid config" do
@@ -101,11 +119,9 @@ describe "extension loading and operation" do
   context "when the extension library cannot be loaded" do
     subject { Appsignal::Extension }
 
-    before :context do
-      Appsignal.extension_loaded = false
-    end
-    after :context do
-      Appsignal.extension_loaded = true
+    before do
+      allow(Appsignal).to receive(:extension_loaded).and_return(false)
+      allow(Appsignal).to receive(:testing?).and_return(false)
     end
 
     it "should indicate that the extension is not loaded" do

data/spec/lib/appsignal/hooks/sequel_spec.rb

@@ -1,6 +1,12 @@
 describe Appsignal::Hooks::SequelHook do
   if DependencyHelper.sequel_present?
-    let(:db) { Sequel.sqlite }
+    let(:db) do
+      if Appsignal::System.jruby?
+        Sequel.connect("jdbc:sqlite::memory:")
+      else
+        Sequel.sqlite
+      end
+    end
 
     before :context do
       start_agent

data/spec/lib/appsignal/integrations/que_spec.rb

@@ -9,7 +9,7 @@ if DependencyHelper.que_present?
           :queue => "dfl",
           :job_class => "MyQueJob",
           :priority => 100,
-          :args => %w(1 birds),
+          :args => %w[1 birds],
           :run_at => fixed_time,
           :error_count => 0
         }
@@ -26,7 +26,7 @@ if DependencyHelper.que_present?
             :run_at => fixed_time.to_s,
             :attempts => 0
           },
-          :params => %w(1 birds)
+          :params => %w[1 birds]
         }
       end
 
@@ -92,7 +92,7 @@ if DependencyHelper.que_present?
             "title" => ""
           )
           expect(subject["sample_data"]).to include(
-            "params" => %w(1 birds),
+            "params" => %w[1 birds],
             "metadata" => {
               "attempts" => 0,
               "id" => 123,
@@ -125,7 +125,7 @@ if DependencyHelper.que_present?
             "message" => error.message
           )
           expect(subject["sample_data"]).to include(
-            "params" => %w(1 birds),
+            "params" => %w[1 birds],
             "metadata" => {
               "attempts" => 0,
               "id" => 123,
@@ -158,7 +158,7 @@ if DependencyHelper.que_present?
             "message" => error.message
           )
           expect(subject["sample_data"]).to include(
-            "params" => %w(1 birds),
+            "params" => %w[1 birds],
             "metadata" => {
               "attempts" => 0,
               "id" => 123,

data/spec/lib/appsignal/system_spec.rb

@@ -55,11 +55,12 @@ describe Appsignal::System do
   end
 
   describe ".agent_platform" do
-    let(:os) { "linux" }
+    let(:os) { "linux-gnu" }
     let(:ldd_output) { "" }
     before do
       allow(described_class).to receive(:ldd_version_output).and_return(ldd_output)
-      allow(Gem::Platform.local).to receive(:os).and_return(os)
+      allow(RbConfig::CONFIG).to receive(:[])
+      allow(RbConfig::CONFIG).to receive(:[]).with("host_os").and_return(os)
     end
     subject { described_class.agent_platform }
 
@@ -110,7 +111,7 @@ describe Appsignal::System do
     end
 
     context "when on macOS" do
-      let(:os) { "darwin" }
+      let(:os) { "darwin16.7.0" }
       let(:ldd_output) { "ldd: command not found" }
 
       it "returns the darwin build" do
@@ -119,7 +120,7 @@ describe Appsignal::System do
     end
 
     context "when on FreeBSD" do
-      let(:os) { "freebsd" }
+      let(:os) { "freebsd11" }
       let(:ldd_output) { "ldd: illegal option -- -" }
 
       it "returns the darwin build" do

data/spec/lib/appsignal/transaction_spec.rb

@@ -59,7 +59,7 @@ describe Appsignal::Transaction do
             new_transaction = create_transaction("2")
             expect(new_transaction).to eq(current_transaction)
             expect(new_transaction.transaction_id).to eq(transaction_id)
-          end.to_not change { current_transaction }
+          end.to_not(change { current_transaction })
         end
 
         it "logs a debug message" do
@@ -835,7 +835,7 @@ describe Appsignal::Transaction do
         end
 
         context "with AppSignal filtering" do
-          before { Appsignal.config.config_hash[:filter_parameters] = %w(foo) }
+          before { Appsignal.config.config_hash[:filter_parameters] = %w[foo] }
           after { Appsignal.config.config_hash[:filter_parameters] = [] }
 
           it "returns sanitized custom params" do
@@ -871,16 +871,16 @@ describe Appsignal::Transaction do
 
       context "with an array" do
         let(:request) do
-          Appsignal::Transaction::GenericRequest.new(background_env_with_data(:params => %w(arg1 arg2)))
+          Appsignal::Transaction::GenericRequest.new(background_env_with_data(:params => %w[arg1 arg2]))
         end
 
-        it { is_expected.to eq %w(arg1 arg2) }
+        it { is_expected.to eq %w[arg1 arg2] }
 
         context "with AppSignal filtering" do
-          before { Appsignal.config.config_hash[:filter_parameters] = %w(foo) }
+          before { Appsignal.config.config_hash[:filter_parameters] = %w[foo] }
           after { Appsignal.config.config_hash[:filter_parameters] = [] }
 
-          it { is_expected.to eq %w(arg1 arg2) }
+          it { is_expected.to eq %w[arg1 arg2] }
         end
       end
 
@@ -901,7 +901,7 @@ describe Appsignal::Transaction do
             Appsignal::Transaction::GenericRequest.new \
               http_request_env_with_data(:params => { :foo => :bar, :baz => :bat })
           end
-          before { Appsignal.config.config_hash[:filter_parameters] = %w(foo) }
+          before { Appsignal.config.config_hash[:filter_parameters] = %w[foo] }
           after { Appsignal.config.config_hash[:filter_parameters] = [] }
 
           it "should call the params sanitizer with filtering" do
@@ -1055,7 +1055,7 @@ describe Appsignal::Transaction do
           :both_symbols => :valid_value,
           :integer_value => 1,
           :hash_value => { "invalid" => "hash" },
-          :array_value => %w(invalid array),
+          :array_value => %w[invalid array],
           :to_long_value => SecureRandom.urlsafe_base64(101),
           :object => Object.new,
           SecureRandom.urlsafe_base64(101) => "to_long_key"

data/spec/lib/appsignal/utils/params_sanitizer_spec.rb

@@ -82,7 +82,7 @@ describe Appsignal::Utils::ParamsSanitizer do
 
     context "with :filter_parameters option" do
       let(:sanitized_params) do
-        described_class.sanitize(params, :filter_parameters => %w(text hash))
+        described_class.sanitize(params, :filter_parameters => %w[text hash])
       end
       subject { sanitized_params }
 
@@ -100,7 +100,7 @@ describe Appsignal::Utils::ParamsSanitizer do
 
       context "with strings as key filter values" do
         let(:sanitized_params) do
-          described_class.sanitize(params, :filter_parameters => %w(string))
+          described_class.sanitize(params, :filter_parameters => %w[string])
         end
 
         it "sanitizes values" do
@@ -110,7 +110,7 @@ describe Appsignal::Utils::ParamsSanitizer do
 
       describe ":hash" do
         let(:sanitized_params) do
-          described_class.sanitize(params, :filter_parameters => %w(nested_text))
+          described_class.sanitize(params, :filter_parameters => %w[nested_text])
         end
         subject { sanitized_params[:hash] }
 
@@ -121,7 +121,7 @@ describe Appsignal::Utils::ParamsSanitizer do
         describe ":nested_array" do
           describe ":nested_hash" do
             let(:sanitized_params) do
-              described_class.sanitize(params, :filter_parameters => %w(key))
+              described_class.sanitize(params, :filter_parameters => %w[key])
             end
             subject { sanitized_params[:hash][:nested_array][3] }