version 2.0.0 - quality gate independency

Author: diegopereiraeng

README.md

@@ -1,47 +1,31 @@
 # Harness Drone/CIE SonarQube Plugin with Quality Gate
 
-The plugin of Harness Drone/CIE to integrate with SonarQube (previously called Sonar), which is an open source code quality management platform and check the report results for status OK.
+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.
 
-<img src="https://github.com/drone-plugins/sonarqube-scanner/blob/main/SonarResult.png" alt="Results" width="800"/>
+## Main Features - 2.0.0
 
+- 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
 
-Detail Informations/tutorials Parameteres: [DOCS.md](DOCS.md).
-
-
-### Build process
-build go binary file: 
-`GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o sonarqube-scanner`
+<img src="https://github.com/drone-plugins/sonarqube-scanner/blob/main/sonar-result-v2.png" alt="Results" width="800"/>
 
-build docker image
-`docker build -t plugins/sonarqube-scanner .`
-
-
-### Testing the docker image:
-```commandline
-docker run --rm \
-  -e DRONE_REPO=test \
-  -e PLUGIN_SOURCES=. \
-  -e SONAR_HOST=http://localhost:9000 \
-  -e SONAR_TOKEN=60878847cea1a31d817f0deee3daa7868c431433 \
-  -e PLUGIN_SONAR_KEY=project-sonar \
-  -e PLUGIN_SONAR_NAME=project-sonar \
-  plugins/sonarqube-scanner
-```
 
-### Pipeline example
+### Simple Pipeline example
 ```yaml
 - step:
     type: Plugin
     name: "Check Sonar "
-    identifier: Check_Sonar
+    identifier: run_sonar
     spec:
         connectorRef: account.DockerHubDiego
-        image: plugins/sonarqube-scanner:linux-amd64
+        image: plugins/sonarqube-scanner:2.0.0
         reports:
             type: JUnit
             spec:
                 paths:
-                    - "**/**/*.xml"
+                  - "**/**/*.xml"
         privileged: false
         settings:
             sonar_host: http://34.100.11.50
@@ -58,12 +42,12 @@ docker run --rm \
 type: Plugin
 spec:
     connectorRef: <+input>
-    image: plugins/sonarqube-scanner:linux-amd64
+    image: plugins/sonarqube-scanner:2.0.0
     reports:
         type: JUnit
         spec:
             paths:
-                - "**/**/*.xml"
+              - "**/**/*.xml"
     settings:
         sonar_key: <+input>
         sonar_name: <+input>
@@ -90,6 +74,141 @@ spec:
 
 ```
 
