dopi 0.17.0

data/lib/dopi/command/ssh/file_deploy.rb

@@ -0,0 +1,71 @@
+#
+# DOPi Plugin: Deploy File
+#
+require 'pathname'
+require "base64"
+
+module Dopi
+  class Command
+    class Ssh
+      class FileDeploy < Dopi::Command
+        include DopCommon::HashParser
+        include Dopi::Connector::Ssh
+        include Dopi::CommandParser::ExitCode
+
+      public
+
+        def validate
+          validate_ssh
+          validate_exit_code
+          log_validation_method('file_valid?', CommandParsingError)
+          log_validation_method('content_valid?', CommandParsingError)
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = ssh_command({}, command_string)
+          check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def file
+          file_valid? ? hash[:file] : nil
+        end
+
+        def content
+          content_valid? ? load_content(hash[:content]) : nil
+        end
+
+      private
+
+        def command_string
+          "echo -n #{Base64.strict_encode64(content)} | base64 -d > #{file}"
+        end
+
+        def file_valid?
+          hash[:file] or
+            raise CommandParsingError, "Plugin #{name}: The key 'file' needs to be specified"
+          hash[:file].kind_of?(String) or
+            raise CommandParsingError, "Plugin #{name}: The value for key 'file' has to be a String"
+          begin
+            Pathname.new(hash[:file]).absolute? or
+              raise CommandParsingError, "Plugin #{name}: The path for 'file' has to be absolute"
+          rescue ArgumentError => e
+            raise CommandParsingError, "Plugin #{name}: The value in 'file' is not a valid file path: #{e.message}"
+          end
+        end
+
+        def content_valid?
+          hash[:content] or
+            raise CommandParsingError, "Plugin #{name}: The key 'content' needs to be specified"
+          load_content_valid?(hash[:content])
+        rescue DopCommon::PlanParsingError => e
+          raise CommandParsingError, "Plugin #{name}: value content not valid: #{e.message}"
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/ssh/file_exists.rb

@@ -0,0 +1,54 @@
+#
+# DOPi Plugin: File Exists
+#
+require 'pathname'
+
+module Dopi
+  class Command
+    class Ssh
+      class FileExists < Dopi::Command
+        include Dopi::Connector::Ssh
+        include Dopi::CommandParser::ExitCode
+
+      public
+
+        def validate
+          validate_ssh
+          validate_exit_code
+          log_validation_method('file_valid?', CommandParsingError)
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = ssh_command({}, command_string)
+          check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def file
+          @file ||= file_valid? ? hash[:file] : nil
+        end
+
+      private
+
+        def command_string
+          "[ -e #{file} ]"
+        end
+
+        def file_valid?
+          hash[:file] or
+            raise CommandParsingError, "Plugin #{name}: The key 'file' needs to be specified"
+          begin
+            Pathname.new(hash[:file]).absolute? or
+              raise CommandParsingError, "Plugin #{name}: The path for 'file' has to be absolute"
+          rescue ArgumentError => e
+            raise CommandParsingError, "Plugin #{name}: The value in 'file' is not a valid file path: #{e.message}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/ssh/file_replace.rb

