[vcloud_director|tests] Add generator tests.

2022-11-09 13:51:43 -05:00 · 2013-09-30 14:56:10 +01:00 · 2013-09-30 14:56:10 +01:00 · 1648c933e0
commit 1648c933e0
parent 0573ceebc3
12 changed files with 384 additions and 64 deletions
--- a/.gitignore
+++ b/.gitignore
@ -22,4 +22,5 @@ spec/credentials.yml
 vendor/*
 tags
 tests/digitalocean/fixtures/
+tests/vcloud_director/fixtures/vcloud/v1.5/schema/*.xsd
 tests/vcloud_director/vcr_cassettes/
--- a/lib/fog/vcloud_director/generators/compute/customization.rb
+++ b/lib/fog/vcloud_director/generators/compute/customization.rb
@ -59,15 +59,11 @@ module Fog
          private

          def header
-            '<GuestCustomizationSection xmlns="http://www.vmware.com/vcloud/v1.5"
+            <<-END
+            <GuestCustomizationSection xmlns="http://www.vmware.com/vcloud/v1.5"
              xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
-              type="application/vnd.vmware.vcloud.guestCustomizationSection+xml"
-              ovf:required="false"
-              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-              xsi:schemaLocation="http://schemas.dmtf.org/ovf/envelope/1
-                http://schemas.dmtf.org/ovf/envelope/1/dsp8023_1.1.0.xsd
-                http://www.vmware.com/vcloud/v1.5
-                http://zone01.bluelock.com/api/v1.5/schema/master.xsd">'
+              type="application/vnd.vmware.vcloud.guestCustomizationSection+xml">
+            END
          end

          # The order matters: http://communities.vmware.com/thread/448760?start=0&tstart=0
@ -83,7 +79,7 @@ module Fog
          #   * " &quot;
          #   * ' &apos;
          def body(opts={})
-            body = "
+            <<-END
              <ovf:Info>Specifies Guest OS Customization Settings</ovf:Info>
              <Enabled>#{opts[:enabled]}</Enabled>
              <ChangeSid>#{opts[:change_sid]}</ChangeSid>
@ -94,11 +90,14 @@ module Fog
              <AdminPasswordAuto>#{opts[:admin_password_auto]}</AdminPasswordAuto>
              <ResetPasswordRequired>#{opts[:reset_password_required]}</ResetPasswordRequired>
              <CustomizationScript>#{CGI::escapeHTML(opts[:customization_script]).gsub(/\r/, "&#13;")}</CustomizationScript>
-              <ComputerName>#{opts[:computer_name]}</ComputerName>"
+              <ComputerName>#{opts[:computer_name]}</ComputerName>
+            END
          end

          def tail
-            '</GuestCustomizationSection>'
+            <<-END
+            </GuestCustomizationSection>
+            END
          end
        end
      end
--- a/lib/fog/vcloud_director/generators/compute/disks.rb
+++ b/lib/fog/vcloud_director/generators/compute/disks.rb
@ -115,17 +115,22 @@ module Fog
          end

          def header
-            '<vcloud:RasdItemsList xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
+            <<-END
+            <vcloud:RasdItemsList xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
              xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
-              type="application/vnd.vmware.vcloud.rasdItemsList+xml">'
+              type="application/vnd.vmware.vcloud.rasdItemsList+xml">
+            END
          end

          def tail
-            '</vcloud:RasdItemsList>'
+            <<-END
+            </vcloud:RasdItemsList>
+            END
          end

          def hard_disk_item(opts={})
-            "<vcloud:Item>
+            <<-END
+            <vcloud:Item>
              <rasd:AddressOnParent>#{opts[:address_on_parent]}</rasd:AddressOnParent>
              <rasd:Description>#{opts[:description]}</rasd:Description>
              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
@ -133,28 +138,33 @@ module Fog
              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
              <rasd:Parent>#{opts[:parent]}</rasd:Parent>
              <rasd:ResourceType>17</rasd:ResourceType>
-            </vcloud:Item>"
+            </vcloud:Item>
+            END
          end

          def ide_controller_item(opts={})
-            "<vcloud:Item>
-               <rasd:Address>#{opts[:address]}</rasd:Address>
-               <rasd:Description>#{opts[:description]}</rasd:Description>
-               <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
-               <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
-               <rasd:ResourceType>5</rasd:ResourceType>
-            </vcloud:Item>"
+            <<-END
+            <vcloud:Item>
+              <rasd:Address>#{opts[:address]}</rasd:Address>
+              <rasd:Description>#{opts[:description]}</rasd:Description>
+              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
+              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
+              <rasd:ResourceType>5</rasd:ResourceType>
+            </vcloud:Item>
+            END
          end

          def scsi_controller(opts={})
-            "<vcloud:Item>
+            <<-END
+            <vcloud:Item>
              <rasd:Address>#{opts[:address]}</rasd:Address>
              <rasd:Description>#{opts[:description]}</rasd:Description>
              <rasd:ElementName>#{opts[:name]}</rasd:ElementName>
              <rasd:InstanceID>#{opts[:id]}</rasd:InstanceID>
              <rasd:ResourceSubType>#{opts[:resource_sub_type]}</rasd:ResourceSubType>
              <rasd:ResourceType>6</rasd:ResourceType>
-            </vcloud:Item>"
+            </vcloud:Item>
+            END
          end

          # helpers
--- a/lib/fog/vcloud_director/generators/compute/metadata.rb
+++ b/lib/fog/vcloud_director/generators/compute/metadata.rb
@ -48,11 +48,12 @@ module Fog

          # 1.5
          def header
-            '<Metadata xmlns="http://www.vmware.com/vcloud/v1.5"
-              type="application/vnd.vmware.vcloud.metadata+xml"
+            <<-END
+            <Metadata
+              xmlns="http://www.vmware.com/vcloud/v1.5"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-              xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://10.194.1.65/api/v1.5/schema/master.xsd">
-              '
+              type="application/vnd.vmware.vcloud.metadata+xml">
+            END
          end

          def metadata_entry
@ -69,33 +70,33 @@ module Fog
          #end

          def tail
-            '</Metadata>'
+            <<-END
+            </Metadata>
+            END
          end
        end

        class MetadataV51 < MetadataBase
-          def metadata_entry(key,value)
-            body = <<EOF
-            <MetadataEntry
-              type="application/vnd.vmware.vcloud.metadata.value+xml">
+          def metadata_entry(key, value)
+            <<-END
+            <MetadataEntry type="application/vnd.vmware.vcloud.metadata.value+xml">
              <Key>#{key}</Key>
-              <TypedValue
-                xsi:type="MetadataStringValue">
+              <TypedValue xsi:type="MetadataStringValue">
                <Value>#{value}</Value>
              </TypedValue>
            </MetadataEntry>
-EOF
+            END
          end
        end

        class MetadataV15 < MetadataBase
-          def metadata_entry(key,value)
-            body = <<EOF
+          def metadata_entry(key, value)
+            <<-END
            <MetadataEntry>
-               <Key>#{key}</Key>
-               <Value>#{value}</Value>
+              <Key>#{key}</Key>
+              <Value>#{value}</Value>
            </MetadataEntry>
-EOF
+            END
          end
        end
      end
--- a/lib/fog/vcloud_director/generators/compute/vm_network.rb
+++ b/lib/fog/vcloud_director/generators/compute/vm_network.rb
@ -85,34 +85,33 @@ module Fog
          private

          def header
-              '<NetworkConnectionSection xmlns="http://www.vmware.com/vcloud/v1.5"
-                 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
-                 type="application/vnd.vmware.vcloud.networkConnectionSection+xml"
-                 ovf:required="false"
-                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                   xsi:schemaLocation="http://schemas.dmtf.org/ovf/envelope/1
-                   http://schemas.dmtf.org/ovf/envelope/1/dsp8023_1.1.0.xsd
-                   http://www.vmware.com/vcloud/v1.5 http://10.194.1.65/api/v1.5/schema/master.xsd">'
+            <<-END
+            <NetworkConnectionSection xmlns="http://www.vmware.com/vcloud/v1.5"
+              xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+              type="application/vnd.vmware.vcloud.networkConnectionSection+xml">
+            END
          end

          def body(opts={})
-            body = <<EOF
-            <ovf:Info>#{opts[:info]}</ovf:Info>
-                 <PrimaryNetworkConnectionIndex>#{opts[:primary_network_connection_index]}</PrimaryNetworkConnectionIndex>
-                 <NetworkConnection
-                     network="#{opts[:network]}"
-                     needsCustomization="#{opts[:needs_customization]}">
-                     <NetworkConnectionIndex>#{opts[:network_connection_index]}</NetworkConnectionIndex>
-                     <IpAddress>#{opts[:ip_address]}</IpAddress>
-                     <IsConnected>#{opts[:is_connected]}</IsConnected>
-                     <MACAddress>#{opts[:mac_address]}</MACAddress>
-                     <IpAddressAllocationMode>#{opts[:ip_address_allocation_mode]}</IpAddressAllocationMode>
-                 </NetworkConnection>
-EOF
+            <<-END
+              <ovf:Info>#{opts[:info]}</ovf:Info>
+              <PrimaryNetworkConnectionIndex>#{opts[:primary_network_connection_index]}</PrimaryNetworkConnectionIndex>
+              <NetworkConnection
+                network="#{opts[:network]}"
+                needsCustomization="#{opts[:needs_customization]}">
+                <NetworkConnectionIndex>#{opts[:network_connection_index]}</NetworkConnectionIndex>
+                <IpAddress>#{opts[:ip_address]}</IpAddress>
+                <IsConnected>#{opts[:is_connected]}</IsConnected>
+                <MACAddress>#{opts[:mac_address]}</MACAddress>
+                <IpAddressAllocationMode>#{opts[:ip_address_allocation_mode]}</IpAddressAllocationMode>
+              </NetworkConnection>
+            END
          end

          def tail
-            '</NetworkConnectionSection>'
+            <<-END
+            </NetworkConnectionSection>
+            END
          end
        end
      end
--- a/tests/vcloud_director/fixtures/vcloud/v1.5/schema/README.md
+++ b/tests/vcloud_director/fixtures/vcloud/v1.5/schema/README.md
@ -0,0 +1,2 @@
+Output of generators will be validated against the XML schema if copies of the
+schema definition files are placed here.
--- a/tests/vcloud_director/generators/compute/disks_tests.rb
+++ b/tests/vcloud_director/generators/compute/disks_tests.rb
@ -0,0 +1,42 @@
+Shindo.tests('Compute::VcloudDirector | disks generator', ['vclouddirector', 'xsd']) do
+
+  require 'fog/vcloud_director/generators/compute/disks'
+
+  tests('#generate_xml').returns(String) do
+    @items =
+      {:disks=>
+       [{:address=>0,
+         :description=>"SCSI Controller",
+         :name=>"SCSI Controller 0",
+         :id=>2,
+         :resource_sub_type=>"VirtualSCSI",
+         :resource_type=>6},
+        {:address_on_parent=>0,
+         :description=>"Hard disk",
+         :name=>"Hard disk 1",
+         :id=>2000,
+         :parent=>2,
+         :resource_type=>17,
+         :capacity=>16384,
+         :bus_sub_type=>"VirtualSCSI",
+         :bus_type=>6},
+        {:address=>0,
+         :description=>"IDE Controller",
+         :name=>"IDE Controller 0",
+         :id=>3,
+         :resource_type=>5}]}
+    @xml = Fog::Generators::Compute::VcloudDirector::Disks.new(@items).generate_xml
+    @xml.class
+  end
+
+  tests('#parse').returns(Nokogiri::XML::Document) do
+    @doc = Nokogiri::XML::Document.parse(@xml)
+    @doc.class
+  end
+
+  tests('#validate').returns([]) do
+    pending unless VcloudDirector::Generators::Helpers.have_xsd?
+    VcloudDirector::Generators::Helpers.validate(@doc)
+  end
+
+end
--- a/tests/vcloud_director/generators/compute/guest_customization_section_tests.rb
+++ b/tests/vcloud_director/generators/compute/guest_customization_section_tests.rb
@ -0,0 +1,36 @@
+Shindo.tests('Compute::VcloudDirector | GuestCustomizationSection generator', ['vclouddirector', 'xsd']) do
+
+  require 'fog/vcloud_director/generators/compute/customization'
+
+  tests('#generate_xml').returns(String) do
+    @attrs =
+      {:type=>"application/vnd.vmware.vcloud.guestCustomizationSection+xml",
+       :href=>
+        "https://example.com/api/vApp/vm-2bbbf556-55dc-4974-82e6-aa6e814f0b64/guestCustomizationSection/",
+       :id=>"vm-2bbbf556-55dc-4974-82e6-aa6e814f0b64",
+       :enabled=>false,
+       :change_sid=>false,
+       :virtual_machine_id=>"2bbbf556-55dc-4974-82e6-aa6e814f0b64",
+       :join_domain_enabled=>false,
+       :use_org_settings=>false,
+       :admin_password_enabled=>false,
+       :admin_password_auto=>true,
+       :reset_password_required=>false,
+       :customization_script=>"hola\nmundo",
+       :has_customization_script=>true,
+       :computer_name=>"DEVWEB-001"}
+    @xml = Fog::Generators::Compute::VcloudDirector::Customization.new(@attrs).generate_xml
+    @xml.class
+  end
+
+  tests('#parse').returns(Nokogiri::XML::Document) do
+    @doc = Nokogiri::XML::Document.parse(@xml)
+    @doc.class
+  end
+
+  tests('#validate').returns([]) do
+    pending unless VcloudDirector::Generators::Helpers.have_xsd?
+    VcloudDirector::Generators::Helpers.validate(@doc)
+  end
+
+end
--- a/tests/vcloud_director/generators/compute/helper.rb
+++ b/tests/vcloud_director/generators/compute/helper.rb
@ -0,0 +1,35 @@
+class VcloudDirector
+  module Generators
+    module Helpers
+
+      def self.have_xsd?
+        if @have_xsd.nil?
+          unless @have_xsd = File.exist?(master)
+            Fog::Logger.warning('XML schema not present, skipping validation')
+          end
+        end
+        @have_xsd
+      end
+
+      def self.validate(doc)
+        xsd.validate(doc).map(&:message)
+      end
+
+      private
+
+      def self.master
+        @master ||= File.expand_path('../../../fixtures/vcloud/v1.5/schema/master.xsd', __FILE__)
+      end
+
+      def self.xsd
+        if @xsd.nil?
+          Dir.chdir(File.dirname(master)) do
+            @xsd = Nokogiri::XML::Schema.new(File.read(File.basename(master)))
+          end
+        end
+        @xsd
+      end
+
+    end
+  end
+end
--- a/tests/vcloud_director/generators/compute/metadata_tests.rb
+++ b/tests/vcloud_director/generators/compute/metadata_tests.rb
@ -0,0 +1,41 @@
+Shindo.tests('Compute::VcloudDirector | Metadata generator', ['vclouddirector', 'xsd']) do
+
+  require 'fog/vcloud_director/generators/compute/metadata'
+
+  @attrs = {:metadata => {'KEY' => 'VALUE'}}
+
+  tests('vCloud API 1.5') do
+    tests('#generate_xml').returns(String) do
+      @xml = Fog::Generators::Compute::VcloudDirector::MetadataV15.new(@attrs).generate_xml
+      @xml.class
+    end
+
+    tests('#parse').returns(Nokogiri::XML::Document) do
+      @doc = Nokogiri::XML::Document.parse(@xml)
+      @doc.class
+    end
+
+    tests('#validate').returns([]) do
+      pending unless VcloudDirector::Generators::Helpers.have_xsd?
+      VcloudDirector::Generators::Helpers.validate(@doc)
+    end
+  end
+
+  tests('vCloud API 5.1') do
+    tests('#generate_xml').returns(String) do
+      @xml = Fog::Generators::Compute::VcloudDirector::MetadataV51.new(@attrs).generate_xml
+      @xml.class
+    end
+
+    tests('#parse').returns(Nokogiri::XML::Document) do
+      @doc = Nokogiri::XML::Document.parse(@xml)
+      @doc.class
+    end
+
+    tests('#validate').returns([]) do
+      pending unless VcloudDirector::Generators::Helpers.have_xsd?
+      VcloudDirector::Generators::Helpers.validate(@doc)
+    end
+  end
+
+end
--- a/tests/vcloud_director/generators/compute/network_connection_section_tests.rb
+++ b/tests/vcloud_director/generators/compute/network_connection_section_tests.rb
@ -0,0 +1,33 @@
+Shindo.tests('Compute::VcloudDirector | NetworkConnectionSection generator', ['vclouddirector', 'xsd']) do
+
+  require 'fog/vcloud_director/generators/compute/vm_network'
+
+  tests('#generate_xml').returns(String) do
+    @attrs =
+      {:type=>"application/vnd.vmware.vcloud.networkConnectionSection+xml",
+       :href=>
+        "https://example.com/api/vApp/vm-8b74d95a-ee91-4f46-88d8-fc92be0dbaae/networkConnectionSection/",
+       :id=>"vm-8b74d95a-ee91-4f46-88d8-fc92be0dbaae",
+       :primary_network_connection_index=>0,
+       :network=>"DevOps - Dev Network Connection",
+       :needs_customization=>true,
+       :network_connection_index=>0,
+       :ip_address=>"10.192.0.130",
+       :is_connected=>true,
+       :mac_address=>"00:50:56:01:00:8d",
+       :ip_address_allocation_mode=>"POOL"}
+    @xml = Fog::Generators::Compute::VcloudDirector::VmNetwork.new(@attrs).generate_xml
+    @xml.class
+  end
+
+  tests('#parse').returns(Nokogiri::XML::Document) do
+    @doc = Nokogiri::XML::Document.parse(@xml)
+    @doc.class
+  end
+
+  tests('#validate').returns([]) do
+    pending unless VcloudDirector::Generators::Helpers.have_xsd?
+    VcloudDirector::Generators::Helpers.validate(@doc)
+  end
+
+end
--- a/tests/vcloud_director/generators/compute/vm_network.rb
+++ b/tests/vcloud_director/generators/compute/vm_network.rb
@ -0,0 +1,121 @@
+module Fog
+  module Generators
+    module Compute
+      module VcloudDirector
+        # This is the data structure it accepts, this is the output of
+        # #get_vm_network
+        #
+        #   {:type=>"application/vnd.vmware.vcloud.networkConnectionSection+xml",
+        #    :href=>
+        #     "https://example.com/api/vApp/vm-8b74d95a-ee91-4f46-88d8-fc92be0dbaae/networkConnectionSection/",
+        #    :id=>"vm-8b74d95a-ee91-4f46-88d8-fc92be0dbaae",
+        #    :primary_network_connection_index=>0,
+        #    :network=>"DevOps - Dev Network Connection",
+        #    :needs_customization=>true,
+        #    :network_connection_index=>0,
+        #    :ip_address=>"10.192.0.130",
+        #    :is_connected=>true,
+        #    :mac_address=>"00:50:56:01:00:8d",
+        #    :ip_address_allocation_mode=>"POOL"}
+        #
+        # This is what it generates:
+        #
+        #   <NetworkConnectionSection xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" type="application/vnd.vmware.vcloud.networkConnectionSection+xml" href="https://example.com/api/vApp/vm-8b74d95a-ee91-4f46-88d8-fc92be0dbaae/networkConnectionSection/" ovf:required="false" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.dmtf.org/ovf/envelope/1 http://schemas.dmtf.org/ovf/envelope/1/dsp8023_1.1.0.xsd http://www.vmware.com/vcloud/v1.5 http://10.194.1.65/api/v1.5/schema/master.xsd">
+        #     <ovf:Info>Specifies the available VM network connections</ovf:Info>
+        #     <PrimaryNetworkConnectionIndex>0</PrimaryNetworkConnectionIndex>
+        #     <NetworkConnection network="DevOps - Dev Network Connection" needsCustomization="true">
+        #       <NetworkConnectionIndex>0</NetworkConnectionIndex>
+        #       <IpAddress>10.192.0.130</IpAddress>
+        #       <IsConnected>true</IsConnected>
+        #       <MACAddress>00:50:56:01:00:8d</MACAddress>
+        #       <IpAddressAllocationMode>POOL</IpAddressAllocationMode>
+        #     </NetworkConnection>
+        #     <Link rel="edit" type="application/vnd.vmware.vcloud.networkConnectionSection+xml" href="https://example.com/api/vApp/vm-8b74d95a-ee91-4f46-88d8-fc92be0dbaae/networkConnectionSection/"/>
+        #   </NetworkConnectionSection>
+        #
+        # @see http://pubs.vmware.com/vcd-51/topic/com.vmware.vcloud.api.reference.doc_51/doc/types/NetworkConnectionSectionType.html
+        #   vCloud API Documentation
+        class VmNetwork
+          attr_reader :attrs
+
+          def initialize(attrs={})
+            @attrs = attrs
+          end
+
+          def generate_xml
+            output = ""
+            output << header
+            output << body(@attrs)
+            output << tail
+            output
+          end
+
+          def network
+            @attrs[:network]
+          end
+
+          def network=(new_network_name)
+            @attrs[:network] = new_network_name
+          end
+
+          def ip_address
+            @attrs[:ip_address]
+          end
+
+          def ip_address=(new_ip_address)
+            @attrs[:ip_address] = new_ip_address
+          end
+
+          def is_connected
+            @attrs[:is_connected]
+          end
+
+          def is_connected=(new_is_connected)
+            @attrs[:is_connected] = new_is_connected
+          end
+
+          def ip_address_allocation_mode
+            @attrs[:ip_address_allocation_mode]
+          end
+
+          def ip_address_allocation_mode=(new_ip_address_allocation_mode)
+            @attrs[:ip_address_allocation_mode] = new_ip_address_allocation_mode
+          end
+
+          private
+
+          def header
+              '<NetworkConnectionSection xmlns="http://www.vmware.com/vcloud/v1.5"
+                 xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
+                 type="application/vnd.vmware.vcloud.networkConnectionSection+xml"
+                 ovf:required="false"
+                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://schemas.dmtf.org/ovf/envelope/1
+                   http://schemas.dmtf.org/ovf/envelope/1/dsp8023_1.1.0.xsd
+                   http://www.vmware.com/vcloud/v1.5 http://10.194.1.65/api/v1.5/schema/master.xsd">'
+          end
+
+          def body(opts={})
+            body = <<EOF
+            <ovf:Info>#{opts[:info]}</ovf:Info>
+                 <PrimaryNetworkConnectionIndex>#{opts[:primary_network_connection_index]}</PrimaryNetworkConnectionIndex>
+                 <NetworkConnection
+                     network="#{opts[:network]}"
+                     needsCustomization="#{opts[:needs_customization]}">
+                     <NetworkConnectionIndex>#{opts[:network_connection_index]}</NetworkConnectionIndex>
+                     <IpAddress>#{opts[:ip_address]}</IpAddress>
+                     <IsConnected>#{opts[:is_connected]}</IsConnected>
+                     <MACAddress>#{opts[:mac_address]}</MACAddress>
+                     <IpAddressAllocationMode>#{opts[:ip_address_allocation_mode]}</IpAddressAllocationMode>
+                 </NetworkConnection>
+EOF
+          end
+
+          def tail
+            '</NetworkConnectionSection>'
+          end
+        end
+      end
+    end
+  end
+end