vmware-vra 1.0.0.rc1

data/spec/requests_spec.rb

@@ -0,0 +1,59 @@
+#
+# 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'
+
+describe Vra::Requests do
+  let(:client) do
+    Vra::Client.new(username: 'user@corp.local',
+                    password: 'password',
+                    tenant: 'tenant',
+                    base_url: 'https://vra.corp.local')
+  end
+
+  let(:requests) { Vra::Requests.new(client) }
+
+  describe '#all_resources' do
+    it 'calls the requests API endpoint' do
+      expect(client).to receive(:http_get_paginated_array!)
+        .with('/catalog-service/api/consumer/requests')
+        .and_return([])
+
+      requests.all_requests
+    end
+
+    it 'returns an array of request objects' do
+      allow(client).to receive(:http_get_paginated_array!)
+        .with('/catalog-service/api/consumer/requests')
+        .and_return([ { 'id' => '1' }, { 'id' => '2' } ])
+
+      items = requests.all_requests
+
+      expect(items[0]).to be_an_instance_of(Vra::Request)
+      expect(items[1]).to be_an_instance_of(Vra::Request)
+    end
+  end
+
+  describe '#by_id' do
+    it 'returns a request object' do
+      expect(Vra::Request).to receive(:new).with(client, '12345')
+
+      requests.by_id('12345')
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,245 @@
+#
+# 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 'ffi_yajl'
+
+describe Vra::Resource do
+  let(:client) do
+    Vra::Client.new(username: 'user@corp.local',
+                    password: 'password',
+                    tenant: 'tenant',
+                    base_url: 'https://vra.corp.local')
+  end
+
+  let(:resource_id) { '31a7badc-6562-458d-84f3-ec58d74a6953' }
+  let(:vm_payload) do
+    FFI_Yajl::Parser.parse(File.read(File.join(File.dirname(__FILE__),
+                                               'fixtures',
+                                               'resource',
+                                               'vm_resource.json')))
+  end
+
+  let(:vm_payload_no_ops) do
+    FFI_Yajl::Parser.parse(File.read(File.join(File.dirname(__FILE__),
+                                               'fixtures',
+                                               'resource',
+                                               'vm_resource_no_operations.json')))
+  end
+
+  let(:non_vm_payload) do
+    FFI_Yajl::Parser.parse(File.read(File.join(File.dirname(__FILE__),
+                                               'fixtures',
+                                               'resource',
+                                               'non_vm_resource.json')))
+  end
+
+  describe '#initialize' do
+    it 'raises an error if no ID or resource data have been provided' do
+      expect { Vra::Resource.new }.to raise_error(ArgumentError)
+    end
+
+    it 'raises an error if an ID and resource data have both been provided' do
+      expect { Vra::Resource.new(id: 123, data: 'foo') }.to raise_error(ArgumentError)
+    end
+
+    context 'when an ID is provided' do
+      it 'calls fetch_resource_data' do
+        resource = Vra::Resource.allocate
+        expect(resource).to receive(:fetch_resource_data)
+        resource.send(:initialize, client, id: resource_id)
+      end
+    end
+
+    context 'when resource data is provided' do
+      it 'populates the ID correctly' do
+        resource = Vra::Resource.new(client, data: vm_payload)
+        expect(resource.id).to eq resource_id
+      end
+    end
+  end
+
+  describe '#fetch_resource_data' do
+    it 'calls http_get! against the resources API endpoint' do
+      expect(client).to receive(:http_get!)
+        .with("/catalog-service/api/consumer/resources/#{resource_id}")
+        .and_return('')
+
+      Vra::Resource.new(client, id: resource_id)
+    end
+  end
+
+  context 'when a valid VM resource instance has been created' do
+    before(:each) do
+      @resource = Vra::Resource.new(client, data: vm_payload)
+    end
+
+    describe '#name' do
+      it 'returns the correct name' do
+        expect(@resource.name).to eq 'hol-dev-11'
+      end
+    end
+
+    describe '#status' do
+      it 'returns the correct status' do
+        expect(@resource.status).to eq 'ACTIVE'
+      end
+    end
+
+    describe '#vm?' do
+      it 'returns true for the VM resource we created' do
+        expect(@resource.vm?).to be true
+      end
+    end
+
+    describe '#tenant_id' do
+      it 'returns the correct tenant ID' do
+        expect(@resource.tenant_id).to eq 'vsphere.local'
+      end
+    end
+
+    describe '#tenant_name' do
+      it 'returns the correct tenant name' do
+        expect(@resource.tenant_name).to eq 'vsphere.local'
+      end
+    end
+
+    describe '#subtenant_id' do
+      it 'returns the correct subtenant ID' do
+        expect(@resource.subtenant_id).to eq '5327ddd3-1a4e-4663-9e9d-63db86ffc8af'
+      end
+    end
+
+    describe '#subtenant_name' do
+      it 'returns the correct subtenant name' do
+        expect(@resource.subtenant_name).to eq 'Rainpole Developers'
+      end
+    end
+
+    describe '#network_interfaces' do
+      it 'returns an array of 2 elements' do
+        expect(@resource.network_interfaces.size).to be 2
+      end
+
+      it 'contains the correct data' do
+        nic1, nic2 = @resource.network_interfaces
+
+        expect(nic1['NETWORK_NAME']).to eq 'VM Network'
+        expect(nic1['NETWORK_ADDRESS']).to eq '192.168.110.200'
+        expect(nic1['NETWORK_MAC_ADDRESS']).to eq '00:50:56:ae:95:3c'
+
+        expect(nic2['NETWORK_NAME']).to eq 'Management Network'
+        expect(nic2['NETWORK_ADDRESS']).to eq '192.168.220.200'
+        expect(nic2['NETWORK_MAC_ADDRESS']).to eq '00:50:56:ae:95:3d'
+      end
+    end
+
+    describe '#ip_addresses' do
+      it 'returns the correct IP addresses' do
+        expect(@resource.ip_addresses).to eq [ '192.168.110.200', '192.168.220.200' ]
+      end
+
+      it 'returns nil if there are no network interfaces' do
+        allow(@resource).to receive(:network_interfaces).and_return nil
+        expect(@resource.ip_addresses).to be_nil
+      end
+    end
+
+    describe '#actions' do
+      it 'does not call #fetch_resource_data' do
+        expect(@resource).not_to receive(:fetch_resource_data)
+        @resource.actions
+      end
+    end
+
+    describe '#action_id_by_name' do
+      it 'returns the correct action ID for the destroy action' do
+        expect(@resource.action_id_by_name('Destroy')).to eq 'ace8ba42-e724-48d8-9614-9b3a62b5a464'
+      end
+
+      it 'returns nil if there are no resource operations' do
+        allow(@resource).to receive(:actions).and_return nil
+        expect(@resource.action_id_by_name('Destroy')).to be_nil
+      end
+
+      it 'returns nil if there are actions, but none with the right name' do
+        allow(@resource).to receive(:actions).and_return([ { 'name' => 'some action' }, { 'name' => 'another action' } ])
+        expect(@resource.action_id_by_name('Destroy')).to be_nil
+      end
+    end
+
+    describe '#destroy' do
+      context 'when the destroy action is available' do
+        it 'calls gets the action ID and submits the request' do
+          expect(@resource).to receive(:action_id_by_name).with('Destroy').and_return('action-123')
+          expect(@resource).to receive(:submit_action_request).with('action-123')
+          @resource.destroy
+        end
+      end
+
+      context 'when the destroy action is not available' do
+        it 'raises an exception' do
+          allow(@resource).to receive(:action_id_by_name).and_return nil
+          expect { @resource.destroy }.to raise_error(Vra::Exception::NotFound)
+        end
+      end
+    end
+
+    describe '#submit_action_request' do
+      before do
+        allow(@resource).to receive(:action_request_payload).and_return({})
+        response = double('response', code: 200, headers: { location: '/requests/request-12345' })
+        allow(client).to receive(:http_post).with('/catalog-service/api/consumer/requests', '{}').and_return(response)
+      end
+
+      it 'calls http_post' do
+        expect(client).to receive(:http_post).with('/catalog-service/api/consumer/requests', '{}')
+
+        @resource.submit_action_request('action-123')
+      end
+
+      it 'returns a Vra::Request object' do
+        expect(@resource.submit_action_request('action-123')).to be_an_instance_of(Vra::Request)
+      end
+    end
+  end
+
+  context 'when a valid VM resource instance with no operations is created' do
+    before(:each) do
+      @resource = Vra::Resource.new(client, data: vm_payload_no_ops)
+    end
+
+    describe '#actions' do
+      it 'calls #fetch_resource_data' do
+        expect(@resource).to receive(:fetch_resource_data)
+        @resource.actions
+      end
+    end
+  end
+
+  context 'when a valid non-VM resource instance has been created' do
+    before(:each) do
+      @resource = Vra::Resource.new(client, data: non_vm_payload)
+    end
+
+    it 'returns nil for network_interfaces and ip_addresses' do
+      expect(@resource.network_interfaces).to be_nil
+      expect(@resource.ip_addresses).to be_nil
+    end
+  end
+end

