vcloud-walker 3.1.2 → 3.2.0

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 3.2.0 (2014-05-14)
+
+Features:
+
+  - Support v5.1 API over VCloud Director 5.5
+  - Require fog v1.21 to allow use of FOG_VCLOUD_TOKEN via ENV as an alternative to a .fog file
+
+## 3.1.2 (2014-02-07)
+
+  - First release of gem

data/README.md

@@ -48,9 +48,13 @@ describes the entire organization, which includes edgegateway, catalogs, network
 
 ### Credentials
 
-You will need to specify the credentials for your VMware environment. As Vcloud-walker uses fog to query the VMware api, you will need to create a `.fog` file containing these credentials.
+You will need to specify the credentials for your VMware environment. Vcloud-walker uses fog to query the VMware api,
+which offers two ways to do this.
+
+#### 1. Create a `.fog` file containing your credentials
 
 An example of .fog file is:
+
 ````
 default:
   vcloud_director_username: 'user_id@org_id'
@@ -60,6 +64,30 @@ default:
 
 To understand more about `.fog` files, visit the 'Credentials' section here => http://fog.io/about/getting_started.html.
 
+### 2. Log on externally and supply your session token
+
+You can choose to log on externally by interacting independently with the API and supplying your session token to the
+tool by setting the `FOG_VCLOUD_TOKEN` ENV variable. This option reduces the risk footprint by allowing the user to
+store their credentials in safe storage. The default token lifetime is '30 minutes idle' - any activity extends the life by another 30 mins.
+
+A basic example of this would be the following:
+
+    curl
+       -D-
+       -d ''
+       -H 'Accept: application/*+xml;version=5.1' -u '<user>@<org>'
+       https://host.com/api/sessions
+
+This will prompt for your password.
+
+From the headers returned, select the header below
+
+     x-vcloud-authorization: AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF=
+
+Use token as ENV var FOG_VCLOUD_TOKEN
+
+    FOG_VCLOUD_TOKEN=AAAABBBBBCCCCCCDDDDDDEEEEEEFFFFF= vcloud-walk organization
+
 ### Output
 
 Walker can output data in JSON or YAML format. The default output format is JSON.

data/jenkins.sh

@@ -6,4 +6,10 @@ git clean -fdx
 
 bundle install --path "${HOME}/bundles/${JOB_NAME}"
 bundle exec rake
+
+./scripts/generate_fog_conf_file.sh
+export FOG_RC=fog_integration_test.config
+bundle exec rake integration_test
+rm fog_integration_test.config
+
 bundle exec rake publish_gem

data/lib/vcloud/walker/resource/vm.rb

@@ -58,10 +58,14 @@ module Vcloud
         def extract_disks(resources)
           disk_resources = resources.select { |element| element[:'rasd:ResourceType']== HARDWARE_RESOURCE_TYPES[:hard_disk] }
           @disks = disk_resources.collect do |d|
-            {:name => d[:'rasd:ElementName'], :size => d[:'rasd:HostResource'][:'ns12_capacity'].to_i}
+            {:name => d[:'rasd:ElementName'], :size => extract_disk_capacity(d)}
           end
         end
 
