flapjack 0.9.6 → 1.0.0rc1

data/features/cli_flapjack-nagios-receiver.feature

@@ -26,42 +26,41 @@ test:
 """
 
   Scenario: Running with --help shows usage information
-    When I run `bin/flapjack-nagios-receiver --help`
+    When I run `bundle exec bin/flapjack receiver nagios --help`
     Then the exit status should be 0
-    And  the output should contain "Usage: flapjack-nagios-receiver"
-    And  the output should contain "-f, --fifo FIFO"
-    And  the output should contain "Required Nagios Configuration Changes"
+    And  the output should contain "[-f arg|--fifo arg]"
+    And  the output should contain "receiver nagios start [-d|--daemonize]"
 
   Scenario: Starting flapjack-nagios-receiver
-    When I start flapjack-nagios-receiver with `flapjack-nagios-receiver start --no-daemonize --config tmp/cucumber_cli/flapjack-nagios-receiver.yaml`
+    When I start flapjack-nagios-receiver (via bundle exec) with `flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver.yaml receiver start --no-daemonize`
     Then flapjack-nagios-receiver should start within 15 seconds
 
   Scenario: Stopping flapjack-nagios-receiver via SIGINT
-    When I start flapjack-nagios-receiver with `flapjack-nagios-receiver start --no-daemonize --config tmp/cucumber_cli/flapjack-nagios-receiver.yaml`
+    When I start flapjack-nagios-receiver (via bundle exec) with `flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver.yaml receiver nagios start --no-daemonize`
     Then flapjack-nagios-receiver should start within 15 seconds
     When I send a SIGINT to the flapjack-nagios-receiver process
     Then flapjack-nagios-receiver should stop within 15 seconds
 
   Scenario: Starting, status, and stopping flapjack-nagios-receiver, daemonized
-    When I start flapjack-nagios-receiver (daemonised) with `flapjack-nagios-receiver start -d --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml`
+    When I start flapjack-nagios-receiver (daemonised) (via bundle exec) with `flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml receiver nagios start -d`
     Then flapjack-nagios-receiver should start within 15 seconds
-    When I run `bin/flapjack-nagios-receiver status --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml`
+    When I run `bundle exec bin/flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml receiver nagios status`
     Then the exit status should be 0
-    And  the output should contain "flapjack-nagios-receiver is running"
-    When I stop flapjack-nagios-receiver with `flapjack-nagios-receiver stop --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml`
+    And  the output should contain "nagios-receiver is running"
+    When I stop flapjack-nagios-receiver (via bundle exec) with `flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml receiver nagios stop`
     Then flapjack-nagios-receiver should stop within 15 seconds
 
   Scenario: Starting, restarting and stopping flapjack-nagios-receiver, daemonized
-    When I start flapjack-nagios-receiver (daemonised) with `flapjack-nagios-receiver start -d --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml`
+    When I start flapjack-nagios-receiver (daemonised) (via bundle exec) with `flapjack  -n test --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml receiver nagios start -d`
     Then flapjack-nagios-receiver should start within 15 seconds
-    When I restart flapjack-nagios-receiver (daemonised) with `flapjack-nagios-receiver restart -d --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml`
+    When I restart flapjack-nagios-receiver (daemonised) (via bundle exec) with `flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml receiver nagios restart`
     Then flapjack-nagios-receiver should restart within 15 seconds
-    When I stop flapjack-nagios-receiver with `flapjack-nagios-receiver stop --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml`
+    When I stop flapjack-nagios-receiver (via bundle exec) with `flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml receiver nagios stop`
     Then flapjack-nagios-receiver should stop within 15 seconds
 
   Scenario: Getting status when stopped
-    When I run `bin/flapjack-nagios-receiver status --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml`
+    When I run `bundle exec bin/flapjack -n test --config tmp/cucumber_cli/flapjack-nagios-receiver_d.yaml receiver nagios status`
     Then the exit status should not be 0
-    And  the output should contain "flapjack-nagios-receiver is not running"
+    And  the output should contain "nagios-receiver is not running"
 
 

data/features/cli_flapjack-populator.feature

@@ -10,6 +10,7 @@ Feature: flapjack-populator command line
 test:
   redis:
     db: 14
+    driver: ruby
 """
     And  a file named "flapjack-populator-contacts.json" with:
 """
@@ -58,32 +59,32 @@ test:
 """
 
   Scenario: Running with --help shows usage information
