pantheios-ruby 0.18.1 → 0.21.0

data/lib/pantheios/services/null_log_service.rb

@@ -1,12 +1,12 @@
 
 # ######################################################################## #
-# File:         lib/pantheios/services/simple_console_log_service.rb
+# File:         lib/pantheios/services/null_log_service.rb
 #
 # Purpose:      Definition of the ::Pantheios::Services::NullLogService
 #               class
 #
 # Created:      14th June 2015
-# Updated:      22nd January 2018
+# Updated:      8th February 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #

data/lib/pantheios/services/simple_console_log_service.rb

@@ -6,7 +6,7 @@
 #               ::Pantheios::Services::SimpleConsoleLogService class
 #
 # Created:      14th June 2015
-# Updated:      6th January 2018
+# Updated:      12th March 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -45,8 +45,6 @@
 # ######################################################################## #
 
 
-require 'pantheios/application_layer/stock_severity_levels'
-
 =begin
 =end
 
@@ -73,11 +71,14 @@ class SimpleConsoleLogService
 		stm.puts "#{pref}#{msg}"
 	end
 
+	# Overrideable method that determines which stream to write, based on a
+	# severity. This implementation always returns +$stderr+
+	#
+	# Overrides must return an object that supports the +puts(String)+
+	# method
 	def infer_stream sev
 
-		sev = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[sev] if ::Symbol === sev
-
-		(sev.to_i < 6) ? $stderr : $stdout
+		$stderr
 	end
 end
 

data/lib/pantheios/util/reflection_util.rb

@@ -9,6 +9,8 @@ module ReflectionUtil
 		ROOT_CLASSES = [ ::Object, ::BasicObject ]
 	end
 
+	# Obtains a list of all classes pertaining to +o+, excepting root
+	# objects (+::Object+ and +::BaseObject+).
 	def self.non_root_classes o
 
 		return [] if o.nil?

data/lib/pantheios/util/thread_util.rb

@@ -22,6 +22,7 @@ module ThreadUtil
 		t.thread_name = name
 	end
 
+	# Obtains the name of the calling thread
 	def self.get_thread_name t
 
 		t ||= Thread.current

data/lib/pantheios/version.rb

@@ -5,13 +5,14 @@
 # Purpose:      Version for Pantheios.Ruby library
 #
 # Created:      2nd April 2011
-# Updated:      5th February 2018
+# Updated:      3rd June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2011-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2011-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -50,7 +51,7 @@
 module Pantheios
 
 	# Current version of the Pantheios.Ruby library
-	VERSION				=	'0.18.1'
+	VERSION				=	'0.21.0'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/scratch/multiplexing_log_service.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/scratch/multiplexing_log_service.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      7th February 2018
+# Updated:      7th February 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 2), 'lib')
+
+require 'pantheios'
+require 'pantheios/application_layer/stock_severity_levels'
+require 'pantheios/services'
+
+$num_BLS_sls	=	0
+$num_ELS_sls	=	0
+
+class BenchmarkLogService
+
+	def severity_logged? severity
+
+		$num_BLS_sls	+=	1
+
+		(0..100).each { |n| n ** n  }
+
+		:benchmark == severity.to_s.to_sym
+	end
+
+	def log sev, t, pref, msg
+
+		puts "BENCHMARK: #{pref}#{msg}\n"
+	end
+end
+
+class EventLogService
+
+	def severity_logged? severity
+
+		$num_ELS_sls	+=	1
+
+		case severity.to_s.to_sym
+		when :notice, :warning, :failure, :critical, :alert, :violation
+
+			true
+		when :warn, :error, :emergency
+
+			true
+		else
+
+			false
+		end
+	end
+
+	def log sev, t, pref, msg
+
+		puts "EVENTLOG: #{pref}#{msg}\n"
+	end
+end
+
+scls		=	Pantheios::Services::SimpleConsoleLogService.new
+
+def scls.severity_logged? severity; ![ :benchmark, :trace, :violation ].include? severity; end
+
+services	=	[
+
+	BenchmarkLogService.new,
+	EventLogService.new,
+	scls,
+]
+
+lcm = :none
+#lcm = :thread_fixed
+#lcm = :process_fixed
+unsync = false
+#unsync = true
+
+Pantheios::Core.set_service Pantheios::Services::MultiplexingLogService.new(services, level_cache_mode: lcm, unsyc_process_lcm: unsync)
+
+include Pantheios
+
+t_b	=	Time.now
+
+log :benchmark, 'statement at benchmark'
+(0..100000).each { log :trace, 'statement at trace' }
+log :debug4, 'statement at debug-4'
+log :debug3, 'statement at debug-3'
+log :debug2, 'statement at debug-2'
+log :debug1, 'statement at debug-1'
+log :debug0, 'statement at debug-0'
+log :informational, 'statement at informational'
+log :notice, 'statement at notice'
+log :warning, 'statement at warning'
+log :failure, 'statement at failure'
+log :critical, 'statement at critical'
+log :alert, 'statement at alert'
+log :violation, 'statement at violation'
+
+t_a	=	Time.now
+
+$stderr.puts "mode= :#{lcm}; t=#{t_a - t_b}; #BLS=#{$num_BLS_sls}; #ELS=#{$num_ELS_sls}"
+

