1 .. This work is licensed under a
2 .. Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
5 CLAMP Policy Participant Smoke Tests
6 ------------------------------------
11 The Smoke testing of the policy participant is executed in a local CLAMP/Policy environment. The CLAMP-ACM interfaces interact with the Policy Framework to perform actions based on the state of the policy participant. The goal of the Smoke tests is the ensure that CLAMP Policy Participant and Policy Framework work together as expected.
16 This section will show the developer how to set up their environment to start testing in GUI with some instruction on how to carry out the tests. There are several prerequisites. Note that this guide is written by a Linux user - although the majority of the steps show will be exactly the same in Windows or other systems.
24 - Refer to this guide for basic environment setup `Setting up dev environment <https://wiki.onap.org/display/DW/Setting+Up+Your+Development+Environment>`_
29 - You are accessing the policy repositories through gerrit
30 - You are using "git review".
32 The following repositories are required for development in this project. These repositories should be present on your machine and you should run "mvn clean install" on all of them so that the packages are present in your .m2 repository.
42 In this setup guide, we will be setting up all the components technically required for a working convenient dev environment.
44 2.3 Setting up the components
45 =============================
50 We will be using Docker to run our mariadb instance. It will have a total of two databases running in it.
52 - clampacm: the runtime-clampacm db
53 - policyadmin: the policy-api db
55 The easiest way to do this is to perform a small alteration on an SQL script provided by the clamp backend in the file "runtime/extra/sql/bulkload/create-db.sql"
59 CREATE DATABASE `clampacm`;
63 GRANT ALL on clampacm.* to 'policy' identified by 'P01icY' with GRANT OPTION;
64 CREATE DATABASE `policyadmin`;
66 DROP USER 'policy_user';
67 CREATE USER 'policy_user';
68 GRANT ALL on clampacm.* to 'policy_user' identified by 'policy_user' with GRANT OPTION;
71 Once this has been done, we can run the bash script provided here: "runtime/extra/bin-for-dev/start-db.sh"
77 This will setup the two databases needed. The database will be exposed locally on port 3306 and will be backed by an anonymous docker volume.
82 For convenience, a dmaap simulator has been provided in the policy/models repository. To start the simulator, you can do the following:
83 1. Navigate to /models-sim/policy-models-simulators in the policy/models repository.
84 2. Add a configuration file to src/test/resources with the following contents:
90 "name":"DMaaP simulator",
95 "name":"DMaaP simulator",
96 "providerClass":"org.onap.policy.models.sim.dmaap.rest.DmaapSimRestControllerV1",
104 3. You can then start dmaap with:
108 mvn exec:java -Dexec.mainClass=org.onap.policy.models.simulators.Main -Dexec.args="src/test/resources/YOUR_CONF_FILE.json"
110 At this stage the dmaap simulator should be running on your local machine on port 3904.
115 In the policy-api repo, you should find the file "src/main/resources/etc/defaultConfig.json". This file must be altered slightly - as below with the restServerParameters and databaseProviderParameters shown. Note how the database parameters match-up with what you setup in Mariadb:
125 mvc.converters.preferred-json-mapper: gson
127 url: jdbc:mariadb://mariadb:3306/policyadmin
128 driverClassName: org.mariadb.jdbc.Driver
129 username: policy_user
130 password: policy_user
134 dialect: org.hibernate.dialect.MariaDB103Dialect
138 physical-strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
139 implicit-strategy: org.onap.policy.common.spring.utils.CustomImplicitNamingStrategy
144 name: PolicyProviderParameterGroup
145 implementation: org.onap.policy.models.provider.impl.DatabasePolicyModelsProviderImpl
146 driver: org.mariadb.jdbc.Driver
147 url: jdbc:mariadb://mariadb:3306/policyadmin
149 password: policy_user
150 persistenceUnit: PolicyDb
153 - policytypes/onap.policies.monitoring.tcagen2.yaml
154 - policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.yaml
155 - policytypes/onap.policies.monitoring.dcae-restconfcollector.yaml
156 - policytypes/onap.policies.monitoring.dcae-pm-subscription-handler.yaml
157 - policytypes/onap.policies.monitoring.dcae-pm-mapper.yaml
158 - policytypes/onap.policies.Optimization.yaml
159 - policytypes/onap.policies.optimization.Resource.yaml
160 - policytypes/onap.policies.controlloop.operational.common.Drools.yaml
162 - policies/sdnc.policy.naming.input.tosca.yaml
168 include: health,metrics,prometheus
169 path-mapping.prometheus: metrics
171 Next, navigate to the "/main" directory. You can then run the following command to start the policy api:
175 mvn exec:java -Dexec.mainClass=org.onap.policy.api.main.startstop.Main -Dexec.args=" -c ../packages/policy-api-tarball/src/main/resources/etc/defaultConfig.json"
180 In the policy-pap repo, you should find the file 'main/src/test/resources/parameters/PapConfigParameters.json'. This file may need to be altered slightly as below:
191 preferred-json-mapper: gson
193 url: jdbc:mariadb://mariadb:3306/policyadmin
194 driverClassName: org.mariadb.jdbc.Driver
195 username: policy_user
196 password: policy_user
200 dialect: org.hibernate.dialect.MySQL5InnoDBDialect
204 physical-strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
205 implicit-strategy: org.onap.policy.pap.main.CustomImplicitNamingStrategy
215 Next, navigate to the "/main" directory. You can then run the following command to start the policy pap
219 mvn -q -e clean compile exec:java -Dexec.mainClass="org.onap.policy.pap.main.startstop.Main" -Dexec.args="-c /src/test/resources/parameters/PapConfigParameters.json"
222 ^^^^^^^^^^^^^^^^^^^^^^^^^
224 To start the clampacm runtime we need to go the "runtime-clampacm" directory in the clamp repo. There is a config file that is used, by default, for the clampacm runtime. That config file is here: "src/main/resources/application.yaml". For development in your local environment, it shouldn't need any adjustment and we can just run the clampacm runtime with:
230 2.3.6 ACM Policy Participant
231 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
233 To start the policy participant we need to go to the "participant-impl/participant-impl-policy" directory in the clamp repo. There is a config file under "src/main/resources/config/application.yaml". For development in your local environment, we will need to adjust this file slightly:
241 pdpGroup: defaultGroup
247 userName: healthcheck
250 allowSelfSignedCerts: true
255 userName: healthcheck
258 allowSelfSignedCerts: true
259 intermediaryParameters:
260 reportingTimeIntervalMs: 120000
261 description: Participant Description
263 name: org.onap.PM_Policy
266 name: org.onap.policy.clampacm.PolicyControlLoopParticipant
268 clampControlLoopTopics:
271 topic: POLICY-CLRUNTIME-PARTICIPANT
273 - ${topicServer:localhost}
274 topicCommInfrastructure: dmaap
278 topic: POLICY-CLRUNTIME-PARTICIPANT
280 - ${topicServer:localhost}
281 topicCommInfrastructure: dmaap
283 Navigate to the participant-impl/particpant-impl-policy/main directory. We can then run the policy-participant with the following command:
287 mvn spring-boot:run -Dspring-boot.run.arguments="--server.port=8082 --topicServer=localhost"
295 To perform the Smoke testing of the policy-participant we will be verifying the behaviours of the participant when the control loop changes state. The scenarios are:
297 - UNINITIALISED to PASSIVE: participant creates policies and policyTypes specified in the ToscaServiceTemplate using policy-api and deploys the policies using pap.
298 - PASSIVE to RUNNING: participant changes state to RUNNING. No operation performed.
299 - RUNNING to PASSIVE: participant changes state to PASSIVE. No operation performed.
300 - PASSIVE to UNINITIALISED: participant undeploys deployed policies and deletes policies and policyTypes which have been created.
306 ************************
308 An ACM is created by commissioning a Tosca template with ACM definitions and instantiating the ACM with the state "UNINITIALISED".
309 Using postman, commission a TOSCA template and instantiate using the following template:
311 :download:`Tosca Service Template <tosca/tosca_service_template_pptnt_smoke.yaml>`
313 :download:`Instantiate ACM <tosca/instantiation_pptnt_smoke.json>`
315 To verify this, we check that the ACM has been created and is in state UNINITIALISED.
317 .. image:: images/pol-part-clampacm-creation-ver.png
319 Creation of policies and policyTypes:
320 *************************************
322 The ACM STATE is changed from UNINITIALISED to PASSIVE using postman:
327 "orderedState": "PASSIVE",
328 "controlLoopIdentifierList": [
330 "name": "PMSHInstance0",
336 This state change will trigger the creation of policies and policyTypes using the policy-api. To verify this we will check, using policy-api endpoints, that the "Test Policy" policyType, which is specified in the service template, has been created.
338 .. image:: images/pol-part-clampacm-test-policy-ver.png
340 We can also check that the pm-control policy has been created.
342 .. image:: images/pol-part-clampacm-pmcontrol-ver.png
344 Deployment of policies:
345 ***********************
347 The ACM STATE is changed from UNINITIALISED to PASSIVE using postman:
349 This state change will trigger the deployment of the policies specified in the ToscaServiceTemplate. To verify this, we will check that the apex pmcontrol policy has been deployed to the defaultGroup. We check this using pap:
351 .. image:: images/pol-part-clampacm-pmcontrol-deploy-ver.png
353 Undeployment of policies:
354 *************************
356 The ACM STATE is changed from PASSIVE to UNINITIALISED using postman:
361 "orderedState": "UNINITIALISED",
362 "controlLoopIdentifierList": [
364 "name": "PMSHInstance0",
370 This state change will trigger the undeployment of the pmcontrol policy which was deployed previously. To verify this we do a PdpGroup Query as before and check that the pmcontrol policy has been undeployed and removed from the defaultGroup:
372 .. image:: images/pol-part-clampacm-pmcontrol-undep-ver.png
374 Deletion of policies and policyTypes:
375 *************************************
377 The ACM STATE is changed from PASSIVE to UNINITIALISED using postman:
379 This state change will trigger the deletion of the previously created policies and policyTypes. To verify this, as before, we can check that the Test Policy policyType is not found this time and likewise for the pmcontrol policy:
381 .. image:: images/pol-part-clampacm-test-policy-nf.png
383 .. image:: images/pol-part-clampacm-pmcontrol-nf.png