Policy Platform Development Tools
This article explains how to build the ONAP Policy Framework for development purposes and how to run stability/performance tests for a variety of components. To start, the developer should consult the latest ONAP Wiki to familiarize themselves with developer best practices and how-tos to setup their environment, see https://wiki.onap.org/display/DW/Developer+Best+Practices.
This article assumes that:
You are using a *nix operating system such as linux or macOS.
You are using a directory called git off your home directory (~/git) for your git repositories
Your local maven repository is in the location ~/.m2/repository
You have copied the settings.xml from oparent to ~/.m2/ directory
You have added settings to access the ONAP Nexus to your M2 configuration, see Maven Settings Example (bottom of the linked page)
The procedure documented in this article has been verified to work on a MacBook laptop running macOS Mojave Version 10.14.6 and an Ubuntu 18.06 VM.
Cloning All The Policy Repositories
Run a script such as the script below to clone the required modules from the ONAP git repository. This script clones all the ONAP Policy Framework repositories.
ONAP Policy Framework has dependencies to the ONAP Parent oparent module, the ONAP ECOMP SDK ecompsdkos module, and the A&AI Schema module.
1 #!/usr/bin/env bash
2
3 ## script name for output
4 MOD_SCRIPT_NAME=`basename $0`
5
6 ## the ONAP clone directory, defaults to "onap"
7 clone_dir="onap"
8
9 ## the ONAP repos to clone
10 onap_repos="\
11 policy/parent \
12 policy/common \
13 policy/models \
14 policy/docker \
15 policy/api \
16 policy/pap \
17 policy/apex-pdp \
18 policy/drools-pdp \
19 policy/drools-applications \
20 policy/xacml-pdp \
21 policy/distribution \
22 policy/gui \
23 policy/clamp "
24
25 ##
26 ## Help screen and exit condition (i.e. too few arguments)
27 ##
28 Help()
29 {
30 echo ""
31 echo "$MOD_SCRIPT_NAME - clones all required ONAP git repositories"
32 echo ""
33 echo " Usage: $MOD_SCRIPT_NAME [-options]"
34 echo ""
35 echo " Options"
36 echo " -d - the ONAP clone directory, defaults to '.'"
37 echo " -h - this help screen"
38 echo ""
39 exit 255;
40 }
41
42 ##
43 ## read command line
44 ##
45 while [ $# -gt 0 ]
46 do
47 case $1 in
48 #-d ONAP clone directory
49 -d)
50 shift
51 if [ -z "$1" ]; then
52 echo "$MOD_SCRIPT_NAME: no clone directory"
53 exit 1
54 fi
55 clone_dir=$1
56 shift
57 ;;
58
59 #-h prints help and exists
60 -h)
61 Help;exit 0;;
62
63 *) echo "$MOD_SCRIPT_NAME: undefined CLI option - $1"; exit 255;;
64 esac
65 done
66
67 if [ -f "$clone_dir" ]; then
68 echo "$MOD_SCRIPT_NAME: requested clone directory '$clone_dir' exists as file"
69 exit 2
70 fi
71 if [ -d "$clone_dir" ]; then
72 echo "$MOD_SCRIPT_NAME: requested clone directory '$clone_dir' exists as directory"
73 exit 2
74 fi
75
76 mkdir $clone_dir
77 if [ $? != 0 ]
78 then
79 echo cannot clone ONAP repositories, could not create directory '"'$clone_dir'"'
80 exit 3
81 fi
82
83 for repo in $onap_repos
84 do
85 repoDir=`dirname "$repo"`
86 repoName=`basename "$repo"`
87
88 if [ ! -z $dirName ]
89 then
90 mkdir "$clone_dir/$repoDir"
91 if [ $? != 0 ]
92 then
93 echo cannot clone ONAP repositories, could not create directory '"'$clone_dir/repoDir'"'
94 exit 4
95 fi
96 fi
97
98 git clone https://gerrit.onap.org/r/${repo} $clone_dir/$repo
99 done
100
101 echo ONAP has been cloned into '"'$clone_dir'"'
Execution of the script above results in the following directory hierarchy in your ~/git directory:
~/git/onap
~/git/onap/policy
~/git/onap/policy/parent
~/git/onap/policy/common
~/git/onap/policy/models
~/git/onap/policy/api
~/git/onap/policy/pap
~/git/onap/policy/gui
~/git/onap/policy/docker
~/git/onap/policy/drools-applications
~/git/onap/policy/drools-pdp
~/git/onap/policy/clamp
~/git/onap/policy/apex-pdp
~/git/onap/policy/xacml-pdp
~/git/onap/policy/distribution
Building ONAP Policy Framework Components
Step 1: Optionally, for a completely clean build, remove the ONAP built modules from your local repository.
rm -fr ~/.m2/repository/org/onap
Step 2: A pom such as the one below can be used to build the ONAP Policy Framework modules. Create the pom.xml file in the directory ~/git/onap/policy.
1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
2 <modelVersion>4.0.0</modelVersion>
3 <groupId>org.onap</groupId>
4 <artifactId>onap-policy</artifactId>
5 <version>1.0.0-SNAPSHOT</version>
6 <packaging>pom</packaging>
7 <name>${project.artifactId}</name>
8 <inceptionYear>2017</inceptionYear>
9 <organization>
10 <name>ONAP</name>
11 </organization>
12
13 <modules>
14 <module>parent</module>
15 <module>common</module>
16 <module>models</module>
17 <module>api</module>
18 <module>pap</module>
19 <module>apex-pdp</module>
20 <module>xacml-pdp</module>
21 <module>drools-pdp</module>
22 <module>drools-applications</module>
23 <module>distribution</module>
24 <module>gui</module>
25 <module>clamp</module>
26 </modules>
27 </project>
Policy Architecture/API Transition
In Dublin, a new Policy Architecture was introduced. The legacy architecture runs in parallel with the new architecture. It will be deprecated after Frankfurt release. If the developer is only interested in working with the new architecture components, the engine sub-module can be ommitted.
Step 3: You can now build the Policy framework.
Java artifacts only:
cd ~/git/onap mvn clean install
With docker images:
cd ~/git/onap mvn clean install -P docker
Developing and Debugging each Policy Component
Running a MariaDb Instance
The Policy Framework requires a MariaDb instance running. The easiest way to do this is to run a docker image locally.
One example on how to do this is to use the scripts used by the policy/api S3P tests.
Simulator Setup Script Example
cd ~/git/onap/api/testsuites/stability/src/main/resources/simulatorsetup ./setup_components.sh
Another example on how to run the MariaDb is using the docker compose file used by the Policy API CSITs:
Running the API component standalone
Assuming you have successfully built the codebase using the instructions above. The only requirement for the API component to run is a running MariaDb database instance. The easiest way to do this is to run the docker image, please see the mariadb documentation for the latest information on doing so. Once the mariadb is up and running, a configuration file must be provided to the api in order for it to know how to connect to the mariadb. You can locate the default configuration file in the packaging of the api component:
Default Policy API Configuration
You will want to change the fields pertaining to “host”, “port” and “databaseUrl” to your local environment settings and start the policy-api springboot application either using your IDE of choice or using the run goal from Spring Boot Maven plugin: mvn spring-boot:run.
Running the API component using Docker Compose
An example of running the api using a docker compose script is located in the Policy Integration CSIT test repository.
Running the PAP component standalone
Once you have successfully built the PAP codebase, a running MariaDb database and DMaaP instance will also be required to start up the application. For MariaDb instance, the easiest way is to run the docker image, please see the mariadb documentation for the latest information on doing so. For DMaaP, the easiest way during development is to run the DMaaP simulator which is explained in the below sections. Once the mariadb and DMaaP are running, a configuration file must be provided to the PAP component in order for it to know how to connect to the mariadb and DMaaP along with other relevant configuration details. You can locate the default configuration file in the packaging of the PAP component:
Update the fields related to MariaDB, DMaaP and the RestServer for the application as per your local environment settings. Then to start the application, just run the Spring Boot application using IDE or command line.
Running the Smoke Tests
The following links contain instructions on how to run the smoke tests. These may be helpful to developers to become familiar with the Policy Framework components and test any local changes.
- CLAMP GUI Smoke Tests
- Policy DB Migrator Smoke Tests
- CLAMP participants (kubernetes, http) Smoke Tests
- CLAMP Automation Composition Smoke Tests
- CLAMP Participant Protocol Smoke Tests
- CLAMP Policy Participant Smoke Tests
- Policy API Smoke Test
- Policy PAP Smoke Test
- Apex-PDP Smoke Test
- Policy Drools PDP and Applications Smoke Test
- XACML PDP Smoke Test
- Policy Distribution Smoke Test
Running the Stability/Performance Tests
The following links contain instructions on how to run the S3P Stability and Performance tests. These may be helpful to developers to become familiar with the Policy Framework components and test any local changes.
Running the Pairwise Tests
The following links contain instructions on how to run the pairwise tests. These may be helpful to developers check that the Policy Framework works in a full ONAP deployment.
Generating Swagger Documentation
1. Using Swagger2Markup maven plugin from Policy Parent Integration POM
The Policy Parent Integration POM contains a generateSwaggerDocs profile. This profile can be activated on any module that has a Swagger endpoint. When active, this profile creates a tarball in Nexus with the name <project-artifactId>-swagger-docs.tar.gz. The tarball contains the following files:
swagger/swagger.html
swagger/swagger.json
swagger/swagger.pdf
The profile is activated when:
The following property is defined at the top of the pom.xml file for a module
<!-- This property triggers generation of the Swagger documents --> <swagger.generation.phase>post-integration-test</swagger.generation.phase>
See the CLAMP runtime POM for an example of the usage of this property.
Unit tests are being executed in the build, in other words when the skipTests flag is false.
You must create a unit test in your module that generates the following file:
src/test/resources/swagger/swagger.json
Typically, you do this by starting your REST endpoint in a unit test, issuing a REST call to get the Swagger API documentation. The test case below is an example of such a test case.
@Test
public void testSwaggerJson() throws Exception {
ResponseEntity<String> httpsEntity = getRestTemplate()
.getForEntity("https://localhost:" + this.httpsPort + "/restservices/clds/api-doc", String.class);
assertThat(httpsEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
assertThat(httpsEntity.getBody()).contains("swagger");
FileUtils.writeStringToFile(new File("target/swagger/swagger.json"), httpsEntity.getBody(),
Charset.defaultCharset());
}
See this unit test case for the full example.
2. Accessing Swagger documentation for springboot based policy applications
Springfox Swagger2 maven dependency aids with auto-generation of Swagger documentation.
Using the Swagger-UI maven dependency Swagger HTML documentation can be accessed at the root url.
The generated swagger.json can be accessed at: https://service_IP:service_port/v2/api-docs
Swagger UI can be accessed at: https://service_IP:service_port/swagger-ui/index.html
Running the DMaaP Simulator during Development
It is sometimes convenient to run the DMaaP simulator during development. You can run it from the command line using Maven or from within your IDE.
Running on the Command Line
Check out the policy models repository
Go to the models-sim/policy-models-simulators subdirectory in the policy-models repo
Run the following Maven command:
mvn exec:java -Dexec.mainClass=org.onap.policy.models.simulators.Main -Dexec.args="src/test/resources/simParameters.json"
Running in Eclipse
Check out the policy models repository
Go to the models-sim/policy-models-simulators module in the policy-models repo
Specify a run configuration using the class org.onap.policy.models.simulators.Main as the main class
Specify an argument of src/test/resources/simParameters.json to the run configuration
Run the configuration
Specifying a local configuration file
You may specify a local configuration file instead of src/test/resources/simParameters.json on the command line or as an argument in the run configuration in eclipse:
{
"dmaapProvider": {
"name": "DMaaP simulator",
"topicSweepSec": 900
},
"restServers": [
{
"name": "DMaaP simulator",
"providerClass": "org.onap.policy.models.sim.dmaap.rest.DmaapSimRestControllerV1",
"host": "localhost",
"port": 3904,
"https": false
}
]
}