flapjack 0.5.1 → 0.5.3

data/spec/notifier_options_spec.rb

@@ -0,0 +1,115 @@
+##!/usr/bin/env ruby 
+##
+#require File.join(File.dirname(__FILE__), '..', 'lib', 'flapjack', 'cli', 'notifier')
+#
+#describe Flapjack::Notifier::Options do 
+# 
+#  # beanstalk
+#  it "should accept the location of a beanstalk queue in short form" do 
+#    args = %w(-b localhost -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.host.should == "localhost"
+#  end
+#  
+#  it "should accept the location of a beanstalk queue in long form" do 
+#    args = %w(--beanstalk localhost -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.host.should == "localhost"
+#  end
+#
+#  it "should set a default beanstalk host" do 
+#    args = %w(-r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.host.should == 'localhost'
+#  end
+#
+#  # beanstalk port
+#  it "should accept a specified beanstalk port in short form" do 
+#    args = %w(-b localhost -p 11340 -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.port.should == 11340
+#  end
+#  
+#  it "should accept a specified beanstalk port in long form" do 
+#    args = %w(-b localhost --port 11399 -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.port.should == 11399
+#  end
+#
+#  it "should set a default beanstalk port" do 
+#    args = %w(-b localhost -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.port.should == 11300
+#  end
+#
+#  # recipients
+#  it "should accept the location of a recipients file in short form" do 
+#    args = %w(-b localhost -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.recipients.should == "spec/recipients.yaml"
+#  end
+#  
+#  it "should accept the location of a recipients file in long form" do 
+#    args = %w(-b localhost --recipient spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.recipients.should == "spec/recipients.yaml"
+#  end
+#
+#  it "should exit if the recipients file doesn't exist" do 
+#    args = %w(-b localhost -r spec/wangity.yaml -c spec/flapjack-notifier.yaml)
+#    lambda { 
+#      Flapjack::Notifier::Options.parse(args) 
+#    }.should raise_error(SystemExit)
+#  end
+#
+#  it "should exit if the recipients file isn't specified" do 
+#    args = %w(-b localhost -c spec/flapjack-notifier.yaml)
+#    lambda { 
+#      Flapjack::Notifier::Options.parse(args) 
+#    }.should raise_error(SystemExit)
+#  end
+#
+#  # config 
+#  it "should accept the location of a config file in short form" do 
+#    args = %w(-b localhost -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.config_filename.should == "spec/flapjack-notifier.yaml"
+#  end
+#
+#  it "should accept the location of a config file in long form" do 
+#    args = %w(-b localhost -r spec/recipients.yaml --config spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.config_filename.should == "spec/flapjack-notifier.yaml"
+#  end
+#
+#  it "should provide a default config file if not specified" do 
+#    args = %w(-b localhost -r spec/recipients.yaml -c spec/flapjack-notifier.yaml)
+#    options = Flapjack::Notifier::Options.parse(args)
+#    options.config_filename.should_not be_nil
+#  end
+#
+#  it "should exit if the config file doesn't exist" do 
+#    args = %w(-b localhost --config spec/wangity.yaml)
+#    lambda { 
+#      Flapjack::Notifier::Options.parse(args) 
+#    }.should raise_error(SystemExit)
+#  end
+#
+#  # general
+#  it "should exit when asked for help in short form" do 
+#    args = %w(-h)
+#    lambda { 
+#      Flapjack::Notifier::Options.parse(args) 
+#    }.should raise_error(SystemExit)
+#  end
+#
+#  it "should exit when asked for help in long form" do 
+#    args = %w(--help)
+#    lambda { 
+#      Flapjack::Notifier::Options.parse(args) 
+#    }.should raise_error(SystemExit)
+#  end
+#end
+#
+#
+#def puts(*args) ; end

