Skip to content

Commit 38b6b11

Browse files
arcuri82arcuri82
committed
fixing auth
1 parent f7f1bc9 commit 38b6b11

2 files changed

Lines changed: 46 additions & 32 deletions

File tree

‎src/main/resources/wfc/schemas/auth.yaml‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ properties:
1111
description: "List of authentication information for different users."
1212
type: array
1313
items:
14-
$ref: "#/$def/AuthenticationInfo"
14+
$ref: "#/$defs/AuthenticationInfo"
1515
authTemplate:
1616
description: "Optional authentication information template. This is used to avoid duplication in the auth list. \
1717
Entries defined in the template will be applied to all elements in the auth list that do not specify them."
1818
allOf:
19-
- $ref: "#/$def/AuthenticationInfo"
19+
- $ref: "#/$defs/AuthenticationInfo"
2020
- type: object
2121
configs:
2222
description: "Optional map of configuration parameters, in the form key:value strings. \
@@ -26,7 +26,9 @@ properties:
2626
additionalProperties:
2727
type: string
2828
required: ["auth"]
29-
$def:
29+
$defs:
30+
# TODO unfortunately, tools like jsonschema2pojo-maven-plugin have major limitations when dealing with enums.
31+
# This is not created as a top-level class
3032
HttpVerb:
3133
type: string
3234
enum:
@@ -66,9 +68,9 @@ $def:
6668
using for example a dynamically generated token from a login endpoint first)."
6769
type: array
6870
items:
69-
$ref: "#/$def/Header"
71+
$ref: "#/$defs/Header"
7072
loginEndpointAuth:
71-
$ref: "#/$def/LoginEndpoint"
73+
$ref: "#/$defs/LoginEndpoint"
7274
required: ["name"]
7375
###
7476
LoginEndpoint:
@@ -89,24 +91,36 @@ $def:
8991
description: "The raw payload to send, as a string."
9092
type: string
9193
payloadUserPwd:
92-
$ref: "#/$def/PayloadUsernamePassword" # TODO
94+
$ref: "#/$defs/PayloadUsernamePassword"
9395
headers:
9496
description: "HTTP headers needed when calling the login endpoint. \
9597
Username/password could be passed by headers instead of by the body payload."
9698
type: array
9799
items:
98-
$ref: "#/$def/Header"
100+
$ref: "#/$defs/Header"
99101
verb:
100-
description: "The verb used to connect to the login endpoint. \
101-
Most of the time, this will be a 'POST'."
102-
allOf:
103-
- $ref: "#/$def/HttpVerb"
104-
- type: string
102+
# description: "The verb used to connect to the login endpoint. \
103+
# Most of the time, this will be a 'POST'."
104+
# type: string
105+
# enum:
106+
# - POST
107+
# - GET
108+
# - PATCH
109+
# - DELETE
110+
# - PUT
111+
$ref: "#/$defs/HttpVerb"
112+
## FIXME: unfortunately, plugin is not able to handle this... need new schema version with $ref not replacing everything
113+
# description: "The verb used to connect to the login endpoint. \
114+
# Most of the time, this will be a 'POST'."
115+
# allOf:
116+
# - $ref: "#/$defs/HttpVerb"
117+
# - type: string
105118
contentType:
106119
description: "Specify the format in which the payload is sent to the login endpoint. \
107120
A common example is 'application/json'."
121+
type: string
108122
token:
109-
$ref: "#/$def/TokenHandling" # TODO
123+
$ref: "#/$defs/TokenHandling"
110124
expectCookies:
111125
description: "Specify if we are expecting to get cookies from the login endpoint. \
112126
If so, a fuzzer can use those as auth info in following requests, instead of trying to extract \