@@ -0,0 +1,96 @@
+#
+# DOPi Plugin: File Replace
+#
+
+module Dopi
+  class Command
+    class Ssh
+      class FileReplace < Dopi::Command
+        include Dopi::Connector::Ssh
+        include Dopi::CommandParser::ExitCode
+
+      public
+
+        def validate
+          validate_ssh
+          validate_exit_code
+          log_validation_method(:replacement_valid?, CommandParsingError)
+          log_validation_method(:global_valid?, CommandParsingError)
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = ssh_command({}, command_string)
+          check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def replacement
+          @replacement ||= replacement_valid? ?
+            hash[:replacement] : nil
+        end
+
+        def global
+          @global ||= global_valid? ?
+            hash[:global] : true
+        end
+
+        def file
+          @file ||= file_valid? ? hash[:file] : nil
+        end
+
+        def pattern
+          @pattern ||= pattern_valid? ?
+            hash[:pattern] : nil
+        end
+
+      private
+
+        def command_string
+          "sed -i \"s/#{pattern}/#{replacement}/#{global_string}\" #{file}"
+        end
+
+        def global_string
+          global ? 'g' : ''
+        end
+
+        def replacement_valid?
+          hash[:replacement] or
+            raise CommandParsingError, "Plugin #{name}: The key 'replacement' needs to be specified"
+          hash[:replacement].kind_of?(String) or
+            raise CommandParsingError, "Plugin #{name}: The value in 'replacement' has to be a String"
+        end
+
+        def global_valid?
+          return false if hash[:global].nil? # is optional
+          hash[:global].kind_of?(TrueClass) or hash[:global].kind_of?(FalseClass) or
+            raise CommandParsingError, "Plugin #{name}: The value for 'global' must be boolean"
+        end
+
+        def file_valid?
+          hash[:file] or
+            raise CommandParsingError, "Plugin #{name}: The key 'file' needs to be specified"
+          begin
+            Pathname.new(hash[:file]).absolute? or
+              raise CommandParsingError, "Plugin #{name}: The path for 'file' has to be absolute"
+          rescue ArgumentError => e
+            raise CommandParsingError, "Plugin #{name}: The value in 'file' is not a valid file path: #{e.message}"
+          end
+        end
+
+        def pattern_valid?
+          hash[:pattern] or
+            raise CommandParsingError, "Plugin #{name}: The key 'pattern' needs to be specified"
+          begin
+            Regexp.new(hash[:pattern])
+          rescue
+            raise CommandParsingError, "Plugin #{name}: The value in 'pattern' is not a valid regexp: #{e.message}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/ssh/puppet_agent_run.rb

@@ -0,0 +1,63 @@
+#
+# SSH custom command
+#
+module Dopi
+  class Command
+    class Ssh
+      class PuppetAgentRun < Dopi::Command
+        include Dopi::Connector::Ssh
+        include Dopi::CommandParser::Env
+        include Dopi::CommandParser::Arguments
+        include Dopi::CommandParser::ExitCode
+        include Dopi::CommandParser::Output
+
+      public
+
+        def initialize(command_parser, step, node, is_verify_command)
+          command_parser.overwrite_defaults = { :plugin_timeout => 1800 }
+          super(command_parser, step, node, is_verify_command)
+        end
+
+        def validate
+          validate_ssh
+          validate_env
+          validate_arguments
+          validate_exit_code
+          validate_output
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = ssh_command(env, command_string)
+          check_output(cmd_stdout) &&
+            check_output(cmd_stderr) &&
+            check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def expect_exit_codes_defaults
+          [ 0, 2 ]
+        end
+
+        def parse_output_defaults
+          { :error => [
+              '^Error:'
+            ],
+            :warning => [
+              '^Warning:'
+            ]
+          }
+        end
+
+      private
+
+        def command_string
+          "puppet agent --test --color false #{arguments}"
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/ssh/reboot.rb

@@ -0,0 +1,50 @@
+#
+# DOPi Plugin: Reboot a node
+#
+
+module Dopi
+  class Command
+    class Ssh
+      class Reboot < Dopi::Command::Ssh::WaitForLogin
+
+        def validate
+          super
+          log_validation_method(:reboot_cmd_valid?, CommandParsingError)
+        end
+
+        def run
+          ssh_command({}, reboot_cmd)
+          connected = true
+          @connection_timeout = 1
+          while connected
+            begin connected = check_exit_code(ssh_command({}, 'exit')[2])
+            rescue Dopi::NodeConnectionError, Dopi::CommandConnectionError
+              connected = false
+            end
+            if connected
+              sleep 1
+              raise GracefulExit if signals[:stop]
+              log(:info, "Still able to login, waiting for shutdown")
+            end
+          end
+          log(:info, "Node is down, starting to check for login")
+          @connection_timeout = nil
+          super
+        end
+
+        def reboot_cmd
+          @reboot_cmd ||= reboot_cmd_valid? ? hash[:reboot_cmd] : 'shutdown -r now'
+        end
+
+        private
+
+        def reboot_cmd_valid?
+          return false if hash[:reboot_cmd].nil? # is optional
+          hash[:reboot_cmd].class == String or
+            raise CommandParsingError, "Plugin #{name}: the value of 'reboot_cmd' has to be a string"
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/ssh/wait_for_login.rb

