topological_inventory-providers-common 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aafb37efd571f568a887c8c11b31bc87a6141a556ae06b970bf4acfcbdea3d08
-  data.tar.gz: 2d1024891611a96df454a56819a5f6f921e195605d3867ca05c595c336f9a699
+  metadata.gz: 868c8f764cd11d9888ed99698a309cc199fdf92823963f4e5cae71208d506ff7
+  data.tar.gz: 39c352e8b1306bdb87675bf0ccc1fe08f02b0c13555b2466c4c38d7a76979aca
 SHA512:
-  metadata.gz: daff9b2dc2388297dba831994c74e048d608256c9fd3aadc06446c16abfa4143f5fcbed2e6dd3eff66cb6fbb9e6637abe8f47c1eda452b99d5557c9424c20849
-  data.tar.gz: ece193799a908c7ca96aee73de80e9a6dc7cf17346b549ebf2d802cd3ed42b11aec7b46837a4078c1569fe608ef0241f7ac64a7daf43bd2905df1d53e21c8e01
+  metadata.gz: c2a8af390114548a89c7dc5bb43f1a6e3784a5a59ebd2ce1c7451c15726015df1353e3dcbc3755d7637d696707b0d6db93e5d4907920a1c4b09d3f6410130a77
+  data.tar.gz: 46e6596954367336de4049f8024da8b5e63e5be4c60636c77f91f22c3e407229b38aca604137907d1f5cd6411201d9c3b57e4ad5bab2cfb749b2c04e9ca8eeab

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.7] - 2020-07-27
+Update operations/source model for receptor-enabled availability checks #36
+Add check for Application subresource under a Source during Availability check #40
+Remove infinite loop in error messages #43
+
 ## [1.0.6] - 2020-07-06
 Add some error handling if Sources does not have endpoints/authentications for a source #38
 Specs for Collector #35
@@ -38,7 +43,8 @@ manageiq-loggers to >= 0.4.2 #20
 ## [1.0.0] - 2020-03-19
 ### Initial release to rubygems.org
 
-[Unreleased]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.6...HEAD
+[Unreleased]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.7...HEAD
+[1.0.6]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.6...v1.0.7
 [1.0.6]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.5...v1.0.6
 [1.0.5]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.4...v1.0.5
 [1.0.4]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.3...v1.0.4

data/lib/topological_inventory/providers/common/operations/source.rb

@@ -12,18 +12,20 @@ module TopologicalInventory
         STATUS_AVAILABLE, STATUS_UNAVAILABLE = %w[available unavailable].freeze
 
         ERROR_MESSAGES = {
-          :authentication_not_found => "Authentication not found in Sources API",
-          :endpoint_not_found       => "Endpoint not found in Sources API",
+          :authentication_not_found          => "Authentication not found in Sources API",
+          :endpoint_or_application_not_found => "Endpoint or Application not found in Sources API",
         }.freeze
 
         LAST_CHECKED_AT_THRESHOLD = 5.minutes.freeze
+        AUTH_NOT_NECESSARY = "n/a".freeze
 
-        attr_accessor :params, :request_context, :source_id
+        attr_accessor :params, :request_context, :source_id, :account_number
 
         def initialize(params = {}, request_context = nil)
           self.params          = params
           self.request_context = request_context
           self.source_id       = params['source_id']
+          self.account_number  = params['external_tenant']
         end
 
         def availability_check
@@ -33,7 +35,7 @@ module TopologicalInventory
 
           status, error_message = connection_status
 
-          update_source_and_endpoint(status, error_message)
+          update_source_and_subresources(status, error_message)
 
           logger.availability_check("Completed: Source #{source_id} is #{status}")
         end
@@ -57,32 +59,57 @@ module TopologicalInventory
         end
 
         def checked_recently?
-          return false if endpoint.nil?
+          checked_recently = if endpoint.present?
+                               endpoint.last_checked_at.present? && endpoint.last_checked_at >= LAST_CHECKED_AT_THRESHOLD.ago
+                             elsif application.present?
+                               application.last_checked_at.present? && application.last_checked_at >= LAST_CHECKED_AT_THRESHOLD.ago
+                             end
 
-          checked_recently = endpoint.last_checked_at.present? && endpoint.last_checked_at >= LAST_CHECKED_AT_THRESHOLD.ago
-          logger.availability_check("Skipping, last check at #{endpoint.last_checked_at} [Source ID: #{source_id}] ") if checked_recently
+          logger.availability_check("Skipping, last check at #{endpoint.last_checked_at || application.last_checked_at} [Source ID: #{source_id}] ") if checked_recently
 
           checked_recently
         end
 
         def connection_status
-          return [STATUS_UNAVAILABLE, ERROR_MESSAGES[:endpoint_not_found]] unless endpoint
-          return [STATUS_UNAVAILABLE, ERROR_MESSAGES[:authentication_not_found]] unless authentication
+          # we need either an endpoint or application to check the source.
+          return [STATUS_UNAVAILABLE, ERROR_MESSAGES[:endpoint_or_application_not_found]] unless endpoint || application
 
           check_time
+          if endpoint
+            endpoint_connection_check
+          elsif application
+            application_connection_check
+          end
+        end
+
+        def endpoint_connection_check
+          return [STATUS_UNAVAILABLE, ERROR_MESSAGES[:authentication_not_found]] unless authentication
+
+          # call down into the operations pod implementation of `Source#connection_check`
           connection_check
         end
 
+        def application_connection_check
+          case application.availability_status
+          when "available"
+            [STATUS_AVAILABLE, nil]
+          when "unavailable"
+            [STATUS_UNAVAILABLE, "Application id #{application.id} unavailable"]
+          end
+        end
+
         # @return [Array<String, String|nil] - STATUS_[UN]AVAILABLE, error message
         def connection_check
           raise NotImplementedError, "#{__method__} must be implemented in a subclass"
         end
 
-        def update_source_and_endpoint(status, error_message = nil)
+        def update_source_and_subresources(status, error_message = nil)
           logger.availability_check("Updating source [#{source_id}] status [#{status}] message [#{error_message}]")
 
           update_source(status)
-          update_endpoint(status, error_message)
+
+          update_endpoint(status, error_message) if endpoint
+          update_application(status) if application
         end
 
         def update_source(status)
@@ -114,18 +141,36 @@ module TopologicalInventory
           logger.availability_check("Failed to update Endpoint(ID: #{endpoint.id}) - #{e.message}", :error)
         end
 
+        def update_application(status)
+          application_update = ::SourcesApiClient::Application.new
+          application_update.last_checked_at     = check_time
+          application_update.last_available_at   = check_time if status == STATUS_AVAILABLE
+
+          api_client.update_application(application.id, application_update)
+        rescue ::SourcesApiClient::ApiError => e
+          logger.availability_check("Failed to update Application id: #{application.id} - #{e.message}", :error)
+        end
+
         def endpoint
           @endpoint ||= api_client.fetch_default_endpoint(source_id)
-        rescue StandardError => e
-          logger.availability_check("Failed to fetch Endpoint for Source #{source_id}, Endpoint #{endpoint}: #{e.message}", :error)
-          return
+        rescue e
+          logger.availability_check("Failed to fetch Endpoint for Source #{source_id}: #{e.message}", :error)
         end
 
         def authentication
-          @authentication ||= api_client.fetch_authentication(source_id, endpoint)
-        rescue StandardError => e
-          logger.availability_check("Failed to fetch Authentication for Source #{source_id}, Endpoint #{endpoint}: #{e.message}", :error)
-          return
+          @authentication ||= if endpoint.receptor_node.present?
+                                AUTH_NOT_NECESSARY
+                              else
+                                api_client.fetch_authentication(source_id, endpoint)
+                              end
+        rescue e
+          logger.availability_check("Failed to fetch Authentication for Source #{source_id}: #{e.message}", :error)
+        end
+
+        def application
+          @application ||= api_client.fetch_application(source_id)
+        rescue e
+          logger.availability_check("Failed to fetch Application for Source #{source_id}: #{e.message}", :error)
         end
 
         def check_time
@@ -133,7 +178,7 @@ module TopologicalInventory
         end
 
         def identity
