vagrant-vbguest-update 0.10.1.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 115e4d953e83136dfba6d647201bc58f8438ff89
+  data.tar.gz: 56bb78d1c6be37469365d148712122c544b587f8
+SHA512:
+  metadata.gz: 8018ef061eadecd77a20debaec6ce9638867974d4ee0053d8fbb00aad3e0540c41c455ad32b3a685a42698dd328faa6143ae061dd9a7bd69ad2015bd45d9de1e
+  data.tar.gz: 22e4b2b7ada9cbbdd0e6f0f64fc46d8e78f9092568cc6373cbae2ae7878efa750d47b0a697e44d248204092c6ca3498437db831ba4344ff84705d33cbb6d3a52

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,209 @@
+## 0.10.1 (Not released yet)
+
+  - Make sure our log message strings are loaded [GH-107]
+
+## 0.10.0 (2013-12-09)
+
+  - Adds new config option `installer_arguments`   
+    Customize arguments passed to the VirtualBox GuestAdditions shell script
+    installer. Defaults to "--no-x11". [GH-98]
+  - Cope with UbuntuCloudImage by default [GH-86], [GH-64], [GH-43]
+    On Ubuntu, always try to remove conflicting installations of
+    GuestAdditions by removing those packages:
+    virtualbox-guest-dkms virtualbox-guest-utils virtualbox-guest-x11
+  - Unload kernel modules when UbuntuCloudImage packages are installed.
+    (Thanks @eric1234 for commenting on ec9a7b1f0a)
+  - Wait for SSH connection to be ready. Fixes timing issues with vagrant
+    v1.3.0 and later. [GH-80], [GH-90]
+  - Fix a typo in command description [GH-84]
+  - Tweak gem dependencies [GH-82]
+    - add rake as development dependency
+    - remove version locks on gems provided by vagrant
+  - Pass plugin name when registration the action hook for vagrant ≥1.1 [GH-80]
+  - Fix crash on Vagrant 1.4 [GH-100]
+
+### heads-up
+  
+  - With [GH-94] the **name**, `vagrant-vbguest` registers itself to vagrant's
+    (≥1.1) plugin-system changed from 'vbguest management' to
+    'vagrant-vbguest'
+
+## 0.9.0
+
+  - Adds support for vagrant 1.3 [GH-71], [GH-72]
+  - Fix crash when using as a command [GH-68].
+  - Don't trust VirtualBox Media Manager informations when
+    looking for a iso file. [GH-70]
+
+### heads-up
+
+  - Be lax about missing installer for guest OS.
+    No longer throws an error when no Installer class
+    for the guest os was found. Keep the error message,
+    stop vbguest workflow, but keep vagrant running.
+    [GH-65]
+
+
+## 0.8.0
+
+  - Adds Vagrant 1.2 compatibility [GH-59], [GH-60], [GH-62] /
+    (thanks @Andrew8xx8 for pointing directions)
+  - Fix basic/fallback linux installer [GH-56]
+  - Guard auto-reload on broken vagrant builds.
+    Some varant 1.1.x versions have a bug regarding ssh and cleaning
+    up old connections, which results in varant crashing when a box
+    is reloaded.
+
+## 0.7.1
+
+  - Fix auto-reloading for vagrant 1.1 [GH-52]
+    Also changes the reload method for vagrant 1.0 when ran
+    as middleware (to not run buildin actions manually).
+
+## 0.7.0
+
+  - When looking for a GuestAdditions iso file in media manager
+    allow version number in filename. [GH-48], [GH-49] /
+    (thanks @neerolyte)
+  - Support multiple locations to be searched while "guessing"
+    GuestAdditions iso file
+  - On Linux guests also search "$HOME/.VirtualBox" for
+    GuestAdditions iso file. [GH-48]
+  - Add support for redhat-based distributions (Scientific Linux and
+    presumably CentOS) [GH-47], [GH-46] / (thanks @neerolyte)
+  - Fix an issue with VirtualBox GuestAdditions 4.2.8 [GH-44] /
+    (thanks @jimmycuadra)
+  - Reworked bunch of internals, particularly how vagrants's
+    environemnt is passed arround. Also decoupled GuestAdditions
+    finder into a seperate class.
+  - Intodruce a vagrant 1.0 compatibility layer for Installers and
+    other vbguest internals
+
+### heads-up
+
+  - [GH-44] changes the behavior of vbguest to that effect, that it
+    will no longer halt vagrant workflow if running the VirtualBox
+    GuestAdditions Installer returns an error-code.
+    Instead it will print a human readable waring message.
+  - The environment (`env`) in custom installers is no longer the
+    actions environment `Hash`, but the `Environment` instance.
+    Which has some implications on how you can access e.g. the `ui`:
+    instead of `env[:ui]` use `env.ui`
+  - To achieve compatibility to both vagrant 1.0 and 1.1, custom
+    Installers, when executing shell commands on the guest system,
+    should use vbguests `communicate` wrapper. e.g.:
+        A call like `vm.channel.sudo 'apt-get update'` should be
+        changed to `communicate.sudo 'apt-get update'`
+    The old `vm.channel` syntax will continue to work on vagrant 1.0.x
+    but will fail on vagrant 1.1.x.
+
+## 0.6.4 (2013-01-24)
+
+  - Fix passing a installer class as an config option [GH-40]
+
+## 0.6.3 (2013-01-19)
+
+  - Fix generic linux installer for not explicitly supported
+    distributions [GH-39]
+
+## 0.6.2 (2013-01-18)
+
+  - Fix typos and wording in error messages and I18n keys
+    et al. [GH-38]
+
+## 0.6.1 (2013-01-13)
+
+  - Fix missing command output block and parameters for
+    installation process [GH-37]
+  - Update README to reflect new wording for status informations
+
+## 0.6.0 (2013-01-13)
+
+ - Debian installer now cope with missing `dkms` package [GH-30]
+ - Fixed some issues when runnig on just creating boxes [GH-31]
+ - Fixed workding (thx @scalp42) [GH-32]
+ - Add debug logging
+ - Installers no longer are shell scripts, but ruby classes
+ - Users may pass in their own installer classes
+   (yes! plugins in plugins)
+ - New `sprintf` style `%{version}` placeholder for iso download path.
+   (old `$VBOX_VERSION` placeholder still working)
+ - Revisited command arguments to not just mirror config values:
+   - New `--do` argument: force-run one of those commands:
+     * `start`   : Try to start the GuestAdditions Service
+     * `rebuild` : Rebuild the currently installed Guest Additions
+     * `install` : Run the installation process from "iso file"
+   - New `--status` argument
+   - Removed `-I|--no-install` argument (instead use `--status`)
+
+## 0.5.1 (2012-11-30)
+
+ - Fix: Provisioning will not run twice when rebooted due
+   to incomplete GuestAdditions installation [GH-27] /
+   (thanks @gregsymons for pointing)
+
+## 0.5.0 (2012-11-19)
+
+  - Box will be rebooted if the GuestAdditions installation
+    process does not load the kernel module [GH-25], [GH-24]
+  - Add `--auto-reboot` argument to allow rebooting when running as a
+    command (which is disabled by default when runnind as command)
+  - Adds this Changelog
+
+## 0.4.0 (2012-10-21)
+
+  - Add global configuration options [GH-22]
+  - Add `iso_path` option `:auto` to rest a previously
+    configured path [GH-22]
+
+## 0.3.5
+
+  - Fix iso detection for windows hosts [GH-20]
+
+## 0.3.4
+
+  - Fix installer shell script invocation [GH-18]
+
+## 0.3.3
+
+  - Add Fedora to the list of supported plattforms [GH-17]
+  - Add system package update (`apt-get update`) to the
+    debian installer if package installation fails [GH-16]
+  - Drop dependency on `vagrant` gem [GH-15]
+
+## 0.3.2
+
+  - Stop GuestAdditions installation and fail with an error
+    when installation of dependency packes fails [GH-13]
+
+## 0.3.1
+
+  - Ruby 1.8.7 compatibility [GH-12]
+
+## 0.3.0
+
+  - Removed dependency to the `virtualbox` gem by using
+    `vagrant`s vm driver [GH-8]
+
+## 0.2.1
+
+  - Typo fixes in readme and internal renamings. [GH-9], [GH-7]
+
+## 0.2.0
+
+  - Makes a guess on where to look for a `VBoxGuestAdditions.iso` file
+    based on the host system (when VirtualBox does not tell). [GH-6]
+  - Adds command line options `--no-install`, `--no-remote`, `--iso`
+  - Requires vagrant v0.9.4 or later
+
+## 0.1.1
+
+  - Fix vagrant 0.9.4 compatibility [GH-4]
+
+## 0.1.0
+
+  - Vagrant 0.9 compatibility (drops 0.8 support) [GH-3]
+
+## Previous (≤ 0.0.3)
+
+  - Vagrant 0.8 support

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-vbguest.gemspec
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Robert Schulze <robert@dotless.de>
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks

data/Readme.md

@@ -0,0 +1,267 @@
+# vagrant-vbguest
+
+*vagrant-vbguest* is a [Vagrant](http://vagrantup.com) plugin which automatically installs the host's VirtualBox Guest Additions on the guest system.
+
+[![Code Climate](https://codeclimate.com/github/dotless-de/vagrant-vbguest.png)](https://codeclimate.com/github/dotless-de/vagrant-vbguest) [![Dependency Status](https://gemnasium.com/dotless-de/vagrant-vbguest.png)](https://gemnasium.com/dotless-de/vagrant-vbguest)
+
+## Installation
+
+Requires vagrant 0.9.4 or later (including 1.x)
+
+### Vagrant ≥ 1.1
+
+```bash
+$ vagrant plugin install vagrant-vbguest
+```
+
+### Vagrant 1.0 and older
+
+Since vagrant v1.0.0 the preferred installation method for vagrant is using the provided packages or installers.
+If you installed vagrant that way, you need to use vagrant's gem wrapper:
+
+```bash
+$ vagrant gem install vagrant-vbguest
+```
+
+If you installed vagrant using RubyGems, use:
+
+```bash
+$ gem install vagrant-vbguest
+```
+
+Compatibly for vagrant 0.8 is provided by version 0.0.3 (which lacks a bunch of new options)
+
+## Configuration / Usage
+
+If you're lucky, *vagrant-vbguest* does not require any configuration. 
+However, here is an example of `Vagrantfile`:
+
+```ruby
+Vagrant::Config.run do |config|
+  # we will try to autodetect this path. 
+  # However, if we cannot or you have a special one you may pass it like:
+  # config.vbguest.iso_path = "#{ENV['HOME']}/Downloads/VBoxGuestAdditions.iso"
+  # or
+  # config.vbguest.iso_path = "http://company.server/VirtualBox/%{version}/VBoxGuestAdditions.iso"
+  
+  # set auto_update to false, if you do NOT want to check the correct 
+  # additions version when booting this machine
+  config.vbguest.auto_update = false
+  
+  # do NOT download the iso file from a webserver
+  config.vbguest.no_remote = true
+end
+```
+
+### Config options
+
+* `iso_path` : The full path or URL to the VBoxGuestAdditions.iso file. <br/>
+The `iso_path` may contain the optional placeholder `%{version}` replaced with detected VirtualBox version (e.g. `4.1.8`).
+The default URI for the actual iso download is: `http://download.virtualbox.org/virtualbox/%{version}/VBoxGuestAdditions_%{version}.iso`<br/>
+vbguest will try to autodetect the best option for your system. WTF? see below.
+* `auto_update` (Boolean, default: `true`) : Whether to check the correct additions version on each start (where start is _not_ resuming a box).
+* `auto_reboot` (Boolean, default: `true` when running as a middleware, `false` when running as a command) : Whether to reboot the box after GuestAdditions has been installed, but not loaded.
+* `no_install` (Boolean, default: `false`) : Whether to check the correct additions version only. This will warn you about version mis-matches, but will not try to install anything.
+* `no_remote` (Boolean, default: `false`) : Whether to _not_ download the iso file from a remote location. This includes any `http` location!
+* `installer` (`VagrantVbguest::Installers::Base`, optional) : Reference to a (custom) installer class
+
+#### Global Configuration
+
+Using [Vagrantfile Load Order](http://vagrantup.com/v1/docs/vagrantfile.html#vagrantfile_load_order) you may change default configuration values.
+Edit (create, if missing) your `~/.vagrant.d/Vagrantfile` like this:
+
+For Vagrant >= 1.1.0 use:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vbguest.auto_update = false
+end
+```
+
+For older versions of Vagrant:
+
+```ruby
+# vagrant's autoloading may not have kicked in
+require 'vagrant-vbguest' unless defined? VagrantVbguest::Config
+VagrantVbguest::Config.auto_update = false
+```
+
+Settings in a project's `Vagrantfile` will overwrite those setting. When executed as a command, command line arguments will overwrite all of the above.
+
+
+### Running as a middleware
+
+Running as a middleware is the default way of using *vagrant-vbguest*. 
+It will run automatically right after the box started. This is each time the box boots, i.e. `vagrant up` or `vagrant reload`. 
+It won't run on `vagrant resume` (or `vagrant up` a suspended box) to save you some time resuming a box.
+
+You may switch off the middleware by setting the vm's config `vbguest.auto_update` to `false`.
+This is a per box setting. On multi vm environments you need to set that for each vm.
+
+When *vagrant-vbguest* is running it will provide you some logs:
+
+    [...]
+    [default] Booting VM...
+    [default] Booting VM...
+    [default] Waiting for VM to boot. This can take a few minutes.
+    [default] VM booted and ready for use!
+    [default] GuestAdditions versions on your host (4.2.6) and guest (4.1.0) do not match.
+    stdin: is not a tty
+    Reading package lists...
+    Building dependency tree...
+    Reading state information...
+    The following extra packages will be installed:
+      fakeroot linux-headers-2.6.32-33 patch
+
+    [...]
+
+    [default] Copy iso file /Applications/VirtualBox.app/Contents/MacOS/VBoxGuestAdditions.iso into the box /tmp/VBoxGuestAdditions.iso
+    stdin: is not a tty
+    [default] Installing Virtualbox Guest Additions 4.2.6 - guest version is 4.1.0
+    stdin: is not a tty
+    Verifying archive integrity... All good.
+    Uncompressing VirtualBox 4.2.6 Guest Additions for Linux...........
+    VirtualBox Guest Additions installer
+    Removing installed version 4.1.0 of VirtualBox Guest Additions...
+    tar: Record size = 8 blocks
+    Removing existing VirtualBox DKMS kernel modules ...done.
+    Removing existing VirtualBox non-DKMS kernel modules ...done.
+    Building the VirtualBox Guest Additions kernel modules ...done.
+    Doing non-kernel setup of the Guest Additions ...done.
+    You should restart your guest to make sure the new modules are actually used
+
+    Installing the Window System drivers ...fail!
+    (Could not find the X.Org or XFree86 Window System.)
+    stdin: is not a tty
+    [default] Restarting VM to apply changes...
+    [default] Attempting graceful shutdown of VM...
+    [default] Booting VM...
+    [default] Waiting for VM to boot. This can take a few minutes.
+    [default] VM booted and ready for use!
+    [default] Configuring and enabling network interfaces...
+    [default] Setting host name...
+    [default] Mounting shared folders...
+    [default] -- v-root: /vagrant
+    [default] -- v-csc-1: /tmp/vagrant-chef-1/chef-solo-1/cookbooks
+    [default] Running provisioner: Vagrant::Provisioners::ChefSolo...
+    [default] Generating chef JSON and uploading...
+    [default] Running chef-solo...
+    [...]
+
+
+The plugin's part starts at `[default] Installing Virtualbox Guest Additions 4.1.14 - guest's version is 4.1.1`, telling you that:
+
+* the guest addition of the box *default* is outdated (or mismatching) 
+* which guest additions iso file will be used 
+* which installer script will be used
+* all the VirtualBox Guest Additions installer output.
+
+No worries on the `Installing the Window System drivers ...fail!`. Most dev boxes you are using won't run a Window Server, thus it's absolutely safe to ignore that error.
+
+When everything is fine, and no update is needed, you see log like:
+
+    ...
+    [default] Booting VM...
+    [default] Waiting for VM to boot. This can take a few minutes.
+    [default] VM booted and ready for use!
+    [default] GuestAdditions 4.2.6 running --- OK.
+    ...
+
+
+### Running as a Command
+
+When you switched off the middleware auto update, or you have a box up and running you may also run the installer manually.
+
+```bash
+$ vagrant vbguest [vm-name] [--do start|rebuild|install] [--status] [-f|--force] [-b|--auto-reboot] [-R|--no-remote] [--iso VBoxGuestAdditions.iso]
+```
+
+For example, when you just updated VirtualBox on your host system, you should update the guest additions right away. However, you may need to reload the box to get the guest additions working.
+
+If you want to check the guest additions version, without installing, you may run:
+
+```bash
+$ vagrant vbguest --status
+```
+
+Telling you either about a version mismatch:
+
+    [default] GuestAdditions versions on your host (4.2.6) and guest (4.1.0) do not match.
+
+or a match:
+
+    [default] GuestAdditions 4.2.6 running --- OK.
+
+
+The `auto-reboot` is turned off by default when running as a command. Vbguest will suggest you to reboot the box when needed. To turn it on simply pass the `--auto-reboot` parameter:
+
+```bash
+$ vagrant vbguest --auto-reboot
+```
+
+You can also pass vagrant's `reload` options like:
+
+```bash
+$ vagrant vbguest --auto-reboot --no-provision
+```
+
+
+
+### ISO autodetection
+
+*vagrant-vbguest* will try to autodetect a VirtualBox GuestAdditions iso file on your system, which usually matches your installed version of VirtualBox. If it cannot find one, it downloads one from the web (virtualbox.org).   
+Those places will be checked in order:
+
+1. Checks your VirtualBox "Virtual Media Maganger" for a DVD called "VBoxGuestAdditions.iso"
+2. Guess by your host operating system:
+  * for linux : `/usr/share/virtualbox/VBoxGuestAdditions.iso`
+  * for Mac : `/Applications/VirtualBox.app/Contents/MacOS/VBoxGuestAdditions.iso`
+  * for Windows : `%PROGRAMFILES%/Oracle/VirtualBox/VBoxGuestAdditions.iso`
+
+
+### Automatic reboot
+
+The VirtualBox GuestAdditions Installer will try to load the newly built kernel module. However the installer may fail to load, just as it is happening when updating GuestAdditions from version 4.1 to 4.2.
+
+Hence, vbguest will check for a loaded kernel module after the installation has finished and reboots the box, if it could not find one.
+
+
+## Advanced Usage
+
+vagrant-vbguest provides installers for generic linux and debian/ubuntu.  
+Installers take care of the whole installation process, that includes where to save the iso file inside the guest and where to mount it.
+
+```ruby
+class MyInstaller < VagrantVbguest::Installers::Linux
+
+  # use /temp instead of /tmp
+  def tmp_path
+    '/temp/VBoxGuestAdditions.iso'
+  end
+
+  # use /media instead of /mnt
+  def mount_point
+    '/media'
+  end
+
+  def install(opts=nil, &block)
+    communicate.sudo('my_distos_way_of_preparing_guestadditions_installation', opts, &block)
+    # calling `super` will run the installation
+    # also it takes care of uploading the right iso file into the box
+    # and cleaning up afterward
+    super
+  end
+end
+
+Vagrant::Config.run do |config|
+  config.vbguest.installer = MyInstaller
+end
+```
+
+
+## Known Issues
+
+* The installer script, which mounts and runs the GuestAdditions Installer Binary, works on Linux only. Most likely it will run on most Unix-like platforms.
+* The installer script requires a directory `/mnt` on the guest system
+* On multi vm boxes, the iso file will be downloaded for each vm
+* The plugin installation on Windows host systems may not work as expected (using `vagrant gem install vagrant-vbguest`). Try `C:\vagrant\vagrant\embedded\bin\gem.bat install vagrant-vbguest` instead. (See [issue #19](https://github.com/dotless-de/vagrant-vbguest/issues/19#issuecomment-7040304))