vm_shepherd 3.3.2 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25a49a93d04e9d20815c0e49f6d1a59b0dcfec95
-  data.tar.gz: 0884c51e7c2c8fee2a9211fb401eac3c07786bb7
+  metadata.gz: c20a4fbcccc9a014091dfb3b562f1a7a229250a4
+  data.tar.gz: 1474fc28386000077c69a829b3520d489c82186e
 SHA512:
-  metadata.gz: 3771e8eae943ca778bde5c58ad09a751a0f5d1d53e893f0bea4d4f397851b1067aa77b36eb598eef374799e5f1b720f2d9d66f89af562e52cd9deb0253978e14
-  data.tar.gz: 5f43ab61a483e64fda40436bd49945803522a1d24e39aca8b33465f993fd27f18a77aef8d0384c83b249b0c9e29258085b2b0075c7be78b743c1b85490970a45
+  metadata.gz: 5d89cffd243b8fb4530b56dff8e6e8b77e46035ac429aa2ece3b271e1d7df5150647d1337481a7edd903ba8e33c9a277fbfcb7007821d7b6d44dd15a7b218bb7
+  data.tar.gz: 0d5c833739ff2b3217739060375d09abe51b0f7199d7e1ea5c90ca10c0c20b6d573150f9ac376e88bc514615a5623d3599f4f4b49ad2b1d36f17db72a0d9ee31

data/lib/vm_shepherd/shepherd.rb

@@ -9,8 +9,8 @@ module VmShepherd
     end
 
     def initialize(settings:)
-      @iaas_type  = settings.dig('iaas_type')
-      @configs    = settings.dig('vm_shepherd', 'vm_configs') || []
+      @iaas_type = settings.dig('iaas_type')
+      @configs = settings.dig('vm_shepherd', 'vm_configs') || []
       @env_config = settings.dig('vm_shepherd', 'env_config')
     end
 
@@ -26,10 +26,10 @@ module VmShepherd
           when VmShepherd::VCLOUD_IAAS_TYPE then
             VmShepherd::VcloudManager.new(
               {
-                url:          vm_shepherd_config.dig('creds', 'url'),
+                url: vm_shepherd_config.dig('creds', 'url'),
                 organization: vm_shepherd_config.dig('creds', 'organization'),
-                user:         vm_shepherd_config.dig('creds', 'user'),
-                password:     vm_shepherd_config.dig('creds', 'password'),
+                user: vm_shepherd_config.dig('creds', 'user'),
+                password: vm_shepherd_config.dig('creds', 'password'),
               },
               vm_shepherd_config.dig('vdc', 'name'),
               stdout_logger
@@ -46,22 +46,13 @@ module VmShepherd
               stdout_logger,
             ).deploy(
               path,
+              vsphere_vm_options(vm_shepherd_config),
               {
-                ip:          vm_shepherd_config.dig('vm', 'ip'),
-                gateway:     vm_shepherd_config.dig('vm', 'gateway'),
-                netmask:     vm_shepherd_config.dig('vm', 'netmask'),
-                dns:         vm_shepherd_config.dig('vm', 'dns'),
-                ntp_servers: vm_shepherd_config.dig('vm', 'ntp_servers'),
-                cpus:        vm_shepherd_config.dig('vm', 'cpus'),
-                ram_mb:      vm_shepherd_config.dig('vm', 'ram_mb'),
-                vm_password: (vm_shepherd_config.dig('vm', 'vm_password') || 'tempest'),
-              },
-              {
-                cluster:       vm_shepherd_config.dig('vsphere', 'cluster'),
+                cluster: vm_shepherd_config.dig('vsphere', 'cluster'),
                 resource_pool: vm_shepherd_config.dig('vsphere', 'resource_pool'),
-                datastore:     vm_shepherd_config.dig('vsphere', 'datastore'),
-                network:       vm_shepherd_config.dig('vsphere', 'network'),
-                folder:        vm_shepherd_config.dig('vsphere', 'folder'),
+                datastore: vm_shepherd_config.dig('vsphere', 'datastore'),
+                network: vm_shepherd_config.dig('vsphere', 'network'),
+                folder: vm_shepherd_config.dig('vsphere', 'folder'),
               }
             )
           when VmShepherd::AWS_IAAS_TYPE then
