tshield 0.13.5.0 → 0.14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab5c5057fe81ae295f572912c6955ce0ea0bd9be6b42fb515a7832fe3451459a
-  data.tar.gz: 9c785dc23adb245fdfcc416698c551f7a45eaa32b5892a2cabea708f16fa2859
+  metadata.gz: 83eb12f572bdfd5f6fade21d83ee7d4883253aa9e42cad7fe0e9feac380d7ae6
+  data.tar.gz: c1718a13671ee6899321dcda86c6d6dbaad23c1389cc24c0b6ea3b684024c725
 SHA512:
-  metadata.gz: 58fd33ddf9e466af5882e6522612b2b0fa05c95f728578fe50b014dca0777357bf5ccfa17605a86309c5742cb828dd2e52eb9bb2839096f594e1e75fef80e81b
-  data.tar.gz: f085f1dcc7a3d861da1b28a0d07f3338f03dd5b27cdd234c283cecf0bce8a0dc66f26193755ea8f5b442cbf4953fb2bd4ce295f90257b76121ac7fdbcbdd38b0
+  metadata.gz: 003b70dbe21e80655ebfe6eae9e0260137a3f6e3e478200c04eefbc238ae72d8d172b62c4d980a934fd56a08eb7d2ad59d93b4d762a3c019e88d3e2e6cc39d46
+  data.tar.gz: 6c4ada87361e89edff1b8fe7353389861c3748986631ad9693d01f148c71fb2dbe06547b318d94c3247dc584081c047fc915f5d1d014d6026172b8cf406b5753

data/lib/tshield/configuration.rb

@@ -29,10 +29,7 @@ module TShield
     #                          generated directory
     #
     attr_reader :request
-    attr_reader :domains
-    attr_reader :tcp_servers
-    attr_reader :session_path
-    attr_reader :windows_compatibility
+    attr_reader :domains, :tcp_servers, :session_path, :windows_compatibility
 
     def initialize(attributes)
       attributes.each { |key, value| instance_variable_set("@#{key}", value) }
@@ -106,6 +103,7 @@ module TShield
 
     def send_header_content_type(domain)
       return domains[domain]['send_header_content_type'] != false if domains[domain]
+
       true
     end
 
@@ -140,6 +138,5 @@ module TShield
     def get_delay(domain, path)
       ((domains[domain] || {})['delay'] || {})[path] || 0
     end
-
   end
 end

data/lib/tshield/controllers/requests.rb

@@ -114,7 +114,6 @@ module TShield
           logger.info("Response with delay of #{delay_in_seconds} seconds")
           sleep delay_in_seconds
         end
-
       end
     end
   end

data/lib/tshield/grpc/grpc_counter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TShield
+  # Increment counter for sessions requests
+  class GrpcCounter
+    def initialize
+      @requests = {}
+    end
+
+    def add(hexdigest)
+      count = @requests.fetch(hexdigest, 0)
+      count += 1
+      @requests[hexdigest] = count
+    end
+
+    def current(hexdigest)
+      @requests.fetch(hexdigest, 0)
+    end
+
+    def to_json(options = {})
+      @requests.to_json(options)
+    end
+  end
+end

data/lib/tshield/grpc/vcr.rb

@@ -5,79 +5,127 @@ require 'tshield/sessions'
 
 module TShield
   module Grpc
+    # Grpc vcr module
     module VCR
+      # Path file to save Grpc request/response
+      class FilePath
+        attr_reader :path, :count
+
+        def initialize(path, count)
+          @path = path
+          @count = count
+        end
+      end
+
       def initialize
         @configuration = TShield::Configuration.singleton
       end
+
       def handler_in_vcr_mode(method_name, request, parameters, options)
         parameters.peer =~ /ipv6:\[(.+?)\]|ipv4:(.+?):/
         peer = Regexp.last_match(1) || Regexp.last_match(2)
 
         TShield.logger.info("request from #{parameters.peer}")
         @session = TShield::Sessions.current(peer)
+        @digest = hexdigest(request)
+        counter = @session ? request_count.current(@digest) : 0
 
         TShield.logger.info("grpc using session #{@session || 'default'}")
         module_name = options['module']
 
