webspicy 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fba27996b7cbe7a2fa50068ee0c03e1474f1acf
-  data.tar.gz: 5c08a417338a79a18b37d529937721fe05b9ccde
+  metadata.gz: 6d78c07ceefb51e2e501878a3c7e85abd6b9497a
+  data.tar.gz: 027aec45632f053e971203a2d8b6ab5d1b20fa9b
 SHA512:
-  metadata.gz: e9e1c6f11170c2f6f8a79a4a910bf1dacc65a3f7d3df69b528f48db0062871ef5c039a7803f35771ae5c56f38f8f76ba56975d5fd5c1d27a72ace0e57800ff4e
-  data.tar.gz: 298faf4ab3202ae045921da9a005185a3779644cc951b218f4575ee6dc8d82ac12f4a29a96db375b44abcd23b48cc9874c8b34aea05f6d14a981e789a9032dcf
+  metadata.gz: ebb4af1b2860f2569c18d282b9fcf2c367b6465411f57d7c01848100118412267876f68cf520b2c537610c1435aa78d4304cefdc0f2f3c9ac09ec0b91f644937
+  data.tar.gz: b743850dc46e00e2e3e2a077e028a6d352a0c378492c34fd471346f3586e0407a309aab1dd4127ff1c5a0625bf8d189068839dbb7cab5de6443c57f6909d015a

data/examples/restful/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.11.2)
+    webspicy (0.12.0)
       finitio (~> 0.6, >= 0.6.1)
       http (~> 2)
       path (~> 1.3)

data/examples/restful/webspicy/todo/patchTodo.yml

@@ -24,6 +24,11 @@ services:
   error_schema: |-
     ErrorSchema
 
+  default_example:
+    expected:
+      content_type: application/json
+      status: 200
+
   examples:
 
     - description: |-
@@ -31,9 +36,6 @@ services:
       params:
         id: 1
         description: 'hello world'
-      expected:
-        content_type: application/json
-        status: 200
       assert:
         - "pathFD('', description: 'hello world')"
 

data/lib/webspicy/formaldoc.fio

@@ -30,13 +30,14 @@ Service =
         output_schema   :  Schema
         error_schema    :  Schema
         blackbox        :? String
+        default_example :? TestCase
         examples        :? [TestCase]
         counterexamples :? [TestCase]
     }
 
 TestCase =
     .Webspicy::Resource::Service::TestCase <info> {
-        description      : String
+        description      :? String
         dress_params     :? Boolean
         params           :? Params
         headers          :? .Hash
@@ -45,13 +46,13 @@ TestCase =
         seeds            :? String
         requester        :? String
         metadata         :? { ...: .Object }
-        expected: {
-            status       :  Integer
+        expected         :? {
+            status       :? Integer
             content_type :? String|Nil
             error        :? String
             headers      :? .Hash
         }
-        assert :? [String]
+        assert           :? [String]
     }
 
 Params = .Array|.Hash

data/lib/webspicy/resource/service/test_case.rb

@@ -53,16 +53,20 @@ module Webspicy
           file_upload ? file_upload.locate(resource) : nil
         end
 
+        def expected
+          @raw[:expected] || {}
+        end
+
         def expected_content_type
-          @raw[:expected].fetch(:content_type){ 'application/json' }
+          expected.fetch(:content_type){ 'application/json' }
         end
 
         def expected_status
-          @raw[:expected][:status]
+          expected[:status]
         end
 
         def expected_error
-          @raw[:expected][:error]
+          expected[:error]
         end
 
         def has_expected_error?
@@ -70,7 +74,7 @@ module Webspicy
         end
 
         def expected_headers
-          @raw[:expected][:headers] || {}
+          expected[:headers] || {}
         end
 
         def has_expected_headers?

data/lib/webspicy/resource/service.rb

@@ -35,6 +35,10 @@ module Webspicy
         !postconditions.empty?
       end
 
+      def default_example
+        @raw[:default_example]
+      end
+
       def examples
         @raw[:examples]
       end

data/lib/webspicy/scope.rb

@@ -47,16 +47,22 @@ module Webspicy
     end
 
     def each_example(service)
-      service.examples.each{|s| yield(s, false) }
+      service.examples.each{|e|
+        yield(expand_example(service, e), false)
+      }
     end
 
     def each_counterexamples(service, &bl)
-      service.counterexamples.each{|s| yield(s, true) } if config.run_counterexamples?
+      service.counterexamples.each{|e|
+        yield(expand_example(service, e), true)
+      } if config.run_counterexamples?
     end
 
     def each_generated_counterexamples(service, &bl)
       Webspicy.with_scope(self) do
-        service.generated_counterexamples.each{|s| yield(s, true) }
+        service.generated_counterexamples.each{|e|
+          yield(expand_example(service, e), true)
+        }
       end if config.run_counterexamples?
     end
 
@@ -117,6 +123,25 @@ module Webspicy
 
     private
 
+      def expand_example(service, example)
+        return example unless service.default_example
+        h1 = service.default_example.to_info
+        h2 = example.to_info
+        ex = Resource::Service::TestCase.new(merge_maps(h1, h2))
+        ex.service = service
+        ex
+      end
+
+      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
+        end
+      end
+
       # Returns a proc that implements file_filter strategy according to the
       # type of filter installed
       def to_filter_proc(filter)

data/lib/webspicy/version.rb

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

data/spec/unit/scope/test_expand_example.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+module Webspicy
+  describe Scope, "expand_example" do
+
+    subject{ Scope.new({}).send(:expand_example, service, example) }
+
+    context 'when the service has no default example' do
+      let(:service) {
+        Webspicy.service({
+          method: "GET",
+          description: "Test service",
+          preconditions: "Foo",
+          input_schema: "{ id: Integer }",
+          output_schema: "{}",
+          error_schema: "{}"
+        })
+      }
+
+      let(:example) {
+        Webspicy.test_case({
+          description: "Hello world"
+        })
+      }
+
+      it 'returns the example itself' do
+        expect(subject).to be(example)
+      end
+    end
+
+    context 'when the service has a default example' do
+      let(:service) {
+        Webspicy.service({
+          method: "GET",
+          description: "Test service",
+          preconditions: "Foo",
+          input_schema: "{ id: Integer }",
+          output_schema: "{}",
+          error_schema: "{}",
+          default_example: {
+            expected: { status: 200 }
+          }
+        })
+      }
+
+      let(:example) {
+        Webspicy.test_case({
+          description: "Hello world",
+          expected: { content_type: "application/json" }
+        })
+      }
+
+      it 'deep merges the default example and the example as expected' do
+        expect(subject).to be_a(Resource::Service::TestCase)
+        expect(subject.description).to eql("Hello world")
+        expect(subject.expected).to eql({
+          status: 200,
+          content_type: "application/json"
+        })
+      end
+    end
+
+  end
+end # module Webspicy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -195,6 +195,7 @@ files:
 - spec/unit/resource/test_url_placeholders.rb
 - spec/unit/scope/test_each_resource.rb
 - spec/unit/scope/test_each_service.rb
+- spec/unit/scope/test_expand_example.rb
 - spec/unit/scope/test_to_real_url.rb
 - spec/unit/spec_helper.rb
 - spec/unit/test_configuration.rb
@@ -221,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!