topological_inventory-providers-common 1.0.9 → 2.1.0

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/spec/topological_inventory/providers/common/operations/processor_spec.rb

@@ -1,102 +1,71 @@
 require "topological_inventory/providers/common/operations/processor"
 
 RSpec.describe TopologicalInventory::Providers::Common::Operations::Processor do
-  let(:topology_api_client) { double }
-  let(:source_id) { 1 }
-  let(:source_ref) { 1000 }
-  let(:service_plan) { double("TopologicalInventoryApiClient::ServicePlan") }
-  let(:service_offering) { double("TopologicalInventoryApiClient::ServiceOffering") }
-
-  # Overriden in contexts
-  let(:payload) { {} }
-
-  before do
-    @processor = described_class.new(nil, nil, payload)
-    allow(@processor).to receive(:logger).and_return(double('null_object').as_null_object)
-
-    allow(service_plan).to receive(:service_offering_id).and_return(1)
-    allow(service_plan).to receive(:name).and_return(double)
-
-    allow(service_offering).to receive(:name).and_return(double)
-    allow(service_offering).to receive(:source_ref).and_return(source_ref)
-    allow(service_offering).to receive(:extra).and_return({:type => 'job_template'})
-    allow(service_offering).to receive(:source_id).and_return(source_id)
-
-    @endpoint_client = double
-    allow(@endpoint_client).to receive(:order_service)
-
-    allow(@processor).to receive(:endpoint_client).and_return(@endpoint_client)
-    allow(@processor).to receive(:topology_api_client).and_return(topology_api_client)
-    allow(topology_api_client).to receive(:update_task)
-    allow(topology_api_client).to receive(:show_service_plan).and_return(service_plan)
-    allow(topology_api_client).to receive(:show_service_offering).and_return(service_offering)
-  end
+  let(:operation_name) { 'Source.availability_check' }
+  let(:params) { {'source_id' => 1, 'external_tenant' => '12345'} }
+  let(:payload) { {"params" => params, "request_context" => double('request_context')} }
+  let(:message) { double("ManageIQ::Messaging::ReceivedMessage", :message => operation_name, :payload => payload) }
 
-  context "Order by ServicePlan" do
-    let(:payload) do
-      {
-        'request_context' => {"x-rh-identity" => 'abcd'},
-        'params'          => {
-          'order_params'    => {
-            'service_plan_id'             => 1,
-            'service_parameters'          => { :name   => "Job 1",
-                                               :param1 => "Test Topology",
-                                               :param2 => 50 },
-            'provider_control_parameters' => {}
-          },
-          'service_plan_id' => 1,
-          'task_id'         => 1 # in tp-inv api (Task)
-        }
-      }
-    end
+  subject { described_class.new(message, nil) }
+
+  describe "#process" do
+    it "starts the operation if class and method exists" do
+      result = double('result')
 
-    describe "#order_service" do
-      it "orders job" do
-        allow(@processor).to receive(:poll_order_complete_thread).and_return(double)
+      klass = TopologicalInventory::Providers::Common::Operations::Source
+      allow(subject).to receive(:operation_class).and_return(klass)
 
-        expect(@endpoint_client).to receive(:order_service).with(service_offering, service_plan, payload['params']['order_params'])
-        @processor.send(:order_service, payload['params'])
-      end
+      source = klass.new(params, payload['request_context'], nil)
+      expect(klass).to receive(:new).with(params, payload['request_context'], nil).and_return(source)
+      expect(source).to receive(:availability_check).and_return(result)
 
-      it "updates task on error" do
-        err_message = "Sample error"
+      expect(subject.process).to eq(result)
+    end
+
+    it "returns 'not_implemented' if class of method doesn't exist" do
+      allow(subject).to receive(:operation_class).and_return(nil)
+      allow(subject).to receive(:method).and_return('awesome')
 
-        allow(@processor).to receive(:poll_order_complete_thread).and_return(double)
-        allow(@processor).to receive(:update_task).and_return(double)
-        allow(@endpoint_client).to receive(:order_service).and_raise(err_message)
+      expect(subject.process).to eq(subject.operation_status[:not_implemented])
+    end
 
-        expect(@processor).to receive(:update_task).with(payload['params']['task_id'], :state => "completed", :status => "error", :context => { :error => err_message })
+    it "updates task if not_implemented" do
+      allow(subject).to receive(:operation_class).and_return(nil)
+      allow(subject).to receive(:method).and_return('awesome')
 
-        @processor.send(:order_service, payload['params'])
-      end
+      subject.send(:params)['task_id'] = '1'
+      expect(subject).to(receive(:update_task).with('1',
+                                                    :state   => "completed",
+                                                    :status  => "error",
+                                                    :context => anything))
+      subject.process
+    end
+
+    it "updates task if exception raised" do
+      subject.send(:params)['task_id'] = '1'
+      expect(subject).to(receive(:update_task).with('1',
+                                                    :state   => "completed",
+                                                    :status  => "error",
+                                                    :context => anything))
+      expect { subject.process }.to raise_exception(NotImplementedError)
     end
   end
 
-  context "Order by ServiceOffering" do
-    let(:payload) do
-      {
-        'request_context' => {"x-rh-identity" => 'abcd'},
-        'params'          => {
-          'order_params'    => {
-            'service_offering_id'             => 1,
-            'service_parameters'          => { :name   => "Job 1",
-                                               :param1 => "Test Topology",
-                                               :param2 => 50 },
-            'provider_control_parameters' => {}
-          },
-          'service_offering_id' => 1,
-          'task_id'         => 1 # in tp-inv api (Task)
-        }
-      }
+  describe "#with_time_measure" do
+    let(:metrics) { double("Metrics") }
+
+    it "records time and yields if metrics provided" do
+      allow(subject).to receive(:metrics).and_return(metrics)
+
+      expect(metrics).to receive(:record_operation_time).with(operation_name).and_yield
+
+      expect(subject.send(:with_time_measure) { 42 }).to eq(42)
     end
 
-    describe "#order_service" do
-      it "orders job" do
-        allow(@processor).to receive(:poll_order_complete_thread).and_return(double)
+    it "only yields if metrics not present" do
+      expect(metrics).not_to receive(:record_operation_time)
 
-        expect(@endpoint_client).to receive(:order_service).with(service_offering, nil, payload['params']['order_params'])
-        @processor.send(:order_service, payload['params'])
-      end
+      expect(subject.send(:with_time_measure) { 42 }).to eq(42)
     end
   end
 end

data/topological_inventory-providers-common.gemspec

@@ -26,16 +26,20 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '~> 5.2.4.3'
   spec.add_runtime_dependency 'config', '~> 1.7', '>= 1.7.2'
   spec.add_runtime_dependency 'json', '~> 2.3'
-  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", ">= 1.0.3"
+  spec.add_runtime_dependency 'manageiq-loggers', '>= 0.4.2'
+  spec.add_runtime_dependency 'manageiq-messaging', '~> 1.0.0'
+  spec.add_runtime_dependency 'more_core_extensions'
+  spec.add_runtime_dependency 'prometheus_exporter', '~> 0.4.17'
+  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', '>= 1.0.3'
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency 'rubocop', '~>0.69.0'
-  spec.add_development_dependency 'rubocop-performance', '~>1.3'
-  spec.add_development_dependency "simplecov", "~> 0.17.1"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.8'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topological_inventory-providers-common
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 2.1.0
 platform: ruby
 authors:
 - Martin Slemr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,6 +72,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: manageiq-messaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: more_core_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prometheus_exporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.17
 - !ruby/object:Gem::Dependency
   name: sources-api-client
   requirement: !ruby/object:Gem::Requirement
@@ -174,28 +216,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.69.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.69.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +287,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
@@ -238,6 +295,7 @@ files:
 - ".rubocop_cc.yml"
 - ".rubocop_local.yml"
 - ".travis.yml"
+- ".yamllint"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -252,13 +310,20 @@ 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/messaging_client.rb
+- lib/topological_inventory/providers/common/metrics.rb
+- lib/topological_inventory/providers/common/mixins/sources_api.rb
+- lib/topological_inventory/providers/common/mixins/statuses.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/processor.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
@@ -268,6 +333,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/async_worker_spec.rb
 - spec/topological_inventory/providers/common/operations/processor_spec.rb
 - spec/topological_inventory/providers/common/operations/source_spec.rb
 - spec/topological_inventory/providers/common/save_inventory/saver_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/sources_api_client.rb

@@ -1,94 +0,0 @@
-require "sources-api-client"
-
-module TopologicalInventory
-  module Providers
-    module Common
-      module Operations
-        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
-end