+        def extract_disk_capacity(d)
+          (d[:"rasd:HostResource"][:ns12_capacity] || d[:"rasd:HostResource"][:vcloud_capacity]).to_i
+        end
+
         def extract_network_cards(resources)
           resources = resources.select {
             |element| element[:'rasd:ResourceType'] == HARDWARE_RESOURCE_TYPES[:network_adapter]

data/lib/vcloud/walker/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Walker
-    VERSION = '3.1.2'
+    VERSION = '3.2.0'
   end
 end

data/spec/stubs/service_layer_stub.rb

@@ -66,14 +66,30 @@ module Fog
       RSpec::Mocks::Mock.new(:fog_vapp, :body => vapp_body)
     end
 
-    def self.hardware_resources
+    def self.vcloud_director_five_one_ids
+      {
+        :disk_capacity_label => :ns12_capacity
+      }
+    end
+
+    def self.vcloud_director_5_5_with_v5_1_api_ids
+      {
+        :disk_capacity_label => :vcloud_capacity
+      }
+    end
+
+
+
+    def self.hardware_resources version_specific_ids
       [
           {
               :'rasd:ResourceType' =>:: Vcloud::Walker::Resource::Vm::HARDWARE_RESOURCE_TYPES[:hard_disk],
               :"rasd:AddressOnParent" => "0",
               :"rasd:Description" => "Hard disk",
               :"rasd:ElementName" => "Hard disk 1",
-              :"rasd:HostResource" => {:ns12_capacity => "11265", :ns12_busSubType => "lsilogic", :ns12_busType => "6"},
+              :"rasd:HostResource" => {version_specific_ids[:disk_capacity_label] => "11265",
+                                                            :ns12_busSubType => "lsilogic",
+                                                            :ns12_busType => "6"},
           },
 
           {
@@ -81,7 +97,9 @@ module Fog
               :"rasd:AddressOnParent" => "1",
               :"rasd:Description" => "Hard disk",
               :"rasd:ElementName" => "Hard disk 2",
-              :"rasd:HostResource" => {:ns12_capacity => "307200", :ns12_busSubType => "lsilogic", :ns12_busType => "6"}
+              :"rasd:HostResource" => {version_specific_ids[:disk_capacity_label] => "307200",
+                                                            :ns12_busSubType => "lsilogic",
+                                                            :ns12_busType => "6"}
           },
           {
               :'rasd:ResourceType' => ::Vcloud::Walker::Resource::Vm::HARDWARE_RESOURCE_TYPES[:cpu],

data/spec/walk/vm_spec.rb

@@ -2,55 +2,14 @@ require 'spec_helper'
 
 describe Vcloud::Walker::Resource::Vm do
 
-  context 'populate summary vm model' do
+  context 'populate summary vm model for 5.1' do
     before(:each) do
-      fog_vm = {
-          :deployed => "true",
-          :status => "8",
-          :name => "ubuntu-testing-template",
-          :id => "urn:vcloud:vm:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
-          :href => 'https://myvdc.carrenza.net/api/vApp/vm-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
-          :"ovf:VirtualHardwareSection" =>
-              {:"ovf:Info" => "Virtual hardware requirements",
-               :"ovf:System" => {:"vssd:ElementName" => "Virtual Hardware Family", :"vssd:VirtualSystemType" => "vmx-08"},
-               :'ovf:Item' => Fog::ServiceLayerStub.hardware_resources
-              },
-          :"ovf:OperatingSystemSection" =>
-              {
-                  :vmw_osType => "ubuntu64Guest",
-                  :"ovf:Info" => "Specifies the operating system installed",
-                  :"ovf:Description" => "Ubuntu Linux (64-bit)"
-              },
-          :NetworkConnectionSection =>
-              {
-                  :type => "application/vnd.vmware.vcloud.networkConnectionSection+xml",
-                  :ovf_required => "false",
-                  :"ovf:Info" => "Specifies the available VM network connections",
-                  :PrimaryNetworkConnectionIndex => "0",
-                  :NetworkConnection =>
-                      [
-                          {
-                              :network => "Default",
-                              :needsCustomization => "true",
-                              :NetworkConnectionIndex => "0",
-                              :IpAddress => "192.168.254.100",
-                              :IsConnected => "true",
-                              :MACAddress => "00:50:56:00:00:01",
-                              :IpAddressAllocationMode => "MANUAL"
-                          },
-                      ]
-              },
-          :RuntimeInfoSection => {:VMWareTools => {:version => "2147483647"}},
-          :StorageProfile =>
-              {
-                  :type=>"application/vnd.vmware.vcloud.vdcStorageProfile+xml",
-                  :name=>"TEST-STORAGE-PROFILE",
-                  :href=>"https://api.vcd.portal.examplecloud.com/api/vdcStorageProfile/00000000-aaaa-bbbb-aaaa-000000000000"
-              }
-      }
+      fog_vm = assemble_sample_vm_data Fog::ServiceLayerStub.vcloud_director_five_one_ids
 
       @metadata = {:name => 'web-app-1', :shutdown => true}
-      Vcloud::Core::Vm.should_receive(:get_metadata).with("vm-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee").and_return(@metadata)
+      Vcloud::Core::Vm.should_receive(:get_metadata)
+                      .with("vm-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
+                      .and_return(@metadata)
 
       @vm_summary = Vcloud::Walker::Resource::Vm.new(fog_vm)
     end
@@ -118,5 +77,80 @@ describe Vcloud::Walker::Resource::Vm do
     end
 
   end
+
+
+  context 'populate summary vm model for 5.1 api on vcloud director 5.5' do
+    before(:each) do
+      fog_vm = assemble_sample_vm_data  Fog::ServiceLayerStub.vcloud_director_5_5_with_v5_1_api_ids
+
+      @metadata = {:name => 'web-app-1', :shutdown => true}
+      Vcloud::Core::Vm.should_receive(:get_metadata)
+                      .with("vm-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
+                      .and_return(@metadata)
+
+      @vm_summary = Vcloud::Walker::Resource::Vm.new(fog_vm)
+    end
+
+    it "report disk info for 5.1 api on 5.5" do
+      @vm_summary.disks.count.should == 2
+      @vm_summary.disks.first.should == {:name => "Hard disk 1", :size => 11265}
+      @vm_summary.disks.last.should == {:name => "Hard disk 2", :size => 307200}
+    end
+
+  end
+
+  def assemble_sample_vm_data api_version
+    {
+      :deployed => "true",
+      :status => "8",
+      :name => "ubuntu-testing-template",
+      :id => "urn:vcloud:vm:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
+      :href => 'https://myvdc.carrenza.net/api/vApp/vm-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
+      :"ovf:VirtualHardwareSection" =>
+        {
+          :"ovf:Info" => "Virtual hardware requirements",
+          :"ovf:System" =>
+            {
+              :"vssd:ElementName" => "Virtual Hardware Family",
+              :"vssd:VirtualSystemType" => "vmx-08"
+            },
+          :'ovf:Item' => Fog::ServiceLayerStub.hardware_resources(api_version)
+        },
+      :"ovf:OperatingSystemSection" =>
+        {
+          :vmw_osType  => "ubuntu64Guest",
+          :"ovf:Info" => "Specifies the operating system installed",
+          :"ovf:Description" => "Ubuntu Linux (64-bit)"
+        },
+      :NetworkConnectionSection =>
+        {
+          :type => "application/vnd.vmware.vcloud.networkConnectionSection+xml",
+          :ovf_required => "false",
+          :"ovf:Info" => "Specifies the available VM network connections",
+          :PrimaryNetworkConnectionIndex => "0",
+          :NetworkConnection =>
+            [
+              {
+                :network => "Default",
+                :needsCustomization => "true",
+                :NetworkConnectionIndex => "0",
+                :IpAddress => "192.168.254.100",
+                :IsConnected => "true",
+                :MACAddress => "00:50:56:00:00:01",
+                :IpAddressAllocationMode => "MANUAL"
+              },
+            ]
+        },
+      :RuntimeInfoSection => {:VMWareTools => {:version => "2147483647"}},
+      :StorageProfile =>
+        {
+          :type => "application/vnd.vmware.vcloud.vdcStorageProfile+xml",
+          :name => "TEST-STORAGE-PROFILE",
+          :href => "https://api.vcd.portal.examplecloud.com/api/vdcStorageProfile/00000000-aaaa-bbbb-aaaa-000000000000"
+        }
+    }
+  end
+
+
 end
 

data/vcloud-walker.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'json_spec', '~> 1.1.1'
   s.add_runtime_dependency 'json', '~> 1.8.0'
   s.add_runtime_dependency 'methadone'
-  s.add_runtime_dependency 'fog', '>= 1.19.0'
-  s.add_runtime_dependency 'vcloud-core', '>= 0.0.5'
+  s.add_runtime_dependency 'fog', '>= 1.21.0'
+  s.add_runtime_dependency 'vcloud-core', '>= 0.0.11'
   s.add_development_dependency 'simplecov', '~> 0.8.2'
   s.add_development_dependency 'gem_publisher', '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-walker
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: vcloud-core
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +181,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -241,7 +242,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1800387428395213455
+      hash: -3247384966975022659
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -250,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1800387428395213455
+      hash: -3247384966975022659
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23