receptor_controller-client 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab72f29ace5c188996000048957bb58020940d3b8ce32b1a0b720602f4ff7e64
-  data.tar.gz: 4b68d648d59809f80e108a1d998af10d09fee233db085e02b736c691db05b8d5
+  metadata.gz: c93a4640b49698fe085a3f8eeeeb21ce3c7c087414e3ab7a177e8d6471c4453f
+  data.tar.gz: 296126023dafdb0325e4c7b4166720b333b5cd6fc3e6ca0709b4314cf109e142
 SHA512:
-  metadata.gz: 32b8c1c4a2173e38ec229bad3b4f0c6747c9f9cc50ce3be86746217a6682b60e4c820e9677adc38798548d81bb62db858994a7019cb85fc9b58c149eb0357c2e
-  data.tar.gz: abfdf8a4c9924f4ba225310f5439b97f003d4ac01eedd14a822328d7750289a60cc9ec49a086ac125f446adbd0c84840afc02562a84c3c02c19f6402b201a469
+  metadata.gz: 42522f3b97b78ac1a25a947351b822c827f01cc851772e61f464694fede11de3b9ab2746cc4de4bb5b2b262b8bf367266c292bf9af562ab9a89f87f24b26198d
+  data.tar.gz: 6c9edc4cde0acbc4396cc729af0b75051c922b197462e09a81afe3834fdd667febea56a9f70548cd77c5b52b00da407ca71da560e39c038960389e42d5ea6929

data/CHANGELOG.md

@@ -5,6 +5,10 @@ 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).
 
 ## [Unreleased]
+## [0.0.8]
+- Fix LOG_ALL_RECEPTOR_MESSAGES check #34
+- Fix Directives with PSK header #33
+
 ## [0.0.7]
 - rdkafka changes #32
 
@@ -30,8 +34,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added extra logging for messages
 
-[Unreleased]: https://github.com/RedHatInsights/receptor_controller-client-ruby/compare/v0.0.7...HEAD
-[0.0.6]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.7
+[Unreleased]: https://github.com/RedHatInsights/receptor_controller-client-ruby/compare/v0.0.8...HEAD
+[0.0.8]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.8
+[0.0.7]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.7
 [0.0.6]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.6
 [0.0.5]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.5
 [0.0.4]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.4

data/lib/receptor_controller/client/directive_blocking.rb

@@ -74,7 +74,7 @@ module ReceptorController
     attr_accessor :response_data, :response_exception, :response_lock, :response_waiting
 
     def connection
-      @connection ||= Faraday.new(config.controller_url, :headers => client.headers) do |c|
+      @connection ||= Faraday.new(config.controller_url, :headers => client.headers(account)) do |c|
         c.use(Faraday::Response::RaiseError)
         c.adapter(Faraday.default_adapter)
       end

data/lib/receptor_controller/client/directive_non_blocking.rb

@@ -42,7 +42,7 @@ module ReceptorController
 
     # Entrypoint for request
     def call(body = default_body)
-      response = Faraday.post(config.job_url, body.to_json, client.headers)
+      response = Faraday.post(config.job_url, body.to_json, client.headers(account))
       if response.success?
         msg_id = JSON.parse(response.body)['id']
 

data/lib/receptor_controller/client/response_worker.rb

@@ -105,8 +105,10 @@ module ReceptorController
       response = JSON.parse(message.payload)
 
       if (message_id = response['in_response_to'])
-        logger.debug(response_log("Received message #{message_id}: serial: #{response["serial"]}, type: #{response['message_type']}, payload: #{response['payload'] || "n/a"}"))
-        if (callbacks = registered_messages[message_id]).present?
+        callbacks = registered_messages[message_id]
+        log_received_message(callbacks, message_id, response)
+
+        if callbacks.present?
           # Reset last_checked_at to avoid timeout in multi-response messages
           reset_last_checked_at(callbacks)
 
@@ -150,7 +152,7 @@ module ReceptorController
 
             callbacks[:receiver].send(callbacks[:error_callback], message_id, response['code'], response['payload'])
           end
-        elsif ENV["LOG_ALL_RECEPTOR_MESSAGES"]&.to_i != 0
+        elsif (ENV["LOG_ALL_RECEPTOR_MESSAGES"] || 0)&.to_i != 0
           # noop, it's not error if not registered, can be processed by another pod
           logger.debug(response_log("NOT REGISTERED | #{message_id} (#{response['code']})"))
         end
@@ -243,6 +245,13 @@ module ReceptorController
       }
     end
 
+    def log_received_message(callbacks, message_id, response)
+      log_all = (ENV["LOG_ALL_RECEPTOR_MESSAGES"] || 0).to_i != 0
+      if log_all || (!log_all && callbacks.present?)
+        logger.debug(response_log("Received message #{message_id}: serial: #{response["serial"]}, type: #{response['message_type']}, payload: #{response['payload'] || "n/a"}"))
+      end
+    end
+    
     def response_log(message)
       "Receptor Response [#{queue_opts[:persist_ref]}]: #{message}"
     end

data/lib/receptor_controller/client/version.rb

@@ -1,5 +1,5 @@
 module ReceptorController
   class Client
-    VERSION = "0.0.7".freeze
+    VERSION = "0.0.8".freeze
   end
 end

data/spec/.yamllint

@@ -0,0 +1,10 @@
+---
+ignore: |
+
+extends: relaxed
+
+rules:
+  indentation:
+    indent-sequences: false
+  line-length:
+    max: 120