-    When I run `bin/flapjack-populator --help`
+    When I run `bundle exec bin/flapjack import --help`
     Then the exit status should be 0
-    And  the output should contain "Usage: flapjack-populator"
-    And  the output should contain "import-contacts"
-    And  the output should contain "import-entities"
-    And  the output should contain "--config"
+    And  the output should contain "Bulk import data from an external source"
+    And  the output should contain "import contacts"
+    And  the output should contain "import entities"
+    And  the output should contain "[-f arg|--from arg]"
 
   Scenario: Running flapjack-populator with no arguments exits uncleanly and shows usage
-    When I run `bin/flapjack-populator`
+    When I run `bundle exec bin/flapjack import`
     Then the exit status should not be 0
-    And  the output should contain "Usage: flapjack-populator"
+    And  the output should contain "Bulk import data from an external source"
 
   Scenario: Importing contacts
-    When I run `bin/flapjack-populator import-contacts --from tmp/cucumber_cli/flapjack-populator-contacts.json --config tmp/cucumber_cli/flapjack-populator.yaml`
+    When I run `bundle exec bin/flapjack -n test --config tmp/cucumber_cli/flapjack-populator.yaml import contacts --from tmp/cucumber_cli/flapjack-populator-contacts.json`
     Then the exit status should be 0
 
   Scenario: Importing entities
-    When I run `bin/flapjack-populator import-entities --from tmp/cucumber_cli/flapjack-populator-entities.json --config tmp/cucumber_cli/flapjack-populator.yaml`
+    When I run `bundle exec bin/flapjack -n test --config tmp/cucumber_cli/flapjack-populator.yaml import entities --from tmp/cucumber_cli/flapjack-populator-entities.json`
     Then the exit status should be 0
 
   Scenario Outline: Running an flapjack-populator import command with a missing '--from' exits uncleanly and shows usage
-    When I run `bin/flapjack-populator <Command> example.json --config tmp/cucumber_cli/flapjack-populator.yaml`
+    When I run `bundle exec bin/flapjack -n test --config tmp/cucumber_cli/flapjack-populator.yaml import <Type> example.json`
     Then the exit status should not be 0
-    And  the output should contain "No import file provided with --from"
-    And  the output should contain "Usage: flapjack-populator"
+    And  the output should contain "error: f is required"
+    And  the output should contain "Bulk import data from an external source"
     Examples:
-      | Command         |
-      | import-entities |
-      | import-contacts |
+      | Type     |
+      | entities |
+      | contacts |

data/features/cli_flapper.feature

@@ -5,40 +5,40 @@ Feature: Flapper command line
   From the command line
 
   Scenario: Running with --help shows usage information
-    When I run `bin/flapper --help`
+    When I run `bundle exec bin/flapjack flapper --help`
     Then the exit status should be 0
-    And  the output should contain "Usage: flapper"
-    And  the output should contain "-b, --bind-ip"
+    And  the output should contain "Artificial service that oscillates up and down"
+    And  the output should contain "[-b arg|--bind-ip arg]"
 
   Scenario: Starting flapper
-    When I start flapper with `flapper start --no-daemonize`
+    When I start flapper (via bundle exec) with `flapjack flapper start --no-daemonize`
     Then flapper should start within 15 seconds
 
   Scenario: Stopping flapper via SIGINT
-    When I start flapper with `flapper start --no-daemonize`
+    When I start flapper (via bundle exec) with `flapjack flapper start --no-daemonize`
     Then flapper should start within 15 seconds
     When I send a SIGINT to the flapper process
     Then flapper should stop within 15 seconds
 
   Scenario: Starting, status, and stopping flapper, daemonized