data/test/unit/application_layer/tc_stock_severity_levels.rb

@@ -26,12 +26,15 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 		debug2
 		debug3
 		debug4
+		debug5
 		trace
+		benchmark
 	}.map { |s| s.to_sym }
 
 	EXPECTED_LEVELS = %w{
 
 		emergency
+		fail
 		info
 		warn
 	}.map { |s| s.to_sym } + EXPECTED_LEVELS_PRIME
@@ -51,6 +54,7 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 		if defined? StockSeverityLevels
 
 			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVELS)
+			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVELS_PRIME)
 			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVEL_VALUES)
 			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVEL_STRINGS)
 		end
@@ -58,18 +62,36 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 
 	def test_StockSeverityLevels_expected_levels
 
+		# all the ones that we expect exist
+
 		EXPECTED_LEVELS.each do |sev|
 
 			assert(StockSeverityLevels::STOCK_SEVERITY_LEVELS.include?(sev), "did not find level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
 		end
+
+		# we expect all the ones that exist
+
+		StockSeverityLevels::STOCK_SEVERITY_LEVELS.each do |sev|
+
+			assert(EXPECTED_LEVELS.include?(sev), "found unexpected level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
+		end
 	end
 
 	def test_StockSeverityLevels_expected_prime_levels
 
+		# all the ones that we expect exist
+
 		EXPECTED_LEVELS_PRIME.each do |sev|
 
 			assert(StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME.include?(sev), "did not find level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
 		end
+
+		# we expect all the ones that exist
+
+		StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME.each do |sev|
+
+			assert(EXPECTED_LEVELS_PRIME.include?(sev), "found unexpected level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
+		end
 	end
 
 	def test_StockSeverityLevels_expected_prime_levels_have_distinct_values
@@ -99,5 +121,50 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 			strings[string] = string
 		end
 	end
+
+	def test_StockSeverityLevels_aliases
+
+		aliases = StockSeverityLevels::STOCK_SEVERITY_LEVEL_ALIASES
+
+		assert_equal :violation, aliases[:violation]
+		assert_equal :violation, aliases[:emergency]
+
+		assert_equal :alert, aliases[:alert]
+
+		assert_equal :critical, aliases[:critical]
+
+		assert_equal :failure, aliases[:failure]
+		assert_equal :failure, aliases[:fail]
+		#assert_equal :failure, aliases[:error]
+
+		assert_equal :warning, aliases[:warning]
+		assert_equal :warning, aliases[:warn]
+
+		assert_equal :notice, aliases[:notice]
+
+		assert_equal :informational, aliases[:informational]
+		assert_equal :informational, aliases[:info]
+
+		%i{ debug0 debug1 debug2 debug3 debug4 debug5 }.each do |sev|
+
+			assert_equal sev, aliases[sev]
+		end
+
+		assert_equal :trace, aliases[:trace]
+
+		assert_equal :benchmark, aliases[:benchmark]
+	end
+
+	def test_StockSeverityLevels_recognised_values_are_nil
+
+		EXPECTED_LEVELS.each do |sev|
+
+			assert_not_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[sev]
+			assert_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[sev.to_s]
+		end
+
+		assert_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[nil]
+		assert_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES['failure']
+	end
 end
 

data/test/unit/front_ends/tc_threshold_front_end.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/front_ends/threshold_front_end'
+
+require 'test/unit'
+
+class Test_FrontEnds_ThresholdFrontEnd < Test::Unit::TestCase
+
+	include ::Pantheios::FrontEnds
+
+	def test_SimpleConsoleLogService_type_exists
+
+		assert defined? ThresholdFrontEnd
+	end
+
+	def test_construct_with_invalid_parameters
+
+		assert_raise(::TypeError) { ThresholdFrontEnd.new('notice') }
+
+		assert_raise_with_message(::ArgumentError, /unknown threshold severity level.*something_else.*Symbol/) { ThresholdFrontEnd.new(:something_else) }
+
+		ThresholdFrontEnd.new(:notice)
+		ThresholdFrontEnd.new(:notice, value_lookup_map: Hash.new)
+		assert_raise_with_message(::TypeError, /:value_lookup_map must be.*Hash/) { ThresholdFrontEnd.new(:notice, value_lookup_map: Array.new) }
+	end
+
+	def test_default_construct
+
+		fe = ThresholdFrontEnd.new(:notice)
+
+		assert_equal :notice, fe.threshold
+
+		assert_true fe.severity_logged?(:violation)
+		assert_true fe.severity_logged?(:alert)
+		assert_true fe.severity_logged?(:critical)
+		assert_true fe.severity_logged?(:failure)
+		assert_true fe.severity_logged?(:warning)
+		assert_true fe.severity_logged?(:notice)
+		assert_false fe.severity_logged?(:informational)
+		assert_false fe.severity_logged?(:debug0)
+		assert_false fe.severity_logged?(:debug1)
+		assert_false fe.severity_logged?(:debug2)
+		assert_false fe.severity_logged?(:debug3)
+		assert_false fe.severity_logged?(:debug4)
+		assert_false fe.severity_logged?(:debug5)
+		assert_false fe.severity_logged?(:trace)
+	end
+
+	def test_default_construct_and_change_threshold
+
+		fe = ThresholdFrontEnd.new(:notice)
+
+		assert_equal :notice, fe.threshold
+
+		fe.threshold = :failure
+
+		assert_equal :failure, fe.threshold
+
+		assert_true fe.severity_logged?(:violation)
+		assert_true fe.severity_logged?(:alert)
+		assert_true fe.severity_logged?(:critical)
+		assert_true fe.severity_logged?(:failure)
+		assert_false fe.severity_logged?(:warning)
+		assert_false fe.severity_logged?(:notice)
+		assert_false fe.severity_logged?(:informational)
+		assert_false fe.severity_logged?(:debug0)
+		assert_false fe.severity_logged?(:debug1)
+		assert_false fe.severity_logged?(:debug2)
+		assert_false fe.severity_logged?(:debug3)
+		assert_false fe.severity_logged?(:debug4)
+		assert_false fe.severity_logged?(:debug5)
+		assert_false fe.severity_logged?(:trace)
+	end
+
+	def test_use_custom_thresholds
+
+		value_lookup_map = {
+
+			FATAL: 1,
+			ERROR: 2,
+			WARN: 3,
+			INFO: 4,
+			DEBUG: 5,
+		}
+
+		fe = ThresholdFrontEnd.new(:INFO, value_lookup_map: value_lookup_map)
+
+		assert_equal :INFO, fe.threshold
+
+		assert_true fe.severity_logged?(:FATAL)
+		assert_true fe.severity_logged?(:ERROR)
+		assert_true fe.severity_logged?(:WARN)
+		assert_true fe.severity_logged?(:INFO)
+		assert_false fe.severity_logged?(:DEBUG)
+	end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/front_ends/ts_all.rb

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
+

data/test/unit/services/tc_multiplexing_log_service.rb

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+#
+# test/unit/services/tc_multiplexing_log_service.rb
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/services/multiplexing_log_service'
+
+require 'pantheios/api'
+require 'pantheios/application_layer/stock_severity_levels'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_MultiplexingLogservice < Test::Unit::TestCase
+
+	include ::Pantheios::API
+	include ::Pantheios::Services
+
+	class ProgrammableLogService
+
+		def initialize name, severities
+
+			@name		=	name
+			@severities	=	severities
+			@items		=	[]
+		end
+
+		attr_reader :name
+		attr_reader :items
+
+		def severity_logged? severity
+
+			@severities.include? severity
+		end
+
+		def log sev, t, pref, msg
+
+			@items << [ sev, t, pref, msg ]
+		end
+	end
+
+	def log_multiple_statements svc
+
+		previous, _	=	Pantheios::Core.set_service svc
+
+		begin
+
+			severities	=	Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME
+
+			severities.each do |sev|
+
+				log sev, "a(n) #{sev} statement"
+			end
+		ensure
+
+			Pantheios::Core.set_service previous
+		end
+	end
+
+
+	def test_MultiplexingLogService_type_exists
+
+		assert defined? MultiplexingLogService
+	end
+
+	if  defined?(MultiplexingLogService)
+
+		def test_MultiplexingLogService_type_is_a_class
+
+			assert_kind_of(::Class, MultiplexingLogService)
+		end
+
+		def test_MultiplexingLogService_type_has_expected_instance_methods
+
+			assert_type_has_instance_methods MultiplexingLogService, [ :severity_logged?, :log ]
+		end
+
+		def test_multiplex_1
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ]
+
+			log_multiple_statements svc
+
+			assert_equal 12, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+
+		def test_multiplex_2
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ], level_cache_mode: :none
+
+			log_multiple_statements svc
+
+			assert_equal 12, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+
+		def test_multiplex_3
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ], level_cache_mode: :process_fixed
+
+			log_multiple_statements svc
+
+			assert_equal 12, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+
+		def test_multiplex_4
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ], level_cache_mode: :thread_fixed
+
+			log_multiple_statements svc
+
+			assert_equal 12, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+	end
+end
+
+