knife-vrealize 1.0.0.rc1

data/lib/chef/knife/vra_server_show.rb

@@ -0,0 +1,52 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/knife'
+require 'chef/knife/cloud/server/show_options'
+require 'chef/knife/cloud/server/show_command'
+require 'chef/knife/cloud/vra_service'
+require 'chef/knife/cloud/vra_service_helpers'
+require 'chef/knife/cloud/vra_service_options'
+
+class Chef
+  class Knife
+    class Cloud
+      class VraServerShow < ServerShowCommand
+        include ServerShowOptions
+        include VraServiceHelpers
+        include VraServiceOptions
+
+        banner 'knife vra server show RESOURCE_ID (options)'
+
+        def validate_params!
+          if @name_args.empty?
+            ui.error('You must supply a Resource ID for a server to display.')
+            exit 1
+          end
+
+          if @name_args.size > 1
+            ui.error('You may only supply one Resource ID.')
+            exit 1
+          end
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/knife-vrealize/version.rb

@@ -0,0 +1,21 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module KnifeVrealize
+  VERSION = '1.0.0.rc1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

data/spec/unit/cloud/vra_service_helpers_spec.rb

@@ -0,0 +1,150 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+require 'chef/knife'
+require 'chef/knife/cloud/vra_service'
+require 'chef/knife/cloud/vra_service_helpers'
+
+class HelpersTester
+  include Chef::Knife::Cloud::VraServiceHelpers
+  attr_accessor :ui
+end
+
+describe 'Chef::Knife::Cloud::VraServiceHelpers' do
+  subject { HelpersTester.new }
+
+  before(:each) do
+    subject.ui = Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
+  end
+
+  describe '#create_service_instance' do
+    it 'creates a service instance' do
+      allow(subject).to receive(:locate_config_value).with(:vra_username).and_return('myuser')
+      allow(subject).to receive(:locate_config_value).with(:vra_password).and_return('mypassword')
+      allow(subject).to receive(:locate_config_value).with(:vra_base_url).and_return('https://vra.corp.local')
+      allow(subject).to receive(:locate_config_value).with(:vra_tenant).and_return('mytenant')
+      allow(subject).to receive(:locate_config_value).with(:vra_disable_ssl_verify).and_return(false)
+
+      expect(Chef::Knife::Cloud::VraService).to receive(:new)
+        .with(username:   'myuser',
+              password:   'mypassword',
+              base_url:   'https://vra.corp.local',
+              tenant:     'mytenant',
+              verify_ssl: true)
+
+      subject.create_service_instance
+    end
+  end
+
+  describe '#verify_ssl?' do
+    context 'when vra_disable_ssl_verify is true' do
+      it 'returns false' do
+        allow(subject).to receive(:locate_config_value).with(:vra_disable_ssl_verify).and_return(true)
+        expect(subject.verify_ssl?).to be false
+      end
+    end
+
+    context 'when vra_disable_ssl_verify is false' do
+      it 'returns true' do
+        allow(subject).to receive(:locate_config_value).with(:vra_disable_ssl_verify).and_return(false)
+        expect(subject.verify_ssl?).to be true
+      end
+    end
+  end
+
+  describe '#wait_for_request' do
+    before(:each) do
+      # muffle any stdout output from this method
+      allow(subject).to receive(:print)
+
+      # don't actually sleep
+      allow(subject).to receive(:sleep)
+    end
+
+    context 'when the requests completes normally, 3 loops' do
+      it 'only refreshes the request 3 times' do
+        request = double('request')
+        allow(request).to receive(:status)
+        allow(request).to receive(:completed?).exactly(3).times.and_return(false, false, true)
+        expect(request).to receive(:refresh).exactly(3).times
+
+        subject.wait_for_request(request)
+      end
+    end
+
+    context 'when the request is completed on the first loop' do
+      it 'only refreshes the request 1 time' do
+        request = double('request')
+        allow(request).to receive(:status)
+        allow(request).to receive(:completed?).once.and_return(true)
+        expect(request).to receive(:refresh).once
+
+        subject.wait_for_request(request)
+      end
+    end
+
+    context 'when the timeout is exceeded' do
+      it 'prints a warning and exits' do
+        request = double('request')
+        allow(Timeout).to receive(:timeout).and_raise(Timeout::Error)
+        expect(subject.ui).to receive(:msg).with('')
+        expect(subject.ui).to receive(:error)
+          .with('Request did not complete in 600 seconds. Check the Requests tab in the vRA UI for more information.')
+        expect { subject.wait_for_request(request) }.to raise_error(SystemExit)
+      end
+    end
+
+    context 'when a non-timeout exception is raised' do
+      it 'raises the original exception' do
+        request = double('request')
+        allow(request).to receive(:refresh).and_raise(RuntimeError)
+        expect { subject.wait_for_request(request) }.to raise_error(RuntimeError)
+      end
+    end
+  end
+
+  describe '#validate!' do
+    it 'calls checks for empty VRA connection configuration values' do
+      expect(subject).to receive(:check_for_missing_config_values!)
+        .with(:vra_username, :vra_password, :vra_base_url, :vra_tenant)
+
+      subject.validate!
+    end
+  end
+
+  describe '#check_for_missing_config_values!' do
+    context 'when all values exist' do
+      it 'does not raise an error' do
+        allow(subject).to receive(:locate_config_value).with(:key1).and_return('value')
+        allow(subject).to receive(:locate_config_value).with(:key2).and_return('value')
+        expect(subject.ui).not_to receive(:error)
+        expect { subject.check_for_missing_config_values!(:key1, :key2) }.not_to raise_error
+      end
+    end
+
+    context 'when a value does not exist' do
+      it 'prints an error and exits' do
+        allow(subject).to receive(:locate_config_value).with(:key1).and_return('value')
+        allow(subject).to receive(:locate_config_value).with(:key2).and_return(nil)
+        expect(subject.ui).to receive(:error)
+        expect { subject.check_for_missing_config_values!(:key1, :key2) }.to raise_error(SystemExit)
+      end
+    end
+  end
+end

