Skip to content

fix: add report summary and separate bootstrap function for using GUI #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pspurlock merged 1 commit into from
Jul 16, 2026
Merged

fix: add report summary and separate bootstrap function for using GUI #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions sonarqube/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,15 @@ require (
go.opentelemetry.io/otel/trace v1.43.0
)

require dagger.io/dagger v0.21.5-0.20260611000309-336f7b79a6df

require (
github.com/99designs/gqlgen v0.17.90 // indirect
github.com/adrg/xdg v0.5.3 // indirect
github.com/cenkalti/backoff/v5 v5.0.3 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/dagger/querybuilder v0.0.0-20260402040506-574a5e81cb59
github.com/go-logr/logr v1.4.3 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/grpc-ecosystem/grpc-gateway/v2 v2.28.0 // indirect
github.com/mitchellh/go-homedir v1.1.0 // indirect
github.com/sosodev/duration v1.4.0 // indirect
go.opentelemetry.io/auto/sdk v1.2.1 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc v0.17.0 // indirect
Expand Down
6 changes: 0 additions & 6 deletions sonarqube/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
dagger.io/dagger v0.21.5-0.20260611000309-336f7b79a6df h1:gSiY/B1ABiQBX7Igt8kRZA1dlKKW7zdutFEsppVw52s=
dagger.io/dagger v0.21.5-0.20260611000309-336f7b79a6df/go.mod h1:8hztpM9rKNjSmOa2nzd8ot6aw1RZFDWCawMfc5V9tXA=
github.com/99designs/gqlgen v0.17.90 h1:wSv6blm/PoplU6QoNw83EcQpNtC0HX3/+44vITJOzpk=
github.com/99designs/gqlgen v0.17.90/go.mod h1:GqYrEwYsqCG8VaOsq2kJUCUKwAE1T+u2i+Nj7NtXiVI=
github.com/Khan/genqlient v0.8.1 h1:wtOCc8N9rNynRLXN3k3CnfzheCUNKBcvXmVv5zt6WCs=
github.com/Khan/genqlient v0.8.1/go.mod h1:R2G6DzjBvCbhjsEajfRjbWdVglSH/73kSivC9TLWVjU=
github.com/adrg/xdg v0.5.3 h1:xRnxJXne7+oWDatRhR1JLnvuccuIeCoBu2rtuLqQB78=
github.com/adrg/xdg v0.5.3/go.mod h1:nlTsY+NNiCBGCK2tpm09vRqfVzrc2fLmXGpBLF0zlTQ=
github.com/agnivade/levenshtein v1.2.1 h1:EHBY3UOn1gwdy/VbFwgo4cxecRznFk7fKWN1KOX7eoM=
github.com/agnivade/levenshtein v1.2.1/go.mod h1:QVVI16kDrtSuwcpd0p1+xMC6Z/VfhtCyDIjcwga4/DU=
github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883 h1:bvNMNQO63//z+xNgfBlViaCIJKLlCJ6/fmUseuG0wVQ=
Expand Down Expand Up @@ -33,8 +29,6 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.28.0 h1:HWRh5R2+9EifMyIHV7ZV+MIZqgz+PMpZ14Jynv3O2Zs=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.28.0/go.mod h1:JfhWUomR1baixubs02l85lZYYOm7LV6om4ceouMv45c=
github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sergi/go-diff v1.3.1 h1:xkr+Oxo4BOQKmkn/B9eMK0g5Kg/983T9DqqPHwYqD+8=
Expand Down
270 changes: 206 additions & 64 deletions sonarqube/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"context"
"crypto/rand"
"dagger/sonarqube/internal/dagger"
"encoding/json"
"fmt"
"strings"
"time"
Expand Down Expand Up @@ -80,6 +81,28 @@ const pollScript = `
sleep 2 # Cooldown for index stabilization
`

type SonarIssue struct {
Key string `json:"key"`
Rule string `json:"rule"`
Severity string `json:"severity"`
Message string `json:"message"`
Component string `json:"component"`
Line int `json:"line"`
}

type SonarPage struct {
Issues []SonarIssue `json:"issues"`
}

type SonarServer struct {
// The live running service
Service *dagger.Service
// The generated user token used for running scans
SonarToken *dagger.Secret
// The plaintext admin password (for logging into the UI)
AdminToken *dagger.Secret
}

// start up sonar-server as a service
func (m *Sonarqube) Service() *dagger.Service {

Expand All @@ -103,103 +126,111 @@ func (m *Sonarqube) Service() *dagger.Service {
).AsService()
}

// scan a source directory with sonar-scanner and get a report from sonar-server
func (m *Sonarqube) Scan(ctx context.Context,
// +defaultPath="/"
src *dagger.Directory,
// comma separated list of impact severities to use when generating report
// +optional
// +default="MEDIUM,HIGH"
impactSeverities string) (*dagger.File, error) {
//start sonar-server
// starts sonar as a service and bootstraps it with an admin password, project, and sonar token for scanning
func (m *Sonarqube) Bootstrap(ctx context.Context) (*SonarServer, error) {

sonarSvc, err := m.Service().Start(ctx)

if err != nil {
return nil, fmt.Errorf("failed to start sonar service: %w", err)
}

// defer sonarSvc.Stop(ctx)

// change admin pw on first use
// generate admin PW for first use
adminToken := m.generateRandomTokenAsSecret()
adminPlaintext, err := adminToken.Plaintext(ctx)

//setup admin pw and project in sonar
// setup admin pw and project in sonar
if err := m.serverSetup(ctx, sonarSvc, adminToken); err != nil {
return nil, err
}

//generate sonar token
// generate sonar token
sonarToken, err := m.generateSonarToken(ctx, sonarSvc, adminToken)

// 5. Print out the login details for UI
fmt.Println("\n====================================================")
fmt.Println("🚀 SONARQUBE LOCAL ENGINE STARTED SUCCESSFULLY! 🚀")
fmt.Println("====================================================")
fmt.Println(" URL: http://localhost:9000")
fmt.Println(" Username: admin")
fmt.Printf(" Password: %s\n", adminPlaintext)
fmt.Println("====================================================")

return &SonarServer{
Service: sonarSvc,
SonarToken: sonarToken,
AdminToken: adminToken,
}, nil
}

// scan a source directory with sonar-scanner and get a report from sonar-server
func (m *Sonarqube) Scan(ctx context.Context,
// +defaultPath="/"
src *dagger.Directory,
// comma separated list of impact severities to use when generating report
// +optional
// +default="MEDIUM,HIGH"
impactSeverities string) (string, error) {
// // start sonar-server
// sonarSvc, err := m.Service().Start(ctx)

// if err != nil {
// return nil, fmt.Errorf("failed to start sonar service: %w", err)
// }

// // defer sonarSvc.Stop(ctx)

// // change admin pw on first use
// adminToken := m.generateRandomTokenAsSecret()

// // setup admin pw and project in sonar
// if err := m.serverSetup(ctx, sonarSvc, adminToken); err != nil {
// return nil, err
// }

// // generate sonar token
// sonarToken, err := m.generateSonarToken(ctx, sonarSvc, adminToken)

server, err := m.Bootstrap(ctx)
if err != nil {
return "", fmt.Errorf("failed to initialize sonarqube: %w", err)
}

// run sonar scan
_, err = dag.Container().
From("sonarsource/sonar-scanner-cli:latest").
WithServiceBinding("sonar-server", sonarSvc).
WithServiceBinding("sonar-server", server.Service).
WithDirectory("/src", src, dagger.ContainerWithDirectoryOpts{Owner: "scanner-cli"}).
WithWorkdir("/src").
WithSecretVariable("SONAR_TOKEN", sonarToken).
WithSecretVariable("SONAR_TOKEN", server.SonarToken).
WithEnvVariable("SONAR_HOST_URL", "http://sonar-server:9000").
WithEnvVariable("CACHEBUSTER", time.Now().String()).
WithExec([]string{
"sonar-scanner",
"-Dsonar.projectName=proj1",
"-Dsonar.projectKey=proj1",
"-Dsonar.qualitygate.wait=true",
}).Sync(ctx)

if err != nil {
return nil, fmt.Errorf("failed to run sonarqube scan: %w", err)
return "", fmt.Errorf("failed to run sonarqube scan: %w", err)
}

// get json report of issues
report := m.getReport(sonarSvc, sonarToken, impactSeverities)
report := m.getReport(server.Service, server.SonarToken, impactSeverities)

return report, nil
return m.AnalyzeSonarReport(ctx, report)
}

// generate random sonar admin pw and return as a secret
// generate random sonar admin pw that passes sonarqube pw requirements
func (m *Sonarqube) generateRandomTokenAsSecret() *dagger.Secret {
const (
lower = "abcdefghijklmnopqrstuvwxyz"
upper = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
numbers = "0123456789"
special = "!@#%"
all = lower + upper + numbers + special
)

b := make([]byte, 16)

// 1 guaranteed from each required set
b[0] = lower[m.randomInt(len(lower))]
b[1] = upper[m.randomInt(len(upper))]
b[2] = numbers[m.randomInt(len(numbers))]
b[3] = special[m.randomInt(len(special))]

// fill remaining with full charset
for i := 4; i < 16; i++ {
b[i] = all[m.randomInt(len(all))]
}

// shuffle so pattern isn't predictable
m.shuffle(b)

token := string(b)

return dag.SetSecret("SONAR_ADMIN_TOKEN", token)
}

// helper for token gen
func (m *Sonarqube) randomInt(max int) int {
b := make([]byte, 1)
b := make([]byte, 6)
_, _ = rand.Read(b)
return int(b[0]) % max
}

// helper for token gen
func (m *Sonarqube) shuffle(b []byte) {
for i := len(b) - 1; i > 0; i-- {
j := m.randomInt(i + 1)
b[i], b[j] = b[j], b[i]
}
// %x forces lowercase and numbers. "A!" guarantees uppercase and special char.
compliantPassword := fmt.Sprintf("A!%x", b)

return dag.SetSecret("SONAR_ADMIN_TOKEN", compliantPassword)
}

// base curl container for sonar api queries
Expand Down Expand Up @@ -230,8 +261,8 @@ func (m *Sonarqube) generateSonarToken(ctx context.Context, svc *dagger.Service,
func (m *Sonarqube) getReport(svc *dagger.Service, token *dagger.Secret, impactSeverities string) *dagger.File {

fetchScript := `
PAGE_SIZE=100
BASE_URL="http://sonar-server:9000/api/issues/search?components=proj1&impactSeverities=$IMPACT_SEVERITIES&ps=$PAGE_SIZE"
PAGE_SIZE=499
BASE_URL="http://sonar-server:9000/api/issues/search?components=proj1&additionalFields=comments&issueStatuses=OPEN,CONFIRMED&impactSeverities=$IMPACT_SEVERITIES&ps=$PAGE_SIZE"

echo "Fetching initial page..." >&2
first_page=$(curl -s --retry 5 --noproxy "*" -u "$SONAR_TOKEN:" "${BASE_URL}&p=1")
Expand Down Expand Up @@ -260,8 +291,6 @@ func (m *Sonarqube) getReport(svc *dagger.Service, token *dagger.Secret, impactS
WithSecretVariable("SONAR_TOKEN", token).
WithEnvVariable("IMPACT_SEVERITIES", impactSeverities).
WithEnvVariable("CACHEBUSTER", time.Now().String()).
// Wait for report generation to finish
WithExec([]string{"sh", "-c", pollScript}).
// Fetch report
WithExec([]string{"sh", "-c", fetchScript}, dagger.ContainerWithExecOpts{
RedirectStdout: "sonar-report.json",
Expand All @@ -287,3 +316,116 @@ func (m *Sonarqube) serverSetup(ctx context.Context, svc *dagger.Service, adminT

return nil
}

// Parses sonarqube JSON report into human readable format. Will return an error if issues are found HIGH or above.
func (m *Sonarqube) AnalyzeSonarReport(ctx context.Context, reportFile *dagger.File) (string, error) {
reportRaw, err := reportFile.Contents(ctx)
if err != nil {
return "", fmt.Errorf("failed to read sonar report file contents: %w", err)
}

var totalIssues int
var blockers, criticals, highs, mediums, lows []SonarIssue

seenIssues := make(map[string]bool)

categorizeIssue := func(issue SonarIssue) {
if seenIssues[issue.Key] {
return
}
seenIssues[issue.Key] = true
totalIssues++

switch strings.ToUpper(issue.Severity) {
case "BLOCKER":
blockers = append(blockers, issue)
case "CRITICAL":
criticals = append(criticals, issue)
case "HIGH", "MAJOR":
highs = append(highs, issue)
case "MEDIUM", "MINOR":
mediums = append(mediums, issue)
default:
lows = append(lows, issue)
}
}

trimmedRaw := strings.TrimSpace(reportRaw)
// Parse standard JSON and multi-line JSONL
var singlePage SonarPage
if err := json.Unmarshal([]byte(trimmedRaw), &singlePage); err == nil && len(singlePage.Issues) > 0 {
for _, issue := range singlePage.Issues {
categorizeIssue(issue)
}
} else {
lines := strings.Split(trimmedRaw, "\n")
for i, line := range lines {
trimmedLine := strings.TrimSpace(line)
if trimmedLine == "" {
continue
}

var page SonarPage
if err := json.Unmarshal([]byte(trimmedLine), &page); err != nil {
return "", fmt.Errorf("failed to parse JSON on line %d (verify format): %w", i+1, err)
}

for _, issue := range page.Issues {
categorizeIssue(issue)
}
}
}

failCount := len(blockers) + len(criticals) + len(highs)

// Use a strings.Builder to capture the entire report output
var report strings.Builder

fmt.Fprintf(&report, "\n=========================================\n")
fmt.Fprintf(&report, " SONARQUBE ANALYSIS SUMMARY \n")
fmt.Fprintf(&report, "=========================================\n")
fmt.Fprintf(&report, "Total Unique Issues Found: %d\n", totalIssues)
fmt.Fprintf(&report, "-----------------------------------------\n")
fmt.Fprintf(&report, " 🛑 BLOCKER: %d\n", len(blockers))
fmt.Fprintf(&report, " 💥 CRITICAL: %d\n", len(criticals))
fmt.Fprintf(&report, " ⚠️ HIGH: %d\n", len(highs))
fmt.Fprintf(&report, " 📝 MEDIUM: %d\n", len(mediums))
fmt.Fprintf(&report, " ℹ️ LOW: %d\n", len(lows))
fmt.Fprintf(&report, "=========================================\n")

// Helper closure to build categorized blocks
appendIssueGroup := func(title string, list []SonarIssue) {
if len(list) == 0 {
return
}
fmt.Fprintf(&report, "\n>>> %s ISSUES (%d) <<<\n", title, len(list))
for _, issue := range list {
fmt.Fprintf(&report, " - [KEY: %s]\n", issue.Key)
fmt.Fprintf(&report, " Component: %s (Line: %d)\n", issue.Component, issue.Line)
fmt.Fprintf(&report, " Message: %s\n\n", issue.Message)
}
}

appendIssueGroup("BLOCKER", blockers)
appendIssueGroup("CRITICAL", criticals)
appendIssueGroup("HIGH", highs)
appendIssueGroup("MEDIUM", mediums)

fmt.Fprintf(&report, "=========================================\n")

// return error and print report summary
if failCount > 0 {
// Output to standard out so it is captured in successful execution history if checked
// fmt.Print(report.String())

// Return the entire structured string inside the error.
return "", fmt.Errorf("%s\nQuality Gate Failed: Found %d blocking issue(s) (Blocker: %d, Critical: %d, High: %d)",
report.String(), failCount, len(blockers), len(criticals), len(highs))
}

successMsg := fmt.Sprintf("Success! Analyzed %d unique issues. Code quality thresholds passed.", totalIssues)
fmt.Println(report.String())
fmt.Println(successMsg)

return successMsg, nil
}
Loading