blufin-lib 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 781d11b53064e1a5a3dea7d33e7a9d991dd0b7ee
-  data.tar.gz: 4ba21e3918b587754588ca52f4a457885597c68c
+  metadata.gz: 270bafc81b6eadf414cfadf2468ad3b85bf569b8
+  data.tar.gz: ef34b1af83e74ec125af126924d5772d8cadf6ca
 SHA512:
-  metadata.gz: 0c0cd453d915027c66fc137f0346ed9d19fccfc72de22ce75e6535b1edefc929f16ee2c6af11571d27219f043c6af1c0c7fa5d3d82c2216c61818b626e1735b8
-  data.tar.gz: 49d99beb71dedc4a3b8f09bf792f4b1e1fcd552a2598499d60eafc394420b59af100759c44a35612064c4d4dde490e6d73fc83c7b546f149bc10bb6d020d95f3
+  metadata.gz: d95f777b6152f9b00ad9bd5ee0ac5894abd2a12f129927519656fd295f5af64d1681ff3e39d2c4d1f4c68bc9561def591c8fa198f7aae8688a4e31b5d482718d
+  data.tar.gz: 41b89f6e3318cc01fee5dca3b1d657fa199c39cb34f32e23446f89e812e7c55d7028874adf9d1ba446b5d0fd37d465c75e160b60db94735a8e559fb0c2449f03

data/lib/blufin-lib.rb

@@ -1,18 +1,21 @@
 module Blufin
 
     autoload :Arrays, 'core/arrays'
+    autoload :Base, 'core/base'
     autoload :Browser, 'core/browser'
+    autoload :Config, 'core/config'
     autoload :DateTimeUtils, 'core/datetime_utils'
     autoload :Encryptor, 'core/encryptor'
     autoload :Files, 'core/files'
     autoload :Image, 'core/image'
     autoload :Network, 'core/network'
     autoload :Numbers, 'core/numbers'
+    autoload :Projects, 'core/projects'
     autoload :Routes, 'core/routes'
-    autoload :SSH, 'core/ssh'
     autoload :Strings, 'core/strings'
     autoload :Terminal, 'core/terminal'
     autoload :Tools, 'core/tools'
     autoload :Validate, 'core/validate'
+    autoload :Versioning, 'core/versioning'
 
 end

data/lib/core/base.rb

@@ -0,0 +1,17 @@
+module Blufin
+
+    class Base
+
+        OPT_PATH = '/opt'
+
+        # Get PATH to opt files.
+        # @return String
+        def self.get_base_path
+            base_path = File.dirname(File.expand_path(__FILE__))
+            base_path = base_path.gsub(/\/\w+\/\w+\z/i, '')
+            base_path
+        end
+
+    end
+
+end

data/lib/core/config.rb

