razorrisk-razor-control 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11bc6351674d5158b9a6a1996b7ae16fd953fe4a
+  data.tar.gz: 259b460cbac634c3c7c34bfccc3e5c72a2d6bbe2
+SHA512:
+  metadata.gz: 1b61b9f047002e5e38f73dacf80b03764c3049516d953f8a6c4b44eca1d78582e8c36495d3ca6ed599f5f8642bd33f5afc39bfcaa5bc90d4f39cbc6c72034aef
+  data.tar.gz: 736c3a56258688f0a30a803e0223154164b9ae9eb2b89bde7557e0266802d6c45c6c11f30614353f8f422d5d2f96c1e5c54d380104ae5e4cad415f4d9a77ec6e

data/RakeFile

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Rakefile for Razor Risk Razor Control library.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+# ######################################################################## #
+# requires
+
+require 'rake'
+require 'razor_risk/razor/control/rake_helpers/gem_tasks'
+
+
+# ##########################################################
+# Default
+
+task :default => :test
+
+
+# ##########################################################
+# Public Tasks
+
+desc 'Run tests'
+task :test => [ :'gem:unit_test' ]
+
+desc 'Builds the Razor Control Gem'
+task :build, [ :path ] => :'gem:build'
+
+desc 'Install gem and dependencies locally and execute unit test'
+task :installAndTest => :'gem:test_with_local_install'
+
+desc 'Push the gem to the gem server.'
+task :deploy => :'gem:push'
+
+desc 'Builds, unit tests, and pushes the gem to the gem server'
+task :buildAndDeploy => [ :build, :installAndTest, :deploy ]
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/razor/control/cucumber_helpers/consolidate_reports.rb

@@ -0,0 +1,80 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Cucumber Rake task library.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ######################################################################## #
+# requires
+
+require 'report_builder'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+module RazorRisk
+module Razor
+module Control
+module CucumberHelpers
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+    # Consolidate multiple Cucumber Reports.
+    #
+    # @param directory [::String] The path to the directory containing
+    #   Cucumber results JSON files.
+    # @param report_path [::String] The path to where the output file should
+    #   be written.
+    # @param report_name [::String] The name of the output report file.
+    # @param **options [::Hash] The options hash.
+    #
+    # @option options [::String] :title The tile of the report.
+    # @option options [::Hash] :additional_info Any additional information
+    #   for the report.
+    #
+    def self.consolidate_reports directory, report_path, report_name, **options
+
+        trace ParamNames[ :directory, :report_path, :options ], directory, report_path, **options
+
+        check_parameter directory, 'directory', type: ::String
+        check_parameter report_path, 'report_path', type: ::String
+        check_parameter report_name, 'report_name', type: ::String
+        check_option options, :title, type: ::String, allow_nil: true
+        check_option options, :additional_info, type: ::Hash, allow_nil: true
+
+        input_files = if Dir[ "#{directory}/*.json" ].empty?
+            Dir[ "#{directory}/*" ].map do |t|
+                [
+                    File.basename(t),
+                    Dir[ "#{t}/**/*.json" ],
+                ] if File.directory? t
+            end.compact.to_h
+        else
+            Dir[ "#{directory}/**/*.json" ]
+        end
+
+        ReportBuilder.configure do |config|
+            config.input_path = input_files
+            config.report_types = [ :html ]
+            config.report_path = File.join(report_path, report_name)
+            config.report_title = options[:title]
+            # NOTE: ReportBuilder will fail if this is set to nil
+            config.additional_info = options[:additional_info] || {}
+            config.color = 'blue'
+        end
+        ReportBuilder.build_report
+    end
+
+end # module RakeHelpers
+end # module Razor
+end # module Razor
+end # module Razor
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/razor/control/cucumber_helpers/executor.rb

