vagrant-vmware-appcatalyst 1.0.1

data/lib/vagrant-vmware-appcatalyst/driver/meta.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+# Copyright (c) 2015 VMware, Inc.  All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License.  You may obtain a copy of
+# the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, without
+# warranties or conditions of any kind, EITHER EXPRESS OR IMPLIED.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'forwardable'
+require 'log4r'
+require 'httpclient'
+require 'json'
+
+require File.expand_path('../base', __FILE__)
+
+module VagrantPlugins
+  module AppCatalyst
+    module Driver
+      class Meta < Base
+        extend Forwardable
+        attr_reader :endpoint
+        attr_reader :version
+
+        def initialize(endpoint)
+          super()
+
+          @logger = Log4r::Logger.new('vagrant::provider::appcatalyst::meta')
+
+          @endpoint = endpoint
+
+          # Read and assign the version of AppCatalyst we know which
+          # specific driver to instantiate.
+          @logger.debug("Asking API Version with host_url: #{@endpoint}")
+          @version = get_api_version(@endpoint) || ''
+
+          # Instantiate the proper version driver for AppCatalyst
+          @logger.debug("Finding driver for AppCatalyst version: #{@version}")
+          driver_map   = {
+            '1.0.0' => Version_1_0
+          }
+
+          driver_klass = nil
+          driver_map.each do |key, klass|
+            if @version.start_with?(key)
+              driver_klass = klass
+              break
+            end
+          end
+
+          unless driver_klass
+            supported_versions = driver_map.keys.sort.join(', ')
+            fail Errors::AppCatalystInvalidVersion,
+                 :supported_versions => supported_versions
+          end
+
+          @logger.info("Using AppCatalyst driver: #{driver_klass}")
+          @driver = driver_klass.new(@endpoint)
+        end
+
+        def_delegators :@driver,
+                       :get_vm,
+                       :get_vm_power,
+                       :get_vm_ipaddress,
+                       :set_vm_power,
+                       :delete_vm,
+                       :import_vm,
+                       :list_vm,
+                       :get_vm_shared_folders,
+                       :set_vm_shared_folders,
+                       :add_vm_shared_folder,
+                       :get_vm_shared_folder,
+                       :delete_vm_shared_folder,
+                       :clone_vm_in_directory,
+                       :set_vmx_value
+        protected
+
+        def get_api_version(endpoint)
+          # Create a new HTTP client
+          clnt = HTTPClient.new
+          uri = URI(endpoint)
+          url = "#{uri.scheme}://#{uri.host}:#{uri.port}/json/swagger.json"
+
+          begin
+            response = clnt.request('GET', url, nil, nil, nil)
+            unless response.ok?
+              fail Errors::UnattendedCodeError,
+                   :message => response.status + ' ' + response.reason
+            end
+
+            api_definition = JSON.parse(response.body)
+
+            api_definition['info']['version']
+
+          rescue SocketError, Errno::EADDRNOTAVAIL, Errno::ETIMEDOUT, Errno::ECONNREFUSED
+            raise Errors::EndpointUnavailable
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-appcatalyst/driver/version_1_0.rb

