webspicy 0.16.3 → 0.20.1

data/lib/webspicy/tester/result.rb

@@ -0,0 +1,142 @@
+module Webspicy
+  class Tester
+    class Result
+      extend Forwardable
+
+      def initialize(tester)
+        @tester = tester
+        @scope = tester.scope
+        @client = tester.client
+        @specification = tester.specification
+        @service = tester.service
+        @test_case = tester.test_case
+        @invocation = tester.invocation
+        @assertions = []
+        @failures = []
+        @errors = []
+        if @invocation
+          check!
+        else
+          @errors << [InvocationSuceeded.new(self), tester.invocation_error]
+        end
+      end
+      attr_reader :tester, :scope, :client
+      attr_reader :specification, :service, :test_case, :invocation
+      attr_reader :assertions, :failures, :errors
+
+      def_delegators :@tester, *[
+        :config,
+        :reporter
+      ]
+
+      def self.from(tester)
+        new(tester)
+      end
+
+      def success?
+        failures.empty? && errors.empty?
+      end
+
+      def failure?
+        errors.empty? && !failures.empty?
+      end
+
+      def error?
+        !errors.empty?
+      end
+
+      def assertions_count
+        assertions.size
+      end
+
+      def failures_count
+        failures.size
+      end
+
+      def errors_count
+        errors.size
+      end
+
+    private
+
+      def check!
+        check_response!
+        check_output! if success? && test_case.example?
+        check_error! if success? && test_case.counterexample?
+        check_assertions! if success?
+        check_postconditions! if success? && test_case.example?
+        check_errconditions! if success? && test_case.counterexample?
+      end
+
+    private
+
+      def check_response!
+        check_one! Result::ResponseStatusMet
+        if ect = test_case.expected_content_type
+          check_one! Result::ResponseHeaderMet.new(self, "Content-Type", ect, :start_with)
+        end
+        test_case.expected_headers.each_pair do |k,v|
+          check_one! Result::ResponseHeaderMet.new(self, k, v)
+        end
+      end
+
+      def check_output!
+        check_one! Result::OutputSchemaMet
+      end
+
+      def check_error!
+        check_one! Result::ErrorSchemaMet
+      end
+
+      def check_assertions!
+        test_case.assert.each do |a|
+          check_one! Result::AssertMet.new(self, a)
+        end
+      end
+
+      def check_postconditions!
+        service.postconditions.each do |c|
+          check_one! Result::PostconditionMet.new(self, c.bind(tester))
+        end
+      end
+
+      def check_errconditions!
+        service.errconditions.each do |c|
+          check_one! Result::ErrconditionMet.new(self, c.bind(tester))
+        end
+      end
+
+      def check_one!(check)
+        if check.is_a?(Class)
+          check_one!(check.new(self))
+        else
+          return unless check.must?
+          begin
+            check.call
+            reporter.check_success(check)
+          rescue *PASSTHROUGH_EXCEPTIONS
+            raise
+          rescue Failure => e
+            self.failures << [check, e]
+            reporter.check_failure(check, e)
+          rescue Exception => e
+            self.errors << [check, e]
+            reporter.check_error(check, e)
+          ensure
+            self.assertions << check
+          end
+        end
+      end
+
+    end # class Result
+  end # class Tester
+end # module Webspicy
+require_relative "result/check"
+require_relative "result/invocation_succeeded"
+require_relative "result/response_status_met"
+require_relative "result/response_header_met"
+require_relative "result/output_schema_met"
+require_relative "result/error_schema_met"
+require_relative "result/assert_met"
+require_relative "result/postcondition_met"
+require_relative "result/errcondition_met"

data/lib/webspicy/tester/result/assert_met.rb

@@ -0,0 +1,29 @@
+module Webspicy
+  class Tester
+    class Result
+      class AssertMet < Check
+
+        def initialize(result, assertion)
+          super(result)
+          @assertion = assertion
+        end
+        attr_reader :assertion
+
+        def behavior
+          "Assert #{assertion}"
+        end
+
+        def must?
+          true
+        end
+
+        def call
+          on = invocation.dressed_body
+          asserter = Tester::Asserter.new(on)
+          asserter.instance_eval(assertion)
+        end
+
+      end # class AssertMet
+    end # class Result
+  end # class Tester
+end # module error

data/lib/webspicy/tester/result/check.rb

@@ -0,0 +1,33 @@
+module Webspicy
+  class Tester
+    class Result
+      class Check
+        extend Forwardable
+
+        def initialize(result)
+          @result = result
+        end
+        attr_reader :result
+
+        def_delegators :@result, *[
+          :config,
+          :scope,
+          :client,
+          :specification,
+          :service,
+          :test_case,
+          :invocation
+        ]
+
+        def_delegators :invocation, *[
+          :response
+        ]
+
+        def _!(msg)
+          raise Failure, msg
+        end
+
+      end # class Check
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/errcondition_met.rb

