scout 5.6.8 → 5.6.9

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 5.6.9
+
+* Install command generates a script for cron to run when using RVM or Bundler
+
 # 5.6.8
 
 * Updated JSON to 1.8.0
@@ -336,4 +340,4 @@
 
 # 1.0.0
 
-* Initial release
+* Initial release

data/Gemfile

@@ -7,4 +7,5 @@ group :test do
   gem "newrelic_rpm"
   gem "activerecord", "2.2.2"
   gem "mysql"
-end
+  gem "mocha", :require => false
+end

data/lib/scout.rb

@@ -11,3 +11,4 @@ require "scout/streamer"
 require "scout/daemon_spawn"
 require "scout/streamer_daemon"
 require "scout/data_file"
+require "scout/environment"

data/lib/scout/command/install.rb

@@ -6,42 +6,30 @@ module Scout
       def run
         create_pid_file_or_exit
 
-        abort usage unless $stdin.tty?
+        abort usage unless $stdin.tty? || @args.first
         
         puts <<-END_INTRO.gsub(/^ {8}/, "")
         === Scout Installation Wizard ===
-
-        You need the 40-character alphanumeric key displayed on the account page.
-
-        Enter the Key:
         END_INTRO
-        key = gets.to_s.strip
+
+        key = @args.first || get_key_from_stdin
 
         puts "\nAttempting to contact the server..."
         begin
-          Scout::Server.new(server, key, history, log, server_name, @http_proxy, @https_proxy, @roles, @hostname) do |scout|
-            scout.fetch_plan
-            scout.run_plugins_by_plan
-          end
+          test_server_connection(key)
+
+          create_cron_script(key) if cron_script_required?
 
           puts <<-END_SUCCESS.gsub(/^ {10}/, "")
           Success!
 
           Now, you must setup Scout to run on a scheduled basis.
 
-          If you are using the system crontab
-          (usually located at /etc/crontab):
-
-          ****** START CRONTAB SAMPLE ******
-          * * * * *  #{user} #{program_path} #{key}
-          ******  END CRONTAB SAMPLE  ******
+          #{special_cron_information}
 
-          If you are using this current user's crontab
-          (using crontab -e to edit):
+          Run `crontab -e`, pasting the line below into your Crontab file:
 
-          ****** START CRONTAB SAMPLE ******
-          * * * * *  #{program_path} #{key}
-          ******  END CRONTAB SAMPLE  ******
+          * * * * * #{cron_command(key)}
 
           For help setting up Scout with crontab, please visit:
 
@@ -60,6 +48,67 @@ module Scout
           END_ERROR
         end
       end
+
+      private
+
+        def create_cron_script(key)
+          cron_script = File.join(config_dir, "scout_cron.sh")
+          File.open(cron_script, 'w') do |file|
+            file.puts '#! /usr/bin/env bash'
+            file.puts '# This shell script executes the scout command and was auto-generated by the "scout install" command.' 
+            file.puts '# It\'s needed for environments that use RVM and/or Bundler.'
+            file.puts
+
+            if Environment.rvm?
+              file.puts '# Loading the RVM Environment files.'
+              file.puts "source #{Environment.rvm_path}\n"
+            end
+
+            if Environment.bundler?
+              file.puts '# Changing directories to your rails project.'
+              file.puts "cd #{`pwd`}\n"
+
+              file.puts '# Call Scout and pass your unique key.'
+              file.puts "bundle exec scout #{key}"
+            else
+              file.puts '# Call Scout and pass your unique key.'
+              file.puts "scout #{key}"
+            end
+          end
+          File.chmod(0774, cron_script)
+        end
+
+        def special_cron_information
+          "It looks like you've installed Scout under RVM and/or Bundler. We've generated a shell script for you." if cron_script_required?
+        end
+
+        def cron_command(key)
+          if cron_script_required?
+            "#{config_dir}/scout_cron.sh"
+          else
+            "#{`which scout`.strip} #{key}"
+          end
+        end
+
+        def cron_script_required?
+          Environment.rvm? || Environment.bundler?
+        end
+
+        def get_key_from_stdin
+          puts <<-END_GET_KEY.gsub(/^ {10}/, "")
+          You need the 40-character alphanumeric key displayed on the account page.
+
+          Enter the Key:
+          END_GET_KEY
+          key = gets.to_s.strip
+        end
+
+        def test_server_connection(key)
+          Scout::Server.new(server, key, history, log, server_name, @http_proxy, @https_proxy, @roles, @hostname) do |scout|
+            scout.fetch_plan
+            scout.run_plugins_by_plan
+          end
+        end
     end
   end
 end

