...
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.
|
IntelliJ
Installing Intellij Community Edition on Linux
Download
https://www.jetbrains.com/idea/download/#section=windows
Installing IntelliJ Community Edition and the Java SDK on Windows
When you start your first IntelliJ project, you will need to specify the Java Software Development Kit (SDK) as the project's. If you do not have the Java SDK installed on your machine, you can download it from within IntelliJ by selecting Maven as the New Project type and clicking on "Download SDK": (Or, visit http://www.oracle.com/technetwork/java/javase/downloads/index.html).
Configure ONAP code
...
CheckStyle for IntelliJ
ONAP is using google java style as mentioned in ONAP java style. Import intellij-java-google-style.xml in intelliJ settings→code style→java and modify the following items,
Tabs and Indents→Indent ( from 2 to 4)
Wrapping and Braces → hard wrap at ( 120)
...
- 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 copyright for IntelliJ
You can create copyright profile to auto-generate the copyright text. e.g, add the following text to new profile,
Replace <organization name>
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
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) 'Binfd 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
Python
Info |
---|
Check which version of python your project is using before installing. |
...
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 Tools
The component you are working on may require additional tool installations, see the relevant section under Development Guides.