topological_inventory-providers-common 2.1.4 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c17638d4fd82db196de0019069a765bf1c6becdb20498765507ae35a02727eb
-  data.tar.gz: a395cd7243591bc3dab9f841e491bb978a2502d2ba1cfec3fdb004de784523dd
+  metadata.gz: ecc26cbace6fd3e43de690666e17f8c7d27e153efb05a2d48fb281712f073e8c
+  data.tar.gz: 0221166156a11b5f75da12b3fc1bb861b8594a058823fa2771c62a529ea165f5
 SHA512:
-  metadata.gz: ba2b33ec9748ef58b4ca7dc30f14d34443c17026e7915fb2bd9aef2a4ec95c4c287a8149a371b91cab88974a0341f7dfd362a987ca55ea644a5b67646adafde6
-  data.tar.gz: 41edf911fa71ef7dcdaa220a417a236e8a593a01e227ab4f0f88e70318141f8736ad8bd9bff7e642d6cef1134d017baa8aea0c1c194987b08770a721a7a2ff00
+  metadata.gz: ce5b60dd2047b2b316fa8e0add3b114664f707feae697afd45febf1abd265af96990b89c32ba53e6084f5abfb0a177cdc5ea2eb8c1f9437fdd3791e2dd19b2f0
+  data.tar.gz: d5ebb51170ffb18b7aaba271f5361742c1a2d849c96b181274b7f2562e67e4cb29bf94f83067ca41e26c51ff01a5ccf595fa4c776135a3b4cd1b154a7b3fea97

data/CHANGELOG.md

@@ -3,6 +3,18 @@ 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).
+## [3.0.2] - 2021-08-24
+Support PSK headers in sources api client #78
+
+## [3.0.1] - 2021-04-30
+More generic activesupport dependency #77
+
+## [3.0.0] - 2021-03-08
+Clowder migration #75 
+
+## [2.1.5] - 2021-01-07
+Include x-rh-id header in Kafka Availability-Status message #73
+
 ## [2.1.4] - 2020-12-14
 Common Counter metrics init #71
 
@@ -81,12 +93,18 @@ 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/v2.1.3...HEAD
-[2.1.3]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.2...v2.1.3
-[2.1.2]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.1...v2.1.2
-[2.1.1]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.0...v2.1.1
-[2.1.0]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.0.0...v2.1.0
-[2.0.0]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.12...v2.0.0
+[Unreleased]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v3.0.2.freeze...HEAD
+[3.0.2]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v3.0.1.freeze...v3.0.2.freeze
+[3.0.1]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v3.0.0.freeze...v3.0.1.freeze
+[3.0.0]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.5.freeze...v3.0.0.freeze
+[2.1.5]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.4.freeze...v2.1.5.freeze
+[2.1.5]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.4.freeze...v2.1.5.freeze
+[2.1.4]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.3.freeze...v2.1.4.freeze
+[2.1.3]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.2.freeze...v2.1.3.freeze
+[2.1.2]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.1.freeze...v2.1.2.freeze
+[2.1.1]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.1.0.freeze...v2.1.1.freeze
+[2.1.0]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v2.0.0.freeze...v2.1.0.freeze
+[2.0.0]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.12...v2.0.0.freeze
 [1.0.12]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.11...v1.0.12
 [1.0.11]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.10...v1.0.11
 [1.0.10]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.9...v1.0.10

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

