virtualbox-guestcontrol 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Eberbach
+
+MIT License
+
+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,29 @@
+# Virtualbox::Guestcontrol
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'virtualbox-guestcontrol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virtualbox-guestcontrol
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/rvbox

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+require File.expand_path("../../lib/virtualbox-guestcontrol.rb", __FILE__)
+
+class VirtualBoxCommand < Clamp::Command
+  option ["-u", "--username"], "USERNAME", "username to log in as"
+  option ["-p", "--password"], "PASSWORD", "password to log in as"
+
+  def virtual_box
+    VirtualBox::GuestControl::Runner.configure do |c|
+      c.name = name
+      c.username = username
+      c.password = password
+    end
+    VirtualBox::GuestControl::Runner.new
+  end
+
+  subcommand "start", "start up the given VM" do
+    parameter "NAME", "name of virtual machine"
+
+    def execute
+      virtual_box.start!
+    end
+  end
+
+  subcommand "shutdown", "shutdown the given VM" do
+    parameter "NAME", "name of virtual machine"
+
+    def execute
+      virtual_box.shutdown!
+    end
+  end
+
+  subcommand "restart", "restart the given VM" do
+    parameter "NAME", "name of virtual machine"
+
+    def execute
+      virtual_box.restart!
+    end
+  end
+
+  subcommand "info", "list all known info about the VM" do
+    parameter "NAME", "name of virtual machine"
+
+    def execute
+      virtual_box.state.tap do |map|
+        map.keys.sort.each do |key|
+          puts [key, map[key]].join(": ")
+        end
+      end
+    end
+  end
+
+  subcommand "status", "says if the vm is booted or not" do
+    parameter "NAME", "name of virtual machine"
+
+    def execute
+      if virtual_box.started?
+        puts "VM is started"
+      else
+        puts "VM is shutdown"
+      end
+    end
+  end
+end
+
+VirtualBoxCommand.run(ARGV)
+

data/lib/virtualbox-guestcontrol.rb

@@ -0,0 +1,136 @@
+require 'timeout'
+require 'shellter'
+require 'active_support/configurable'
+require 'active_support/time'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'clamp'
+
+module VirtualBox
+  module GuestControl
+    class Runner
+      include ActiveSupport::Configurable
+
+      self.config[:default_timeout] = 120.seconds
+      self.config[:vbox_manage] = Shellter.which("VBoxManage")
+
+      config_accessor :vbox_manage
+      config_accessor :name
+      config_accessor :default_timeout
+      config_accessor :username
+      config_accessor :password
+
+      #validate that vbox_manage exists
+      #validate that name is a valid name
+
+      def started?
+        state[:GuestAdditionsRunLevel] == "2"
+      end
+
+      def shutdown?
+        ["poweroff", "aborted"].include?(state[:VMState])
+      end
+
+      def shutdown!(force = false)
+        return if shutdown?
+        if force
+          Shellter.run(vbox_manage, "controlvm", ":name", "poweroff", :name => name)
+          wait_until { shutdown? }
+        else
+          begin
+            Shellter.run(vbox_manage, "controlvm", ":name", "acpipowerbutton", :name => name)
+            wait_until { shutdown? }
+          rescue TimeoutError
+            shutdown_machine(true)
+          end
+        end
+      end
+
+      def start!
+        return if started?
+        Shellter.run!(vbox_manage, "startvm", ":name", :name => name)
+        wait_until { started? }
+      end
+
+      def restart!
+        shutdown!
+        start!
+      end
+
+      # VBoxManage guestcontrol     <vmname>|<uuid>
+      #                             exec[ute]
+      #                             --image <path to program>
+      #                             --username <name> --password <password>
+      #                             [--dos2unix]
+      #                             [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
+      #                             [--timeout <msec>] [--unix2dos] [--verbose]
+      #                             [--wait-exit] [--wait-stdout] [--wait-stderr]
+      #                             [-- [<argument1>] ... [<argumentN>]]
+      def execute(command, *arguments)
+        with_started_machine do
+          options = arguments.extract_options!
+          params = ["guestcontrol", ":name", "execute", "--image", ":command"]
+
+          options[:name] = name
+          options[:command] = command
+
+          if username
+            params += ["--username", ":username"]
+            options[:username] = username
+          end
+
+          if password
+            params += ["--password", ":password"]
+            options[:password] = password
+          end
+
+          params += ["--wait-stdout"]
+          params += ["--timeout", ":timeout"]
+          options[:timeout] = default_timeout.to_s
+
+          unless arguments.empty?
+            params += ["--", ":arguments"]
+            options[:arguments] = arguments.join(" ")
+          end
+
+          params << options
+
+          Shellter.run!(vbox_manage, *params)
+        end
+      end
+
+      def state
+        result = Shellter.run!(vbox_manage, "showvminfo", ":name", "--machinereadable", :name => name)
+        {}.with_indifferent_access.tap do |map|
+          result.stdout.read.lines.each do |line|
+            name, value = line.strip.split("=").map { |y| y.gsub(/(^"|"$)/, "") }
+            map[name] = value
+          end
+        end
+      end
+
+      private
+
+      def wait_until
+        Timeout::timeout(default_timeout) do
+          loop do
+            result = yield
+            if result
+              break
+            else
+              sleep 5
+            end
+          end
+        end
+      end
+
+      def with_started_machine
+        begin
+          start!
+          yield
+        ensure
+          shutdown!
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox-guestcontrol/version.rb

@@ -0,0 +1,5 @@
+module VirtualBox
+  module GuestControl
+    VERSION = "1.0.0"
+  end
+end

data/virtualbox-guestcontrol.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/virtualbox-guestcontrol/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Eberbach"]
+  gem.email         = ["andrew@ebertech.ca"]
+  gem.description   = %q{Runs stuff inside of a VirtualBox VM}
+  gem.summary       = %q{Runs stuff inside of a VirtualBox VM}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "virtualbox-guestcontrol"
+  gem.require_paths = ["lib"]
+  gem.version       = VirtualBox::GuestControl::VERSION
+  
+  gem.add_dependency 'shellter'
+  gem.add_dependency 'activesupport', "~> 3.0"
+  gem.add_dependency 'clamp'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: virtualbox-guestcontrol
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Eberbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shellter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Runs stuff inside of a VirtualBox VM
+email:
+- andrew@ebertech.ca
+executables:
+- rvbox
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rvbox
+- lib/virtualbox-guestcontrol.rb
+- lib/virtualbox-guestcontrol/version.rb
+- virtualbox-guestcontrol.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Runs stuff inside of a VirtualBox VM
+test_files: []