-          @identity ||= {"x-rh-identity" => Base64.strict_encode64({"identity" => {"account_number" => params["external_tenant"], "user" => {"is_org_admin" => true}}}.to_json)}
+          @identity ||= {"x-rh-identity" => Base64.strict_encode64({"identity" => {"account_number" => account_number, "user" => {"is_org_admin" => true}}}.to_json)}
         end
 
         def api_client

data/lib/topological_inventory/providers/common/operations/sources_api_client.rb

@@ -5,7 +5,7 @@ module TopologicalInventory
     module Common
       module Operations
         class SourcesApiClient < ::SourcesApiClient::ApiClient
-          delegate :update_source, :update_endpoint, :to => :api
+          delegate :update_source, :update_endpoint, :update_application, :to => :api
 
           INTERNAL_API_PATH = '//internal/v1.0'.freeze
 
@@ -25,6 +25,11 @@ module TopologicalInventory
             endpoints.find(&:default)
           end
 
+          def fetch_application(source_id)
+            applications = api.list_source_applications(source_id)&.data || []
+            applications.first
+          end
+
           def fetch_authentication(source_id, default_endpoint = nil, authtype = nil)
             endpoint = default_endpoint || fetch_default_endpoint(source_id)
             return if endpoint.nil?

data/lib/topological_inventory/providers/common/version.rb

@@ -1,7 +1,7 @@
 module TopologicalInventory
   module Providers
     module Common
-      VERSION = "1.0.6"
+      VERSION = "1.0.7"
     end
   end
 end

data/spec/support/shared/availability_check.rb

@@ -11,6 +11,7 @@ RSpec.shared_examples "availability_check" do
   let(:headers) { {'Content-Type' => 'application/json'}.merge(identity) }
   let(:source_id) { '123' }
   let(:endpoint_id) { '234' }
