train-vmware 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 238630d02bbca3ff3ba2bf7c27577bcb291222c3dbed50918601ac2100293989
+  data.tar.gz: 900a9ccf490ad20969bd1bda9e8cab0e309d44535df143cd665b8061bbd30448
+SHA512:
+  metadata.gz: '09d46aaad75d424f1f3042627dc08cf4ba3b9205a97d72d2fedbe68663cccc7f7e75fa37836828059e6b6d5c49127c9944d235e56b7be4783f66d18198feb354'
+  data.tar.gz: 31f060e25871a77e487731566e490a2899f4c7f892395adbd7b582ae7d96ab3eb171e2a085c7da4ec9e1c4633573ca26eaf8edc4f9e2b7fba8d69a84d5856a18

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+# This is Gemfile, which is used by bundler
+# to ensure a coherent set of gems is installed.
+# This file lists dependencies needed when outside
+# of a gem (the gemspec lists deps for gem deployment)
+
+# Bundler should refer to the gemspec for any dependencies.
+gemspec
+
+# Remaining group is only used for development.
+group :development do
+  gem "bundler"
+  gem "byebug"
+  gem "inspec", ">= 2.2.112" # We need InSpec for the test harness while developing.
+  gem "minitest"
+  gem "rake"
+  gem "rubocop", "= 0.49.1" # Need to keep in sync with main InSpec project, so config files will work
+end

data/README.md

@@ -0,0 +1,8 @@
+# train-vmware
+
+InSpec Train Plugin for vSphere
+
+
+gem build .\train-vmware.gemspec
+
+gem push .\train-vmware-0.1.1.gem

data/lib/train-vmware/connection.rb

@@ -0,0 +1,175 @@
+# This allow us to inherit from Train::Plugins::Transport::BaseConnection
+require "train"
+require "open3"
+require "ostruct" unless defined?(OpenStruct)
+require "json" unless defined?(JSON)
+require "mkmf"
+
+module TrainPlugins
+  module VMware
+    # You must inherit from BaseConnection.
+    class Connection < Train::Plugins::Transport::BaseConnection
+      POWERSHELL_PROMPT_REGEX = /PS\s.*> $/.freeze
+
+      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 platform
+        force_platform!("vmware", @platform_details)
+      end
+
+      def run_command_via_connection(cmd, &_data_handler)
+        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("powershell")
+          :powershell
+        elsif find_executable0("pwsh")
+          :pwsh
+        else
+          raise "Cannot find PowerShell binary, is `pwsh` installed?"
+        end
+      end
+
+      # Read from stdout pipe until prompt is received
+      def flush_stdout(pipe)
+        @stdout_buffer += pipe.read_nonblock(1) while @stdout_buffer !~ POWERSHELL_PROMPT_REGEX
+        @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-vmware/transport.rb

@@ -0,0 +1,21 @@
+require "train-vmware/connection"
+
+# Train Plugins v1 are usually declared under the TrainPlugins namespace.
+# Each plugin has three components: Transport, Connection, and (optionally) Platform.
+# We'll only define the Transport here, but we'll refer to the others.
+
+module TrainPlugins
+  module VMware
+    class VMware < Train.plugin(1)
+      name "vmware"
+      option :viserver, default: proc { ENV["VISERVER"]          }
+      option :username, default: proc { ENV["VISERVER_USERNAME"] }
+      option :password, default: proc { ENV["VISERVER_PASSWORD"] }
+      option :insecure, default: false
+
+      def connection(_ = nil)
+        @connection ||= Connection.new(@options)
+      end
+    end
+  end
+end

data/lib/train-vmware/version.rb

@@ -0,0 +1,10 @@
+# This file exists simply to record the version number of the plugin.
+# It is kept in a separate file, so that your gemspec can load it and
+# learn the current version without loading the whole plugin.  Also,
+# many CI servers can update this file when "version bumping".
+
+module TrainPlugins
+  module VMware
+    VERSION = "0.1.4".freeze
+  end
+end

data/lib/train-vmware.rb

@@ -0,0 +1,20 @@
+# This file is known as the "entry point."
+# This is the file Train will try to load if it
+# thinks your plugin is needed.
+
+# The *only* thing this file should do is setup the
+# load path, then load plugin files.
+
+# Next two lines simply add the path of the gem to the load path.
+# This is not needed when being loaded as a gem; but when doing
+# plugin development, you may need it.  Either way, it's harmless.
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+# It's traditional to keep your gem version in a separate file, so CI can find it easier.
+require_relative "train-vmware/version"
+
+# A train plugin has three components: Transport, Connection, and (optionally) Platform.
+# Transport acts as the glue.
+require_relative "train-vmware/transport"
+require_relative "train-vmware/connection"

data/train-vmware.gemspec

@@ -0,0 +1,45 @@
+# As plugins are usually packaged and distributed as a RubyGem,
+# we have to provide a .gemspec file, which controls the gembuild
+# and publish process.  This is a fairly generic gemspec.
+
+# It is traditional in a gemspec to dynamically load the current version
+# from a file in the source tree.  The next three lines make that happen.
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "train-vmware/version"
+
+Gem::Specification.new do |spec|
+  # Importantly, all Train plugins must be prefixed with `train-`
+  spec.name          = "train-vmware"
+
+  # It is polite to namespace your plugin under TrainPlugins::YourPluginInCamelCase
+  spec.version       = TrainPlugins::VMware::VERSION
+  spec.authors       = ["VMware"]
+  spec.email         = ["none@none.com"]
+  spec.summary       = "Train Plugin for VMware PowerCLI"
+  spec.description   = "Plugin version of the native VMware Transport in InSpec Train"
+  spec.homepage      = ""
+  spec.license       = "Apache-2.0"
+
+  # Though complicated-looking, this is pretty standard for a gemspec.
+  # It just filters what will actually be packaged in the gem (leaving
+  # out tests, etc)
+  spec.files = %w{
+    README.md train-vmware.gemspec Gemfile
+  } + Dir.glob(
+    "lib/**/*", File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ["lib"]
+
+  # If you rely on any other gems, list them here with any constraints.
+  # This is how `inspec plugin install` is able to manage your dependencies.
+  # For example, perhaps you are writing a thing that talks to AWS, and you
+  # want to ensure you have `aws-sdk` in a certain version.
+
+  # If you only need certain gems during development or testing, list
+  # them in Gemfile, not here.
+  # Do not list inspec as a dependency of the train plugin.
+
+  # All plugins should mention train, > 1.4
+  spec.add_dependency "train", "~> 3.8"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: train-vmware
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- VMware
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: train
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Plugin version of the native VMware Transport in InSpec Train
+email:
+- none@none.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/train-vmware.rb
+- lib/train-vmware/connection.rb
+- lib/train-vmware/transport.rb
+- lib/train-vmware/version.rb
+- train-vmware.gemspec
+homepage: ''
+licenses:
+- Apache-2.0
+metadata: {}
+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: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Train Plugin for VMware PowerCLI
+test_files: []