@@ -0,0 +1,223 @@
+# encoding: utf-8
+# Copyright (c) 2015 VMware, Inc.  All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License.  You may obtain a copy of
+# the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, without
+# warranties or conditions of any kind, EITHER EXPRESS OR IMPLIED.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'uri'
+require 'vagrant/util/platform'
+require 'log4r'
+
+module VagrantPlugins
+  module AppCatalyst
+    module Driver
+      # Main class to access AppCatalyst rest APIs
+      class Version_1_0 < Base
+
+        ##
+        # Init the driver with the Vagrantfile information
+        def initialize(endpoint)
+          super()
+
+          @logger = Log4r::Logger.new('vagrant::provider::appcatalyst::driver_1_0')
+          @logger.debug("AppCatalyst Driver 1.0 loaded")
+          @endpoint = endpoint
+        end
+
+        ##
+        # Fetch details about a given VM
+        def get_vm(vm_id)
+          params = {
+            'method'  => :get,
+            'command' => "/api/vms/#{vm_id}"
+          }
+
+          response, _headers = send_request(params)
+
+          response
+        end
+
+        def get_vm_power(vm_id)
+          params = {
+            'method'  => :get,
+            'command' => "/api/vms/power/#{vm_id}"
+          }
+
+          response, _headers = send_request(params)
+
+          response
+        end
+
+        def get_vm_ipaddress(vm_id)
+          params = {
+            'method'  => :get,
+            'command' => "/api/vms/#{vm_id}/ipaddress"
+          }
+
+          response, _headers = send_request(params)
+
+          response
+        end
+
+        def set_vm_power(vm_id, operation)
+          params = {
+            'method'  => :patch,
+            'command' => "/api/vms/power/#{vm_id}"
+          }
+
+          response, _headers = send_request(
+            params,
+            operation,
+            'application/json'
+          )
+
+          response
+        end
+
+        def delete_vm(vm_id)
+          params = {
+            'method'  => :delete,
+            'command' => "/api/vms/#{vm_id}"
+          }
+
+          _response, _headers = send_request(params)
+        end
+
+        def import_vm(vm_id, name, source_reference, tag)
+          @logger.debug("Importing #{name}")
+          vm_to_import = {
+            'id' => vm_id,
+            'name' => name,
+            'sourceReference' => source_reference,
+            'tag' => tag
+          }
+
+          params = {
+            'method'  => :post,
+            'command' => '/api/vms'
+          }
+
+          @logger.debug("JSON stuff #{JSON.generate(vm_to_import)}")
+          response, _headers = send_request(
+            params,
+            JSON.generate(vm_to_import),
+            'application/json'
+          )
+
+          response
+        end
+
+        def list_vms
+          params = {
+            'method'  => :get,
+            'command' => '/api/vms'
+          }
+
+          response, _headers = send_request(params)
+
+          response
+        end
+
+        def get_vm_shared_folders(vm_id)
+          params = {
+            'method'  => :get,
+            'command' => "/api/vms/#{vm_id}/folders"
+          }
+
+          response, _headers = send_request(params)
+
+          response
+        end
+
+        def set_vm_shared_folders(vm_id, operation)
+          params = {
+            'method'  => :patch,
+            'command' => "/api/vms/#{vm_id}/folders"
+          }
+
+          response, _headers = send_request(
+            params,
+            operation,
+            'application/json'
+          )
+
+          response
+        end
+
+        def add_vm_shared_folder(vm_id, guest_path, host_path, flags)
+          @logger.debug("Adding Shared Folder #{guest_path} to #{vm_id}")
+          shared_folder_to_add = {
+            'guestPath' => guest_path,
+            'hostPath' => host_path,
+            'flags' => flags
+          }
+
+          params = {
+            'method'  => :post,
+            'command' => "/api/vms/#{vm_id}/folders"
+          }
+
+          @logger.debug("JSON stuff #{JSON.generate(shared_folder_to_add)}")
+          response, _headers = send_request(
+            params,
+            JSON.generate(shared_folder_to_add),
+            'application/json'
+          )
+
+          response
+        end
+
+        def get_vm_shared_folder(vm_id, shared_folder_id)
+          params = {
+            'method'  => :get,
+            'command' => "/api/vms/#{vm_id}/folders/#{shared_folder_id}"
+          }
+
+          response, _headers = send_request(params)
+
+          response
+        end
+
+        def delete_vm_shared_folder(vm_id, shared_folder_id)
+          params = {
+            'method'  => :delete,
+            'command' => "/api/vms/#{vm_id}/folders/#{shared_folder_id}"
+          }
+
+          _response, _headers = send_request(params)
+        end
+
+        def clone_vm_in_directory(src, dest)
+          @logger.debug("Cloning VM from #{src} to #{dest}")
+          FileUtils.cp_r("#{src}/.", dest)
+        end
+
+        def set_vmx_value(vmx_file, key, value)
+          # read VMX in a hash
+          temp_vmx = Hash[File.read(vmx_file).scan(/^(.+?)\s*=\s*"(.*?)"\s*$/)]
+          vmx = Hash[temp_vmx.map { |k, v| v.class == Array ? [k, v.map { |r| f r }.to_a] : [k.downcase, v]}]
+          @logger.debug("Setting #{key} = #{value} in VMX")
+          # Set the key/value
+          vmx[key.downcase] = value
+
+          # Open file for writing
+          f = File.open(vmx_file, 'w')
+
+          # Write file in order
+          vmx.sort.map do |k, v|
+            f.write("#{k} = \"#{v}\"\n")
+          end
+
+          f.close
+        end
+      end # Class Version 5.1
+    end # Module Driver
+  end # module AppCatalyst
+end # Module VagrantPlugins

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

