vagrant-vm-info 0.0.4

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-vm-info.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" , :tag => 'v1.6.3'
+end
+
+group :plugins do
+  gem "vagrant-vm-info", path: "."
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kostiantyn Chkhaidze
+
+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 @@
+# Vagrant::Vm::Info
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vagrant-vm-info'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vagrant-vm-info
+
+## 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 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/vagrant-vm-info/plugin.rb

@@ -0,0 +1,151 @@
+begin
+  require "vagrant"
+  require Vagrant.source_root.join('plugins/commands/up/start_mixins')
+rescue LoadError
+  raise "The vagrant-vm-info vagrant plugin must be run with vagrant."
+end
+
+require "yaml"
+require "time"
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.1.0"
+  raise "The vagrant-vm-info vagrant plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantVminfo
+  class Plugin < Vagrant.plugin("2")
+    name "vagrant-vm-info"
+    description <<-DESC
+    This plugin provides the 'info' command that will display detailed information about the VM in YAML for easy parsing
+    DESC
+
+    command("info") do
+        InfoCommand
+    end
+  end
+
+  class InfoCommand < Vagrant.plugin(2, :command)
+    include VagrantPlugins::CommandUp::StartMixins
+
+    def get_vm_info(vm)
+        # Get some provider specific details for vm
+        provider = vm.provider_name.id2name
+        if provider == 'virtualbox'
+            return get_vm_info_virtualbox(vm)
+        elsif provider == 'vmware_workstation' or provider == 'vmware_fusion'
+            return get_vm_info_vmware(vm)
+        end
+    end
+
+    def get_vm_info_virtualbox(vm)
+        # Get VM info by virtualbox provider
+        # All we need is network interfaces details
+
+        networks = []
+        begin
+            nic_count = vm.provider.driver.execute("guestproperty", "get", vm.id, "/VirtualBox/GuestInfo/Net/Count")[/Value: (\d)/, 1]
+        rescue Exception => e
+            @logger.warn(e.message)
+            nic_count = 0
+        else
+            nic_count = Integer(nic_count)
+        end
+        # Check nic_count is not defined in case of VBox Guest Additions not install, or some other issue
+        vminfo = vm.provider.driver.execute("showvminfo", vm.id, "--machinereadable")
+        if nic_count > 0
+            (0..(nic_count-1)).each do |i|
+                nic_ip = vm.provider.driver.execute("guestproperty", "get", vm.id, "/VirtualBox/GuestInfo/Net/#{i}/V4/IP")[/Value: (.*)/, 1]
+                nic_mac = vm.provider.driver.execute("guestproperty", "get", vm.id, "/VirtualBox/GuestInfo/Net/#{i}/MAC")[/Value: (.*)/, 1]
+                nic_broadcast = vm.provider.driver.execute("guestproperty", "get", vm.id, "/VirtualBox/GuestInfo/Net/#{i}/V4/Broadcast")[/Value: (.*)/, 1]
+                nic_netmask = vm.provider.driver.execute("guestproperty", "get", vm.id, "/VirtualBox/GuestInfo/Net/#{i}/V4/Netmask")[/Value: (.*)/, 1]
+                # Get the number of this network device based on the mac address
+                # TODO: probably just should just get a hash of all of this info somehow, my ruby foo is weak
+                nic_number = vminfo[/\w*(\d)=\"#{nic_mac}\"/, 1]
+                nic_type = vminfo[/nic#{nic_number}=\"(.*)\"/, 1]
+                networks << {'ip' => nic_ip,
+                             'mac' => nic_mac,
+                             'netmask' => nic_netmask,
+                             'broadcast' => nic_broadcast,
+                             'type' => nic_type}
+            end
+        end
+        # If VM is running - VMStateChangeTime is actually it's launch time 
+        state_change_time = vminfo[/VMStateChangeTime=\"(.*)\"/, 1]
+        return {"launch_time" => Time.parse(state_change_time).strftime("%Y-%m-%d %H:%M:%S"),
+                "networks" => networks}
+
+    end
+
+    def get_vm_info_vmware(vm)
+        # Get VM info by virtualbox provider
+        # We can get some network interfaces details and current IP address
+
+        # Collect details for all the network interfaces
+        nics = {}
+        vm.provider.driver.send(:read_vmx_data).each do |key, val|
+            key1, key2 = key.split('.')
+            m = /^ethernet\d+$/.match(key1)
+            if m
+                if !nics.include?(m[0])
+                    nics[m[0]] = {}
+                end
+                nics[m[0]][key2] = val
+            end
+        end
+
+        # Check and normalize collected network information
+        networks = []
+        nics.values.each do |nic|
+            nic_type = nic['connectiontype']
+            nic_addresstype = nic['addresstype']
+            nic_mac = nic_addresstype == 'generated' ? nic['generatedaddress'] : nic['address']
+            #TODO: For now I don't know simple way to retrieve these details
+            #nic_ip = nil
+            #nic_netmask = nil
+            #nic_broadcast = nil
+
+            networks << {#'ip' => nic_ip,
+                         'mac' => nic_mac,
+                         #'netmask' => nic_netmask,
+                         #'broadcast' => nic_broadcast,
+                         'type' => nic_type}
+        end
+
+        # We can try to get IP address for VM but can not assign it to any network interface
+        ip = nil
+        begin
+            resp =  vm.provider.driver.send(:vmrun, *['getGuestIPAddress', vm.id])
+        rescue Exception => e
+            @logger.warn(e.message)
+        else
+            m = /(?<ip>\d{1,3}\.\d{1,3}.\d{1,3}\.\d{1,3})/.match(resp.stdout)
+            ip = (resp.exit_code == 0 and m) ? m['ip'] : nil
+        end
+
+        return {'ip' => ip,
+                'networks' => networks }
+    end
+
+    def execute
+        # Not sure if this is the only way to do this?  How else would I get argv?
+        argv = parse_options(OptionParser.new)
+
+        info = {}
+
+        with_target_vms(argv) do |vm|
+            info["name"] = vm.name.id2name
+            info["status"] = vm.state.id.id2name
+
+            # Check if vm is running - try to get some provider specific details
+            if vm.state.id == :running
+                info["id"] = vm.id
+                info["provider"] = vm.provider_name.id2name
+                info.merge!(get_vm_info(vm))
+            end
+        end
+        puts info.to_yaml
+    end
+  end
+end

data/lib/vagrant-vm-info/version.rb

@@ -0,0 +1,3 @@
+module VagrantVminfo
+  VERSION = "0.0.4"
+end

data/lib/vagrant-vm-info.rb

@@ -0,0 +1,19 @@
+require "pathname"
+
+module VagrantVminfo
+
+  def self.vagrant_vm_info_root
+    @vagrant_vm_info_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+  end
+
+  def self.load_script(script_file_name)
+    File.read(expand_script_path(script_file_name))
+  end
+
+  def self.load_script_template(script_file_name, options)
+    Vagrant::Util::TemplateRenderer.render(expand_script_path(script_file_name), options)
+  end
+
+end
+
+require "vagrant-vm-info/plugin"

data/vagrant-vm-info.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-vm-info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-vm-info"
+  spec.version       = VagrantVminfo::VERSION
+  spec.authors       = ["Lin Salisbury", "Kostiantyn Chkhaidze"]
+  spec.email         = ["lin.salisbury@gmail.com", "kchkhaidze@rivermeadow.com"]
+  spec.description   = %q{Plugin to get detailed VM info from Vagrant}
+  spec.summary       = %q{Gets detailed information about the VM, including network interfaes}
+  spec.homepage      = ""
+  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_paths = ["lib"]
+
+#  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-core", "~> 2.12.2"
+  spec.add_development_dependency "rspec-expectations", "~> 2.12.1"
+  spec.add_development_dependency "rspec-mocks", "~> 2.12.1"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-vm-info
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Lin Salisbury
+- Kostiantyn Chkhaidze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+description: Plugin to get detailed VM info from Vagrant
+email:
+- lin.salisbury@gmail.com
+- kchkhaidze@rivermeadow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-vm-info.rb
+- lib/vagrant-vm-info/plugin.rb
+- lib/vagrant-vm-info/version.rb
+- vagrant-vm-info.gemspec
+homepage: ''
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: Gets detailed information about the VM, including network interfaes
+test_files: []