flapjack 0.8.11 → 0.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20501028ceb91b915d143e9d9343fae832db8e1c
-  data.tar.gz: b2d975287acd597e04f148f589c76ed067832665
+  metadata.gz: c12d1908e4d17b6184593f91b1208c20cff78bcd
+  data.tar.gz: c3975b071f0b015ad7a2f0728430cdb4b5411751
 SHA512:
-  metadata.gz: 051d4c2f9f58b9b57a45105a10c7cd64353c2a3c485b53a57a8bcc54f7546ed36058a50dfcb52a663413ffc2f8d5c955651a5cb554a48ea276b073eb93345409
-  data.tar.gz: ea18f80815f9172ca9a0f3f2021934b9f38d5da6cec030c0f27ad493dec8178ef40120f3004a898adfe50f6a1df22b0ac89c45a8a6492110694f02d2c5986e8f
+  metadata.gz: 71d0bcbb7e4317817dbadd673ebb719f8c07afd3b73d0daac58610f5774b1c653cbac43443020bc319abd98d40a1031d3273c6904557bc9cc8ad3f896042eccb
+  data.tar.gz: 756fb36155e507f440464f4e1841db59e43e5eff0c468579d208d19d4f2a45cf84494077f20ad685a82aa23807a364ddc26cfb655673cf2454e9e63721c1ffab

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## Flapjack Changelog
 
+# 0.8.12 - 2014-05-21
+- Feature: highlight the section that I'm in #483 (@auxesis)
+- Feature: Visualise the event queue length on self stats page #482 (@auxesis)
+- Feature: Restructure backbone /edit_contacts UI (and backend file structure), fix remaining usage issues #515 (@ali-graham)
+- Bug: pagerduty gateway exception when subdomain not set #486 (@jessereynolds)
+- Bug: tests use default redis port #495 (@spazm)
+- Bug: GET /notification_rules doesn't work #510 (@ali-graham)
+- Bug: JSONAPI -- do not emit entities without ids #521 (@ali-graham)
+- Bug: PATCHing blackhole properties for notification rule changes other blackholes #504 (@ali-graham)
+- Chore: updated github urls to use new flapjack project name #491 (@spazm)
+- Chore: Add a CONTRIBUTING.md doc for potential helpers #492 (@spazm)
+
+
 # 0.8.11 - 2014-05-01
 - Feature: simulate-failed-check - give -t a default of 45 seconds (@jessereynolds)
 - Feature: allow email messages to have custom from address #468 (@mattdelves)

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+#Contributing to ![Flapjack](https://raw.github.com/flapjack/flapjack/gh-pages/images/flapjack-2013-notext-transparent-50-50.png "Flapjack") Flapjack
+
+[![Build Status](https://travis-ci.org/flapjack/flapjack.png)](https://travis-ci.org/flapjack/flapjack)
+
+Please see the [Contributing to Flapjack](https://github.com/flapjack/flapjack/wiki/DEVELOPING) section of the Flapjack wiki.
+
+> Flapjack is, and will continue to be, well tested. Monitoring is like continuous integration for production apps, so why shouldn't your monitoring system have tests?
+
+## Quick Start
+
+1. clone the repo
+
+        git clone https://github.com/flapjack/flapjack.git
+
+2. install development dependencies with bundler:
+
+        cd flapjack
+        gem install bundler
+        bundle install
+
+3. install redis
+4. run unit tests
+
+        rake spec
+
+5. run integration tests
+
+        rake features
+
+6. code coverage for tests
+
+        COVERAGE=x rake spec
+        COVERAGE=x rake features
+
+7. make changes with tests, send a [pull request](https://help.github.com/articles/creating-a-pull-request), share love!

data/Gemfile

@@ -20,6 +20,6 @@ group :test do
   gem 'guard-cucumber'
   gem 'fuubar'
   gem 'simplecov', :require => false
-  gem 'debugger-ruby_core_source', '>= 1.3.2' # required for perftools
+  gem 'debugger-ruby_core_source', '>= 1.3.4' # required for perftools
   gem 'perftools.rb'
 end

data/README.md

@@ -1,6 +1,6 @@
-# ![Flapjack](https://raw.github.com/flpjck/flapjack/gh-pages/images/flapjack-2013-notext-transparent-50-50.png "Flapjack") Flapjack
+# ![Flapjack](https://raw.github.com/flapjack/flapjack/gh-pages/images/flapjack-2013-notext-transparent-50-50.png "Flapjack") Flapjack
 
-[![Build Status](https://travis-ci.org/flpjck/flapjack.png)](https://travis-ci.org/flpjck/flapjack)
+[![Build Status](https://travis-ci.org/flapjack/flapjack.png)](https://travis-ci.org/flapjack/flapjack)
 
 [Flapjack](http://flapjack.io/) is a flexible monitoring notification routing system that handles:
 
@@ -71,11 +71,13 @@ gem install flapjack
 
 Using a tool like [rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/) is recommended to keep your Ruby applications from intefering with one another.
 
-Alternatively, you can add support for your OS of choice to [omnibus-flapjack](https://github.com/flpjck/omnibus-flapjack) and build a native package. Pull requests welcome, and we'll help you make this happen!
+Alternatively, you can add support for your OS of choice to [omnibus-flapjack](https://github.com/flapjack/omnibus-flapjack) and build a native package. Pull requests welcome, and we'll help you make this happen!
+
+You'll also need Redis >= 2.6.12.
 
 ## Configuring
 
-Have a look at the default config file and modify things as required. See the [Configuring Components](https://github.com/flpjck/flapjack/wiki/USING#wiki-configuring_components) section on the wiki for more details.
+Have a look at the default config file and modify things as required. See the [Configuring Components](https://github.com/flapjack/flapjack/wiki/USING#wiki-configuring_components) section on the wiki for more details.
 
 ``` bash
 # hack the config
@@ -122,11 +124,11 @@ sudo /etc/init.d/flapjack start
 
 ## Using - Details
 
-For more information, including full specification of the configuration file and the data import formats, please refer to the [USING](https://github.com/flpjck/flapjack/wiki/USING) section of the Flapjack wiki
+For more information, including full specification of the configuration file and the data import formats, please refer to the [USING](https://github.com/flapjack/flapjack/wiki/USING) section of the Flapjack wiki
 
 ## Developing Flapjack
 
-Information on developing more Flapjack components or contributing to core Flapjack development can be found in the [DEVELOPING](https://github.com/flpjck/flapjack/wiki/DEVELOPING) section of the Flapjack wiki
+Information on developing more Flapjack components or contributing to core Flapjack development can be found in the [DEVELOPING](https://github.com/flapjack/flapjack/wiki/DEVELOPING) section of the Flapjack wiki
 
 ## Documentation Submodule
 
@@ -145,14 +147,14 @@ If you make changes to the documentation locally, here's how to publish them:
 
 ## More on the wiki
 
-[The Flapjack wiki](https://github.com/flpjck/flapjack/wiki) has even more goodies:
+[The Flapjack wiki](https://github.com/flapjack/flapjack/wiki) has even more goodies:
 
-- [Using Flapjack](https://github.com/flpjck/flapjack/wiki/USING)
-- [Developing Flapjack](https://github.com/flpjck/flapjack/wiki/DEVELOPING)
-- [Redis Data Structure](https://github.com/flpjck/flapjack/wiki/DATA_STRUCTURES)
-- [API](https://github.com/flpjck/flapjack/wiki/API)
-- [Importing](https://github.com/flpjck/flapjack/wiki/IMPORTING)
-- [Debugging Flapjack](https://github.com/flpjck/flapjack/wiki/DEBUGGING)
-- [Flapjack Glossary](https://github.com/flpjck/flapjack/wiki/GLOSSARY)
+- [Using Flapjack](https://github.com/flapjack/flapjack/wiki/USING)
+- [Developing Flapjack](https://github.com/flapjack/flapjack/wiki/DEVELOPING)
+- [Redis Data Structure](https://github.com/flapjack/flapjack/wiki/DATA_STRUCTURES)
+- [API](https://github.com/flapjack/flapjack/wiki/API)
+- [Importing](https://github.com/flapjack/flapjack/wiki/IMPORTING)
+- [Debugging Flapjack](https://github.com/flapjack/flapjack/wiki/DEBUGGING)
+- [Flapjack Glossary](https://github.com/flapjack/flapjack/wiki/GLOSSARY)
 
 

data/bin/flapjack-feed-events

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+unless $:.include?(File.dirname(__FILE__) + '/../lib/')
+  $: << File.dirname(__FILE__) + '/../lib'
+end
+
+require 'optparse'
+require 'ostruct'
+require 'redis'
+require 'oj'
+
+require 'flapjack/configuration'
+require 'flapjack/data/event'
+
+exe = File.basename(__FILE__)
+
+options = OpenStruct.new
+options.config = Flapjack::Configuration::DEFAULT_CONFIG_PATH
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{exe} [OPTIONS]"
+
+  opts.separator  ""
+  opts.separator  "Feed JSON blobs from file or STDIN into the Flapjack event queue."
+  opts.separator  ""
+  opts.separator  "Options"
+
+  opts.on("-c", "--config [PATH]", String, "PATH to the config file to use.") do |c|
+    options.config = c
+  end
+
+  opts.on("-f", "--from [FILE]", String, "path to the FILE to process; if not provided, defaults to STDIN.") do |f|
+    options.from = f
+  end
+end
+optparse.parse!(ARGV)
+
+bail_with_usage = proc do |message|
+  puts message
+  puts "\n#{optparse}"
+  exit(false)
+end
+
+if options.help
+  puts optparse
+  exit
+elsif options.version
+  puts Flapjack::VERSION
+  exit
+end
+
+FLAPJACK_ENV = ENV['FLAPJACK_ENV'] || 'production'
+config = Flapjack::Configuration.new
+config.load(options.config)
+config_env = config.all
+if config_env.nil? || config_env.empty?
+  puts "No config data for environment '#{FLAPJACK_ENV}' found in '#{options.config}'"
+  exit(false)
+end
+redis = Redis.new(config.for_redis)
+
+input = if options.from
+          File.open(options.from) # Explodes if file does not exist.
+        else
+          bail_with_usage.call("No file provided, and STDIN is from terminal! Exiting...") if $stdin.tty?
+          $stdin
+        end
+
+# Sit and churn through the input stream until a valid JSON blob has been assembled.
+# This handles both the case of a process sending a single JSON and then exiting
+# (eg. cat foo.json | bin/flapjack-feed-event) *and* a longer-running process spitting
+# out events (eg. /usr/bin/slow-event-feed | bin/flapjack-feed-event)
+
+class EventFeedHandler < Oj::ScHandler
+
+  def initialize(&block)
+    @hash_depth = 0
+    @callback = block if block_given?
+  end
+
+  def hash_start
+    @hash_depth += 1
+    Hash.new
+  end
+
+  def hash_end
+    @hash_depth -= 1
+  end
+
+  def array_start
+    Array.new
+  end
+
+  def array_end
+  end
+
+  def add_value(value)
+    @callback.call(value) if @callback
+    nil
+  end
+
+  def hash_set(hash, key, value)
+    hash[key] = value
+  end
+
+  def array_append(array, value)
+    array << value
+  end
+
+end
+
+parser = EventFeedHandler.new do |parsed|
+  # Handle "parsed" (a hash)
+  errors = Flapjack::Data::Event.validation_errors_for_hash(parsed)
+  if errors.empty?
+    Flapjack::Data::Event.add(parsed, :redis => redis)
+    puts "Enqueued event data, #{parsed.inspect}"
+  else
+    puts "Invalid event data received, #{errors.join(', ')} #{parsed.inspect}"
+  end
+end
+
+Oj.sc_parse(parser, input)
+
+puts "Done."

data/bin/flapjack-nagios-receiver

@@ -140,7 +140,7 @@ nagios.cfg changes:
   host_perfdata_file_mode=p
   service_perfdata_file_mode=p
 
-Details on the wiki: https://github.com/flpjck/flapjack/wiki/USING#configuring-nagios
+Details on the wiki: https://github.com/flapjack/flapjack/wiki/USING#configuring-nagios
 '
 
     exit

data/bin/flapjack-nsca-receiver

@@ -138,7 +138,7 @@ in the configfile:
 The Nsca daemon is optionally writing to a tempfile if the named pipe does
 not exist.
 
-Details on the wiki: https://github.com/flpjck/flapjack/wiki/USING#XXX
+Details on the wiki: https://github.com/flapjack/flapjack/wiki/USING#XXX
 '
 
     exit

data/etc/flapjack_config.yaml.example

@@ -291,5 +291,4 @@ development:
 
 test:
   redis:
-    database: 14
-
+    db: 14

data/features/cli_flapjack-feed-events.feature

@@ -0,0 +1,104 @@
+@process
+Feature: flapjack-feed-events command line
+  As a systems administrator
+  I should be able to use flapjack-feed-events
+  From the command line
+
+  Background:
+    Given a file named "flapjack-feed-events.yaml" with:
+"""
+test:
+  redis:
+    db: 14
+"""
+
+  Scenario: Running with --help shows usage information
+    When I run `bin/flapjack-feed-events --help`
+    Then the exit status should be 0
+    And  the output should contain "Usage: flapjack-feed-events"
+    And  the output should contain "-c, --config"
+    And  the output should contain "-f, --from"
+
+  Scenario: Running flapjack-feed-events with no arguments and no STDIN fails with a warning
+    When I run `bin/flapjack-feed-events -c tmp/cucumber_cli/flapjack-feed-events.yaml`
+    And  the output should contain "No file provided, and STDIN is from terminal! Exiting..."
+    And  the output should contain "Usage: flapjack-feed-events"
+    Then the exit status should be 1
+
+
+  Scenario: Feed a single event into the events queue
+    Given a file named "single-event.json" with:
+"""
+{
+  "entity": "client1-localhost-test-1",
+  "check": "foo",
+  "type": "service",
+  "state": "ok",
+  "summary": "testing"
+}
+"""
+    When I run `cat tmp/cucumber_cli/single-event.json | bin/flapjack-feed-events -c tmp/cucumber_cli/flapjack-feed-events.yaml`
+    Then the exit status should be 0
+    And  the output should not contain "Invalid event data received"
+    And  the output should contain "Enqueued event data, "
+    And  the output should contain "client1-localhost-test-1"
+    And  the output should contain "Done."
+
+    When I run `bin/flapjack-feed-events -c tmp/cucumber_cli/flapjack-feed-events.yaml -f tmp/cucumber_cli/single-event.json`
+    Then the exit status should be 0
+    And  the output should not contain "Invalid event data received"
+    And  the output should contain "Enqueued event data, "
+    And  the output should contain "client1-localhost-test-1"
+    And  the output should contain "Done."
+
+
+  Scenario: Feed multiple events into the events queue
+    Given a file named "multiple-events.json" with:
+"""
+{"entity": "client1-localhost-test-1", "check": "foo",
+  "type": "service", "state": "ok", "summary": "testing"}
+{"entity": "client1-localhost-test-2",
+  "check": "bar", "type": "service", "state": "ok", "summary":
+  "testing"
+  }
+"""
+    When I run `cat tmp/cucumber_cli/multiple-events.json | bin/flapjack-feed-events -c tmp/cucumber_cli/flapjack-feed-events.yaml`
+    Then the exit status should be 0
+    And  the output should not contain "Invalid event data received"
+    And  the output should contain "Enqueued event data, "
+    And  the output should contain "client1-localhost-test-1"
+    And  the output should contain "client1-localhost-test-2"
+    And  the output should contain "Done."
+
+    When I run `bin/flapjack-feed-events -c tmp/cucumber_cli/flapjack-feed-events.yaml -f tmp/cucumber_cli/multiple-events.json`
+    Then the exit status should be 0
+    And  the output should not contain "Invalid event data received"
+    And  the output should contain "Enqueued event data, "
+    And  the output should contain "client1-localhost-test-1"
+    And  the output should contain "client1-localhost-test-2"
+    And  the output should contain "Done."
+
+  Scenario: Feed invalid events into the events queue
+    Given a file named "invalid-events.json" with:
+"""
+{"entity": "client1-localhost-test-1"}
+{"entity": "client1-localhost-test-2", "check": "bar"}
+"""
+    When I run `cat tmp/cucumber_cli/invalid-events.json | bin/flapjack-feed-events -c tmp/cucumber_cli/flapjack-feed-events.yaml`
+    Then the exit status should be 0
+    And  the output should not contain "Enqueued event data, "
+    And  the output should contain "Invalid event data received"
+    And  the output should contain "client1-localhost-test-1"
+    And  the output should contain "client1-localhost-test-2"
+    And  the output should contain "Done."
+
+  Scenario: Feed invalid JSON into the events queue
+    Given a file named "invalid-json.json" with:
+"""
+{"entity": "client1-localhost-test-1"
+{"entity": "client1-localhost-test-2", "check": "bar"}
+"""
+    When I run `cat tmp/cucumber_cli/invalid-json.json | bin/flapjack-feed-events -c tmp/cucumber_cli/flapjack-feed-events.yaml`
+    Then the exit status should be 1
+    And  the output should not contain "Enqueued event data, "
+    And  the output should contain "(Oj::ParseError)"

data/features/steps/events_steps.rb

@@ -145,8 +145,8 @@ end
 
 def icecube_schedule_to_time_restriction(sched, time_zone)
   tr = sched.to_hash
-  tr[:start_time] = time_zone.utc_to_local(tr[:start_date][:time]).strftime "%Y-%m-%d %H:%M:%S"
-  tr[:end_time]   = time_zone.utc_to_local(tr[:end_time][:time]).strftime "%Y-%m-%d %H:%M:%S"
+  tr[:start_time] = {:time => time_zone.utc_to_local(tr[:start_time][:time]).strftime("%Y-%m-%d %H:%M:%S"), :zone => time_zone}
+  tr[:end_time]   = {:time => time_zone.utc_to_local(tr[:end_time][:time]).strftime("%Y-%m-%d %H:%M:%S"), :zone => time_zone}
 
   # rewrite IceCube::WeeklyRule to Weekly, etc
   tr[:rrules].each {|rrule|

data/features/steps/packaging-lintian_steps.rb

@@ -24,6 +24,6 @@ Then /^the exit status should( not)? be (\d+)$/ do |negativity, number|
   expect(@exit_status).send(negativity ? :not_to : :to, eq(number.to_i))
 end
 
-Then /^the output should contain "([^"]*)"$/ do |matcher|
-  expect(@output).to include(matcher)
+Then /^the output should( not)? contain "([^"]*)"$/ do |negativity, matcher|
+  expect(@output).send(negativity ? :not_to : :to, include(matcher))
 end

data/features/support/env.rb

@@ -5,6 +5,7 @@ require 'delorean'
 require 'chronic'
 require 'active_support/time'
 require 'ice_cube'
+require 'flapjack/configuration'
 require 'flapjack/data/entity_check'
 require 'flapjack/data/event'
 
@@ -23,6 +24,8 @@ end
 
 ENV["FLAPJACK_ENV"] = 'test'
 FLAPJACK_ENV = 'test'
+FLAPJACK_ROOT   = File.join(File.dirname(__FILE__), '..', '..')
+FLAPJACK_CONFIG = File.join(FLAPJACK_ROOT, 'etc', 'flapjack_config.yaml')
 
 $: << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 
@@ -119,7 +122,10 @@ EXPIRE_AS_IF_AT
 
 end
 
-redis_opts = { :db => 14, :driver => :ruby }
+config = Flapjack::Configuration.new
+redis_opts = config.load(FLAPJACK_CONFIG) ?
+             config.for_redis :
+             {:db => 14, :driver => :ruby}
 redis = ::Redis.new(redis_opts)
 redis.flushdb
 RedisDelorean.before_all(:redis => redis)