consolr 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c01188d47bf7c259961f8f684016128fe3475d3b
-  data.tar.gz: d632fe8cb4bc31f429939bd32952ed2c7b4bdd6b
+  metadata.gz: ec522cd9e46a3d7f619654ed781bd56c78f01186
+  data.tar.gz: 966abf1ef88812ddb044664fdf17b561a0b33b1d
 SHA512:
-  metadata.gz: 955dac9d7942799846908523f60d2a30db3e481a819c6b244178b2dd9775f1688adb183657ebda15a48300191ee07bb7d8122c529e51341f228d69008fc2622b
-  data.tar.gz: d734a3cad1e28620af367df53f93b5358812cb2e58ec6e708594d0d3114080f93a55634c1bdcdca8b9005d8636f8256a0c5c6935be00f223d79fa91ac6870836
+  metadata.gz: 4805b73bd42dbbf2ebfd574267fb7e5daf0878b91b6ac9bd06527fa8b2ee2659fcd8b05976622309a60a36e1dce384d3d4379489aff513a72af8797f0e493133
+  data.tar.gz: 2ff30dcf1993cfdfbe0ebdfed430be23fe279a00eb1e0eb06b570946ba94ba271c50f21da936185071987d4e48ceab7fcb97bf6e08e7df627d91aa266615b08e

data/README.md

@@ -62,13 +62,17 @@ Configuration params are searched in these locations --
 An example consolr.yml file
 
 ```    
-ipmitool:  /usr/bin/ipmitool
+runners:
+  ipmitool:  /usr/bin/ipmitool
 dangerous_assets:
   - "007117"
 dangerous_status:
   - "Allocated"
 ```
 
+Consolr will load the runners listed and pick the first runner that says it can
+manage the node in question by running the `can_run?` method of the runner.
+
 ## Running the tool
 
 ```
@@ -81,6 +85,54 @@ For a full list of actions, look up the help page
 $ consolr --help
 ```
 
+## Runners
+Consolr ships with a runner that uses ipmitool to manage servers but there are
+cases where you might want to extend it. For instance to support your favorite
+IaaS provider or a private cloud. In this case, you need to write a custom
+runner and deploy it. The way we do it at Tumblr is to gather our custom runner
+into a gem and install that gem along with consolr. 
+
+A runner is simply a class that extends the `Consolr::Runners::Runner` base
+class and is located in the correct module. A very simple example could look
+like:
+```
+module Consolr
+  module Runners
+    class MyRunner < Runner
+    def initialize
+      // Set up the runner
+    end
+
+    def can_run? node
+      // Should return true if this runner can manage `node`
+    end
+
+    def verify node
+      // Verify that the runner can talk to the node. For instance by pinging
+      // the ipmi interface. 
+    end
+
+    def on node
+      // issue command to power node on
+    end
+
+  end
+end
+```
+All the methods (`on`, `off`) etc. that can be implemented can be seen in the
+`Consolr::Runners::Runner` base class.
+
+In order to package it up as a gem the directory structure should look like
+
+```
+.
+└── lib
+└── consolr
+    └── runners
+        └── myrunner.rb
+```
+You'll also need a gemspec file at the root.
+
 ## Mailing list
 http://groups.google.com/group/collins-sm
 

data/bin/consolr

@@ -18,9 +18,13 @@ opt_parser = OptionParser.new do |opt|
   opt.on('-l', '--log LOG',         'System Event Log (SEL) [list|clear]')     { |log| options[:log] = log }
   opt.on('-o', '--on',              'turn on node')                            { options[:on] = true }
   opt.on('-r', '--reboot',          'restart node')                            { options[:reboot] = true }
+  opt.on('-R', '--soft-reboot',     'restart node gracefully')                 { options[:soft_reboot] = true }
   opt.on('-s', '--sdr',             'Sensor Data Repository (SDR)')            { options[:sdr] = true }
   opt.on('-t', '--tag ASSET',       'asset tag')                               { |tag| options[:tag] = tag }
   opt.on('-x', '--off',             'turn off node')                           { options[:off] = true }
+  opt.on('-X', '--soft-off',        'turn off gracefully (via ACPI)')          { options[:soft_off] = true }
+  opt.on('-S', '--status',          'print asset power status')                { options[:status] = true }
+  opt.on('--runner RUNNER',         'specify the runner to use')               { |runner| options[:runner] = runner }
 
   opt.on_tail('-h', '--help', 'help') { puts opt; exit 0 }
   opt.on_tail('-v', '--version', 'version') { puts Consolr::VERSION; exit 0 }

data/lib/consolr/runners/ipmitool.rb

