train 1.4.21 → 1.4.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c4862d3b58025d9911ae676ff682f54a09865ebb909549781c6b830c0088ff1
-  data.tar.gz: fb096faa3df3d6676ac4cf9e29a0c6da2d7b4ea45d81796e2a4012afa037fe23
+  metadata.gz: 455f5a9ff1827140f4f890be1b536a30261120db86836ee266b15eb418fe2900
+  data.tar.gz: e4d8c9dba2799532849ed9699cf11e813ec44669abc519f5e52de9ec9c5bd507
 SHA512:
-  metadata.gz: eca750c91b7bb535029cf29b03f240c7bb25c119438ec11480f113e98d1989d447422d5786b2980b544a722e30169a0ce305248f349386b82462ad0fc35e3645
-  data.tar.gz: 8a1857619fca8f3289b497a1fc49afc02c6e5b1296fc883d115ffe7bb4247d33b843ad48c9e102389cbcdef47bca8deb2fa9ef5931bb6cfc45e1398dfbe1fb98
+  metadata.gz: 8403b5941b3596a6aff77c830332e21f4b9a878eeb65b39c84fc598467060dae99b69c7968f9697379534d2fd5867b990343783a971658b257a21110ceeca044
+  data.tar.gz: 0dd9693a229a54b80c6bdaf9fe91f9d80ef3809bd2d860f5fa77ca7438f349df3d6951a0516057672651942251fa1eea432570774172b2b9afe3b49f100b973b

data/CHANGELOG.md

@@ -1,19 +1,25 @@
-<!-- latest_release 1.4.21 -->
-## [v1.4.21](https://github.com/inspec/train/tree/v1.4.21) (2018-07-05)
+<!-- latest_release 1.4.22 -->
+## [v1.4.22](https://github.com/inspec/train/tree/v1.4.22) (2018-07-12)
 
 #### Merged Pull Requests
