kosli attest sonar

Report a SonarQube attestation to an artifact or a trail in a Kosli flow.

Synopsis

kosli attest sonar [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]

Report a SonarQube attestation to an artifact or a trail in a Kosli flow.
Retrieves results for the specified scan from SonarQube Cloud or SonarQube Server and attests them to Kosli. The results are parsed to find the status of the project’s quality gate which is used to determine the attestation’s compliance status. Both branch scans and pull request scans are supported.

The scan to be retrieved can be specified in three ways:

1. (Default) Using metadata created by the Sonar scanner. By default this is located within a temporary .scannerwork folder in the repo base directory. If you have overriden the location of this folder by passing parameters to the Sonar scanner, or are running Kosli’s CLI locally outside the repo’s base directory, you can provide the correct path using the --sonar-working-dir flag. This metadata is generated by a specific scan, allowing Kosli to retrieve the results of that scan. If there are delays in the scan processing (either because the scanned project is very large, or because SonarQube is experiencing processing delays), it may happen that the scan results are not available by the time the attest sonar command is executed. In this case you can use the --max-wait flag to retry the command while waiting for the scan to be processed. This flag takes the maximum number of seconds to wait for the results to be available. The Kosli CLI will then attempt to retrieve the scan results until the maximum wait time is reached, with exponential backoff between retries. Once the results are available they are attested to Kosli as usual.

2. Providing the Sonar project key and either the revision or the pull-request ID of the scan (plus the SonarQube server URL if relevant). For branch scans: if running the Kosli CLI in some CI/CD pipeline, the revision is defaulted to the commit SHA. If you are running the command locally, or have overriden the revision in SonarQube via parameters to the Sonar scanner, you can provide the correct revision using the --sonar-revision flag. For pull request scans: provide the pull-request ID using the --pull-request flag instead of the revision. Kosli then finds the scan results for the specified project key and revision or pull-request ID.

3. Providing the CE task URL directly via --sonar-ce-task-url. The CE task URL can be found in the report-task.txt file generated by the Sonar scanner (the ceTaskUrl field). This is useful in CI/CD environments where the Sonar scanner and the Kosli CLI run in different containers that do not share a filesystem, making the report-task.txt file inaccessible to the CLI.

Note that if your project is very large and you are using SonarQube Cloud’s automatic analysis, it is possible for the attest sonar command to run before the SonarQube Cloud scan is completed. In this case, we recommend using Kosli’s Sonar webhook integration ( docs ) rather than the CLI to attest the scan results.

The attestation can be bound to a trail using the trail name. The attestation can be bound to an artifact in two ways:

• using the artifact’s SHA256 fingerprint which is calculated (based on the --artifact-type flag and the artifact name/path argument) or can be provided directly (with the --fingerprint flag).
• using the artifact’s name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

Flags

Flag	Description
--annotate stringToString	[optional] Annotate the attestation with data using key=value.
-t, --artifact-type string	The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don’t specify ‘--fingerprint’ on commands that allow it).
--attachments strings	[optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli’s evidence vault.
-g, --commit string	[conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: docs ).
--description string	[optional] attestation description
-D, --dry-run	[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors.
-x, --exclude strings	[optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for --artifact-type dir.
--external-fingerprint stringToString	[optional] A SHA256 fingerprint of an external attachment represented by --external-url. The format is label=fingerprint (labels cannot contain ’.’ or ’=’). This flag can be set multiple times. There must be an external url with a matching label for each external fingerprint.
--external-url stringToString	[optional] Add labeled reference URL for an external resource. The format is label=url (labels cannot contain ’.’ or ’=’). This flag can be set multiple times. If the resource is a file or dir, you can optionally add its fingerprint via --external-fingerprint
-F, --fingerprint string	[conditional] The SHA256 fingerprint of the artifact to attach the attestation to. Only required if the attestation is for an artifact and --artifact-type and artifact name/path are not used.
-f, --flow string	The Kosli flow name.
-h, --help	help for sonar
--max-wait int	[optional] Allow the command to wait and retry fetching the scan results from SonarQube, up to the maximum number of seconds provided, with exponential backoff. Useful when using SonarQube’s metadata file to retrieve and attest scans that take a long time to process . Defaults to 30 seconds. (default 30)
-n, --name string	The name of the attestation as declared in the flow or trail yaml template.
-o, --origin-url string	[optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: docs ).
--pull-request string	[conditional] The ID of the pull-request. Only required if you want to use the project key/pull-request to get the scan results rather than using Sonar’s metadata file. Cannot be used with --sonar-revision.
--redact-commit-info strings	[optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch].
--registry-password string	[conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry.
--registry-username string	[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry.
--repo-id string	[conditional] The stable, unique identifier for the repository in your VCS provider (e.g. a numeric ID). Do not use the repository name as it can change if the repo is renamed. All three of --repo-id, --repo-url and --repository must be set to record repository information (defaulted in some CIs: docs ).
--repo-provider string	[optional] The source code hosting provider. One of: github, gitlab, bitbucket, azure-devops (defaulted in some CIs: docs ).
--repo-root string	[defaulted] The directory where the source git repository is available. Only used if --commit is used or defaulted in CI, see docs . (default ”.”)
--repo-url string	[conditional] The URL of the repository. Must be a valid URL. All three of --repo-id, --repo-url and --repository must be set to record repository information (defaulted in some CIs: docs ).
--repository string	[conditional] The name of the repository (e.g. owner/repo-name). All three of --repo-id, --repo-url and --repository must be set to record repository information (defaulted in some CIs: docs ).
--sonar-api-token string	[required] SonarQube API token.
--sonar-ce-task-url string	[conditional] The URL of the SonarQube CE task. Can be used instead of --sonar-working-dir when the report-task.txt file is not accessible, e.g. due to container isolation in CI/CD pipelines.
--sonar-project-key string	[conditional] The project key of the SonarQube project. Only required if you want to use the project key/revision/pull-request to get the scan results rather than using Sonar’s metadata file.
--sonar-revision string	[conditional] The revision of the SonarQube project. Only required if you want to use the project key/revision to get the scan results rather than using Sonar’s metadata file and you have overridden the default revision, or you aren’t using a CI. Defaults to the value of the git commit flag. Cannot be used with --pull-request.
--sonar-server-url string	[conditional] The URL of your SonarQube server. Only required if you are using SonarQube Server and not using SonarQube’s metadata file to get scan results. (default “https://sonarcloud.io”)
--sonar-working-dir string	[conditional] The base directory of the repo scanned by SonarQube. Only required if you have overriden the default in the sonar scanner or you are running the CLI locally in a separate folder from the repo. (default “.scannerwork”)
-T, --trail string	The Kosli trail name.
-u, --user-data string	[optional] The path to a JSON file containing additional data you would like to attach to the attestation.

Flags inherited from parent commands

Flag	Description
-a, --api-token string	The Kosli API token.
-c, --config-file string	[optional] The Kosli config file path. (default “kosli”)
--debug	[optional] Print debug logs to stdout.
-H, --host string	[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
--http-proxy string	[optional] The HTTP proxy URL including protocol and port number. e.g. http://proxy-server-ip:proxy-port
-r, --max-api-retries int	[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
--org string	The Kosli organization.
-q, --quiet	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both --quiet and --debug are set, --debug wins.

Live Examples in different CI systems

GitHub

View an example of the kosli attest sonar command in GitHub.

In this YAML file, which created this Kosli Event.

Examples Use Cases

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.

report a SonarQube Cloud attestation about a trail using SonarQube's metadata, with no retries

kosli attest sonar 
	--name yourAttestationName 
	--sonar-api-token yourSonarAPIToken 
	--sonar-working-dir yourSonarWorkingDirPath 

report a SonarQube Server attestation about a trail using SonarQube's metadata, waiting for up to 60 seconds for the results to be available

kosli attest sonar 
	--name yourAttestationName 
	--sonar-api-token yourSonarAPIToken 
	--sonar-working-dir yourSonarWorkingDirPath 
	--max-wait 60

report a SonarQube Cloud attestation about a trail using key/revision

kosli attest sonar 
	--name yourAttestationName 
	--sonar-api-token yourSonarAPIToken 
	--sonar-project-key yourSonarProjectKey 
	--sonar-revision yourSonarRevision 

report a SonarQube Server attestation about a trail using key/revision

kosli attest sonar 
	--name yourAttestationName 
	--sonar-api-token yourSonarAPIToken 
	--sonar-server-url yourSonarServerURL 
	--sonar-project-key yourSonarProjectKey 
	--sonar-revision yourSonarRevision 

report a SonarQube Cloud attestation about a trail for a pull request scan using key/pull-request

kosli attest sonar 
	--name yourAttestationName 
	--sonar-api-token yourSonarAPIToken 
	--sonar-project-key yourSonarProjectKey 
	--pull-request yourPullRequestID 

report a SonarQube Cloud attestation about a trail with an attachment using SonarQube's metadata, waiting for up to 300 seconds for the results to be available

kosli attest sonar 
	--name yourAttestationName 
	--sonar-api-token yourSonarAPIToken 
	--sonar-working-dir yourSonarWorkingDirPath 
	--attachment yourAttachmentPath 
	--max-wait 300

report a SonarQube attestation using the CE task URL directly (useful when report-task.txt is not accessible)

kosli attest sonar 
	--name yourAttestationName 
	--sonar-api-token yourSonarAPIToken 
	--sonar-ce-task-url yourCETaskURL