data/spec/notifier_spec.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'flapjack', 'notifier_engine')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'flapjack', 'transports', 'result')
+require File.join(File.dirname(__FILE__), 'helpers')
+
+describe "running the notifier" do 
+ 
+  before(:each) do 
+  end
+ 
+  it "should complain if no logger has been specified" do 
+    lambda {
+      n = Flapjack::NotifierEngine.new
+    }.should raise_error(RuntimeError)
+  end
+  
+  it "should warn if no notifiers have been specified" do 
+    n = Flapjack::NotifierEngine.new(:log => MockLogger.new)
+    n.log.messages.last.should =~ /no notifiers/
+  end
+
+  it "should log when adding a new notifier" do
+    mock_notifier = mock("MockFlapjack::NotifierEngine")
+    n = Flapjack::NotifierEngine.new(:log => MockLogger.new, 
+                     :notifiers => [mock_notifier])
+    n.log.messages.last.should =~ /using the (.+) notifier/
+  end
+
+  it "should call notify on each notifier when notifying" do 
+    mock_notifier = mock("MockFlapjack::NotifierEngine")
+    mock_notifier.should_receive(:notify)
+
+    result = Flapjack::Transport::Result.new(:result => {:check_id => 12345})
+
+    n = Flapjack::NotifierEngine.new(:log => MockLogger.new, 
+                                     :notifiers => [mock_notifier])
+    n.notify!(:result => result, 
+              :event => true, 
+              :recipients => [OpenStruct.new({:name => "John Doe"})])
+  end
+
+  it "should log notification on each notifier" do 
+    mock_notifier = mock("MockFlapjack::NotifierEngine")
+    mock_notifier.stub!(:notify)
+
+    result = Flapjack::Transport::Result.new(:result => {:check_id => 12345})
+
+    n = Flapjack::NotifierEngine.new(:log => MockLogger.new, 
+                                     :notifiers => [mock_notifier])
+    n.notify!(:result => result, 
+              :event => true,
+              :recipients => [OpenStruct.new({:name => "John Doe"})])
+    n.log.messages.last.should =~ /12345/
+    n.log.messages.last.should =~ /John Doe/
+  end
+end
+
+

data/spec/notifiers/mailer_spec.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'flapjack', 'notifiers', 'mailer', 'init')
+require File.join(File.dirname(__FILE__), '..', 'helpers')
+
+describe "mailing notifier" do 
+
+  it "should error if no from address is provided" do 
+    lambda {
+      mailer = Flapjack::Notifiers::Mailer.new(:log => MockLogger.new)
+    }.should raise_error(ArgumentError, /from address/)
+  end
+
+  it "should error if no recipient is provided" do
+    mailer = Flapjack::Notifiers::Mailer.new(:from_address => "test@example.org")
+    lambda {
+      mailer.notify()
+    }.should raise_error(ArgumentError, /recipient/)
+  end
+
+  it "should error if no result is provided" do
+    mailer = Flapjack::Notifiers::Mailer.new(:from_address => "test@example.org")
+    lambda {
+      mailer.notify(:who => 'foo')
+    }.should raise_error(ArgumentError, /result/)
+  end
+
+  it "should deliver mail to a recipient" do 
+    mailer = Flapjack::Notifiers::Mailer.new(:from_address => "test@example.org")
+    response = mailer.notify(:who => OpenStruct.new(:email => "nobody@example.org"), 
+                             :result => OpenStruct.new(:id => 11, :status => 2, :output => "foo"))
+    response.status.should == '250'
+  end
+
+  it "should have a configurable server to send through"
+end
+
+

