vagrant-vcenter 0.0.2.pre.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c733695318829ceed21eafa83e10faa309ccc6ef
+  data.tar.gz: 95a52dd729748fcdb3ea944f3674361568620d07
+SHA512:
+  metadata.gz: 3135b7e6ed6c775bde2f1176c795f9614250497bfe64469309338d94a29341c4395779807ff569d6e0dab0144ba373fd418fb8d23a19c873b1b2c7e32c65ceb5
+  data.tar.gz: db2a1fb9232ee85ec4b315372995861ebc01629efdda358196fdfc2204335db83efc84c50285408b87fa0c084fe3882d63ae92b54b146bb954ea4e8ff31fe04a

data/.gitignore

@@ -0,0 +1,4 @@
+.vagrant/*
+pkg/*
+Gemfile.lock
+test-*

data/.rubocop.yml

@@ -0,0 +1,34 @@
+MethodLength:
+  CountComments: false  # count full line comments?
+  Enabled: false
+
+MethodName:
+  EnforcedStyle: snake_case
+
+AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+
+Encoding:
+  Description: 'Use UTF-8 as the source file encoding.'
+  Enabled: true
+
+HashSyntax:
+  Description: >-
+                 Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
+                 { :a => 1, :b => 2 }.
+  Enabled: false
+  EnforcedStyle: hash_rockets
+
+LineEndConcatenation:
+  Description: 'Use \\ instead of + to concatenate two string literals at line end.'
+  Enabled: true
+  
+LineLength:
+  Description: 'Limit lines to 79 characters.'
+  Enabled: true
+  Max: 80
+
+CyclomaticComplexity:
+  Description: 'Avoid complex methods.'
+  Enabled: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Fabio Rapposelli
+
+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,5 @@
+# vagrant-vcenter
+
+Vagrant provider for VMware vCenter ®
+
+Please note that this is NOT WORKING yet.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the y of this file.
+Dir.chdir(File.expand_path('../', __FILE__))
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new
+
+task :default => 'spec'

data/example_box/README.md

@@ -0,0 +1,13 @@
+# vagrant-vcenter box specifications [WIP]
+
+*Note that vagrant-vcenter currently supports only single VM vApp boxes*
+
+BOX package should contain:
+
+- `metadata.json` -- Vagrant metadata file
+- `<boxname>.ovf` -- OVF descriptor of the vApp.
+- `<boxname>.mf` -- OVF manifest file containing file hashes.
+- `<boxname>-disk-<#>.vmdk` -- Associated VMDK files.
+- `Vagrantfile`-- vagrant-vcenter default Vagrantfile
+
+A [task is open](https://github.com/frapposelli/vagrant-vcenter/issues/12) for creating a veewee plugin to facilitate Box creation

data/example_box/Vagrantfile

@@ -0,0 +1,6 @@
+Vagrant::Config.run do |config|
+  config.vm.base_mac = "<mac address>"
+end
+
+include_vagrantfile = File.expand_path("../include/_Vagrantfile", __FILE__)
+load include_vagrantfile if File.exist?(include_vagrantfile)

data/example_box/metadata.json

@@ -0,0 +1 @@
+{"provider": "vagrant-vcenter"}

data/lib/vagrant-vcenter.rb

@@ -0,0 +1,18 @@
+require 'pathname'
+require 'vagrant-vcenter/plugin'
+
+module VagrantPlugins
+  # Initialize the plugin.
+  module VCenter
+    lib_path = Pathname.new(File.expand_path('../vagrant-vcenter', __FILE__))
+    autoload :Action, lib_path.join('action')
+    autoload :Errors, lib_path.join('errors')
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/vagrant-vcenter/action.rb

@@ -0,0 +1,232 @@
+require 'pathname'
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module VCenter
+    # Actions to be performed by the vagrant-vcenter provider.
+    module Action
+      include Vagrant::Action::Builtin
+
+      # Vagrant commands
+      # This action boots the VM, assuming the VM is in a state that requires
+      # a bootup (i.e. not saved).
+      def self.action_boot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use PowerOn
+          b.use Provision
+          b.use SyncFolders
+        end
+      end
+
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use action_halt
+            b2.use action_start
+            b2.use DisconnectvCenter
+          end
+        end
+      end
+
+      # This action starts a VM, assuming it is already imported and exists.
+      # A precondition of this action is that the VM exists.
+      def self.action_start
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectvCenter
+          b.use Call, IsRunning do |env, b2|
+            # If the VM is running, then our work here is done, exit
+            if env[:result]
+              b2.use MessageAlreadyRunning
+              next
+            end
+            b2.use Call, IsPaused do |env2, b3|
+              if env2[:result]
+                b3.use Resume
+                next
+              end
+              b3.use action_boot
+            end
+          end
+        end
+      end
+
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectvCenter
+          b.use Call, IsPaused do |env, b2|
+            b2.use Resume if env[:result]
+            b2.use PowerOff
+          end
+        end
+      end
+
+      def self.action_suspend
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectvCenter
+          b.use Call, IsRunning do |env, b2|
+            # If the VM is stopped, can't suspend
+            if !env[:result]
+              b2.use MessageCannotSuspend
+            else
+              b2.use Suspend
+            end
+          end
+        end
+      end
+
+      def self.action_resume
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectvCenter
+          b.use Resume
+        end
+      end
+
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, DestroyConfirm do |env, b2|
+            if env[:result]
+              b2.use ConfigValidate
+              b2.use ConnectvCenter
+              b2.use Call, IsRunning do |env2, b3|
+              # If the VM is running, must power off
+                b3.use action_halt if env2[:result]
+                b3.use Destroy
+              end
+            else
+              b2.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use Provision
+            b2.use SyncFolders
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectvCenter
+          b.use ReadSSHInfo
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectvCenter
+          b.use ReadState
+        end
+      end
+
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use AnnounceSSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use SSHRun
+          end
+        end
+      end
+
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            b2.use HandleBox unless env[:result]
+          end
+          b.use ConnectvCenter
+          b.use InventoryCheck
+          b.use Call, IsCreated do |env, b2|
+            b2.use BuildVM unless env[:result]
+          end
+          b.use action_start
+          b.use DisconnectvCenter
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :AnnounceSSHExec,
+               action_root.join('announce_ssh_exec')
+      autoload :BuildVM,
+               action_root.join('build_vm')
+      autoload :ConnectvCenter,
+               action_root.join('connect_vcenter')
+      autoload :Destroy,
+               action_root.join('destroy')
+      autoload :DisconnectvCenter,
+               action_root.join('disconnect_vcenter')
+      autoload :ForwardPorts,
+               action_root.join('forward_ports')
+      autoload :InventoryCheck,
+               action_root.join('inventory_check')
+      autoload :IsCreated,
+               action_root.join('is_created')
+      autoload :IsPaused,
+               action_root.join('is_paused')
+      autoload :IsRunning,
+               action_root.join('is_running')
+      autoload :MessageAlreadyRunning,
+               action_root.join('message_already_running')
+      autoload :MessageCannotSuspend,
+               action_root.join('message_cannot_suspend')
+      autoload :MessageNotCreated,
+               action_root.join('message_not_created')
+      autoload :MessageWillNotDestroy,
+               action_root.join('message_will_not_destroy')
+      autoload :PowerOff,
+               action_root.join('power_off')
+      autoload :PowerOn,
+               action_root.join('power_on')
+      autoload :ReadSSHInfo,
+               action_root.join('read_ssh_info')
+      autoload :ReadState,
+               action_root.join('read_state')
+      autoload :Resume,
+               action_root.join('resume')
+      autoload :Suspend,
+               action_root.join('suspend')
+      autoload :SyncFolders,
+               action_root.join('sync_folders')
+    end
+  end
+end

data/lib/vagrant-vcenter/action/announce_ssh_exec.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module VCenter
+    module Action
+      # Extends the Builtin SSHExec and announces the external IP.
+      class AnnounceSSHExec < Vagrant::Action::Builtin::SSHExec
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          ssh_info = env[:machine].ssh_info
+          env[:ui].success('External IP for ' +
+                           "#{env[:machine].name}: #{ssh_info[:host]}")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vcenter/action/build_vm.rb

@@ -0,0 +1,130 @@
+require 'securerandom'
+require 'etc'
+
+module VagrantPlugins
+  module VCenter
+    module Action
+      # This class builds the VM to be used by Vagrant.
+      class BuildVM
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_vcenter::action::build_vm')
+        end
+
+        def call(env)
+          # FIXME: we need to find a way to clean things up when a SIGINT get
+          # called... see env[:interrupted] in the vagrant code
+
+          config = env[:machine].provider_config
+          vm_name = env[:machine].name
+
+          # FIXME: Raise a correct exception
+          dc = config.vcenter_cnx.serviceInstance.find_datacenter(
+            config.datacenter_name) or abort 'datacenter not found'
+
+          if config.template_folder_name.nil?
+            box_to_search = env[:machine].box.name.to_s
+          else
+            box_to_search = config.template_folder_name + '/' +
+                            env[:machine].box.name.to_s
+          end
+
+          # FIXME: Raise a correct exception
+          computer = dc.find_compute_resource(
+                        config.computer_name) or fail 'Host not found'
+          rp = computer.resourcePool
+
+          # FIXME: Raise a correct exception
+          template = dc.find_vm(
+                        box_to_search) or abort 'VM not found'
+
+          if config.linked_clones
+            @logger.debug('DOING LINKED CLONE!')
+            # The API for linked clones is quite strange. We can't create a
+            # linked straight from any VM. The disks of the VM for which we can
+            # create a linked clone need to be read-only and thus VC demands
+            # that the VM we are cloning from uses delta-disks. Only then it
+            # will allow us to share the base disk.
+            #
+            # Thus, this code first create a delta disk on top of the base disk
+            # for the to-be-cloned VM, if delta disks aren't used already.
+            disks = template.config.hardware.device.grep(
+                    RbVmomi::VIM::VirtualDisk)
+            disks.select { |x| x.backing.parent.nil? }.each do |disk|
+              spec = {
+                :deviceChange => [
+                  {
+                    :operation => :remove,
+                    :device => disk
+                  },
+                  {
+                    :operation => :add,
+                    :fileOperation => :create,
+                    :device => disk.dup.tap do |x|
+                      x.backing = x.backing.dup
+                      x.backing.fileName = "[#{disk.backing.datastore.name}]"
+                      x.backing.parent = disk.backing
+                    end
+                  }
+                ]
+              }
+              template.ReconfigVM_Task(:spec => spec).wait_for_completion
+            end
+
+            relocate_spec = RbVmomi::VIM.VirtualMachineRelocateSpec(
+                            :diskMoveType => :moveChildMostDiskBacking,
+                            :pool => rp)
+          else
+            relocate_spec = RbVmomi::VIM.VirtualMachineRelocateSpec(
+                            :pool => rp)
+          end
+
+          @logger.debug("Relocate Spec: #{relocate_spec.pretty_inspect}")
+
+          spec = RbVmomi::VIM.VirtualMachineCloneSpec(
+                 :location => relocate_spec,
+                 :powerOn => false,
+                 :template => false)
+
+          @logger.debug("Spec: #{spec.pretty_inspect}")
+
+          vm_target = "Vagrant-#{Etc.getlogin}-" +
+                      "#{vm_name}-#{Socket.gethostname.downcase}-" +
+                      "#{SecureRandom.hex(4)}"
+
+          @logger.debug("VM name: #{vm_target}")
+
+          # FIXME: vm.parent brings us to the template folder, fix this with
+          # folder_path.
+
+          root_vm_folder = dc.vmFolder
+          vm_folder = root_vm_folder
+          unless config.folder_name.nil?
+            vm_folder = root_vm_folder.traverse(config.folder_name,
+                                                RbVmomi::VIM::Folder)
+          end
+          @logger.debug("folder for VM: #{vm_folder}")
+
+          template.CloneVM_Task(
+                                :folder => vm_folder,
+                                :name => vm_target,
+                                :spec => spec).wait_for_completion
+
+          if config.folder_name.nil?
+            vm_to_search = vm_target
+          else
+            vm_to_search = config.folder_name + '/' + vm_target
+          end
+
+          @logger.debug("VM to search: #{vm_to_search}")
+
+          # FIXME: Raise a correct exception
+          env[:machine].id = dc.find_vm(
+                            vm_to_search).config.uuid or abort 'VM not found'
+
+          @app.call env
+        end
+      end
+    end
+  end
+end