webspicy 0.16.3 → 0.20.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -3
  3. data/bin/webspicy +6 -1
  4. data/doc/1-black-box-scene.md +109 -0
  5. data/doc/2-black-box-testing.md +27 -0
  6. data/doc/3-specification-importance.md +41 -0
  7. data/doc/4-sequence-diagram.md +82 -0
  8. data/lib/webspicy.rb +18 -9
  9. data/lib/webspicy/configuration.rb +57 -8
  10. data/lib/webspicy/configuration/scope.rb +22 -16
  11. data/lib/webspicy/formaldoc.fio +7 -5
  12. data/lib/webspicy/specification.rb +10 -9
  13. data/lib/webspicy/specification/condition.rb +48 -0
  14. data/lib/webspicy/specification/err.rb +18 -0
  15. data/lib/webspicy/specification/oldies.rb +4 -0
  16. data/lib/webspicy/specification/oldies/bridge.rb +29 -0
  17. data/lib/webspicy/specification/oldies/errcondition.rb +22 -0
  18. data/lib/webspicy/specification/{postcondition.rb → oldies/postcondition.rb} +6 -0
  19. data/lib/webspicy/specification/{precondition.rb → oldies/precondition.rb} +6 -2
  20. data/lib/webspicy/specification/post.rb +20 -0
  21. data/lib/webspicy/specification/post/missing_condition_impl.rb +15 -0
  22. data/lib/webspicy/specification/post/unexpected_condition_impl.rb +15 -0
  23. data/lib/webspicy/specification/pre.rb +19 -0
  24. data/lib/webspicy/specification/{precondition → pre}/global_request_headers.rb +4 -4
  25. data/lib/webspicy/specification/{precondition → pre}/robust_to_invalid_input.rb +4 -4
  26. data/lib/webspicy/specification/service.rb +58 -24
  27. data/lib/webspicy/specification/test_case.rb +10 -17
  28. data/lib/webspicy/support.rb +32 -0
  29. data/lib/webspicy/support/data_object.rb +25 -0
  30. data/lib/webspicy/support/hooks.rb +65 -0
  31. data/lib/webspicy/support/world.rb +47 -0
  32. data/lib/webspicy/tester.rb +180 -60
  33. data/lib/webspicy/tester/asserter.rb +9 -4
  34. data/lib/webspicy/tester/assertions.rb +8 -9
  35. data/lib/webspicy/tester/client.rb +4 -50
  36. data/lib/webspicy/tester/failure.rb +6 -0
  37. data/lib/webspicy/tester/fakeses.rb +41 -0
  38. data/lib/webspicy/tester/fakeses/email.rb +38 -0
  39. data/lib/webspicy/tester/fakesmtp.rb +39 -0
  40. data/lib/webspicy/tester/fakesmtp/email.rb +27 -0
  41. data/lib/webspicy/tester/file_checker.rb +22 -0
  42. data/lib/webspicy/tester/invocation.rb +15 -196
  43. data/lib/webspicy/tester/reporter.rb +85 -0
  44. data/lib/webspicy/tester/reporter/composite.rb +38 -0
  45. data/lib/webspicy/tester/reporter/documentation.rb +74 -0
  46. data/lib/webspicy/tester/reporter/error_count.rb +25 -0
  47. data/lib/webspicy/tester/reporter/exceptions.rb +62 -0
  48. data/lib/webspicy/tester/reporter/file_progress.rb +25 -0
  49. data/lib/webspicy/tester/reporter/file_summary.rb +43 -0
  50. data/lib/webspicy/tester/reporter/progress.rb +30 -0
  51. data/lib/webspicy/tester/reporter/summary.rb +63 -0
  52. data/lib/webspicy/tester/result.rb +142 -0
  53. data/lib/webspicy/tester/result/assert_met.rb +29 -0
  54. data/lib/webspicy/tester/result/check.rb +33 -0
  55. data/lib/webspicy/tester/result/errcondition_met.rb +29 -0
  56. data/lib/webspicy/tester/result/error_schema_met.rb +25 -0
  57. data/lib/webspicy/tester/result/invocation_succeeded.rb +13 -0
  58. data/lib/webspicy/tester/result/output_schema_met.rb +25 -0
  59. data/lib/webspicy/tester/result/postcondition_met.rb +29 -0
  60. data/lib/webspicy/tester/result/response_header_met.rb +43 -0
  61. data/lib/webspicy/tester/result/response_status_met.rb +25 -0
  62. data/lib/webspicy/version.rb +2 -2
  63. data/lib/webspicy/web.rb +4 -0
  64. data/lib/webspicy/web/client.rb +15 -0
  65. data/lib/webspicy/{tester → web}/client/http_client.rb +34 -14
  66. data/lib/webspicy/{tester → web}/client/rack_test_client.rb +3 -3
  67. data/lib/webspicy/{tester → web}/client/support.rb +2 -2
  68. data/lib/webspicy/web/invocation.rb +68 -0
  69. data/lib/webspicy/web/mocker.rb +90 -0
  70. data/lib/webspicy/{mocker → web/mocker}/config.ru +3 -2
  71. data/lib/webspicy/{openapi.rb → web/openapi.rb} +0 -0
  72. data/lib/webspicy/web/openapi/generator.rb +129 -0
  73. data/spec/unit/configuration/scope/test_each_service.rb +2 -2
  74. data/spec/unit/configuration/scope/test_each_specification.rb +7 -7
  75. data/spec/unit/specification/{precondition → pre}/test_global_request_headers.rb +9 -4
  76. data/spec/unit/specification/test_condition.rb +44 -0
  77. data/spec/unit/support/hooks/test_fire_after_each.rb +53 -0
  78. data/spec/unit/{tester/client/test_around.rb → support/hooks/test_fire_around.rb} +15 -10
  79. data/spec/unit/support/hooks/test_fire_before_each.rb +53 -0
  80. data/spec/unit/support/world/fixtures/array.json +8 -0
  81. data/spec/unit/support/world/fixtures/queue.rb +1 -0
  82. data/spec/unit/support/world/fixtures/single.json +11 -0
  83. data/spec/unit/support/world/fixtures/yaml.yml +3 -0
  84. data/spec/unit/support/world/test_world.rb +56 -0
  85. data/spec/unit/test_configuration.rb +50 -1
  86. data/spec/unit/tester/fakeses/test_email.rb +40 -0
  87. data/spec/unit/tester/test_asserter.rb +198 -3
  88. data/spec/unit/tester/test_assertions.rb +8 -6
  89. data/spec/unit/web/mocker/test_mocker.rb +35 -0
  90. data/spec/unit/web/openapi/test_generator.rb +31 -0
  91. metadata +90 -67
  92. data/examples/restful/Gemfile +0 -5
  93. data/examples/restful/Gemfile.lock +0 -105
  94. data/examples/restful/Rakefile +0 -25
  95. data/examples/restful/app.rb +0 -180
  96. data/examples/restful/webspicy/config.rb +0 -23
  97. data/examples/restful/webspicy/rack.rb +0 -7
  98. data/examples/restful/webspicy/real.rb +0 -8
  99. data/examples/restful/webspicy/schema.fio +0 -20
  100. data/examples/restful/webspicy/support/must_be_an_admin.rb +0 -20
  101. data/examples/restful/webspicy/support/must_be_authenticated.rb +0 -48
  102. data/examples/restful/webspicy/support/todo_removed.rb +0 -18
  103. data/examples/restful/webspicy/todo/deleteTodo.yml +0 -52
  104. data/examples/restful/webspicy/todo/getTodo.yml +0 -50
  105. data/examples/restful/webspicy/todo/getTodoSingleServiceFormat.yml +0 -46
  106. data/examples/restful/webspicy/todo/getTodos.yml +0 -36
  107. data/examples/restful/webspicy/todo/options.yml +0 -32
  108. data/examples/restful/webspicy/todo/patchTodo.yml +0 -66
  109. data/examples/restful/webspicy/todo/postCsv.yml +0 -43
  110. data/examples/restful/webspicy/todo/postFile.yml +0 -40
  111. data/examples/restful/webspicy/todo/postTodos.yml +0 -51
  112. data/examples/restful/webspicy/todo/putTodo.yml +0 -65
  113. data/examples/restful/webspicy/todo/todos.csv +0 -4
  114. data/examples/single_spec/spec.yml +0 -59
  115. data/examples/website/config.rb +0 -2
  116. data/examples/website/schema.fio +0 -1
  117. data/examples/website/specification/get-http.yml +0 -30
  118. data/examples/website/specification/get-https.yml +0 -30
  119. data/lib/webspicy/checker.rb +0 -25
  120. data/lib/webspicy/mocker.rb +0 -88
  121. data/lib/webspicy/openapi/generator.rb +0 -127
  122. data/lib/webspicy/tester/rspec_asserter.rb +0 -108
  123. data/lib/webspicy/tester/rspec_matchers.rb +0 -104
  124. data/spec/unit/mocker/test_mocker.rb +0 -32
  125. data/spec/unit/openapi/test_generator.rb +0 -28
