sensu-settings 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecff7fd492c9359b7cd7acd1a5d96cbd58dbb4ba
-  data.tar.gz: c28ea05aada28e40f753142d7028a62106926ae2
+  metadata.gz: 3cbf9a4e7d37ba04e4fbbcfe697fcadb75a448c2
+  data.tar.gz: c6c4db9dcbf1f9f076aa6f5f9770c865b9ed1fe0
 SHA512:
-  metadata.gz: dd1cb0e18dfa49dd1eddc80ec674d63306b1ec546ea346ff68fdec00e5938d114cd6fb2f89838c80fac442e39f610df8a5efa0a7ad8388b32f244c0684b3450f
-  data.tar.gz: f27ce319271b20543fa332d1945ca064965f6ea27a2658461df5e6e452339925933c898c46178d4a3a1c31def07f6d3e4de536916daec878b18c1042c0b21ec1
+  metadata.gz: 7b07bc280b7a7c920cc3f4eac878f49645bf34a48812c021cb2c111d55a0b8a23fbc9594a8aa8180491da316386ff2ae8d7f84126e7e0ba5b46cc7a10d5cc558
+  data.tar.gz: 5aff8a7a597d6d6c8ceeaa061663fa403167003c734c7b53dd6bfb7c2c4ab7cc8c5e2900b8c66d694b2ead2f60953d4151d8c026b45a3f8684d1fb21e60f6399

data/lib/sensu/settings/validators.rb

@@ -1,6 +1,6 @@
 require "sensu/settings/validators/sensu"
 require "sensu/settings/validators/transport"
-require "sensu/settings/validators/subdue"
+require "sensu/settings/validators/time_window"
 require "sensu/settings/validators/check"
 require "sensu/settings/validators/filter"
 require "sensu/settings/validators/mutator"
@@ -14,7 +14,7 @@ module Sensu
     module Validators
       include Sensu
       include Transport
-      include Subdue
+      include TimeWindow
       include Check
       include Filter
       include Mutator

data/lib/sensu/settings/validators/check.rb

@@ -129,6 +129,14 @@ module Sensu
           end
         end
 
+        # Validate check subdue.
+        # Validates: subdue
+        #
+        # @param check [Hash] sensu check definition.
+        def validate_check_subdue(check)
+          validate_time_windows(check, :subdue)
+        end
+
         # Validate a Sensu check definition.
         #
         # @param check [Hash] sensu check definition.
@@ -141,7 +149,7 @@ module Sensu
           validate_check_ttl(check) if check[:ttl]
           validate_check_aggregate(check)
           validate_check_flap_detection(check)
-          validate_subdue(check) if check[:subdue]
+          validate_check_subdue(check) if check[:subdue]
         end
       end
     end

data/lib/sensu/settings/validators/filter.rb

@@ -2,6 +2,14 @@ module Sensu
   module Settings
     module Validators
       module Filter
+        # Validate filter when.
+        # Validates: when
+        #
+        # @param filter [Hash] sensu filter definition.
+        def validate_filter_when(filter)
+          validate_time_windows(filter, :when)
+        end
+
         # Validate a Sensu filter definition.
         # Validates: attributes, negate
         #
@@ -11,6 +19,7 @@ module Sensu
             invalid(filter, "filter negate must be boolean")
           must_be_a_hash(filter[:attributes]) ||
             invalid(filter, "filter attributes must be a hash")
+          validate_filter_when(filter) if filter[:when]
         end
       end
     end

data/lib/sensu/settings/validators/handler.rb

@@ -110,7 +110,7 @@ module Sensu
         end
 
         # Validate a Sensu handler definition.
-        # Validates: timeout, mutator, handle_flapping
+        # Validates: timeout, mutator, handle_flapping, handle_silenced
         #
         # @param handler [Hash] sensu handler definition.
         def validate_handler(handler)
@@ -123,9 +123,8 @@ module Sensu
             invalid(handler, "handler mutator must be a string")
           must_be_boolean_if_set(handler[:handle_flapping]) ||
             invalid(handler, "handler handle_flapping must be boolean")
-          if handler[:subdue]
-            validate_subdue(handler)
-          end
+          must_be_boolean_if_set(handler[:handle_silenced]) ||
+            invalid(handler, "handler handle_silenced must be boolean")
         end
       end
     end

data/lib/sensu/settings/validators/time_window.rb

