webspicy 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d890646c50effb64a3d44939eb1e85bcf20f1e43
-  data.tar.gz: d87ee755a543f0199b4e811ccde28ef800467c8d
+  metadata.gz: 316f44001f615a30f037e1bced5a2988df1e85c2
+  data.tar.gz: af13f64c5f2096dfaf1fea51dbc119a30a9ac4f6
 SHA512:
-  metadata.gz: 73b92b474d1b94b5c0ed74b76e7363b3f8fd57c2f7a3e05ac2ddcbeb93364ba9f6b9272acbb71cb3d6171de320901931dcddfdf2ad7c2ae2415471c9c62b5144
-  data.tar.gz: b7c1bdd9ed89ebd65c5364b3da910935ee13c108e1482628b335900781ce5f922dc71f806ecc8aaa0cf71deebcee82217caf6b1486527eea6153319f8ee62bb4
+  metadata.gz: d0c0c064b0c096fea8a4520356f08104dd796778b88c3564abdc5eb61adcb41d0ccf8e08fd513adc57f6f1cf6a88437a52ba15f72494cf09f45d2254899ed196
+  data.tar.gz: aba64e2492ba14d5f89f867508f3f737893b6d42cd2776dafc4932b8a1e8d93ca22461694161cc8da7e5a38238be940b7c08d1f11857fe2e4f854669ce2b8156

data/examples/restful/Rakefile

@@ -4,32 +4,18 @@ require 'webspicy'
 
 desc "Checks all .yml definition files"
 task :check do
-  config = Webspicy::Configuration.new(Path.dir/"webspicy")
-  Webspicy::Checker.new(config).call
+  Webspicy::Checker.new(Path.dir/'webspicy').call
 end
 
 namespace :test do
   desc "Run all tests directly on Sinatra application using rack/test"
   task :rack do
-    config = Webspicy::Configuration.new(Path.dir/"webspicy") do |c|
-      c.client = Webspicy::RackTestClient.for(::Sinatra::Application)
-      c.before_each do |_,_,_,client|
-        client.api.post "/reset"
-      end
-    end
-    Webspicy::Tester.new(config).call
+    Webspicy::Tester.new(Path.dir/'webspicy/rack.rb').call
   end
 
   desc "Runs all tests on the real web server (must be launched previously)"
   task :real do
-    config = Webspicy::Configuration.new(Path.dir/"webspicy") do |c|
-      c.host = "http://127.0.0.1:4567"
-      c.client = Webspicy::HttpClient
-      c.before_each do |_,_,_,client|
-        client.api.post "http://127.0.0.1:4567/reset"
-      end
-    end
-    Webspicy::Tester.new(config).call
+    Webspicy::Tester.new(Path.dir/'webspicy/real.rb').call
   end
 end
 

data/examples/restful/webspicy/config.rb

@@ -0,0 +1 @@
+Webspicy::Configuration.new(Path.dir)

data/examples/restful/webspicy/rack.rb

@@ -0,0 +1,6 @@
+Webspicy::Configuration.inherits(Path.dir) do |c|
+  c.client = Webspicy::RackTestClient.for(::Sinatra::Application)
+  c.before_each do |_,client|
+    client.api.post "/reset"
+  end
+end

data/examples/restful/webspicy/real.rb

@@ -0,0 +1,7 @@
+Webspicy::Configuration.inherits(Path.dir) do |c|
+  c.host = "http://127.0.0.1:4567"
+  c.client = Webspicy::HttpClient
+  c.before_each do |_,client|
+    client.api.post "http://127.0.0.1:4567/reset"
+  end
+end

data/lib/webspicy/checker.rb

@@ -2,7 +2,7 @@ module Webspicy
   class Checker
 
     def initialize(config)
-      @config = config
+      @config = Configuration.dress(config)
     end
     attr_reader :config
 

data/lib/webspicy/client/http_client.rb

@@ -7,7 +7,9 @@ module Webspicy
     end
     attr_reader :api
 
-    def call(test_case, service, resource)
+    def call(test_case)
+      service, resource = test_case.service, test_case.resource
+
       # Instantiate the parameters
       headers = test_case.headers
       params = test_case.dress_params? ? service.dress_params(test_case.params) : test_case.params

data/lib/webspicy/client/rack_test_client.rb