-        path = create_destiny(module_name, method_name, request)
-        save_request(path, request)
-        response = saved_response(path)
-        if response
-          TShield.logger.info("returning saved response for request #{request.to_json} saved into #{hexdigest(request)}")
-          return response
+        path = create_destiny(module_name, method_name)
+        @file_path = FilePath.new(path, counter)
+        save_request(request)
+        response = {}
+        saved_error
+        begin
+          response = saved_response
+          if response
+            TShield.logger.info("returning saved response for request #{request.to_json} saved into #{@digest}")
+            request_count.add(@digest) if @session
+            return response
+          end
+
+          response = send_request(request, module_name, options, method_name)
+          save_response(response)
+        rescue GRPC::BadStatus => e
+          save_error({ code: e.code, details: e.details })
+          raise e
         end
+        request_count.add(@digest) if @session
+        response
+      end
 
+      def send_request(request, module_name, options, method_name)
         TShield.logger.info("calling server to get response for #{request.to_json}")
         client_class = Object.const_get("#{module_name}::Stub")
         client_instance = client_class.new(options['hostname'], :this_channel_is_insecure)
-        response = client_instance.send(method_name, request)
-        save_response(path, response)
-        response
+        client_instance.send(method_name, request)
+      end
+
+      def request_count
+        @session[:grpc_counter]
       end
 
       def encode_colon(value)
-        value.gsub(':','%3a')
+        value.gsub(':', '%3a')
       end
 
-      def saved_response(path)
-        response_file = File.join(path, 'response')
+      def saved_response
+        response_file = File.join(@file_path.path, "#{@file_path.count}.response")
         return false unless File.exist? response_file
 
         content = JSON.parse File.open(response_file).read
-        response_class = File.open(File.join(path, 'response_class')).read.strip
+        response_class = File.open(File.join(@file_path.path, "#{@file_path.count}.response_class")).read.strip
         Kernel.const_get(response_class).new(content)
       end
 
-      def save_request(path, request)
-        file = File.open(File.join(path, 'original_request'), 'w')
+      def saved_error
+        error_file = File.join(@file_path.path, "#{@file_path.count}.error")
+        return false unless File.exist? error_file
+
+        request_count.add(@digest) if @session
+        content = JSON.parse File.open(error_file).read
+        grpc_error = GRPC::BadStatus.new(content['code'], content['details'])
+        raise grpc_error
+      end
+
+      def save_request(request)
+        file = File.open(File.join(@file_path.path, "#{@file_path.count}.original_request"), 'w')
         file.puts request.to_json
         file.close
       end
 
-      def save_response(path, response)
-        file = File.open(File.join(path, 'response'), 'w')
+      def save_error(error)
+        file = File.open(File.join(@file_path.path, "#{@file_path.count}.error"), 'w')
+        file.puts error.to_json
+        file.close
+        request_count.add(@digest) if @session
+      end
+
+      def save_response(response)
+        file = File.open(File.join(@file_path.path, "#{@file_path.count}.response"), 'w')
         file.puts response.to_json
         file.close
 
-        response_class = File.open(File.join(path, 'response_class'), 'w')
+        response_class = File.open(File.join(@file_path.path, "#{@file_path.count}.response_class"), 'w')
         response_class.puts response.class.to_s
         response_class.close
       end
 
-      def complete_path(module_name, method_name, request)
+      def complete_path(module_name, method_name)
         @session_name = (@session || {})[:name]
         module_name = @configuration.windows_compatibility? ? encode_colon(module_name) : module_name
-        path = ['requests', 'grpc', @session_name, module_name, method_name.to_s, hexdigest(request)].compact
-        path
+        ['requests', @session_name, module_name, method_name.to_s, @digest].compact
       end
 
-      def create_destiny(module_name, method_name, request)
+      def create_destiny(module_name, method_name)
         current_path = []
 
-        path = complete_path(module_name, method_name, request)
+        path = complete_path(module_name, method_name)
         TShield.logger.info("using path #{path}")
-        path.each do |path|
-          current_path << path
+        path.each do |inner_path|
+          current_path << inner_path
           destiny = File.join current_path
           Dir.mkdir destiny unless File.exist? destiny
         end

