{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"ONAP Developer Set-Up","type":"text"}]},{"type":"paragraph","content":[{"text":"Follow the steps below to set up the development environment on your client machine, and to establish credentials with which you may access the repositories.","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"94f3fe79-4e39-46c4-a2f2-2ddbf6141f40"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create a Linux Foundation Account","type":"text"}]},{"type":"paragraph","content":[{"text":"Follow the instructions on the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"identity portal","type":"text","marks":[{"type":"link","attrs":{"href":"https://identity.linuxfoundation.org/"}}]},{"text":" to create a Linux Foundation account and get access to the ONAP Gerrit instance. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]},{"type":"paragraph","content":[{"text":"Verify that you can log in at ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"https://gerrit.onap.org/","type":"text","marks":[{"type":"link","attrs":{"href":"https://gerrit.onap.org/"}}]},{"text":" and that you can see the ONAP list of repositories.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Basic Setup","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Git","type":"text"}]},{"type":"paragraph","content":[{"text":"Install git for your OS in accordance with ","type":"text"},{"text":"https://www.atlassian.com/git/tutorials/install-git","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.atlassian.com/git/tutorials/install-git#windows"}}]}]},{"type":"paragraph","content":[{"text":"Since this is common for all OS, we will also use it to generate our SSH keys as well :","type":"text"}]},{"type":"codeBlock","content":[{"text":"ssh-keygen","type":"text"}]},{"type":"paragraph","content":[{"text":"This should generate a private and public ssh key.","type":"text"}]},{"type":"paragraph","content":[{"text":"The public ssh key can then be uploaded to Gerrit (user setting, ssh keys, add new key) or elsewhere as needed for authorization.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Java","type":"text"}]},{"type":"paragraph","content":[{"text":"ONAP is moving to Java 11 but many projects still use Java 8.","type":"text"}]},{"type":"paragraph","content":[{"text":"Download and install the appropriate openjdk version","type":"text","marks":[{"type":"link","attrs":{"href":"https://openjdk.java.net/install/"}}]},{"text":" in accordance with the component you are working and set JAVA_HOME environment variable to point to that","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Maven","type":"text"}]},{"type":"paragraph","content":[{"text":"Download the latest Maven using installer from ","type":"text"},{"text":"https://maven.apache.org/download.cgi","type":"text","marks":[{"type":"link","attrs":{"href":"https://maven.apache.org/download.cgi"}}]}]},{"type":"paragraph","content":[{"text":"Add maven to your path variable.","type":"text"}]},{"type":"paragraph","content":[{"text":"To test the new installation run:","type":"text"}]},{"type":"codeBlock","content":[{"text":"mvn -version","type":"text"}]},{"type":"paragraph","content":[{"text":"Use the ","type":"text"},{"text":"settings.xml found in the oparent repo","type":"text","marks":[{"type":"link","attrs":{"href":"https://git.onap.org/oparent/plain/settings.xml"}}]}]},{"type":"paragraph","content":[{"text":"Save this Maven settings.xml as your ~/.m2/settings.xml (windows c:\\users\\\\.m2)","type":"text"}]},{"type":"paragraph","content":[{"text":"WSL users can point to one common repo across Windows and Ubuntu as :","type":"text"}]},{"type":"codeBlock","content":[{"text":"ln -s /mnt/c/Users//.m2 ~","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Proxy settings for Maven (if required)","type":"text"}]},{"type":"paragraph","content":[{"text":"If you are behind a proxy you can add a proxy section to your settings.xml ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Proxy Settings","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\t\n \n evil-corp-http\n true\n http\n proxy.evil-corp.com\n 599\n localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com\n \n \n evil-corp-https\n true\n https\n proxy.evil-corp.com\n 599\n localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com\n \n\t","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"OS Specific Instructions","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"MAC/OSX (in review under 10.15.7)","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"text":"get your MBP 2020 16 inch ","type":"text"},{"text":"ready for development","type":"text","marks":[{"type":"link","attrs":{"href":"http://eclipsejpa.blogspot.ca/2017/03/optimizing-your-macbook-pro-15-2016-for.html"}}]},{"text":" - refer to ","type":"text"},{"text":"http://wiki.obrienlabs.cloud/display/DEV/Developer+Guide#DeveloperGuide-OSX","type":"text","marks":[{"type":"link","attrs":{"href":"http://wiki.obrienlabs.cloud/display/DEV/Developer+Guide#DeveloperGuide-OSX"}}]},{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Install homebrew package manager - ","type":"text"}]},{"type":"paragraph","content":[{"text":"/usr/bin/ruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"python should already be installed. - do a ","type":"text"},{"text":"--version","type":"text","marks":[{"type":"em"}]},{"text":" check","type":"text"}]},{"type":"paragraph","content":[{"text":"install openstack tools","type":"text"}]},{"type":"paragraph","content":[{"text":"install docker (dmg) - ","type":"text"},{"text":"https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac"}}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Redhat/CentOS (in review under RHEL 8.3)","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"-D","type":"text","marks":[{"type":"textColor","attrs":{"color":"#242729"}}]},{"text":"java.net","type":"text","marks":[{"type":"link","attrs":{"href":"http://java.net/"}}]},{"text":".preferIPv4Stack=true","type":"text","marks":[{"type":"textColor","attrs":{"color":"#242729"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"enable IP4 forwarding to enable the RHEL VM to act as an edge router - without this docker containers cannot communicate","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"add to /etc/sysctl.conf","type":"text"},{"type":"hardBreak"},{"text":"net.ipv4.ip_forward = 1","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Install docker","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.docker.com/engine/installation/linux/centos/#install-using-the-repository"}}]},{"text":" (required for some repos like ","type":"text"},{"text":"dcae-inventory","type":"text","marks":[{"type":"strong"}]},{"text":" off dcae","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\nto install kubernetes follow Cloud Native Deployment#Scriptedundercloud(Helm/Kubernetes/Docker)andONAPinstall-SingleVM","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Ubuntu (in review under 20.04 )","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"enable ubuntu desktop","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"apt-get update","type":"text"}]},{"type":"paragraph","content":[{"text":"apt-get install ubuntu-desktop","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"enable static IP","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"vi /etc/network/interfaces","type":"text"}]},{"type":"paragraph","content":[{"text":"add","type":"text"}]},{"type":"paragraph","content":[{"text":"iface enp0s25 inet static","type":"text"}]},{"type":"paragraph","content":[{"text":"address 192.168.15.101","type":"text"}]},{"type":"paragraph","content":[{"text":"netmask 255.255.255.0","type":"text"}]},{"type":"paragraph","content":[{"text":"network 192.168.15.0","type":"text"}]},{"type":"paragraph","content":[{"text":"broadcast 192.168.15.255","type":"text"}]},{"type":"paragraph","content":[{"text":"gateway 192.168.15.1","type":"text"}]},{"type":"paragraph","content":[{"text":"dns-nameservers 8.8.4.4","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"disable strict host checking (client and server)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"in ~/.ssh/config","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"Host *\n StrictHostKeyChecking no\n UserKnownHostsFile=/dev/null","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Enable non CD repositories so an apt-get update will work","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"comment out the CD first line in /etc/apt/sources.list","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"enable ssh if skipped during installation so we can remote ssh","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"sudo apt-get install openssh-server","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"enable root login and gui (no sudo su -)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"sudo passwd root","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"sudo usermod -U root","type":"text"}]},{"type":"paragraph","content":[{"text":"sudo reboot now","type":"text"}]},{"type":"paragraph","content":[{"text":"sudo vi /etc/lightdm/lightdm.conf","type":"text"}]},{"type":"paragraph","content":[{"text":"[SeatDefaults]","type":"text"}]},{"type":"paragraph","content":[{"text":"greeter-session=unity-greeter","type":"text"}]},{"type":"paragraph","content":[{"text":"user-session=ubuntu","type":"text"}]},{"type":"paragraph","content":[{"text":"greeter-show-manual-login=true","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":": enable root login","type":"text"}]},{"type":"paragraph","content":[{"text":"vi /etc/ssh/sshd_config","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"FROM:\nPermitRootLogin prohibit-password\nTO:\nPermitRootLogin yes","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"systemctl restart sshd","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"in /etc/environment","type":"text","marks":[{"type":"textColor","attrs":{"color":"#242729"}}]}]},{"type":"paragraph","content":[{"text":"-D","type":"text","marks":[{"type":"textColor","attrs":{"color":"#242729"}}]},{"text":"java.net","type":"text","marks":[{"type":"link","attrs":{"href":"http://java.net/"}}]},{"text":".preferIPv4Stack=true","type":"text","marks":[{"type":"textColor","attrs":{"color":"#242729"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Install docker","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.docker.com/engine/installation/linux/centos/#install-using-the-repository"}}]},{"text":" (required when building docker images)","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"use the current as of 20180621 17.03 version in the script","type":"text"},{"type":"hardBreak"},{"text":"https://git.onap.org/logging-analytics/tree/deploy/rancher/oom_rancher_setup.sh","type":"text","marks":[{"type":"link","attrs":{"href":"https://git.onap.org/logging-analytics/tree/deploy/rancher/oom_rancher_setup.sh"}}]},{"type":"hardBreak"},{"text":"which is","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"curl https://releases.rancher.com/install-docker/17.03.sh | sh","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"paragraph","content":[{"text":"Connecting to ONAP Gerrit","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SSH Connection (Recommended)","type":"text"}]},{"type":"paragraph","content":[{"text":"Log in to the Gerrit host ","type":"text"},{"text":"https://gerrit.onap.org/","type":"text","marks":[{"type":"link","attrs":{"href":"https://gerrit.onap.org/"}}]},{"text":", pull down the menu under your user name (at the extreme top right of the browser window), click on \"Settings\":","type":"text"}]},{"type":"paragraph","content":[{"text":"Click your account name on the top right corner of the website and click on ","type":"text"},{"text":"Settings","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the public ssh key that you created in the previous step.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"HTTPS Connection","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"text":"If you choose to use HTTP/HTTPS, you'll need to generate an access password. Log in to the Gerrit host ","type":"text"},{"text":"https://gerrit.onap.org/","type":"text","marks":[{"type":"link","attrs":{"href":"https://gerrit.onap.org/"}}]},{"text":", pull down the menu under your user name (at the extreme top right of the browser window), click on \"Settings\", and select \"HTTP Password\"","type":"text"}]},{"type":"paragraph","content":[{"text":"This password may have a limited time to live, so you might get errors like this one:","type":"text"}]},{"type":"paragraph","content":[{"text":"Problem running 'git remote update gerrit'","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]},{"type":"hardBreak"},{"text":"Fetching gerrit","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]},{"type":"hardBreak"},{"text":"fatal: unable to access 'https://USERNAME@gerrit.onap.org/r/a/mso/ ': Unknown SSL protocol error in connection to gerrit.onap.org:443 error: Could not fetch gerrit ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Proxy setting for IntelliJ and Git (if required)","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"To configure the proxy settings in IntelliJ;","type":"text"}]},{"type":"paragraph","content":[{"text":"click ","type":"text"},{"text":"File","type":"text","marks":[{"type":"strong"}]},{"text":" -> ","type":"text"},{"text":"Settings","type":"text","marks":[{"type":"strong"}]},{"text":" -> ","type":"text"},{"text":"Appearance & Behavior","type":"text","marks":[{"type":"strong"}]},{"text":" -> ","type":"text"},{"text":"System Settings","type":"text","marks":[{"type":"strong"}]},{"text":" -> ","type":"text"},{"text":"HTTP Proxy","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":" enter the correct proxy settings and click ","type":"text"},{"text":"Apply","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"In case of ","type":"text"},{"text":"Manual proxy configuration","type":"text","marks":[{"type":"strong"}]},{"text":", while entering the ","type":"text"},{"text":"Host name","type":"text","marks":[{"type":"strong"}]},{"text":", there is no need to write ","type":"text"},{"text":"http://","type":"text","marks":[{"type":"strong"}]},{"text":" in front of the URL. For example, if the proxy value is ","type":"text"},{"text":"http://one.proxy.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://one.proxy.com"}}]},{"text":", you would put ","type":"text"},{"text":"one.proxy.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://one.proxy.com"}},{"type":"strong"}]},{"text":" as the ","type":"text"},{"text":"Host name","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"To configure the proxy settings for Git, play the following command:","type":"text"}]},{"type":"paragraph","content":[{"text":"git config --global https.proxy https://:@ ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"git config --global http.proxy http://:@","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]},{"text":": while entering the proxy username, sometimes it may require to add the domain name in front.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"IDEs","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Eclipse","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Install Eclipse","type":"text"}]},{"type":"paragraph","content":[{"text":"Download and run the installer from: ","type":"text"},{"text":"Install Eclipse","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.eclipse.org/downloads/packages/installer"}}]},{"text":".","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.eclipse.org/downloads/packages/installer"}}]},{"text":" Select \"Eclipse IDE for Java Developers\" to install.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"ONAP Eclipse Java Formatter ","type":"text"}]},{"type":"paragraph","content":[{"text":"Download ","type":"text"},{"text":"onap-java-formatter.xml","type":"text","marks":[{"type":"link","attrs":{"href":"https://gerrit.onap.org/r/gitweb?p=aai/aai-common.git;a=blob_plain;f=onap-java-formatter.xml;hb=HEAD"}}]},{"text":" and import into Eclipse. ","type":"text"}]},{"type":"paragraph","content":[{"text":"(updates to the settings should be committed and merged back into the repository)","type":"text"}]},{"type":"paragraph","content":[{"text":"ONAP uses ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"Google Java Style","type":"text","marks":[{"type":"link","attrs":{"href":"https://google.github.io/styleguide/javaguide.html"}}]},{"text":" with some modifications. ( ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"See ","type":"text"},{"text":"Java code style","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16230141"}}]},{"text":" )","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"expand","attrs":{"title":"Maven Plugins to Reformat Java code"},"content":[{"type":"paragraph","content":[{"text":"Using the Eclipse Formatter file above and maven plugin configuration in pom.xml as per ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"link","attrs":{"href":"https://gerrit.onap.org/r/gitweb?p=aai/aai-common.git;a=blob_plain;f=pom.xml;hb=refs/heads/master"}}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"(","type":"text"},{"text":"https://code.revelc.net/formatter-maven-plugin/","type":"text","marks":[{"type":"link","attrs":{"href":"https://code.revelc.net/formatter-maven-plugin/"}}]},{"text":" for Eclipse formatter and ","type":"text"},{"text":"https://github.com/diffplug/spotless/tree/master/plugin-maven","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/diffplug/spotless/tree/master/plugin-maven"}}]},{"text":" for import order)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example pom.xml configuration","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":" \n \n \n net.revelc.code.formatter\n formatter-maven-plugin\n 2.8.1\n \n ${project.parent.basedir}/onap-java-formatter.xml\n \n \n \n \n com.diffplug.spotless\n spotless-maven-plugin\n 1.18.0\n \n \n \n com,java,javax,org\n \n \n \n \n \n ","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"The combination can be used in a maven command to rewrite code and imports, then checkstyle audit like so","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example maven command","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"mvn formatter:format spotless:apply process-sources","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Install useful plugins for Eclipse","type":"text"}]},{"type":"paragraph","content":[{"text":"Install ","type":"text"},{"text":"EclEmma","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.eclemma.org/installation.html"}}]},{"text":" for code coverage and ","type":"text"},{"text":"SonarLint","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.sonarlint.org/eclipse/"}}]},{"text":" for static code analysis.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Set up Sonar towards ONAP for Eclipse","type":"text"}]},{"type":"paragraph","content":[{"text":"To bind your projects to the ONAP Sonar server, follow the instructions below.","type":"text"}]},{"type":"paragraph","content":[{"text":"Your projects should be imported in to Eclipse before this.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"expand","attrs":{"title":"Click here to view detailed steps..."},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Right click on the project and select \"SonarLint -> Bind to SonarQube or SonarCloud...\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select \"sonarcloud\" and press \"Next\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click \"Generate Token\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A browser opens and you are taken to a Sonarcloud login page","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Login with an appropriate account from the list presented, most likely your GitHub account","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You are now directed to a sonarcloud token generation page","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter a name for your token and click \"Generate\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the token hex string that is generated from the browser and paste it into the \"Token\" field in Eclipse and click \"Next\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the \"Organization\" field, enter the string \"onap\" and press \"Next\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Connection name \"SonarCloud/onap\" should be found by the system, click \"Next\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The connection should be successfully created, click \"Finish\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Press \"Add...\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the projects you want to add and press \"OK\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Press \"Next\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Start typing the name of your project, and it should appear in a list box where it should be selected.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Press \"Finish\".","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"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\".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Setting up the ONAP Checkstyle for Eclipse","type":"text"}]},{"type":"paragraph","content":[{"text":"Set \"ONAP\" configuration in Eclipse","type":"text"}]},{"type":"paragraph","content":[{"text":"To set the newly built checkstyle files in Eclipse:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Preferences->Checkstyle","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click \"New\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select \"External Configuration File\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Give it a name eg ONAP","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Point at the file /oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml ","type":"text"},{"type":"hardBreak"},{"text":"(assuming you have downloaded the ","type":"text"},{"text":"oparent","type":"text","marks":[{"type":"em"}]},{"text":" repo)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click OK","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select \"ONAP\" configuration and click \"Set as Default\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select \"Apply and Close\"","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Apply \"ONAP\" configuration to a project in Eclipse","type":"text"}]},{"type":"paragraph","content":[{"text":"Now we need to activate the checkstyle on one project and set it as the blueprint for all of them:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select a project in eclipse and right click->Properties→Checkstyle","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"check \"Checkstyle active for this project\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the \"ONAP\" checkstyle profile","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click \"Apply and Close\"","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Spread ","type":"text"},{"text":"blueprint","type":"text","marks":[{"type":"em"}]},{"text":" to other projects for Eclipse","type":"text"}]},{"type":"paragraph","content":[{"text":"Now spread the profile to all other projects:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select all the projects you want to apply the profile to in the Eclipse project explorer (not the one that you set up above)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Right click->Checkstyle->Configure projects from blueprint","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the project you set up above","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now all the projects have the correct checkstyle setup.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Configure ONAP copyright for Eclipse","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Window > Preferences","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Java > Code Style > Code Templates","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click Code and select New Java files","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click Edit","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Paste the license below","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click Insert Variable and add the date","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the organization name","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click Apply","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"============LICENSE_START=======================================================\n Copyright (C) $today.year \n ================================================================================\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n \n SPDX-License-Identifier: Apache-2.0\n ============LICENSE_END=========================================================","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"IntelliJ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Download & Install","type":"text"}]},{"type":"paragraph","content":[{"text":"see ","type":"text"},{"text":"https://www.jetbrains.com/idea/download/#section=windows","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.jetbrains.com/idea/download/#section=windows"}}]}]},{"type":"paragraph","content":[{"text":"Make sure you have added the Checkstyle plugin . Follow the below link","type":"text"}]},{"type":"paragraph","content":[{"text":"https://plugins.jetbrains.com/plugin/1065-checkstyle-idea","type":"text","marks":[{"type":"link","attrs":{"href":"https://plugins.jetbrains.com/plugin/1065-checkstyle-idea"}}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Configure ONAP code CheckStyle Plugin for IntelliJ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select, File, Settings, Tools, Checkstyle ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on + beside the 'Configuration File' box to add a configuration","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set description to something like 'ONAP Rules'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on Browse to select the file /oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml ","type":"text"},{"type":"hardBreak"},{"text":"(assuming you have downloaded the","type":"text"},{"text":" ","type":"text"},{"text":"oparent","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"},{"text":"repo)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Complete the Wizard (you can set exclusion properties if needed)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the Configuration File you just added by selecting the relevant checkbox","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click [OK] to close the settings popup","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Configure ONAP code style auto formatting for IntelliJ (using the same checkstyle rules and automating it for you ","type":"text"},{"type":"emoji","attrs":{"id":"1f642","text":"🙂","shortName":":slight_smile:"}},{"text":")","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select, File, Settings, Editor, Code Style","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on the gear icon at the end of the line for \"Scheme:\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Import Scheme→Checkstyle Configuration","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on Browse to select the file /oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml ","type":"text"},{"type":"hardBreak"},{"text":"(assuming you have downloaded the","type":"text"},{"text":" ","type":"text"},{"text":"oparent","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"},{"text":"repo)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click OK","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Configure ONAP copyright for IntelliJ","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"File > Settings > Editor > Copyright > Copyright Profiles","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the + icon and add the copyright text below","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change the organization name","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to the Copyright","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the new copyright profile from the drop down for Default project copyright","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click Apply","type":"text"}]}]}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"============LICENSE_START=======================================================","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"Copyright (C) $today.year ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"================================================================================","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"Licensed under the Apache License, Version","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"2.0","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"(the","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"\"License\"","type":"text","marks":[{"type":"code"}]},{"text":");","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"you may not use","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"this","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"file except in compliance with the License.","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"You may obtain a copy of the License at","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"http:","type":"text","marks":[{"type":"code"}]},{"text":"//","type":"text","marks":[{"type":"code"}]},{"text":"www.apache.org/licenses/LICENSE-2.0","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.apache.org/licenses/LICENSE-2.0"}}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"Unless required by applicable law or agreed to in writing, software","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"distributed under the License is distributed on an","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"\"AS IS\"","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"BASIS,","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"See the License","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"for","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"the specific language governing permissions and","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"limitations under the License.","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"SPDX-License-Identifier: Apache-","type":"text","marks":[{"type":"code"}]},{"text":"2.0","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"============LICENSE_END=========================================================","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Set up SonarLint towards ONAP for IntelliJ","type":"text"}]},{"type":"paragraph","content":[{"text":"Prerequisites","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You need to be part of the","type":"text"},{"text":" ","type":"text"},{"text":"onap organization","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/onap"}}]},{"text":" ","type":"text"},{"text":"in GitHub (see GitHub, click on your icon and select 'My Organizations')","type":"text"},{"type":"hardBreak"},{"text":"If you are not a member of this organization email ","type":"text"},{"text":"support.linuxfoundation.org","type":"text","marks":[{"type":"link","attrs":{"href":"http://support.linuxfoundation.org/"}}]},{"text":" and ask to be added to the","type":"text"},{"text":" ","type":"text"},{"text":"onap organization","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/onap"}}]},{"text":" ","type":"text"},{"text":"in GitHub","type":"text"},{"type":"hardBreak"},{"text":"Note","type":"text","marks":[{"type":"strong"}]},{"text":". It is possible to enter a different organization if you at least member of 1 organization (you can create your own in GitHub).","type":"text"},{"type":"hardBreak"},{"text":"The plugin wizard crashes if you are member of no organization at all, see this Bug: ","type":"text"},{"text":"https://jira.sonarsource.com/browse/SLI-426","type":"text","marks":[{"type":"link","attrs":{"href":"https://jira.sonarsource.com/browse/SLI-426"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make sure you have added the SonarLint plugin","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"To use SonarLint with Onap projects you need to setup a connection with SonarCloud","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select, File, Settings, Tools, SonarLint.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on + beside the 'SonarCube / SonarClod connections' box to add a new connection","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set Configuration Name to something like 'ONAP'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure","type":"text"},{"text":" ","type":"text"},{"text":"sonarcloud","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"is selected and click [Next]","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click [Create Token]","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select GitHub, logon and follow the GitHub wizard to create a Token","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy Token into IntelliJ wizard","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click [Next] (might have to wait a little while your data is being downloaded)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select 'Open Network Automation Platform (ONAP)' from 'Your Organizations' and click [Next]","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click [Finish] to close the wizard","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click [OK] to leave settings","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Then you need to bind each project to the corresponding project in GitHub/SonarCloud:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select, File, Settings, Tools, SonarLint, Project Settings","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable (check) 'Bind project to SonarQube / SonarCloud'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the connection created above using the [Configure the connection] button","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter the project name (e.g. 'onap_ccsdk-sli-plugins') or select it using [Search in list..] ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Start typing the name of your project, and it should appear in a list box where it should be selected.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click [OK] to finish","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Optional Tools & Utilities","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Python","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Check which version of python your project is using before installing. ","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Download Python from ","type":"text"},{"text":"https://www.python.org/downloads/","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.python.org/downloads/"}}]}]},{"type":"paragraph","content":[{"text":"Add python binary to Path.","type":"text"}]},{"type":"paragraph","content":[{"text":"Install \"pip3\", if you plan to use git-review.","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"sudo apt-get update","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"sudo apt-get -y install python3-pip","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]},{"type":"paragraph","content":[{"text":"pip3 --version","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"git-review (optional)","type":"text"}]},{"type":"paragraph","content":[{"text":"In a shell, type the following command (assumes you installed python above) :","type":"text"},{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"pip3 install git-review","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"To use ","type":"text"},{"text":"git review","type":"text","marks":[{"type":"code"}]},{"text":", you have to be in a Git clone directory that already contains a (possibly hidden) ","type":"text"},{"text":".gitreview","type":"text","marks":[{"type":"code"}]},{"text":" configuration file (see ","type":"text"},{"text":"Gerrit/Advanced usage#Setting up a repository for git-remote","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.mediawiki.org/wiki/Gerrit/Advanced_usage#Setting_up_a_repository_for_git-remote"}}]},{"text":")","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The Git and git-review installation steps above are derived from the description at: ","type":"text"},{"text":"https://www.mediawiki.org/wiki/Gerrit/git-review#Windows","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.mediawiki.org/wiki/Gerrit/git-review#Windows"}}]},{"text":" ","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Configure Git to remember your Linux Foundation user name and email address (the user name and email address associated with your Linux Foundation login):","type":"text"}]},{"type":"codeBlock","content":[{"text":"git config --global user.email \n\ngit config --global --add gitreview.username ","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Configure git review","type":"text"}]},{"type":"codeBlock","content":[{"text":"git config --global gitreview.remote origin","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"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:","type":"text"}]},{"type":"codeBlock","content":[{"text":"git config --global https.proxy https://:@ \n\ngit config --global http.proxy http://:@","type":"text"}]},{"type":"paragraph","content":[{"text":"NOTE: When entering the proxy username, you might be required to add the domain name in front of the username.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Node-JS","type":"text"}]},{"type":"paragraph","content":[{"text":"The dcae build will install npm in most cases.","type":"text"}]},{"type":"paragraph","content":[{"text":"However you can install it yourself from ","type":"text"},{"text":"https://nodejs.org/en/download/","type":"text","marks":[{"type":"link","attrs":{"href":"https://nodejs.org/en/download/"}}]}]},{"type":"paragraph","content":[{"text":"Verify your installation by ","type":"text"}]},{"type":"codeBlock","content":[{"text":"npm -v","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Local SonarQube Setup","type":"text"}]},{"type":"paragraph","content":[{"text":"It can be useful to have SonarQube running locally rather than pushing through CI for feedback.","type":"text"}]},{"type":"paragraph","content":[{"text":"This can be done using docker:","type":"text"}]},{"type":"paragraph","content":[{"text":"Images of the Community, Developer, and Enterprise Editions are available on ","type":"text"},{"text":"Docker Hub","type":"text","marks":[{"type":"link","attrs":{"href":"https://hub.docker.com/_/sonarqube/"}}]},{"text":".","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Start the server by running:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"$ docker run -d --name sonarqube -p 9000:9000 sonarqube:latest","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to ","type":"text"},{"text":"http://localhost:9000","type":"text","marks":[{"type":"link","attrs":{"href":"http://localhost:9000"}}]},{"text":" with System Administrator credentials (login=admin, password=admin).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the ","type":"text"},{"text":"Create new project","type":"text","marks":[{"type":"strong"}]},{"text":" button to analyze your first project.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Other Optional Tools","type":"text"}]},{"type":"paragraph","content":[{"text":"The component you are working on may require additional tool installations, see the relevant section under ","type":"text"},{"text":"Development Guides","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/display/DW/Development+Guides"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Troubleshooting & Know Issues","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Windows Limitations","type":"text"}]},{"type":"paragraph","content":[{"text":"Some repos might not clone in Windows until some file paths are reduced below 255 chars.","type":"text"}]},{"type":"paragraph","content":[{"text":"Enable long paths in windows as","type":"text"}]},{"type":"codeBlock","content":[{"text":"git config --system core.longpaths true","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Hack oparent to fix \"curly bracket\" issue","type":"text"}]},{"type":"expand","attrs":{"title":""},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check out oparent","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"git tag -l","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"git co tags/1.2.3 -b 1.2.3","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you want CheckStyle to ignore generated files, do the following:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the following tag to the above file:","type":"text"},{"type":"hardBreak"},{"text":"","type":"text"},{"type":"hardBreak"},{"text":" /suppressions.xml\"/>","type":"text"},{"type":"hardBreak"},{"text":"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a file called \"suppressions.xml\" in the folder given above, and put the following content in it:","type":"text"},{"type":"hardBreak"},{"text":"","type":"text"},{"type":"hardBreak"},{"text":"","type":"text"},{"type":"hardBreak"},{"text":"","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The versions in the POMs in oparent are snapshot, so we need to change those to 1.2.1","type":"text"},{"type":"hardBreak"},{"text":" mvn versions:set -DnewVersion=1.2.1","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now build locally:","type":"text"},{"type":"hardBreak"},{"text":"mvn clean install","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Appendix","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Building Entire ONAP","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/display/DW/Building+Entire+ONAP"}}]}]}]}]}],"version":1}