ONAP Developer Set-Up
Follow the steps below to set up your the development environment on your client machine, and to establish credentials with which you may access the repositories.
Table of Contents |
---|
Required Tools
See Required Tools for a list, with URLs, for the software tools required for OpenECOMP development.
...
Create a Linux Foundation Account
Follow the instructions on the identity portal to create a Linux Foundation account and get access to the OpenECOMP ONAP Gerrit instance. Then verify
Verify that you can log in at https://gerrit.openecomponap.org/ and that you can see the OpenECOMP ONAP list of repositories.
Git and Gerrit local setup
The OpenECOMP repositories are stored on Gerrit. You need a Git client to be able to pull/push code.
You also need to add a plugin to Git in order to interact with Gerrit. The plugin is called git-review.
To install git-review on Linux (Ubuntu) :
sudo apt-get install git-review
To install it on Windows:
<<TODO: Shall we make the below section a sub-section?>>
Follow those steps if you are a Windows user and need to interact with Gerrit; it will help you when you install git-review on your system.
Step-by-Step Guide
NOTE: It is assumed that you already have a Gerrit profile setup and you can connect to it.
Preliminary Step: Install Putty and Generate a Putty Key
NOTE: If you already have keys registered with putty, skip this section.
- Ensure you have the complete putty suite installed. You should have pageant.exe, plink.exe and puttygen.exe.
- Generate a key with puttygen. Choose a passphrase, then select "Save private key" and choose a target; also "Save public key" and select a target. It is recommended to use file names containing "private" and "public" for the keys as both will end in .ppk.
- Start pageant if not started, then add your newly generated private key.
- Under the control panel > system > advanced system properties > environment variables, add a GIT_SSH entry (if not present) and point to plink.exe.
- When done, start a command line (cmd.exe) and run 'env'; the newly added environment variable should appear.
- In your Gerrit profile, add the public key. Also, copy/paste the known_hosts entries listed, into a file named known_hosts under your .ssh profile (something like C:\Users\<ATTUID>\.ssh) (if known_hosts does not exist, create it).
Remaining Steps
- Download Python, based on the TSS approved version (2.7.10 at OpenECOMP Release 1):
2. Using a command line with administrative privileges, go to the folder in which the .msi file was downloaded. For example:
cd C:\Users\xxxxxx\Downloads
(Replace xxxxx with your user name if the package was downloaded to your Downloads folder.)
NOTE: You'll know that cmd.exe has admin privileges if the console text is green.
3. Install Python:
msiexec /i python-2.7.10.msi
(32-bits)msiexec /i python-2.7.10.amd64.msi
(64-bits)
4. Now, follow the instructions at the following URL:
NOTE: You MUST select "Add python.exe to Path."
5. When installation is complete, restart a new command line (admin privileges may be needed) and run:
pip install git-review
NOTE: By opening a new command line you'll benefit from the %PATH% update.
6. Add your reviewer name for all future reviews:
git config --global --add gitreview.username "your_LF_user_name"
NOTE: Ensure that your user.name and user.email are matching what was configured for the Linux Foundation credentials: user.name should equal gitreview.username and email address should match the email address that was configured for the Linux Foundation.
<<TODO: Should we make the section above a sub section ? >>
7. Set up your Git user email address to the one defined in your Linux Foundation account. The easiest way to do so is to run:
git config --global user.email your LF account email
Basic Setup
Git
Install git for your OS in accordance with https://www.atlassian.com/git/tutorials/install-git
Since this is common for all OS, we will also use it to generate our SSH keys as well :
Code Block |
---|
ssh-keygen |
This should generate a private and public ssh key.
The public ssh key can then be uploaded to Gerrit (user setting, ssh keys, add new key) or elsewhere as needed for authorization.
Java
ONAP is moving to Java 11 but many projects still use Java 8.
Download and install the appropriate openjdk version in accordance with the component you are working and set JAVA_HOME environment variable to point to that
Maven
Download the latest Maven using installer from https://maven.apache.org/download.cgi
Add maven to your path variable.
To test the new installation run:
Code Block |
---|
mvn -version |
Use the settings.xml found in the oparent repo
Save this Maven settings.xml as your ~/.m2/settings.xml (windows c:\users\<username>\.m2)
WSL users can point to one common repo across Windows and Ubuntu as :
Code Block |
---|
ln -s /mnt/c/Users/<username>/.m2 ~ |
Proxy settings for Maven (if required)
If you are behind a proxy you can add a proxy section to your settings.xml
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<proxies>
<proxy>
<id>evil-corp-http</id>
<active>true</active>
<protocol>http</protocol>
<host>proxy.evil-corp.com</host>
<port>599</port>
<nonProxyHosts>localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com</nonProxyHosts>
</proxy>
<proxy>
<id>evil-corp-https</id>
<active>true</active>
<protocol>https</protocol>
<host>proxy.evil-corp.com</host>
<port>599</port>
<nonProxyHosts>localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com</nonProxyHosts>
</proxy>
</proxies> |
OS Specific Instructions
MAC/OSX (in review under 10.15.7)
Expand |
---|
get your MBP 2020 16 inch ready for development - refer to http://wiki.obrienlabs.cloud/display/DEV/Developer+Guide#DeveloperGuide-OSX Install homebrew package manager -
python should already be installed. - do a --version check install openstack tools install docker (dmg) - https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac |
Redhat/CentOS (in review under RHEL 8.3)
Expand | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Ubuntu (in review under 20.04 )
Expand | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Connecting to ONAP Gerrit
SSH Connection (Recommended)
Log in to the Gerrit host https://gerrit.onap.org/, pull down the menu under your user name (at the extreme top right of the browser window), click on "Settings":
Click your account name on the top right corner of the website and click on Settings.
Add the public ssh key that you created in the previous step.
HTTPS Connection
Expand |
---|
If you choose to use HTTP/HTTPS, you'll need to generate an access password. Log in to the Gerrit host https://gerrit.onap.org/, pull down the menu under your user name (at the extreme top right of the browser window), click on "Settings", and select "HTTP Password" This password may have a limited time to live, so you might get errors like this one: Problem running 'git remote update gerrit' Regenerating a password will most likely solve the connectivity issue. Sometimes, the Gerrit interface on HTTPS might be temporarily faulty, so retries might be needed. |
Proxy setting for IntelliJ and Git (if required)
Expand |
---|
For developers working with a proxy, you might have proxy issues connecting to Linux Foundation website. To avoid the connection issue, you must define the proxy setting for both IntelliJ and Git. To configure the proxy settings in IntelliJ; click File -> Settings -> Appearance & Behavior -> System Settings -> HTTP Proxy enter the correct proxy settings and click Apply. In case of Manual proxy configuration, while entering the Host name, there is no need to write http:// in front of the URL. For example, if the proxy value is http://one.proxy.com, you would put one.proxy.com as the Host name To configure the proxy settings for Git, play the following command: git config --global https.proxy https://<proxy username>:<proxy password>@<proxy url> git config --global http.proxy http://<proxy username>:<proxy password>@<proxy url> Note: while entering the proxy username, sometimes it may require to add the domain name in front. |
IDEs
Eclipse
Install Eclipse
Download and run the installer from: Install Eclipse. Select "Eclipse IDE for Java Developers" to install.
ONAP Eclipse Java Formatter
Download onap-java-formatter.xml and import into Eclipse.
(updates to the settings should be committed and merged back into the repository)
ONAP uses Google Java Style with some modifications. ( See Java code style )
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Using the Eclipse Formatter file above and maven plugin configuration in pom.xml as per pom.xml (https://code.revelc.net/formatter-maven-plugin/ for Eclipse formatter and https://github.com/diffplug/spotless/tree/master/plugin-maven for import order)
The combination can be used in a maven command to rewrite code and imports, then checkstyle audit like so
|
Install useful plugins for Eclipse
Install EclEmma for code coverage and SonarLint for static code analysis.
Set up Sonar towards ONAP for Eclipse
To bind your projects to the ONAP Sonar server, follow the instructions below.
Your projects should be imported in to Eclipse before this.
Expand | ||
---|---|---|
| ||
|
To see messages from Sonar introduced by edits made in the projects, select "Window -> Show View -> Other...". Expand "SonarLint" and select "SonarLint -> On-The-Fly".
Setting up the ONAP Checkstyle for Eclipse
Set "ONAP" configuration in Eclipse
To set the newly built checkstyle files in Eclipse:
- Preferences->Checkstyle
- Click "New"
- Select "External Configuration File"
- Give it a name eg ONAP
- Point at the file <your_git_folder>/oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml
(assuming you have downloaded the oparent repo) - Click OK
- Select "ONAP" configuration and click "Set as Default"
- Select "Apply and Close"
Apply "ONAP" configuration to a project in Eclipse
Now we need to activate the checkstyle on one project and set it as the blueprint for all of them:
- Select a project in eclipse and right click->Properties→Checkstyle
- check "Checkstyle active for this project"
- Select the "ONAP" checkstyle profile
- Click "Apply and Close"
Spread blueprint to other projects for Eclipse
Now spread the profile to all other projects:
- Select all the projects you want to apply the profile to in the Eclipse project explorer (not the one that you set up above)
- Right click->Checkstyle->Configure projects from blueprint
- Select the project you set up above
- Now all the projects have the correct checkstyle setup.
Configure ONAP copyright for Eclipse
Expand | ||
---|---|---|
|
IntelliJ
Download & Install
see https://www.jetbrains.com/idea/download/#section=windows
Make sure you have added the Checkstyle plugin . Follow the below link
https://plugins.jetbrains.com/plugin/1065-checkstyle-idea
Configure ONAP code CheckStyle Plugin for IntelliJ
- Select, File, Settings, Tools, Checkstyle
- Click on + beside the 'Configuration File' box to add a configuration
- Set description to something like 'ONAP Rules'
- Click on Browse to select the file <your_git_folder>/oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml
(assuming you have downloaded the oparent repo) - Complete the Wizard (you can set exclusion properties if needed)
- Select the Configuration File you just added by selecting the relevant checkbox
- Click [OK] to close the settings popup
Configure ONAP code style auto formatting for IntelliJ (using the same checkstyle rules and automating it for you )
- Select, File, Settings, Editor, Code Style
- Click on the gear icon at the end of the line for "Scheme:"
- Optional: As importing a schema overrides the current scheme you might want to first use the 'Duplicate..' and 'Rename...' options to create an easily identifiable scheme e.g. 'ONAP Standard'
- Import Scheme→Checkstyle Configuration
- Click on Browse to select the file <your_git_folder>/oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml
(assuming you have downloaded the oparent repo) - Click OK
Configure ONAP copyright for IntelliJ
Expand | |
---|---|
|
Set up SonarLint towards ONAP for IntelliJ
Prerequisites
- You need to be part of the onap organization in GitHub (see GitHub, click on your icon and select 'My Organizations')
If you are not a member of this organization email support.linuxfoundation.org and ask to be added to the onap organization in GitHub
Note. It is possible to enter a different organization if you at least member of 1 organization (you can create your own in GitHub).
The plugin wizard crashes if you are member of no organization at all, see this Bug: https://jira.sonarsource.com/browse/SLI-426 - Make sure you have added the SonarLint plugin
To use SonarLint with Onap projects you need to setup a connection with SonarCloud
- Select, File, Settings, Tools, SonarLint.
- Click on + beside the 'SonarCube / SonarClod connections' box to add a new connection
- Set Configuration Name to something like 'ONAP'
- Ensure sonarcloud is selected and click [Next]
- Click [Create Token]
- Select GitHub, logon and follow the GitHub wizard to create a Token
- Copy Token into IntelliJ wizard
- Click [Next] (might have to wait a little while your data is being downloaded)
- Select 'Open Network Automation Platform (ONAP)' from 'Your Organizations' and click [Next]
- Click [Finish] to close the wizard
- Click [OK] to leave settings
Then you need to bind each project to the corresponding project in GitHub/SonarCloud:
- Select, File, Settings, Tools, SonarLint, Project Settings
- Enable (check) 'Bind project to SonarQube / SonarCloud'
- Select the connection created above using the [Configure the connection] button
- Enter the project name (e.g. 'onap_ccsdk-sli-plugins') or select it using [Search in list..]
- Start typing the name of your project, and it should appear in a list box where it should be selected.
- Click [OK] to finish
Optional Tools & Utilities
Python
Info |
---|
Check which version of python your project is using before installing. |
Download Python from https://www.python.org/downloads/
Add python binary to Path.
Install "pip3", if you plan to use git-review.
|
---|
git-review (optional)
In a shell, type the following command (assumes you installed python above) :
Code Block |
---|
pip3 install git-review |
To use git review
, you have to be in a Git clone directory that already contains a (possibly hidden) .gitreview
configuration file (see Gerrit/Advanced usage#Setting up a repository for git-remote)
Info |
---|
The Git and git-review installation steps above are derived from the description at: https://www.mediawiki.org/wiki/Gerrit/git-review#Windows |
Configure Git to remember your Linux Foundation user name and email address (the user name and email address associated with your Linux Foundation login):
Code Block |
---|
git config --global user.email <your_LF_account_email> git config --global --add gitreview.username |
...
<your_LF_user |
...
_name> |
Configure git review
Code Block | ||
---|---|---|
| ||
git config --global gitreview.remote origin |
If you are using VPN, you might encounter a proxy problem while connecting to the Linux Foundation website. To avoid the problem, you should add the proxy setting in git config, using the following command:
Code Block |
---|
git config --global https.proxy https://<proxy username>:<proxy password>@<proxy url> |
...
git config --global http.proxy http://<proxy username>:<proxy password>@<proxy url> |
NOTE: When entering the proxy username, you might be required to add the domain name in front of the username.
Selecting a connection method (SSH or HTTPS)
Once Git/Gerrit is installed, you will need to select a connection method to the remote server.
We recommend using SSH in which case you need to register your public key in your account settings in Gerrit.
If you choose to use HTTP/HTTPS, you'll need to generate an access password. To do so:
In your Gerrit account settings, select HTTP Password:
The icon at the right of the generated password allows you to copy the generated password to your clipboard, it will be needed when you interact with git/gerrit.
This password may have a limited time to live, so you might get errors like this one:
Problem running 'git remote update gerrit'
Fetching gerrit
fatal: unable to access 'https://USERNAME@gerrit.openecomp.org/r/a/mso/ ': Unknown SSL protocol error in connection to gerrit.openecomp.org:443 error: Could not fetch gerrit
Regenerating a password will most likely solve the connectivity issue. Sometime, the Gerrit interface on HTTPS might be temporarily faulty, so retries might be needed.
Cloning the Repository by Using the Command Line
...
to add the domain name in front of the username.
Node-JS
The dcae build will install npm in most cases.
However you can install it yourself from https://nodejs.org/en/download/
Verify your installation by
Code Block |
---|
npm -v |
Local SonarQube Setup
It can be useful to have SonarQube running locally rather than pushing through CI for feedback.
This can be done using docker:
Images of the Community, Developer, and Enterprise Editions are available on Docker Hub.
Start the server by running:
Code Block language bash $ docker run -d --name sonarqube -p 9000:9000 sonarqube:latest
- Log in to http://localhost:9000 with System Administrator credentials (login=admin, password=admin).
- Click the Create new project button to analyze your first project.
Other Optional Tools
The component you are working on may require additional tool installations, see the relevant section under Development Guides.
Troubleshooting & Know Issues
Windows Limitations
Some repos might not clone in Windows until some file paths are reduced below 255 chars.
Enable long paths in windows as
Code Block |
---|
git config --system core.longpaths true |
Hack oparent to fix "curly bracket" issue
Expand |
---|
The first issue is that the current ONAP master tagged version of the checkstyle does not work with Eclipse Oxygen/Photon (and maybe other versions) because of the "curly bracket" issue. There is a fix on the way but it's not here yet. The current tagged version of oparent we are using in Policy is 1.2.1. To get around this issue, check out oparent, checked out the 1.2.1 tag, fixed the "curly bracket" bug and built it on my local machine.
|
Appendix
...
Installing the Gerrit plugin in IntelliJ
Open File -> Settings -> Plugins of IntelliJ, and click on the Browse repositories... button.
In the new window, search for Gerrit, click Install to install the plugin, and finally restart IntelliJ.
To verify whether the Gerrit plugin is installed successfully, you can click File -> New -> Project from Version Control and verify whether Gerrit is present.
Working with a Proxy
For people working with a proxy, you might have proxy issues connecting to Linux Foundation website. To avoid the connection issue, you shall define the proxy setting for both IntelliJ and Git.
To configure the proxy settings in IntelliJ, click File -> Settings -> Appearance & Behavior -> System Settings -> HTTP Proxy, enter the correct proxy settings and click Apply. In case of Manual proxy configuration, while entering the Host name, there is no need to write http:// in front of the URL. For example, if the proxy value is http://one.proxy.com, you shall putone.proxy.com as the Host name.
To configure the proxy settings for Git, play the following command:
git config --global https.proxy https://<proxy username>:<proxy password>@<proxy url>
git config --global http.proxy http://<proxy username>:<proxy password>@<proxy url>
...