flapjack 0.8.10 → 0.8.11

data/lib/flapjack/data/event.rb

@@ -9,10 +9,10 @@ module Flapjack
 
       attr_accessor :counter, :id_hash, :tags
 
-      attr_reader :check, :summary, :details, :acknowledgement_id
+      attr_reader :check, :summary, :details, :acknowledgement_id, :perfdata
 
       REQUIRED_KEYS = ['type', 'state', 'entity', 'check', 'summary']
-      OPTIONAL_KEYS = ['time', 'details', 'acknowledgement_id', 'duration', 'tags']
+      OPTIONAL_KEYS = ['time', 'details', 'acknowledgement_id', 'duration', 'tags', 'perfdata']
 
       VALIDATIONS = {
         proc {|e| e['type'].is_a?(String) &&
@@ -42,6 +42,9 @@ module Flapjack
         proc {|e| e['details'].nil? || e['details'].is_a?(String) } =>
           "details must be a string",
 
+        proc { |e| e['perfdata'].nil? || e['perfdata'].is_a?(String) } =>
+          "perfdata must be a string",
+
         proc {|e| e['acknowledgement_id'].nil? ||
                   e['acknowledgement_id'].is_a?(String) ||
                   e['acknowledgement_id'].is_a?(Integer) } =>
@@ -164,6 +167,7 @@ module Flapjack
       #   'state'     => state,
       #   'summary'   => check_output,
       #   'details'   => check_long_output,
+      #   'perfdata'  => perf_data,
       #   'time'      => timestamp
       def self.add(evt, opts = {})
         raise "Redis connection not set" unless redis = opts[:redis]
@@ -204,11 +208,13 @@ module Flapjack
 
       def initialize(attrs = {})
         ['type', 'state', 'entity', 'check', 'time', 'summary', 'details',
-         'acknowledgement_id', 'duration'].each do |key|
+         'perfdata', 'acknowledgement_id', 'duration'].each do |key|
           instance_variable_set("@#{key}", attrs[key])
         end
         # details is optional. set it to nil if it only contains whitespace
         @details = (@details.is_a?(String) && ! @details.strip.empty?) ? @details.strip : nil
+        # perfdata is optional. set it to nil if it only contains whitespace
+        @perfdata = (@perfdata.is_a?(String) && ! @perfdata.strip.empty?) ? @perfdata.strip : nil
         if attrs['tags']
           @tags = Flapjack::Data::TagSet.new
           attrs['tags'].each {|tag| @tags.add(tag)}

data/lib/flapjack/data/notification_rule.rb

@@ -81,6 +81,14 @@ module Flapjack
         }.to_json
       end
 
+      def to_jsonapi(opts = {})
+        self.class.hashify(:id, :tags, :regex_tags, :entities, :regex_entities,
+            :time_restrictions, :unknown_media, :warning_media, :critical_media,
+            :unknown_blackhole, :warning_blackhole, :critical_blackhole) {|k|
+          [k, self.send(k)]
+        }.merge(:links => {:contacts => [self.contact_id]}).to_json
+      end
+
       # entity names match?
       def match_entity?(event_id)
         return false unless @entities

data/lib/flapjack/gateways/api.rb

@@ -104,7 +104,6 @@ module Flapjack
       end
 
       register Flapjack::Gateways::API::EntityMethods
-
       register Flapjack::Gateways::API::ContactMethods
 
       not_found do

data/lib/flapjack/gateways/api/entity_check_presenter.rb

@@ -24,6 +24,7 @@ module Flapjack
            'enabled'                           => @entity_check.enabled?,
            'summary'                           => @entity_check.summary,
            'details'                           => @entity_check.details,
+           'perfdata'                          => @entity_check.perfdata,
            'in_unscheduled_maintenance'        => @entity_check.in_unscheduled_maintenance?,
            'in_scheduled_maintenance'          => @entity_check.in_scheduled_maintenance?,
            'last_update'                       => @entity_check.last_update,
@@ -214,4 +215,4 @@ module Flapjack
 
   end
 
-end
+end

data/lib/flapjack/gateways/email.rb

@@ -51,6 +51,7 @@ module Flapjack
           host = @smtp_config ? @smtp_config['host'] : nil
           port = @smtp_config ? @smtp_config['port'] : nil
           starttls = @smtp_config ? !! @smtp_config['starttls'] : nil
+          m_from = @smtp_config ? @smtp_config['from'] : "flapjack@#{@fqdn}"
           if @smtp_config
             if auth_config = @smtp_config['auth']
               auth = {}
@@ -60,7 +61,6 @@ module Flapjack
             end
           end
 
-          m_from = "flapjack@#{@fqdn}"
           @logger.debug("flapjack_mailer: set from to #{m_from}")
 
           mail = prepare_email(:from       => m_from,
@@ -176,4 +176,3 @@ module Flapjack
     end
   end
 end
-

data/lib/flapjack/gateways/jabber.rb

@@ -189,7 +189,7 @@ module Flapjack
           four_hours = 4 * 60 * 60
           duration = (dur.nil? || (dur <= 0)) ? four_hours : dur
 
-          event_id = @redis.hget('check_hashes', ackid)
+          event_id = @redis.hget('checks_by_hash', ackid)
 
           if event_id.nil?
             error = "not found"
@@ -394,7 +394,7 @@ module Flapjack
                       )
                   end
                 end
-                msg = failing_list.inject("Ack list:\n") {|memo,kv|
+                msg = entities.inject("Ack list:\n") {|memo,kv|
                   kv[1].each {|e| memo << "#{kv[0]}:#{e}\n" }
                   memo
                 }
@@ -475,7 +475,7 @@ module Flapjack
                       )
                   end
                 end
