brightpearl-cli 2.5.0 → 2.6.0

data/lib/core/pom.rb

@@ -38,23 +38,25 @@ module App
 
         end
 
-        def self.unsnapshot_files(files_to_change, current_branch_code_repo, add_branch_tag = true)
+        def self.unsnapshot_files(files_to_change, current_branch_code, add_branch_tag = true, first_answer = nil, second_answer = nil, third_answer = nil)
 
             unless files_to_change.any?
                 App::Terminal::info('No feature-tagged POMs found', 'Nothing to un-snapshot.')
                 return
             end
 
-            unless App::Terminal::prompt_yes_no('Un-snapshot POMs', generate_confirmation_text(files_to_change))
-                App::Terminal::abort(nil, nil, true, false)
+            unless first_answer == App::Enum::YES
+                if first_answer == App::Enum::NO || App::Terminal::prompt_yes_no('Un-snapshot POMs', generate_confirmation_text(files_to_change)) == false
+                    App::Terminal::abort
+                end
             end
 
             files_to_change.each do |filename|
                 App::Terminal::output("Un-snapshotting: #{App::Terminal::format_directory(filename)}")
-                if current_branch_code_repo == App::Git::MASTER || add_branch_tag == false
+                if current_branch_code == App::Git::MASTER || add_branch_tag == false
                     new_snapshot_tag = '-SNAPSHOT'
                 else
-                    new_snapshot_tag = "-#{current_branch_code_repo}-SNAPSHOT"
+                    new_snapshot_tag = "-#{current_branch_code}-SNAPSHOT"
                 end
                 contents = File.read(filename)
                 contents_new = contents.gsub(/-(.*)-SNAPSHOT/, new_snapshot_tag)
@@ -79,51 +81,35 @@ module App
 
             if red_versions != green_versions
                 unless App::Terminal::prompt_yes_no('POM version conflict occurred', ['Unable to successfully Un-snapshot POMs.', 'Please fix the POM versions before continuing.'], 'POMs fixed and ready to continue?')
-                    App::Terminal::abort(nil, nil, true, false)
+                    App::Terminal::abort
                 end
             end
 
             App::Terminal::command_capture(['git add .', 'git status'], App::Config.param(App::Config::WORKSTATION_PATH_TO_BP_CODE))
 
             # Figure out the commit message.
-            git = App::Git.new
-            current_branch_name = git.current_branch_for_repo(App::Config.param(App::Config::WORKSTATION_PATH_TO_BP_CODE))
+            @git = App::Git.new
+            current_branch_name = @git.current_branch_for_repo(App::Config.param(App::Config::WORKSTATION_PATH_TO_BP_CODE))
             if current_branch_name =~ /\A(bp|bug)-\d{4,5}\z/i
                 jira_number = current_branch_name.gsub(/\D/, '')
             else
                 jira_number = '0000'
             end
 
-            if current_branch_code_repo == App::Git::MASTER
+            if current_branch_code == App::Git::MASTER
                 commit_message = "BP-#{jira_number} Removed POM tags."
             else
-                commit_message = "BP-#{jira_number} Updated POM tags on #{current_branch_code_repo}."
+                commit_message = "BP-#{jira_number} Updated POM tags on #{current_branch_code}."
             end
 
-            git = App::Git.new
+            @git = App::Git.new
 
-            if git.current_branch_for_repo(App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_CODE)) == App::Git::MASTER
+            if @git.current_branch_for_repo(App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_CODE)) == App::Git::MASTER
                 App::Terminal::info('Un-snapshotting complete', ["Your POMs have been un-snapshotted. However, nothing has been committed to Git or pushed to origin because you are on #{App::Git::MASTER}.", 'You will need to do this manually.'], false)
             else