data/lib/tshield/grpc.rb

@@ -4,7 +4,6 @@ require 'grpc'
 
 require 'tshield/configuration'
 require 'tshield/grpc/vcr'
-
 module TShield
   module Grpc
     module RequestHandler
@@ -14,6 +13,7 @@ module TShield
         handler_in_vcr_mode(method_name, request, parameters, options)
       end
     end
+
     def self.run!
       @configuration = TShield::Configuration.singleton.grpc
 
@@ -41,6 +41,7 @@ module TShield
       handlers = []
       number_of_handlers = 0
       services.each do |file, options|
+
         require file
 
         base = Object.const_get("#{options['module']}::Service")
@@ -55,8 +56,7 @@ module TShield
     def self.build_handler(base, descriptions, number_of_handlers, options)
       handler = Class.new(base) do
         class << self
-          attr_writer :options
-          attr_reader :options
+          attr_accessor :options
         end
         descriptions.each do |service_name, description|
           puts description

data/lib/tshield/logger.rb

@@ -5,6 +5,6 @@ require 'logger'
 # Logger instance for application
 module TShield
   def self.logger
-    @logger ||= Logger.new(STDOUT)
+    @logger ||= Logger.new($stdout)
   end
 end

data/lib/tshield/request_vcr.rb

@@ -79,7 +79,6 @@ module TShield
     end
 
     def apply_set_cookie_header_values(raw_response, headers = {})
-
       headers_clone = headers.clone
 
       field = raw_response.get_fields('Set-Cookie')
@@ -98,6 +97,7 @@ module TShield
 
       raw_response.headers.each do |k, v|
         next if k == 'set-cookie'
+
         headers[k] = v unless configuration.not_save_headers(domain).include? k
       end
 
@@ -156,9 +156,10 @@ module TShield
     end
 
     def encode_for_windows_dir(directory)
-      replace = [['<','%3c'],['>','%3e'],[':','%3a'],['"','%22'],['?','%3f'],[' ','%20'],['*','%2a'],['/','%2f']]
+      replace = [['<', '%3c'], ['>', '%3e'], [':', '%3a'], ['"', '%22'], ['?', '%3f'], [' ', '%20'], ['*', '%2a'],
+                 ['/', '%2f']]
       replace.each do |value|
-        directory = directory.gsub(value.first,value.last)
+        directory = directory.gsub(value.first, value.last)
       end
       directory
     end
@@ -171,7 +172,7 @@ module TShield
       else
         directory = url.gsub(%r{/}, '-').gsub(/^-/, '')
       end
-        configuration.windows_compatibility? ? encode_for_windows_dir(directory) : directory
+      configuration.windows_compatibility? ? encode_for_windows_dir(directory) : directory
     end
   end
 end

data/lib/tshield/sessions.rb

@@ -2,6 +2,7 @@
 
 require 'tshield/logger'
 require 'tshield/counter'
+require 'tshield/grpc/grpc_counter'
 require 'tshield/errors'
 
 module TShield
@@ -14,6 +15,7 @@ module TShield
       sessions[normalize_ip(ip)] = {
         name: name,
         counter: TShield::Counter.new,
+        grpc_counter: TShield::GrpcCounter.new,
         secondary_sessions: []
       }
     end

data/lib/tshield/version.rb

@@ -4,8 +4,8 @@ module TShield
   # Control version of gem
   class Version
     MAJOR = 0
-    MINOR = 13
-    PATCH = 5
+    MINOR = 14
+    PATCH = 0
     PRE = 0
 
     class << self

data/spec/tshield/configuration_spec.rb

@@ -67,7 +67,7 @@ describe TShield::Configuration do
 
     describe 'SO compatibility' do
       it 'should be compatible with windows when configuration is true' do
-        allow(YAML).to receive(:safe_load).and_return({:windows_compatibility => true })
+        allow(YAML).to receive(:safe_load).and_return({ windows_compatibility: true })
         TShield::Configuration.clear
         @configuration = TShield::Configuration.singleton
 
