flapjack 1.6.0 → 2.0.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73fab84ec6ecf9809883faab9ae7e91ae1828736
-  data.tar.gz: d00319c07b1545b497b5ef455069246cac6ead6f
+  metadata.gz: 6f80bd12fd052bc57f9cbb1bc686cd4486c13048
+  data.tar.gz: 4dfd2c65ce37dc1c1029eba4163c918eb301fc46
 SHA512:
-  metadata.gz: c2e8bfb77b5aa4dd0527fa1a923a610e2bc66c2fb8e2a6c22939bc11587ddc8640667662945188d3055bbf653a37edd24270ee978e4271a5b9edd8b7ba7f59c0
-  data.tar.gz: 674559686c725b96dc75f250f024e0811ca00117f107c7a02c52462a582f135f05ca082a049335a5f239c83d0a3d338d41cdda6c7d8d0c9b66698f95f1fb60b0
+  metadata.gz: 77963f6d58d2068d582dc361cc9c9bc1d0533f28cf63a81e3c6ebcde341277cf5dd6d26f74f70a4045f492f0069a02e079009f77f867c003bf1d98098d07a5fb
+  data.tar.gz: cc105efea7c53645be8fe33b38868bcc9d9a051e1d0498fce0208621a0187ccef2bb0aaa38674e6d415d993bfdc8336c9370cfe3bea99c096d7587e877ca73cd

data/.gitignore

