webspicy 0.20.8 → 0.20.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f14b3463098780f10139ffd28362d60eaa61e4b9e77d16a91e8ac597847ca1b
-  data.tar.gz: 73571e1c2bd2764e4de2af708fa94d396ae943029ab11300ce9e14345c3479db
+  metadata.gz: 01b2fecc83c9d660dc6eba242b306e965196a6ecf9ad12b9b0e5929d9394e1ab
+  data.tar.gz: 16e008749db41f89755e9c0cc65457e438383044aaf54c6e171fc565b2da8ba0
 SHA512:
-  metadata.gz: 3e6281472272c61b01898ff513b721a3203a6c21ad314c0932d069fab01529d060030db1d0a0d6bb445bf306a62618227aee1fd6dfaea08f0073247f338b9582
-  data.tar.gz: 7136d69f3f9b5de2a1fb72a37377bc01262311c9f4e6bbf52e2062452368a5b81ace3f11b9173c88ac85f46ea3c2765582633b8cb22a43d85def530fb378c471
+  metadata.gz: 0f7a18cbbfead965fefc954c07ea8ebb2d91e60cfd0e72c2658ec5e7c5c1425b6d9f0c8e2d3c09e7b3399697ab299c36f9873e1837422f785e96e1a298cccfaa
+  data.tar.gz: 12377e4af44a7b6d65c6daf3c83a41d1201ec3deab8922343b25f8f6483f07fb997dca45ed6e3fbc243c5f869c915642a7e6a867bf90dc0e5f8bae5fda7fb726

data/lib/webspicy/configuration/scope.rb

@@ -22,7 +22,7 @@ module Webspicy
       def _each_specification_file(config, apply_filter = true)
         folder = config.folder
         world  = config.folder/"world"
-        fs = folder.glob("**/*.yml").reject{|f| f.to_s.start_with?(world.to_s) }
+        fs = folder.glob("**/*.{yml, yaml}").reject{|f| f.to_s.start_with?(world.to_s) }
         fs = fs.sort
         fs = fs.select(&to_filter_proc(config.file_filter)) if apply_filter
         fs.each do |file|

data/lib/webspicy/specification.rb

@@ -14,6 +14,10 @@ module Webspicy
       @location = Path(location)
     end
 
+    def relative_location
+      @location && @location.relative_to(config.folder)
+    end
+
     def locate(relative_path)
       file = @location.parent/relative_path
       raise "File not found: #{file}" unless file.exists?
@@ -21,7 +25,7 @@ module Webspicy
     end
 
     def name
-      @raw[:name]
+      @raw[:name] || relative_location || "Unnamed"
     end
 
     def services

data/lib/webspicy/tester.rb

@@ -149,6 +149,8 @@ module Webspicy
     end
 
     def call_test_case_target
+      @invocation = nil
+      @invocation_error = nil
       reporter.before_invocation
       @invocation = client.call(test_case)
       reporter.invocation_done

data/lib/webspicy/tester/fakesendgrid.rb

@@ -0,0 +1,39 @@
+module Webspicy
+  class Tester
+    class Fakesendgrid
+      include Webspicy::Support::World::Item
+
+      DEFAULT_OPTIONS = {
+        endpoint: "http://fakesendgrid"
+      }
+
+      def initialize(options = {})
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+      attr_reader :options
+
+      def endpoint
+        options[:endpoint]
+      end
+
+      def clear!
+        res = HTTP.delete("#{endpoint}/api/mails")
+      end
+
+      def emails
+        res = HTTP.get("#{endpoint}/api/mails")
+        JSON.parse(res.body).map{|data| Email.new(data) }
+      end
+
+      def emails_count
+        emails.length
+      end
+
+      def last_email
+        emails.first
+      end
+
+    end # class Fakesendgrid
+  end # class Tester
+end # module Webspicy
+require_relative 'fakesendgrid/email'

data/lib/webspicy/tester/fakesendgrid/email.rb