@@ -75,7 +75,7 @@ describe TShield::Configuration do
       end
 
       it 'should be compatible with Unix when configuration is false' do
-        allow(YAML).to receive(:safe_load).and_return({:windows_compatibility => false })
+        allow(YAML).to receive(:safe_load).and_return({ windows_compatibility: false })
         TShield::Configuration.clear
         @configuration = TShield::Configuration.singleton
 
@@ -89,7 +89,6 @@ describe TShield::Configuration do
 
         expect(@configuration.windows_compatibility?).to eq(false)
       end
-
     end
   end
   context 'on config not exist' do

data/spec/tshield/controllers/requests_spec.rb

@@ -73,7 +73,6 @@ describe TShield::Controllers::Requests do
     allow(@configuration).to receive(:get_domain_for).and_return('example.org')
     allow(@configuration).to receive(:get_delay).and_return(0)
 
-
     allow(TShield::Options).to receive_message_chain(:instance, :break?)
     @mock_logger = double
     @controller = MockController.new(@mock_logger)
@@ -100,15 +99,15 @@ describe TShield::Controllers::Requests do
       allow(matched_response).to receive(:body).and_return('')
       allow(@mock_logger).to receive(:info)
 
-      expect(TShield::RequestVCR).to receive(:new).with("/",{
-        call: 0,
-        headers: {},
-        ip: "0.0.0.0",
-        method: "GET",
-        raw_query: "a=b",
-        secondary_sessions: nil,
-        session: nil
-      })
+      expect(TShield::RequestVCR).to receive(:new).with('/', {
+                                                          call: 0,
+                                                          headers: {},
+                                                          ip: '0.0.0.0',
+                                                          method: 'GET',
+                                                          raw_query: 'a=b',
+                                                          secondary_sessions: nil,
+                                                          session: nil
+                                                        })
       @controller.treat(params, request, nil)
     end
   end
@@ -135,16 +134,15 @@ describe TShield::Controllers::Requests do
       allow(matched_response).to receive(:body).and_return('')
       allow(@mock_logger).to receive(:info)
 
-      expect(TShield::RequestVCR).to receive(:new).with("/",{
-        call: 0,
-        headers: {'Content-Type' => 'application/json'},
-        ip: "0.0.0.0",
-        method: "GET",
-        raw_query: "a=b",
-        secondary_sessions: nil,
-        session: nil
-      })
-
+      expect(TShield::RequestVCR).to receive(:new).with('/', {
+                                                          call: 0,
+                                                          headers: { 'Content-Type' => 'application/json' },
+                                                          ip: '0.0.0.0',
+                                                          method: 'GET',
+                                                          raw_query: 'a=b',
+                                                          secondary_sessions: nil,
+                                                          session: nil
+                                                        })
 
       @controller.treat(params, request, nil)
     end

data/spec/tshield/request_vcr_spec.rb

@@ -107,9 +107,9 @@ describe TShield::RequestVCR do
 
       it 'should create response directory in windows standard' do
         allow(@configuration).to receive(:domains).and_return(
-            'example.org' => {
-                'skip_query_params' => []
-            }
+          'example.org' => {
+            'skip_query_params' => []
+          }
         )
 
         allow(@configuration).to receive(:windows_compatibility?).and_return(true)
@@ -118,28 +118,28 @@ describe TShield::RequestVCR do
         file_double = double
 
         allow(File).to receive(:join)
-                           .with('./requests/example.org', '%3fparam=value')
-                           .and_return('./requests/example.org/%3fparam=value')
+          .with('./requests/example.org', '%3fparam=value')
+          .and_return('./requests/example.org/%3fparam=value')
         allow(File).to receive(:join)
-                           .with('./requests/example.org/%3fparam=value', 'get')
-                           .and_return('./requests/example.org/%3fparam=value/get')
+          .with('./requests/example.org/%3fparam=value', 'get')
+          .and_return('./requests/example.org/%3fparam=value/get')
         allow(File).to receive(:join)
-                           .with('./requests/example.org/%3fparam=value/get', '0')
-                           .and_return('./requests/example.org/%3fparam=value/get/0')
+          .with('./requests/example.org/%3fparam=value/get', '0')
+          .and_return('./requests/example.org/%3fparam=value/get/0')
 
         allow(file_double).to receive(:read).and_return('{}')
 
         expect(File).to receive('open')
