appsignal 1.1.0.beta.12 → 1.1.0.beta.13

data/lib/appsignal/cli/notify_of_deploy.rb

@@ -0,0 +1,41 @@
+module Appsignal
+  class CLI
+    class NotifyOfDeploy
+      class << self
+        def run(options, config)
+          validate_active_config(config)
+          validate_required_options(options, [:revision, :user, :environment])
+
+          Appsignal::Marker.new(
+            {
+              :revision => options[:revision],
+              :user => options[:user]
+            },
+            config,
+            nil
+          ).transmit
+        end
+
+        protected
+
+        def validate_required_options(options, required_options)
+          missing = required_options.select do |required_option|
+            val = options[required_option]
+            val.nil? || (val.respond_to?(:empty?) && val.empty?)
+          end
+          if missing.any?
+            puts "Missing options: #{missing.join(', ')}"
+            exit(1)
+          end
+        end
+
+        def validate_active_config(config)
+          unless config.active?
+            puts 'Exiting: No config file or push api key env var found'
+            exit(1)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/config.rb

@@ -20,7 +20,7 @@ module Appsignal
       :enable_frontend_error_catching => false,
       :frontend_error_catching_path   => '/appsignal_error_catcher',
       :enable_allocation_tracking     => true,
-      :enable_gc_instrumentation      => true,
+      :enable_gc_instrumentation      => false,
       :running_in_container           => false
     }.freeze
 
@@ -47,6 +47,7 @@ module Appsignal
     }.freeze
 
     attr_reader :root_path, :env, :initial_config, :config_hash
+    attr_accessor :logger
 
     def initialize(root_path, env, initial_config={}, logger=Appsignal.logger)
       @root_path      = root_path
@@ -74,6 +75,10 @@ module Appsignal
       config_hash[key]
     end
 
+    def []=(key, value)
+      config_hash[key] = value
+    end
+
     def log_file_path
       path = config_hash[:log_path] || root_path
       File.join(File.realpath(path), 'appsignal.log')

data/lib/appsignal/event_formatter/active_record/sql_formatter.rb

@@ -5,11 +5,7 @@ module Appsignal
         register 'sql.active_record'
 
         def format(payload)
-          [
-            payload[:name],
-            Appsignal::Utils.encode_utf8(payload[:sql]),
-            SQL_BODY_FORMAT
-          ]
+          [payload[:name], payload[:sql], SQL_BODY_FORMAT]
         end
       end
     end

data/lib/appsignal/integrations/capistrano/careful_logger.rb

@@ -3,6 +3,7 @@ module Appsignal
     # Because Capistrano 2's logger uses the term important
     # instead of error.
     def carefully_log_error(message)
+      return unless @logger
       if @logger.respond_to?(:important)
         @logger.important(message)
       else

data/lib/appsignal/integrations/railtie.rb

@@ -36,10 +36,6 @@ module Appsignal
 
         Appsignal.start
       end
-
-      rake_tasks do
-        load 'tasks/diag.rake'
-      end
     end
   end
 end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 require 'yaml'
 
 module Appsignal
-  VERSION = '1.1.0.beta.12'
+  VERSION = '1.1.0.beta.13'
 end

data/{lib/generators/appsignal/templates/appsignal.yml → resources/appsignal.yml.erb}

@@ -4,15 +4,15 @@ default: &defaults
   push_api_key: "<%= push_api_key %>"
 
   # Your app's name
-  name: "<%= Rails.application.class.parent_name %>"
-
-  # The cuttoff point in ms above which a request is considered slow, default is 200
-  # slow_request_threshold: 200
+  name: "<%= app_name %>"
 
   # Actions that should not be monitored by AppSignal
   # ignore_actions:
   #   - ApplicationController#isup
 
+  # See http://docs.appsignal.com/gem-settings/configuration.html for
+  # all configuration options.
+
 # Configuration per environment, leave out an environment or set active
 # to false to not push metrics for that environment.
 <% environments.each do |environment| -%>

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

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'appsignal/cli'
+
+describe Appsignal::CLI::Diagnose do
+  let(:out_stream) { StringIO.new }
+  let(:cli) { Appsignal::CLI::Diagnose }
+  before do
+    @original_stdout = $stdout
+    $stdout = out_stream
+  end
+  after do
+    $stdout = @original_stdout
+  end
+
+  describe ".run" do
+    it "should output diagnostic information" do
+      cli.run
+
+      out_stream.string.should include('Gem version')
+      out_stream.string.should include('Agent version')
+      out_stream.string.should include('Config')
+      out_stream.string.should include('Checking API key')
+      out_stream.string.should include('Checking if required paths are writable')
+      out_stream.string.should include('Showing last lines of extension install log')
+    end
+  end
+end

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