+### Skip Scan - Pipeline example
+```yaml
+- step:
+    type: Plugin
+    name: "Check Sonar "
+    identifier: run_sonar
+    spec:
+        connectorRef: account.DockerHubDiego
+        image: plugins/sonarqube-scanner:2.0.0
+        reports:
+            type: JUnit
+            spec:
+                paths:
+                  - "**/**/*.xml"
+        privileged: false
+        settings:
+            sonar_host: https://sonarcloud.io
+            sonar_token: 66778345cea1a31d817f0deee3daa7868c431433
+            sonar_name: sonarqube-scanner
+            sonar_key: sonarqube-scanner
+            skip_scan: true
+```
+
+### Configuration Parameters
+
+- `key`: The project key in SonarQube.
+  - Example: `"key": "your-project-key"`
+- `name`: The project name in SonarQube.
+  - Example: `"name": "your-project-name"`
+- `host`: The URL of the SonarQube server.
+  - Example: `"host": "https://sonarqube.example.com"`
+- `token`: The token for authenticating with the SonarQube server.
+  - Example: `"token": "your-sonarqube-token"`
+- `ver`: The version of the project.
+  - Example: `"ver": "1.0.0"`
+- `branch`: The branch of the project.
+  - Example: `"branch": "master"`
+- `timeout`: The timeout for the Sonar scanner.
+  - Example: `"timeout": "300"`
+- `sources`: The paths for the source directories, separated by commas.
+  - Example: `"sources": "src"`
+- `inclusions`: The files to be included in the analysis.
+  - Example: `"inclusions": "*.go, *.java"`
+- `exclusions`: The files to be excluded from the analysis.
+  - Example: `"exclusions": "*.test.go"`
+- `level`: The logging level.
+  - Example: `"level": "INFO"`
+- `showProfiling`: Enable profiling during analysis.
+  - Example: `"showProfiling": "true"`
+- `branchAnalysis`: Execute branch analysis.
+  - Example: `"branchAnalysis": "true"`
+- `usingProperties`: Use `sonar-project.properties`.
+  - Example: `"usingProperties": "true"`
+- `binaries`: Java binaries.
+  - Example: `"binaries": "/path/to/binaries"`
+- `quality`: Quality Gate.
+  - Example: `"quality": "OK"`
+- `quality_gate_enabled`: Stop pipeline if Sonar quality gate conditions are not met.
+  - Example: `"quality_gate_enabled": "true"`
+- `qualitygate_timeout`: Number in seconds for timeout.
+  - Example: `"qualitygate_timeout": "300"`
+- `artifact_file`: Artifact file location that will be generated by the plugin. This file will include information of Docker images that are uploaded by the plugin.
+  - Example: `"artifact_file": "artifact.json"`
+- `output-file`: Output file location that will be generated by the plugin. This file will include information that is exported by the plugin.
+  - Example: `"output-file": "/path/to/output/file"`
+- `javascript_icov_reportPath`: Sonar JavaScript Icov Report Path parameter.
+  - Example: `"javascript_icov_reportPath": "/path/to/icov/report"`
+- `java_coverage_plugin`: Sonar Java Plugin parameter.
+  - Example: `"java_coverage_plugin": "jacoco"`
+- `jacoco_report_path`: Sonar Jacoco Report Path parameter.
+  - Example: `"jacoco_report_path": "/path/to/jacoco/report"`
+- `ssl_keystore_pwd`: Java Keystore Password.
+  - Example: `"ssl_keystore_pwd": "your-keystore-password"`
+- `cacerts_location`: Java Truststore Location (cacerts).
+  - Example: `"cacerts_location": "/path/to/cacerts"`
+- `junit_reportpaths`: JUnit Report Paths.
+  - Example: `"junit_reportpaths": "/path/to/junit/reports"`
+- `source_encoding`: Source Encoding.
+  - Example: `"source_encoding": "UTF-8"`
+- `tests`: Sonar Tests.
+  - Example: `"tests": "/path/to/tests"`
+- `java_test`: Java Test.
+  - Example: `"java_test": "/path/to/java/test"`
+- `pr_key`: PR Key.
+  - Example: `"pr_key": "your-pr-key"`
+- `pr_branch`: PR Branch.
+  - Example: `"pr_branch": "your-pr-branch"`
+- `pr_base`: PR Base.
+  - Example: `"pr_base": "your-pr-base"`
+- `coverage_exclusion`: Sonar coverage exclusions.
+  - Example: `"coverage_exclusion": "*.test.go"`
+- `java_source`: Sonar Java source.
+  - Example: `"java_source": "1.8"`
+- `java_libraries`: Sonar Java libraries.
+  - Example: `"java_libraries": "/path/to/libraries"`
+- `surefire_reportsPath`: Sonar surefire reportsPath.
+  - Example: `"surefire_reportsPath": "/path/to/surefire/reports"`
+- `typescript_lcov_reportPaths`: Sonar TypeScript lcov reportPaths.
+  - Example: `"typescript_lcov_reportPaths": "/path/to/typescript/lcov/reports"`
+- `verbose`: Sonar verbose.
+  - Example: `"verbose": "true"`
+- `custom_jvm_params`: JVM parameters. Use comma for multiple parameters.
+  - Example: `"custom_jvm_params": "-Dsonar.java.source='value_you_want'"`
+- `taskid`: Sonar analysis taskId.
+  - Example: `"taskid": "your-task-id"`
+- `skip_scan`: Skip Sonar analysis scan - get last analysis automatically.
+  - Example: `"skip_scan": true`
+
+Detail Informations/tutorials Parameteres: [DOCS.md](DOCS.md).
+
+### Build Process
+
+build go binary file: 
+```
+GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o sonarqube-scanner
+```
+
+build docker image
+```
+docker build -t plugins/sonarqube-scanner .
+```
+
+
+### Testing the docker image:
+```commandline
+docker run --rm \
+  -e DRONE_REPO=test \
+  -e PLUGIN_SOURCES=. \
+  -e SONAR_HOST=http://localhost:9000 \
+  -e SONAR_TOKEN=60878847cea1a31d817f0deee3daa7868c431433 \
+  -e PLUGIN_SONAR_KEY=project-sonar \
+  -e PLUGIN_SONAR_NAME=project-sonar \
+  plugins/sonarqube-scanner
+```
+
 <img src="https://github.com/drone-plugins/sonarqube-scanner/blob/main/Sonar-CIE.png" alt="Plugin Configuration" width="400"/>
 
 <img src="https://github.com/drone-plugins/sonarqube-scanner/blob/main/SonarResultConsole.png" alt="Console Results" width="800"/>

