Commit 3c3f75de authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

Merge branch 'OCF-Doc29-fix-issues-on-auditing-testplan' into 'develop' 

Resolve "Fix issues on Auditing Testplan"

Closes #29

See merge request !33
parents fdd311bf 00f053f0

doc/testing/testplan/api_auditing_service/README.md

+71 −14
Changes for doc/testing/testplan/api_auditing_service/README.md: 71 added lines, 14 removed lines.
Original line number Original line Diff line number Diff line 
# Test Plan for CAPIF Api Auditing Service

# Test Plan for CAPIF Api Auditing Service

At this documentation you will have all information and related files and examples of test plan for this API.

At this documentation you will have all information and related files and examples of test plan for this API.





## Test Case 1: Get CAPIF Log Entry.

## Test Case 1: Get Log Entry.





**Test ID**: ***capif_api_auditing-1***

**Test ID**: ***capif_api_auditing_service-1***





**Description**:

**Description**:
@@ -17,6 +17,7 @@ At this documentation you will have all information and related files and exampl 
  *  Log Entry exist in CAPIF

  *  Log Entry exist in CAPIF





**Execution Steps**:

**Execution Steps**:



  1. Register Provider and Invoker CCF

  1. Register Provider and Invoker CCF

  2. Publish Service

  2. Publish Service

  3. Create Log Entry

  3. Create Log Entry
@@ -44,14 +45,14 @@ At this documentation you will have all information and related files and exampl 




  1. Response to Logging Service must accomplish:

  1. Response to Logging Service must accomplish:

     1. **200 OK**

     1. **200 OK**

     2. Response Body must follow **InvocationLog** data structure with:

     2. Response Body must follow **InvocationLogsRetrieveRes** including **InvocationLog** data structure with:

        * aefId

        * aefId

        * apiInvokerId

        * apiInvokerId

        * logs

        * logs





## Test Case 2: Get CAPIF Log Entry With no Log entry in CAPIF.

## Test Case 2: Get Log Entry With no Log entry in CAPIF.





**Test ID**: ***capif_api_auditing-2***

**Test ID**: ***capif_api_auditing_service-2***





**Description**:

**Description**:
@@ -64,6 +65,7 @@ At this documentation you will have all information and related files and exampl 
  *  Invoker exist in CAPIF

  *  Invoker exist in CAPIF





**Execution Steps**:

**Execution Steps**:



  1. Register Provider and Invoker CCF

  1. Register Provider and Invoker CCF

  2. Publish Service

  2. Publish Service

  3. Get Log Entry

  3. Get Log Entry
@@ -91,9 +93,9 @@ At this documentation you will have all information and related files and exampl 
        * cause with message "Not Exist Logs with the filters applied".

        * cause with message "Not Exist Logs with the filters applied".









## Test Case 3: Get CAPIF Log Entry without aef-id and api-invoker-id.

## Test Case 3: Get Log Entry without aef-id and api-invoker-id.





**Test ID**: ***capif_api_auditing-3***

**Test ID**: ***capif_api_auditing_service-3***





**Description**:

**Description**:
@@ -107,6 +109,7 @@ At this documentation you will have all information and related files and exampl 
  *  Log Entry exist in CAPIF

  *  Log Entry exist in CAPIF





**Execution Steps**:

**Execution Steps**:



  1. Register Provider and Invoker CCF

  1. Register Provider and Invoker CCF

  2. Publish Service

  2. Publish Service

  3. Create Log Entry

  3. Create Log Entry
@@ -141,9 +144,9 @@ At this documentation you will have all information and related files and exampl 
        * cause with message "Mandatory parameters missing".

        * cause with message "Mandatory parameters missing".









## Test Case 4: Get CAPIF Log Entry with filtter api-version.

## Test Case 4: Get Log Entry with filter api-version.





**Test ID**: ***capif_api_auditing-4***

**Test ID**: ***capif_api_auditing_service-4***





**Description**:

**Description**:
@@ -157,6 +160,7 @@ At this documentation you will have all information and related files and exampl 
  *  Log Entry exist in CAPIF

  *  Log Entry exist in CAPIF





**Execution Steps**:

**Execution Steps**:



  1. Register Provider and Invoker CCF

  1. Register Provider and Invoker CCF

  2. Publish Service

  2. Publish Service

  3. Create Log Entry

  3. Create Log Entry
@@ -184,15 +188,15 @@ At this documentation you will have all information and related files and exampl 




  1. Response to Logging Service must accomplish:

  1. Response to Logging Service must accomplish:

     1. **200 OK**

     1. **200 OK**

     2. Response Body must follow **InvocationLog** data structure with:

     2. Response Body must follow **InvocationLogsRetrieveRes** including **InvocationLog** data structure with:

        * aefId

        * aefId

        * apiInvokerId

        * apiInvokerId

        * logs

        * logs









## Test Case 5: Get CAPIF Log Entry with filter api-version but not exist in log entry.

## Test Case 5: Get Log Entry with filter api-version but not exist in log entry.





**Test ID**: ***capif_api_auditing-4***

**Test ID**: ***capif_api_auditing_service-5***





**Description**:

**Description**:
@@ -206,6 +210,7 @@ At this documentation you will have all information and related files and exampl 
  *  Log Entry exist in CAPIF

  *  Log Entry exist in CAPIF





**Execution Steps**:

**Execution Steps**:



  1. Register Provider and Invoker CCF

  1. Register Provider and Invoker CCF

  2. Publish Service

  2. Publish Service

  3. Create Log Entry

  3. Create Log Entry
@@ -238,10 +243,62 @@ At this documentation you will have all information and related files and exampl 
        * detail with message "Parameters do not match any log entry"

        * detail with message "Parameters do not match any log entry"

        * cause with message "No logs found".

        * cause with message "No logs found".





## Test Case 6: Get Multiple Log Entries.





**Test ID**: ***capif_api_auditing_service-6***





[log entry request body]: ../api_logging_service/invocation_log.json "Log Request Body"

**Description**:





[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"

  **(WIP, NOT IMPLEMENTED)**This test case will check that a CAPIF AMF can get log entry to Logging Service



**Pre-Conditions**:





  *  CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)

  *  Service exist in CAPIF

  *  Invoker exist in CAPIF

  *  Log Entry exist in CAPIF



**Execution Steps**:



  1. Register Provider and Invoker CCF

  2. Publish Service

  3. Create Log Entry

  4. Get Log Entry



**Information of Test**:



  1. Perform [provider onboarding], [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**

    - Use **APF Certificate**



  3. Create Log Entry:

     - Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**

     - body [log entry request body]

     - Use **AEF Certificate**



  4. Create Other Log Entry:

     - Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**

     - body [log entry request body] with apiInvokerId = "other"

     - Use **AEF Certificate**



  5. Get Log:

     1. Send **GET** to **https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&api-invoker-id={api-invoker-id}**

     2. Use **AMF Certificate**



**Expected Result**:



  1. Response to Logging Service must accomplish:

     1. **200 OK**

     2. Response Body must follow **InvocationLogsRetrieveRes** including **InvocationLogs** attribute on data structure with:

        * aefId

        * apiInvokerId

        * logs





[log entry request body]: ../api_logging_service/invocation_log.json "Log Request Body"

[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"

[provider onboarding]: ../common_operations/README.md#register-a-provider "Provider Onboarding"

[provider onboarding]: ../common_operations/README.md#register-a-provider "Provider Onboarding"

[service api description]: ../api_publish_service/service_api_description_post_example.json  "Service API Description Request"