webspicy 0.15.4 → 0.16.0

data/spec/unit/openapi/test_generator.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'webspicy/openapi'
+require 'openapi3_parser'
+module Webspicy
+  module Openapi
+    describe Generator do
+
+      let(:config) {
+        Configuration.new(restful_folder)
+      }
+
+      subject {
+        ruby_objs = Generator.new(config).call
+        JSON.parse(ruby_objs.to_json)
+      }
+
+      it 'works fine' do
+        document = Openapi3Parser.load(subject)
+        #puts JSON.pretty_generate(subject)
+        document.errors.each do |err|
+          puts err.inspect
+        end unless document.errors.empty?
+        expect(document.errors).to be_empty
+      end
+
+    end
+  end
+end

data/spec/unit/specification/precondition/test_global_request_headers.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Webspicy
+  class Specification
+    module Precondition
+      describe GlobalRequestHeaders do
+        let(:gbr){
+          GlobalRequestHeaders.new('Accept' => 'application/json')
+        }
+
+        describe "instrument" do
+          it 'injects the headers' do
+            tc = TestCase.new({})
+            gbr.instrument(tc, nil)
+            expect(tc.headers['Accept']).to eql("application/json")
+          end
+
+          it 'keeps original headers unchanged' do
+            tc = TestCase.new({
+              headers: {
+                'Content-Type' => 'text/plain'
+              }
+            })
+            gbr.instrument(tc, nil)
+            expect(tc.headers['Content-Type']).to eql("text/plain")
+            expect(tc.headers['Accept']).to eql("application/json")
+          end
+
+          it 'has low precedence' do
+            tc = TestCase.new({
+              headers: {
+                'Accept' => 'text/plain'
+              }
+            })
+            gbr.instrument(tc, nil)
+            expect(tc.headers['Accept']).to eql("text/plain")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/{resource → specification}/service/test_dress_params.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 module Webspicy
-  class Resource
+  class Specification
     describe Service, "dress_params" do
 
       it 'symbolizes keys' do
@@ -30,5 +30,5 @@ module Webspicy
       end
 
     end
-  end # class Resource
+  end # class Specification
 end # module Webspicy

data/spec/unit/specification/test_case/test_mutate.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+module Webspicy
+  class Specification
+    describe TestCase, "mutate" do
+
+      it 'helps easily creating a new test by mutation' do
+        tc = TestCase.new({
+          :params => {
+            "id" => 1
+          }
+        })
+        tc2 = tc.mutate({
+          :params => {
+            "id" => 2
+          }
+        })
+        expect(tc2).to be_a(TestCase)
+        expect(tc.params["id"]).to eql(1)
+        expect(tc2.params["id"]).to eql(2)
+      end
+
+    end
+  end
+end

data/spec/unit/{resource → specification}/test_instantiate_url.rb

@@ -1,30 +1,30 @@
 require "spec_helper"
 module Webspicy
-  describe Resource, "instantiate_url" do
+  describe Specification, "instantiate_url" do
 
     it 'does nothing when the url has no placeholder' do
-      r = Resource.new(url: "/test/a/url")
+      r = Specification.new(url: "/test/a/url")
       url, params = r.instantiate_url(foo: "bar")
       expect(url).to eq("/test/a/url")
       expect(params).to eq(foo: "bar")
     end
 
     it 'instantiates placeholders and strips corresponding params' do
-      r = Resource.new(url: "/test/{foo}/url")
+      r = Specification.new(url: "/test/{foo}/url")
       url, params = r.instantiate_url(foo: "bar", baz: "coz")
       expect(url).to eq("/test/bar/url")
       expect(params).to eq(baz: "coz")
     end
 
     it 'instantiates placeholders and strips corresponding params even when multiple' do
-      r = Resource.new(url: "/test/{foo}/url/{bar}")
+      r = Specification.new(url: "/test/{foo}/url/{bar}")
       url, params = r.instantiate_url(foo: "bar", bar: "baz", baz: "coz")
       expect(url).to eq("/test/bar/url/baz")
       expect(params).to eq(baz: "coz")
     end
 
     it 'supports placeholders corresponding to subentities' do
-      r = Resource.new(url: "/test/{foo.id}/url")
+      r = Specification.new(url: "/test/{foo.id}/url")
       url, params = r.instantiate_url(foo: {id: "bar"}, baz: "coz")
       expect(url).to eq("/test/bar/url")
       expect(params).to eq(foo: {}, baz: "coz")

data/spec/unit/{resource → specification}/test_url_placeholders.rb

@@ -1,19 +1,19 @@
 require "spec_helper"
 module Webspicy
-  describe Resource, "url_placeholders" do
+  describe Specification, "url_placeholders" do
 
     it 'returns an empty array on none' do