@@ -0,0 +1,82 @@
+require 'consolr/runners/runner'
+
+module Consolr
+  module Runners
+    class Ipmitool < Runner
+      def initialize config
+        @ipmitool = if config.empty?
+                      '/usr/bin/ipmitool'
+                    else
+                      config
+                    end
+      end
+
+      def can_run? node
+        begin
+          not (node.ipmi.address.empty? or node.ipmi.username.empty? or node.ipmi.password.empty?)
+        rescue
+          false
+        end
+      end
+
+      def verify node
+        Net::Ping::External.new(node.ipmi.address).ping?
+      end
+
+      def console node
+        cmd 'sol activate', node
+      end
+
+      def kick node
+        cmd 'sol deactivate', node
+      end
+
+      def identify node
+        cmd 'chassis identify', node
+      end
+
+      def sdr node
+        cmd 'sdr elist all', node
+      end
+
+      def log_list node
+        cmd 'sel list', node
+      end
+
+      def log_clear node
+        cmd 'sel clear', node
+      end
+
+      def on node
+        cmd 'power on', node
+      end
+
+      def off node
+        cmd 'power off', node
+      end
+
+      def soft_off node
+        cmd 'power soft', node
+      end
+
+      def reboot node
+        cmd 'power cycle', node
+      end
+
+      def soft_reboot node
+        cmd 'power reset', node
+      end
+
+      def status node
+        cmd 'power status', node
+      end
+
+      private
+      def cmd action, node
+        system("#{@ipmitool} -I lanplus -H #{node.ipmi.address} -U #{node.ipmi.username} -P #{node.ipmi.password} #{action}")
+        return $?.exitstatus == 0 ? "SUCCESS" : "FAILED"
+      end
+    end
+  end
+end
+

data/lib/consolr/runners/runner.rb

@@ -0,0 +1,64 @@
+require 'net/ping'
+
+module Consolr
+  module Runners
+    class Runner
+      def can_run? node
+        raise 'can_run? is not implemented for this runner'
+      end
+
+      def verify node
+        raise 'verify is not implemented for this runner'
+      end
+
+      def console node
+        raise 'console is not implemented for this runner'
+      end
+
+      def kick node
+        raise 'kick is not implemented for this runner'
+      end
+
+      def identify node
+        raise 'identify is not implemented for this runner'
+      end
+
+      def sdr node
+        raise 'sdr is not implemented for this runner'
+      end
+
+      def log_list node
+        raise 'log list is not implemented for this runner'
+      end
+
+      def log_clear node
+        raise 'log clear is not implemented for this runner'
+      end
+
+      def on node
+        raise 'power on is not implemented for this runner'
+      end
+
+      def off node
+        raise 'power off is not implemented for this runner'
+      end
+
+      def soft_off node
+        raise 'soft_off is not implemented for this runner'
+      end
+
+      def reboot node
+        raise 'reboot is not implemented for this runner'
+      end
+
+      def soft_reboot node
+        raise 'reboot_soft is not implemented for this runner'
+      end
+
+      def status node
+        raise 'status is not implemented for this runner'
+      end
+    end
+  end
+end
+              

data/lib/consolr/version.rb

@@ -1,3 +1,3 @@
 module Consolr
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/consolr.rb

@@ -2,10 +2,10 @@ $LOAD_PATH.unshift('./lib/')
 
 require 'consolr/version'
 require 'collins_auth'
-require 'net/ping'
 require 'optparse'
 require 'yaml'
 
+
 module Consolr
   class Console
 
@@ -19,7 +19,7 @@ module Consolr
         File.readable?(File.expand_path(conf, __FILE__)) and File.size(File.expand_path(conf, __FILE__)) > 0
       end
 
-      config_params = begin
+      @config_params = begin
         YAML.load(File.open(File.expand_path(config_file, __FILE__)))
       rescue TypeError => e
         puts "-------"
@@ -36,33 +36,21 @@ module Consolr
         puts "------"
         exit 1
       end
-
-      begin
-        @ipmitool_exec = config_params['ipmitool'] # ipmitool absolute path
-      rescue Exception => e
-        puts e
-        puts "-------"
-        puts "Ensure that the ipmitool's path (#{@ipmitool_exec}) is given in the consolr.yml file and is correct"
-        puts "-------"
-        exit 1
-      end
-
+      #
       # Will be ignored for dangerous actions, no matter what, even with --force
       begin
-        @dangerous_assets = config_params['dangerous_assets']
+        @dangerous_assets = @config_params['dangerous_assets']
       rescue Exception => e
         puts e
         puts "-------"
         puts "Dangerous Assets -- #{dangrous}"
         puts "Please make sure dangerous_assets exists and is valid."
         puts "Supply them in a comma separated list."
-        puts "-------"
-        exit 1
       end
 
       # Dangerous actions wont be run in these status, override with --force
       begin
-        @dangerous_status = config_params['dangerous_status']
+        @dangerous_status = @config_params['dangerous_status']
       rescue Exception => e
         puts e
         puts "-------"
