Newer
Older
# Test Plan for Vendor Extensibility Feature
At this documentation you will have all information and related files and examples of test plan for this feature.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
## Test Case 1: Published API with vendor extensibility
**Test ID**: ***vendor_extensibility-1***
**Description**:
This test case will check if a published API with vendorExt flag active and vendorSpecific, can be discovered by invoker with all vendorSpecific fields.
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 1 0000 0000 -> string **100**)
2. This API includes "Vendor Specific" information at **service API Description** and inside **AEF Profile**.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
1. includes **supported-features** with VendSpecQueryParams active (binary 010 -> string **2**)
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* include [vendor specific service] in root of [service api description].
* include [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **100**
* Use **APF Certificate**
3. Request Discover Published APIs:
* Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&aef-id=${aefId}&supported-features=2**
* Param api-invoker-id is mandatory
* Use **Invoker Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **201 Created**
2. Response Body must follow **ServiceAPIDescription** data structure with:
* apiId
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
4. Response must include **"vendorSpecific"** keys inside root and at AEF Profile.
2. Response to Onboard request must accomplish:
1. **201 Created**
2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
* apiInvokerId
* onboardingInformation->apiInvokerCertificate must contain the public key signed.
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
3. Response to Discover Request By Invoker:
1. **200 OK** response.
2. Response body must follow **DiscoveredAPIs** data structure:
* Check if DiscoveredAPIs contains the API Published previously
* Check if contains the **vendorSpecific** keys
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
## Test Case 2: Published API with vendor extensibility and discover with VendSpecQueryParams disabled
**Test ID**: ***vendor_extensibility-2***
**Description**:
This test case will check if a published API with vendorExt flag active and vendorSpecific, but discovered filter only APIs without vendorSpecific parameter
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 1 0000 0000 -> string **100**)
2. This API includes "Vendor Specific" information at **service API Description** and inside **AEF Profile**.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* include [vendor specific service] in root of [service api description].
* include [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **100**
* Use **APF Certificate**
3. Request Discover Published APIs:
* Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&aef-id=${aefId}&supported-features=0**
* Param api-invoker-id is mandatory
* Use **Invoker Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **201 Created**
2. Response Body must follow **ServiceAPIDescription** data structure with:
* apiId
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
4. Response must include **"vendorSpecific"** keys inside root and at AEF Profile.
2. Response to Onboard request must accomplish:
1. **201 Created**
2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
* apiInvokerId
* onboardingInformation->apiInvokerCertificate must contain the public key signed.
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
3. Response to Discover Request By Invoker:
1. **404 Not Found** response.
2. Error Response Body must accomplish with **ProblemDetails** data structure with:
* status 404
* title with message "Not Found"
* detail with message "API Invoker {api_invoker_id} has no API Published that accomplish filter conditions".
* cause with message "No API Published accomplish filter conditions".
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
## Test Case 3: Publish API with vendorExt active and discover without supported features filter
**Test ID**: ***vendor_extensibility-3***
**Description**:
This test case will check if a published API with vendor extensions can be discovered by invoker but without verdorSpecific parameters if supported-features query parameter is not set properly
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 1 0000 0000 -> string **100**)
2. This API includes "Vendor Specific" information at **service API Description** and inside **AEF Profile**.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* include [vendor specific service] in root of [service api description].
* include [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **100**
* Use **APF Certificate**
3. Request Discover Published APIs:
* Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&aef-id=${aefId}**
* Param api-invoker-id is mandatory
* Use **Invoker Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **201 Created**
2. Response Body must follow **ServiceAPIDescription** data structure with:
* apiId
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
4. Response must include **"vendorSpecific"** keys inside root and at AEF Profile.
2. Response to Onboard request must accomplish:
1. **201 Created**
2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
* apiInvokerId
* onboardingInformation->apiInvokerCertificate must contain the public key signed.
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
3. Response to Discover Request By Invoker:
1. **200 OK** response.
2. Response body must follow **DiscoveredAPIs** data structure:
* Check if DiscoveredAPIs contains the API Published previously
* Check **NOT** contains the **vendorSpecific** keys
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
## Test Case 4: Publish API with vendorExt active but without vendorSpecifics
**Test ID**: ***vendor_extensibility-4***
**Description**:
This test case will check if a published API with vendorExt flag active and without vendorSpecific gets a 400 Bad Request, because is not allowed by definition.
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 1 0000 0000 -> string **100**)
2. This API **NOT** includes any "Vendor Specific" information.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* **NOT INCLUDED** [vendor specific service] in root of [service api description].
* **NOT INCLUDED** [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **100**
* Use **APF Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **400 Bad Request**
2. Error Response Body must accomplish with **ProblemDetails** data structure with:
* status 400
* title with message "Bad Request"
* detail with message "If and only if VendorExt feature is enabled, then vendor-specific fields should be defined".
* cause with message "Vendor extensibility misconfiguration".
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
## Test Case 5: Publish API with vendorExt inactive but with vendorSpecifics
**Test ID**: ***vendor_extensibility-5***
**Description**:
This test case will check if a published API with vendorExt flag inactive and with vendorSpecific gets a 400 Bad Request, because is not allowed by definition.
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 0 0000 0000 -> string **000**)
2. This API includes any "Vendor Specific" information.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* include [vendor specific service] in root of [service api description].
* include [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **000**
* Use **APF Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **400 Bad Request**
2. Error Response Body must accomplish with **ProblemDetails** data structure with:
* status 400
* title with message "Bad Request"
* detail with message "If and only if VendorExt feature is enabled, then vendor-specific fields should be defined".
* cause with message "Vendor extensibility misconfiguration".
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
## Test Case 6: Published API without vendor extensibility discover with VendSpecQueryParams enabled
**Test ID**: ***vendor_extensibility-6***
**Description**:
This test case will check if a published API with vendorExt flag inactive and vendorSpecific no presnet, but discovered filter only APIs with vendorSpecific parameter
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 0 0000 0000 -> string **000**)
2. This API **NOT** includes "Vendor Specific" information at **service API Description** and inside **AEF Profile**.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
1. Supported-features: binary 010 -> string 2
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* **NOT INCLUDED** [vendor specific service] in root of [service api description].
* **NOT INCLUDED** [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **00**
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
* Use **APF Certificate**
3. Request Discover Published APIs:
* Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&aef-id=${aefId}&supported-features=2**
* Param api-invoker-id is mandatory
* Use **Invoker Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **201 Created**
2. Response Body must follow **ServiceAPIDescription** data structure with:
* apiId
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
4. Response must NOT include any **"vendorSpecific"** keys inside root and at AEF Profile.
2. Response to Onboard request must accomplish:
1. **201 Created**
2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
* apiInvokerId
* onboardingInformation->apiInvokerCertificate must contain the public key signed.
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
3. Response to Discover Request By Invoker:
1. **404 Not Found** response.
2. Error Response Body must accomplish with **ProblemDetails** data structure with:
* status 404
* title with message "Not Found"
* detail with message "API Invoker {api_invoker_id} has no API Published that accomplish filter conditions".
* cause with message "No API Published accomplish filter conditions".
## Test Case 7: Published API without vendor extensibility and discover with vendSpecQueryParams disabled
**Test ID**: ***vendor_extensibility-7***
**Description**:
This test case will check if a published API with vendorExt flag inactive and no vendorSpecific, can be discovered by invoker filtering by vendSpecQueryParams.
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 0 0000 0000 -> string **0**)
2. This API **NOT** includes any "Vendor Specific" information at **service API Description** and inside **AEF Profile**.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
1. includes **supported-features** with VendSpecQueryParams active (binary 000 -> string **0**)
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* **NOT INCLUDE** [vendor specific service] in root of [service api description].
* **NOT INCLUDE** [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **0**
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
* Use **APF Certificate**
3. Request Discover Published APIs:
* Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&aef-id=${aefId}&supported-features=0**
* Param api-invoker-id is mandatory
* Use **Invoker Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **201 Created**
2. Response Body must follow **ServiceAPIDescription** data structure with:
* apiId
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
4. Response must **NOT** include **"vendorSpecific"** keys inside root and at AEF Profile.
2. Response to Onboard request must accomplish:
1. **201 Created**
2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
* apiInvokerId
* onboardingInformation->apiInvokerCertificate must contain the public key signed.
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
3. Response to Discover Request By Invoker:
1. **200 OK** response.
2. Response body must follow **DiscoveredAPIs** data structure:
* Check if DiscoveredAPIs contains the API Published previously
* Check if **NOT** contains any **vendorSpecific** keys
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
## Test Case 8: Published API without vendor extensibility and discover without supported-features query parameter
**Test ID**: ***vendor_extensibility-8***
**Description**:
This test case will check if a published API with vendorExt flag inactive and no vendorSpecific, can be discovered by invoker without filtering by vendSpecQueryParams.
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF:
1. Supported Features with vendorExt flag active (binary 0 0000 0000 -> string **000**)
2. This API **NOT** includes any "Vendor Specific" information at **service API Description** and inside **AEF Profile**.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
1. **NOT** includes **supported-features**
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* **NOT INCLUDE** [vendor specific service] in root of [service api description].
* **NOT INCLUDE** [vendor specific aef profile] in one AEFProfile inside aefProfiles key.
* supportedFeatures **000**
* Use **APF Certificate**
3. Request Discover Published APIs:
* Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&aef-id=${aefId}**
* Param api-invoker-id is mandatory
* Use **Invoker Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **201 Created**
2. Response Body must follow **ServiceAPIDescription** data structure with:
* apiId
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
4. Response must **NOT** include **"vendorSpecific"** keys inside root and at AEF Profile.
2. Response to Onboard request must accomplish:
1. **201 Created**
2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
* apiInvokerId
* onboardingInformation->apiInvokerCertificate must contain the public key signed.
3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
3. Response to Discover Request By Invoker:
1. **200 OK** response.
2. Response body must follow **DiscoveredAPIs** data structure:
* Check if DiscoveredAPIs contains the API Published previously
* Check if **NOT** contains any **vendorSpecific** keys
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
## Test Case 9: Publish API without supportedFeatures
**Test ID**: ***vendor_extensibility-9***
**Description**:
This test case will check if a published API without supportedFeatures receives the 400 Bad Request, because is not allowed by definition.
**Pre-Conditions**:
* Network App was registered previously
* Network App was onboarded previously with {onboardingId}
**Execution Steps**:
1. Register Provider at CCF, store certificates.
2. Publish Service API at CCF.
3. Register Invoker and Onboard Invoker at CCF
4. Discover Service APIs by Invoker
**Information of Test**:
1. Perform [Provider Registration] and [Invoker Onboarding]
2. Publish Service API at CCF:
* Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
* body [service api description] with apiName **service_1**
* **without supportedFeatures parameter.**
* Use **APF Certificate**
**Expected Result**:
1. Response to Publish request must accomplish:
1. **400 Bad Request**
2. Error Response Body must accomplish with **ProblemDetails** data structure with:
* status 400
* title with message "Bad Request"
* detail with message "supportedFeatures not present in request".
* cause with message "supportedFeatures not present".
[service api description]: ../api_publish_service/service_api_description_post_example.json "Service API **Description** Request"
[publisher register body]: ../api_publish_service/publisher_register_body.json "Publish register Body"
[invoker onboarding body]: ../api_invoker_management/invoker_details_post_example.json "API Invoker Request"
[provider request body]: ../api_provider_management/provider_details_post_example.json "API Provider Enrolment Request"
[provider request patch body]: ../api_provider_management/provider_details_enrolment_details_patch_example.json "API Provider Enrolment Patch Request"
[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
[provider registration]: ../common_operations/README.md#register-a-provider "Provider Registration"
[vendor specific service]: ./vendor_specific_service.json "Vendor Specific Service"
[vendor specific aef profile]: ./vendor_specific_aef_profile.json "Vendor Specific AEF Profile"