right_chimp 2.1.12 → 2.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc15b41e6fcc5ea1696d6255206015000f9a31ee
-  data.tar.gz: 462e82c8dc41dfb152fa2218be76f8dbe04b1c1c
+  metadata.gz: 1a1bf8d5dec859eb24d0fad4003af83381f78339
+  data.tar.gz: fdabc1c04d9aa7593bf6ca56966c31958e593361
 SHA512:
-  metadata.gz: f0a8baa2ba2a7b35585d4d6c73a339d03d59cd21b7d02cb576f2f25f0f1fd502ee9d059f619b19d88628611563566de1fad78eddcdf02d274c19aab14df76d82
-  data.tar.gz: 7cc171141adc3b7c1204489c234e22e3e13ad6461591a47f68910ff31c5e87cbaa32c7d12b28d5e7cc7fbd669ed953a7fde5aedfd5d892ff73154d6a7520b70c
+  metadata.gz: 30a3fab9da5cac9f3a8401719cc1d04a9a266c262d0f7fd16fec33ce69b789ac9c4812f73bca4002da74156d7f9d0670f231a06a1a9d163b4f94bba3b14b1f5d
+  data.tar.gz: cba737a819c688bf0a68f7c6c7ba1d9c0a7c6b62e6496ab4d46d6b3ba933770bd7454c85b7c4d8859e02faf7e84a1ed75ada587071b055b41d0ff6b07eaf5f2e

data/CHANGES

@@ -147,6 +147,12 @@ Version 2.1.3
 -------------
 * Feature: chimpd-wait-until now dsiplays the group name it is waiting on every 120secs
 
-Vearsion 2.1.4
+Version 2.1.4
 -------------
 * Bugfix: Fixed UI issues casued by long job names
+
+Version 2.1.13
+--------------
+* Feature: Changed error reporting format
+* Feature: Web UI now shows job_uuid
+* Feature: One can now associate a "note" to a job by using --job-notes="foo"

data/lib/right_chimp/Chimp.rb

@@ -2,11 +2,10 @@
 #
 module Chimp
   class Chimp
-
     attr_accessor :concurrency, :delay, :retry_count, :hold, :progress, :prompt,
                   :quiet, :use_chimpd, :chimpd_host, :chimpd_port, :tags, :array_names,
                   :deployment_names, :script, :all_scripts, :servers, :ssh, :report, :interactive, :action,
-                  :limit_start, :limit_end, :dry_run, :group, :job_id, :job_uuid, :verify, :cli_args
+                  :limit_start, :limit_end, :dry_run, :group, :job_id, :job_uuid, :job_note, :verify, :cli_args
     #
     # These class variables control verbosity
     #
@@ -259,7 +258,7 @@ module Chimp
           # If script is an uri/url no need to "detect it"
           # https://my.rightscale.com/acct/9202/right_scripts/205347
           if @script =~ /\A#{URI::regexp}\z/
-            if not @use_chimpd
+            if not @use_chimpd || !@prompt
               puts "=================================================="
               puts "WARNING! You will be running this script on all "
               puts "server matches! (Press enter to continue)"
@@ -333,7 +332,8 @@ module Chimp
           [ '--timing-log', '-4', GetoptLong::REQUIRED_ARGUMENT ],
           [ '--timeout', '-5',  GetoptLong::REQUIRED_ARGUMENT ],
           [ '--noverify', '-6', GetoptLong::NO_ARGUMENT ],
-          [ '--exact-matching', '-8', GetoptLong::NO_ARGUMENT ]
+          [ '--exact-matching', '-8', GetoptLong::NO_ARGUMENT ],
+          [ '--job-notes', '-k', GetoptLong::OPTIONAL_ARGUMENT ]
         )
 
         opts.each do |opt, arg|
@@ -428,6 +428,8 @@ module Chimp
               @group_type = arg.to_sym
             when '--group-concurrency'
               @group_concurrency = arg.to_i
+            when '--job-notes'
+              @job_notes = arg
             when '--timing-log'
               @timing_log = arg
             when '--timeout'
@@ -904,6 +906,7 @@ module Chimp
             :server => s,
             :exec => queue_executable,
             :job_uuid => @job_uuid,
+            :job_notes => @job_notes,
             :inputs => @inputs,
             :timeout => @timeout,
             :verbose => @@verbose,
@@ -1027,7 +1030,7 @@ module Chimp
           message = result[:error].to_s || "unknown"
           message.sub!("\n", "")
           failed_workers << result[:worker]
-          results_display << "#{name.ljust(40)} #{message}"
+          results_display << "#{name[0..40]}  >> #{message}"
         end
       end
 
