vagrant-vboxmanage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 280d1189e39b23d3de749116bee0608f1e6f6801
+  data.tar.gz: a7710f25c1ec28ada03ca58b410e6c6e1342d90f
+SHA512:
+  metadata.gz: 76946d07a235e897e57f37da811872644fef57bf89dc015fdc1077e06f19e4174dafc97f6387f5712fd8a9eb974a946c213e14ab8328eea8aa337aa5b1254478
+  data.tar.gz: ba409ad56b3fe1189417f68a2929d13119467701178ca6dd02861da3f9929f5dd069829ce1ed324759a0aaf02ce825317467a29c9acefb4dbde340439d3942fc

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [0.0.1](https://github.com/dergachev/vagrant-vbox-snapshot/compare/v0.0.0...v0.0.1) (Sep 23, 2013)
+
+BACKWARDS INCOMPATIBILITIES:
+
+  - none
+
+FEATURES:
+
+  - Initial commit
+
+IMPROVEMENTS:
+
+  - none

data/DEVNOTES.md

@@ -0,0 +1,18 @@
+# Developer notes for vagrant-vboxmanage
+
+See docs in https://github.com/dergachev/vagrant-vbox-snapshot/blob/master/DEVNOTES.md
+
+## Resources 
+
+Testing is a big TODO:
+
+* https://github.com/mitchellh/vagrant/blob/master/test/acceptance/ssh_test.rb
+
+VBoxManage info:
+
+* http://www.virtualbox.org/manual/ch08.html
+
+Other Vagrant command examples:
+
+* https://github.com/mitchellh/vagrant/blob/master/plugins/providers/virtualbox/driver/version_4_1.rb
+* https://github.com/mitchellh/vagrant/blob/master/plugins/commands/ssh/command.rb

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-snap.gemspec
+gemspec
+
+gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"

data/README.md

@@ -0,0 +1,58 @@
+vagrant-vboxmanage
+==================================
+Vagrant plugin that simplifies calling `VBoxManage cmd UUID`
+
+## Usage
+
+The following commands are added by this plugin:
+
+     vagrant vboxmanage [vm-name] [--] <subcommand> [args]
+
+Where:
+
+* `<subcommand>` is the VBoxManage subcommand, eg `showvminfo` 
+  * See http://www.virtualbox.org/manual/ch08.html
+* `[vm-name]` is the VM name; must be specified if multiple VMs are defined in Vagrantfile
+
+For all commands except those listed in `SPECIAL_COMMANDS.md`, the VM uuid will be inserted
+immediately after the command name. For example:
+
+    # calls `VBoxManage showvminfo a0b76635-3c88-45ea-b26e-e9f442dc1f6e`
+    vagrant vboxmanage showvminfo --details    
+
+## Caveats
+
+* Only minimally tested.
+* TODO: support for UUID substitution for irregular commands like `guestproperty`.
+* TODO: show VBoxManage-like usage help.
+
+## Installation
+
+Ensure you have Vagrant 1.1+ installed, then run:
+
+    vagrant plugin install vagrant-vboxmanage
+
+## Development
+
+To develop on this plugin, do the following:
+
+```
+# get the repo, and then make a feature branch (REPLACE WITH YOUR FORK)
+git clone https://github.com/dergachev/vagrant-vboxmanage.git
+cd vagrant-vboxmanage
+git checkout -b MY-NEW-FEATURE
+
+# installs the vagrant gem, which is a dev dependency
+bundle install 
+
+# hack on the plugin
+vim lib/vagrant-vboxmanage.rb # or any other file
+
+# test out your changes, in the context provided by the development vagrant gem, and the local Vagrantfile.
+bundle exec vagrant snapshot ...
+
+# commit, push, and do a pull-request
+```
+
+See [DEVNOTES.md](https://github.com/dergachev/vagrant-vboxmanage/blob/master/DEVNOTES.md)
+for the notes I compiled while developing this plugin.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'  
+Bundler::GemHelper.install_tasks 

data/SPECIAL_COMMANDS.md

@@ -0,0 +1,170 @@
+  list [--long|-l]          vms|runningvms|ostypes|hostdvds|hostfloppies|
+                            bridgedifs|hostonlyifs|dhcpservers|hostinfo|
+                            hostcpuids|hddbackends|hdds|dvds|floppies|
+                            usbhost|usbfilters|systemproperties|extpacks|
+                            groups
+
+  registervm                <filename>
+
+  createvm                  --name <name>
+                            [--groups <group>, ...]
+                            [--ostype <ostype>]
+                            [--register]
+                            [--basefolder <path>]
+                            [--uuid <uuid>]
+
+  import                    <ovf/ova>
+                            [--dry-run|-n]
+                            [--options keepallmacs|keepnatmacs]
+                            [more options]
+                            (run with -n to have options displayed
+                             for a particular OVF)
+
+  export                    <machines> --output|-o <name>.<ovf/ova>
+                            [--legacy09|--ovf09|--ovf10|--ovf20]
+                            [--manifest]
+                            [--vsys <number of virtual system>]
+                                    [--product <product name>]
+                                    [--producturl <product url>]
+                                    [--vendor <vendor name>]
+                                    [--vendorurl <vendor url>]
+                                    [--version <version info>]
+                                    [--eula <license text>]
+                                    [--eulafile <filename>]
+
+  closemedium               disk|dvd|floppy <uuid>|<filename>
+                            [--delete]
+
+  createhd                  --filename <filename>
+                            [--size <megabytes>|--sizebyte <bytes>]
+                            [--diffparent <uuid>|<filename>
+                            [--format VDI|VMDK|VHD] (default: VDI)
+                            [--variant Standard,Fixed,Split2G,Stream,ESX]
+  clonehd                   <uuid>|<filename> <uuid>|<outputfile>
+                            [--format VDI|VMDK|VHD|RAW|<other>]
+                            [--variant Standard,Fixed,Split2G,Stream,ESX]
+                            [--existing]
+
+  convertfromraw            <filename> <outputfile>
+                            [--format VDI|VMDK|VHD]
+                            [--variant Standard,Fixed,Split2G,Stream,ESX]
+                            [--uuid <uuid>]
+  convertfromraw            stdin <outputfile> <bytes>
+                            [--format VDI|VMDK|VHD]
+                            [--variant Standard,Fixed,Split2G,Stream,ESX]
+                            [--uuid <uuid>]
+
+  getextradata              global|<uuid>|<name>
+                            <key>|enumerate
+
+  setextradata              global|<uuid>|<name>
+                            <key>
+                            [<value>] (no value deletes key)
+
+  setproperty               machinefolder default|<folder> |
+                            vrdeauthlibrary default|<library> |
+                            websrvauthlibrary default|null|<library> |
+                            vrdeextpack null|<library> |
+                            autostartdbpath null|<folder> |
+                            loghistorycount <value>
+
+  usbfilter                 add <index,0-N>
+                            --target <uuid>|<name>|global
+                            --name <string>
+                            --action ignore|hold (global filters only)
+                            [--active yes|no] (yes)
+                            [--vendorid <XXXX>] (null)
+                            [--productid <XXXX>] (null)
+                            [--revision <IIFF>] (null)
+                            [--manufacturer <string>] (null)
+                            [--product <string>] (null)
+                            [--remote yes|no] (null, VM filters only)
+                            [--serialnumber <string>] (null)
+                            [--maskedinterfaces <XXXXXXXX>]
+
+  usbfilter                 modify <index,0-N>
+                            --target <uuid>|<name>|global
+                            [--name <string>]
+                            [--action ignore|hold] (global filters only)
+                            [--active yes|no]
+                            [--vendorid <XXXX>|""]
+                            [--productid <XXXX>|""]
+                            [--revision <IIFF>|""]
+                            [--manufacturer <string>|""]
+                            [--product <string>|""]
+                            [--remote yes|no] (null, VM filters only)
+                            [--serialnumber <string>|""]
+                            [--maskedinterfaces <XXXXXXXX>]
+
+  usbfilter                 remove <index,0-N>
+                            --target <uuid>|<name>|global
+
+  sharedfolder              add <vmname>|<uuid>
+                            --name <name> --hostpath <hostpath>
+                            [--transient] [--readonly] [--automount]
+
+  sharedfolder              remove <vmname>|<uuid>
+                            --name <name> [--transient]
+
+  guestproperty             get <vmname>|<uuid>
+                            <property> [--verbose]
+
+  guestproperty             set <vmname>|<uuid>
+                            <property> [<value> [--flags <flags>]]
+
+  guestproperty             enumerate <vmname>|<uuid>
+                            [--patterns <patterns>]
+
+  guestproperty             wait <vmname>|<uuid> <patterns>
+                            [--timeout <msec>] [--fail-on-timeout]
+
+  metrics                   list [*|host|<vmname> [<metric_list>]]
+                                                 (comma-separated)
+
+  metrics                   setup
+                            [--period <seconds>] (default: 1)
+                            [--samples <count>] (default: 1)
+                            [--list]
+                            [*|host|<vmname> [<metric_list>]]
+
+  metrics                   query [*|host|<vmname> [<metric_list>]]
+
+  metrics                   enable
+                            [--list]
+                            [*|host|<vmname> [<metric_list>]]
+
+  metrics                   disable
+                            [--list]
+                            [*|host|<vmname> [<metric_list>]]
+
+  metrics                   collect
+                            [--period <seconds>] (default: 1)
+                            [--samples <count>] (default: 1)
+                            [--list]
+                            [--detach]
+                            [*|host|<vmname> [<metric_list>]]
+
+  hostonlyif                ipconfig <name>
+                            [--dhcp |
+                            --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |
+                            --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]
+                            create |
+                            remove <name>
+
+  dhcpserver                add|modify --netname <network_name> |
+                                       --ifname <hostonly_if_name>
+                            [--ip <ip_address>
+                            --netmask <network_mask>
+                            --lowerip <lower_ip>
+                            --upperip <upper_ip>]
+                            [--enable | --disable]
+
+  dhcpserver                remove --netname <network_name> |
+                                   --ifname <hostonly_if_name>
+
+  extpack                   install [--replace] <tarball> |
+                            uninstall [--force] <name> |
+                            cleanup
+
+
+

data/Vagrantfile

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require_relative 'lib/vagrant-vboxmanage.rb'
+
+Vagrant.configure("2") do |config|
+
+  TEST_MULTI_VM = false
+  TEST_SHARED_FOLDERS = false
+
+  if TEST_MULTI_VM
+    config.vm.define :web do |web|
+      web.vm.box = "precise64"
+    end
+    config.vm.define :db do |web|
+      web.vm.box = "precise64"
+    end
+  else
+    config.vm.box = "precise64"
+    config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+  end
+
+  if TEST_SHARED_FOLDERS
+    config.vm.synced_folder "/tmp", "/tmp/host-tmp"
+    config.vm.synced_folder "/tmp", "/tmp/host-tmp2"
+  end
+end

data/lib/vagrant-vboxmanage.rb

@@ -0,0 +1,2 @@
+require_relative 'vagrant-vboxmanage/version.rb'
+require_relative 'vagrant-vboxmanage/plugin.rb'

data/lib/vagrant-vboxmanage/commands/root.rb

@@ -0,0 +1,82 @@
+module VagrantPlugins
+  module VBoxManage
+    module Command
+      class Root < Vagrant.plugin(2, :command)
+        
+        def execute
+          options = {}
+
+          opts = OptionParser.new do |opts|
+            opts.banner = "Usage: vagrant vboxmanage [vm-name] [--] <vboxmanage-cmd> [UUID] [cmd-args]..."
+          end
+
+          if split_index = @argv.index('--')
+            # of form `vagrant vboxmanage [vm-name] -- showvminfo ...`
+            options[:command] = @argv[split_index + 1]
+            options[:extra_args] = @argv.drop(split_index + 2) 
+            @argv = @argv.take(split_index)
+          elsif command_index = @argv.index { |x| vboxmanage_commands_all.include?(x)}
+            # of form `vagrant vboxmanage [vm-name] showvminfo...`
+            options[:command] = @argv[command_index]
+            options[:extra_args] = @argv.drop(command_index + 1)
+            @argv = @argv.take(command_index)
+          else
+            @env.ui.error opts
+            @env.ui.error "No valid VBoxManage subcommand detected."
+            return 1
+          end
+
+          @logger.debug "Parsing options:" + options.merge({"argv" => @argv}).to_yaml
+
+          argv = parse_options(opts)
+          return if argv.length > 1
+
+          with_target_vms(argv, single_target: true) do |machine|
+            if machine.state.id == :not_created
+              machine.env.ui.error("Target machine is not created, unable to run VBoxManage.")
+            end
+
+            if vboxmanage_commands_standard.include?(options[:command])
+              @logger.debug("Performing UUID insertion for standard vboxmanage command: #{options[:command]}")
+              args = [options[:command], machine.id] + options[:extra_args]
+            else
+              @logger.debug("Skipping UUID insertion for special vboxmanage command: #{options[:command]}")
+              # TODO: handle substitution for commands like `usbfilter add 0 --target <uuid|name>`
+              # [VM_UUID] is an optiona literal token `VM_UUID`, which will be replaced by the UUID of the VM referenced by Vagrant
+              args = [options[:command]] + options[:extra_args]
+            end
+
+            @logger.debug("Executing: VBoxManage " + args.join(" "))
+            machine.provider.driver.execute(*args) do |type, data|
+              colors = { :stdout => :green, :stderr => :red }
+              machine.env.ui.info(data, :color => colors[type])
+            end
+          end
+        end
+
+        def vboxmanage_commands_all 
+          # derived as follows: `VBoxManage | sed '1,/Commands/d' | grep '^  [a-z]' | awk '{ print $1; }' | sort -u`
+          return %w{adoptstate bandwidthctl clonehd clonevm closemedium controlvm convertfromraw
+            createhd createvm debugvm dhcpserver discardstate export extpack
+            getextradata guestcontrol guestproperty hostonlyif import list
+            metrics modifyhd modifyvm registervm setextradata setproperty
+            sharedfolder showhdinfo showvminfo snapshot startvm storageattach
+            storagectl unregistervm usbfilter}
+        end
+
+        # not of form `VBoxManage showvminfo uuid|name ...`
+        def vboxmanage_commands_special
+          #   derived by manual inspection of `VBoxManage`; see SPECIAL_COMMANDS.md
+          return %w{list registervm createvm import export closemedium createhd clonehd
+            convertfromraw getextradata setextradata setproperty usbfilter
+            sharedfolder guestproperty metrics hostonlyif dhcpserver extpack}
+        end
+
+        # of form `VBoxManage showvminfo uuid|name ...`
+        def vboxmanage_commands_standard
+          return vboxmanage_commands_all - vboxmanage_commands_special
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vboxmanage/plugin.rb

@@ -0,0 +1,20 @@
+begin
+    require "vagrant"
+rescue LoadError
+    raise "The vagrant-vboxmanage plugin must be run within Vagrant."
+end
+
+module VagrantPlugins
+  module VBoxManage
+    class Plugin < Vagrant.plugin("2")
+      name "vagrant-vboxmanage"
+      description "Simplifies calling the `VBoxManage` command."
+
+      command "vboxmanage" do
+        require_relative 'commands/root.rb'
+        Command::Root
+      end
+
+    end
+  end
+end

data/lib/vagrant-vboxmanage/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module VBoxManage
+    VERSION = "0.0.1"
+  end
+end

data/vagrant-vboxmanage.gemspec

@@ -0,0 +1,20 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'vagrant-vboxmanage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-vboxmanage"
+  spec.version       = VagrantPlugins::VBoxManage::VERSION
+  spec.authors       = "Alex Dergachev"
+  spec.email         = "alex@evolvingweb.ca"
+  spec.summary       = 'Vagrant plugin that simplifies calling the `VBoxManage` command.'
+  spec.homepage      = 'https://github.com/dergachev/vagrant-vboxmanage'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path  = 'lib'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-vboxmanage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Dergachev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: alex@evolvingweb.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- DEVNOTES.md
+- Gemfile
+- README.md
+- Rakefile
+- SPECIAL_COMMANDS.md
+- Vagrantfile
+- lib/vagrant-vboxmanage.rb
+- lib/vagrant-vboxmanage/commands/root.rb
+- lib/vagrant-vboxmanage/plugin.rb
+- lib/vagrant-vboxmanage/version.rb
+- vagrant-vboxmanage.gemspec
+homepage: https://github.com/dergachev/vagrant-vboxmanage
+licenses:
+- MIT
+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.3
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin that simplifies calling the `VBoxManage` command.
+test_files: []