(draft)

Objective

Have the processor running locally is to use the IDE to run the code, while having the database running in a container. This way, code changes can be conveniently tested and debugged.

Check out the code

Check out the latest code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds

Build it locally

In the checked out directory, type

    mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none

Spin up a Docker container with the database

The Blueprints Processor project uses a database to store information about the blueprints and therefore it needs to be online before attempting to run it.

One way to create the database is to adapt the docker-compose.yaml file present on the distribution module.

Navigate to the docker-compose file in the distribution module:

    cd ms/blueprintsprocessor/distribution/src/main/dc

Edit it to exclude the blueprints-processor image:

version: '3.3'

services:
  db:
    image: mariadb:latest
    container_name: ccsdk-mariadb
    ports:
    - "3306:3306"
    volumes:
    - ~/vm_mysql:/var/lib/mysql
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: sdnctl
      MYSQL_DATABASE: sdnctl
      MYSQL_USER: sdnctl
      MYSQL_PASSWORD: sdnctl
#  blueprints-processor:
#    depends_on:
#    - db
#    image: onap/ccsdk-blueprintsprocessor:latest
#    container_name: bp-rest
#    ports:
#    - "8000:8080"
#    restart: always
#    environment:
#      APPLICATIONNAME: BlueprintsProcessor
#      BUNDLEVERSION: 1.0.0
#      APP_CONFIG_HOME: /opt/app/onap/config
#      STICKYSELECTORKEY:
#      ENVCONTEXT: dev

After this, run docker-composer:

    docker-compose up -d

This should spin up a container of the mariadb image in the background. To check if it as worked, this command can be used:

    docker-compose logs -f

The phrase mysqld: ready for connections indicates that the database was started correctly.

After this, revert the docker-compose.yaml file to its original state:

    git checkout -- ms/blueprintsprocessor/distribution/src/main/dc/docker-compose.yaml

From now on, the Docker container will be available on the computer; if it ever gets stopped, it can be started again by the command:

    docker start <id of mariadb container>

Set permissions on the local file system

Blueprints processor uses the local file system for some operations and, therefore, need some existing and accessible paths to run properly.

Execute the following commands to create the needed directories and to give permissions for them:

    mkdir -p /opt/app/onap/blueprints/archive
    mkdir -p /opt/app/onap/blueprints/deploy
    mkdir -p /opt/app/onap/scripts

    sudo chmod -R 777 app/

Import the project on the IDE

For this page, the chosen IDE is IntelliJ, but the instructions present here can be adapted to be used in other IDEs as well.

Go to File | Open and choose the pom.xml file of the cds directory:

Image Removed

...