appsignal 2.1.2 → 2.2.0.beta.1

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

@@ -51,6 +51,7 @@ describe Appsignal::CLI::Helpers do
   describe ".press_any_key" do
     before do
       set_input "a" # a as in any
+      prepare_input
     end
 
     it "continues after press" do
@@ -59,12 +60,40 @@ describe Appsignal::CLI::Helpers do
     end
   end
 
+  describe ".ask_for_input" do
+    it "returns the input" do
+      set_input "foo"
+      prepare_input
+      expect(cli.send(:ask_for_input)).to eq("foo")
+    end
+
+    context "with input ending with a line break" do
+      it "returns only the input" do
+        set_input "foo\n"
+        prepare_input
+        expect(cli.send(:ask_for_input)).to eq("foo")
+      end
+    end
+
+    context "when user interrupts the program" do
+      before do
+        expect(cli).to receive(:stdin).and_raise(Interrupt)
+        expect(cli).to receive(:exit).with(1)
+        capture_stdout(out_stream) { cli.send :ask_for_input }
+      end
+
+      it "exits the process" do
+        expect(output).to include("Exiting...")
+      end
+    end
+  end
+
   describe ".yes_or_no" do
     def yes_or_no
       capture_stdout(out_stream) { cli.send(:yes_or_no, "yes or no?: ") }
     end
 
-    it "takes yes for an answer" do
+    it "takes 'y' for an answer" do
       set_input ""
       set_input "nonsense"
       set_input "y"
@@ -73,7 +102,21 @@ describe Appsignal::CLI::Helpers do
       expect(yes_or_no).to be_truthy
     end
 
-    it "takes no for an answer" do
+    it "takes 'Y' for an answer" do
+      set_input "Y"
+      prepare_input
+
+      expect(yes_or_no).to be_truthy
+    end
+
+    it "takes 'yes' for an answer" do
+      set_input "yes"
+      prepare_input
+
+      expect(yes_or_no).to be_truthy
+    end
+
+    it "takes 'n' for an answer" do
       set_input ""
       set_input "nonsense"
       set_input "n"
@@ -81,6 +124,35 @@ describe Appsignal::CLI::Helpers do
 
       expect(yes_or_no).to be_falsy
     end
+
+    it "takes 'N' for an answer" do
+      set_input "N"
+      prepare_input
+
+      expect(yes_or_no).to be_falsy
+    end
+
+    it "takes 'no' for an answer" do
+      set_input "no"
+      prepare_input
+
+      expect(yes_or_no).to be_falsy
+    end
+
+    context "with a default" do
+      def yes_or_no
+        capture_stdout(out_stream) do
+          cli.send(:yes_or_no, "yes or no?: ", :default => "y")
+        end
+      end
+
+      it "returns the default if no input is received from the user" do
+        set_input ""
+        prepare_input
+
+        expect(yes_or_no).to be_truthy
+      end
+    end
   end
 
   describe ".required_input" do

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

@@ -419,7 +419,7 @@ describe Appsignal::CLI::Install do
             "Installing for Sinatra",
             "Sinatra requires some manual configuration.",
             "require 'appsignal/integrations/sinatra'",
-            "http://docs.appsignal.com/getting-started/supported-frameworks.html#sinatra"
+            "http://docs.appsignal.com/ruby/integrations/sinatra.html"
           ]
         end
         let(:app_name) { "Test app" }
@@ -486,7 +486,7 @@ describe Appsignal::CLI::Install do
           [
             "Installing for Padrino",
             "Padrino requires some manual configuration.",
-            "http://docs.appsignal.com/getting-started/supported-frameworks.html#padrino"
+            "http://docs.appsignal.com/ruby/integrations/padrino.html"
           ]
         end
         let(:app_name) { "Test app" }
@@ -553,7 +553,7 @@ describe Appsignal::CLI::Install do
           [
             "Installing for Grape",
             "Manual Grape configuration needed",
-            "http://docs.appsignal.com/getting-started/supported-frameworks.html#grape"
+            "http://docs.appsignal.com/ruby/integrations/grape.html"
           ]
         end
         let(:app_name) { "Test app" }

data/spec/lib/appsignal/config_spec.rb

@@ -50,34 +50,6 @@ describe Appsignal::Config do
       end
     end
 
-    describe ":running_in_container" do
-      subject { config[:running_in_container] }
-
-      context "when running on Heroku" do
-        around { |example| recognize_as_heroku { example.run } }
-
-        it "is set to true" do
-          expect(subject).to be_truthy
-        end
-      end
-
-      context "when running in container" do
-        around { |example| recognize_as_container(:docker) { example.run } }
-
-        it "is set to true" do
-          expect(subject).to be_truthy
-        end
-      end
-
-      context "when not running in container" do
-        around { |example| recognize_as_container(:none) { example.run } }
-
-        it "is set to false" do
-          expect(subject).to be_falsy
-        end
-      end
-    end
-
     describe ":log" do
       subject { config[:log] }
 
@@ -90,8 +62,6 @@ describe Appsignal::Config do
       end
 
       context "when not running on Heroku" do
-        around { |example| recognize_as_container(:none) { example.run } }
-
         it "is set to file" do
           expect(subject).to eq("file")
         end
@@ -109,7 +79,6 @@ describe Appsignal::Config do
         :active => true
       )
     end
-    around { |example| recognize_as_container(:none) { example.run } }
 
     it "merges with the default config" do
       expect(config.config_hash).to eq(
@@ -131,11 +100,11 @@ describe Appsignal::Config do
         :frontend_error_catching_path   => "/appsignal_error_catcher",
         :enable_allocation_tracking     => true,
         :enable_gc_instrumentation      => false,
-        :running_in_container           => false,
         :enable_host_metrics            => true,
         :enable_minutely_probes         => false,
         :hostname                       => Socket.gethostname,
-        :ca_file_path                   => File.join(resources_dir, "cacert.pem")
+        :ca_file_path                   => File.join(resources_dir, "cacert.pem"),
+        :dns_servers                    => []
       )
     end
 
@@ -216,7 +185,6 @@ describe Appsignal::Config do
           :debug => true
         )
       end
-      around { |example| recognize_as_container(:none) { example.run } }
 
       it "overrides system detected and defaults config" do
         expect(config[:running_in_container]).to be_truthy
@@ -315,7 +283,6 @@ describe Appsignal::Config do
       ENV["APPSIGNAL_INSTRUMENT_REDIS"]     = "false"
       ENV["APPSIGNAL_INSTRUMENT_SEQUEL"]    = "false"
     end
-    around { |example| recognize_as_container(:none) { example.run } }
 
     it "overrides config with environment values" do
       expect(config.valid?).to be_truthy
@@ -326,7 +293,7 @@ describe Appsignal::Config do
       expect(config[:active]).to be_truthy
       expect(config[:name]).to eq "App name"
       expect(config[:debug]).to be_truthy
-      expect(config[:ignore_actions]).to eq ["action1", "action2"]
+      expect(config[:ignore_actions]).to eq %w(action1 action2)
       expect(config[:instrument_net_http]).to be_falsey
       expect(config[:instrument_redis]).to be_falsey
       expect(config[:instrument_sequel]).to be_falsey
@@ -397,39 +364,43 @@ describe Appsignal::Config do
     let(:config) { project_fixture_config(:production) }
     before do
       config[:http_proxy] = "http://localhost"
-      config[:ignore_actions] = ["action1", "action2"]
-      config[:ignore_errors] = ["VerySpecificError", "AnotherError"]
+      config[:ignore_actions] = %w(action1 action2)
+      config[:ignore_errors] = %w(VerySpecificError AnotherError)
+      config[:log] = "stdout"
       config[:log_path] = "/tmp"
       config[:hostname] = "app1.local"
       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
     end
 
     it "writes the current config to environment variables" do
-      expect(ENV["APPSIGNAL_ACTIVE"]).to                       eq "true"
-      expect(ENV["APPSIGNAL_APP_PATH"]).to                     end_with("spec/support/project_fixture")
-      expect(ENV["APPSIGNAL_AGENT_PATH"]).to                   end_with("/ext")
-      expect(ENV["APPSIGNAL_DEBUG_LOGGING"]).to                eq "false"
-      expect(ENV["APPSIGNAL_LOG_FILE_PATH"]).to                end_with("/tmp/appsignal.log")
-      expect(ENV["APPSIGNAL_PUSH_API_ENDPOINT"]).to            eq "https://push.appsignal.com"
-      expect(ENV["APPSIGNAL_PUSH_API_KEY"]).to                 eq "abc"
-      expect(ENV["APPSIGNAL_APP_NAME"]).to                     eq "TestApp"
-      expect(ENV["APPSIGNAL_ENVIRONMENT"]).to                  eq "production"
-      expect(ENV["APPSIGNAL_AGENT_VERSION"]).to                eq Appsignal::Extension.agent_version
-      expect(ENV["APPSIGNAL_LANGUAGE_INTEGRATION_VERSION"]).to eq "ruby-#{Appsignal::VERSION}"
-      expect(ENV["APPSIGNAL_HTTP_PROXY"]).to                   eq "http://localhost"
-      expect(ENV["APPSIGNAL_IGNORE_ACTIONS"]).to               eq "action1,action2"
-      expect(ENV["APPSIGNAL_IGNORE_ERRORS"]).to                eq "VerySpecificError,AnotherError"
-      expect(ENV["APPSIGNAL_FILTER_PARAMETERS"]).to            eq "password,confirm_password"
-      expect(ENV["APPSIGNAL_SEND_PARAMS"]).to                  eq "true"
-      expect(ENV["APPSIGNAL_RUNNING_IN_CONTAINER"]).to         eq "false"
-      expect(ENV["APPSIGNAL_ENABLE_HOST_METRICS"]).to          eq "true"
-      expect(ENV["APPSIGNAL_ENABLE_MINUTELY_PROBES"]).to       eq "false"
-      expect(ENV["APPSIGNAL_HOSTNAME"]).to                     eq "app1.local"
-      expect(ENV["APPSIGNAL_PROCESS_NAME"]).to                 include "rspec"
-      expect(ENV["APPSIGNAL_CA_FILE_PATH"]).to                 eq File.join(resources_dir, "cacert.pem")
-      expect(ENV).to_not                                       have_key("APPSIGNAL_WORKING_DIR_PATH")
+      expect(ENV["_APPSIGNAL_ACTIVE"]).to                       eq "true"
+      expect(ENV["_APPSIGNAL_APP_PATH"]).to                     end_with("spec/support/project_fixture")
+      expect(ENV["_APPSIGNAL_AGENT_PATH"]).to                   end_with("/ext")
+      expect(ENV["_APPSIGNAL_DEBUG_LOGGING"]).to                eq "false"
+      expect(ENV["_APPSIGNAL_LOG"]).to                          eq "stdout"
+      expect(ENV["_APPSIGNAL_LOG_FILE_PATH"]).to                end_with("/tmp/appsignal.log")
+      expect(ENV["_APPSIGNAL_PUSH_API_ENDPOINT"]).to            eq "https://push.appsignal.com"
+      expect(ENV["_APPSIGNAL_PUSH_API_KEY"]).to                 eq "abc"
+      expect(ENV["_APPSIGNAL_APP_NAME"]).to                     eq "TestApp"
+      expect(ENV["_APPSIGNAL_ENVIRONMENT"]).to                  eq "production"
+      expect(ENV["_APPSIGNAL_AGENT_VERSION"]).to                eq Appsignal::Extension.agent_version
+      expect(ENV["_APPSIGNAL_LANGUAGE_INTEGRATION_VERSION"]).to eq "ruby-#{Appsignal::VERSION}"
+      expect(ENV["_APPSIGNAL_HTTP_PROXY"]).to                   eq "http://localhost"
+      expect(ENV["_APPSIGNAL_IGNORE_ACTIONS"]).to               eq "action1,action2"
+      expect(ENV["_APPSIGNAL_IGNORE_ERRORS"]).to                eq "VerySpecificError,AnotherError"
+      expect(ENV["_APPSIGNAL_FILTER_PARAMETERS"]).to            eq "password,confirm_password"
+      expect(ENV["_APPSIGNAL_SEND_PARAMS"]).to                  eq "true"
+      expect(ENV["_APPSIGNAL_RUNNING_IN_CONTAINER"]).to         eq "false"
+      expect(ENV["_APPSIGNAL_ENABLE_HOST_METRICS"]).to          eq "true"
+      expect(ENV["_APPSIGNAL_ENABLE_MINUTELY_PROBES"]).to       eq "false"
+      expect(ENV["_APPSIGNAL_HOSTNAME"]).to                     eq "app1.local"
+      expect(ENV["_APPSIGNAL_PROCESS_NAME"]).to                 include "rspec"
+      expect(ENV["_APPSIGNAL_CA_FILE_PATH"]).to                 eq File.join(resources_dir, "cacert.pem")
+      expect(ENV["_APPSIGNAL_DNS_SERVERS"]).to                  eq "8.8.8.8,8.8.4.4"
+      expect(ENV).to_not                                        have_key("_APPSIGNAL_WORKING_DIR_PATH")
     end
 
     context "with :working_dir_path" do
@@ -439,7 +410,7 @@ describe Appsignal::Config do
       end
 
       it "sets the modified :working_dir_path" do
-        expect(ENV["APPSIGNAL_WORKING_DIR_PATH"]).to eq "/tmp/appsignal2"
+        expect(ENV["_APPSIGNAL_WORKING_DIR_PATH"]).to eq "/tmp/appsignal2"
       end
     end
   end
@@ -449,15 +420,10 @@ describe Appsignal::Config do
     let(:output) { out_stream.read }
     let(:config) { project_fixture_config("production", :log_path => log_path) }
     subject { capture_stdout(out_stream) { config.log_file_path } }
-    around do |example|
-      recognize_as_container(:none) do
-        example.run
-      end
-    end
 
     context "when path is writable" do
       let(:log_path) { File.join(tmp_dir, "writable-path") }
-      before { FileUtils.mkdir_p(log_path, :mode => 0755) }
+      before { FileUtils.mkdir_p(log_path, :mode => 0o755) }
       after { FileUtils.rm_rf(log_path) }
 
       it "returns log file path" do
@@ -476,7 +442,7 @@ describe Appsignal::Config do
       after { FileUtils.rm_rf(system_tmp_dir) }
 
       context "when the /tmp fallback path is writable" do
-        before { FileUtils.chmod(0777, system_tmp_dir) }
+        before { FileUtils.chmod(0o777, system_tmp_dir) }
 
         it "returns returns the tmp location" do
           expect(subject).to eq(File.join(system_tmp_dir, "appsignal.log"))
@@ -490,7 +456,7 @@ describe Appsignal::Config do
       end
 
       context "when the /tmp fallback path is not writable" do
-        before { FileUtils.chmod(0555, system_tmp_dir) }
+        before { FileUtils.chmod(0o555, system_tmp_dir) }
 
         it "returns nil" do
           expect(subject).to be_nil
@@ -533,7 +499,7 @@ describe Appsignal::Config do
 
     context "when path is not writable" do
       let(:log_path) { File.join(tmp_dir, "not-writable-path") }
-      before { FileUtils.mkdir_p(log_path, :mode => 0555) }
+      before { FileUtils.mkdir_p(log_path, :mode => 0o555) }
       after { FileUtils.rm_rf(log_path) }
 
       include_examples "#log_file_path: tmp path"
@@ -555,7 +521,7 @@ describe Appsignal::Config do
           let(:log_path) { File.join(tmp_dir, "symlink-path") }
           before do
             FileUtils.mkdir_p(real_path)
-            FileUtils.chmod(0444, real_path)
+            FileUtils.chmod(0o444, real_path)
             File.symlink(real_path, log_path)
           end
           after do

data/spec/lib/appsignal/demo_spec.rb

@@ -11,7 +11,7 @@ describe Appsignal::Demo do
 
     context "without config" do
       it "returns false" do
-        expect(silence { subject }).to be_falsy
+        expect(silence { subject }).to eq(false)
       end
     end
 
@@ -20,7 +20,7 @@ describe Appsignal::Demo do
       before { Appsignal.config = config }
 
       it "returns true" do
-        expect(subject).to be_truthy
+        expect(subject).to eq(true)
       end
 
       it "creates demonstration samples" do

data/spec/lib/appsignal/event_formatter_spec.rb

@@ -8,12 +8,12 @@ class MockFormatter < Appsignal::EventFormatter
   end
 
   def format(_payload)
-    ["title", @body]
+    ["title", body]
   end
 end
 
 class MissingFormatMockFormatter < Appsignal::EventFormatter
-  def transform(payload)
+  def transform(_payload)
   end
 end
 

data/spec/lib/appsignal/extension_spec.rb

@@ -63,6 +63,10 @@ describe "extension loading and operation" do
           subject.set_action("value")
         end
 
+        it "should have a set_namespace method" do
+          subject.set_namespace("value")
+        end
+
         it "should have a set_queue_start method" do
           subject.set_queue_start(10)
         end

data/spec/lib/appsignal/garbage_collection_profiler_spec.rb

@@ -1,44 +1,41 @@
 describe Appsignal::GarbageCollectionProfiler do
   let(:internal_profiler) { FakeGCProfiler.new }
+  let(:profiler) { described_class.new }
 
   before do
-    allow_any_instance_of(Appsignal::GarbageCollectionProfiler)
+    allow_any_instance_of(described_class)
       .to receive(:internal_profiler)
       .and_return(internal_profiler)
   end
 
-  it "should have a total time of 0" do
-    expect(Appsignal::GarbageCollectionProfiler.new.total_time).to eq(0)
+  context "on initialization" do
+    it "has a total time of 0" do
+      expect(profiler.total_time).to eq(0)
+    end
   end
 
-  describe "after a GC run" do
-    before do
-      internal_profiler.total_time = 0.12345
-      @profiler = Appsignal::GarbageCollectionProfiler.new
-    end
+  context "when the GC has run" do
+    before { internal_profiler.total_time = 0.12345 }
 
-    it "should take the total time from Ruby's GC::Profiler" do
-      expect(@profiler.total_time).to eq(123)
+    it "fetches the total time from Ruby's GC::Profiler" do
+      expect(profiler.total_time).to eq(123)
     end
 
-    it "should clear Ruby's GC::Profiler" do
+    it "clears Ruby's GC::Profiler afterward" do
       expect(internal_profiler).to receive(:clear)
-      @profiler.total_time
+      profiler.total_time
     end
   end
 
-  describe "when the total GC time becomes too high" do
-    it "should reset" do
-      profiler = Appsignal::GarbageCollectionProfiler.new
+  context "when the total GC time becomes too high" do
+    it "resets the total time" do
       internal_profiler.total_time = 2_147_483_647
       expect(profiler.total_time).to eq(0)
     end
   end
 
-  describe "after multiple GC runs" do
-    it "should add all times from Ruby's GC::Profiler together" do
-      profiler = Appsignal::GarbageCollectionProfiler.new
-
+  context "when the GC has run multiple times" do
+    it "adds all times from Ruby's GC::Profiler together" do
       2.times do
         internal_profiler.total_time = 0.12345
         profiler.total_time
@@ -48,8 +45,8 @@ describe Appsignal::GarbageCollectionProfiler do
     end
   end
 
-  describe "in multiple threads, with a slow GC::Profiler" do
-    it "should not count garbage collection times twice" do
+  context "when in multiple threads and with a slow GC::Profiler" do
+    it "does not count garbage collection times twice" do
       threads = []
       results = []
       internal_profiler.clear_delay = 0.001