webspicy 0.26.0 → 0.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f65b0370d22d9ff81cb309ec916a292c7c852e25d783b11b72de21d5466772
-  data.tar.gz: be4edc16dd8809028b243687b69da34591fec591c520ad72f9a5786a8f324130
+  metadata.gz: 80a8b39983717af6c599f4ef9fbd88bacfa408dbd16089f7b559ca8de2b46e39
+  data.tar.gz: c899bfe6f59ef4aec92e897bff3cff3899103feb0ca1640132a0a79c3968b50b
 SHA512:
-  metadata.gz: 89f2301b02f83bfe3e48286854e6c51c3b55dfd588d2dc1c4f1f4f343a8cde91eccbf592d3c7516975143f743869aa26719b2d5389b318b95284c5f9239a3761
-  data.tar.gz: f63b1e52e4ae1edebe0b2e9f6aaa7360a4208f8b9fe7bc917ef19a6710d28b003bad13bcea31874935528cf428444e7548d6bc6fac42d46526fc11b84a327dba
+  metadata.gz: ba81af580827248b93f6ca3720ed845bc8010071a5311c134b8c4090b0bda65a8927298124c4cd18e8d2af9612cca55c9f1ebc25e219fac145d4c196ed8c771f
+  data.tar.gz: 1b7fa160cda6a2b8cb412b46e928104e33c14b9fba3bebdbffd47aa68b72237b02622c3656277f19441f55f2951f140732c67568499686d60bbc038440a3a529

data/lib/webspicy/configuration.rb

@@ -299,7 +299,7 @@ module Webspicy
     # truthy value is returned will be considered by the scope.
     # - ===: any instance responding to `===` can be used as a matcher, following
     #   Ruby conventions. The match is done on a Service instance.
-    def test_case_filter=(tag_filter)
+    def test_case_filter=(test_case_filter)
       @test_case_filter = test_case_filter
     end
     attr_reader :test_case_filter

data/lib/webspicy/specification/post/missing_condition_impl.rb

@@ -2,6 +2,7 @@ module Webspicy
   class Specification
     module Postcondition
       class MissingConditionImpl
+        include Pre
         include Post
 
         def check!

data/lib/webspicy/specification/post/unexpected_condition_impl.rb

@@ -2,6 +2,7 @@ module Webspicy
   class Specification
     module Postcondition
       class UnexpectedConditionImpl
+        include Pre
         include Post
 
         def check!

data/lib/webspicy/specification/service.rb

@@ -149,7 +149,7 @@ module Webspicy
               mc.matching_description = d
             }
           }
-        mapped + unmapped + unexpected
+        instances + unmapped + unexpected
       end
 
       def bind_examples

data/lib/webspicy/support/deep_merge.rb

@@ -1,49 +1,69 @@
 module Webspicy
   module Support
     class DeepMerge
-      class << self
 
-        def symbolize_keys(arg)
-          case arg
-          when Hash
-            arg.each_pair.each_with_object({}){|(k,v),memo|
-              memo[k.to_sym] = symbolize_keys(v)
-            }
-          when Array
-            arg.map{|item| symbolize_keys(item) }
-          else
-            arg
-          end
-        end
+      DEFAULT_OPTIONS = {
+        uniq_on_arrays: false
+      }
+
+      def initialize(options = {})
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def self.deep_merge(*args, &bl)
+        new.deep_merge(*args, &bl)
+      end
+
+      def self.deep_dup(*args, &bl)
+        new.deep_dup(*args, &bl)
+      end
+
+      def self.symbolize_keys(*args, &bl)
+        new.symbolize_keys(*args, &bl)
+      end
 
-        def deep_merge(h1, h2)
-          merge_maps(deep_dup(h1), deep_dup(h2))
+      def symbolize_keys(arg)
+        case arg
+        when Hash
+          arg.each_pair.each_with_object({}){|(k,v),memo|
+            memo[k.to_sym] = symbolize_keys(v)
+          }
+        when Array
+          arg.map{|item| symbolize_keys(item) }
+        else
+          arg
         end
+      end
 
