tshield 0.10.0.0 → 0.11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64cf908b05ea57f6314d850f0474f11e830d561f1e91db2c6b8cb9edb4fbf786
-  data.tar.gz: f2e16b6b56318a5e4cd710b24720aa87439d280a1e17bc1bacada981bc89eaff
+  metadata.gz: 618a5c8f2527911612734f7aaddd21fab7ba82066409a451ad4bd39ac42eae33
+  data.tar.gz: 4637697bcef288f4276e664adb653eaa7c6aae7b898cdf8b238ac27a8499b55c
 SHA512:
-  metadata.gz: 2d877bc07758ce22abfe127e6ea372343913b5d7f7529ad2989d9a4824901f5bbdb4036fc362af0a90142e7e83b6d1e2553e0a43d1f229b0ae1aa920f76d912c
-  data.tar.gz: fb07bdc34d9b557d2e11a071b9e0825e3bc84712240cf962643fe0fdbb687e3b7eb1abd0cec991adb7863a4dd43bc49120fa7cd5d9871033b767164b814e2f96
+  metadata.gz: a8b7d0731557762fa096a583845865817848b301b7f82c3e6ea467953d587b116ac72dce5930698051cdaf192c6ae3a1b34d501d1bb35bc32a36b265a039017b
+  data.tar.gz: 440c90f16f7ef256078a115b2f725bf94ac747375a40b01b3d33d6dab8da427a598555487e70c2568e7e6b5e0585f4b9ce6e0cf0b5e3772effeacc6ce8969620

data/README.md

@@ -25,7 +25,11 @@ To run server execute this command
     tshield
     
 Default port is **4567**
-    
+
+#### Command Line Options
+
+* __-port__: Overwrite default port (4567)
+* __-help__: Show all command line options
 
 #### Config example
 
@@ -49,7 +53,102 @@ domains:
       - /users
 ```
 
-## Config options
+## Config options for Pattern Matching
+
+An example of file to create a stub:
+
+All files should be in `matching` directory.
+Each file should be a valid JSON array of objects and each object must contain
+at least the following attributes:
+
+* __method__: a http method.
+* __path__: url path.
+* __response__: object with response data.
+
+Response must be contain the following attributes:
+
+* __headers__: key value object with expected headers to match. In the evaluation process
+  this stub will be returned if all headers are in request. 
+* __status__: integer used http status respose.
+* __body__: content to be returned.
+
+Optional request attributes:
+
+* __headers__: key value object with expected headers to match. In the evaluation process
+  this stub will be returned if all headers are in request. 
+* __query__: works like headers but use query params.
+
+__Important__: If VCR config conflicts with Matching config Matching will be
+used. Matching config have priority.
+
+### Session Configuration
+
+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
+
+```json
+[{
+    "method": "GET",
+    "path": "/matching/example",
+    "query": {
+      "user": 123
+    },
+    "response": {
+      "body": "matching-example-response-with-query",
+      "headers": {},
+      "status": 200
+    }
+  },
+  {
+    "method": "GET",
+    "path": "/matching/example",
+    "response": {
+      "body": "matching-example-response",
+      "headers": {},
+      "status": 200
+    }
+  },
+  {
+    "method": "POST",
+    "path": "/matching/example",
+    "headers": {
+      "user": "123"
+    },
+    "response": {
+      "body": "matching-example-response-with-headers",
+      "headers": {},
+      "status": 200
+    }
+  },
+  {
+    "method": "POST",
+    "path": "/matching/example",
+    "response": {
+      "body": "matching-example-response-with-post",
+      "headers": {},
+      "status": 200
+    }
+  },
+  {
+    "session": "example-session",
+    "stubs": [{
+      "method": "GET",
+      "path": "/matching/example",
+      "response": {
+        "body": "matching-example-response-in-session",
+        "headers": {},
+        "status": 200
+      }
+    }]
+  }
+]
+```
+
+## Config options for VCR
 ```yaml
 request:
   timeout: 8
@@ -167,37 +266,6 @@ This features files are used as base for the component tests.
 ## Samples
 #### Basic sample for a client app requesting a server API
 [examples/client-api-nodejs](examples/client-api-nodejs)
-#### Basic sample for componente/integration test
-**[WIP]**
-
-## Setup for local development
-
-First install dependencies.
-_We recommend use of the RVM to manage project dependencies.__
-
-```
-bundle install
-```
-
-### Run server to development
-
-To start server execute:
-
-`rake server`
-
-### Build
-
-To generate ruby gem execute:
-
-`rake build`
-
-### Test
-
-To run all unit tests:
-
-`rake spec`
-
-To run all component tests:
-
-`rake component__tests`
 
