webspicy 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: df662e6e4d8e94403071753f7f4e3a61919bf6fc8e5913316b847fee3b03d9d3
-  data.tar.gz: 4e18c04cff9b572d4173a267590f6e91cbfe1bbbf40236944c7fad50edff88dc
+SHA1:
+  metadata.gz: 5b78ed1d162fe75c83bd7bffa819b61ec7153dab
+  data.tar.gz: c5a6ba9ee1d76e1e861d1952fd135664a5e1b408
 SHA512:
-  metadata.gz: 997f7223ba296843ff3ef1c4acaeed45815921c88e03ae756d7e27cf0c4ab60b3a644ddea34e0ac3df4bed41c3472a1135ac15801efc0052cca0c190ca5aceee
-  data.tar.gz: b1cdceb0a8a3b9bc756e2f7a763b4e529c4bb370d7db916d83c273f6e692cb08aa652f296571d846f3112c344d144f03117fecab9d21c7b622c0ed5867231af6
+  metadata.gz: 31da61f468c86496d77f1eb659e17e4b02ec4de80ba14e6a6220a26cde324c9b0113099c4457f45a05be378ccd2acbaba172268fe60000172704c992623a8554
+  data.tar.gz: a347f32c634c884cfdb29ee92e5a4b0d6ca5134b9f9ec95ac8ee604e244ac3f332fc71b846e47c9a3744febcf63fcc631c0f7a0cf1cc452f880f25370c2a3406

data/examples/restful/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.13.0)
+    webspicy (0.14.0)
       finitio (>= 0.8.0)
       http (~> 2)
       mustermann (~> 1.0)

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

@@ -28,6 +28,8 @@ services:
 
     - description: |-
         when requested with a valid CSV file
+      tags:
+        - upload
       file_upload:
         path: ./todos.csv
         content_type: "text/csv"

data/lib/webspicy/configuration.rb

@@ -14,6 +14,7 @@ module Webspicy
       @run_counterexamples = default_run_counterexamples
       @file_filter = default_file_filter
       @service_filter = default_service_filter
+      @test_case_filter = default_test_case_filter
       @client = HttpClient
       Path.require_tree(folder/'support') if (folder/'support').exists?
       yield(self) if block_given?
@@ -152,7 +153,10 @@ module Webspicy
     # set. In that case, a file filter is set that matches the file name to the
     # variable value, through a regular expression.
     def default_file_filter
-      ENV['RESOURCE'] ? Regexp.compile(ENV['RESOURCE']) : nil
+      return nil unless res = ENV['RESOURCE']
+      negated = res =~ /^!/
+      rx = Regexp.compile(negated ? "#{res[1..-1]}" : res)
+      negated ? ->(f){ !(f.to_s =~ rx) } : rx
     end
     private :default_file_filter
 
@@ -171,7 +175,7 @@ module Webspicy
     end
     attr_reader :service_filter
 
-    # Returns the default service filters.
+    # Returns the default service filter.
     #
     # By default no filter is set unless a METHOD environment variable is set.
     # In that case, a service filter is returned that filters the services whose
@@ -181,6 +185,35 @@ module Webspicy
     end
     private :default_service_filter
 
+    # Installs a test case filter.
+    #
+    # A test case filter can be added to restrict the scope attention only to
+    # the test cases that match the service installed. Supported values are:
+    #
+    # - Proc: each test case is passed in turn. Only test cases for which a
+    # 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)
+      @test_case_filter = test_case_filter
+    end
+    attr_reader :test_case_filter
+
+    # Returns the default test case filter.
+    #
+    # By default no filter is set unless a TAG environment variable is set.
+    # In that case, a test case filter is returned that filters the test cases
+    # whose tags map the specified value.
+    def default_test_case_filter
+      return nil unless tags = ENV['TAG']
+      no, yes = tags.split(/\s*,\s*/).partition{|t| t =~ /^!/ }
+      no, yes = no.map{|t| t[1..-1 ]}, yes
+      ->(tc){
+        (yes.empty? || !(yes & tc.tags).empty?) \
+        && \
+        (no.empty? || (no & tc.tags).empty?)
+      }
+    end
 
     # Installs a client class to use to invoke web services for real.
     #

