soar_auditing_provider 0.9.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 056cf6242d669750fa2c234eb4cfa2504920a2c8
-  data.tar.gz: 7e6ea39e550d7e8e7a58d0c08c0457a47cdebc88
+  metadata.gz: 4390d2df4df9f1cd83f6ca1b4c89666a8d04f6f7
+  data.tar.gz: f56c79fc2d8abbfa76cb3191c6a51768a41fbcd2
 SHA512:
-  metadata.gz: c6a678c6102764415268ec84d48a3b286267be8074bc31fcdc1b25ec006a219ace7492760ac714b5196c0f18456fb712effd74f2f0cac94a4425505ceae5cd4c
-  data.tar.gz: 42eba1261f942b1a08ecc7bbd83c3ed791e1207abe3635f49bd6142d4eec38aed65a3e2f1fe046ac971e162c9edc2d7c8a52f6e986922ec44625ae55ee2be483
+  metadata.gz: 4d69636507b2a922cd24068f58f42271f25353230c6549838b44a276d1038e804f576a3b931df470e49fe96a9aa421c615697be63343981c158e171115777a77
+  data.tar.gz: c16d6398b32618d03bb1b9c94412068164c16062177ff30cf3c6aeaf852096ad710c7a78151731cc73eeacf9e3ddabc47ebe99947e0a255387fee377d6629544

data/README.md

@@ -51,7 +51,7 @@ Initialize and configure the provider.
 ```ruby
 AUDITING_CONFIGURATION = {
   'auditing' => {
-    'level' => 'debug',
+    'level' => 'info',
     'queue_worker' => {
       'queue_size' => 1000,
       'initial_back_off_in_seconds' => 1,
@@ -121,6 +121,8 @@ class Main
   AUDITING_CONFIGURATION = {
     'auditing' => {
       'level' => 'debug',
+      'install_exit_handler' => 'true',
+      'add_caller_source_location' => 'false',
       'queue_worker' => {
         'queue_size' => 1000,
         'initial_back_off_in_seconds' => 1,
@@ -196,6 +198,12 @@ At present only the buffer overflow count is avialable:
   { 'audit_buffer_overflows' => 123 }
 ```
 