@@ -17,13 +17,9 @@ features/support/etc/netsaint/*
 log/*
 vendor
 .bundle
-etc/*.yaml
 coverage
-tmp/pacts
-tmp/cucumber_cli
-tmp/pids/*
-tmp/spec*
-tmp/profiles
+reports
+tmp/*
 flapjack-*.gem
 _site/*
 .rvmrc
@@ -37,3 +33,5 @@ libexec/oneoff.linux_386
 libexec/oneoff.linux_amd64
 src/github.com
 src/gopkg.in
+etc/flapjack_config.toml
+etc/flapjack_config.yaml

data/.gitmodules

@@ -1,3 +1,3 @@
 [submodule "doc"]
 	path = doc
-	url = https://github.com/flpjck/flapjack.wiki.git
+	url = https://github.com/flapjack/flapjack.wiki.git

data/.rspec

@@ -1,5 +1,5 @@
 --color
---format Fuubar
+--format documentation
 --format html
 --out tmp/spec.html
 --require ./spec/support/uncolored_doc_formatter.rb

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.2.3

data/.travis.yml

@@ -1,10 +1,15 @@
+sudo: false
 language: ruby
 rvm:
 - '2.0'
 - '2.1'
 - '2.2'
-env:
-- GOPATH=$TRAVIS_BUILD_DIR
+- 'jruby-9.0.0.0'
+jdk: oraclejdk8
+script: bundle exec rspec spec && bundle exec rake pact:verify && bundle exec cucumber features && cd src/flapjack && go test -v
+env: GOPATH=$TRAVIS_BUILD_DIR
+gemfile: Gemfile
+cache: bundler
 services:
 - redis-server
 before_script:
@@ -15,20 +20,14 @@ before_install:
 install:
 - go get github.com/garyburd/redigo/redis
 - go get github.com/go-martini/martini
-- go get gopkg.in/alecthomas/kingpin.v1
+- go get gopkg.in/alecthomas/kingpin.v2
 - go get github.com/oguzbilgic/pandik
 - bundle install
-script: "bundle exec rspec spec && bundle exec rake pact:verify && bundle exec cucumber features && cd src/flapjack && go test -v"
 notifications:
   irc:
     channels:
-      - 'irc.freenode.net#flapjack'
+    - irc.freenode.net#flapjack
     template:
-      - '%{message} %{repository}#%{build_number} (%{branch} - %{commit} : %{author})'
-  hipchat:
-    template:
-      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}
-        (<a href="%{build_url}">Details</a>/<a href="%{compare_url}">Change view</a>)'
-    format: html
-    rooms:
-      secure: ajMolTKDuprYJ9Fadcjb3evh80MyJSgjW4hl4OWnEHyrjQLnsO0hbAvSrKRFUzorMoi58L8XZXd01gMgRqRxMvwqfoHLv4njw8px4X9+F/hySPZj3aMAFM1HuoTmHqeP+Rl+1Ssg+Kss6N4JkgNS81s+tkRnnoHG1n/EhfH6PkE=
+    - "%{message} %{repository}#%{build_number} (%{branch} - %{commit} : %{author})"
+  slack:
+    secure: OlXm5ljaX0xAR8wHEeODXUrL9r++LmBZIj/lZbJTJ0HUSUe11evYDN8NXAwzUCP57EGeVqV94m7uoIZzvknunrs4zPlNDAbTIGkSZ+ahemBYfQmlH54PYbPQWm0mrkN6NXgzn3e6CPkQIZPCWDA+/iq5oRl6ZZtIEmoa41KrUh0=

data/CHANGELOG.md

@@ -1,14 +1,7 @@
 ## Flapjack Changelog
 
-# 1.6.0 - 2015-07-09
-- No changes
-
-# 1.6.0rc4 - 2015-07-09
-- Feature: slack webhook gateway #881 (@mcqueenorama, @ali-graham)
-- Bug: sns gateway debugging and improvements (but still broken) #879 (@ali-graham, @jessereynolds)
-
-## Notes:
-- the SNS gateway signature calculation has been broken since v1.5.0 or earlier. See [#829](https://github.com/flapjack/flapjack/issues/829)
+# 2.0.0b1 - 2015-10-12
+- Feature: First beta release for v2.0.
 
 # 1.6.0rc3 - 2015-06-15
 - Chore/Bug?: SNS gateway improvements (@ali-graham)

data/CONTRIBUTING.md

@@ -23,13 +23,18 @@ Please see the [Contributing to Flapjack](http://flapjack.io/docs/1.0/developmen
 
         rake spec
 
-5. run integration tests
+5. run [pact](https://github.com/realestate-com-au/pact) tests
+
+        rake pact:verify
+
+6. run integration tests
 
         rake features
 
-6. code coverage for tests
+7. code coverage for tests
 
         COVERAGE=x rake spec
+        COVERAGE=x rake pact:verify
         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

@@ -2,22 +2,13 @@ source 'https://rubygems.org'
 
 gemspec :name => 'flapjack'
 
-group :development do
-  gem 'ruby-prof'
-end
-
 group :test do
-  gem 'rspec', '~> 3.0'
-  gem 'cucumber', '>= 2.0.0.beta.3'
+  gem 'rspec'
+  gem 'cucumber', '>= 2.0.0.rc.4'
   gem 'delorean'
   gem 'rack-test'
-  gem 'pact'
-  gem 'async_rack_test', '>= 0.0.5'
+  gem 'json_spec'
   gem 'webmock'
-  gem 'guard'
-  gem 'rb-fsevent'
-  gem 'guard-rspec'
-  gem 'guard-cucumber'
-  gem 'fuubar'
+  gem 'pact'
   gem 'simplecov', :require => false
 end

data/LICENCE

@@ -1,4 +1,5 @@
 Copyright (c) 2009 Lindsay Holmwood
+Copyright (c) 2012-2015 Ali Graham, Lindsay Holmwood, Sarah Kowalik, Jesse Reynolds and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,3 +1,7 @@
+Please note that Flapjack's master branch currently represents the `v2.0.0-alpha.1` pre-release of this gem. You may be looking for the [documentation for the release branch](https://github.com/flapjack/flapjack/blob/maint/1.x/README.md). Many things have changed for Flapjack v2, and the documentation needs to be fixed before the actual release.
+
+---
+
 # ![Flapjack](http://flapjack.io/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)
@@ -87,11 +91,11 @@ You'll also need Redis >= 2.6.12.
 
 ## Configuring
 
-Have a look at the [default config file](https://github.com/flapjack/flapjack/blob/master/etc/flapjack_config.yaml.example) and modify things as required. The package installer copies this to `/etc/flapjack/flapjack_config.yaml` if it doesn't already exist.
+Have a look at the [default config file](https://github.com/flapjack/flapjack/blob/master/etc/flapjack_config.toml.example) and modify things as required. The package installer copies this to `/etc/flapjack/flapjack_config.toml` if it doesn't already exist.
 
 ``` bash
 # edit the config
-sudo vi /etc/flapjack/flapjack_config.yaml
+sudo vi /etc/flapjack/flapjack_config.toml
 
 # reload the config
 sudo /etc/init.d/flapjack reload
@@ -140,6 +144,8 @@ We are [updating](https://github.com/flapjack/flapjack/issues/624) this section
 
 Information on developing more Flapjack components or contributing to core Flapjack development can be found in the [Developing](http://flapjack.io/docs/1.0/development/DEVELOPING/) section of [the docs](http://flapjack.io/docs/1.0/).
 
+Note that the master branch is still undergoing breaking changes and is for Flapjack 2. Building packages from the master branch is unlikely to work. Current stable builds are built from the maint/1.x branch.
+
 ## Documentation Submodule
 
 We have the documentation for this project on a github wiki and also referenced as a submodule at /doc in this project. Run the following commands to populate the local doc/ directory:

data/Rakefile

@@ -7,8 +7,6 @@ end
 require 'fileutils'
 require 'rake'
 
-require 'pact/tasks'
-
 Dir['tasks/**/*.rake'].each { |t| load t }
 
 require 'cucumber'
