razorrisk-razor-control 0.1

data/lib/razor_risk/razor/control/rake_helpers/razor_tasks.rb

@@ -0,0 +1,195 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Rakefile for Razor Risk Razor Control library.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/razor/control/razor'
+require 'razor_risk/razor/control/rake_helpers/aborter'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+require 'rake'
+
+module RazorRisk
+module Razor
+module Control
+module RakeHelpers
+
+# Rake tasks for controlling a Razor instance.
+module RazorTasks
+
+    extend ::Rake::DSL
+
+    include ::RazorRisk::Razor::Control
+    include ::RazorRisk::Razor::Control::Exceptions
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # Constants
+
+    # Default config to include for all Razor instances.
+    DefaultConfig = Razor::Config.new(
+        'StandardConfig',
+        'config/StandardConfig',
+        'config',
+        '1_start.cmd',
+        '4_rebuild.cmd',
+    )
+
+
+    # ##########################################################
+    # variables
+
+    razor_instance = nil
+
+
+    # ##########################################################
+    # tasks
+
+    namespace :razor do
+
+        # Initializes the Razor insance.
+        #
+        # @param directory [::String] The path to the Razor instance.
+        # @param environment [::String] The Razor instance environment.
+        # @param configs [Array<Razor::Config>] An array of configs available in
+        #   the razor instance.
+        #
+        task :init_instance, [ :directory, :environment, :configs ] do |task, args|
+
+            trace ParamNames[ :task, :args ], task, args
+
+            configs = [ args[:configs], DefaultConfig ].flatten.compact
+
+            begin
+                razor_instance = Razor::RazorInstance.new(
+                    args[:directory],
+                    args[:environment],
+                    configs,
+                )
+            rescue RazorControlException => x
+                abort x.message
+            end
+
+            # Ensure that razor is always stopped if initialized.
+            RakeHelpers::RakeAborter.abort_hook do
+                log :critical, 'Aborting: Killing Razor'
+                ::Rake::Task[:'razor:kill'].invoke
+            end
+        end
+
+        # Kills the running Razor instance.
+        #
+        task :kill do |task|
+
+            trace ParamNames[ :task ], task
+
+            log :informational, "Killing Razor '#{razor_instance.environment}'"
+
+            begin
+                status = razor_instance.kill
+            rescue RazorControlException => x
+                abort x.message
+            end
+
+            abort "Failed to kill Razor isntance '#{razor_instance.environment}'" unless status
+
+            task.reenable
+        end
+
+        # Rebuilds the Razor instance to used the specified config.
+        #
+        # @param config [::String] (DefaultConfig) The name of the config.
+        #
+        task :rebuild, [ :config ] do |task, args|
+
+            trace ParamNames[ :task, :args ], task, args
+
+            args.with_defaults(config: DefaultConfig.name)
+
+            log :informational, "Executing rebuild on '#{args[:config]}'"
+
+            begin
+                status = razor_instance.rebuild args[:config]
+            rescue RazorControlException => x
+                abort x.message
+            end
+
+            abort "Failed to rebuild '#{razor_instance.environment}' with '#{config}" unless status
+
+            task.reenable
+        end
+
+        # Executes a Turn of Day the Razor instance to used the specified
+        # config.
+        #
+        # @param config [::String] (DefaultConfig) The name of the config.
+        #
+        task :turn_of_day, [ :config ] do |task, args|
+
+            trace ParamNames[ :task, :args ], task, args
+
+            args.with_defaults(config: DefaultConfig.name)
+
+            log :informational, "Starting Razor with '#{args[:config]}'"
+
+            begin
+                status = razor_instance.turn_of_day args[:config]
+            rescue RazorControlException => x
+                abort x.message
+            end
+
+            abort "Failed execute Turn of Day for '#{razor_instance.environment}' with '#{args[:config]}" unless status
+
+            task.reenable
+        end
+
+        # Copies the razor logs to an output location.
+        #
+        # @param directory [::String] A path to the directory the logs are to
+        # be copied to.
+        # @param config [::String] (DefaultConfig) The name of the config.
+        #
+        task :copy_logs, [:directory, :config] do |task, args|
+
+            trace ParamNames[ :task, :args ], task, args
+
+            args.with_defaults(config: DefaultConfig.name)
+
+            log :informational, "Copying razor logs into output log directory"
+
+            begin
+                razor_instance.copy_logs args[:directory], args[:config]
+            rescue RazorControlException => x
+                abort x.message
+            end
+
+            task.reenable
+        end
+    end
+end # module RazorTasks
+
+end # module RakeHelpers
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+
+

data/lib/razor_risk/razor/control/rake_helpers/task_helpers.rb

@@ -0,0 +1,86 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Rake Task helpers.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ##########################################################
+# requires
+
+require 'pantheios'
+
+require 'rake'
+
+# ##########################################################
+# RazorInstance
+
+module RazorRisk
+module Razor
+module Control
+module RakeHelpers
+
+# Helper methods for Rake tasks.
+class TaskHelpers
+
+    include ::Pantheios
+
+    # Adds First, Before and After hooks. This must be called AFTER all other
+    # tasks have been defined.
+    def self.add_hooks
+
+        first = ::Rake::Task.task_defined? :first
+        before = ::Rake::Task.task_defined? :before
+        after = ::Rake::Task.task_defined? :after
+
+        prereq = []
+        prereq << :first if first
+        prereq << :before if before
+
+        reject = [
+            :default,
+            :clean,
+            :clobber,
+        ]
+
+        if first
+            reject << :first
+            reject << ::Rake::Task[:first].prerequisites
+        end
+        if before
+            reject << :before
+            reject << ::Rake::Task[:before].prerequisites
+        end
+        if after
+            reject << :after
+            reject << ::Rake::Task[:after].prerequisites
+        end
+
+        reject.flatten!
+        reject.map! { |r| r.is_a?(::String) ? r.to_sym : r }.uniq!
+
+        ::Rake::Task.tasks.reject do |t|
+            reject.include? t.name.to_sym
+        end.each do |t|
+            t.enhance(prereq) do
+                if after
+                    ::Rake::Task[:after].invoke
+                    ::Rake::Task[:after].reenable
+                end
+                ::Rake::Task[:before].reenable if before
+            end
+        end
+    end
+end # class TaskHelpers
+
+end # module RakeHelpers
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,3 @@
+
+require 'razor_risk/razor/control/rake_helpers/aborter'
+require 'razor_risk/razor/control/rake_helpers/task_helpers'

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

