From bcacd7b97a19deda003c3e7bf0c8fbdabbd39af7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez?= Date: Thu, 16 Jul 2026 21:08:21 -0600 Subject: [PATCH 1/3] Add shell plugin for SonarQube CLI --- plugins/sonarqube/cli_token.go | 47 +++++++++++++++ plugins/sonarqube/cli_token_test.go | 93 +++++++++++++++++++++++++++++ plugins/sonarqube/plugin.go | 22 +++++++ plugins/sonarqube/sonar_scanner.go | 30 ++++++++++ 4 files changed, 192 insertions(+) create mode 100644 plugins/sonarqube/cli_token.go create mode 100644 plugins/sonarqube/cli_token_test.go create mode 100644 plugins/sonarqube/plugin.go create mode 100644 plugins/sonarqube/sonar_scanner.go diff --git a/plugins/sonarqube/cli_token.go b/plugins/sonarqube/cli_token.go new file mode 100644 index 00000000..6c15fafc --- /dev/null +++ b/plugins/sonarqube/cli_token.go @@ -0,0 +1,47 @@ +package sonarqube + +import ( + "github.com/1Password/shell-plugins/sdk" + "github.com/1Password/shell-plugins/sdk/importer" + "github.com/1Password/shell-plugins/sdk/provision" + "github.com/1Password/shell-plugins/sdk/schema" + "github.com/1Password/shell-plugins/sdk/schema/credname" + "github.com/1Password/shell-plugins/sdk/schema/fieldname" +) + +func CLIToken() schema.CredentialType { + return schema.CredentialType{ + Name: credname.CLIToken, + DocsURL: sdk.URL("https://docs.sonarsource.com/sonarqube-cli/using-sonarqube-cli/environment-variables"), + ManagementURL: sdk.URL("https://sonarcloud.io/account/security"), + Fields: []schema.CredentialField{ + { + Name: fieldname.Token, + MarkdownDescription: "User token used to authenticate to SonarQube CLI.", + Secret: true, + }, + { + Name: fieldname.Organization, + MarkdownDescription: "SonarQube Cloud organization key. Use together with the token to authenticate to SonarQube Cloud.", + Secret: false, + Optional: true, + }, + { + Name: fieldname.URL, + MarkdownDescription: "Server URL. Use together with the token to authenticate to a self-hosted SonarQube instance or a specific SonarQube Cloud region.", + Secret: false, + Optional: true, + }, + }, + DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping), + Importer: importer.TryAll( + importer.TryEnvVarPair(defaultEnvVarMapping), + ), + } +} + +var defaultEnvVarMapping = map[string]sdk.FieldName{ + "SONARQUBE_CLI_TOKEN": fieldname.Token, + "SONARQUBE_CLI_ORG": fieldname.Organization, + "SONARQUBE_CLI_SERVER": fieldname.URL, +} diff --git a/plugins/sonarqube/cli_token_test.go b/plugins/sonarqube/cli_token_test.go new file mode 100644 index 00000000..7bbfa3a4 --- /dev/null +++ b/plugins/sonarqube/cli_token_test.go @@ -0,0 +1,93 @@ +package sonarqube + +import ( + "testing" + + "github.com/1Password/shell-plugins/sdk" + "github.com/1Password/shell-plugins/sdk/plugintest" + "github.com/1Password/shell-plugins/sdk/schema/fieldname" +) + +func TestCLITokenImporter(t *testing.T) { + plugintest.TestImporter(t, CLIToken().Importer, map[string]plugintest.ImportCase{ + "token only": { + Environment: map[string]string{ + "SONARQUBE_CLI_TOKEN": "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + }, + ExpectedCandidates: []sdk.ImportCandidate{ + { + Fields: map[sdk.FieldName]string{ + fieldname.Token: "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + }, + }, + }, + }, + "token with organization": { + Environment: map[string]string{ + "SONARQUBE_CLI_TOKEN": "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + "SONARQUBE_CLI_ORG": "my-org", + }, + ExpectedCandidates: []sdk.ImportCandidate{ + { + Fields: map[sdk.FieldName]string{ + fieldname.Token: "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + fieldname.Organization: "my-org", + }, + }, + }, + }, + "token with server": { + Environment: map[string]string{ + "SONARQUBE_CLI_TOKEN": "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + "SONARQUBE_CLI_SERVER": "https://sonarqube.example.com", + }, + ExpectedCandidates: []sdk.ImportCandidate{ + { + Fields: map[sdk.FieldName]string{ + fieldname.Token: "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + fieldname.URL: "https://sonarqube.example.com", + }, + }, + }, + }, + }) +} + +func TestCLITokenProvisioner(t *testing.T) { + plugintest.TestProvisioner(t, CLIToken().DefaultProvisioner, map[string]plugintest.ProvisionCase{ + "token only": { + ItemFields: map[sdk.FieldName]string{ + fieldname.Token: "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + }, + ExpectedOutput: sdk.ProvisionOutput{ + Environment: map[string]string{ + "SONARQUBE_CLI_TOKEN": "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + }, + }, + }, + "token with organization": { + ItemFields: map[sdk.FieldName]string{ + fieldname.Token: "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + fieldname.Organization: "my-org", + }, + ExpectedOutput: sdk.ProvisionOutput{ + Environment: map[string]string{ + "SONARQUBE_CLI_TOKEN": "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + "SONARQUBE_CLI_ORG": "my-org", + }, + }, + }, + "token with server": { + ItemFields: map[sdk.FieldName]string{ + fieldname.Token: "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + fieldname.URL: "https://sonarqube.example.com", + }, + ExpectedOutput: sdk.ProvisionOutput{ + Environment: map[string]string{ + "SONARQUBE_CLI_TOKEN": "sqp_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2", + "SONARQUBE_CLI_SERVER": "https://sonarqube.example.com", + }, + }, + }, + }) +} diff --git a/plugins/sonarqube/plugin.go b/plugins/sonarqube/plugin.go new file mode 100644 index 00000000..e48a5a0e --- /dev/null +++ b/plugins/sonarqube/plugin.go @@ -0,0 +1,22 @@ +package sonarqube + +import ( + "github.com/1Password/shell-plugins/sdk" + "github.com/1Password/shell-plugins/sdk/schema" +) + +func New() schema.Plugin { + return schema.Plugin{ + Name: "sonarqube", + Platform: schema.PlatformInfo{ + Name: "SonarQube CLI", + Homepage: sdk.URL("https://docs.sonarsource.com/sonarqube-cli/"), + }, + Credentials: []schema.CredentialType{ + CLIToken(), + }, + Executables: []schema.Executable{ + SonarScannerCLI(), + }, + } +} diff --git a/plugins/sonarqube/sonar_scanner.go b/plugins/sonarqube/sonar_scanner.go new file mode 100644 index 00000000..16923904 --- /dev/null +++ b/plugins/sonarqube/sonar_scanner.go @@ -0,0 +1,30 @@ +package sonarqube + +import ( + "github.com/1Password/shell-plugins/sdk" + "github.com/1Password/shell-plugins/sdk/needsauth" + "github.com/1Password/shell-plugins/sdk/schema" + "github.com/1Password/shell-plugins/sdk/schema/credname" +) + +func SonarScannerCLI() schema.Executable { + return schema.Executable{ + Name: "SonarQube CLI", + Runs: []string{"sonar"}, + DocsURL: sdk.URL("https://docs.sonarsource.com/sonarqube-cli/"), + NeedsAuth: needsauth.IfAll( + needsauth.NotForHelpOrVersion(), + needsauth.NotWithoutArgs(), + needsauth.NotForExactArgs("auth", "login"), + needsauth.NotForExactArgs("auth", "logout"), + needsauth.NotWhenContainsArgs("config", "telemetry"), + needsauth.NotWhenContainsArgs("system",), + needsauth.NotWhenContainsArgs("self-update"), + ), + Uses: []schema.CredentialUsage{ + { + Name: credname.CLIToken, + }, + }, + } +} From d6c202b2c67287df04e7b92d0a1e43838dd33810 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez?= Date: Thu, 16 Jul 2026 21:09:57 -0600 Subject: [PATCH 2/3] fix: remove trailing comma in sonar_scanner.go NeedsAuth args Co-Authored-By: Claude Sonnet 4.6 --- plugins/sonarqube/sonar_scanner.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/sonarqube/sonar_scanner.go b/plugins/sonarqube/sonar_scanner.go index 16923904..19275378 100644 --- a/plugins/sonarqube/sonar_scanner.go +++ b/plugins/sonarqube/sonar_scanner.go @@ -18,7 +18,7 @@ func SonarScannerCLI() schema.Executable { needsauth.NotForExactArgs("auth", "login"), needsauth.NotForExactArgs("auth", "logout"), needsauth.NotWhenContainsArgs("config", "telemetry"), - needsauth.NotWhenContainsArgs("system",), + needsauth.NotWhenContainsArgs("system"), needsauth.NotWhenContainsArgs("self-update"), ), Uses: []schema.CredentialUsage{ From 7662adfbf884753a36116de222aa31388da3df06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez?= Date: Thu, 16 Jul 2026 21:31:23 -0600 Subject: [PATCH 3/3] Fix comments --- plugins/sonarqube/plugin.go | 2 +- plugins/sonarqube/{sonar_scanner.go => sonarqube.go} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename plugins/sonarqube/{sonar_scanner.go => sonarqube.go} (94%) diff --git a/plugins/sonarqube/plugin.go b/plugins/sonarqube/plugin.go index e48a5a0e..1e4be803 100644 --- a/plugins/sonarqube/plugin.go +++ b/plugins/sonarqube/plugin.go @@ -16,7 +16,7 @@ func New() schema.Plugin { CLIToken(), }, Executables: []schema.Executable{ - SonarScannerCLI(), + SonarQubeCLI(), }, } } diff --git a/plugins/sonarqube/sonar_scanner.go b/plugins/sonarqube/sonarqube.go similarity index 94% rename from plugins/sonarqube/sonar_scanner.go rename to plugins/sonarqube/sonarqube.go index 19275378..7b585e0d 100644 --- a/plugins/sonarqube/sonar_scanner.go +++ b/plugins/sonarqube/sonarqube.go @@ -7,7 +7,7 @@ import ( "github.com/1Password/shell-plugins/sdk/schema/credname" ) -func SonarScannerCLI() schema.Executable { +func SonarQubeCLI() schema.Executable { return schema.Executable{ Name: "SonarQube CLI", Runs: []string{"sonar"},