razorrisk-razor-control 0.1

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

@@ -0,0 +1,397 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Rake Task helpers.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ##########################################################
+# requires
+
+
+begin
+    require 'razor_risk/razor/control/exceptions'
+rescue ::LoadError
+    abort "RazorRisk Diagnostics is required to use this rake file"
+end
+
+begin
+    require 'pantheios'
+rescue ::LoadError
+    abort "Panthios is required to use this rake file"
+end
+
+begin
+    require 'xqsr3/quality/parameter_checking'
+rescue ::LoadError
+    abort "RazorRisk Diagnostics is required to use this rake file"
+end
+
+require 'rubygems/package'
+require 'rubygems/uninstaller'
+require 'rubygems/commands/push_command'
+
+require 'tmpdir'
+
+# ##########################################################
+# RazorInstance
+
+module RazorRisk
+module Razor
+module Control
+module Gem
+
+# Helpers for intercting with Ruby Gems.
+class GemHelpers
+
+    include ::RazorRisk::Razor::Control::Exceptions
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+    # Initialize class.
+    #
+    # @param gem_module [#install] The module for to use for executing
+    # gem commands.
+    #
+    def initialize gem_module = ::Gem
+
+        trace ParamNames[ :gem_module ], gem_module
+
+        @gem_module = check_parameter gem_module, 'gem_module', respond_to: :install
+    end
+
+    # Installs the gem in the specified directory. The specified directory
+    # must have both the gem and gemspec, and may not have multiple versions
+    # of the build gem.
+    #
+    # @raise (see get_gem_file_)
+    #
+    # @param directory [::String] The path to where the gem is located.
+    # @param options (see ::Gem::DependencyInstaller#initialize)
+    #
+    # @return (see ::Gem::DependencyInstaller#installed_gems)
+    def install_gem directory, **options
+
+        trace ParamNames[ :directory ], directory
+
+        check_parameter directory, 'directory', type: ::String
+
+        gem_file = get_gem_file_ directory
+        @gem_module.install gem_file, nil, **options
+    end
+
+    # Builds the gem in the specified directory. The specified directory must
+    # constain a gemspec and no previously built gem.
+    #
+    # @param directory [::String] The path to the gem directory.
+    # @param path [::String,nil] Path to a directory to copy the gem to.
+    #
+    # @raise [GemDeploymentException] if the gemspec fails to load.
+    # @raise (see get_file_)
+    #
+    def build_gem directory, path = nil
+
+        trace ParamNames[ :directory, :path ], directory, path
+
+        check_parameter directory, 'directory', type: ::String
+        check_parameter path, 'path', type: ::String, allow_nil: true
+
+        gemspec = get_gemspec_file_ directory
+
+        spec = @gem_module::Specification.load gemspec
+        raise GemDeploymentException.new "Failed to load gemspec" unless spec
+
+        begin
+            gem_file = @gem_module::Package.build spec
+        rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+            raise
+        rescue => x
+            raise GemDeploymentException.new "Failed to build gem; (#{x.class}): #{x.mesage}"
+        end
+
+        begin
+            FileUtils.cp(
+                gem_file,
+                path
+            ) if path
+        rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+            raise
+        rescue => x
+            raise GemDeploymentException.new "Failed to copy gem to #{path}; (#{x.class}): #{x.message}"
+        end
+    end
+
+    # Push gem to a gem server.
+    #
+    # @param directory [::String] The location of the gem.
+    # @param gem_server [::String] The URL to the gem server.
+    #
+    # @raise (see get_file_)
+    #
+    def push_gem directory, gem_server
+
+        trace ParamNames[ :directory, :gem_server ], directory, gem_server
+
+        check_parameter directory, 'directory', type: ::String
+        check_parameter gem_server, 'gem_server', type: ::String
+
+        gem_file = get_gem_file_ directory
+
+        original = {
+            host: @gem_module.host,
+        }
+
+        begin
+            @gem_module.host = gem_server
+            pc = @gem_module::Commands::PushCommand.new
+            pc.send_gem gem_file
+        ensure
+            @gem_module.host = original[:host]
+        end
+    end
+
+    # Sets gem varaibles to temp directories for the duration of the block.
+    # This is to aid in actions like temporarily installing a gem for
+    # testing.
+    #
+    # The following parameters are ensure to be reset after the block:
+    # * +Gem.dir+
+    # * +Gem.path+
+    # * +Gem.sources+
+    # * Environement vairable +'GEM_HOME'+
+    #
+    # The following parameters are set to a temp directory for the block:
+    # * +Gem.dir+
+    # * Environement vairable +'GEM_HOME'+
+    #
+    # @yield The block to execute with a local temporary environement setup.
+    #
+    def temporary_env &block
+
+        original = {
+            sources: @gem_module.sources,
+            dir: @gem_module.dir,
+            path: @gem_module.path,
+            home: ENV['GEM_HOME'],
+        }
+
+        begin
+            Dir.mktmpdir do |tmpdir|
+                @gem_module.use_paths tmpdir, @gem_module.path
+                ENV['GEM_HOME'] = tmpdir
+                yield
+            end
+        ensure
+            @gem_module.sources = original[:sources]
+            @gem_module.use_paths original[:dir], original[:path]
+            ENV['GEM_HOME'] = original[:home]
+        end
+    end
+
+    private
+    # Gets the path to the gem in the specified directory by first getting
+    # the gem name from the gemspec.
+    #
+    # @param directory [::String] The path to where the gem is located.
+    #
+    # @raise (see get_file_)
+    #
+    # @return [::String] The path to the gem file.
+    def get_gem_file_ directory = '.'
+
+        gemspec = get_gemspec_file_ directory
+        spec = @gem_module::Specification.load gemspec
+        raise GemDeploymentException.new "Failed to load gemspec #{spec}" unless spec
+        get_file_ "#{spec.name}*.gem", 'project gem', directory
+    end
+
+    # Finds the gemspec file.
+    #
+    # @param directory [::String] The directory to search in.
+    #
+    # @raise (see get_file_)
+    #
+    # @return [::String] The path to the gemspec file.
+    def get_gemspec_file_ directory = '.'
+
+        get_file_ '*.gemspec', 'gemspec', directory
+    end
+
+    # Finds a file based on a glob pattern. This method expects only one file
+    # to be found.
+    #
+    # @param pattern [::String] A pattern for use with a file glob.
+    # @param name [::String] The name of the type of files being searched
+    #   for.
+    # @param directory [::String] The directory to search in.
+    #
+    # @raise [GemDeploymentException] if no files are found.
+    # @raise [GemDeploymentException] if more than one file is found.
+    #
+    # @return [::String] The path to the file.
+    def get_file_ pattern, name, directory = '.'
+
+        files = Dir.glob("#{directory}/#{pattern}")
+        case files.count
+        when 0
+            raise GemDeploymentException.new "No #{name} files found"
+        when 1
+            return files.first
+        else
+            raise GemDeploymentException.new "Multiple #{name} files found: #{files}"
+        end
+    end
+end
+
+# @!visibility private
+module MockGem
+
+    def self.host= host
+        @host = host
+    end
+
+    def self.host
+        @host
+    end
+
+    def self.sources= sources
+        @sources = sources
+    end
+
+    def self.sources
+        @sources
+    end
+
+    def self.dir= dir
+        @dir = dir
+    end
+
+    def self.dir
+        @dir
+    end
+
+    def self.path= path
+        @path = path
+    end
+
+    def self.path
+        @path
+    end
+
+    def self.use_paths dir, path
+        @dir = dir
+        @path = path
+    end
+
+    def self.install_block &block
+        @install_block = block
+    end
+
+    def self.install name, version = nil, **options
+        @install_block.call(name, version, **options) if @install_block
+    end
+
+    def self.clear
+        @install_block = nil
+        @host = nil
+        @sources = nil
+        @dir = nil
+        @path = nil
+        Specification.clear
+        Package.clear
+        Commands::PushCommand.clear
+    end
+
+    private
+    @install_block = nil
+    @host = nil
+    @sources = nil
+    @dir = nil
+    @path = nil
+
+    public
+    module Specification
+
+        Spec = Struct.new(:name)
+
+        def self.load spec
+            @load_block.call(spec) if @load_block
+            @specs[spec]
+        end
+
+        def self.add_spec spec, name
+            @specs[spec] = Spec.new(name)
+        end
+
+        def self.load_block &block
+            @load_block = block
+        end
+
+        def self.clear
+            @specs = {}
+            @load_block = nil
+        end
+
+        private
+        @specs = {}
+        @load_block = nil
+    end
+
+    module Package
+
+        def self.build spec
+            @build_block.call(spec) if @build_block
+            @gems[spec.name]
+        end
+
+        def self.add_gem name
+            @gems[name] = "#{name}.gem"
+        end
+
+        def self.build_block &block
+            @build_block = block
+        end
+
+        def self.clear
+            @build_block = nil
+            @gems = {}
+        end
+
+        private
+        @gems = {}
+        @build_block = nil
+    end
+
+    module Commands
+        class PushCommand
+
+            def self.push_block &block
+                @@push_block = block
+            end
+
+            def self.clear
+                @@push_block = nil
+            end
+
+            def send_gem gem_file
+                @@push_block.call(gem_file) if @@push_block
+            end
+
+            private
+            @@push_block = nil
+        end
+    end
+end
+
+end # module RakeHelpers
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Rake Task helpers.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ##########################################################
+# requires
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+require 'rake'
+
+require 'razor_risk/core/diagnostics/logger'
+
+# ##########################################################
+# RazorInstance
+
+module RazorRisk
+module Razor
+module Control
+module RakeHelpers
+
+# Extends ruby abort for rake files that provides a hook and logging.
+module RakeAborter
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::RazorRisk::Core::Diagnostics::Logger
+    private
+    @@abort_hook = []
+    @@called = false
+
+    public
+    # Executes defined abort hooks before terminating execution. If
+    # exceptions are raised during execution of the hooks, the exception will
+    # be logged and hook execution will end.
+    #
+    # @param msg [::String] Message to be written to +STRERR+ before
+    #   termination.
+    #
+    # @see ::Kernel::abort
+    def abort msg = nil
+
+        begin
+
+            unless @@called
+
+                @@called = true
+
+                log :critical, 'Aborting' + (msg ? ": #{msg}" : '')
+                log :critical, 'Executing abort hook(s)' unless @@abort_hook.empty?
+
+                @@abort_hook.each do |h|
+                    h.call
+                end
+            end
+        rescue => x
+
+            log :critical, "Exception during abort: (#{x.class}): #{x.message}\n#{x.backtrace * "\n"}"
+        ensure
+
+            msg ?  Kernel.abort(msg) : Kernel.abort
+        end
+    end
+
+    # Sets the provided proc to execute if rake aborts.
+    #
+    # @param block [#call] The proc to execute if a task aborts.
+    def self.abort_hook &block
+
+        check_parameter block, 'block', respond_to: :call
+
+        @@abort_hook << block
+    end
+end
+
+end # module RakeHelpers
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Diagnostics Rake tasks for Razor Risk projects.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ######################################################################## #
+# requires
+
+require 'razor_risk/razor/control/diagnostics/zeroth_include'
+require 'razor_risk/razor/control/diagnostics/util_functions'
+
+require 'xqsr3/quality/parameter_checking'
+
+require 'rake'
+require 'rake/clean'
+
+
+module RazorRisk
+module Razor
+module Control
+module RakeHelpers
+
+# Rake tasks for setting up logging.
+module DiagnosticTasks
+
+    extend ::Rake::DSL
+
+    include ::RazorRisk::Razor::Control
+    include ::Xqsr3::Quality::ParameterChecking
+
+
+    # ##########################################################
+    # tasks
+
+    namespace :diagnostics do
+
+        # Task to initialize logging for rake files.
+        #
+        # @param name [::String] The program name.
+        # @param version [::String] The program version.
+        # @param directory [::String] The directory to write logs to.
+        # @param thrsholds [Array<::Symbol, ::Symbol>] The logging thresholds.
+        #
+        task :init, [ :name, :version, :directory, :thresholds ] do |task, args|
+
+            name      = check_parameter args[:name], 'name', type: ::String
+            version   = check_parameter args[:version], 'version', type: ::String
+            directory = check_parameter args[:directory], 'directory', type: ::String
+            threshold = check_parameter args[:thresholds], 'thresholds', type: [::String, ::Symbol]
+
+            Diagnostics.setup_diagnostic_logging(
+                "#{name}-#{version}",
+                log_directory: directory,
+                log_threshold: threshold,
+            )
+
+            CLEAN << directory
+        end
+    end
+end # module DiagnosticsTasks
+
+end # module RakeHelpers
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,128 @@
+# 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/exceptions'
+require 'razor_risk/razor/control/gem/gem_helpers'
+
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+module RazorRisk
+module Razor
+module Control
+module RakeHelpers
+
+# Rake tasks for building/installing/testing/deploying gems.
+module GemTasks
+
+    extend ::Rake::DSL
+
+    include ::RazorRisk::Razor::Control::Gem
+    include ::RazorRisk::Razor::Control::Exceptions
+
+    # ######################################################################## #
+    # constants
+
+    # Constants for use in gem related rake tasks.
+    module Constants
+
+        # Default gem server to use.
+        GemServer = ENV['RZ_GEM_SERVER'] || 'http://syd-pandora:9292'
+
+        # Unit test options
+        UnitTestOps = '--no-show-detail-immediately -v'
+    end
+
+    # ##########################################################
+    # JUnit Reporting
+
+    if ENV['RR_GENERATE_REPORTS'] == 'true'
+        require 'ci/reporter/rake/test_unit'
+        ENV['TESTOPTS'] = Constants::UnitTestOps
+        ::Rake::Task['ci:setup:testunit'].invoke
+    end
+
+
+    # ##########################################################
+    # clean and clobber
+
+    CLEAN << Dir[ 'test/reports' ]
+    CLOBBER << Dir[ '*.gem' ]
+
+
+    # ##########################################################
+    # tasks
+
+    namespace :gem do
+
+        # Test task runs all tests
+        Rake::TestTask.new do |t|
+            t.test_files = FileList[ 'test/unit/**/tc_*.rb']
+            t.verbose = false
+            # Disable warnings for code that Razor Risk does not control.
+            # See also https://github.com/hanami/utils/issues/123 for details.
+            t.warning = false
+            t.options = Constants::UnitTestOps
+            t.name = :unit_test
+            t.description = nil
+        end
+
+        task :build, [:path] do |task, options|
+
+            begin
+                GemHelpers.new.build_gem '.', options[:path]
+            rescue GemDeploymentException => x
+                abort x.message
+            end
+        end
+
+        task :install, [:options] do |task, args|
+
+            options = args[:options] || {}
+            begin
+                GemHelpers.new.install_gem '.', **options
+            rescue GemDeploymentException => x
+                abort x.message
+            end
+        end
+
+        task :push do
+
+            begin
+                GemHelpers.new.push_gem '.', Constants::GemServer
+            rescue GemDeploymentException => x
+                abort x.message
+            end
+        end
+
+        task :test_with_local_install do
+
+            GemHelpers.new.temporary_env do
+                ::Gem.sources = [ Constants::GemServer ]
+                ::Rake::Task[:'gem:install'].invoke
+                ::Rake::Task[:'gem:unit_test'].invoke
+            end
+        end
+    end
+
+end # module GemTasks
+
+end # module RakeHelpers
+end # module Control
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+