-    When I start flapper (daemonised) with `flapper start -d -p tmp/cucumber_cli/flapper_d.pid -l tmp/cucumber_cli/flapper_d.log`
+    When I start flapper (daemonised) (via bundle exec) with `flapjack flapper start -d -p tmp/cucumber_cli/flapper_d.pid -l tmp/cucumber_cli/flapper_d.log`
     Then flapper should start within 15 seconds
-    When I run `bin/flapper status -p tmp/cucumber_cli/flapper_d.pid`
+    When I run `bundle exec bin/flapjack flapper status -p tmp/cucumber_cli/flapper_d.pid`
     Then the exit status should be 0
     And  the output should contain "flapper is running"
-    When I stop flapper with `flapper stop -p tmp/cucumber_cli/flapper_d.pid`
+    When I stop flapper (via bundle exec) with `flapjack flapper stop -p tmp/cucumber_cli/flapper_d.pid`
     Then flapper should stop within 15 seconds
 
   Scenario: Starting, restarting and stopping flapper, daemonized
-    When I start flapper (daemonised) with `flapper start -d -p tmp/cucumber_cli/flapper_d.pid -l tmp/cucumber_cli/flapper_d.log`
+    When I start flapper (daemonised) (via bundle exec) with `flapjack flapper start -d -p tmp/cucumber_cli/flapper_d.pid -l tmp/cucumber_cli/flapper_d.log`
     Then flapper should start within 15 seconds
-    When I restart flapper (daemonised) with `flapper restart -d -p tmp/cucumber_cli/flapper_d.pid -l tmp/cucumber_cli/flapper_d.log`
+    When I restart flapper (daemonised) (via bundle exec) with `flapjack flapper restart -p tmp/cucumber_cli/flapper_d.pid -l tmp/cucumber_cli/flapper_d.log`
     Then flapper should restart within 15 seconds
-    When I stop flapper with `flapper stop -p tmp/cucumber_cli/flapper_d.pid`
+    When I stop flapper (via bundle exec) with `flapjack flapper stop -p tmp/cucumber_cli/flapper_d.pid`
     Then flapper should stop within 15 seconds
 
   Scenario: Getting status when stopped
-    When I run `bin/flapper status -p tmp/cucumber_cli/flapper_d.pid`
+    When I run `bundle exec bin/flapjack flapper status -p tmp/cucumber_cli/flapper_d.pid`
     Then the exit status should not be 0
     And  the output should contain "flapper is not running"
 

data/features/cli_receive-events.feature

@@ -10,18 +10,19 @@ Feature: receive-events command line
 test:
   redis:
     db: 14
+    driver: ruby
 """
 
   Scenario: Running with --help shows usage information
-    When I run `bin/receive-events --help`
+    When I run `bundle exec bin/flapjack -n test receiver mirror --help`
     Then the exit status should be 0
-    And  the output should contain "Usage: receive-events"
-    And  the output should contain "-s, --source URL"
+    And  the output should contain "replay the last COUNT events from the source"
+    And  the output should contain "-s, --source=arg"
 
   Scenario: Running receive-events with no arguments exits uncleanly and shows usage
-    When I run `bin/receive-events`
+    When I run `bundle exec bin/flapjack -n test receiver mirror`
     Then the exit status should not be 0
-    And  the output should contain "Usage: receive-events"
+    And  the output should contain "error: s is required"
 
     #TODO: put some archived events into a separate redis db and then run receive-events to suck them up
 

data/features/cli_simulate-failed-check.feature

@@ -10,21 +10,22 @@ Feature: simulate-failed-check command line
 test:
   redis:
     db: 14
+    driver: ruby
 """
 
   Scenario: Running with --help shows usage information
-    When I run `bin/simulate-failed-check --help`
+    When I run `bundle exec bin/flapjack simulate --help`
     Then the exit status should be 0
-    And  the output should contain "Usage: simulate-failed-check"
-    And  the output should contain "-k, --check CHECK"
+    And  the output should contain "Generate streams of events in various states"
+    And  the output should contain "-k arg|--check arg"
 
   Scenario: Running simulate-failed-check with no arguments exits uncleanly and shows usage
-    When I run `bin/simulate-failed-check`
+    When I run `bundle exec bin/flapjack simulate`
     Then the exit status should not be 0
-    And  the output should contain "Usage: simulate-failed-check"
+    And  the output should contain "Generate streams of events in various states"
 
   Scenario: Simulate a failed check
-    When I run `bin/simulate-failed-check fail -c tmp/cucumber_cli/simulate-failed-check.yaml -t 0 -i 0.1 -e 'test' -k 'PING'`
+    When I run `bundle exec bin/flapjack -n test -c tmp/cucumber_cli/simulate-failed-check.yaml simulate fail -t 0 -i 0.1 -e 'test' -k 'PING'`
     Then the exit status should be 0
     And  the output should contain "sending failure event"
     And  the output should contain "stopping"

data/features/steps/cli_steps.rb

@@ -11,12 +11,12 @@ Given /^a fifo named "([^"]*)" exists$/ do |fifo_name|
   create_fifo(fifo_name)
 end
 
-When /^I ((?:re)?start|stop) (\S+)( \(daemonised\))? with `(.+)`$/ do |start_stop_restart, exe, daemonise, cmd|
+When /^I ((?:re)?start|stop) (\S+)( \(daemonised\))?( \(via bundle exec\))? with `(.+)`$/ do |start_stop_restart, exe, daemonise, bundle_exec, cmd|
   @daemons_output      ||= []
   @daemons_exit_status ||= []
 
   @root = Pathname.new(File.dirname(__FILE__)).parent.parent.expand_path
-  command = "#{@root.join('bin')}/#{cmd}"
+  command = "#{bundle_exec ? 'bundle exec ' : ''}#{@root.join('bin')}/#{cmd}"
 
   # enable debugging output from spawn_process etc
   #@debug = true

data/features/support/env.rb

@@ -203,6 +203,7 @@ After('@process') do
    'tmp/cucumber_cli/flapper_d.log',
    'tmp/cucumber_cli/flapjack-populator.yaml',
    'tmp/cucumber_cli/flapjack-populator-contacts.json',
+   'tmp/cucumber_cli/flapjack-populator-entities.json',
   ].each do |file|
     next unless File.exists?(file)
     File.unlink(file)

data/flapjack.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'tzinfo-data'
   gem.add_dependency 'rbtrace'
   gem.add_dependency 'rake'
+  gem.add_dependency 'gli'
 end

data/lib/flapjack/cli/flapper.rb

