vmware-vra 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01f8978ee0a6e0ed1865001f50876e122b5ee30f
-  data.tar.gz: ff5897d229cc674c2f5b3310c29bbe7857f6b55c
+  metadata.gz: 563dc4afc43f55acb9a8730e85c36eb056bf8659
+  data.tar.gz: 7cd1b95d64942372852164ae4a9d46d7b29eb102
 SHA512:
-  metadata.gz: fe516b37bc68296e53500270d3ac357d52ed176974e55ae539ab302f3cffa6453be5cc264c27f0b41ba1813027145d2ad99641ee9f545704213e827ee55b67ae
-  data.tar.gz: b94a9d038ea6dbe094b601baedd89fc2c0c26b455613699ffc88cad4556c8117d2244204a3671c336252a51bfbd6eb50d490975785eac7268c47d03fd8636f0d
+  metadata.gz: bfd135e158d35ff715734115ba2185762d680b397e4488bb7d3afa4ff19a7c8cb64b58f244512d9c4d12d60f8822c349bc02e8dcc308cff5c9b3bac59e1006e3
+  data.tar.gz: f32e242fe52fdb7596de59cf6d792f7097fd3b9a514e80204b608219b6f7799c15cd4f6f73db7b71d8c0c24797cfced5ceae64232ad5f68366c9db91ccab7b27

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v1.3.0
+* [pr#13](https://github.com/chef-partners/vmware-vra-gem/pull/13) Additional methods to support a vRA driver for Chef Provisioning
+
 ## v1.2.0
 * [pr#11](https://github.com/chef-partners/vmware-vra-gem/pull/11) Ability to set paginated results page size, which is a workaround for issue reported in #10 regarding duplicate items returned in paginated results.
 

data/lib/vra/resource.rb

@@ -49,55 +49,87 @@ module Vra
     rescue Vra::Exception::HTTPNotFound
       raise Vra::Exception::NotFound, "resource ID #{@id} does not exist"
     end
+    alias_method :refresh, :fetch_resource_data
 
     def name
-      @resource_data['name']
+      resource_data['name']
+    end
+
+    def description
+      resource_data['description']
     end
 
     def status
-      @resource_data['status']
+      resource_data['status']
     end
 
     def vm?
-      @resource_data['resourceTypeRef']['id'] == 'Infrastructure.Virtual'
+      resource_data['resourceTypeRef']['id'] == 'Infrastructure.Virtual'
     end
 
     def tenant_id
-      @resource_data['organization']['tenantRef']
+      resource_data['organization']['tenantRef']
     end
 
     def tenant_name
-      @resource_data['organization']['tenantLabel']
+      resource_data['organization']['tenantLabel']
     end
 
     def subtenant_id
-      @resource_data['organization']['subtenantRef']
+      resource_data['organization']['subtenantRef']
     end
 
     def subtenant_name
-      @resource_data['organization']['subtenantLabel']
+      resource_data['organization']['subtenantLabel']
     end
 
     def catalog_id
-      @resource_data['catalogItem']['id']
+      resource_data['catalogItem']['id']
     end
 
     def catalog_name
-      @resource_data['catalogItem']['label']
+      resource_data['catalogItem']['label']
     end
 
     def owner_ids
-      @resource_data['owners'].map { |x| x['ref'] }
+      resource_data['owners'].map { |x| x['ref'] }
     end
 
     def owner_names
-      @resource_data['owners'].map { |x| x['value'] }
+      resource_data['owners'].map { |x| x['value'] }
+    end
+
+    def machine_status
+      status = resource_data['resourceData']['entries'].find { |x| x['key'] == 'MachineStatus' }
+      raise 'No MachineStatus entry available for resource' if status.nil?
+
+      status['value']['value']
+    end
+
+    def machine_on?
+      machine_status == 'On'
+    end
+
+    def machine_off?
+      machine_status == 'Off'
+    end
+
+    def machine_turning_on?
+      machine_status == 'TurningOn'
+    end
+
+    def machine_turning_off?
+      %w(TurningOff ShuttingDown).include?(machine_status)
+    end
+
+    def machine_in_provisioned_state?
+      machine_status == 'MachineProvisioned'
     end
 
     def network_interfaces
       return unless vm?
 
-      network_list = @resource_data['resourceData']['entries'].find { |x| x['key'] == 'NETWORK_LIST' }
+      network_list = resource_data['resourceData']['entries'].find { |x| x['key'] == 'NETWORK_LIST' }
       return if network_list.nil?
 
       network_list['value']['items'].each_with_object([]) do |item, nics|
@@ -127,9 +159,9 @@ module Vra
     def actions
       # if this Resource instance was created with data from a "all_resources" fetch,
       # it is likely missing operations data because the vRA API is not pleasant sometimes.
-      fetch_resource_data if @resource_data['operations'].nil?
+      fetch_resource_data if resource_data['operations'].nil?
 
-      @resource_data['operations']
+      resource_data['operations']
     end
 
     def action_id_by_name(name)
@@ -148,6 +180,27 @@ module Vra
       submit_action_request(action_id)
     end
 
+    def shutdown
+      action_id = action_id_by_name('Shutdown')
+      raise Vra::Exception::NotFound, "No shutdown action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id)
+    end
+
+    def poweroff
+      action_id = action_id_by_name('Power Off')
+      raise Vra::Exception::NotFound, "No power-off action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id)
+    end
+
+    def poweron
+      action_id = action_id_by_name('Power On')
+      raise Vra::Exception::NotFound, "No power-on action found for resource #{@id}" if action_id.nil?
+
+      submit_action_request(action_id)
+    end
+
     def action_request_payload(action_id)
       {
         '@type' => 'ResourceActionRequest',

data/lib/vra/version.rb

@@ -17,5 +17,5 @@
 #
 
 module Vra
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/fixtures/resource/vm_resource.json

@@ -6,6 +6,7 @@
     "label": "Virtual Machine"
   },
   "name": "hol-dev-11",
+  "description": "test-description",
   "status": "ACTIVE",
   "organization": {
     "tenantRef": "vsphere.local",

data/spec/resource_spec.rb

@@ -19,6 +19,23 @@
 require 'spec_helper'
 require 'ffi_yajl'
 
+shared_examples_for 'a resource action' do |action_method, action_name|
+  context 'when the action is available' do
+    it 'calls gets the action ID and submits the request' do
+      expect(resource).to receive(:action_id_by_name).with(action_name).and_return('action-123')
+      expect(resource).to receive(:submit_action_request).with('action-123')
+      resource.send(action_method)
+    end
+  end
+
+  context 'when the action is not available' do
+    it 'raises an exception' do
+      expect(resource).to receive(:action_id_by_name).with(action_name).and_return nil
+      expect { resource.send(action_method) }.to raise_error(Vra::Exception::NotFound)
+    end
+  end
+end
+
 describe Vra::Resource do
   let(:client) do
     Vra::Client.new(username: 'user@corp.local',
@@ -93,6 +110,12 @@ describe Vra::Resource do
       end
     end
 
+    describe '#description' do
+      it 'returns the correct description' do
+        expect(resource.description).to eq 'test-description'
+      end
+    end
+
     describe '#status' do
       it 'returns the correct status' do
         expect(resource.status).to eq 'ACTIVE'
@@ -141,6 +164,102 @@ describe Vra::Resource do
       end
     end
 
+    describe '#machine_status' do
+      context 'when no MachineStatus exists' do
+        let(:resource_data) { { 'resourceData' => { 'entries' => [] } } }
+
+        it 'raises an exception' do
+          allow(resource).to receive(:resource_data).and_return(resource_data)
+          expect { resource.machine_status }.to raise_error(RuntimeError)
+        end
+      end
+
+      context 'when MachineStatus Exists' do
+        let(:resource_data) do
+          {
+            'resourceData' => {
+              'entries' => [
+                {
+                  'key' => 'MachineStatus',
+                  'value' => { 'type' => 'string', 'value' => 'Off' }
+                }
+              ]
+            }
+          }
+        end
+
+        it 'returns the correct status value' do
+          allow(resource).to receive(:resource_data).and_return(resource_data)
+          expect(resource.machine_status).to eq('Off')
+        end
+      end
+    end
+
+    describe '#machine_on?' do
+      it 'returns true if the machine_status is On' do
+        allow(resource).to receive(:machine_status).and_return('On')
+        expect(resource.machine_on?).to eq(true)
+      end
+
+      it 'returns false if the machine_status is not On' do
+        allow(resource).to receive(:machine_status).and_return('Off')
+        expect(resource.machine_on?).to eq(false)
+      end
+    end
+
+    describe '#machine_off?' do
+      it 'returns true if the machine_status is Off' do
+        allow(resource).to receive(:machine_status).and_return('Off')
+        expect(resource.machine_off?).to eq(true)
+      end
+
+      it 'returns false if the machine_status is not Off' do
+        allow(resource).to receive(:machine_status).and_return('On')
+        expect(resource.machine_off?).to eq(false)
+      end
+    end
+
+    describe '#machine_turning_on?' do
+      it 'returns true if the machine_status is TurningOn' do
+        allow(resource).to receive(:machine_status).and_return('TurningOn')
+        expect(resource.machine_turning_on?).to eq(true)
+      end
+
+      it 'returns false if the machine_status is not TurningOn' do
+        allow(resource).to receive(:machine_status).and_return('On')
+        expect(resource.machine_turning_on?).to eq(false)
+      end
+    end
+
+    describe '#machine_turning_off?' do
+      it 'returns true if the machine_status is TurningOff' do
+        allow(resource).to receive(:machine_status).and_return('TurningOff')
+        expect(resource.machine_turning_off?).to eq(true)
+      end
+
+      it 'returns true if the machine_status is ShuttingDown' do
+        allow(resource).to receive(:machine_status).and_return('ShuttingDown')
+        expect(resource.machine_turning_off?).to eq(true)
+      end
+
+      it 'returns false if the machine_status is not TurningOff or ShuttingDown' do
+        allow(resource).to receive(:machine_status).and_return('Off')
+        expect(resource.machine_turning_off?).to eq(false)
+      end
+    end
+
+    describe '#machine_in_provisioned_state?' do
+      it 'returns true if the machine_status is MachineProvisioned' do
+        allow(resource).to receive(:machine_status).and_return('MachineProvisioned')
+        expect(resource.machine_in_provisioned_state?).to eq(true)
+      end
+
+      it 'returns false if the machine_status is not MachineProvisioned' do
+        allow(resource).to receive(:machine_status).and_return('On')
+        expect(resource.machine_in_provisioned_state?).to eq(false)
+      end
+    end
+
     describe '#network_interfaces' do
       it 'returns an array of 2 elements' do
         expect(resource.network_interfaces.size).to be 2
@@ -194,20 +313,19 @@ describe Vra::Resource do
     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
+      it_behaves_like 'a resource action', :destroy, 'Destroy'
+    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
+    describe '#shutdown' do
+      it_behaves_like 'a resource action', :shutdown, 'Shutdown'
+    end
+
+    describe '#poweroff' do
+      it_behaves_like 'a resource action', :poweroff, 'Power Off'
+    end
+
+    describe '#poweron' do
+      it_behaves_like 'a resource action', :poweron, 'Power On'
     end
 
     describe '#submit_action_request' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmware-vra
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Adam Leff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Client gem for interacting with VMware vRealize Automation.