data/spec/receptor_controller/directive_blocking_spec.rb

@@ -7,11 +7,21 @@ RSpec.describe ReceptorController::Client::DirectiveBlocking do
   let(:identity) do
     {"x-rh-identity" => Base64.strict_encode64({"identity" => {"account_number" => external_tenant, "user" => {"is_org_admin" => true}, "internal" => {"org_id" => organization_id}}}.to_json)}
   end
-  let(:headers) do
+  let(:pre_shared_key) { '1234' }
+  let(:pre_shared_key_headers) do
+    {
+      'x-rh-receptor-controller-psk'       => pre_shared_key,
+      'x-rh-receptor-controller-client-id' => "topological-inventory",
+      'x-rh-receptor-controller-account'   => external_tenant
+    }
+  end
+  let(:headers_common) do
     {"Content-Type"    => "application/json",
      "Accept"          => "*/*",
-     "Accept-Encoding" => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}.merge(identity)
+     "Accept-Encoding" => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}
   end
+  let(:headers) { headers_common.merge(identity) }
+  let(:headers_psk) { headers_common.merge(pre_shared_key_headers) }
   let(:receptor_scheme) { 'http' }
   let(:receptor_host) { 'localhost:9090' }
   let(:receptor_node) { 'testing-receptor' }
@@ -52,6 +62,22 @@ RSpec.describe ReceptorController::Client::DirectiveBlocking do
       subject.call
     end
 
+    it "makes POST /job request with PSK headers if set in the config" do
+      receptor_config.pre_shared_key = pre_shared_key
+      allow(subject).to receive(:wait_for_response)
+
+      response = {"id" => '1234'}
+
+      stub_request(:post, "#{receptor_scheme}://#{receptor_host}/job")
+        .with(:body    => subject.default_body.to_json,
+              :headers => headers_psk)
+        .to_return(:status => 200, :body => response.to_json, :headers => {})
+
+      expect(subject.response_worker).to receive(:register_message).with(response['id'], subject)
+
+      subject.call
+    end
+
     it "raises ControllerResponseError if POST /job returns error" do
       stub_request(:post, "#{receptor_scheme}://#{receptor_host}/job")
         .with(:body    => subject.default_body.to_json,

data/spec/receptor_controller/directive_non_blocking_spec.rb

@@ -6,11 +6,21 @@ RSpec.describe ReceptorController::Client::DirectiveNonBlocking do
   let(:identity) do
     {"x-rh-identity" => Base64.strict_encode64({"identity" => {"account_number" => external_tenant, "user" => {"is_org_admin" => true}, "internal" => {"org_id" => organization_id}}}.to_json)}
   end
-  let(:headers) do
+  let(:pre_shared_key) { '1234' }
+  let(:pre_shared_key_headers) do
+    {
+      'x-rh-receptor-controller-psk'       => pre_shared_key,
+      'x-rh-receptor-controller-client-id' => "topological-inventory",
+      'x-rh-receptor-controller-account'   => external_tenant
+    }
+  end
+  let(:headers_common) do
     {"Content-Type"    => "application/json",
      "Accept"          => "*/*",
-     "Accept-Encoding" => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}.merge(identity)
+     "Accept-Encoding" => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'}
   end
+  let(:headers) { headers_common.merge(identity) }
+  let(:headers_psk) { headers_common.merge(pre_shared_key_headers) }
   let(:receptor_scheme) { 'http' }
   let(:receptor_host) { 'localhost:9090' }
   let(:receptor_node) { 'testing-receptor' }
@@ -21,7 +31,7 @@ RSpec.describe ReceptorController::Client::DirectiveNonBlocking do
     end
   end
   let(:receptor_client) do
-    client = ReceptorController::Client.new
+    client = ReceptorController::Client.new(:config => receptor_config)
     client.identity_header = identity
     client
   end
@@ -64,6 +74,19 @@ RSpec.describe ReceptorController::Client::DirectiveNonBlocking do
 
       expect(subject.call).to be_nil
     end
+
+    it "makes a POST request with PSK headers if provided" do
+      receptor_config.pre_shared_key = pre_shared_key
+
+      response = {"id" => '1234'}
+
+      stub_request(:post, "#{receptor_scheme}://#{receptor_host}/job")
+        .with(:body    => subject.default_body.to_json,
+              :headers => headers_psk)
+        .to_return(:status => 200, :body => response.to_json, :headers => {})
+
+      expect(subject.call).to eq(response['id'])
+    end
   end
 
   context "callbacks" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receptor_controller-client
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Martin Slemr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -232,6 +232,7 @@ files:
 - lib/receptor_controller/client/response_worker.rb
 - lib/receptor_controller/client/version.rb
 - receptor_controller-client.gemspec
+- spec/.yamllint
 - spec/receptor_controller/client_spec.rb
 - spec/receptor_controller/directive_blocking_spec.rb
 - spec/receptor_controller/directive_non_blocking_spec.rb
@@ -261,8 +262,8 @@ signing_key:
 specification_version: 4
 summary: Client for communication with Platform Receptor Controller - Gem
 test_files:
-- spec/receptor_controller/directive_non_blocking_spec.rb
-- spec/receptor_controller/response_worker_spec.rb
 - spec/receptor_controller/directive_blocking_spec.rb
+- spec/receptor_controller/directive_non_blocking_spec.rb
 - spec/receptor_controller/client_spec.rb
+- spec/receptor_controller/response_worker_spec.rb
 - spec/spec_helper.rb