@@ -0,0 +1,438 @@
+require 'spec_helper'
+require 'appsignal/cli'
+
+begin
+  require 'sinatra'
+rescue LoadError
+end
+
+describe Appsignal::CLI::Install do
+  let(:out_stream) { StringIO.new }
+  let(:cli) { Appsignal::CLI::Install }
+  let(:config) { Appsignal::Config.new(nil, {}) }
+  let(:auth_check) { double }
+
+  before do
+    ENV['PWD'] = project_fixture_path
+    @original_stdout = $stdout
+    $stdout = out_stream
+    Appsignal::AuthCheck.stub(:new => auth_check)
+    auth_check.stub(:perform => '200')
+    cli.stub(:sleep)
+    cli.stub(:press_any_key)
+  end
+  after do
+    $stdout = @original_stdout
+  end
+
+  describe ".run" do
+    it "should not continue if there is no key" do
+      cli.run(nil, config)
+
+      out_stream.string.should include('Problem encountered:')
+      out_stream.string.should include('No push api key entered')
+    end
+
+    context "auth check" do
+      it "should exit if the key is invalid" do
+        auth_check.stub(:perform => '402')
+
+        cli.run('key', config)
+
+        out_stream.string.should include("Api key 'key' is not valid")
+      end
+
+      it "should exit if there was an error" do
+        auth_check.stub(:perform).and_raise(StandardError.new)
+
+        cli.run('key', config)
+
+        out_stream.string.should include("There was an error validating your api key")
+      end
+    end
+  end
+
+  context "with rails" do
+    if rails_present?
+      describe ".run" do
+        it "should install with environment variables" do
+          cli.should_receive(:gets).once.and_return('n')
+          cli.should_receive(:gets).once.and_return('2')
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Ruby on Rails")
+          out_stream.string.should include("export APPSIGNAL_PUSH_API_KEY=key")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+
+        it "should install with config file" do
+          cli.should_receive(:gets).once.and_return('n')
+          cli.should_receive(:gets).once.and_return('1')
+          cli.should_receive(:write_config_file)
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Ruby on Rails")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+
+        it "should install with an overridden app name and environment variables" do
+          cli.should_receive(:gets).once.and_return('y')
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('2')
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Ruby on Rails")
+          out_stream.string.should include("export APPSIGNAL_PUSH_API_KEY=key")
+          out_stream.string.should include("export APPSIGNAL_APP_NAME=Appname")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+
+        it "should install with an overridden app name and a config file" do
+          cli.should_receive(:gets).once.and_return('y')
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('1')
+          cli.should_receive(:write_config_file)
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Ruby on Rails")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+      end
+
+      describe ".rails_environments" do
+        before do
+          ENV['PWD'] = project_fixture_path
+        end
+
+        subject { cli.rails_environments }
+
+        it { should == ['development', 'production'] }
+      end
+
+      describe ".installed_frameworks" do
+        subject { cli.installed_frameworks }
+
+        it { should include(:rails) }
+      end
+    end
+  end
+
+  context "with sinatra" do
+    if sinatra_present? && !padrino_present?
+      describe ".install" do
+        it "should install with environment variables" do
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('2')
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Sinatra")
+          out_stream.string.should include("export APPSIGNAL_PUSH_API_KEY=key")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+
+        it "should install with a config file" do
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('1')
+          cli.should_receive(:write_config_file)
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Sinatra")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+      end
+
+      describe ".installed_frameworks" do
+        subject { cli.installed_frameworks }
+
+        it { should include(:sinatra) }
+      end
+    end
+  end
+
+  context "with padrino" do
+    if padrino_present?
+      describe ".install" do
+        it "should install with environment variables" do
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('2')
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Padrino")
+          out_stream.string.should include("export APPSIGNAL_PUSH_API_KEY=key")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+
+        it "should install with a config file" do
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('1')
+          cli.should_receive(:write_config_file)
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Padrino")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+      end
+
+      describe ".installed_frameworks" do
+        subject { cli.installed_frameworks }
+
+        it { should include(:padrino) }
+      end
+    end
+  end
+
+  context "with grape" do
+    if grape_present?
+      describe ".install" do
+        it "should install with environment variables" do
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('2')
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Grape")
+          out_stream.string.should include("export APPSIGNAL_PUSH_API_KEY=key")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+
+        it "should install with a config file" do
+          cli.should_receive(:gets).once.and_return('Appname')
+          cli.should_receive(:gets).once.and_return('1')
+          cli.should_receive(:write_config_file)
+
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("Installing for Grape")
+          out_stream.string.should include("AppSignal installation complete")
+        end
+      end
+
+      describe ".installed_frameworks" do
+        subject { cli.installed_frameworks }
+
+        it { should include(:grape) }
+      end
+    end
+  end
+
+  context "with unknown framework" do
+    if !rails_present? && !sinatra_present? && !padrino_present? && !grape_present?
+      describe ".install" do
+        it "should give a message about unknown framework" do
+          cli.run('key', config)
+
+          out_stream.string.should include("Validating api key...")
+          out_stream.string.should include("Api key valid")
+          out_stream.string.should include("We could not detect which framework you are using.")
+        end
+      end
+
+      describe ".installed_frameworks" do
+        subject { cli.installed_frameworks }
+
+        it { should be_empty }
+      end
+    end
+  end
+
+  describe ".colorize" do
+    subject { cli.colorize('text', :green) }
+
+    context "on windows" do
+      before do
+        Gem.stub(:win_platform? => true)
+      end
+
+      it { should == 'text' }
+    end
+
+    context "not on windows" do
+      before do
+        Gem.stub(:win_platform? => false)
+      end
+
+      it { should == "\e[32mtext\e[0m" }
+    end
+  end
+
+  describe ".periods" do
+    it "should output three periods" do
+      cli.periods
+      out_stream.string.should include('...')
+    end
+  end
+
+  describe ".press_any_key" do
+    before do
+      cli.unstub(:press_any_key)
+      STDIN.stub(:getch)
+    end
+
+    it "should continue" do
+      cli.press_any_key
+      out_stream.string.should include('Press any key')
+    end
+  end
+
+  describe ".yes_or_no" do
+    it "should take yes for an answer" do
+      cli.should_receive(:gets).once.and_return('')
+      cli.should_receive(:gets).once.and_return('nonsense')
+      cli.should_receive(:gets).once.and_return('y')
+
+      cli.yes_or_no('yes or no?: ').should be_true
+    end
+
+    it "should take no for an answer" do
+      cli.should_receive(:gets).once.and_return('')
+      cli.should_receive(:gets).once.and_return('nonsense')
+      cli.should_receive(:gets).once.and_return('n')
+
+      cli.yes_or_no('yes or no?: ').should be_false
+    end
+  end
+
+  describe ".required_input" do
+    it "should collect required input" do
+      cli.should_receive(:gets).once.and_return('')
+      cli.should_receive(:gets).once.and_return('value')
+
+      cli.required_input('provide: ').should == 'value'
+    end
+  end
+
+  describe ".configure" do
+    before do
+      config[:push_api_key] = 'key'
+      config[:name] = 'Appname'
+    end
+
+    context "environment variables" do
+      it "should output the environment variables" do
+        cli.should_receive(:gets).once.and_return('2')
+
+        cli.configure(config, [], false)
+
+        out_stream.string.should include("Add the following environment variables to configure AppSignal")
+        out_stream.string.should include("export APPSIGNAL_ACTIVE=true")
+        out_stream.string.should include("export APPSIGNAL_PUSH_API_KEY=key")
+      end
+
+      it "should output the environment variables with name overwritten" do
+        cli.should_receive(:gets).once.and_return('2')
+
+        cli.configure(config, [], true)
+
+        out_stream.string.should include("Add the following environment variables to configure AppSignal")
+        out_stream.string.should include("export APPSIGNAL_ACTIVE=true")
+        out_stream.string.should include("export APPSIGNAL_PUSH_API_KEY=key")
+        out_stream.string.should include("export APPSIGNAL_APP_NAME=Appname")
+      end
+    end
+
+    context "config file" do
+      it "should write the config file" do
+        cli.should_receive(:gets).once.and_return('1')
+
+        cli.should_receive(:write_config_file).with(
+          :push_api_key => 'key',
+          :app_name => config[:name],
+          :environments => []
+        )
+
+        cli.configure(config, [], false)
+
+        out_stream.string.should include("Writing config file")
+        out_stream.string.should include("Config file written to config/appsignal.yml")
+      end
+    end
+  end
+
+  describe ".done_notice" do
+    subject { out_stream.string }
+
+    context "on windows" do
+      before do
+        Gem.stub(:win_platform? => true)
+        cli.done_notice
+      end
+
+      it { should include('The AppSignal agent currently does not work on Windows') }
+      it { should include('test/staging/production environment') }
+    end
+
+    context "not on windows" do
+      before do
+        Gem.stub(:win_platform? => false)
+        cli.done_notice
+      end
+
+      it { should include('You can do this on your dev environment') }
+      it { should include('Or deploy to staging or production') }
+    end
+  end
+
+  context ".write_config_file" do
+    before do
+      ENV['PWD'] = tmp_dir
+    end
+
+    it "should write a config file with environments" do
+      cli.write_config_file(
+        :push_api_key => 'key',
+        :app_name => 'App name',
+        :environments => [:staging, :production]
+      )
+
+      config = File.read(File.join(tmp_dir, 'config/appsignal.yml'))
+
+      config.should include('name: "App name"')
+      config.should include('push_api_key: "key"')
+      config.should include('staging:')
+      config.should include('production:')
+    end
+
+    it "should write a config file without environments" do
+      cli.write_config_file(
+        :push_api_key => 'key',
+        :app_name => 'App name',
+        :environments => []
+      )
+
+      config = File.read(File.join(tmp_dir, 'config/appsignal.yml'))
+
+      config.should include('name: "App name"')
+      config.should include('push_api_key: "key"')
+      config.should_not include('staging:')
+      config.should_not include('production:')
+    end
+  end
+end