Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.2 KB

contributing-plugin.md

File metadata and controls

47 lines (30 loc) · 2.2 KB
Raw

Building, Testing and Debugging the SonarQube plugin

Setup your Java environment

  • Install the Java Development Kit (JDK) version 11 or later (make sure it's an LTS version) - you can install it from here
  • Install IntelliJ IDEA Community Edition
  • Install Apache Maven
  • Setup the Maven Settings (internal link)
  • Setup the Orchestrator (internal link)

Working with the code

  1. Clone this repository
  2. Download sub-modules git submodule update --init --recursive
  3. Build the plugin
    • To build the plugin while embedding a local build of the analyzer you can either:

      • run .\scripts\build\dev-build.ps1 -build -test -buildJava -release

        The flags -restore -build -test need to be run only when you have changed the analyzer. Otherwise you can run only -buildJava

      • or run the following commands:

        1. msbuild /t:rebuild .\analyzers\SonarAnalyzer.sln
        2. mvn clean install -D analyzer.configuration=Debug

Developing with Eclipse or IntelliJ

When working with Eclipse or IntelliJ please follow the sonar guidelines

Running Tests

Unit Tests

As for any maven project, the command mvn clean install automatically runs the unit tests.

Integration Tests

Before running ITs, you need to setup the NUGET_PATH environment variable to point to the nuget.exe executable. Additional information about the integration tests configuration can be found at the following internal link.

To run the ITs, from your command prompt, you can either:

  • go to the its folder and run mvn clean install
  • or run .\scripts\build\dev-build.ps1 -itsJava

Contributing

Please see the How to contribute section for details on contributing changes back to the code.