webspicy 0.17.0 → 0.20.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (124) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -0
  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 +17 -9
  9. data/lib/webspicy/configuration.rb +48 -8
  10. data/lib/webspicy/configuration/scope.rb +22 -8
  11. data/lib/webspicy/formaldoc.fio +5 -5
  12. data/lib/webspicy/specification.rb +5 -2
  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 +32 -0
  17. data/lib/webspicy/specification/{errcondition.rb → oldies/errcondition.rb} +6 -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 +34 -5
  27. data/lib/webspicy/specification/test_case.rb +11 -9
  28. data/lib/webspicy/support.rb +31 -0
  29. data/lib/webspicy/support/hooks.rb +65 -0
  30. data/lib/webspicy/support/world.rb +47 -0
  31. data/lib/webspicy/tester.rb +202 -3
  32. data/lib/webspicy/tester/assertions.rb +2 -2
  33. data/lib/webspicy/tester/client.rb +4 -50
  34. data/lib/webspicy/tester/fakeses.rb +41 -0
  35. data/lib/webspicy/tester/fakeses/email.rb +38 -0
  36. data/lib/webspicy/tester/fakesmtp.rb +39 -0
  37. data/lib/webspicy/tester/fakesmtp/email.rb +27 -0
  38. data/lib/webspicy/tester/file_checker.rb +22 -0
  39. data/lib/webspicy/tester/invocation.rb +15 -48
  40. data/lib/webspicy/tester/reporter.rb +85 -0
  41. data/lib/webspicy/tester/reporter/composite.rb +38 -0
  42. data/lib/webspicy/tester/reporter/documentation.rb +74 -0
  43. data/lib/webspicy/tester/reporter/error_count.rb +25 -0
  44. data/lib/webspicy/tester/reporter/exceptions.rb +62 -0
  45. data/lib/webspicy/tester/reporter/file_progress.rb +25 -0
  46. data/lib/webspicy/tester/reporter/file_summary.rb +43 -0
  47. data/lib/webspicy/tester/reporter/progress.rb +30 -0
  48. data/lib/webspicy/tester/reporter/summary.rb +63 -0
  49. data/lib/webspicy/tester/result.rb +142 -0
  50. data/lib/webspicy/tester/result/assert_met.rb +29 -0
  51. data/lib/webspicy/tester/result/check.rb +33 -0
  52. data/lib/webspicy/tester/result/errcondition_met.rb +29 -0
  53. data/lib/webspicy/tester/result/error_schema_met.rb +25 -0
  54. data/lib/webspicy/tester/result/invocation_succeeded.rb +13 -0
  55. data/lib/webspicy/tester/result/output_schema_met.rb +25 -0
  56. data/lib/webspicy/tester/result/postcondition_met.rb +29 -0
  57. data/lib/webspicy/tester/result/response_header_met.rb +43 -0
  58. data/lib/webspicy/tester/result/response_status_met.rb +25 -0
  59. data/lib/webspicy/version.rb +2 -2
  60. data/lib/webspicy/web.rb +4 -0
  61. data/lib/webspicy/web/client.rb +15 -0
  62. data/lib/webspicy/{tester → web}/client/http_client.rb +34 -14
  63. data/lib/webspicy/{tester → web}/client/rack_test_client.rb +3 -3
  64. data/lib/webspicy/{tester → web}/client/support.rb +2 -2
  65. data/lib/webspicy/web/invocation.rb +69 -0
  66. data/lib/webspicy/web/mocker.rb +90 -0
  67. data/lib/webspicy/{mocker → web/mocker}/config.ru +3 -2
  68. data/lib/webspicy/{openapi.rb → web/openapi.rb} +0 -0
  69. data/lib/webspicy/web/openapi/generator.rb +129 -0
  70. data/spec/unit/specification/{precondition → pre}/test_global_request_headers.rb +9 -4
  71. data/spec/unit/specification/test_condition.rb +44 -0
  72. data/spec/unit/support/hooks/test_fire_after_each.rb +53 -0
  73. data/spec/unit/{tester/client/test_around.rb → support/hooks/test_fire_around.rb} +15 -10
  74. data/spec/unit/support/hooks/test_fire_before_each.rb +53 -0
  75. data/spec/unit/support/world/fixtures/array.json +8 -0
  76. data/spec/unit/support/world/fixtures/queue.rb +1 -0
  77. data/spec/unit/support/world/fixtures/single.json +11 -0
  78. data/spec/unit/support/world/fixtures/yaml.yml +3 -0
  79. data/spec/unit/support/world/test_world.rb +56 -0
  80. data/spec/unit/test_configuration.rb +49 -0
  81. data/spec/unit/tester/fakeses/test_email.rb +40 -0
  82. data/spec/unit/web/mocker/test_mocker.rb +35 -0
  83. data/spec/unit/web/openapi/test_generator.rb +31 -0
  84. metadata +86 -72
  85. data/examples/restful/Gemfile +0 -5
  86. data/examples/restful/Gemfile.lock +0 -106
  87. data/examples/restful/Rakefile +0 -25
  88. data/examples/restful/app.rb +0 -180
  89. data/examples/restful/webspicy/config.rb +0 -24
  90. data/examples/restful/webspicy/formaldef/todo/_one/delete.yml +0 -55
  91. data/examples/restful/webspicy/formaldef/todo/_one/get.simpler.yml +0 -46
  92. data/examples/restful/webspicy/formaldef/todo/_one/get.yml +0 -50
  93. data/examples/restful/webspicy/formaldef/todo/_one/patch.yml +0 -66
  94. data/examples/restful/webspicy/formaldef/todo/_one/put.yml +0 -65
  95. data/examples/restful/webspicy/formaldef/todo/get.yml +0 -36
  96. data/examples/restful/webspicy/formaldef/todo/options.yml +0 -32
  97. data/examples/restful/webspicy/formaldef/todo/post.csv.yml +0 -43
  98. data/examples/restful/webspicy/formaldef/todo/post.file.yml +0 -40
  99. data/examples/restful/webspicy/formaldef/todo/post.yml +0 -51
  100. data/examples/restful/webspicy/formaldef/todo/todos.csv +0 -4
  101. data/examples/restful/webspicy/rack.rb +0 -7
  102. data/examples/restful/webspicy/real.rb +0 -8
  103. data/examples/restful/webspicy/schema.fio +0 -20
  104. data/examples/restful/webspicy/support/must_be_an_admin.rb +0 -20
  105. data/examples/restful/webspicy/support/must_be_authenticated.rb +0 -48
  106. data/examples/restful/webspicy/support/todo_not_removed.rb +0 -21
  107. data/examples/restful/webspicy/support/todo_removed.rb +0 -20
  108. data/examples/single_spec/spec.yml +0 -59
  109. data/examples/website/config.rb +0 -2
  110. data/examples/website/schema.fio +0 -1
  111. data/examples/website/specification/get-http.yml +0 -30
  112. data/examples/website/specification/get-https.yml +0 -30
  113. data/lib/webspicy/checker.rb +0 -10
  114. data/lib/webspicy/mocker.rb +0 -88
  115. data/lib/webspicy/openapi/generator.rb +0 -127
  116. data/lib/webspicy/rspec/checker.rb +0 -2
  117. data/lib/webspicy/rspec/checker/rspec_checker.rb +0 -24
  118. data/lib/webspicy/rspec/support/rspec_runnable.rb +0 -27
  119. data/lib/webspicy/rspec/tester.rb +0 -4
  120. data/lib/webspicy/rspec/tester/rspec_asserter.rb +0 -121
  121. data/lib/webspicy/rspec/tester/rspec_matchers.rb +0 -114
  122. data/lib/webspicy/rspec/tester/rspec_tester.rb +0 -63
  123. data/spec/unit/mocker/test_mocker.rb +0 -32
  124. data/spec/unit/openapi/test_generator.rb +0 -28