data/lib/scout/environment.rb

@@ -0,0 +1,15 @@
+module Scout
+  class Environment
+    def self.bundler?
+      ENV['BUNDLE_BIN_PATH'] && ENV['BUNDLE_GEMFILE']
+    end
+
+    def self.rvm?
+      ENV['MY_RUBY_HOME'] && ENV['MY_RUBY_HOME'].include?('rvm')
+    end
+
+    def self.rvm_path
+      `rvm env --path`
+    end
+  end
+end

data/lib/scout/version.rb

@@ -1,3 +1,3 @@
 module Scout
-  VERSION = "5.6.8"
-end
+  VERSION = "5.6.9"
+end

data/test/scout_test.rb

@@ -19,6 +19,7 @@ require 'test/unit'
 $LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
 $LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/..' )
 require 'lib/scout'
+require 'mocha'
 
 
 SCOUT_PATH = '../scout'
@@ -64,7 +65,13 @@ class ScoutTest < Test::Unit::TestCase
 
   def test_should_checkin_during_interactive_install
     Client.update_all "last_checkin=null"
-    res=""
+    Scout::Command::Install.new({:server => 'http://localhost:4567', :history => PATH_TO_DATA_FILE},[@client.key]).run
+
+    assert_in_delta Time.now.utc.to_i, @client.reload.last_ping.to_i, 100
+    assert_in_delta Time.now.utc.to_i, @client.reload.last_checkin.to_i, 100
+  end
+
+  def test_prompts_the_user_for_a_key_if_none_is_provided
     PTY.spawn("bin/scout -s http://localhost:4567 -d #{PATH_TO_DATA_FILE} install ") do | stdin, stdout, pid |
       begin
         stdin.expect("Enter the Key:", 3) do |response|
@@ -76,11 +83,6 @@ class ScoutTest < Test::Unit::TestCase
         # don't care
       end
     end
-
-    assert res.match(/Attempting to contact the server.+Success!/m), "Output from interactive install session isn't right"
-
-    assert_in_delta Time.now.utc.to_i, @client.reload.last_ping.to_i, 100
-    assert_in_delta Time.now.utc.to_i, @client.reload.last_checkin.to_i, 100  
   end
   
   def test_should_run_first_time
@@ -575,6 +577,33 @@ mybar=100
     assert_equal hostname_override, client.hostname
   end
 
+  def test_create_cron_script
+    Scout::Environment.stubs(:rvm?).returns(true)
+    Scout::Environment.stubs(:bundler?).returns(true)
+    install = Scout::Command::Install.new({:history => PATH_TO_DATA_FILE},{})
+    install.send(:create_cron_script, @client.key)
+    cron_script = File.join(AGENT_DIR, 'scout_cron.sh')
+    assert File.exist?(cron_script)
+    assert File.executable?(cron_script)
+    File.delete(cron_script)
+  end
+
+  def test_generate_rvm_bundler_cron_command
+    Scout::Environment.stubs(:rvm?).returns(true)
+    Scout::Environment.stubs(:bundler?).returns(true)
+    install = Scout::Command::Install.new({},{})
+    cron_command = install.send(:cron_command, @client.key)
+    assert cron_command.include?('scout_cron.sh')
+  end
+
+  def test_generate_non_rvm_bundler_cron_command
+    Scout::Environment.stubs(:rvm?).returns(false)
+    Scout::Environment.stubs(:bundler?).returns(false)
+    install = Scout::Command::Install.new({},{})
+    cron_command = install.send(:cron_command, @client.key)
+    assert_equal cron_command, "#{`which scout`.strip} #{@client.key}"
+  end
+
 
   ######################
   ### Helper Methods ###
@@ -600,9 +629,8 @@ mybar=100
   #   scout in the process, making debugging easier. 
   # * The option handling is different in this method vs. #exec_scout: it takes an Array of options as Scout::Command.dispatch
   #   uses ARGV.
-  def scout(key, *opts)
-    args = []
-    args << key
+  def scout(args, *opts)
+    args = Array(args)
     args += ['-s','http://localhost:4567']
     args += ['-d', PATH_TO_DATA_FILE]
     args += opts if opts.any?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout
 version: !ruby/object:Gem::Version
-  version: 5.6.8
+  version: 5.6.9
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elif
@@ -59,6 +59,7 @@ files:
 - lib/scout/command/troubleshoot.rb
 - lib/scout/daemon_spawn.rb
 - lib/scout/data_file.rb
+- lib/scout/environment.rb
 - lib/scout/plugin.rb
 - lib/scout/plugin_options.rb
 - lib/scout/scout_logger.rb