@@ -0,0 +1,65 @@
+module Sensu
+  module Settings
+    module Validators
+      module TimeWindow
+        # Validate time window condition
+        # Validates: begin, end
+        #
+        # @param definition [Hash] sensu definition.
+        # @param scope [String] definition scope to validate.
+        # @param condition [Hash] to have begin and end validated.
+        def validate_time_window_condition(definition, scope, condition)
+          if is_a_hash?(condition)
+            if either_are_set?(condition[:begin], condition[:end])
+              must_be_time(condition[:begin], condition[:end]) ||
+                invalid(definition, "#{scope} begin and end times must be valid")
+            end
+          else
+            invalid(definition, "#{scope} must be a hash")
+          end
+        end
+
+        # Validate time windows
+        # Validates: days
+        #
+        # @param definition [Hash] sensu definition.
+        # @param scope [String] definition scope to validate.
+        # @param days [String] time window days to validate.
+        def validate_time_windows_days(definition, scope, days)
+          valid_days = [:all, :sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday]
+          if must_be_either(valid_days, days.keys)
+            days.each do |day, conditions|
+              if is_an_array?(conditions)
+                conditions.each do |condition|
+                  validate_time_window_condition(definition, scope, condition)
+                end
+              else
+                invalid(definition, "#{scope} #{day} time windows must be in an array")
+              end
+            end
+          else
+            invalid(definition, "#{scope} days must be valid days of the week or 'all'")
+          end
+        end
+
+        # Validate time windows
+        # Validates: days
+        #
+        # @param definition [Hash] sensu definition.
+        # @param scope [String] definition scope to validate.
+        def validate_time_windows(definition, scope)
+          if is_a_hash?(definition[scope])
+            days = definition[scope][:days]
+            must_be_a_hash_if_set(days) ||
+              invalid(definition, "#{scope} days must be a hash")
+            if is_a_hash?(days)
+              validate_time_windows_days(definition, scope, days)
+            end
+          else
+            invalid(definition, "#{scope} must be a hash")
+          end
+        end
+      end
+    end
+  end
+end

data/sensu-settings.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-settings"
-  spec.version       = "8.0.0"
+  spec.version       = "9.0.0"
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.summary       = "The Sensu settings library, loader and validator"

data/spec/validator_spec.rb

@@ -270,56 +270,72 @@ describe "Sensu::Settings::Validator" do
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
     check[:subdue] = {
-      :at => "unknown"
+      :days => []
     }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
