feat: Update SonarQube plugin to v2.4.2

- Added new parameters `sonar_config_file`, `sonar_config_file_override`, and `quality_gate_error_exit_code` for enhanced configuration control.
- Updated README and documentation to include new features and configuration options.
- Improved parameter reference with detailed descriptions and examples.

Author: diegopereiraeng

.drone.yml

@@ -19,15 +19,15 @@ steps:
     when:
       ref:
         - "refs/pull/**" # Only run for pull requests
-  - name: publish-2.4.1
+  - name: publish-2.4.2
     image: plugins/docker:20
     settings:
       # auto_tag: true
       # auto_tag_suffix: v2.0.2-java17
       tags:
-        - v2.4.1
-        # - latest
-        # - stable-java17
+        - v2.4.2
+        - latest
+        - stable-java17
       daemon_off: false
       dockerfile: Dockerfile
       password:
@@ -39,6 +39,26 @@ steps:
       ref:
         - refs/heads/main
         - refs/tags/**
+  - name: publish-2.4.2-java11
+    image: plugins/docker:20
+    settings:
+      # auto_tag: true
+      # auto_tag_suffix: v2.0.2-java17
+      tags:
+        - v2.4.2
+        - latest-java11
+        - stable-java11
+      daemon_off: false
+      dockerfile: Dockerfile_Deprecated
+      password:
+        from_secret: docker_password
+      repo: plugins/sonarqube-scanner
+      username:
+        from_secret: docker_username
+    when:
+      ref:
+        - refs/heads/main
+        - refs/tags/**
 trigger:
   ref:
     - refs/heads/main

DOCS.md

@@ -25,25 +25,55 @@ steps:
 
 Customized parameters could be specified:
 
-```diff
-  steps:
-  - name: code-analysis
-    image: drone-plugins/sonarqube-scanner
-    settings:
-      sonar_host:
-        from_secret: sonar_host
-      sonar_token:
-        from_secret: sonar_token
-      sonar_name: project-harness
-      sonar_key: project-harness
-+     build_number: 1.0
-+     timeout: 20
-+     sources: .
-+     level: DEBUG
-+     showProfiling: true
-+     exclusions: **/static/**/*,**/dist/**/*.js
-+     usingProperties: false
-+     binaries: .
+```yaml
+steps:
+- name: code-analysis
+  image: drone-plugins/sonarqube-scanner
+  settings:
+    sonar_host:
+      from_secret: sonar_host
+    sonar_token:
+      from_secret: sonar_token
+    sonar_name: project-harness
+    sonar_key: project-harness
+    build_number: 1.0
+    timeout: 20
+    sources: .
+    level: DEBUG
+    showProfiling: true
+    exclusions: **/static/**/*,**/dist/**/*.js
+    usingProperties: false
+    binaries: .
+    sonar_config_file: true
+    sonar_config_file_override: false
+    quality_gate_error_exit_code: 5
+    sonar_qualitygate_timeout: 300
+    branch: master
+    inclusions: "*.go, *.java"
+    sonar_quality_enabled: true
+    artifact_file: artifact.json
+    javascript_icov_reportPath: /path/to/icov/report
+    java_coverage_plugin: jacoco
+    jacoco_report_path: /path/to/jacoco/report
+    ssl_keystore_pwd: your-keystore-password
+    cacerts_location: /path/to/cacerts
+    junit_reportpaths: /path/to/junit/reports
+    source_encoding: UTF-8
+    tests: /path/to/tests
+    java_test: /path/to/java/test
+    pr_key: 123
+    pr_branch: your-pr-branch
+    pr_base: your-pr-base
+    coverage_exclusion: **/test/**/*.*,**/*.test.go
+    java_source: 1.8
+    java_libraries: /path/to/libraries
+    surefire_reportsPath: /path/to/surefire/reports
+    typescript_lcov_reportPaths: /path/to/typescript/lcov/reports
+    verbose: true
+    custom_jvm_params: "-Dsonar.java.source='value_you_want'"
+    taskid: your-task-id
+    skip_scan: true
+    SONAR_SCANNER_OPTS: "--add-opens java.base/sun.nio.ch=ALL-UNNAMED --add-opens java.base/java.io=ALL-UNNAMED"
 ```
 
 # Secret Reference
@@ -52,48 +82,37 @@ Safety first, the host and token are stored in Drone Secrets.
 * `sonar_host`: Host of SonarQube with schema(http/https).
 * `sonar_token`: User token used to post the analysis report to SonarQube Server. Click User -- My Account -- Security -- Generate Tokens.
 
-
 # Parameter Reference
 
-* `sonar_name`: Sonar Project NAme.
+* `sonar_name`: Sonar Project Name.
 * `sonar_key`: Sonar Project Key.
 * `sonar_qualitygate_timeout`: Timeout in seconds for Sonar Scan.