data/spec/unit/cloud/vra_service_spec.rb

@@ -0,0 +1,250 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+require 'chef/knife/cloud/exceptions'
+require 'chef/knife/cloud/vra_service'
+require 'support/shared_examples_for_service'
+
+describe Chef::Knife::Cloud::VraService do
+  subject do
+    Chef::Knife::Cloud::VraService.new(username:   'myuser',
+                                       password:   'mypassword',
+                                       base_url:   'https://vra.corp.local',
+                                       tenant:     'mytenant',
+                                       verify_ssl: true)
+  end
+
+  before(:each) do
+    subject.ui = Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
+    allow(subject.ui).to receive(:msg).with('')
+  end
+
+  describe '#connection' do
+    it 'creates a Vra::Client object' do
+      expect(subject.connection).to be_an_instance_of(Vra::Client)
+    end
+  end
+
+  describe '#create_server' do
+    before(:each) do
+      allow(subject.ui).to receive(:msg).with('Catalog request 1 submitted.')
+      allow(subject.ui).to receive(:msg).with("Catalog request complete.\n")
+    end
+
+    context 'when the request is successful' do
+      it 'calls all the appropriate methods' do
+        submitted_request = double('submitted_request', id: 1, failed?: false)
+        resource = double('resource', vm?: true)
+        allow(submitted_request).to receive(:resources).and_return([resource])
+        expect(subject).to receive_message_chain(:catalog_request, :submit).and_return(submitted_request)
+        expect(subject).to receive(:wait_for_request)
+        expect(subject).to receive(:request_summary)
+
+        server = subject.create_server
+        expect(server).to eq resource
+      end
+    end
+
+    context 'when the request failed' do
+      it 'raises an exception' do
+        submitted_request = double('submitted_request', id: 1, failed?: true, completion_details: 'it failed')
+        expect(subject).to receive_message_chain(:catalog_request, :submit).and_return(submitted_request)
+        expect(subject).to receive(:wait_for_request)
+        expect(subject).to receive(:request_summary)
+
+        expect { subject.create_server }.to raise_error(Chef::Knife::Cloud::CloudExceptions::ServerCreateError)
+      end
+    end
+
+    context 'when the request returns no resources' do
+      it 'raises an exception' do
+        submitted_request = double('submitted_request', id: 1, failed?: false)
+        allow(submitted_request).to receive(:resources).and_return([])
+        expect(subject).to receive_message_chain(:catalog_request, :submit).and_return(submitted_request)
+        expect(subject).to receive(:wait_for_request)
+        expect(subject).to receive(:request_summary)
+
+        expect { subject.create_server }.to raise_error(Chef::Knife::Cloud::CloudExceptions::ServerCreateError)
+      end
+    end
+
+    context 'when the request returns more than one VM resource' do
+      it 'raises an exception' do
+        submitted_request = double('submitted_request', id: 1, failed?: false)
+        resource1 = double('resource1', vm?: true)
+        resource2 = double('resource2', vm?: true)
+        allow(submitted_request).to receive(:resources).and_return([resource1, resource2])
+        expect(subject).to receive_message_chain(:catalog_request, :submit).and_return(submitted_request)
+        expect(subject).to receive(:wait_for_request)
+        expect(subject).to receive(:request_summary)
+
+        expect { subject.create_server }.to raise_error(Chef::Knife::Cloud::CloudExceptions::ServerCreateError)
+      end
+    end
+
+    context 'when the request returns multiple resources, but only 1 VM' do
+      it 'happily returns the server resource' do
+        submitted_request = double('submitted_request', id: 1, failed?: false)
+        resource1 = double('resource1', vm?: true)
+        resource2 = double('resource2', vm?: false)
+        allow(submitted_request).to receive(:resources).and_return([resource1, resource2])
+        expect(subject).to receive_message_chain(:catalog_request, :submit).and_return(submitted_request)
+        expect(subject).to receive(:wait_for_request)
+        expect(subject).to receive(:request_summary)
+
+        server = subject.create_server
+        expect(server).to eq resource1
+      end
+    end
+  end
+
+  describe '#delete_server' do
+    context 'when the server exists' do
+      it 'calls the appropriate methods' do
+        server = double('server', status: 'ACTIVE')
+        destroy_request = double('destroy_request', id: 1)
+        expect(subject).to receive(:get_server).with('12345').and_return(server)
+        expect(subject).to receive(:server_summary).with(server)
+        expect(subject.ui).to receive(:confirm)
+        expect(server).to receive(:destroy).and_return(destroy_request)
+        expect(subject.ui).to receive(:msg).with('Destroy request 1 submitted.')
+        expect(subject).to receive(:wait_for_request)
+        expect(subject.ui).to receive(:msg).with('Destroy request complete.')
+        expect(subject).to receive(:request_summary)
+
+        subject.delete_server('12345')
+      end
+    end
+
+    context 'when the server is already deleted' do
+      it 'does not call #destroy on the server object' do
+        server = double('server', status: 'DELETED')
+        expect(subject).to receive(:get_server).with('12345').and_return(server)
+        expect(subject).to receive(:server_summary).with(server)
+        expect(subject.ui).to receive(:warn).with("Server is already deleted.\n")
+        expect(server).not_to receive(:destroy)
+
+        subject.delete_server('12345')
+      end
+    end
+  end
+
+  describe '#list_servers' do
+    it 'calls all_resources' do
+      expect(subject).to receive_message_chain(:connection, :resources, :all_resources)
+        .and_return([])
+
+      subject.list_servers
+    end
+  end
+
+  describe '#list_catalog_items' do
+    context 'when requesting entitled items only' do
+      it 'calls entitled_items' do
+        expect(subject).to receive_message_chain(:connection, :catalog, :entitled_items)
+
+        subject.list_catalog_items(true)
+      end
+    end
+
+    context 'when requesting all items' do
+      it 'calls all_items' do
+        expect(subject).to receive_message_chain(:connection, :catalog, :all_items)
+
+        subject.list_catalog_items(false)
+      end
+    end
+  end
+
+  describe '#get_server' do
+    it 'calls resources.by_id' do
+      expect(subject).to receive_message_chain(:connection, :resources, :by_id).with('12345')
+
+      subject.get_server('12345')
+    end
+  end
+
+  describe '#catalog_request' do
+    context 'when handling a proper request' do
+      it 'calls the appropriate methods' do
+        catalog_request = double('catalog_request')
+        expect(catalog_request).to receive(:cpus=).with(1)
+        expect(catalog_request).to receive(:memory=).with(512)
+        expect(catalog_request).to receive(:requested_for=).with('myuser@corp.local')
+        expect(catalog_request).to receive(:lease_days=).with(5)
+        expect(catalog_request).to receive(:notes=).with('my notes')
+        expect(catalog_request).to receive(:subtenant_id=).with('tenant1')
+        expect(subject).to receive_message_chain(:connection, :catalog, :request)
+          .with('12345')
+          .and_return(catalog_request)
+
+        subject.catalog_request(catalog_id: '12345',
+                                cpus: 1,
+                                memory: 512,
+                                requested_for: 'myuser@corp.local',
+                                lease_days: 5,
+                                notes: 'my notes',
+                                subtenant_id: 'tenant1')
+      end
+    end
+
+    context 'when optional arguments are missing' do
+      it 'does not call the attr setters for the missing attributes' do
+        catalog_request = double('catalog_request')
+        expect(catalog_request).to receive(:cpus=).with(1)
+        expect(catalog_request).to receive(:memory=).with(512)
+        expect(catalog_request).to receive(:requested_for=).with('myuser@corp.local')
+        expect(catalog_request).to_not receive(:lease_days=)
+        expect(catalog_request).to_not receive(:notes=)
+        expect(catalog_request).to_not receive(:subtenant_id=)
+        expect(subject).to receive_message_chain(:connection, :catalog, :request)
+          .with('12345')
+          .and_return(catalog_request)
+
+        subject.catalog_request(catalog_id: '12345',
+                                cpus: 1,
+                                memory: 512,
+                                requested_for: 'myuser@corp.local')
+      end
+    end
+
+    context 'when extra parameters are supplied' do
+      it 'calls set_parameter on the catalog_request' do
+        catalog_request = double('catalog_request')
+        expect(catalog_request).to receive(:cpus=).with(1)
+        expect(catalog_request).to receive(:memory=).with(512)
+        expect(catalog_request).to receive(:requested_for=).with('myuser@corp.local')
+        expect(catalog_request).to receive(:set_parameter).with('key1', 'string', 'value1')
+        expect(catalog_request).to receive(:set_parameter).with('key2', 'integer', '2')
+        expect(subject).to receive_message_chain(:connection, :catalog, :request)
+          .with('12345')
+          .and_return(catalog_request)
+
+        subject.catalog_request(catalog_id: '12345',
+                                cpus: 1,
+                                memory: 512,
+                                requested_for: 'myuser@corp.local',
+                                vra_extra_params: {
+                                  'key1' => { type: 'string', value: 'value1' },
+                                  'key2' => { type: 'integer', value: '2' }
+                                })
+      end
+    end
+  end
+end