Commit eb9f29ee authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

Deployed 3c3f75de to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent d66b97b7

public/develop/search/search_index.json

+1 −1

File changed.

Preview size limit exceeded, changes collapsed.

public/develop/testing/testplan/api_auditing_service/index.html

+138 −51
Original line number Diff line number Diff line
@@ -1280,45 +1280,54 @@ 
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

      

        <li class="md-nav__item">

  <a href="#test-case-1-get-capif-log-entry" class="md-nav__link">

  <a href="#test-case-1-get-log-entry" class="md-nav__link">

    <span class="md-ellipsis">

      Test Case 1: Get CAPIF Log Entry.

      Test Case 1: Get Log Entry.

    </span>

  </a>

  

</li>

      

        <li class="md-nav__item">

  <a href="#test-case-2-get-capif-log-entry-with-no-log-entry-in-capif" class="md-nav__link">

  <a href="#test-case-2-get-log-entry-with-no-log-entry-in-capif" class="md-nav__link">

    <span class="md-ellipsis">

      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.

    </span>

  </a>

  

</li>

      

        <li class="md-nav__item">

  <a href="#test-case-3-get-capif-log-entry-without-aef-id-and-api-invoker-id" class="md-nav__link">

  <a href="#test-case-3-get-log-entry-without-aef-id-and-api-invoker-id" class="md-nav__link">

    <span class="md-ellipsis">

      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.

    </span>

  </a>

  

</li>

      

        <li class="md-nav__item">

  <a href="#test-case-4-get-capif-log-entry-with-filtter-api-version" class="md-nav__link">

  <a href="#test-case-4-get-log-entry-with-filter-api-version" class="md-nav__link">

    <span class="md-ellipsis">

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

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

    </span>

  </a>

  

</li>

      

        <li class="md-nav__item">

  <a href="#test-case-5-get-capif-log-entry-with-filter-api-version-but-not-exist-in-log-entry" class="md-nav__link">

  <a href="#test-case-5-get-log-entry-with-filter-api-version-but-not-exist-in-log-entry" class="md-nav__link">

    <span class="md-ellipsis">

      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.

    </span>

  </a>

  

</li>

      

        <li class="md-nav__item">

  <a href="#test-case-6-get-multiple-log-entries" class="md-nav__link">

    <span class="md-ellipsis">

      Test Case 6: Get Multiple Log Entries.

    </span>

  </a>
@@ -1342,8 +1351,8 @@ 


<h1 id="test-plan-for-capif-api-auditing-service">Test Plan for CAPIF Api Auditing Service</h1>

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

<h2 id="test-case-1-get-capif-log-entry">Test Case 1: Get CAPIF Log Entry.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-1</em></strong></p>

<h2 id="test-case-1-get-log-entry">Test Case 1: Get Log Entry.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing_service-1</em></strong></p>

<p><strong>Description</strong>:</p>

<p>This test case will check that a CAPIF AMF can get log entry to Logging Service</p>

<p><strong>Pre-Conditions</strong>:</p>
@@ -1353,11 +1362,13 @@ 
<li>Invoker exist in CAPIF</li>

<li>Log Entry exist in CAPIF</li>

</ul>

<p><strong>Execution Steps</strong>:

  1. Register Provider and Invoker CCF

  2. Publish Service

  3. Create Log Entry

  4. Get Log Entry</p>

<p><strong>Execution Steps</strong>:</p>

<ol>

<li>Register Provider and Invoker CCF</li>

<li>Publish Service</li>

<li>Create Log Entry</li>

<li>Get Log Entry</li>

</ol>

<p><strong>Information of Test</strong>:</p>

<ol>

<li>
@@ -1367,7 +1378,7 @@ 
<p>Publish Service API at CCF:</p>

<ul>

<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>

<li>body [service api description] with apiName <strong>service_1</strong></li>

<li>body <a href="../api_publish_service/service_api_description_post_example.json" title="Service API Description Request">service api description</a> with apiName <strong>service_1</strong></li>

<li>Use <strong>APF Certificate</strong></li>

</ul>

</li>
@@ -1391,7 +1402,7 @@ 
<ol>

<li>Response to Logging Service must accomplish:<ol>

<li><strong>200 OK</strong></li>

<li>Response Body must follow <strong>InvocationLog</strong> data structure with:<ul>

<li>Response Body must follow <strong>InvocationLogsRetrieveRes</strong> including <strong>InvocationLog</strong> data structure with:<ul>

<li>aefId</li>

<li>apiInvokerId</li>

<li>logs</li>
@@ -1400,8 +1411,8 @@ 
</ol>

</li>

</ol>

<h2 id="test-case-2-get-capif-log-entry-with-no-log-entry-in-capif">Test Case 2: Get CAPIF Log Entry With no Log entry in CAPIF.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-2</em></strong></p>

<h2 id="test-case-2-get-log-entry-with-no-log-entry-in-capif">Test Case 2: Get Log Entry With no Log entry in CAPIF.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing_service-2</em></strong></p>

<p><strong>Description</strong>:</p>

<p>This test case will check that a CAPIF AEF can create log entry to Logging Service</p>

<p><strong>Pre-Conditions</strong>:</p>
@@ -1410,10 +1421,12 @@ 
<li>Service exist in CAPIF</li>

<li>Invoker exist in CAPIF</li>

</ul>

<p><strong>Execution Steps</strong>:

  1. Register Provider and Invoker CCF

  2. Publish Service

  3. Get Log Entry</p>

<p><strong>Execution Steps</strong>:</p>

<ol>

<li>Register Provider and Invoker CCF</li>

<li>Publish Service</li>

<li>Get Log Entry</li>

</ol>

<p><strong>Information of Test</strong>:</p>

<ol>

<li>
@@ -1423,7 +1436,7 @@ 
<p>Publish Service API at CCF:</p>

<ul>

<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>

<li>body [service api description] with apiName <strong>service_1</strong></li>

<li>body <a href="../api_publish_service/service_api_description_post_example.json" title="Service API Description Request">service api description</a> with apiName <strong>service_1</strong></li>

<li>Use <strong>APF Certificate</strong></li>

</ul>

</li>
@@ -1448,8 +1461,8 @@ 
</ol>

</li>

</ol>

<h2 id="test-case-3-get-capif-log-entry-without-aef-id-and-api-invoker-id">Test Case 3: Get CAPIF Log Entry without aef-id and api-invoker-id.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-3</em></strong></p>

<h2 id="test-case-3-get-log-entry-without-aef-id-and-api-invoker-id">Test Case 3: Get Log Entry without aef-id and api-invoker-id.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing_service-3</em></strong></p>

<p><strong>Description</strong>:</p>

<p>This test case will check that a CAPIF AEF can create log entry to Logging Service</p>

<p><strong>Pre-Conditions</strong>:</p>
@@ -1459,11 +1472,13 @@ 
<li>Invoker exist in CAPIF</li>

<li>Log Entry exist in CAPIF</li>

</ul>

<p><strong>Execution Steps</strong>:

  1. Register Provider and Invoker CCF

  2. Publish Service

  3. Create Log Entry

  4. Get Log Entry</p>

<p><strong>Execution Steps</strong>:</p>

<ol>

<li>Register Provider and Invoker CCF</li>

<li>Publish Service</li>

<li>Create Log Entry</li>

<li>Get Log Entry</li>

</ol>

<p><strong>Information of Test</strong>:</p>

<ol>

<li>
@@ -1473,7 +1488,7 @@ 
<p>Publish Service API at CCF:</p>

<ul>

<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>

<li>body [service api description] with apiName <strong>service_1</strong></li>

<li>body <a href="../api_publish_service/service_api_description_post_example.json" title="Service API Description Request">service api description</a> with apiName <strong>service_1</strong></li>

<li>Use <strong>APF Certificate</strong></li>

</ul>

</li>
@@ -1507,8 +1522,8 @@ 
</ol>

</li>

</ol>

<h2 id="test-case-4-get-capif-log-entry-with-filtter-api-version">Test Case 4: Get CAPIF Log Entry with filtter api-version.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-4</em></strong></p>

<h2 id="test-case-4-get-log-entry-with-filter-api-version">Test Case 4: Get Log Entry with filter api-version.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing_service-4</em></strong></p>

<p><strong>Description</strong>:</p>

<p>This test case will check that a CAPIF AMF can get log entry to Logging Service</p>

<p><strong>Pre-Conditions</strong>:</p>
@@ -1518,11 +1533,13 @@ 
<li>Invoker exist in CAPIF</li>

<li>Log Entry exist in CAPIF</li>

</ul>

<p><strong>Execution Steps</strong>:

  1. Register Provider and Invoker CCF

  2. Publish Service

  3. Create Log Entry

  4. Get Log Entry</p>

<p><strong>Execution Steps</strong>:</p>

<ol>

<li>Register Provider and Invoker CCF</li>

<li>Publish Service</li>

<li>Create Log Entry</li>

<li>Get Log Entry</li>

</ol>

<p><strong>Information of Test</strong>:</p>

<ol>

<li>
@@ -1532,7 +1549,7 @@ 
<p>Publish Service API at CCF:</p>

<ul>

<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>

<li>body [service api description] with apiName <strong>service_1</strong></li>

<li>body <a href="../api_publish_service/service_api_description_post_example.json" title="Service API Description Request">service api description</a> with apiName <strong>service_1</strong></li>

<li>Use <strong>APF Certificate</strong></li>

</ul>

</li>
@@ -1556,7 +1573,7 @@ 
<ol>

<li>Response to Logging Service must accomplish:<ol>

<li><strong>200 OK</strong></li>

<li>Response Body must follow <strong>InvocationLog</strong> data structure with:<ul>

<li>Response Body must follow <strong>InvocationLogsRetrieveRes</strong> including <strong>InvocationLog</strong> data structure with:<ul>

<li>aefId</li>

<li>apiInvokerId</li>

<li>logs</li>
@@ -1565,8 +1582,8 @@ 
</ol>

</li>

</ol>

<h2 id="test-case-5-get-capif-log-entry-with-filter-api-version-but-not-exist-in-log-entry">Test Case 5: Get CAPIF Log Entry with filter api-version but not exist in log entry.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing-4</em></strong></p>

<h2 id="test-case-5-get-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.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing_service-5</em></strong></p>

<p><strong>Description</strong>:</p>

<p>This test case will check that a CAPIF AMF can get log entry to Logging Service</p>

<p><strong>Pre-Conditions</strong>:</p>
@@ -1576,11 +1593,13 @@ 
<li>Invoker exist in CAPIF</li>

<li>Log Entry exist in CAPIF</li>

</ul>

<p><strong>Execution Steps</strong>:

  1. Register Provider and Invoker CCF

  2. Publish Service

  3. Create Log Entry

  4. Get Log Entry</p>

<p><strong>Execution Steps</strong>:</p>

<ol>

<li>Register Provider and Invoker CCF</li>

<li>Publish Service</li>

<li>Create Log Entry</li>

<li>Get Log Entry</li>

</ol>

<p><strong>Information of Test</strong>:</p>

<ol>

<li>
@@ -1590,7 +1609,7 @@ 
<p>Publish Service API at CCF:</p>

<ul>

<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>

<li>body [service api description] with apiName <strong>service_1</strong></li>

<li>body <a href="../api_publish_service/service_api_description_post_example.json" title="Service API Description Request">service api description</a> with apiName <strong>service_1</strong></li>

<li>Use <strong>APF Certificate</strong></li>

</ul>

</li>
@@ -1623,6 +1642,74 @@ 
</ol>

</li>

</ol>

<h2 id="test-case-6-get-multiple-log-entries">Test Case 6: Get Multiple Log Entries.</h2>

<p><strong>Test ID</strong>: <strong><em>capif_api_auditing_service-6</em></strong></p>

<p><strong>Description</strong>:</p>

<p><strong>(WIP, NOT IMPLEMENTED)</strong>This test case will check that a CAPIF AMF can get log entry to Logging Service</p>

<p><strong>Pre-Conditions</strong>:</p>

<ul>

<li>CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)</li>

<li>Service exist in CAPIF</li>

<li>Invoker exist in CAPIF</li>

<li>Log Entry exist in CAPIF</li>

</ul>

<p><strong>Execution Steps</strong>:</p>

<ol>

<li>Register Provider and Invoker CCF</li>

<li>Publish Service</li>

<li>Create Log Entry</li>

<li>Get Log Entry</li>

</ol>

<p><strong>Information of Test</strong>:</p>

<ol>

<li>

<p>Perform <a href="../common_operations/#register-a-provider" title="Provider Onboarding">provider onboarding</a>, <a href="../common_operations/#onboard-an-invoker" title="Invoker Onboarding">invoker onboarding</a> </p>

</li>

<li>

<p>Publish Service API at CCF:</p>

<ul>

<li>Send <strong>POST</strong> to ccf_publish_url <strong>https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis</strong></li>

<li>body <a href="../api_publish_service/service_api_description_post_example.json" title="Service API Description Request">service api description</a> with apiName <strong>service_1</strong></li>

<li>Use <strong>APF Certificate</strong></li>

</ul>

</li>

<li>

<p>Create Log Entry:</p>

<ul>

<li>Send <strong>POST</strong> to <strong>https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs</strong></li>

<li>body <a href="../api_logging_service/invocation_log.json" title="Log Request Body">log entry request body</a></li>

<li>Use <strong>AEF Certificate</strong></li>

</ul>

</li>

<li>

<p>Create Other Log Entry:</p>

<ul>

<li>Send <strong>POST</strong> to <strong>https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs</strong></li>

<li>body <a href="../api_logging_service/invocation_log.json" title="Log Request Body">log entry request body</a> with apiInvokerId = "other"</li>

<li>Use <strong>AEF Certificate</strong></li>

</ul>

</li>

<li>

<p>Get Log:</p>

<ol>

<li>Send <strong>GET</strong> to <strong>https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&amp;api-invoker-id={api-invoker-id}</strong></li>

<li>Use <strong>AMF Certificate</strong></li>

</ol>

</li>

</ol>

<p><strong>Expected Result</strong>:</p>

<ol>

<li>Response to Logging Service must accomplish:<ol>

<li><strong>200 OK</strong></li>

<li>Response Body must follow <strong>InvocationLogsRetrieveRes</strong> including <strong>InvocationLogs</strong> attribute on data structure with:<ul>

<li>aefId</li>

<li>apiInvokerId</li>

<li>logs</li>

</ul>

</li>

</ol>

</li>

</ol>