+## Contributing
+[Hacking or Contributing to Tshield](CONTRIBUTING.md)

data/config/tshield.yml

@@ -1,9 +1,11 @@
 ---
 request:
-  timeout: 8
-
+  timeout: 10
 domains:
-  'https://service.com':
-    name: 'service'
+  'http://localhost:9090':
+    name: 'components'
+    skip_query_params:
+      - b
     paths:
       - /users
+      - /resources

data/lib/tshield.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'tshield/extensions/string_extensions'
 require 'tshield/options'
 require 'tshield/simple_tcp_server'
 require 'tshield/server'

data/lib/tshield/configuration.rb

@@ -25,6 +25,8 @@ module TShield
     #                (NEED IMPROVEMENT github-issue #https://github.com/diegorubin/tshield/issues/17)
     #     not_save_headers: List of headers that should be ignored in generated
     #                       file
+    #     ignore_query_params: List of params that should be ignored in
+    #                          generated directory
     #
     attr_reader :request
     attr_reader :domains
@@ -63,7 +65,7 @@ module TShield
     end
 
     def get_headers(domain)
-      domains[domain]['headers'] || {}
+      (domains[domain] || {})['headers'] || {}
     end
 
     def get_name(domain)

data/lib/tshield/controllers/helpers/session_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TShield
+  module Controllers
+    module Helpers
+      # Session Helpers
+      module SessionHelpers
+        def self.current_session_name(request)
+          session = TShield::Sessions.current(request.ip)
+          session ? session[:name] : 'no-session'
+        end
+      end
+    end
+  end
+end

data/lib/tshield/controllers/requests.rb

@@ -2,15 +2,16 @@
 
 require 'sinatra'
 
-require 'byebug'
-
+require 'tshield/controllers/helpers/session_helpers'
 require 'tshield/options'
 require 'tshield/configuration'
-require 'tshield/request'
+require 'tshield/request_matching'
+require 'tshield/request_vcr'
 require 'tshield/sessions'
 
 module TShield
   module Controllers
+    # Requests Handler
     module Requests
       PATHP = %r{([a-zA-Z0-9/\._-]+)}.freeze
 
@@ -44,25 +45,26 @@ module TShield
         end
       end
 
+      # Requests Handler Helpers
       module Helpers
+        def self.build_headers(request)
+          headers = request.env.select { |key, _value| key =~ /HTTP/ }
+          headers['Content-Type'] = request.content_type || 'application/json'
+          headers
+        end
+
         def treat(params, request, _response)
           path = params.fetch('captures', [])[0]
 
-          debugger if TShield::Options.instance.break?(path: path, moment: :before)
-
           method = request.request_method
           request_content_type = request.content_type
-
-          headers = {
-            'Content-Type' => request.content_type || 'application/json'
-          }
-
-          add_headers(headers, path)
+          session_name = TShield::Controllers::Helpers::SessionHelpers.current_session_name(request)
 
           options = {
             method: method,
-            headers: headers,
+            headers: Helpers.build_headers(request),
             raw_query: request.env['QUERY_STRING'],
+            session: session_name,
             ip: request.ip
           }
 
@@ -73,13 +75,18 @@ module TShield
                                               replace: '')
             options[:body] = result
           end
+          api_response = TShield::RequestMatching.new(path, options).match_request
 
-          set_content_type content_type
+          unless api_response
+            add_headers(headers, path)
 
-          api_response = TShield::Request.new(path, options).response
+            api_response ||= TShield::RequestVCR.new(path, options).response
+          end
 
           logger.info(
-            "original=#{api_response.original} method=#{method} path=#{path} content-type=#{request_content_type} session=#{current_session_name(request)}"
+            "original=#{api_response.original} method=#{method} path=#{path}"\
+            "content-type=#{request_content_type}"\
+            "session=#{session_name}"
           )
 
           status api_response.status
@@ -87,17 +94,8 @@ module TShield
           body api_response.body
         end
 
-        def set_content_type(_request_content_type)
-          content_type :json
-        end
-
-        def current_session_name(request)
-          session = TShield::Sessions.current(request.ip)
-          session ? session[:name] : 'no-session'
-        end
-
         def add_headers(headers, path)