@@ -0,0 +1,200 @@
+#!/usr/bin/env ruby
+
+require 'eventmachine'
+require 'socket'
+require 'dante'
+
+module Flapjack
+  module CLI
+    class Flapper
+
+      def self.local_ip
+        # turn off reverse DNS resolution temporarily
+        orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true
+
+        UDPSocket.open do |s|
+          s.connect '64.233.187.99', 1
+          s.addr.last
+        end
+      ensure
+        Socket.do_not_reverse_lookup = orig
+      end
+
+      def initialize(global_options, options)
+        @global_options = global_options
+        @options = options
+      end
+
+      def start
+        if runner.daemon_running?
+          puts "flapper is already running."
+          exit 1
+        else
+          print "flapper starting..."
+          runner.execute(:daemonize => @options[:daemonize]) do
+            main(@options['bind-ip'], @options['bind-port'].to_i, @options[:frequency])
+          end
+          puts " done."
+        end
+      end
+
+      def stop
+        if runner.daemon_running?
+          print "flapper stopping..."
+          runner.execute(:kill => true)
+          puts " done."
+        else
+          puts "flapper is not running."
+          exit 1
+        end
+      end
+
+      def restart
+        print "flapper restarting..."
+        runner.execute(:daemonize => true, :restart => true) do
+          main(@options['bind-ip'], @options['bind-port'].to_i, @options[:frequency])
+        end
+        puts " done."
+      end
+
+      def status
+        uptime = (runner.daemon_running?) ? (Time.now - File.stat(@options[:pidfile]).ctime) : 0
+        if runner.daemon_running?
+          puts "flapper is running: #{uptime}"
+        else
+          puts "flapper is not running"
+          exit 3
+        end
+      end
+
+      private
+
+      module Receiver
+        def receive_data(data)
+          send_data ">>>you sent: #{data}"
+          close_connection if data === /quit/i
+        end
+      end
+
+      def runner
+        return @runner if @runner
+
+        @runner = Dante::Runner.new('flapper', :pid_path => @options[:pidfile],
+          :log_path => @options[:logfile])
+        @runner
+      end
+
+      def main(bind_ip, bind_port, frequency)
+        raise "bind_port must be an integer" unless bind_port.is_a?(Integer) && (bind_port > 0)
+        start_every = frequency
+        stop_after  = frequency.to_f / 2
+
+        EM.run do
+
+          puts "#{Time.now}: starting server on #{bind_ip}:#{bind_port}"
+          server_init = EM.start_server bind_ip, bind_port, Flapjack::CLI::Flapper::Receiver
+          EM.add_timer(stop_after) do
+            puts "#{Time.now}: stopping server"
+            EM.stop_server(server_init)
+          end
+
+          EM.add_periodic_timer(start_every) do
+            puts "#{Time.now}: starting server on #{bind_ip}:#{bind_port}"
+            server = EM.start_server bind_ip, bind_port, Flapjack::CLI::Flapper::Receiver
+            EM.add_timer(stop_after) do
+              puts "#{Time.now}: stopping server"
+              EM.stop_server(server)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end
+
+
+desc 'Artificial service that oscillates up and down'
+command :flapper do |flapper|
+
+  flapper.desc 'start flapper'
+  flapper.command :start do |start|
+
+    start.switch [:d, 'daemonize'], :desc => 'Daemonize',
+      :default_value => true
+
+    start.flag   [:p, 'pidfile'],   :desc => 'PATH of the pidfile to write to',
+      :default_value =>  "/var/run/flapjack/flapper.pid"
+
+    start.flag   [:l, 'logfile'],   :desc => 'PATH of the logfile to write to',
+      :default_value =>  "/var/log/flapjack/flapper.log"
+
+    start.flag   [:b, 'bind-ip'],   :desc => 'ADDRESS (IPv4 or IPv6) for flapper to bind to',
+      :default_value => Flapjack::CLI::Flapper.local_ip
+
+    start.flag   [:P, 'bind-port'], :desc => 'PORT for flapper to bind to (default: 12345)',
+      :default_value => '12345'
+
+    start.flag   [:f, 'frequency'], :desc => 'oscillate with a frequency of SECONDS [120]',
+      :default_value => '120.0'
+
+    start.action do |global_options, options, args|
+      cli_flapper = Flapjack::CLI::Flapper.new(global_options, options)
+      cli_flapper.start
+    end
+  end
+
+  flapper.desc 'stop flapper'
+  flapper.command :stop do |stop|
+
+    stop.flag   [:p, 'pidfile'],   :desc => 'PATH of the pidfile to write to',
+      :default_value =>  "/var/run/flapjack/flapper.pid"
+
+    stop.flag   [:l, 'logfile'],   :desc => 'PATH of the logfile to write to',
+      :default_value =>  "/var/log/flapjack/flapper.log"
+
+    stop.action do |global_options, options, args|
+      cli_flapper = Flapjack::CLI::Flapper.new(global_options, options)
+      cli_flapper.stop
+    end
+  end
+
+  flapper.desc 'restart flapper'
+  flapper.command :restart do |restart|
+
+    restart.flag   [:p, 'pidfile'],   :desc => 'PATH of the pidfile to write to',
+      :default_value =>  "/var/run/flapjack/flapper.pid"
+
+    restart.flag   [:l, 'logfile'],   :desc => 'PATH of the logfile to write to',
+      :default_value =>  "/var/log/flapjack/flapper.log"
+
+    restart.flag   [:b, 'bind-ip'],   :desc => 'ADDRESS (IPv4 or IPv6) for flapper to bind to',
+      :default_value => Flapjack::CLI::Flapper.local_ip
+
+    restart.flag   [:P, 'bind-port'], :desc => 'PORT for flapper to bind to (default: 12345)',
+      :default_value => 12345
+
+    restart.flag   [:f, 'frequency'], :desc => 'oscillate with a frequency of SECONDS [120]',
+      :default_value => 120.0
+
+    restart.action do |global_options, options, args|
+      cli_flapper = Flapjack::CLI::Flapper.new(global_options, options)
+      cli_flapper.restart
+    end
+  end
+
+  flapper.desc 'flapper status'
+  flapper.command :status do |status|
+
+    status.flag   [:p, 'pidfile'],   :desc => 'PATH of the pidfile to write to',
+      :default_value =>  "/var/run/flapjack/flapper.pid"
+
+    status.flag   [:l, 'logfile'],   :desc => 'PATH of the logfile to write to',
+      :default_value =>  "/var/log/flapjack/flapper.log"
+
+    status.action do |global_options, options, args|
+      cli_flapper = Flapjack::CLI::Flapper.new(global_options, options)
+      cli_flapper.status
+    end
+  end
+end