@@ -0,0 +1,131 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Razor Control Operations.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ##########################################################
+# requires
+
+require 'razor_risk/razor/control/diagnostics/util_functions'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+# ##########################################################
+# RazorInstance
+
+module RazorRisk
+module Razor
+module Control
+module Razor
+
+# Executes operations on a Razor instance.
+class Executor
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # Executes the provided system command and logs its output. The system
+    # command will be fed new lines to prevent getting stuck on any 'pause'
+    # statements. The program will be terminated if this process is
+    # interupeted.
+    #
+    # @param command [::String] The system command to execute.
+    def execute command, **opts
+
+        check_parameter command, 'command', type: ::String
+
+        rout,wout = IO.pipe
+        rerr,werr = IO.pipe
+        rin,win = IO.pipe
+
+        tout = Thread.new do
+            while line = rout.readline do
+                log :informational, "#{command}: #{line}".strip
+            end
+        end
+        terr = Thread.new do
+            while line = rerr.readline do
+                log :warning, "#{command}: #{line}".strip
+            end
+        end
+        tin = Thread.new do
+            while true do
+                win.write "\n"
+                sleep(1)
+            end
+        end
+
+        opts.merge!({
+            out: wout,
+            err: werr,
+            in: rin,
+        })
+
+        begin
+            pid = Process.spawn(
+                command,
+                opts
+            )
+            Process.wait pid
+        ensure
+            begin
+                Process.kill('SIGKILL', pid)
+            rescue Errno::ESRCH
+                # Process exited normally
+            end
+
+            win.close
+            tout.exit
+            terr.exit
+            tin.exit
+        end
+        $?.success?
+    end
+end # class Executor
+
+# Executes operations on a Razor instance.
+class MockExecutor
+
+    # @return [Array<::String>] An array of commands sent to {#execute}.
+    attr_reader :commands
+    # @return [Array<::Hash>] An array of option hashes sent to {#execute}.
+    attr_reader :opts
+
+    # method description
+    #
+    # @param codes [Array<Numeric>] The return codes to uses.
+    #
+    def initialize *codes
+
+        @commands = []
+        @opts = []
+        @codes = codes
+    end
+
+    # Mocks the execute command. This will store the command and options in
+    # {#commands} and {#opts}.
+    def execute command, **opts
+
+        @commands << command
+        @opts << opts
+
+        return @codes.shift
+    end
+end # class Executor
+
+end # module Razor
+end # module Control
+end # module Razor
+end # module Razor
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,227 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Razor Control Operations.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ##########################################################
+# requires
+
+require 'razor_risk/razor/control/diagnostics/util_functions'
+
+require 'razor_risk/razor/control/exceptions'
+require 'razor_risk/razor/control/razor/executor'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'xqsr3/quality/parameter_checking'
+require 'pantheios'
+
+# ##########################################################
+# RazorInstance
+
+module RazorRisk
+module Razor
+module Control
+module Razor
+
+# Details required for a razor config.
+#
+# @attr name [String] The name of the config, this is for specifying the
+#   config and does not need to match the directory.
+# @attr path [String] The relative path of the config to the razor instace,
+#   e.g. 'config/StandardConfig'
+# @attr script_dir [String] The relative path to where the config scripts
+#   (e.g. '4_rebuild.cmd') are from the config directory, e.g. 'config'.
+# @attr tod_script [String] The name of the script to execute a Turn of Day
+#   with.
+# @attr rebuild_script [String] The name of the script to rebuild the config.
+#
+Config = Struct.new(
+    :name,
+    :path,
+    :script_dir,
+    :tod_script,
+    :rebuild_script
+)
+
+LogLocation = 'master/log'
+
+# Executes operations on a Razor instance.
+class RazorInstance
+
+    include ::RazorRisk::Razor::Control::Exceptions
+
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::Pantheios
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # @return [::String] Path to the razor instance.
+    attr_reader :directory
+    # @return [::String] The razor environment.
+    attr_reader :environment
+    # @return [Array<Config>] An array of Razor configs supported by this
+    # instance.
+    attr_reader :configs
+
+    # Initializer.
+    #
+    # @param directory [::String] Path to the razor instance.
+    # @param environment [::String] The razor environment.
+    # @param configs [Array<Config>] An array of Razor configs supported by this
+    # instance.
+    # @param options [Hash] The options hash.
+    #
+    # @option executor [#execute]
+    #   (::RazorRisk::Razor::Control::Razor::Executor) The object that will
+    #   execute the scripts.
+    def initialize directory, environment, configs, **options
+
+        trace ParamNames[ :directory, :environment, :configs ], directory, environment, configs
+
+        @directory = check_parameter directory, 'directory', type: ::String
+        @environment = check_parameter environment, 'environment', type: ::String
+        check_parameter configs, 'configs', type: [ ::RazorRisk::Razor::Control::Razor::Config ]
+
+        raise RazorControlException.new(
+            "Razor directory '#{@directory}' does not exist or is not a directory."
+        ) unless File.directory? @directory
+        raise RazorControlException.new(
+            "Razor Instance must have at least one config defined"
+        ) if configs.empty?
+
+        @configs = configs.map do |c|
+
+            p = File.join(@directory, c.path)
+            raise RazorControlException.new(
+                "Razor config '#{c.name}' did not have an existing directory path; was '#{p}'."
+            ) unless File.directory?(p)
+
+            [ c.name, c ]
+        end.to_h
+
+        @commands = {
+            kill: 'razor_kill.cmd',
+        }
+
+        @executor = options[:executor] || Executor.new
+    end
+
+    # Kills the razor instance.
+    #
+    # @return [boolean] if the exit process succeeded.
+    def kill
+
+        trace
+
+        raise RazorControlException.new(
+            "Command file '#{@commands[:kill]}' does not exist"
+        ) unless File.file?(File.join(@directory, @commands[:kill]))
+
+        log :debug, "Killing Razor with '#{@commands[:kill]}' in '#{@directory}'"
+        @executor.execute @commands[:kill], chdir: @directory
+    end
+
+    # Execute a rebuild on the specified config.
+    #
+    # @param config [String] The name of the config to rebuild.
+    #
+    # @return [boolean] if the rebuild process succeeded.
+    def rebuild config
+
+        trace ParamNames[ :config ], config
+
+        check_parameter config, 'config', type: ::String, values: @configs.keys
+
+        con = @configs[config]
+        dir = File.join(@directory, con.path, con.script_dir)
+
+        raise RazorControlException.new(
+            "Command file '#{con.rebuild_script}' does not exist"
+        ) unless File.file?(File.join(dir, con.rebuild_script))
+
+        log :debug, "Executing rebuild script '#{con.rebuild_script}' in '#{dir}'"
+        @executor.execute con.rebuild_script, chdir: dir
+    end
+
+    # Starts Razor with the specified config.
+    #
+    # @param config [String] The name of the config execute a Turn of Day for.
+    #
+    # @return [boolean] if the turn of day process succeeded.
+    def turn_of_day config
+
+        trace ParamNames[ :config ], config
+
+        check_parameter config, 'config', type: ::String, values: @configs.keys
+
+        con = @configs[config]
+        dir = File.join(@directory, con.path, con.script_dir)
+
+        raise RazorControlException.new(
+            "Command file '#{con.tod_script}' does not exist"
+        ) unless File.file?(File.join(dir, con.tod_script))
+
+        log :debug, "Executing turn of day script '#{con.tod_script}' in '#{dir}'"
+        @executor.execute con.tod_script, chdir: dir
+    end
+
+    # Copy razor logs to output directory. Copies logs to
+    # +<directory>/razor/<config>+.
+    #
+    # @param directory [::String] Path to the output directory.
+    # @param config [::String] The name of the current config.
+    #
+    # @raise [RazorControlException] if Razor log directory does not exist.
+    # @raise [RazorControlException] if no Razor logs can be found.
+    #
+    def copy_logs directory, config
+
+        trace ParamNames[ :directory, :config ], directory, config
+
+        check_parameter directory, 'directory', type: ::String
+        check_parameter config, 'config', type: ::String
+
+        razor_log_dir = File.join(
+            @directory,
+            Razor::LogLocation
+        )
+        out_log_dir = File.join(
+            directory,
+            'razor',
+            config
+        )
+
+        raise RazorControlException.new(
+            "Razor log directory '#{razor_log_dir}' does not exist"
+        ) unless Dir.exists? razor_log_dir
+
+        logs = Dir[ File.join(razor_log_dir, '**', '*.log').gsub('\\', '/') ]
+        raise RazorControlException.new(
+            "Razor logs could not be found in '#{razor_log_dir}'"
+        ) if logs.empty?
+
+        FileUtils.mkdir_p out_log_dir unless Dir.exists? out_log_dir
+
+        logs.each do |f|
+            src = f
+            dst = File.join(out_log_dir, File.basename(f))
+            log :debug, "Copying '#{src}' to '#{dst}'"
+            FileUtils.cp src, dst
+        end
+    end
+end # class RazorInstance
+
+end # module Razor
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,2 @@
+
+require 'razor_risk/razor/control/razor/razor_instance'

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

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Version file for Razor Risk Razor Control library.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+module RazorRisk
+module Razor
+module Control
+
+    # Current version of the RazorRisk::Razor::Control library
+    VERSION             =   '0.1'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    public
+    # Major version of the RazorRisk::Razor:Control library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]       # :nodoc:
+    # Minor version of the RazorRisk::Razor::Control library
+    VERSION_MINOR       =   VERSION_PARTS_[1]       # :nodoc:
+    # Patch version of the RazorRisk::Razor::Control library
+    VERSION_PATCH       =   VERSION_PARTS_[2]       # :nodoc:
+    # Commit version of the RazorRisk::Razor::Control library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0  # :nodoc:
+
+
+    # The description of the framework
+    DESCRIPTION         =   'Support library for controlling razor testing environments.'
+
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+