@@ -17,6 +15,8 @@ require 'rake/clean'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
+require 'pact/tasks'
+
 Cucumber::Rake::Task.new(:features) do |t|
   #t.cucumber_opts = 'features --format pretty'
   t.cucumber_opts = '--format progress'

data/bin/flapjack

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'gli'
+require 'flapjack/version'
 
 $stdout.sync = true
 
@@ -15,13 +16,8 @@ version Flapjack::VERSION
 
 desc 'Configuration file to use'
 flag [:c,:config],
-  :arg_name => '/path/to/flapjack.yaml',
-  :default_value => '/etc/flapjack/flapjack_config.yaml'
-
-desc 'Environment to boot'
-flag [:n, :env, :environment],
-  :arg_name => '<environment>',
-  :default_value => 'production'
+  :arg_name => '/path/to/flapjack.toml',
+  :default_value => '/etc/flapjack/flapjack_config.toml'
 
 desc 'Force UTF-8 encoding'
 switch [:'force-utf8'],
@@ -32,11 +28,6 @@ accept Array do |value|
   value.split(/,/).map(&:strip)
 end
 
-pre do |global,command,options,args|
-  FLAPJACK_ENV = ENV["FLAPJACK_ENV"] || global[:environment]
-  true
-end
-
 post do |global,command,options,args|
 end
 

data/build.sh

@@ -6,11 +6,13 @@ export GOPATH=$(pwd):$GOPATH
 
 go get github.com/garyburd/redigo/redis
 go get github.com/go-martini/martini
-go get gopkg.in/alecthomas/kingpin.v1
+go get gopkg.in/alecthomas/kingpin.v2
 go get github.com/oguzbilgic/pandik
 mv bin/pandik libexec/httpchecker
 
-go test flapjack
+if [ ! -z "$SKIPTESTS" ]; then
+  go test flapjack
+fi
 
 go build -x -o libexec/httpbroker libexec/httpbroker.go
 go build -x -o libexec/oneoff libexec/oneoff.go

data/etc/flapjack_config.toml.example

@@ -0,0 +1,273 @@
+[logger]
+  file = "/var/log/flapjack/flapjack.log"
+  level = "INFO"
+  syslog_errors = true
+[redis]
+  host = "127.0.0.1"
+  port = 6380
+  db = 0
+# Processes monitoring events off the *events* queue (a redis list) and decides
+# what actions to take (generate notification event, record state changes, etc)
+[processor]
+  enabled = true
+  queue = "events"
+  notifier_queue = "notifications"
+  archive_events = true
+  events_archive_maxage = 10800
+  # Flapjack sets scheduled maintenance on new check results so contacts aren't
+  # notified as soon as Flapjack becomes aware of an entity to notify on.
+  # This is useful is cases where your monitoring starts checking something
+  # before it is completely provisioned
+  # Value parsed by https://github.com/hpoydar/chronic_duration
+  # You can disable this setting by specifying "0 seconds".
+  new_check_scheduled_maintenance_duration = "100 years"
+  new_check_scheduled_maintenance_ignore_regex = "bypass_ncsm$"
+  [processor.logger]
+    file = "/var/log/flapjack/flapjack.log"
+    level = "INFO"
+    syslog_errors = true
+# Processes notification events off the *notifications* queue (a redis list) and
+# works out who to notify, and on which media, and with what kind of notification
+# message. It then creates jobs for the various notification gateways below.
+[notifier]
+  enabled = true
+  queue = "notifications"
+  email_queue = "email_notifications"
+  sms_queue = "sms_notifications"
+  sms_nexmo_queue = "sms_nexmo_notifications"
+  slack_queue = "slack_notifications"
+  sms_twilio_queue = "sms_twilio_notifications"
+  sms_aspsms_queue = "sms_aspsms_notifications"
+  sns_queue = "sns_notifications"
+  jabber_queue = "jabber_notifications"
+  pagerduty_queue = "pagerduty_notifications"
+  default_contact_timezone = "UTC"
+  [notifier.logger]
+    file = "/var/log/flapjack/flapjack.log"
+    level = "INFO"
+    syslog_errors = true
+[nagios-receiver]
+  fifo = "/var/cache/nagios3/event_stream.fifo"
+[nsca-receiver]
+  fifo = "/var/lib/nagios3/rw/nagios.cmd"
+[gateways]
+  # Generates email notifications
+  [gateways.email]
+    enabled = false
+    # the redis queue this pikelet will look for notifications on
+    queue = "email_notifications"
+    [gateways.email.logger]
+      level = "INFO"
+      syslog_errors = true
+    # these values are passed directly through to EventMachine::Protocols::SmtpClient configuration,
+    # and can be omitted if the defaults are acceptable
+    [gateways.email.smtp_config]
+      # from = "Flapjack Example <flapjack@noreply.example>"
+      # reply_to = "flapjack@support.example"
+      host = "127.0.0.1"
+      # 1025 is the default port for http://mailcatcher.me
+      port = 1025
+      starttls = false
+      #[gateways.email.smtp_config.auth]
+      #  type =
+      #  username =
+      #  password =
+    # location of custom alert templates
+    #[gateways.email.templates]
+    #  rollup_subject_text = "/etc/flapjack/templates/email/rollup_subject.text.erb"
+    #  alert_subject_text = "/etc/flapjack/templates/email/alert_subject.text.erb"
+    #  rollup_text = "/etc/flapjack/templates/email/rollup.text.erb"
+    #  alert_text = "/etc/flapjack/templates/email/alert.text.erb"
+    #  rollup.html = "/etc/flapjack/templates/email/rollup.html.erb"
+    #  alert.html = "/etc/flapjack/templates/email/alert.html.erb"
+  # Sends SMS notifications via MessageNet (Australia only)
+  [gateways.sms]
+    enabled = false
+    # the redis queue this pikelet will look for notifications on
+    queue = "sms_notifications"
+    endpoint = "https://www.messagenet.com.au/dotnet/Lodge.asmx/LodgeSMSMessage"
+    username = "ermahgerd"
+    password = "xxxx"
+    [gateways.sms.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+    # location of custom alert templates
+    #templates:
+    #  rollup_text = "/etc/flapjack/templates/sms/rollup.text.erb"
+    #  alert_text = "/etc/flapjack/templates/sms/alert.text.erb"
+  # Sends notifications via Slack
+  [gateways.slack]
+    enabled = false
+    queue = "slack_notifications"
+    account_sid = "webhookbot"
+    endpoint = "https://hooks.slack.com/services/xxx/yyy/"
+    auth_token = "zzzzz"
+    from = ""
+    [gateways.slack.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+    ## location of custom alert templates
+    #templates:
+    #  rollup_text = "/etc/flapjack/templates/slack/rollup.text.erb"
+    #  alert_text = "/etc/flapjack/templates/slack/alert.text.erb"
+  # Sends SMS notifications via Nexmo
+  [gateways.sms_nexmo]
+    enabled = false
+    queue = "sms_nexmo_notifications"
+    from = "zzzzzz"
+    api_key = "APIKEY"
+    secret = "s3cr3t"
+    [gateways.sms_nexmo.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+    ## location of custom alert templates
+    #templates:
+    #  rollup_text = "/etc/flapjack/templates/sms_nexmo/rollup.text.erb"
+    #  alert_text = "/etc/flapjack/templates/sms_nexmo/alert.text.erb"
+  # Sends SMS notifications via Twilio
+  [gateways.sms_twilio]
+    enabled = false
+    queue = "sms_twilio_notifications"
+    account_sid = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+    auth_token = "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+    from = "+1xxxxxxxxxx"
+    [gateways.sms_twilio.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+    # location of custom alert templates
+    #[gateways.sms_twilio.templates]
+    #  rollup_text = "/etc/flapjack/templates/sms_twilio/rollup.text.erb"
+    #  alert_text = "/etc/flapjack/templates/sms_twilio/alert.text.erb"
+  # Sends SMS notifications via ASPSMS ( https://www.aspsms.com/ )
+  [gateways.sms_aspsms]
+    enabled = false
+    # the redis queue this pikelet will look for notifications on
+    queue = "sms_aspsms_notifications"
+    endpoint_host = "webservice.aspsms.com"
+    endpoint_path = "/aspsmsx.asmx/SimpleTextSMS"
+    originator = "Flapjack"
+    username = "xxxx"
+    password = "xxxx"
+    [gateways.sms_aspsms.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+    # location of custom alert templates
+    #templates:
+    #  rollup_text = "/etc/flapjack/templates/sms_aspsms/rollup.text.erb"
+    #  alert_text = "/etc/flapjack/templates/sms_aspsms/alert.text.erb"
+  # Generates SNS notifications
+  [gateways.sns]
+    enabled = false
+    queue = "sns_notifications"
+    #region_name = "us-east-1"
+    # Don't forget to use an IAM user's credentials here so revocation is easy!
+    access_key = "AKIAIOSFODNN7EXAMPLE"
+    secret_key = "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
+  # Connects to an XMPP (jabber) server, sends notifications (to rooms and individuals),
+  # handles acknowledgements from jabber users and other commands.
+  [gateways.jabber]
+    enabled = false
+    # Announce my arrival in the Multi-User Chat room
+    chatbot_announce = true
+    # the redis queue this pikelet will look for notifications on
+    queue = "jabber_notifications"
+    server = "jabber.example.com"
+    port = 5222
+    jabberid = "flapjack@jabber.example.com"
+    password = "good-password"
+    alias = "flapjack"
+    # List of strings that this pikelet user will respond to
+    identifiers = ["@flapjack"]
+    # the Multi-User Chats the pikelet should join and announce to
+    rooms = [
+      "gimp@conference.jabber.example.com",
+      "log@conference.jabber.example.com"
+    ]
+    [gateways.jabber.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+    # location of custom alert templates
+    #[gateways.jabber.templates]
+    #  rollup_text = "/etc/flapjack/templates/jabber/rollup.text.erb"
+    #  alert_text = "/etc/flapjack/templates/jabber/alert.text.erb"
+  # Sends notifications to and accepts acknowledgements from [PagerDuty](http://www.pagerduty.com/)
+  # (NB = "contacts will need to have a registered PagerDuty account to use this)"
+  [gateways.pagerduty]
+    enabled = false
+    # the redis queue this pikelet will look for notifications on
+    queue = "pagerduty_notifications"
+    [gateways.pagerduty.credentials]
+      service_key = "1234567890"
+      subdomain = "thecompany"
+      username = "user"
+      password = "pass"
+    [gateways.pagerduty.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+    # location of custom alert templates
+    #[gateways.pagerduty.templates]
+    #  alert_text = "/etc/flapjack/templates/pagerduty/alert.text.erb"
+  # Browsable web interface
+  [gateways.web]
+    enabled = true
+    bind_address = "0.0.0.0"
+    port = 3080
+    timeout = 300
+    # Seconds between auto_refresh of entities/checks pages.  Set to 0 to disable
+    auto_refresh = 120
+    access_log = "/var/log/flapjack/web_access.log"
+    api_url = "http://127.0.0.1:3081/"
+    # Full path to location of logo file, e.g. /etc/flapjack/custom_logo.png
+    #logo_image_path = "/etc/flapjack/web/custom_logo/flapjack-2013-notext-transparent-300-300.png"
+    show_exceptions = false
+    [gateways.web.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+  # HTTP API server
+  [gateways.jsonapi]
+    enabled = true
+    bind_address = "0.0.0.0"
+    port = 3081
+    timeout = 300
+    access_log = "/var/log/flapjack/jsonapi_access.log"
+    base_url = "http://127.0.0.1:3081/"
+    [gateways.jsonapi.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true
+  # "out-of-band" end-to-end testing, used for monitoring other instances of
+  # flapjack to ensure that they are running correctly
+  [gateways.oobetet]
+    enabled = false
+    server = "jabber.example.com"
+    port = 5222
+    # jabberid, password, alias, rooms = "see the jabber pikelet"
+    jabberid = "flapjacktest@jabber.example.com"
+    password = "nuther-good-password"
+    alias = "flapjacktest"
+    # The check oobetet should watch for the state change
+    watched_check = "PING"
+    # The entitiy that the check should be associated with
+    watched_entity = "foo.example.com"
+    # The maximum amount of time allowed to pass between state changes on that check
+    max_latency = 300
+    # The API key for a service in PagerDuty that the oobetet will use to alert you
+    pagerduty_contact = "11111111111111111111111111111111"
+    # Jabber rooms to join
+    rooms = [
+      "flapjacktest@conference.jabber.example.com",
+      "gimp@conference.jabber.example.com",
+      "log@conference.jabber.example.com"
+    ]
+    [gateways.oobetet.logger]
+      file = "/var/log/flapjack/flapjack.log"
+      level = "INFO"
+      syslog_errors = true