robot-controller 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2f749801d61882786e5c4d20fed0f0d25e49330
-  data.tar.gz: 6d33a112ceecfc0e489d6a62ac1ede016fef30ce
+  metadata.gz: 4aecc4e3e0802963a8bde215f896ae5cf46c1eb8
+  data.tar.gz: c3e49d1dfb090a7bd99d000616990b4ffcdf4b7e
 SHA512:
-  metadata.gz: a13063c8cf25fb05dcb0dd9fab4c0060cd9b2f25c2ae5702044089f98369f112b82f40843cdc61b198a5181fa38e2f8a3131354c752ceac48c23da1c862515f7
-  data.tar.gz: f15b215c9e5a88645ca4ca7ce351fa589f11b09ab41c6d283d91f180ddc62d299f411d777f8bc0855cf5521612149c6d616a8de5bca0850163630ca81c8eed02
+  metadata.gz: 13ef598d961e075c20b26919576dfaed18c850e41ecf9be31ad799b2a6cd6298f250a80e1c19b93a8e35aa5776c9c3cd4c1ebc92a6e453b337b99f5d47854c9d
+  data.tar.gz: 0858eef295cd386ecfd652b10ad28fd8b7486dd682ed6c9058016cc4955bab4798addd85a79e2ddf1a6ba79fa8410e655833243d1bce89ee13a6ecb0367294d3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop_todo.yml

@@ -1,31 +1,35 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-06-23 11:24:30 -0700 using RuboCop version 0.31.0.
+# on 2015-07-01 12:52:10 -0700 using RuboCop version 0.32.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 3
 Metrics/AbcSize:
-  Max: 37
+  Max: 87
 
 # Offense count: 1
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 23
 
-# Offense count: 17
+# Offense count: 34
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 130
+  Max: 123
 
-# Offense count: 1
+# Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 22
+  Max: 88
 
-# Offense count: 1
+# Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 21
 
 # Offense count: 1
 # Configuration parameters: Exclude.
@@ -41,8 +45,3 @@ Style/FormatString:
 # Cop supports --auto-correct.
 Style/NumericLiterals:
   MinDigits: 6
-
-# Offense count: 1
-# Configuration parameters: Methods.
-Style/SingleLineBlockParams:
-  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+notifications:
+  email: false
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2

data/README.md