@@ -0,0 +1,108 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Cucumber Rake task library.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ######################################################################## #
+# requires
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+require 'fileutils'
+
+module RazorRisk
+module Razor
+module Control
+module CucumberHelpers
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+    # Execute Cucumber tests.
+    #
+    # @param cucumber [::Module] The cucumber module.
+    # @param name [::String] The name of the group of tests.
+    # @param tags [::String] The tags string for filtering cucumber tests.
+    # @param **options [::Hash] The options hash.
+    #
+    # @option options [::String] :report_directory (.) The directory to write
+    #   results files into.
+    # @option options [::String] :console (progress) The format to print to
+    #   console.
+    # @option options [::String] :group The name of the group this test is part
+    #   of.
+    # @option options [boolean] :html Write results to file in HTML format.
+    # @option options [boolean] :json Write results to file in JSON format.
+    # @option options [boolean] :junit Write results to file in JUnit XML format.
+    #
+    # @return [boolean] Whether the cucumber tests succeeded.
+    def self.execute cucumber, name, tags = nil, **options
+
+        trace ParamNames[ :name, :tags, :options ], name, tags, **options
+
+        check_parameter cucumber, 'cucumber', type: ::Module
+        check_parameter name, 'name', type: ::String, reject_empty: true
+        check_parameter tags, 'tags', type: ::String, allow_nil: true, reject_empty: true
+
+        check_option options, :report_directory, type: ::String, allow_nil: true
+        check_option options, :console, type: ::String, allow_nil: true
+        check_option options, :group, type: ::String, allow_nil: true
+        check_option options, :html, type: :boolean, allow_nil: true
+        check_option options, :json, type: :boolean, allow_nil: true
+        check_option options, :junit, type: :boolean, allow_nil: true
+
+        if [ :html, :json, :junit ].any? { |t| options.keys.include? t }
+            report_directory = options[:report_directory] || '.'
+            report_directory = File.join(report_directory, options[:group]) if options[:group]
+            FileUtils.mkdir_p(report_directory)
+        end
+
+        args = []
+        args << '-s' # Don't print the step source location.
+        args << '-x' # Expand scenario template tables.
+
+        if tags
+            args << '-t' << tags
+        end
+
+        if options[:html]
+            args << '--format' << 'html'
+            args << '-o' << File.join(report_directory, "#{name}.html")
+        end
+
+        if options[:junit]
+            args << '--format' << 'junit'
+            args << '-o' << File.join(report_directory, 'JUnit')
+        end
+
+        if options[:json]
+            args << '--format' << 'json'
+            args << '-o' << File.join(report_directory, "#{name}.json")
+        end
+
+        if options[:console]
+            args << '--format' << options[:console]
+        else
+            args << '--format' << 'progress'
+        end
+
+        begin
+            cucumber::Cli::Main.new(args).execute!
+        rescue SystemExit => x
+            x.success?
+        end
+    end
+end # module CucumberHelpers
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/razor/control/cucumber_helpers.rb

@@ -0,0 +1,3 @@
+
+require 'razor_risk/razor/control/cucumber_helpers/consolidate_reports'
+require 'razor_risk/razor/control/cucumber_helpers/executor'

data/lib/razor_risk/razor/control/diagnostics/util_functions.rb

