vmware-vra 2.7.0 → 3.0.1

data/spec/fixtures/resource/sample_dep_resource.json

@@ -0,0 +1,112 @@
+{
+    "id": "res-123",
+    "name": "Cloud_vSphere_Machine_1",
+    "type": "Cloud.vSphere.Machine",
+    "createdAt": "2021-12-20T13:22:10.404600Z",
+    "properties": {
+        "resourceId": "671c2ec7-4863-42c8-addf-7e420cb190b7",
+        "Owner": "admin",
+        "zone_overlapping_migrated": "true",
+        "powerState": "ON",
+        "environmentName": "On premise",
+        "hasSnapshots": "false",
+        "computeHostType": "ClusterComputeResource",
+        "id": "/resources/compute/671c2ec7-4863-42c8-addf-7e420cb190b7",
+        "cpuCount": 2,
+        "totalMemoryMB": 8192,
+        "endpointType": "vsphere",
+        "resourceLink": "/resources/compute/671c2ec7-4863-42c8-addf-7e420cb190b7",
+        "networks": [
+            {
+                "address": "192.168.110.200",
+                "assignment": "dynamic",
+                "mac_address": "00:50:56:ae:95:3c",
+                "name": "VM Network",
+                "resourceName": "VM Network",
+                "id": "/resources/network-interfaces/net-1",
+                "ipv6Addresses": [
+                    "fd27:5600:0:232::7cd",
+                    "fe80::59be:c7d0:665f:13f5"
+                ],
+                "deviceIndex": 0
+            },
+            {
+                "address": "192.168.220.200",
+                "assignment": "dynamic",
+                "mac_address": "00:50:56:ae:95:3d",
+                "name": "Management Network",
+                "resourceName": "Management Network",
+                "id": "/resources/network-interfaces/net-2",
+                "ipv6Addresses": [
+                    "fd27:5600:0:232::8cd",
+                    "fe80::59be:c7d0:665f:13e1"
+                ],
+                "deviceIndex": 0
+            }
+        ],
+        "resourcePool": "/resources/pools/d66ae91db21f2075-7f703c5265a63d87",
+        "componentType": "Cloud.vSphere.Machine",
+        "address": "10.30.236.64",
+        "resourceGroupName": "VRATEMPDCI",
+        "datastoreName": "ncvra01",
+        "coreCount": "2",
+        "flavorMappingName": "",
+        "customizationSpec": "vRA-Windows2019",
+        "resourceDescLink": "/resources/compute-descriptions/e756089d-5256-48eb-977c-4af31405eb72",
+        "project": "pro-123",
+        "provisionGB": "100",
+        "zone": "USMORVRA01",
+        "memoryGB": "8",
+        "image": "VRA-nc-base-w2k19",
+        "resourceName": "nc-vra-2073",
+        "flavor": "Medium",
+        "softwareName": "Microsoft Windows Server 2016 or later (64-bit)",
+        "name": "Cloud_vSphere_Machine_1",
+        "region": "USNC-VRA-CL01",
+        "storage": {
+            "disks": [
+                {
+                    "independent": "false",
+                    "sharesLevel": "normal",
+                    "diskPlacementRef": "Datastore:datastore-361848",
+                    "controllerKey": "1000",
+                    "type": "HDD",
+                    "shares": "1000",
+                    "provisionGB": "100",
+                    "encrypted": false,
+                    "bootOrder": 1,
+                    "provisioningType": "thin",
+                    "capacityGb": 100,
+                    "vm": "VirtualMachine:vm-1086705",
+                    "limitIops": "-1",
+                    "name": "nc-vra-2073-boot-disk",
+                    "controllerUnitNumber": "0",
+                    "persistent": false,
+                    "vcUuid": "d9a8730b-c244-4cd2-a570-41f3724b1bff"
+                },
+                {
+                    "encrypted": false,
+                    "capacityGb": 0,
+                    "vm": "VirtualMachine:vm-1086705",
+                    "name": "CD/DVD drive 1",
+                    "controllerUnitNumber": "0",
+                    "controllerKey": "15000",
+                    "type": "CDROM",
+                    "persistent": false,
+                    "vcUuid": "d9a8730b-c244-4cd2-a570-41f3724b1bff"
+                }
+            ]
+        },
+        "providerId": "5035dbc0-5ecd-2875-f21c-5fe844e4dcd4",
+        "osType": "WINDOWS",
+        "instanceUUID": "5035dbc0-5ecd-2875-f21c-5fe844e4dcd4",
+        "endpointId": "d3b65631-3196-4e38-ad4a-ee02afa2bea4",
+        "datacenter": "Datacenter:datacenter-342098",
+        "primaryMAC": "00:50:56:b5:72:2d",
+        "computeHostRef": "ClusterComputeResource:domain-c342105",
+        "account": "nc-devvcmor01",
+        "vcUuid": "d9a8730b-c244-4cd2-a570-41f3724b1bff"
+    },
+    "syncStatus": "SUCCESS",
+    "state": "OK"
+}

data/spec/fixtures/resource/sample_deployment.json

@@ -0,0 +1,26 @@
+{
+    "id": "dep-123",
+    "name": "win-DCI",
+    "description": "win-dci deployment",
+    "orgId": "origin-123",
+    "catalogItemId": "cat-123",
+    "catalogItemVersion": "6",
+    "blueprintId": "blueprint-123",
+    "blueprintVersion": "6",
+    "iconId": "icon-123",
+    "createdAt": "2021-12-31T09:25:09.668646Z",
+    "createdBy": "administrator",
+    "ownedBy": "administrator",
+    "lastUpdatedAt": "2021-12-31T09:27:32.801759Z",
+    "lastUpdatedBy": "administrator",
+    "leaseExpireAt": "2022-03-01T09:27:00Z",
+    "inputs": {
+        "count": 1,
+        "image": "SQL 2016",
+        "flavor": "Medium",
+        "sql-image": "Windows2016",
+        "hardware-config": "Medium"
+    },
+    "projectId": "pro-123456",
+    "status": "CREATE_SUCCESSFUL"
+}

data/spec/fixtures/resource/sample_entitlements.json

@@ -0,0 +1,25 @@
+[
+    {
+        "id": "0225face-95dd-49a5-b0cd-493759a2f7c5",
+        "projectId": "6ba69375-79d5-42c3-a099-7d32739f71a7",
+        "definition": {
+            "type": "CatalogSourceIdentifier",
+            "id": "18102dc2-9e48-487a-93a8-aafab2ecc057",
+            "name": "DCI",
+            "sourceType": "com.vmw.blueprint",
+            "numItems": 17,
+            "iconId": "1495b8d9-9428-30d6-9626-10ff9281645e"
+        }
+    },
+    {
+        "id": "07317598-0a6b-47c4-a5e9-ba0c9ce430b1",
+        "projectId": "6ba69375-79d5-42c3-a099-7d32739f71a7",
+        "definition": {
+            "type": "CatalogItemIdentifier",
+            "id": "e186f066-7971-485a-8aed-bf75f16d3ea8",
+            "name": "TemplateCreation",
+            "sourceType": "com.vmw.vro.workflow",
+            "numItems": 1
+        }
+    }
+]

data/spec/http_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require "spec_helper"
-require "webmock"
+
+require 'spec_helper'
+require 'webmock'
 
 describe Vra::Http do
   def expecting_request(method, url, with = nil)
@@ -26,128 +27,129 @@ describe Vra::Http do
     execute :head, params
   end
 
-  describe "#execute" do
-    it "makes a HEAD request" do
-      headers = { "X-Made-Up-Header" => "Foo AND bar?  Are you sure?" }
+  describe '#execute' do
+    it 'makes a HEAD request' do
+      headers = { 'X-Made-Up-Header' => 'Foo AND bar?  Are you sure?' }
 
-      expecting_request(:head, "http://test.local", headers: headers) do
-        head url: "http://test.local", headers: headers
+      expecting_request(:head, 'http://test.local', headers: headers) do
+        head url: 'http://test.local', headers: headers
       end
     end
 
-    it "makes a GET request" do
-      headers = { "X-Made-Up-Header" => "Foo AND bar?  Are you sure?" }
+    it 'makes a GET request' do
+      headers = { 'X-Made-Up-Header' => 'Foo AND bar?  Are you sure?' }
 
