1 .. This work is a derivative of https://wiki.onap.org/display/DW/Running+Blueprints+Processor+Microservice+in+an+IDE
2 .. This work is licensed under a Creative Commons Attribution 4.0
3 .. International License. http://creativecommons.org/licenses/by/4.0
4 .. Copyright (C) 2020 Deutsche Telekom AG.
6 Running Blueprints Processor Microservice in an IDE
7 ====================================================
12 Run the blueprint processor locally in an IDE, while having the database running in a container.
13 This way, code changes can be conveniently tested and debugged.
18 Check out the code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds
23 In the checked out directory, type
27 mvn clean install -Pq -Dadditionalparam=-Xdoclint:none
29 Wait for the maven install command to finish until you go further.
31 Spin up a Docker container with the database
32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34 The Blueprints Processor project uses a database to store information about the blueprints
35 and therefore it needs to be online before attempting to run it.
37 One way to create the database is by using the :file:`docker-compose.yaml` file.
38 This database will require a local directory to mount a volume, therefore before running docker-compose create following directory:
42 mkdir -p -m 755 /opt/app/cds/mysql/data
44 Navigate to the docker-compose file in the distribution module:
48 .. group-tab:: Frankfurt - Latest
52 cd ms/blueprintsprocessor/application/src/main/dc
54 .. group-tab:: El Alto - Dublin
58 ms/blueprintsprocessor/distribution/src/main/dc
60 And run docker-composer:
64 docker-compose up -d db
66 This should spin up a container of the MariaDB image in the background.
67 To check if it has worked, this command can be used:
71 docker-compose logs -f
73 The phrase ``mysqld: ready for connections`` indicates that the database was started correctly.
75 From now on, the Docker container will be available on the computer; if it ever gets stopped,
76 it can be started again by the command:
80 docker start <id of mariadb container>
82 Set permissions on the local file system
83 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
85 Blueprints processor uses the local file system for some operations and, therefore,
86 need some existing and accessible paths to run properly.
88 Execute the following commands to create the needed directories, and grant access to the current user to modify them:
92 mkdir -p -m 755 /opt/app/onap/blueprints/archive
93 mkdir -p -m 755 /opt/app/onap/blueprints/deploy
94 mkdir -p -m 755 /opt/app/onap/scripts
95 sudo chown -R $(id -u):$(id -g) /opt/app/onap/
97 Import the project into the IDE
98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102 .. tab:: IntelliJ IDEA
105 This is the recommended IDE for running CDS blueprint processor.
107 Go to *File | Open* and choose the :file:`pom.xml` file of the cds/ms/blueprintprocessor directory:
111 Import as a project. Sometimes it may be necessary to reimport Maven project, e.g. if some dependencies can't be found:
115 **Override some application properties:**
117 Next steps will create a run configuration profile overriding some application properties with custom values,
118 to reflect the local environment characteristics.
122 .. group-tab:: Frankfurt - Latest
124 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
126 ``ms/blueprintsprocessor/application/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.kt``.
128 After dependencies are imported and indexes are set up you will see a green arrow
129 next to main function of BlueprintProcessorApplication class, indicating that the run configuration can now be
130 created. Right-click inside the class at any point to load the context menu and select create
131 a run configuration from context:
133 |imageCreateRunConfigKt|
135 **The following window will open:**
139 **Add the following in the field `VM Options`:**
142 :caption: **Custom values for properties**
144 -Dspring.profiles.active=dev
146 Optional: You can override any value from **application-dev.properties** file here. In this case use the following pattern:
150 -D<application-dev.properties key>=<application-dev.properties value>
152 .. group-tab:: El Alto
154 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
156 ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java.``
158 After dependencies are imported and indexes are set up you will see a green arrow
159 next to main function of BlueprintProcessorApplication class, indicating that the run configuration can now be
160 created. Right-click inside the class at any point to load the context menu and select create
161 a run configuration from context:
163 |imageCreateRunConfigJava|
165 **The following window will open:**
169 **Add the following in the field `VM Options`:**
172 :caption: **Custom values for properties**
174 -Dspring.profiles.active=dev
176 Optional: You can override any value from **application-dev.properties** file here. In this case use the following pattern:
180 -D<application-dev.properties key>=<application-dev.properties value>
182 .. group-tab:: Dublin
184 Navigate to the main class of the Blueprints Processor, the BlueprintProcessorApplication class:
186 ``ms/blueprintsprocessor/application/src/main/java/org/onap/ccsdk/cds/blueprintsprocessor/BlueprintProcessorApplication.java``.
188 After dependencies are imported and indexes are set up you will see a green arrow
189 next to main function of BlueprintProcessorApplication class, indicating that the run configuration can now be
190 created. Right-click inside the class at any point to load the context menu and select create
191 a run configuration from context:
193 |imageCreateRunConfigJava|
195 **The following window will open:**
199 **Add the following in the field `VM Options`**
202 :caption: **Custom values for properties**
204 -DappName=ControllerBluePrints
205 -Dms_name=org.onap.ccsdk.apps.controllerblueprints
207 -Dspring.config.location=opt/app/onap/config/
208 -Dspring.datasource.url=jdbc:mysql://127.0.0.1:3306/sdnctl
209 -Dspring.datasource.username=sdnctl
210 -Dspring.datasource.password=sdnctl
211 -Dcontrollerblueprints.loadInitialData=true
212 -Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
213 -Dblueprintsprocessor.db.primary.url=jdbc:mysql://localhost:3306/sdnctl
214 -Dblueprintsprocessor.db.primary.username=sdnctl
215 -Dblueprintsprocessor.db.primary.password=sdnctl
216 -Dblueprintsprocessor.db.primary.driverClassName=org.mariadb.jdbc.Driver
217 -Dblueprintsprocessor.db.primary.hibernateHbm2ddlAuto=update
218 -Dblueprintsprocessor.db.primary.hibernateDDLAuto=none
219 -Dblueprintsprocessor.db.primary.hibernateNamingStrategy=org.hibernate.cfg.ImprovedNamingStrategy
220 -Dblueprintsprocessor.db.primary.hibernateDialect=org.hibernate.dialect.MySQL5InnoDBDialect
221 -Dblueprints.processor.functions.python.executor.executionPath=./components/scripts/python/ccsdk_blueprints
222 -Dblueprints.processor.functions.python.executor.modulePaths=./components/scripts/python/ccsdk_blueprints,./components/scripts/python/ccsdk_netconf,./components/scripts/python/ccsdk_restconf
223 -Dblueprintsprocessor.restconfEnabled=true
224 -Dblueprintsprocessor.restclient.sdncodl.type=basic-auth
225 -Dblueprintsprocessor.restclient.sdncodl.url=http://localhost:8282/
226 -Dblueprintsprocessor.restclient.sdncodl.username=admin
227 -Dblueprintsprocessor.restclient.sdncodl.password=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
228 -Dblueprintsprocessor.grpcEnable=false
229 -Dblueprintsprocessor.grpcPort=9111
230 -Dblueprintsprocessor.blueprintDeployPath=/opt/app/onap/blueprints/deploy
231 -Dblueprintsprocessor.blueprintArchivePath=/opt/app/onap/blueprints/archive
232 -Dblueprintsprocessor.blueprintWorkingPath=/opt/app/onap/blueprints/work
233 -Dsecurity.user.password={bcrypt}$2a$10$duaUzVUVW0YPQCSIbGEkQOXwafZGwQ/b32/Ys4R1iwSSawFgz7QNu
234 -Dsecurity.user.name=ccsdkapps
235 -Dblueprintsprocessor.messageclient.self-service-api.kafkaEnable=false
236 -Dblueprintsprocessor.messageclient.self-service-api.topic=producer.t
237 -Dblueprintsprocessor.messageclient.self-service-api.type=kafka-basic-auth
238 -Dblueprintsprocessor.messageclient.self-service-api.bootstrapServers=127.0.0.1:9092
239 -Dblueprintsprocessor.messageclient.self-service-api.consumerTopic=receiver.t
240 -Dblueprintsprocessor.messageclient.self-service-api.groupId=receiver-id
241 -Dblueprintsprocessor.messageclient.self-service-api.clientId=default-client-id
242 -Dspring.profiles.active=dev
243 -Dblueprintsprocessor.httpPort=8080
247 **In the field 'Working Directory' browse to your application path** ``.../cds/ms/blueprintsprocessor/application``
248 **if path is not already specified correctly.**
250 Run configuration should now look something like this:
252 |imageRunConfigSetUp|
254 **Add/replace the following in Blueprint's application-dev.properties file.**
258 blueprintsprocessor.grpcclient.remote-python.type=token-auth
259 blueprintsprocessor.grpcclient.remote-python.host=localhost
260 blueprintsprocessor.grpcclient.remote-python.port=50051
261 blueprintsprocessor.grpcclient.remote-python.token=Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==
263 blueprintprocessor.remoteScriptCommand.enabled=true
265 Take care that if a parameter already exist you need to change the value of the existing parameter to avoid duplicates.
268 **Run the application:**
270 Before running Blueprint Processor check that you use the correct Java version in IntelliJ.
271 Select either run or debug for the created Run Configuration to start the Blueprints Processor:
277 .. tab:: Visual Studio Code
281 .. group-tab:: Frankfurt - Latest
283 * **Step #1** - Make sure your installation of Visual Studio Code is up to date. This guide was writen using version 1.48
284 * **Step #2** - Install `Kotlin extension from the Visual Studio Code Marketplace <https://marketplace.visualstudio.com/items?itemName=fwcd.kotlin>`_
285 * **Step #3** - On the top menu click *Run | Open Configurations*
287 .. warning:: This should open the file called `launch.json` but in some cases you'll need to wait for the Kotlin Language Server to be installed before you can do anything.
288 Please watch the bottom bar in Visual Studio Code for messages about things getting installed.
290 * **Step #4** - add configuration shown below to your configurations list.
297 "name": "Blueprint Processor",
298 "projectRoot": "${workspaceFolder}/ms/blueprintsprocessor/application",
299 "mainClass": "-Dspring.profiles.active=dev org.onap.ccsdk.cds.blueprintsprocessor.BlueprintProcessorApplicationKt"
302 .. warning:: The `projectRoot` path assumes that you created your Workspace in the main CDS repository folder. If not - please change the path accordingly
304 .. note:: The `mainClass` contains a spring profile param before the full class name. This is done because `args` is not supported by Kotlin launch.json configuration.
305 If you have a cleaner idea how to solve this - please let us know.
307 **Add/replace the following in Blueprint's application-dev.properties file:**
311 blueprintsprocessor.grpcclient.remote-python.type=token-auth
312 blueprintsprocessor.grpcclient.remote-python.host=localhost
313 blueprintsprocessor.grpcclient.remote-python.port=50051
314 blueprintsprocessor.grpcclient.remote-python.token=Basic Y2NzZGthcHBzOmNjc2RrYXBwcw==
316 blueprintprocessor.remoteScriptCommand.enabled=true
318 **Currently the following entries need to be added in VSC too:**
322 logging.level.web=DEBUG
323 logging.level.org.springframework.web: DEBUG
325 #Encrypted username and password for health check service
326 endpoints.user.name=eHbVUbJAj4AG2522cSbrOQ==
327 endpoints.user.password=eHbVUbJAj4AG2522cSbrOQ==
329 #BaseUrls for health check blueprint processor services
330 blueprintprocessor.healthcheck.baseUrl=http://localhost:8080/
331 blueprintprocessor.healthcheck.mapping-service-name-with-service-link=[Execution service,/api/v1/execution-service/health-check],[Resources service,/api/v1/resources/health-check],[Template service,/api/v1/template/health-check]
333 #BaseUrls for health check Cds Listener services
334 cdslistener.healthcheck.baseUrl=http://cds-sdc-listener:8080/
335 cdslistener.healthcheck.mapping-service-name-with-service-link=[SDC Listener service,/api/v1/sdclistener/healthcheck]
338 management.endpoints.web.exposure.include=*
339 management.endpoint.health.show-details=always
340 management.info.git.mode=full
342 In VSC the properties are read from target folder, thats why the following maven command needs to be rerun:
346 mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none
348 Click Run in Menu bar.
353 Testing the application
354 ~~~~~~~~~~~~~~~~~~~~~~~
356 There are two main features of the Blueprints Processor that can be of interest of a developer:
357 blueprint publish and blueprint process.
359 To upload custom blueprints, the endpoint ``api/v1/execution-service/publish`` is used.
361 To process, the endpoint is ``api/v1/execution-service/process``.
363 Postman is a software that can be used to send these request, and an example of
364 them is present on https://www.getpostman.com/collections/b99863b0cde7565a32fc.
366 A detailed description of the usage of different APIs of CDS will follow.
372 Imported packages or annotiations are not found, Run Config not available?
373 *****************************************************************************
375 1. Rebuild with ``maven install ...`` (see above)
376 2. Potentially change Maven home directory in Settings
377 3. Maven reimport in IDE
381 * Change Java Version to 11
384 .. image alignment inside tabs doesn't work
386 .. |imageRunConfigJava| image:: media/run_config_java.png
390 .. |imageRunConfigKt| image:: media/run_config_kt.png
394 .. |imageCreateRunConfigJava| image:: media/create_run_config_java.png
398 .. |imageCreateRunConfigKt| image:: media/create_run_config_kt.png
402 .. |imageImportProject| image:: media/import_project.png
406 .. |imageReimportMaven| image:: media/reimport_maven.png
410 .. |imageRunDebug| image:: media/run_debug.png
414 .. |imageBuildLogs| image:: media/build_logs.png
418 .. |imageLogsVSC| image:: media/vsc_logs.png
422 .. |imageRunConfigSetUp| image:: media/run-config-set-up.png