data/lib/webspicy/formaldoc.fio

@@ -1,6 +1,8 @@
 Method =
     String( s | s =~ /^(GET|POST|POST_FORM|PUT|DELETE|PATCH|OPTIONS)$/ )
 
+Tag = String( s | s.length > 0 )
+
 Schema =
     .Finitio::System <fio> String
       \( s | ::Webspicy.schema(s) )
@@ -53,6 +55,7 @@ TestCase =
             headers      :? .Hash
         }
         assert           :? [String]
+        tags             :? [Tag]
     }
 
 Params = .Array|.Hash

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

@@ -32,6 +32,10 @@ module Webspicy
           @raw[:metadata] ||= {}
         end
 
+        def tags
+          @raw[:tags] ||= []
+        end
+
         def dress_params
           @raw.fetch(:dress_params){ true }
         end

data/lib/webspicy/scope.rb

@@ -47,20 +47,20 @@ module Webspicy
     end
 
     def each_example(service)
-      service.examples.each{|e|
+      service.examples.select(&to_filter_proc(config.test_case_filter)).each{|e|
         yield(expand_example(service, e), false)
       }
     end
 
     def each_counterexamples(service, &bl)
-      service.counterexamples.each{|e|
+      service.counterexamples.select(&to_filter_proc(config.test_case_filter)).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{|e|
+        service.generated_counterexamples.select(&to_filter_proc(config.test_case_filter)).each{|e|
           yield(expand_example(service, e), true)
         }
       end if config.run_counterexamples?

data/lib/webspicy/version.rb

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

data/spec/unit/test_configuration.rb

@@ -111,9 +111,19 @@ module Webspicy
         ENV['RESOURCE'] = 'getTodo.yml'
         config = Configuration.new
         expect(config.file_filter).to be_a(Regexp)
+        expect(config.file_filter).to match("foo/bar/getTodo.yml")
+        expect(config.file_filter).not_to match("foo/bar/getTodos.yml")
       end
 
-      it 'ignores the environment is set explicitly' do
+      it 'allows expressing a no match' do
+        ENV['RESOURCE'] = '!getTodo.yml'
+        config = Configuration.new
+        expect(config.file_filter).to be_a(Proc)
+        expect(config.file_filter.call("foo/bar/getTodos.yml")).to eq(true)
+        expect(config.file_filter.call("foo/bar/getTodo.yml")).to eq(false)
+      end
+
+      it 'ignores the environment if set explicitly' do
         ENV['RESOURCE'] = 'getTodo.yml'
         config = Configuration.new do |c|
           c.file_filter = nil
@@ -144,6 +154,68 @@ module Webspicy
       end
     end
 
+    describe 'test_case_filter' do
+
+      let(:tc){ OpenStruct.new(tags: ["foo", "bar"]) }
+
+      subject {
+        Configuration.new.test_case_filter
+      }
+
+      it 'is nil by default' do
+        expect(subject).to be_nil
+      end
+
+      it 'allows setting a single tag' do
+        ENV['TAG'] = 'foo'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(true)
+      end
+
+      it 'allows no matching a single tag' do
+        ENV['TAG'] = 'baz'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(false)
+      end
+
+      it 'allows setting multiple tags' do
+        ENV['TAG'] = 'foo,baz'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(true)
+      end
+
+      it 'allows no matching any of multiple tags' do
+        ENV['TAG'] = 'foi,baz'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(false)
+      end
+
+      it 'allows setting a single negative tag' do
+        ENV['TAG'] = '!foo'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(false)
+      end
+
+      it 'allows not matching a single negative tag' do
+        ENV['TAG'] = '!baz'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(true)
+      end
+
+      it 'allows mixing positive & negative tags and have a match' do
+        ENV['TAG'] = 'foo,!baz'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(true)
+      end
+
+      it 'allows mixing positive & negative tags and have no match' do
+        ENV['TAG'] = 'foo,!bar'
+        expect(subject).to be_a(Proc)
+        expect(subject.call(tc)).to eql(false)
+      end
+
+    end
+
     describe 'before/after/listeners' do
 
       let(:before_eacher) { ->(){} }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -259,7 +259,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.0.pre1
+rubyforge_project: 
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!