+  let(:application_id) { '345' }
   let(:authentication_id) { '345' }
   let(:payload) do
     {
@@ -26,6 +27,8 @@ RSpec.shared_examples "availability_check" do
   let(:list_endpoint_authentications_response) { "{\"data\":[{\"authtype\":\"username_password\",\"id\":\"#{authentication_id}\",\"resource_id\":\"#{endpoint_id}\",\"resource_type\":\"Endpoint\",\"username\":\"admin\",\"tenant\":\"#{external_tenant}\"}]}" }
   let(:list_endpoint_authentications_response_empty) { "{\"data\":[]}" }
   let(:internal_api_authentication_response) { "{\"authtype\":\"username_password\",\"id\":\"#{authentication_id}\",\"resource_id\":\"#{endpoint_id}\",\"resource_type\":\"Endpoint\",\"username\":\"admin\",\"tenant\":\"#{external_tenant}\",\"password\":\"xxx\"}" }
+  let(:list_applications_response) { {:data => [{:id => "345", :availability_status => "available"}]}.to_json }
+  let(:list_applications_unavailable_response) { {:data => [{:id => "345", :availability_status => "unavailable"}]}.to_json }
 
   subject { described_class.new(payload["params"]) }
 
@@ -39,6 +42,7 @@ RSpec.shared_examples "availability_check" do
       stub_get(:endpoint, list_endpoints_response)
       stub_get(:authentication, list_endpoint_authentications_response)
       stub_get(:password, internal_api_authentication_response)
+      stub_get(:application, "[]")
 
       # PATCH
       source_patch_body   = {'availability_status' => described_class::STATUS_AVAILABLE, 'last_available_at' => subject.send(:check_time), 'last_checked_at' => subject.send(:check_time)}.to_json
@@ -61,6 +65,7 @@ RSpec.shared_examples "availability_check" do
       stub_get(:endpoint, list_endpoints_response)
       stub_get(:authentication, list_endpoint_authentications_response)
       stub_get(:password, internal_api_authentication_response)
+      stub_get(:application, "[]")
 
       # PATCH
       connection_error_message = "Some connection error"
@@ -82,6 +87,7 @@ RSpec.shared_examples "availability_check" do
     it "updates only Source to 'unavailable' status if Endpoint not found" do
       # GET
       stub_get(:endpoint, '')
+      stub_get(:application, "[]")
 
       # PATCH
       source_patch_body = {'availability_status' => described_class::STATUS_UNAVAILABLE, 'last_checked_at' => subject.send(:check_time)}.to_json
@@ -100,6 +106,7 @@ RSpec.shared_examples "availability_check" do
       # GET
       stub_get(:endpoint, list_endpoints_response)
       stub_get(:authentication, list_endpoint_authentications_response_empty)
+      stub_get(:application, "[]")
 
       # PATCH
       source_patch_body   = {'availability_status' => described_class::STATUS_UNAVAILABLE, 'last_checked_at' => subject.send(:check_time)}.to_json
@@ -131,6 +138,49 @@ RSpec.shared_examples "availability_check" do
     end
   end
 
+  context "when there is an application" do
+    context "when it is available" do
+      it "updates the availability status to available" do
+        # GET
+        stub_get(:endpoint, "[]")
+        stub_get(:application, list_applications_response)
+        # PATCH
+        application_patch_body = {'last_available_at' => subject.send(:check_time), 'last_checked_at' => subject.send(:check_time)}.to_json
+        source_patch_body = {'availability_status' => described_class::STATUS_AVAILABLE, 'last_available_at' => subject.send(:check_time), 'last_checked_at' => subject.send(:check_time)}.to_json
+
+        stub_patch(:source, source_patch_body)
+        stub_patch(:application, application_patch_body)
+
+        # Check
+        expect(subject).not_to receive(:connection_check)
+        subject.availability_check
+
+        assert_patch(:source, source_patch_body)
+        assert_patch(:application, application_patch_body)
+      end
+    end
+
+    context "when it is unavailable" do
+      it "updates the availability status to unavailable" do
+        # GET
+        stub_get(:endpoint, "[]")
+        stub_get(:application, list_applications_unavailable_response)
+        # PATCH
+        application_patch_body = {'last_checked_at' => subject.send(:check_time)}.to_json
+        source_patch_body = {'availability_status' => described_class::STATUS_UNAVAILABLE, 'last_checked_at' => subject.send(:check_time)}.to_json
+
+        stub_patch(:source, source_patch_body)
+        stub_patch(:application, application_patch_body)
+
+        # Check
+        expect(subject).not_to receive(:connection_check)
+        subject.availability_check
+
+        assert_patch(:source, source_patch_body)
+        assert_patch(:application, application_patch_body)
+      end
+    end
+  end
 
   def stub_get(object_type, response)
     case object_type
@@ -146,6 +196,10 @@ RSpec.shared_examples "availability_check" do
       stub_request(:get, "#{host_url}#{sources_internal_api_path}/authentications/#{authentication_id}?expose_encrypted_attribute%5B%5D=password")
         .with(:headers => headers)
         .to_return(:status => 200, :body => response, :headers => {})
+    when :application
+      stub_request(:get, "#{sources_api_url}/sources/#{source_id}/applications")
+        .with(:headers => headers)
+        .to_return(:status => 200, :body => response, :headers => {})
     end
   end
 
@@ -159,6 +213,10 @@ RSpec.shared_examples "availability_check" do
       stub_request(:patch, "#{sources_api_url}/endpoints/#{endpoint_id}")
         .with(:body => data, :headers => headers)
         .to_return(:status => 200, :body => "", :headers => {})
+    when :application
+      stub_request(:patch, "#{sources_api_url}/applications/#{application_id}")
+        .with(:body => data, :headers => headers)
+        .to_return(:status => 200, :body => "", :headers => {})
     end
   end
 
@@ -166,10 +224,13 @@ RSpec.shared_examples "availability_check" do
     case object_type
     when :source
       expect(WebMock).to have_requested(:patch, "#{sources_api_url}/sources/#{source_id}")
-                           .with(:body => data, :headers => headers).once
+        .with(:body => data, :headers => headers).once
     when :endpoint
       expect(WebMock).to have_requested(:patch, "#{sources_api_url}/endpoints/#{endpoint_id}")
-                           .with(:body => data, :headers => headers).once
+        .with(:body => data, :headers => headers).once
+    when :application
+      expect(WebMock).to have_requested(:patch, "#{sources_api_url}/applications/#{application_id}")
+        .with(:body => data, :headers => headers).once
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topological_inventory-providers-common
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Martin Slemr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport