appsignal 2.5.0.alpha.1-java

data/spec/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: ../.rubocop.yml
+
+Metrics/BlockLength:
+  Enabled: false
+
+# Metrics/LineLength:
+#   Max: 100

data/spec/lib/appsignal/auth_check_spec.rb

@@ -0,0 +1,80 @@
+describe Appsignal::AuthCheck do
+  let(:config) { project_fixture_config }
+  let(:auth_check) { Appsignal::AuthCheck.new(config) }
+  let(:auth_url) do
+    query = {
+      :api_key => config[:push_api_key],
+      :environment => config.env,
+      :gem_version => Appsignal::VERSION,
+      :hostname => config[:hostname],
+      :name => config[:name]
+    }.map { |k, v| "#{k}=#{v}" }.join("&")
+
+    URI(config[:endpoint]).tap do |uri|
+      uri.path = "/1/auth"
+      uri.query = query
+    end.to_s
+  end
+  let(:stubbed_request) do
+    WebMock.stub_request(:post, auth_url).with(:body => "{}")
+  end
+
+  describe "#perform" do
+    subject { auth_check.perform }
+
+    context "when performing a request against the push api" do
+      before { stubbed_request.to_return(:status => 200) }
+
+      it "returns status code" do
+        is_expected.to eq("200")
+      end
+    end
+
+    context "when encountering an exception" do
+      before { stubbed_request.to_timeout }
+
+      it "raises an error" do
+        expect { subject }.to raise_error(Net::OpenTimeout)
+      end
+    end
+  end
+
+  describe "#perform_with_result" do
+    subject { auth_check.perform_with_result }
+
+    context "when successful response" do
+      before { stubbed_request.to_return(:status => 200) }
+
+      it "returns success tuple" do
+        is_expected.to eq ["200", "AppSignal has confirmed authorization!"]
+      end
+    end
+
+    context "when unauthorized response" do
+      before { stubbed_request.to_return(:status => 401) }
+
+      it "returns unauthorirzed tuple" do
+        is_expected.to eq ["401", "API key not valid with AppSignal..."]
+      end
+    end
+
+    context "when unrecognized response" do
+      before { stubbed_request.to_return(:status => 500) }
+
+      it "returns an error tuple" do
+        is_expected.to eq ["500", "Could not confirm authorization: 500"]
+      end
+    end
+
+    context "when encountering an exception" do
+      before { stubbed_request.to_timeout }
+
+      it "returns an error tuple" do
+        is_expected.to eq [
+          nil,
+          "Something went wrong while trying to authenticate with AppSignal: execution expired"
+        ]
+      end
+    end
+  end
+end

data/spec/lib/appsignal/capistrano2_spec.rb

