topological_inventory-providers-common 1.0.8 → 2.0.0

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

@@ -0,0 +1,92 @@
+require "sources-api-client"
+
+module TopologicalInventory
+  module Providers
+    module Common
+      class SourcesApiClient < ::SourcesApiClient::ApiClient
+        delegate :update_source, :update_endpoint, :update_application, :to => :api
+
+        INTERNAL_API_PATH = '//internal/v1.0'.freeze
+
+        def initialize(identity = nil)
+          super(::SourcesApiClient::Configuration.default)
+          self.identity = identity
+          self.api      = init_default_api
+        end
+
+        def init_default_api
+          default_headers.merge!(identity) if identity.present?
+          ::SourcesApiClient::DefaultApi.new(self)
+        end
+
+        def fetch_default_endpoint(source_id)
+          endpoints = api.list_source_endpoints(source_id)&.data || []
+          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?
+
+          endpoint_authentications = api.list_endpoint_authentications(endpoint.id.to_s).data || []
+          return if endpoint_authentications.empty?
+
+          auth_id = if authtype.nil?
+                      endpoint_authentications.first&.id
+                    else
+                      endpoint_authentications.detect { |a| a.authtype = authtype }&.id
+                    end
+          return if auth_id.nil?
+
+          fetch_authentication_with_password(auth_id)
+        end
+
+        private
+
+        attr_accessor :identity, :api, :custom_base_path
+
+        def fetch_authentication_with_password(auth_id)
+          on_internal_api do
+            local_var_path = "/authentications/#{auth_id}"
+
+            query_params = "expose_encrypted_attribute[]=password"
+
+            header_params = {'Accept' => select_header_accept(['application/json'])}
+            return_type   = 'Authentication'
+            data, _, _    = call_api(:GET, local_var_path,
+                                     :header_params => header_params,
+                                     :query_params  => query_params,
+                                     :auth_names    => ['UserSecurity'],
+                                     :return_type   => return_type)
+            data
+          end
+        end
+
+        def build_request_url(path)
+          # Add leading and trailing slashes to path
+          path = "/#{path}".gsub(/\/+/, '/')
+          URI.encode((custom_base_url || @config.base_url) + path)
+        end
+
+        def custom_base_url
+          return nil if custom_base_path.nil?
+
+          url = "#{@config.scheme}://#{[@config.host, custom_base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+          URI.encode(url)
+        end
+
+        def on_internal_api
+          self.custom_base_path = INTERNAL_API_PATH
+          yield
+        ensure
+          self.custom_base_path = nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require "topological_inventory-api-client"
+
+module TopologicalInventory
+  module Providers
+    module Common
+      class TopologyApiClient < ::TopologicalInventoryApiClient::ApiClient
+        attr_accessor :api
+
+        def initialize(identity = nil)
+          super(::TopologicalInventoryApiClient::Configuration.default)
+
+          self.identity = identity
+          self.api      = init_default_api
+        end
+
+        def init_default_api
+          default_headers.merge!(identity) if identity.present?
+          ::TopologicalInventoryApiClient::DefaultApi.new(self)
+        end
+
+        def update_task(task_id, source_id: nil, state:, status:, target_type: nil, target_source_ref: nil, context: nil)
+          params                      = {'state'  => state,
+                                         'status' => status}
+          params['context']           = context if context
+          params['source_id']         = source_id if source_id
+          params['target_type']       = target_type if target_type
+          params['target_source_ref'] = target_source_ref if target_source_ref
+          task                        = TopologicalInventoryApiClient::Task.new(params)
+          api.update_task(task_id, task)
+        end
+
+        def svc_instance_url(service_instance)
+          rest_api_path = '/service_instances/{id}'.sub('{' + 'id' + '}', service_instance&.id.to_s)
+          build_request(:GET, rest_api_path).url
+        end
+
+        private
+
+        attr_accessor :identity
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module TopologicalInventory
   module Providers
     module Common
-      VERSION = "1.0.8"
+      VERSION = "2.0.0".freeze
     end
   end
 end

data/spec/support/shared/availability_check.rb

@@ -94,7 +94,7 @@ RSpec.shared_examples "availability_check" do
       stub_patch(:source, source_patch_body)
 
       # Check
-      api_client = subject.send(:api_client)
+      api_client = subject.send(:sources_api)
       expect(api_client).not_to receive(:update_endpoint)
 
       subject.availability_check

data/spec/topological_inventory/providers/common/operations/async_worker_spec.rb

@@ -0,0 +1,36 @@
+require "topological_inventory/providers/common/operations/async_worker"
+
+describe TopologicalInventory::Providers::Common::Operations::AsyncWorker do
+  let(:queue) { double }
+  let(:impl) { double }
+  let(:msg) { double }
+  subject { described_class.new(impl, queue) }
+
+  before do
+    allow(queue).to receive(:length).and_return(0)
+    allow(msg).to receive(:message).and_return("Source.availability_check")
+  end
+
+  context "when the message is able to be processed" do
+    before do
+      allow(impl).to receive(:process!).with(msg)
+      allow(msg).to receive(:ack)
+    end
+
+    it "drains messages that are added to the queue" do
+      expect(impl).to receive(:process!).with(msg).once
+      subject.send(:process_message, msg)
+    end
+  end
+
+  context "when the message results in an error" do
+    before do
+      allow(impl).to receive(:process!).with(msg).and_raise(StandardError.new("boom!"))
+    end
+
+    it "ack's the message on failure" do
+      expect(msg).to receive(:ack).once
+      subject.send(:process_message, msg)
+    end
+  end
+end