data/spec/notifiers/xmpp_spec.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'flapjack', 'notifiers', 'xmpp', 'init')
+require File.join(File.dirname(__FILE__), '..', 'helpers')
+
+describe "xmpp notifier" do 
+
+  it "should error if no login details provided" do 
+    lambda {
+      xmpp = Flapjack::Notifiers::Xmpp.new
+    }.should raise_error(ArgumentError)
+  end
+
+  it "should error if no recipient is provided" do
+    xmpp = Flapjack::Notifiers::Xmpp.new(:jid => "5b73a016c5c644e9bf1601a241fc27f5@jabber.org", :password => "5b73a016c5c644e9bf1601a241fc27f5")
+    lambda {
+      xmpp.notify(:result => 'foo')
+    }.should raise_error(ArgumentError, /recipient/)
+  end
+
+  it "should error if no result is provided" do
+    xmpp = Flapjack::Notifiers::Xmpp.new(:jid => "5b73a016c5c644e9bf1601a241fc27f5@jabber.org", :password => "5b73a016c5c644e9bf1601a241fc27f5")
+    lambda {
+      xmpp.notify(:who => 'foo')
+    }.should raise_error(ArgumentError, /result/)
+  end
+
+  it "should deliver message to a recipient" do 
+    xmpp = Flapjack::Notifiers::Xmpp.new(:jid => "5b73a016c5c644e9bf1601a241fc27f5@jabber.org", :password => "5b73a016c5c644e9bf1601a241fc27f5")
+    lambda {
+      response = xmpp.notify(:who => OpenStruct.new(:jid => "5b73a016c5c644e9bf1601a241fc27f5@jabber.org"), 
+                             :result => OpenStruct.new(:id => 11, :status => 2, :output => "foo"))
+    }.should_not raise_error
+  end
+
+end
+
+

data/spec/persistence/datamapper_spec.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby 
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'flapjack', 'applications', 'notifier')
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'flapjack', 'persistence', 'data_mapper')
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'flapjack', 'transports', 'result')
+require File.join(File.dirname(__FILE__), '..', 'helpers')
+require 'tmpdir'
+
+describe "datamapper persistence backend" do 
+
+  it "should query its parent's statuses" do
+    backend_options = { :uri => "sqlite3://#{Dir.mktmpdir}/flapjack.db", :log => MockLogger.new }
+    DataMapper.setup(:default, backend_options[:uri])
+    DataMapper.auto_migrate!
+
+    bad = Check.new(:command => "exit 1", :name => "bad")
+    bad.save.should be_true
+
+    good = Check.new(:command => "exit 0", :name => "good")
+    good.save.should be_true
+
+    relation = RelatedCheck.new(:parent_check => bad, :child_check => good)
+    relation.save.should be_true
+
+    # the bad check doesn't have failing parents
+    raw_result = {:check_id => bad.id, :retval => 2}
+    result = Flapjack::Transport::Result.new(:result => raw_result)
+
+    backend = Flapjack::Persistence::DataMapper.new(backend_options)
+    backend.any_parents_failed?(result).should be_false
+
+    bad.status = 2
+    bad.save
+    
+    # the good check has a failing parent (bad)
+    raw_result = {:check_id => good.id, :retval => 0}
+    result = Flapjack::Transport::Result.new(:result => raw_result)
+    backend.any_parents_failed?(result).should be_true
+  end
+
+  it "should persist a result" do 
+    backend_options = { :uri => "sqlite3://#{Dir.mktmpdir}/flapjack.db", :log => MockLogger.new }
+    DataMapper.setup(:default, backend_options[:uri])
+    DataMapper.auto_migrate!
+    
+    backend = Flapjack::Persistence::DataMapper.new(backend_options)
+
+    check = Check.new(:command => "exit 0", :name => "good")
+    check.save.should be_true
+
+    raw_result = {:check_id => check.id, :retval => 2}
+    result = Flapjack::Transport::Result.new(:result => raw_result)
+
+    backend.save(result).should be_true
+  end
+
+  it "should create an event" do 
+    backend_options = { :uri => "sqlite3://#{Dir.mktmpdir}/flapjack.db", :log => MockLogger.new }
+    DataMapper.setup(:default, backend_options[:uri])
+    DataMapper.auto_migrate!
+    
+    backend = Flapjack::Persistence::DataMapper.new(backend_options)
+
+    check = Check.new(:command => "exit 0", :name => "good")
+    check.save.should be_true
+
+    raw_result = {:check_id => check.id, :retval => 2}
+    result = Flapjack::Transport::Result.new(:result => raw_result)
+
+    backend.create_event(result).should be_true
+  end
+
+end
+

