vagrant-vmware-esxi 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3301495dc2f6eedc70da07b146b713b93e27bd0f
-  data.tar.gz: 8f97dd15927c34cb105cfa28c59b9f7d49e8e218
+  metadata.gz: 8a4b0a4a1d1fb0d75a31e089a5768c08f39e4a97
+  data.tar.gz: f05e33dc43287a63abe340df0129a6fe1bcaf4b3
 SHA512:
-  metadata.gz: af1a8de6400d7f4ef38bc8a6b80e8561ac6fb5fbf228cf858d3c5894ee320c7e017045734e041911fcde0490e29276f91986fbfeb2276dcbfbf27bc0715443fa
-  data.tar.gz: 27319e322ee0600a762e5c49591b9db54c6d22b7926ce751d6ecfa323cc28e0ee0a0108eeaa38a8f36ded661704cda9b0c4bfff7f0f44a8c97b829a386895b39
+  metadata.gz: d7cc652733e6811873f6fa2d1abc282120adc43fefee116f271ab96890d236d014b2ce9bf89a3b6b886ab69000d4b4f9b38e522f00bf644f9ff5c8659d641efb
+  data.tar.gz: 2c5590cb4815ef1a793f8f1c2e74dbda26d13d635a92f2c96d1b193f84b1a6ca69c71e5043c30fd5334eb772d7ffee1712bba54a33db0ae508364504793f6195

data/README.md

@@ -18,6 +18,7 @@ Features and Compatibility
 * snapshots.
 * rsync & NFS using built-in Vagrant synced folders.
 * Provision using built-in Vagrant provisioner.
+* package
 
 Requirements
 ------------
@@ -51,7 +52,7 @@ Vagrant.configure("2") do |config|
   #    https://www.vmware.com/support/developer/ovf/
   #
   #    If your box is stuck at "Powered On", then most likely
-  #    the system didn't have the vmware tools installed.
+  #    the system doesn't have the vmware tools installed.
   #
   # Here are some of the MANY examples....
   config.vm.box = 'hashicorp/precise64'
@@ -60,6 +61,9 @@ Vagrant.configure("2") do |config|
   #config.vm.box = 'laravel/homestead'
   #config.vm.box = 'centos/7'
   #config.vm.box = 'bento/ubuntu-14.04'
+  #config.vm.box = 'generic/fedora26'
+  #config.vm.box = 'generic/alpine36'
+
 
   #  Supports type rsync and NFS.
   config.vm.synced_folder('.', '/Vagrantfiles', type: 'rsync')
@@ -148,6 +152,7 @@ Vagrant.configure("2") do |config|
     #    when you run vagrant up.   ie,  if the vmname already exists,
     #    it will be destroyed, then over written...  This is helpful
     #    if you have a VM that became an orphan (vagrant lost association).
+    #    This will also overwrite your box when using vagrant package.
     #esxi.allow_overwrite = 'True'
 
   end
@@ -173,7 +178,7 @@ Basic usage
 Known issues with vmware_esxi
 -----------------------------
 * Cleanup doesn't always destroy a VM that has been partially built.  Use the allow_overwrite = 'True' option if you need to force a rebuild.
-* ovftool for windows doesn't put ovftool.exe in your path.  You can manually set your path, or install ovftool in the \HashiCorp\Vagrant\bin directory.
+* ovftool installer for windows doesn't put ovftool.exe in your path.  You can manually set your path, or install ovftool in the \HashiCorp\Vagrant\bin directory.
 * Built-in Vagrant synced folders using NFS fails if you try to re-provision.
   * In general I find NFS synced folders pretty "flakey" anyways...
 * Multi machines may not provision one VM if the boxes are different.

data/example_box/Vagrantfile

@@ -1,20 +1,23 @@
 Vagrant.configure("2") do |config|
 
-  #  Box, Select any box created for VMware that is compatible with
+  #  Select any box created for VMware that is compatible with
   #    the ovftool.  To get maximum compatiblity You should download
   #    and install the latest version for your OS.
   #    https://www.vmware.com/support/developer/ovf/
   #
   #    If your box is stuck at "Powered On", then most likely
-  #    the system didn't have the vmware tools installed.
+  #    the system doesn't have the vmware tools installed.
   #
-  # Here are some of the MANY examples....
+  # Here are some of the MANY box examples....
   config.vm.box = 'hashicorp/precise64'
   #config.vm.box = 'steveant/CentOS-7.0-1406-Minimal-x64'
   #config.vm.box = 'geerlingguy/ubuntu1604'
   #config.vm.box = 'laravel/homestead'
   #config.vm.box = 'centos/7'
   #config.vm.box = 'bento/ubuntu-14.04'