@@ -0,0 +1,44 @@
+# encoding: utf-8
+# Copyright (c) 2015 VMware, Inc.  All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License.  You may obtain a copy of
+# the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, without
+# warranties or conditions of any kind, EITHER EXPRESS OR IMPLIED.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'vagrant'
+
+module VagrantPlugins
+  module AppCatalyst
+    module Errors
+      # Generic Errors during Vagrant execution
+      class AppCatalystGenericError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_appcatalyst.errors')
+      end
+      class AppCatalystOldVersion < AppCatalystGenericError
+        error_key(:appcatalyst_old_version)
+      end
+      # Errors in the REST API communication
+      class AppCatalystRestError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_appcatalyst.errors.rest_errors')
+      end
+      class UnattendedCodeError < AppCatalystRestError
+        error_key(:unattended_code_error)
+      end
+      class EndpointUnavailable < AppCatalystRestError
+        error_key(:endpoint_unavailable)
+      end
+      class AppCatalystViolationError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_appcatalyst.errors.violations')
+      end
+      class PowerOnNotAllowed < AppCatalystViolationError
+        error_key(:poweron_not_allowed)
+      end
+    end
+  end
+end

data/lib/vagrant-vmware-appcatalyst/plugin.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+# Copyright (c) 2015 VMware, Inc.  All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License.  You may obtain a copy of
+# the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, without
+# warranties or conditions of any kind, EITHER EXPRESS OR IMPLIED.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant AppCatalyst plugin must be run within Vagrant.'
+end
+
+if Vagrant::VERSION < '1.6.3'
+  fail 'The Vagrant AppCatalyst plugin is only compatible with Vagrant 1.6.3+'
+end
+
+module VagrantPlugins
+  module AppCatalyst
+    class Plugin < Vagrant.plugin('2')
+      name 'VMware AppCatalyst Provider'
+      description 'Allows Vagrant to manage machines with VMware AppCatalyst®'
+
+      config(:vmware_appcatalyst, :provider) do
+        require_relative 'config'
+        Config
+      end
+
+      # We provide support for multiple box formats.
+      provider(
+        :vmware_appcatalyst,
+        box_format: %w(vmware_desktop vmware_fusion vmware_workstation),
+        parallel: true
+      ) do
+        setup_logging
+        setup_i18n
+
+        # Return the provider
+        require_relative 'provider'
+        Provider
+      end
+
+      # Add vagrant share support
+      provider_capability('vmware_appcatalyst', 'public_address') do
+        require_relative 'cap/public_address'
+        Cap::PublicAddress
+      end
+
+      synced_folder(:vmware_appcatalyst) do
+        require File.expand_path('../synced_folder', __FILE__)
+        SyncedFolder
+      end
+
+      # Add vmware shared folders mount capability to linux
+      guest_capability('linux', 'mount_appcatalyst_shared_folder') do
+        require_relative 'cap/mount_appcatalyst_shared_folder'
+        Cap::MountAppCatalystSharedFolder
+      end
+
+      guest_capability('linux', 'unmount_appcatalyst_shared_folder') do
+        require_relative 'cap/mount_appcatalyst_shared_folder'
+        Cap::MountAppCatalystSharedFolder
+      end
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml', AppCatalyst.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require 'log4r'
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as 'true' resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil unless level.is_a?(Integer)
+
+        # Set the logging level on all 'vagrant' namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new('vagrant_appcatalyst')
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          # logger = nil
+        end
+      end
+    end
+
+    module Driver
+      autoload :Meta, File.expand_path('../driver/meta', __FILE__)
+      autoload :Version_1_0, File.expand_path('../driver/version_1_0', __FILE__)
+    end
+  end
+end