vcloud-launcher 0.6.0 → 0.7.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.7.0 (2014-12-05)
+
+Features:
+
+  - Supports attaching of independent disks to VMs.
+
 ## 0.6.0 (2014-12-03)
 
 Features:

data/lib/vcloud/launcher.rb

@@ -7,6 +7,7 @@ require 'vcloud/launcher/schema/launcher_vapps'
 
 require 'vcloud/launcher/launch'
 require 'vcloud/launcher/preamble'
+require 'vcloud/launcher/independent_disk_orchestrator'
 require 'vcloud/launcher/vm_orchestrator'
 require 'vcloud/launcher/vapp_orchestrator'
 

data/lib/vcloud/launcher/independent_disk_orchestrator.rb

@@ -0,0 +1,29 @@
+module Vcloud
+  module Launcher
+    class IndependentDiskOrchestrator
+
+      def initialize(vm)
+        @vm = vm
+      end
+
+      def attach(independent_disks_config)
+        disk_list = find_disks(independent_disks_config)
+        @vm.attach_independent_disks(disk_list)
+      end
+
+      def vdc_name
+        return @vdc_name if @vdc_name
+        parent_vapp = Vcloud::Core::Vapp.get_by_child_vm_id(@vm.id)
+        parent_vdc = Vcloud::Core::Vdc.new(parent_vapp.vdc_id)
+        @vdc_name = parent_vdc.name
+      end
+
+      def find_disks(independent_disks_config)
+        independent_disks_config.map do |disk|
+          Vcloud::Core::IndependentDisk.get_by_name_and_vdc_name(disk[:name], vdc_name)
+        end
+      end
+
+    end
+  end
+end

data/lib/vcloud/launcher/schema/vm.rb

@@ -40,6 +40,17 @@ module Vcloud
               },
             },
           },