@@ -78,8 +66,6 @@ module Consolr
     def start options
       abort("Please pass either the asset tag or hostname") if options[:tag].nil? and options[:hostname].nil?
 
-      abort("Cannot find #{@ipmitool_exec}") unless File.exist?(@ipmitool_exec)
-
       dangerous_body = "Dangerous actions: #{dangerous_actions.join(', ')}\n"\
         "Dangerous status: #{dangerous_status.join(', ')} (override with --force)\n"\
         "Dangerous assets: #{dangerous_assets.join(', ')} (ignored no matter what, even with --force)"
@@ -103,11 +89,36 @@ module Consolr
         abort("Please pass either the hostname OR the tag but not both.")
       end
 
+      if options[:runner].nil?
+        runners = load_runners(@config_params.fetch('runners', []))
+        # Default to the ipmitool runner for backwards compatibility
+        if runners.empty?
+          require 'consolr/runners/ipmitool'
+          runners = [Consolr::Runners::Ipmitool.new(@config_params.fetch('ipmitool', {}))]
+        end
+      else
+        runners = load_runners([options[:runner]])
+        if runners.empty?
+          abort('Specified runner could not be loaded. Aborting.')
+        end
+      end
+
       # match assets like vm-67f5eh, zt-*, etc.
       nodes = options[:tag] ? (collins.find :tag => options[:tag]) : (collins.find :hostname => options[:hostname])
       @node = nodes.length == 1 ? nodes.first : abort("Found #{nodes.length} assets, aborting.")
 
-      abort("Cannot ping IP #{@node.ipmi.address} (#{@node.tag})") unless Net::Ping::External.new(@node.ipmi.address).ping?
+      # select the first runner that support the node
+      runner = runners.select {|runner|
+        runner.can_run? @node
+      }.first
+
+      if runner.nil?
+        abort("No runners available for node #{@node.hostname} (#{@node.tag})")
+      end
+
+      if not runner.verify @node
+        abort("Cannot verify asset #{@node.hostname} (#{@node.tag})")
+      end
 
       selected_dangerous_actions = dangerous_actions.select { |o| options[o] }
       if dangerous_assets.include?(@node.tag) and selected_dangerous_actions.any?
@@ -121,40 +132,47 @@ module Consolr
       case
       when options[:console]
         puts '--> Opening SOL session (type ~~. to quit)'
-        puts ipmitool_cmd('sol activate')
+        puts runner.console @node
       when options[:kick]
-        puts ipmitool_cmd('sol deactivate')
+        puts runner.kick @node
       when options[:identify]
-        puts ipmitool_cmd('chassis identify')
+        puts runner.identify @node
       when options[:sdr]
-        puts ipmitool_cmd('sdr elist all')
+        puts runner.sdr @node
       when options[:log] == 'list'
-        puts ipmitool_cmd('sel list')
+        puts runner.log_list @node
       when options[:log] == 'clear'
-        puts ipmitool_cmd('sel clear')
+        puts runner.log_clear @node
       when options[:on]
-        puts ipmitool_cmd('power on')
+        puts runner.on @node
       when options[:off]
-        puts ipmitool_cmd('power off')
+        puts runner.off @node
+      when options[:soft_off]
+        puts runner.soft_off @node
       when options[:reboot]
-        puts ipmitool_cmd('power cycle')
+        puts runner.reboot @node
+      when options[:soft_reboot]
+        puts runner.soft_reboot @node
+      when options[:status]
+        puts runner.status @node
       else
         begin
-          raise OptionParser::MissingArgument, "specify an action"
-        rescue OptionParser::MissingArgument => e
-          puts e
+          puts "specify an action"
           exit 1
         end
       end
     end
 
     private
-
-    def ipmitool_cmd action
-      system("#{@ipmitool_exec} -I lanplus -H #{@node.ipmi.address} -U #{@node.ipmi.username} -P #{@node.ipmi.password} #{action}")
-      return $?.exitstatus == 0 ? "SUCCESS" : "FAILED"
+    def load_runners runners
+      runners.map {|runner|
+        begin
+          require "consolr/runners/#{runner}"
+          Consolr::Runners.const_get(runner.capitalize).new @config_params.fetch(runner, {})
+        rescue NameError, LoadError => e
+          puts "Could not load runner #{runner.capitalize}, skipping."
+        end
+      }.compact
     end
-
   end
-
 end

data/spec/configs/consolr_runners_rspec.yml

@@ -0,0 +1,9 @@
+# this is a dummy config for the unit tests
+runners:
+  - failrunner
+  - testrunner
+dangerous_assets:
+  - "dangerous-allocated-tag"
+  - "dangerous-maintenance-tag"
+dangerous_status:
+  - "Allocated"

data/spec/consolr_spec.rb