data/topological_inventory-providers-common.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "manageiq-loggers", ">= 0.4.2"
   spec.add_runtime_dependency "sources-api-client", "~> 3.0"
   spec.add_runtime_dependency "topological_inventory-api-client", "~> 3.0", ">= 3.0.1"
-  spec.add_runtime_dependency "topological_inventory-ingress_api-client", "~> 1.0"
+  spec.add_runtime_dependency "topological_inventory-ingress_api-client", "~> 1.0", ">= 1.0.3"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", ">= 12.3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topological_inventory-providers-common
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 2.0.0
 platform: ruby
 authors:
 - Martin Slemr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,6 +113,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -120,6 +123,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -246,13 +252,16 @@ files:
 - lib/topological_inventory/providers/common/collector/parser.rb
 - lib/topological_inventory/providers/common/collectors_pool.rb
 - lib/topological_inventory/providers/common/logging.rb
-- lib/topological_inventory/providers/common/operations/endpoint_client.rb
-- lib/topological_inventory/providers/common/operations/processor.rb
+- lib/topological_inventory/providers/common/mixins/sources_api.rb
+- lib/topological_inventory/providers/common/mixins/topology_api.rb
+- lib/topological_inventory/providers/common/mixins/x_rh_headers.rb
+- lib/topological_inventory/providers/common/operations/async_worker.rb
+- lib/topological_inventory/providers/common/operations/health_check.rb
 - lib/topological_inventory/providers/common/operations/source.rb
-- lib/topological_inventory/providers/common/operations/sources_api_client.rb
-- lib/topological_inventory/providers/common/operations/topology_api_client.rb
 - lib/topological_inventory/providers/common/save_inventory/exception.rb
 - lib/topological_inventory/providers/common/save_inventory/saver.rb
+- lib/topological_inventory/providers/common/sources_api_client.rb
+- lib/topological_inventory/providers/common/topology_api_client.rb
 - lib/topological_inventory/providers/common/version.rb
 - spec/spec_helper.rb
 - spec/support/inventory_helper.rb
@@ -262,7 +271,7 @@ files:
 - spec/topological_inventory/providers/common/collectors/inventory_collection_wrapper_spec.rb
 - spec/topological_inventory/providers/common/collectors_pool_spec.rb
 - spec/topological_inventory/providers/common/logger_spec.rb
-- spec/topological_inventory/providers/common/operations/processor_spec.rb
+- spec/topological_inventory/providers/common/operations/async_worker_spec.rb
 - spec/topological_inventory/providers/common/operations/source_spec.rb
 - spec/topological_inventory/providers/common/save_inventory/saver_spec.rb
 - spec/topological_inventory/providers/common_spec.rb

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

@@ -1,65 +0,0 @@
-require "topological_inventory/providers/common/operations/topology_api_client"
-require "topological_inventory/providers/common/operations/sources_api_client"
-
-module TopologicalInventory
-  module Providers
-    module Common
-      module Operations
-        class EndpointClient
-          include TopologyApiClient
-
-          def initialize(source_id, task_id, identity = nil)
-            self.identity   = identity
-            self.source_id  = source_id
-            self.task_id    = task_id
-          end
-
-          def order_service(service_offering, service_plan, order_params)
-            raise NotImplementedError, "#{__method__} must be implemented in a subclass"
-          end
-
-          def source_ref_of(endpoint_svc_instance)
-            raise NotImplementedError, "#{__method__} must be implemented in a subclass"
-          end
-
-          def wait_for_provision_complete(source_id, endpoint_svc_instance, context = {})
-            raise NotImplementedError, "#{__method__} must be implemented in a subclass"
-          end
-
-          def provisioned_successfully?(endpoint_svc_instance)
-            raise NotImplementedError, "#{__method__} must be implemented in a subclass"
-          end
-
-          # Endpoint for conversion of provisioned service's status to
-          # TopologicalInventory Task's status
-          def task_status_for(endpoint_svc_instance)
-            raise NotImplementedError, "#{__method__} must be implemented in a subclass"
-          end
-
-          private
-
-          attr_accessor :identity, :task_id, :source_id
-
-          def sources_api
-            @sources_api ||= SourcesApiClient.new(identity)
-          end
-
-          def default_endpoint
-            @default_endpoint ||= sources_api.fetch_default_endpoint(source_id)
-            raise "Sources API: Endpoint not found! (source id: #{source_id})" if @default_endpoint.nil?
-
-            @default_endpoint
-          end
-
-          def authentication
-            @authentication ||= sources_api.fetch_authentication(source_id, default_endpoint)
-          end
-
-          def verify_ssl_mode
-            default_endpoint.verify_ssl ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,135 +0,0 @@
-require "topological_inventory/providers/common/operations/topology_api_client"
-
-module TopologicalInventory
-  module Providers
-    module Common
-      module Operations
-        class Processor
-          include Logging
-          include TopologyApiClient
-
-          SLEEP_POLL = 10
-          POLL_TIMEOUT = 1800
-
-          def self.process!(message)
-            model, method = message.headers['message_type'].to_s.split(".")
-            new(model, method, message.payload).process
-          end
-
-          # @param payload [Hash] https://github.com/ManageIQ/topological_inventory-api/blob/master/app/controllers/api/v0/service_plans_controller.rb#L32-L41
-          def initialize(model, method, payload, metrics = nil)
-            self.model           = model
-            self.method          = method
-            self.params          = payload["params"]
-            self.identity        = payload["request_context"]
-            self.metrics         = metrics
-          end
-
-          def process
-            logger.info("Processing #{model}##{method} [#{params}]...")
-            result = order_service(params)
-            logger.info("Processing #{model}##{method} [#{params}]...Complete")
-
-            result
-          end
-
-          private
-
-          attr_accessor :identity, :model, :method, :metrics, :params
-
-          def endpoint_client(source_id, task_id, identity)
-            raise NotImplementedError, "#{__method__} must be implemented in a subclass as kind of TopologicalInventory::Providers::Common::EndpointClient class"
-          end
-
-          def order_service(params)
-            task_id, service_offering_id, service_plan_id, order_params = params.values_at("task_id", "service_offering_id", "service_plan_id", "order_params")
-
-            service_plan     = topology_api_client.show_service_plan(service_plan_id) if service_plan_id.present?
-            service_offering_id = service_plan.service_offering_id if service_offering_id.nil? && service_plan.present?
-            service_offering = topology_api_client.show_service_offering(service_offering_id)
-
-            source_id        = service_offering.source_id
-            client = endpoint_client(source_id, task_id, identity)
-
-            logger.info("Ordering #{service_offering.name}...")
-            remote_service_instance = client.order_service(service_offering, service_plan.presence, order_params)
-            logger.info("Ordering #{service_offering.name}...Complete")
-
-            poll_order_complete_thread(task_id, source_id, remote_service_instance)
-          rescue StandardError => err
-            metrics&.record_error
-            logger.error("[Task #{task_id}] Ordering error: #{err}\n#{err.backtrace.join("\n")}")
-            update_task(task_id, :state => "completed", :status => "error", :context => {:error => err.to_s})
-          end
-
-          def poll_order_complete_thread(task_id, source_id, remote_svc_instance)
-            Thread.new do
-              begin
-                poll_order_complete(task_id, source_id, remote_svc_instance)
-              rescue StandardError => err
-                logger.error("[Task #{task_id}] Waiting for complete: #{err}\n#{err.backtrace.join("\n")}")
-                update_task(task_id, :state => "completed", :status => "warn", :context => {:error => err.to_s})
-              end
-            end
-          end
-
-          def poll_order_complete(task_id, source_id, remote_svc_instance)
-            client = endpoint_client(source_id, task_id, identity)
-
-            context = {
-              :service_instance => {
-                :source_id  => source_id,
-                :source_ref => client.source_ref_of(remote_svc_instance)
-              }
-            }
-
-            remote_svc_instance = client.wait_for_provision_complete(task_id, remote_svc_instance, context)
-
-            if client.provisioned_successfully?(remote_svc_instance)
-              if (service_instance = load_topological_svc_instance(source_id, client.source_ref_of(remote_svc_instance))).present?
-                context[:service_instance][:id] = service_instance.id
-                context[:service_instance][:url] = svc_instance_url(service_instance)
-              else
-                logger.warn("Failed to get service_instance API URL (endpoint's service instance: #{remote_svc_instance.inspect})")
-              end
-            end
-            update_task(task_id, :state => "completed", :status => client.task_status_for(remote_svc_instance), :context => context)
-          end
-
-          def load_topological_svc_instance(source_id, source_ref)
-            api = topology_api_client.api_client
-
-            count = 0
-            timeout_count = POLL_TIMEOUT / SLEEP_POLL
-
-            header_params = { 'Accept' => api.select_header_accept(['application/json']) }
-            query_params = { :'source_id' => source_id, :'source_ref' => source_ref }
-            return_type = 'ServiceInstancesCollection'
-
-            service_instance = nil
-            loop do
-              data, _status_code, _headers = api.call_api(:GET, "/service_instances",
-                                                          :header_params => header_params,
-                                                          :query_params  => query_params,
-                                                          :auth_names    => ['UserSecurity'],
-                                                          :return_type   => return_type)
-
-              service_instance = data.data&.first if data.meta.count > 0
-              break if service_instance.present?
-
-              break if (count += 1) >= timeout_count
-
-              sleep(SLEEP_POLL) # seconds
-            end
-
-            if service_instance.nil?
-              logger.error("Failed to find service_instance by source_id [#{source_id}] source_ref [#{source_ref}]")
-            end
-
-            service_instance
-          end
-        end
-      end
-    end
-  end
-end