rbvmomi_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35b56f3ecbf77d888c2550ef41029bcc003a9785
+  data.tar.gz: 9e2e9bd5ffb14ce70e1e6b6c8344250337e62795
+SHA512:
+  metadata.gz: e05a40b561dd990093b5749da750841355ef7e1a693b35e23752b6ba15e8aa31831f89cb200f44a78f80850c4ecd551594aa8b72f07c76398dfc2723ad341398
+  data.tar.gz: 08ff6509a24d0d3a8a386a037768703338dd0c02934a3d38edd2a4bb699f4445d5bcda4364ff095de07790c9fa2fceb3faa6469d045d1cd90b62053b5ccbac2b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rbvmomi_helper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Deric Crago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# RbVmomiHelper
+
+[![Build Status](https://travis-ci.org/dericcrago/rbvmomi_helper.svg?branch=master)](https://travis-ci.org/dericcrago/rbvmomi_helper)
+[![codecov.io](https://codecov.io/github/dericcrago/rbvmomi_helper/coverage.svg?branch=master)](https://codecov.io/github/dericcrago/rbvmomi_helper?branch=master)
+
+A set of helper methods for [RbVmomi](https://github.com/vmware/rbvmomi).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbvmomi_helper'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install rbvmomi_helper
+```
+
+## Usage
+
+```ruby
+require 'rbvmomi_helper'
+
+# Find a vm like you normally would using RbVmomi
+# Then use the helper methods
+vm.configure_auth('root', 'password')
+vm.put_file('sleep.sh', '/tmp/sleep.sh')
+vm.start_program('/bin/bash', '/tmp/sleep.sh')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dericcrago/rbvmomi_helper.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rbvmomi_helper'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rbvmomi_helper.rb

@@ -0,0 +1,5 @@
+require 'rbvmomi'
+require 'rbvmomi_helper/version'
+require 'rbvmomi_helper/virtual_machine'
+
+RbVmomi::VIM::VirtualMachine.send(:include, RbVmomiHelper::VirtualMachine)

data/lib/rbvmomi_helper/version.rb

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

data/lib/rbvmomi_helper/virtual_machine.rb

@@ -0,0 +1,158 @@
+require 'rbvmomi'
+
+module RbVmomiHelper
+  # VirtualMachine Class
+  module VirtualMachine
+    def initialize(connection, ref)
+      super(connection, ref)
+      @gom = @connection.serviceContent.guestOperationsManager
+    end
+
+    def configure_auth(username, password, interactiveSession = false)
+      @auth = RbVmomi::VIM::NamePasswordAuthentication(
+        username: username,
+        password: password,
+        interactiveSession: interactiveSession
+      )
+    end
+
+    def create_temporary_file(prefix, suffix)
+      raise "please 'configure_auth' first" unless @auth
+
+      @gom.fileManager.CreateTemporaryFileInGuest(
+        vm: self,
+        auth: @auth,
+        prefix: prefix,
+        suffix: suffix
+      )
+    end
+
+    def delete_file(file_path)
+      raise "please 'configure_auth' first" unless @auth
+
+      @gom.fileManager.DeleteFileInGuest(
+        vm: self,
+        auth: @auth,
+        filePath: file_path
+      )
+    end
+
+    def list_processes(pids = [])
+      @gom.processManager.ListProcessesInGuest(
+        vm: self,
+        auth: @auth,
+        pids: [*pids]
+      )
+    end
+
+    def start_program(program_path, arguments = '',
+                      working_directory = nil, env_variables = nil)
+      raise "please 'configure_guest_auth' first" unless @auth
+
+      program_spec = RbVmomi::VIM::GuestProgramSpec(
+        programPath: program_path,
+        arguments: arguments,
+        workingDirectory: working_directory,
+        envVariables: env_variables
+      )
+
+      @gom.processManager.StartProgramInGuest(
+        vm: self,
+        auth: @auth,
+        spec: program_spec
+      )
+    end
+
+    def put_file(source, destination = nil, overwrite = true)
+      destination = get_destination_path(source, destination)
+      url = initiate_file_transfer_to(source, destination, overwrite)
+      uri = URI.parse(url)
+
+      http = setup_http(uri)
+      request = setup_put_request(uri, source)
+
+      response = http.request(request)
+      process_response(response) ? destination : response
+    end
+
+    def validate_credentials
+      raise "please 'configure_guest_auth' first" unless @auth
+
+      @gom.authManager.ValidateCredentialsInGuest(
+        vm: self,
+        auth: @auth
+      )
+    end
+
+    private
+
+    def get_destination_path(source, destination)
+      destination ? get_file_path(destination) : get_file_path(source)
+    end
+
+    def get_file_path(file_path)
+      # return file_path if file_path is absolute
+      # aka, starts with '/' or 'SOME_LETTER:'
+      return file_path if file_path =~ %r{\A(/|[a-zA-Z]:)}
+      suffix = File.extname(file_path)
+      prefix = File.basename(file_path, suffix) + '_'
+      create_temporary_file(prefix, suffix)
+    end
+
+    def file_attributes
+      case guest.guestFamily
+      when 'linuxGuest'
+        RbVmomi::VIM::GuestPosixFileAttributes()
+      when 'windowsGuest'
+        RbVmomi::VIM::GuestWindowsFileAttributes()
+      else
+        raise 'unrecognized guestFamily'
+      end
+    end
+
+    def initiate_file_transfer_to(source, destination, overwrite)
+      raise "please 'configure_guest_auth' first" unless @auth
+
+      @gom.fileManager.InitiateFileTransferToGuest(
+        vm: self,
+        auth: @auth,
+        guestFilePath: destination,
+        fileAttributes: file_attributes,
+        fileSize: File.size(source),
+        overwrite: overwrite
+      )
+    end
+
+    def setup_http(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      configure_https(http) if uri.scheme == 'https'
+
+      http
+    end
+
+    def configure_https(http)
+      opts = @connection.instance_variable_get('@opts')
+
+      http.use_ssl = true
+      http.verify_mode =
+        if opts.fetch(:insecure, false)
+          OpenSSL::SSL::VERIFY_NONE
+        else
+          OpenSSL::SSL::VERIFY_PEER
+        end
+    end
+
+    def setup_put_request(uri, source)
+      request = Net::HTTP::Put.new(uri.request_uri)
+      request.body_stream = File.open(source)
+      request['Content-Type'] = 'multipart/form-data'
+      request.add_field('Content-Length', File.size(source))
+
+      request
+    end
+
+    def process_response(response)
+      response.code == '200'
+    end
+  end
+end

data/rbvmomi_helper.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rbvmomi_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rbvmomi_helper'
+  spec.version       = RbVmomiHelper::VERSION
+  spec.authors       = ['Deric Crago']
+  spec.email         = ['deric.crago@gmail.com']
+
+  spec.summary = 'A set of helper methods for RbVmomi.'
+  spec.homepage = 'https://github.com/dericcrago/rbvmomi_helper'
+
+  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_development_dependency('bundler', '~> 1.11')
+  spec.add_development_dependency('rake', '~> 10.0')
+  spec.add_development_dependency('rspec', '~> 3.0')
+
+  # Added
+  spec.add_dependency('rbvmomi')
+  spec.add_development_dependency('vcr')
+  spec.add_development_dependency('webmock')
+  spec.add_development_dependency('rubocop', '~> 0.37')
+  spec.add_development_dependency('rubocop-checkstyle_formatter')
+  spec.add_development_dependency('simplecov')
+  spec.add_development_dependency('simplecov-json')
+  spec.add_development_dependency('simplecov-rcov')
+  spec.add_development_dependency('codecov')
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: rbvmomi_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deric Crago
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rbvmomi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: rubocop-checkstyle_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- deric.crago@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rbvmomi_helper.rb
+- lib/rbvmomi_helper/version.rb
+- lib/rbvmomi_helper/virtual_machine.rb
+- rbvmomi_helper.gemspec
+homepage: https://github.com/dericcrago/rbvmomi_helper
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: A set of helper methods for RbVmomi.
+test_files: []