vagrant-vcloudair 0.5.0

data/lib/vagrant-vcloudair/errors.rb

@@ -0,0 +1,77 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module VCloudAir
+    module Errors
+      # Generic Errors during Vagrant execution
+      class VCloudAirGenericError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_vcloudair.errors')
+      end
+      class VCloudAirOldVersion < VCloudAirGenericError
+        error_key(:vcloud_old_version)
+      end
+      class CatalogAddError < VCloudAirGenericError
+        error_key(:catalog_add_error)
+      end
+      class UnauthorizedAccess < VCloudAirGenericError
+        error_key(:unauthorized_access)
+      end
+      class StopVAppError < VCloudAirGenericError
+        error_key(:stop_vapp_error)
+      end
+      class ComposeVAppError < VCloudAirGenericError
+        error_key(:compose_vapp_error)
+      end
+      class InvalidNetSpecification < VCloudAirGenericError
+        error_key(:invalid_network_specification)
+      end
+      class WontCreate < VCloudAirGenericError
+        error_key(:wont_create)
+      end
+      # Config Error that are caught during Vagrant execution
+      class VCloudAirConfigError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_vcloudair.errors.config')
+      end
+      class ServiceNotFound < VCloudAirConfigError
+        error_key(:service_not_found)
+      end
+      class VdcNotFound < VCloudAirConfigError
+        error_key(:vdc_not_found)
+      end
+      class EdgeGWNotFound < VCloudAirConfigError
+        error_key(:edgegw_not_found)
+      end
+      class EdgeGWIPNotFound < VCloudAirConfigError
+        error_key(:edgegw_ip_not_found)
+      end
+      class EdgeGWNotConnected < VCloudAirConfigError
+        error_key(:edgegw_not_connected)
+      end
+      class ForwardPortCollision < VCloudAirConfigError
+        error_key(:forward_port_collision)
+      end
+      # Errors in the REST API communication
+      class VCloudAirRestError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_vcloudair.errors.rest_errors')
+      end
+      class ObjectNotFound < VCloudAirRestError
+        error_key(:object_not_found)
+      end
+      class InvalidConfigError < VCloudAirRestError
+        error_key(:invalid_config_error)
+      end
+      class InvalidStateError < VCloudAirRestError
+        error_key(:invalid_state_error)
+      end
+      class InvalidRequestError < VCloudAirRestError
+        error_key(:invalid_request_error)
+      end
+      class UnattendedCodeError < VCloudAirRestError
+        error_key(:unattended_code_error)
+      end
+      class EndpointUnavailable < VCloudAirRestError
+        error_key(:endpoint_unavailable)
+      end
+    end
+  end
+end

data/lib/vagrant-vcloudair/model/forwarded_port.rb

@@ -0,0 +1,66 @@
+module VagrantPlugins
+  module VCloudAir
+    module Model
+      # Represents a single forwarded port for VirtualBox. This has various
+      # helpers and defaults for a forwarded port.
+      class ForwardedPort
+        # If true, this port should be auto-corrected.
+        #
+        # @return [Boolean]
+        attr_reader :auto_correct
+
+        # The unique ID for the forwarded port.
+        #
+        # @return [String]
+        attr_reader :id
+
+        # The protocol to forward.
+        #
+        # @return [String]
+        attr_reader :protocol
+
+        # The IP that the forwarded port will connect to on the guest machine.
+        #
+        # @return [String]
+        attr_reader :guest_ip
+
+        # The port on the guest to be exposed on the host.
+        #
+        # @return [Integer]
+        attr_reader :guest_port
+
+        # The IP that the forwarded port will bind to on the host machine.
+        #
+        # @return [String]
+        attr_reader :host_ip
+
+        # The port on the host used to access the port on the guest.
+        #
+        # @return [Integer]
+        attr_reader :host_port
+
+        def initialize(id, host_port, guest_port, options)
+          @id         = id
+          @guest_port = guest_port
+          @host_port  = host_port
+
+          options ||= {}
+          @auto_correct = false
+          if options.key?(:auto_correct)
+            @auto_correct = options[:auto_correct]
+          end
+          @guest_ip = options[:guest_ip] || nil
+          @host_ip = options[:host_ip] || nil
+          @protocol = options[:protocol] || 'tcp'
+        end
+
+        # This corrects the host port and changes it to the given new port.
+        #
+        # @param [Integer] new_port The new port
+        def correct_host_port(new_port)
+          @host_port = new_port
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vcloudair/plugin.rb

@@ -0,0 +1,111 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant vCloud Air plugin must be run within Vagrant.'
+end
+
+if Vagrant::VERSION < '1.6.3'
+  fail 'The Vagrant vCloud Air plugin is only compatible with Vagrant 1.6.3+'
+end
+
+module VagrantPlugins
+  module VCloudAir
+    class Plugin < Vagrant.plugin('2')
+      name 'VMware vCloud Air Provider'
+      description 'Allows Vagrant to manage machines with VMware vCloud Air(R)'
+
+      config(:vcloudair, :provider) do
+        require_relative 'config'
+        Config
+      end
+
+      # We provide support for multiple box formats, including the new standard
+      # 'vmware_ovf' and the legacy 'vcloud' and 'vcenter'.
+      provider(:vcloudair, box_format: %w[vmware_ovf vcloud vcenter]) do
+        setup_logging
+        setup_i18n
+
+        # Return the provider
+        require_relative 'provider'
+        Provider
+      end
+
+      # Add vagrant share support
+      provider_capability('vcloudair', 'public_address') do
+        require_relative 'cap/public_address'
+        Cap::PublicAddress
+      end
+
+      provider_capability(:vcloudair, :forwarded_ports) do
+        require_relative 'cap/forwarded_ports'
+        Cap::ForwardedPorts
+      end
+
+      provider_capability(:vcloudair, :winrm_info) do
+        require_relative 'cap/winrm_info'
+        Cap::WinRM
+      end
+
+      provider_capability(:vcloudair, :rdp_info) do
+        require_relative 'cap/rdp_info'
+        Cap::RDP
+      end
+
+      # Added a vagrant vcloudair-status command to enhance troubleshooting and
+      # visibility.
+      command('vcloudair') do
+        require_relative 'command'
+        Command
+      end
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml', VCloudAir.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_vcloudair')
+          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_5_1, File.expand_path('../driver/version_5_1', __FILE__)
+    end
+
+    module Model
+      autoload :ForwardedPort,
+               File.expand_path('../model/forwarded_port', __FILE__)
+    end
+
+    module Util
+      autoload :CompileForwardedPorts,
+               File.expand_path('../util/compile_forwarded_ports', __FILE__)
+    end
+  end
+end

data/lib/vagrant-vcloudair/provider.rb

