runsible 0.1.2.1 → 0.1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eddd85cd8f461bb7429cc4ec8b791426abfa579
-  data.tar.gz: d0f88b818945461a24e13825fc1ca0494a294dd6
+  metadata.gz: f31a8f06a0427b8f580a9240bc5698bc87e1b439
+  data.tar.gz: bf3daedd7b2e648992ced1ea3ec8140f83e9f30c
 SHA512:
-  metadata.gz: fe055d42239b15ff92f99ecce93a17a3291a542c83e27d3c9b7eb1855fdc28fc0650c1e1f774c6fe51c88936516ccb4d2480098756978805b5752b88b576b880
-  data.tar.gz: 3f41d2e3a40e9ff47e054a8da23314f228453b1d5b9e9d17b868aa20ff06700f5d4fc9b0c74d764ac08aff555f00461665fbdda1442de7a1cc7e0bbb01e67810
+  metadata.gz: 3c43fd82babf3dd5630fa2d1e69b82ff141a33ac23781b670a51d50e893e5313f8ad45305de6f9cd779176e720cf047e9c25866b8b66e59a5eebd6e79665b230
+  data.tar.gz: 539a72b37cab94eba245b16fdd5d67bbd31ade5cecadd84cd10f34a5457a29b3a3eca3b4085c1ec5c8b3f865fef52cd515ace50f45e5ee92a27cd6e455617823

data/VERSION

@@ -1 +1 @@
-0.1.2.1
+0.1.3.1

data/bin/runsible

@@ -2,4 +2,4 @@
 
 require 'runsible'
 
-Runsible.run
+Runsible.spoon

data/lib/runsible.rb

@@ -18,8 +18,8 @@ end
 #   STDOUT and STDERR
 #
 module Runsible
-  SSH_CNX_TIMEOUT = 10
   class Error < RuntimeError; end
+  SSH_CNX_TIMEOUT = 10
 
   SETTINGS = {
     user: ENV['USER'],
@@ -29,6 +29,10 @@ module Runsible
     vars: [],
   }
 
+  #
+  # Utility stuff
+  #
+
   def self.default_settings
     hsh = {}
     SETTINGS.each { |sym, v|
@@ -48,32 +52,58 @@ module Runsible
     exit 1
   end
 
-  def self.run(ssh_options = Hash.new)
-    opts = Runsible.slop_parse
-    Runsible.spoon(opts, self.extract_yaml(opts), ssh_options)
+  def self.alert(topic, message, settings)
+    backend = settings['alerts'] && settings['alerts']['backend']
+    case backend
+    when 'disabled', nil, false
+      return
+    when 'email'
+      Pony.mail(to: settings.fetch(:address),
+                from: 'runsible@spoon',
+                subject: topic,
+                body: message)
+    when 'kafka', 'slack'
+      # TODO
+      raise Error, "unsupported backend: #{backend.inspect}"
+    else
+      raise Error, "unknown backend: #{backend.inspect}"
+    end
   end
 
-  def self.extract_yaml(opts)
-    yaml_filename = opts.arguments.shift
-    self.usage(opts, "yaml_file is required") if yaml_filename.nil?
+  def self.warn(msg)
+    $stdout.puts msg
+    $stderr.puts msg
+  end
 
-    begin
-      yaml = YAML.load_file(yaml_filename)
-    rescue RuntimeError => e
-      Runsible.usage(opts, "could not load yaml_file\n#{e}")
-    end
-    yaml
+  def self.die!(msg, settings)
+    self.warn(msg)
+    self.alert("runsible:fatal:#{Process.pid}", msg, settings)
+    exit 1
+  end
+
+
+  #
+  # CLI or bin/runsible stuff
+  #
+
+  # bin/runsible entry point
+  def self.spoon(ssh_options = Hash.new)
+    opts = Runsible.slop_parse
+    yaml = self.extract_yaml(opts)
+    settings = Runsible.default_settings.merge(yaml['settings'] || Hash.new)
+    settings = self.merge(opts, settings)
+    self.ssh_runlist(settings, yaml['runlist'] || Array.new, ssh_options, yaml)
   end
 
   def self.slop_parse
-    d = SETTINGS
+    d = SETTINGS # display defaults
     Slop.parse do |o|
       o.banner = "usage: runsible [options] yaml_file"
       o.on '-h', '--help' do
         puts o
         exit 0
       end
-      o.on     '-v', '--version', 'show Runsible version' do
+      o.on     '-v', '--version', 'show runsible version' do
         puts Runsible.version
         exit 0
       end
@@ -89,43 +119,30 @@ module Runsible
     end
   end
 
-  def self.merge(opts, settings)
-    Runsible::SETTINGS.keys.each { |sym|
-      settings[sym.to_s] = opts[sym] if opts[sym]
-    }
-    settings['alerts'] = {} if opts.silent?
-    settings
-  end
+  def self.extract_yaml(opts)
+    yaml_filename = opts.arguments.shift
+    self.usage(opts, "yaml_file is required") if yaml_filename.nil?
 
-  def self.alert(topic, message, settings)
-    backend = settings['alerts'] && settings['alerts']['backend']
-    case backend
-    when 'disabled', nil, false
-      return
-    when 'email'
-      Pony.mail(to: settings.fetch(:address),
-                from: 'runsible@spoon',
-                subject: topic,
-                body: message)
-    when 'kafka', 'slack'
-      # TODO
-      raise Error, "unsupported backend: #{backend.inspect}"
-    else
-      raise Error, "unknown backend: #{backend.inspect}"
+    begin
+      yaml = YAML.load_file(yaml_filename)
+    rescue RuntimeError => e
+      Runsible.usage(opts, "could not load yaml_file\n#{e}")
     end
+    yaml
   end
 
-  def self.warn(msg)
-    $stdout.puts msg
-    $stderr.puts msg
-  end
+  #
+  # Library stuff
+  #
 
-  def self.spoon(opts, yaml, ssh_options = Hash.new)
-    settings = Runsible.default_settings.merge(yaml['settings'] || Hash.new)
-    settings = self.merge(opts, settings)
-    self.ssh_runlist(settings, yaml['runlist'] || Array.new, ssh_options, yaml)
+  # run a YAML file without any consideration for command line options
+  def self.run_yaml(yaml_filename, ssh_options = Hash.new)
+    yaml = YAML.load_file(yaml_filename)
+    self.ssh_runlist(self.default_settings, yaml['runlist'] || Array.new,
+                     ssh_options, yaml)
   end
 
+  # initiate ssh connection, perform the runlist
   def self.ssh_runlist(settings, runlist, ssh_options, yaml)
     ssh_options[:forward_agent] ||= true
     ssh_options[:port] ||= settings.fetch('port')
@@ -137,12 +154,6 @@ module Runsible
     }
   end
 
-  def self.die!(msg, settings)
-    self.warn(msg)
-    self.alert("runsible:fatal:#{Process.pid}", msg, settings)
-    exit 1
-  end
-
   # execute runlist with failure handling, retries, alerting, etc.
   def self.exec_runlist(ssh, runlist, settings, yaml = Hash.new)
     runlist.each { |run|
@@ -177,6 +188,26 @@ module Runsible
     }
   end
 
+  # retry several times, rescuing CommandFailure
+  # raises on SSH channel exec failure and CommandFailure on final retry
+  def self.exec_retry(ssh, cmd, retries)
+    self.banner_wrap(cmd) {
+      success = false
+      retries.times { |i|
+        begin
+          success = self.exec(ssh, cmd)
+          break
+        rescue CommandFailure => e
+          $stdout.puts "#{e}; retrying shortly..."
+          $stderr.puts e
+          sleep 2
+        end
+      }
+      # the final retry, may blow up
+      success or self.exec(ssh, cmd)
+    }
+  end
+
   # prints remote STDOUT to local STDOUT, likewise for STDERR
   # raises on SSH channel exec failure or nonzero exit status
   def self.exec(ssh, cmd)
@@ -199,24 +230,17 @@ module Runsible
     exit_code == 0 or raise(CommandFailure, "[exit #{exit_code}] #{cmd}")
   end
 
-  # retry several times, rescuing CommandFailure
-  # raises on SSH channel exec failure and CommandFailure on final retry
-  def self.exec_retry(ssh, cmd, retries)
-    self.banner_wrap(cmd) {
-      success = false
-      retries.times { |i|
-        begin
-          success = self.exec(ssh, cmd)
-          break
-        rescue CommandFailure => e
-          $stdout.puts "#{e}; retrying shortly..."
-          $stderr.puts e
-          sleep 2
-        end
-      }
-      # the final retry, may blow up
-      success or self.exec(ssh, cmd)
+
+  #
+  # Necessities
+  #
+
+  def self.merge(opts, settings)
+    Runsible::SETTINGS.keys.each { |sym|
+      settings[sym.to_s] = opts[sym] if opts[sym]
     }
+    settings['alerts'] = {} if opts.silent?
+    settings
   end
 
   def self.begin_banner(msg)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runsible
 version: !ruby/object:Gem::Version
-  version: 0.1.2.1
+  version: 0.1.3.1
 platform: ruby
 authors:
 - Rick Hull