CI Migration: Backport pkg/build (daggerbuild) and GHAs to release-12.0.3 (#107997)

* CI: move grafana-build into pkg/build (#105640)

* move grafana-build into pkg/build

* Update go.mod/go.sum files after cherry-pick build

- Updates from workspace sync after cherry-picking daggerbuild package
- Resolves dependency conflicts from pkg/build integration
- Required for successful build after CI migration backport

* CI Migration: Replace .github with main branch version

- Complete replacement of .github directory from main branch
- Includes updated workflows, actions, and configuration files
- Ensures all CI improvements from main are included
- Next step: fix branch-specific issues in separate commits

* Fix branch triggers: Update workflows to target release branches

- Update 8 workflows to trigger on release-* instead of main
- Ensures workflows run on pull requests to release branches
- Workflows updated: documentation-ci, pr-codeql-analysis-*, pr-dependabot-update-go-workspace, pr-go-workspace-check, pr-k8s-codegen-check, verify-kinds, codeowners-validator

* Fix branch triggers: Update workflows to target both main and release branches

- CORRECTED: Include both main and release-* branch patterns
- Ensures workflows run on both main branch (original functionality) and release branches (needed for backport)
- Previous commit incorrectly removed main branch support
- Workflows updated: documentation-ci, pr-codeql-analysis-*, pr-dependabot-update-go-workspace, pr-go-workspace-check, pr-k8s-codegen-check, verify-kinds, codeowners-validator

* CI Migration: Update .gitignore to allow OSS wire file to be committed

- Remove **/wire_gen.go (allow pkg/server/wire_gen.go to be committed)
- Add /pkg/server/enterprise_wire_gen.go (keep enterprise wire file ignored)
- This enables the new committed wire files architecture for CI

* CI Migration: Add enhanced wire tool with automatic build constraints

- Backport enhanced wire tool from main branch with -gen_tags flag
- This enables automatic regeneration with proper constraints to prevent conflicts
- Wire file contains all required functions: Initialize, InitializeDocumentBuilders, etc.
- Solves the missing wire functions issue causing CI failures
- Enhanced tool ensures build constraints persist on regeneration

* CI Migration: Update Makefile to use enhanced wire tool with build constraints

- Update gen-go target to use -gen_tags flag for automatic build constraints
- Ensures future engineers get proper build constraints when running 'make gen-go'
- Matches main branch approach for consistent wire file generation
- Removes dependency on WIRE_TAGS variable and GO_RACE_FLAG for simplicity

* Add gen-enterprise-go target to Makefile for release-12.0.3

- Backports gen-enterprise-go target from main branch
- Enables enterprise wire file generation in release branches
- Part of CI migration backport wire infrastructure fixes
- Resolves CI issues where enterprise wire functions were missing

* Fix wire tool golden file format for Drone CI compatibility

- Update all 43 golden test files to match main branch format
- Change go:generate command from github.com/google/wire/cmd/wire to ./pkg/build/wire/cmd/wire/main.go
- Remove legacy '// +build !wireinject' constraints
- Fixes Drone CI test failures that were blocking OSS PR merge
- All wire tests now pass successfully

This aligns the backport branch with the golden file format updates
that were made in main branch when the wire tool was enhanced.

* Update swagger specs to include enterprise APIs

- Regenerated api-enterprise-spec.json with enterprise API definitions
- Updated api-merged.json with merged OSS and enterprise specs
- Regenerated openapi3.json with complete API specifications
- Fixes enterprise CI swagger generation validation failures
- Enterprise APIs now properly detected and documented

* Fix OSS integration tests missing enterprise build tags in Drone CI

- Add -tags=enterprise to all integration test steps in lib.star
- Fixes test-backend-integration, postgres-integration-tests, and mysql-integration-tests
- Regenerate .drone.yml with proper enterprise build tags
- Resolves 'server could not find the requested resource' errors for enterprise APIs
- Ensures enterprise APIs (querylibrary, reporting, banners, scim) are registered during tests
- Aligns OSS Drone CI with GitHub Actions behavior and enterprise repository

* Fix CODEOWNERS for release-12.0.3 compatibility

- Remove 21 entries that reference files/directories not present in release branch
- Resolves File Exist Checker failures in codeowners-validator workflow
- Maintains team ownership assignments from main branch for existing files
- Lines removed: .air.toml, apps/secret/, apps/iam/, e2e-playwright/, packages/grafana-alerting/, etc.

* baldm0mma/ update releasefinder

* Add i18n-extract script for release branch compatibility

- Add 'i18n-extract': 'make i18n-extract' to package.json scripts
- Resolves i18n-verify workflow failure that expects this script
- The make target already exists and handles OSS + enterprise i18n extraction
- Maintains i18n verification functionality from main branch workflows
- Simple safe addition that calls existing make infrastructure

* Phase 4: Fix GitHub Actions workflow branch triggers

- Add release-*.*.* pattern to 8 workflows missing it
- Fix duplicate release branch patterns in 3 workflows
- Ensure consistent branch trigger format across all workflows
- Critical workflows now properly trigger on release branches

Fixes workflows: actionlint, backend-code-checks, go-lint, reject-gh-secrets,
run-schema-v2-e2e, shellcheck, swagger-gen, trivy-scan

* Fix: Backport E2E runner infrastructure for Enterprise CI

- Add e2e/main.go and e2e/internal/ directory from main branch
- Add urfave/cli/v3 dependency required by E2E runner
- Fixes Enterprise CI failure: 'Build E2E test runner' and 'Build & package Grafana for e2e tests'
- Root cause: E2E runner infrastructure was added to main after release-12.0.3 branch creation
- Solution: Backport missing E2E runner files to enable Enterprise CI completion

Resolves: no Go files in /opt/actions-runner/_work/grafana-enterprise/grafana-enterprise/grafana/e2e

* Fix: Update go.mod dependency classification for urfave/cli/v3

- Change urfave/cli/v3 from indirect to direct dependency
- Fixes Go Workspace Check failure in CI
- Required after adding E2E runner infrastructure that directly imports urfave/cli/v3
- Resolves: make update-workspace corrects dependency classification

* Fix: Add team ownership for urfave/cli/v3 dependency

- Assign @grafana/grafana-backend-group as owner for github.com/urfave/cli/v3@v3.3.8
- Follows existing pattern: urfave/cli v1 and v2 also owned by grafana-backend-group
- Resolves Backend Code Checks / Validate Backend Configs CI failure
- Required for E2E runner infrastructure dependency ownership compliance

Fixes: modowners check requiring team assignment for newly added dependencies

* Fix: Revert experimental E2E playwright infrastructure to stable version

- Revert pr-e2e-tests.yml to stable Cypress-based E2E testing
- Remove experimental storybook-verification-playwright.yml workflow
- Revert run-dashboard-search-e2e.yml and release-pr.yml to use e2e/test-plugins/
- Keep stable E2E runner infrastructure (e2e/main.go + e2e/internal/)
- Remove experimental playwright features per team recommendation

Team feedback: Playwright tests are experimental and shouldn't be backported to stable release branches

* Fix: Complete cleanup of experimental playwright dependencies

- Revert package.json to stable version (remove e2e-playwright scripts and path references)
- Revert playwright.config.ts to stable plugin-e2e configuration
- Remove all experimental playwright infrastructure dependencies
- Ensure clean stable E2E testing environment

All experimental features removed per team recommendation for stable release branches

* Fix: Restore working package.json configuration

- Revert package.json to version 12.0.3 (working release branch version)
- Fix workspace dependency resolution issues caused by incorrect revert to main branch version
- FE tests, betterer, and linting should now work correctly

Issue was caused by reverting package.json to main branch (12.1.0-pre) instead of keeping
the working release branch configuration (12.0.3)

* CI: mirror some CI dependencies (#106148)

* mirror some CI dependencies
* remove -v from go build

* Fix: Backport missing e2e/run-suite script for daggerbuild E2E system

The daggerbuild E2E system (used by OSS workflows) expects ./e2e/run-suite
to exist, but we only backported the new E2E runner infrastructure.

This script is needed for:
- OSS workflow: 'go run ./pkg/build/e2e --suite=dashboards-suite'
- Legacy Cypress configuration with video support
- Integration between daggerbuild and existing Cypress test suites

Resolves E2E test failures in OSS workflows where videos directory
cannot be found because run-suite script was missing.

* Fix: Resolve daggerbuild E2E path doubling issue

- Extract just suite name from full path using filepath.Base()
- Prevents doubled paths like './e2e/e2e/dashboards-suite/videos'
- Resolves 'no spec files found' and 'no such file or directory' errors
- GitHub Actions passes full paths like 'e2e/dashboards-suite' but run-suite script expects just 'dashboards-suite'

* Infrastructure: Wholesale copy pkg/build/ from main

COMPLETE DAGGERBUILD SYSTEM UPDATE:
- Modern E2E system with CLI framework and --flags support
- New accessibility testing system (a11y/)
- New Playwright E2E testing system (e2e-playwright/)
- External infrastructure improvements (musl.cc → dl.grafana.com/ci)
- Updated daggerbuild core components with latest fixes
- Updated Go dependencies and wire modules

ARCHITECTURAL COMPATIBILITY VERIFIED:
- Modern pkg/build calls: ./e2e-runner cypress --start-grafana=false --cypress-video
- Our e2e runner supports: All required parameters including --suite, --env flags
- GitHub Actions workflows: Pass compatible arguments
- Binary builds: Successfully creates working e2e-runner

RESOLVES ISSUES:
- Fixes --flags parameter compatibility with GitHub Actions
- Includes all follow-up infrastructure improvements
- Provides complete, tested system with modern CLI framework
- Eliminates external dependency failures (musl.cc timeouts)
- Removes need for path doubling workarounds (modern system handles full paths correctly)

Replaces incremental cherry-picking with complete, tested system from main.

* Dependencies: Update Go modules after pkg/build wholesale copy

DEPENDENCY UPDATES:
- Updated go.work.sum with new dependencies from modern pkg/build system
- Updated all workspace module dependencies (go.mod/go.sum files)
- Removed pkg/build/cmd/enterprise.go (enterprise-only file, gets copied during enterprise development)

ENTERPRISE INTEGRATION FIX:
- enterprise.go file doesn't belong in OSS repository
- Gets copied from grafana-enterprise during development mode
- Main branch doesn't have this file, explaining module compatibility

All Go modules now properly resolved and compatible with modern pkg/build architecture.

* Dependencies: Update workspace Go module checksums after pkg/build wholesale copy

- Synchronizes all go.sum files across workspace modules
- Adds missing .mod.h1 entries that were required after infrastructure update
- Resolves Go Workspace Check CI failures
- Updates 22 modules: .citools/, apps/, pkg/ subdirectories plus go.work.sum

Addresses CI error: 'Please run make update-workspace and commit the changes'

* Infrastructure: Revert to pre-Playwright E2E system for release branch compatibility

Strategic combination of modern daggerbuild with stable E2E infrastructure:

**Modern Daggerbuild (from main):**
- Latest CLI framework (github.com/urfave/cli/v3)
- External infrastructure fixes (musl.cc → dl.grafana.com/ci)
- Complete pkg/build/ system with all enhancements
- Updated dependencies and architecture improvements

**Stable E2E Infrastructure (pre-Playwright):**
- pkg/build/e2e/service.go: Reverted to version before commit b6580ccb10
- pkg/build/a11y/: Reverted to stable version compatible with existing infrastructure
- Removed experimental pkg/build/e2e-playwright/ system
- Removed experimental e2e-playwright/ test infrastructure

**Why This Approach:**
- GitHub Actions workflows call 'go run ./pkg/build/e2e' (modern system)
- Modern system now expects only standard e2e/ directory (compatible)
- Release branches have standard e2e/ infrastructure (dashboards-suite, various-suite, etc.)
- Eliminates dependency on experimental Playwright infrastructure

**Key Dependencies Met:**
- e2e/pa11yci.conf.js: Added for a11y test compatibility
- /src/e2e directory: Standard directory structure (no e2e-playwright needed)
- Existing test plugins: Uses stable e2e/test-plugins/

**Result:**
Best of both worlds - modern, reliable daggerbuild infrastructure with
proven E2E testing that works across all release branches without
requiring experimental dependencies.

* Fix: Remove unused embed.go file causing golangci-lint failure

- Removes pkg/build/daggerbuild/msi/embed.go with unused embed.FS variable
- MSI build process uses directory mounting instead of embedded filesystem
- Resolves 'var resources is unused (unused)' linting error

* Fix: Update Node.js version to match working E2E configuration

- Changes from v22.11.0 to v22.16.0 to match commit 17952d45e4
- Working commit had all E2E tests passing with same daggerbuild infrastructure
- Node.js version differences can affect frontend builds and UI rendering
- Ensures consistent environment between working reference and current branch

* Fix: Use conditional container base for E2E compatibility

- Alpine for OSS tests (better old arch dashboardScene=false compatibility)
- Ubuntu for Enterprise tests (when image renderer needed)
- Restores original release-12.0.3 Alpine behavior for OSS
- Should resolve old arch E2E test failures

* Fix: Go fmt formatting for conditional container logic

* Revert: Remove unnecessary Alpine/Ubuntu conditional logic

- Real issue was wrong environment variable name (dashboardScene vs DISABLE_SCENES)
- Keep Ubuntu base (original main branch behavior) for simplicity
- Container base was not the root cause of old arch failures

* Experiment: Copy scripts/ from pre-Playwright commit (ea0ddb3fc9)

- Copied scripts directory from commit ea0ddb3fc9 (just before Playwright migration)
- This overwrites some CI migration fixes but testing if it's actually needed
- Can revert back to b9b4602dbd if CI breaks

Test commit to see real impact on GitHub Actions workflows.

* trigger ci 01

* Fix: Copy .drone.star from main to match scripts structure

- Resolves Starlark evaluation error for missing integration_test_pipelines
- Aligns .drone.star with main branch scripts structure
- Same fix applied to both OSS and Enterprise repositories

* make drone

* Fix ARM/v7 Docker build failures by using dagger run for cross-compilation

- Change artifacts_cmd() in scripts/drone/steps/rgm.star to use 'dagger run go run' instead of 'go run'
- Add --max-execution-steps 100000 to make drone target in Makefile to properly regenerate .drone.yml
- This fixes CGO cross-compilation issues with SQLite for ARM/v7 Docker builds
- Matches the approach already used successfully in Enterprise builds

* Fix Docker base image references in rgm build steps

- Change from symbolic names (alpine-base, ubuntu-base) to actual Docker images
- alpine-base → alpine:3.21.3
- ubuntu-base → ubuntu:22.04
- Add ubuntu and alpine parameters to rgm_artifacts_step and rgm_build_docker_step functions
- Fixes Docker pull errors: 'repository does not exist or may require authorization'
- Aligns OSS configuration with Enterprise approach

---------

Co-authored-by: Kevin Minehart <5140827+kminehart@users.noreply.github.com>
This commit is contained in:
Jev Forsberg
2025-07-18 09:14:14 -06:00
committed by GitHub
co-authored by Kevin Minehart
parent aee6b20c7f
commit dc6bd2a20a
432 changed files with 24660 additions and 16787 deletions
+94
View File
@@ -0,0 +1,94 @@
package backend
import (
"fmt"
"log"
"path"
"strings"
"dagger.io/dagger"
)
type LDFlag struct {
Name string
Values []string
}
func GoLDFlags(flags []LDFlag) string {
ldflags := strings.Builder{}
for _, v := range flags {
if v.Values == nil {
ldflags.WriteString(v.Name + " ")
continue
}
for _, value := range v.Values {
// For example, "-X 'main.version=v1.0.0'"
ldflags.WriteString(fmt.Sprintf(`%s \"%s\" `, v.Name, value))
}
}
return ldflags.String()
}
// GoBuildCommand returns the arguments for go build to be used in 'WithExec'.
func GoBuildCommand(output string, ldflags []LDFlag, tags []string, main string) []string {
args := []string{"go", "build",
fmt.Sprintf("-ldflags=\"%s\"", GoLDFlags(ldflags)),
fmt.Sprintf("-o=%s", output),
"-trimpath",
fmt.Sprintf("-tags=%s", strings.Join(tags, ",")),
// Go is weird and paths referring to packages within a module to be prefixed with "./".
// Otherwise, the path is assumed to be relative to $GOROOT
"./" + main,
}
return args
}
func Build(
d *dagger.Client,
builder *dagger.Container,
src *dagger.Directory,
distro Distribution,
out string,
opts *BuildOpts,
) *dagger.Directory {
vcsinfo := GetVCSInfo(src, opts.Version, opts.Enterprise)
builder = WithVCSInfo(builder, vcsinfo, opts.Enterprise)
ldflags := LDFlagsDynamic(vcsinfo)
if opts.Static {
ldflags = LDFlagsStatic(vcsinfo)
}
cmd := []string{
"grafana",
"grafana-server",
"grafana-cli",
"grafana-example-apiserver",
}
os, _ := OSAndArch(distro)
for _, v := range cmd {
// Some CLI packages such as grafana-example-apiserver don't exist in earlier Grafana Versions <10.3
// Below check skips building them as needed
pkgPath := path.Join("pkg", "cmd", v)
out := path.Join(out, v)
if os == "windows" {
out += ".exe"
}
cmd := GoBuildCommand(out, ldflags, opts.Tags, pkgPath)
script := fmt.Sprintf(`if [ -d %s ]; then %s; fi`, pkgPath, strings.Join(cmd, " "))
log.Printf("Building with command '%s'", script)
builder = builder.
WithExec([]string{"/bin/sh", "-c", script})
}
return builder.Directory(out)
}
+202
View File
@@ -0,0 +1,202 @@
package backend
import (
"errors"
"fmt"
"log/slog"
"dagger.io/dagger"
"github.com/grafana/grafana/pkg/build/daggerbuild/containers"
"github.com/grafana/grafana/pkg/build/daggerbuild/golang"
)
// BuildOpts are general options that can change the way Grafana is compiled regardless of distribution.
type BuildOpts struct {
Version string
ExperimentalFlags []string
Tags []string
WireTag string
GoCacheProg string
Static bool
Enterprise bool
}
func distroOptsFunc(log *slog.Logger, distro Distribution) (DistroBuildOptsFunc, error) {
if val, ok := DistributionGoOpts[distro]; ok {
return DistroOptsLogger(log, val), nil
}
return nil, errors.New("unrecognized distribution")
}
func WithGoEnv(log *slog.Logger, container *dagger.Container, distro Distribution, opts *BuildOpts) (*dagger.Container, error) {
fn, err := distroOptsFunc(log, distro)
if err != nil {
return nil, err
}
bopts := fn(distro, opts.ExperimentalFlags, opts.Tags)
return containers.WithEnv(container, GoBuildEnv(bopts)), nil
}
func WithViceroyEnv(log *slog.Logger, container *dagger.Container, distro Distribution, opts *BuildOpts) (*dagger.Container, error) {
fn, err := distroOptsFunc(log, distro)
if err != nil {
return nil, err
}
bopts := fn(distro, opts.ExperimentalFlags, opts.Tags)
return containers.WithEnv(container, ViceroyEnv(bopts)), nil
}
func ViceroyContainer(
d *dagger.Client,
log *slog.Logger,
distro Distribution,
goVersion string,
viceroyVersion string,
opts *BuildOpts,
) (*dagger.Container, error) {
containerOpts := dagger.ContainerOpts{
Platform: "linux/amd64",
}
// Instead of directly using the `arch` variable here to substitute in the GoURL, we have to be careful with the Go releases.
// Supported releases (in the names):
// * amd64
// * armv6l
// * arm64
goURL := golang.DownloadURL(goVersion, "amd64")
container := d.Container(containerOpts).From(fmt.Sprintf("rfratto/viceroy:%s", viceroyVersion))
// Install Go manually, and install make, git, and curl from the package manager.
container = container.WithExec([]string{"apt-get", "update"}).
WithExec([]string{"apt-get", "install", "-yq", "curl", "make", "git"}).
WithExec([]string{"/bin/sh", "-c", fmt.Sprintf("curl -L %s | tar -C /usr/local -xzf -", goURL)}).
WithEnvVariable("PATH", "/bin:/usr/bin:/usr/local/bin:/usr/local/go/bin:/usr/osxcross/bin")
return WithViceroyEnv(log, container, distro, opts)
}
func GolangContainer(
d *dagger.Client,
log *slog.Logger,
goVersion string,
viceroyVersion string,
platform dagger.Platform,
distro Distribution,
opts *BuildOpts,
) (*dagger.Container, error) {
os, _ := OSAndArch(distro)
// Only use viceroy for all darwin and only windows/amd64
if os == "darwin" || distro == DistWindowsAMD64 {
return ViceroyContainer(d, log, distro, goVersion, viceroyVersion, opts)
}
container := golang.Container(d, platform, goVersion).
WithExec([]string{"apk", "add", "--update", "wget", "build-base", "alpine-sdk", "musl", "musl-dev", "xz"}).
WithExec([]string{"wget", "-q", "https://dl.grafana.com/ci/zig-linux-x86_64-0.11.0.tar.xz"}).
WithExec([]string{"tar", "--strip-components=1", "-C", "/", "-xf", "zig-linux-x86_64-0.11.0.tar.xz"}).
WithExec([]string{"mv", "/zig", "/bin/zig"}).
// Install the toolchain specifically for armv7 until we figure out why it's crashing w/ zig container = container.
WithExec([]string{"mkdir", "/toolchain"}).
WithExec([]string{"wget", "-q", "http://dl.grafana.com/ci/arm-linux-musleabihf-cross.tgz", "-P", "/toolchain"}).
WithExec([]string{"tar", "-xf", "/toolchain/arm-linux-musleabihf-cross.tgz", "-C", "/toolchain"}).
WithExec([]string{"wget", "-q", "https://dl.grafana.com/ci/s390x-linux-musl-cross.tgz", "-P", "/toolchain"}).
WithExec([]string{"tar", "-xf", "/toolchain/s390x-linux-musl-cross.tgz", "-C", "/toolchain"})
return WithGoEnv(log, container, distro, opts)
}
func withCue(c *dagger.Container, src *dagger.Directory) *dagger.Container {
return c.
WithDirectory("/src/cue.mod", src.Directory("cue.mod")).
WithDirectory("/src/kinds", src.Directory("kinds")).
WithDirectory("/src/packages/grafana-schema", src.Directory("packages/grafana-schema"), dagger.ContainerWithDirectoryOpts{
Include: []string{"**/*.cue"},
}).
WithDirectory("/src/public/app/plugins", src.Directory("public/app/plugins"), dagger.ContainerWithDirectoryOpts{
Include: []string{"**/*.cue", "**/plugin.json"},
}).
WithFile("/src/embed.go", src.File("embed.go"))
}
// Builder returns the container that is used to build the Grafana backend binaries.
// The build container:
// * Will be based on rfratto/viceroy for Darwin or Windows
// * Will be based on golang:x.y.z-alpine for all other ditsros
// * Will download & cache the downloaded Go modules
// * Will run `make gen-go` on the provided Grafana source
// - With the linux/amd64 arch/os combination, regardless of what the requested distro is.
//
// * And will have all of the environment variables necessary to run `go build`.
func Builder(
d *dagger.Client,
log *slog.Logger,
distro Distribution,
opts *BuildOpts,
platform dagger.Platform,
src *dagger.Directory,
goVersion string,
viceroyVersion string,
goBuildCache *dagger.CacheVolume,
goModCache *dagger.CacheVolume,
) (*dagger.Container, error) {
var (
version = opts.Version
)
// for some distros we use the golang official iamge. For others, we use viceroy.
builder, err := GolangContainer(d, log, goVersion, viceroyVersion, platform, distro, opts)
if err != nil {
return nil, err
}
builder = builder.
WithMountedCache("/root/.cache/go", goBuildCache).
WithEnvVariable("GOCACHE", "/root/.cache/go")
if prog := opts.GoCacheProg; prog != "" {
builder = builder.WithEnvVariable("GOCACHEPROG", prog)
}
commitInfo := GetVCSInfo(src, version, opts.Enterprise)
builder = withCue(builder, src).
WithDirectory("/src/", src, dagger.ContainerWithDirectoryOpts{
Include: []string{"**/*.mod", "**/*.sum", "**/*.work", ".git"},
}).
WithDirectory("/src/pkg", src.WithoutDirectory("pkg/build").Directory("pkg")).
WithDirectory("/src/apps", src.Directory("apps")).
WithDirectory("/src/emails", src.Directory("emails")).
WithFile("/src/pkg/server/wire_gen.go", Wire(d, src, platform, goVersion, opts.WireTag)).
WithFile("/src/.buildinfo.commit", commitInfo.Commit).
WithWorkdir("/src")
if opts.Enterprise {
builder = builder.WithFile("/src/.buildinfo.enterprise-commit", commitInfo.EnterpriseCommit)
}
builder = golang.WithCachedGoDependencies(
builder,
goModCache,
)
return builder, nil
}
func Wire(d *dagger.Client, src *dagger.Directory, platform dagger.Platform, goVersion string, wireTag string) *dagger.File {
// withCue is only required during `make gen-go` in 9.5.x or older.
return withCue(golang.Container(d, platform, goVersion), src).
WithExec([]string{"apk", "add", "make"}).
WithDirectory("/src/", src, dagger.ContainerWithDirectoryOpts{
Include: []string{"**/*.mod", "**/*.sum", "**/*.work", ".git"},
}).
WithDirectory("/src/pkg", src.Directory("pkg")).
WithDirectory("/src/apps", src.Directory("apps")).
WithDirectory("/src/.bingo", src.Directory(".bingo")).
WithDirectory("/src/.citools", src.Directory(".citools")).
WithFile("/src/Makefile", src.File("Makefile")).
WithWorkdir("/src").
WithExec([]string{"make", "gen-go", fmt.Sprintf("WIRE_TAGS=%s", wireTag)}).
File("/src/pkg/server/wire_gen.go")
}
@@ -0,0 +1,352 @@
package backend
import (
"fmt"
"log/slog"
"strings"
"dagger.io/dagger"
)
// Distribution is a string that represents the GOOS and GOARCH environment variables joined by a "/".
// Optionally, if there is an extra argument specific to that architecture, it will be the last segment of the string.
// Examples:
// - "linux/arm/v6" = GOOS=linux, GOARCH=arm, GOARM=6
// - "linux/arm/v7" = GOOS=linux, GOARCH=arm, GOARM=7
// - "linux/amd64/v7" = GOOS=linux, GOARCH=arm, GOARM=7
// - "linux/amd64/v2" = GOOS=linux, GOARCH=amd64, GOAMD64=v2
// The list of distributions is built from the command "go tool dist list".
// While not all are used, it at least represents the possible combinations.
type Distribution string
const (
DistDarwinAMD64 Distribution = "darwin/amd64"
DistDarwinAMD64v1 Distribution = "darwin/amd64/v1"
DistDarwinAMD64v2 Distribution = "darwin/amd64/v2"
DistDarwinAMD64v3 Distribution = "darwin/amd64/v3"
DistDarwinAMD64v4 Distribution = "darwin/amd64/v4"
DistDarwinARM64 Distribution = "darwin/arm64"
)
const (
DistFreeBSD386 Distribution = "freebsd/386"
DistFreeBSD386SSE2 Distribution = "freebsd/386/sse2"
DistFreeBSD386SoftFloat Distribution = "freebsd/386/softfloat"
DistFreeBSDAMD64 Distribution = "freebsd/amd64"
DistFreeBSDAMD64v1 Distribution = "freebsd/amd64/v1"
DistFreeBSDAMD64v2 Distribution = "freebsd/amd64/v2"
DistFreeBSDAMD64v3 Distribution = "freebsd/amd64/v3"
DistFreeBSDAMD64v4 Distribution = "freebsd/amd64/v4"
DistFreeBSDARM Distribution = "freebsd/arm"
DistFreeBSDARM64 Distribution = "freebsd/arm64"
DistFreeBSDRISCV Distribution = "freebsd/riscv64"
)
const (
DistIllumosAMD64 Distribution = "illumos/amd64"
DistIllumosAMD64v1 Distribution = "illumos/amd64/v1"
DistIllumosAMD64v2 Distribution = "illumos/amd64/v2"
DistIllumosAMD64v3 Distribution = "illumos/amd64/v3"
DistIllumosAMD64v4 Distribution = "illumos/amd64/v4"
)
const (
DistLinux386 Distribution = "linux/386"
DistLinux386SSE2 Distribution = "linux/386/sse2"
DistLinux386SoftFloat Distribution = "linux/386/softfloat"
DistLinuxAMD64 Distribution = "linux/amd64"
DistLinuxAMD64v1 Distribution = "linux/amd64/v1"
DistLinuxAMD64v2 Distribution = "linux/amd64/v2"
DistLinuxAMD64v3 Distribution = "linux/amd64/v3"
DistLinuxAMD64v4 Distribution = "linux/amd64/v4"
DistLinuxAMD64Dynamic Distribution = "linux/amd64/dynamic"
DistLinuxAMD64DynamicMusl Distribution = "linux/amd64/dynamic-musl"
DistLinuxARM Distribution = "linux/arm"
DistLinuxARMv6 Distribution = "linux/arm/v6"
DistLinuxARMv7 Distribution = "linux/arm/v7"
DistLinuxARM64 Distribution = "linux/arm64"
DistLinuxARM64Dynamic Distribution = "linux/arm64/dynamic"
DistLinuxLoong64 Distribution = "linux/loong64"
DistLinuxMips Distribution = "linux/mips"
DistLinuxMips64 Distribution = "linux/mips64"
DistLinuxMips64le Distribution = "linux/mips64le"
DistLinuxMipsle Distribution = "linux/mipsle"
DistLinuxPPC64 Distribution = "linux/ppc64"
DistLinuxPPC64le Distribution = "linux/ppc64le"
DistLinuxRISCV64 Distribution = "linux/riscv64"
DistLinuxS390X Distribution = "linux/s390x"
)
const (
DistOpenBSD386 Distribution = "openbsd/386"
DistOpenBSD386SSE2 Distribution = "openbsd/386/sse2"
DistOpenBSD386SoftFLoat Distribution = "openbsd/386/softfloat"
DistOpenBSDAMD64 Distribution = "openbsd/amd64"
DistOpenBSDAMD64v1 Distribution = "openbsd/amd64/v1"
DistOpenBSDAMD64v2 Distribution = "openbsd/amd64/v2"
DistOpenBSDAMD64v3 Distribution = "openbsd/amd64/v3"
DistOpenBSDAMD64v4 Distribution = "openbsd/amd64/v4"
DistOpenBSDARM Distribution = "openbsd/arm"
DistOpenBSDARMv6 Distribution = "openbsd/arm/v6"
DistOpenBSDARMv7 Distribution = "openbsd/arm/v7"
DistOpenBSDARM64 Distribution = "openbsd/arm64"
DistOpenBSDMips64 Distribution = "openbsd/mips64"
)
const (
DistPlan9386 Distribution = "plan9/386"
DistPlan9386SSE2 Distribution = "plan9/386/sse2"
DistPlan9386SoftFloat Distribution = "plan9/386/softfloat"
DistPlan9AMD64 Distribution = "plan9/amd64"
DistPlan9AMD64v1 Distribution = "plan9/amd64/v1"
DistPlan9AMD64v2 Distribution = "plan9/amd64/v2"
DistPlan9AMD64v3 Distribution = "plan9/amd64/v3"
DistPlan9AMD64v4 Distribution = "plan9/amd64/v4"
DistPlan9ARM Distribution = "plan9/arm/v6"
DistPlan9ARMv6 Distribution = "plan9/arm/v6"
DistPlan9ARMv7 Distribution = "plan9/arm/v7"
)
const (
DistSolarisAMD64 Distribution = "solaris/amd64"
DistSolarisAMD64v1 Distribution = "solaris/amd64/v1"
DistSolarisAMD64v2 Distribution = "solaris/amd64/v2"
DistSolarisAMD64v3 Distribution = "solaris/amd64/v3"
DistSolarisAMD64v4 Distribution = "solaris/amd64/v4"
)
const (
DistWindows386 Distribution = "windows/386"
DistWindows386SSE2 Distribution = "windows/386/sse2"
DistWindows386SoftFloat Distribution = "windows/386/softfloat"
DistWindowsAMD64 Distribution = "windows/amd64"
DistWindowsAMD64v1 Distribution = "windows/amd64/v1"
DistWindowsAMD64v2 Distribution = "windows/amd64/v2"
DistWindowsAMD64v3 Distribution = "windows/amd64/v3"
DistWindowsAMD64v4 Distribution = "windows/amd64/v4"
DistWindowsARM Distribution = "windows/arm"
DistWindowsARMv6 Distribution = "windows/arm/v6"
DistWindowsARMv7 Distribution = "windows/arm/v7"
DistWindowsARM64 Distribution = "windows/arm64"
)
func IsWindows(d Distribution) bool {
return strings.Split(string(d), "/")[0] == "windows"
}
func OSAndArch(d Distribution) (string, string) {
p := strings.Split(string(d), "/")
if len(p) < 2 {
return string(d), ""
}
return p[0], p[1]
}
func FullArch(d Distribution) string {
p := strings.Split(string(d), "/")
return strings.Join(p[1:], "/")
}
func ArchVersion(d Distribution) string {
p := strings.Split(string(d), "/")
if len(p) < 3 {
return ""
}
// ARM specifically must be specified without a 'v' prefix.
// GOAMD64, however, expects a 'v' prefix.
// Specifying the ARM version with the 'v' prefix and without is supported in Docker's platform argument, however.
if arch := p[1]; arch == "arm" {
return strings.TrimPrefix(p[2], "v")
}
return p[2]
}
func PackageArch(d Distribution) string {
_, arch := OSAndArch(d)
if arch == "arm" {
return "armhf"
}
return arch
}
// From the distribution, try to assume the docker platform (used in Docker's --platform argument or the (dagger.ContainerOpts).Platform field
func Platform(d Distribution) dagger.Platform {
p := strings.ReplaceAll(string(d), "/dynamic-musl", "")
p = strings.ReplaceAll(p, "/dynamic", "")
p = strings.ReplaceAll(p, "arm/v6", "arm/v7")
// for now let's just try to use the distro name as the platform and see if that works...
return dagger.Platform(p)
}
type DistroBuildOptsFunc func(distro Distribution, experiments []string, tags []string) *GoBuildOpts
func LDFlagsStatic(info *VCSInfo) []LDFlag {
return []LDFlag{
{"-w", nil},
{"-s", nil},
{"-X", info.X()},
{"-linkmode=external", nil},
{"-extldflags=-static", nil},
}
}
func LDFlagsDynamic(info *VCSInfo) []LDFlag {
return []LDFlag{
{"-X", info.X()},
}
}
func ZigCC(distro Distribution) string {
target, ok := ZigTargets[distro]
if !ok {
target = "x86_64-linux-musl" // best guess? should probably retun an error but i don't want to
}
return fmt.Sprintf("zig cc -target %s", target)
}
func ZigCXX(distro Distribution) string {
target, ok := ZigTargets[distro]
if !ok {
target = "x86_64-linux-musl" // best guess? should probably retun an error but i don't want to
}
return fmt.Sprintf("zig c++ -target %s", target)
}
var DefaultBuildOpts = func(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
os, arch := OSAndArch(distro)
return &GoBuildOpts{
CC: ZigCC(distro),
CXX: ZigCXX(distro),
ExperimentalFlags: experiments,
OS: os,
Arch: arch,
CGOEnabled: true,
}
}
// BuildOptsStaticARM builds Grafana statically for the armv6/v7 architectures (not aarch64/arm64)
func BuildOptsStaticARM(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
var (
os, _ = OSAndArch(distro)
arm = ArchVersion(distro)
)
return &GoBuildOpts{
CC: "/toolchain/arm-linux-musleabihf-cross/bin/arm-linux-musleabihf-gcc",
CXX: "/toolchain/arm-linux-musleabihf-cross/bin/arm-linux-musleabihf-cpp",
ExperimentalFlags: experiments,
OS: os,
Arch: "arm",
GoARM: GoARM(arm),
CGOEnabled: true,
}
}
// BuildOptsStaticS390X builds Grafana statically for the s390x arch
func BuildOptsStaticS390X(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
var (
os, _ = OSAndArch(distro)
)
return &GoBuildOpts{
CC: "/toolchain/s390x-linux-musl-cross/bin/s390x-linux-musl-gcc",
CXX: "/toolchain/s390x-linux-musl-cross/bin/s390x-linux-musl-cpp",
ExperimentalFlags: experiments,
OS: os,
Arch: "s390x",
CGOEnabled: true,
}
}
func StdZigBuildOpts(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
var (
os, arch = OSAndArch(distro)
)
return &GoBuildOpts{
CC: ZigCC(distro),
CXX: ZigCXX(distro),
ExperimentalFlags: experiments,
OS: os,
Arch: arch,
CGOEnabled: true,
}
}
func BuildOptsWithoutZig(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
var (
os, arch = OSAndArch(distro)
)
return &GoBuildOpts{
ExperimentalFlags: experiments,
OS: os,
Arch: arch,
CGOEnabled: true,
}
}
func ViceroyBuildOpts(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
var (
os, arch = OSAndArch(distro)
)
return &GoBuildOpts{
CC: "viceroycc",
ExperimentalFlags: experiments,
OS: os,
Arch: arch,
CGOEnabled: true,
}
}
var ZigTargets = map[Distribution]string{
DistLinuxAMD64: "x86_64-linux-musl",
DistLinuxAMD64Dynamic: "x86_64-linux-gnu",
DistLinuxAMD64DynamicMusl: "x86_64-linux-musl",
DistLinuxARM64: "aarch64-linux-musl",
DistLinuxARM64Dynamic: "aarch64-linux-musl",
DistLinuxARM: "arm-linux-musleabihf",
DistLinuxARMv6: "arm-linux-musleabihf",
DistLinuxARMv7: "arm-linux-musleabihf",
DistLinuxRISCV64: "riscv64-linux-musl",
DistWindowsAMD64: "x86_64-windows-gnu",
DistWindowsARM64: "aarch64-windows-gnu",
}
var DistributionGoOpts = map[Distribution]DistroBuildOptsFunc{
// The Linux distros should all have an equivalent zig target in the ZigTargets map
DistLinuxARM: BuildOptsStaticARM,
DistLinuxARMv6: BuildOptsStaticARM,
DistLinuxARMv7: BuildOptsStaticARM,
DistLinuxS390X: BuildOptsStaticS390X,
DistLinuxARM64: StdZigBuildOpts,
DistLinuxARM64Dynamic: StdZigBuildOpts,
DistLinuxAMD64: StdZigBuildOpts,
DistLinuxAMD64Dynamic: StdZigBuildOpts,
DistPlan9AMD64: StdZigBuildOpts,
DistLinuxRISCV64: StdZigBuildOpts,
// Non-Linux distros can have whatever they want in CC and CXX; it'll get overridden
// but it's probably not best to rely on that.
DistWindowsAMD64: ViceroyBuildOpts,
DistWindowsARM64: StdZigBuildOpts,
DistDarwinAMD64: ViceroyBuildOpts,
DistDarwinARM64: ViceroyBuildOpts,
DistLinuxAMD64DynamicMusl: BuildOptsWithoutZig,
}
func DistroOptsLogger(log *slog.Logger, fn DistroBuildOptsFunc) func(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
return func(distro Distribution, experiments []string, tags []string) *GoBuildOpts {
opts := fn(distro, experiments, tags)
log.Debug("Building with options", "distribution", distro, "experiments", experiments, "tags", tags, "os", opts.OS, "arch", opts.Arch, "arm", opts.GoARM, "CGO", opts.CGOEnabled, "386", opts.Go386, "CC", opts.CC, "CXX", opts.CXX)
return opts
}
}
+2
View File
@@ -0,0 +1,2 @@
// Package backend holds the functions that create containers, files, and directories for building Grafana's backend binaries.
package backend
+140
View File
@@ -0,0 +1,140 @@
package backend
import (
"strings"
"github.com/grafana/grafana/pkg/build/daggerbuild/containers"
)
type (
BuildMode string
GoARM string
GoAMD64 string
Go386 string
LibC int
)
const (
BuildModeDefault BuildMode = "default"
BuildModeExe BuildMode = "exe"
)
const (
GOARM5 GoARM = "5"
GOARM6 GoARM = "6"
GOARM7 GoARM = "7"
)
const (
Go386SSE2 Go386 = "sse2"
Go386SoftFloat Go386 = "softfloat"
)
const (
Musl LibC = iota
GLibC
)
type GoBuildOpts struct {
// OS is value supplied to the GOOS environment variable
OS string
// Arch is value supplied to the GOARCH environment variable
Arch string
// ExperimentalFlags are Go build-time feature flags in the "GOEXPERIMENT" environment variable that enable experimental features.
ExperimentalFlags []string
// CGOEnabled defines whether or not the CGO_ENABLED flag is set.
CGOEnabled bool
// GOARM: For GOARCH=arm, the ARM architecture for which to compile.
// Valid values are 5, 6, 7.
GoARM GoARM
// GO386: For GOARCH=386, how to implement floating point instructions.
// Valid values are sse2 (default), softfloat.
Go386 Go386
// CC is the command to use to compile C code when CGO is enabled. (Sets the "CC" environment variable)
CC string
// CXX is the command to use to compile C++ code when CGO is enabled. (Sets the "CXX" environment variable)
CXX string
}
// GoBuildEnv returns the environment variables that must be set for a 'go build' command given the provided 'GoBuildOpts'.
func GoBuildEnv(opts *GoBuildOpts) []containers.Env {
var (
os = opts.OS
arch = opts.Arch
)
env := []containers.Env{containers.EnvVar("GOOS", os), containers.EnvVar("GOARCH", arch)}
if arch == "arm" {
env = append(env, containers.EnvVar("GOARM", string(opts.GoARM)))
}
if opts.CGOEnabled {
env = append(env, containers.EnvVar("GOARM", string(opts.GoARM)))
env = append(env, containers.EnvVar("CGO_ENABLED", "1"))
// https://github.com/mattn/go-sqlite3/issues/1164#issuecomment-1635253695
env = append(env, containers.EnvVar("CGO_CFLAGS", "-D_LARGEFILE64_SOURCE"))
} else {
env = append(env, containers.EnvVar("CGO_ENABLED", "0"))
}
if opts.ExperimentalFlags != nil {
env = append(env, containers.EnvVar("GOEXPERIMENT", strings.Join(opts.ExperimentalFlags, ",")))
}
if opts.CC != "" {
env = append(env, containers.EnvVar("CC", opts.CC))
}
if opts.CXX != "" {
env = append(env, containers.EnvVar("CXX", opts.CXX))
}
return env
}
// ViceroyEnv returns the environment variables that must be set for a 'go build' command given the provided 'GoBuildOpts'.
func ViceroyEnv(opts *GoBuildOpts) []containers.Env {
var (
os = opts.OS
arch = opts.Arch
)
env := []containers.Env{
containers.EnvVar("VICEROYOS", os),
containers.EnvVar("GOOS", os),
containers.EnvVar("VICEROYARCH", arch),
containers.EnvVar("GOARCH", arch),
}
if arch == "arm" {
env = append(env, containers.EnvVar("VICEROYARM", string(opts.GoARM)))
}
if opts.CGOEnabled {
env = append(env, containers.EnvVar("CGO_ENABLED", "1"))
// https://github.com/mattn/go-sqlite3/issues/1164#issuecomment-1635253695
env = append(env, containers.EnvVar("CGO_CFLAGS", "-D_LARGEFILE64_SOURCE"))
} else {
env = append(env, containers.EnvVar("CGO_ENABLED", "0"))
}
if opts.ExperimentalFlags != nil {
env = append(env, containers.EnvVar("GOEXPERIMENT", strings.Join(opts.ExperimentalFlags, ",")))
}
if opts.CC != "" {
env = append(env, containers.EnvVar("CC", "viceroycc"))
}
return env
}
+56
View File
@@ -0,0 +1,56 @@
package backend
import (
"fmt"
"strings"
"dagger.io/dagger"
)
type VCSInfo struct {
Version string
Commit *dagger.File
EnterpriseCommit *dagger.File
Branch *dagger.File
}
func WithVCSInfo(c *dagger.Container, info *VCSInfo, enterprise bool) *dagger.Container {
c = c.
WithFile(".buildinfo.commit", info.Commit).
WithFile(".buildinfo.branch", info.Branch)
if enterprise {
return c.WithFile(".buildinfo.enterprise-commit", info.EnterpriseCommit)
}
return c
}
// VCSInfo gets the VCS data from the directory 'src', writes them to a file on the given container, and returns the files which can be used in other containers.
func GetVCSInfo(src *dagger.Directory, version string, enterprise bool) *VCSInfo {
info := &VCSInfo{
Version: version,
Commit: src.File(".buildinfo.commit"),
Branch: src.File(".buildinfo.branch"),
}
if enterprise {
info.EnterpriseCommit = src.File(".buildinfo.enterprise-commit")
}
return info
}
func (v *VCSInfo) X() []string {
flags := []string{
fmt.Sprintf("main.version=%s", strings.TrimPrefix(v.Version, "v")),
`main.commit=$(cat ./.buildinfo.commit)`,
`main.buildBranch=$(cat ./.buildinfo.branch)`,
}
if v.EnterpriseCommit != nil {
flags = append(flags, `main.enterpriseCommit=$(cat ./.buildinfo.enterprise-commit)`)
}
return flags
}