Commit 5669454d authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

Merge branch 'OCF-Doc18-create-test-suite-for-apistatus-at-documentation' into 'develop' 

Resolve "Create Test Suite for apiStatus at documentation"

Closes #18

See merge request !22
parents c0e087b8 78f7160d

doc/releasenotes.md

+84 −2
Original line number Diff line number Diff line 
## **Release 2.0.0**



### **New Features**



#### 3GPP CAPIF release 18



- New endpoints included in new release 18 with new logic.

- New logic to support ***Vendor Extensibility*** on Publish Service.

- New logic to support ***API Status*** feature on Publish and Events Services.

- Supported Features now are mandatory for all POST and PUT Requests as is described on TS 29.222.

    - **Possible Breaking change**, all POST request now must include supported features attribute, default can me set to "0" to keep all features inactive.

    - **Possible Breaking change** on Events API, if you need eventDetails information on notification you must activate **Enhanced Event Report** feature by setting properly the supported features flag.



### **Technical Debt Solved**



#### **Api Status feature**



- Events API:

    - Event internal notifications between services improved to accomplish specification.

    - On event subscription **SupportedFeatures** is readed and stored in db to accomplish specification.

    - Also **SupportedFeatures** is checked before send event notification, in order to accomplish specification, sending **eventDetails** and related information according to ***enhanced_event_report*** and ***apiStatusMonitoring*** supported features activated.



#### **Issues**



- Solved issue to get ready REDIS on deployment: REDIS scheduled on start to allow receive notification since service is deployed.

- Solved problem removing service APIs published is provider register more than one APF.

- Solved Superadmin problem deleting service API published through helper service if provider is not present.

- Increased the overall stability, fixing some corner cases.

- Location headers now are filled in same way at all services that needs it.

- Security issues solved.

- Base docker images present on ETSI registry.

- Robot image uploaded to ETSI Registry.



#### Local Scripts



- All scripts were reviewed and improved.

- New scripts to manage users on local deployment added:

  - create_users.sh: helps developer to create new users in local deployment.

  - remove_users.sh: helps developer to remove users from db in local deployment.



#### Remote Scripts



New scripts developed to help on remote deployment, configuration and testing. All this script are stored under helm/scripts in capif repository.



***variables.sh*** contains all configuration that will be used on remote operation. This file must be filled carefully before run remote scripts.



- Deployment Scripts:

    - ***install_vault.sh***: Deploy Vault component from k8s cluster, only needed if vault is not previously deployed. If it’s deployed you can setup vault token on variables.sh.

    - ***install_monitoring.sh***: Deploy monitoring on k8s cluster.

    - ***install_capif.sh***: Deploy OpenCAPIF on k8s cluster. It will be deployed on configured namespace with domain and hostnames configured under variables.sh.

    - ***uninstall_vault.sh***: Rollback Vault component from k8s cluster.

    - ***uninstall_monitoring.sh***: Rollback monitoring components from k8s cluster.

    - ***uninstall_capif.sh***: Rollback OpenCAPIF from k8s cluster.



- Manage remote users:

    - ***create_remote_users.sh***: This script create users setup by parameters on deployed OpenCAPIF. Those users are created by administrator.

    - ***remove_remote_users.sh***: This script removes user from deployed OpenCAPIF.

    - ***remove_remote_users_by_prefix.sh***:: This script removes users by prefix.



- Configuration of bastion machine, this simplify DNS fixed resolution:

    - ***get_ingress.sh***: This create a configuration for dns fixed resolution for ingress configured in namespace passed by parameters.

    - ***set_ingress.sh***: This scripts adds to /etc/hosts the fixed DNS resolution for ingress setup for  namespace passed by parameters.



- Execute robot tests over remote deployment.

    - ***run_remote_capif_tests.sh***: This scripts launch Robot Test docker image on current machine to reach deployed OpenCAPIF. Is useful to launch with “--include smoke” in order to ensure all is deployed properly.



- Just for testing, next scripts upload dummy information to deployed OpenCAPIF:

    - ***populate_create_remote_dummy_users.sh***: : Create Dummy providers and invokers, publish service APIs and creates security context for invokers.

    - ***populate_remove_remote_dummy_users.sh***: Remove dummy information created.





### **Documentation**



#### New test included on documentation



- New Vendor Extensibility test suite with 9 tests. [Api Events Service](./testing/testplan/vendor_extensibility/README.md)

- New [API Status feature](./testing/testplan/api_status/README.md) test suite.

- Improved [Events test suite](./testing/testplan/api_events_service/README.md) with 8 new tests.

- Test plan updated with default supported features for all request set to "0" (all inactive by default) [See common operations](./testing/testplan/common_operations/README.md).



---



## **Release 1.0.0**



### **New Features**
@@ -179,5 +261,5 @@ This Release also includes a Robot Test Suite for all those services and a Postm 
[OCF Event test plan documentation]: https://ocf.etsi.org/documentation/latest/testing/testplan/api_events_service/ "OCF Event test plan documentation"

[OCF Registration Flow]: https://ocf.etsi.org/documentation/latest/testing/testplan/common_operations/ "OCF Registration Flow"

[New Registration Demo]: https://www.youtube.com/watch?v=sn-tN6eRvv8 "New Registration Demo"

[CICD Wiki]: [https://](https://labs.etsi.org/rep/ocf/community/-/wikis/OCF-CICD)   "CI/CD Wiki"

[Upgrade Release 17 to 18 Wiki]: [https://](https://labs.etsi.org/rep/ocf/community/-/wikis/?¿?¿?¿?¿?)   "Upgrade Release 17 to 18 Wiki"
 
[CICD Wiki]: https://labs.etsi.org/rep/ocf/community/-/wikis/OCF-CICD "CI/CD Wiki"

[Upgrade Release 17 to 18 Wiki]: https://labs.etsi.org/rep/ocf/community/-/wikis/?¿?¿?¿?¿?   "Upgrade Release 17 to 18 Wiki"

doc/testing/testplan/README.md

+1 −0
Original line number Diff line number Diff line
@@ -14,3 +14,4 @@ List of Common API Services implemented: 
  

## Features

* [Vendor Extensibility](./vendor_extensibility/README.md)

* [Api Status](./api_status/README.md)

doc/testing/testplan/api_access_control_policy/service_api_description_post_example.json

+1 −1
Original line number Diff line number Diff line
@@ -95,7 +95,7 @@ 
    }

  ],

  "description": "string",

  "supportedFeatures": "fffff",

  "supportedFeatures": "0",

  "shareableInfo": {

    "isShareable": true,

    "capifProvDoms": [

doc/testing/testplan/api_events_service/README.md

+574 −10

File changed.

Preview size limit exceeded, changes collapsed.

doc/testing/testplan/api_events_service/event_subscription.json

+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ 
  "events": ["SERVICE_API_AVAILABLE", "API_INVOKER_ONBOARDED"],

  "notificationDestination": "http://robot.testing",

  "requestTestNotification": true,

  "supportedFeatures": "aaa",

  "supportedFeatures": "0",

  "websockNotifConfig": {

    "requestWebsocketUri": true,

    "websocketUri": "websocketUri"