@@ -1,108 +0,0 @@
1
- module Webspicy
2
- class Tester
3
- class RSpecAsserter
4
-
5
- def initialize(rspec, invocation)
6
- @rspec = rspec
7
- @invocation = invocation
8
- end
9
- attr_reader :rspec, :invocation
10
-
11
- def response
12
- invocation.response
13
- end
14
-
15
- def test_case
16
- invocation.test_case
17
- end
18
-
19
- def service
20
- test_case.service
21
- end
22
-
23
- def assert!
24
- assert_status_met
25
- assert_content_type_met
26
- assert_expected_headers
27
- assert_output_schema_met
28
- assert_assertions_met
29
- assert_postconditions_met
30
-
31
- assert_no_other_errors
32
- end
33
-
34
- def assert_status_met
35
- got = response.status
36
- expected = test_case.expected_status
37
- rspec.expect(got).to rspec.match_response_status(expected)
38
- end
39
-
40
- def assert_content_type_met
41
- return if test_case.is_expected_status?(204)
42
- return unless ect = test_case.expected_content_type
43
- got = response.content_type
44
- got = got.mime_type if got.respond_to?(:mime_type)
45
- if ect.nil?
46
- rspec.expect(ect).to rspec.have_no_response_type
47
- else
48
- rspec.expect(got).to rspec.match_content_type(ect)
49
- end
50
- end
51
-
52
- def assert_expected_headers
53
- return unless test_case.has_expected_headers?
54
- test_case.expected_headers.each_pair do |k,v|
55
- got = response.headers[k]
56
- if got.nil?
57
- rspec.expect(got).to rspec.be_in_response_headers(k)
58
- else
59
- rspec.expect(got).to rspec.match_response_header(k, v)
60
- end
61
- end
62
- end
63
-
64
- def assert_output_schema_met
65
- return if test_case.is_expected_status?(204)
66
- return if invocation.is_redirect?
67
- if invocation.is_empty_response?
68
- body = response.body.to_s.strip
69
- rspec.expect(body).to rspec.be_an_empty_response_body
70
- else
71
- b = invocation.dressed_body
72
- if invocation.is_expected_success?
73
- rspec.expect(b).to rspec.meet_output_schema
74
- else
75
- rspec.expect(b).to rspec.meet_error_schema
76
- end
77
- end
78
- end
79
-
80
- def assert_assertions_met
81
- return unless test_case.has_assertions?
82
- asserter = Tester::Asserter.new(invocation.dressed_body)
83
- test_case.assert.each do |assert|
84
- begin
85
- asserter.instance_eval(assert)
86
- rescue => ex
87
- rspec.expect(ex).to rspec.meet_assertion(assert)
88
- end
89
- end
90
- end
91
-
92
- def assert_postconditions_met
93
- return unless service.has_postconditions?
94
- return if test_case.counterexample?
95
- service.postconditions.each do |post|
96
- msg = post.check(invocation)
97
- rspec.expect(msg).to rspec.meet_postcondition(post)
98
- end
99
- end
100
-
101
- def assert_no_other_errors
102
- errors = invocation.errors
103
- rspec.expect(errors).to rspec.be_an_empty_errors_array
104
- end
105
-
106
- end # class RSpecAsserter
107
- end # class Tester
108
- end # module Webspicy
@@ -1,104 +0,0 @@
1
- require 'rspec/expectations'
2
-
3
- RSpec::Matchers.define :match_response_status do |expected|
4
- match do |actual|
5
- expected === actual
6
- end
7
- failure_message_for_should do |actual|
8
- "expected response status #{actual} to be #{expected}"
9
- end
10
- end
11
-
12
- RSpec::Matchers.define :have_no_response_type do
13
- match do |actual|
14
- actual.nil?
15
- end
16
- failure_message_for_should do |actual|
17
- "expected Content-Type not to be present"
18
- end
19
- end
20
-
21
- RSpec::Matchers.define :match_content_type do |expected|
22
- match do |actual|
23
- actual.to_s.start_with?(expected.to_s)
24
- end
25
- failure_message_for_should do |actual|
26
- "expected Content-Type to be `#{expected}`, got `#{actual}`"
27
- end
28
- end
29
-
30
- RSpec::Matchers.define :be_in_response_headers do |header_name|
31
- match do |actual|
32
- !actual.nil?
33
- end
34
- failure_message_for_should do |actual|
35
- "expected response header `#{header_name}` to be set"
36
- end
37
- end
38
-
39
- RSpec::Matchers.define :match_response_header do |header_name, expected|
40
- match do |actual|
41
- expected == actual
42
- end
43
- failure_message_for_should do |actual|
44
- "expected response header `#{header_name}` to be `#{expected}`, got `#{actual}`"
45
- end
46
- end
47
-
48
- RSpec::Matchers.define :be_an_empty_response_body do
49
- match do |actual|
50
- actual.empty?
51
- end
52
- failure_message_for_should do |actual|
53
- "expected response body to be empty, started with `#{actual[0..20]}`"
54
- end
55
- end
56
-
57
- RSpec::Matchers.define :meet_output_schema do
58
- match do |actual|
59
- !actual.is_a?(Exception)
60
- end
61
- failure_message_for_should do |actual|
62
- "expected response body to meet output schema, got following error:\n" + \
63
- " #{actual.message}"
64
- end
65
- end
66
-
67
- RSpec::Matchers.define :meet_error_schema do
68
- match do |actual|
69
- !actual.is_a?(Exception)
70
- end
71
- failure_message_for_should do |actual|
72
- "expected response body to meet error schema, got following error:\n" + \
73
- " #{actual.message}"
74
- end
75
- end
76
-
77
- RSpec::Matchers.define :meet_assertion do |assert|
78
- match do |actual|
79
- actual.nil?
80
- end
81
- failure_message_for_should do |actual|
82
- "expected assertion `#{assert}` to be met, got following error:\n" + \
83
- " #{actual.message}"
84
- end
85
- end
86
-
87
- RSpec::Matchers.define :meet_postcondition do |post|
88
- match do |actual|
89
- actual.nil?
90
- end
91
- failure_message_for_should do |actual|
92
- "expected postcondition `#{post.class.name}` to be met, got following error:\n" + \
93
- " #{actual}"
94
- end
95
- end
96
-
97
- RSpec::Matchers.define :be_an_empty_errors_array do
98
- match do |actual|
99
- actual.empty?
100
- end
101
- failure_message_for_should do |actual|
102
- "expected no webspicy error, got the following ones:\n" + actual.map{|a| " #{a}" }.join("\n")
103
- end
104
- end
@@ -1,32 +0,0 @@
1
- require 'spec_helper'
2
- require 'rack/test'
3
- require 'webspicy/mocker'
4
- module Webspicy
5
- describe Mocker do
6
- include Rack::Test::Methods
7
-
8
- let(:app) {
9
- Mocker.new(Configuration.dress(restful_folder))
10
- }
11
-
12
- it 'works as expected' do
13
- get '/todo/'
14
- expect(last_response.status).to eql(200)
15
- expect(last_response.body).not_to be_empty
16
- end
17
-
18
- it 'supports CORS on OPTIONS' do
19
- options '/todo/'
20
- expect(last_response.status).to eql(204)
21
- expect(last_response.body).to be_empty
22
- end
23
-
24
- it 'returns the correct status code, taken from first example' do
25
- delete '/todo/1'
26
- expect(last_response.status).to eql(204)
27
- expect(last_response.body).to be_empty
28
- expect(last_response["Content-Type"]).to be_nil
29
- end
30
-
31
- end
32
- end
@@ -1,28 +0,0 @@
1
- require 'spec_helper'
2
- require 'webspicy/openapi'
3
- require 'openapi3_parser'
4
- module Webspicy
5
- module Openapi
6
- describe Generator do
7
-
8
- let(:config) {
9
- Configuration.new(restful_folder)
10
- }
11
-
12
- subject {
13
- ruby_objs = Generator.new(config).call
14
- JSON.parse(ruby_objs.to_json)
15
- }
16
-
17
- it 'works fine' do
18
- document = Openapi3Parser.load(subject)
19
- #puts JSON.pretty_generate(subject)
20
- document.errors.each do |err|
21
- puts err.inspect
22
- end unless document.errors.empty?
23
- expect(document.errors).to be_empty
24
- end
25
-
26
- end
27
- end
28
- end