+  #config.vm.box = 'generic/fedora26'
+  #config.vm.box = 'generic/alpine36'
+
 
   #  Supports type rsync and NFS.
   config.vm.synced_folder('.', '/Vagrantfiles', type: 'rsync')
@@ -103,6 +106,7 @@ Vagrant.configure("2") do |config|
     #    when you run vagrant up.   ie,  if the vmname already exists,
     #    it will be destroyed, then over written...  This is helpful
     #    if you have a VM that became an orphan (vagrant lost association).
+    #    This will also overwrite your box when using vagrant package.
     #esxi.allow_overwrite = 'True'
 
   end

data/lib/vagrant-vmware-esxi/action.rb

@@ -147,6 +147,13 @@ module VagrantPlugins
         end
       end
 
+      def self.action_package
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ReadState
+          b.use Package
+        end
+      end
+
       action_root = Pathname.new(File.expand_path('../action', __FILE__))
       autoload :ConnectESXi, action_root.join('connect_esxi')
       autoload :CreateVM, action_root.join('createvm')
@@ -157,6 +164,7 @@ module VagrantPlugins
       autoload :Destroy, action_root.join('destroy')
       autoload :Suspend, action_root.join('suspend')
       autoload :Resume, action_root.join('resume')
+      autoload :Package, action_root.join('package')
       autoload :SnapshotInfo, action_root.join('snapshot_info')
       autoload :SnapshotList, action_root.join('snapshot_list')
       autoload :SnapshotSave, action_root.join('snapshot_save')

data/lib/vagrant-vmware-esxi/action/createvm.rb

@@ -261,7 +261,7 @@ module VagrantPlugins
             # Using ovftool, import vmx in box folder, export to ESXi server
             #
             unless system 'ovftool --version'
-              raise Errors::ESXiConfigError,
+              raise Errors::OVFToolError,
                     message: 'ovftool not found or not in your path.'\
                              "  Please download and "\
                              '  install from http://www.vmware.com.'
@@ -276,7 +276,7 @@ module VagrantPlugins
             #  Security bug if unremarked! Password will be exposed in log file.
             #  @logger.info("vagrant-vmware-esxi, createvm: ovf_cmd #{ovf_cmd}")
             unless system "#{ovf_cmd}"
-              raise Errors::ESXiConfigError, message: 'Error with ovftool...'
+              raise Errors::OVFToolError, message: ''
             end
 
             # VMX file is not needed any longer

data/lib/vagrant-vmware-esxi/action/package.rb

@@ -0,0 +1,139 @@
+require 'log4r'
+require 'net/ssh/simple'
+require 'fileutils'
+
+module VagrantPlugins
+  module ESXi
+    module Action
+      # This action will save (create) a new snapshot
+      class Package
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_vmware_esxi::action::package')
+          env['package.files'] ||= {}
+          env['package.output'] ||= 'package'
+        end
+
+        def call(env)
+          suspend(env)
+          @app.call(env)
+        end
+
+        def suspend(env)
+          @logger.info('vagrant-vmware-esxi, package: start...')
+
+          # Get config.
+          machine = env[:machine]
+          config = env[:machine].provider_config
+
+          @logger.info("vagrant-vmware-esxi, package: machine id: #{machine.id}")
+          @logger.info("vagrant-vmware-esxi, package: current state: #{env[:machine_state]}")
+
+          if env[:machine_state].to_s != 'powered_off'
+           env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                message: 'Cannot package in this state, must '\
+                                         'be powered off.')
+          else
+            env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                 message: 'Attempting to package')
+
+            if (config.allow_overwrite =~ %r{true}i) ||
+               (config.allow_overwrite =~ %r{yes}i)
+              overwrite_opts = '--overwrite'
+            else
+              overwrite_opts = nil
+            end
+
+            boxname = env['package.output'].gsub('/', '-VAGRANTSLASH-')
+            tmpdir = "ZZZZ_tmpdir"
+            Dir.mkdir(tmpdir) unless File.exists?(tmpdir)
+
+            env[:ui].info I18n.t('vagrant_vmware_esxi.vagrant_vmware_esxi_message',
+                                 message: "boxname: #{boxname}.box")
+
+            if File.exists?("#{boxname}.box") && overwrite_opts.nil?
+              raise Errors::GeneralError,
+                    message: "#{boxname}.box already exists.  Set \n"\
+                             "  allow_overwrite='True' in Vagrantfile for force."
+            end
+
+            # Find a tar/bsdtar
+            if system 'tar --version >/dev/null 2>&1'
+              tar_cmd = 'tar'
+            elsif system 'bsdtar --version >/dev/null 2>&1'
+              tar_cmd = 'bsdtar'
+            else
+              raise Errors::ESXiConfigError,
+                    message: 'unable to find tar in your path.'
+            end
+
+            # Check if user files and Vagrantfile exists
+            if env['package.include']
+              env['package.include'].each do |f|
+                unless File.exists?(f)
+                  raise Errors::GeneralError,
+                        message: "file not found #{f}"
+                end
+              end
+            end
+            if env['package.vagrantfile']
+              unless File.exists?(env['package.vagrantfile'])
+                raise Errors::GeneralError,
+                      message: "file not found #{env['package.vagrantfile']}"
+              end
+            end
+
+            #
+            # Using ovftool, import vmx in box folder, export to ESXi server
+            #
+            unless system 'ovftool --version'
+              raise Errors::OVFToolError,
+                    message: 'ovftool not found or not in your path.'\
+                             "  Please download and "\
+                             '  install from http://www.vmware.com.'
+            end
+
+            ovf_cmd = "ovftool --noSSLVerify -tt=VMX --name=\"#{boxname}\" "\
+                      "#{overwrite_opts} vi://#{config.esxi_username}:"\
+                      "#{config.esxi_password}@#{config.esxi_hostname}"\
+                      "?moref=vim.VirtualMachine:#{machine.id} #{tmpdir}"
+
+            unless system "#{ovf_cmd}"
+              raise Errors::OVFToolError, message: ''
+            end
+
+            #  Add user files, Vagrantfile & metadata
+            if env['package.include']
+              env['package.include'].each do |f|
+                env[:ui].info("Including user file: #{f}")
+                FileUtils.cp(f, "#{tmpdir}/#{boxname}/")
+              end
+            end
+            if env['package.vagrantfile']
+              env[:ui].info('Including user Vagrantfile')
+              FileUtils.cp(env['package.vagrantfile'], "#{tmpdir}/#{boxname}/")
+            end
+            #  Add metadata.json
+            File.open("#{tmpdir}/#{boxname}/metadata.json", "w") do |f|
+              unless f.write('{"provider":"vmware"}')
+                raise Errors::GeneralError, message: 'cannot create metadata.json'
+              end
+            end
+
+            env[:ui].info("tarring #{boxname}.box")
+            unless system "cd #{tmpdir}/#{boxname} ; #{tar_cmd} cvf ../../#{boxname}.box *"
+              raise Errors::GeneralError,
+                    message: 'tar command failed.'
+            end
+
+            env[:ui].info("Doing cleanup.")
+            unless FileUtils.rm_r tmpdir
+              raise Errors::GeneralError,
+                    message: "unable to remove tmpdir. (#{tmpdir})"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-esxi/errors.rb

@@ -17,6 +17,15 @@ module VagrantPlugins
       class ESXiConfigError < VagrantESXiErrors
         error_key(:esxi_config_error)
       end
+
+      # Error class
+      class OVFToolError < VagrantESXiErrors
+        error_key(:esxi_ovftool_error)
+      end
+      # Error class
+      class GeneralError < VagrantESXiErrors
+        error_key(:general_error)
+      end
     end
   end
 end

data/lib/vagrant-vmware-esxi/version.rb

@@ -1,6 +1,6 @@
 #  VERSION
 module VagrantPlugins
   module ESXi
-    VERSION = '1.1.2'
+    VERSION = '1.1.3'
   end
 end

data/locales/en.yml

@@ -18,6 +18,12 @@ en:
       esxi_config_error: |-
         There was an ESXi configuration error.
           %{message}
+      esxi_ovftool_error: |-
+        There was an OVF Tool error.
+          %{message}
+      general_error: |-
+        There was an error.
+          %{message}
     vagrant_vmware_esxi_message: |-
       --- %{message}
     vmbuild_not_done: |-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-vmware-esxi
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Jonathan Senkerik
@@ -128,6 +128,7 @@ files:
 - lib/vagrant-vmware-esxi/action/createvm.rb
 - lib/vagrant-vmware-esxi/action/destroy.rb
 - lib/vagrant-vmware-esxi/action/halt.rb
+- lib/vagrant-vmware-esxi/action/package.rb
 - lib/vagrant-vmware-esxi/action/read_ssh_info.rb
 - lib/vagrant-vmware-esxi/action/read_state.rb
 - lib/vagrant-vmware-esxi/action/resume.rb