webspicy 0.16.1 → 0.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (110) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -5
  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 +15 -4
  9. data/lib/webspicy/configuration.rb +57 -8
  10. data/lib/webspicy/configuration/scope.rb +22 -16
  11. data/lib/webspicy/formaldoc.fio +3 -1
  12. data/lib/webspicy/specification.rb +12 -10
  13. data/lib/webspicy/specification/condition.rb +23 -0
  14. data/lib/webspicy/specification/errcondition.rb +17 -0
  15. data/lib/webspicy/specification/postcondition.rb +1 -0
  16. data/lib/webspicy/specification/precondition.rb +1 -0
  17. data/lib/webspicy/specification/precondition/robust_to_invalid_input.rb +1 -1
  18. data/lib/webspicy/specification/service.rb +38 -25
  19. data/lib/webspicy/specification/test_case.rb +10 -17
  20. data/lib/webspicy/support.rb +22 -0
  21. data/lib/webspicy/support/data_object.rb +25 -0
  22. data/lib/webspicy/support/hooks.rb +65 -0
  23. data/lib/webspicy/support/world.rb +47 -0
  24. data/lib/webspicy/tester.rb +120 -61
  25. data/lib/webspicy/tester/asserter.rb +9 -4
  26. data/lib/webspicy/tester/assertions.rb +8 -9
  27. data/lib/webspicy/tester/client.rb +22 -42
  28. data/lib/webspicy/tester/failure.rb +6 -0
  29. data/lib/webspicy/tester/file_checker.rb +22 -0
  30. data/lib/webspicy/tester/invocation.rb +15 -196
  31. data/lib/webspicy/tester/reporter.rb +85 -0
  32. data/lib/webspicy/tester/reporter/composite.rb +38 -0
  33. data/lib/webspicy/tester/reporter/documentation.rb +67 -0
  34. data/lib/webspicy/tester/reporter/error_count.rb +25 -0
  35. data/lib/webspicy/tester/reporter/exceptions.rb +60 -0
  36. data/lib/webspicy/tester/reporter/file_progress.rb +22 -0
  37. data/lib/webspicy/tester/reporter/file_summary.rb +42 -0
  38. data/lib/webspicy/tester/reporter/progress.rb +28 -0
  39. data/lib/webspicy/tester/reporter/summary.rb +62 -0
  40. data/lib/webspicy/tester/result.rb +139 -0
  41. data/lib/webspicy/tester/result/assert_met.rb +29 -0
  42. data/lib/webspicy/tester/result/check.rb +33 -0
  43. data/lib/webspicy/tester/result/errcondition_met.rb +29 -0
  44. data/lib/webspicy/tester/result/error_schema_met.rb +24 -0
  45. data/lib/webspicy/tester/result/output_schema_met.rb +24 -0
  46. data/lib/webspicy/tester/result/postcondition_met.rb +29 -0
  47. data/lib/webspicy/tester/result/response_header_met.rb +43 -0
  48. data/lib/webspicy/tester/result/response_status_met.rb +25 -0
  49. data/lib/webspicy/version.rb +2 -2
  50. data/lib/webspicy/web.rb +4 -0
  51. data/lib/webspicy/web/client.rb +15 -0
  52. data/lib/webspicy/{tester → web}/client/http_client.rb +34 -14
  53. data/lib/webspicy/{tester → web}/client/rack_test_client.rb +3 -3
  54. data/lib/webspicy/{tester → web}/client/support.rb +2 -2
  55. data/lib/webspicy/web/invocation.rb +65 -0
  56. data/lib/webspicy/web/mocker.rb +90 -0
  57. data/lib/webspicy/web/mocker/config.ru +6 -0
  58. data/lib/webspicy/{openapi.rb → web/openapi.rb} +0 -0
  59. data/lib/webspicy/web/openapi/generator.rb +129 -0
  60. data/spec/unit/configuration/scope/test_each_service.rb +2 -2
  61. data/spec/unit/configuration/scope/test_each_specification.rb +7 -7
  62. data/spec/unit/specification/test_condition.rb +26 -0
  63. data/spec/unit/support/hooks/test_fire_after_each.rb +53 -0
  64. data/spec/unit/{tester/client/test_around.rb → support/hooks/test_fire_around.rb} +15 -10
  65. data/spec/unit/support/hooks/test_fire_before_each.rb +53 -0
  66. data/spec/unit/support/world/fixtures/array.json +8 -0
  67. data/spec/unit/support/world/fixtures/queue.rb +1 -0
  68. data/spec/unit/support/world/fixtures/single.json +11 -0
  69. data/spec/unit/support/world/fixtures/yaml.yml +3 -0
  70. data/spec/unit/support/world/test_world.rb +56 -0
  71. data/spec/unit/test_configuration.rb +50 -1
  72. data/spec/unit/tester/test_asserter.rb +198 -3
  73. data/spec/unit/tester/test_assertions.rb +8 -6
  74. data/spec/unit/web/mocker/test_mocker.rb +35 -0
  75. data/spec/unit/web/openapi/test_generator.rb +31 -0
  76. metadata +72 -61
  77. data/examples/restful/Gemfile +0 -5
  78. data/examples/restful/Gemfile.lock +0 -105
  79. data/examples/restful/Rakefile +0 -25
  80. data/examples/restful/app.rb +0 -180
  81. data/examples/restful/webspicy/config.rb +0 -23
  82. data/examples/restful/webspicy/rack.rb +0 -7
  83. data/examples/restful/webspicy/real.rb +0 -8
  84. data/examples/restful/webspicy/schema.fio +0 -20
  85. data/examples/restful/webspicy/support/must_be_an_admin.rb +0 -20
  86. data/examples/restful/webspicy/support/must_be_authenticated.rb +0 -48
  87. data/examples/restful/webspicy/support/todo_removed.rb +0 -18
  88. data/examples/restful/webspicy/todo/deleteTodo.yml +0 -52
  89. data/examples/restful/webspicy/todo/getTodo.yml +0 -50
  90. data/examples/restful/webspicy/todo/getTodoSingleServiceFormat.yml +0 -46
  91. data/examples/restful/webspicy/todo/getTodos.yml +0 -36
  92. data/examples/restful/webspicy/todo/options.yml +0 -32
  93. data/examples/restful/webspicy/todo/patchTodo.yml +0 -66
  94. data/examples/restful/webspicy/todo/postCsv.yml +0 -43
  95. data/examples/restful/webspicy/todo/postFile.yml +0 -40
  96. data/examples/restful/webspicy/todo/postTodos.yml +0 -51
  97. data/examples/restful/webspicy/todo/putTodo.yml +0 -65
  98. data/examples/restful/webspicy/todo/todos.csv +0 -4
  99. data/examples/single_spec/spec.yml +0 -59
  100. data/examples/website/config.rb +0 -2
  101. data/examples/website/schema.fio +0 -1
  102. data/examples/website/specification/get-http.yml +0 -34
  103. data/examples/website/specification/get-https.yml +0 -34
  104. data/lib/webspicy/checker.rb +0 -25
  105. data/lib/webspicy/mocker.rb +0 -88
  106. data/lib/webspicy/openapi/generator.rb +0 -127
  107. data/lib/webspicy/tester/rspec_asserter.rb +0 -108
  108. data/lib/webspicy/tester/rspec_matchers.rb +0 -104
  109. data/spec/unit/mocker/test_mocker.rb +0 -32
  110. data/spec/unit/openapi/test_generator.rb +0 -28
