webspicy 0.18.0 → 0.20.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. checksums.yaml +4 -4
  2. data/bin/webspicy +6 -1
  3. data/doc/1-black-box-scene.md +109 -0
  4. data/doc/2-black-box-testing.md +27 -0
  5. data/doc/3-specification-importance.md +41 -0
  6. data/doc/4-sequence-diagram.md +82 -0
  7. data/lib/webspicy.rb +17 -9
  8. data/lib/webspicy/configuration.rb +48 -8
  9. data/lib/webspicy/configuration/scope.rb +22 -8
  10. data/lib/webspicy/formaldoc.fio +5 -5
  11. data/lib/webspicy/specification.rb +5 -2
  12. data/lib/webspicy/specification/condition.rb +48 -0
  13. data/lib/webspicy/specification/err.rb +18 -0
  14. data/lib/webspicy/specification/oldies.rb +4 -0
  15. data/lib/webspicy/specification/oldies/bridge.rb +32 -0
  16. data/lib/webspicy/specification/{errcondition.rb → oldies/errcondition.rb} +6 -0
  17. data/lib/webspicy/specification/{postcondition.rb → oldies/postcondition.rb} +6 -0
  18. data/lib/webspicy/specification/{precondition.rb → oldies/precondition.rb} +6 -2
  19. data/lib/webspicy/specification/post.rb +20 -0
  20. data/lib/webspicy/specification/post/missing_condition_impl.rb +15 -0
  21. data/lib/webspicy/specification/post/unexpected_condition_impl.rb +15 -0
  22. data/lib/webspicy/specification/pre.rb +19 -0
  23. data/lib/webspicy/specification/{precondition → pre}/global_request_headers.rb +4 -4
  24. data/lib/webspicy/specification/{precondition → pre}/robust_to_invalid_input.rb +4 -4
  25. data/lib/webspicy/specification/service.rb +34 -5
  26. data/lib/webspicy/specification/test_case.rb +11 -9
  27. data/lib/webspicy/support.rb +31 -0
  28. data/lib/webspicy/support/hooks.rb +65 -0
  29. data/lib/webspicy/support/world.rb +47 -0
  30. data/lib/webspicy/tester.rb +202 -3
  31. data/lib/webspicy/tester/assertions.rb +2 -2
  32. data/lib/webspicy/tester/client.rb +4 -50
  33. data/lib/webspicy/tester/fakeses.rb +41 -0
  34. data/lib/webspicy/tester/fakeses/email.rb +38 -0
  35. data/lib/webspicy/tester/fakesmtp.rb +39 -0
  36. data/lib/webspicy/tester/fakesmtp/email.rb +27 -0
  37. data/lib/webspicy/tester/file_checker.rb +22 -0
  38. data/lib/webspicy/tester/invocation.rb +15 -48
  39. data/lib/webspicy/tester/reporter.rb +85 -0
  40. data/lib/webspicy/tester/reporter/composite.rb +38 -0
  41. data/lib/webspicy/tester/reporter/documentation.rb +74 -0
  42. data/lib/webspicy/tester/reporter/error_count.rb +25 -0
  43. data/lib/webspicy/tester/reporter/exceptions.rb +62 -0
  44. data/lib/webspicy/tester/reporter/file_progress.rb +25 -0
  45. data/lib/webspicy/tester/reporter/file_summary.rb +43 -0
  46. data/lib/webspicy/tester/reporter/progress.rb +30 -0
  47. data/lib/webspicy/tester/reporter/summary.rb +63 -0
  48. data/lib/webspicy/tester/result.rb +142 -0
  49. data/lib/webspicy/tester/result/assert_met.rb +29 -0
  50. data/lib/webspicy/tester/result/check.rb +33 -0
  51. data/lib/webspicy/tester/result/errcondition_met.rb +29 -0
  52. data/lib/webspicy/tester/result/error_schema_met.rb +25 -0
  53. data/lib/webspicy/tester/result/invocation_succeeded.rb +13 -0
  54. data/lib/webspicy/tester/result/output_schema_met.rb +25 -0
  55. data/lib/webspicy/tester/result/postcondition_met.rb +29 -0
  56. data/lib/webspicy/tester/result/response_header_met.rb +43 -0
  57. data/lib/webspicy/tester/result/response_status_met.rb +25 -0
  58. data/lib/webspicy/version.rb +2 -2
  59. data/lib/webspicy/web.rb +4 -0
  60. data/lib/webspicy/web/client.rb +15 -0
  61. data/lib/webspicy/{tester → web}/client/http_client.rb +34 -14
  62. data/lib/webspicy/{tester → web}/client/rack_test_client.rb +3 -3
  63. data/lib/webspicy/{tester → web}/client/support.rb +2 -2
  64. data/lib/webspicy/web/invocation.rb +69 -0
  65. data/lib/webspicy/web/mocker.rb +90 -0
  66. data/lib/webspicy/{mocker → web/mocker}/config.ru +3 -2
  67. data/lib/webspicy/{openapi.rb → web/openapi.rb} +0 -0
  68. data/lib/webspicy/web/openapi/generator.rb +129 -0
  69. data/spec/unit/specification/{precondition → pre}/test_global_request_headers.rb +9 -4
  70. data/spec/unit/specification/test_condition.rb +44 -0
  71. data/spec/unit/support/hooks/test_fire_after_each.rb +53 -0
  72. data/spec/unit/{tester/client/test_around.rb → support/hooks/test_fire_around.rb} +15 -10
  73. data/spec/unit/support/hooks/test_fire_before_each.rb +53 -0
  74. data/spec/unit/support/world/fixtures/array.json +8 -0
  75. data/spec/unit/support/world/fixtures/queue.rb +1 -0
  76. data/spec/unit/support/world/fixtures/single.json +11 -0
  77. data/spec/unit/support/world/fixtures/yaml.yml +3 -0
  78. data/spec/unit/support/world/test_world.rb +56 -0
  79. data/spec/unit/test_configuration.rb +49 -0
  80. data/spec/unit/tester/fakeses/test_email.rb +40 -0
  81. data/spec/unit/web/mocker/test_mocker.rb +35 -0
  82. data/spec/unit/web/openapi/test_generator.rb +31 -0
  83. metadata +80 -65
  84. data/examples/restful/Gemfile +0 -5
  85. data/examples/restful/Rakefile +0 -25
  86. data/examples/restful/app.rb +0 -180
  87. data/examples/restful/webspicy/config.rb +0 -24
  88. data/examples/restful/webspicy/formaldef/todo/_one/delete.yml +0 -55
  89. data/examples/restful/webspicy/formaldef/todo/_one/get.simpler.yml +0 -46
  90. data/examples/restful/webspicy/formaldef/todo/_one/get.yml +0 -50
  91. data/examples/restful/webspicy/formaldef/todo/_one/patch.yml +0 -66
  92. data/examples/restful/webspicy/formaldef/todo/_one/put.yml +0 -65
  93. data/examples/restful/webspicy/formaldef/todo/get.yml +0 -36
  94. data/examples/restful/webspicy/formaldef/todo/options.yml +0 -32
  95. data/examples/restful/webspicy/formaldef/todo/post.csv.yml +0 -43
  96. data/examples/restful/webspicy/formaldef/todo/post.file.yml +0 -40
  97. data/examples/restful/webspicy/formaldef/todo/post.yml +0 -51
  98. data/examples/restful/webspicy/formaldef/todo/todos.csv +0 -4
  99. data/examples/restful/webspicy/rack.rb +0 -7
  100. data/examples/restful/webspicy/real.rb +0 -8
  101. data/examples/restful/webspicy/schema.fio +0 -20
  102. data/examples/restful/webspicy/support/must_be_an_admin.rb +0 -20
  103. data/examples/restful/webspicy/support/must_be_authenticated.rb +0 -48
  104. data/examples/restful/webspicy/support/todo_not_removed.rb +0 -21
  105. data/examples/restful/webspicy/support/todo_removed.rb +0 -20
  106. data/examples/single_spec/spec.yml +0 -59
  107. data/examples/website/config.rb +0 -2
  108. data/examples/website/schema.fio +0 -1
  109. data/examples/website/specification/get-http.yml +0 -30
  110. data/examples/website/specification/get-https.yml +0 -30
  111. data/lib/webspicy/checker.rb +0 -10
  112. data/lib/webspicy/mocker.rb +0 -88
  113. data/lib/webspicy/openapi/generator.rb +0 -127
  114. data/lib/webspicy/rspec/checker.rb +0 -2
  115. data/lib/webspicy/rspec/checker/rspec_checker.rb +0 -24
  116. data/lib/webspicy/rspec/support/rspec_runnable.rb +0 -27
  117. data/lib/webspicy/rspec/tester.rb +0 -4
  118. data/lib/webspicy/rspec/tester/rspec_asserter.rb +0 -121
  119. data/lib/webspicy/rspec/tester/rspec_matchers.rb +0 -114
  120. data/lib/webspicy/rspec/tester/rspec_tester.rb +0 -63
  121. data/spec/unit/mocker/test_mocker.rb +0 -32
  122. data/spec/unit/openapi/test_generator.rb +0 -28
@@ -0,0 +1,41 @@
1
+ require 'base64'
2
+
3
+ module Webspicy
4
+ class Tester
5
+ class Fakeses
6
+ include Webspicy::Support::World::Item
7
+
8
+ DEFAULT_OPTIONS = {
9
+ endpoint: "http://fake-ses/_/api"
10
+ }
11
+
12
+ def initialize(options = {})
13
+ @options = DEFAULT_OPTIONS.merge(options)
14
+ end
15
+ attr_reader :options
16
+
17
+ def endpoint
18
+ options[:endpoint]
19
+ end
20
+
21
+ def clear!
22
+ res = HTTP.post("#{endpoint}/reset")
23
+ end
24
+
25
+ def emails
26
+ res = HTTP.get("#{endpoint}/emails")
27
+ JSON.parse(res.body).map{|data| Email.new(data) }
28
+ end
29
+
30
+ def emails_count
31
+ emails.length
32
+ end
33
+
34
+ def last_email
35
+ emails.last
36
+ end
37
+
38
+ end # class Fakeses
39
+ end # class Tester
40
+ end # module Websipcy
41
+ require_relative 'fakeses/email'
@@ -0,0 +1,38 @@
1
+ module Webspicy
2
+ class Tester
3
+ class Fakeses
4
+ class Email
5
+
6
+ def initialize(data)
7
+ @data = data
8
+ end
9
+ attr_reader :data
10
+
11
+ def from
12
+ data["body"]["Source"]
13
+ end
14
+
15
+ def to
16
+ data["body"]
17
+ .each_pair
18
+ .select{|(k,v)|
19
+ k =~ /Destinations.member/
20
+ }
21
+ .map{|(k,v)| v }
22
+ end
23
+
24
+ def subject
25
+ rx = /^Subject:\s*(.*)$/
26
+ raw_data
27
+ .each_line
28
+ .find{|l| l =~ rx }[rx, 1]
29
+ end
30
+
31
+ def raw_data
32
+ @raw_data ||= Base64.decode64(data["body"]["RawMessage.Data"])
33
+ end
34
+
35
+ end # class Email
36
+ end # class Fakeses
37
+ end # class Tester
38
+ end # module Webspicy
@@ -0,0 +1,39 @@
1
+ module Webspicy
2
+ class Tester
3
+ class Fakesmtp
4
+ include Webspicy::Support::World::Item
5
+
6
+ DEFAULT_OPTIONS = {
7
+ endpoint: "http://fakesmtp"
8
+ }
9
+
10
+ def initialize(options = {})
11
+ @options = DEFAULT_OPTIONS.merge(options)
12
+ end
13
+ attr_reader :options
14
+
15
+ def endpoint
16
+ options[:endpoint]
17
+ end
18
+
19
+ def clear!
20
+ res = HTTP.delete("#{endpoint}/emails")
21
+ end
22
+
23
+ def emails
24
+ res = HTTP.get("#{endpoint}/emails")
25
+ JSON.parse(res.body).map{|data| Email.new(data) }
26
+ end
27
+
28
+ def emails_count
29
+ emails.length
30
+ end
31
+
32
+ def last_email
33
+ emails.last
34
+ end
35
+
36
+ end # class Fakesmtp
37
+ end # class Tester
38
+ end # module Webspicy
39
+ require_relative 'fakesmtp/email'
@@ -0,0 +1,27 @@
1
+ module Webspicy
2
+ class Tester
3
+ class Fakesmtp
4
+ class Email
5
+
6
+ def initialize(data)
7
+ @data = data
8
+ end
9
+ attr_reader :data
10
+
11
+ def from
12
+ @from ||= data["headerLines"]
13
+ .select{|h| h["key"] == "from" }
14
+ .map{|h| h["line"][/From:\s*(.*)$/, 1] }
15
+ .first
16
+ end
17
+
18
+ def to
19
+ @to ||= data["headerLines"]
20
+ .select{|h| h["key"] == "to" }
21
+ .map{|h| h["line"][/To:\s*(.*)$/, 1] }
22
+ end
23
+
24
+ end # class Email
25
+ end # class Fakesmtp
26
+ end # class Tester
27
+ end # module Webspicy
@@ -0,0 +1,22 @@
1
+ module Webspicy
2
+ class Tester
3
+ class FileChecker < Tester
4
+
5
+ def default_reporter
6
+ @reporter = Reporter::Composite.new
7
+ @reporter << Reporter::FileProgress.new
8
+ @reporter << Reporter::Exceptions.new
9
+ @reporter << Reporter::FileSummary.new
10
+ @reporter << Reporter::ErrorCount.new
11
+ end
12
+
13
+ def run_scope
14
+ scope.each_specification_file do |spec_file|
15
+ @specification = load_specification(spec_file)
16
+ reporter.spec_file_done
17
+ end
18
+ end
19
+
20
+ end # class FileChecker
21
+ end # class Tester
22
+ end # module Webspicy
@@ -1,68 +1,35 @@
1
1
  module Webspicy