@@ -0,0 +1,29 @@
+module Webspicy
+  class Tester
+    class Result
+      class ErrconditionMet < Check
+
+        def initialize(result, post)
+          super(result)
+          @post = post
+        end
+        attr_reader :post
+
+        def behavior
+          post.to_s
+        end
+
+        def must?
+          true
+        end
+
+        def call
+          if err = post.check!
+            _! err
+          end
+        end
+
+      end # class ErrconditionMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/error_schema_met.rb

@@ -0,0 +1,25 @@
+module Webspicy
+  class Tester
+    class Result
+      class ErrorSchemaMet < Check
+
+        def behavior
+          "Error data meets the expected error schema"
+        end
+
+        def must?
+          !test_case.is_expected_status?(204)
+        end
+
+        def call
+          return unless invocation.is_structured_output?
+          output = invocation.loaded_body
+          service.error_schema.dress(output)
+        rescue Finitio::TypeError => ex
+          _! "Invalid error: #{ex.message}"
+        end
+
+      end # class ErrorSchemaMet
+    end # class Result
+  end # class Tester
+end # module error

data/lib/webspicy/tester/result/invocation_succeeded.rb

@@ -0,0 +1,13 @@
+module Webspicy
+  class Tester
+    class Result
+      class InvocationSuceeded < Check
+
+        def initialize(result)
+          super(result)
+        end
+
+      end # class InvocationSuceeded
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/output_schema_met.rb

@@ -0,0 +1,25 @@
+module Webspicy
+  class Tester
+    class Result
+      class OutputSchemaMet < Check
+
+        def behavior
+          "Its output meets the expected data schema"
+        end
+
+        def must?
+          !test_case.is_expected_status?(204)
+        end
+
+        def call
+          return unless invocation.is_structured_output?
+          output = invocation.loaded_body
+          service.output_schema.dress(output)
+        rescue Finitio::TypeError => ex
+          _! "Invalid output: #{ex.message}"
+        end
+
+      end # class OutputSchemaMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/postcondition_met.rb

@@ -0,0 +1,29 @@
+module Webspicy
+  class Tester
+    class Result
+      class PostconditionMet < Check
+
+        def initialize(result, post)
+          super(result)
+          @post = post
+        end
+        attr_reader :post
+
+        def behavior
+          post.to_s
+        end
+
+        def must?
+          true
+        end
+
+        def call
+          if err = post.check!
+            _! err
+          end
+        end
+
+      end # class PostconditionMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/response_header_met.rb

@@ -0,0 +1,43 @@
+module Webspicy
+  class Tester
+    class Result
+      class ResponseHeaderMet < Check
+
+        def initialize(result, header, expected, strategy = :eq)
+          unless [:eq, :start_with].include?(strategy)
+            raise ArgumentError, "Invalid strategy `#{strategy.inspect}`"
+          end
+          super(result)
+          @header = header
+          @expected = expected
+          @strategy = strategy
+        end
+        attr_reader :header, :expected, :strategy
+
+        def behavior
+          "It has a `#{header}: #{expected}` response header"
+        end
+
+        def must?
+          true
+        end
+
+        def call
+          got = response.headers[header]
+          if got.nil?
+            _! "Expected response header `#{header}` to be set"
+          else
+            msg = "Expected response header `#{header}` to be `#{expected}`, got `#{got}`"
+            case strategy
+            when :eq
+              _!(msg) unless expected == got
+            when :start_with
+              _!(msg) unless got.start_with?(expected)
+            end
+          end
+        end
+
+      end # class ResponseHeaderMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/result/response_status_met.rb

@@ -0,0 +1,25 @@
+module Webspicy
+  class Tester
+    class Result
+      class ResponseStatusMet < Check
+
+        def behavior
+          "It has a %d response status" % [ test_case.expected_status ]
+        end
+
+        def must?
+          test_case.has_expected_status?
+        end
+
+        def call
+          actual = response.status
+          expected = test_case.expected_status
+          unless expected === actual
+            _!("Expected response status to be #{expected}, got #{actual}")
+          end
+        end
+
+      end # class ResponseStatusMet
+    end # class Result
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 16
-    TINY  = 3
+    MINOR = 20
+    TINY  = 1
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/lib/webspicy/web.rb

@@ -0,0 +1,4 @@
+require_relative 'web/client'
+require_relative 'web/invocation'
+require_relative 'web/mocker'
+require_relative 'web/openapi'

data/lib/webspicy/web/client.rb

