vmesh 0.1.3

data/.gitattributes

@@ -0,0 +1 @@
+* eol=lf

data/.gitignore

@@ -0,0 +1,7 @@
+*~
+*swp
+*idea
+*.swo
+vmesh*.gem
+vendor
+results.html

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+#gem 'rbvmomi', :git => 'https://github.com/vmware/rbvmomi.git'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    vmesh (0.1.3)
+      gli (= 2.9.0)
+      highline (~> 1.6)
+      logger (= 1.2.8)
+      nokogiri (~> 1.6)
+      rbvmomi (= 1.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.4)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.5.1)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.13)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    gli (2.9.0)
+    highline (1.6.21)
+    json (1.8.1)
+    logger (1.2.8)
+    metaclass (0.0.4)
+    mini_portile (0.6.0)
+    mocha (1.0.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.0)
+    multi_test (0.1.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    rake (10.3.1)
+    rbvmomi (1.8.2)
+      builder
+      nokogiri (>= 1.4.1)
+      trollop
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    trollop (2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (= 0.5.4)
+  mocha (= 1.0.0)
+  rake (= 10.3.1)
+  rdoc (= 4.1.1)
+  vmesh!

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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,175 @@
+# Command suite for VMWare
+
+## What is Vmesh?
+
+Vmesh is a Command Suite (think git) to make managing VMWare components easier and possible without leaving your local machine.
+
+##THIS IS ALPHA!
+
+Vmesh is currently Alpha, hence the 0-dot version; it is susceptible to methods, classes and modules being renamed, added or deleted.
+
+## Setup
+
+Install the gem
+
+```
+  gem install vmesh
+```
+
+You can now start using it, e.g. list top level dirs
+```
+  vmesh --datacenter=my.datacenter.com --host=my.vcenter.host.com ls
+```
+
+#### I don't want to type my connection config every time
+
+Vmesh can save config so you don't have to type it each time, use initconfig with an alias like so
+
+```
+  vmesh my_alias --datacenter=my.datacenter.com --host=my.vcenter.host.com initconfig
+```
+
+Commands are now as easy as
+
+```
+  vmesh my_alias ls
+```
+
+#### How to setup cloning servers
+
+Define the image types, their relevant template and any custom specs by editing the `server_defaults.rb` file
+
+```
+  lib/vmesh/server_defaults.rb 
+```
+
+e.g. an entry similar to
+```
+  :linux => {
+    :name => 'Templates/CENTOS_6',
+    :spec => 'Linux No Prompt'
+  },
+```
+
+then to create a server named `vmlinux01` cloned from `'Templates/CENTOS_6'` template using a custom spec called `Linux No Prompt`
+
+```
+  vmesh create vmlinux01 linux
+```
+
+#### AMG It complains about vtypes and stuff
+
+* There is (or at least was?) an Rbvmomi hack required for nokogiri breaking change in 1.6.1, I'm still trying to figure the best way around this...
+
+  * https://github.com/vmware/rbvmomi/pull/32
+
+
+## Usage
+
+### Help
+
+Get help
+  
+```
+  vmesh --help
+```
+
+Help on a specific command
+
+```
+  vmesh create --help
+```
+
+### Create or clone
+
+###### IP Handling
+For multiple servers vmesh automatically increments the IP Address, e.g.
+```
+  vmesh create vmweb01,vmweb02 linux --ip_address='192.168.0.10'
+```
+will create the following servers
+|| server name || ip ||
+| vmweb01 | 192.168.0.10 |
+| vmweb02 | 192.168.0.11 |
+
+Of course you can just comma separate the IPs too
+```
+  vmesh create vmweb01,vmweb02 linux --ip_address='192.168.0.10','192.168.0.11'
+```
+
+###### How vmesh deals with datastores
+When specifying datastore vmesh will use a datastore matching name exactly, if it doesn't find a match it will gets all datastores with this string in their name then uses the one with the most free space.
+
+```
+  vmesh create my_vm_name2 windows12 [--ip_address='<ip_address>'] --datastore='SEARCH_STRING' [--folder='DESTINATION_FOLDER']
+```
+e.g. for the above, if datastores exist with names FIRST_SEARCH_STRING, ANOTHER_SEARCH_STRING it will find both (as they both contain "SEARCH_STRING") then use the one with the most free space.
+
+### Power
+
+To change the power state of a VM
+
+```
+  vmesh power 'folder/machine_name' on
+```
+
+```
+  vmesh power 'folder/machine_name' off
+```
+
+##### Deleting a VM can be done with the command
+
+```
+  vmesh power 'folder/machine_name' destroy
+```
+
+### List
+
+_Note_ you can use `ls`, `dir` or `list`
+
+List vms and directories at the top level
+
+```
+  vmesh ls
+```
+
+List recursively
+
+```
+  vmesh ls -r
+```
+
+List directories only
+
+```
+  vmesh ls -d
+```
+
+## TODOs
+
+* Sort out problem with upstream rbvmomi/nogokiri
+
+  * Related bug here https://github.com/nsidc/vagrant-vsphere/issues/28
+
+* Create
+
+  * Don't create new vm if less than 10% space
+
+* Power
+  
+  * Query & display state after operation completes
+
+* General
+
+  * Performance enhancements would be nice
+
+  * Server defaults in external configuration, e.g. Symlink to config/shared/ or etcd
+
+* Vmesh everything else :-)
+
+
+## Copyright
+
+Copyright (c) 2014 Kurt Gardiner. See LICENSE.txt for further details.
+
+

data/README.rdoc

@@ -0,0 +1,6 @@
+= vmesh
+
+Describe your project here
+
+:include:vmesh.rdoc
+

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('vmesh.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/bin/vmesh

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+require 'gli'
+begin # XXX: Remove this begin/rescue before distributing your app
+require 'vmesh'
+require 'logger'
+require 'highline/import'
+
+rescue LoadError
+  STDERR.puts "In development, you need to use `bundle exec bin/vmesh` to run your app"
+  STDERR.puts "At install-time, RubyGems will make sure lib, etc. are in the load path"
+  STDERR.puts "Feel free to remove this message from bin/vmesh now"
+  exit 64
+end
+
+include GLI::App
+
+version Vmesh::VERSION
+Vmesh.logger = Logger.new(STDOUT)
+@logger = Vmesh.logger
+
+
+config_filename = '.vmesh.rc'
+
+def check_migrate
+  Dir.glob(File.join(File.expand_path(ENV['HOME']),'.mesh.*.rc')).each do |mesh_file|
+    new_name = mesh_file.gsub('.mesh','.vmesh')
+    Vmesh.logger.info "Migrating #{mesh_file} from #{File.basename(mesh_file)} to #{new_name}"
+    File.rename mesh_file, new_name
+  end
+end
+
+check_migrate
+
+if ARGV.count >= 2
+  host_alias = ARGV[0]
+  init_config = (ARGV.last == 'initconfig')
+  if init_config or File.exist? File.join(File.expand_path(ENV['HOME']),".vmesh.#{host_alias}.rc")
+    config_filename = ".vmesh.#{host_alias}.rc"
+    Vmesh.logger.info "Using host specific config file ~/.vmesh.#{host_alias}.rc"
+    ARGV.shift
+  else
+    Vmesh.logger.info "No site specific config file found, using default ~/#{config_filename}."
+  end
+end
+
+config_file config_filename
+
+program_desc 'VMWare VSphere command suite interface'
+program_long_desc 'A command suite to allow users to manage VMWare virtual machines remotely via the command line'
+
+desc 'Ignore SSL Certificate errors in connection'
+switch [:insecure]
+
+desc 'VCenter username'
+arg_name 'user'
+flag [:u,:user]
+
+desc 'VCenter password'
+arg_name 'password'
+flag [:p,:password]
+
+desc 'VCenter host'
+arg_name 'vcenter host'
+flag [:h,:host]
+
+desc 'Datacenter'
+arg_name 'datacenter'
+flag [:d,:datacenter]
+
+desc 'VCenter Resource Pool'
+arg_name 'vcenter resource pool'
+flag [:r,:resource_pool]
+
+commands_from 'vmesh/commands'
+
+desc 'TODO Describe destroy here'
+arg_name 'Describe arguments to destroy here'
+command :destroy do |c|
+  c.action do |global_options,options,args|
+    puts "destroy command ran"
+  end
+end
+
+desc 'TODO Describe run here'
+arg_name 'Describe arguments to run here'
+command :run do |c|
+  c.action do |global_options,options,args|
+    puts "run command ran"
+  end
+end
+
+desc 'TODO Describe info here'
+arg_name 'Describe arguments to info here'
+command :info do |c|
+  c.action do |global_options,options,args|
+    puts "info command ran"
+  end
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  if global[:user].to_s == ''
+    not_so_secret_username = ask("Enter Username please:") {|q| q.echo = true}
+    global['u'] = global[:u] = global['user'] = global[:user] = not_so_secret_username
+  end
+
+  if global[:password].to_s == ''
+    the_super_secret_password = ask("Enter Password for #{global[:user]} please:") {|q| q.echo = false}
+    global['p'] = global[:p] = global['password'] = global[:password] = the_super_secret_password
+  end
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/features/step_definitions/vmesh.create_steps.rb

@@ -0,0 +1,9 @@
+=begin
+When /^I create with no arguments$/ do 
+  step %(I run `vmesh create`)
+end
+=end
+
+When /^I create with "([^"]*)" template and name "([^"]*)"$/ do |type, name|
+  step %(I run `vmesh -u user -p fakepass create #{name} #{type}`)
+end

data/features/step_definitions/vmesh.power_steps.rb

@@ -0,0 +1,3 @@
+When /^I power machine "([^"]*)" into state "([^"]*)"$/ do |machine, desired_state|
+  step %(I run `vmesh -u user -p secret power #{machine} #{desired_state}`)
+end

data/features/step_definitions/vmesh_steps.rb

@@ -0,0 +1,9 @@
+When /^I (.*) with no arguments$/ do |command|
+  step %(I run `vmesh -u user -p fake #{command}`)
+end
+
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} --help`)
+end
+

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/features/vmesh.create.feature

@@ -0,0 +1,14 @@
+Feature: Create a new VM
+  In order to provision new infrastructure
+  I want to be able to create new templated VMs
+  So I have consistent easily created VMs
+
+  Scenario: Create with no arguments
+    When I create with no arguments
+    Then the exit status should be 1
+
+  Scenario: Create with unknown vm type
+    When I create with "unknown" template and name "anything"
+    Then the exit status should be 1
+     And the stderr should contain "unknown machine type"
+

data/features/vmesh.feature

@@ -0,0 +1,18 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: vmesh just runs
+    When I get help for "vmesh"
+    Then the exit status should be 0
+
+
+  Scenario: vmesh create just runs
+    When I get help for "vmesh create"
+    Then the exit status should be 0
+
+  Scenario: vmesh power just runs
+    When I get help for "vmesh power"
+    Then the exit status should be 0
+

data/features/vmesh.power.feature

@@ -0,0 +1,12 @@
+Feature: Change Power State of a VM
+  In order to manage servers
+  I want to be able to change the power state of VMs
+  So I can easily manage these servers
+
+  Scenario: Power with no arguments
+    When I power with no arguments
+    Then the exit status should be 1
+
+  Scenario: Power vm into an unknown state
+    When I power machine "vmfrozen01" into state "unfrozed"
+    Then the exit status should be 1

data/lib/vmesh/commands/create.rb

@@ -0,0 +1,65 @@
+require 'ipaddr'
+
+desc 'create a new virtual machine'
+arg_name 'folder/name[,folder/name_of_second_machine] type'
+
+command :create do |c|
+  c.desc 'Destination datastore, full or partial match'
+  c.long_desc 'Destination datastore, full or partial match, partial match will use datastore including the string with the greatest free space'
+  c.flag [:s, :datastore]
+
+  c.desc 'Destination folder where not supplied with name'
+  c.long_desc 'Destination folder for the vm(s), will be ignored for any vms with a folder supplied as part of the name'
+  c.flag [:f, :folder]
+
+# This wasn't working for what-ever reason, no error, just no effect
+  #c.desc 'Number of CPUs'
+  #c.long_desc 'Number of CPUs'
+  #c.flag [:c, :cpus]
+#
+  #c.desc 'MB of RAM'
+  #c.long_desc 'MB of RAM'
+  #c.flag [:r, :ramMB]
+
+  c.desc 'Destination Machine IP Address'
+  c.long_desc 'Destination machine IP Address, when creating multiple vms ips will be calculated by incrementing this value'
+  c.flag :ip_address
+  c.action do |global_options,options,args|
+
+    ARGV.size >= 2 or abort "must specify VM target name and VM type"
+    vm_targets = ARGV.shift
+    vm_type = ARGV.shift
+    @logger.debug "Create invoked to create #{vm_targets} of type #{vm_type}\n\t#{global_options[:host]}\n\t#{options}\n\t#{args}."
+    Vmesh::template.has_key? vm_type.to_sym or raise "unknown machine type #{vm_type}, known types are #{Vmesh::template.keys.to_s}"
+
+    ip_address = options[:ip_address]
+    machine_options = {}
+    vm_manager = Vmesh::VSphere.new global_options
+    #default_vm_folder = vm_manager.get_folder(options[:folder]) if options[:folder]
+    default_vm_folder = options[:folder] || '/'
+    vm_targets.split(',').each do |vm_target|
+      machine_options[:ip_address] = ip_address if ip_address.to_s != ''
+      machine_options[:datastore] = options[:datastore] if options[:datastore].to_s != ''
+      machine_options[:memoryMB] = options[:ramMB] if options[:ramMB].to_s != ''
+      machine_options[:numCPUs] = options[:cpus] if options[:cpus].to_s != ''
+      new_vm = vm_manager.clone_machine(vm_type, vm_target, default_vm_folder, machine_options)
+      Vmesh.logger.info "#{vm_type}, #{vm_target}, #{machine_options}"
+      ip_address = IPAddr.new(ip_address).succ.to_s if ip_address.to_s != ''
+      Vmesh.logger.warn "Check #{vm_target}, nil vm returned..." if new_vm.nil?
+    end
+  end
+end
+
+module Vmesh
+  def self.parse_vm_target(vm_target)
+    vm_details = vm_target.match(/(.+)\/(.+)/)
+    vm = Hash.new
+    vm[:folder] = '/'
+    vm[:name]   = vm_target
+    if vm_details
+      vm[:folder] = vm_details[1]
+      vm[:name]   = vm_details[2]
+    end
+    vm
+  end
+end

data/lib/vmesh/commands/create_helpers.rb

@@ -0,0 +1,6 @@
+module CreateHelpers
+  def self.parse_vm_target (input_string)
+    puts "input_string"
+  end
+end
+

data/lib/vmesh/commands/list.rb

@@ -0,0 +1,39 @@
+
+desc 'list directory contents'
+arg_name '[dir]'
+
+command [:list,:ls,:dir] do |c|
+  c.desc 'list directory entries instead of contents, and do not dereference symbolic links'
+  c.switch [:d, :directory]
+
+  c.desc 'list recursively'
+  c.switch [:r, :recursive]
+
+  c.action do |global_options,options,args|
+    pwd = ARGV.shift if ARGV.any?
+    vm_manager = Vmesh::VSphere.new global_options
+    show_directories_only = options[:directory]
+    folder = pwd.nil? ? vm_manager.vm_root_folder : vm_manager.get_folder(pwd)
+    raise "Folder #{pwd} not found, exiting" if folder.to_s == ''
+    Vmesh::logger.debug "Searching folder #{folder.name}."
+    Vmesh::list_under folder,show_directories_only,options[:recursive],"/#{folder.name}"
+  end
+end
+
+module Vmesh
+  def self.list_under(folder, show_directories_only, recurse = false, currently_in = '')
+     currently_in = '' if currently_in == '/vm'
+     folder.childEntity.each do |x|
+        name = x.to_s.split('(').first
+        case name
+        when "Folder"
+          puts "#{currently_in}/#{x.name}/" #if show_directories_only
+          list_under(x, show_directories_only, recurse, "#{currently_in}/#{x.name}" ) if recurse
+        when "VirtualMachine"
+          puts "#{currently_in}/#{x.name}" unless show_directories_only
+        else
+           puts "# Unrecognized Entity " + x.to_s
+        end
+     end
+  end
+end

data/lib/vmesh/commands/power.rb

@@ -0,0 +1,19 @@
+
+desc 'change the power state of the vm'
+arg_name 'vm_name [on|off|reset|suspend|destroy]'
+
+command :power do |c|
+  c.action do |global_options,options,args|
+    ARGV.size >= 2 or abort "must specify VM and a desired state."
+    vm_target = ARGV.shift
+    desired_state = ARGV.shift
+    abort "Invalid desired state #{desired_state}, valid ones are #{Vmesh::Machine::valid_states}." unless Vmesh::Machine::valid_states.include? desired_state 
+    @logger.debug "Power invoked for #{vm_target} with desired state #{desired_state}\n\t#{global_options[:host]}\n\t#{options}\n\t#{args}."
+
+    vm_manager = Vmesh::VSphere.new global_options
+    vm = vm_manager.get_machine(vm_target, global_options[:datacenter])
+    Vmesh::logger.debug "Got vm #{vm.name}"
+
+    vm.power desired_state
+  end
+end