-- Modify `WindowsPipeRunner` stderr to use String [#320](https://github.com/inspec/train/pull/320) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+- Add VMware transport [#321](https://github.com/inspec/train/pull/321) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
 <!-- latest_release -->
 
-<!-- release_rollup since=1.4.19 -->
-### Changes since 1.4.19 release
+<!-- release_rollup since=1.4.21 -->
+### Changes since 1.4.21 release
 
 #### Merged Pull Requests
-- Modify `WindowsPipeRunner` stderr to use String [#320](https://github.com/inspec/train/pull/320) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 1.4.21 -->
-- Remove the delivery cookbook [#317](https://github.com/inspec/train/pull/317) ([tas50](https://github.com/tas50)) <!-- 1.4.20 -->
+- Add VMware transport [#321](https://github.com/inspec/train/pull/321) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 1.4.22 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v1.4.21](https://github.com/inspec/train/tree/v1.4.21) (2018-07-05)
+
+#### Merged Pull Requests
+- Remove the delivery cookbook [#317](https://github.com/inspec/train/pull/317) ([tas50](https://github.com/tas50))
+- Modify `WindowsPipeRunner` stderr to use String [#320](https://github.com/inspec/train/pull/320) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+<!-- latest_stable_release -->
+
 ## [v1.4.19](https://github.com/inspec/train/tree/v1.4.19) (2018-06-29)
 
 #### Merged Pull Requests
@@ -21,7 +27,6 @@
 - Adding proper bastion support [#310](https://github.com/inspec/train/pull/310) ([frezbo](https://github.com/frezbo))
 - Remove github_changelog_generator [#313](https://github.com/inspec/train/pull/313) ([tas50](https://github.com/tas50))
 - Remove the deploy config from Travis [#315](https://github.com/inspec/train/pull/315) ([tas50](https://github.com/tas50))
-<!-- latest_stable_release -->
 
 ## [v1.4.15](https://github.com/inspec/train/tree/v1.4.15) (2018-06-14)
 

data/README.md

@@ -22,6 +22,7 @@ Train supports:
 * Mock (for testing and debugging)
 * AWS as an API
 * Azure as an API
+* VMware via PowerCLI
 
 # Examples
 
@@ -79,6 +80,20 @@ require 'train'
 train = Train.create('aws')
 ```
 
+**VMware**
+
+```ruby
+require 'train'
+Train.create('vmware', viserver: '10.0.0.10', user: 'demouser', password: 'securepassword')
+```
+
+You may also use environment variables by setting `VISERVER`, `VISERVER__USERNAME`, and `VISERVER_PASSWORD`
+
+```ruby
+require 'train'
+Train.create('vmware')
+```
+
 ## Configuration
 
 To get a list of available options for a plugin:
@@ -151,7 +166,7 @@ bundle exec ruby -I .\test\windows\ .\test\windows\local_test.rb
 
 Train is heavily based on the work of:
 
-* [test-kitchen](https://github.com/test-kitchen/test-kitchen)  
+* [test-kitchen](https://github.com/test-kitchen/test-kitchen)
 
     by [Fletcher Nichol](fnichol@nichol.ca)
     and [a great community of contributors](https://github.com/test-kitchen/test-kitchen/graphs/contributors)

data/lib/train/platforms/detect/specifications/api.rb

@@ -11,6 +11,8 @@ module Train::Platforms::Detect::Specifications
       plat.name('aws').in_family('cloud')
       plat.name('azure').in_family('cloud')
       plat.name('gcp').in_family('cloud')
+      plat.name('vmware').in_family('cloud')
+
       plat.family('iaas').in_family('api')
       plat.name('oneview').in_family('iaas')
     end

data/lib/train/transports/vmware.rb

@@ -0,0 +1,190 @@
+# encoding: utf-8
+require 'train/plugins'
+require 'open3'
+require 'ostruct'
+require 'json'
+require 'mkmf'
+
+module Train::Transports
+  class VMware < Train.plugin(1)
+    name 'vmware'
+    option :viserver, default: ENV['VISERVER']
+    option :username, default: ENV['VISERVER_USERNAME']
+    option :password, default: ENV['VISERVER_PASSWORD']
+    option :insecure, default: false
+
+    def connection(_ = nil)
+      @connection ||= Connection.new(@options)
+    end
+
+    class Connection < BaseConnection # rubocop:disable ClassLength
+      POWERSHELL_PROMPT_REGEX = /PS\s.*> $/
+
+      def initialize(options)
+        super(options)
+
+        options[:viserver] = options[:viserver] || options[:host]
+        options[:username] = options[:username] || options[:user]
+
+        @username = options[:username]
+        @viserver = options[:viserver]
+        @session = nil
+        @stdout_buffer = ''
+        @stderr_buffer = ''
+
+        @powershell_binary = detect_powershell_binary
+
+        if @powershell_binary == :powershell
+          require 'train/transports/local'
+          @powershell = Train::Transports::Local::Connection.new(options)
+        end
+
+        if options[:insecure] == true
+          run_command_via_connection('Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Scope Session -Confirm:$False')
+        end
+
+        @platform_details = {
+          release: "vmware-powercli-#{powercli_version}",
+        }
+
+        connect
+      end
+
+      def connect
+        login_command = "Connect-VIServer #{options[:viserver]} -User #{options[:username]} -Password #{options[:password]} | Out-Null"
+        result = run_command_via_connection(login_command)
+
+        if result.exit_status != 0
+          message = "Unable to connect to VIServer at #{options[:viserver]}. "
+          case result.stderr
+          when /Invalid server certificate/
+            message += 'Certification verification failed. Please use `--insecure` or set `Set-PowerCLIConfiguration -InvalidCertificateAction Ignore` in PowerShell'
+          when /incorrect user name or password/
+            message += 'Incorrect username or password'
+          else
+            message += result.stderr.gsub(/-Password .*\s/, '-Password REDACTED')
+          end
+
+          raise message
+        end
+      end
+
+      def local?
+        true
+      end
+
+      def platform
+        direct_platform('vmware', @platform_details)
+      end
+
+      def run_command_via_connection(cmd)
+        if @powershell_binary == :pwsh
+          result = parse_pwsh_output(cmd)
+
+          # Attach exit status to result
+          exit_status = parse_pwsh_output('echo $?').stdout.chomp
+          result.exit_status = exit_status == 'True' ? 0 : 1
+
+          result
+        else
+          @powershell.run_command(cmd)
+        end
+      end
+
+      def unique_identifier
+        uuid_command = '(Get-VMHost | Get-View).hardware.systeminfo.uuid'
+        run_command_via_connection(uuid_command).stdout.chomp
+      end
+
+      def uri
+        "vmware://#{@username}@#{@viserver}"
+      end
+
+      private
+
+      def detect_powershell_binary
+        if find_executable0('pwsh')
+          :pwsh
+        elsif find_executable0('powershell')
+          :powershell
+        else
+          raise 'Cannot find PowerShell binary, is `pwsh` installed?'
+        end
+      end
+
+      # Read from stdout pipe until prompt is received
+      def flush_stdout(pipe)
+        while @stdout_buffer !~ POWERSHELL_PROMPT_REGEX
+          @stdout_buffer += pipe.read_nonblock(1)
+        end
+        @stdout_buffer
+      rescue IO::EAGAINWaitReadable
+        # We cannot know when the stdout pipe is finished so we keep reading
+        retry
+      ensure
+        @stdout_buffer = ''
+      end
+
+      # This must be called after `flush_stdout` to ensure buffer is full
+      def flush_stderr(pipe)
+        loop do
+          @stderr_buffer += pipe.read_nonblock(1)
+        end
+      rescue IO::EAGAINWaitReadable
+        # If `flush_stderr` is ran after reading stdout we know that all of
+        # stderr is in the pipe. Thus, we can return the buffer once the pipe
+        # is unreadable.
+        @stderr_buffer
+      ensure
+        @stderr_buffer = ''
+      end
+
+      def parse_pwsh_output(cmd)
+        session.stdin.puts(cmd)
+
+        stdout = flush_stdout(session.stdout)
+
+        # Remove stdin from stdout (including trailing newline)
+        stdout.slice!(0, cmd.length+1)
+
+        # Remove prompt from stdout
+        stdout.gsub!(POWERSHELL_PROMPT_REGEX, '')
+
+        # Grab stderr
+        stderr = flush_stderr(session.stderr)
+
+        CommandResult.new(
+          stdout,
+          stderr,
+          nil # exit_status is attached in `run_command_via_connection`
+        )
+      end
+
+      def powercli_version
+        version_command = '[string](Get-Module -Name VMware.PowerCLI -ListAvailable | Select -ExpandProperty Version)'
+        result = run_command_via_connection(version_command)
+        if result.stdout.empty? || result.exit_status != 0
+          raise 'Unable to determine PowerCLI Module version, is it installed?'
+        end
+
+        result.stdout.chomp
+      end
+
+      def session
+        return @session unless @session.nil?
+
+        stdin, stdout, stderr = Open3.popen3('pwsh')
+
+        # Remove leading prompt and intro text
+        flush_stdout(stdout)
+
+        @session = OpenStruct.new
+        @session.stdin = stdin
+        @session.stdout = stdout
+        @session.stderr = stderr
+
+        @session
+      end
+    end
+  end
+end

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = '1.4.21'.freeze
+  VERSION = '1.4.22'.freeze
 end

data/test/unit/transports/vmware_test.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+require 'helper'
+
+describe 'Train::Transports::VMware::Connection' do
+  def add_stubs(stub_options)
+    Train::Transports::VMware::Connection.any_instance
+      .stubs(:detect_powershell_binary)
+      .returns(stub_options[:powershell_binary] || :pwsh)
+    Train::Transports::VMware::Connection.any_instance
+      .stubs(:powercli_version)
+      .returns('10.1.1.8827525')
+    Train::Transports::VMware::Connection.any_instance
+      .stubs(:run_command_via_connection)
+      .with('(Get-VMHost | Get-View).hardware.systeminfo.uuid')
+      .returns(stub_options[:mock_uuid_result] || nil)
+    if stub_options[:mock_connect_result]
+      Train::Transports::VMware::Connection.any_instance
+        .expects(:run_command_via_connection)
+        .with('Connect-VIServer 10.0.0.10 -User testuser -Password supersecurepassword | Out-Null')
+        .returns(stub_options[:mock_connect_result])
+    else
+      Train::Transports::VMware::Connection.any_instance
+        .stubs(:connect)
+        .returns(nil)
+    end
+  end
+
+  def create_transport(options = {})
+    ENV['VISERVER'] = '10.0.0.10'
+    ENV['VISERVER_USERNAME'] = 'testuser'
+    ENV['VISERVER_PASSWORD'] = 'supersecurepassword'
+
+    # Need to require this here as it captures the ENV variables on load
+    require 'train/transports/vmware'
+    add_stubs(options[:stub_options] || {})
+    Train::Transports::VMware.new(options[:transport_options])
+  end
+
+  describe '#initialize' do
+    it 'defaults to ENV options' do
+      options = create_transport.connection.instance_variable_get(:@options)
+      options[:viserver].must_equal '10.0.0.10'
+      options[:username].must_equal 'testuser'
+      options[:password].must_equal 'supersecurepassword'
+      options[:insecure].must_equal false
+    end
+
+    it 'allows for overriding options' do
+      transport = create_transport(
+        transport_options: {
+          viserver: '10.1.1.1',
+          username: 'anotheruser',
+          password: 'notsecurepassword',
+          insecure: false,
+        }
+      )
+      options = transport.connection.instance_variable_get(:@options)
+      options[:viserver].must_equal '10.1.1.1'
+      options[:username].must_equal 'anotheruser'
+      options[:password].must_equal 'notsecurepassword'
+      options[:insecure].must_equal false
+    end
+
+    it 'ignores certificate validation if --insecure is used' do
+      Train::Transports::VMware::Connection.any_instance
+        .expects(:run_command_via_connection)
+        .with('Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Scope Session -Confirm:$False')
+        .returns(nil)
+      transport = create_transport(transport_options: { insecure: true })
+      options = transport.connection.instance_variable_get(:@options)
+      options[:insecure].must_equal true
+    end
+
+    it 'uses the Local connection when Windows PowerShell is found' do
+      require 'train/transports/local'
+      Train::Transports::Local::Connection.expects(:new)
+      create_transport(
+        stub_options: {
+          powershell_binary: :powershell
+        }
+      ).connection
+    end
+  end
+
+  describe '#connect' do
+    def mock_connect_result(stderr, exit_status)
+      OpenStruct.new(stderr: stderr, exit_status: exit_status)
+    end
+
+    it 'raises certificate error when stderr matches regular expression' do
+      e = proc {
+        create_transport(
+          stub_options: {
+            mock_connect_result: mock_connect_result(
+              'Invalid server certificate', 1
+            )
+          }
+        ).connection
+      }.must_raise(RuntimeError)
+      e.message.must_match /Unable to connect.*Please use `--insecure`/
+    end
+
+    it 'raises auth error when stderr matches regular expression' do
+      e = proc {
+        create_transport(
+          stub_options: {
+            mock_connect_result: mock_connect_result(
+              'incorrect user name or password', 1
+            )
+          }
+        ).connection
+      }.must_raise(RuntimeError)
+      e.message.must_match /Unable to connect.*Incorrect username/
+    end
+
+    it 'redacts the password when an unspecified error is raised' do
+      e = proc {
+        create_transport(
+          stub_options: {
+            mock_connect_result: mock_connect_result(
+              'something unexpected -Password supersecret -AnotherOption', 1
+            )
+          }
+        ).connection
+      }.must_raise(RuntimeError)
+      e.message.must_match /-Password REDACTED/
+    end
+  end
+
+  describe '#local' do
+    it 'returns true' do
+      create_transport.connection.local?.must_equal true
+    end
+  end
+
+  describe '#platform' do
+    it 'returns correct platform details' do
+      platform = create_transport.connection.platform
+      platform.clean_name.must_equal 'vmware'
+      platform.family_hierarchy.must_equal ['cloud', 'api']
+      platform.platform.must_equal(release: 'vmware-powercli-10.1.1.8827525')
+      platform.vmware?.must_equal true
+    end
+  end
+
+  describe '#unique_identifier' do
+    it 'returns the correct unique identifier' do
+      uuid = '1f261432-e23e-6911-841c-94c6911a02dd'
+      mock_uuid_result = OpenStruct.new(
+        stdout: uuid + "\n"
+      )
+      connection = create_transport(
+        stub_options: { mock_uuid_result: mock_uuid_result }
+      ).connection
+
+      connection.unique_identifier.must_equal(uuid)
+    end
+  end
+
+  describe '#uri' do
+    it 'returns the correct URI' do
+      create_transport.connection.uri.must_equal 'vmware://testuser@10.0.0.10'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 1.4.21
+  version: 1.4.22
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -271,6 +271,7 @@ files:
 - lib/train/transports/mock.rb
 - lib/train/transports/ssh.rb
 - lib/train/transports/ssh_connection.rb
+- lib/train/transports/vmware.rb
 - lib/train/transports/winrm.rb
 - lib/train/transports/winrm_connection.rb
 - lib/train/version.rb
@@ -337,6 +338,7 @@ files:
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb
+- test/unit/transports/vmware_test.rb
 - test/unit/version_test.rb
 - test/windows/local_test.rb
 - test/windows/winrm_test.rb
@@ -429,6 +431,7 @@ test_files:
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb
+- test/unit/transports/vmware_test.rb
 - test/unit/version_test.rb
 - test/windows/local_test.rb
 - test/windows/winrm_test.rb