Installing SonarQube for python on WSL/Windows

Installing docker desktop

You can use this link to download the latest version of docker desktop. Remember to check Install required Windows components for WSL 2 while installing.

Installing SonarQube image in docker

After installing Docker, you can use this command in cmd to download and install SonarQube image on windows:

docker run -d  -p 9000:9000 -p 9092:9092 sonarqube

For more details see How I configured SonarQube for Python code analysis with Jenkins and Docker.

Installing SonarScanner

The next step is to install a SonarScanner on WSL 2 to scan your code and check the rules. You can download and install sonar-scanner according to this guidline. Here we may install SonarScanner directly via sonar-scanner-cli-4.6.2.2472-linux.zip file.

To run SonarScanner from the zip file, follow these steps:

Expand the downloaded file into the directory of your choice. We’ll refer to it as $install_directory in the next steps. You may use unzip package from apt.
Update the global settings to point to your SonarQube server by editing $install_directory/conf/sonar-scanner.properties:
```
#----- Default SonarQube server
#sonar.host.url=http://localhost:9000
```
Add the $install_directory/bin directory to your path. To do this permanently, you can edit the following file:
```
sudo nano ~/.bash_profile
```
And then add this line at the end of it:
```
export PATH="$PATH:$install_directory/bin"
```
Verify your installation by opening a new shell and executing the command sonar-scanner -h (sonar-scanner.bat -h on Windows). Don’t forget to open a new terminal, to update the Path variable.

Scanning project with sonar-scanner

In the root directory of your project create the following file with the following name: sonar-project.properties

# Something like your project name.
sonar.projectKey=coa_project
# folders and files to be excluded
sonar.exclusions=env/**,env/*, static/**, static/*, .git/**, .git/*, log/* 
# Here I specified for scanner to scan only python files
sonar.inclusions=**/*.py
sonar.scm.provider=git
# Token file which you may create in sonarqube clinet
sonar.login=
sonar.sources=. 
sonar.scm.disabled=True
sonar.python.version=3

To create a SonarQube token just head to SonarQube server URL, which you previously installed with docker and do as follows: Top right account button -> My Account -> Security Tab -> Generate a new token After some point, if you see SonarScanner stuck on a line, probably it means you should exclude more uneeded files.

After that sonar-scanner configuration is done and you should be able to scan your code via sonar-scanner command in your project root directory.

sonar-scanner

It may take a while and after that, you should wait for its processing task in background task in the SonarQube server. After that head to your SonarQube URL again, click on the project that appeared in the projects tab. That’s it.