@@ -0,0 +1,110 @@
+require 'yaml'
+require 'kwalify'
+
+module Blufin
+
+    class Config
+
+        @@data = {}
+
+        # Validate and initialize the configuration file.
+        # @return void
+        def self.init(schema_file, template_file, config_file, gem_name, setup_command = 'x')
+            schema_file = File.expand_path(schema_file)
+            template_file = File.expand_path(template_file)
+            config_file = File.expand_path(config_file)
+            raise RuntimeError, "File not found: #{schema_file}" unless Blufin::Files::file_exists(schema_file)
+            raise RuntimeError, "File not found: #{template_file}" unless Blufin::Files::file_exists(template_file)
+            if Blufin::Files::file_exists(config_file)
+                # Validate the user created config file.
+                load_config(config_file, schema_file, gem_name)
+            else
+                system('clear')
+                if Blufin::Terminal::prompt_yes_no(" Missing Configuration File: #{Blufin::Terminal::format_directory(config_file)}", 'This script can automatically create it.', 'Create configuration file')
+                    make_config(template_file, config_file)
+                    edit_config(config_file)
+                    Blufin::Terminal::custom('File Created', 56, "Now try running: #{Blufin::Terminal::format_command(gem_name)}", nil, false)
+                end
+                exit
+            end
+        end
+
+        # Straight-up returns the data object so you can get keys using string literals.
+        # Hard-coding keys is OK because configuration rarely changes and it's validated, so you can be assured the data is there.
+        # @return Hash
+        def self.get
+            @@data
+        end
+
+        # Use for path. Basically wraps them in File.expand_path.
+        # @return String
+        def self.get_path(*args)
+            val = get
+            args.each { |arg| val = val[arg] }
+            File.expand_path(val)
+        end
+
+        # Opens the config file in VIM.
+        # @return void
+        def self.edit_config(config_file)
+            system("vim #{config_file}")
+        end
+
+        # This validates the configuration file against the defined schema.
+        # @return Array
+        def self.validate_file(config_file, schema_file)
+            begin
+                schema_file_parsed = YAML.load_file(schema_file)
+            rescue => e
+                Blufin::Terminal::error("Failed to parse config file: #{Blufin::Terminal::format_directory(config_file)}", e.message)
+            end
+            validator = Kwalify::Validator.new(schema_file_parsed)
+            begin
+                document = YAML.load_file(config_file)
+                # This is here because the IDE is incorrectly resolving to Convoy::validate().
+                # noinspection RubyArgCount
+                errors = validator.validate(document)
+            rescue => e
+                Blufin::Terminal::error("Failed to parse config file: #{Blufin::Terminal::format_directory(config_file)}", e.message)
+            end
+            return document, errors
+        end
+
+        # This shows the schema validation errors in a consistent manner across all the gems.
+        # @return void
+        def self.display_errors(errors, gem_name, setup_command = 'x')
+            errors_output = []
+            errors.each { |e|
+                errors_output << "[#{e.path}] #{e.message}"
+            }
+            invalid_configuration(gem_name, errors, setup_command)
+        end
+
+        # Standardized way of outputting invalid configuration.
+        # @return void
+        def self.invalid_configuration(gem_name, errors = nil, setup_command = 'x')
+            Blufin::Terminal::error("Your configuration file is invalid. To fix it run: #{Blufin::Terminal::format_command("#{gem_name} #{setup_command}")}", errors, true)
+        end
+
+        private
+
+        # Loads the config file into global Hash.
+        # @return void
+        def self.load_config(config_file, schema_file, gem_name, setup_command = 'x')
+            document, errors = validate_file(config_file, schema_file)
+            if errors && !errors.empty?
+                display_errors(errors, gem_name, setup_command)
+            else
+                @@data = document
+            end
+        end
+
+        # Creates a the config file from the given template.
+        # @return
+        def self.make_config(template_file, config_file)
+            `cp #{template_file} #{config_file}`
+        end
+
+    end
+
+end

data/lib/core/files.rb

@@ -162,6 +162,12 @@ module Blufin
         def self.write_file(path_and_file, array_of_lines)
             raise RuntimeError, "Expected String, instead got: #{path_and_file.class}" unless path_and_file.is_a?(String)
             path_and_file = File.expand_path(path_and_file)
+            # If this comes in as a string, convert it to an Array of lines.
+            if array_of_lines.is_a?(String)
+                array_of_lines_new = []
+                array_of_lines.split("\n").each { |line| array_of_lines_new << line.gsub("\n", '') }
+                array_of_lines = array_of_lines_new
+            end
             raise RuntimeError, "Expected an array of lines to write to file, instead got: #{array_of_lines.class}" unless array_of_lines.is_a? Array
             prepare_for_file_write(path_and_file)
             begin
@@ -327,7 +333,7 @@ module Blufin
             files.uniq.sort
         end
 
-           # Get and array of directories in a directory.
+        # Get and array of directories in a directory.
         # @return Array
         def self.get_dirs_in_dir(path, recursive = false)
             raise RuntimeError, "Expected String, instead got: #{path.class}" unless path.is_a?(String)
@@ -381,6 +387,16 @@ module Blufin
             return File.basename(File.expand_path(path_and_file), '*') unless include_extension
         end
 
+        # Returns TRUE if file is empty. Ignores spaces and new-line characters.
+        # @return bool
+        def self.is_empty(path_and_file)
+            Blufin::Files::read_file(path_and_file).each do |line|
+                line.strip!
+                return false if line != ''
+            end
+            true
+        end
+
         private
 
         # Creates path (if not exists) and deletes file (if exists).

data/lib/core/projects.rb

@@ -0,0 +1,331 @@
+module Blufin
+
+    class Projects
+
+        SCHEMA_FILE = "#{Blufin::Base::get_base_path}#{Blufin::Base::OPT_PATH}/awx/project-schema.yml"
+        SCRIPT_RUN = 'run'
+        SCRIPT_TEST = 'test'
+        SCRIPT_BUILD = 'build'
+        SCRIPT_DEPLOY = 'deploy'
+        RUN_SCRIPTS = 'RunScripts'
+        TEST_SCRIPTS = 'TestScripts'
+        BUILD_SCRIPTS = 'BuildScripts'
+        DEPLOY_SCRIPTS = 'DeployScripts'
+        DEPLOYMENT_ID = 'Id'
+        TYPE = 'Type'
+        PROJECT = 'Project'
+        REPO_ROOT = 'RepoRoot'
+        REPO_PATH = 'RepoPath'
+        PORT_RANGE = 'PortRange'
+        RUN = 'Run'
+        TEST = 'Test'
+        BUILD = 'Build'
+        DEPLOY = 'Deploy'
+        SERVERS = 'Servers'
+        REGION = 'Region'
+        STACK = 'Stack'
+        ENVIRONMENTS = 'Environments'
+        TARGETS = 'Targets'
+        COMMANDS = 'Commands'
+        API = 'API'
+        TITLE = 'Title'
+        ALIAS = 'Alias'
+        DOMAIN = 'Domain'
+        PROJECT_NAME_PASCAL_CASE = 'ProjectNamePascalCase'
+        PROJECT_NAME = 'ProjectName'
+        TYPE_ALEXA = 'alexa'
+        TYPE_API = 'api'
+        TYPE_LAMBDA = 'lambda'
+        TYPE_UI = 'ui'
+        VALID_TYPES = [
+            TYPE_ALEXA,
+            TYPE_API,
+            TYPE_LAMBDA,
+            TYPE_UI,
+        ]
+
+        @@projects = nil
+        @@project_names = []
+        @@scripts = nil
+        @@deployments = nil
+        @@apis = nil
+        @@environments = []
+
+        # Takes a Hash that should have the APIs, Lambdas and UIs keys in the root.
+        # This can come from both .awx.yml['Profiles'] or .blufin.yml (root).
+        # @return void
+        def self.init(hash, file)
+            raise RuntimeError, 'Cannot run Blufin::Projects::init() more than once.' unless @@projects.nil? && @@scripts.nil?
+            @@projects = {}
+            @@scripts = {}
+            if hash.has_key?('Projects')
+                projects = hash['Projects']
+                # Throw error if we have multiple sources defined, can only have 1.
+                Blufin::Terminal::error("Found multiple sources for #{Blufin::Terminal::format_highlight(UIs)} property in: #{Blufin::Terminal::format_directory(file)}. Can #{Blufin::Terminal::format_highlight('only have one')} of the following, not both:", [Blufin::Terminal::format_invalid('Local'), Blufin::Terminal::format_invalid('S3Bucket')], true) if projects.has_key?('Local') && projects.has_key?('S3Bucket')
+                if projects.has_key?('Local')
+                    source_file = File.expand_path(projects['Local']['File'])
+                    # Throw error if source file doesn't exist.
+                    Blufin::Terminal::error("Cannot find source file: #{Blufin::Terminal::format_directory(source_file)}") unless Blufin::Files::file_exists(source_file)
+                    # Validate the source file against the expected schema.
+                    process_source_file(source_file)
+                elsif projects.has_key?('S3Bucket')
+
+                    # TODO - Finish this once we start running this on an EC2 instance (build/deploy server).
+                    # TODO - Whatever file we validate should be available on disk locally.
+                    # TODO - If the source is an S3 bucket, pull it down into a /tmp folder (on EC2 instance) and validate from there.
+
+                end
+            end
+        end
+
+        # Gets Project(s).
+        # @return Hash
+        def self.get_projects
+            @@projects
+        end
+
+        # Gets Project Name(s).
+        # @return Array
+        def self.get_project_names
+            @@project_names
+        end
+
+        # Gets Script(s).
+        # @return Hash
+        def self.get_scripts
+            @@scripts
+        end
+
+        # Gets API(s).
+        # @return Hash
+        def self.get_apis
+            @@apis
+        end
+
+        # Gets Environments(s).
+        # @return Array
+        def self.get_environments
+            @@environments
+        end
+
+        # Get matching deployments for parameters.
+        # @return Hash
+        def self.get_deployments(project, stack, region, environment)
+            if @@deployments.nil?
+                @@deployments = {}
+                if @@projects.is_a?(Hash) && @@projects.has_key?(project)
+                    project = @@projects[project]
+                    project.each do |deployment_id, data|
+                        if data.is_a?(Hash) && data.has_key?(SERVERS)
+                            servers = data[SERVERS]
+                            if servers.is_a?(Array)
+                                servers.each do |server|
+                                    if server.has_key?(REGION) && server[REGION] == region
+                                        if server.has_key?(STACK) && server[STACK] == stack
+                                            if server.has_key?(ENVIRONMENTS) && server[ENVIRONMENTS].include?(environment)
+                                                @@deployments[deployment_id] = data
+                                            end
+                                        end
+                                    end
+                                end
+                            end
+                        end
+                    end
+                end
+            end
+            @@deployments
+        end
+
+        # Maps root-level property to enum.
+        # @return string
+        def self.script_key_mapper(script_type)
+            if [RUN_SCRIPTS, RUN].include?(script_type)
+                return SCRIPT_RUN
+            elsif [TEST_SCRIPTS, TEST].include?(script_type)
+                return TEST_SCRIPTS
+            elsif [BUILD_SCRIPTS, BUILD].include?(script_type)
+                return BUILD_SCRIPTS
+            elsif [DEPLOY_SCRIPTS, DEPLOY].include?(script_type)
+                return DEPLOY_SCRIPTS
+            else
+                raise RuntimeError, "Unhandled script type: #{script_type}"
+            end
+        end
+
+        private
+
+        # Validate the Project YML.
+        # @return void
+        def self.process_source_file(source_file)
+            # Skip empty file.
+            return if Blufin::Files::is_empty(source_file)
+            # Otherwise, validate file.
+            document, errors = Blufin::Config::validate_file(source_file, SCHEMA_FILE)
+            if errors && !errors.empty?
+                errors_output = []
+                errors.each { |e|
+                    errors_output << "[#{e.path}] #{e.message}"
+                }
+                Blufin::Terminal::error("Your configuration file is invalid. Please fix: #{Blufin::Terminal::format_directory(source_file)}", errors)
+            else
+                begin
+                    file_parsed = YAML.load_file(source_file)
+                rescue => e
+                    Blufin::Terminal::error("Failed to parse config file: #{Blufin::Terminal::format_directory(source_file)}", e.message)
+                end
+
+                # Buffer script(s).
+                [RUN_SCRIPTS, TEST_SCRIPTS, BUILD_SCRIPTS, DEPLOY_SCRIPTS].each do |script_type|
+                    if file_parsed.has_key?(script_type)
+                        if file_parsed[script_type].is_a?(Array)
+                            script_key = script_key_mapper(script_type)
+                            @@scripts[script_key] = {} unless @@scripts.has_key?(script_key)
+                            file_parsed[script_type].each do |script|
+                                script_id = script[DEPLOYMENT_ID]
+                                # Throw error if duplicate script is found for type.
+                                Blufin::Terminal::error("#{Blufin::Terminal::format_highlight("#{script_type} - #{script_id}")} \xe2\x80\x94 Duplicate script found: #{Blufin::Terminal::format_invalid(script_id)}") if @@scripts[script_key].has_key?(script_id)
+                                @@scripts[script_key][script_id] = script
+                                # Check that if script is AWS, it doesn't have --region or --profile flag.
+                                if script.has_key?(COMMANDS)
+                                    script[COMMANDS].each do |command|
+                                        if command.strip =~ /^aws/i
+                                            Blufin::Terminal::error("#{Blufin::Terminal::format_highlight("#{script_type} - #{script_id}")} \xe2\x80\x94 AWS scripts cannot have: #{Blufin::Terminal::format_invalid('--region')} flag.", command) if command =~ /\s--region\s/
+                                            Blufin::Terminal::error("#{Blufin::Terminal::format_highlight("#{script_type} - #{script_id}")} \xe2\x80\x94 AWS scripts cannot have: #{Blufin::Terminal::format_invalid('--profile')} flag.", command) if command =~ /\s--profile\s/
+                                        end
+                                    end
+                                end
+                            end
+                        end
+                    end
+                end
+
+                used_ports = {}
+
+                # Loop (and validate) projects.
+                file_parsed['Projects'].each do |project|
+                    # Validate keys are in specific order.
+                    expected = {
+                        DEPLOYMENT_ID => true,
+                        TYPE => true,
+                        PROJECT => true,
+                        REPO_ROOT => true,
+                        REPO_PATH => true,
+                        PORT_RANGE => false,
+                        RUN => false,
+                        TEST => false,
+                        BUILD => false,
+                        DEPLOY => false,
+                        SERVERS => false,
+                        API => false
+                    }
+                    Blufin::Validate::assert_valid_keys(expected, project.keys, source_file)
+                    project_id = project[DEPLOYMENT_ID]
+                    project_name = project[PROJECT]
+                    project_type = project[TYPE]
+
+                    @@project_names << project_name
+
+                    # Validate Type.
+                    Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Invalid Project Type: #{Blufin::Terminal::format_invalid(project_type)}. Valid types are:", VALID_TYPES, true) unless VALID_TYPES.include?(project_type)
+                    # Validate Script(s).
+                    [RUN, TEST, BUILD, DEPLOY].each do |script_type|
+                        if project.has_key?(script_type)
+                            # Validate the LAMBDA functions don't need build scripts.
+                            Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Project type: #{Blufin::Terminal::format_highlight(TYPE_LAMBDA)} cannot have #{Blufin::Terminal::format_invalid(script_type)} property.", 'This type of project does not support this.', true) if [BUILD].include?(script_type) && project_type == TYPE_LAMBDA
+                            if project[script_type].is_a?(Array)
+                                script_key = script_key_mapper(script_type)
+                                valid_scripts = []
+                                valid_scripts = @@scripts[script_key].keys if @@scripts.has_key?(script_key)
+                                project[script_type].each do |script|
+                                    script_name = script['Script']
+                                    unless valid_scripts.include?(script_name)
+                                        error = valid_scripts.any? ? 'Valid values are:' : "There currently are no #{script_key} script(s) defined."
+                                        Blufin::Terminal::error("#{project_id} \xe2\x80\x94 #{Blufin::Terminal::format_highlight(script_type)} \xe2\x80\x94 Invalid script reference: #{Blufin::Terminal::format_invalid(script_name)}. #{error}", valid_scripts)
+                                    end
+                                end
+                            end
+                        end
+                    end
+                    # Validate Server(s) and create new 'Targets' Hash from it.
+                    if project.has_key?(SERVERS)
+                        targets = {}
+                        project[SERVERS].each do |server|
+                            region = server['Region']
+                            stack = server['Stack']
+                            environments = server['Environments']
+                            environments.each do |environment|
+                                targets[environment] = {} unless targets.has_key?(environment)
+                                targets[environment] = {
+                                    :region => region,
+                                    :stack => stack,
+                                }
+                                @@environments << environment
+                            end
+                        end
+                        project[TARGETS] = targets
+                    end
+                    # Validate APIs and build @@api Hash.
+                    if project_type == TYPE_API
+                        # Make sure we have the API & PortRange properties.
+                        Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Missing property: #{Blufin::Terminal::format_highlight(API)}", "This property is required for project(s) with type: #{API}", true) unless project.has_key?(API)
+                        Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Missing property: #{Blufin::Terminal::format_highlight(PORT_RANGE)}", "This property is required for project(s) with type: #{API}", true) unless project.has_key?(PORT_RANGE)
+                        # Validate keys are in specific order.
+                        expected = {
+                            TITLE => true,
+                            ALIAS => true,
+                            DOMAIN => true,
+                            PROJECT_NAME => true,
+                            PROJECT_NAME_PASCAL_CASE => true
+                        }
+                        Blufin::Validate::assert_valid_keys(expected, project[API].keys, source_file)
+                        @@apis = {} if @@apis.nil?
+                        @@apis[project[DEPLOYMENT_ID]] = {
+                            REPO_ROOT => project[REPO_ROOT],
+                            TITLE => project[API][TITLE],
+                            ALIAS => project[API][ALIAS],
+                            PROJECT_NAME => project[API][PROJECT_NAME],
+                            PROJECT_NAME_PASCAL_CASE => project[API][PROJECT_NAME_PASCAL_CASE],
+                            DOMAIN => project[API][DOMAIN],
+                            PORT_RANGE => project[PORT_RANGE]
+                        }
+                    else
+                        # Make sure we DON'T have the API key.
+                        Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Property not supported: #{Blufin::Terminal::format_invalid(API)}", "This property is only allowed for project(s) with type: #{API}", true) if project.has_key?(API)
+                    end
+
+                    # Validate the ports range.
+                    if project.has_key?(PORT_RANGE)
+                        port_range = project[PORT_RANGE].strip
+                        # Make sure Port Range is in format: XXXX-XXXX
+                        port_range_regex = /^\d{4}-\d{4}$/
+                        Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Port Range does not match regex: #{Blufin::Terminal::format_invalid(port_range)}", "Must match regex: #{port_range_regex}", true) unless port_range =~ port_range_regex
+                        prs = port_range.split('-')
+                        raise RuntimeError, "Expected port range to have exactly one hyphen (-), instead got: #{port_range}" unless prs.length == 2
+                        # Make sure port range spans exactly 20 ports (by having a difference of 19).
+                        Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Port Range either doesn't span 20 ports or is not in correct, numerical order: #{Blufin::Terminal::format_invalid(port_range)}") unless prs[1].to_i - prs[0].to_i == 19
+                        # Make sure none of the ports conflict with other projects.
+                        (prs[0].to_i..prs[1].to_i).each do |i|
+                            if used_ports.has_key?(i)
+                                Blufin::Terminal::error("#{project_id} \xe2\x80\x94 Port overlap detected for range: #{Blufin::Terminal::format_invalid(port_range)}", ["The conflicting project is: #{used_ports[i]}"])
+                            end
+                        end
+                        # Add ports to used_ports.
+                        (prs[0].to_i..prs[1].to_i).each { |i| used_ports[i] = "#{Blufin::Terminal::format_highlight(project_id)} \xe2\x80\x94 #{port_range}" }
+                    end
+
+                    @@projects[project_name] = {} unless @@projects.has_key?(project_name)
+                    Blufin::Terminal::error("Duplicate project ID: #{Blufin::Terminal::format_invalid(project_id)}") if @@projects[project_name].has_key?(project_id)
+                    @@projects[project_name][project_id] = project
+
+                end
+
+                @@project_names.uniq!.sort!
+                @@environments.uniq!.sort!
+
+            end
+
+        end
+
+    end
+
+end

data/lib/core/strings.rb

@@ -1,7 +1,11 @@
+require 'securerandom'
+
 module Blufin
 
     class Strings
 
+        RETURN_CHARACTER = '↵'
+
         # Convert 'snake_case' or 'SnAKE_cAse' to 'SnakeCase'.
         # @param String
         # @return String
@@ -82,6 +86,13 @@ module Blufin
             return ((discrepancies.to_f / total_letters.to_f) * 100).round
         end
 
+        # Generate Random string.
+        # Currently returns something like: 1ec6c763
+        # @return String
+        def self.random_string
+            "#{SecureRandom.uuid.split('-')[0].downcase}#{SecureRandom.uuid.split('-')[0].downcase}"
+        end
+
         private
 
         # Internal string validation.

data/lib/core/terminal.rb

@@ -11,20 +11,20 @@ module Blufin
 
         extend Columnist
 
-        MSG_INFO            = 'info'
-        MSG_WARNING         = 'warning'
-        MSG_ERROR           = 'error'
-        MSG_TODO            = 'todo'
-        MSG_AUTOMATIC       = 'automatic'
-        MSG_GENERATED       = 'generated'
-        MSG_PROCESSED       = 'processed'
-        MSG_PROGRESS        = 'progress'
-        MSG_CUSTOM          = 'custom'
+        MSG_INFO = 'info'
+        MSG_WARNING = 'warning'
+        MSG_ERROR = 'error'
+        MSG_TODO = 'todo'
+        MSG_AUTOMATIC = 'automatic'
+        MSG_GENERATED = 'generated'
+        MSG_PROCESSED = 'processed'
+        MSG_PROGRESS = 'progress'
+        MSG_CUSTOM = 'custom'
         MSG_CUSTOM_AUTO_PAD = 'custom_auto_pad'
 
         # Runs a series of commands in the terminal.
         # @return void
-        def self.command(commands, location = nil, verbose = true, verbose_cd = true, capture_real_output = false)
+        def self.command(commands, location = nil, verbose = true, verbose_cd = true, capture_real_output = false, pbl: false, tbl: false)
             unless commands.is_a?(Array)
                 commands = [commands]
             end
@@ -35,13 +35,15 @@ module Blufin
             end
             output = []
             if verbose_cd && verbose && commands.any? && !location.nil?
-                puts "\x1B[38;5;231m\x1B[42m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m #{Blufin::Terminal::format_command("cd #{location}")}\n"
+                puts "\x1B[38;5;231m\x1B[48;5;22m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m #{Blufin::Terminal::format_command("cd #{location}")}\n"
             end
             if commands.any?
                 commands.each do |command|
                     if verbose
-                        puts "\x1B[38;5;231m\x1B[42m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m #{Blufin::Terminal::format_command("#{command}")}\n"
+                        puts "\x1B[38;5;231m\x1B[48;5;22m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m #{Blufin::Terminal::format_command("#{command}")}\n"
+                        puts if pbl
                     end
+
                     if location.nil?
                         if capture_real_output
                             output << `#{command}`
@@ -60,6 +62,7 @@ module Blufin
             if capture_real_output
                 output.map! { |v| v.gsub('\n', "\n") }
             end
+            puts if tbl
             output
         end
 
@@ -69,25 +72,29 @@ module Blufin
             command(commands, location, verbose, verbose_cd, true)
         end
 
-        # Executes a command and shows that something is happening (via a cli-spinner)
+        # Executes a command and shows that something is happening (via a cli-spinner).
+        # If capture: is false, returns TRUE:FALSE whether command was successful or not.
+        # If capture: is true, returns raw output of command.
         # See: https://github.com/piotrmurach/tty-spinner/blob/master/lib/tty/spinner/formats.rb (for spinner options).
         # @return void
-        def self.execute(command, path = nil, capture = false)
-            t1      = Time.now
-            spinner = TTY::Spinner.new("[:spinner] \x1B[38;5;208m#{command}#{!path.nil? ? " \x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;240m#{path}" : nil}\x1B[0m", format: :dots)
-            spinner.auto_spin
+        def self.execute(command, path = nil, capture: false, verbose: true, text: nil)
+            text = text.is_a?(String) ? text : command
+            t1 = Time.now
+            spinner = TTY::Spinner.new("[:spinner] \x1B[38;5;208m#{text}#{!path.nil? ? " \x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;240m#{path}" : nil}\x1B[0m", format: :dots) if verbose
+            spinner.auto_spin if verbose
             path = File.expand_path('~/') if path.nil?
             if capture
-                res = system(`cd #{path} && #{command}`)
+                res = `cd #{path} && #{command}`
             else
                 res = system("cd #{path} && #{command} > /tmp/execute-output")
             end
-            t2    = Time.now
+            t2 = Time.now
             delta = "#{'%.3f' % (t2 - t1).abs}s"
             if res || capture
-                spinner.success("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;46mComplete \x1B[38;5;240m(#{delta})\x1B[0m\x1B[0m")
+                spinner.success("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;46mComplete \x1B[38;5;240m(#{delta})\x1B[0m\x1B[0m") if verbose
             else
-                spinner.error("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;196mFailed (#{delta})\x1B[0m")
+                spinner.error("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;196mFailed (#{delta})\x1B[0m") if verbose
+                # If there is an error, output it (even if verbose == false).
                 puts "\x1B[38;5;240m"
                 system('cat /tmp/execute-output')
                 puts "\x1B[0m"
@@ -100,12 +107,12 @@ module Blufin
         def self.execute_proc(title, proc, verbose: true)
             raise RuntimeError, "Expected String, instead got:#{title.class}" unless title.is_a?(String)
             raise RuntimeError, "Expected proc to be an instance of Proc, instead got: #{proc.class}" unless proc.is_a?(Proc)
-            t1      = Time.now
+            t1 = Time.now
             spinner = nil
             spinner = TTY::Spinner.new("[:spinner] \x1B[38;5;208m#{title}\x1B[0m", format: :dots) if verbose
             spinner.auto_spin if verbose
-            res   = proc.call
-            t2    = Time.now
+            res = proc.call
+            t2 = Time.now
             delta = "#{'%.3f' % (t2 - t1).abs}s"
             spinner.success("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;46mComplete \x1B[38;5;240m(#{delta})\x1B[0m\x1B[0m") if verbose && res
             spinner.error("\x1B[38;5;246m\xe2\x86\x92 \x1B[38;5;196mFailed (#{delta})\x1B[0m") if verbose && !res
@@ -151,7 +158,7 @@ module Blufin
         # Displays error and exits script by default.
         # @return void
         def self.abort(title = nil, message = nil, exit_script = true, preceding_blank_line = false)
-            title   = 'Abandon ship!' if title.nil?
+            title = 'Abandon ship!' if title.nil?
             message = "You have chosen to \x1B[38;5;196mABORT\x1B[38;5;240m the script." if message.nil?
             Blufin::Terminal::error(title, message, exit_script, preceding_blank_line, 'ABORT')
         end
@@ -193,7 +200,7 @@ module Blufin
         # @return void
         def self.warning(title = nil, message = nil, preceding_blank_line = true)
             puts if preceding_blank_line
-            puts "  \x1B[38;5;231m\x1B[48;5;202m Warning \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
+            puts "  \x1B[38;5;231m\x1B[48;5;130m Warning \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
             parse_messages(message)
         end
 
@@ -210,6 +217,7 @@ module Blufin
         # Displays custom message (ideally, keyword should be 7 characters long to match the rest of the output).
         # @return void
         def self.custom(keyword = 'N/A', color = 1, title = nil, message = nil, preceding_blank_line = true)
+            color = 55 if color.nil?
             puts if preceding_blank_line
             puts "  \x1B[38;5;231m\x1B[48;5;#{color}m #{keyword} \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
             parse_messages(message)
@@ -272,11 +280,25 @@ module Blufin
 
         # Returns action message in consistent, uniform manner.
         # @return String
-        def self.format_highlight(highlighted_text, capitalize = false)
+        def self.format_highlight(highlighted_text, capitalize = false, target: nil)
+            case target
+                when 'cf' # CloudFormation
+                    color = 82
+                    color_end = "\x1B[38;5;246m"
+                when 'cf-ctt' # CloudFormation (Creation Time Title)
+                    color = 196
+                    color_end = "\x1B[38;5;246m"
+                when 'cf-ct' # CloudFormation (Creation Time)
+                    color = 82
+                    color_end = "\x1B[38;5;246m"
+                else
+                    color = 117
+                    color_end = "\x1B[0m"
+            end
             if capitalize
-                return "\x1B[38;5;117m#{highlighted_text.upcase}\x1B[0m"
+                return "\x1B[38;5;#{color}m#{highlighted_text.upcase}#{color_end}"
             else
-                return "\x1B[38;5;117m#{highlighted_text}\x1B[0m"
+                return "\x1B[38;5;#{color}m#{highlighted_text}#{color_end}"
             end
         end
 
@@ -303,10 +325,10 @@ module Blufin
         # Gives a prompt where 'y/Y' will return TRUE, 'n/N' will return false, and ANY other key will do nothing.
         # @return void
         def self.prompt_yes_no(title = nil, message = nil, confirmation_message = nil, preceding_blank_line = true)
-            title                = 'Please confirm YES or NO.' if title.nil?
+            title = 'Please confirm YES or NO.' if title.nil?
             confirmation_message = 'Would you like to continue?' if confirmation_message.nil?
             puts if preceding_blank_line
-            puts "  \x1B[38;5;231m\x1B[48;5;56m Confirm \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
+            puts "  \x1B[38;5;231m\x1B[48;5;55m Confirm \x1B[0m #{title.nil? ? '' : "\xe2\x86\x92 "}#{title}\n"
             parse_messages(message)
             response = ''
             until %w[y Y n N x X a A].include? response
@@ -320,9 +342,9 @@ module Blufin
                     puts "\n"
                     return false
                 when 'a'
-                    Blufin::Terminal::error('Abandon ship!', ["You have chosen to \x1B[38;5;9mABORT\x1B[38;5;240m the script.", nil, 'Please note that whenever you do this, any scripted tasks which were running', 'will have been interrupted mid-script. This may (or may not) cause problems.'], true)
+                    Blufin::Terminal::error('Abandon ship!', ["You have chosen to \x1B[38;5;196mABORT\x1B[38;5;240m the script.", nil, 'Please note that whenever you do this, any scripted tasks which were running', 'will have been interrupted mid-script. This may (or may not) cause problems.'], true)
                 when 'x'
-                    Blufin::Terminal::error('Abandon ship!', ["You have chosen to \x1B[38;5;9mABORT\x1B[38;5;240m the script.", nil, 'Please note that whenever you do this, any scripted tasks which were running', 'will have been interrupted mid-script. This may (or may not) cause problems.'], true)
+                    Blufin::Terminal::error('Abandon ship!', ["You have chosen to \x1B[38;5;196mABORT\x1B[38;5;240m the script.", nil, 'Please note that whenever you do this, any scripted tasks which were running', 'will have been interrupted mid-script. This may (or may not) cause problems.'], true)
                 else
                     raise RuntimeError, "Un-handled response: #{response.downcase}"
             end
@@ -423,10 +445,26 @@ module Blufin
         #   ⬡ bourbon
         # @options = %w(vodka beer wine whisky bourbon)
         # @return Array
-        def self.prompt_multi_select(question, options)
+        def self.prompt_multi_select(question, options, help: nil, per_page: 20, cycle: true)
             raise RuntimeError, "Expected Array, instead got #{options.class}" unless options.is_a?(Array)
+            puts display_prompt_help(help) unless help.nil?
             prompt = TTY::Prompt.new
-            prompt.multi_select(display_prompt_text(question), options)
+            if options[0].is_a?(String)
+                prompt.multi_select(display_prompt_text(question), options, per_page: per_page, cycle: cycle)
+            elsif options[0].is_a?(Hash)
+                prompt.multi_select(display_prompt_text(question), options, per_page: per_page, cycle: cycle) do |menu|
+                    options.each do |option|
+                        raise RuntimeError, "Expected option to be Hash, instead got: (#{option.class}) #{option.inspect}" unless option.is_a?(Hash)
+                        raise RuntimeError, 'Option is missing key => :text' unless option.has_key?(:text)
+                        raise RuntimeError, 'Option is missing key => :value' unless option.has_key?(:value)
+                        raise RuntimeError, "Expected :disabled option to be String, instead got: #{option[:disabled].class}" if option.has_key?(:disabled) && !option[:disabled].is_a?(String) && !option[:disabled].nil?
+                        menu.choice option[:text], option[:value] unless option.has_key?(:disabled)
+                        menu.choice option[:text], option[:value], disabled: "\x1B[38;5;196m#{option[:disabled]}\x1B[0m" if option.has_key?(:disabled)
+                    end
+                end
+            else
+                raise RuntimeError, "Expected options Array to consist of either Strings or Hashes, instead got: #{options.inspect}"
+            end
         end
 
         # Select an editor?
@@ -454,8 +492,8 @@ module Blufin
         def self.prompt_expand(question, options)
             raise RuntimeError, "Expected Array, instead got #{options.class}" unless options.is_a?(Array)
             options.each do |option|
-                found_key   = false
-                found_name  = false
+                found_key = false
+                found_name = false
                 found_value = false
                 option.each do |k, v|
                     case k
@@ -521,11 +559,11 @@ module Blufin
         # @return void
         def self.print_files_written(array_of_paths_or_files, message = nil, limit = 10, preceding_blank_line = true)
             raise RuntimeError, "Expected Array of files, instead got: #{array_of_paths_or_files.class}" unless array_of_paths_or_files.is_a?(Array)
-            message     = "Wrote the following #{Blufin::Terminal::format_highlight('files/directories')}" if message.nil?
-            limit       = limit.nil? ? 99999999999 : limit.to_i
+            message = "Wrote the following #{Blufin::Terminal::format_highlight('files/directories')}" if message.nil?
+            limit = limit.nil? ? 99999999999 : limit.to_i
             file_output = []
-            file_count  = 0
-            file_more   = 0
+            file_count = 0
+            file_more = 0
             array_of_paths_or_files.compact!
             array_of_paths_or_files.sort!
             array_of_paths_or_files.each do |path_or_file|
@@ -555,13 +593,13 @@ module Blufin
         # @return void
         def self.code_highlight(string, type, indent = 5)
             raise RuntimeError, "Expected String, instead got:#{string.class}" unless string.is_a?(String)
-            type  = type.downcase
+            type = type.downcase
             types = {
-                'yml'  => Rouge::Lexers::YAML.new,
+                'yml' => Rouge::Lexers::YAML.new,
                 'json' => Rouge::Lexers::JSON.new
             }
             raise RuntimeError, "Lexer not defined for type: #{type}" unless types.has_key?(type)
-            repeat    = ' ' * indent
+            repeat = ' ' * indent
             formatter = Rouge::Formatters::Terminal256.new
             formatter.format(types[type].lex(string)).split("\n").each do |line|
                 puts "#{repeat}#{line}"
@@ -601,8 +639,9 @@ module Blufin
 
         # Standardized way of displaying prompts text.
         # @return string
-        def self.display_prompt_text(question)
-            "\x1B[38;5;208m#{question}\x1B[38;5;240m =>\x1B[0m"
+        def self.display_prompt_text(question, answer = nil)
+            return "\x1B[38;5;208m#{question}\x1B[38;5;240m =>\x1B[0m" if answer.nil?
+            return "\x1B[38;5;208m#{question}\x1B[38;5;240m => \x1B[38;5;46m#{answer}\x1B[0m" unless answer.nil?
         end
 
     end

data/lib/core/versioning.rb

@@ -0,0 +1,29 @@
+module Blufin
+
+    class Versioning
+
+        VERSION_REGEX = /\d{1,3}\.\d{1,3}\.\d{0,3}/
+
+        # Shows prompt to let you select a new major, minor or patch version.
+        # @return string
+        def self.get_new_version_from_prompt(title, current_version, capitalize_tile: true)
+            Blufin::Terminal::error("Current version does not match regex: #{current_version}", "Expected something like: #{Blufin::Terminal::format_highlight('12.1.0')}", true) unless current_version =~ VERSION_REGEX
+            vp = current_version.split('.')
+            color1 = 246
+            color2 = 40
+            patch = "\x1B[38;5;#{color1}mPatch \x1B[38;5;242m\xe2\x80\x94 \x1B[38;5;#{color2}m#{vp[0]}.#{vp[1]}.#{vp[2].to_i + 1} \x1B[38;5;242m\xe2\x80\x94\x1B[38;5;240m New version is interchangeable, users can upgrade/downgrade freely."
+            minor = "\x1B[38;5;#{color1}mMinor \x1B[38;5;242m\xe2\x80\x94 \x1B[38;5;#{color2}m#{vp[0]}.#{vp[1].to_i + 1}.0 \x1B[38;5;242m\xe2\x80\x94\x1B[38;5;240m New version is backwards compatible, users can upgrade freely."
+            major = "\x1B[38;5;#{color1}mMajor \x1B[38;5;242m\xe2\x80\x94 \x1B[38;5;#{color2}m#{vp[0].to_i + 1}.0.0 \x1B[38;5;242m\xe2\x80\x94\x1B[38;5;240m New version has breaking API changes, users #{Blufin::Terminal::format_invalid('CANNOT')}\x1B[38;5;240m upgrade without making code changes."
+            options = [
+                {:text => patch, :value => "#{vp[0]}.#{vp[1]}.#{vp[2].to_i + 1}"},
+                {:text => minor, :value => "#{vp[0]}.#{vp[1].to_i + 1}.0"},
+                {:text => major, :value => "#{vp[0].to_i + 1}.0.0"}
+            ]
+            title = title.upcase if capitalize_tile
+            Blufin::Terminal::custom(title, nil, "Current version is: #{Blufin::Terminal::format_highlight(current_version)}")
+            Blufin::Terminal::prompt_select('Choose new semantic version:', options)
+        end
+
+    end
+
+end

data/lib/version.rb

@@ -1 +1 @@
-BLUFIN_LIB_VERSION = '1.5.0'
+BLUFIN_LIB_VERSION = '1.5.2'

data/opt/awx/project-schema.yml

@@ -0,0 +1,130 @@
+type: map
+mapping:
+  RunScripts:
+    type: seq
+    sequence:
+    - type: map
+      mapping:
+        Id:
+          required: yes
+        Commands:
+          type: seq
+          required: yes
+          sequence:
+          - type: str
+  TestScripts:
+    type: seq
+    sequence:
+    - type: map
+      mapping:
+        Id:
+          required: yes
+        Commands:
+          type: seq
+          required: yes
+          sequence:
+          - type: str
+  BuildScripts:
+    type: seq
+    sequence:
+    - type: map
+      mapping:
+        Id:
+          required: yes
+        Commands:
+          type: seq
+          required: yes
+          sequence:
+          - type: str
+  DeployScripts:
+    type: seq
+    sequence:
+    - type: map
+      mapping:
+        Id:
+          required: yes
+        Commands:
+          type: seq
+          required: yes
+          sequence:
+          - type: str
+  Projects:
+    type: seq
+    required: yes
+    sequence:
+    - type: map
+      mapping:
+        Id:
+          required: yes
+        Type:
+          required: yes
+        Project:
+          required: yes
+        RepoRoot:
+          required: yes
+        RepoPath:
+          required: yes
+        PortRange:
+        Run:
+          type: seq
+          sequence:
+          - type: map
+            mapping:
+              Path:
+                required: yes
+              Script:
+                required: yes
+        Test:
+          type: seq
+          sequence:
+          - type: map
+            mapping:
+              Path:
+                required: yes
+              Script:
+                required: yes
+        Build:
+          type: seq
+          sequence:
+          - type: map
+            mapping:
+              Path:
+                required: yes
+              Script:
+                required: yes
+        Deploy:
+          type: seq
+          sequence:
+          - type: map
+            mapping:
+              Path:
+                required: yes
+              Script:
+                required: yes
+        Servers:
+          type: seq
+          sequence:
+          - type: map
+            mapping:
+              Region:
+                required: yes
+              Stack:
+                required: yes
+              Environments:
+                type: seq
+                required: yes
+                sequence:
+                - type: str
+        API:
+          type: map
+          mapping:
+            Title:
+              required: yes
+            Alias:
+              required: yes
+            Domain:
+              required: yes
+            ProjectName:
+              required: yes
+            ProjectNamePascalCase:
+              required: yes

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: blufin-lib
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Albert Rannetsperger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-08-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -74,20 +88,24 @@ extra_rdoc_files: []
 files:
 - lib/blufin-lib.rb
 - lib/core/arrays.rb
+- lib/core/base.rb
 - lib/core/browser.rb
+- lib/core/config.rb
 - lib/core/datetime_utils.rb
 - lib/core/encryptor.rb
 - lib/core/files.rb
 - lib/core/image.rb
 - lib/core/network.rb
 - lib/core/numbers.rb
+- lib/core/projects.rb
 - lib/core/routes.rb
-- lib/core/ssh.rb
 - lib/core/strings.rb
 - lib/core/terminal.rb
 - lib/core/tools.rb
 - lib/core/validate.rb
+- lib/core/versioning.rb
 - lib/version.rb
+- opt/awx/project-schema.yml
 homepage: https://github.com/alb3rtuk
 licenses:
 - MIT

data/lib/core/ssh.rb

@@ -1,145 +0,0 @@
-module Blufin
-
-    class SSH
-
-        SSH_PREFIX = 'ssh_'
-
-        # SSH into remote host.
-        # @return void
-        def self.ssh_into_remote(config_key)
-            if config_key.nil?
-                show_available_ssh_hosts
-            else
-                ssh_user, ssh_host, ssh_cert = get_ssh_credentials(config_key)
-                ssh_into_remote_credentials(ssh_user, ssh_host, ssh_cert)
-            end
-        end
-
-        # SSH into remote with pre-supplied credentials.
-        # @return void
-        def self.ssh_into_remote_credentials(ssh_user, ssh_host, ssh_cert = nil)
-            if ssh_cert.nil?
-                Blufin::Terminal::command("ssh #{ssh_user}@#{ssh_host}", nil, false, false)
-            else
-                Blufin::Terminal::command("ssh -i #{ssh_cert} #{ssh_user}@#{ssh_host}", nil, false, false)
-            end
-        end
-
-        # Source can be a file or directory but whatever it is, target must be the same (a file or directory).
-        # @return void
-        def self.scp_to_remote(config_key, source, target)
-            if config_key.nil?
-                show_available_ssh_hosts
-            else
-                ssh_user, ssh_host, ssh_cert = get_ssh_credentials(config_key)
-                unless Blufin::Files::file_exists(source)
-                    Blufin::Terminal::error("The file doesn't exist: #{Blufin::Terminal::format_directory(source)}", nil, true)
-                    return
-                end
-                Blufin::Terminal::command("scp -i #{ssh_cert} #{source} #{ssh_user}@#{ssh_host}:#{target}", nil)
-            end
-        end
-
-        private
-
-        # Get SSH credentials from the config file.
-        # @return Array
-        def self.get_ssh_credentials(config_key)
-            ssh_parts    = Blufin::Config.get_custom_key(SSH_PREFIX, config_key).split('|')
-            ssh_user     = ssh_parts[0]
-            ssh_host     = ssh_parts[1]
-            ssh_cert     = ssh_parts[2].to_s.strip.length == 0 ? nil : ssh_parts[2]
-            help_message = [
-                "The file: #{Blufin::Terminal::format_directory(ConfigUnique::CONFIG_FILE)} must contain a line similar to the following:",
-                nil,
-                'ssh_ec2=ec2-user|ec2-XX-XX-XX-XX.eu-west-1.compute.amazonaws.com|~/.ssh/pem-key.pem',
-                'ssh_ec2=ec2-user|ec2-XX-XX-XX-XX.eu-west-1.compute.amazonaws.com',
-            ]
-            Blufin::Terminal::error("SSH #{Blufin::Terminal::format_highlight('user')} required", help_message, true) if ssh_user.nil? || ssh_user == ''
-            Blufin::Terminal::error("SSH #{Blufin::Terminal::format_highlight('host')} required", help_message, true) if ssh_host.nil? || ssh_host == ''
-            unless ssh_cert.nil?
-                unless Blufin::Files::file_exists(File.expand_path(ssh_cert))
-                    Blufin::Terminal::error("PEM key not found: #{Blufin::Terminal::format_directory(ssh_cert)}")
-                end
-            end
-            return ssh_user, ssh_host, ssh_cert
-        end
-
-        # Check that SSHPASS is installed.
-        # @return void
-        def self.check_sshpass_is_installed
-            Blufin::UtilsTools::check_sshpass_is_installed
-        end
-
-        # Runs a series of commands on the VM.
-        # @return void
-        def self.command(commands, ssh_user, ssh_host, ssh_cert, verbose = true)
-            commands = [commands] unless commands.is_a?(Array)
-            if commands.any?
-                commands.each do |command|
-                    puts "\x1B[48;5;136m Executing \x1B[0m \xe2\x86\x92\x1B[0m #{Blufin::Terminal::format_command("#{command} \x1B[0m\xe2\x86\x92 \x1B[38;5;202m[\x1B[38;5;168m#{ssh_user}@#{ssh_host}\x1B[38;5;202m]\x1B[0m")}" if verbose
-                    if ssh_cert.nil?
-                        Blufin::Terminal::command("ssh #{ssh_user}@#{ssh_host} '#{command}'", nil, false, false)
-                    else
-                        Blufin::Terminal::command("ssh -i #{ssh_cert} #{ssh_user}@#{ssh_host} '#{command}'", nil, false, false)
-                    end
-                end
-            end
-        end
-
-        # Runs a series of commands on the VM and capture output.
-        # Currently only works for single-line output (IE: Won't capture multi-line output properly).
-        # @return void
-        def self.command_capture(commands, ssh_user, ssh_host, ssh_cert, verbose = true)
-            commands = [commands] unless commands.is_a?(Array)
-            results  = []
-            if commands.any?
-                commands.each do |command|
-                    puts "\x1B[48;5;136m Executing \x1B[0m \xe2\x86\x92\x1B[0m #{Blufin::Terminal::format_command("#{command} \x1B[0m\xe2\x86\x92 \x1B[38;5;202m[\x1B[38;5;168m#{ssh_user}@#{ssh_host}\x1B[38;5;202m]\x1B[0m")}" if verbose
-                    if ssh_cert.nil?
-                        results << Blufin::Terminal::command_capture("ssh #{ssh_user}@#{ssh_host} '#{command}'", nil, false, false)[0].gsub(/\n$/, '')
-                    else
-                        results << Blufin::Terminal::command_capture("ssh -i #{ssh_cert} #{ssh_user}@#{ssh_host} '#{command}'", nil, false, false)[0].gsub(/\n$/, '')
-                    end
-                end
-            end
-            results
-        end
-
-        # Show a list of available SSH hosts.
-        # @return void
-        def self.show_available_ssh_hosts
-            all_keys          = Blufin::Config::params
-            ssh_hosts         = []
-            ssh_hosts_lengths = []
-            all_keys.keys.each do |key|
-                if key =~ /\A#{SSH_PREFIX}.+/i
-                    ssh_hosts_lengths << key.length
-                end
-            end
-            if ssh_hosts_lengths.any?
-                ssh_hosts_lengths.uniq!
-                max_key_length = ssh_hosts_lengths.max - SSH_PREFIX.length
-                all_keys.keys.sort!.each do |key|
-                    if key =~ /\A#{SSH_PREFIX}.+/i
-                        ssh_user, ssh_host, ssh_cert = get_ssh_credentials(key.gsub(SSH_PREFIX, ''))
-                        ssh_hosts << "\x1B[38;5;154m#{key.gsub(SSH_PREFIX, '').rjust(max_key_length, ' ')}\x1B[0m\x1B[38;5;240m \xe2\x80\x94 #{ssh_host} \x1B[38;5;245m(#{ssh_user})#{ssh_cert.nil? ? '' : "\x1B[38;5;204m #{ssh_cert}"}"
-                    end
-                end
-                Blufin::Terminal::info('Pre-configured hosts to SSH into:', ssh_hosts)
-            else
-                help_message = [
-                    "To define a remote host \xe2\x80\x94 run #{Blufin::Terminal::format_command("#{ConfigUnique::GEM_NAME} x")} and add a line similar to:",
-                    nil,
-                    "\x1B[38;5;154mssh_ec2=ec2-user|ec2-XX-XX-XX-XX.eu-west-1.compute.amazonaws.com|~/.ssh/pem-key.pem",
-                    "\x1B[38;5;154mssh_ec2=ec2-user|ec2-XX-XX-XX-XX.eu-west-1.compute.amazonaws.com",
-                    nil,
-                    "IMPORTANT: Configuration key must start with prefix: #{Blufin::Terminal::format_highlight(SSH_PREFIX)}"
-                ]
-                Blufin::Terminal::info('No remote host(s) defined in configuration file', help_message)
-            end
-        end
-
-    end
-
-end