-
-                if git.changes_exist(App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_CODE))
-
-                    if App::Terminal::prompt_yes_no('Commit to GIT', ["This will commit your changes to GIT with message: #{App::Terminal::format_highlight(commit_message)}"])
-                        App::Terminal::command(["git commit -m '#{commit_message.gsub("'", "\\'")}'"], App::Config.param(App::Config::WORKSTATION_PATH_TO_BP_CODE))
-                    else
-                        App::Terminal::info('Un-snapshotting complete', "Please note that your changes #{App::Terminal::format_highlight('HAVE NOT')} been #{App::Terminal::format_action('committed')} to Git.", false)
-                        return
-                    end
-
-                    if App::Terminal::prompt_yes_no('Push changes to origin')
-                        App::Terminal::command('git push', App::Config.param(App::Config::WORKSTATION_PATH_TO_BP_CODE))
-                        App::Terminal::info('Un-snapshotting complete', "Your POMs have been un-snapshotted, the changes #{App::Terminal::format_action('committed')} to Git and #{App::Terminal::format_action('pushed')} to origin.")
-                    else
-                        App::Terminal::info('Un-snapshotting complete', ["Your POMs have been un-snapshotted and the changes #{App::Terminal::format_action('committed')} to Git.", 'However, nothing has been pushed to origin. You will need to do this manually.'], false)
-                    end
-
+                if @git.changes_exist(App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_CODE))
+                    @git.ask_to_commit_to_git(commit_message, App::Config.param(App::Config::WORKSTATION_PATH_TO_BP_CODE), second_answer, third_answer)
                 end
-
             end
 
         end

data/lib/core/sql_update.rb

@@ -2,21 +2,129 @@ module App
 
     class SqlUpdate
 
-        def self.run_sql_update
+        def self.run_sql_update(branch_to_run_on = nil, skip_first_confirm = false)
 
