tcell_agent 0.4.0 → 1.0.0

data/spec/lib/tcell_agent/config/unknown_options_spec.rb

@@ -2,195 +2,212 @@ require 'spec_helper'
 
 module TCellAgent
   module Config
-
     describe Validate do
-      describe ".get_unknown_options" do
-        context "with an unknown tcell environment variable set" do
-          it "should return a message about the unknown variable" do
-
-            orig_allow_uap = ENV.fetch("TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS", nil)
-            orig_allow_uafp = ENV.fetch("TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS", nil)
-            orig_allow_ap = ENV.fetch("TCELL_AGENT_ALLOW_PAYLOADS", nil)
-            orig_demomode = ENV.fetch("TCELL_DEMOMODE", nil)
-            orig_agent_home = ENV.fetch("TCELL_AGENT_HOME", nil)
-            orig_agent_log_dir = ENV.fetch("TCELL_AGENT_LOG_DIR", nil)
-            orig_agent_config = ENV.fetch("TCELL_AGENT_CONFIG", nil)
-            orig_agent_app_id = ENV.fetch("TCELL_AGENT_APP_ID", nil)
-            orig_agent_api_key = ENV.fetch("TCELL_AGENT_API_KEY", nil)
-            orig_agent_host_identifier = ENV.fetch("TCELL_AGENT_HOST_IDENTIFIER", nil)
-            orig_input_url = ENV.fetch("TCELL_INPUT_URL", nil)
-            orig_hmac_key = ENV.fetch("TCELL_HMAC_KEY", nil)
-            orig_api_url = ENV.fetch("TCELL_API_URL", nil)
-
-            ENV["TCELL_HACK"] = "hack the system"
-            ENV["TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS"] = "valid"
-            ENV["TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS"] = "valid"
-            ENV["TCELL_AGENT_ALLOW_PAYLOADS"] = "valid"
-            ENV["TCELL_DEMOMODE"] = "valid"
-            ENV["TCELL_AGENT_HOME"] = "valid"
-            ENV["TCELL_AGENT_LOG_DIR"] = "valid"
-            ENV["TCELL_AGENT_CONFIG"] = "valid"
-            ENV["TCELL_AGENT_APP_ID"] = "valid"
-            ENV["TCELL_AGENT_API_KEY"] = "valid"
-            ENV["TCELL_AGENT_HOST_IDENTIFIER"] = "valid"
-            ENV["TCELL_INPUT_URL"] = "valid"
-            ENV["TCELL_HMAC_KEY"] = "valid"
-            ENV["TCELL_API_URL"] = "valid"
+      describe '.get_unknown_options' do
+        context 'with an unknown tcell environment variable set' do
+          it 'should return a message about the unknown variable' do
+            orig_allow_uap = ENV.fetch('TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS', nil)
+            orig_allow_uafp = ENV.fetch('TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS', nil)
+            orig_allow_ap = ENV.fetch('TCELL_AGENT_ALLOW_PAYLOADS', nil)
+            orig_demomode = ENV.fetch('TCELL_DEMOMODE', nil)
+            orig_agent_home = ENV.fetch('TCELL_AGENT_HOME', nil)
+            orig_agent_log_dir = ENV.fetch('TCELL_AGENT_LOG_DIR', nil)
+            orig_agent_config = ENV.fetch('TCELL_AGENT_CONFIG', nil)
+            orig_agent_app_id = ENV.fetch('TCELL_AGENT_APP_ID', nil)
+            orig_agent_api_key = ENV.fetch('TCELL_AGENT_API_KEY', nil)
+            orig_agent_host_identifier = ENV.fetch('TCELL_AGENT_HOST_IDENTIFIER', nil)
+            orig_input_url = ENV.fetch('TCELL_INPUT_URL', nil)
+            orig_hmac_key = ENV.fetch('TCELL_HMAC_KEY', nil)
+            orig_api_url = ENV.fetch('TCELL_API_URL', nil)
+            orig_password_hmac_key = ENV.fetch('TCELL_PASSWORD_HMAC_KEY', nil)
+
+            ENV['TCELL_HACK'] = 'hack the system'
+            ENV['TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS'] = 'valid'
+            ENV['TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS'] = 'valid'
+            ENV['TCELL_AGENT_ALLOW_PAYLOADS'] = 'valid'
+            ENV['TCELL_DEMOMODE'] = 'valid'
+            ENV['TCELL_AGENT_HOME'] = 'valid'
+            ENV['TCELL_AGENT_LOG_DIR'] = 'valid'
+            ENV['TCELL_AGENT_CONFIG'] = 'valid'
+            ENV['TCELL_AGENT_APP_ID'] = 'valid'
+            ENV['TCELL_AGENT_API_KEY'] = 'valid'
+            ENV['TCELL_AGENT_HOST_IDENTIFIER'] = 'valid'
+            ENV['TCELL_INPUT_URL'] = 'valid'
+            ENV['TCELL_HMAC_KEY'] = 'valid'
+            ENV['TCELL_API_URL'] = 'valid'
+            ENV['TCELL_PASSWORD_HMAC_KEY'] = 'valid'
 
             messages = Validate.get_unknown_options(nil)
 
-            ENV.delete "TCELL_HACK"
+            ENV.delete 'TCELL_HACK'
             if orig_allow_uap
-              ENV["TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS"] = orig_allow_uap
+              ENV['TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS'] = orig_allow_uap
             else
-              ENV.delete "TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS"
+              ENV.delete 'TCELL_AGENT_ALLOW_UNENCRYPTED_APPSENSOR_PAYLOADS'
             end
 
             if orig_allow_uafp
-                ENV["TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS"] = orig_allow_uafp
+              ENV['TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS'] = orig_allow_uafp
             else
-              ENV.delete "TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS"
+              ENV.delete 'TCELL_AGENT_ALLOW_UNENCRYPTED_APPFIREWALL_PAYLOADS'
             end
             if orig_allow_ap
-                ENV["TCELL_AGENT_ALLOW_PAYLOADS"] = orig_allow_ap
+              ENV['TCELL_AGENT_ALLOW_PAYLOADS'] = orig_allow_ap
             else
-              ENV.delete "TCELL_AGENT_ALLOW_PAYLOADS"
+              ENV.delete 'TCELL_AGENT_ALLOW_PAYLOADS'
             end
             if orig_demomode
-              ENV["TCELL_DEMOMODE"] = orig_demomode
+              ENV['TCELL_DEMOMODE'] = orig_demomode
             else
-              ENV.delete "TCELL_DEMOMODE"
+              ENV.delete 'TCELL_DEMOMODE'
             end
             if orig_agent_home
-              ENV["TCELL_AGENT_HOME"] = orig_agent_home
+              ENV['TCELL_AGENT_HOME'] = orig_agent_home
             else
-              ENV.delete "TCELL_AGENT_HOME"
+              ENV.delete 'TCELL_AGENT_HOME'
             end
             if orig_agent_log_dir
-              ENV["TCELL_AGENT_LOG_DIR"] = orig_agent_log_dir
+              ENV['TCELL_AGENT_LOG_DIR'] = orig_agent_log_dir
             else
-              ENV.delete "TCELL_AGENT_LOG_DIR"
+              ENV.delete 'TCELL_AGENT_LOG_DIR'
             end
             if orig_agent_config
-              ENV["TCELL_AGENT_CONFIG"] = orig_agent_config
+              ENV['TCELL_AGENT_CONFIG'] = orig_agent_config
             else
-              ENV.delete "TCELL_AGENT_CONFIG"
+              ENV.delete 'TCELL_AGENT_CONFIG'
             end
             if orig_agent_app_id
-              ENV["TCELL_AGENT_APP_ID"] = orig_agent_app_id
+              ENV['TCELL_AGENT_APP_ID'] = orig_agent_app_id
             else
-              ENV.delete "TCELL_AGENT_APP_ID"
+              ENV.delete 'TCELL_AGENT_APP_ID'
             end
             if orig_agent_api_key
-              ENV["TCELL_AGENT_API_KEY"] = orig_agent_api_key
+              ENV['TCELL_AGENT_API_KEY'] = orig_agent_api_key
             else
-              ENV.delete "TCELL_AGENT_API_KEY"
+              ENV.delete 'TCELL_AGENT_API_KEY'
             end
             if orig_agent_host_identifier
-              ENV["TCELL_AGENT_HOST_IDENTIFIER"] = orig_agent_host_identifier
+              ENV['TCELL_AGENT_HOST_IDENTIFIER'] = orig_agent_host_identifier
             else
-              ENV.delete "TCELL_AGENT_HOST_IDENTIFIER"
+              ENV.delete 'TCELL_AGENT_HOST_IDENTIFIER'
             end
             if orig_input_url
-              ENV["TCELL_INPUT_URL"] = orig_input_url
+              ENV['TCELL_INPUT_URL'] = orig_input_url
             else
-              ENV.delete "TCELL_INPUT_URL"
+              ENV.delete 'TCELL_INPUT_URL'
             end
             if orig_hmac_key
-              ENV["TCELL_HMAC_KEY"] = orig_hmac_key
+              ENV['TCELL_HMAC_KEY'] = orig_hmac_key
             else
-              ENV.delete "TCELL_HMAC_KEY"
+              ENV.delete 'TCELL_HMAC_KEY'
+            end
+            if orig_password_hmac_key
+              ENV['TCELL_PASSWORD_HMAC_KEY'] = orig_password_hmac_key
+            else
+              ENV.delete 'TCELL_PASSWORD_HMAC_KEY'
             end
             if orig_api_url
-              ENV["TCELL_API_URL"] = orig_api_url
+              ENV['TCELL_API_URL'] = orig_api_url
             else
-              ENV.delete "TCELL_API_URL"
+              ENV.delete 'TCELL_API_URL'
             end
 
-            expect(messages.sort).to eq([
-              "Unrecognized environment parameter (TCELL_*) found: TCELL_HACK"
-            ])
+            expect(messages.sort).to eq(
+              [
+                'Unrecognized environment parameter (TCELL_*) found: TCELL_HACK'
+              ]
+            )
           end
         end
 
