sensu-settings 5.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8924c88d3f2c09c838a8d63483dc5c5b43e4dfb
-  data.tar.gz: 6602361eb730baa005e103d0f916dc73c387febc
+  metadata.gz: b4a1cb240875b92bbe08382f6b826cdd5842fbe8
+  data.tar.gz: a106106ad7f49e8431fef9ffcfa4ce0465b95a5a
 SHA512:
-  metadata.gz: 51c1f51bd223da49a9cf4221ae0504758841572628359d491dba61e5a091a77fbe51957f2aca71a4deb4a00c612982c485075a110239e6ecf5d8ebcd41166bc7
-  data.tar.gz: 343e7d524dc24d974007ee1bf190048084ab0005ed23ec1574bf801d31dc29f50083b62490f49991c80a0820c1ac54d2d68707278bbebd2ffefc17364032195e
+  metadata.gz: b835741087e47bd2a3aad317dfd9d00f162182348c5e545bc249fdc0d1a91775a05e3510cc3e13abc81a76d73ef3bad98619da29421545652f3632469722b316
+  data.tar.gz: 5546f23571be9b5d6414b730fc14913272f3493ec7e0aaa2cb4caf44f633504f5475a111579c6fec99a2b0adb01e4da4e8e6f713614f76d8fdced1191cca0f35

data/lib/sensu/settings/loader.rb

@@ -29,6 +29,23 @@ module Sensu
         self.class.create_category_methods
       end
 
+      # Auto-detected defaults for client definition
+      #
+      # Client name defaults to system hostname.
+      # Client address defaults to first detected non-loopback ipv4 address.
+      #
+      # Client subscriptions are intentionally omitted here as sensu-client
+      # will provide defaults using client name after final settings are
+      # loaded.
+      #
+      # @return [Hash] default client settings
+      def client_defaults
+        {
+          :name => system_hostname,
+          :address => system_address
+        }
+      end
+
       # Default settings.
       #
       # @return [Hash] settings.
@@ -47,6 +64,9 @@ module Sensu
         CATEGORIES.each do |category|
           default[category] = {}
         end
+        if ["client", "rspec"].include?(sensu_service_name)
+          default[:client] = client_defaults
+        end
         default
       end
 
@@ -139,8 +159,12 @@ module Sensu
       def load_directory(directory)
         warning("loading config files from directory", :directory => directory)
         path = directory.gsub(/\\(?=\S)/, "/")
-        Dir.glob(File.join(path, "**{,/*/**}/*.json")).uniq.each do |file|
-          load_file(file)
+        if File.readable?(path) && File.executable?(path)
+          Dir.glob(File.join(path, "**{,/*/**}/*.json")).uniq.each do |file|
+            load_file(file)
+          end
+        else
+          load_error("insufficient permissions for loading", :directory => directory)
         end
       end
 
@@ -249,20 +273,19 @@ module Sensu
       end
 
       # Load Sensu client settings from the environment. This method
-      # loads client settings from several variables if
-      # `SENSU_CLIENT_NAME` is set: `SENSU_CLIENT_NAME`,
-      # `SENSU_CLIENT_ADDRESS`, and `SENSU_CLIENT_SUBSCRIPTIONS`. The
-      # Sensu client address defaults to the current system hostname
-      # and subscriptions defaults to an empty array.
+      # loads client settings from several variables:
+      # `SENSU_CLIENT_NAME`, `SENSU_CLIENT_ADDRESS`, and
+      # `SENSU_CLIENT_SUBSCRIPTIONS`.
+      #
+      # The client subscriptions defaults to an empty array.
       def load_client_env
-        if ENV["SENSU_CLIENT_NAME"]
-          @settings[:client] ||= {}
-          @settings[:client][:name] = ENV["SENSU_CLIENT_NAME"]
-          @settings[:client][:address] = ENV.fetch("SENSU_CLIENT_ADDRESS", system_hostname)
-          @settings[:client][:subscriptions] = ENV.fetch("SENSU_CLIENT_SUBSCRIPTIONS", "").split(",")
+        @settings[:client][:name] = ENV["SENSU_CLIENT_NAME"] if ENV["SENSU_CLIENT_NAME"]
+        @settings[:client][:address] = ENV["SENSU_CLIENT_ADDRESS"] if ENV["SENSU_CLIENT_ADDRESS"]
+        @settings[:client][:subscriptions] = ENV.fetch("SENSU_CLIENT_SUBSCRIPTIONS", "").split(",")
+        if ENV.keys.any? {|k| k =~ /^SENSU_CLIENT/}
           warning("using sensu client environment variables", :client => @settings[:client])
-          @indifferent_access = false
         end
+        @indifferent_access = false
       end
 
       # Load Sensu API settings from the environment. This method sets
@@ -372,6 +395,17 @@ module Sensu
         Socket.gethostname rescue "unknown"
       end
 
+      # Retrieve the system IP address. If a valid non-loopback
+      # IPv4 address cannot be found and an error is thrown,
+      # "unknown" will be returned.
+      #
+      # @return [String] system ip address
+      def system_address
+        Socket.ip_address_list.find { |address|
+          address.ipv4? && !address.ipv4_loopback?
+        }.ip_address rescue "unknown"
+      end
+
       # Record a warning.
       #
       # @param message [String] warning message.

data/lib/sensu/settings/rules.rb