-      expecting_request(:get, "http://test.local", headers: headers) do
-        get url: "http://test.local", headers: headers
+      expecting_request(:get, 'http://test.local', headers: headers) do
+        get url: 'http://test.local', headers: headers
       end
     end
 
-    it "makes a POST request" do
-      headers = { "X-Made-Up-Header" => "Foo AND bar?  Are you sure?" }
-      payload = "withabodylikethis"
+    it 'makes a POST request' do
+      headers = { 'X-Made-Up-Header' => 'Foo AND bar?  Are you sure?' }
+      payload = 'withabodylikethis'
 
-      expecting_request(:post, "http://test.local", headers: headers, body: payload) do
-        post url: "http://test.local", headers: headers, payload: payload
+      expecting_request(:post, 'http://test.local', headers: headers, body: payload) do
+        post url: 'http://test.local', headers: headers, payload: payload
       end
     end
 
-    it "preserves Location" do
-      stub_request(:head, "http://test.local")
-        .to_return(headers: { "Location" => "http://test-location.local" })
+    it 'preserves Location' do
+      stub_request(:head, 'http://test.local')
+        .to_return(headers: { 'Location' => 'http://test-location.local' })
 
-      response = head(url: "http://test.local")
+      response = head(url: 'http://test.local')
 
-      expect(response.location).to eq "http://test-location.local"
+      expect(response.location).to eq 'http://test-location.local'
     end
 
-    it "preserves status code" do
-      stub_request(:head, "http://test.local")
-        .to_return(status: [204, "No content"])
+    it 'preserves status code' do
+      stub_request(:head, 'http://test.local')
+        .to_return(status: [204, 'No content'])
 
-      response = head(url: "http://test.local")
+      response = head(url: 'http://test.local')
 
       expect(response.code).to eq 204
     end
 
-    it "configures ssl verification" do
+    it 'configures ssl verification' do
       allow(Net::HTTP).to receive(:start).and_wrap_original do |_http, *args|
         expect(args.last).to include(verify_mode: OpenSSL::SSL::VERIFY_NONE)
-        double("response", final?: true, success?: true)
+        double('response', final?: true, success?: true)
       end
 
-      execute(:get, url: "https://test.local", verify_ssl: false)
+      execute(:get, url: 'https://test.local', verify_ssl: false)
     end
 
-    context "when successful" do
-      it "returns a successful response given a status 200" do
-        stub_request(:head, "http://test.local")
-          .to_return(status: [200, "Whatevs"])
+    context 'when successful' do
+      it 'returns a successful response given a status 200' do
+        stub_request(:head, 'http://test.local')
+          .to_return(status: [200, 'Whatevs'])
 
-        response = head(url: "http://test.local")
+        response = head(url: 'http://test.local')
 
         expect(response.success_ok?).to be_truthy
       end
 
-      it "returns a successful response given a status 204" do
-        stub_request(:head, "http://test.local")
-          .to_return(status: [204, "Whatevs"])
+      it 'returns a successful response given a status 204' do
+        stub_request(:head, 'http://test.local')
+          .to_return(status: [204, 'Whatevs'])
 
-        response = head(url: "http://test.local")
+        response = head(url: 'http://test.local')
 
         expect(response.success_no_content?).to be_truthy
       end
     end
 
-    context "when unsuccessful" do
+    context 'when unsuccessful' do
       (400..418).each do |status|
-        it 'raises an exception given a status #{status}' do
-          stub_request(:get, "http://test.local")
-            .to_return(status: [status, "Whatevs"],
-                       body: "Error body")
+        it "raises an exception given a status #{status}" do
+          stub_request(:get, 'http://test.local')
+            .to_return(status: [status, 'Whatevs'],
+                       body: '{"message":"Error"}')
 
-          expect { get(url: "http://test.local") }.to raise_error do |error|
+          expect { get(url: 'http://test.local') }.to raise_error do |error|
             expect(error).to be_a(StandardError)
             expect(error.http_code).to eq status
-            expect(error.response).to eq "Error body"
+            expect(error.response).to eq({ 'message' => 'Error' })
           end
         end
       end
     end
 
-    context "when redirected" do
+    context 'when redirected' do
       [301, 302, 307].each do |status|
-        [:get, :head].each do |method|
+        %i[get head].each do |method|
           it "follows #{status} redirected #{method.to_s.upcase} requests" do
-            stub_request(method, "http://test.local")
-              .to_return(status: [status, "redirect"],
-                         headers: { "Location" => "http://test.local/redirect" })
-            expecting_request(method, "http://test.local/redirect") do
-              execute(method, url: "http://test.local")
+            stub_request(method, 'http://test.local')
+              .to_return(status: [status, 'redirect'],
+                         headers: { 'Location' => 'http://test.local/redirect' })
+
+            expecting_request(method, 'http://test.local/redirect') do
+              execute(method, url: 'http://test.local')
             end
           end
         end
 
         it "does not follow #{status} redirected POST requests" do
-          stub_request(:post, "http://test.local")
-            .to_return(status: [status, "redirect"],
-                       headers: { "Location" => "http://test.local/redirect" })
+          stub_request(:post, 'http://test.local')
+            .to_return(status: [status, 'redirect'],
+                       headers: { 'Location' => 'http://test.local/redirect' })
 
-          expect { post(url: "http://test.local") }.to raise_error do |error|
+          expect { post(url: 'http://test.local') }.to raise_error do |error|
             expect(error).to be_a(StandardError)
             expect(error.http_code).to eq status
           end
         end
       end
 
-      [:head, :post].each do |method|
+      %i[head post].each do |method|
         it "converts #{method.to_s.upcase} to GET on 303 redirect" do
-          stub_request(method, "http://test.local")
-            .to_return(status: [303, "See Other"],
-                       headers: { "Location" => "http://test.local/redirect" })
+          stub_request(method, 'http://test.local')
+            .to_return(status: [303, 'See Other'],
+                       headers: { 'Location' => 'http://test.local/redirect' })
 
-          expecting_request(:get, "http://test.local/redirect") do
-            execute method, url: "http://test.local"
+          expecting_request(:get, 'http://test.local/redirect') do
+            execute method, url: 'http://test.local'
           end
         end
       end

data/spec/request_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 #
 # Author:: Chef Partner Engineering (<partnereng@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright (c) 2022 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,15 +17,15 @@
 # limitations under the License.
 #
 
-require "spec_helper"
+require 'spec_helper'
 
-shared_examples "refresh_trigger_method" do |method|
-  it "calls #refresh_if_needed" do
+shared_examples 'refresh_trigger_method' do |method|
+  it 'calls #refresh_if_needed' do
     expect(request).to receive(:refresh_if_empty)
     request.send(method)
   end
 
-  it "returns nil if request data is empty" do
+  it 'returns nil if request data is empty' do
     allow(request).to receive(:refresh_if_empty)
     allow(request).to receive(:request_empty?).and_return true
     expect(request.send(method)).to eq nil
@@ -34,113 +34,107 @@ end
 
 describe Vra::Request do
   let(:client) do
-    Vra::Client.new(username: "user@corp.local",
-                    password: "password",
-                    tenant: "tenant",
-                    base_url: "https://vra.corp.local")
+    Vra::Client.new(
+      username: 'user@corp.local',
+      password: 'password',
+      tenant: 'tenant',
+      base_url: 'https://vra.corp.local'
+    )
   end
 
-  let(:request_id) { "2c3df007-b1c4-4687-b332-310089c4851d" }
+  let(:deployment_id) { 'dep-123' }
+
+  let(:request_id) { 'req-123' }
+
+  let(:completed_payload) do
+    JSON.parse(File.read('spec/fixtures/resource/sample_dep_request.json'))
+  end
 
   let(:in_progress_payload) do
-    {
-      "phase" => "IN_PROGRESS",
-      "requestCompletion" => {
-        "requestCompletionState" => nil,
-        "completionDetails" => nil,
-      },
-    }
+    JSON.parse(File.read('spec/fixtures/resource/sample_dep_request.json'))
+        .merge('status' => 'IN_PROGRESS')
   end
 
-  let(:completed_payload) do
-    {
-      "phase" => "SUCCESSFUL",
-      "requestCompletion" => {
-        "requestCompletionState" => "SUCCESSFUL",
-        "completionDetails" => "Request succeeded. Created test-machine.",
-      },
-    }
+  let(:request) { Vra::Request.new(client, deployment_id, data: in_progress_payload) }
+
+  before(:each) do
+    allow(client).to receive(:authorized?).and_return(true)
   end
 
-  let(:request) { Vra::Request.new(client, request_id) }
+  describe '#initialize' do
+    it 'sets the id' do
+      allow(client).to receive(:get_parsed).and_return(completed_payload)
 
-  describe "#initialize" do
-    it "sets the id" do
-      expect(request.id).to eq request_id
+      req = described_class.new(client, deployment_id, id: request_id)
+      expect(req.id).to eq(request_id)
+    end
+
+    it 'sets the attributes correctly' do
+      allow(client).to receive(:get_parsed).and_return(completed_payload)
+
+      req = described_class.new(client, deployment_id, id: request_id)
+      expect(req.status).to eq('SUCCESSFUL')
+      expect(req.completed?).to be_truthy
+      expect(req.failed?).to be_falsey
+      expect(req.name).to eq('Create')
+      expect(req.requested_by).to eq('admin')
     end
   end
 
-  describe "#refresh" do
-    it "calls the request API endpoint" do
+  describe '#refresh' do
+    it 'calls the request API endpoint' do
       expect(client).to receive(:get_parsed)
-        .with("/catalog-service/api/consumer/requests/#{request_id}")
+        .with("/deployment/api/deployments/#{deployment_id}/requests/#{request_id}?deleted=true")
         .and_return(in_progress_payload)
 
       request.refresh
     end
-  end
 
-  describe "#refresh_if_empty" do
-    context "request data is empty" do
-      it "calls #refresh" do
-        expect(request).to receive(:refresh)
-        request.refresh_if_empty
-      end
+    it 'should raise an exception if the resource not found' do
+      allow(client).to receive(:get_parsed).and_raise(Vra::Exception::HTTPNotFound)
+
+      expect { request.refresh }
+        .to raise_error(Vra::Exception::NotFound)
+        .with_message("request ID #{request_id} is not found")
     end
+  end
 
-    context "request data is not empty" do
-      it "does not call #refresh" do
+  describe '#refresh_if_empty' do
+    context 'request data is not empty' do
+      it 'does not call #refresh' do
         allow(request).to receive(:request_empty?).and_return(false)
         expect(request).to_not receive(:refresh)
       end
     end
   end
 
-  describe "#status" do
-    it_behaves_like "refresh_trigger_method", :status
+  describe '#status' do
+    it_behaves_like 'refresh_trigger_method', :status
   end
 
-  describe "#completed?" do
-    context "when the request is neither successful or failed yet" do
-      it "returns false" do
+  describe '#completed?' do
+    context 'when the request is neither successful or failed yet' do
+      it 'returns false' do
         allow(request).to receive(:successful?).and_return(false)
         allow(request).to receive(:failed?).and_return(false)
         expect(request.completed?).to eq false
       end
     end
 
-    context "when the request is successful" do
-      it "returns true" do
+    context 'when the request is successful' do
+      it 'returns true' do
         allow(request).to receive(:successful?).and_return(true)
         allow(request).to receive(:failed?).and_return(false)
         expect(request.completed?).to eq true
       end
     end
 
-    context "when the request failed" do
-      it "returns true" do
+    context 'when the request failed' do
+      it 'returns true' do
         allow(request).to receive(:successful?).and_return(false)
         allow(request).to receive(:failed?).and_return(true)
         expect(request.completed?).to eq true
       end
     end
   end
-
-  describe "#completion_state" do
-    it_behaves_like "refresh_trigger_method", :completion_state
-  end
-
-  describe "#completion_details" do
-    it_behaves_like "refresh_trigger_method", :completion_details
-  end
-
-  describe "#resources" do
-    it "calls the requests resources API endpoint" do
-      expect(client).to receive(:http_get_paginated_array!)
-        .with("/catalog-service/api/consumer/requests/#{request_id}/resources")
-        .and_return([])
-
-      request.resources
-    end
-  end
 end