summaryrefslogtreecommitdiffstats
path: root/docs/development/devtools/smoke/distribution-smoke.rst
blob: c0e3cb1d5821af88a4653a53ddf80d4ce7343c01 (plain)
1
2
3
4
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
65
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
126
127
128
129
130
131
132
133
134
135
136
137
.. This work is licensed under a
.. Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

.. _policy-distribution-smoke-testing-label:

Policy Distribution Smoke Test
################################

The policy-distribution smoke testing is executed against a custom ONAP docker installation as defined in the docker compose file in "policy/docker/csit/".
The policy-distribution configuration file is located in "docker/csit/config/distribution/".
This test verifies the execution of the REST api's exposed by the component to make sure the CSAR Decoding and Forwarding works as expected.

General Setup
*****************
In policy/docker/csit/

.. code-block:: bash

    ./start-grafana.sh distribution

This script will compose the ONAP components used during the smoke tests are:

- Policy API to perform CRUD of policies.
- Policy DB to store the policies, and DB Migrator to start the db.
- DMAAP Simulator for the communication between components.
- Policy PAP to perform runtime administration (deploy/undeploy/status/statistics/etc).
- Policy Apex-PDP to deploy & undeploy policies. And send heartbeats to PAP.
- Policy Drools-PDP to deploy & undeploy policies. And send heartbeats to PAP.
- Policy Xacml-PDP to deploy & undeploy policies. And send heartbeats to PAP.

- Policy Distribution to test the Decoding and Forwarding functions.

Use this script to easily bring down the containers :

.. code-block:: bash

    ./stop-grafana.sh

Testing procedure
**********************

The test set is focused on the following use cases:

- Wait until Distribution starts and reach the built-in REST endpoints for fetching healthcheck & statistics.
- Execute some of the REST api's exposed by policy-pap component.

Starting Policy Distribution
------------------------------------

Check the docker logs to see when Distribution service is up and running.

Get the ips of distribution and pap services:

.. code::
  :number-lines:

    ./get-instance-ip.sh policy-distribution
	./get-instance-ip.sh policy-pap

Health check status & statistical data of running distribution system.

.. code-block:: bash

	curl -u 'healthcheck:zb!XztG34' --basic http://{POLICY_DISTRIBUTION_IP}:6969/healthcheck
	curl -u 'healthcheck:zb!XztG34' --basic http://{POLICY_DISTRIBUTION_IP}:6969/statistics

Expected result for healthcheck

.. code-block:: json

	{"name":"Policy SSD","url":"policy-distribution","healthy":true,"code":200,"message":"alive"}

Expected result for statistics

.. code-block:: json

	{"code":200,"totalDistributionCount":0,"distributionSuccessCount":0,"distributionFailureCount":0,"totalDownloadCount":0,"downloadSuccessCount":0,"downloadFailureCount":0}

Trigger Policy Distribution Core
------------------------------------------

In order to test policy-distribution, we need to trigger the decoding copying a .csar in the mapped volume,
defined in the docker-compose-distribution-smoke.yml as :

.. code-block:: yaml

      volumes:
       - ./distribution/config/temp/:/opt/app/policy/distribution/etc/temp/

So now copy the "sample_csar_with_apex_policy.csar" from ./distribution/config/csar/ to ./distribution/config/temp/

If the commissioning is successful we should see from the logs this message

.. image:: images/message-commissioning-participant.png

So if we check the distribution statistics again

.. code-block:: bash

	{"code":200,"totalDistributionCount":1,"distributionSuccessCount":1,"distributionFailureCount":0,"totalDownloadCount":1,"downloadSuccessCount":1,"downloadFailureCount":0}

Execute policy-pap testing
------------------------------------
.. note::
	The user for pap is different.

Check the details of policies deployed

.. code-block:: bash

	curl -k --user 'policyadmin:zb!XztG34' http://{POLICY_PAP_IP}:6969/policy/pap/v1/policies/status

Expected SUCCESS result

.. code-block:: json

	[{"pdpGroup":"defaultGroup","pdpType":"apex","pdpId":"apex-91fa25a1-0456-42fa-9556-6a4d2bd613fc","policy":{"name":"operational.apex.sampledomain","version":"1.0.0"},"policyType":{"name":"onap.policies.native.Apex","version":"1.0.0"},"deploy":true,"state":"SUCCESS"},{"pdpGroup":"defaultGroup","pdpType":"xacml","pdpId":"xacml-83e19452-0854-41dd-9f17-8b0a68f11813","policy":{"name":"SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP","version":"1.0.0"},"policyType":{"name":"onap.policies.Naming","version":"1.0.0"},"deploy":true,"state":"SUCCESS"}]

Check number of policies deployed

.. code-block:: bash

	curl -k --user 'policyadmin:zb!XztG34' http://{POLICY_PAP_IP}:6969/policy/pap/v1/policies/deployed

Expected success-count result

.. code-block:: json

	[{"policy-type":"onap.policies.native.Apex","policy-type-version":"1.0.0","policy-id":"operational.apex.sampledomain","policy-version":"1.0.0","success-count":1,"failure-count":0,"incomplete-count":0},{"policy-type":"onap.policies.Naming","policy-type-version":"1.0.0","policy-id":"SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP","policy-version":"1.0.0","success-count":1,"failure-count":0,"incomplete-count":0}]

Or download & execute the steps in postman collection for verifying policy-pap component.
The steps need to be performed sequentially one after another. And no input is required from user.

`Policy Framework Administration API <https://github.com/onap/policy-pap/blob/master/postman/pap-api-collection.json>`_

Make sure to execute the delete steps in order to clean the setup after testing.