@@ -1253,7 +1256,7 @@ module Chimp
       i = 0
       items.sort.each do |item|
         i += 1
-        puts "  %03d. #{item}" % i
+        puts "%03d.#{item}" % i
       end
 
       puts "=================================================="

data/lib/right_chimp/exec/Executor.rb

@@ -5,7 +5,7 @@
 module Chimp
   class Executor
     attr_accessor :server, :array, :exec, :inputs, :template, :owner, :group,
-                  :job_id, :job_uuid, :status, :dry_run, :verbose, :quiet, :timeout,
+                  :job_id, :job_uuid, :job_notes, :status, :dry_run, :verbose, :quiet, :timeout,
                   :retry_count, :retry_sleep, :time_start, :time_end, :error
 
     attr_reader   :results
@@ -24,6 +24,8 @@ module Chimp
 
       @job_id = h[:job_id]            || nil
       @job_uuid = h[:job_uuid]        || nil
+      @job_notes = h[:job_notes]      || nil
+
       @group = h[:group]              || nil
       @exec = h[:exec]                || nil
       @inputs = h[:inputs]            || nil
@@ -155,9 +157,18 @@ module Chimp
         end
 
       rescue RuntimeError => ex
-        Log.error "[#{@job_uuid}] Caught RuntimeError: #{ex}. Aborting job."
-        Log.error ex.inspect
-        Log.error ex.backtrace
+        if @server.params["ip_address"]
+          err = ex.message + "IP: #{@server.params["ip_address"]}\n"
+        end
+        if @group.group_id
+          err += " Group: #{@group.group_id}\n"
+        end
+        if @job_notes
+          err += " Notes: #{@job_notes}\n"
+        end
+        Log.error "[#{@job_uuid}] Caught RuntimeError: #{err} Aborting job.\n"
+        #Log.error ex.inspect
+        #Log.error ex.backtrace
         @status = STATUS_ERROR
         @error = ex
       end

data/lib/right_chimp/{objects/ChimpObjects.rb → resources/Connection.rb}

@@ -276,152 +276,4 @@ module Chimp
     end
 
   end