@@ -81,10 +72,10 @@ module VmShepherd
           @configs.each do |vm_shepherd_config|
             VmShepherd::VcloudManager.new(
               {
-                url:          vm_shepherd_config.dig('creds', 'url'),
+                url: vm_shepherd_config.dig('creds', 'url'),
                 organization: vm_shepherd_config.dig('creds', 'organization'),
-                user:         vm_shepherd_config.dig('creds', 'user'),
-                password:     vm_shepherd_config.dig('creds', 'password'),
+                user: vm_shepherd_config.dig('creds', 'user'),
+                password: vm_shepherd_config.dig('creds', 'password'),
               },
               vm_shepherd_config.dig('vdc', 'name'),
               stdout_logger
@@ -118,10 +109,10 @@ module VmShepherd
           when VmShepherd::VCLOUD_IAAS_TYPE then
             VmShepherd::VcloudManager.new(
               {
-                url:          vm_shepherd_config.dig('creds', 'url'),
+                url: vm_shepherd_config.dig('creds', 'url'),
                 organization: vm_shepherd_config.dig('creds', 'organization'),
-                user:         vm_shepherd_config.dig('creds', 'user'),
-                password:     vm_shepherd_config.dig('creds', 'password'),
+                user: vm_shepherd_config.dig('creds', 'user'),
+                password: vm_shepherd_config.dig('creds', 'password'),
               },
               vm_shepherd_config.dig('vdc', 'name'),
               stdout_logger
@@ -151,10 +142,10 @@ module VmShepherd
           @configs.each do |vm_shepherd_config|
             VmShepherd::VcloudManager.new(
               {
-                url:          vm_shepherd_config.dig('creds', 'url'),
+                url: vm_shepherd_config.dig('creds', 'url'),
                 organization: vm_shepherd_config.dig('creds', 'organization'),
-                user:         vm_shepherd_config.dig('creds', 'user'),
-                password:     vm_shepherd_config.dig('creds', 'password'),
+                user: vm_shepherd_config.dig('creds', 'user'),
+                password: vm_shepherd_config.dig('creds', 'password'),
               },
               vm_shepherd_config.dig('vdc', 'name'),
               stdout_logger,
@@ -170,8 +161,8 @@ module VmShepherd
               stdout_logger,
             ).clean_environment(
               datacenter_folders_to_clean: vm_shepherd_config.dig('cleanup', 'datacenter_folders_to_clean'),
-              datastores:                  vm_shepherd_config.dig('cleanup', 'datastores'),
-              datastore_folders_to_clean:  vm_shepherd_config.dig('cleanup', 'datastore_folders_to_clean'),
+              datastores: vm_shepherd_config.dig('cleanup', 'datastores'),
+              datastore_folders_to_clean: vm_shepherd_config.dig('cleanup', 'datastore_folders_to_clean'),
             )
           end
         when VmShepherd::AWS_IAAS_TYPE then
@@ -185,19 +176,34 @@ module VmShepherd
 
     private
 
-
     def stdout_logger
       Logger.new(STDOUT)
     end
 
+    def vsphere_vm_options(input_config)
+      {
+        ip: input_config.dig('vm', 'ip'),
+        gateway: input_config.dig('vm', 'gateway'),
+        netmask: input_config.dig('vm', 'netmask'),
+        dns: input_config.dig('vm', 'dns'),
+        ntp_servers: input_config.dig('vm', 'ntp_servers'),
+        cpus: input_config.dig('vm', 'cpus'),
+        ram_mb: input_config.dig('vm', 'ram_mb'),
+        vm_password: (input_config.dig('vm', 'vm_password') || 'tempest'),
+      }.tap do |result|
+        hostname = input_config.dig('vm', 'custom_hostname')
+        result[:custom_hostname] = hostname unless hostname.nil?
+      end
+    end
+
     def vcloud_deploy_options(vm_shepherd_config)
       VmShepherd::Vcloud::VappConfig.new(
-        name:    vm_shepherd_config.dig('vapp', 'ops_manager_name'),
-        ip:      vm_shepherd_config.dig('vapp', 'ip'),
+        name: vm_shepherd_config.dig('vapp', 'ops_manager_name'),
+        ip: vm_shepherd_config.dig('vapp', 'ip'),
         gateway: vm_shepherd_config.dig('vapp', 'gateway'),
         netmask: vm_shepherd_config.dig('vapp', 'netmask'),
-        dns:     vm_shepherd_config.dig('vapp', 'dns'),
-        ntp:     vm_shepherd_config.dig('vapp', 'ntp'),
+        dns: vm_shepherd_config.dig('vapp', 'dns'),
+        ntp: vm_shepherd_config.dig('vapp', 'ntp'),
         catalog: vm_shepherd_config.dig('vdc', 'catalog'),
         network: vm_shepherd_config.dig('vdc', 'network'),
       )
@@ -229,20 +235,20 @@ module VmShepherd
       OpenstackManager.new(
         auth_url: vm_shepherd_config.dig('creds', 'auth_url'),
         username: vm_shepherd_config.dig('creds', 'username'),
-        api_key:  vm_shepherd_config.dig('creds', 'api_key'),
-        tenant:   vm_shepherd_config.dig('creds', 'tenant'),
+        api_key: vm_shepherd_config.dig('creds', 'api_key'),
+        tenant: vm_shepherd_config.dig('creds', 'tenant'),
       )
     end
 
     def openstack_vm_options(vm_shepherd_config)
       {
-        name:                 vm_shepherd_config.dig('vm', 'name'),
-        flavor_name:          vm_shepherd_config.dig('vm', 'flavor_name'),
-        network_name:         vm_shepherd_config.dig('vm', 'network_name'),
-        key_name:             vm_shepherd_config.dig('vm', 'key_name'),
+        name: vm_shepherd_config.dig('vm', 'name'),
+        flavor_name: vm_shepherd_config.dig('vm', 'flavor_name'),
+        network_name: vm_shepherd_config.dig('vm', 'network_name'),
+        key_name: vm_shepherd_config.dig('vm', 'key_name'),
         security_group_names: vm_shepherd_config.dig('vm', 'security_group_names'),
-        public_ip:            vm_shepherd_config.dig('vm', 'public_ip'),
-        private_ip:           vm_shepherd_config.dig('vm', 'private_ip'),
+        public_ip: vm_shepherd_config.dig('vm', 'public_ip'),
+        private_ip: vm_shepherd_config.dig('vm', 'private_ip'),
       }
     end
 

data/lib/vm_shepherd/version.rb

@@ -1,3 +1,3 @@
 module VmShepherd
-  VERSION = '3.3.2'.freeze
+  VERSION = '3.4.0'.freeze
 end

data/lib/vm_shepherd/vsphere_manager.rb

@@ -112,7 +112,7 @@ module VmShepherd
     end
 
     def boot_vm(ovf_file_path, vm_config, vsphere_config)
-      datacenter.vmFolder.traverse(vsphere_config[:folder], RbVmomi::VIM::Folder, true)
+      ensure_folder_exists(vsphere_config[:folder])
       template = deploy_ovf_template(ovf_file_path, vsphere_config)
       vm       = create_vm_from_template(template, vm_config, vsphere_config)
 
@@ -120,6 +120,10 @@ module VmShepherd
       power_on_vm(vm)
     end
 
+    def ensure_folder_exists(folder_name)
+      datacenter.vmFolder.traverse(folder_name, RbVmomi::VIM::Folder, true)
+    end
+
     def delete_folder_and_vms(folder_name)
       3.times do |attempt|
         break unless (folder = datacenter.vmFolder.traverse(folder_name))
@@ -167,7 +171,17 @@ module VmShepherd
     def deploy_ovf_template(ovf_file_path, vsphere_config)
       template_name = [TEMPLATE_PREFIX, Time.new.strftime('%F-%H-%M'), cluster(vsphere_config).name].join('-')
       logger.info("BEGIN deploy_ovf ovf_file=#{ovf_file_path} template_name=#{template_name}")
+
       connection.serviceContent.ovfManager.deployOVF(
+        ovf_template_options(ovf_file_path, template_name, vsphere_config)
+      ).tap do |ovf_template|
+        ovf_template.add_delta_disk_layer_on_all_disks
+        ovf_template.MarkAsTemplate
+      end
+    end
+
+    def ovf_template_options(ovf_file_path, template_name, vsphere_config)
+      {
         uri:              ovf_file_path,
         vmName:           template_name,
         vmFolder:         target_folder(vsphere_config),
@@ -176,10 +190,7 @@ module VmShepherd
         datastore:        datastore(vsphere_config),
         networkMappings:  create_network_mappings(ovf_file_path, vsphere_config),
         propertyMappings: {},
-      ).tap do |ovf_template|
-        ovf_template.add_delta_disk_layer_on_all_disks
-        ovf_template.MarkAsTemplate
-      end
+      }
     end
 
     def find_deploy_host(vsphere_config)
@@ -203,7 +214,7 @@ module VmShepherd
     end
 
     def create_vm_from_template(template, vm_config, vsphere_config)
-      logger.info("BEGIN clone_vm_task tempalte=#{template.name}")
+      logger.info("BEGIN clone_vm_task template=#{template.name}")
       template.CloneVM_Task(
         folder: target_folder(vsphere_config),
         name:   "#{template.name}-vm",
@@ -218,17 +229,17 @@ module VmShepherd
           config:   {numCPUs: vm_config[:cpus] || 2, memoryMB: vm_config[:ram_mb] || 4096},
         }
       ).wait_for_completion.tap {
-        logger.info("END   clone_vm_task tempalte=#{template.name}")
+        logger.info("END   clone_vm_task template=#{template.name}")
       }
     end
 
     def reconfigure_vm(vm, vm_config)
       virtual_machine_config_spec = create_virtual_machine_config_spec(vm_config)
-      logger.info("BEGIN reconfigure_vm_task virtual_machine_cofig_spec=#{virtual_machine_config_spec.inspect}")
+      logger.info("BEGIN reconfigure_vm_task virtual_machine_config_spec=#{virtual_machine_config_spec.inspect}")
       vm.ReconfigVM_Task(
         spec: virtual_machine_config_spec
       ).wait_for_completion.tap {
-        logger.info("END   reconfigure_vm_task virtual_machine_cofig_spec=#{virtual_machine_config_spec.inspect}")
+        logger.info("END   reconfigure_vm_task virtual_machine_config_spec=#{virtual_machine_config_spec.inspect}")
       }
     end
 
@@ -255,6 +266,7 @@ module VmShepherd
         'gateway'     => vm_config[:gateway],
         'DNS'         => vm_config[:dns],
         'ntp_servers' => vm_config[:ntp_servers],
+        'custom_hostname' => vm_config[:custom_hostname],
       }
 
       vapp_property_specs = []

data/spec/fixtures/shepherd/vsphere.yml

@@ -21,6 +21,7 @@ vm_shepherd:
       cpus: OVA_CPUS
       ram_mb: OVA_RAM_MB
       vm_password: not-tempest
+      custom_hostname: not-default-hostname
     cleanup:
       datacenter: VSPHERE_OTHER_DATACENTER
       datastores:

data/spec/vm_shepherd/shepherd_spec.rb

@@ -151,6 +151,7 @@ module VmShepherd
               cpus:        first_config.dig('vm', 'cpus'),
               ram_mb:      first_config.dig('vm', 'ram_mb'),
               vm_password: first_config.dig('vm', 'vm_password'),
+              custom_hostname: first_config.dig('vm', 'custom_hostname')
             },
             {
               cluster:       first_config.dig('vsphere', 'cluster'),

data/spec/vm_shepherd/vsphere_manager_spec.rb

@@ -10,7 +10,30 @@ module VmShepherd
     let(:vm2) { instance_double(RbVmomi::VIM::VirtualMachine, name: 'vm_name2', resourcePool: instance_double(RbVmomi::VIM::ResourcePool, name: 'second_resource_pool')) }
     let(:vm3) { instance_double(RbVmomi::VIM::VirtualMachine, name: 'vm_name3', resourcePool: instance_double(RbVmomi::VIM::ResourcePool, name: 'second_resource_pool')) }
     let(:vms) { [vm1, vm2, vm3] }
+    let(:task) { instance_double(RbVmomi::VIM::Task) }
     let(:fake_logger) { instance_double(Logger).as_null_object }
+    let(:datacenter) do
+      instance_double(RbVmomi::VIM::Datacenter,
+        name: datacenter_name,
+        vmFolder: folder,
+        find_compute_resource: cluster,
+        find_datastore: datastore
+      )
+    end
+    let(:datastore) { double(name: datastore_name) }
+    let(:datastore_name) { 'datastore-name' }
+    let(:cluster) { instance_double(RbVmomi::VIM::ComputeResource, name: 'cluster-name', host: [host], resourcePool: double)}
+    let(:folder) { instance_double(RbVmomi::VIM::Folder, traverse: instance_double(RbVmomi::VIM::Folder)) }
+    let(:connection) { instance_double(RbVmomi::VIM, serviceContent: service_content, searchIndex: search_index) }
+    let(:service_content) do
+      instance_double(RbVmomi::VIM::ServiceContent,
+        searchIndex: search_index,
+        ovfManager: ovf_manager,
+        propertyCollector: instance_double(RbVmomi::VIM::PropertyCollector, collectMultiple: {}),
+      )
+    end
+    let(:search_index) { instance_double(RbVmomi::VIM::SearchIndex) }
+    let(:ovf_manager) { instance_double(RbVmomi::VIM::OvfManager) }
 
     subject(:vsphere_manager) { VsphereManager.new(host, username, password, datacenter_name, fake_logger) }
 
@@ -18,12 +41,69 @@ module VmShepherd
       expect { vsphere_manager }.not_to raise_error
     end
 
+    describe 'deploy' do
+      let(:tar_path) { 'example-tar' }
+      let(:ova_path) { 'example-ova' }
+      let(:folder_name) { 'example-folder' }
+      let(:ovf_template) { instance_double(RbVmomi::VIM::VirtualMachine, name: 'vm_name', add_delta_disk_layer_on_all_disks: nil, MarkAsTemplate: nil) }
+      let(:vsphere_config) { { folder: folder_name, datastore: datastore_name } }
+      let(:vm_config) { {ip: '10.0.0.1'} }
+
+      before do
+        allow(vsphere_manager).to receive(:system).with("nc -z -w 1 #{vm_config[:ip]} 443").and_return(false)
+        allow(vsphere_manager).to receive(:system).with(/tar xfv/).and_return(true)
+        allow(Dir).to receive(:[]).and_return(['foo.ovf'])
+        allow(vsphere_manager).to receive(:datacenter).and_return(datacenter)
+        allow(vsphere_manager).to receive(:connection).and_return(connection)
+        allow(ovf_manager).to receive(:deployOVF).and_return(ovf_template)
+        allow(vsphere_manager).to receive(:ovf_template_options).and_return({})
+      end
+
+      context 'When custom hostname is not set' do
+
+        it 'verifies the value of custom hostname is nil' do
+          expect(vsphere_manager).to receive(:create_vm_from_template).and_return(vm1)
+          allow(subject).to receive(:power_on_vm)
+          allow(task).to receive(:wait_for_completion)
+
+          expect(vm1).to receive(:ReconfigVM_Task) do |options|
+            custom_hostname_property = options[:spec].vAppConfig.property.find do |prop|
+              prop.instance_variable_get(:@props)[:info].instance_variable_get(:@props)[:label] == 'custom_hostname'
+            end
+            expect(custom_hostname_property).to_not be_nil
+            custom_hostname_value = custom_hostname_property.instance_variable_get(:@props)[:info].instance_variable_get(:@props)[:value]
+            expect(custom_hostname_value).to be_nil
+            task
+          end
+
+          subject.deploy(ova_path, vm_config, vsphere_config)
+        end
+      end
+
+      context 'When custom hostname is set' do
+        let(:vm_config) { {ip: '10.0.0.1', custom_hostname: 'meow' } }
+        it 'sets the custom hostname' do
+          expect(vsphere_manager).to receive(:create_vm_from_template).and_return(vm1)
+          allow(subject).to receive(:power_on_vm)
+          allow(task).to receive(:wait_for_completion)
+
+          expect(vm1).to receive(:ReconfigVM_Task) do |options|
+            custom_hostname_property = options[:spec].vAppConfig.property.find do |prop|
+              prop.instance_variable_get(:@props)[:info].instance_variable_get(:@props)[:label] == 'custom_hostname'
+            end
+            expect(custom_hostname_property).to_not be_nil
+            custom_hostname_value = custom_hostname_property.instance_variable_get(:@props)[:info].instance_variable_get(:@props)[:value]
+            expect(custom_hostname_value).to eq('meow')
+            task
+          end
+
+          subject.deploy(ova_path, vm_config, vsphere_config)
+        end
+      end
+    end
+
     describe 'clean_environment' do
-      let(:connection) { instance_double(RbVmomi::VIM, serviceContent: service_content, searchIndex: search_index) }
-      let(:service_content) { instance_double(RbVmomi::VIM::ServiceContent, searchIndex: search_index) }
-      let(:search_index) { instance_double(RbVmomi::VIM::SearchIndex) }
-      let(:folder) { instance_double(RbVmomi::VIM::Folder) }
-      let(:datacenter) { instance_double(RbVmomi::VIM::Datacenter, name: datacenter_name) }
+
       let(:filemanager) { instance_double(RbVmomi::VIM::FileManager) }
       let(:delete_datastore_file_task) { instance_double(RbVmomi::VIM::Task) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vm_shepherd
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.4.0
 platform: ruby
 authors:
 - Ops Manager Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-v1
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A tool for booting and tearing down Ops Manager VMs on various Infrastructures.