sensu-settings 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca8f0399f312c1be636acd8b5e2821e506293e27
-  data.tar.gz: f555802b381e16ee23947c3e384c370b6c865eca
+  metadata.gz: 465a54c899448ee7c064f1228578e3fd226daecf
+  data.tar.gz: 4e1254a5e35fbdaee4e01be93e14e3e1295a0928
 SHA512:
-  metadata.gz: b797e36e3831943b86bbc9ff9fa38cac622b70a987b35041ed5eb8fe5b8a72db9143037d7e34379872490cd9104f7c8e1899a3b5a7c1aefdaed42d58a872b4d4
-  data.tar.gz: fea30269b1e5d2ee02db99adee8dfcb035fb8bac8ef334d0331137f6e1808a2ded3926dc3f0e91566ecbdc2fc9ea2a9c3d0b1e29ab9bc0c743688d265a4f2a8d
+  metadata.gz: 9bd57ce2da4854212f624673af2da4d7c96e0ca1c74c9a825c4f71f4723a041ff1f3ea6f70e878016cfd1e14c92c2cf0c7c33c8c62f1b75b7cbcab69931b391d
+  data.tar.gz: bd9d90d96bdf5546b13b796321410897c2d2d80a39688d055759fd4ab10cfff074f1fcd02b90b30b688d004410c288e83df4d3683f4762b82f683ec5c3aac578

data/lib/sensu/settings/loader.rb

@@ -1,6 +1,7 @@
 require "sensu/settings/validator"
 require "multi_json"
-require "tempfile"
+require "tmpdir"
+require "socket"
 
 module Sensu
   module Settings
@@ -71,24 +72,16 @@ module Sensu
       end
 
       # Load settings from the environment.
-      # Loads: RABBITMQ_URL, REDIS_URL, REDISTOGO_URL, API_PORT, PORT
+      #
+      # Loads: SENSU_TRANSPORT_NAME, RABBITMQ_URL, REDIS_URL,
+      #        SENSU_CLIENT_NAME, SENSU_CLIENT_ADDRESS
+      #        SENSU_CLIENT_SUBSCRIPTIONS, SENSU_API_PORT
       def load_env
-        if ENV["RABBITMQ_URL"]
-          @settings[:rabbitmq] = ENV["RABBITMQ_URL"]
-          warning("using rabbitmq url environment variable", :rabbitmq => @settings[:rabbitmq])
-        end
-        ENV["REDIS_URL"] ||= ENV["REDISTOGO_URL"]
-        if ENV["REDIS_URL"]
-          @settings[:redis] = ENV["REDIS_URL"]
-          warning("using redis url environment variable", :redis => @settings[:redis])
-        end
-        ENV["API_PORT"] ||= ENV["PORT"]
-        if ENV["API_PORT"]
-          @settings[:api] ||= {}
-          @settings[:api][:port] = ENV["API_PORT"].to_i
-          warning("using api port environment variable", :api => @settings[:api])
-        end
-        @indifferent_access = false
+        load_transport_env
+        load_rabbitmq_env
+        load_redis_env
+        load_client_env
+        load_api_env
       end
 
       # Load settings from a JSON file.
@@ -136,17 +129,6 @@ module Sensu
         end
       end
 
-      # Create a temporary file containing the colon delimited list of
-      # loaded configuration files.
-      #
-      # @return [String] tempfile path.
-      def create_loaded_tempfile!
-        file = Tempfile.new("sensu_loaded_files")
-        file.write(@loaded_files.join(":"))
-        file.close
-        file.path
-      end
-
       # Set Sensu settings related environment variables. This method
       # sets `SENSU_LOADED_TEMPFILE` to a new temporary file path,
       # a file containing the colon delimited list of loaded
@@ -217,6 +199,68 @@ module Sensu
         @indifferent_access = true
       end
 
+      # Load Sensu transport settings from the environment. This
+      # method sets the Sensu transport name to `SENSU_TRANSPORT_NAME`
+      # if set.
+      def load_transport_env
+        if ENV["SENSU_TRANSPORT_NAME"]
+          @settings[:transport][:name] = ENV["SENSU_TRANSPORT_NAME"]
+          warning("using sensu transport name environment variable", :transport => @settings[:transport])
+          @indifferent_access = false
+        end
+      end
+
+      # Load Sensu RabbitMQ settings from the environment. This method
+      # sets the RabbitMQ settings to `RABBITMQ_URL` if set. The Sensu
+      # RabbitMQ transport accepts a URL string for options.
+      def load_rabbitmq_env
+        if ENV["RABBITMQ_URL"]
+          @settings[:rabbitmq] = ENV["RABBITMQ_URL"]
+          warning("using rabbitmq url environment variable", :rabbitmq => @settings[:rabbitmq])
+          @indifferent_access = false
+        end
+      end
+
+      # Load Sensu Redis settings from the environment. This method
+      # sets the Redis settings to `REDIS_URL` if set. The Sensu Redis
+      # library accepts a URL string for options, this applies to data
+      # storage and the transport.
+      def load_redis_env
+        if ENV["REDIS_URL"]
+          @settings[:redis] = ENV["REDIS_URL"]
+          warning("using redis url environment variable", :redis => @settings[:redis])
+          @indifferent_access = false
+        end
+      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.
+      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(",")
+          warning("using sensu client environment variables", :client => @settings[:client])
+          @indifferent_access = false
+        end
+      end
+
+      # Load Sensu API settings from the environment. This method sets
+      # the API port to `SENSU_API_PORT` if set.
+      def load_api_env
+        if ENV["SENSU_API_PORT"]
+          @settings[:api] ||= {}
+          @settings[:api][:port] = ENV["SENSU_API_PORT"].to_i
+          warning("using api port environment variable", :api => @settings[:api])
+          @indifferent_access = false
+        end
+      end
+
       # Read a configuration file and force its encoding to 8-bit
       # ASCII, ignoring invalid characters. If there is a UTF-8 BOM,
       # it will be removed. Some JSON parsers force ASCII but do not
@@ -277,6 +321,25 @@ module Sensu
         end
       end
 
+      # Create a temporary file containing the colon delimited list of
+      # loaded configuration files. Ruby TempFile is not used to
+      # create the temporary file as it would be removed if the Sensu
+      # service daemonizes (fork/detach). The file is created in the
+      # system temporary file directory for the platform (Linux,
+      # Windows, etc.) and the file name contains the Sensu service
+      # name to reduce the likelihood of one Sensu service affecting
+      # another.
+      #
+      # @return [String] tempfile path.
+      def create_loaded_tempfile!
+        file_name = "sensu_#{sensu_service_name}_loaded_files"
+        path = File.join(Dir.tmpdir, file_name)
+        File.open(path, "w") do |file|
+          file.write(@loaded_files.join(":"))
+        end
+        path
+      end
+
       # Retrieve Sensu service name.
       #
       # @return [String] service name.
@@ -284,6 +347,15 @@ module Sensu
         File.basename($0).split("-").last
       end
 
+      # Retrieve the system hostname. If the hostname cannot be
+      # determined and an error is thrown, return "unknown", the same
+      # value Sensu uses for JIT clients.
+      #
+      # @return [String] system hostname.
+      def system_hostname
+        Socket.gethostname rescue "unknown"
+      end
+
       # Record a warning.
       #
       # @param message [String] warning message.

data/sensu-settings.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-settings"
-  spec.version       = "2.0.0"
+  spec.version       = "3.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,34 +25,65 @@ describe "Sensu::Settings::Loader" do
     expect(failures.size).to eq(0)
   end
 
+  it "can load Sensu transport settings from the environment" do
+    ENV["SENSU_TRANSPORT_NAME"] = "redis"
+    @loader.load_env
+    expect(@loader.warnings.size).to eq(1)
+    warning = @loader.warnings.shift
+    transport = warning[:transport]
+    expect(transport[:name]).to eq("redis")
+    ENV["SENSU_TRANSPORT_NAME"] = nil
+  end
+
   it "can load RabbitMQ settings from the environment" do
     ENV["RABBITMQ_URL"] = "amqp://guest:guest@localhost:5672/"
     @loader.load_env
     expect(@loader.warnings.size).to eq(1)