-        def deep_dup(x)
-          case x
-          when Array
-            x.map{|y| deep_dup(y) }
-          when Hash
-            x.each_with_object({}){|(k,v),memo| memo[k] = deep_dup(v) }
-          else
-            x
-          end
+      def deep_merge(h1, h2)
+        merge_maps(deep_dup(h1), deep_dup(h2))
+      end
+
+      def deep_dup(x)
+        case x
+        when Array
+          x.map{|y| deep_dup(y) }
+        when Hash
+          x.each_with_object({}){|(k,v),memo| memo[k] = deep_dup(v) }
+        else
+          x
         end
+      end
 
-        private
+    private
 
-        def merge_maps(h1, h2)
-          h1.merge(h2) do |k,v1,v2|
-            case v1
-            when Hash  then merge_maps(v1, v2)
-            when Array then v1 + v2
-            else v2
-            end
+      def merge_maps(h1, h2)
+        h1.merge(h2) do |k,v1,v2|
+          case v1
+          when Hash
+            merge_maps(v1, v2)
+          when Array
+            @options[:uniq_on_arrays] ? (v1 + v2).uniq : v1 + v2
+          else v2
           end
         end
-
       end
+
     end
   end
 end

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

@@ -12,8 +12,11 @@ module Webspicy
         end
 
         def call
-          return unless invocation.is_structured_output?
-          output = invocation.loaded_body
+          output = if invocation.is_structured_output?
+            invocation.loaded_body
+          else
+            invocation.raw_output
+          end
           service.error_schema.dress(output)
         rescue Finitio::TypeError => ex
           _! "Invalid error: #{ex.message}"

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

@@ -12,8 +12,11 @@ module Webspicy
         end
 
         def call
-          return unless invocation.is_structured_output?
-          output = invocation.loaded_body
+          output = if invocation.is_structured_output?
+            invocation.loaded_body
+          else
+            invocation.raw_output
+          end
           service.output_schema.dress(output)
         rescue Finitio::TypeError => ex
           _! "Invalid output: #{ex.message}"

data/lib/webspicy/tester.rb

@@ -65,7 +65,11 @@ module Webspicy
         raise Error, "No such service `#{method} #{url}`"
       end
       mutated = tc.mutate(mutation)
-      fork_tester(test_case: mutated) do |t|
+      call_one(mutated)
+    end
+
+    def call_one(test_case)
+      fork_tester(test_case: test_case) do |t|
         instrumented = t.instrument_test_case
         t.client.call(instrumented)
       end

data/lib/webspicy/version.rb

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

data/lib/webspicy/web/formaldoc.fio

@@ -11,10 +11,16 @@ FileUpload =
         param_name   :? String
     }
 
+OpenApi = {
+    tag     :? String
+    summary :? String
+}
+
 Specification = .Webspicy::Web::Specification
   <info> {
     name: String
     url: String
+    openapi :? OpenApi
     services: [Service]
   }
   <singleservice> {
@@ -22,6 +28,7 @@ Specification = .Webspicy::Web::Specification
     url             :  String
     method          :  Method
     description     :  String
+    openapi         :? OpenApi
     preconditions   :? [String]|String
     postconditions  :? [String]|String
     errconditions   :? [String]|String
@@ -39,6 +46,7 @@ Service =
         name            :? String
         method          :  Method
         description     :  String
+        openapi         :? OpenApi
         preconditions   :? [String]|String
         postconditions  :? [String]|String
         errconditions   :? [String]|String
@@ -51,8 +59,30 @@ Service =
         counterexamples :? [TestCase]
     }
 