+          independent_disks: {
+            type: 'array',
+            required: false,
+            allowed_empty: true,
+            each_element_is: {
+              type: 'hash',
+              internals: {
+                name: { type: 'string', required: true },
+              },
+            },
+          },
           bootstrap:   {
             type: 'hash',
             required: false,

data/lib/vcloud/launcher/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Launcher
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/vcloud/launcher/vm_orchestrator.rb

@@ -17,6 +17,9 @@ module Vcloud
         end
         @vm.add_extra_disks(vm_config[:extra_disks])
         @vm.update_metadata(vm_config[:metadata])
+        if vm_config.key?(:independent_disks)
+          Vcloud::Launcher::IndependentDiskOrchestrator.new(@vm).attach(vm_config.fetch(:independent_disks))
+        end
 
         preamble = vm_config[:bootstrap] ? generate_preamble(vm_config) : ''
 

data/spec/integration/launcher/data/happy_path.yaml.erb

@@ -20,6 +20,8 @@ vapps:
         name: Hard disk 2
       - size: '2048'
         name: Hard disk 3
+      independent_disks:
+      - name: <%= independent_disk_name %>
       network_connections:
       - name: <%= network_1 %>
         ip_address: <%= network_1_ip %>

data/spec/integration/launcher/launch_spec.rb

@@ -81,6 +81,11 @@ describe Vcloud::Launcher::Launch do
   context "happy path" do
     before(:all) do
       @test_data = define_test_data
+      @test_case_independent_disks = IntegrationHelper.create_test_case_independent_disks(
+        1, @test_data[:vdc_name], '100MB')
+      @test_independent_disk = @test_case_independent_disks.first
+      @test_data[:independent_disk_name] = @test_independent_disk.name
+
       @config_yaml = ErbHelper.convert_erb_template_to_yaml(@test_data, File.join(File.dirname(__FILE__), 'data/happy_path.yaml.erb'))
       @api_interface = Vcloud::Core::ApiInterface.new
       Vcloud::Launcher::Launch.new(@config_yaml, { "dont-power-on" => true }).run
@@ -125,14 +130,22 @@ describe Vcloud::Launcher::Launch do
         expect(@vm_metadata[:is_string]).to eq('Hello World')
       end
 
-      it "should attach extra hard disks to vm" do
-        disks = extract_disks(@vm)
+      it "should attach extra local hard disks to vm" do
+        disks = extract_local_disks(@vm)
         expect(disks.count).to eq(3)
         [{:name => 'Hard disk 2', :size => '1024'}, {:name => 'Hard disk 3', :size => '2048'}].each do |new_disk|
           expect(disks).to include(new_disk)
         end
       end
 
+      it "should attach extra independent disks to vm" do
+        disks = extract_independent_disks(@vm)
+        expect(disks.count).to eq(1)
+        [{:name => 'Hard disk 4'}].each do |new_disk|
+          expect(disks).to include(new_disk)
+        end
+      end
+
       it "should configure the vm network interface" do
         vm_network_connection = @vm[:NetworkConnectionSection][:NetworkConnection]
         expect(vm_network_connection).not_to be_nil
@@ -167,12 +180,25 @@ describe Vcloud::Launcher::Launch do
     after(:all) do
       unless ENV['VCLOUD_TOOLS_RSPEC_NO_DELETE_VAPP']
         File.delete @config_yaml
-        expect(@api_interface.delete_vapp(@vapp_id)).to eq(true)
+        @api_interface.delete_vapp(@vapp_id)
+        wait_for_disks_to_detach
+        IntegrationHelper.delete_independent_disks(@test_case_independent_disks)
       end
     end
 
   end
 
+  def wait_for_disks_to_detach
+    # There is an annoying delay after a vapp is deleted before any attached
+    # independent disks are registered as detached in vCD. The
+    # disk#attached_vms call lies during this period too, so cannot be used to
+    # ascertain that the disk is completely detached.
+    #
+    # As a result, just wait for a sufficiently long time for vCD to get its
+    # act together.
+    sleep(20)
+  end
+
   def extract_memory(vm)
     vm[:'ovf:VirtualHardwareSection'][:'ovf:Item'].detect { |i| i[:'rasd:ResourceType'] == '4' }[:'rasd:VirtualQuantity']
   end
@@ -181,9 +207,26 @@ describe Vcloud::Launcher::Launch do
     vm[:'ovf:VirtualHardwareSection'][:'ovf:Item'].detect { |i| i[:'rasd:ResourceType'] == '3' }[:'rasd:VirtualQuantity']
   end
 
-  def extract_disks(vm)
+  def extract_local_disks(vm)
     vm[:'ovf:VirtualHardwareSection'][:'ovf:Item'].collect { |d|
-      {:name => d[:"rasd:ElementName"], :size => (d[:"rasd:HostResource"][:ns12_capacity] || d[:"rasd:HostResource"][:vcloud_capacity])} if d[:'rasd:ResourceType'] == '17'
+      if d[:'rasd:ResourceType'] == '17' && ! d[:'rasd:HostResource'].key?(:vcloud_disk)
+        {
+          :name => d[:"rasd:ElementName"],
+          :size => (
+            d[:"rasd:HostResource"][:ns12_capacity] || d[:"rasd:HostResource"][:vcloud_capacity]
+          )
+        }
+      end
+    }.compact
+  end
+
+  def extract_independent_disks(vm)
+    vm[:'ovf:VirtualHardwareSection'][:'ovf:Item'].collect { |d|
+      if d[:'rasd:ResourceType'] == '17' && d[:'rasd:HostResource'].key?(:vcloud_disk)
+        {
+          :name => d[:"rasd:ElementName"]
+        }
+      end
     }.compact
   end
 

data/spec/spec_helper.rb

@@ -22,6 +22,7 @@ if ENV['COVERAGE']
 end
 
 require 'erb_helper'
+require 'support/integration_helper'
 require 'vcloud/launcher'
 
 RSpec.configure do |config|

data/spec/support/integration_helper.rb

@@ -0,0 +1,28 @@
+module IntegrationHelper
+
+  def self.create_test_case_independent_disks(number_of_disks,
+                                  vdc_name,
+                                  size,
+                                  prefix = "vcloud-launcher-tests"
+                                 )
+    timestamp_in_s = Time.new.to_i
+    base_disk_name = "#{prefix}-#{timestamp_in_s}-"
+    disk_list = []
+    vdc = Vcloud::Core::Vdc.get_by_name(vdc_name)
+    number_of_disks.times do |index|
+      disk_list << Vcloud::Core::IndependentDisk.create(
+        vdc,
+        base_disk_name + index.to_s,
+        size,
+      )
+    end
+    disk_list
+  end
+
+  def self.delete_independent_disks(disk_list)
+    disk_list.each do |disk|
+      disk.destroy
+    end
+  end
+
+end

data/spec/vcloud/launcher/independent_disk_orchestrator_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Vcloud::Launcher::IndependentDiskOrchestrator do
+
+  let(:mock_vm) {
+    double(
+      :vm,
+      :id => 'vm-12341234-1234-1234-1234-123412340001',
+      :vapp_name => 'web-app1',
+      :name => 'test-vm-1'
+    )
+  }
+
+  let(:mock_parent_vapp) {
+    double(
+      :vapp,
+      :id => 'vapp-12341234-1234-1234-1234-123412340000',
+      :name => 'web-app1',
+      :vdc_id => '12341234-1234-1234-1234-123412349999',
+    )
+  }
+
+  let(:mock_parent_vdc) {
+    double(
+      :vdc,
+      :id => '12341234-1234-1234-1234-123412349999',
+      :name => 'test-vdc-1',
+    )
+  }
+
+  let(:independent_disk_config) {
+    [
+      {:name => 'test-independent-disk-1' },
+      {:name => 'test-independent-disk-2' },
+    ]
+  }
+
+  let(:mock_disk_1) {
+    double(
+      :independent_disk_1,
+      :id => '12341234-1234-1234-123411110001',
+      :name => 'test-independent-disk-1'
+    )
+  }
+
+  let(:mock_disk_2) {
+    double(
+      :independent_disk_2,
+      :id => '12341234-1234-1234-123411110002',
+      :name => 'test-independent-disk-2'
+    )
+  }
+
+  subject { Vcloud::Launcher::IndependentDiskOrchestrator.new(mock_vm) }
+
+  describe "#vdc_name" do
+  end
+
+  describe "#find_disks" do
+
+    before(:each) do
+      expect(Vcloud::Core::Vapp).to receive(:get_by_child_vm_id).with(mock_vm.id).
+        and_return(mock_parent_vapp)
+      expect(Vcloud::Core::Vdc).to receive(:new).with(mock_parent_vapp.vdc_id).
+        and_return(mock_parent_vdc)
+    end
+
+    it "finds Vcloud::Core::IndependentDisk objects from our configuration" do
+      expect(Vcloud::Core::IndependentDisk).
+        to receive(:get_by_name_and_vdc_name).
+        with(independent_disk_config[0][:name], mock_parent_vdc.name).
+        ordered.
+        and_return(mock_disk_1)
+      expect(Vcloud::Core::IndependentDisk).
+        to receive(:get_by_name_and_vdc_name).
+        with(independent_disk_config[1][:name], mock_parent_vdc.name).
+        ordered.
+        and_return(mock_disk_2)
+      expect(subject.find_disks(independent_disk_config)).
+        to eq([mock_disk_1, mock_disk_2])
+    end
+
+  end
+
+  describe "#attach" do
+    it "orchestrates attachment of independent disks to a VM" do
+      expect(subject).to receive(:find_disks).and_return([mock_disk_1, mock_disk_2])
+      expect(mock_vm).to receive(:attach_independent_disks).
+        with([mock_disk_1, mock_disk_2]).
+        and_return(true)
+      expect(subject.attach(independent_disk_config)).to be_true
+    end
+  end
+
+end

data/spec/vcloud/launcher/schema/launcher_vapps_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe Vcloud::Launcher::Schema::LAUNCHER_VAPPS do
+
+  let(:schema) { Vcloud::Launcher::Schema::LAUNCHER_VAPPS }
+
+  context "independent_disks section is present" do
+
+    let(:config) do
+      { vapps: [
+          {
+            name: "test_vapp_name",
+            vdc_name: "Test VDC",
+            catalog_name: "default",
+            vapp_template_name: "ubuntu-precise",
+            vm: {
+              independent_disks: [ { name: 'indydisk-1' }, { name: 'indydisk-2' } ],
+            }
+          }
+        ]
+      }
+    end
+
+    it "validates successfully" do
+      validation = Vcloud::Core::ConfigValidator.new(:base, config, schema)
+      expect(validation.valid?).to be_true
+    end
+
+  end
+
+  context "independent_disks section is present but not an array" do
+
+    let(:config) do
+      { vapps: [
+          {
+            name: "test_vapp_name",
+            vdc_name: "Test VDC",
+            catalog_name: "default",
+            vapp_template_name: "ubuntu-precise",
+            vm: {
+              independent_disks: 'indydisk-1'
+            }
+          }
+        ]
+      }
+    end
+
+    it "does not validate successfully" do
+      validation = Vcloud::Core::ConfigValidator.new(:base, config, schema)
+      expect(validation.valid?).to be_false
+      expect(validation.errors).to eq(['independent_disks is not an array'])
+    end
+
+  end
+
+  context "independent_disks section is present but not an array of hashes" do
+
+    let(:config) do
+      { vapps: [
+          {
+            name: "test_vapp_name",
+            vdc_name: "Test VDC",
+            catalog_name: "default",
+            vapp_template_name: "ubuntu-precise",
+            vm: {
+              independent_disks: [ 'indydisk-1', 'indydisk-2' ]
+            }
+          }
+        ]
+      }
+    end
+
+    it "does not validate successfully" do
+      validation = Vcloud::Core::ConfigValidator.new(:base, config, schema)
+      expect(validation.valid?).to be_false
+      expect(validation.errors).to eq(
+        ['independent_disks: is not a hash', 'independent_disks: is not a hash']
+      )
+    end
+
+  end
+
+  context "independent_disks section is present and a hash, but not contain a :name parameter" do
+
+    let(:config) do
+      { vapps: [
+          {
+            name: "test_vapp_name",
+            vdc_name: "Test VDC",
+            catalog_name: "default",
+            vapp_template_name: "ubuntu-precise",
+            vm: {
+              independent_disks: [ { nametypo: 'indydisk-1'} ]
+            }
+          }
+        ]
+      }
+    end
+
+    it "does not validate successfully" do
+      validation = Vcloud::Core::ConfigValidator.new(:base, config, schema)
+      expect(validation.valid?).to be_false
+      expect(validation.errors).to eq([
+        "independent_disks: parameter 'nametypo' is invalid",
+        "independent_disks: missing 'name' parameter"
+      ])
+    end
+
+  end
+
+end

data/spec/vcloud/launcher/vm_orchestrator_spec.rb

@@ -12,6 +12,10 @@ describe Vcloud::Launcher::VmOrchestrator do
   let(:vapp) {
     double(:vapp, :name => 'web-app1')
   }
+  let(:mock_disk_orchestrator) {
+    double(:mock_disk_orchestrator)
+  }
+
   subject {
     Vcloud::Launcher::VmOrchestrator.new(vcloud_vm, vapp)
   }
@@ -29,6 +33,10 @@ describe Vcloud::Launcher::VmOrchestrator do
             {:name => 'Hard disk 2', :size => '1024'},
             {:name => 'Hard disk 3', :size => '2048'},
         ],