-* `artifact_file`: Timeout in seconds for Sonar Scan.
-* `sonar_quality_enabled`: True to block pipeline if sonar quality gate conditions are not met.
+* `artifact_file`: Path to the artifact file that will be generated by the plugin.
+* `sonar_quality_enabled`: True to block the pipeline if Sonar quality gate conditions are not met.
 * `branch`: Branch for analysis. (-Dsonar.branch.name=)
 * `build_number`: Build Version.
-
 * `build_version`: Code version, Default value `DRONE_BUILD_NUMBER`.
-* `timeout`: Default seconds `60`.
-* `sources`: Comma-separated paths to directories containing source files. 
-* `inclusions`: Comma-delimited list of file path patterns to be included in analysis. When set, only files matching the paths set here will be included in analysis.
+* `timeout`: Timeout in seconds, default `60`.
+* `sources`: Comma-separated paths to directories containing source files.
+* `inclusions`: Comma-delimited list of file path patterns to be included in analysis. Example: `*.go, *.java`.
 * `exclusions`: Comma-delimited list of file path patterns to be excluded from analysis. Example: `**/static/**/*,**/dist/**/*.js`.
-* `level`: Control the quantity / level of logs produced during an analysis. Default value `INFO`. 
-    * DEBUG: Display INFO logs + more details at DEBUG level.
-    * TRACE: Display DEBUG logs + the timings of all ElasticSearch queries and Web API calls executed by the SonarQube Scanner.
+* `level`: Control the quantity/level of logs produced during an analysis. Default value `INFO`. Options are `DEBUG` and `TRACE`.
 * `showProfiling`: Display logs to see where the analyzer spends time. Default value `false` (-Dsonar.showProfiling=)
-* `branchAnalysis`: Pass currently analysed branch to SonarQube. (Must not be active for initial scan!) Default value `false`
-
-
-* `usingProperties`: Using the `sonar-project.properties` file in root directory as sonar parameters. (Not include `sonar_host` and
-`sonar_token`.) Default value `false`
-
-* `sonar_qualitygate_timeout`: Quality gate timeout. (-Dsonar.qualitygate.timeout=)
-
-* `binaries`: app binaries (-Dsonar.java.binaries=)
-
+* `branchAnalysis`: Pass currently analyzed branch to SonarQube. (Must not be active for initial scan!) Default value `false`.
+* `usingProperties`: Use the `sonar-project.properties` file in the root directory as sonar parameters. (Not including `sonar_host` and `sonar_token`.) Default value `false`.
+* `binaries`: Path to application binaries (-Dsonar.java.binaries=).
+* `sonar_config_file`: Use `sonar-project.properties` if available. Default value `false`.
+* `sonar_config_file_override`: Use `sonar-project.properties` if available and override host, login, or project key settings. Default value `false`.
+* `quality_gate_error_exit_code`: Specifies the "exit code" error when the quality gate fails. Default is `5`.
 
 # Javascript Parameters
 
-* `javascript_icov_reportPath`: Path to coverage report (-Dsonar.javascript.lcov.reportPath)
-
+* `javascript_icov_reportPath`: Path to coverage report (-Dsonar.javascript.lcov.reportPath).
 
 # Java Parameters
 
-* `jacoco_report_path`: Path to Jacoco Report (if not default). (-Dsonar.jacoco.reportPath=)
-
-* `java_coverage_plugin`: plugin to use as coverage. ex: jacoco (-Dsonar.java.coveragePlugin=)
-
+* `jacoco_report_path`: Path to Jacoco Report (if not default). (-Dsonar.jacoco.reportPath=).
+* `java_coverage_plugin`: Plugin to use as coverage, e.g., jacoco (-Dsonar.java.coveragePlugin=).
 
 # Notes
 
