concourse-sonarqube-notifier's Introduction

SonarQube Notification Resource

Gets Sonarqube results.

Installing

Shortcut: Pipeline example

Use this resource by adding the following to the resource_types section of a pipeline config:

---
resource_types:
- name: sonarqube-notifier
  type: docker-image
  source:
    repository: lgohr/sonarqube
    tag: latest

Source configuration

Configure as follows:

---
resources:
- name: my-sonarqube
  type: sonarqube-notifier
  source:
    target: https://my.sonar.server
    sonartoken: ((my-secret-token))
    component: my:component
    metrics: ncloc,complexity,violations,coverage

target: Required. URL of your SonarQube instance e.g. https://my-atlassian.com/sonar.
sonartoken: Required. Security token, which is used to connect to Sonarqube.
component: Required. The component key of your component. This is shown in the dashboard url as https://my-atlassian/sonar/dashboard?id=ComponentKey
metrics: Required. The metrics you want to grab. See https://docs.sonarqube.org/display/SONAR/Metric+Definitions

`in`: Get the latest result

Get the latest result; write it to the local working directory (e.g. /tmp/build/get) with the filename result.json.

Example response (metrics: nloc,complexity,violations,coverage)

{
  "component": {
    "id": "AWH_6osdce3G0HojaCW1",
    "key": "my:component",
    "name": "my-component",
    "qualifier": "TRK",
    "measures": [
      {
        "metric": "ncloc",
        "value": "824",
        "periods": [
          {
            "index": 1,
            "value": "299"
          }
        ]
      },
      {
        "metric": "complexity",
        "value": "90",
        "periods": [
          {
            "index": 1,
            "value": "27"
          }
        ]
      },
      {
        "metric": "violations",
        "value": "5",
        "periods": [
          {
            "index": 1,
            "value": "-6"
          }
        ]
      },
      {
        "metric": "coverage",
        "value": "91.4",
        "periods": [
          {
            "index": 1,
            "value": "40.7"
          }
        ]
      }
    ]
  },
  "periods": [
    {
      "index": 1,
      "mode": "previous_version",
      "date": "2018-03-07T16:58:31+0100"
    }
  ]
}

`out`: Nothing

concourse-sonarqube-notifier's People

Contributors

Stargazers

Watchers

concourse-sonarqube-notifier's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

test

checks failing with runtime error

I've just configured my pipeline with this resource and initial check have been failing with below runtime error. My concourse version is 7.4.0. Could you please provide some insight on this error

panic: runtime error: invalid memory address or nil pointer dereference
23:13:35
[signal SIGSEGV: segmentation violation code=0x1 addr=0x40 pc=0x6561db]
23:13:35

23:13:35
goroutine 1 [running]:
23:13:35
main.getVersions(0xc0000b60f0, 0x24, 0xc0000b60c0, 0x28, 0xc0000bc090, 0x18, 0x0, 0x0, 0x0, 0x0, ...)
23:13:35
	/concourse-sonarqube-notifier/assets/check/main/check.go:87 +0x2db
23:13:35
main.run(0x723e60, 0xc0000be000, 0x723e80, 0xc0000be008, 0x0, 0x0)
23:13:35
	/concourse-sonarqube-notifier/assets/check/main/check.go:51 +0x18f
23:13:35
main.main()
23:13:35
	/concourse-sonarqube-notifier/assets/check/main/check.go:32 +0x55
23:13:35

Recommend Projects