‎src/main/resources/wfc/schemas/report.yaml‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ properties:
1919
format: date-time
2020
description: "The timestamp of when this report file was created."
2121
faults:
22-
$ref: "#/$def/Faults"
22+
$ref: "#/$defs/Faults"
2323
#### Unfortunately, there is no support for oneOf in jsonschema2pojo
2424
# problem_details:
2525
# type: object
2626
# oneOf:
27-
# - $ref: "#/$def/RESTReport"
27+
# - $ref: "#/$defs/RESTReport"
2828
# # TODO GraphQL, RPC and Web
2929
problem_details:
3030
type: object
3131
properties:
3232
rest:
33-
$ref: "#/$def/RESTReport"
33+
$ref: "#/$defs/RESTReport"
3434
# TODO GraphQL, RPC and Web
3535
# expressing that only 1 should be present is possible, but super-verbose and convoluted
3636
total_tests:
@@ -40,24 +40,24 @@ properties:
4040
test_file_paths:
4141
type: array
4242
items:
43-
$ref: "#/$def/TestFilePath"
43+
$ref: "#/$defs/TestFilePath"
4444
uniqueItems: true
4545
description: "The list of relative paths (compared to this document) of all the generated test suite files."
4646
test_cases:
4747
description: "Information on each generated test case."
4848
type: array
4949
items:
50-
$ref: "#/$def/TestCase"
50+
$ref: "#/$defs/TestCase"
5151
#OPTIONAL
5252
extra:
5353
description: "Extra, optional coverage information, collected by different tools."
5454
type: array
5555
items:
56-
$ref: "#/$def/Coverage"
56+
$ref: "#/$defs/Coverage"
5757

5858
required: ["schema_version","tool_name","tool_version","creation_time","faults","problem_details","total_tests","test_file_paths","test_cases"]
5959

60-
$def:
60+
$defs:
6161
OperationId:
6262
description: "A unique identifier for an operation. For example, in REST, it would be a HTTP endpoint, including
6363
verb, e.g., 'GET:/users/{id}'."
@@ -85,15 +85,15 @@ $def:
8585
type: object
8686
properties:
8787
endpoint_id:
88-
$ref: "#/$def/OperationId"
88+
$ref: "#/$defs/OperationId"
8989
test_case_id:
90-
$ref: "#/$def/TestCaseId"
90+
$ref: "#/$defs/TestCaseId"
9191
http_status:
9292
description: "As in a test case the same endpoint could be called more than once, here we report all of the
9393
obtained HTTP status codes"
9494
type: array
9595
items:
96-
$ref: "#/$def/HttpStatus"
96+
$ref: "#/$defs/HttpStatus"
9797
minItems: 1
9898
uniqueItems: true
9999
required: ["endpoint_id","test_case_id","http_status"]
@@ -107,13 +107,13 @@ $def:
107107
type: object
108108
properties:
109109
operation_id:
110-
$ref: "#/$def/OperationId"
110+
$ref: "#/$defs/OperationId"
111111
test_case_id:
112-
$ref: "#/$def/TestCaseId"
112+
$ref: "#/$defs/TestCaseId"
113113
fault_categories:
114114
type: array
115115
items:
116-
$ref: "#/$def/FaultCategoryId"
116+
$ref: "#/$defs/FaultCategoryId"
117117
minItems: 1
118118
uniqueItems: true
119119
required: ["endpoint_id","test_case_id","fault_categories"]
@@ -130,22 +130,22 @@ $def:
130130
description: "Unique ids of all the endpoints in the tested API."
131131
type: array
132132
items:
133-
$ref: "#/$def/OperationId"
133+
$ref: "#/$defs/OperationId"
134134
uniqueItems: true
135135
covered_http_status:
136136
description: "List of which HTTP status codes were covered, based on endpoints."
137137
type: array
138138
items:
139-
$ref: "#/$def/CoveredEndpoint"
139+
$ref: "#/$defs/CoveredEndpoint"
140140
required: ["total_http_calls","endpoint_ids","covered_http_status"]
141141

142142
TestCase:
143143
type: object
144144
properties:
145145
id:
146-
$ref: "#/$def/TestCaseId"
146+
$ref: "#/$defs/TestCaseId"
147147
file_path:
148-
$ref: "#/$def/TestFilePath"
148+
$ref: "#/$defs/TestFilePath"
149149
name:
150150
description: "The name of the test case, as it appears in the generated test file."
151151
type: string
@@ -171,7 +171,7 @@ $def:
171171
description: "Information on all the identified potential faults."
172172
type: array
173173
items:
174-
$ref: "#/$def/FoundFault"
174+
$ref: "#/$defs/FoundFault"
175175
required: ["total_number","found_faults"]
176176

177177
Coverage:
@@ -183,7 +183,7 @@ $def:
183183
criteria:
184184
type: array
185185
items:
186-
$ref: "#/$def/CoverageCriterion"
186+
$ref: "#/$defs/CoverageCriterion"
187187
required: ["tool_name","criteria"]
188188

189189
CoverageCriterion:

0 commit comments

Comments
 (0)