@@ -26,6 +26,40 @@ describe Consolr::Console do
     expect { @console.start({:hostname => 'hostname-with-multiple-assets.dc.net'}) }.to raise_error(SystemExit, /Found \d+ assets/)
   end
 
+  it 'loads ipmitool as the default runner' do
+    expect_any_instance_of(Consolr::Runners::Ipmitool).to receive(:initialize)
+    @console.start({:tag => 'safe-allocated-tag', :on => true})
+  end
+
+  it 'prints an error when passed an unknown runner' do
+    expect {
+      @console.start({:tag => 'safe-allocated-tag', :on  => true, :runner => 'bogusrunner'})
+    }.to raise_error SystemExit
+  end
+
+  it 'loads a custom runner when specified' do
+    $LOAD_PATH << 'spec/mocks'
+    require 'consolr/runners/testrunner'
+    expect_any_instance_of(Consolr::Runners::Testrunner).to receive(:initialize)
+    @console.start({:tag => 'safe-allocated-tag', :on => true, :runner => 'testrunner'})
+  end
+
+  it 'selects a runner that supports the node' do
+    $LOAD_PATH << 'spec/mocks'
+    require 'consolr/runners/testrunner'
+    require 'consolr/runners/failrunner'
+    old_config = ENV['CONSOLR_CONFIG']
+    ENV['CONSOLR_CONFIG'] = '../../spec/configs/consolr_runners_rspec.yml'
+
+    console = Consolr::Console.new
+    expect_any_instance_of(Consolr::Runners::Failrunner).to receive(:can_run?).
+      and_return(false)
+    expect_any_instance_of(Consolr::Runners::Testrunner).to receive(:on)
+    console.start({:tag => 'safe-allocated-tag', :on => true})
+
+    ENV['CONSOLR_CONFIG'] = old_config
+  end
+
   safe_boolean_actions = {:console => "--> Opening SOL session (type ~~. to quit)\nsol activate", :kick => 'sol deactivate', :identify => 'chassis identify', :sdr => 'sdr elist all', :on => 'power on'}
   dangerous_boolean_actions = {:off => 'power off', :reboot => 'power cycle'}
 

data/spec/mocks/consolr/runners/failrunner.rb

@@ -0,0 +1,13 @@
+module Consolr
+  module Runners
+    class Failrunner < Runner
+      def initialize config
+        true
+      end
+
+      def can_run? node
+        false
+      end
+    end
+  end
+end

data/spec/mocks/consolr/runners/testrunner.rb

@@ -0,0 +1,25 @@
+module Consolr
+  module Runners
+    class Testrunner < Runner
+      def initialize config
+        true
+      end
+
+      def can_run? node
+        true
+      end
+
+      def verify node
+        true
+      end
+
+      def on node
+        'SUCCESS'
+      end
+
+      def power node
+        'SUCCESS'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: consolr
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Will Richard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: collins_auth
@@ -118,9 +118,12 @@ files:
 - bin/consolr
 - consolr.gemspec
 - lib/consolr.rb
+- lib/consolr/runners/ipmitool.rb
+- lib/consolr/runners/runner.rb
 - lib/consolr/version.rb
 - spec/configs/collins_rspec.yml
 - spec/configs/consolr_rspec.yml
+- spec/configs/consolr_runners_rspec.yml
 - spec/consolr_spec.rb
 - spec/fixtures/assets/dangerous-allocated-tag.yml
 - spec/fixtures/assets/dangerous-maintenance-tag.yml
@@ -128,6 +131,8 @@ files:
 - spec/fixtures/assets/safe-maintenance-tag.yml
 - spec/mocks/collins.rb
 - spec/mocks/collins_auth.rb
+- spec/mocks/consolr/runners/failrunner.rb
+- spec/mocks/consolr/runners/testrunner.rb
 - spec/mocks/ping.rb
 - spec/rspec_ipmi
 - spec/spec_helper.rb
@@ -151,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: consolr is a pure ruby wrapper over IPMI to allow Out of Band communiation
@@ -159,6 +164,7 @@ summary: consolr is a pure ruby wrapper over IPMI to allow Out of Band communiat
 test_files:
 - spec/configs/collins_rspec.yml
 - spec/configs/consolr_rspec.yml
+- spec/configs/consolr_runners_rspec.yml
 - spec/consolr_spec.rb
 - spec/fixtures/assets/dangerous-allocated-tag.yml
 - spec/fixtures/assets/dangerous-maintenance-tag.yml
@@ -166,6 +172,8 @@ test_files:
 - spec/fixtures/assets/safe-maintenance-tag.yml
 - spec/mocks/collins.rb
 - spec/mocks/collins_auth.rb
+- spec/mocks/consolr/runners/failrunner.rb
+- spec/mocks/consolr/runners/testrunner.rb
 - spec/mocks/ping.rb
 - spec/rspec_ipmi
 - spec/spec_helper.rb