vm_shepherd 0.0.1

data/spec/vm_shepherd/vapp_manager/deployer_spec.rb

@@ -0,0 +1,287 @@
+require 'vm_shepherd/vapp_manager/deployer'
+
+module VmShepherd
+  module VappManager
+    RSpec.describe Deployer do
+      let(:login_info) do
+        {
+          url: 'FAKE_URL',
+          organization: 'FAKE_ORGANIZATION',
+          user: 'FAKE_USER',
+          password: 'FAKE_PASSWORD',
+        }
+      end
+      let(:location) do
+        {
+          catalog: 'FAKE_CATALOG',
+          network: 'FAKE_NETWORK',
+          vdc: 'FAKE_VDC',
+        }
+      end
+      let(:logger) { instance_double(Logger).as_null_object }
+
+      let(:deployer) { Deployer.new(login_info, location, logger) }
+
+      describe '#deploy' do
+        let(:vapp_config) do
+          {
+            ip: 'FAKE_IP',
+            name: 'FAKE_NAME',
+            gateway: 'FAKE_GATEWAY',
+            dns: 'FAKE_DNS',
+            ntp: 'FAKE_NTP',
+            ip: 'FAKE_IP',
+            netmask: 'FAKE_NETMASK',
+          }
+        end
+        let(:vapp_template_path) { 'FAKE_VAPP_TEMPLATE_PATH' }
+        let(:tmpdir) { 'FAKE_TMP_DIR' }
+
+        before { allow(Dir).to receive(:mktmpdir).and_return(tmpdir) }
+
+        context 'when NO host exists at the specified IP' do
+          let(:expanded_vapp_template_path) { 'FAKE_EXPANDED_VAPP_TEMPLATE_PATH' }
+
+          before do
+            allow(deployer).to receive(:system).with("ping -c 5 #{vapp_config.fetch(:ip)}").and_return(false)
+
+            allow(File).to receive(:expand_path).with(vapp_template_path).and_return(expanded_vapp_template_path)
+
+            allow(FileUtils).to receive(:remove_entry_secure)
+          end
+
+          it 'expands the vapp_template into a TMP dir' do
+            expect(deployer).to receive(:system).with("cd #{tmpdir} && tar xfv '#{expanded_vapp_template_path}'")
+
+            expect { deployer.deploy(vapp_template_path, vapp_config) }.to raise_error
+          end
+
+          context 'when the template can be expanded' do
+            let(:client) { instance_double(VCloudSdk::Client) }
+            let(:catalog) { instance_double(VCloudSdk::Catalog) }
+            let(:network_config) { instance_double(VCloudSdk::NetworkConfig) }
+            let(:vapp) { instance_double(VCloudSdk::VApp) }
+            let(:vm) { instance_double(VCloudSdk::VM) }
+
+            before do
+              allow(deployer).to receive(:system).with("cd #{tmpdir} && tar xfv '#{expanded_vapp_template_path}'").
+                  and_return(true)
+            end
+
+            context 'when the vApp can be deployed' do
+              let(:expected_properties) do
+                [
+                  {
+                    'type' => 'string',
+                    'key' => 'gateway',
+                    'value' => vapp_config.fetch(:gateway),
+                    'password' => 'false',
+                    'userConfigurable' => 'true',
+                    'Label' => 'Default Gateway',
+                    'Description' => 'The default gateway address for the VM network. Leave blank if DHCP is desired.'
+                  },
+                  {
+                    'type' => 'string',
+                    'key' => 'DNS',
+                    'value' => vapp_config.fetch(:dns),
+                    'password' => 'false',
+                    'userConfigurable' => 'true',
+                    'Label' => 'DNS',
+                    'Description' => 'The domain name servers for the VM (comma separated). Leave blank if DHCP is desired.',
+                  },
+                  {
+                    'type' => 'string',
+                    'key' => 'ntp_servers',
+                    'value' => vapp_config.fetch(:ntp),
+                    'password' => 'false',
+                    'userConfigurable' => 'true',
+                    'Label' => 'NTP Servers',
+                    'Description' => 'Comma-delimited list of NTP servers'
+                  },
+                  {
+                    'type' => 'string',
+                    'key' => 'admin_password',
+                    'value' => 'tempest',
+                    'password' => 'true',
+                    'userConfigurable' => 'true',
+                    'Label' => 'Admin Password',
+                    'Description' => 'This password is used to SSH into the VM. The username is "tempest".',
+                  },
+                  {
+                    'type' => 'string',
+                    'key' => 'ip0',
+                    'value' => vapp_config.fetch(:ip),
+                    'password' => 'false',
+                    'userConfigurable' => 'true',
+                    'Label' => 'IP Address',
+                    'Description' => 'The IP address for the VM. Leave blank if DHCP is desired.',
+                  },
+                  {
+                    'type' => 'string',
+                    'key' => 'netmask0',
+                    'value' => vapp_config.fetch(:netmask),
+                    'password' => 'false',
+                    'userConfigurable' => 'true',
+                    'Label' => 'Netmask',
+                    'Description' => 'The netmask for the VM network. Leave blank if DHCP is desired.'
+                  }
+                ]
+              end
+
+              before do
+                allow(VCloudSdk::Client).to receive(:new).and_return(client)
+                allow(client).to receive(:catalog_exists?)
+                allow(client).to receive(:delete_catalog_by_name)
+
+                allow(client).to receive(:create_catalog).and_return(catalog)
+                allow(catalog).to receive(:upload_vapp_template)
+                allow(catalog).to receive(:instantiate_vapp_template).and_return(vapp)
+
+                allow(VCloudSdk::NetworkConfig).to receive(:new).and_return(network_config)
+
+                allow(vapp).to receive(:find_vm_by_name).and_return(vm)
+                allow(vm).to receive(:product_section_properties=)
+                allow(vapp).to receive(:power_on)
+              end
+
+              it 'uses VCloudSdk::Client' do
+                expect(VCloudSdk::Client).to receive(:new).with(
+                    login_info.fetch(:url),
+                    [login_info.fetch(:user), login_info.fetch(:organization)].join('@'),
+                    login_info.fetch(:password),
+                    {},
+                    logger,
+                  ).and_return(client)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+
+              describe 'catalog deletion' do
+                before do
+                  allow(client).to receive(:catalog_exists?).and_return(catalog_exists)
+                end
+
+                context 'when the catalog exists' do
+                  let(:catalog_exists) { true }
+
+                  it 'deletes the catalog' do
+                    expect(client).to receive(:delete_catalog_by_name).with(location.fetch(:catalog))
+
+                    deployer.deploy(vapp_template_path, vapp_config)
+                  end
+                end
+
+                context 'when the catalog does not exist' do
+                  let(:catalog_exists) { false }
+
+                  it 'does not delete the catalog' do
+                    expect(client).not_to receive(:delete_catalog_by_name).with(location.fetch(:catalog))
+
+                    deployer.deploy(vapp_template_path, vapp_config)
+                  end
+                end
+              end
+
+              it 'creates the catalog' do
+                expect(client).to receive(:create_catalog).with(location.fetch(:catalog)).and_return(catalog)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+
+              it 'uploads the vApp template' do
+                expect(catalog).to receive(:upload_vapp_template).with(
+                    location.fetch(:vdc),
+                    vapp_config.fetch(:name),
+                    tmpdir,
+                  ).and_return(catalog)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+
+              it 'creates a VCloudSdk::NetworkConfig' do
+                expect(VCloudSdk::NetworkConfig).to receive(:new).with(
+                    location.fetch(:network),
+                    'Network 1',
+                  ).and_return(network_config)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+
+              it 'instantiates the vApp template' do
+                expect(catalog).to receive(:instantiate_vapp_template).with(
+                    vapp_config.fetch(:name),
+                    location.fetch(:vdc),
+                    vapp_config.fetch(:name),
+                    nil,
+                    nil,
+                    network_config
+                  ).and_return(vapp)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+
+              it 'sets the product section properties' do
+                expect(vm).to receive(:product_section_properties=).with(expected_properties)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+
+              it 'powers on the vApp' do
+                expect(vapp).to receive(:power_on)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+
+              it 'removes the expanded vApp template' do
+                expect(FileUtils).to receive(:remove_entry_secure).with(tmpdir, force: true)
+
+                deployer.deploy(vapp_template_path, vapp_config)
+              end
+            end
+
+            context 'when the vApp can NOT be deployed' do
+              it 'removes the expanded vApp template' do
+                expect(FileUtils).to receive(:remove_entry_secure).with(tmpdir, force: true)
+
+                expect { deployer.deploy(vapp_template_path, vapp_config) }.to raise_error
+              end
+            end
+          end
+
+          context 'when the template can NOT be expanded' do
+            let(:tar_expand_cmd) { "cd #{tmpdir} && tar xfv '#{expanded_vapp_template_path}'" }
+            before do
+              allow(deployer).to receive(:system).with(tar_expand_cmd).and_return(false)
+            end
+
+            it 'raises an error' do
+              expect { deployer.deploy(vapp_template_path, vapp_config) }.to raise_error("Error executing: #{tar_expand_cmd.inspect}")
+            end
+
+            it 'removes the expanded vApp template' do
+              expect(FileUtils).to receive(:remove_entry_secure).with(tmpdir, force: true)
+
+              expect { deployer.deploy(vapp_template_path, vapp_config) }.to raise_error
+            end
+          end
+        end
+
+        context 'when a host exists at the specified IP' do
+          before do
+            allow(deployer).to receive(:system).with("ping -c 5 #{vapp_config.fetch(:ip)}").and_return(true)
+          end
+
+          it 'raises an error' do
+            expect { deployer.deploy(vapp_template_path, vapp_config) }.to raise_error("VM exists at #{vapp_config.fetch(:ip)}")
+          end
+
+          it 'removes the expanded vApp template' do
+            expect(FileUtils).to receive(:remove_entry_secure).with(tmpdir, force: true)
+
+            expect { deployer.deploy(vapp_template_path, vapp_config) }.to raise_error
+          end
+        end
+      end
+    end
+  end
+end

data/spec/vm_shepherd/vapp_manager/destroyer_spec.rb

@@ -0,0 +1,104 @@
+require 'vm_shepherd/vapp_manager/destroyer'
+
+module VmShepherd
+  module VappManager
+    RSpec.describe Destroyer do
+      let(:login_info) do
+        {
+          url: 'FAKE_URL',
+          organization: 'FAKE_ORGANIZATION',
+          user: 'FAKE_USER',
+          password: 'FAKE_PASSWORD',
+        }
+      end
+      let(:location) do
+        {
+          catalog: 'FAKE_CATALOG',
+          vdc: 'FAKE_VDC',
+        }
+      end
+      let(:logger) { instance_double(Logger).as_null_object }
+
+      let(:destroyer) { Destroyer.new(login_info, location, logger) }
+
+      describe '#destroy' do
+        let(:client) { instance_double(VCloudSdk::Client) }
+        let(:vdc) { instance_double(VCloudSdk::VDC) }
+        let(:vapp) { instance_double(VCloudSdk::VApp) }
+        let(:vapp_name) { 'FAKE_VAPP_NAME' }
+
+        context 'when the catalog exists' do
+          before do
+            allow(client).to receive(:catalog_exists?).with(location.fetch(:catalog)).and_return(true)
+          end
+
+          it 'uses VCloudSdk::Client to delete the vApp' do
+            expect(client).to receive(:find_vdc_by_name).with(location.fetch(:vdc)).and_return(vdc)
+            expect(vdc).to receive(:find_vapp_by_name).with(vapp_name).and_return(vapp)
+            expect(vapp).to receive(:power_off)
+            expect(vapp).to receive(:delete)
+            expect(client).to receive(:delete_catalog_by_name).with(location.fetch(:catalog))
+
+            expect(VCloudSdk::Client).to receive(:new).with(
+                login_info.fetch(:url),
+                [login_info.fetch(:user), login_info.fetch(:organization)].join('@'),
+                login_info.fetch(:password),
+                {},
+                logger,
+              ).and_return(client)
+
+            destroyer.destroy(vapp_name)
+          end
+
+          context 'when an VCloudSdk::ObjectNotFoundError is thrown' do
+            before do
+              allow(VCloudSdk::Client).to receive(:new).and_return(client)
+              allow(client).to receive(:find_vdc_by_name).and_return(vdc)
+              allow(vdc).to receive(:find_vapp_by_name).and_return(vapp)
+              allow(vapp).to receive(:power_off)
+              allow(vapp).to receive(:delete)
+
+              allow(client).to receive(:delete_catalog_by_name)
+            end
+
+            it 'catches the error' do
+              allow(client).to receive(:find_vdc_by_name).and_raise(VCloudSdk::ObjectNotFoundError)
+
+              expect { destroyer.destroy(vapp_name) }.not_to raise_error
+            end
+
+            it 'deletes to catalog' do
+              expect(client).to receive(:delete_catalog_by_name).with(location.fetch(:catalog))
+
+              destroyer.destroy(vapp_name)
+            end
+          end
+        end
+
+        context 'when the catalog does not exist' do
+          before do
+            allow(client).to receive(:catalog_exists?).with(location.fetch(:catalog)).and_return(false)
+          end
+
+          it 'uses VCloudSdk::Client to delete the vApp' do
+            expect(client).to receive(:find_vdc_by_name).with(location.fetch(:vdc)).and_return(vdc)
+            expect(vdc).to receive(:find_vapp_by_name).with(vapp_name).and_return(vapp)
+            expect(vapp).to receive(:power_off)
+            expect(vapp).to receive(:delete)
+            expect(client).not_to receive(:delete_catalog_by_name).with(location.fetch(:catalog))
+
+            expect(VCloudSdk::Client).to receive(:new).with(
+                login_info.fetch(:url),
+                [login_info.fetch(:user), login_info.fetch(:organization)].join('@'),
+                login_info.fetch(:password),
+                {},
+                logger,
+              ).and_return(client)
+
+            destroyer.destroy(vapp_name)
+          end
+        end
+      end
+    end
+  end
+end

data/vm_shepherd.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vm_shepherd/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'vm_shepherd'
+  spec.version      = VmShepherd::VERSION
+  spec.authors      = ['Ops Manager Team']
+  spec.email        = ['cf-tempest-eng@pivotal.io']
+  spec.summary      = %q{A tool for booting and tearing down Ops Manager VMs on various Infrastructures.}
+  spec.description  = %q{A tool for booting and tearing down Ops Manager VMs on various Infrastructures.}
+  spec.homepage     = ''
+
+  spec.files          = `git ls-files -z`.split("\x0")
+  spec.executables    = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files     = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths  = ['lib']
+
+  spec.add_dependency 'aws-sdk-v1'
+
+  spec.add_dependency 'ruby_vcloud_sdk', '~> 0.7.0'
+
+  spec.add_dependency 'rbvmomi'
+  spec.add_dependency 'vsphere_clients'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'recursive-open-struct', '~> 0.5.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: vm_shepherd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ops Manager Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_vcloud_sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rbvmomi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vsphere_clients
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool for booting and tearing down Ops Manager VMs on various Infrastructures.
+email:
+- cf-tempest-eng@pivotal.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- ci/run_specs.sh
+- lib/vm_shepherd/ami_manager.rb
+- lib/vm_shepherd/ova_manager/base.rb
+- lib/vm_shepherd/ova_manager/deployer.rb
+- lib/vm_shepherd/ova_manager/destroyer.rb
+- lib/vm_shepherd/ova_manager/open_monkey_patch.rb
+- lib/vm_shepherd/shepherd.rb
+- lib/vm_shepherd/vapp_manager/deployer.rb
+- lib/vm_shepherd/vapp_manager/destroyer.rb
+- lib/vm_shepherd/version.rb
+- spec/fixtures/ova_manager/foo.ova
+- spec/fixtures/shepherd/aws.yml
+- spec/fixtures/shepherd/unknown.yml
+- spec/fixtures/shepherd/vcloud.yml
+- spec/fixtures/shepherd/vsphere.yml
+- spec/spec_helper.rb
+- spec/vm_shepherd/ami_manager_spec.rb
+- spec/vm_shepherd/ova_manager/base_spec.rb
+- spec/vm_shepherd/ova_manager/deployer_spec.rb
+- spec/vm_shepherd/ova_manager/destroyer_spec.rb
+- spec/vm_shepherd/shepherd_spec.rb
+- spec/vm_shepherd/vapp_manager/deployer_spec.rb
+- spec/vm_shepherd/vapp_manager/destroyer_spec.rb
+- vm_shepherd.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A tool for booting and tearing down Ops Manager VMs on various Infrastructures.
+test_files:
+- spec/fixtures/ova_manager/foo.ova
+- spec/fixtures/shepherd/aws.yml
+- spec/fixtures/shepherd/unknown.yml
+- spec/fixtures/shepherd/vcloud.yml
+- spec/fixtures/shepherd/vsphere.yml
+- spec/spec_helper.rb
+- spec/vm_shepherd/ami_manager_spec.rb
+- spec/vm_shepherd/ova_manager/base_spec.rb
+- spec/vm_shepherd/ova_manager/deployer_spec.rb
+- spec/vm_shepherd/ova_manager/destroyer_spec.rb
+- spec/vm_shepherd/shepherd_spec.rb
+- spec/vm_shepherd/vapp_manager/deployer_spec.rb
+- spec/vm_shepherd/vapp_manager/destroyer_spec.rb