-          configuration.get_headers(domain(path)).each do |source, destiny|
+          (configuration.get_headers(domain(path)) || {}).each do |source, destiny|
             headers[destiny] = request.env[source] unless request.env[source].nil?
           end
         end

data/lib/tshield/controllers/sessions.rb

@@ -7,18 +7,31 @@ require 'tshield/sessions'
 
 module TShield
   module Controllers
+    # Actions to handle sessions
     module Sessions
       def self.registered(app)
-        app.get TShield::Configuration.singleton.session_path do
-          TShield::Sessions.current(request.ip).to_json
+        session_path = TShield::Configuration.singleton.session_path
+        ip = request.ip
+        register_get(app, session_path, ip)
+        register_post(app, session_path, ip, params)
+        register_delete(app, session_path, ip)
+      end
+
+      def self.register_get(app, session_path, ip)
+        app.get session_path do
+          TShield::Sessions.current(ip).to_json
         end
+      end
 
-        app.post TShield::Configuration.singleton.session_path do
-          TShield::Sessions.start(request.ip, params[:name]).to_json
+      def self.register_post(app, session_path, params, ip)
+        app.post session_path do
+          TShield::Sessions.start(ip, params[:name]).to_json
         end
+      end
 
-        app.delete TShield::Configuration.singleton.session_path do
-          TShield::Sessions.stop(request.ip).to_json
+      def self.register_delete(app, session_path, ip)
+        app.delete session_path do
+          TShield::Sessions.stop(ip).to_json
         end
       end
     end

data/lib/tshield/extensions/string_extensions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# String Extensions
+module StringExtensions
+  def to_rack_name
+    "HTTP_#{upcase.tr('-', '_')}"
+  end
+end
+
+String.include StringExtensions

data/lib/tshield/options.rb

@@ -23,35 +23,20 @@ module TShield
       parse unless options[:skip_parse]
     end
 
-    def break?(args = {})
-      check_breakpoint(args)
-    end
-
     def configuration_file
       @options.fetch(:configuration_file, 'config/tshield.yml')
     end
 
-    private
-
-    def check_breakpoint(args)
-      check_breakpoint_moment(args)
-    end
-
-    def check_breakpoint_moment(args)
-      @options["#{args[:moment]}_pattern".to_sym] =~ args[:path]
+    def port
+      @options.fetch(:port, 4567)
     end
 
-    def register_before_pattern(opts)
-      opts.on('-b', '--break-before-request [PATTERN]',
-              'Breakpoint before request') do |pattern|
-        @options[:before_pattern] = Regexp.new(pattern)
-      end
-    end
+    private
 
-    def register_after_pattern(opts)
-      opts.on('-a', '--break-after-request [PATTERN]',
-              'Breakpoint after request') do |pattern|
-        @options[:after_pattern] = Regexp.new(pattern)
+    def register_port(opts)
+      opts.on('-p', '--port [PORT]',
+              'Sinatra port') do |port|
+        @options[:port] = port.to_i
       end
     end
 
@@ -62,11 +47,6 @@ module TShield
       end
     end
 
-    def register_patterns(opts)
-      register_before_pattern(opts)
-      register_after_pattern(opts)
-    end
-
     def register_version(opts)
       opts.on('-v', '--version', 'Show version') do
         TShield.logger.info(TShield::Version.to_s)
@@ -90,8 +70,8 @@ module TShield
 
     def register(opts)
       register_configuration(opts)
-      register_patterns(opts)
       register_version(opts)
+      register_port(opts)
       register_help(opts)
     end
   end

data/lib/tshield/request.rb

@@ -1,166 +1,74 @@
 # frozen_string_literal: true
 
-require 'httparty'
-require 'json'
-require 'byebug'
-
-require 'digest/sha1'
-
-require 'tshield/configuration'
-require 'tshield/options'
-require 'tshield/response'
 require 'tshield/sessions'
 
 module TShield
+  # Base of request mock methods
   class Request
-    attr_reader :response
+    attr_reader :configuration
+    attr_writer :content_idx
 
-    def initialize(path, options = {})
-      @path = path
-      @options = options
+    def initialize
       @configuration = TShield::Configuration.singleton