@@ -1,5 +0,0 @@
1
- source "https://rubygems.org"
2
-
3
- gem "rake", "~> 12"
4
- gem 'sinatra', "~> 2"
5
- gem "webspicy", path: "../.."
@@ -1,106 +0,0 @@
1
- PATH
2
- remote: ../..
3
- specs:
4
- webspicy (0.17.0)
5
- colorize (~> 0.8.1)
6
- finitio (~> 0.9.0)
7
- http (>= 2)
8
- mustermann (~> 1.0)
9
- mustermann-contrib
10
- openapi3_parser (~> 0.8.2)
11
- path (~> 2.0)
12
- rack-robustness (~> 1.1, >= 1.1.0)
13
- rack-test (~> 0.6.3)
14
- rspec (~> 3.10)
15
- rspec_junit_formatter (~> 0.4.1)
16
-
17
- GEM
18
- remote: https://rubygems.org/
19
- specs:
20
- addressable (2.7.0)
21
- public_suffix (>= 2.0.2, < 5.0)
22
- citrus (3.0.2)
23
- colorize (0.8.1)
24
- commonmarker (0.21.0)
25
- ruby-enum (~> 0.5)
26
- concurrent-ruby (1.1.7)
27
- diff-lcs (1.4.4)
28
- domain_name (0.5.20190701)
29
- unf (>= 0.0.5, < 1.0.0)
30
- ffi (1.14.2)
31
- ffi-compiler (1.0.1)
32
- ffi (>= 1.0.0)
33
- rake
34
- finitio (0.9.1)
35
- citrus (>= 2.4, < 4.0)
36
- hansi (0.2.0)
37
- http (4.4.1)
38
- addressable (~> 2.3)
39
- http-cookie (~> 1.0)
40
- http-form_data (~> 2.2)
41
- http-parser (~> 1.2.0)
42
- http-cookie (1.0.3)
43
- domain_name (~> 0.5)
44
- http-form_data (2.3.0)
45
- http-parser (1.2.3)
46
- ffi-compiler (>= 1.0, < 2.0)
47
- i18n (1.8.7)
48
- concurrent-ruby (~> 1.0)
49
- mustermann (1.1.1)
50
- ruby2_keywords (~> 0.0.1)
51
- mustermann-contrib (1.1.1)
52
- hansi (~> 0.2.0)
53
- mustermann (= 1.1.1)
54
- openapi3_parser (0.8.2)
55
- commonmarker (~> 0.17)
56
- psych (~> 3.1)
57
- path (2.0.1)
58
- psych (3.3.0)
59
- public_suffix (4.0.6)
60
- rack (2.2.3)
61
- rack-protection (2.1.0)
62
- rack
63
- rack-robustness (1.1.0)
64
- rack-test (0.6.3)
65
- rack (>= 1.0)
66
- rake (12.3.3)
67
- rspec (3.10.0)
68
- rspec-core (~> 3.10.0)
69
- rspec-expectations (~> 3.10.0)
70
- rspec-mocks (~> 3.10.0)
71
- rspec-core (3.10.1)
72
- rspec-support (~> 3.10.0)
73
- rspec-expectations (3.10.1)
74
- diff-lcs (>= 1.2.0, < 2.0)
75
- rspec-support (~> 3.10.0)
76
- rspec-mocks (3.10.1)
77
- diff-lcs (>= 1.2.0, < 2.0)
78
- rspec-support (~> 3.10.0)
79
- rspec-support (3.10.1)
80
- rspec_junit_formatter (0.4.1)
81
- rspec-core (>= 2, < 4, != 2.12.0)
82
- ruby-enum (0.8.0)
83
- i18n
84
- ruby2_keywords (0.0.2)
85
- sinatra (2.1.0)
86
- mustermann (~> 1.0)
87
- rack (~> 2.2)
88
- rack-protection (= 2.1.0)
89
- tilt (~> 2.0)
90
- tilt (2.0.10)
91
- unf (0.1.4)
92
- unf_ext
93
- unf_ext (0.0.7.7)
94
-
95
- PLATFORMS
96
- ruby
97
- x86_64-darwin-15
98
- x86_64-darwin-18
99
-
100
- DEPENDENCIES
101
- rake (~> 12)
102
- sinatra (~> 2)
103
- webspicy!
104
-
105
- BUNDLED WITH
106
- 2.2.2
@@ -1,25 +0,0 @@
1
- $LOAD_PATH.unshift File.expand_path("..", __FILE__)
2
- require 'app'
3
-
4
- desc "Checks all .yml definition files"
5
- task :check do
6
- Webspicy::Checker.new(Path.dir/'webspicy').call
7
- end
8
-
9
- namespace :test do
10
- desc "Run all tests directly on Sinatra application using rack/test"
11
- task :rack do
12
- Webspicy::Tester.new(Path.dir/'webspicy/rack.rb').call
13
- end
14
-
15
- desc "Runs all tests on the real web server (must be launched previously)"
16
- task :real do
17
- Webspicy::Tester.new(Path.dir/'webspicy/real.rb').call
18
- end
19
- end
20
-
21
- desc "Runs all checks and tests"
22
- task :test => :check
23
- task :test => :"test:rack"
24
-
25
- task :default => :test
@@ -1,180 +0,0 @@
1
- require 'webspicy'
2
- require 'sinatra'
3
- require 'json'
4
- require 'path'
5
- require 'finitio'
6
- require 'rack/robustness'
7
- require 'csv'
8
-
9
- SCHEMA = Finitio::DEFAULT_SYSTEM.parse (Path.dir/('webspicy/schema.fio')).read
10
-
11
- TODOLIST = [
12
- {
13
- id: 1,
14
- description: "Refactor the framework"
15
- },
16
- {
17
- id: 2,
18
- description: "Write documentation"
19
- }
20
- ]
21
-
22
- disable :show_exceptions
23
- enable :raise_errors
24
-
25
- set :todolist, TODOLIST.dup
26
-
27
- set(:auth) do |role|
28
- condition do
29
- token = env['HTTP_AUTHORIZATION']
30
- case token
31
- when NilClass
32
- halt [
33
- 401,
34
- {'Content-Type' => 'application/json'},
35
- [{ error: "Please log in first" }.to_json]
36
- ]
37
- when "Bearer #{role}"
38
- true
39
- else
40
- halt [
41
- 401,
42
- {'Content-Type' => 'application/json'},
43
- [{ error: "#{role.capitalize} required" }.to_json]
44
- ]
45
- end
46
- end
47
- end
48
-
49
- use Rack::Robustness do |g|
50
- g.no_catch_all
51
- g.status 400
52
- g.content_type 'application/json'
53
- g.body{|ex| { error: ex.message }.to_json }
54
- g.on(Finitio::TypeError)
55
- end
56
-
57
- options '*' do
58
- status 204
59
- ""
60
- end
61
-
62
- post '/reset' do
63
- settings.todolist = TODOLIST.dup
64
- status 200
65
- ""
66
- end
67
-
68
- get '/todo/' do
69
- raise unless request.env['HTTP_ACCEPT'] == 'application/json'
70
- content_type :json
71
- settings.todolist.to_json
72
- end
73
-
74
- post '/todo/', :auth => :user do
75
- content_type :json
76
- case todos = loaded_body
77
- when Array
78
- n = 0
79
- todos.each do |todo|
80
- settings.todolist << todo
81
- n += 1
82
- end
83
- status 201
84
- { count: n }.to_json
85
- when Hash
86
- todo = SCHEMA["Todo"].dress(todos)
87
- if settings.todolist.find{|t| t[:id] == todo[:id] }
88
- status 409
89
- {error: "Identifier already in use"}.to_json
90
- else
91
- settings.todolist << todo
92
- status 201
93
- todo.to_json
94
- end
95
- end
96
- end
97
-
98
- get '/todo/:id' do |id|
99
- raise unless request.env['HTTP_ACCEPT'] == 'application/json'
100
- content_type :json
101
- todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
102
- if todo.nil?
103
- status 404
104
- {error: "No such todo"}.to_json
105
- else
106
- todo.to_json
107
- end
108
- end
109
-
110
- patch '/todo/:id', :auth => :user do |id|
111
- content_type :json
112
- todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
113
- if todo.nil?
114
- status 404
115
- {error: "No such todo"}.to_json
116
- else
117
- patch = SCHEMA["TodoPatch"].dress(loaded_body.merge("id" => Integer(id)))
118
- patched = todo.merge(patch)
119
- settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
120
- settings.todolist << patched
121
- patched.to_json
122
- end
123
- end
124
-
125
- put '/todo/:id', :auth => :user do |id|
126
- content_type :json
127
- todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
128
- if todo.nil?
129
- status 404
130
- {error: "No such todo"}.to_json
131
- else
132
- put = SCHEMA["TodoPut"].dress(loaded_body.merge(id: Integer(id)))
133
- updated = todo.merge(put)
134
- settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
135
- settings.todolist << updated
136
- updated.to_json
137
- end
138
- end
139
-
140
- delete '/todo/:id', :auth => :admin do |id|
141
- content_type :json
142
- todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
143
- if todo.nil?
144
- status 404
145
- {error: "No such todo"}.to_json
146
- else
147
- settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
148
- status 204
149
- content_type "text/plain"
150
- end
151
- end
152
-
153
- ###
154
-
155
- def loaded_body
156
- case ctype = request.content_type
157
- when /json/
158
- JSON.load(request.body.read)
159
- when /csv/
160
- csv = ::CSV.new(request.body.read, :headers => true, :header_converters => :symbol)
161
- csv.map {|row| row.to_hash }
162
- when /multipart\/form-data/
163
- file_body params[:file]
164
- else
165
- halt [415,{},["Unsupported content type: `#{ctype}`"]]
166
- end
167
- end
168
-
169
- def file_body(file)
170
- ctype = Path(file[:filename] || file["filename"]).extname
171
- ctype = (file[:type] || file["type"]) if ctype.nil? or ctype.empty?
172
- case ctype
173
- when /csv/
174
- str = file[:tempfile].read
175
- csv = ::CSV.new(str, :headers => true, :header_converters => :symbol)
176
- csv.map {|row| row.to_hash }
177
- else
178
- halt [415,{},["Unsupported content type: `#{ctype}`\n#{file.inspect}"]]
179
- end
180
- end
@@ -1,24 +0,0 @@
1
- def webspicy_config(&bl)
2
- Webspicy::Configuration.new(Path.dir) do |c|
3
-
4
- c.precondition MustBeAuthenticated
5
- c.precondition MustBeAnAdmin
6
-
7
- c.precondition Webspicy::Specification::Precondition::GlobalRequestHeaders.new({
8
- 'Accept' => 'application/json'
9
- }){|service| service.method == "GET" }
10
-
11
- c.precondition Webspicy::Specification::Precondition::RobustToInvalidInput.new
12
-
13
- c.postcondition TodoRemoved
14
- c.errcondition TodoNotRemoved
15
-
16
- c.instrument do |tc, client|
17
- role = tc.metadata[:role]
18
- tc.headers['Authorization'] = "Bearer #{role}" if role
19
- end
20
-
21
- bl.call(c) if bl
22
- end
23
- end
24
- webspicy_config
@@ -1,55 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/{id}
7
-
8
- services:
9
- - method: |-
10
- DELETE
11
-
12
- description: |-
13
- Deletes a single todo item
14
-
15
- preconditions:
16
- - Must be an admin
17
-
18
- postconditions:
19
- - The todo has been removed
20
-
21
- errconditions:
22
- - If it existed, the todo has not been removed
23
-
24
- input_schema: |-
25
- {
26
- id: Integer
27
- }
28
-
29
- output_schema: |-
30
- Any
31
-
32
- error_schema: |-
33
- ErrorSchema
34
-
35
- examples:
36
-
37
- - description: |-
38
- when requested on an existing TODO
39
- params:
40
- id: 1
41
- expected:
42
- content_type: ~
43
- status: 204
44
-
45
- counterexamples:
46
-
47
- - description: |-
48
- when requested on an unexisting TODO
49
- params:
50
- id: 999254654
51
- expected:
52
- content_type: application/json
53
- status: 404
54
- assert:
55
- - "pathFD('', error: 'No such todo')"
@@ -1,46 +0,0 @@
1
- ---
2
- url: |-
3
- /todo/{id}
4
-
5
- method: |-
6
- GET
7
-
8
- description: |-
9
- Returns a single todo item
10
-
11
- input_schema: |-
12
- {
13
- id: Integer
14
- }
15
-
16
- output_schema: |-
17
- Todo
18
-
19
- error_schema: |-
20
- ErrorSchema
21
-
22
- examples:
23
-
24
- - description: |-
25
- when requested on an existing TODO
26
- params:
27
- id: 1
28
- expected:
29
- content_type: application/json
30
- status: 200
31
- assert:
32
- - "pathFD('', id: 1)"
33
- - "match('description', /Refactor/)"
34
- - "notMatch('description', /Foo/)"
35
-
36
- counterexamples:
37
-
38
- - description: |-
39
- when requested on an unexisting TODO
40
- params:
41
- id: 999254654
42
- expected:
43
- content_type: application/json
44
- status: 404
45
- assert:
46
- - "pathFD('', error: 'No such todo')"