-                            .with('./requests/example.org/%3fparam=value/get/0.content', 'w')
-                            .and_return(file_double)
+          .with('./requests/example.org/%3fparam=value/get/0.content', 'w')
+          .and_return(file_double)
 
         expect(File).to receive('open')
-                            .with('./requests/example.org/%3fparam=value/get/0.json', 'w')
-                            .and_return(file_double)
+          .with('./requests/example.org/%3fparam=value/get/0.json', 'w')
+          .and_return(file_double)
 
         expect(file_double).to receive(:write).ordered.with('this is the body')
         expect(file_double).to receive(:write)
-                                   .with("{\n  \"status\": 200,\n  \"headers\": {\n  }\n}")
+          .with("{\n  \"status\": 200,\n  \"headers\": {\n  }\n}")
         expect(file_double).to receive(:close)
         expect(file_double).to receive(:close)
 
@@ -148,7 +148,6 @@ describe TShield::RequestVCR do
                                 method: 'GET',
                                 call: 0
       end
-
     end
   end
 
@@ -161,7 +160,7 @@ describe TShield::RequestVCR do
       'this is the body'
     end
 
-    def get_fields(field = "")
+    def get_fields(_field = '')
       []
     end
 
@@ -172,22 +171,19 @@ describe TShield::RequestVCR do
 
   class RawResponseCookiesMultipleValues
     def headers
-     {'Set-Cookie' => ['FirstCookie=An Value', 'SecondCookie=An Value']}
+      { 'Set-Cookie' => ['FirstCookie=An Value', 'SecondCookie=An Value'] }
     end
 
     def body
       'this is the body'
     end
 
-    def get_fields(field = "")
-      self.headers[filed] unless self.headers.key?(field)
+    def get_fields(field = '')
+      headers[filed] unless headers.key?(field)
     end
 
     def code
       200
     end
   end
-
 end
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tshield
 version: !ruby/object:Gem::Version
-  version: 0.13.5.0
+  version: 0.14.0.0
 platform: ruby
 authors:
 - Diego Rubin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -415,6 +415,7 @@ files:
 - lib/tshield/errors.rb
 - lib/tshield/extensions/string_extensions.rb
 - lib/tshield/grpc.rb
+- lib/tshield/grpc/grpc_counter.rb
 - lib/tshield/grpc/vcr.rb
 - lib/tshield/logger.rb
 - lib/tshield/matching/filters.rb
@@ -467,19 +468,19 @@ signing_key:
 specification_version: 4
 summary: Proxy for mocks API responses
 test_files:
-- spec/tshield/controllers/requests_spec.rb
+- spec/spec_helper.rb
+- spec/tshield/request_matching_spec.rb
+- spec/tshield/sessions_spec.rb
+- spec/tshield/request_vcr_spec.rb
 - spec/tshield/after_filter_spec.rb
-- spec/tshield/configuration_spec.rb
-- spec/tshield/fixtures/proto/test_services_pb.rb
+- spec/tshield/grpc_spec.rb
+- spec/tshield/options_spec.rb
 - spec/tshield/fixtures/config/tshield-without-grpc.yml
 - spec/tshield/fixtures/config/tshield-with-send-content-type-header_as_false.yml
-- spec/tshield/fixtures/config/tshield.yml
 - spec/tshield/fixtures/config/tshield-with-send-content-type-header.yml
+- spec/tshield/fixtures/config/tshield.yml
+- spec/tshield/fixtures/proto/test_services_pb.rb
 - spec/tshield/fixtures/matching/example.json
 - spec/tshield/fixtures/filters/example_filter.rb
-- spec/tshield/request_vcr_spec.rb
-- spec/tshield/sessions_spec.rb
-- spec/tshield/grpc_spec.rb
-- spec/tshield/options_spec.rb
-- spec/tshield/request_matching_spec.rb
-- spec/spec_helper.rb
+- spec/tshield/controllers/requests_spec.rb
+- spec/tshield/configuration_spec.rb