tshield 0.11.13.0 → 0.11.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822edc6241a2e6d53abc32da081364b3c56c7804a76bdc5f280cf42229ab36a4
-  data.tar.gz: de7090a23614e79b2d422665e86218df7cd313c26765660422b7ce8d2c7ab081
+  metadata.gz: 36efe1ccd1ea061d66f046d338b76fcb0b9b6f30c740ecadabe6c774939dcd5b
+  data.tar.gz: 38559f053d082a577260aa94a115a66937ffb9ce45c52fee3a60339ade9ea32d
 SHA512:
-  metadata.gz: 9faf59a02b986ff0ebede6763451fb93157516b4aebe1e809043f8519a65dd9fed61b4a46e9efa57b8be63b841d3861c211cdd0c60fb1c01722c9a62eec710a4
-  data.tar.gz: c89b1ead5400a31bae4d8a06e807f3e66503e4a2314924a1dc263b7c992524791a7334cd401bbeb0ea20382ebcf8edbf9ab85ae57c62689d4057a73a8d4b3678
+  metadata.gz: ba74b2c25265ef74b62b297db19795b387c1bfe4821dce609d17cf99b00d663d58f3f889e134d58a22b679b9f1781bf00c64117fdd1e097111c7fc2cfaab5069
+  data.tar.gz: ce7f58cb6bf00a942b56464235cd8fa002c6489aa6643c057f9d201eeebafe3e57be70724f8bca03f8068a5468caf3d62caea846869305d145edca2ed4d19322

data/Gemfile

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-gem 'sinatra-cross_origin'
 gemspec

data/README.md

@@ -13,9 +13,10 @@ TShield is an open source proxy for mocks API responses.
 *   REST
 *   SOAP
 *   Session manager to separate multiple scenarios (success, error, sucess variation, ...)
+    gRPC [EXPERIMENTAL]
 *   Lightweight
 *   MIT license
-    
+
 ## Table of Contents
 
 *   [Basic Usage](#basic-usage)
@@ -26,7 +27,7 @@ TShield is an open source proxy for mocks API responses.
 *   [Features](#features)
 *   [Examples](#examples)
 *   [Contributing](#contributing)
-    
+
 ## Basic Usage
 ### Install
 
@@ -37,7 +38,7 @@ TShield is an open source proxy for mocks API responses.
 To run server execute this command
 
     tshield
-    
+
 Default port is `4567`
 
 #### Command Line Options
@@ -102,7 +103,7 @@ To register stub into a session create an object with following attributes:
 *   **session**: name of session.
 *   **stubs**: an array with objects described above.
 
-### Example of matching configuration
+### Example of HTTP matching configuration
 
 ```json
 [
@@ -163,7 +164,7 @@ To register stub into a session create an object with following attributes:
 ]
 ```
 
-## Config options for VCR
+## Config options for HTTP VCR
 ```yaml
 request:
   timeout: 8
@@ -227,7 +228,7 @@ You can use TShield sessions to separate multiple scenarios for your mocks
 By default TShield save request/response into 
 
     requests/<<domain_name>>/<<resource_with_param>>/<<http_verb>>/<<index_based.content and json>>
-    
+
 If you start a session a folder with de **session_name** will be placed between **"requests/"** and **"<<domain_name>>"**
 
 ### Start TShield session
@@ -249,6 +250,36 @@ _DELETE_ to http://localhost:4567/sessions
 curl -X DELETE \
   http://localhost:4567/sessions
 ```
+## [Experimental] Config options for gRPC
+
+```yaml
+grpc:
+  port: 5678
+  proto_dir: 'proto'
+  services:
+    'helloworld_services_pb': 
+      module: 'Helloworld::Greeter'
+      hostname: '0.0.0.0:50051'
+```
+
+
+### Not Implemented Yet 
+
+- Sessions
+- Matching
+
+### Configuration
+
+First, generate ruby files from proto files. Use `grpc_tools_ruby_protoc`
+present in the gem `grpc-tools`. Example:
+
+`grpc_tools_ruby_protoc -I proto --ruby_out=proto --grpc_out=proto proto/<INPUT>.proto`
+
+Call example in component_tests using [grpcurl](https://github.com/fullstorydev/grpcurl):
+
+`grpcurl -plaintext -import-path component_tests/proto -proto helloworld.proto  -d '{"name": "teste"}' localhost:5678 helloworld.Greeter/SayHello`
+
+### Using in VCR mode
 
 ## Custom controllers
 

data/Rakefile

@@ -32,5 +32,5 @@ end
 
 task :server do
   $LOAD_PATH.unshift File.dirname('./lib/tshield.rb')
-  exec 'bin/tshield'
+  Thread.new { exec 'bin/tshield' }
 end

data/bin/tshield

@@ -5,14 +5,6 @@ require 'tshield/options'
 TShield::Options.init
 
 require 'tshield'
-tshield = Thread.new { TShield::Server.run! }
 
-configuration = TShield::Configuration.load_configuration
-(configuration.tcp_servers || []).each do |tcp_server|
-  puts "initializing #{tcp_server['name']}"
-  require "./servers/#{tcp_server['file']}"
-  klass = Object.const_get(tcp_server['name'])
-  Thread.new { klass.new.listen(tcp_server['port']) }
-end
-
-tshield.join
+Thread.new { TShield::Grpc.run! }
+TShield::Server.run!

data/config/tshield.yml

@@ -1,4 +1,11 @@
 ---
+grpc:
+  port: 5678
+  proto_dir: 'proto'
+  services:
+    'helloworld_services_pb': 
+      module: 'Helloworld::Greeter'
+      hostname: '0.0.0.0:50051'
 request:
   timeout: 10
 domains:

data/lib/tshield.rb

@@ -2,8 +2,8 @@
 
 require 'tshield/extensions/string_extensions'
 require 'tshield/options'
-require 'tshield/simple_tcp_server'
 require 'tshield/server'
+require 'tshield/grpc'
 
 # TShield: API mocks for development and testing
 module TShield

data/lib/tshield/configuration.rb

@@ -103,6 +103,11 @@ module TShield
       session_path || '/sessions'
     end
 
+    def grpc
+      defaults = { 'port' => 5678, 'proto_dir' => 'proto', 'services' => {} }
+      defaults.merge(@grpc || {})
+    end
+
     def self.get_url_for_domain_by_path(path, config)
       config['paths'].select { |pattern| path =~ Regexp.new(pattern) }[0]
     end

data/lib/tshield/extensions/string_extensions.rb

@@ -5,6 +5,14 @@ module StringExtensions
   def to_rack_name
     "HTTP_#{upcase.tr('-', '_')}"
   end
+
+  def underscore
+    gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
+  end
 end
 
 String.include StringExtensions

data/lib/tshield/grpc.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: false
+
+require 'grpc'
+
+require 'tshield/configuration'
+require 'tshield/grpc/vcr'
+
+module TShield
+  module Grpc
+    module RequestHandler
+      include TShield::Grpc::VCR
+      def handler(method_name, request, parameters)
+        options = self.class.options
+        handler_in_vcr_mode(method_name, request, parameters, options)
+      end
+    end
+    def self.run!
+      @configuration = TShield::Configuration.singleton.grpc
+
+      lib_dir = File.join(Dir.pwd, @configuration['proto_dir'])
+      $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+      TShield.logger.info("loading proto files from #{lib_dir}")
+
+      bind = "0.0.0.0:#{@configuration['port']}"
+      TShield.logger.info("Starting gRPC server in #{bind}")
+
+      server = GRPC::RpcServer.new
+      server.add_http2_port(bind, :this_port_is_insecure)
+
+      services = load_services(@configuration['services'])
+      services.each do |class_service|
+        class_service.include RequestHandler
+        server.handle(class_service)
+      end
+
+      server.run_till_terminated_or_interrupted([1, 'int', 'SIGQUIT']) unless services.empty?
+    end
+
+    def self.load_services(services)
+      handlers = []
+      number_of_handlers = 0
+      services.each do |file, options|
+        require file
+
+        base = Object.const_get("#{options['module']}::Service")
+        number_of_handlers += 1
+
+        implementation = build_handler(base, base.rpc_descs, number_of_handlers, options)
+        handlers << implementation
+      end
+      handlers
+    end
+
+    def self.build_handler(base, descriptions, number_of_handlers, options)
+      handler = Class.new(base) do
+        class << self
+          attr_writer :options
+          attr_reader :options
+        end
+        descriptions.each do |service_name, description|
+          puts description
+          method_name = service_name.to_s.underscore.to_sym
+          define_method(method_name) do |request, parameters|
+            handler(__method__, request, parameters)
+          end
+        end
+      end
+      handler.options = options
+      TShield::Grpc.const_set "GrpcService#{number_of_handlers}", handler
+    end
+  end
+end

data/lib/tshield/grpc/vcr.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'tshield/sessions'
+
+module TShield
+  module Grpc
+    module VCR
+      def handler_in_vcr_mode(method_name, request, parameters, options)
+        parameters.peer =~ /\[(.+?)\]/
+        @session = TShield::Sessions.current(Regexp.last_match(1))
+
+        TShield.logger.info("grpc using session #{@session || 'default'}")
+        module_name = options['module']
+
+        path = create_destiny(module_name, method_name, request)
+        response = saved_response(path)
+        if response
+          TShield.logger.info("returning saved response for request #{request.to_json} saved into #{hexdigest(request)}")
+          return response
+        end
+
+        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_request_and_response(path, request, response)
+        response
+      end
+
+      def saved_response(path)
+        response_file = File.join(path, '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
+        Kernel.const_get(response_class).new(content)
+      end
+
+      def save_request_and_response(path, request, response)
+        save_request(path, request)
+        save_response(path, response)
+      end
+
+      def save_request(path, request)
+        file = File.open(File.join(path, 'original_request'), 'w')
+        file.puts request.to_json
+        file.close
+      end
+
+      def save_response(path, response)
+        file = File.open(File.join(path, 'response'), 'w')
+        file.puts response.to_json
+        file.close
+
+        response_class = File.open(File.join(path, 'response_class'), 'w')
+        response_class.puts response.class.to_s
+        response_class.close
+      end
+
+      def complete_path(module_name, method_name, request)
+        @session_name = (@session || {})[:name]
+        path = ['requests', 'grpc', @session_name, module_name, method_name.to_s, hexdigest(request)].compact
+        path
+      end
+
+      def create_destiny(module_name, method_name, request)
+        current_path = []
+
+        path = complete_path(module_name, method_name, request)
+        TShield.logger.info("using path #{path}")
+        path.each do |path|
+          current_path << path
+          destiny = File.join current_path
+          Dir.mkdir destiny unless File.exist? destiny
+        end
+        path
+      end
+
+      def hexdigest(request)
+        Digest::SHA1.hexdigest request.to_json
+      end
+    end
+  end
+end

data/lib/tshield/server.rb

@@ -17,6 +17,7 @@ module TShield
     set :views, File.join(File.dirname(__FILE__), 'views')
     set :bind, '0.0.0.0'
     set :port, TShield::Options.instance.port
+    set :server, :puma
 
     configure do
       enable :cross_origin
@@ -56,7 +57,6 @@ module TShield
 
     def self.run!
       register_resources
-      require 'byebug'
       super
     end
   end

data/lib/tshield/version.rb

@@ -5,7 +5,7 @@ module TShield
   class Version
     MAJOR = 0
     MINOR = 11
-    PATCH = 13
+    PATCH = 18
     PRE = 0
 
     class << self

data/spec/spec_helper.rb

@@ -15,9 +15,4 @@ require 'webmock/rspec'
 require 'tshield/extensions/string_extensions'
 
 RSpec.configure do |config|
-  config.before(:each) do
-    allow(File).to receive(:join).and_return(
-      'spec/tshield/fixtures/config/tshield.yml'
-    )
-  end
 end

data/spec/tshield/configuration_spec.rb

@@ -35,6 +35,12 @@ describe TShield::Configuration do
         )
       end
 
+      context 'on grpc configuration' do
+        it 'recover server port' do
+          expect(@configuration.grpc['port']).to(eq(5678))
+        end
+      end
+
       context 'on load filters' do
         it 'recover filters for a domain' do
           expect(@configuration.get_filters('example.org')).to eq([ExampleFilter])
@@ -72,4 +78,17 @@ describe TShield::Configuration do
       expect { TShield::Configuration.singleton }.to raise_error RuntimeError
     end
   end
+
+  context 'on config exists without grpc entry' do
+    before :each do
+      options_instance = double
+      allow(options_instance).to receive(:configuration_file)
+        .and_return('spec/tshield/fixtures/config/tshield-without-grpc.yml')
+      allow(TShield::Options).to receive(:instance).and_return(options_instance)
+      @configuration = TShield::Configuration.singleton
+    end
+    it 'should set default value for port' do
+      expect(@configuration.grpc).to eql('port' => 5678, 'proto_dir' => 'proto', 'services' => {})
+    end
+  end
 end

data/spec/tshield/fixtures/config/tshield-without-grpc.yml

@@ -0,0 +1,17 @@
+---
+request:
+  timeout: 0
+domains:
+  'example.org':
+    name: 'example.org'
+    filters:
+      - 'ExampleFilter'
+    paths:
+      - '/api/one'
+      - '/api/two'
+    skip_query_params:
+      - 'a'
+  'example.com':
+    name: 'example.com'
+    paths:
+      - '/api/three'

data/spec/tshield/fixtures/config/tshield.yml

@@ -1,4 +1,6 @@
 ---
+grpc:
+  port: 5678
 request:
   timeout: 0
 domains:

data/spec/tshield/fixtures/proto/test_services_pb.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TestServices
+  class Service
+    def self.rpc_descs
+      { 'ServiceMethod' => {} }
+    end
+  end
+
+  class Stub
+    def initialize(attributes, options = {}); end
+  end
+end

data/spec/tshield/grpc_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'tshield/grpc'
+
+describe TShield::Grpc do
+  context 'on load services' do
+    before :each do
+      lib_dir = File.join(__dir__, 'fixtures/proto')
+      $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+      @services = {
+        'test_services_pb' => { 'module' => 'TestServices', 'hostname' => '0.0.0.0:5678' }
+      }
+    end
+
+    it 'should implement a service from options' do
+      implementation = TShield::Grpc.load_services(@services).first
+      instance = implementation.new
+      expect(instance.respond_to?(:service_method)).to be_truthy
+    end
+  end
+end

data/tshield.gemspec

@@ -25,8 +25,11 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.3'
 
   s.add_dependency('byebug', '~> 11.0', '>= 11.0.1')
+  s.add_dependency('grpc', '~> 1.28', '>= 1.28.0')
+  s.add_dependency('grpc-tools', '~> 1.28', '>= 1.28.0')
   s.add_dependency('httparty', '~> 0.14', '>= 0.14.0')
   s.add_dependency('json', '~> 2.0', '>= 2.0')
+  s.add_dependency('puma', '~> 4.3', '>= 4.3.3')
   s.add_dependency('sinatra', '~> 1.4', '>= 1.4.0')
   s.add_dependency('sinatra-cross_origin', '~> 0.4.0', '>= 0.4')
   s.add_development_dependency('coveralls')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tshield
 version: !ruby/object:Gem::Version
-  version: 0.11.13.0
+  version: 0.11.18.0
 platform: ruby
 authors:
 - Diego Rubin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -31,6 +31,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.1
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.28.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +111,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.3
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -367,6 +427,8 @@ files:
 - lib/tshield/controllers/sessions.rb
 - lib/tshield/counter.rb
 - lib/tshield/extensions/string_extensions.rb
+- lib/tshield/grpc.rb
+- lib/tshield/grpc/vcr.rb
 - lib/tshield/logger.rb
 - lib/tshield/matching/filters.rb
 - lib/tshield/options.rb
@@ -376,15 +438,17 @@ files:
 - lib/tshield/response.rb
 - lib/tshield/server.rb
 - lib/tshield/sessions.rb
-- lib/tshield/simple_tcp_server.rb
 - lib/tshield/version.rb
 - spec/spec_helper.rb
 - spec/tshield/after_filter_spec.rb
 - spec/tshield/configuration_spec.rb
 - spec/tshield/controllers/requests_spec.rb
+- spec/tshield/fixtures/config/tshield-without-grpc.yml
 - spec/tshield/fixtures/config/tshield.yml
 - spec/tshield/fixtures/filters/example_filter.rb
 - spec/tshield/fixtures/matching/example.json
+- spec/tshield/fixtures/proto/test_services_pb.rb
+- spec/tshield/grpc_spec.rb
 - spec/tshield/options_spec.rb
 - spec/tshield/request_matching_spec.rb
 - spec/tshield/request_vcr_spec.rb
@@ -415,11 +479,14 @@ summary: Proxy for mocks API responses
 test_files:
 - spec/spec_helper.rb
 - spec/tshield/request_matching_spec.rb
+- spec/tshield/grpc_spec.rb
 - spec/tshield/configuration_spec.rb
 - spec/tshield/request_vcr_spec.rb
 - spec/tshield/controllers/requests_spec.rb
 - spec/tshield/options_spec.rb
 - spec/tshield/after_filter_spec.rb
 - spec/tshield/fixtures/matching/example.json
+- spec/tshield/fixtures/proto/test_services_pb.rb
 - spec/tshield/fixtures/filters/example_filter.rb
 - spec/tshield/fixtures/config/tshield.yml
+- spec/tshield/fixtures/config/tshield-without-grpc.yml

data/lib/tshield/simple_tcp_server.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-
-module TShield
-  class SimpleTCPServer
-    def initialize
-      @running = true
-    end
-
-    def on_connect(_client)
-      raise 'should implement method on_connect'
-    end
-
-    def close
-      @running = false
-    end
-
-    def listen(port)
-      puts "listening #{port}"
-      @server = TCPServer.new(port)
-      while @running
-        client = @server.accept
-        on_connect(client)
-      end
-    end
-  end
-end