@@ -0,0 +1,203 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Centralised diagnostics utility functions.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+require 'pantheios/application_layer/stock_severity_levels'
+require 'pantheios/services/multiplexing_log_service'
+require 'pantheios/services/null_log_service'
+require 'pantheios/services/simple_console_log_service'
+require 'pantheios/services/simple_file_log_service'
+
+require 'xqsr3/quality/parameter_checking'
+
+require 'fileutils'
+
+require 'razor_risk/core/diagnostics/logger'
+
+module RazorRisk
+module Razor
+module Control
+
+module Diagnostics
+    include ::RazorRisk::Core::Diagnostics::Logger
+    module SetupDiagnosticLogging_Constants
+
+        STOCK_SEVERITY_LEVEL_VALUES     =   Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
+
+        DEFAULT_LOG_THRESHOLD_MAIN      =   :debug4
+        DEFAULT_LOG_THRESHOLD_CONSOLE   =   :informational
+
+        BENCHMARK_SEVERITY_VALUE        =   STOCK_SEVERITY_LEVEL_VALUES[:benchmark]
+
+        DEFAULT_LOG_SIZE_MAIN           =   1024 * 1024 * 100
+
+        DEFAULT_LOG_DEPTH               =   20
+    end # module SetupDiagnosticLogging_Constants
+
+    # configure diagnostic logging:
+    #
+    # - set program name
+    # - set services:
+    #   * main file logger : file, stores all except :benchmark, according to
+    #     :log_threshold
+    #   * main cons logger : stdout/stderr, only :notice and above
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +program_name+:: (::String) The program name. May not be +nil+
+    #   - +log_directory+:: (::String) The directory in which log-files
+    #     will be created. May not be +nil+
+    #   - +log_threshold+:: (::String | ::Symbol |[ ::Symbol, ::Symbol ] )
+    #     Specifies the log-threshold(s). The threshold(s) is specified as a
+    #     string containing comma-separated values, or as a single symbol,
+    #     or as an array of symbols, all of which are treated as a sequence
+    #     of severity thresholds. The severity thresholds apply,
+    #     respectively, to the modifiable-sequence of Console and Main.
+    #
+    # * *Options:*
+    #   - +:no_console_log+:: (boolean) Unless truey, a console log will be
+    #     created
+    #
+    def self.setup_diagnostic_logging program_name, **options
+
+        program_name    =   ::Xqsr3::Quality::ParameterChecking.check_parameter program_name, :program_name, type: ::String, treat_as_option: true
+        log_directory   =   ::Xqsr3::Quality::ParameterChecking.check_parameter options[:log_directory], :log_directory, type: ::String, treat_as_option: true, allow_nil: true
+        log_threshold   =   ::Xqsr3::Quality::ParameterChecking.check_parameter options[:log_threshold], :log_threshold, types: [ ::Array, ::Integer, ::Symbol ], treat_as_option: true, allow_nil: true
+
+        case log_threshold
+        when ::Array
+
+            log_thresholds  =   log_threshold.dup
+        when ::Symbol
+
+            log_thresholds  =   [ log_threshold ]
+        else
+
+            log_thresholds  =   []
+        end
+
+        console_threshold   =   log_thresholds.shift || options[:console_threshold] || SetupDiagnosticLogging_Constants::DEFAULT_LOG_THRESHOLD_CONSOLE
+        main_threshold      =   log_thresholds.shift || options[:main_threshold] || SetupDiagnosticLogging_Constants::DEFAULT_LOG_THRESHOLD_MAIN
+
+        console_threshold_v =   ::Integer === console_threshold ? console_threshold : SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[console_threshold]
+        main_threshold_v    =   ::Integer === main_threshold ? main_threshold : SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[main_threshold]
+
+        services = []
+
+        if log_directory
+
+            unless File.directory?(log_directory)
+
+                climate.abort "log directory '#{log_directory}' exists and is not a directory" if File.exist?(log_directory)
+
+                begin
+
+                    FileUtils.mkdir_p log_directory
+                rescue => x
+
+                    log :alert, "exception(#{x.class}): #{x.message}"
+
+                    climate.abort x.message
+                end
+            end
+
+            mf_log_file_name    =   program_name + '-main.log'
+
+            mf_log_file_path    =   File.join(log_directory, mf_log_file_name)
+
+            mf_logger           =   Pantheios::Services::SimpleFileLogService.new mf_log_file_path, roll_size: SetupDiagnosticLogging_Constants::DEFAULT_LOG_SIZE_MAIN, roll_depth: SetupDiagnosticLogging_Constants::DEFAULT_LOG_DEPTH
+
+            mf_logger.instance_variable_set :@main_threshold_v_, main_threshold_v
+
+            def mf_logger.severity_logged? severity
+
+                return true unless @main_threshold_v_
+
+                severity = :debug4 if :debug == severity
+
+                severity_v = nil
+
+                case severity
+                when :benchmark, SetupDiagnosticLogging_Constants::BENCHMARK_SEVERITY_VALUE
+
+                    return false
+                when ::Symbol
+
+                    severity_v = SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[severity]
+                when ::Integer
+
+                    severity_v = severity
+                    ;
+                end
+
+                return true unless severity_v
+
+                severity_v <= @main_threshold_v_
+            end
+
+            services            <<  mf_logger
+        end
+
+        unless options[:no_console_log]
+
+            mc_logger           =   Pantheios::Services::SimpleConsoleLogService.new
+
+            mc_logger.instance_variable_set :@console_threshold_v_, console_threshold_v
+
+            def mc_logger.severity_logged? severity
+
+                return true unless @console_threshold_v_
+
+                severity = :debug4 if :debug == severity
+
+                severity_v = nil
+
+                case severity
+                when :benchmark, SetupDiagnosticLogging_Constants::BENCHMARK_SEVERITY_VALUE
+
+                    return false
+                when ::Symbol
+
+                    severity_v = SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[severity]
+                when ::Integer
+
+                    severity_v = severity
+                else
+
+                    ;
+                end
+
+                return true unless severity_v
+
+                severity_v <= @console_threshold_v_
+            end
+
+            services            << mc_logger
+        end
+
+        if services.empty?
+
+            mx_logger   =   Pantheios::Services::NullLogService.new
+        else
+
+            mx_logger   =   Pantheios::Services::MultiplexingLogService.new services, level_cache_mode: :thread_fixed
+        end
+
+        ::Pantheios::Core.set_service mx_logger
+    end
+end # module Diagnostics
+
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/razor/control/diagnostics/zeroth_include.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  When required as the very first file it sets up, for diagnostics, the main
+#  thread name and the process name
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ##########################################################################
+# requires
+
+require 'pantheios/globals'
+require 'pantheios/services/null_log_service'
+
+# ##########################################################
+# Loggin
+
+Pantheios::Globals.MAIN_THREAD_NAME = [ Thread.current, 'main' ]
+Pantheios::Globals.PROCESS_NAME = :script_stem
+Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/razor/control/exceptions.rb