2
2
  class Tester
3
3
  class Invocation
4
+ extend Forwardable
4
5
 
5
6
  def initialize(test_case, response, client)
6
7
  @test_case = test_case
7
8
  @response = response
8
9
  @client = client
9
10
  end
10
-
11
11
  attr_reader :test_case, :response, :client
12
12
 
13
- def service
14
- test_case.service
15
- end
16
-
17
- ### Getters on response
13
+ def_delegators :@client, *[
14
+ :config
15
+ ]
18
16
 
19
- def response_code
20
- code = response.status
21
- code = code.code unless code.is_a?(Integer)
22
- code
23
- end
24
-
25
- ### Query methods
26
-
27
- def done?
28
- !response.nil?
29
- end
30
-
31
- def is_expected_success?
32
- test_case.expected_status.to_i >= 200 && test_case.expected_status.to_i < 300
33
- end
34
-
35
- def is_success?
36
- response_code >= 200 && response_code < 300
37
- end
38
-
39
- def is_empty_response?
40
- response_code == 204
41
- end
17
+ def_delegators :@test_case, *[
18
+ :scope,
19
+ :specification,
20
+ :service
21
+ ]
42
22
 
43
- def is_redirect?
44
- response_code >= 300 && response_code < 400
23
+ def raw_output
24
+ raise NotImplementedError
45
25
  end
46
26
 
47
- def loaded_body
48
- ct = response.content_type || test_case.expected_content_type
49
- ct = ct.mime_type if ct.respond_to?(:mime_type)
50
- case ct
51
- when %r{json}
52
- raise "Body empty while expected" if response.body.to_s.empty?
53
- @loaded_body ||= ::JSON.parse(response.body)
54
- else
55
- response.body.to_s
56
- end
27
+ def loaded_output
28
+ raise NotImplementedError
57
29
  end
58
30
 
59
- def dressed_body
60
- schema = is_expected_success? ? service.output_schema : service.error_schema
61
- begin
62
- schema.dress(loaded_body)
63
- rescue Finitio::TypeError => ex
64
- ex
65
- end
31
+ def output
32
+ raise NotImplementedError
66
33
  end
67
34
 
68
35
  end # class Invocation
@@ -0,0 +1,85 @@
1
+ module Webspicy
2
+ class Tester
3
+ class Reporter
4
+ include Support::Colorize
5
+
6
+ def initialize(io = STDOUT)
7
+ @io = io
8
+ end
9
+ attr_reader :io
10
+
11
+ def init(tester)
12
+ @tester = tester
13
+ end
14
+ attr_reader :tester
15
+
16
+ [
17
+ :config,
18
+ :scope,
19
+ :client,
20
+ :spec_file,
21
+ :specification,
22
+ :service,
23
+ :test_case,
24
+ :invocation,
25
+ :result
26
+ ].each do |meth|
27
+ define_method(meth) do |*args, &bl|
28
+ tester.send(meth, *args, &bl)
29
+ end
30
+ end
31
+
32
+ HOOKS = [
33
+ :before_all,
34
+ :before_all_done,
35
+ :before_scope,
36
+ :scope_done,
37
+ :before_spec_file,
38
+ :spec_file_error,
39
+ :spec_file_done,
40
+ :before_specification,
41
+ :specification_done,
42
+ :before_service,
43
+ :service_done,
44
+ :before_test_case,
45
+ :test_case_done,
46
+ :before_each,
47
+ :before_each_done,
48
+ :before_instrument,
49
+ :instrument_done,
50
+ :before_invocation,
51
+ :invocation_done,
52
+ :before_assertions,
53
+ :check_success,
54
+ :check_failure,
55
+ :check_error,
56
+ :assertions_done,
57
+ :after_each,
58
+ :after_each_done,
59
+ :after_all,
60
+ :after_all_done,
61
+ :report
62
+ ]
63
+
64
+ HOOKS.each do |meth|
65
+ define_method(meth){|*args, &bl|
66
+ }
67
+ end
68
+
69
+ protected
70
+
71
+ def plural(word, count)
72
+ "%d #{word}#{count>1 ? 's' : ''}" % [count]
73
+ end
74
+
75
+ end # class Reporter
76
+ end # class Tester
77
+ end # module Webspicy
78
+ require_relative 'reporter/error_count'
79
+ require_relative 'reporter/progress'
80
+ require_relative 'reporter/summary'
81
+ require_relative 'reporter/documentation'
82
+ require_relative 'reporter/exceptions'
83
+ require_relative 'reporter/composite'
84
+ require_relative 'reporter/file_progress'
85
+ require_relative 'reporter/file_summary'
@@ -0,0 +1,38 @@
1
+ module Webspicy
2
+ class Tester
3
+ class Reporter
4
+ class Composite < Reporter
5
+
6
+ def initialize(*args, &bl)
7
+ super
8
+ @reporters = []
9
+ end
10
+
11
+ def <<(reporter)
12
+ @reporters << reporter
13
+ self
14
+ end
15
+
16
+ def init(tester)
17
+ super
18
+ @reporters.each do |r|
19
+ r.init(tester)
20
+ end
21
+ end
22
+
23
+ HOOKS.each do |meth|
24
+ define_method(meth) do |*args, &bl|
25
+ @reporters.each do |r|
26
+ r.send(meth, *args, &bl)
27
+ end
28
+ end
29
+ end
30
+
31
+ def find(kind)
32
+ @reporters.find{|r| r.is_a?(kind) }
33
+ end
34
+
35
+ end # class Composite
36
+ end # class Reporter
37
+ end # class Tester
38
+ end # module Webspicy
@@ -0,0 +1,74 @@
1
+ module Webspicy
2
+ class Tester
3
+ class Reporter
4
+ class Documentation < Reporter
5
+
6
+ module Helpers
7
+ def spec_file_error_line(spec_file, ex)
8
+ str = colorize_highlight(spec_file.to_s)
9
+ str += "\n " + colorize_error("X #{ex.message}")
10
+ if ex.root_cause && ex.root_cause != ex
11
+ str += "\n " + colorize_error("#{ex.root_cause.message}")
12
+ end
13
+ str
14
+ end
15
+
16
+ def service_line(service, test_case)
17
+ str = service.to_s + ", " + test_case.to_s
18
+ str = colorize_highlight(str)
19
+ end
20
+
21
+ def check_success_line(check)
22
+ " " + colorize_success("v") + " " + check.behavior
23
+ end
24
+
25
+ def check_failure_line(check, ex)
26
+ " " + colorize_error("F " + ex.message)
27
+ end
28
+
29
+ def check_error_line(check, ex)
30
+ " " + colorize_error("E " + ex.message)
31
+ end
32
+ end
33
+ include Helpers
34
+
35
+ def spec_file_error(e)
36
+ io.puts spec_file_error_line(spec_file, e)
37
+ io.puts
38
+ io.flush
39
+ end
40
+
41
+ def before_test_case
42
+ io.puts service_line(service, test_case)
43
+ io.flush
44
+ end
45
+
46
+ def check_success(check)
47
+ io.puts check_success_line(check)
48
+ io.flush
49
+ end
50
+
51
+ def check_failure(check, ex)
52
+ io.puts check_failure_line(check, ex)
53
+ io.flush
54
+ end
55
+
56
+ def check_error(check, ex)
57
+ io.puts check_error_line(check, ex)
58
+ io.flush
59
+ end
60
+
61
+ def test_case_done
62
+ io.puts
63
+ io.flush
64
+ end
65
+
66
+ def service_done
67
+ io.puts
68
+ io.flush
69
+ end
70
+
71
+ end # class Documentation
72
+ end # class Reporter
73
+ end # class Tester
74
+ end # module Webspicy