@@ -1,3 +1,7 @@
+[![Build Status](https://travis-ci.org/sul-dlss/robot-controller.svg?branch=master)](https://travis-ci.org/sul-dlss/robot-controller)
+[![Dependency Status](https://gemnasium.com/sul-dlss/robot-controller.svg)](https://gemnasium.com/sul-dlss/robot-controller)
+
+
 robot-controller
 ================
 
@@ -19,7 +23,7 @@ Create the following configuration files based on the examples in `example/confi
     
 Then to use the controller to boot the robots:
 
-    % bundle exec controller boot
+    bundle exec controller boot
     
 If you want to *override* the bluepill configuration but still use the 
 controller (though NOT recommended), then add:
@@ -34,12 +38,12 @@ controller (though NOT recommended), then add:
            controller [--help]
 
     Example:
-      % controller boot    # start bluepilld and jobs
-      % controller status  # check on status of jobs
-      % controller verify  # verify robots are running as configured
-      % controller log robot01_01_dor_accessionWF_descriptive-metadata # view log for worker 
-      % controller stop    # stop jobs
-      % controller quit    # stop bluepilld
+      controller boot    # start bluepilld and jobs
+      controller status  # check on status of jobs
+      controller verify  # verify robots are running as configured
+      controller log robot01_01_dor_accessionWF_descriptive-metadata # view log for worker 
+      controller stop    # stop jobs
+      controller quit    # stop bluepilld
   
     Environment:
       BLUEPILL_BASEDIR - where bluepill stores its state (default: run/bluepill)
@@ -51,6 +55,7 @@ controller (though NOT recommended), then add:
 * `v1.0.0`: Initial version
 * `v1.0.1`: Add 'rake' as dependency
 * `v2.0.0`: Added 'verify' command
+* `v2.0.1`: Added rake robots:verify and support for whenever gem
 
 ### `verify` command
 
@@ -92,4 +97,23 @@ The various states are determined as follows:
 - If the robot is unknown by the suite:
   - `ERROR`: always
 
-NOTE: The queues on which the robots are running are NOT verified.
+NOTE: The queues on which the robots are running are NOT verified.
+
+### Running `verify` command via crontab
+
+In `Capfile` add:
+
+    require 'whenever/capistrano'
+
+In `config/deploy.rb` add:
+
+    set :whenever_identifier, ->{ "#{fetch(:application)}_#{fetch(:stage)}" }
+
+In `config/schedule.rb` add:
+
+    every 5.minutes do
+      # cannot use :output with Hash/String because we don't want append behavior
+      set :output, proc { '> log/verify.log 2> log/cron.log' }
+      set :environment_variable, 'ROBOT_ENVIRONMENT'
+      rake 'robots:verify'
+    end

data/Rakefile

@@ -1,13 +1,9 @@
 require 'rubygems'
 require 'rake'
+require 'rspec/core/rake_task'
 require 'version_bumper'
 require 'robot-controller/tasks'
 
 Dir.glob('lib/tasks/*.rake').each { |r| import r }
 
-require 'rspec/core/rake_task'
-
-desc 'Run specs'
-RSpec::Core::RakeTask.new(:spec)
-
-task default: [:yard, :spec]
+task default: [:spec, :rubocop, :yard]

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1

data/bin/controller

@@ -2,110 +2,121 @@
 require 'yaml'
 require 'robot-controller'
 
-if ARGV.size == 0
-  puts '
-Usage: controller ( boot | quit )
-       controller ( start | status | stop | restart | log ) [worker]
-       controller verify [--verbose]
-       controller [--help]
+# bin/controller tool
+module RobotController
+  #
+  class CLI
+    # meta command
+    def self.run(args)
+      if args.size == 0 || args.first == '--help'
+        puts '
+      Usage: controller ( boot | quit )
+             controller ( start | status | stop | restart | log ) [worker]
+             controller verify [--verbose]
+             controller [--help]
 
-Example:
-  % controller boot    # start bluepilld and jobs
-  % controller status  # check on status of jobs
-  % controller log dor_accessionWF_descriptive-metadata # view log for worker
-  % controller verify  # verify robots are running as configured
-  % controller stop    # stop jobs
-  % controller quit    # stop bluepilld
+      Example:
+        % controller boot    # start bluepilld and jobs
+        % controller status  # check on status of jobs
+        % controller log dor_accessionWF_descriptive-metadata # view log for worker
+        % controller verify  # verify robots are running as configured
+        % controller stop    # stop jobs
+        % controller quit    # stop bluepilld
 
-Environment:
-  BLUEPILL_BASEDIR - where bluepill stores its state (default: run/bluepill)
-  BLUEPILL_LOGFILE - output log (default: log/bluepill.log)
-  ROBOT_ENVIRONMENT - (default: development)
-'
-  exit(-1)
-end
+      Environment:
+        BLUEPILL_BASEDIR - where bluepill stores its state (default: run/bluepill)
+        BLUEPILL_LOGFILE - output log (default: log/bluepill.log)
+        ROBOT_ENVIRONMENT - (default: development)
+      '
+        exit(-1)
+      end
 
-ENV['ROBOT_ENVIRONMENT'] ||= 'development'
-ENV['BLUEPILL_BASE_DIR'] ||= File.expand_path('run/bluepill')
-ENV['BLUEPILL_LOGFILE'] ||= File.expand_path('log/bluepill.log')
+      ENV['ROBOT_ENVIRONMENT'] ||= 'development'
+      ENV['BLUEPILL_BASE_DIR'] ||= File.expand_path('run/bluepill')
+      ENV['BLUEPILL_LOGFILE'] ||= File.expand_path('log/bluepill.log')
 
-fail 'bluepill requires config directory' unless File.directory?('config')
-fail 'bluepill requires run directory' unless File.directory?(File.dirname(ENV['BLUEPILL_BASE_DIR']))
-fail 'bluepill requires log directory' unless File.directory?(File.dirname(ENV['BLUEPILL_LOGFILE']))
+      fail 'bluepill requires config directory' unless File.directory?('config')
+      fail 'bluepill requires run directory' unless File.directory?(File.dirname(ENV['BLUEPILL_BASE_DIR']))
+      fail 'bluepill requires log directory' unless File.directory?(File.dirname(ENV['BLUEPILL_LOGFILE']))
 
-cmd = 'bluepill'
-cmd << ' --no-privileged'
-cmd << " --base-dir #{ENV['BLUEPILL_BASE_DIR']}"
-cmd << " --logfile #{ENV['BLUEPILL_LOGFILE']}"
+      cmd = 'bluepill'
+      cmd << ' --no-privileged'
+      cmd << " --base-dir #{ENV['BLUEPILL_BASE_DIR']}"
+      cmd << " --logfile #{ENV['BLUEPILL_LOGFILE']}"
 
-case ARGV[0].downcase
-when 'boot'
-  fn = 'config/bluepill.rb' # allow override
-  fn = RobotController.bluepill_config unless File.file?(fn)
-  if File.file?(fn)
-    # puts "Loading #{fn}"
-    exec "#{cmd} load #{fn}"
-    # NOTREACHED
-  end
-  puts "ERROR: Cannot find bluepill configuration file for #{ENV['ROBOT_ENVIRONMENT']}"
-  exit(-1)
-when 'verify'
-  verbose = (ARGV[1] == '--verbose')
+      case args.first.downcase
+      when 'boot'
+        fn = 'config/bluepill.rb' # allow override
+        fn = RobotController.bluepill_config unless File.file?(fn)
+        if File.file?(fn)
+          # puts "Loading #{fn}"
+          exec "#{cmd} load #{fn}"
+          # NOTREACHED
+        end
+        puts "ERROR: Cannot find bluepill configuration file for #{ENV['ROBOT_ENVIRONMENT']}"
+        exit(-1)
+      when 'verify'
+        verbose = (args[1] == '--verbose')
 
-  # load list of all possible robots
-  robots = YAML.load_file('config/robots.yml')
-  fail ArgumentError unless robots.is_a? Array
+        # load list of all possible robots
+        robots = YAML.load_file('config/robots.yml')
+        fail ArgumentError unless robots.is_a? Array
 
-  # determine how many processes should be running for each robot
-  running = {}
-  robots.each do |robot|
-    running[robot] = 0
-  end
-  RobotController::Parser.load("robots_#{ENV['ROBOT_ENVIRONMENT']}.yml").each do |h|
-    running[h[:robot]] = h[:n]
-  end
+        # determine how many processes should be running for each robot
+        running = {}
+        robots.each do |robot|
+          running[robot] = 0
+        end
+        RobotController::Parser.load("robots_#{ENV['ROBOT_ENVIRONMENT']}.yml").each do |h|
+          running[h[:robot]] = h[:n]
+        end
 
-  # verify that all robots running are known to the config/robots.yml
-  running.each_key do |robot|
-    if !robots.include?(robot)
-      puts "ERROR: '#{robot}' robot is unknown to the suite. Check config/robots.yml" 
-      running.delete(robot)
-    end
-  end
+        # verify that all robots running are known to the config/robots.yml
+        running.each_key do |robot|
+          unless robots.include?(robot)
+            puts "ERROR: '#{robot}' robot is unknown to the suite. Check config/robots.yml"
+            running.delete(robot)
+          end
+        end
 
-  # verify suite
-  verify = RobotController::Verify.new(running)
-  begin
-    statuses = verify.verify
-  rescue => e
-    puts "ERROR: Cannot run verification for any robots. #{e.class}: #{e.message}" 
-    exit(-1)
-  end
+        # verify suite
+        verify = RobotController::Verify.new(running)
+        begin
+          statuses = verify.verify
+        rescue => e
+          puts "ERROR: Cannot run verification for any robots. #{e.class}: #{e.message}"
+          exit(-1)
+        end
 
-  # print output for each status
-  ok = true
-  puts 'ERROR: No robots to verify?' if statuses.size == 0
-  statuses.each_pair do |robot, status|
-    case status[:state]
-    when :up
-      puts "OK: #{robot} is up (#{status[:running]} running)" if verbose
-    when :not_enabled
-      if status[:running] == 0
-        puts "OK: #{robot} is not enabled (0 running)" if verbose
+        # print output for each status
+        ok = true
+        puts 'ERROR: No robots to verify?' if statuses.size == 0
+        statuses.each_pair do |robot, status|
+          case status[:state]
+          when :up
+            puts "OK: #{robot} is up (#{status[:running]} running)" if verbose
+          when :not_enabled
+            if status[:running] == 0
+              puts "OK: #{robot} is not enabled (0 running)" if verbose
+            else
+              puts "ERROR: #{robot} is not enabled (but #{status[:running]} running)"
+            end
+          when :down
+            ok = false
+            puts "ERROR: #{robot} is down (#{status[:running]} of #{running[robot]} running)"
+          else
+            ok = false
+            puts "ERROR: #{robot} cannot be verified (state=#{status[:state]})"
+          end
+        end
+        puts 'OK' if ok && !verbose && statuses.size > 0
+        exit(0)
       else
-        puts "ERROR: #{robot} is not enabled (but #{status[:running]} running)"
+        exec "#{cmd} #{args.join(' ')}"
+        # NOTREACHED
       end
-    when :down
-      ok = false
-      puts "ERROR: #{robot} is down (#{status[:running]} of #{running[robot]} running)"
-    else
-      ok = false
-      puts "ERROR: #{robot} cannot be verified (state=#{status[:state]})"
     end
   end
-  puts 'OK' if ok && !verbose && statuses.size > 0
-  exit(0)
-else
-  exec "#{cmd} #{ARGV.join(' ')}"
-  # NOTREACHED
 end
+
+RobotController::CLI.run(ARGV)

data/config/schedule_example.rb

@@ -0,0 +1,10 @@
+# Use this file to easily define all of your cron jobs.
+
+every 5.minutes do
+  # cannot use :output with Hash/String because we don't want append behavior
+  set :output, proc { '> log/verify.log 2> log/cron.log' }
+  set :environment_variable, 'ROBOT_ENVIRONMENT'
+  rake 'robots:verify'
+end
+
+# Learn more: http://github.com/javan/whenever

data/example/config/environments/robots_development.yml

@@ -14,6 +14,7 @@
 #          - a list of identiers ('A,B,C'), or 
 #          - an asterix (*).
 #    3. instances is a single integer.
+#    4. host is the hostname or '*' for any host
 #
 #  Both lane and instances are optional. Lane defaults to 'default', and 
 #  instances defaults to 1.
@@ -43,7 +44,7 @@
 #
 # Robot 1 (8 CPU) hosts shelving and publish only
 #
-sul-robots1-dev:
+robot1:
   - dor_accessionWF_shelve:A                  # 1 robot for lane A
   - dor_accessionWF_shelve:B:3                # 3 robots for lane B
   - dor_accessionWF_shelve:C:3                # 3 robots for lane C
@@ -64,7 +65,7 @@ sul-robots1-dev:
 #
 # Robot 2 (16 CPU) hosts technical metadata creation only
 #
-sul-robots2-dev:
+robot2:
   - dor_accessionWF_technical-metadata:A:5    # 5 robots for lane A
   - dor_accessionWF_technical-metadata:B:5    # 5 robots for lane B
   - dor_accessionWF_technical-metadata:C,D,E:5  # 5 robots for lanes C, D, and E
@@ -72,7 +73,7 @@ sul-robots2-dev:
 #
 # Robot 3 (4 CPU) hosts helper robots for all accessioning workflows
 #
-sul-robots3-dev:
+robot3:
   - dor_accessionWF_descriptive-metadata      # 1 robot for default lane
   - dor_accessionWF_rights-metadata           # 1 robot for default lane
   - dor_accessionWF_content-metadata          # 1 robot for default lane

data/lib/robot-controller/robots.rb

@@ -4,6 +4,7 @@ require 'yaml'
 module RobotController
   #
   class Parser
+    # maximum number of processes a single robot can have
     ROBOT_INSTANCE_MAX = 16
 
     class << self
@@ -13,80 +14,90 @@ module RobotController
         robots_fn = File.join(dir, robots_fn) if dir
         fail "FileNotFound: #{robots_fn}" unless File.file?(robots_fn)
 
-        # read the YAML file
-        # puts "Loading #{robots_fn}"
+        # read the YAML file with the configuration of all the robots to run
         robots =  YAML.load_file(robots_fn)
-        # puts robots
 
-        # determine current host
-        host = `hostname -s`.strip unless host
-        # puts host
+        # determine current host if not provided
+        host ||= `hostname -s`.strip
 
-        # host = 'sul-robots1-dev' # XXX
-        fail "HostMismatch: #{host} not defined in #{robots_fn}" unless robots.include?(host) || robots.include?('*')
-        host = '*' unless robots.include?(host)
+        # if the config lists this specific host, use it;
+        # else check to see if '*' is a matching host
+        unless robots.include?(host)
+          if robots.include?('*')
+            host = '*'
+          else
+            fail "HostMismatch: #{host} not defined in #{robots_fn}"
+          end
+        end
 
-        parse_yaml(robots[host])
+        # parse the host-specific YAML configuration
+        parse_robots_configuration(robots[host])
       end
 
-      # parse_instances(1) == 1
-      # parse_instances(16) == 16
-      # parse_instances(0) == 1
-      # parse_instances(99) => RuntimeError
-      def parse_instances(n)
+      # validates that the instances value is within range, e.g.,
+      #
+      #   instances_valid?(1) == 1
+      #   instances_valid?(16) == 16
+      #   instances_valid?(0) == 1             # out of range low, enforce minimum
+      #   instances_valid?(99) => RuntimeError # out of range high, error out
+      def instances_valid?(n)
         fail "TooManyInstances: #{n} > #{ROBOT_INSTANCE_MAX}" if n > ROBOT_INSTANCE_MAX
-        n = 1 if n < 1
-        n
+        (n < 1) ? 1 : n
       end
 
-      # parse_lanes('') == ['default']
-      # parse_lanes(' ') == ['default']
-      # parse_lanes(' , ') == ['default']
-      # parse_lanes(' , ,') == ['default']
-      # parse_lanes('*') == ['*']
-      # parse_lanes('1') == ['1']
-      # parse_lanes('A') == ['A']
-      # parse_lanes('A , B') == ['A', 'B']
-      # parse_lanes('A,B,C') == ['A','B','C']
-      # parse_lanes('A-C,E') == ['A-C', 'E']
+      # parse the lane values designator using the following syntax:
+      #
+      #   parse_lanes('') == ['default']
+      #   parse_lanes(' ') == ['default']
+      #   parse_lanes(' , ') == ['default']
+      #   parse_lanes(' , ,') == ['default']
+      #   parse_lanes('*') == ['*']
+      #   parse_lanes('1') == ['1']
+      #   parse_lanes('A') == ['A']
+      #   parse_lanes('A , B') == ['A', 'B']
+      #   parse_lanes('A,B,C') == ['A','B','C']
+      #   parse_lanes('A-C,E') == ['A-C', 'E']
       def parse_lanes(lanes_spec)
-        return ['default'] if lanes_spec.split(/,/).collect(&:strip).join('') == ''
-        lanes_spec.split(/,/).collect(&:strip).uniq
+        lanes = lanes_spec.split(/,/).collect(&:strip).uniq
+        lanes.join('') == '' ? ['default'] : lanes
       end
 
-      # build_queues('z','A') => ['z_A']
-      # build_queues('z','A,C') => ['z_A', 'z_C']
-      def build_queues(robot, lanes)
-        queues = []
-        parse_lanes(lanes).each do |i|
-          queues << [robot, i].join('_')
-        end
-        queues
+      # generate the queue names for all given lanes, e.g.,
+      #
+      #   queue_names('z','A') => ['z_A']
+      #   queue_names('z','A,C') => ['z_A', 'z_C']
+      def queue_names(robot, lanes)
+        parse_lanes(lanes).collect { |lane| robot + '_' + lane }
       end
 
-      def parse_yaml(robots)
-        # parse YAML lines for host where i is robot[:lane[:instances]]
-        r = []
-        robots.each do |i|
-          robot = i.split(/:/).collect(&:strip)
-          robot.each do |j|
-            fail "SyntaxError: #{i}" if j.strip == ''
-          end
+      # parse YAML lines for host where line is robot[:lane[:instances]]
+      #
+      # @return [Array<Hash>]
+      #  [{
+      #    robot: 'foo',
+      #    queues: ['foo_default'],
+      #    n: 2
+      #  }, ... ]
+      def parse_robots_configuration(robots)
+        [].tap do |r|
+          robots.each do |line|
+            robot = line.split(/:/).collect(&:strip)
+            robot.each do |j|
+              fail "SyntaxError: '#{line}' is missing arguments" if j.strip == ''
+            end
 
-          # add defaults
-          robot << 'default' if robot.size == 1
-          robot << '1' if robot.size == 2
+            # add defaults
+            robot << 'default' if robot.size == 1
+            robot << '1' if robot.size == 2
 
-          # build queues for robot instances
-          fail "SyntaxError: #{i}" unless robot.size == 3
-          robot[2] = parse_instances(robot[2].to_i)
-          # puts robot.join(' : ')
-          queues = build_queues(robot[0], robot[1])
-          # puts queues
+            # build queues for robot instances
+            fail "SyntaxError: '#{line}' is missing arguments" unless robot.size == 3
+            robot[2] = instances_valid?(robot[2].to_i)
+            queues = queue_names(robot[0], robot[1])
 
-          r << { robot: robot[0], queues: queues, n: robot[2] }
+            r << { robot: robot[0], queues: queues, n: robot[2] }
+          end
         end
-        r
       end
     end
   end

data/lib/robot-controller/tasks.rb

@@ -1 +1,9 @@
 require 'resque/tasks'
+
+desc 'Verify that robots are running as configured'
+namespace :robots do
+  task :verify, :verbose do |_t, args|
+    args.with_defaults(verbose: nil)
+    system "bundle exec controller verify #{args[:verbose] ? '--verbose' : ''}"
+  end
+end

data/lib/robot-controller/verify.rb

@@ -49,7 +49,7 @@ module RobotController
       fail ArgumentError if nprocesses.nil? || !nprocesses.is_a?(Hash)
       fail ArgumentError, 'Empty argument' if nprocesses.size == 0
       @running = nprocesses
-      @robots = @running.each_key.to_a
+      @robots = @running.keys
       @status = nil
     end
 
@@ -71,11 +71,7 @@ module RobotController
     # }
     def verify(reload = true)
       @status = nil if reload
-      r = {}
-      robots.each do |robot|
-        r[robot] = robot_status(robot)
-      end
-      r
+      {}.tap { |hash| robots.each { |robot| hash[robot] = robot_status(robot) } }
     end
 
     # @param [String] robot name
@@ -84,8 +80,6 @@ module RobotController
       @running[robot]
     end
 
-    protected
-
     # @param [String] robot name
     # @return [Hash] { state: :up | :down | :not_enabled, running: n }
     def robot_status(robot)
@@ -96,6 +90,8 @@ module RobotController
       end
     end
 
+    protected
+
     #
     # @return [Hash] status
     # {

data/lib/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts 'no rspec available'
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  puts 'Unable to load RuboCop.'
+end

data/lib/tasks/yard.rake

@@ -0,0 +1,16 @@
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['lib/**/*.rb', 'bin/controller']
+    t.options = ['--readme', 'README.md', '-m', 'markdown']
+  end
+
+  namespace :yard do
+    desc 'Clean up documentation'
+    task :clean do
+      FileUtils.rm_rf('doc')
+    end
+  end
+rescue LoadError
+  abort 'Please install the YARD gem to generate doc.'
+end

data/robot-controller.gemspec

@@ -25,11 +25,13 @@ Gem::Specification.new do |s|
   s.add_dependency 'bluepill', '0.0.68' # pin bluepill to prevent nil status output regression
   s.add_dependency 'resque', '~> 1.25.2'
   s.add_dependency 'rake', '~> 10.3.2'
+  s.add_dependency 'whenever', '~> 0.9.2'
 
-  s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'redcarpet' # provides Markdown
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'version_bumper'
   s.add_development_dependency 'yard'
 end

data/spec/fixtures/matcher.yml

@@ -0,0 +1,4 @@
+'*':
+  - M:default:1
+  - N:B:2
+  - O:C:3

data/spec/unit/robots_spec.rb

@@ -6,7 +6,7 @@ describe RobotController::Parser do
       RobotController::Parser.load('standard.yml', 'spec/fixtures', 'host1')
     end
 
-    it 'pass1' do
+    it 'parses correctly' do
       expect(subject).to eq [
         { robot: 'X', queues: ['X_default'], n: 1 },
         { robot: 'Y', queues: ['Y_B'], n: 1 },
@@ -20,7 +20,7 @@ describe RobotController::Parser do
       RobotController::Parser.load('standard.yml', 'spec/fixtures', 'host2')
     end
 
-    it 'pass2' do
+    it 'parses correctly' do
       expect(subject).to eq [
         { robot: 'A', queues: ['A_*'], n: 1 },
         { robot: 'B', queues: %w(B_X B_Y), n: 1 },
@@ -30,19 +30,50 @@ describe RobotController::Parser do
     end
   end
 
-  context 'parse_instances' do
+  context 'expanded mismatched host' do
+    it 'reports error' do
+      expect do
+        RobotController::Parser.load('standard.yml', 'spec/fixtures', 'host3')
+      end.to raise_error(RuntimeError)
+    end
+  end
+
+  context 'matcher' do
+    subject do
+      RobotController::Parser.load('matcher.yml', 'spec/fixtures', 'host3')
+    end
+
+    it 'parses correctly' do
+      expect(subject).to eq [
+        { robot: 'M', queues: ['M_default'], n: 1 },
+        { robot: 'N', queues: ['N_B'], n: 2 },
+        { robot: 'O', queues: ['O_C'], n: 3 }
+      ]
+    end
+  end
+
+  context 'file-not-found' do
+    it 'reports error' do
+      expect do
+        RobotController::Parser.load('nofile.yml', 'spec/fixtures', 'host3')
+      end.to raise_error(RuntimeError)
+    end
+  end
+
+  context 'instances_valid?' do
     subject do
       RobotController::Parser
     end
     it 'valid inputs' do
-      expect(subject.parse_instances(0)).to eq 1
-      expect(subject.parse_instances(1)).to eq 1
-      expect(subject.parse_instances(16)).to eq 16
+      expect(subject.instances_valid?(0)).to eq 1
+      expect(subject.instances_valid?(1)).to eq 1
+      expect(subject.instances_valid?(8)).to eq 8
+      expect(subject.instances_valid?(16)).to eq 16
     end
 
     it 'invalid inputs' do
       expect do
-        subject.parse_instances(17)
+        subject.instances_valid?(17)
       end.to raise_error RuntimeError
     end
   end
@@ -70,15 +101,15 @@ describe RobotController::Parser do
     end
   end
 
-  context 'build_queues' do
+  context 'queue_names' do
     subject do
       RobotController::Parser
     end
 
     it 'valid inputs' do
-      expect(subject.build_queues('z', '*')).to eq ['z_*']
-      expect(subject.build_queues('z', 'default')).to eq ['z_default']
-      expect(subject.build_queues('z', 'A,B,C')).to eq %w(z_A z_B z_C)
+      expect(subject.queue_names('z', '*')).to eq ['z_*']
+      expect(subject.queue_names('z', 'default')).to eq ['z_default']
+      expect(subject.queue_names('z', 'A,B,C')).to eq %w(z_A z_B z_C)
     end
   end
 end

data/spec/unit/verify_spec.rb

@@ -94,6 +94,23 @@ describe RobotController::Verify do
       )
     end
 
+    it 'runs controller status with errors' do
+      allow(subject).to receive(:controller_status).and_return([
+        'robot01_01_dor_gisAssemblyWF_assign-placenamesMISMATCH(pid:29481): down'
+      ])
+      expect(subject.robot_status('dor_gisAssemblyWF_assign-placenames')).to eq(
+        state: :unknown, running: 0
+      )
+      # expect(subject.robot_status('dor_gisAssemblyWF_assign-placenamesMISMATCH')).to eq(
+      #  { state: :not_enabled, running: 1 }
+      # )
+      expect { subject.robot_status('garbage') }.to raise_error(RuntimeError)
+      expect(subject.verify).to eq(
+        # 'dor_gisAssemblyWF_assign-placenamesMISMATCH' => { state: :not_enabled, running: 1 },
+        'dor_gisAssemblyWF_assign-placenames' => { state: :unknown, running: 0 }
+      )
+    end
+
     it 'runs controller status even when broken' do
       allow(subject).to receive(:controller_status).and_return([])
       expect { subject.verify }.to raise_error(RuntimeError)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robot-controller
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Darren Hardy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bluepill
@@ -53,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 10.3.2
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: whenever
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -145,8 +173,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rubocop.yml
 - .rubocop_todo.yml
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -155,6 +185,7 @@ files:
 - bin/controller
 - config/environments/robots_development.yml
 - config/robots.yml
+- config/schedule_example.rb
 - example/config/environments/robots_development.yml
 - example/lib/tasks/environment.rake
 - lib/robot-controller.rb
@@ -162,8 +193,11 @@ files:
 - lib/robot-controller/robots.rb
 - lib/robot-controller/tasks.rb
 - lib/robot-controller/verify.rb
-- lib/tasks/doc.rake
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
+- lib/tasks/yard.rake
 - robot-controller.gemspec
+- spec/fixtures/matcher.yml
 - spec/fixtures/standard.yml
 - spec/spec_helper.rb
 - spec/unit/robots_spec.rb
@@ -189,14 +223,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Monitors and controls running workflow robots off of priority queues and
   within a cluster
 test_files:
+- spec/fixtures/matcher.yml
 - spec/fixtures/standard.yml
 - spec/spec_helper.rb
 - spec/unit/robots_spec.rb
 - spec/unit/verify_spec.rb
-has_rdoc: true

data/lib/tasks/doc.rake

@@ -1,37 +0,0 @@
-desc 'Generate RDoc'
-task doc: ['doc:generate']
-
-namespace :doc do
-  project_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
-  doc_destination = File.join(project_root, 'rdoc')
-
-  begin
-    require 'yard'
-    require 'yard/rake/yardoc_task'
-
-    YARD::Rake::YardocTask.new(:generate) do |yt|
-      yt.files   =  Dir.glob(File.join(project_root, 'lib', '*.rb')) +
-        Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
-        [File.join(project_root, 'README.rdoc')]
-
-      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
-    end
-  rescue LoadError
-    desc 'Generate YARD Documentation'
-    task :generate do
-      abort 'Please install the YARD gem to generate rdoc.'
-    end
-  end
-
-  desc 'Remove generated documenation'
-  task :clean do
-    rm_r doc_destination if File.exist?(doc_destination)
-  end
-end
-
-desc 'Build Yard documentation'
-task :yard do
-  YARD::Rake::YardocTask.new do |t|
-    t.files = ['lib/**/*.rb', 'bin/**/*.rb']
-  end
-end