@@ -5,19 +5,24 @@ module Webspicy
       Factory.new(app)
     end
 
-    def initialize(scope, app)
+    def initialize(scope, app, domain)
       super(scope)
       @api = Api.new(app)
+      @domain = domain
     end
     attr_reader :api
+    attr_reader :domain
+
+    def call(test_case)
+      service, resource = test_case.service, test_case.resource
 
-    def call(test_case, service, resource)
       # Instantiate the parameters
-      headers = test_case.headers
+      headers = test_case.headers.dup
       params = test_case.dress_params? ? service.dress_params(test_case.params) : test_case.params
 
       # Instantiate the url and strip parameters
       url, params = resource.instantiate_url(params)
+      url = "http://#{domain}#{url}" if domain
 
       # Invoke the service now
       api.public_send(service.method.to_s.downcase.to_sym, url, params, headers)
@@ -32,9 +37,15 @@ module Webspicy
         @app = app
       end
       attr_reader :app
+      attr_reader :domain
+
+      def on(domain)
+        @domain = domain
+        self
+      end
 
       def new(scope)
-        RackTestClient.new(scope, app)
+        RackTestClient.new(scope, app, domain)
       end
 
     end # class Factory

data/lib/webspicy/configuration.rb

@@ -5,17 +5,38 @@ module Webspicy
       @folder = folder
       @parent = parent
       @children = []
+      @preconditions = []
+      @postconditions = []
       @before_listeners = []
       @rspec_options = default_rspec_options
       @run_counterexamples = default_run_counterexamples
       @file_filter = default_file_filter
       @service_filter = default_service_filter
       @client = HttpClient
+      Path.require_tree(folder/'support') if (folder/'support').exists?
       yield(self) if block_given?
     end
     attr_accessor :folder
     protected :folder=
 
+    def self.dress(arg, &bl)
+      return arg if arg.is_a?(Configuration)
+      arg = Path(arg)
+      if arg.file?
+        c = Kernel.instance_eval arg.read, arg.to_s
+        yield(c) if block_given?
+        c
+      elsif (arg/'config.rb').file?
+        dress(arg/'config.rb', &bl)
+      else
+        raise ArgumentError, "Missing config.rb file"
+      end
+    end
+
+    def self.inherits(*args, &bl)
+      dress(*args, &bl)
+    end
+
     attr_accessor :parent
     protected :parent=
 
@@ -51,6 +72,20 @@ module Webspicy
     attr_accessor :children
     protected :children=
 
+    # Registers a precondition matcher
+    def precondition(clazz)
+      preconditions << clazz
+    end
+    attr_accessor :preconditions
+    protected :preconditions=
+
+    # Registers a postcondition matcher
+    def postcondition(clazz)
+      postconditions << clazz
+    end
+    attr_accessor :postconditions
+    protected :postconditions=
+
     # Returns whether this configuration has children configurations or not
     def has_children?
       !children.empty?
@@ -229,6 +264,8 @@ module Webspicy
     def dup(&bl)
       super.tap do |d|
         d.children = []
+        d.preconditions = self.preconditions.dup
+        d.postconditions = self.postconditions.dup
         d.rspec_options = self.rspec_options.dup
         d.before_listeners = self.before_listeners.dup
         yield d if block_given?

data/lib/webspicy/formaldoc.fio