@@ -0,0 +1,15 @@
+module Webspicy
+  module Web
+    class Client < Tester::Client
+
+      def call(test_case)
+        response = _call(test_case)
+        Invocation.new(test_case, response, self)
+      end
+
+    end # class Client
+  end # module Web
+end # module Webspicy
+require_relative 'client/support'
+require_relative 'client/http_client'
+require_relative 'client/rack_test_client'

data/lib/webspicy/{tester → web}/client/http_client.rb

@@ -1,5 +1,5 @@
 module Webspicy
-  class Tester
+  module Web
     class HttpClient < Client
 
       class ::HTTP::Request
@@ -19,7 +19,7 @@ module Webspicy
       end
       attr_reader :api
 
-      def call(test_case)
+      def _call(test_case)
         service, specification = test_case.service, test_case.specification
 
         # Instantiate the parameters
@@ -43,11 +43,10 @@ module Webspicy
       class Api
         include Client::Support
 
-        attr_reader :last_response
-
         def initialize(scope)
           @scope = scope
         end
+        attr_reader :last_response
 
         def config
           @scope.config
@@ -57,7 +56,8 @@ module Webspicy
           info_request("OPTIONS", url, params, headers, body)
 
           params = querystring_params(params)
-          @last_response = HTTP[headers || {}].options(url, params: params)
+          http_opts = http_options(params: params)
+          @last_response = HTTP[headers || {}].options(url, http_opts)
 
           debug_response(@last_response)
 
@@ -68,7 +68,8 @@ module Webspicy
           info_request("GET", url, params, headers, body)
 
           params = querystring_params(params)
-          @last_response = HTTP[headers || {}].get(url, params: params)
+          http_opts = http_options(params: params)
+          @last_response = HTTP[headers || {}].get(url, http_opts)
 
           debug_response(@last_response)
 
@@ -85,18 +86,21 @@ module Webspicy
           case body
           when NilClass
             headers['Content-Type'] ||= 'application/json'
-            @last_response = HTTP[headers].post(url, body: params.to_json)
+            http_opts = http_options(body: params.to_json)
+            @last_response = HTTP[headers].post(url, http_opts)
           when FileUpload
             file = HTTP::FormData::File.new(body.path.to_s, {
               content_type: body.content_type,
               filename: body.path.basename.to_s
             })
-            @last_response = HTTP[headers].post(url, form: {
+            http_opts = http_options(form: {
               body.param_name.to_sym => file
             })
+            @last_response = HTTP[headers].post(url, http_opts)
           else
             headers['Content-Type'] ||= 'application/json'
-            @last_response = HTTP[headers].post(url, body: body)
+            http_opts = http_options(body: body)
+            @last_response = HTTP[headers].post(url, http_opts)
           end
 
           debug_response(@last_response)
@@ -109,7 +113,8 @@ module Webspicy
 
           headers ||= {}
           headers['Content-Type'] ||= 'application/json'
-          @last_response = HTTP[headers].patch(url, body: params.to_json)
+          http_opts = http_options(body: params.to_json)
+          @last_response = HTTP[headers].patch(url, http_opts)
 
           debug_response(@last_response)
 
@@ -121,7 +126,8 @@ module Webspicy
 
           headers ||= {}
           headers['Content-Type'] ||= 'application/json'
-          @last_response = HTTP[headers].put(url, body: params.to_json)
+          http_opts = http_options(body: params.to_json)
+          @last_response = HTTP[headers].put(url, http_opts)
 
           debug_response(@last_response)
 
@@ -131,7 +137,8 @@ module Webspicy
         def post_form(url, params = {}, headers = nil, body = nil)
           info_request("POST", url, params, headers, body)
 
-          @last_response = HTTP[headers || {}].post(url, form: params)
+          http_opts = http_options(form: params)
+          @last_response = HTTP[headers || {}].post(url, http_opts)
 
           debug_response(@last_response)
 
@@ -141,14 +148,27 @@ module Webspicy
         def delete(url, params = {}, headers = nil, body = nil)
           info_request("DELETE", url, params, headers, body)
 
-          @last_response = HTTP[headers || {}].delete(url, body: params.to_json)
+          http_opts = http_options(body: params.to_json)
+          @last_response = HTTP[headers || {}].delete(url, http_opts)
 
           debug_response(@last_response)
 
           @last_response
         end
+
+        def http_options(extra)
+          if config.insecure
+            ctx = OpenSSL::SSL::SSLContext.new
+            ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            {
+              :ssl_context => ctx
+            }.merge(extra)
+          else
+            extra
+          end
+        end
       end # class Api
 
     end # class HttpClient
-  end # class Tester
+  end # module Web
 end # module Webspicy