+        :independent_disks => [
+            {:name => 'test-independent-disk-1' },
+            {:name => 'test-independent-disk-2' },
+        ],
         :network_connections => [
             {:name => "network1", :ip_address => "198.12.1.21"},
         ],
@@ -47,6 +55,9 @@ describe Vcloud::Launcher::VmOrchestrator do
     expect(vm).to receive(:update_memory_size_in_mb).with(4096)
     expect(vm).to receive(:add_extra_disks).with(vm_config[:extra_disks])
     expect(vm).to receive(:update_metadata).with(vm_config[:metadata])
+    expect(Vcloud::Launcher::IndependentDiskOrchestrator).
+      to receive(:new).with(vm).and_return(mock_disk_orchestrator)
+    expect(mock_disk_orchestrator).to receive(:attach).with(vm_config[:independent_disks])
 
     allow(vm).to receive(:configure_guest_customization_section).with('')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-launcher
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcloud-core
-  requirement: &7246000 !ruby/object:Gem::Requirement
+  requirement: &16107320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.16.0
   type: :runtime
   prerelease: false
-  version_requirements: *7246000
+  version_requirements: *16107320
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &7244900 !ruby/object:Gem::Requirement
+  requirement: &16106340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.0
   type: :development
   prerelease: false
-  version_requirements: *7244900
+  version_requirements: *16106340
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &7243800 !ruby/object:Gem::Requirement
+  requirement: &16105780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7243800
+  version_requirements: *16105780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &7242280 !ruby/object:Gem::Requirement
+  requirement: &16104580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7242280
+  version_requirements: *16104580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7240360 !ruby/object:Gem::Requirement
+  requirement: &16103800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *7240360
+  version_requirements: *16103800
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: &7239760 !ruby/object:Gem::Requirement
+  requirement: &16102180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.23.0
   type: :development
   prerelease: false
-  version_requirements: *7239760
+  version_requirements: *16102180
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &7239120 !ruby/object:Gem::Requirement
+  requirement: &16192900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *7239120
+  version_requirements: *16192900
 - !ruby/object:Gem::Dependency
   name: vcloud-tools-tester
-  requirement: &7137660 !ruby/object:Gem::Requirement
+  requirement: &16192100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.2.0
   type: :development
   prerelease: false
-  version_requirements: *7137660
+  version_requirements: *16192100
 description: 
 email:
 - anna.shipman@digital.cabinet-office.gov.uk
@@ -125,6 +125,7 @@ files:
 - jenkins_tests.sh
 - lib/vcloud/launcher.rb
 - lib/vcloud/launcher/cli.rb
+- lib/vcloud/launcher/independent_disk_orchestrator.rb
 - lib/vcloud/launcher/launch.rb
 - lib/vcloud/launcher/preamble.rb
 - lib/vcloud/launcher/schema/launcher_vapps.rb
@@ -146,9 +147,12 @@ files:
 - spec/integration/launcher/storage_profile_integration_spec.rb
 - spec/integration/vcloud_tools_testing_config.yaml.template
 - spec/spec_helper.rb
+- spec/support/integration_helper.rb
 - spec/vcloud/launcher/cli_spec.rb
+- spec/vcloud/launcher/independent_disk_orchestrator_spec.rb
 - spec/vcloud/launcher/launch_spec.rb
 - spec/vcloud/launcher/preamble_spec.rb
+- spec/vcloud/launcher/schema/launcher_vapps_spec.rb
 - spec/vcloud/launcher/vapp_orchestrator_spec.rb
 - spec/vcloud/launcher/vm_orchestrator_spec.rb
 - vcloud-launcher.gemspec
@@ -173,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 646331227041677497
+      hash: 2886844518648342452
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -193,8 +197,11 @@ test_files:
 - spec/integration/launcher/storage_profile_integration_spec.rb
 - spec/integration/vcloud_tools_testing_config.yaml.template
 - spec/spec_helper.rb
+- spec/support/integration_helper.rb
 - spec/vcloud/launcher/cli_spec.rb
+- spec/vcloud/launcher/independent_disk_orchestrator_spec.rb
 - spec/vcloud/launcher/launch_spec.rb
 - spec/vcloud/launcher/preamble_spec.rb
+- spec/vcloud/launcher/schema/launcher_vapps_spec.rb
 - spec/vcloud/launcher/vapp_orchestrator_spec.rb
 - spec/vcloud/launcher/vm_orchestrator_spec.rb