-TestCase =
-    .Webspicy::Web::Specification::TestCase <info> {
+TestCase = .Webspicy::Web::Specification::TestCase
+    <v2> {
+        for              :? String
+        when             :? String
+        it               :? String
+        description      :? String
+        validate_input   :? Boolean
+        input            :? Params
+        headers          :? .Hash
+        body             :? String
+        file_upload      :? FileUpload
+        seeds            :? String
+        requester        :? String
+        metadata         :? { ...: .Object }
+        expected         :? {
+            status       :? StatusRange
+            content_type :? String|Nil
+            error        :? String
+            headers      :? .Hash
+        }
+        assert           :? [String]
+        tags             :? [Tag]
+    }
+    <info> {
         description      :? String
         dress_params     :? Boolean
         params           :? Params

data/lib/webspicy/web/openapi/data_struct.rb

@@ -0,0 +1,40 @@
+module Webspicy
+  module Web
+    module Openapi
+      class DataStruct
+
+        MERGER = Support::DeepMerge.new({
+          uniq_on_arrays: true
+        })
+
+        def initialize
+          @info = {}
+          @tags = []
+          @paths = {}
+        end
+        attr_reader :info, :tags, :paths
+
+        def ensure_tags(tags)
+          @tags = (@tags + tags).uniq.sort_by{|t| t[:name] }
+        end
+
+        def ensure_path(path)
+          @paths = MERGER.deep_merge(
+            @paths,
+            path,
+          )
+        end
+
+        def to_openapi_data
+          {
+            "openapi" => '3.0.2',
+            "info" => info,
+            "tags" => tags,
+            "paths" => paths,
+          }
+        end
+
+      end # class DataStruct
+    end # module Openapi
+  end # module Web
+end # module Webspicy

data/lib/webspicy/web/openapi/reporter.rb

@@ -0,0 +1,36 @@
+module Webspicy
+  module Web
+    module Openapi
+      class Reporter < Webspicy::Tester::Reporter
+        include Utils
+
+        def initialize(base, output_file)
+          @base = base
+          @output_file = output_file
+        end
+
+        def before_all
+          @datastruct = DataStruct.new
+        end
+
+        def after_each
+          @datastruct.ensure_tags(tags_for(specification))
+          @datastruct.ensure_path(base_path_for(specification))
+          @datastruct.ensure_path(base_verb_for(service))
+          @datastruct.ensure_path(base_request_body_for(service))
+          @datastruct.ensure_path(base_request_example_for(test_case))
+          @datastruct.ensure_path(base_request_response_for(invocation))
+        end
+
+        def report
+          json = Support::DeepMerge.deep_merge(
+            @base,
+            @datastruct.to_openapi_data,
+          )
+          @output_file.write(JSON.pretty_generate(json))
+        end
+
+      end # class Reporter
+    end # class OpenApi
+  end # class Web
+end # module Webspicy

data/lib/webspicy/web/openapi/utils.rb

@@ -0,0 +1,210 @@
+module Webspicy
+  module Web
+    module Openapi
+      module Utils
+
+        def into_specification_path(specification, x)
+          {
+            standardize(specification.url) => x.compact,
+          }
+        end
+
+        def into_service_verb(service, x)
+          verb = downcase_verb(service)
+          into_specification_path(service.specification, {
+            verb => x.compact,
+          })
+        end
+
+        def into_service_request_body(service, x)
+          into_service_verb(service, {
+            requestBody: x.compact,
+          })
+        end
+
+        def into_service_responses(service, x)
+          into_service_verb(service, {
+            responses: x.compact,
+          })
+        end
+
+        ###
+
+        def base_path_for(specification)
+          into_specification_path(specification, {
+            summary: specification.name.to_s || 'API Specification'
+          })
+        end
+
+        def base_verb_for(service)
+          verb_defn = {
+            summary: service.name,
+            description: service.description,
+            tags: tags_for(service.specification).map{|s| s[:name] },
+            parameters: parameters_for(service),
+          }
+
+          verb_defn = service.conditions.inject(verb_defn) do |memo, p|
+            if p.respond_to?(:contribute_to_openapi_verb)
+              p.contribute_to_openapi_verb(memo)
+            else
+              memo
+            end
+          end
+
+          into_service_verb(service, verb_defn)
+        end
+
+        def extract_request_body_info_for(service)
+          verb = downcase_verb(service)
+          return nil if ['get', 'options', 'head'].include?(verb)
+
+          schema = actual_body_schema(service)
+          return nil if empty_schema?(schema)
+          puts schema.inspect
+
+          content_type = content_type_for(service)
+
+          [schema, content_type]
+        end
+
+        def base_request_body_for(service)
+          schema, content_type = extract_request_body_info_for(service)
+          return {} unless schema
+
+          into_service_request_body(service, {
+            required: true,
+            content: {
+              content_type => {
+                schema: schema.to_json_schema,
+              }.compact,
+            },
+          })
+        end
+
+        def base_request_example_for(test_case)
+          schema, content_type = extract_request_body_info_for(service)
+          return {} unless schema
+
+          value = test_case.params
+          in_url = service.specification.url_placeholders
+          value = value.reject{|k,v| in_url.include?(k) } if value.is_a?(Hash)
+
+          example = {
+            description: test_case.description,
+            value: value,
+          }
+
+          into_service_request_body(service, {
+            required: true,
+            content: {
+              content_type => {
+                examples: {
+                  test_case.description => example
+                }
+              }.compact,
+            },
+          })
+        end
+
+        def base_request_response_for(invocation)
+          test_case = invocation.test_case
+          service = invocation.service
+          content_type = content_type_for(service)
+          verb = downcase_verb(service)
+
+          content = nil
+          unless invocation.is_empty_response?
+            schema = actual_output_schema(test_case, false)
+            example = invocation.loaded_output
+            content = {
+              content_type => {
+                schema: schema&.to_json_schema,
+                example: example,
+              }.compact
+            }
+          end
+
+          into_service_responses(service, {
+            invocation.response_code.to_s => {
+              description: '',
+              content: content,
+            }.compact
+          })
+        end
+
+        def tags_for(specification)
+          tag = specification&.openapi&.[](:tag) || specification.name
+
+          return [] unless tag.is_a?(String)
+          return [] if tag.empty?
+
+          [{
+            name: tag.gsub(/\n/, ' ').strip
+          }]
+        end
+
+        def parameters_for(service)
+          schema = actual_input_schema(service)
+          params = service.specification.url_placeholders.map{|p|
+            {
+              in: 'path',
+              name: p,
+              schema: { type: 'string' },
+              required: true
+            }
+          }
+          params.empty? ? nil : params
+        end
+
+        def actual_output_schema(test_case, counterexample)
+          if counterexample
+            test_case.service.error_schema['Main']
+          else
+            test_case.service.output_schema['Main']
+          end
+        end
+
+        def actual_input_schema(service)
+          service.input_schema['Main']
+        end
+
+        def actual_body_schema(service)
+          schema = actual_input_schema(service)
+
+          a_schema = schema
+          a_schema = schema.target if schema.is_a?(Finitio::AliasType)
+          return schema unless a_schema.is_a?(Finitio::HashBasedType)
+
+          in_url = service.specification.url_placeholders.map(&:to_sym)
+          return schema if in_url.empty?
+
+          a_schema.allbut(in_url)
+        end
+
+        def standardize(url)
+          url = url.gsub(/\/$/, '') if url =~ /\/$/
+          url
+        end
+
+        def downcase_verb(service)
+          service.method.downcase.gsub(/_form$/, '')
+        end
+
+        def content_type_for(service)
+          if service.method.downcase == 'post_form'
+            'application/x-www-form-urlencoded'
+          else
+            'application/json'
+          end
+        end
+
+        def empty_schema?(schema)
+          schema = schema.target if schema.is_a?(Finitio::AliasType)
+          schema.is_a?(Finitio::HashBasedType) && schema.heading.empty?
+        end
+
+      end # module Utils
+    end # module Openapi
+  end # module Web
+end # module Webspicy

data/lib/webspicy/web/openapi.rb

@@ -1,2 +1,5 @@
+require_relative 'openapi/utils'
+require_relative 'openapi/data_struct'
+require_relative 'openapi/reporter'
 require_relative 'openapi/generator'
 require_relative 'openapi/ext'

data/lib/webspicy/web/specification/pre/global_request_headers.rb

@@ -27,7 +27,6 @@ module Webspicy
             extra = headers.reject{|k|
               test_case.headers.has_key?(k)
             }
-            puts "Instrumenting #{test_case.object_id}"
             test_case.headers.merge!(extra)
           end
 

data/lib/webspicy/web/specification/test_case.rb

@@ -3,6 +3,24 @@ module Webspicy
     class Specification
       class TestCase < Webspicy::Specification::TestCase
 
+        def self.v2(info)
+          info = info.dup
+          if !info.has_key?(:description) && (info.has_key?(:when) || info.has_key?(:it))
+            info[:description] = "when #{info[:when]}" if info.has_key?(:when)
+            info[:description] << ", it #{info[:it]}" if info.has_key?(:it)
+            info.delete_if{|k,v| k == :when || k == :it }
+          end
+          if !info.has_key?(:dress_params) && info.has_key?(:validate_input)
+            info[:dress_params] = info[:validate_input]
+            info.delete(:validate_input)
+          end
+          if !info.has_key?(:params) && info.has_key?(:input)
+            info[:params] = info[:input]
+            info.delete(:input)
+          end
+          new(info)
+        end
+
         def headers
           @raw[:headers] ||= {}
         end
@@ -52,6 +70,20 @@ module Webspicy
           !expected_headers.empty?
         end
 
+        def to_v2
+          info = to_info
+          info = info.merge({
+            validate_input: !!info[:dress_params],
+            input: info[:params] || {},
+          }).delete_if{|k,v| k == :dress_params || k == :params }
+          if info[:description] =~ /^when (.*?), it (.*)$/
+            info[:when] = $1
+            info[:it] = $2
+            info.delete(:description)
+          end
+          info
+        end
+
       end # class TestCase
     end # class Specification
   end # module Web

data/lib/webspicy/web/specification.rb

@@ -19,6 +19,10 @@ module Webspicy
         end
       end
 
+      def openapi
+        @raw[:openapi]
+      end
+
       def url
         @raw[:url]
       end

data/spec/unit/configuration/scope/test_expand_example.rb

@@ -52,7 +52,7 @@ module Webspicy
         let(:example) {
           Webspicy::Web.test_case({
             description: "Hello world",
-            expected: { content_type: "application/json" }
+            expected: { content_type: "application/json" },
           })
         }
 

data/spec/unit/web/specification/test_case/test_v2_ic.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+module Webspicy
+  module Web
+    class Specification
+      describe TestCase, "v2 information contract" do
+
+        it 'dresses fine' do
+          tc = Webspicy::Web.test_case({
+            when: "a condition",
+            it: "does something",
+            input: { foo: "bar" },
+            validate_input: false,
+          })
+          expect(tc.description).to eql("when a condition, it does something")
+          expect(tc.params).to eql({ foo: "bar" })
+          expect(tc.dress_params).to eql(false)
+        end
+
+        it 'undresses fine' do
+          tc = Webspicy::Web.test_case({
+            when: "a condition",
+            it: "does something",
+            input: { foo: "bar" },
+            validate_input: false,
+          })
+          expect(tc.to_v2).to eql({
+            when: "a condition",
+            it: "does something",
+            input: { foo: "bar" },
+            validate_input: false,
+          })
+        end
+
+        it 'keeps to_info clean' do
+          tc = Webspicy::Web.test_case({
+            when: "a condition",
+            it: "does something",
+            input: { foo: "bar" },
+            validate_input: false,
+          })
+          expect(tc.to_info).to eql({
+            description: "when a condition, it does something",
+            params: { foo: "bar" },
+            dress_params: false,
+          })
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.1
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2025-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,7 +104,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.12.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.13.0
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.12.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.13.0
@@ -399,8 +399,11 @@ files:
 - lib/webspicy/web/mocker.rb
 - lib/webspicy/web/mocker/config.ru
 - lib/webspicy/web/openapi.rb
+- lib/webspicy/web/openapi/data_struct.rb
 - lib/webspicy/web/openapi/ext.rb
 - lib/webspicy/web/openapi/generator.rb
+- lib/webspicy/web/openapi/reporter.rb
+- lib/webspicy/web/openapi/utils.rb
 - lib/webspicy/web/specification.rb
 - lib/webspicy/web/specification/file_upload.rb
 - lib/webspicy/web/specification/post.rb
@@ -441,6 +444,7 @@ files:
 - spec/unit/web/mocker/test_mocker.rb
 - spec/unit/web/openapi/test_generator.rb
 - spec/unit/web/specification/pre/test_global_request_headers.rb
+- spec/unit/web/specification/test_case/test_v2_ic.rb
 - spec/unit/web/specification/test_instantiate_url.rb
 - spec/unit/web/specification/test_url_placeholders.rb
 - tasks/gem.rake
@@ -464,7 +468,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!