dopi 0.17.0

data/doc/plugins/winrm/cmd.md

@@ -0,0 +1,161 @@
+# DOPi Command Plugin: WinRM Command executor
+
+This DOPi Plugin will execute a command on Windows with WinRM.
+
+## Plugin Settings:
+
+### credentials (optional)
+
+`default: []`
+
+The winrm plugin and all the plugins that inherit from it can use
+credentials from the credentials hash in the plan to login.
+
+    credentials:
+      'windows_staging_login':
+        type: :username_password
+        username: 'administrator'
+        password: 'foo'
+
+    steps:
+      - name: 'set winrm login credentials'
+        command:
+          plugin: 'winrm/cmd'
+          credentials: 'windows_staging_login'
+          exec: 'somecommand'
+
+You can also specify multiple credentials and the winrm plugin will try each one
+of them in turn to login to the node.
+
+    credentials:
+      'windows_staging_login':
+        type: :username_password
+        username: 'administrator'
+        password: 'foo'
+      'windows_prod_login':
+        type: :kerberos
+        realm: 'FOOO'
+
+    steps:
+      - name: 'set winrm login credentials'
+        command:
+          plugin: 'winrm/cmd'
+          credentials:
+            - 'windows_staging_login'
+            - 'windows_prod_login'
+          exec: 'somecommand'
+
+This can be set in each plugin (don't forget the validator plugins) or via
+the set_plugin_defaults hash. The plugin defaults will be preserved for
+subsequent steps until it is altered or deleted.
+
+    credentials:
+      'windows_staging_login':
+        type: :username_password
+        username: 'administrator'
+        password: 'foo'
+      'windows_prod_login':
+        type: :kerberos
+        realm: 'FOOO'
+
+    steps:
+      - name: 'set winrm login credentials'
+        set_plugin_defaults:
+          - plugins: '/^ssh/'
+            :credentials:
+              - 'windows_staging_login'
+              - 'windows_prod_login'
+        command:
+          plugin: 'winrm/cmd'
+          exec: 'somecommand'
+
+
+(See dop_common plan format for more options)
+
+### exec (required)
+
+The command the plugin should execute for every node.
+
+### arguments (optional)
+
+`default: ""`
+
+The arguments for the command. This can be set by a string as an array or
+as a hash. All the elements of the hash and the array will be flattened
+and joined with a space.
+
+### port (optional)
+
+`default: 5985`
+
+The port where the service is listening on the remote machines.
+
+### ssl (optional)
+
+`default: true`
+
+Communicate with the node over ssl
+
+### ca_trust_path (optional)
+
+`default: nil`
+
+Point to another CA trust ca trust path
+
+### disable_sspi (optional)
+
+`default: false`
+
+Disable the security support provider interface.
+
+### basic_auth_only (optional)
+
+`default: false`
+
+Use basic auth only
+
+### operation_timeout (optional)
+
+`default: plugin_timeout - 5s`
+
+Timeout for the winrm command to respond. This will default to the plugin_timeout - 5s
+
+### expect_exit_codes (optional)
+
+`default: 0`
+
+The exit codes DOPi should expect if the program terminates. It the program
+exits with an exit code not listed here, DOPi will mark the run as failed.
+The values can be a number, an array of numbers or :all for all possible exit
+codes. Will replace the current default.
+
+### parse_output (optional)
+
+`default: {}`
+
+Here you can define patterns that match against the output of the command plugin
+and flag certain lines as errors or warnings. The parse_output key should contain
+a hash with two keys, 'error' and 'warning' which each can contain an array of
+patterns.
+
+## Example:
+
+    credentials:
+      'windows_kerberos':
+        type: 'kerberos'
+        realm: 'EXAMPLE.COM'
+      'windows_login':
+        type: 'username_password'
+        username: 'Administrator'
+        password: 'vagrant'
+
+    steps:
+      - name: 'execute a simple cmd command'
+        nodes: 'all'
+        command:
+          plugin: 'winrm/cmd'
+          credentials:
+            - 'windows_kerberos'
+            - 'windows_login'
+          exec: 'ipconfig'
+          arguments: '/all'

data/doc/plugins/winrm/file_contains.md

@@ -0,0 +1,39 @@
+# DOPi Command Plugin: File Contains WinRM Command
+
+This DOPi Plugin will check if the specified file on the node contains a
+specific pattern. This plugin is usually used as a verify command to check
+if a command has to be executed on a node.
+
+## Plugin Settings:
+
+The winrm/file_contains command plugin is based on the
+[winrm powershell command plugin](doc/plugins/winrm/powershell.md) and the
+[winrm cmd command plugin](doc/plugins/winrm/cdm.md) and inherits all their
+parameters.
+
+It will however overwrite the **exec** parameter, so it is not possible to
+set a custom command in this plugin.
+
+### file (required)
+
+The file to check
+
+### pattern (required)
+
+The regular expression to check against
+
+## Example:
+
+    - name "Run puppet on a node"
+      nodes:
+        - 'web01.example.com'
+      command:
+        plugin: 'winrm/cmd'
+        verify_commands:
+          - plugin: 'winrm/file_contains'
+            file: 'C:\puppet\puppet.conf'
+            pattern: 'puppetmaster.example.com'
+        exec: 'puppet'
+        arguments:
+          'agent': '--test'
+          '--server': 'puppetmaster.example.com'

data/doc/plugins/winrm/file_exists.md

@@ -0,0 +1,31 @@
+# DOPi Command Plugin: File Contains WinRM Command
+
+This DOPi Plugin will check if the specified file on the node exists.
+This plugin is usually used as a verify command to check if a command
+has to be executed on a node.
+
+## Plugin Settings:
+
+The winrm/file_exists command plugin is based on the
+[winrm powershell command plugin](doc/plugins/winrm/powershell.md) and the
+[winrm cmd plugin](doc/plugins/winrm/cmd.md) and inherits all their
+parameters.
+
+It will however overwrite the **exec** parameter, so it is not possible to
+set a custom command in this plugin.
+
+### file (required)
+
+The file to check
+
+## Example:
+
+    - name: 'Say hello'
+      nodes: all
+      command:
+        verify_commands:
+          - plugin: 'winrm/file_exists'
+            file: 'C:\some\file.txt'
+        plugin: 'winrm/cmd'
+        exec: 'echo'
+        arguments: '"Hello"'

data/doc/plugins/winrm/powershell.md

@@ -0,0 +1,27 @@
+# DOPi Command Plugin: WinRM Command executor
+
+This DOPi Plugin will execute a powershell command on Windows with WinRM.
+
+This Plugin is identical to the 'winrm/cmd' plugin and shares the same options.
+The only difference is that it will execute powershell commands.
+
+## Example:
+
+    credentials:
+      'windows_kerberos':
+        type: 'kerberos'
+        realm: 'EXAMPLE.COM'
+      'windows_login':
+        type: 'username_password'
+        username: 'Administrator'
+        password: 'vagrant'
+
+    steps:
+      - name: 'execute a simple powershell command'
+        nodes: 'all'
+        command:
+          plugin: 'winrm/powershell'
+          credentials:
+            - 'windows_kerberos'
+            - 'windows_login'
+          exec: 'Get-NetAdapter'

data/doc/plugins/winrm/puppet_agent_run.md

@@ -0,0 +1,49 @@
+# DOPi Command Plugin: WinRM Puppet Agent run Command
+
+This DOPi Plugin will run puppet on the nodes in the step.
+
+## Plugin Settings:
+
+The winrm/puppet_agent_run command plugin is based on the
+[winrm custom command plugin](doc/plugins/winrm/powershell.md) and
+inherits all it's parameters.
+
+It will however overwrite the **exec** parameter, so it is not possible to
+set a custom command in this plugin.
+
+You may want to set a high **plugin_timeout** here to make sure it waits
+long enough for all the nodes to come up if you provision the nodes while
+waiting.
+
+This plugin overwrites the defaults for the **expect_exit_codes** parameter.
+Puppet will return an exit code of 2 if there where changes. Since this will
+be what we are looking we have to expect this and mark it as success
+
+`default overwrite for expect_exit_codes : [ 0, 2 ]`
+
+If you are sure that there will be changes you should overwrite this with 2
+to make sure there where changes. This may help you catching problems where
+nodes don't actually get a configuration or are in the wrong environment.
+
+The winrm/puppet_agent_run plugin has no additional parameters.
+
+## Examples:
+
+### Simple Example
+
+    - name "Run puppet on a node"
+      nodes:
+        - 'web01.example.com'
+      command: 'winrm/puppet_agent_run'
+
+### Complete Example
+
+    - name "Run puppet with parameters on a node"
+      nodes:
+        - 'web01.example.com'
+      command:
+        plugin: 'winrm/puppet_agent_run'
+        plugin_timeout: 300
+        arguments:
+          '--server': 'puppetmaster.example.com'
+          '--environment': 'development'

data/doc/plugins/winrm/reboot.md

@@ -0,0 +1,17 @@
+# DOPi Command Plugin: Reboot
+
+This plugin will send the reboot command to a node. Then it will check if the
+node actually rebooted by checking until it is unavailable and then available
+again. The command will finish if DOPi is again able to login after the reboot.
+
+## Plugin Settings:
+
+There are currently no settings for this plugin
+
+## Example
+
+    - name "Wait until we can successfully login to the node"
+      nodes:
+        - 'web01.example.com'
+      command: 'winrm/reboot'
+

data/doc/plugins/winrm/wait_for_login.md

@@ -0,0 +1,55 @@
+# DOPi Command Plugin: Wait for SSH login Command
+
+This DOPi Plugin will try to connect to the node until a successful login
+is possible or until a timeout is reached.
+
+## Plugin Settings:
+
+The winrm/wait_for_login command plugin is based on the
+[winrm cmd plugin](doc/plugins/winrm/cmd.md) and the
+[custom command plugin](doc/plugins/custom.md) and inherits all their
+parameters.
+
+It will however overwrite the **exec** parameter, so it is not possible to
+set a custom command in this plugin.
+
+You may want to set a high **plugin_timeout** here to make sure it waits
+long enough for all the nodes to come up if you provision the nodes while
+waiting.
+
+### connect_timeout (optional)
+
+`default: 0`
+
+__*NOTE:*__ This is not implemented for the winrm version of this plugin right now
+
+Amount of seconds to wait while connecting until giving up.
+
+### interval (optional)
+
+`default: 10`
+
+Amount of seconds to wait between login attempts.
+
+## Examples:
+
+### Simple Example
+
+    - name "Wait until we can successfully login to the node"
+      nodes:
+        - 'windows01.example.com'
+      command:
+        plugin: 'winrm/wait_for_login'
+        plugin_timeout: 300
+
+
+### Complete Example
+
+    - name "Wait until we can successfully login to the node"
+      nodes:
+        - 'windows01.example.com'
+      command:
+        plugin: 'winrm/wait_for_login'
+        plugin_timeout: 300
+        connect_timeout: 5
+        interval: 30

data/dopi.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dopi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dopi'
+  spec.version       = Dopi::VERSION
+  spec.authors       = ['Andreas Zuber', 'Andreas Maierhofer']
+  spec.email         = ['zuber@puzzle.ch', 'andreas.maierhofer@swisscom.com']
+  spec.description   = %q{DOPi orchestrates puppet runs, mco calls and custom commands over different nodes}
+  spec.summary       = %q{DOPi orchestrates puppet runs, mco calls and custom commands over different nodes}
+  spec.homepage      = ''
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rspec-command'
+
+  # Code quality
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'dop_common', '~> 0.13', '>= 0.13.0'
+  spec.add_runtime_dependency 'gli', '~> 2'
+  spec.add_runtime_dependency 'logger-colors', '~> 1'
+  spec.add_runtime_dependency 'mcollective-client', '~> 2'
+  spec.add_runtime_dependency 'winrm', '~> 1'
+  spec.add_runtime_dependency 'parallel', '~> 1'
+
+  # curses was removed in ruby 2.1
+  if RUBY_VERSION >= '2.1'
+    spec.add_runtime_dependency 'curses', '~> 1'
+  end
+end

data/lib/dopi/cli/command_add.rb

@@ -0,0 +1,35 @@
+module Dopi
+  module Cli
+
+    def self.command_add(base)
+      base.class_eval do
+
+        desc 'Add a new plan file to the plan cache'
+        arg_name 'plan_file'
+        command :add do |c|
+          c.desc 'update the plan if it already exists'
+          c.default_value false
+          c.switch [:update, :u]
+
+          c.action do |global_options,options,args|
+            help_now!('Specify a plan file to add') if args.empty?
+            help_now!('You can only add one plan') if args.length > 1
+            plan_file = args[0]
+            begin
+              puts Dopi.add(plan_file)
+            rescue DopCommon::PlanExistsError => e
+              if options[:update]
+                puts Dopi.update_plan(plan_file, {})
+              else
+                raise e
+              end
+						end
+          end
+        end
+
+      end
+    end
+
+  end
+end
+

data/lib/dopi/cli/command_list.rb

@@ -0,0 +1,19 @@
+module Dopi
+  module Cli
+
+    def self.command_list(base)
+      base.class_eval do
+
+        desc 'Show the list of plans in the dopi plan cache'
+        command :list do |c|
+          c.action do |global_options,options,args|
+            puts Dopi.list
+          end
+        end
+
+      end
+    end
+
+  end
+end
+

data/lib/dopi/cli/command_remove.rb

@@ -0,0 +1,31 @@
+module Dopi
+  module Cli
+
+    def self.command_remove(base)
+      base.class_eval do
+
+        desc 'Remove an existing plan from the plan cache'
+        arg_name 'name'
+        command :remove do |c|
+          c.desc 'Keep the DOPi state file'
+          c.default_value false
+          c.switch [:keep_dopi_state]
+
+          c.desc 'Remove the DOPv state file (THIS WILL REMOVE THE DISK INFO)'
+          c.default_value false
+          c.switch [:remove_dopv_state]
+
+          c.action do |global_options,options,args|
+            help_now!('Specify a plan name to remove') if args.empty?
+            help_now!('You can only remove one plan') if args.length > 1
+            plan_name = args[0]
+            Dopi.remove(plan_name, !options[:keep_dopi_state], options[:remove_dopv_state])
+          end
+        end
+
+      end
+    end
+
+  end
+end
+

data/lib/dopi/cli/command_reset.rb

@@ -0,0 +1,27 @@
+module Dopi
+  module Cli
+
+    def self.command_reset(base)
+      base.class_eval do
+
+        desc 'Reset a failed plan'
+        arg_name 'name'
+        command :reset do |c|
+          c.desc 'Force reset the states back to ready from every state'
+          c.default_value false
+          c.switch [:force, :f]
+
+          c.action do |global_options,options,args|
+            help_now!('Specify a plan name to run') if args.empty?
+            help_now!('You can only run one plan') if args.length > 1
+            plan_name = args[0]
+            Dopi.reset(plan_name, options[:force])
+          end
+        end
+
+      end
+    end
+
+  end
+end
+

data/lib/dopi/cli/command_run.rb

@@ -0,0 +1,68 @@
+module Dopi
+  module Cli
+
+    def self.run_options(command)
+      DopCommon::Cli.node_select_options(command)
+
+      command.desc 'Show only stuff the run would do but don\'t execute commands (verify commands will still be executed)'
+      command.default_value false
+      command.switch [:noop, :n]
+
+      command.desc 'Select the step set to run (if nothing is specified it will try to run the step set "default")'
+      command.default_value 'default'
+      command.arg_name 'STEPSET'
+      command.flag [:step_set, :s]
+    end
+
+    def self.command_run(base)
+      base.class_eval do
+
+        desc 'Run the plan'
+        arg_name 'id'
+        command :run do |c|
+          run_options(c)
+          c.action do |global_options,options,args|
+            help_now!('Specify a plan name to run') if args.empty?
+            help_now!('You can only run one plan') if args.length > 1
+            options[:run_for_nodes] = DopCommon::Cli.parse_node_select_options(options)
+            plan_name = args[0]
+            begin
+              Dopi.run(plan_name, options)
+            rescue Dopi::StateTransitionError => e
+              Dopi.log.error(e.message)
+              exit_now!("Some steps are in a state where they can't be started again. Try to reset the plan.")
+            ensure
+              print_state(plan_name)
+              exit_now!('Errors during plan run detected!') if Dopi.show(plan_name).state_failed?
+            end
+          end
+        end
+
+        desc 'Add a plan, run it and then remove it again (This is mainly for testing)'
+        arg_name 'plan_file'
+        command :oneshot do |c|
+          run_options(c)
+          c.action do |global_options,options,args|
+            help_now!('Specify a plan file to add') if args.empty?
+            help_now!('You can only add one plan') if args.length > 1
+            options[:run_for_nodes] = DopCommon::Cli.parse_node_select_options(options)
+            plan_file = args[0]
+            plan_name = Dopi.add(plan_file)
+            begin
+              Dopi.run(plan_name, options)
+            ensure
+              print_state(plan_name)
+              failed = Dopi.show(plan_name).state_failed?
+              Dopi.remove(plan_name, true)
+              exit_now!('Errors during plan run detected!') if failed
+            end
+          end
+        end
+
+      end
+    end
+
+  end
+end
+
+