-      @options[:timeout] = @configuration.request['timeout']
-      @options[:verify] = @configuration.request['verify_ssl']
-      request
-    end
-
-    def request
-      unless @options[:raw_query].nil? || @options[:raw_query].empty?
-        @path = "#{@path}?#{@options[:raw_query]}"
-      end
-
-      @url = "#{domain}#{@path}"
-
-      if exists
-        @response = get_current_response
-        @response.original = false
-      else
-        @method = method
-        @configuration.get_before_filters(domain).each do |filter|
-          @method, @url, @options = filter.new.filter(@method, @url, @options)
-        end
-
-        raw = HTTParty.send(@method.to_s, @url, @options)
-
-        @configuration.get_after_filters(domain).each do |filter|
-          raw = filter.new.filter(raw)
-        end
-
-        @response = save(raw)
-
-        @response.original = true
-      end
-      current_session[:counter].add(@path, method) if current_session
-      debugger if TShield::Options.instance.break?(path: @path, moment: :after)
-      @response
-    end
-
-    private
-
-    def domain
-      @domain ||= @configuration.get_domain_for(@path)
-    end
-
-    def name
-      @name ||= @configuration.get_name(domain)
-    end
-
-    def method
-      @options[:method].downcase
     end
 
-    def save(raw_response)
-      headers = {}
-      raw_response.headers.each do |k, v|
-        headers[k] = v unless @configuration.not_save_headers(domain).include? k
-      end
-
-      content = {
-        body: raw_response.body,
-        status: raw_response.code,
-        headers: headers
-      }
-
-      write(content)
-
-      TShield::Response.new(raw_response.body, headers, raw_response.code)
-    end
+    protected
 
     def current_session
       TShield::Sessions.current(@options[:ip])
     end
 
-    def content
-      return @content if @content
-
-      @content = JSON.parse(File.open(destiny).read)
-      @content['body'] = File.open(destiny(true)).read unless @content['body']
-      @content
-    end
-
-    def file_exists
+    def session_destiny(request_path)
       session = current_session
-      @content_idx = session ? session[:counter].current(@path, method) : 0
-      File.exist?(destiny)
-    end
+      return unless session
 
-    def exists
-      file_exists && @configuration.cache_request?(domain)
+      request_path = File.join(request_path, session[:name])
+      Dir.mkdir(request_path) unless File.exist?(request_path)
     end
 
-    def get_current_response
-      TShield::Response.new(content['body'], content['headers'] || [], content['status'] || 200)
+    def content_destiny
+      "#{destiny}.content"
     end
 
-    def key
-      @key ||= Digest::SHA1.hexdigest "#{@url}|#{method}"
+    def headers_destiny
+      "#{destiny}.json"
     end
 
-    def destiny(iscontent = false)
+    def destiny
       request_path = File.join('requests')
       Dir.mkdir(request_path) unless File.exist?(request_path)
 
-      session = current_session
-      if session
-        request_path = File.join(request_path, session[:name])
-        Dir.mkdir(request_path) unless File.exist?(request_path)
-      end
+      session_destiny(request_path)
 
       name_path = File.join(request_path, name)
       Dir.mkdir(name_path) unless File.exist?(name_path)
 
-      path_path = File.join(name_path, safe_dir(@path))
+      cleared_path = clear_path(@path)
+      path_path = File.join(name_path, safe_dir(cleared_path))
+
       Dir.mkdir(path_path) unless File.exist?(path_path)
 
       method_path = File.join(path_path, method)
       Dir.mkdir(method_path) unless File.exist?(method_path)
 
-      destiny_name = iscontent ? "#{@content_idx}.content" : "#{@content_idx}.json"
-      File.join(method_path, destiny_name)
+      File.join(method_path, @content_idx.to_s)
     end
 
-    def write(content)
-      f = File.open(destiny(true), 'w')
-      f.write(content[:body])
-      f.close
+    def clear_path(path)
+      skip_query_params = configuration.domains[@domain]['skip_query_params']
+      url_path, params = path.split('?')
 
-      body = content.delete :body
+      return path if !skip_query_params || !params
 
-      f = File.open(destiny, 'w')
-      f.write(JSON.pretty_generate(content))
-      f.close
+      cleared_params = params.split('&').select do |param|
+        param unless skip_query_params.include?(param.gsub(/=.*?$/, ''))
+      end.join('&')
 
-      content[:body] = body
+      [url_path, cleared_params].join('?')
     end
 
-    def safe_dir(url)
-      if url.size > 225
-        path = url.gsub(/(\?.*)/, '')
-        params = Digest::SHA1.hexdigest Regexp.last_match(1)
-        "#{path.gsub(%r{/}, '-').gsub(/^-/, '')}?#{params}"
-      else
-        url.gsub(%r{/}, '-').gsub(/^-/, '')
-      end
+    def method
+      @options[:method].downcase
     end
   end
 end