@@ -0,0 +1,224 @@
+if DependencyHelper.capistrano2_present?
+  require "capistrano"
+  require "capistrano/configuration"
+  require "appsignal/capistrano"
+
+  describe "Capistrano 2 integration" do
+    let(:out_stream) { std_stream }
+    let(:output) { out_stream.read }
+    let(:config) { project_fixture_config }
+    let(:capistrano_config) do
+      Capistrano::Configuration.new.tap do |c|
+        c.set(:rails_env, "production")
+        c.set(:repository, "master")
+        c.set(:deploy_to, "/home/username/app")
+        c.set(:current_release, "")
+        c.set(:current_revision, "503ce0923ed177a3ce000005")
+        c.dry_run = false
+      end
+    end
+    before { Appsignal::Capistrano.tasks(capistrano_config) }
+
+    def run
+      capture_stdout(out_stream) do
+        capistrano_config.find_and_execute_task("appsignal:deploy")
+      end
+    end
+
+    it "has a deploy task" do
+      expect(capistrano_config.find_task("appsignal:deploy")).to_not be_nil
+    end
+
+    describe "appsignal:deploy task" do
+      before do
+        ENV["USER"] = "batman"
+        ENV["PWD"] = project_fixture_path
+      end
+
+      context "config" do
+        before do
+          capistrano_config.dry_run = true
+        end
+
+        context "when appsignal_config is available" do
+          before do
+            capistrano_config.set(
+              :appsignal_config,
+              :name => "AppName",
+              :active => true,
+              :push_api_key => "abc"
+            )
+          end
+
+          it "overrides the default config with the custom appsignal_config" do
+            original_new = Appsignal::Marker.method(:new)
+
+            expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+              expect(given_config[:name]).to eq("AppName")
+              original_new.call(data, given_config)
+            end
+
+            run
+          end
+
+          context "when rack_env is used instead of rails_env" do
+            before do
+              capistrano_config.unset(:rails_env)
+              capistrano_config.set(:rack_env, "rack_production")
+            end
+
+            it "uses the rack_env as the env" do
+              original_new = Appsignal::Marker.method(:new)
+
+              expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+                expect(given_config.env).to eq("rack_production")
+                original_new.call(data, given_config)
+              end
+
+              run
+            end
+          end
+
+          context "when stage is used instead of rack_env / rails_env" do
+            before do
+              capistrano_config.unset(:rails_env)
+              capistrano_config.set(:stage, "stage_production")
+            end
+
+            it "uses the stage as the env" do
+              original_new = Appsignal::Marker.method(:new)
+
+              expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+                expect(given_config.env).to eq("stage_production")
+                original_new.call(data, given_config)
+              end
+
+              run
+            end
+          end
+
+          context "when appsignal_env is set" do
+            before do
+              capistrano_config.set(:rack_env, "rack_production")
+              capistrano_config.set(:stage, "stage_production")
+              capistrano_config.set(:appsignal_env, "appsignal_production")
+            end
+
+            it "uses the appsignal_env as the env" do
+              original_new = Appsignal::Marker.method(:new)
+
+              expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+                expect(given_config.env).to eq("appsignal_production")
+                original_new.call(data, given_config)
+              end
+
+              run
+            end
+          end
+
+          context "with invalid config" do
+            before do
+              capistrano_config.set(:appsignal_config, :push_api_key => nil)
+            end
+
+            it "does not continue with invalid config" do
+              run
+              expect(output).to include \
+                "Not notifying of deploy, config is not active for environment: production"
+            end
+          end
+        end
+      end
+
+      describe "markers" do
+        def stub_marker_request(data = {})
+          stub_api_request config, "markers", marker_data.merge(data)
+        end
+
+        let(:marker_data) do
+          {
+            :revision => "503ce0923ed177a3ce000005",
+            :user => "batman"
+          }
+        end
+
+        context "when active for this environment" do
+          it "transmits marker" do
+            stub_marker_request.to_return(:status => 200)
+            run
+
+            expect(output).to include \
+              "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+              "AppSignal has been notified of this deploy!"
+          end
+
+          context "with overridden revision" do
+            before do
+              capistrano_config.set(:appsignal_revision, "abc123")
+              stub_marker_request(:revision => "abc123").to_return(:status => 200)
+              run
+            end
+
+            it "transmits the overriden revision" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: abc123, user: batman",
+                "AppSignal has been notified of this deploy!"
+            end
+          end
+
+          context "with overridden deploy user" do
+            before do
+              capistrano_config.set(:appsignal_user, "robin")
+              stub_marker_request(:user => "robin").to_return(:status => 200)
+              run
+            end
+
+            it "transmits the overriden deploy user" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: robin",
+                "AppSignal has been notified of this deploy!"
+            end
+          end
+
+          context "with failed request" do
+            before do
+              stub_marker_request.to_return(:status => 500)
+              run
+            end
+
+            it "does not transmit marker" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+                "Something went wrong while trying to notify AppSignal:"
+              expect(output).to_not include "AppSignal has been notified of this deploy!"
+            end
+          end
+
+          context "when dry run" do
+            before do
+              capistrano_config.dry_run = true
+              run
+            end
+
+            it "does not transmit marker" do
+              expect(output).to include \
+                "Dry run: AppSignal deploy marker not actually sent."
+            end
+          end
+        end
+
+        context "when not active for this environment" do
+          before do
+            capistrano_config.set(:rails_env, "nonsense")
+            run
+          end
+
+          it "does not transmit marker" do
+            expect(output).to include \
+              "Not notifying of deploy, config is not active for environment: nonsense"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/appsignal/capistrano3_spec.rb

