vmware-vra 3.1.2 → 3.1.3

data/spec/http_spec.rb

@@ -1,7 +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)
@@ -27,129 +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'],
+          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({ 'message' => 'Error' })
+            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|
-        %i[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' })
+            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')
+            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
 
-      %i[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

@@ -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
@@ -35,24 +35,24 @@ 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'
+      username: "user@corp.local",
+      password: "password",
+      tenant: "tenant",
+      base_url: "https://vra.corp.local"
     )
   end
 
-  let(:deployment_id) { 'dep-123' }
+  let(:deployment_id) { "dep-123" }
 
-  let(:request_id) { 'req-123' }
+  let(:request_id) { "req-123" }
 
   let(:completed_payload) do
-    JSON.parse(File.read('spec/fixtures/resource/sample_dep_request.json'))
+    JSON.parse(File.read("spec/fixtures/resource/sample_dep_request.json"))
   end
 
   let(:in_progress_payload) do
-    JSON.parse(File.read('spec/fixtures/resource/sample_dep_request.json'))
-        .merge('status' => 'IN_PROGRESS')
+    JSON.parse(File.read("spec/fixtures/resource/sample_dep_request.json"))
+      .merge("status" => "IN_PROGRESS")
   end
 
   let(:request) { Vra::Request.new(client, deployment_id, data: in_progress_payload) }
@@ -61,28 +61,28 @@ describe Vra::Request do
     allow(client).to receive(:authorized?).and_return(true)
   end
 
-  describe '#initialize' do
-    it 'sets the id' do
+  describe "#initialize" do
+    it "sets the id" do
       allow(client).to receive(:get_parsed).and_return(completed_payload)
 
       req = described_class.new(client, deployment_id, id: request_id)
       expect(req.id).to eq(request_id)
     end
 
-    it 'sets the attributes correctly' do
+    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.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')
+      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("/deployment/api/deployments/#{deployment_id}/requests/#{request_id}?deleted=true")
         .and_return(in_progress_payload)
@@ -90,7 +90,7 @@ describe Vra::Request do
       request.refresh
     end
 
-    it 'should raise an exception if the resource not found' do
+    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 }
@@ -99,38 +99,38 @@ describe Vra::Request do
     end
   end
 
-  describe '#refresh_if_empty' do
-    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

data/spec/resource_spec.rb

@@ -17,53 +17,53 @@
 # limitations under the License.
 #
 
-require 'spec_helper'
-require 'ffi_yajl'
+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'
+      username: "user@corp.local",
+      password: "password",
+      tenant: "tenant",
+      base_url: "https://vra.corp.local"
     )
   end
 
-  let(:resource_id) { 'res-123' }
-  let(:deployment_id) { 'dep-123' }
+  let(:resource_id) { "res-123" }
+  let(:deployment_id) { "dep-123" }
 
   let(:vm_payload) do
-    JSON.parse(File.read('spec/fixtures/resource/sample_dep_resource.json'))
+    JSON.parse(File.read("spec/fixtures/resource/sample_dep_resource.json"))
   end
 
-  describe '#initialize' do
-    it 'raises an error if no ID or resource data have been provided' do
+  describe "#initialize" do
+    it "raises an error if no ID or resource data have been provided" do
       expect { Vra::Resource.new(client, deployment_id) }.to raise_error(ArgumentError)
     end
 
-    it 'raises an error if an ID and resource data have both been provided' do
-      expect { Vra::Resource.new(client, deployment_id, id: 123, data: 'foo') }.to raise_error(ArgumentError)
+    it "raises an error if an ID and resource data have both been provided" do
+      expect { Vra::Resource.new(client, deployment_id, id: 123, data: "foo") }.to raise_error(ArgumentError)
     end
 
-    context 'when an ID is provided' do
-      it 'calls fetch_resource_data' do
+    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, deployment_id, id: resource_id)
       end
     end
 
-    context 'when resource data is provided' do
-      it 'populates the ID correctly' do
+    context "when resource data is provided" do
+      it "populates the ID correctly" do
         resource = Vra::Resource.new(client, deployment_id, data: vm_payload)
         expect(resource.id).to eq resource_id
       end
     end
   end
 
-  describe '#fetch_resource_data' do
-    it 'calls get_parsed against the resources API endpoint' do
+  describe "#fetch_resource_data" do
+    it "calls get_parsed against the resources API endpoint" do
       expect(client).to receive(:get_parsed)
         .with("/deployment/api/deployments/#{deployment_id}/resources/#{resource_id}")
         .and_return({})
@@ -71,7 +71,7 @@ describe Vra::Resource do
       Vra::Resource.new(client, deployment_id, id: resource_id)
     end
 
-    it 'should raise an exception if the resource not found' do
+    it "should raise an exception if the resource not found" do
       allow(client).to receive(:get_parsed).and_raise(Vra::Exception::HTTPNotFound)
 
       expect { Vra::Resource.new(client, deployment_id, id: resource_id) }
@@ -80,80 +80,80 @@ describe Vra::Resource do
     end
   end
 
-  context 'when a valid VM resource instance has been created' do
+  context "when a valid VM resource instance has been created" do
     let(:resource) { Vra::Resource.new(client, deployment_id, data: vm_payload) }
 
-    describe '#name' do
-      it 'returns the correct name' do
-        expect(resource.name).to eq 'Cloud_vSphere_Machine_1'
+    describe "#name" do
+      it "returns the correct name" do
+        expect(resource.name).to eq "Cloud_vSphere_Machine_1"
       end
     end
 
-    describe '#status' do
-      it 'returns the correct status' do
-        expect(resource.status).to eq 'SUCCESS'
+    describe "#status" do
+      it "returns the correct status" do
+        expect(resource.status).to eq "SUCCESS"
       end
     end
 
-    describe '#vm?' do
-      context 'when the resource type is Cloud.vSphere.Machine' do
-        let(:resource_data) { { 'type' => 'Cloud.vSphere.Machine' } }
-        it 'returns true' do
+    describe "#vm?" do
+      context "when the resource type is Cloud.vSphere.Machine" do
+        let(:resource_data) { { "type" => "Cloud.vSphere.Machine" } }
+        it "returns true" do
           allow(resource).to receive(:resource_data).and_return(resource_data)
           expect(resource.vm?).to eq(true)
         end
       end
 
-      context 'when the resource type is Cloud.Machine' do
-        let(:resource_data) { { 'type' => 'Cloud.Machine' } }
-        it 'returns true' do
+      context "when the resource type is Cloud.Machine" do
+        let(:resource_data) { { "type" => "Cloud.Machine" } }
+        it "returns true" do
           allow(resource).to receive(:resource_data).and_return(resource_data)
           expect(resource.vm?).to eq(true)
         end
       end
 
-      context 'when the resource type is an unknown type' do
-        let(:resource_data) { { 'type' => 'Infrastructure.Unknown' } }
-        it 'returns false' do
+      context "when the resource type is an unknown type" do
+        let(:resource_data) { { "type" => "Infrastructure.Unknown" } }
+        it "returns false" do
           allow(resource).to receive(:resource_data).and_return(resource_data)
           expect(resource.vm?).to eq(false)
         end
       end
     end
 
-    describe '#project' do
-      it 'returns the correct project ID' do
-        expect(resource.project_id).to eq 'pro-123'
+    describe "#project" do
+      it "returns the correct project ID" do
+        expect(resource.project_id).to eq "pro-123"
       end
     end
 
-    describe '#owner_names' do
-      it 'returns the correct owner names' do
-        expect(resource.owner_names).to eq 'admin'
+    describe "#owner_names" do
+      it "returns the correct owner names" do
+        expect(resource.owner_names).to eq "admin"
       end
     end
 
-    describe '#network_interfaces' do
-      it 'returns an array of 2 elements' do
+    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
+      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(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'
+        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 'should have the correct ip address' do
-        expect(resource.ip_address).to eq '10.30.236.64'
+    describe "#ip_addresses" do
+      it "should have the correct ip address" do
+        expect(resource.ip_address).to eq "10.30.236.64"
       end
     end
   end

data/spec/spec_helper.rb

@@ -17,19 +17,19 @@
 # limitations under the License.
 #
 
-require 'webmock/rspec'
-require 'simplecov'
+require "webmock/rspec"
+require "simplecov"
 
 SimpleCov.start do
   enable_coverage :branch
 end
 
-require 'vra'
+require "vra"
 
 def fixtures_dir
   @fixtures_dir ||= begin
     base_dir = File.dirname(__FILE__)
-    File.join(base_dir, 'fixtures')
+    File.join(base_dir, "fixtures")
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vmware-vra
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors:
 - Adam Leff
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-yajl
@@ -130,10 +130,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/workflows/unit.yml"
+- ".github/workflows/linters.yml"
 - ".gitignore"
+- ".markdownlint.yaml"
+- ".mdlrc"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Client gem for interacting with VMware vRealize Automation.

data/.github/ISSUE_TEMPLATE.md

@@ -1,23 +0,0 @@
-### Versions:
-<!--- Version of the software where you are encountering the issue --->
-<!-- You should probably update in this is not newest release.--->
-* Version of vmware-vra-gem:
-* Version of chef:
-* Version of ruby:
-
-### Platform Details
-<!--- What version of vRA are you running? What version of ESXi are you using too?--->
-* Version of vRA:
-* Version of ESXi:
-
-### Scenario:
-<!--- What you are trying to achieve and you can't?--->
-
-### Steps to Reproduce:
-<!--- If you are filing an issue what are the things we need to do in order to repro your problem? How are you using this gem or any resources it includes?--->
-
-### Expected Result:
-<!--- What are you expecting to happen as the consequence of above reproduction steps?--->
-
-### Actual Result:
-<!--- What actually happens after the reproduction steps? Include the error output or a link to a gist if possible.--->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +0,0 @@
-### Description
-
-<!--- Describe what this change achieves--->
-
-### Issues Resolved
-
-<!--- List any existing issues this PR resolves--->
-
-### Check List
-
-- [ ] All tests pass.
-- [ ] All style checks pass.
-- [ ] Functionality includes testing.
-- [ ] Functionality has been documented in the README if applicable