consolr 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a38a3e55d260cd0e651624b9538fe1dd5c02ebec
-  data.tar.gz: 97b68495858ac85a54d9f676d82009ab3439cfee
+  metadata.gz: 11a24c9b0561b89685d3adb05787b51e0005c7ec
+  data.tar.gz: a7e6fc27c2b7b13f2c0896e6c78eaad4535891a0
 SHA512:
-  metadata.gz: 5a95919989e09084c03e4855ff040aaa3d077bc26487b32eca569e9bfbbf3925d6cbe737782d977f9ede59eaa6a7ccc917b34edd1ac68e7b7c5728f582a826e0
-  data.tar.gz: 630d5a041cec8a5fee3980ae3a6bfad5ad84c0e359fe7879281bab738ce04005ef9a46277ebb608d9138b171fa2ac3bb21ffd705b8ad2025ce563529764371f5
+  metadata.gz: acbd07b961a90a56cf71181e11751c7447cda0af49ed2047a4fa7923dffd40f451e23e83e984786c95d3606b48fa69b0bec8c53c5aef83ac023e9be579a1761d
+  data.tar.gz: 2ad9199618d6c9f2be136c6fdf28650e97c717ff07a330090b99743f1d8837668873d71a8b925798805f6a3e69942da163b39c91e07d0bf24da6d7df21f4d0f6

data/.gitignore

@@ -1 +1,3 @@
+.bundle
 coverage/
+vendor/

data/README.md

@@ -43,27 +43,36 @@ Redhat Flavors
 # gem install consolr
 ```
 
-- Setting up a configuration file
+### Configuration
 
-Configuration file is where consolr looks for the location of ipmitool.
-If you have assets where you don't want users changing things, just add the 
+The configuration file is where consolr looks for what runners you have enabled
+and what parameters should be passed for them. To configure your runners add
+them to the `runners` array. For any runner you have, you can add another root
+key to the config object with parameters for that runner.
+
+If you have assets where you don't want users changing things, just add the
 asset in the dangerous assets list. Consolr will safeguard it.
 
-Consolr authenticates with Collins through [collins-auth](https://github.com/tumblr/collins/tree/master/support/ruby/collins-auth). So 
+Consolr authenticates with Collins through [collins-auth](https://github.com/tumblr/collins/tree/master/support/ruby/collins-auth). So
 one would want collins.yml file to be set up as well.
 
-Configuration params are searched in these locations -- 
+Configuration params are searched in these locations:
 
--- ENV['CONSOLR_CONFIG']
--- $HOME/.consolr.yml
--- /etc/consolr.yml
--- /var/db/consolr.yml
+1. `ENV['CONSOLR_CONFIG']`
+2. `$HOME/.consolr.yml`
+3. `/etc/consolr.yml`
+4. `/var/db/consolr.yml`
 
 An example consolr.yml file
 
-```    
+```
 runners:
-  ipmitool:  /usr/bin/ipmitool
+  - ipmitool
+  - customrunner
+ipmitool: /usr/bin/ipmitool
+customrunner:
+  user: admin
+  password: s3cr3t
 dangerous_assets:
   - "007117"
 dangerous_status:

data/consolr.gemspec

@@ -6,8 +6,8 @@ require 'consolr/version'
 Gem::Specification.new do |spec|
   spec.name          = "consolr"
   spec.version       = Consolr::VERSION
-  spec.authors       = ["Will Richard", "Sashidhar Guntury"]
-  spec.email         = ["will@tumblr.com", "sashi@tumblr.com", "collins-sm@googlegroups.com"]
+  spec.authors       = ["Will Richard", "Sashidhar Guntury", "Felix Aronsson"]
+  spec.email         = ["collins-sm@googlegroups.com"]
   spec.summary       = %q{consolr is a pure ruby wrapper over IPMI to allow Out of Band communiation with nodes.}
   spec.description   = %q{Consolr is a utility which speaks to Collins on our behalf and retrieves the address, username and password to connect to that node over IPMI. Passing different flags, we can performs a variety of taks on the node over IPMI. There are safeguards in place to prevent potentially catastrophic actions being performed on nodes.}
   spec.homepage      = "https://github.com/tumblr/collins/tree/master/support/ruby/consolr"
@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "collins_auth", "~> 0.1.2"
-  spec.add_runtime_dependency "net-ping", "~> 1.7.7"
+  spec.add_runtime_dependency "collins_auth", "~> 0.1"
+  spec.add_runtime_dependency "net-ping", "~> 1.7"
 
-  spec.add_development_dependency "rake", "~> 10.4.2"
-  spec.add_development_dependency "rspec", "~> 3.3.0"
-  spec.add_development_dependency "simplecov", "~> 0.10.0"
-  spec.add_development_dependency "webmock", "~> 1.21.0"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "webmock", "~> 1.21"
 end

data/lib/consolr.rb

@@ -97,37 +97,10 @@ 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.")
 
-      # 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?
         abort "Asset #{@node.tag} is a crucial asset. Can't ever execute dangerous actions on this asset.\n#{dangerous_body}"
@@ -137,54 +110,83 @@ module Consolr
         abort "Cannot run dangerous commands on #{@node.hostname} (#{@node.tag} - #{@node.status}) because it is in a protected status. This can be overridden with the --force flag\n#{dangerous_body}"
       end
 
-      case
-      when options[:console]
-        puts '--> Opening SOL session (type ~~. to quit)'
-        puts runner.console @node
-      when options[:kick]
-        puts runner.kick @node
-      when options[:identify]
-        puts runner.identify @node
-      when options[:sdr]
-        puts runner.sdr @node
-      when options[:log] == 'list'
-        puts runner.log_list @node
-      when options[:log] == 'clear'
-        puts runner.log_clear @node
-      when options[:on]
-        puts runner.on @node
-      when options[:off]
-        puts runner.off @node
-      when options[:soft_off]
-        puts runner.soft_off @node
-      when options[:reboot]
-        puts runner.reboot @node
-      when options[:soft_reboot]
-        puts runner.soft_reboot @node
-      when options[:status]
-        puts runner.status @node
-      when options[:sensors]
-        puts runner.sensors @node
-      when options[:get_sol_info]
-        puts runner.sol_info @node
-      else
-        begin
-          puts "specify an action"
-          exit 1
-        end
+      # use the command line runner, if it was provided
+      runner_names = [options[:runner]].compact
+
+      # if no runner specified on command line, use the runners from the config
+      if runner_names.empty?
+        runner_names = @config_params.fetch('runners', []).compact
       end
-    end
 
-    private
-    def load_runners runners
-      runners.map {|runner|
+      # if neither of the above is true, default to using ipmitool
+      if runner_names.empty?
+        runner_names = ['ipmitool']
+      end
+
+      # select the first runner that support the node
+      runner_names.each do |runner_name|
+
+        # load the runner
         begin
-          require "consolr/runners/#{runner}"
-          Consolr::Runners.const_get(runner.capitalize).new @config_params.fetch(runner, {})
+          require "consolr/runners/#{runner_name}"
+          runner = Consolr::Runners.const_get(runner_name.capitalize).new @config_params.fetch(runner_name, {})
         rescue NameError, LoadError => e
-          puts "Could not load runner #{runner.capitalize}, skipping."
+          puts "Could not load runner #{runner_name.capitalize}, skipping."
+          next
         end
-      }.compact
+
+        # if this runner can't work for this node, try the next runner
+        if not runner.can_run? @node
+          next
+        end
+
+        if not runner.verify @node
+          abort("Cannot verify asset #{@node.hostname} (#{@node.tag})")
+        end
+
+        # run the command!
+        case
+        when options[:console]
+          puts '--> Opening SOL session (type ~~. to quit)'
+          puts runner.console @node
+        when options[:kick]
+          puts runner.kick @node
+        when options[:identify]
+          puts runner.identify @node
+        when options[:sdr]
+          puts runner.sdr @node
+        when options[:log] == 'list'
+          puts runner.log_list @node
+        when options[:log] == 'clear'
+          puts runner.log_clear @node
+        when options[:on]
+          puts runner.on @node
+        when options[:off]
+          puts runner.off @node
+        when options[:soft_off]
+          puts runner.soft_off @node
+        when options[:reboot]
+          puts runner.reboot @node
+        when options[:soft_reboot]
+          puts runner.soft_reboot @node
+        when options[:status]
+          puts runner.status @node
+        when options[:sensors]
+          puts runner.sensors @node
+        when options[:get_sol_info]
+          puts runner.sol_info @node
+        else
+          begin
+            abort("specify an action")
+          end
+        end
+        # everything worked!
+        exit 0
+      end
+
+      # if we got here, all the runners did not work for this node
+      abort("No runners available for node #{@node.hostname} (#{@node.tag})")
     end
+
   end
 end

data/lib/consolr/version.rb

@@ -1,3 +1,3 @@
 module Consolr
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: consolr
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Will Richard
 - Sashidhar Guntury
+- Felix Aronsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: collins_auth
@@ -17,91 +18,89 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: net-ping
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.21'
 description: Consolr is a utility which speaks to Collins on our behalf and retrieves
   the address, username and password to connect to that node over IPMI. Passing different
   flags, we can performs a variety of taks on the node over IPMI. There are safeguards
   in place to prevent potentially catastrophic actions being performed on nodes.
 email:
-- will@tumblr.com
-- sashi@tumblr.com
 - collins-sm@googlegroups.com
 executables:
 - consolr