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,65 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/{id}
7
-
8
- services:
9
- - method: |-
10
- PUT
11
-
12
- description: |-
13
- Update a single Todo item
14
-
15
- preconditions:
16
- - Must be authenticated
17
-
18
- input_schema: |-
19
- TodoPut
20
-
21
- output_schema: |-
22
- Todo
23
-
24
- error_schema: |-
25
- ErrorSchema
26
-
27
- default_example:
28
- expected:
29
- content_type: application/json
30
- status: 200
31
-
32
- examples:
33
-
34
- - description: |-
35
- when requested on an existing TODO
36
- params:
37
- id: 1
38
- description: 'hello world'
39
- assert:
40
- - "pathFD('', description: 'hello world')"
41
-
42
- counterexamples:
43
-
44
- - description: |-
45
- when requested on an unexisting TODO
46
- params:
47
- id: 999254654
48
- description: 'hello world'
49
- expected:
50
- content_type: application/json
51
- status: 404
52
- assert:
53
- - "pathFD('', error: 'No such todo')"
54
-
55
- - description: |-
56
- when violating the Put data type
57
- params:
58
- id: 1
59
- description: 'hello world'
60
- nosuchone: 'foobar'
61
- dress_params:
62
- false
63
- expected:
64
- content_type: application/json
65
- status: 400
@@ -1,4 +0,0 @@
1
- id,description
2
- 10,Write documentation
3
- 11,Create website
4
- 12,Add smart tools
@@ -1,59 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- http://127.0.0.1:4567/todo/{id}
7
-
8
- services:
9
- - method: |-
10
- GET
11
-
12
- description: |-
13
- Returns a single todo item
14
-
15
- input_schema: |-
16
- {
17
- id: Integer
18
- }
19
-
20
- output_schema: |-
21
- {
22
- id: Integer
23
- description: String
24
- }
25
-
26
- error_schema: |-
27
- {
28
- error: String
29
- }
30
-
31
- examples:
32
-
33
- - description: |-
34
- when requested on an existing TODO
35
- headers:
36
- Accept: application/json
37
- params:
38
- id: 1
39
- expected:
40
- content_type: application/json
41
- status: 200
42
- assert:
43
- - "pathFD('', id: 1)"
44
- - "match('description', /Refactor/)"
45
- - "notMatch('description', /Foo/)"
46
-
47
- counterexamples:
48
-
49
- - description: |-
50
- when requested on an unexisting TODO
51
- headers:
52
- Accept: application/json
53
- params:
54
- id: 999254654
55
- expected:
56
- content_type: application/json
57
- status: 404
58
- assert:
59
- - "pathFD('', error: 'No such todo')"
@@ -1,2 +0,0 @@
1
- Webspicy::Configuration.new{|c|
2
- }
@@ -1 +0,0 @@
1
- @import webspicy/scalars
@@ -1,30 +0,0 @@
1
- ---
2
- url: |-
3
- http://yourbackendisbroken.dev
4
-
5
- method: |-
6
- GET
7
-
8
- description: |-
9
- Redirects to the https version
10
-
11
- input_schema: |-
12
- Any
13
-
14
- output_schema: |-
15
- Any
16
-
17
- error_schema: |-
18
- Any
19
-
20
- examples:
21
-
22
- - description: |-
23
- it works
24
- params:
25
- id: 1
26
- expected:
27
- content_type: text/html
28
- status: 3xx
29
- headers:
30
- Location: https://yourbackendisbroken.dev/?id=1
@@ -1,30 +0,0 @@
1
- ---
2
- url: |-
3
- https://yourbackendisbroken.dev
4
-
5
- method: |-
6
- GET
7
-
8
- description: |-
9
- Returns the web page
10
-
11
- input_schema: |-
12
- Any
13
-
14
- output_schema: |-
15
- Any
16
-
17
- error_schema: |-
18
- Any
19
-
20
- examples:
21
-
22
- - description: |-
23
- it works
24
- params:
25
- id: 1
26
- expected:
27
- content_type: text/html
28
- status: 200
29
- assert:
30
- - notEmpty
@@ -1,25 +0,0 @@
1
- module Webspicy
2
- class Checker
3
-
4
- def initialize(config)
5
- @config = Configuration.dress(config)
6
- end
7
- attr_reader :config
8
-
9
- def call
10
- config.each_scope do |scope|
11
- scope.each_specification_file do |file, folder|
12
- RSpec.describe file.relative_to(folder).to_s do
13
-
14
- it 'meets the formal doc data schema' do
15
- Webspicy.specification(file.load, file, scope)
16
- end
17
-
18
- end
19
- end
20
- end
21
- RSpec::Core::Runner.run config.rspec_options
22
- end
23
-
24
- end
25
- end
@@ -1,88 +0,0 @@
1
- require "finitio/generation"
2
- require "json"
3
- module Webspicy
4
- class Mocker
5
-
6
- def initialize(config)
7
- @config = Configuration.dress(config)
8
- @generator = config.generator || Finitio::Generation.new
9
- end
10
- attr_reader :config, :generator
11
-
12
- def call(env)
13
- req = Rack::Request.new(env)
14
- path = req.path
15
- meth = req.request_method
16
- if meth == "OPTIONS" && has_service?(path)
17
- [204, {}, []]
18
- elsif service = find_service(meth, path)
19
- status = best_status_code(service)
20
- body = status == 204 ? "" : random_body(service, req)
21
- headers = generate_headers(service)
22
- [ status, headers, [ body ].compact ]
23
- else
24
- [404, {}, []]
25
- end
26
- end
27
-
28
- private
29
-
30
- def has_service?(path)
31
- config.each_scope do |scope|
32
- scope.each_specification do |specification|
33
- next unless url_matches?(specification, path)
34
- return true
35
- end
36
- end
37
- return false
38
- end
39
-
40
- def find_service(method, path)
41
- config.each_scope do |scope|
42
- scope.each_specification do |specification|
43
- next unless url_matches?(specification, path)
44
- scope.each_service(specification) do |service|
45
- return service if service.method == method
46
- end
47
- end
48
- end
49
- nil
50
- end
51
-
52
- def generate_headers(service)
53
- {
54
- "Content-Type" => best_content_type(service)
55
- }.delete_if{|k,v| v.nil? }
56
- end
57
-
58
- def best_status_code(service)
59
- if ex = service.examples.first
60
- (ex.expected_status && ex.expected_status.to_i) || 200
61
- else
62
- 200
63
- end
64
- end
65
-
66
- def best_content_type(service)
67
- if ex = service.examples.first
68
- ex.expected_content_type
69
- else
70
- "application/json"
71
- end
72
- end
73
-
74
- def url_matches?(specification, path)
75
- specification.url_pattern.match(path)
76
- end
77
-
78
- def random_body(service, request)
79
- world = OpenStruct.new({
80
- service: service,
81
- request: request
82
- })
83
- data = generator.call(service.output_schema.main, world)
84
- JSON.pretty_generate(data) if data
85
- end
86
-
87
- end # class Mocker
88
- end # module Webspicy
@@ -1,127 +0,0 @@
1
- require "finitio/generation"
2
- require "finitio/json_schema"
3
- module Webspicy
4
- module Openapi
5
- class Generator
6
-
7
- def initialize(config)
8
- @config = Configuration.dress(config)
9
- @generator = config.generator || Finitio::Generation.new
10
- end
11
- attr_reader :config, :generator
12
-
13
- def call
14
- {
15
- openapi: "3.0.2",
16
- info: {
17
- version: "1.0.0",
18
- title: "Hello API"
19
- },
20
- paths: paths
21
- }
22
- end
23
-
24
- private
25
-
26
- def paths
27
- config.each_scope.inject({}) do |paths,scope|
28
- scope.each_specification.inject(paths) do |paths,specification|
29
- paths.merge(path_for(specification)){|k,ps,qs|
30
- ps.merge(qs)
31
- }
32
- end
33
- end
34
- end
35
-
36
- def path_for(specification)
37
- {
38
- specification.url => {
39
- summary: specification.name
40
- }.merge(verbs_for(specification))
41
- }
42
- end
43
-
44
- def verbs_for(specification)
45
- specification.services.inject({}) do |verbs,service|
46
- verb = service.method.downcase
47
- verb_defn = {
48
- description: service.description,
49
- responses: responses_for(service)
50
- }
51
- unless ["get", "options", "delete", "head"].include?(verb)
52
- verb_defn[:requestBody] = request_body_for(service)
53
- end
54
- verbs.merge({ verb => verb_defn })
55
- end
56
- end
57
-
58
- def request_body_for(service)
59
- schema = actual_input_schema(service)
60
- {
61
- required: true,
62
- content: {
63
- "application/json" => {
64
- schema: schema.to_json_schema,
65
- example: generator.call(schema, {})
66
- }
67
- }
68
- }
69
- end
70
-
71
- def responses_for(service)
72
- result = {}
73
- service.examples.each_with_object(result) do |test_case, rs|
74
- rs.merge!(response_for(test_case, false)){|k,r1,r2| r1 }
75
- end
76
- service.counterexamples.each_with_object(result) do |test_case, rs|
77
- rs.merge!(response_for(test_case, true)){|k,r1,r2| r1 }
78
- end
79
- result
80
- end
81
-
82
- def response_for(test_case, counterexample)
83
- res = {
84
- description: test_case.description,
85
- }
86
- status = (test_case.expected_status && test_case.expected_status.to_int) || 200
87
- if test_case.expected_content_type && status != 204
88
- content = {
89
- schema: schema_for(test_case, counterexample)
90
- }
91
- unless counterexample
92
- content[:example] = example_for(test_case, counterexample)
93
- end
94
- res[:content] = {
95
- test_case.expected_content_type => content
96
- }
97
- end
98
- {
99
- status => res
100
- }
101
- end
102
-
103
- def schema_for(test_case, counterexample)
104
- schema = actual_output_schema(test_case, counterexample)
105
- schema.to_json_schema
106
- end
107
-
108
- def example_for(test_case, counterexample)
109
- schema = actual_output_schema(test_case, counterexample)
110
- generator.call(schema, {})
111
- end
112
-
113
- def actual_output_schema(test_case, counterexample)
114
- if counterexample
115
- test_case.service.error_schema['Main']
116
- else
117
- test_case.service.output_schema['Main']
118
- end
119
- end
120
-
121
- def actual_input_schema(service)
122
- service.input_schema['Main']
123
- end
124
-
125
- end # class Generator
126
- end # module Openapi
127
- end # module Webspicy