# Generating a SonarQube SAST Report

### Introduction

This guide will walk you through the steps to run a python script which will download your SonarQube vulnerability SAST report as a `json` file that can be submitted to Mobb. This script works for both Sonarcloud (SaaS) and SonarQube (on-premise).

### Pre-Requisites

* You must have Python installed in your environment. If you don't have Python installed, please do so by visiting the Python download site [here](https://www.python.org/downloads/).
* You will need to run the script via your terminal or command prompt.
* Download the `sonarqube_download_report.py` script from [here](https://github.com/mobb-dev/sonarqube-report-downloader/blob/main/sonarqube_download_report.py).

### Required environment variable settings

#### `SONARQUBE_HOST_URL`

Example values: `https://sonarcloud.io` or `http://localhost:9000`

#### `SONARQUBE_TOKEN`

Generate this token at by following the instruction [here](https://docs.sonarsource.com/sonarqube/9.8/user-guide/user-account/generating-and-using-tokens/#generating-a-token)

#### `SONARQUBE_ORG`

Your Sonarcloud Org ID. If you are using SonarQube, enter `none`

#### `SONARQUBE_PROJECT`

Your Sonarqube project key

#### `REPORT_PATH`

Name of the output report For example: `sonar_report.json`

#### `BRANCH` (Use either `BRANCH` or `PULL_REQUEST_ID` depending on your scan type. Do not use both together. See examples below)

The branch name. For example: `main`

### 'PULL\_REQUEST\_ID' (Use either `BRANCH` or `PULL_REQUEST_ID` depending on your scan type. Do not use both together. See examples below)

The Pull Request ID or Pull Request Number associated to the scan, for example `PULL_REQUEST_ID=13`

### Sample command to download a report tied to a branch:

```
SONARQUBE_HOST_URL=https://sonarcloud.io \
SONARQUBE_TOKEN=XXX \
SONARQUBE_ORG=antonychiu2 \
SONARQUBE_PROJECT=antonychiu2_wf-examples-sonar \
BRANCH=main \
REPORT_PATH=sonar_report.json \
python sonarqube_download_report.py
```

### Sample command to download a report tied to a PR:

```
SONARQUBE_HOST_URL=https://sonarcloud.io \
SONARQUBE_TOKEN=XXX \
SONARQUBE_ORG=antonychiu2 \
SONARQUBE_PROJECT=antonychiu2_wf-examples-sonar \
PULL_REQUEST_ID=13 \
REPORT_PATH=sonar_report.json \
python sonarqube_download_report.py
```

### Sample command to download a SAST report from SonarQube (on-premise):

```
SONARQUBE_HOST_URL=http://local-ubuntu-vm:9000 \
SONARQUBE_TOKEN=XXX \
SONARQUBE_ORG=none \
SONARQUBE_PROJECT=webgoat-local \
BRANCH=main \
REPORT_PATH=sonar_report.json \
python sonarqube_download_report.py
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mobb.ai/mobb-user-docs/integrating-sast-findings/sonarqube/generating-a-sonarqube-sast-report.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.