@@ -102,7 +121,7 @@ Safety first, the host and token are stored in Drone Secrets.
 * You could also add a file named `sonar-project.properties` at the root of your project to specify parameters.
 
 Code repository: [drone-plugins/sonarqube-scanner](https://github.com/drone-plugins/sonarqube-scanner).  
-SonarQube Parameters: [Analysis Parameters](https://docs.sonarqube.org/display/SONAR/Analysis+Parameters)
+SonarQube Parameters: [Analysis Parameters](https://docs.sonarqube.org/display/SONAR/Analysis+Parameters).
 
 # Test your SonarQube Server:
 

README.md

@@ -1,21 +1,41 @@
-
 # Harness Drone/CIE SonarQube Plugin with Quality Gate
 
-This plugin is designed to run SonarQube scans and handle the results and convert it to JUnit Format. It's written in Go and check the report results for status OK.
+This plugin is designed to run SonarQube scans, handle the results, and convert them to JUnit format. It's written in Go and checks the report results for status OK.
+
+## Main Features - v2.4.2
+
+- **New Parameter: `sonar_config_file`**
+  - **Type**: Boolean
+  - **Description**: If set to true, the plugin will utilize the specified `sonar-project.properties` file for the SonarQube analysis, if it exists.
+  - **Environment Variable**: `PLUGIN_SONAR_CONFIG_FILE`
+  - **Allowed Values**: `"true"`, `"false"`
+
+- **New Parameter: `sonar_config_file_override`**
+  - **Type**: Boolean
+  - **Description**: If set to true, the plugin will use the `sonar-project.properties` file and allow overriding of host, login, and/or project key settings.
+  - **Environment Variable**: `PLUGIN_SONAR_CONFIG_FILE_OVERRIDE`
+  - **Allowed Values**: `"true"`, `"false"`
+
+- **New Parameter: `quality_gate_error_exit_code`**
+  - **Type**: Integer
+  - **Description**: Specifies the "exit code" error when the quality gate fails. Default is `5`.
+  - **Environment Variable**: `PLUGIN_QUALITY_GATE_ERROR_EXIT_CODE`
+  - **Default Value**: `5`
 
 ## Main Features - v2.4.1
 
 - Sonar CLI downgraded from 6.0.0.4432 to 5.0.1.3006
 - Execute SonarQube scans and handle the results
 - Generate JUnit reports based on the scan results
 - Quality Gate status reporting + Metrics
-- Skip Scan and only check for quality Gate Status of a specific analysisId or last analysis
-- Waiting for Analysis and QualityGate nows skip the wait if set to false - thanks @kangguru
-- Added SONAR_SCANNER_OPTS as param, so it transform into this env var during execution for Sonar JVM params - check for the param detail section below
+- Skip Scan and only check for Quality Gate status of a specific `analysisId` or last analysis
+- Waiting for Analysis and QualityGate now skips the wait if set to false - thanks @kangguru
+- Added `SONAR_SCANNER_OPTS` as a parameter, transforming into this env var during execution for Sonar JVM params - check the parameter detail section below
 
-Obs: USe branch and pr_key params for accuracy results matches when skiping the scan
+**Note**: Use `branch` and `pr_key` parameters for accurate results matching when skipping the scan.
+
+![Results](https://github.com/drone-plugins/sonarqube-scanner/blob/main/sonar-result-v2.png)
 
-<img src="https://github.com/drone-plugins/sonarqube-scanner/blob/main/sonar-result-v2.png" alt="Results" width="800"/>
 
 ### Simple Pipeline example
 
@@ -26,7 +46,7 @@ Obs: USe branch and pr_key params for accuracy results matches when skiping the
     identifier: run_sonar
     spec:
         connectorRef: account.DockerHubDiego
-        image: plugins/sonarqube-scanner:v2.4.1
+        image: plugins/sonarqube-scanner:v2.4.2
         reports:
             type: JUnit
             spec:
@@ -48,7 +68,7 @@ Obs: USe branch and pr_key params for accuracy results matches when skiping the
 type: Plugin
 spec:
     connectorRef: <+input>
-    image: plugins/sonarqube-scanner:v2.4.1
+    image: plugins/sonarqube-scanner:v2.4.2
     reports:
         type: JUnit
         spec:
@@ -88,7 +108,7 @@ spec:
     identifier: check_sonar
     spec:
         connectorRef: account.DockerHubDiego
-        image: plugins/sonarqube-scanner:v2.4.1
+        image: plugins/sonarqube-scanner:v2.4.2
         reports:
             type: JUnit
             spec:
@@ -110,7 +130,7 @@ name: default
 
 steps:
 - name: perform-code-analysis
-  image: plugins/sonarqube-scanner:v2.4.1
+  image: plugins/sonarqube-scanner:v2.4.2
   settings:
     sonar_host: http://34.100.11.50
     sonar_token:
@@ -212,6 +232,24 @@ steps:
 - `SONAR_SCANNER_OPTS`: pass any Sonar JVM param as env var during execution.
   - Example: `"SONAR_SCANNER_OPTS": "--add-opens java.base/sun.nio.ch=ALL-UNNAMED --add-opens java.base/java.io=ALL-UNNAMED"`
 
+- **`sonar_config_file`**:
+  - **Type**: Boolean
+  - **Description**: Use `sonar-project.properties` if available.
+  - **Environment Variable**: `PLUGIN_SONAR_CONFIG_FILE`
+  - **Allowed Values**: `"true"`, `"false"`
+
+- **`sonar_config_file_override`**:
+  - **Type**: Boolean
+  - **Description**: Use `sonar-project.properties` if available and allow overriding of host, login, and/or project key settings.
+  - **Environment Variable**: `PLUGIN_SONAR_CONFIG_FILE_OVERRIDE`
+  - **Allowed Values**: `"true"`, `"false"`
+
+- **`quality_gate_error_exit_code`**:
+  - **Type**: Integer
+  - **Description**: Specifies the "exit code" error when the quality gate fails. Default is `5`.
+  - **Environment Variable**: `PLUGIN_QUALITY_GATE_ERROR_EXIT_CODE`
+  - **Default Value**: `5` 
+
 Detail Informations/tutorials Parameteres: [DOCS.md](DOCS.md).
 
 ### Build Process