@@ -0,0 +1,68 @@
+#
+# DOPi Plugin: Wait For Login
+#
+
+module Dopi
+  class Command
+    class Ssh
+      class WaitForLogin < Dopi::Command
+        include Dopi::Connector::Ssh
+        include Dopi::CommandParser::ExitCode
+
+        DEFAULT_CONNECTION_TIMEOUT = 0
+        DEFAULT_INTERVAL = 10
+
+        def validate
+          validate_ssh
+          validate_exit_code
+          log_validation_method(:connection_timeout_valid?, CommandParsingError)
+          log_validation_method(:interval_valid?, CommandParsingError)
+        end
+
+        def run
+          connected = false
+          until connected
+            begin connected = check_exit_code(ssh_command({}, 'exit')[2])
+            rescue Dopi::NodeConnectionError, Dopi::CommandConnectionError
+            end
+            unless connected
+              sleep interval
+              raise GracefulExit if signals[:stop]
+              log(:info, "Retrying connect to node")
+            end
+          end
+          true
+        end
+
+        def connection_timeout
+          @connection_timeout ||= connection_timeout_valid? ?
+            hash[:connection_timeout] : DEFAULT_CONNECTION_TIMEOUT
+        end
+
+        def interval
+          @interval ||= interval_valid? ?
+            hash[:interval] : DEFAULT_INTERVAL
+        end
+
+        def ssh_options_defaults
+          [" -o ConnectTimeout=#{connection_timeout} -q "]
+        end
+
+      private
+
+        def connection_timeout_valid?
+          return false if hash[:connection_timeout].nil? # is optional
+          hash[:connection_timeout].class == Fixnum or
+            raise CommandParsingError, "Plugin #{name}: the value of 'connection_timeout' has to be a number"
+        end
+
+        def interval_valid?
+          return false if hash[:interval].nil? # is optional
+          hash[:interval].class == Fixnum or
+            raise CommandParsingError, "Plugin #{name}: the value of 'interval' has to be a number"
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/winrm/cmd.rb

@@ -0,0 +1,44 @@
+#
+# DOPi Plugin: WinRM Command
+#
+require 'winrm'
+
+module Dopi
+  class Command
+    class Winrm
+      class Cmd < Dopi::Command
+        include Dopi::Connector::Winrm
+        include Dopi::CommandParser::Exec
+        include Dopi::CommandParser::Env
+        include Dopi::CommandParser::Arguments
+        include Dopi::CommandParser::ExitCode
+        include Dopi::CommandParser::Output
+
+        def validate
+          validate_winrm
+          validate_exec
+          validate_env
+          validate_arguments
+          validate_exit_code
+          validate_output
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = winrm_command(command_string)
+          check_output(cmd_stdout) &&
+            check_output(cmd_stderr) &&
+            check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def command_string
+          exec + ' ' + arguments
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/winrm/file_contains.rb

@@ -0,0 +1,66 @@
+#
+# DOPi Plugin: File Contains
+#
+
+module Dopi
+  class Command
+    class Winrm
+      class FileContains < Dopi::Command
+        include Dopi::Connector::Winrm
+        include Dopi::CommandParser::ExitCode
+
+        def validate
+          validate_winrm
+          validate_exit_code
+          log_validation_method('file_valid?', CommandParsingError)
+          log_validation_method('pattern_valid?', CommandParsingError)
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = winrm_powershell_command(command_string)
+          check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def command_string
+          "if(-not(Select-String -Pattern #{pattern} -Path '#{file}' -Quiet)) { exit 1 }"
+        end
+
+        def file
+          @file ||= file_valid? ?
+            hash[:file] : nil
+        end
+
+        def pattern
+          @pattern ||= pattern_valid? ?
+            hash[:pattern] : nil
+        end
+
+        def file_valid?
+          hash[:file] or
+            raise CommandParsingError, "Plugin #{name}: The key 'file' needs to be specified"
+          begin
+            hash[:file][/[a-zA-Z]+:\\/] or hash[:file][/\\\\\w+/] or
+              raise CommandParsingError, "Plugin #{name}: The path for 'file' has to be absolute"
+          rescue ArgumentError => e
+            raise CommandParsingError, "Plugin #{name}: The value in 'file' is not a valid file path: #{e.message}"
+          end
+        end
+
+        def pattern_valid?
+          hash[:pattern] or
+            raise CommandParsingError, "Plugin #{name}: The key 'pattern' needs to be specified"
+          begin
+            Regexp.new(hash[:pattern])
+          rescue
+            raise CommandParsingError, "Plugin #{name}: The value in 'pattern' is not a valid regexp: #{e.message}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/winrm/file_exists.rb

@@ -0,0 +1,51 @@
+#
+# DOPi Plugin: File Exists
+#
+require 'pathname'
+
+module Dopi
+  class Command
+    class Winrm
+      class FileExists < Dopi::Command
+        include Dopi::Connector::Winrm
+        include Dopi::CommandParser::ExitCode
+
+        def validate
+          validate_winrm
+          validate_exit_code
+          log_validation_method(:file_valid?, CommandParsingError)
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = winrm_powershell_command(command_string)
+          check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def command_string
+          "if(-not(Test-Path '#{file}')) { exit 1 }"
+        end
+
+        def file
+          @file ||= file_valid? ?
+            hash[:file] : nil
+        end
+
+        def file_valid?
+          hash[:file] or
+            raise CommandParsingError, "Plugin #{name}: The key 'file' needs to be specified"
+          begin
+            hash[:file][/[a-zA-Z]+:\\/] or hash[:file][/\\\\\w+/] or
+              raise CommandParsingError, "Plugin #{name}: The path for 'file' has to be absolute"
+          rescue ArgumentError => e
+            raise CommandParsingError, "Plugin #{name}: The value in 'file' is not a valid file path: #{e.message}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/winrm/powershell.rb

@@ -0,0 +1,16 @@
+module Dopi
+  class Command
+    class Winrm
+      class Powershell < Dopi::Command::Winrm::Cmd
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = winrm_powershell_command(command_string)
+          check_output(cmd_stdout) &&
+            check_output(cmd_stderr) &&
+            check_exit_code(cmd_exit_code)
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/winrm/puppet_agent_run.rb

@@ -0,0 +1,61 @@
+#
+# WinRM Puppet Agent Plugin
+#
+module Dopi
+  class Command
+    class Winrm
+      class PuppetAgentRun < Dopi::Command
+        include Dopi::Connector::Winrm
+        include Dopi::CommandParser::Arguments
+        include Dopi::CommandParser::ExitCode
+        include Dopi::CommandParser::Output
+
+      public
+
+        def initialize(command_parser, step, node, is_verify_command)
+          command_parser.overwrite_defaults = { :plugin_timeout => 1800 }
+          super(command_parser, step, node, is_verify_command)
+        end
+
+        def validate
+          validate_winrm
+          validate_arguments
+          validate_exit_code
+          validate_output
+        end
+
+        def run
+          cmd_stdout, cmd_stderr, cmd_exit_code = winrm_powershell_command(command_string)
+          check_output(cmd_stdout) &&
+            check_output(cmd_stderr) &&
+            check_exit_code(cmd_exit_code)
+        end
+
+        def run_noop
+          log(:info, "(NOOP) Executing '#{command_string}' for command #{name}")
+        end
+
+        def expect_exit_codes_defaults
+          [ 0, 2 ]
+        end
+
+        def parse_output_defaults
+          { :error => [
+              '^Error:'
+            ],
+            :warning => [
+              '^Warning:'
+            ]
+          }
+        end
+
+      private
+
+        def command_string
+          "puppet agent --test --color false #{arguments}"
+        end
+
+      end
+    end
+  end
+end

data/lib/dopi/command/winrm/reboot.rb

@@ -0,0 +1,33 @@
+#
+# DOPi Plugin: Wait For Login
+#
+
+module Dopi
+  class Command
+    class Winrm
+      class Reboot < Dopi::Command::Winrm::WaitForLogin
+
+        def run
+          winrm_powershell_command('shutdown /r /f /t 0')
+          connected = true
+          while connected
+            begin
+              @node.reset_address(port)
+              @node.address(port)
+            rescue Dopi::NodeConnectionError
+              connected = false
+            end
+            if connected
+              sleep 1
+              raise GracefulExit if signals[:stop]
+              log(:info, "Still able to login, waiting for shutdown")
+            end
+          end
+          log(:info, "Node is down, starting to check for login")
+          super
+        end
+
+      end
+    end
+  end
+end