data/lib/flapjack/cli/import.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+require 'oj'
+Oj.default_options = { :indent => 0, :mode => :strict }
+
+require 'redis'
+
+require 'flapjack/configuration'
+require 'flapjack/data/contact'
+require 'flapjack/data/entity'
+
+module Flapjack
+  module CLI
+    class Import
+
+      def initialize(global_options, options)
+        @global_options = global_options
+        @options = options
+
+        config = Flapjack::Configuration.new
+        config.load(global_options[:config])
+        @config_env = config.all
+
+        if @config_env.nil? || @config_env.empty?
+          puts "No config data for environment '#{FLAPJACK_ENV}' found in '#{global_options[:config]}'"
+          exit 1
+        end
+
+        @redis_options = config.for_redis
+      end
+
+      # TODO should these be similar to JSONAPI structures? e.g.
+      # {'contacts' => [CONTACT_HASH, ...]}
+
+      def contacts
+        conts = Oj.load(File.new(@options[:from]))
+
+        if conts && conts.is_a?(Enumerable) && conts.any? {|e| !e['id'].nil?}
+          conts.each do |contact|
+            unless contact['id']
+              puts "Contact not imported as it has no id: " + contact.inspect
+              next
+            end
+            Flapjack::Data::Contact.add(contact, :redis => redis)
+          end
+        end
+
+      end
+
+      def entities
+        ents = Oj.load(File.new(@options[:from]))
+
+        if ents && ents.is_a?(Enumerable) && ents.any? {|e| !e['id'].nil?}
+          ents.each do |entity|
+            unless entity['id']
+              puts "Entity not imported as it has no id: " + entity.inspect
+              next
+            end
+            Flapjack::Data::Entity.add(entity, :redis => redis)
+          end
+        end
+
+      end
+
+      private
+
+      def redis
+        @redis ||= Redis.new(@redis_options)
+      end
+
+    end
+  end
+end
+
+desc 'Bulk import data from an external source'
+command :import do |import|
+
+  import.desc 'Import contacts'
+  import.command :contacts do |contacts|
+
+    contacts.flag [:f, 'from'],     :desc => 'PATH of the contacts JSON file to import',
+      :required => true
+
+    contacts.action do |global_options,options,args|
+      import = Flapjack::CLI::Import.new(global_options, options)
+      import.contacts
+    end
+  end
+
+  import.desc 'Import entities'
+  import.command :entities do |entities|
+
+    entities.flag [:f, 'from'],     :desc => 'PATH of the entities JSON file to import',
+      :required => true
+
+    entities.action do |global_options,options,args|
+      import = Flapjack::CLI::Import.new(global_options, options)
+      import.entities
+    end
+  end
+
+end