kpn_winrm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a8fa621a194fcac699a2a168a87d3bbb55f0fac53e8da0daf938e5ede20c7e5
+  data.tar.gz: cab7d40f550adb3a2d6336df145213c9efeff7e188b07c43949e666fd5981b82
+SHA512:
+  metadata.gz: 58cc3cb31c6a6941f827f90249799b5f02122e9010c75923b5947ee9d53ee5486afc0f5c1923f9fca79195f0a990e3307b0772e0a4d1f054304e320a5ecd4d9a
+  data.tar.gz: f12ea25c53b8ae58a045328c4f6c2bdc7899509b6cbfaf6ed6546710030957df3b4ddc5e2853c3617f7a8e4083ef4f2b4abfde900a88d307206f887a19f73e2b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+---
+inherit_gem:
+  kpn-style:
+    - ruby-2.1.yml

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kpn_winrm.gemspec
+gemspec

data/README.md

@@ -0,0 +1,82 @@
+# kpn_winrm
+
+This gem is used to execute Puppet module acceptance tests (beaker) for Windows using WinRM instead of SSH.
+
+
+TODO: rspec test for this gem
+
+## Dependencies
+
+This gem has two gem dependencies:
+- [winrm](https://rubygems.org/gems/winrm) (version requirement: >= 2.2.2)
+- [winrm-elevated](https://rubygems.org/gems/winrm-elevated) (version requirement: >= 1.1.0)
+
+## Installation
+
+Add this line to your spec_helper_acceptance.rb:
+
+```ruby
+require 'kpn_winrm'
+```
+
+Make sure the gem is installed:
+
+    $ gem install kpn_winrm
+
+
+## Usage
+
+This gem contains 2 functions:
+- apply_manifest_on_winrm
+- winrm_command
+
+### apply_manifest_on_winrm
+This function can be used to apply a puppet manifest on the beaker node using winrm.
+
+The functions has 3 parameters:
+#### host
+The host definition on which to execute the commands, for one node tests set this to `default`.
+
+#### manifest
+The ruby variable containting the manifest to apply, example:
+```ruby
+pp = <<-PP
+      user { 'testuser':
+        password => 'Dummy1234qwer!',
+        groups   => ['Administrators'],
+      }
+    PP
+```
+
+#### opts
+A hash of options, which can have one of the following:
+- catch_changes
+- catch_failures
+- expect_failures
+- expect_changes
+
+Example
+```ruby
+apply_manifest_on_winrm(default, pp, :catch_failures => true)
+apply_manifest_on_winrm(default, pp, :catch_changes => true)
+```
+
+### winrm_command
+Run a command on the beaker node via winrm.
+
+The functions has 3 parameters:
+#### host
+The host definition on which to execute the commands, for one node tests set this to `default`.
+
+#### command
+The command which should be executed via WinRM.
+- acceptable_exit_codes
+- run_as_cmd
+
+#### opts
+A hash of options, which can have one of the following:
+
+Example
+```ruby
+winrm_command(default, 'SecEdit /export /cfg c:\cfg.txt')
+```

data/Rakefile

@@ -0,0 +1,7 @@
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/kpn_winrm.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kpn_winrm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kpn_winrm'
+  spec.version       = KpnWinrm::VERSION
+  spec.authors       = ['kpn']
+  spec.email         = ['noreply@kpn.com']
+
+  spec.summary       = 'Additional functions for acceptance testing, to run commands and puppet apply over WinRM instead of ssh'
+  spec.homepage      = 'https://github.com/kpn-puppet/gem-kpn-winrm'
+  spec.license       = 'Apache-2.0'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'winrm', '~> 2.2', '>= 2.2.2'
+  spec.add_dependency 'winrm-elevated', '~> 1.1', '>= 1.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/kpn_winrm.rb

@@ -0,0 +1,99 @@
+require 'winrm'
+require 'winrm-elevated'
+
+# kpn_winrm
+module KpnWinrm
+  def self.winrm_command(host, command, opts = {})
+    # Get parameters
+    puts host
+    user = host[:ssh][:user]
+    pass = host[:ssh][:password]
+    hostname = host.to_s
+    endpoint = 'http://' + hostname + ':5985/wsman'
+    acceptable_exit_codes = if opts.key?(:acceptable_exit_codes) && !opts[:acceptable_exit_codes].nil?
+                              opts[:acceptable_exit_codes]
+                            else
+                              opts[:acceptable_exit_codes] = [0]
+                            end
+
+    run_as_cmd = false
+    if opts.key?(:run_as_cmd) && !opts[:acceptable_exit_codes].nil?
+      run_as_cmd = true
+    end
+
+    # Setup winrm
+    opts = {
+      user: user,
+      password: pass,
+      endpoint: endpoint,
+      operation_timeout: 300,
+    }
+    host.logger.debug 'Trying to connect to windows host'
+    p opts.inspect
+    winrm = WinRM::Connection.new opts
+
+    # Debugging
+    host.logger.debug "Running command '#{command}' via winrm"
+    # Execute command via winrm
+    if run_as_cmd
+      winrm.shell(:cmd) do |shell|
+        @result = shell.run(command) do |stdout, stderr|
+          host.logger.debug stdout
+          host.logger.debug stderr
+        end
+      end
+    else
+      winrm.shell(:elevated) do |shell|
+        @result = shell.run(command) do |stdout, stderr|
+          host.logger.debug stdout
+          host.logger.debug stderr
+        end
+      end
+    end
+
+    # Debugging
+    host.logger.debug "winrm - stdout  :#{stdout}"
+    host.logger.debug "winrm - stderr  :#{stderr}"
+    host.logger.debug "winrm - exitcode:#{@result.exitcode}"
+
+    unless acceptable_exit_codes.include?(@result.exitcode)
+      raise StandardError, "Command '#{command}' failed with unacceptable exit code:#{@result.exitcode} on host '#{hostname}'\n" \
+                          "Stdout:#{@result.stdout}\n" \
+                          "Stderr:#{@result.stderr}\n"
+    end
+
+    # Return flat hash with stdout, stderr and the exitcode
+    { stdout: @result.stdout,
+      stderr: @result.stderr,
+      exitcode: @result.exitcode }
+  end
+
+  def self.apply_manifest_on_winrm(host, manifest, opts = {})
+    if [opts[:catch_changes], opts[:catch_failures], opts[:expect_failures], opts[:expect_changes]].compact.length > 1
+      raise StandardError, 'only one of :catch_changes, :catch_failures, :expect_failures and :expect_changes should be set'
+    end
+
+    acceptedexitcodes = [0]
+
+    if opts[:catch_changes]
+      acceptedexitcodes = [0]
+    end
+
+    if opts[:catch_failures]
+      acceptedexitcodes = [0, 2]
+    end
+
+    if opts[:expect_failures]
+      acceptedexitcodes = [1, 4, 6]
+    end
+
+    if opts[:expect_changes]
+      acceptedexitcodes = [2]
+    end
+
+    file_path = host.tmpfile('apply_manifest.pp')
+    create_remote_file(host, file_path, manifest + "\n")
+
+    winrm_command(host, 'puppet apply --detailed-exitcodes ' + file_path + '; exit $lastexitcode', acceptable_exit_codes: acceptedexitcodes)
+  end
+end

data/lib/kpn_winrm/version.rb

@@ -0,0 +1,3 @@
+module KpnWinrm
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: kpn_winrm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kpn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: winrm-elevated
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- noreply@kpn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- kpn_winrm.gemspec
+- lib/kpn_winrm.rb
+- lib/kpn_winrm/version.rb
+homepage: https://github.com/kpn-puppet/gem-kpn-winrm
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Additional functions for acceptance testing, to run commands and puppet apply
+  over WinRM instead of ssh
+test_files: []