-
-  #
-  # This class allows to check on the status of any of the tasks created.
-  #
-  class Task
-
-    attr_writer :tasker
-    attr_reader :tasker
-
-    def wait_for_state(desired_state, timeout=900)
-      while(timeout > 0)
-        state=self.tasker.show.summary
-      return true if self.state.match(desired_state)
-        friendly_url = Connection.audit_url+"/audit_entries/"
-        friendly_url += self.href.split(/\//).last
-        friendly_url = friendly_url.gsub("ae-","")
-        raise "FATAL error, #{self.tasker.show.summary}\n See Audit: #{friendly_url}'\n " if self.state.match("failed")
-        sleep 30
-        timeout -= 30
-      end
-      raise "FATAL: Timeout waiting for Executable to complete.  State was #{self.state}" if timeout <= 0
-    end
-
-    def wait_for_completed(timeout=900)
-      wait_for_state("completed", timeout)
-    end
-
-    def state
-      self.tasker.show.summary
-    end
-
-    def href
-      self.tasker.href
-    end
-
-    def details
-      self.tasker.show(:view => "extended").detail
-    end
-  end
-
-  #
-  # This task contains parameters that describe a script/task to be executed
-  #
-  class Executable
-
-    attr_writer :params
-    attr_reader :params
-
-    def initialize
-      @params = {
-        "position"=>5,
-        "right_script"=>{
-          "created_at"=>"",
-          "href"=>"dummy_href",
-          "updated_at"=>"",
-          "version"=>4,
-          "is_head_version"=>false,
-          "script"=>"",
-          "name"=>"dummy_name",
-          "description"=>"dummy_description"
-          },
-          "recipe"=>nil,
-          "apply"=>"operational"
-        }
-    end
-
-    def href
-      @params['right_script']['href']
-    end
-    def name
-      @params['right_script']['name']
-    end
-  end
-
-  #
-  # This class holds all necessary information regarding an instance
-  # and provides a way of executing a script on  it via the run_executable method.
-  #
-  class Server
-
-    attr_writer :params, :object
-    attr_reader :params, :object
-
-    attr_accessor :run_executable
-
-    def initialize
-      @params = {
-        "href"                    => "dummy href",
-        "current_instance_href"   => nil,
-        "current-instance-href "  => nil,
-        "name"                    => "dummy name",
-        "nickname"                => "dummy nickname",
-        "ip_address"              => nil,
-        "ip-address"              => nil,
-        "private-ip-address"      => nil,
-        "aws-id"                  => "",
-        "ec2-instance-type"       => "",
-        "dns-name"                => "",
-        "locked"                  => "",
-        "state"                   => "",
-        "datacenter"              => nil
-      }
-      @object = nil
-    end
-
-    def href
-      @params['href']
-    end
-
-    def name
-      @params['name']
-    end
-
-    def nickname
-      @params['nickname']
-    end
-
-    def ip_address
-      @params['ip_address']
-    end
-
-    def encode_with(coder)
-      vars = instance_variables.map{|x| x.to_s}
-      vars = vars - ['@object']
-
-      vars.each do |var|
-        var_val = eval(var)
-        coder[var.gsub('@', '')] = var_val
-      end
-    end
-
-    #In order to run the task, we need to call run_executable on ourselves
-    def run_executable(exec, options)
-      script_href = "right_script_href="+exec.href
-      # Construct the parameters to pass for the inputs
-      params=options.collect { |k, v|
-        "&inputs[][name]=#{k}&inputs[][value]=#{v}" unless k == :ignore_lock
-        }.join('&')
-
-      if options[:ignore_lock]
-        params+="&ignore_lock=true"
-      end
-      # self is the actual Server object
-      Log.debug "[#{Chimp.get_job_uuid}] Running executable"
-      task = self.object.run_executable(script_href + params)
-      return task
-    end
-  end
 end

data/lib/right_chimp/resources/Executable.rb

@@ -0,0 +1,38 @@
+#
+# Extra classes needed to operate with Chimp
+#
+module Chimp
+  #
+  # This task contains parameters that describe a script/task to be executed
+  #
+  class Executable
+
+    attr_writer :params
+    attr_reader :params
+
+    def initialize
+      @params = {
+        "position"=>5,
+        "right_script"=>{
+          "created_at"=>"",
+          "href"=>"dummy_href",
+          "updated_at"=>"",
+          "version"=>4,
+          "is_head_version"=>false,
+          "script"=>"",
+          "name"=>"dummy_name",
+          "description"=>"dummy_description"
+          },
+          "recipe"=>nil,
+          "apply"=>"operational"
+        }
+    end
+
+    def href
+      @params['right_script']['href']
+    end
+    def name
+      @params['right_script']['name']
+    end
+  end
+end

data/lib/right_chimp/resources/Server.rb

@@ -0,0 +1,79 @@
+#
+# Extra classes needed to operate with Chimp
+#
+module Chimp
+  #
+  # This class holds all necessary information regarding an instance
+  # and provides a way of executing a script on  it via the run_executable method.
+  #
+  class Server
+
+    attr_writer :params, :object
+    attr_reader :params, :object
+
+    attr_accessor :run_executable
+
+    def initialize
+      @params = {
+        "href"                    => "dummy href",
+        "current_instance_href"   => nil,
+        "current-instance-href "  => nil,
+        "name"                    => "dummy name",
+        "nickname"                => "dummy nickname",
+        "ip_address"              => nil,
+        "ip-address"              => nil,
+        "private-ip-address"      => nil,
+        "aws-id"                  => "",
+        "ec2-instance-type"       => "",
+        "dns-name"                => "",
+        "locked"                  => "",
+        "state"                   => "",
+        "datacenter"              => nil
+      }
+      @object = nil
+    end
+
+    def href
+      @params['href']
+    end
+
+    def name
+      @params['name']
+    end
+
+    def nickname
+      @params['nickname']
+    end
+
+    def ip_address
+      @params['ip_address']
+    end
+
+    def encode_with(coder)
+      vars = instance_variables.map{|x| x.to_s}
+      vars = vars - ['@object']
+
+      vars.each do |var|
+        var_val = eval(var)
+        coder[var.gsub('@', '')] = var_val
+      end
+    end
+
+    #In order to run the task, we need to call run_executable on ourselves
+    def run_executable(exec, options)
+      script_href = "right_script_href="+exec.href
+      # Construct the parameters to pass for the inputs
+      params=options.collect { |k, v|
+        "&inputs[][name]=#{k}&inputs[][value]=#{v}" unless k == :ignore_lock
+        }.join('&')
+
+      if options[:ignore_lock]
+        params+="&ignore_lock=true"
+      end
+      # self is the actual Server object
+      Log.debug "[#{Chimp.get_job_uuid}] Running executable"
+      task = self.object.run_executable(script_href + params)
+      return task
+    end
+  end
+end

data/lib/right_chimp/resources/Task.rb

@@ -0,0 +1,43 @@
+#
+# Extra classes needed to operate with Chimp
+#
+module Chimp
+  #
+  # This class allows to check on the status of any of the tasks created.
+  #
+  class Task
+
+    attr_writer :tasker
+    attr_reader :tasker
+
+    def wait_for_state(desired_state, timeout=900)
+      while(timeout > 0)
+        state=self.tasker.show.summary
+      return true if self.state.match(desired_state)
+        friendly_url = Connection.audit_url+"/audit_entries/"
+        friendly_url += self.href.split(/\//).last
+        friendly_url = friendly_url.gsub("ae-","")
+        raise "FATAL error, #{self.tasker.show.summary}\n\n Audit: #{friendly_url}'\n " if self.state.match("failed")
+        sleep 30
+        timeout -= 30
+      end
+      raise "FATAL: Timeout waiting for Executable to complete.  State was #{self.state}" if timeout <= 0
+    end
+
+    def wait_for_completed(timeout=900)
+      wait_for_state("completed", timeout)
+    end
+
+    def state
+      self.tasker.show.summary
+    end
+
+    def href
+      self.tasker.href
+    end
+
+    def details
+      self.tasker.show(:view => "extended").detail
+    end
+  end
+end

data/lib/right_chimp/templates/all_jobs.erb

@@ -167,18 +167,27 @@ jobs.each do |j|
   color = "red"         if status == Executor::STATUS_ERROR
 %>
   <ul style="color: <%= color %>">
+    Uuid: [<%= j.job_uuid %>]
+
     <li>Server: <b><%= server_name %></b></li>
     <li>Group: <b><%= j.group.group_id %></b></li>
+    <% if j.job_notes %>
+      <li>Notes: <b><%= j.job_notes %></b></li>
+    <% end %>
     <li>Action: <%= action %></li>
     <li>Status: <%= status %></li>
     <li>Time: <%= time %></li>
     <% if status != Executor::STATUS_RUNNING %>
       <li>Results: <span style="color:#777"><%= j.results %></span></li>
+    <% end %>
+
+    <% if status == Executor::STATUS_DONE %>
       <!-- HACK HERE THE LOOP CODE TO INJECT CSS TO HIDE/EXPAND-->
       <li><label for="<%= id%>">Details (click to expand):</label> <input type="checkbox" id="<%= id%>"><span style="color:#777"><div id="d<%= id%>" class="job_details"><%= j.audit_entry_data %></div></span></li>
       <!-- HACK HERE THE LOOP CODE TO INJECT CSS TO HIDE/EXPAND-->
     <% end %>
 
+
     <li> <span class="action">
     <% case status
         when Executor::STATUS_ERROR %>

data/lib/right_chimp/version.rb

@@ -1,3 +1,3 @@
 module Chimp
-  VERSION = "2.1.12"
+  VERSION = "2.1.13"
 end

data/lib/right_chimp.rb

@@ -23,16 +23,23 @@ module Chimp
   require 'right_chimp/Chimp'
   require 'right_chimp/Log'
   require 'right_chimp/IDManager'
+
   require 'right_chimp/daemon/ChimpDaemon'
   require 'right_chimp/daemon/ChimpDaemonClient'
+
   require 'right_chimp/queue/ChimpQueue'
   require 'right_chimp/queue/QueueWorker'
   require 'right_chimp/queue/ExecutionGroup'
+
   require 'right_chimp/exec/Executor'
   require 'right_chimp/exec/ExecArray'
   require 'right_chimp/exec/ExecRightScript'
   require 'right_chimp/exec/ExecSSH'
   require 'right_chimp/exec/ExecReport'
   require 'right_chimp/exec/ExecNoop'
-  require 'right_chimp/objects/ChimpObjects'
+
+  require 'right_chimp/resources/Connection'
+  require 'right_chimp/resources/Executable'
+  require 'right_chimp/resources/Server'
+  require 'right_chimp/resources/Task'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: right_chimp
 version: !ruby/object:Gem::Version
-  version: 2.1.12
+  version: 2.1.13
 platform: ruby
 authors:
 - RightScale Operations
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -155,10 +155,13 @@ files:
 - lib/right_chimp/exec/ExecRightScript.rb
 - lib/right_chimp/exec/ExecSSH.rb
 - lib/right_chimp/exec/Executor.rb
-- lib/right_chimp/objects/ChimpObjects.rb
 - lib/right_chimp/queue/ChimpQueue.rb
 - lib/right_chimp/queue/ExecutionGroup.rb
 - lib/right_chimp/queue/QueueWorker.rb
+- lib/right_chimp/resources/Connection.rb
+- lib/right_chimp/resources/Executable.rb
+- lib/right_chimp/resources/Server.rb
+- lib/right_chimp/resources/Task.rb
 - lib/right_chimp/templates/all_jobs.erb
 - lib/right_chimp/templates/default.css
 - lib/right_chimp/templates/greenscreen.css