data/examples/restful/webspicy/todo/getTodoSingleServiceFormat.yml DELETED
@@ -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')"
data/examples/restful/webspicy/todo/getTodos.yml DELETED
@@ -1,36 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/
7
-
8
- services:
9
- - method: |-
10
- GET
11
-
12
- description: |-
13
- Returns the list of todo items
14
-
15
- input_schema: |-
16
- {
17
- }
18
-
19
- output_schema: |-
20
- [Todo]
21
-
22
- error_schema: |-
23
- ErrorSchema
24
-
25
- examples:
26
-
27
- - description: |-
28
- when requested
29
- params: {}
30
- expected:
31
- content_type: application/json
32
- status: 200
33
- assert:
34
- - notEmpty
35
-
36
- counterexamples: []
data/examples/restful/webspicy/todo/options.yml DELETED
@@ -1,32 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/
7
-
8
- services:
9
- - method: |-
10
- OPTIONS
11
-
12
- description: |-
13
- Returns options about the web service
14
-
15
- input_schema: |-
16
- {
17
- }
18
-
19
- output_schema: |-
20
- Any
21
-
22
- error_schema: |-
23
- ErrorSchema
24
-
25
- examples:
26
-
27
- - description: |-
28
- when requested on an existing TODO
29
- params: {}
30
- expected:
31
- content_type: ~
32
- status: 204
data/examples/restful/webspicy/todo/patchTodo.yml DELETED
@@ -1,66 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/{id}
7
-
8
- services:
9
- - method: |-
10
- PATCH
11
-
12
- description: |-
13
- Patches a single Todo item
14
-
15
- preconditions:
16
- - Must be authenticated
17
-
18
- input_schema: |-
19
- TodoPatch
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
- expected:
40
- content_type: application/json
41
- status: 200
42
- assert:
43
- - "pathFD('', description: 'hello world')"
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')"
56
-
57
- - description: |-
58
- when violating the Patch data type
59
- params:
60
- id: 1
61
- nosuchone: 'foobar'
62
- dress_params:
63
- false
64
- expected:
65
- content_type: application/json
66
- status: 400
data/examples/restful/webspicy/todo/postCsv.yml DELETED
@@ -1,43 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/
7
-
8
- services:
9
- - method: |-
10
- POST
11
-
12
- description: |-
13
- Creates new todo items through a CSV import
14
-
15
- preconditions:
16
- - Must be authenticated
17
-
18
- input_schema: |-
19
- {}
20
-
21
- output_schema: |-
22
- { count: Integer }
23
-
24
- error_schema: |-
25
- ErrorSchema
26
-
27
- examples:
28
-
29
- - description: |-
30
- when requested with a valid CSV
31
- params: {}
32
- headers:
33
- Content-Type: text/csv
34
- body: |-
35
- id,description
36
- 10,Write documentation
37
- 11,Create website
38
- 12,Add smart tools
39
- expected:
40
- content_type: application/json
41
- status: 201
42
- assert:
43
- - "pathFD('', count: 3)"
data/examples/restful/webspicy/todo/postFile.yml DELETED
@@ -1,40 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/
7
-
8
- services:
9
- - method: |-
10
- POST
11
-
12
- description: |-
13
- Creates new todo items through a CSV file upload
14
-
15
- preconditions:
16
- - Must be authenticated
17
-
18
- input_schema: |-
19
- Any
20
-
21
- output_schema: |-
22
- { count: Integer }
23
-
24
- error_schema: |-
25
- ErrorSchema
26
-
27
- examples:
28
-
29
- - description: |-
30
- when requested with a valid CSV file
31
- tags:
32
- - upload
33
- file_upload:
34
- path: ./todos.csv
35
- content_type: "text/csv"
36
- expected:
37
- content_type: application/json
38
- status: 201
39
- assert:
40
- - "pathFD('', count: 3)"
data/examples/restful/webspicy/todo/postTodos.yml DELETED
@@ -1,51 +0,0 @@
1
- ---
2
- name: |-
3
- Todo
4
-
5
- url: |-
6
- /todo/
7
-
8
- services:
9
- - method: |-
10
- POST
11
-
12
- description: |-
13
- Creates a new todo item
14
-
15
- preconditions:
16
- - Must be authenticated
17
-
18
- input_schema: |-
19
- Todo
20
-
21
- output_schema: |-
22
- Todo
23
-
24
- error_schema: |-
25
- ErrorSchema
26
-
27
- examples:
28
-
29
- - description: |-
30
- when requested with a non existing ID
31
- params:
32
- id: 3
33
- description: "Hello World"
34
- expected:
35
- content_type: application/json
36
- status: 201
37
- assert:
38
- - "pathFD('', id: 3)"
39
-
40
- counterexamples:
41
-
42
- - description: |-
43
- when requested while the id already exists
44
- params:
45
- id: 1
46
- description: "Hello World"
47
- expected:
48
- content_type: application/json
49
- status: 409
50
- assert:
51
- - "pathFD('', error: 'Identifier already in use')"
data/examples/restful/webspicy/todo/putTodo.yml DELETED
@@ -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
data/examples/restful/webspicy/todo/todos.csv DELETED
@@ -1,4 +0,0 @@
1
- id,description
2
- 10,Write documentation
3
- 11,Create website
4
- 12,Add smart tools
data/examples/single_spec/spec.yml DELETED
@@ -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')"