-                msg = failing_list.inject("Ack list:\n") {|memo,kv|
+                msg = my_failing_checks.inject("Ack list:\n") {|memo,kv|
                   kv[1].each {|e| memo << "#{kv[0]}:#{e}\n" }
                   memo
                 }

data/lib/flapjack/gateways/jsonapi.rb

@@ -16,8 +16,13 @@ require 'flapjack/redis_pool'
 
 require 'flapjack/gateways/jsonapi/rack/json_params_parser'
 
+require 'flapjack/gateways/jsonapi/check_methods'
 require 'flapjack/gateways/jsonapi/contact_methods'
 require 'flapjack/gateways/jsonapi/entity_methods'
+require 'flapjack/gateways/jsonapi/medium_methods'
+require 'flapjack/gateways/jsonapi/notification_rule_methods'
+require 'flapjack/gateways/jsonapi/pagerduty_credential_methods'
+require 'flapjack/gateways/jsonapi/report_methods'
 
 module Flapjack
 
@@ -28,6 +33,10 @@ module Flapjack
       include Flapjack::Utility
 
       JSON_REQUEST_MIME_TYPES = ['application/vnd.api+json', 'application/json', 'application/json-patch+json']
+      # http://www.iana.org/assignments/media-types/application/vnd.api+json
+      JSONAPI_MEDIA_TYPE = 'application/vnd.api+json; charset=utf-8'
+      # http://tools.ietf.org/html/rfc6902
+      JSON_PATCH_MEDIA_TYPE = 'application/json-patch+json; charset=utf-8'
 
       class ContactNotFound < RuntimeError
         attr_reader :contact_id
@@ -57,6 +66,13 @@ module Flapjack
         end
       end
 
+      class EntitiesNotFound < RuntimeError
+        attr_reader :entity_ids
+        def initialize(entity_ids)
+          @entity_ids = entity_ids
+        end
+      end
+
       class EntityCheckNotFound < RuntimeError
         attr_reader :entity, :check
         def initialize(entity, check)
@@ -209,62 +225,194 @@ module Flapjack
         end
       end
 
-      def is_json_request?
-        Flapjack::Gateways::JSONAPI::JSON_REQUEST_MIME_TYPES.include?(request.content_type.split(/\s*[;,]\s*/, 2).first.downcase)
-      end
+      module Helpers
+
+        def cors_headers
+          allow_headers  = %w(* Content-Type Accept AUTHORIZATION Cache-Control)
+          allow_methods  = %w(GET POST PUT PATCH DELETE OPTIONS)
+          expose_headers = %w(Cache-Control Content-Language Content-Type Expires Last-Modified Pragma)
+          cors_headers   = {
+            'Access-Control-Allow-Origin'   => '*',
+            'Access-Control-Allow-Methods'  => allow_methods.join(', '),
+            'Access-Control-Allow-Headers'  => allow_headers.join(', '),
+            'Access-Control-Expose-Headers' => expose_headers.join(', '),
+            'Access-Control-Max-Age'        => '1728000'
+          }
+          headers(cors_headers)
+        end
 
-      def is_jsonpatch_request?
-        'application/json-patch+json'.eql?(request.content_type.split(/\s*[;,]\s*/, 2).first.downcase)
-      end
+        def location(ids)
+          location = "#{base_url}#{request.path_info}#{ids.length == 1 ? '/' + ids.first : '?ids=' + ids.join(',')}"
+          headers({'Location' => location})
+        end
 
-      register Flapjack::Gateways::JSONAPI::EntityMethods
+        def err(status, *msg)
+          msg_str = msg.join(", ")
+          logger.info "Error: #{msg_str}"
+          [status, {}, {:errors => msg}.to_json]
+        end
 
-      register Flapjack::Gateways::JSONAPI::ContactMethods
+        def is_json_request?
+          Flapjack::Gateways::JSONAPI::JSON_REQUEST_MIME_TYPES.include?(request.content_type.split(/\s*[;,]\s*/, 2).first)
+        end
 
-      # the following should add the cors headers to every request, but is no work
-      #register Sinatra::CrossOrigin
-      #
-      #configure do
-      #  enable :cross_origin
-      #end
-      #set :allow_origin, :any
-      #set :allow_methods, [:get, :post, :put, :patch, :delete, :options]
+        def is_jsonapi_request?
+          return false if request.content_type.nil?
+          'application/vnd.api+json'.eql?(request.content_type.split(/\s*[;,]\s*/, 2).first)
+        end
+
+        def is_jsonpatch_request?
+          return false if request.content_type.nil?
+          'application/json-patch+json'.eql?(request.content_type.split(/\s*[;,]\s*/, 2).first)
+        end
+
+        def wrapped_params(name, error_on_nil = true)
+          result = params[name.to_sym]
+          if result.nil?
+            if error_on_nil
+              logger.debug("No '#{name}' object found in the following supplied JSON:")
+              logger.debug(request.body.is_a?(StringIO) ? request.body.read : request.body)
+              halt err(403, "No '#{name}' object received")
+            else
+              result = [{}]
+            end
+          end
+          unless result.is_a?(Array)
+            halt err(403, "The received '#{name}'' object is not an Array")
+          end
+          result
+        end
+
+        def find_contact(contact_id)
+          contact = Flapjack::Data::Contact.find_by_id(contact_id, :logger => logger, :redis => redis)
+          raise Flapjack::Gateways::JSONAPI::ContactNotFound.new(contact_id) if contact.nil?
+          contact
+        end
+
+        def find_rule(rule_id)
+          rule = Flapjack::Data::NotificationRule.find_by_id(rule_id, :logger => logger, :redis => redis)
+          raise Flapjack::Gateways::JSONAPI::NotificationRuleNotFound.new(rule_id) if rule.nil?
+          rule
+        end
+
+        def find_tags(tags)
+          halt err(400, "no tags given") if tags.nil? || tags.empty?
+          tags
+        end
+
+        def find_entity(entity_name)
+          entity = Flapjack::Data::Entity.find_by_name(entity_name, :redis => redis)
+          raise Flapjack::Gateways::JSONAPI::EntityNotFound.new(entity_name) if entity.nil?
+          entity
+        end
+
+        def find_entity_by_id(entity_id)
+          entity = Flapjack::Data::Entity.find_by_id(entity_id, :redis => redis)
+          raise Flapjack::Gateways::JSONAPI::EntityNotFound.new(entity_id) if entity.nil?
+          entity
+        end
+
+        def find_entity_check(entity, check_name)
+          entity_check = Flapjack::Data::EntityCheck.for_entity(entity, check_name, :redis => redis)
+          raise Flapjack::Gateways::JSONAPI::EntityCheckNotFound.new(entity.name, check_name) if entity_check.nil?
+          entity_check
+        end
+
+        def find_entity_check_by_name(entity_name, check_name)
+          entity_check = Flapjack::Data::EntityCheck.for_entity_name(entity_name, check_name, :redis => redis)
+          raise Flapjack::Gateways::JSONAPI::EntityCheckNotFound.new(entity_name, check_name) if entity_check.nil?
+          entity_check
+        end
+
+        def apply_json_patch(object_path, &block)
+          ops = params[:ops]
+
+          if ops.nil? || !ops.is_a?(Array)
+            halt err(400, "Invalid JSON-Patch request")
+          end
+
+          ops.each do |operation|
+            linked = nil
+            property = nil
+
+            op = operation['op']
+            operation['path'] =~ /\A\/#{object_path}\/0\/([^\/]+)(?:\/([^\/]+)(?:\/([^\/]+))?)?\z/
+            if 'links'.eql?($1)
+              linked = $2
+
+              value = case op
+              when 'add'
+                operation['value']
+              when 'remove'
+                $3
+              end
+            elsif 'replace'.eql?(op)
+              property = $1
+              value = operation['value']
+            else
+              next
+            end
+
+            yield(op, property, linked, value)
+          end
+        end
+
+        # NB: casts to UTC before converting to a timestamp
+        def validate_and_parsetime(value)
+          return unless value
+          Time.iso8601(value).getutc.to_i
+        rescue ArgumentError => e
+          logger.error "Couldn't parse time from '#{value}'"
+          nil
+        end
+
+      end
 
       options '*' do
         cors_headers
         204
       end
 
-      not_found do
-        err(404, "not routable")
+      # The following catch-all routes act as impromptu filters for their method types
+      get '*' do
+        content_type JSONAPI_MEDIA_TYPE
+        cors_headers
+        pass
       end
 
-      def cors_headers
-        allow_headers  = %w(* Content-Type Accept AUTHORIZATION Cache-Control)
-        allow_methods  = %w(GET POST PUT PATCH DELETE OPTIONS)
-        expose_headers = %w(Cache-Control Content-Language Content-Type Expires Last-Modified Pragma)
-        cors_headers   = {
-          'Access-Control-Allow-Origin'   => '*',
-          'Access-Control-Allow-Methods'  => allow_methods.join(', '),
-          'Access-Control-Allow-Headers'  => allow_headers.join(', '),
-          'Access-Control-Expose-Headers' => expose_headers.join(', '),
-          'Access-Control-Max-Age'        => '1728000'
-        }
-        headers(cors_headers)
+      # bare 'params' may have splat/captures for regex route, see
+      # https://github.com/sinatra/sinatra/issues/453
+      post '*' do
+        halt(405) unless request.params.empty? || is_json_request? || is_jsonapi_request
+        content_type JSONAPI_MEDIA_TYPE
+        cors_headers
+        pass
+      end
+
+      patch '*' do
+        halt(405) unless is_jsonpatch_request?
+        content_type JSONAPI_MEDIA_TYPE
+        cors_headers
+        pass
       end
 
-      def location(ids)
-        location = "#{base_url}#{request.path_info}#{ids.length == 1 ? '/' + ids.first : '?ids=' + ids.join(',')}"
-        headers({'Location' => location})
+      delete '*' do
+        cors_headers
+        pass
       end
 
-      private
+      register Flapjack::Gateways::JSONAPI::CheckMethods
+      register Flapjack::Gateways::JSONAPI::ContactMethods
+      register Flapjack::Gateways::JSONAPI::EntityMethods
+      register Flapjack::Gateways::JSONAPI::MediumMethods
+      register Flapjack::Gateways::JSONAPI::NotificationRuleMethods
+      register Flapjack::Gateways::JSONAPI::PagerdutyCredentialMethods
+      register Flapjack::Gateways::JSONAPI::ReportMethods
 
-      def err(status, *msg)
-        msg_str = msg.join(", ")
-        logger.info "Error: #{msg_str}"
-        [status, {}, {:errors => msg}.to_json]
+      not_found do
+        err(404, "not routable")
       end
+
     end
 
   end

data/lib/flapjack/gateways/jsonapi/check_methods.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+
+require 'sinatra/base'
+
+require 'flapjack/data/event'
+
+module Flapjack
+
+  module Gateways
+
+    class JSONAPI < Sinatra::Base
+
+      module CheckMethods
+
+        module Helpers
+
+          def checks_for_check_names(check_names)
+            return if check_names.nil?
+            entity_cache = {}
+            check_names.inject([]) do |memo, check_name|
+              entity_name, check = check_name.split(':', 2)
+              entity = (entity_cache[entity_name] ||= find_entity(entity_name))
+              memo << find_entity_check(entity, check)
+              memo
+            end
+          end
+
+        end
+
+        def self.registered(app)
+          app.helpers Flapjack::Gateways::JSONAPI::Helpers
+          app.helpers Flapjack::Gateways::JSONAPI::CheckMethods::Helpers
+
+          # create a scheduled maintenance period for a check on an entity
+          app.post %r{^/scheduled_maintenances/checks/([^/]+)$} do
+            scheduled_maintenances = wrapped_params('scheduled_maintenances')
+            checks_for_check_names(params[:captures][0].split(',')).each do |check|
+              scheduled_maintenances.each do |wp|
+                start_time = validate_and_parsetime(wp['start_time'])
+                halt( err(403, "start time must be provided") ) unless start_time
+
+                check.create_scheduled_maintenance(start_time,
+                  wp[:duration].to_i, :summary => wp[:summary])
+              end
+            end
+
+            status 204
+          end
+
+          # create an acknowledgement for a service on an entity
+          # NB currently, this does not acknowledge a specific failure event, just
+          # the entity-check as a whole
+          app.post %r{^/unscheduled_maintenances/checks/([^/]+)$} do
+            unscheduled_maintenances = wrapped_params('unscheduled_maintenances', false)
+            checks_for_check_names(params[:captures][0].split(',')).each do |check|
+              unscheduled_maintenances.each do |wp|
+                dur = wp['duration'] ? wp['duration'].to_i : nil
+                duration = (dur.nil? || (dur <= 0)) ? (4 * 60 * 60) : dur
+                summary = wp['summary']
+
+                opts = {:duration => duration}
+                opts[:summary] = summary if summary
+
+                Flapjack::Data::Event.create_acknowledgement(
+                  check.entity_name, check.check, {:redis => redis}.merge(opts))
+              end
+            end
+
+            status 204
+          end
+
+          app.patch %r{^/unscheduled_maintenances/checks/([^/]+)$} do
+            checks_for_check_names(params[:captures][0].split(',')).each do |check|
+              apply_json_patch('unscheduled_maintenances') do |op, property, linked, value|
+                case op
+                when 'replace'
+                  if ['end_time'].include?(property)
+                    end_time = validate_and_parsetime(value)
+                    check.end_unscheduled_maintenance(end_time.to_i)
+                  end
+                end
+              end
+            end
+            status 204
+          end
+
+          app.delete %r{^/scheduled_maintenances/checks/([^/]+)$} do
+            start_time = validate_and_parsetime(params[:start_time])
+            halt( err(403, "start time must be provided") ) unless start_time
+
+            checks_for_check_names(params[:captures][0].split(',')).each do |check|
+              check.end_scheduled_maintenance(start_time.to_i)
+            end
+            status 204
+          end
+
+          app.post %r{^/test_notifications/checks/([^/]+)$} do
+            test_notifications = wrapped_params('test_notifications', false)
+            checks_for_check_names(params[:captures][0].split(',')).each do |check|
+              test_notifications.each do |wp|
+                summary = wp['summary'] ||
+                          "Testing notifications to all contacts interested in entity #{check.entity.name}"
+                Flapjack::Data::Event.test_notifications(
+                  check.entity_name, check.check,
+                  :summary => summary,
+                  :redis => redis)
+              end
+            end
+            status 204
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end