@@ -0,0 +1,68 @@
+require 'clowder-common-ruby'
+require 'singleton'
+
+module TopologicalInventory
+  module Providers
+    module Common
+      class ClowderConfig
+        include Singleton
+
+        def self.clowder_enabled?
+          ::ClowderCommonRuby::Config.clowder_enabled?
+        end
+
+        def self.instance
+          @instance ||= {}.tap do |options|
+            if clowder_enabled?
+              config                        = ::ClowderCommonRuby::Config.load
+              options["awsAccessKeyId"]     = config.logging.cloudwatch.accessKeyId
+              options["awsRegion"]          = config.logging.cloudwatch.region
+              options["awsSecretAccessKey"] = config.logging.cloudwatch.secretAccessKey
+              broker                        = config.kafka.brokers.first
+              options["kafkaHost"]          = broker.hostname
+              options["kafkaPort"]          = broker.port
+
+              options["kafkaTopics"] = {}.tap do |topics|
+                config.kafka.topics.each do |topic|
+                  topics[topic.requestedName.to_s] = topic.name.to_s
+                end
+              end
+              options["logGroup"]    = config.logging.cloudwatch.logGroup
+              options["metricsPort"] = config.metricsPort
+              options["metricsPath"] = config.metricsPath # not supported by PrometheusExporter
+            else
+              options["awsAccessKeyId"]     = ENV['CW_AWS_ACCESS_KEY_ID']
+              options["awsRegion"]          = 'us-east-1'
+              options["awsSecretAccessKey"] = ENV['CW_AWS_SECRET_ACCESS_KEY']
+              options["kafkaBrokers"]       = ["#{ENV['QUEUE_HOST']}:#{ENV['QUEUE_PORT']}"]
+              options["kafkaHost"]          = ENV['QUEUE_HOST'] || 'localhost'
+              options["kafkaPort"]          = (ENV['QUEUE_PORT'] || '9092').to_i
+              options["kafkaTopics"]        = {}
+              options["logGroup"]           = 'platform-dev'
+              options["metricsPort"]        = (ENV['METRICS_PORT'] || 9394).to_i
+            end
+          end
+        end
+
+        def self.fill_args_operations(args)
+          args[:metrics_port] = instance['metricsPort']
+          args[:queue_host]   = instance['kafkaHost']
+          args[:queue_port]   = instance['kafkaPort']
+          args
+        end
+
+        def self.kafka_topic(name)
+          instance["kafkaTopics"][name] || name
+        end
+      end
+    end
+  end
+end
+
+# ManageIQ Message Client depends on these variables
+ENV["QUEUE_HOST"] = TopologicalInventory::Providers::Common::ClowderConfig.instance["kafkaHost"]
+ENV["QUEUE_PORT"] = TopologicalInventory::Providers::Common::ClowderConfig.instance["kafkaPort"].to_s
+
+# ManageIQ Logger depends on these variables
+ENV['CW_AWS_ACCESS_KEY_ID']     = TopologicalInventory::Providers::Common::ClowderConfig.instance["awsAccessKeyId"]
+ENV['CW_AWS_SECRET_ACCESS_KEY'] = TopologicalInventory::Providers::Common::ClowderConfig.instance["awsSecretAccessKey"]

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

@@ -1,5 +1,6 @@
 require "more_core_extensions/core_ext/module/cache_with_timeout"
 require "manageiq-messaging"
+require "topological_inventory/providers/common/clowder_config"
 
 module TopologicalInventory
   module Providers
@@ -11,8 +12,8 @@ module TopologicalInventory
         attr_accessor :queue_port
 
         def initialize
-          self.queue_host = ENV['QUEUE_HOST'] || 'localhost'
-          self.queue_port = (ENV['QUEUE_PORT'] || 9092).to_i
+          self.queue_host = TopologicalInventory::Providers::Common::ClowderConfig.instance["kafkaHost"]
+          self.queue_port = TopologicalInventory::Providers::Common::ClowderConfig.instance["kafkaPort"].to_i
         end
 
         def self.default

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

@@ -17,7 +17,7 @@ module TopologicalInventory
 
           STATUS_AVAILABLE, STATUS_UNAVAILABLE = %w[available unavailable].freeze
           EVENT_AVAILABILITY_STATUS            = "availability_status".freeze
-          SERVICE_NAME                         = "platform.sources.status".freeze
+          KAFKA_TOPIC_NAME                     = "platform.sources.status".freeze
 
           ERROR_MESSAGES = {
             :authentication_not_found          => "Authentication not found in Sources API",
@@ -209,9 +209,10 @@ module TopologicalInventory
 
           def availability_status_message(payload)
             messaging_client.publish_topic(
-              :service => SERVICE_NAME,
+              :service => TopologicalInventory::Providers::Common::ClowderConfig.kafka_topic(KAFKA_TOPIC_NAME),
               :event   => EVENT_AVAILABILITY_STATUS,
-              :payload => payload.to_json
+              :payload => payload.to_json,
+              :headers => identity
             )
           rescue => err
             logger.availability_check("Failed to update #{payload[:resource_type]} id: #{payload[:resource_id]} - #{err.message}", :error)

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

@@ -15,10 +15,27 @@ module TopologicalInventory
         end
 
         def init_default_api
-          default_headers.merge!(identity) if identity.present?
+          # TODO: remove this once PSK is set up everywhere.
+          if identity.present?
+            if psk
+              parsed_identity = JSON.parse(Base64.decode64(identity.fetch('x-rh-identity')))
+
+              default_headers.merge!(
+                "x-rh-sources-psk"            => psk,
+                "x-rh-sources-account-number" => parsed_identity['identity']['account_number']
+              )
+            else
+              default_headers.merge!(identity)
+            end
+          end
+
           ::SourcesApiClient::DefaultApi.new(self)
         end
 
+        def psk
+          @psk ||= ENV.fetch("SOURCES_PSK", nil)
+        end
+
         def fetch_default_endpoint(source_id)
           endpoints = api.list_source_endpoints(source_id)&.data || []
           endpoints.find(&:default)

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

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

data/spec/support/shared/availability_check.rb

@@ -9,7 +9,8 @@ RSpec.shared_examples "availability_check" do
   let(:external_tenant) { '11001' }
   let(:kafka_client) { TopologicalInventory::Providers::Common::MessagingClient.default.client }
   let(:identity) { {'x-rh-identity' => Base64.strict_encode64({'identity' => {'account_number' => external_tenant, 'user' => {'is_org_admin' => true}}}.to_json)} }
-  let(:headers) { {'Content-Type' => 'application/json'}.merge(identity) }
+  let(:identity_with_psk) { { "x-rh-sources-account-number" => external_tenant, "x-rh-sources-psk" => '1234' } }
+  let(:headers) { ENV['SOURCES_PSK'] ? {'Content-Type' => 'application/json'}.merge(identity_with_psk) : {'Content-Type' => 'application/json'}.merge(identity)  }
   let(:status_available) { described_class::STATUS_AVAILABLE }
   let(:status_unavailable) { described_class::STATUS_UNAVAILABLE }
   let(:error_message) { 'error_message' }
@@ -38,12 +39,15 @@ RSpec.shared_examples "availability_check" do
 
   def kafka_message(resource_type, resource_id, status, error_message = nil)
     res = {
-      :service => described_class::SERVICE_NAME,
+      :service => described_class::KAFKA_TOPIC_NAME,
       :event   => described_class::EVENT_AVAILABILITY_STATUS,
       :payload => {
         :resource_type => resource_type,
         :resource_id   => resource_id,
         :status        => status
+      },
+      :headers => {
+        "x-rh-identity" => "eyJpZGVudGl0eSI6eyJhY2NvdW50X251bWJlciI6IjExMDAxIiwidXNlciI6eyJpc19vcmdfYWRtaW4iOnRydWV9fX0="
       }
     }
     res[:payload][:error] = error_message if error_message

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

@@ -1,5 +1,15 @@
 require "topological_inventory/providers/common/operations/source"
 
 RSpec.describe TopologicalInventory::Providers::Common::Operations::Source do
+  context "PSK" do
+    around do |example|
+      ENV['SOURCES_PSK'] = '1234'
+      example.run
+      ENV['SOURCES_PSK'] = nil
+    end
+
+    it_behaves_like "availability_check"
+  end
+
   it_behaves_like "availability_check"
 end

data/topological_inventory-providers-common.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'activesupport', '~> 5.2.4.3'
+  spec.add_runtime_dependency 'activesupport', '~> 5.2', '>= 5.2.4.3'
+  spec.add_runtime_dependency 'clowder-common-ruby', '~> 0.2.1'
   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'

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: topological_inventory-providers-common
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 3.0.2
 platform: ruby
 authors:
 - Martin Slemr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.3
   type: :runtime
@@ -22,8 +25,25 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.3
+- !ruby/object:Gem::Dependency
+  name: clowder-common-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: config
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +324,7 @@ files:
 - bin/console
 - bin/setup
 - lib/topological_inventory/providers/common.rb
+- lib/topological_inventory/providers/common/clowder_config.rb
 - lib/topological_inventory/providers/common/collector.rb
 - lib/topological_inventory/providers/common/collector/inventory_collection_storage.rb
 - lib/topological_inventory/providers/common/collector/inventory_collection_wrapper.rb
@@ -358,7 +379,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Common classes for topological-inventory collectors/operations