data/spec/resources_spec.rb

@@ -0,0 +1,59 @@
+#
+# 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'
+
+describe Vra::Resources do
+  let(:client) do
+    Vra::Client.new(username: 'user@corp.local',
+                    password: 'password',
+                    tenant: 'tenant',
+                    base_url: 'https://vra.corp.local')
+  end
+
+  let(:resources) { Vra::Resources.new(client) }
+
+  describe '#all_resources' do
+    it 'calls the resources API endpoint' do
+      expect(client).to receive(:http_get_paginated_array!)
+        .with('/catalog-service/api/consumer/resources')
+        .and_return([])
+
+      resources.all_resources
+    end
+
+    it 'returns an array of resource objects' do
+      allow(client).to receive(:http_get_paginated_array!)
+        .with('/catalog-service/api/consumer/resources')
+        .and_return([ { 'id' => '1' }, { 'id' => '2' } ])
+
+      items = resources.all_resources
+
+      expect(items[0]).to be_an_instance_of(Vra::Resource)
+      expect(items[1]).to be_an_instance_of(Vra::Resource)
+    end
+  end
+
+  describe '#by_id' do
+    it 'returns a resource object' do
+      expect(Vra::Resource).to receive(:new).with(client, id: '12345')
+
+      resources.by_id('12345')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+#
+# 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 'vra'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)

data/vmware-vra.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vmware-vra'
+  spec.version       = Vra::VERSION
+  spec.authors       = ['Adam Leff']
+  spec.email         = ['partnereng@chef.io']
+  spec.summary       = 'Client gem for interacting with VMware vRealize Automation.'
+  spec.description   = spec.summary
+  spec.homepage      = ''
+  spec.license       = 'Apache 2.0'
+
+  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 'rest-client', '~> 1.8'
+  spec.add_dependency 'ffi-yajl',    '~> 2.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'pry',     '~> 0.10'
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: vmware-vra
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Adam Leff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: ffi-yajl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Client gem for interacting with VMware vRealize Automation.
+email:
+- partnereng@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/vra.rb
+- lib/vra/catalog.rb
+- lib/vra/catalog_item.rb
+- lib/vra/catalog_request.rb
+- lib/vra/client.rb
+- lib/vra/exceptions.rb
+- lib/vra/request.rb
+- lib/vra/request_parameters.rb
+- lib/vra/requests.rb
+- lib/vra/resource.rb
+- lib/vra/resources.rb
+- lib/vra/version.rb
+- spec/catalog_item_spec.rb
+- spec/catalog_request_spec.rb
+- spec/catalog_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/resource/non_vm_resource.json
+- spec/fixtures/resource/vm_resource.json
+- spec/fixtures/resource/vm_resource_no_operations.json
+- spec/request_spec.rb
+- spec/requests_spec.rb
+- spec/resource_spec.rb
+- spec/resources_spec.rb
+- spec/spec_helper.rb
+- vmware-vra.gemspec
+homepage: ''
+licenses:
+- Apache 2.0
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Client gem for interacting with VMware vRealize Automation.
+test_files:
+- spec/catalog_item_spec.rb
+- spec/catalog_request_spec.rb
+- spec/catalog_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/resource/non_vm_resource.json
+- spec/fixtures/resource/vm_resource.json
+- spec/fixtures/resource/vm_resource_no_operations.json
+- spec/request_spec.rb
+- spec/requests_spec.rb
+- spec/resource_spec.rb
+- spec/resources_spec.rb
+- spec/spec_helper.rb
+has_rdoc: