razorrisk-cassini-utilities-cassis 0.7.6

data/lib/razor_risk/cassini/utilities/cassis/zip_utils.rb

@@ -0,0 +1,236 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassis/zip_utils.rb
+#
+# Purpose:      Zip utility functions
+#
+# Created:      11th July 2018
+# Updated:      25th January 2019
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+require 'razor_risk/cassini/utilities/cassis/program_utils'
+
+require 'razor_risk/cassini/utilities/cassis/internal/require/pantheios'
+require 'razor_risk/cassini/utilities/cassis/internal/require/xqsr3/quality/parameter_checking'
+
+require 'open3'
+require 'yaml'
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+module CassIS
+
+module ZipUtils
+
+    def load_unzippers_spec config_dirs, unzippers_all, unzippers_unix, unzippers_windows
+
+        unzippers = nil
+
+        unless unzippers
+
+            config_dirs.each do |config_dir|
+
+                cf_path = File.join(config_dir, ProgramUtils.windows? ? unzippers_windows : unzippers_unix)
+
+                if File.file?(cf_path)
+
+                    unzippers = cf_path
+
+                    break
+                end
+            end
+        end
+
+        unless unzippers
+
+            config_dirs.each do |config_dir|
+
+                cf_path = File.join(config_dir, unzippers_all)
+
+                if File.file? cf_path
+
+                    unzippers = cf_path
+
+                    break
+                end
+            end
+        end
+
+        if unzippers
+
+            begin
+
+                unzippers = YAML.load_file unzippers
+            rescue => x
+
+                $stderr.puts "exception(#{x.class}): #{x}"
+
+                raise
+            end
+        end
+
+        unzippers
+    end
+
+    def load_unzipper_classes lib_dir, aborter
+
+        Dir[ "#{lib_dir}/razor_risk/utilities/software/packaging/unzippers/*" ].each { |p| require p }
+
+        unless defined?(::RazorRisk::Utilities::Software::Packaging::Unzippers)
+
+            begin
+
+                require 'razor_risk/utilities/software/packaging/unzippers'
+            rescue ::LoadError
+
+                aborter.abort 'no zippers found'
+            end
+        end
+    end
+
+    def get_zip_command_maker unzip_tools, env, **options
+
+        hmd =   nil
+
+        if ProgramUtils.windows?
+
+            hmd ||= options[:homedrive]
+            hmd ||= env['HOMEDRIVE'] || 'C:'
+        end
+
+        unzip_tools.each do |k, v|
+
+            uz_class    =   v['class'] or next
+
+            # 1. try the environment variable(s)
+
+            env_vars    =   v['env-vars'] || []
+
+            env_vars.each do |env_var|
+
+                evv =   env[env_var]
+
+                if evv && File.exist?(evv)
+
+                    # evv might be a file, in which case
+
+                    return uz_class.new(evv) if File.file?(evv)
+
+                    if File.directory?(evv)
+
+                        exe =   v['exe']
+
+                        p   =   File.join(evv, exe)
+
+                        return uz_class.new(p) if File.file?(p)
+                    end
+                end
+            end
+
+            # 2. try the directories
+
+            exe         =   v['exe'] or next
+
+            directories =   v['directories'] || []
+
+            directories.each do |dir|
+
+                dir =   ProgramUtils.make_windows_path(dir, hmd) if ProgramUtils.windows?
+
+                p   =   File.join(dir, exe)
+
+                return uz_class.new(p) if File.file?(p)
+            end
+
+            # 3. try 'which/where'
+
+            unless ProgramUtils.windows?
+
+                begin
+
+                    stdout, _, status   =   Open3::captur3("which \"#{exe}\"")
+                    r                   =   stdout.strip
+
+                    return uz_class.new(r) unless r.nil? or r.empty? or !status.success?
+                rescue Errno::ENOENT => x
+
+                end
+            else
+
+                begin
+                    stdout, _, status   =   Open3::capture3("where \"#{exe}\"")
+                    r                   =   stdout.split(/$/).map(&:strip).compact.first
+
+                    return uz_class.new(r) unless r.nil? or r.empty? or !status.success?
+                rescue Errno::ENOENT => x
+
+                end
+            end
+        end
+
+
+        nil
+    end
+
+    def report_unzip_failure unzip_tools, env, aborter, **options
+
+        hmd =   nil
+
+        if windows?
+
+            hmd ||= options[:homedrive]
+            hmd ||= env['HOMEDRIVE'] || 'C:'
+        end
+
+        msg =   ''
+
+        msg +=  "failed to detect any of the following (un)zipper utilities:\n"
+
+        unzip_tools.each { |k, v| msg += "\t#{k}\n" }
+
+        msg +=  "in any of the following directories:\n"
+
+        unzip_tools.each do |k, v|
+
+            (v['directories'] || {}).each do |dir|
+
+                dir =   ProgramUtils.make_windows_path(dir, hmd) if windows?
+
+                msg +=  "\t#{dir}\n"
+            end
+        end
+
+        msg +=  "and none of the following environment variables were defined or, if defined, existed:\n"
+
+        unzip_tools.each do |k, v|
+
+            (v['env-vars'] || {}).each do |ev|
+
+                msg +=  "\t#{ev}\n"
+            end
+        end
+
+        aborter.abort msg
+    end
+
+end # module ZipUtils
+
+end # module CassIS
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassis.rb

@@ -0,0 +1,6 @@
+
+require 'razor_risk/cassini/utilities/cassis/configuration_generator'
+require 'razor_risk/cassini/utilities/cassis/constants'
+require 'razor_risk/cassini/utilities/cassis/program_utils'
+require 'razor_risk/cassini/utilities/cassis/version'
+require 'razor_risk/cassini/utilities/cassis/zip_utils'

data/lib/razor_risk/cassini/utilities/configuration/cli.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Process the CLI arguments for the configurator.
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/utilities/cassis/version'
+require 'razor_risk/cassini/utilities/cassis/constants'
+
+require 'libclimate'
+
+
+# ##########################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Utilities
+module Configuration
+
+# ##########################################################
+# CLI
+
+class CLI
+
+    include ::RazorRisk::Cassini::Utilities::CassIS
+
+    def self.parse_args *args
+
+        options = {}
+        climate = LibCLImate::Climate.new do |cl|
+
+            cl.add_flag(
+                '--absolute-paths',
+                alias: '-a',
+                help: 'given paths are made absolute'
+            ) do
+                options[:absolute_paths] = true
+            end
+
+            cl.add_flag(
+                '--quiet',
+                alias: '-q',
+                help: 'does not issue informational/progress reports (to standard output stream) the installation progress steps; any failure contingent reports are still issued'
+            ) do
+                options[:quiet] = true
+            end
+
+            cl.add_flag(
+                '--generate-initial-config ',
+                alias: '-C',
+                help: 'generates an initial configuration file'
+            ) do
+                options[:gen_init_conf] = true
+            end
+
+            cl.add_flag(
+                '--generate-secrets',
+                alias: '-S',
+                help: 'generates a secrets files required for JWT'
+            ) do
+                options[:gen_secrets] = true
+            end
+
+            cl.add_flag(
+                '--no-configuration',
+                alias: '-N',
+                help: 'do not run configuration helper to configure the razor web services'
+            ) do
+                options[:no_configuration] = true
+            end
+
+            cl.add_option(
+                '--input-config-file',
+                alias: '-f',
+                help: 'Merge an input configuration rather than configuring interactively'
+            ) do |o, a|
+                options[:no_configuration] = true
+                options[:input_config] = o.value
+            end
+
+            cl.info_lines = [
+                'Razor Web Services Configuration Tool',
+                CASSIS_INFO_DESCRIPTION,
+                CASSINI_INFO_DESCRIPTION,
+                CASSINI_INFO_COPYRIGHT_ + '2018',
+                :version,
+                nil,
+                'Configures a Razor Web Services instance.',
+                nil,
+            ]
+        end
+
+        options[:aborter]           = climate
+        options[:working_directory] = Dir.pwd
+
+        climate.run *args
+
+        options
+    end
+end
+
+
+# ##########################################################
+# modules
+
+end # module Configuration
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/configuration.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/utilities/configuration/cli'
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/extensions/hash.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+#
+class Hash
+
+    # Returns a new hash that combines the contents of the receiver and the
+    # contents of the given hash. Duplicate keys are deep merged if the
+    # values are both hashes, concatenated if both values are arrays,
+    # otherwise overwritten with the value from +other_hash+.
+    #
+    # @param other_hash [Hash] The hash to be merged in.
+    #
+    # @raise [::ArgumentError] if +other_hash+ is not a +Hash+.
+    #
+    # @return [::Hash] A new hash that combines the contents of the receiver
+    #   and the contents of the given hash.
+    def deep_merge other_hash
+
+        unless other_hash.is_a? ::Hash
+            raise ArgumentError.new "Argument is not a Hash"
+        end
+
+        self.merge(other_hash) do |key, v1, v2|
+            if v1.is_a? ::Hash and v2.is_a? ::Hash
+                v1.deep_merge v2
+            elsif v1.is_a? ::Array and v2.is_a? ::Array
+                [ v1, v2 ].flatten
+            else
+                v2
+            end
+        end
+    end
+end
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/utilities/software/packaging/unzippers/mac_zip.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         lib/razor_risk/utilities/software/packaging/unzippers/mac_zip.rb
+#
+# Purpose:      Definition of
+#               RazorRisk::Utilities::Software::Packaging::Unzippers::MacZip
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'open3'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Utilities
+module Software
+module Packaging
+module Unzippers
+
+# ##########################################################################
+# classes
+
+class MacZip
+
+    def initialize exe_path, **options
+
+        @exe_path   =   exe_path
+        @options    =   options
+    end
+
+    def call(archive_path, destination_root, **options)
+
+        options =   @options.merge options
+        indent  =   options[:indent] || ''
+
+        cmd =   ''
+        cmd +=  %Q<"#{@exe_path}" >
+        cmd +=  '-o '
+        cmd +=  %Q<-d "#{destination_root}" >
+        cmd +=  '-- '
+        cmd +=  %Q<"#{archive_path}">
+
+        stdout_str, stderr_str, status = Open3.capture3(cmd)
+
+        if 0 != status.exitstatus
+
+            $stderr.puts stderr_str
+
+            return status.exitstatus
+        else
+
+            unless options[:quiet]
+
+                $stdout.puts stdout_str.split(/[\r\n]/).map { |l| "#{indent}#{l}" }.join("\n")
+            end
+        end
+
+        0
+    end
+end
+
+end # module Unzippers
+end # module Packaging
+end # module Software
+end # module Utilities
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/utilities/software/packaging/unzippers/seven_zip.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         lib/razor_risk/utilities/software/packaging/unzippers/seven_zip.rb
+#
+# Purpose:      Definition of
+#               RazorRisk::Utilities::Software::Packaging::Unzippers::SevenZip
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'open3'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Utilities
+module Software
+module Packaging
+module Unzippers
+
+# ##########################################################################
+# classes
+
+class SevenZip
+
+    def initialize exe_path, **options
+
+        @exe_path   =   exe_path
+        @options    =   options
+    end
+
+    def call(archive_path, destination_root, **options)
+
+        options =   @options.merge options
+        indent  =   options[:indent] || ''
+
+        cmd =   ''
+        cmd +=  %Q<"#{@exe_path}" >
+        cmd +=  'x '
+        cmd +=  '-aoa '
+        cmd +=  %Q<-o"#{destination_root}" >
+        cmd +=  '-- '
+        cmd +=  %Q<"#{archive_path}">
+
+        stdout_str, stderr_str, status = Open3.capture3(cmd)
+
+        if 0 != status.exitstatus
+
+            $stderr.puts stderr_str
+
+            return status.exitstatus
+        else
+
+            unless options[:quiet]
+
+                $stdout.puts stdout_str.split(/[\r\n]/).map { |l| "#{indent}#{l}" }.join("\n")
+            end
+        end
+
+        0
+    end
+end
+
+end # module Unzippers
+end # module Packaging
+end # module Software
+end # module Utilities
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/utilities/software/packaging/unzippers/win_rar.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         lib/razor_risk/utilities/software/packaging/unzippers/win_rar.rb
+#
+# Purpose:      Definition of
+#               RazorRisk::Utilities::Software::Packaging::Unzippers::WinRAR
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'open3'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Utilities
+module Software
+module Packaging
+module Unzippers
+
+# ##########################################################################
+# classes
+
+class WinRAR
+
+    def initialize exe_path, **options
+
+        @exe_path   =   exe_path
+        @options    =   options
+    end
+
+    def call(archive_path, destination_root, **options)
+
+        options =   @options.merge options
+        indent  =   options[:indent] || ''
+
+        cmd =   ''
+        cmd +=  %Q<"#{@exe_path}" >
+        cmd +=  'x '
+        cmd +=  '-o+ '
+        cmd +=  %Q<"#{archive_path}" >
+        cmd +=  '*.* '
+        cmd +=  %Q<"#{destination_root}">
+
+        stdout_str, stderr_str, status = Open3.capture3(cmd)
+
+        if 0 != status.exitstatus
+
+            $stderr.puts stderr_str
+
+            return status.exitstatus
+        else
+
+            unless options[:quiet]
+
+                $stdout.puts stdout_str.split(/[\r\n]/).map { |l| "#{indent}#{l}" }.join("\n")
+            end
+        end
+
+        0
+    end
+end
+
+end # module Unzippers
+end # module Packaging
+end # module Software
+end # module Utilities
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+