@@ -113,10 +113,12 @@ module Sensu
       # Check that value items are all strings and not empty.
       #
       # @param value [Array] with items to check.
+      # @param regex [Regexp] to validate string items with.
       # @return [TrueClass, FalseClass]
-      def items_must_be_strings(value)
+      def items_must_be_strings(value, regex=nil)
         value.all? do |item|
-          item.is_a?(String) && !item.empty?
+          item.is_a?(String) && !item.empty? &&
+            (regex.nil? || item =~ regex)
         end
       end
 

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

@@ -97,12 +97,22 @@ module Sensu
         #
         # @param check [Hash] sensu check definition.
         def validate_check_aggregate(check)
-          if is_a_string?(check[:aggregate])
-            must_match_regex(/\A[\w\.-]+\z/, check[:aggregate]) ||
-              invalid(check, "check aggregate cannot contain spaces or special characters")
-          else
-            must_be_boolean(check[:aggregate]) ||
-              invalid(check, "check aggregate must be a string (name) or boolean")
+          if check[:aggregates]
+            if is_an_array?(check[:aggregates])
+              items_must_be_strings(check[:aggregates], /\A[\w\.:|-]+\z/) ||
+                invalid(check, "check aggregates items must be strings without spaces or special characters")
+            else
+              invalid(check, "check aggregates must be an array")
+            end
+          end
+          if check[:aggregate]
+            if is_a_string?(check[:aggregate])
+              must_match_regex(/\A[\w\.:|-]+\z/, check[:aggregate]) ||
+                invalid(check, "check aggregate cannot contain spaces or special characters")
+            else
+              must_be_boolean(check[:aggregate]) ||
+                invalid(check, "check aggregate must be a string (name) or boolean")
+            end
           end
         end
 
@@ -129,7 +139,7 @@ module Sensu
           validate_check_scheduling(check)
           validate_check_handling(check)
           validate_check_ttl(check) if check[:ttl]
-          validate_check_aggregate(check) if check[:aggregate]
+          validate_check_aggregate(check)
           validate_check_flap_detection(check)
           validate_subdue(check) if check[:subdue]
         end

data/sensu-settings.gemspec

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

data/spec/loader_spec.rb

@@ -25,6 +25,13 @@ describe "Sensu::Settings::Loader" do
     expect(failures.size).to eq(0)
   end
 
+  it "can load Sensu client settings with auto-detected defaults" do
+    @loader.load_env
+    expect(@loader.warnings.size).to eq(0)
+    expect(@loader.default_settings[:client][:name]).to be_kind_of(String)
+    expect(@loader.default_settings[:client][:address]).to be_kind_of(String)
+  end
+
   it "can load Sensu transport settings from the environment" do
     ENV["SENSU_TRANSPORT_NAME"] = "redis"
     @loader.load_env
@@ -77,6 +84,8 @@ describe "Sensu::Settings::Loader" do
     expect(client[:address]).to eq("127.0.0.1")
     expect(client[:subscriptions]).to eq(["foo", "bar", "baz"])
     ENV["SENSU_CLIENT_NAME"] = nil
+    ENV["SENSU_CLIENT_ADDRESS"] = nil
+    ENV["SENSU_CLIENT_SUBSCRIPTIONS"] = nil
   end
 
   it "can load Sensu API settings from the environment" do
@@ -153,10 +162,13 @@ describe "Sensu::Settings::Loader" do
   end
 
   it "can attempt to load settings from files in a nonexistent directory" do
-    @loader.load_directory("/tmp/rottentomatos")
+    expect {
+      @loader.load_directory("/tmp/rottentomatos")
+    }.to raise_error(Sensu::Settings::Loader::Error)
     expect(@loader.warnings.size).to eq(1)
-    warning = @loader.warnings.first
-    expect(warning[:message]).to eq("loading config files from directory")
+    expect(@loader.warnings.first[:message]).to eq("loading config files from directory")
+    expect(@loader.errors.size).to eq(1)
+    expect(@loader.errors.first[:message]).to eq("insufficient permissions for loading")
   end
 
   it "can set environment variables for child processes" do

data/spec/validator_spec.rb

@@ -188,6 +188,27 @@ describe "Sensu::Settings::Validator" do
     check[:ttl] = 1
     @validator.validate_check(check)
     expect(@validator.reset).to eq(0)
+    check[:aggregates] = "string"
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(1)
+    check[:aggregates] = true
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(1)
+    check[:aggregates] = [1]
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(1)
+    check[:aggregates] = [true]
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(1)
+    check[:aggregates] = ["foo", "$bar$"]
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(1)
+    check[:aggregates] = ["foo", "bar"]
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(0)
+    check[:aggregates] = [":::some_custom_attr:::-checks", ":::another_custom_attr|default_value:::-checks"]
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(0)
     check[:aggregate] = 1
     @validator.validate_check(check)
     expect(@validator.reset).to eq(1)
@@ -200,6 +221,9 @@ describe "Sensu::Settings::Validator" do
     check[:aggregate] = "test"
     @validator.validate_check(check)
     expect(@validator.reset).to eq(0)
+    check[:aggregate] = ":::some_custom_attribute|magic:::"
+    @validator.validate_check(check)
+    expect(@validator.reset).to eq(0)
     check[:low_flap_threshold] = "25"
     @validator.validate_check(check)
     expect(@validator.reset).to eq(2)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-settings
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-03 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-json