@@ -15,13 +15,13 @@ Resource =
 
 Service =
     .Webspicy::Resource::Service <info> {
-        method          : Method
-        description     : String
-        preconditions   : String
-        postconditions  :? String
-        input_schema    : Schema
-        output_schema   : Schema
-        error_schema    : Schema
+        method          :  Method
+        description     :  String
+        preconditions   :? [String]|String
+        postconditions  :? [String]|String
+        input_schema    :  Schema
+        output_schema   :  Schema
+        error_schema    :  Schema
         blackbox        :? String
         examples        :? [TestCase]
         counterexamples :? [TestCase]

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

@@ -141,6 +141,15 @@ module Webspicy
           unmet.empty? ? nil : unmet.join("\n")
         end
 
+        ### Check of postconditions
+
+        def postconditions_unmet
+          failures = service.postconditions.map{|post|
+            post.check(self)
+          }.compact
+          failures.empty? ? nil : failures.join("\n")
+        end
+
       private
 
         def loaded_body

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

@@ -6,6 +6,11 @@ module Webspicy
         def initialize(raw)
           @raw = raw
         end
+        attr_accessor :service
+
+        def resource
+          service.resource
+        end
 
         def self.info(raw)
           new(raw)
@@ -20,7 +25,7 @@ module Webspicy
         end
 
         def headers
-          @raw[:headers] || {}
+          @raw[:headers] ||= {}
         end
 
         def dress_params
@@ -68,6 +73,16 @@ module Webspicy
           @raw
         end
 
+        def instrument
+          service.preconditions.each do |pre|
+            pre.ensure(self)
+          end
+        end
+
+        def to_s
+          description
+        end
+
       end # class TestCase
     end # class Service
   end # class Resource

data/lib/webspicy/resource/service.rb

@@ -4,7 +4,12 @@ module Webspicy
 
       def initialize(raw)
         @raw = raw
+        bind_examples
+        bind_counterexamples
+        @preconditions = compile_preconditions
+        @postconditions = compile_postconditions
       end
+      attr_accessor :resource
 
       def self.info(raw)
         new(raw)
@@ -14,6 +19,22 @@ module Webspicy
         @raw[:method]
       end
 
+      def preconditions
+        @preconditions
+      end
+
+      def has_preconditions?
+        !preconditions.empty?
+      end
+
+      def postconditions
+        @postconditions
+      end
+
+      def has_postconditions?
+        !postconditions.empty?
+      end
+
       def examples
         @raw[:examples]
       end
@@ -22,6 +43,16 @@ module Webspicy
         @raw[:counterexamples]
       end
 
+      def generated_counterexamples
+        preconditions.map{|pre|
+          pre.counterexamples(self).map{|tc|
+            tc = Webspicy.test_case(tc, Webspicy.current_scope)
+            tc.service = self
+            tc
+          }
+        }.flatten
+      end
+
       def input_schema
         @raw[:input_schema]
       end
@@ -42,6 +73,46 @@ module Webspicy
         @raw
       end
 
+      def to_s
+        "#{method} #{resource.url}"
+      end
+
+    private
+
+      def scope
+        Webspicy.current_scope
+      end
+
+      def compile_preconditions
+        @raw[:preconditions] = [@raw[:preconditions]] if @raw[:preconditions].is_a?(String)
+        compile_conditions(@raw[:preconditions] ||= [], scope.preconditions)
+      end
+
+      def compile_postconditions
+        @raw[:postconditions] = [@raw[:postconditions]] if @raw[:postconditions].is_a?(String)
+        compile_conditions(@raw[:postconditions] ||= [], scope.postconditions)
+      end
+
+      def compile_conditions(descriptions, conditions)
+        descriptions
+          .map{|descr|
+            conditions.map{|c| c.match(self, descr) }.compact
+          }
+          .flatten
+      end
+
+      def bind_examples
+        (@raw[:examples] ||= []).each do |ex|
+          ex.service = self
+        end
+      end
+
+      def bind_counterexamples
+        (@raw[:counterexamples] ||= []).each do |ex|
+          ex.service = self
+        end
+      end
+
     end # class Service
   end # class Resource
 end # module Webspicy

data/lib/webspicy/resource.rb

@@ -3,6 +3,7 @@ module Webspicy
 
     def initialize(raw)
       @raw = raw
+      bind_services
     end
 
     def self.info(raw)
@@ -38,6 +39,14 @@ module Webspicy
       @raw
     end
 
+  private
+
+    def bind_services
+      (@raw[:services] ||= []).each do |s|
+        s.resource = self
+      end
+    end
+
   end
 end
 require_relative 'resource/service'

data/lib/webspicy/scope.rb

@@ -6,6 +6,14 @@ module Webspicy
     end
     attr_reader :config
 
+    def preconditions
+      config.preconditions
+    end
+
+    def postconditions
+      config.postconditions
+    end
+
     ###
     ### Eachers -- Allow navigating the web service definitions
     ###
@@ -38,14 +46,25 @@ module Webspicy
       resource.services.select(&to_filter_proc(config.service_filter)).each(&bl)
     end
 
-    def each_example(service, &bl)
-      service.examples.each(&bl)
+    def each_example(service)
+      service.examples.each{|s| yield(s, false) }
     end
 
     def each_counterexamples(service, &bl)
-      service.counterexamples.each(&bl) if config.run_counterexamples?
+      service.counterexamples.each{|s| yield(s, 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) }
+      end if config.run_counterexamples?
+    end
+
+    def each_testcase(service, &bl)
+      each_example(service, &bl)
+      each_counterexamples(service, &bl)
+      each_generated_counterexamples(service, &bl)
+    end
 
     ###
     ### Schemas -- For parsing input and output data schemas found in

data/lib/webspicy/tester.rb

@@ -2,96 +2,70 @@ module Webspicy
   class Tester
 
     def initialize(config)
-      @config = config
+      @config = Configuration.dress(config)
     end
     attr_reader :config
 
     def call
+      rspec_config!
       config.each_scope do |scope|
         client = scope.get_client
         scope.each_resource do |resource|
           scope.each_service(resource) do |service|
-            RSpec.describe "#{service.method} `#{resource.url}`" do
-              scope.each_example(service) do |test_case|
-                describe test_case.description do
-
-                  before(:all) do
-                    client.before(test_case, service, resource)
-                    @invocation ||= client.call(test_case, service, resource)
-                  end
-
-                  subject do
-                    @invocation
-                  end
-
-                  it 'can be invoked successfuly' do
-                    expect(subject.done?).to eq(true)
-                  end
-
-                  it 'meets the status and content type specification' do
-                    expect(subject.expected_status_unmet).to(be_nil)
-                    expect(subject.expected_content_type_unmet).to(be_nil)
-                  end
-
-                  it 'has the expected response headers' do
-                    expect(subject.expected_headers_unmet).to(be_nil)
-                  end if test_case.has_expected_headers?
-
-                  it 'meets the output data schema' do
-                    expect(subject.expected_schema_unmet).to(be_nil)
-                  end
-
-                  it 'meets all assertions' do
-                    expect(subject.assertions_unmet).to(be_nil)
-                  end if test_case.has_assertions?
-
-                end
-              end # service.examples
-
-              scope.each_counterexamples(service) do |test_case|
-                describe test_case.description do
-
-                  before(:all) do
-                    client.before(test_case, service, resource)
-                    @invocation ||= client.call(test_case, service, resource)
-                  end
+            rspec_service!(service, client, scope)
+          end
+        end
+      end
+      RSpec::Core::Runner.run config.rspec_options
+    end
 
-                  subject do
-                    @invocation
-                  end
+    def rspec_service!(service, client, scope)
+      RSpec.describe service do
+        scope.each_testcase(service) do |test_case, counterexample|
+          describe test_case do
+            include_examples 'a successful test case invocation', client, test_case, counterexample
+          end
+        end
+      end
+    end
 
-                  it 'can be invoked successfuly' do
-                    expect(subject.done?).to eq(true)
-                  end
+    def rspec_config!
+      return if @rspec_config
+      RSpec.shared_examples "a successful test case invocation" do |client, test_case, counterexample|
 
-                  it 'meets the status and content type specification' do
-                    expect(subject.expected_status_unmet).to(be_nil)
-                    expect(subject.expected_content_type_unmet).to(be_nil)
-                  end
+        before(:all) do
+          @invocation ||= begin
+            test_case.instrument
+            client.before(test_case)
+            client.call(test_case)
+          end
+        end
 
-                  it 'has the expected response headers' do
-                    expect(subject.expected_headers_unmet).to(be_nil)
-                  end if test_case.has_expected_headers?
+        let(:invocation) do
+          @invocation
+        end
 
-                  it 'meets the output data schema' do
-                    expect(subject.expected_schema_unmet).to(be_nil)
-                  end
+        it 'meets the HTTP specification' do
+          expect(invocation.done?).to eq(true)
+          expect(invocation.expected_status_unmet).to(be_nil)
+          expect(invocation.expected_content_type_unmet).to(be_nil)
+          expect(invocation.expected_headers_unmet).to(be_nil) if test_case.has_expected_headers?
+          expect(invocation.expected_schema_unmet).to(be_nil)
+        end
 
-                  it 'meets all assertions' do
-                    expect(subject.assertions_unmet).to(be_nil)
-                  end if test_case.has_assertions?
+        it 'meets all specific assertions' do
+          expect(invocation.assertions_unmet).to(be_nil)
+        end if test_case.has_assertions?
 
-                  it 'has expected error' do
-                    expect(subject.expected_error_unmet).to(be_nil)
-                  end if test_case.has_expected_error?
+        it 'meets declarative postconditions' do
+          expect(invocation.postconditions_unmet).to(be_nil)
+        end if test_case.service.has_postconditions? and not(counterexample)
 
-                end
-              end
-            end
-          end
-        end
+        it 'meets the specific error messages, if any (backward compatibility)' do
+          expect(@invocation.expected_error_unmet).to(be_nil)
+        end if test_case.has_expected_error?
       end
-      RSpec::Core::Runner.run config.rspec_options
+      @rspec_config = true
     end
 
   end # class Tester

data/lib/webspicy/version.rb

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

data/lib/webspicy.rb

@@ -84,6 +84,15 @@ module Webspicy
   end
   module_function :with_scope
 
+  #
+  # Returns the current scope or a default one is none has been
+  # previously installed using `set_current_scope` or `with_scope`
+  #
+  def current_scope
+    Thread.current[:webspicy_scope] || default_scope
+  end
+  module_function :current_scope
+
   #
   # Sets the current scope.
   #

data/spec/unit/configuration/config.rb

@@ -0,0 +1,3 @@
+Webspicy::Configuration.new(Path.dir) do |c|
+  c.precondition Class.new
+end

data/spec/unit/test_configuration.rb

@@ -10,6 +10,43 @@ module Webspicy
       expect(seen).to be_a(Configuration)
     end
 
+    describe '.dress' do
+
+      it 'is idempotent' do
+        c = Configuration.new
+        expect(Configuration.dress(c)).to be(c)
+      end
+
+      it 'supports a config.rb file' do
+        c = Configuration.dress(Path.dir/'configuration/config.rb')
+        expect(c).to be_a(Configuration)
+        expect(c.folder).to eq(Path.dir/'configuration')
+        expect(c.preconditions.size).to eq(1)
+      end
+
+      it 'supports a folder having a config.rb file' do
+        c = Configuration.dress(Path.dir/'configuration')
+        expect(c).to be_a(Configuration)
+        expect(c.folder).to eq(Path.dir/'configuration')
+        expect(c.preconditions.size).to eq(1)
+      end
+
+      it 'yields the block with the configuration, if given' do
+        seen = nil
+        Configuration.dress(Path.dir/'configuration'){|c|
+          seen = c
+        }
+        expect(seen).to be_a(Configuration)
+      end
+
+      it 'raises if the folder has no config.rb file' do
+        expect(->{
+          Configuration.dress(Path.dir)
+        }).to raise_error(/Missing config.rb file/)
+      end
+
+    end
+
     describe 'folder' do
 
       it 'returns the main folder without arg' do
@@ -129,12 +166,18 @@ module Webspicy
         duped = original.dup do |d|
           d.rspec_options << "--hello"
           d.before_each do end
+          d.precondition Class.new
+          d.postcondition Class.new
         end
         expect(duped.rspec_options.last).to eq("--hello")
         expect(original.rspec_options.last).not_to eq("--hello")
+        expect(duped.preconditions.size).to eq(1)
+        expect(duped.postconditions.size).to eq(1)
 
         expect(duped.before_listeners.size).to eq(1)
         expect(original.before_listeners.size).to eq(0)
+        expect(original.preconditions.size).to eq(0)
+        expect(original.postconditions.size).to eq(0)
       end
 
       it 'empties the children' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bernard Lambeau
@@ -122,6 +122,9 @@ files:
 - examples/restful/Gemfile.lock
 - examples/restful/Rakefile
 - examples/restful/app.rb
+- examples/restful/webspicy/config.rb
+- examples/restful/webspicy/rack.rb
+- examples/restful/webspicy/real.rb
 - examples/restful/webspicy/schema.fio
 - examples/restful/webspicy/todo/deleteTodo.yml
 - examples/restful/webspicy/todo/getTodo.yml
@@ -143,6 +146,7 @@ files:
 - lib/webspicy/tester/asserter.rb
 - lib/webspicy/tester/assertions.rb
 - lib/webspicy/version.rb
+- spec/unit/configuration/config.rb
 - spec/unit/resource/service/test_dress_params.rb
 - spec/unit/resource/test_instantiate_url.rb
 - spec/unit/resource/test_url_placeholders.rb
@@ -174,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!