+## Testing
+
+Behavioural driven testing can be performed by testing so:
+
+    $ bundle exec rspec -cfd spec/*
+
 ## Contributing
 
 Bug reports and feature requests are welcome by email to ernst dot van dot graan at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)

data/lib/soar_auditing_provider/auditing_provider.rb

@@ -44,27 +44,27 @@ module SoarAuditingProvider
     end
 
     def debug(data, flow_identifier = nil)
-      enqueue(:debug, format(:debug, data, flow_identifier))
+      enqueue(:debug, format(:debug, prepend_caller_information(data), flow_identifier))
     end
 
     def info(data, flow_identifier = nil)
-      enqueue(:info, format(:info, data, flow_identifier))
+      enqueue(:info, format(:info, prepend_caller_information(data), flow_identifier))
     end
 
     def warn(data, flow_identifier = nil)
-      enqueue(:warn, format(:warn, data, flow_identifier))
+      enqueue(:warn, format(:warn, prepend_caller_information(data), flow_identifier))
     end
 
     def error(data, flow_identifier = nil)
-      enqueue(:error, format(:error, data, flow_identifier))
+      enqueue(:error, format(:error, prepend_caller_information(data), flow_identifier))
     end
 
     def fatal(data, flow_identifier = nil)
-      enqueue(:fatal, format(:fatal, data, flow_identifier))
+      enqueue(:fatal, format(:fatal, prepend_caller_information(data), flow_identifier))
     end
 
     def <<(data, flow_identifier = nil)
-      enqueue(:info, format(:info, data, flow_identifier))
+      enqueue(:info, format(:info, prepend_caller_information(data), flow_identifier))
     end
 
     def get_status
@@ -77,8 +77,16 @@ module SoarAuditingProvider
 
     private
 
+    def prepend_caller_information(data)
+      if 'true' == @configuration['add_caller_source_location']
+        caller_key_value_pair = SoarAuditingFormatter::Formatter.optional_field_format("caller_source_location","#{caller_locations(2,1)[0]}")
+        data = "#{caller_key_value_pair} #{data}"
+      end
+      data
+    end
+
     def install_at_exit_handler
-      if @configuration['install_exit_handler'] == 'true'
+      if 'true' == @configuration['install_exit_handler']
         Kernel.at_exit do
           exit_cleanup
         end

data/lib/soar_auditing_provider/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditingProvider
-  VERSION = "0.9.3"
+  VERSION = "1.0.0"
 end

data/sanity/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
 gem 'soar_auditing_provider', :path => "../"
-gem "log4r_auditor", "~> 0.0.4"
+gem "log4r_auditor", "~> 1.0.0"
 gem "soar_flow", "~> 0.1.1"

data/sanity/sanity_benchmark.rb

@@ -0,0 +1,83 @@
+require 'soar_auditing_provider'
+require 'log4r_auditor'
+require 'soar_flow'
+require 'benchmark'
+require 'byebug'
+
+class Main
+
+  AUDITING_CONFIGURATION = {
+    'auditing' => {
+      'level' => 'debug',
+      'install_exit_handler' => 'false',
+      'add_caller_source_location' => 'false',
+      'queue_worker' => {
+        'queue_size' => 1000000,
+        'initial_back_off_in_seconds' => 1,
+        'back_off_multiplier' => 2,
+        'back_off_attempts' => 5
+      },
+      'default_nfrs' => {
+        'accessibility' => 'local',
+        'privacy' => 'not encrypted',
+        'reliability' => 'instance',
+        'performance' => 'high'
+      },
+      'auditors' => {
+        'log4r' => {
+          'adaptor' => 'Log4rAuditor::Log4rAuditor',
+          'file_name' => 'soar_sc.log',
+          'standard_stream' => 'none',
+          'nfrs' => {
+            'accessibility' => 'local',
+            'privacy' => 'not encrypted',
+            'reliability' => 'instance',
+            'performance' => 'high'
+          }
+        }
+      }
+    }
+  }
+
+  def test_sanity
+    iterations = 1000000
+
+    #create and configure auditing instance
+    myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'] )
+    myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+    myauditing.service_identifier = 'my-test-service.com'
+
+    #associate a set of auditing entries with a flow by generating a flow identifiers
+    flow_id = SoarFlow::ID::generate_flow_id
+
+    Benchmark.bm do |x|
+      myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'].dup.merge("level" => "warn") )
+      myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+      myauditing.service_identifier = 'my-test-service.com'
+      x.report ("audit_call_below_audit_threshold:") {
+        iterations.times {
+          myauditing.info("Benchmarking test",flow_id)
+        }
+      }
+      myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'].dup.merge("add_caller_source_location" => "false") )
+      myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+      myauditing.service_identifier = 'my-test-service.com'
+      x.report ("audit_call_without_caller_info  :") {
+        iterations.times {
+          myauditing.info("Benchmarking test",flow_id)
+        }
+      }
+      myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'].dup.merge("add_caller_source_location" => "true") )
+      myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+      myauditing.service_identifier = 'my-test-service.com'
+      x.report ("audit_call_with_caller_info     :") {
+        iterations.times {
+          myauditing.info("Benchmarking test",flow_id)
+        }
+      }
+    end
+  end
+end
+
+main = Main.new
+main.test_sanity

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_provider
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Ernst van Graan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -196,6 +196,7 @@ files:
 - sanity/.ruby-version
 - sanity/Gemfile
 - sanity/sanity.rb
+- sanity/sanity_benchmark.rb
 - soar_auditing_provider.gemspec
 homepage: 
 licenses: