diff --git a/doc/releasenotes.md b/doc/releasenotes.md index cfe9e5ea0abaaf9276396640003d56360c62524e..e048e11fcdcc3d8106a0e6cb80c5120c8da953c8 100644 --- a/doc/releasenotes.md +++ b/doc/releasenotes.md @@ -1,9 +1,8 @@ -## **Release X.0.0** +## **Release 4.0.0** ### **Visibility Control** - - +Current relase includes the initial implementation (Not complete functional) of Visibility Control API. The complete feature implementation is expected to be relased on next OpenCAPIF version, stay tuned! ### **Technical Debt Solved** diff --git a/doc/testing/testplan/visibility_control/README.md b/doc/testing/testplan/visibility_control/README.md index d07a7e8e5df2695a089abdc42c8fb4448670ed9e..1341df4328adacf887ff9d9040fb27a9d0b20cda 100644 --- a/doc/testing/testplan/visibility_control/README.md +++ b/doc/testing/testplan/visibility_control/README.md @@ -16,16 +16,19 @@ This test plan validates the lifecycle of the visibility control rules, ensuring This test case verifies that the **Superadmin** can retrieve the registered rules. In this case, the response is an empty registry because no rules have been provisioned. It validates the basic connectivity and authentication flow for administrative roles. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * Superadmin credentials (`SUPERADMIN_USERNAME`) are provisioned. * The database is in a clean state (no rules existing). **Execution Steps**: + 1. Authenticate as **Superadmin**. 2. Send a **GET** request to `{apiRoot}/helper/visibility-control/rules`. 3. Inspect the **JSON** response body. **Expected Result**: + * **Status**: **200 OK**. * **Body**: Returns a **JSON** object with a `rules` array. The length of this array must be **0**. @@ -39,15 +42,18 @@ This test case verifies that the **Superadmin** can retrieve the registered rule This test case validates the API's logic regarding time-range consistency. A visibility rule must have a logical duration; therefore, the service must reject any attempt to create a rule where the expiration date occurs before the start date. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * Superadmin credentials (`SUPERADMIN_USERNAME`) are provisioned. **Execution Steps**: + 1. Authenticate as **Superadmin**. 2. Send a **POST** request to `{apiRoot}/helper/visibility-control/rules`. 3. Use a payload where `startsAt` is later than `endsAt` (e.g., Starts: `2026`, Ends: `2025`). **Expected Result**: + * **Status**: **400 Bad Request**. * **Body**: Must contain a `ProblemDetails` object with the `detail` field specifying **"endsAt must be later than startsAt"**. @@ -61,11 +67,13 @@ This test case validates the API's logic regarding time-range consistency. A vis This test verifies that the **Superadmin** can create a rule, obtain its information, and successfully remove it. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * Superadmin credentials (`SUPERADMIN_USERNAME`) are provisioned. * A valid `RuleCreateRequest` payload including the mandatory `providerSelector` and `userName`. **Execution Steps**: + 1. Authenticate as **Superadmin**. 2. Send a **POST** request to `{apiRoot}/helper/visibility-control/rules`. 3. Send a **GET** request to `{apiRoot}/helper/visibility-control/rules`. @@ -73,6 +81,7 @@ This test verifies that the **Superadmin** can create a rule, obtain its informa 5. **GET** the rules list again to verify the count returns to zero. **Expected Result**: + * **Creation**: **201 Created** (Body contains the generated `ruleId`). * **Listing**: **200 OK** (List length is **1**). * **Deletion**: **204 No Content**. @@ -87,15 +96,18 @@ This test verifies that the **Superadmin** can create a rule, obtain its informa This test case validates that an **AMF Provider** can list rules and that the system correctly maps the Provider's certificate (**CN**) to their registered identity to filter the results. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * A **Provider** has been registered and onboarded at **CCF**. * The **Provider** possesses a valid certificate (in this case **AMF** certificate). **Execution Steps**: + 1. Authenticate using the **AMF Provider Certificate**. 2. Send a **GET** request to `{apiRoot}/helper/visibility-control/rules`. **Expected Result**: + * **Status**: **200 OK**. * **Validation**: The response body must only contain rules where the requester is the owner (`userName`). @@ -109,17 +121,20 @@ This test case validates that an **AMF Provider** can list rules and that the sy This test validates the roles and permissions of **Superadmin** and **Providers** to create, delete, and obtain rules. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * A **Provider** has been registered and onboarded at **CCF**. * The **Provider** possesses a valid certificate (in this case **AMF** certificate). * **Superadmin** has administrative access. **Execution Steps**: + 1. **AMF Provider** creates a rule: **POST** request to `{apiRoot}/helper/visibility-control/rules`. 2. **Superadmin** sends a **GET** request to `{apiRoot}/helper/visibility-control/rules`. 3. **Superadmin** sends a **DELETE** request for that `ruleId`. **Expected Result**: + * **Provider rule Creation**: **201 Created**. * **Superadmin Get**: **200 OK**. * **Superadmin Deletion**: **204 No Content**. @@ -135,15 +150,18 @@ This test validates the roles and permissions of **Superadmin** and **Providers* This test validates that the **Providers** can create, delete, and obtain rules, ensuring that the identity-based authorization logic correctly identifies the owner of a resource and allows them to delete it without requiring **Superadmin** intervention. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * A **Provider** has been registered and onboarded at **CCF**. * The **Provider** possesses a valid certificate (in this case **AMF** certificate). **Execution Steps**: + 1. **AMF Provider** creates a rule: **POST** request to `{apiRoot}/helper/visibility-control/rules`. 2. **AMF Provider** sends a **DELETE** request for the same rule using the same provider identity and the `ruleId`. **Expected Result**: + * **Status**: **204 No Content**. * **Validation**: Subsequent list requests by the provider return an empty set. @@ -157,11 +175,13 @@ This test validates that the **Providers** can create, delete, and obtain rules, This test validates the **PATCH** implementation. It ensures that **Providers** can perform partial updates to their rules and that the system correctly updates metadata like `updatedAt`. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * A **Provider** has been registered and onboarded at **CCF**. * The **Provider** possesses a valid certificate (in this case **AMF** certificate). **Execution Steps**: + 1. **AMF Provider** creates a rule: **POST** request to `{apiRoot}/helper/visibility-control/rules`. 2. Send a **PATCH** request to `{apiRoot}/helper/visibility-control/rules/{ruleId}`. 3. **Payload**: Change `default_access` from **"ALLOW"** to **"DENY"**. @@ -169,6 +189,7 @@ This test validates the **PATCH** implementation. It ensures that **Providers** 5. **AMF Provider** sends a **DELETE** request for the same rule using the same provider identity and the `ruleId`. **Expected Result**: + * **Status**: **200 OK**. * **Body**: Returns the updated `Rule` object showing the new `default_access` value and a refreshed `updatedAt` timestamp, and finally the rule is successfully removed. @@ -182,16 +203,19 @@ This test validates the **PATCH** implementation. It ensures that **Providers** This test verifies the direct resource addressing logic and the error reporting. **Pre-Conditions**: + * The **CAPIF** helper service is deployed and reachable. * Superadmin credentials (`SUPERADMIN_USERNAME`) are provisioned. **Execution Steps**: + 1. **Superadmin** creates a rule: **POST** request to `{apiRoot}/helper/visibility-control/rules`. 2. Send a **GET** request for the specific resource via `{apiRoot}/helper/visibility-control/rules/{ruleId}`. 3. **DELETE** the resource. 4. Perform the same **GET** request as in step 2. **Expected Result**: + * **Step 2**: **200 OK** (Returns the specific rule object). * **Step 4**: **404 Not Found** (Ensures the resource no longer exists in the registry).