@@ -0,0 +1,237 @@
+if DependencyHelper.capistrano3_present?
+  require "capistrano/all"
+  require "capistrano/deploy"
+  require "appsignal/capistrano"
+
+  describe "Capistrano 3 integration" do
+    let(:capistrano) { Class.new.extend(Capistrano::DSL) }
+    let(:config) { project_fixture_config }
+    let(:out_stream) { std_stream }
+    let(:output) { out_stream.read }
+    let(:logger) { Logger.new(out_stream) }
+    let!(:capistrano_config) do
+      Capistrano::Configuration.reset!
+      Capistrano::Configuration.env.tap do |c|
+        c.set(:log_level, :error)
+        c.set(:logger, logger)
+        c.set(:rails_env, "production")
+        c.set(:repository, "master")
+        c.set(:deploy_to, "/home/username/app")
+        c.set(:current_release, "")
+        c.set(:current_revision, "503ce0923ed177a3ce000005")
+      end
+    end
+    let(:marker_data) do
+      {
+        :revision => "503ce0923ed177a3ce000005",
+        :user => "batman"
+      }
+    end
+    before { Rake::Task["appsignal:deploy"].reenable }
+
+    def run
+      capture_std_streams(out_stream, out_stream) do
+        capistrano.invoke("appsignal:deploy")
+      end
+    end
+
+    it "should have a deploy task" do
+      expect(Rake::Task.task_defined?("appsignal:deploy")).to be_truthy
+    end
+
+    describe "appsignal:deploy task" do
+      before do
+        ENV["USER"] = "batman"
+        ENV["PWD"] = project_fixture_path
+      end
+
+      context "config" do
+        let(:env) { "production" }
+        before do
+          capistrano_config.set(
+            :appsignal_config,
+            :name => "AppName",
+            :active => true,
+            :push_api_key => "abc"
+          )
+          config[:name] = "AppName"
+          config.instance_variable_set(:@env, env)
+          stub_marker_request.to_return(:status => 200)
+        end
+
+        context "when rack_env is the only env set" do
+          let(:env) { "rack_production" }
+          before do
+            capistrano_config.delete(:rails_env)
+            capistrano_config.set(:rack_env, env)
+          end
+
+          it "uses the rack_env as the env" do
+            original_new = Appsignal::Marker.method(:new)
+
+            expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+              expect(given_config.env).to eq("rack_production")
+              original_new.call(data, given_config)
+            end
+
+            run
+          end
+        end
+
+        context "when stage is set" do
+          let(:env) { "stage_production" }
+          before do
+            capistrano_config.set(:rack_env, "rack_production")
+            capistrano_config.set(:stage, env)
+          end
+
+          it "prefers the Capistrano stage rather than rails_env and rack_env" do
+            original_new = Appsignal::Marker.method(:new)
+
+            expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+              expect(given_config.env).to eq("stage_production")
+              original_new.call(data, given_config)
+            end
+
+            run
+          end
+        end
+
+        context "when `appsignal_config` is set" do
+          before do
+            ENV["APPSIGNAL_APP_NAME"] = "EnvName"
+            capistrano_config.set(:appsignal_config, :name => "AppName")
+            config[:name] = "AppName"
+          end
+
+          it "overrides the default config with the custom appsignal_config" do
+            original_new = Appsignal::Marker.method(:new)
+
+            expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+              expect(given_config[:name]).to eq("AppName")
+              original_new.call(data, given_config)
+            end
+
+            run
+          end
+
+          context "with invalid config" do
+            before do
+              capistrano_config.set(:appsignal_config, :push_api_key => nil)
+            end
+
+            it "does not continue with invalid config" do
+              run
+              expect(output).to include \
+                "Not notifying of deploy, config is not active for environment: production"
+            end
+          end
+        end
+
+        context "when `appsignal_env` is set" do
+          let(:env) { "appsignal_production" }
+          before do
+            capistrano_config.set(:rack_env, "rack_production")
+            capistrano_config.set(:stage, "stage_production")
+            capistrano_config.set(:appsignal_env, env)
+          end
+
+          it "prefers the appsignal_env rather than stage, rails_env and rack_env" do
+            original_new = Appsignal::Marker.method(:new)
+
+            expect(Appsignal::Marker).to receive(:new) do |data, given_config|
+              expect(given_config.env).to eq("appsignal_production")
+              original_new.call(data, given_config)
+            end
+
+            run
+          end
+        end
+      end
+
+      describe "markers" do
+        context "when active for this environment" do
+          it "transmits marker" do
+            stub_marker_request.to_return(:status => 200)
+            run
+
+            expect(output).to include \
+              "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+              "AppSignal has been notified of this deploy!"
+          end
+
+          context "with overridden revision" do
+            before do
+              capistrano_config.set(:appsignal_revision, "abc123")
+              stub_marker_request(:revision => "abc123").to_return(:status => 200)
+              run
+            end
+
+            it "transmits the overriden revision" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: abc123, user: batman",
+                "AppSignal has been notified of this deploy!"
+            end
+          end
+
+          context "with overridden deploy user" do
+            before do
+              capistrano_config.set(:appsignal_user, "robin")
+              stub_marker_request(:user => "robin").to_return(:status => 200)
+              run
+            end
+
+            it "transmits the overriden deploy user" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: robin",
+                "AppSignal has been notified of this deploy!"
+            end
+          end
+
+          if Gem::Version.new(Capistrano::VERSION) >= Gem::Version.new("3.5.0")
+            context "when dry run" do
+              before do
+                expect(capistrano_config).to receive(:dry_run?).and_return(true)
+                run
+              end
+
+              it "does not transmit the marker" do
+                expect(output).to include "Dry run: AppSignal deploy marker not actually sent."
+              end
+            end
+          end
+
+          context "with failed request" do
+            before do
+              stub_marker_request.to_return(:status => 500)
+              run
+            end
+
+            it "does not transmit marker" do
+              expect(output).to include \
+                "Notifying AppSignal of deploy with: revision: 503ce0923ed177a3ce000005, user: batman",
+                "Something went wrong while trying to notify AppSignal:"
+              expect(output).to_not include "AppSignal has been notified of this deploy!"
+            end
+          end
+        end
+
+        context "when not active for this environment" do
+          before do
+            capistrano_config.set(:rails_env, "nonsense")
+            run
+          end
+
+          it "should not send deploy marker" do
+            expect(output).to include \
+              "Not notifying of deploy, config is not active for environment: nonsense"
+          end
+        end
+      end
+    end
+  end
+
+  def stub_marker_request(data = {})
+    stub_api_request config, "markers", marker_data.merge(data)
+  end
+end