-            unless App::Terminal::prompt_yes_no("You're about to run the SQL update script", ["Please note this script is still in #{App::Terminal::format_highlight('BETA')} and will only work under certain (assumed) circumstances."])
-                App::Terminal::abort(nil, nil, true, false)
+            @git = App::Git::new
+
+            branch_to_run_on = @git.current_branch_for_repo(App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB)) if branch_to_run_on.nil?
+            jira_number = @git.resolve_jira_for_branch(branch_to_run_on)
+
+            unless skip_first_confirm
+                unless App::Terminal::prompt_yes_no("You're about to run the SQL update script for #{App::Terminal::format_highlight("BP-#{jira_number}")} on branch #{App::Terminal::format_branch(@git.current_branch_for_repo(App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB)))}", ["Please note this script is still in #{App::Terminal::format_highlight('BETA')} and will only work under certain (assumed) circumstances."])
+                    App::Terminal::abort
+                end
             end
 
             @git = App::Git::new
 
-            App::Terminal::output('Checking that both your repositories are on the same branch')
-            @git.check_for_same_branch(App::Git::SAME_BRANCH_ERROR)
+            update_performed = false
+            fail_message = ["An automatic SQL update #{App::Terminal::format_invalid('could not', true)}\x1B[38;5;240m be performed.", "You can either do this #{App::Terminal::format_action('manually')} or exit the script."]
+            fail_confirmation = "Have you #{App::Terminal::format_highlight('made altered the necessary files')}\x1B[38;5;89m and #{App::Terminal::format_action('committed')}\x1B[38;5;89m the changes?"
+
+            unless jira_number =~ /\d{4,5}/i
+                unless App::Terminal::prompt_yes_no("No #{App::Terminal::format_highlight('jira number')} could be resolved for branch #{App::Terminal::format_branch(branch_to_run_on)}", fail_message, fail_confirmation)
+                    App::Terminal::abort
+                end
+                return
+            end
+
+            sandpit_files = get_sandpit_files(jira_number)
+
+            unless sandpit_files.any?
+                unless App::Terminal::prompt_yes_no("No #{App::Terminal::format_highlight('sandpit files')} found for jira number: #{App::Terminal::format_action(jira_number)}", fail_message, fail_confirmation)
+                    App::Terminal::abort
+                end
+                return
+            end
+
+            sandpit_files.each do |file|
+                new_file_contents = []
+                new_file_contents_output = []
+                script_run_line_found = false
+                latest_sql_index = get_latest_unused_sql_index
+                file_contents = App::UtilsFiles::read_file(file)
+                file_contents.each do |line|
+                    if line =~ /\A\s*(#+|-{2,}).*(sql_script_run|leave\s+.+;|end\s+if\s*;)/i
+                        new_file_contents_output << "\x1B[38;5;196m- #{line.gsub("\n", '')}\x1B[0m"
+
+                        # REMOVE COMMENTS
+                        if line =~ /\A\s*#+/i
+                            new_line = line.sub(/#+/i, '')
+                        elsif line =~ /\A\s*-{2,}/i
+                            new_line = line.sub(/-{2,}/i, '')
+                        else
+                            new_line = line
+                        end
+
+                        # UPDATE SQL INDEX
+                        if new_line =~ /script_index\s*=\s*('|")\S*('|")/i
+                            new_line = new_line.sub(/script_index\s*=\s*('|")\S*('|")/i, "script_index = '#{get_latest_unused_sql_index}'")
+                        elsif new_line =~ /sql_script_run\s+values\s+\(('|")\S*('|")\s*,/i
+                            new_line = new_line.sub(/sql_script_run\s+values\s+\(('|")\S*('|")\s*,/i, "sql_script_run VALUES ('#{get_latest_unused_sql_index}',")
+                        end
 
-            branch_number = @git.current_branch_for_repo(App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB))
+                        new_file_contents_output << "\x1B[38;5;10m+ #{new_line.gsub("\n", '')}\x1B[0m"
+                        new_file_contents << new_line.gsub("\n", '')
+                    else
+                        new_file_contents_output << "\x1B[38;5;240m. #{line.gsub("\n", '')}\x1B[0m"
+                        new_file_contents << line.gsub("\n", '')
+                    end
 
-            puts branch_number
+                    # IF SQL_INDEX INSERT IS FOUND..
+                    if line =~ /insert\s+into\s+sql_script_run\s+values\s+\(/i
+                        script_run_line_found = true
+                    end
 
+                end
+                if script_run_line_found == false
+                    sql_index_insert_statement = "INSERT INTO sql_script_run VALUES ('#{latest_sql_index}', NOW(), 1);"
+                    new_file_contents_output << "\x1B[38;5;10m+ #{sql_index_insert_statement}\x1B[0m"
+                    new_file_contents << sql_index_insert_statement
+                end
+                new_sql_filename = "#{latest_sql_index}.sql"
+                new_sql_filename_full = "#{App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB)}/brightpearl/structure/#{new_sql_filename}"
+                if App::Terminal::prompt_yes_no('SQL changes', new_file_contents_output, "Would you like to #{App::Terminal::format_action('apply')}\x1B[38;5;89m these changes and create #{App::Terminal::format_directory(new_sql_filename)} ?")
+                    App::Terminal::output("\x1B[38;5;46mCREATING: #{new_sql_filename_full}\x1B[0m")
+                    App::UtilsFiles::write_file(new_sql_filename_full, new_file_contents)
+                    App::Terminal::command("git add brightpearl/structure/#{new_sql_filename}", App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB))
+                    App::Terminal::output("\x1B[38;5;196mDELETING: #{file}\x1B[0m")
+                    App::UtilsFiles::delete_file(file)
+                    update_performed = true
+                else
+                    App::Terminal::warning('SQL update not processed', ["Sandpit file found but not processed: #{App::Terminal::format_directory(file)}", "Either this is your intention or it will need to be done #{App::Terminal::format_action('manually')}."])
+                    App::Terminal::any_key_to_continue("     Press any key to #{App::Terminal::format_highlight('acknowledge you understand')}...")
+                end
+            end
+
+            if update_performed
+                @git.ask_to_commit_to_git("BP-#{jira_number} SQL Update [auto-script].", App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB))
+            end
+
+        end
+
+        def self.get_sandpit_files(jira_number)
+            App::Terminal::output('Checking for sandpit files...')
+            sql_update_files = []
+            sandpit_files = App::UtilsFiles::get_files_in_dir("#{App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB)}/brightpearl/sandpit")
+            sandpit_files.each do |file|
+                file_basename = File.basename(file)
+                if file_basename =~ /#{jira_number}/i
+                    sql_update_files << file
+                    App::Terminal::output("Found: #{App::Terminal::format_directory(file_basename)}", App::Terminal::MSG_AUTOMATIC)
+                end
+            end
+            sql_update_files
+        end
+
+        # Gets the latest (unused) SQL index .
+        # @return Integer
+        def self.get_latest_unused_sql_index
+            sql_numbers = []
+            current_sql_files = App::UtilsFiles::get_files_in_dir("#{App::Config.param(ConfigUnique::WORKSTATION_PATH_TO_BP_DB)}/brightpearl/structure")
+            current_sql_files.each do |file|
+                sql_numbers << File.basename(file).gsub(/.sql/i, '').strip.to_i
+            end
+            (sql_numbers[sql_numbers.length - 1] + 1).to_s.rjust(4, '0')
         end
 
     end

data/lib/core/ssh.rb

@@ -0,0 +1,160 @@
+module App
+
+    class SSH
+
+        SCRIPT_PATH = 'vm-scripts/'
+
+        # SSH into remote host.
+        # @return void
+        def self.ssh_into_remote(config_key)
+            ssh_user, ssh_host, ssh_cert = get_ssh_credentials(config_key)
+            ssh_into_remote_credentials(ssh_user, ssh_host, ssh_cert)
+        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?
+                App::Terminal::command("ssh #{ssh_user}@#{ssh_host}", nil, false, false)
+            else
+                App::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)
+
+        end
+
+        # SCPs a script to a remote host and runs it.
+        # @return void
+        def self.run_script_on_remote(config_key, script_name, args = nil, run_as_root = false)
+            ssh_user, ssh_host, ssh_cert = get_ssh_credentials(config_key)
+            run_script_on_remote_credentials(ssh_user, ssh_host, ssh_cert, script_name, args, run_as_root)
+        end
+
+        # SCPs a script to remote and runs it with pre-supplied credentials.
+        # @return void
+        def self.run_script_on_remote_credentials(ssh_user, ssh_host, ssh_cert, script_name, args = nil, run_as_root = false)
+            script_path_local = "#{App::UtilsTools::get_base_path}/#{App::SSH::SCRIPT_PATH}#{script_name}"
+            script_path_remote = "/tmp/#{script_name}" # Time.now.to_i
+            check_script_exists(script_name)
+            scp_script_to_vm(script_path_local, script_path_remote, ssh_user, ssh_host, ssh_cert)
+            args = args.nil? ? [] : args
+            command("chmod 0755 #{script_path_remote}", ssh_user, ssh_host, ssh_cert)
+            command_execute_message("#{script_path_remote} #{args.join(' ')}")
+            display_script_content(script_path_local)
+            command("#{script_path_remote} #{args.join(' ')}", ssh_user, ssh_host, ssh_cert, false)
+            command("rm #{script_path_remote}", ssh_user, ssh_host, ssh_cert)
+        end
+
+        private
+
+        # Get SSH credentials from the config file.
+        # @return Array
+        def self.get_ssh_credentials(config_key)
+            ssh_parts = App::Config.get_custom_key('ssh_', 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: #{App::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',
+            ]
+            App::Terminal::error("SSH #{App::Terminal::format_highlight('user')} required", help_message, true) if ssh_user.nil? || ssh_user == ''
+            App::Terminal::error("SSH #{App::Terminal::format_highlight('host')} required", help_message, true) if ssh_host.nil? || ssh_host == ''
+            unless ssh_cert.nil?
+                unless App::UtilsFiles::file_exists(File.expand_path(ssh_cert))
+                    App::Terminal::error("PEM key not found: #{App::Terminal::format_directory(ssh_cert)}")
+                end
+            end
+            return ssh_user, ssh_host, ssh_cert
+        end
+
+        # Check script exists.
+        # @return void
+        def self.check_script_exists(script_name)
+            App::Terminal::output("Fetching: #{App::Terminal::format_directory("#{SCRIPT_PATH}#{script_name}")}")
+            scripts = get_all_scripts.keys
+            unless scripts.include?(script_name)
+                App::Terminal::error("Script doesn't exist: #{App::Terminal::format_invalid(script_name)}", nil, true)
+            end
+        end
+
+        # Returns all script files as hash, IE: {'sql-updates' => '/Library/Ruby/Gems/2.0.0/gems/brightpearl-cli-1.4.0/vm-scripts/sql-updates.sh'}
+        # @return Hash
+        def self.get_all_scripts
+            return_hash = {}
+            all_scripts = App::UtilsFiles::get_files_in_dir("#{App::UtilsTools::get_base_path}/vm-scripts")
+            all_scripts.each do |file|
+                return_hash[File.basename(file)] = file
+            end
+            return_hash
+        end
+
+        # Check that SSHPASS is installed.
+        # @return void
+        def self.check_sshpass_is_installed
+            App::UtilsTools::check_sshpass_is_installed
+        end
+
+        # Copy script to VM.
+        # @return void
+        def self.scp_script_to_vm(script_path_local, script_path_remote, ssh_user, ssh_host, ssh_cert)
+            App::Terminal::output("Local: #{script_path_local}")
+            App::Terminal::output("Remote: #{script_path_remote}")
+            App::Terminal::output("scp to \xe2\x86\x92 #{App::Terminal::format_highlight(ssh_host)}")
+            if ssh_cert.nil?
+                App::Terminal::command("scp #{script_path_local} #{ssh_user}@#{ssh_host}:#{script_path_remote}", nil, false, false)
+            else
+                App::Terminal::command("scp -i #{ssh_cert} #{script_path_local} #{ssh_user}@#{ssh_host}:#{script_path_remote}", nil, false, false)
+            end
+        end
+
+        # Runs a series of commands on the VM.
+        # @return void
+        def self.command(commands, ssh_user, ssh_host, ssh_cert, verbose = true)
+            unless commands.is_a?(Array)
+                commands = [commands]
+            end
+            if commands.any?
+                commands.each do |command|
+                    if verbose
+                        command_execute_message(command)
+                    end
+                    if ssh_cert.nil?
+                        App::Terminal::command("ssh #{ssh_user}@#{ssh_host} '#{command}'", nil, false, false)
+                    else
+                        App::Terminal::command("ssh -i #{ssh_cert} #{ssh_user}@#{ssh_host} '#{command}'", nil, false, false)
+                    end
+                end
+            end
+        end
+
+        # Custom Terminal::output clone only used here).
+        # @return void
+        def self.command_execute_message(command)
+            puts "\x1B[48;5;136m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m #{App::Terminal::format_command("#{command}")}"
+        end
+
+        # DISPLAY SCRIPT CONTENT
+        # @return void
+        def self.display_script_content(script_path_local)
+            script_content = App::Terminal::command_capture("cat #{script_path_local}", nil, false, false)
+            if script_content[0] != ''
+                puts
+                script_content[0].split("\n").each do |line|
+                    if line.strip != ''
+                        puts "\x1B[38;5;95m  #{line}\x1B[0m"
+                    end
+                end
+                puts
+            end
+        end
+
+    end
+
+end

data/lib/core/terminal.rb

@@ -14,6 +14,7 @@ module App
         MSG_AUTOMATIC = 'automatic'
         MSG_GENERATED = 'generated'
         MSG_PROCESSED = 'processed'
+        MSG_CUSTOM = 'custom'
 
         # Runs a series of commands in the terminal.
         # @return void
@@ -63,8 +64,9 @@ module App
         end
 
         # Outputs messages to the terminal.
+        # If CUSTOM, title must be 11 characters to match existing scheme.
         # @return void
-        def self.output(message = 'No message', type = MSG_INFO)
+        def self.output(message = 'No message', type = MSG_INFO, title = nil, bg_color = nil)
             case type
                 when MSG_INFO
                     puts "\x1B[48;5;2m Executing \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m"
@@ -80,6 +82,10 @@ module App
                     puts "\x1B[48;5;96m Generated \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m"
                 when MSG_PROCESSED
                     puts "\x1B[48;5;238m Processed \x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m"
+                when MSG_CUSTOM
+                    raise RuntimeError, "'title' cannot be nil." if title.nil?
+                    raise RuntimeError, "'bg_color' cannot be nil." if bg_color.nil?
+                    puts "\x1B[48;5;#{bg_color}m#{title}\x1B[0m \x1B[0m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m"
                 else
                     puts "'#{type}' is not a valid Terminal::output() type."
                     exit
@@ -88,7 +94,7 @@ module App
 
         # Displays error and exits script by default.
         # @return void
-        def self.abort(title = nil, message = nil, exit_script = true, preceding_blank_line = true)
+        def self.abort(title = nil, message = nil, exit_script = true, preceding_blank_line = false)
             if title.nil?
                 title = 'Abandon ship!'
             end
@@ -114,6 +120,20 @@ module App
             end
         end
 
+        # Displays automatic message.
+        # @return void
+        def self.automatic(title = nil, message = nil, preceding_blank_line = true)
+            if title.nil?
+                title = 'Something is happening automatically...'
+            end
+            if preceding_blank_line
+                puts
+            end
+            puts "\x1B[48;5;96m Automatic \x1B[0m \xe2\x86\x92 #{title}"
+            parse_messages(message)
+        end
+
+
         # Displays info message.
         # @return void
         def self.info(title = nil, message = nil, preceding_blank_line = true)
@@ -270,11 +290,11 @@ module App
 
         # Gives a prompt where ANY KEY will continue executing the script.
         # @return void
-        # @deprecated
         def self.any_key_to_continue(text = "\n\x1B[90mPress any key to continue\x1B[0m => ")
             STDOUT.flush
             print "#{text}"
             STDIN.gets
+            puts
             nil
         end