data/spec/persistence/mock_persistence_backend.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby 
+
+
+module Flapjack
+  module Persistence
+    class MockPersistenceBackend
+      def initialize(options={})
+        @options = options
+        @config = OpenStruct.new(@options)
+        @queue = []
+        @log = @config.log
+      end
+
+      # log if the method is called (essentially, these are dodgy mocks)
+      %w(any_parents_failed? save create_event).each do |method|
+        class_eval <<-HERE
+          def #{method}(*args)
+            @log.info("method #{method} was called on MockPersistenceBackend")
+          end
+        HERE
+      end
+    
+    end
+  end
+end
+

data/spec/simple.ini

@@ -0,0 +1,6 @@
+[forks]
+hello = world
+[spoons]
+foo = bar
+[splades]
+bar = baz

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--color
+--format
+progress
+--diff

data/spec/test-filters/blocker.rb

@@ -0,0 +1,13 @@
+module Flapjack
+  module Filters
+    class Blocker
+      def initialize(opts={})
+        @log = opts[:log]
+      end
+
+      def block?(result)
+        true
+      end
+    end
+  end
+end

data/spec/test-filters/mock.rb

@@ -0,0 +1,13 @@
+module Flapjack
+  module Filters
+    class Mock
+      def initialize(opts={})
+        @log = opts[:log]
+      end
+
+      def block?(result)
+        false
+      end
+    end
+  end
+end

data/spec/transports/beanstalkd_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'flapjack', 'applications', 'notifier')
+require File.join(File.dirname(__FILE__), '..', 'helpers')
+require 'beanstalk-client'
+
+describe "notifier application" do 
+
+  before(:each) do
+    lambda {
+      begin
+        @beanstalk = Beanstalk::Connection.new('localhost:11300', 'results')
+      rescue => e
+        # give helpful error messages to people unfamiliar with the test suite
+        puts
+        puts "You need to have an instance of beanstalkd running locally to run these tests!"
+        puts
+        raise
+      end
+    }.should_not raise_error
+  end
+
+  it "should handle good, bad, and ugly test result" do 
+    [ {:output => "", :id => 1, :retval => 0},
+      {:output => "", :id => 2, :retval => 1},
+      {:output => "", :id => 3, :retval => 2} ].each do |result|
+      @beanstalk.yput(result)
+    end
+
+    options = { :notifiers => {},
+                :filters => [],
+                :log => MockLogger.new,
+                :transport => {:backend => :beanstalkd},
+                :persistence => {:backend => :mock_persistence_backend,                                                                    
+                                   :basedir => File.join(File.dirname(__FILE__), '..', 'persistence')}} 
+    app = Flapjack::Notifier::Application.run(options)
+
+    3.times do |n|
+      lambda {
+        app.process_result
+      }.should_not raise_error
+    end
+  end
+
+end
+

data/spec/transports/mock_transport.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby 
+
+
+module Flapjack
+  module Transport
+    class MockTransport
+      def initialize(options={})
+        @options = options
+        @config = OpenStruct.new(@options)
+        @queue = []
+        @log = @config.log
+      end
+
+      %w(delete put).each do |method|
+        class_eval <<-HERE
+          def #{method}(*args)
+            @log.info("method #{method} was called on MockTransport")
+          end
+        HERE
+      end
+
+      # exactly the same as above, just returns a real object
+      def next
+        @log.info("method next was called on MockTransport")
+        MockResult.new(@options)
+      end
+
+
+    end
+  end
+end
+
+module Flapjack
+  module Transport
+    class MockResult
+      def initialize(options={})
+        @options = options
+        @config = OpenStruct.new(@options)
+        @log = @config.log
+      end
+
+      # log if the method is called (essentially, these are dodgy mocks)
+      %w(warning? critical? any_parents_failed? save check_id frequency).each do |method|
+        class_eval <<-HERE
+          def #{method}(*args)
+            @log.info("method #{method} was called on MockResult")
+          end
+        HERE
+      end
+
+      # exactly the same as above, just returns a real object
+      def command(*args)
+        @log.info("method command was called on MockResult")
+        "echo foo"
+      end
+    end
+  end
+end