CLAMP Automation Composition Smoke Tests

This article explains how to build the CLAMP automation composition for development purposes and how to run smoke tests for automation composition. 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 using Ubuntu 20.04 LTS VM.

Cloning CLAMP automation composition and all dependency

Run a script such as the script below to clone the required modules from the ONAP git repository. This script clones CLAMP automation composition and all dependency.

ONAP Policy Framework has dependencies to the ONAP Parent oparent module, the ONAP ECOMP SDK ecompsdkos module, and the A&AI Schema module.

Typical ONAP Policy Framework Clone Script
 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/clamp "
15
16 ##
17 ## Help screen and exit condition (i.e. too few arguments)
18 ##
19 Help()
20 {
21     echo ""
22     echo "$MOD_SCRIPT_NAME - clones all required ONAP git repositories"
23     echo ""
24     echo "       Usage:  $MOD_SCRIPT_NAME [-options]"
25     echo ""
26     echo "       Options"
27     echo "         -d          - the ONAP clone directory, defaults to '.'"
28     echo "         -h          - this help screen"
29     echo ""
30     exit 255;
31 }
32
33 ##
34 ## read command line
35 ##
36 while [ $# -gt 0 ]
37 do
38     case $1 in
39         #-d ONAP clone directory
40         -d)
41             shift
42             if [ -z "$1" ]; then
43                 echo "$MOD_SCRIPT_NAME: no clone directory"
44                 exit 1
45             fi
46             clone_dir=$1
47             shift
48         ;;
49
50         #-h prints help and exists
51         -h)
52             Help;exit 0;;
53
54         *)    echo "$MOD_SCRIPT_NAME: undefined CLI option - $1"; exit 255;;
55     esac
56 done
57
58 if [ -f "$clone_dir" ]; then
59     echo "$MOD_SCRIPT_NAME: requested clone directory '$clone_dir' exists as file"
60     exit 2
61 fi
62 if [ -d "$clone_dir" ]; then
63     echo "$MOD_SCRIPT_NAME: requested clone directory '$clone_dir' exists as directory"
64     exit 2
65 fi
66
67 mkdir $clone_dir
68 if [ $? != 0 ]
69 then
70     echo cannot clone ONAP repositories, could not create directory '"'$clone_dir'"'
71     exit 3
72 fi
73
74 for repo in $onap_repos
75 do
76     repoDir=`dirname "$repo"`
77     repoName=`basename "$repo"`
78
79     if [ ! -z $dirName ]
80     then
81         mkdir "$clone_dir/$repoDir"
82         if [ $? != 0 ]
83         then
84             echo cannot clone ONAP repositories, could not create directory '"'$clone_dir/repoDir'"'
85             exit 4
86         fi
87     fi
88
89     git clone https://gerrit.onap.org/r/${repo} $clone_dir/$repo
90 done
91
92 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/clamp

Building CLAMP automation composition and all dependency

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.

Typical pom.xml to build the ONAP Policy Framework
 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>2023</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>clamp</module>
18      </modules>
19  </project>

Step 3: You can now build the Policy framework.

Build java artifacts only:

cd ~/git/onap/policy
mvn clean install

Build with docker images:

cd ~/git/onap/policy/clamp/packages/
mvn clean install -P docker

cd ~/git/onap/policy/models/models-sim/packages
mvn clean install -P docker

Running MariaDb and DMaaP Simulator

Running a MariaDb Instance

Assuming you have successfully built the codebase using the instructions above. There are two requirements for the Clamp automation composition component to run, one of them is a running MariaDb database instance. The easiest way to do this is to run the docker image locally.

A sql such as the one below can be used to build the SQL initialization. Create the mariadb.sql file in the directory ~/git.

create database clampacm;
CREATE USER 'policy'@'%' IDENTIFIED BY 'P01icY';
GRANT ALL PRIVILEGES ON clampacm.* TO 'policy'@'%';

Execution of the command above results in the creation and start of the mariadb-smoke-test container.

cd ~/git
docker run --name mariadb-smoke-test  \
 -p 3306:3306 \
 -e MYSQL_ROOT_PASSWORD=my-secret-pw  \
 --mount type=bind,source=$HOME/git/mariadb.sql,target=/docker-entrypoint-initdb.d/data.sql \
 -d mariadb:10.10.2 \
 --lower-case-table-names=1

Running the DMaaP Simulator during Development

The second requirement for the Clamp automation composition component to run is to run the DMaaP simulator. You can run it from the command line using Maven.

Create a new configuration file ~/git/onap/policy/models/models-sim/policy-models-simulators/src/test/resources/newParameters.json using the below code:

{
  "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
    }
  ]
}

Run the following commands:

cd ~/git/onap/policy/models/models-sim/policy-models-simulators
mvn exec:java  -Dexec.mainClass=org.onap.policy.models.simulators.Main -Dexec.args="src/test/resources/newParameters.json"

Developing and Debugging CLAMP automation composition

Running on the Command Line using Maven

Once the mariadb and DMaap simulator are up and running, run the following commands:

cd ~/git/onap/policy/clamp/runtime-acm
mvn spring-boot:run

Running on the Command Line

cd ~/git/onap/policy/clamp/runtime-acm
java -jar target/policy-clamp-runtime-acm-6.4.2-SNAPSHOT.jar

Running in Eclipse

  1. Check out the policy models repository

  2. Go to the policy-clamp-runtime-acm module in the clamp repo

  3. Where necessary Add as Source Folder ‘target/generated-sources/swagger’

  4. Specify a run configuration using the class org.onap.policy.clamp.acm.runtime.Application as the main class

  5. Run the configuration

Swagger UI of Automation composition is available at http://localhost:6969/onap/policy/clamp/acm/swagger-ui/index.html

Running one or more participants

Into HTTP Participant you can find a test case with http-participant.

Run the following commands:

cd ~/git/onap/policy/clamp/participant/participant-impl/participant-impl-http
java -jar target/policy-clamp-participant-impl-http-6.4.2-SNAPSHOT.jar

Running the CLAMP automation composition docker image

Create the ‘docker-composition.yaml’ using following code:

version: '3.1'

services:
  mariadb:
    image: mariadb:10.10.2
    volumes:
      - type: bind
        source: ./mariadb.sql
        target: /docker-entrypoint-initdb.d/data.sql
    environment:
      - MYSQL_ROOT_PASSWORD=my-secret-pw
      - lower-case-table-names=1
    ports:
      - "3306:3306"

  runtime-acm:
    image: onap/policy-clamp-runtime-acm
    environment:
      - mariadb.host=mariadb
      - topicServer=message-router
    volumes:
      - type: bind
        source: ./onap/policy/clamp/runtime-acm/src/main/resources/application.yaml
        target: /opt/app/policy/clamp/etc/AcRuntimeParameters.yaml
    ports:
      - "6969:6969"

  message-router:
    image: onap/policy-models-simulator
    volumes:
      - type: bind
        source: ./onap/policy/models/models-sim/policy-models-simulators/src/test/resources/newParameters.json
        target: /opt/app/policy/simulators/etc/mounted/simParameters.json
    ports:
      - "3904:3904"

Run the docker composition:

cd ~/git/
docker-compose up

Swagger UI of automation composition is available at http://localhost:6969/onap/policy/clamp/acm/swagger-ui/index.html