@@ -0,0 +1,41 @@
+require 'log4r'
+require 'vagrant'
+
+module VagrantPlugins
+  module VCloudAir
+    class Provider < Vagrant.plugin('2', :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      def action(name)
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      def ssh_info
+        env = @machine.action('read_ssh_info')
+        env[:machine_ssh_info]
+      end
+
+      def state
+        env = @machine.action('read_state')
+
+        state_id = env[:machine_state_id]
+
+        # Translate into short/long descriptions
+        short = state_id.to_s.gsub('_', ' ')
+        long  = I18n.t("vagrant_vcloudair.vm.states.#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        id = @machine.id.nil? ? 'new' : @machine.id
+        "vCloud Air (#{id})"
+      end
+    end
+  end
+end

data/lib/vagrant-vcloudair/util/compile_forwarded_ports.rb

@@ -0,0 +1,34 @@
+require 'vagrant/util/scoped_hash_override'
+
+module VagrantPlugins
+  module VCloudAir
+    module Util
+      module CompileForwardedPorts
+        include Vagrant::Util::ScopedHashOverride
+
+        # This method compiles the forwarded ports into {ForwardedPort}
+        # models.
+        def compile_forwarded_ports(config)
+          mappings = {}
+
+          config.vm.networks.each do |type, options|
+            if type == :forwarded_port
+              guest_port = options[:guest]
+              host_port  = options[:host]
+              options    = scoped_hash_override(options, :vcloud)
+              id         = options[:id]
+
+              # skip forwarded rules already found in handle_nat_port_collisions
+              next if options[:already_exists]
+
+              mappings[host_port] =
+                Model::ForwardedPort.new(id, host_port, guest_port, options)
+            end
+          end
+
+          mappings.values
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vcloudair/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module VCloudAir
+    VERSION = '0.5.0'
+  end
+end

data/locales/en.yml

@@ -0,0 +1,169 @@
+en:
+  vagrant_vcloudair:
+    vapp:
+      build_vapp: |-
+        Building vApp...
+      vapp_created: |-
+        vApp %{vapp_name} successfully created.
+      vapp_creation_failed: |-
+        vApp %{vapp_name} creation failed!
+      adding_vm: |-
+        Adding VM to existing vApp...
+      vm_add_failed: |-
+        VM %{vm_name} add to %{vapp_name} failed!
+      destroy_vapp: |-
+        Destroying vApp...
+      poweroff_vapp: |-
+        Single VM left in the vApp, Powering off vApp...
+    catalog:
+      create_catalog: |-
+        Catalog [%{catalog_name}] successfully created.
+      create_catalog_ask: |-
+        Would you like to create the [#{cfg.catalog_name}] catalog?
+        Choice (yes/no): 
+      catalog_not_created: |-
+        Catalog not created, exiting...
+      add_to_catalog: |-
+        Adding [%{box_name}] to Catalog [%{catalog_name}]
+      nonexistant_catalog: |-
+        Catalog [%{catalog_name}] does not exist!
+      nonexistant_catalog_item: |-
+        Catalog item [%{catalog_item}] in Catalog [%{catalog_name}] does not exist!"
+      upload_ask: |-
+        Would you like to upload the [%{catalog_item}] box to [%{catalog_name}] Catalog?
+        Choice (yes/no):
+      uploading: |-
+        Uploading [%{catalog_item}]...
+      catalog_item_not_available: |-
+        Catalog item not available, exiting...
+    edge:
+      network_test: |-
+        Testing Network Configuration in vCloud Air...
+      removing_nat_rules: |-
+        Removing NAT rules on [%{vdc_edge_gateway}] for IP [%{vdc_edge_gateway_ip}].
+      port_forwarding: |-
+        Forwarding Ports: VM port %{guest_port} -> vShield Edge port %{host_port}
+      nat_rules_creation: |-
+        Creating NAT rules on [%{vdc_edge_gateway}] for IP [%{vapp_edge_ip}] port %{port}.
+    vm:
+      setting_vm_hardware: |-
+        Setting VM hardware...
+      poweron_vm: |-
+        Powering on VM...
+      suspend_vm: |-
+        Suspending VM...
+      vm_not_created: |-
+        The VM has not been created
+      will_not_destroy: |-
+        VM will not be destroyed
+      vm_already_running: |-
+        VM is already running
+      vm_not_running: |-
+        VM is not running
+      vm_halted_cannot_suspend: |-
+        VM is not running or already suspended, cannot suspend it.
+      ssh_announce: |-
+        External IP for %{machine_name}: %{ip}
+      destroy_vm: |-
+        Destroying VM...
+      poweroff_vm: |-
+        Powering off VM...
+      waiting_for_ssh: |-
+        Waiting for %{port_name} Access on %{external_ip}:%{external_port} ...
+      states:
+        not_created: |-
+          The environment has not yet been created. Run `vagrant up` to
+          create the environment. If a machine is not created, only the
+          default provider will be shown. So if a provider is not listed,
+          then the machine is not created for that environment.
+        suspended: |-
+          The VM is paused. To resume the VM, simply run `vagrant up`
+          or `vagrant resume`
+        stopped: |-
+          The VM is powered off. To restart the VM, simply run `vagrant up`
+        running: |-
+          The VM is running. To stop this VM, you can run `vagrant halt` to
+          shut it down forcefully, or you can run `vagrant suspend` to simply
+          suspend the virtual machine. In either case, to restart it again,
+          simply run `vagrant up`.
+    errors:
+      missing_compute_resource: |-
+        Configured compute resource not found
+      missing_datacenter: |-
+        Configured data center not found
+      missing_resource_pool: |-
+        Configured resource pool not found
+      missing_template: |-
+        Configured template VM could not be found
+      vcloud_old_version: |-
+        Sorry, VMware vCloud Air API version %{version} is not supported
+      unauthorized_access: |-
+        Access not authorized, please verify the username and password in your
+        Vagrantfile
+      catalog_add_error: |-
+        Impossible to add Box to Catalog, error: %{message}
+      invalid_network_specification: |-
+        Wrong Network specification in the Vagrantfile, make sure you have
+        access to the specified network.
+      wont_create: |-
+        User rejected creation/upload of %{item}, exiting...
+      stop_vapp_error: |-
+        Impossible to stop vApp, could be a transient error, please try again,
+        error: %{message}
+      compose_vapp_error: |-
+        Impossible to compose a vApp, error: %{message}
+      rest_errors:
+        object_not_found: |-
+          Object not found in vCloud Air, %{message}. Please report this Error.
+        invalid_config_error: |-
+          Invalid Guest Customization Specified
+        invalid_state_error: |-
+          Invalid vApp State %{message}
+        invalid_request_error: |-
+          Invalid request %{message}
+        unattended_code_error: |-
+          Unattended code received %{message}
+        endpoint_unavailable: |-
+          Can't connect to vCloud Air, please verify connectivity.
+      config:
+        username: |-
+          Configuration must specify a vCloud Air username
+        password: |-
+          Configuration must specify a vCloud Air password
+        dns_not_valid: |-
+          One or more DNS names specified are invalid
+        dns_specified_as_subnet: |-
+          One or more DNS names are specified as subnets
+        ip_dns: |-
+          DNS configuration must be specified as an Array type
+        edge_gateway_ip_not_valid: |-
+          The Edge Gateway IP specified is not invalid
+        edge_gateway_ip_specified_as_subnet: |-
+          The Edge Gateway IP specified is specified as subnet
+        ip_subnet_not_valid: |-
+          The specified subnet is invalid
+        ip_subnet_too_small: |-
+          The specified subnet is too small, must contain at least 2 usable IPs (/30 or 255.255.255.252)
+        catalog_name: |-
+          Configuration must specify a vCloud Air Catalog (for the VM templates images)
+        vdc_name: |-
+          Configuration must specify a vCloud Air Virtual Datacenter (Target Organization VDC)
+        vdc_network_name: |-
+          Configuration must specify a vCloud Air Network Name
+        mixed_bridge: |-
+          Configuration 'network_bridge' and 'vdc_edge_gateway'/'vdc_edge_gateway_ip' are mutually exclusive
+        wrong_edge_configuration: |-
+          Configuration 'vdc_edge_gateway' and 'vdc_edge_gateway_ip' must be both specified
+        service_not_found: |-
+          The specified Service cannot be found, please verify your 'cloud_id' and/or 'vdc_name' parameters.
+        vdc_not_found: |-
+          The Virtual Data Center %{message} cannot be found, please verify your 'vdc_name' parameter.
+        edgegw_not_found: |-
+          The specified Edge Gateway %{message} cannot be found, please verify your 'vdc_edge_gateway' parameter.
+        edgegw_ip_not_found: |-
+          The specified Edge Gateway IP %{message} cannot be found, please verify your 'vdc_edge_gateway_ip' parameter.
+        edgegw_not_connected: |-
+          The Edge Gateway %{edge} is not connected to network %{network}, please check your Vagrantfile parameters.
+        forward_port_collision: |-
+          Port collision detected, change it in the Vagrantfile or add auto_correct: true. %{guest_port} => %{host_port}
+