-        context "with a config json with all options including some extra ones" do
-          it "should report the extra options in messages" do
+        context 'with a config json with all options including some extra ones' do
+          it 'should report the extra options in messages' do
             config_json = {
-                "first_level" => "boo",
-                "version" => 1,
-                "applications" => [{
-                    "second_level" => "boo",
-                    "name" => "name",
-                    "app_id" => "app id",
-                    "api_key" => "api key",
-                    "fetch_policies_from_tcell" => true,
-                    "preload_policy_filename" => "preload policy filename",
-                    "log_dir" => "custom log dir",
-                    "logging_options" => {
-                        "logging_level" => "boo",
-                        "enabled" => true,
-                        "level" => "DEBUG",
-                        "filename" => "filename"},
-                    "tcell_api_url" => "tcell api url",
-                    "tcell_input_url" => "tcell input url",
-                    "host_identifier" => "host identifier",
-                    "hipaaSafeMode" => "hipaa safe mode",
-                    "hmac_key" => "hmac key",
-                    "js_agent_api_base_url" => "js agent api base url",
-                    "js_agent_url" => "js agent url",
-                    "max_csp_header_bytes" => 512,
-                    "event_batch_size_limit" => 50,
-                    "allow_unencrypted_appsensor_payloads" => true,
-                    "allow_unencrypted_appfirewall_payloads" => true,
-                    "allow_payloads" => true,
-                    "data_exposure" => {
-                        "data_ex_level" => "boo",
-                        "max_data_ex_db_records_per_request" => 10000},
-                    "reverse_proxy" => true,
-                    "reverse_proxy_ip_address_header" => "reverse proxy ip address header",
-                    "demomode" => true,
-                    # Ruby only
-                    "disable_all" => false,
-                    "enabled" => true,
-                    "enable_event_manager" => true,
-                    "enable_event_consumer" => true,
-                    "enable_policy_polling" => true,
-                    "enable_instrumentation" => true,
-                    "enable_intercept_requests" => true,
-                    "instrument_for_events" => true,
-                    "agent_home_owner" => true,
-                    "enabled_instrumentations" => {
-                      "enabled_instrumentations_level" => "blah",
-                      "doorkeeper" => true,
-                      "devise" => true,
-                      "authlogic" => true}}]}
+              'first_level' => 'boo',
+              'version' => 1,
+              'applications' => [
+                {
+                  'second_level' => 'boo',
+                  'name' => 'name',
+                  'app_id' => 'app id',
+                  'api_key' => 'api key',
+                  'fetch_policies_from_tcell' => true,
+                  'preload_policy_filename' => 'preload policy filename',
+                  'log_dir' => 'custom log dir',
+                  'logging_options' => {
+                    'logging_level' => 'boo',
+                    'enabled' => true,
+                    'level' => 'DEBUG',
+                    'filename' => 'filename'
+                  },
+                  'tcell_api_url' => 'tcell api url',
+                  'tcell_input_url' => 'tcell input url',
+                  'host_identifier' => 'host identifier',
+                  'hipaaSafeMode' => 'hipaa safe mode',
+                  'hmac_key' => 'hmac key',
+                  'password_hmac_key' => 'password_hmac_key',
+                  'js_agent_api_base_url' => 'js agent api base url',
+                  'js_agent_url' => 'js agent url',
+                  'max_csp_header_bytes' => 512,
+                  'event_batch_size_limit' => 50,
+                  'allow_unencrypted_appsensor_payloads' => true,
+                  'allow_unencrypted_appfirewall_payloads' => true,
+                  'allow_payloads' => true,
+                  'data_exposure' => {
+                    'data_ex_level' => 'boo',
+                    'max_data_ex_db_records_per_request' => 10_000
+                  },
+                  'reverse_proxy' => true,
+                  'reverse_proxy_ip_address_header' => 'reverse proxy ip address header',
+                  'demomode' => true,
+                  # Ruby only
+                  'disable_all' => false,
+                  'enabled' => true,
+                  'enable_event_manager' => true,
+                  'enable_event_consumer' => true,
+                  'enable_policy_polling' => true,
+                  'enable_instrumentation' => true,
+                  'enable_intercept_requests' => true,
+                  'instrument_for_events' => true,
+                  'agent_home_owner' => true,
+                  'enabled_instrumentations' => {
+                    'enabled_instrumentations_level' => 'blah',
+                    'doorkeeper' => true,
+                    'devise' => true,
+                    'authlogic' => true
+                  }
+                }
+              ]
+            }
 
             messages = Validate.get_unknown_options(config_json)
 
-            expect(messages.sort).to eq([
-              "Unrecognized config setting key: data_ex_level",
-              "Unrecognized config setting key: enabled_instrumentations_level",
-              "Unrecognized config setting key: first_level",
-              "Unrecognized config setting key: logging_level",
-              "Unrecognized config setting key: second_level"
-            ])
+            expect(messages.sort).to eq(
+              [
+                'Unrecognized config setting key: data_ex_level',
+                'Unrecognized config setting key: enabled_instrumentations_level',
+                'Unrecognized config setting key: first_level',
+                'Unrecognized config setting key: logging_level',
+                'Unrecognized config setting key: second_level'
+              ]
+            )
           end
         end
 
-        context "with a config json that has more than one application" do
-          it "should report the misconfiguration" do
-            config_json = {"version" => 1, "applications" => [{}, {}]}
+        context 'with a config json that has more than one application' do
+          it 'should report the misconfiguration' do
+            config_json = { 'version' => 1, 'applications' => [{}, {}] }
 
             messages = Validate.get_unknown_options(config_json)
 
-            expect(messages.sort).to eq([
-              "Multiple applications detected in config file"
-            ])
+            expect(messages.sort).to eq(
+              [
+                'Multiple applications detected in config file'
+              ]
+            )
           end
         end
       end
     end
-
   end
 end
-