+    warning = @loader.warnings.shift
+    expect(warning[:rabbitmq]).to eq("amqp://guest:guest@localhost:5672/")
     ENV["RABBITMQ_URL"] = nil
   end
 
   it "can load Redis settings from the environment" do
-    ENV["REDIS_URL"] = "redis://username:password@localhost:6789"
+    ENV["REDIS_URL"] = "redis://:password@localhost:6789"
     @loader.load_env
     expect(@loader.warnings.size).to eq(1)
+    warning = @loader.warnings.shift
+    expect(warning[:redis]).to eq("redis://:password@localhost:6789")
     ENV["REDIS_URL"] = nil
   end
 
-  it "can load Sensu API settings from the environment" do
-    ENV["API_PORT"] = "4567"
+  it "can load Sensu client settings with defaults from the environment" do
+    ENV["SENSU_CLIENT_NAME"] = "i-424242"
     @loader.load_env
     expect(@loader.warnings.size).to eq(1)
-    ENV["API_PORT"] = nil
+    warning = @loader.warnings.shift
+    client = warning[:client]
+    expect(client[:name]).to eq("i-424242")
+    expect(client[:address]).to be_kind_of(String)
+    expect(client[:subscriptions]).to eq([])
+    ENV["SENSU_CLIENT_NAME"] = nil
+  end
+
+  it "can load Sensu client settings with defaults from the environment" do
+    ENV["SENSU_CLIENT_NAME"] = "i-424242"
+    ENV["SENSU_CLIENT_ADDRESS"] = "127.0.0.1"
+    ENV["SENSU_CLIENT_SUBSCRIPTIONS"] = "foo,bar,baz"
+    @loader.load_env
+    expect(@loader.warnings.size).to eq(1)
+    warning = @loader.warnings.shift
+    client = warning[:client]
+    expect(client[:name]).to eq("i-424242")
+    expect(client[:address]).to eq("127.0.0.1")
+    expect(client[:subscriptions]).to eq(["foo", "bar", "baz"])
+    ENV["SENSU_CLIENT_NAME"] = nil
   end
 
-  it "can load Redis and Sensu API settings from the environment using alternative variables" do
-    ENV["REDISTOGO_URL"] = "redis://username:password@localhost:6789"
-    ENV["PORT"] = "4567"
+  it "can load Sensu API settings from the environment" do
+    ENV["SENSU_API_PORT"] = "4567"
     @loader.load_env
-    expect(@loader.warnings.size).to eq(2)
-    ENV["REDISTOGO_URL"] = nil
-    ENV["PORT"] = nil
+    expect(@loader.warnings.size).to eq(1)
+    ENV["SENSU_API_PORT"] = nil
   end
 
   it "can load settings from a file" do
@@ -130,7 +161,7 @@ describe "Sensu::Settings::Loader" do
     @loader.load_directory(@config_dir)
     expect(@loader.loaded_files.size).to eq(3)
     @loader.set_env!
-    expect(ENV["SENSU_LOADED_TEMPFILE"]).to match(/sensu_loaded_files/)
+    expect(ENV["SENSU_LOADED_TEMPFILE"]).to match(/sensu_rspec_loaded_files/)
     loaded_files = IO.read(ENV["SENSU_LOADED_TEMPFILE"])
     expect(loaded_files.split(":")).to eq(@loader.loaded_files)
   end

data/spec/settings_spec.rb

@@ -38,7 +38,7 @@ describe "Sensu::Settings" do
     expect(settings[:checks][:merger][:command]).to eq("echo -n merger")
     expect(settings[:checks][:merger][:subscribers]).to eq(["foo", "bar"])
     expect(settings[:checks][:nested][:command]).to eq("true")
-    expect(ENV["SENSU_LOADED_TEMPFILE"]).to match(/sensu_loaded_files/)
+    expect(ENV["SENSU_LOADED_TEMPFILE"]).to match(/sensu_rspec_loaded_files/)
     loaded_files = IO.read(ENV["SENSU_LOADED_TEMPFILE"])
     expect(loaded_files.split(":")).to eq(settings.loaded_files)
     ENV["RABBITMQ_URL"] = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-settings
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json