@@ -0,0 +1,31 @@
+module Webspicy
+  class Tester
+    class Fakesendgrid
+      class Email
+
+        def initialize(data)
+          @data = data
+        end
+        attr_reader :data
+
+        def from
+          @from ||= data['from']['name'] ?
+            "#{data['from']['name']} <#{data['from']['email']}>" :
+            data['from']['email']
+        end
+
+        def to
+          @to ||= data["personalizations"]
+            .select{|h| h.key? "to" }
+            .map{|(h)| h["to"] }
+            .map{|(h)| h["email"] }
+        end
+
+        def subject
+          @subject ||= data["subject"]
+        end
+
+      end # class Email
+    end # class Fakesendgrid
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/fakeses/email.rb

@@ -9,7 +9,10 @@ module Webspicy
         attr_reader :data
 
         def from
-          data["body"]["Source"]
+          rx = /^From:\s*(.*)$/
+          raw_data
+            .each_line
+            .find{|l| l =~ rx }[rx, 1].strip
         end
 
         def to
@@ -18,14 +21,14 @@ module Webspicy
             .select{|(k,v)|
               k =~ /Destinations.member/
             }
-            .map{|(k,v)| v }
+            .map{|(k,v)| v.strip }
         end
 
         def subject
           rx = /^Subject:\s*(.*)$/
           raw_data
             .each_line
-            .find{|l| l =~ rx }[rx, 1]
+            .find{|l| l =~ rx }[rx, 1].strip
         end
 
         def raw_data

data/lib/webspicy/tester/reporter.rb

@@ -88,3 +88,4 @@ require_relative 'reporter/composite'
 require_relative 'reporter/file_progress'
 require_relative 'reporter/file_summary'
 require_relative 'reporter/success_or_not'
+require_relative 'reporter/junit_xml_file'

data/lib/webspicy/tester/reporter/exceptions.rb

@@ -15,7 +15,7 @@ module Webspicy
           @spec_file_errors << spec_file_error_line(spec_file, e)
         end
 
-        def after_each_done
+        def test_case_done
           @failed_results << result unless result.success?
         end
 
@@ -24,6 +24,8 @@ module Webspicy
           report_failed_results
         end
 
+      private
+
         def report_spec_file_errors
           return if spec_file_errors.empty?
           io.puts

data/lib/webspicy/tester/reporter/junit_xml_file.rb

@@ -0,0 +1,151 @@
+module Webspicy
+  class Tester
+    class Reporter
+      class JunitXmlFile < Reporter
+
+        TPL = <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <testsuites
+            disabled="{{counts.disabled}}"
+            errors="{{counts.errors}}"
+            failures="{{counts.failures}}"
+            tests="{{counts.total}}"
+            time="{{time}}s"
+          >
+            {{#testsuites}}
+              <testsuite
+                name="{{name}}"
+                tests="{{counts.total}}"
+                errors="{{counts.errors}}"
+                failures="{{counts.failures}}"
+                time="{{time}}s"
+              >
+                {{#testcases}}
+                  <testcase
+                    name="{{name}}"
+                    assertions="{{assert}}"
+                    classname="{{classname}}"
+                    status=""
+                    time="{{time}}s"
+                  >
+                    {{#errors}}
+                      <error
+                        message="{{message}}"
+                        type="{{type}}"
+                      ></error>
+                    {{/errors}}
+                    {{#failures}}
+                      <failure
+                        message="{{message}}"
+                        type="{{type}}"
+                        ></failure>
+                    {{/failures}}
+                  </testcase>
+                {{/testcases}}
+              </testsuite>
+            {{/testsuites}}
+          </testsuites>
+        XML
+
+        def initialize(path_or_io = STDOUT)
+          @path_or_io = path_or_io
+          path_or_io.parent.mkdir_p if path_or_io.is_a?(Path)
+        end
+
+        attr_reader :template_data, :timer_all, :timer_specification, :timer_testcase
+
+        def before_all
+          @timer_all = Time.now
+          @template_data = OpenStruct.new({
+            counts: Hash.new{|h,k| h[k] = 0 },
+            testsuites: []
+          })
+        end
+
+        def after_all
+          template_data.time = Time.now - timer_all
+        end
+
+        def before_specification
+          @timer_specification = Time.now
+          template_data.testsuites << OpenStruct.new({
+            :name => specification.name,
+            :counts => Hash.new{|h,k| h[k] = 0 },
+            :testcases => []
+          })
+        end
+
+        def specification_done
+          template_data.testsuites[-1].time = Time.now - timer_specification
+        end
+
+        def spec_file_error(e)
+          template_data.testsuites[-1].testcases << OpenStruct.new({
+            :name => "Specification can be loaded",
+            :assert => 1,
+            :classname => "Webspicy.Specification",
+            :failures => [],
+            :errors => [OpenStruct.new({
+              :type => e.class,
+              :message => e.message
+            })]
+          })
+        end
+
+        def before_test_case
+          @timer_testcase = Time.now
+          template_data.testsuites[-1].testcases << OpenStruct.new({
+            :name => test_case.description,
+            :assert => test_case.assert.length,
+            :classname => test_case.class.name.to_s.gsub(/::/, "."),
+            :failures => [],
+            :errors => [],
+          })
+          template_data.counts[:total] += 1
+          template_data.testsuites[-1].counts[:total] += 1
+        end
+
+        def test_case_done
+          template_data.testsuites[-1].testcases[-1].time = Time.now - timer_testcase
+        end
+
+        def check_failure(check, ex)
+          template_data.testsuites[-1].testcases[-1].failures << OpenStruct.new({
+            :type => check.class.name,
+            :message => ex.message
+          })
+          template_data.counts[:failures] += 1
+          template_data.testsuites[-1].counts[:failures] += 1
+        end
+
+        def check_error(check, ex)
+          template_data.testsuites[-1].testcases[-1].errors << OpenStruct.new({
+            :type => check.class.name,
+            :message => ex.message
+          })
+          template_data.counts[:errors] += 1
+          template_data.testsuites[-1].counts[:errors] += 1
+        end
+
+        def report
+          require 'mustache'
+          with_io do |io|
+            io << Mustache.render(TPL, template_data)
+          end
+        end
+
+      private
+
+        def with_io(&bl)
+          case io = @path_or_io
+          when IO, StringIO
+            bl.call(io)
+          else
+            Path(io).open('w', &bl)
+          end
+        end
+
+      end # class JunitXmlFile
+    end # class Reporter
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/reporter/progress.rb

@@ -7,7 +7,7 @@ module Webspicy
           io.print colorize_error("X", config)
         end
 
-        def after_each_done
+        def test_case_done
           if result.success?
             io.print colorize_success(".", config)
           elsif result.failure?

data/lib/webspicy/tester/reporter/summary.rb

@@ -26,7 +26,7 @@ module Webspicy
           @spec_file_errors_count += 1
         end
 
-        def after_each_done
+        def test_case_done
           if tester.test_case.counterexample?
             @counterexamples_count += 1
           else

data/lib/webspicy/tester/result.rb

@@ -18,6 +18,7 @@ module Webspicy
           check!
         else
           @errors << [InvocationSuceeded.new(self), tester.invocation_error]
+          reporter.check_error(*errors.first)
         end
       end
       attr_reader :tester, :scope, :client

data/lib/webspicy/version.rb

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

data/lib/webspicy/web/specification.rb

@@ -9,7 +9,7 @@ module Webspicy
 
         def singleservice(raw)
           converted = {
-            name: raw[:name] || "Unamed specification",
+            name: raw[:name],
             url: raw[:url],
             services: [
               Webspicy::Web.service(raw.reject{|k| k==:url or k==:name }, Webspicy.current_scope)

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

@@ -18,7 +18,7 @@ module Webspicy
         }
 
         it 'returns all files' do
-          expect(subject.size).to eql(restful_folder.glob('**/*.yml').size)
+          expect(subject.size).to eql(restful_folder.glob('**/*.{yml, yaml}').size)
         end
       end
 
@@ -59,7 +59,7 @@ module Webspicy
         }
 
         it 'returns all files' do
-          expect(subject.size).to eql(restful_folder.glob('**/*.yml').size)
+          expect(subject.size).to eql(restful_folder.glob('**/*.{yml, yaml}').size)
         end
       end
 

data/spec/unit/tester/fakesendgrid/test_email.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'webspicy/tester/fakesendgrid'
+module Webspicy
+  class Tester
+    class Fakesendgrid
+      describe Email do
+
+        DATA = JSON.parse <<~J
+        {
+          "datetime": "2021-06-02T15:29:27.161Z",
+          "from": {
+            "email": "info@mydomain.be",
+            "name": "Foo Bar"
+          },
+          "subject": "Hello World",
+          "personalizations": [
+            {
+              "to": [
+                {
+                  "email": "support@mydomain.fr"
+                }
+              ]
+            }
+          ],
+          "content": [
+            {
+              "value": "test",
+              "type": "text/plain"
+            },
+            {
+              "value": "test <b>test</b> test",
+              "type": "text/html"
+            }
+          ]
+        }
+        J
+
+        subject{
+          Email.new(DATA)
+        }
+
+        it 'works as expected' do
+          expect(subject.from).to eql("Foo Bar <info@mydomain.be>")
+          expect(subject.to).to eql(["support@mydomain.fr"])
+          expect(subject.subject).to eql("Hello World")
+        end
+
+      end
+    end
+  end
+end

data/spec/unit/tester/fakeses/test_email.rb

@@ -6,9 +6,26 @@ module Webspicy
       describe Email do
 
         DATA = Base64.encode64 <<~J
-          From: Webspicy <noreply@webspicy.io>
-          To: someone@world.com
-          Subject: Hey world, hello!
+        Content-Type: multipart/alternative;
+        boundary="--_NmP-d246fd025a6652c9-Part_1"
+        From: Webspicy <noreply@webspicy.io>
+        To: david.parloir@gmail.com
+        Subject: Hey world, hello!
+        Message-ID: <2421bae3-9c42-7988-23b4-b1f6168130c9@webspicy.io>
+        Date: Thu, 24 Jun 2021 13:45:16 +0000
+        MIME-Version: 1.0
+
+        ----_NmP-d246fd025a6652c9-Part_1
+        Content-Type: text/plain; charset=utf-8
+        Content-Transfer-Encoding: 7bit
+
+        Hello world, in a text version
+        ----_NmP-d246fd025a6652c9-Part_1
+        Content-Type: text/html; charset=utf-8
+        Content-Transfer-Encoding: 7bit
+
+        Hello world, in an html version
+        ----_NmP-d246fd025a6652c9-Part_1--
         J
 
         DATA = JSON.parse <<~J
@@ -29,7 +46,7 @@ module Webspicy
         }
 
         it 'works as expected' do
-          expect(subject.from).to eql("noreply@webspicy.io")
+          expect(subject.from).to eql("Webspicy <noreply@webspicy.io>")
           expect(subject.to).to eql(["someone@world.com"])
           expect(subject.subject).to eql("Hey world, hello!")
         end

data/spec/unit/tester/fakesmtp/test_email.rb

@@ -15,7 +15,7 @@ module Webspicy
             },
             {
               "key": "from",
-              "line": "From: info@mydomain.be"
+              "line": "From: Webspicy <noreply@webspicy.io>"
             },
             {
               "key": "reply-to",
@@ -82,7 +82,7 @@ module Webspicy
         }
 
         it 'works as expected' do
-          expect(subject.from).to eql("info@mydomain.be")
+          expect(subject.from).to eql("Webspicy <noreply@webspicy.io>")
           expect(subject.to).to eql(["support@mydomain.fr"])
           expect(subject.subject).to eql("Hello World")
         end

data/tasks/test.rake

@@ -5,8 +5,12 @@ namespace :test do
 
   desc "Runs unit tests on the library itself"
   RSpec::Core::RakeTask.new(:unit) do |t|
+    require 'path'
+    root_folder = Path.dir.parent
+    test_results = root_folder/"test-results"
+    puts (test_results/"unit-tests.xml").inspect
     t.pattern = "spec/unit/**/test_*.rb"
-    t.rspec_opts = ["-Ilib", "-Ispec/unit", "--color", "--backtrace", "--format=progress"]
+    t.rspec_opts = ["-Ilib", "-Ispec/unit", "--color", "--backtrace", "--format=progress", "--format RspecJunitFormatter", "--out #{test_results}/unit-tests.xml"]
   end
   tests << :unit
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.20.8
+  version: 0.20.13
 platform: ruby
 authors:
 - Bernard Lambeau
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,16 +98,16 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.4.1
 - !ruby/object:Gem::Dependency
   name: path
   requirement: !ruby/object:Gem::Requirement
@@ -126,22 +126,22 @@ dependencies:
   name: rack-robustness
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: mustermann
   requirement: !ruby/object:Gem::Requirement
@@ -198,11 +198,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Webspicy helps testing web services as software operation black boxes
 email: blambeau@gmail.com
 executables:
-- sandr
-- search
 - webspicy
 extensions: []
 extra_rdoc_files: []
@@ -210,8 +222,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- bin/sandr
-- bin/search
 - bin/webspicy
 - doc/1-black-box-scene.md
 - doc/2-black-box-testing.md
@@ -251,6 +261,8 @@ files:
 - lib/webspicy/tester/assertions.rb
 - lib/webspicy/tester/client.rb
 - lib/webspicy/tester/failure.rb
+- lib/webspicy/tester/fakesendgrid.rb
+- lib/webspicy/tester/fakesendgrid/email.rb
 - lib/webspicy/tester/fakeses.rb
 - lib/webspicy/tester/fakeses/email.rb
 - lib/webspicy/tester/fakesmtp.rb
@@ -263,6 +275,7 @@ files:
 - lib/webspicy/tester/reporter/exceptions.rb
 - lib/webspicy/tester/reporter/file_progress.rb
 - lib/webspicy/tester/reporter/file_summary.rb
+- lib/webspicy/tester/reporter/junit_xml_file.rb
 - lib/webspicy/tester/reporter/progress.rb
 - lib/webspicy/tester/reporter/success_or_not.rb
 - lib/webspicy/tester/reporter/summary.rb
@@ -312,6 +325,7 @@ files:
 - spec/unit/support/world/fixtures/yaml.yml
 - spec/unit/support/world/test_world.rb
 - spec/unit/test_configuration.rb
+- spec/unit/tester/fakesendgrid/test_email.rb
 - spec/unit/tester/fakeses/test_email.rb
 - spec/unit/tester/fakesmtp/test_email.rb
 - spec/unit/tester/test_asserter.rb
@@ -326,7 +340,7 @@ homepage: http://github.com/enspirit/webspicy
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -341,8 +355,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key:
+rubygems_version: 3.2.15
+signing_key: 
 specification_version: 4
 summary: Webspicy helps testing web services as software operation black boxes!
 test_files: []

data/bin/sandr

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-require 'path'
-
-def sandr(file)
-  file.write file.read.gsub(ARGV[0], ARGV[1])
-end
-
-Path.dir.parent.glob("lib/**/*.rb") do |file|
-  sandr(file)
-end
-
-Path.dir.parent.glob("spec/**/*.rb") do |file|
-  sandr(file)
-end

data/bin/search

@@ -1,2 +0,0 @@
-#!/bin/bash
-grep -Rn --color $1 lib spec