-    check[:subdue][:at] = "publisher"
-    @validator.validate_check(check)
-    expect(@validator.reset).to eq(0)
-    check[:subdue][:at] = "handler"
-    @validator.validate_check(check)
-    expect(@validator.reset).to eq(0)
-    check[:subdue][:begin] = "14:30"
-    check[:subdue][:end] = 1
-    @validator.validate_check(check)
-    expect(@validator.reset).to eq(1)
-    check[:subdue][:begin] = 1
-    check[:subdue][:end] = "14:30"
-    @validator.validate_check(check)
-    expect(@validator.reset).to eq(1)
-    check[:subdue][:begin] = "14:30"
-    check[:subdue][:end] = "16:30"
+    check[:subdue] = {
+      :days => {}
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(0)
-    check[:subdue][:days] = 1
-    @validator.validate_check(check)
-    expect(@validator.reset).to eq(1)
-    check[:subdue][:days] = ["unknown"]
+    check[:subdue] = {
+      :days => {
+        :nope => {}
+      }
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
-    check[:subdue][:days] = [true]
+    check[:subdue] = {
+      :days => {
+        :nope => []
+      }
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
-    check[:subdue][:days] = ["monday"]
-    @validator.validate_check(check)
-    expect(@validator.reset).to eq(0)
-    check[:subdue][:exceptions] = 1
+    check[:subdue] = {
+      :days => {
+        :all => {}
+      }
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
-    check[:subdue][:exceptions] = []
+    check[:subdue] = {
+      :days => {
+        :all => []
+      }
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(0)
-    check[:subdue][:exceptions] = [1]
+    check[:subdue] = {
+      :days => {
+        :all => [true]
+      }
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
-    check[:subdue][:exceptions] = [{}]
-    @validator.validate_check(check)
-    expect(@validator.reset).to eq(0)
-    check[:subdue][:exceptions] = [{:begin => "15:00"}]
+    check[:subdue] = {
+      :days => {
+        :all => [
+          {
+            :begin => "5:00 PM",
+            :end => "nope"
+          }
+        ]
+      }
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
-    check[:subdue][:exceptions] = [{:begin => "15:00", :end => "15:30"}]
+    check[:subdue] = {
+      :days => {
+        :all => [
+          {
+            :begin => "5:00 PM",
+            :end => "8:00 AM"
+          }
+        ]
+      }
+    }
     @validator.validate_check(check)
     expect(@validator.reset).to eq(0)
   end
@@ -358,6 +374,86 @@ describe "Sensu::Settings::Validator" do
     expect(@validator.reset).to eq(0)
   end
 
+  it "can validate filter when" do
+    filter = {
+      :attributes => {}
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(0)
+    filter[:when] = true
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(1)
+    filter[:when] = {
+      :days => []
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(1)
+    filter[:when] = {
+      :days => {}
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(0)
+    filter[:when] = {
+      :days => {
+        :nope => {}
+      }
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(1)
+    filter[:when] = {
+      :days => {
+        :nope => []
+      }
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(1)
+    filter[:when] = {
+      :days => {
+        :all => {}
+      }
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(1)
+    filter[:when] = {
+      :days => {
+        :all => []
+      }
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(0)
+    filter[:when] = {
+      :days => {
+        :all => [true]
+      }
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(1)
+    filter[:when] = {
+      :days => {
+        :all => [
+          {
+            :begin => "5:00 PM",
+            :end => "nope"
+          }
+        ]
+      }
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(1)
+    filter[:when] = {
+      :days => {
+        :all => [
+          {
+            :begin => "5:00 PM",
+            :end => "8:00 AM"
+          }
+        ]
+      }
+    }
+    @validator.validate_filter(filter)
+    expect(@validator.reset).to eq(0)
+  end
+
   it "can validate a mutator definition" do
     mutator = {}
     @validator.validate_mutator(mutator)
@@ -526,26 +622,6 @@ describe "Sensu::Settings::Validator" do
     expect(@validator.reset).to eq(0)
   end
 
-  it "can validate handler subdue" do
-    handler = {
-      :name => "foo",
-      :type => "pipe",
-      :command => "cat"
-    }
-    @validator.validate_handler(handler)
-    expect(@validator.reset).to eq(0)
-    handler[:subdue] = true
-    @validator.validate_handler(handler)
-    expect(@validator.reset).to eq(1)
-    handler[:subdue] = {
-      :at => "handler",
-      :begin => "14:30",
-      :end => "15:45"
-    }
-    @validator.validate_handler(handler)
-    expect(@validator.reset).to eq(0)
-  end
-
   it "can validate a client definition" do
     client = true
     @validator.validate_client(client)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-settings
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-json
@@ -107,7 +107,7 @@ files:
 - lib/sensu/settings/validators/handler.rb
 - lib/sensu/settings/validators/mutator.rb
 - lib/sensu/settings/validators/sensu.rb
-- lib/sensu/settings/validators/subdue.rb
+- lib/sensu/settings/validators/time_window.rb
 - lib/sensu/settings/validators/transport.rb
 - sensu-settings.gemspec
 - spec/assets/alternative/conf.d/loop

data/lib/sensu/settings/validators/subdue.rb

@@ -1,68 +0,0 @@
-module Sensu
-  module Settings
-    module Validators
-      module Subdue
-        # Validate subdue time.
-        # Validates: begin, end
-        #
-        # @param scope [String] definition scope to report under.
-        # @param definition [Hash] sensu definition.
-        # @param object [Hash] to have begin and end validated.
-        def validate_subdue_time(scope, definition, object)
-          if is_a_hash?(object)
-            if either_are_set?(object[:begin], object[:end])
-              must_be_time(object[:begin], object[:end]) ||
-                invalid(definition, "#{scope} begin and end times must be valid")
-            end
-          else
-            invalid(definition, "#{scope} must be a hash")
-          end
-        end
-
-        # Validate subdue days.
-        # Validates: days
-        #
-        # @param definition [Hash] sensu definition.
-        def validate_subdue_days(definition)
-          subdue = definition[:subdue]
-          must_be_an_array_if_set(subdue[:days]) ||
-            invalid(definition, "subdue days must be an array")
-          if is_an_array?(subdue[:days])
-            days = %w[sunday monday tuesday wednesday thursday friday saturday]
-            must_be_either(days, subdue[:days]) ||
-              invalid(definition, "subdue days must be valid days of the week")
-          end
-        end
-
-        # Validate subdue exceptions.
-        # Validates: exceptions (begin, end)
-        #
-        # @param definition [Hash] sensu definition.
-        def validate_subdue_exceptions(definition)
-          subdue = definition[:subdue]
-          must_be_an_array_if_set(subdue[:exceptions]) ||
-            invalid(definition, "subdue exceptions must be an array")
-          if is_an_array?(subdue[:exceptions])
-            subdue[:exceptions].each do |exception|
-              validate_subdue_time("subdue exceptions", definition, exception)
-            end
-          end
-        end
-
-        # Validate Sensu subdue, for either a check or handler definition.
-        #
-        # @param definition [Hash] sensu definition.
-        def validate_subdue(definition)
-          subdue = definition[:subdue]
-          validate_subdue_time("subdue", definition, subdue)
-          if is_a_hash?(subdue)
-            must_be_either_if_set(%w[handler publisher], subdue[:at]) ||
-              invalid(definition, "subdue at must be either handler or publisher")
-            validate_subdue_days(definition)
-            validate_subdue_exceptions(definition)
-          end
-        end
-      end
-    end
-  end
-end