-      r = Resource.new(url: "/test/a/url")
+      r = Specification.new(url: "/test/a/url")
       expect(r.url_placeholders).to eq([])
     end
 
     it 'returns all placeholders' do
-      r = Resource.new(url: "/test/{foo}/url/{bar}")
+      r = Specification.new(url: "/test/{foo}/url/{bar}")
       expect(r.url_placeholders).to eq(["foo", "bar"])
     end
 
     it 'returns all placeholders expr' do
-      r = Resource.new(url: "/test/{foo.id}/url/{bar}")
+      r = Specification.new(url: "/test/{foo.id}/url/{bar}")
       expect(r.url_placeholders).to eq(["foo.id", "bar"])
     end
 

data/spec/unit/test_configuration.rb

@@ -31,6 +31,23 @@ module Webspicy
         expect(c.preconditions.size).to eq(1)
       end
 
+      it 'supports an URL and returns a specific configuration instance' do
+        c = Configuration.dress("http://google.com/")
+        expect(c).to be_a(Configuration)
+        expect(c.folder).to eq(Path.pwd)
+        expect(c.each_scope.to_a.size).to eql(1)
+        expect(c.each_scope.to_a.first.each_specification.to_a.size).to eql(1)
+      end
+
+      it 'supports a single .yml file and returns a specific configuration instance' do
+        file = restful_folder/"todo/getTodo.yml"
+        c = Configuration.dress(file)
+        expect(c).to be_a(Configuration)
+        expect(c.folder).to eq(restful_folder)
+        expect(c.each_scope.to_a.size).to eql(1)
+        expect(c.each_scope.to_a.first.each_specification.to_a.size).to eql(1)
+      end
+
       it 'yields the block with the configuration, if given' do
         seen = nil
         Configuration.dress(Path.dir/'configuration'){|c|
@@ -56,20 +73,20 @@ module Webspicy
 
       it 'creates a child when adding a folder' do
         Configuration.new(Path.dir) do |c|
-          child = c.folder 'resource'
+          child = c.folder 'specification'
           expect(child).to be_a(Configuration)
-          expect(child.folder).to eql(Path.dir/'resource')
+          expect(child.folder).to eql(Path.dir/'specification')
         end
       end
 
       it 'yield the child to the block if any given' do
         Configuration.new(Path.dir) do |c|
           seen = nil
-          c.folder 'resource' do |child|
+          c.folder 'specification' do |child|
             seen = child
           end
           expect(seen).to be_a(Configuration)
-          expect(seen.folder).to eql(Path.dir/'resource')
+          expect(seen.folder).to eql(Path.dir/'specification')
         end
       end
     end
@@ -223,7 +240,7 @@ module Webspicy
       let(:before_aller) { ->(){} }
       let(:after_aller) { ->(){} }
       let(:config) do
-        Configuration.new(Path.dir/'resource') do |c|
+        Configuration.new(Path.dir/'specification') do |c|
           c.before_all(&before_aller)
           c.before_each(&before_eacher)
           c.after_each(&after_eacher)
@@ -243,7 +260,7 @@ module Webspicy
     describe 'dup' do
 
       let(:original) do
-        Configuration.new(Path.dir/'resource') do |c|
+        Configuration.new(Path.dir/'specification') do |c|
           c.host = "http://127.0.0.1"
           c.folder 'service'
         end
@@ -253,7 +270,7 @@ module Webspicy
         duped = original.dup do |d|
           d.host = "http://127.0.0.1:4567"
         end
-        expect(duped.folder).to eql(Path.dir/'resource')
+        expect(duped.folder).to eql(Path.dir/'specification')
         expect(duped.host).to eql("http://127.0.0.1:4567")
         expect(original.host).to eql("http://127.0.0.1")
       end

data/spec/unit/tester/client/test_around.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+module Webspicy
+  class Tester
+    describe Client, "around" do
+
+      it 'work with no around at all' do
+        config = Configuration.new
+
+        seen = false
+        block = ->(){ seen = true }
+
+        scope = Configuration::Scope.new(config)
+        Client.new(scope).around(1, 2, 3, &block)
+        expect(seen).to be(true)
+      end
+
+      it 'work with one around' do
+        config = Configuration.new
+
+        seen = false
+        seen_args = nil
+        config.around_each do |*args, &bl|
+          seen_args = args
+          bl.call
+        end
+
+        scope = Configuration::Scope.new(config)
+        block = ->(){ seen = true }
+        Client.new(scope).around(1, 2, 3, &block)
+
+        expect(seen_args[0...-1]).to eql([1, 2, 3])
+        expect(seen).to be(true)
+      end
+
+      it 'works with two arounds' do
+        config = Configuration.new
+
+        seen = false
+
+        seen_args = []
+        config.around_each do |*args, &bl|
+          seen_args << args
+          bl.call
+        end
+        config.around_each do |*args, &bl|
+          seen_args << args
+          bl.call
+        end
+
+        scope = Configuration::Scope.new(config)
+        block = ->(){ seen = true }
+        Client.new(scope).around(1, 2, 3, &block)
+
+        expect(seen_args.size).to eql(2)
+        expect(seen_args.all?{|sa| sa[0...-1] == [1,2,3] }).to be(true)
+        expect(seen).to be(true)
+      end
+
+    end
+  end
+end

data/spec/unit/tester/test_asserter.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Webspicy
+  class Tester
+    describe Asserter do
+      let(:asserter) { Asserter.new(target) }
+
+      describe '#size' do
+        let(:target) { [1, 2, 3, 4] }
+
+        it 'returns nil when the assertion is true for a plain array' do
+          expect(asserter.size('', 4)).to eq nil
+        end
+
+        it 'raises an exception with a descriptive message when the assertion is false' do
+          expect { asserter.size('', 3) }
+            .to raise_exception RuntimeError, 'Expected [1,2,3,4] to have a size of 3, actual size is: 4'
+        end
+
+        context 'with a string' do
+          let(:target) { 'FooBaz' }
+
+          it 'returns nil when the assertion is true' do
+            expect(asserter.size('', 6)).to eq nil
+          end
+        end
+
+        context 'with an array at a nested path' do
+          let(:target) { { foo: [1, 2, { bar: [10, 11, 12] }, 4] } }
+
+          it 'returns nil when the assertion is true' do
+            expect(asserter.size('foo/2/bar', 3)).to eq nil
+          end
+
+          it 'raises an exception with a descriptive message when the assertion is false' do
+            expect { asserter.size('foo/2/bar', 99) }
+              .to raise_exception RuntimeError,
+                                  'Expected [10,11,12] to have a size of 99, actual size is: 3'
+          end
+
+          it 'raises an InvalidArgError when the path is invalid' do
+            expect { asserter.size('foo/28/bar', 99) }
+              .to raise_exception Webspicy::Tester::Assertions::InvalidArgError,
+                                  'Expecting instance responding to size'
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/unit/tester/test_assertions.rb

@@ -23,7 +23,7 @@ module Webspicy
         expect(includes [5, 1], 1).to be(true)
       end
 
-      it 'has an notIcludes() assertion' do
+      it 'has a notIncludes() assertion' do
         expect(notIncludes [], 1).to be(true)
         expect(notIncludes [5, 1], 1).to be(false)
       end
@@ -37,7 +37,7 @@ module Webspicy
         expect(exists({ foo: {} }, 'foo/bar')).to be(false)
       end
 
-      it 'has an notExists() assertion' do
+      it 'has a notExists() assertion' do
         expect(notExists nil).to be(true)
         expect(notExists []).to be(false)
         expect(notExists [1]).to be(false)
@@ -60,7 +60,7 @@ module Webspicy
         expect(notEmpty({ foo: [1] }, 'foo')).to be(true)
       end
 
-      it 'has an size() assertion' do
+      it 'has a size() assertion' do
         expect(size [], 0).to be(true)
         expect(size [], 1).to be(false)
         expect(size [12], 1).to be(true)
@@ -106,7 +106,7 @@ module Webspicy
         expect(idFD(target, 'foo', 1, baz: "boz")).to be(false)
       end
 
-      it 'has an pathFD assertion' do
+      it 'has a pathFD assertion' do
         target = { foo: { bar: "baz"} }
         expect(pathFD(target, 'foo', bar: "baz")).to be(true)
         expect(pathFD(target, 'foo', bar: "boz")).to be(false)

data/tasks/test.rake

@@ -11,7 +11,9 @@ namespace :test do
   tests << :unit
 
   require 'path'
-  Path.dir.parent.glob("examples/*").select{|f| f.directory? }.each do |file|
+  Path.dir.parent.glob("examples/*").select{|f|
+    f.directory? && (f/"Rakefile").exists?
+  }.each do |file|
     test_name = file.basename.to_s.to_sym
     desc "Runs the integration tests on the #{file.basename} example"
     task(test_name) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.16.0
 platform: ruby
 authors:
 - Bernard Lambeau
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,34 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -90,16 +84,16 @@ dependencies:
   name: finitio
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -118,16 +112,16 @@ dependencies:
   name: path
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rack-robustness
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +170,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: openapi3_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
 description: Webspicy helps testing web services as software operation black boxes
 email: blambeau@gmail.com
 executables:
@@ -198,51 +220,73 @@ files:
 - examples/restful/webspicy/schema.fio
 - examples/restful/webspicy/support/must_be_an_admin.rb
 - examples/restful/webspicy/support/must_be_authenticated.rb
+- examples/restful/webspicy/support/todo_removed.rb
 - examples/restful/webspicy/todo/deleteTodo.yml
 - examples/restful/webspicy/todo/getTodo.yml
+- examples/restful/webspicy/todo/getTodoSingleServiceFormat.yml
 - examples/restful/webspicy/todo/getTodos.yml
 - examples/restful/webspicy/todo/options.yml
 - examples/restful/webspicy/todo/patchTodo.yml
 - examples/restful/webspicy/todo/postCsv.yml
 - examples/restful/webspicy/todo/postFile.yml
 - examples/restful/webspicy/todo/postTodos.yml
+- examples/restful/webspicy/todo/putTodo.yml
 - examples/restful/webspicy/todo/todos.csv
+- examples/single_spec/spec.yml
+- examples/website/config.rb
+- examples/website/schema.fio
+- examples/website/specification/get-http.yml
+- examples/website/specification/get-https.yml
+- lib/finitio/webspicy/scalars.fio
 - lib/webspicy.rb
 - lib/webspicy/checker.rb
-- lib/webspicy/client.rb
-- lib/webspicy/client/http_client.rb
-- lib/webspicy/client/rack_test_client.rb
-- lib/webspicy/client/support.rb
 - lib/webspicy/configuration.rb
-- lib/webspicy/file_upload.rb
+- lib/webspicy/configuration/scope.rb
+- lib/webspicy/configuration/single_url.rb
+- lib/webspicy/configuration/single_yml_file.rb
 - lib/webspicy/formaldoc.fio
 - lib/webspicy/mocker.rb
-- lib/webspicy/postcondition.rb
-- lib/webspicy/precondition.rb
-- lib/webspicy/resource.rb
-- lib/webspicy/resource/service.rb
-- lib/webspicy/resource/service/invocation.rb
-- lib/webspicy/resource/service/test_case.rb
-- lib/webspicy/scope.rb
+- lib/webspicy/openapi.rb
+- lib/webspicy/openapi/generator.rb
+- lib/webspicy/specification.rb
+- lib/webspicy/specification/file_upload.rb
+- lib/webspicy/specification/postcondition.rb
+- lib/webspicy/specification/precondition.rb
+- lib/webspicy/specification/precondition/global_request_headers.rb
+- lib/webspicy/specification/precondition/robust_to_invalid_input.rb
+- lib/webspicy/specification/service.rb
+- lib/webspicy/specification/test_case.rb
 - lib/webspicy/support.rb
+- lib/webspicy/support/colorize.rb
 - lib/webspicy/support/status_range.rb
 - lib/webspicy/tester.rb
 - lib/webspicy/tester/asserter.rb
 - lib/webspicy/tester/assertions.rb
+- lib/webspicy/tester/client.rb
+- lib/webspicy/tester/client/http_client.rb
+- lib/webspicy/tester/client/rack_test_client.rb
+- lib/webspicy/tester/client/support.rb
+- lib/webspicy/tester/invocation.rb
+- lib/webspicy/tester/rspec_asserter.rb
+- lib/webspicy/tester/rspec_matchers.rb
 - lib/webspicy/version.rb
-- spec/unit/client/test_around.rb
+- spec/spec_helper.rb
 - spec/unit/configuration/config.rb
+- spec/unit/configuration/scope/test_each_service.rb
+- spec/unit/configuration/scope/test_each_specification.rb
+- spec/unit/configuration/scope/test_expand_example.rb
+- spec/unit/configuration/scope/test_to_real_url.rb
 - spec/unit/mocker/test_mocker.rb
-- spec/unit/resource/service/test_dress_params.rb
-- spec/unit/resource/test_instantiate_url.rb
-- 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/openapi/test_generator.rb
+- spec/unit/specification/precondition/test_global_request_headers.rb
+- spec/unit/specification/service/test_dress_params.rb
+- spec/unit/specification/test_case/test_mutate.rb
+- spec/unit/specification/test_instantiate_url.rb
+- spec/unit/specification/test_url_placeholders.rb
 - spec/unit/support/test_status_range.rb
 - spec/unit/test_configuration.rb
+- spec/unit/tester/client/test_around.rb
+- spec/unit/tester/test_asserter.rb
 - spec/unit/tester/test_assertions.rb
 - tasks/gem.rake
 - tasks/test.rake
@@ -250,7 +294,7 @@ homepage: http://github.com/enspirit/webspicy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -266,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!
 test_files: []