vagrant-screenshot 0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in vagrant-screenshot.gemspec
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+Vagrant plugin to take screenshots of VMs
+=========================================
+
+This plugin is useful to debug your VM while booting
+
+Instalation
+-----------
+
+    $ gem install vagrant-screenshot
+  
+Add to your Vagrantfile
+
+    require 'vagrant-screenshot'
+
+Usage
+-----
+
+    $ vagrant screenshot
+    $ vagrant screenshot my-vm-name
+
+For more information use
+
+    $ vagrant screenshot --help
+
+There is a ``--open``(or ``-o``) option to open the generated images, but
+it's only available on OS X for now.
+
+Contributing
+------------
+
+1. Create an issue (if it doesn't exist yet)
+2. Fork [this repository](https://github.com/igorsobreira/vagrant-screenshot), make your changes
+3. Send a pull request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant-screenshot.rb

@@ -0,0 +1,4 @@
+require "vagrant-screenshot/errors"
+require "vagrant-screenshot/screenshot_command"
+
+Vagrant.commands.register(:screenshot) { Vagrant::Command::ScreenshotCommand }

data/lib/vagrant-screenshot/errors.rb

@@ -0,0 +1,14 @@
+module Vagrant
+
+  module Errors
+
+    class VBoxManageCommandNotFound < VagrantError
+      def initialize
+        message = "VBoxManage command not found"
+        super
+      end
+    end
+
+  end
+
+end

data/lib/vagrant-screenshot/screenshot_command.rb

@@ -0,0 +1,80 @@
+module Vagrant
+
+  module Command
+    class ScreenshotCommand < Base
+
+      VBOX_MANAGE = 'VBoxManage'
+
+      def execute
+        options = {}
+        filenames = []
+
+        raise Errors::VBoxManageCommandNotFound if vbox_manage_command.empty?
+
+        opts = build_screenshot_options options
+        argv = parse_options(opts)
+        return if !argv
+
+        vm_name = argv[0]
+        with_target_vms(vm_name) do |vm|
+          if vm.state != :running
+            notify "Skiping #{vm.name}. VM not running"
+          else
+            notify "Taking screenshot for #{vm.name}"
+            filename = create_output_filename vm.name
+            take_screenshot vm.uuid, filename
+            filenames << filename
+            open_generated_files(filenames) if options[:open]
+          end
+        end
+
+      end
+
+      protected
+
+      def vbox_manage_command
+        %x[which VBoxManage].chomp
+      end
+
+      def open_command
+        # Currently just Mac's 'open' command is supported, if it's
+        # not found the -o option is not provided
+        %x[which open].chomp
+      end
+
+      def build_screenshot_options(options)
+        opts = OptionParser.new do |opts|
+          opts.banner  = "Take screenshot from all active VMs.\n\n"
+          opts.banner += "Usage: vagrant screenshot [vm-name1, vm-name2, ...]\n\n"
+
+          if !open_command.empty?
+            opts.on("-o", "--open", "Opens the generated images") do |c|
+              options[:open] = true
+            end
+          end
+
+        end
+        opts
+      end
+
+      def create_output_filename(vm_name)
+        "screenshot-#{vm_name}.png"
+      end
+
+      def take_screenshot(vm_uuid, filename)
+        %x[#{VBOX_MANAGE} controlvm #{vm_uuid} screenshotpng #{filename}]
+        notify "Screenshot saved on #{filename}"
+      end
+
+      def open_generated_files(filenames)
+        %x[open #{filenames.join(' ')}]
+      end
+
+      def notify(msg)
+        puts msg
+      end
+
+    end
+  end
+
+end

data/vagrant-screenshot.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "vagrant-screenshot"
+  s.version     = "0.1"
+  s.authors     = ["Igor Sobreira"]
+  s.email       = ["igor@igorsobreira.com"]
+  s.homepage    = "https://github.com/igorsobreira/vagrant-screenshot"
+  s.summary     = %q{Vagrant plugin to take screenshots of VMs}
+  s.description = %q{Vagrant plugin to take screenshots of VMs}
+
+  s.rubyforge_project = "vagrant-screenshot"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-screenshot
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Igor Sobreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-13 00:00:00.000000000 Z
+dependencies: []
+description: Vagrant plugin to take screenshots of VMs
+email:
+- igor@igorsobreira.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/vagrant-screenshot.rb
+- lib/vagrant-screenshot/errors.rb
+- lib/vagrant-screenshot/screenshot_command.rb
+- vagrant-screenshot.gemspec
+homepage: https://github.com/igorsobreira/vagrant-screenshot
+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: vagrant-screenshot
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Vagrant plugin to take screenshots of VMs
+test_files: []