You can set up the SDN-C IDE by following instructions from Setting Up Your Development Environment.
If you already have a Linux Foundation account, you can skip this section.
You will need linux foundation account to submit code change to ONAP projects repos. If you only want to read the code, you can skip this step.
To create your linux foundation account, go to Linux Foundation Identity page, and select I need to create a Linux Foundation ID, the following page will be shown:
Filling the information and click on Create new account to proceed account creation.
Follow steps in Get git command from ONAP gerrit to get the git clone command and clone each of the following SDNC projects:
Project Name | Project Description | has code |
---|---|---|
sdnc/adaptors | SDN-C adaptors | |
sdnc/architecture | SDN-C architectural artifacts (e.g. blueprints) | |
sdnc/core | SDN-C core platform | |
sdnc/features | SDN-C Karaf features | |
sdnc/northbound | SDN-C northbound adaptors | java |
sdnc/oam | SDN-C OA&M tools | bash, javascript, python, DGs |
sdnc/parent | Parent POMS to be used by SDN-C components | |
sdnc/plugin | SDN-C plugins |
Note: The ONAP SDN-C projects are more like a demo version of ECOMP's SDN-GC.
Follow steps in Get git command from ONAP gerrit to get the git clone command and clone each of the following CCSDK projects:
Project Name | Project Description | has code |
---|---|---|
ccsdk/dashboard | Opeations Manager Dashboard | |
ccsdk/distribution | CCSDK distribution packaging (e.g. docker containers) | |
ccsdk/parent | Parent POMs to be used by CCSDK clients | |
ccsdk/platform/blueprints | Blueprints. not in Amesterdam release | |
ccsdk/platform/nbapi | Northbound API | |
ccsdk/platform/plugins | Platform plugins | |
ccsdk/sli/adaptors | Common adaptors for use by directed graphs | |
ccsdk/sli/core | Core Service Logic Interpreter classes | |
ccsdk/sli/northbound | Common northbound APIS related to service logic interpreter | |
ccsdk/sli/plugins | Common plugins used by direcged graphs | python |
ccsdk/storage/esaas | Elastic Storage as a Service. not in Amesterdam release | |
ccsdk/storage/pgaas | PGAAS (PostgreSQL as a Service) | java, python, bash |
ccsdk/utils | Utilities | bash, yaml |
Use your linux foundation account to login onto ONAP projects.
Get Project list by entering the project key name in the Filter, for example sdnc, this list of projects under sdnc will be shown as below:
Click on the wanted project from the list, the General page of the selected project will be shown. the following is the General page of sdnc/adaptors:
Now click on Clone with commit-msg hook, then click on http, then click on the notepad icon.
The git clone command for the selected project is now copied into your clipboard. You do paste to use it at where-ever you want to.
ONAP code can also be viewed from gerrit web site as below (sdnc/adaptors project is used as the example here):
To view the coce through gerrit client, first follow steps in Get git command from ONAP gerrit to get the Projects list page.
Then, choose either one of the following option to view the code of the desired project.
Note: this option will bring you to, and only to, the HEAD branch which is the master branch.
In the project list page, click on the gitweb under the Repository Browser column of your project row.
The master branch's summary page will be shown up. Click on the tree option.
Now, the repo details page will be shown and you can view the code in master branch from there.
Note: This option allows you to select a particular branch to view it code.
In the project list page, click the project under the Project Name column. (using sdnc/adaptors project as example here)
It takes you to the project General page, click on the Branches option.
The project page will be switched to Branches page. Check out the Branch Name column, click the gitweb on the same row of the desired branch.
The project Summary page of the selected branch will be shown up. Click on the tree option.
Now, the repo details page will be shown and you can view the code in master branch from there.
Ensure your maven is installed / set up as per instruction from Maven section of Setting Up Your Development Environment page.
Following instruction from Maven Example settings.xml section of Setting Up Your Development Environment page to get your setting.xml file.
If you are going to do compiling in your intelliJ, follow steps in this section to configure settings.xml file in your interlliJ.
If you did not make your Maven Project by default shown, do the following:
In your interlliJ, Select View -> Tool Windows -> Maven Project
The maven project will shown on the right side of your intelliJ window.
Click the Maven Settings wrench to bring up the Settings window:
Select the Override of the User settings file, add the settings.xml file full path, the Apply button will be enabled. click on Apply to apply the change.
The SDN-C projects repos should be built in the following order:
Under the directory where your clone code is, run the following command to build the project
mvn clean install -s <the settings.xml file with full path>
From interlliJ Maven Projects window, find the module marked with (root), expand it by clicking on the triange on the left side or double clicking the text. It will then show two folders : Lifecycle and Plugins. Use the same way to expand the Lifecycle folder, the build options are now shown:
To run the build, double click the Install or select install and then click on the Run Maven Build triange icon.
To do clean, double click the clean or select clean and then click on the Run Maven Build triange icon.
In the case, maven javadoc compliation failing which causes build process abort. To continue build the code, we need to skip the maven javadoc compilation.
add the "maven.javadoc.skip=true" in the command line build command as the following:
mvn clean install -Dmaven.javadoc.skip=true -s <the settings.xml file with full path>
add the following property definition:
<properties> <maven.javadoc.skip>true</maven.javadoc.skip> </properties> |
Before start writing unit test, it's important that there's a common definition of what a good unit test is.
From the official site of Roy Osherove’s book The Art of Unit Testing:
A unit test is an automated piece of code that invokes a unit of work in the system and then checks a single assumption about the behavior of that unit of work.
In SDN-C project, the unit of work is being defined as Java Method and a "good" Unit Test:
When determining what to unit test there are several key principles to keep in mind.
Java code coverage can be measured using an external tool such as JaCoCo which ONAP sonar build is using.
JUnit is the unit test framework used for testing Java. It is recommend to use Junit4 and Mockito to write the junit tests.
This applies to both creating brand new JUnit Test class or navigating to existing test class to add new additions.
Open the class that you are going to write JUnit test for in IntelliJ.
In anywhere of this class editor, do Ctrl+Shift+T or right click to bring up right click menu, then select Go To, then Test in the cascaded menu:
This will bring up the Choose Test for... window as below.
Choose Create New Test... for creating brand new JUnit Test, or just choose the test class to go to the existing tests.
When Create New Test... is selected, the Create Test window will be brough up:
The test Class name is automatically generated and shown in the window. Ensure the Testing library is selected with JUnit4.
Select
Click OK button, once you completed your selection/set up in the Create Test window.
It will bring you to the edit page of the new test class.
If the Junit and mockito dependencies are not in the module and its parent pom file, add them the module pom.xml file as the following:
<dependency> |
More about how to use Mockito can be found from Mockito Tutorial.
Sometimes you do want to set/get class level attributes to satisfy complex test code and still keep the test coverage in sonar achievable, Whitebox of package org.mockito.internal.util.reflectio could be used to do code reflection.
static Object | getInternalState(Object target, String field) |
static void | setInternalState(Object target, String field, Object value) |
There are multiple advantages of using PowerMockito to easily write the junit test.
However, we don't recommend to use Powermockito, due to the issue of Jacoco is not compatible with PowerMockito.
To commit code to ONAP, you must have git-review installed.
The steps in this section only need to be done one time, except the Tips
run the following command to check if git-review is installed as part of your OS image.
git-review
If not the following command to install the git-review.
sudo apt install git-review
here's an example:
ubuntu@beili-ws-01:~/Videos$ git-review The program 'git-review' is currently not installed. You can install it by typing: sudo apt install git-review ubuntu@beili-ws-01:~/Videos$ sudo apt install git-review |
If you do not have git installed, following Install Git on Windows at atlassian's tutorials for installing git to
If you do not have python installed, following Python & pip Windows installation to
Open a git bash terminal by
In the git bash terminal, run the following command to install git-review
c:/Python27/Scripts/pip2.7 install git_review --proxy <your proxy>
Check your git remote setting, use the following command
git remote -v
Here's an example of output:
C:\workspace\onap_sdnc\northbound>git remote -v |
If the gerrit does not exist, you need to set it up with the following command:
git remote add gerrit <the link of the origin>
Note: the remote origin is added automatically after git clone of the repo. The gerrit link is the same as the origin's, hence, we just directly use it.
Use the following command to check your git config:
git config -l
Ensure that you have the following configuraiton set properly:
GIT Config Key | Expected Value | Setting Command |
---|---|---|
core.eol | lf | git config --global core.eol lf |
core.autocrlf | true | git config --global core.autocrlf true |
user.name | your name | git config --global user.name <your name> |
user.email | your email address | git config --global user.email <your email address> |
Checkout the master branch, work on your changes, once you are ready for submission, do the following to create a review.
Use the following command to check all the changes in the master branch
git status
Ensure
2. Run the following commands in the listed order to create a review
Steps | Command | Notes | |
---|---|---|---|
1 | git commit -sam <comment summary> | Commit summary should not exceed 50 char. See ONAP Commit Messages for more details. | |
2 | git log --shortstat | To ensure change lines are properly done and your commit has the following:
Here's an example:
If the Change-Id does not exist, do not proceed. You need to following Fix no change-id to fix it before proceeding further. | |
3 | git commit --amend | Use this command to do the following:
| |
4 | git review | This command will create the review at Gerrit. Once this command is completed, your newly created review can be found from Outgoing reviews in Gerrit self dashboard . |
3. Update the Gerrit Review to get ready
From Gerrit self dashboard, click your newly created review, it will bring up the review details.
Click the Add button in the Reviewers section, to add reviewers (who is going to review your code) and committers (who is going to review your code as well as approve and commit your code).
Note:
By now, you will just wait and check your email for information of
Oops, I made a mistake in my review comments. It cannot be changed in the gerrit review.
Go back to your workspace, and do the following to change the comments of your existing review.
Steps | Command | Notes |
---|---|---|
1 | git commit --amend | update the comment as desired |
2 | git log --shortstat | validate your commit now has the updated comments, as well as the Change-Id as the one in the gerrit review |
3 | git review | push the changed comment to the review again. Once the command is completed, go to your review, you will see
|
Now, I got comments in my view, and I have made the code adjustment in my workspace and tested.
Follow the steps to push your new code changes to the your existing reiew.
Steps | command | notes |
---|---|---|
1 | git commit -sam "my updated code" | To create a new commit with your updated code |
2 | git log --shortstat | you will see the most 2 recent commits are from
|
3 | git rebase -i HEAD~2 | To run rebase interactively for the most recent 2 commits In the interactive mode, it will bring up the text which contains pick for your last 2 commits along with the following content: Do the following:
Once this command is completed, 2 commits will be merged into 1 commit. |
4 | git log --shortstat | you will see there's only 1 commit which replaces the 2 commit you have seen in step 2. validate your commit has the Change-Id as the one in the gerrit review |
5 | git review | push the changed comment to the review again. Once the command is completed, go to your review, you will see
|
The would only happen when you are creating your very first review in a repo. It mainly because your workspace might have some mis-config which lead your repo clone was not done properly with the Clone with commit-msg hook option.
Follow the steps below to do the correction.
Steps | Command | Notes |
---|---|---|
1 | git reset HEAD~1 | to undo the commit |
2 | from github helper page, download commit-msg, and place it under your <repo>/.git/hook directory | set the proper commit-msg hook this will set the Change-Id properly in your commit |
3 | Use your previous command to create the commit again | |
4 | git log --shortstat | to check the existence of Change-Id |
You can find your recent merged changes from Gerrit self dashboard, however, it only works for Recent changes.
To find all of your changes, you can type in "is:closed(owner:self)" in the Search field at Gerrit self dashboard, then click on the Search button.
This tutorial is based on ONAP-integration project[1] which utilizes Vagrant[2], a deployment tool to build an ONAP environment.
The goal of this section is to guide how to quickly deploy a running ONAP SDN-C envrionment which is going to use the existed image in the ONAP Nexus3 server.
Actually it supports various automate deployment environment including compling code with maven, building docker images as part of the deployment procedure.
"Integration framework, automated tools, code and scripts, best practice guidance related to cross-project Continuous System Integration Testing (CSIT), and delivery of ONAP." |
Tool | Version | Introduction |
---|---|---|
Vagrant | 1.9.5 | https://www.vagrantup.com/ |
Virtualbox | 5.1.20 | https://www.virtualbox.org/ |
Git | 2.14.3 | https://git-scm.com/ |
(1) After installation, make sure that your system is restarted in order to let configuration be activated.
(2) Instead of using Git bash, Cygwin could be also used and make sure "dos2unix" package is installed which will be used during setup
Download the exe of the following (from the link listed in the above table) and install:
Do the following:
Add the following line to your /etc/apt/sources.list:
deb http://download.virtualbox.org/virtualbox/debian xenial contrib
Run the command below
wget -q https://www.virtualbox.org/download/oracle_vbox_2016.asc -O- | sudo apt-key add -
wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add -
sudo apt-get update
sudo apt-get install virtualbox-5.1
On windows installation this may have been created already.
See "https://www.virtualbox.org/manual/ch06.html#network_hostonly"
VBoxManage hostonlyif create
wget https://releases.hashicorp.com/vagrant/1.9.5/vagrant_1.9.5_x86_64.deb
sudo dpkg -i vagrant_1.9.5_x86_64.deb
sudo apt-get install git
sudo apt install dos2unix
Clone the intergration project with the following command:
git clone https://git.onap.org/integration
Hint: More information could be found under integration\bootstrap\vagrant-onap\README.md
If in windows, open Gitbash As Administrator.
Run the following commands:
cd integration/bootstrap/vagrant-onap/libfind . -type f -print0 | xargs -0 dos2unix
Hint: This issue might be fixed later
There is an settings.yaml.development under integration\bootstrap\vagrant-onap\etc used for different deployment scenarios.
The goal is to have a running SDN-C environment, so in the configuration, it turns off clone and build project. Only file name called settings.yaml will be picked-up by the deployment script.
Run the following command to create settings.yaml file from the repo's settings.yaml.development file:
cp settings.yaml.development settings.yaml
vim settings.yaml
Here's the example of the outcoming settings.yaml file:
build_image: "False" clone_repo: "False" compile_repo: "False" enable_oparent: "False" skip_get_images: "False" skip_install: "False" |
Hint:
vim integration/bootstrap/vagrant-onap/Vagrantfile
For example,
... configuration = { ... 'docker_version' => '1.2-STAGING-latest', ... } ... |
vim integration/bootstrap/vagrant-onap/lib/sdnc
Find function get_sdnc_images{...} in the file and modify
Mainly use pull_onap_image to replace pull_openecomp_image
Pull onap/ccsdk-dgbuilder-image instead of openecomp one
For example,
... # get_sdnc_images() - Build or retrieve necessary images function get_sdnc_images { if [[ "$build_image" == "True" ]]; then _build_sdnc_images else # pull_openecomp_image sdnc-image openecomp/sdnc-image:latest # pull_openecomp_image admportal-sdnc-image openecomp/admportal-sdnc-image:latest # pull_openecomp_image dgbuilder-sdnc-image openecomp/dgbuilder-sdnc-image:latest pull_onap_image sdnc-image onap/sdnc-image:latest pull_onap_image admportal-sdnc-image onap/admportal-sdnc-image:latest pull_docker_image nexus3.onap.org:10001/onap/ccsdk-dgbuilder-image:latest onap/ccsdk-dgbuilder-image:latest fi pull_docker_image mysql/mysql-server:5.6 } ... |
cd integration/bootstrap/vagrant-onap
./tools/run.sh sdnc
This could be replaced by adding scripts in Vagrantfile.
http://127.0.0.1:8282/apidoc/explorer/index.html
Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
// check running vm instances
vagrant global-status
// ssh to the vm
vagrant ssh ${vm-id}
// check docker images
docker images
// check running docker instances
docker ps -a
// ssh to the docker instance
docker exec it ${docker-instance} bash
Reference:
[1] ONAP integration: https://git.onap.org/integration/
[2] Vagrant: https://www.vagrantup.com/
[3] ONAP SDC setup: Using Vagrant-Onap for local deployment of SDC project - WIP!!!
[4] Virtualbox Download link: https://www.virtualbox.org/wiki/Linux_Downloads
This tutotial talks about one way to deploy new sdnc code into the corresponding docker image which is based on the prevjous chapter "Deploying a Minimal ONAP SDN-C Environment"
The example is about adding a new rpc in the generic-resource-api which is a sub-module of northbound project.
Download sdnc-northbound project and put it under integration/boostrap/vagrant-onap/opt/openecomp/sdnc
This step is not necssary which is used to align with the folder path where ONAP-integeration clone, complie project.
Edit northinboud/generic-resources-api/model/src/main/yang/GENERIC-RESOURCES-API.yang
For example
... rpc haok-sdnc-test { output { leaf hello-world { type string; mandatory true; } } } ... |
build generic-resources-api/model
Implement the new rpc generated by YANG model in GenericResourcesApiProvider
For example
@Override public Future<RpcResult<HaokSdncTestOutput>> haokSdncTest() { HaokSdncTestOutputBuilder responseBuilder = new HaokSdncTestOutputBuilder(); responseBuilder.setHelloWorld("hello-world3"); RpcResult<HaokSdncTestOutput> rpcResult = RpcResultBuilder.<HaokSdncTestOutput>status(true).withResult(responseBuilder.build()).build(); return Futures.immediateFuture(rpcResult); } |
vagrant ssh $(vagrant global-status | grep sdnc | awk '{print $1}')
docker cp /opt/openecomp/sdnc/northbound/generic-resource-api/installer/target/sdnc-generic-resource-api-1.2.0-SNAPSHOT-installer.zip $(docker ps -a | grep "/sdnc-image" | awk '{print $1}'):/opt/sdnc/features
docker exec -it $(docker ps -a | grep "/sdnc-image" | awk '{print $1}') bash
cd /opt/sdnc/features
unzip -o sdnc-generic-resource-api-1.2.0-SNAPSHOT-installer.zip
unzip -o -d /opt/opendaylight/current sdnc-generic-resource-api/sdnc-generic-resource-api-1.2.0-SNAPSHOT.zip
rm sdnc-generic-resource-api-1.2.0-SNAPSHOT-installer.zip
rm -rf sdnc-generic-resource-api
/opt/opendaylight/current/bin/client -u karaf feature:uninstall sdnc-generic-resource-api
/opt/opendaylight/current/bin/client -u karaf feature:repo-remove mvn:org.onap.sdnc.northbound/generic-resource-api-features/1.2.0-SNAPSHOT/xml/features
/opt/opendaylight/current/bin/client -u karaf feature:repo-add mvn:org.onap.sdnc.northbound/generic-resource-api-features/1.2.0-SNAPSHOT/xml/features
/opt/opendaylight/current/bin/client -u karaf feature:install sdnc-generic-resource-api
docker restart $(docker ps -a | grep "/sdnc-image" | awk '{print $1}')
Hint: The version 1.2.0-SNAPSHOT could be updated in the future. Please update the version according to the current project version.
Here is an simple sdnc-docker-auto-deploy script if you would like to use.
Download Link: sdnc-docker-auto-deploy.zip
After download this link, unzip the file under integration//vagrant-onap/opt.
Use Vagrant ssh to connect your running sdnc vm.
and find the script, run ./sdnc-docker-auto-deploy.cfg.
The corresponding configuation is in sdnc-docker-auto-delpoy.cfg.
It takes a miniute to restart the karaf platform which really depends on the performance of your host machine.
This is the tutorial about how to turn on the remote debug for sdnc docker instance.
vagrant ssh ${vm-id}
export MTU=$(/sbin/ifconfig | grep MTU | sed 's/.*MTU://' | sed 's/ .*//' |sort -n | head -1)
alias docker-compose=/opt/docker/docker-compose
docker rm ${sdnc-docker-instance-id}
//check the java process to make sure it's been killed, if not run "sudo kill -9 ${PID}"
ps aux | grep java
vim /opt/openecomp/sdnc/oam/installation/src/main/yaml/docker-compose.yaml
Under sdnc service, add "5005:5005" under ports
Under sdnc service, add "KARAF_DEBUG=true" under envrionment.
Below shows the example
... sdnc: image: onap/sdnc-image:latest depends_on : - db container_name: sdnc_controller_container entrypoint: ["/opt/onap/sdnc/bin/startODL.sh"] ports: - "8282:8181" - "8201:8101" - "5005:5005" links: - db:dbhost - db:sdnctldb01 - db:sdnctldb02 environment: - MYSQL_ROOT_PASSWORD=openECOMP1.0 - SDNC_CONFIG_DIR=/opt/onap/sdnc/data/properties - KARAF_DEBUG=true dns: - ${DNS_IP_ADDR-10.0.100.1} logging: driver: "json-file" options: max-size: "30m" max-file: "5" ... |
cd /opt/openecomp/sdnc/oam/installation/src/main/yaml/
docker-compose up -d sdnc
docker-compose logs -f sdnc
After the docker instances fully started, you should see the karaf log information below with 5005 port open.