@@ -0,0 +1,121 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Exceptions
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/core/diagnostics/exceptions'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+module RazorRisk
+module Razor
+module Control
+
+# Module for exceptions for control:
+#
+# Exceptions:
+#
+# (::RazorRisk::Core::Diagnostics::Exceptions::RRCSBaseException)
+#   |
+#   +- ControlException (abstract)
+#       |
+#       +- GemDeploymentException
+#       |
+#       +- RazorControlException
+#
+module Exceptions
+
+# @abstract
+#
+# Root exception class for Control module
+#
+class ControlException < ::RazorRisk::Core::Diagnostics::Exceptions::RRCSBaseException
+
+    include ::Pantheios
+
+    # ControlException Constants
+    module Constants
+
+        # List of derived classes that are abstract.
+        ABSTRACT_CLASSES = %w{
+            ControlException
+        }
+
+    end # module Constants
+
+    # Override of +new+ to enforce abstract exception classes cannot be
+    # constructed.
+    def self.new *args
+
+        if Constants::ABSTRACT_CLASSES.include?(self.name.split('::')[-1])
+
+            raise NoMethodError, "private method `new' called for #{self}:Class"
+        end
+
+        super
+    end
+
+    # @return [::Hash] the options hash.
+    attr_reader :options
+
+    # Initialises an instance, based on the given message and options
+    #
+    # @param message [String] The exception message/
+    # @param options [Hash] The options hash.
+    #
+    # @option cause [Exception] The cause.
+    #
+    def initialize message, **options
+
+        trace ParamNames[ :message, :options ], message, options
+
+        super message, **options
+
+        @options = {}.merge! options
+    end
+end # class ControlException
+
+# Exception thrown if an operation fails while building/testing/deploying a
+# gem.
+class GemDeploymentException < ControlException
+
+    # @see ControlException
+    def initialize message, **options
+
+        trace ParamNames[ :message, :options ], message, options
+
+        super message, **options
+    end
+end # class GemDeploymentException
+
+# Exception thrown if a Razor Control opteration fails.
+class RazorControlException < ControlException
+
+    # @see ControlException
+    def initialize message, **options
+
+        trace ParamNames[ :message, :options ], message, options
+
+        super message, **options
+    end
+end # class RazorControlException
+
+end # module Exceptions
+
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+