go.sum

@@ -40,6 +40,7 @@ github.com/urfave/cli v1.22.9/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtX
 github.com/urfave/cli v1.22.14 h1:ebbhrRiGK2i4naQJr+1Xj92HXZCrK7MsyTS/ob3HnAk=
 github.com/urfave/cli v1.22.14/go.mod h1:X0eDS6pD6Exaclxm99NJ3FiCDRED7vIHpx2mDOHLvkA=
 github.com/urfave/cli/v2 v2.25.7/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
+github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037 h1:YyJpGZS1sBuBCzLAR1VEpK193GlqGZbnPFnPV/5Rsb4=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=

main.go

@@ -244,6 +244,11 @@ func main() {
 			Value:  "",
 			EnvVar: "PLUGIN_TASKID",
 		},
+		cli.BoolFlag{
+			Name:   "skip_scan",
+			Usage:  "Skip the SonarQube scan",
+			EnvVar: "PLUGIN_SKIP_SCAN",
+		},
 	}
 	app.Run(os.Args)
 }
@@ -289,6 +294,7 @@ func run(c *cli.Context) {
 			Verbose:                   c.String("verbose"),
 			CustomJvmParams:           c.String("custom_jvm_params"),
 			TaskId:                    c.String("taskid"),
+			SkipScan:                  c.Bool("skip_scan"),
 		},
 		Output: Output{
 			OutputFile: c.String("output-file"),

plugin.go

@@ -75,6 +75,7 @@ type (
 		Verbose                   string
 		CustomJvmParams           string
 		TaskId                    string
+		SkipScan                  bool
 	}
 	Output struct {
 		OutputFile string // File where plugin output are saved
@@ -569,8 +570,8 @@ func (p Plugin) Exec() error {
 	fmt.Printf("\n")
 
 	status := ""
-
-	if p.Config.TaskId != "" {
+	
+	if p.Config.TaskId != "" or !p.Config.SkipScan {
 		fmt.Printf("Skipping Scan...")
 		fmt.Printf("\n")
 		fmt.Printf("\n")
@@ -692,7 +693,7 @@ func displayQualityGateStatus(status string, qualityEnabled bool) {
 	fmt.Printf("|         QUALITY GATE STATUS REPORT           |\n")
 	fmt.Println("----------------------------------------------")
 
-	if status == "SUCCESS" {
+	if status == "OK" {
 		fmt.Printf("|         STATUS              |      \033[32m%s\033[0m       |\n", status)
 	} else {
 		fmt.Printf("|         STATUS              |      \033[31m%s\033[0m       |\n", status)