feat(go): reach rendering parity (#753)

Author: Proximyst

.github/workflows/docker-test.yaml

@@ -15,23 +15,26 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  bats:
+  acceptance:
     strategy:
       fail-fast: false
       matrix:
         file: [Dockerfile, go.Dockerfile]
         # TODO: Use self-hosted runners when available.
         runs-on: [github-hosted-ubuntu-arm64-large, github-hosted-ubuntu-x64-large]
 
-    name: bats (${{ matrix.runs-on }}, ${{ matrix.file }})
+    name: acceptance tests (${{ matrix.runs-on }}, ${{ matrix.file }})
     runs-on: ${{ matrix.runs-on }}
     permissions:
       contents: read # clone the repository
     steps:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
-      - uses: bats-core/bats-action@42fcc8700f773c075a16a90eb11674c0318ad507 # 3.0.1
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+          cache: false
 
       - name: docker build
         env:
@@ -40,8 +43,45 @@ jobs:
           BUILDKIT_STEP_LOG_MAX_SPEED: -1
           FILE: ${{ matrix.file }}
         run: docker build . -t image-renderer -f "$FILE"
-      - name: bats
-        working-directory: tests/bats
-        run: ./test.sh image-renderer
+      - name: go test ./tests/acceptance/...
+        run: go test ./tests/acceptance/... -count=1
         env:
           TERM: linux
+          IMAGE: image-renderer
+          UPDATE_FIXTURES: 'true' # this will make changes, so we can see them
+
+      - name: Tar changed files
+        if: failure()
+        id: tar
+        run: |
+          set -euo pipefail
+          readarray -t files < <(git diff --name-only)
+          if [ "${#files[@]}" -gt "0" ]; then
+            tar cJf changed-files.tar.xz "${files[@]}"
+            echo 'upload=true' >> "$GITHUB_OUTPUT"
+          else
+            echo "No files changed :)"
+          fi
+      - name: Upload changed files
+        if: ${{ steps.tar.outputs.upload == 'true' && (success() || failure()) }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: changed-files-${{ matrix.file }}-${{ matrix.runs-on }}
+          path: changed-files.tar.xz
+
+  # This is the job that is actually required by rulesets.
+  required-acceptance-tests:
+    needs:
+      - acceptance
+    # always() is the best function here.
+    # success() || failure() will skip this function if any need is also skipped.
+    # That means conditional test suites will fail the entire requirement check.
+    if: always()
+
+    name: All acceptance tests complete
+    runs-on: ubuntu-latest
+    steps:
+      - name: Assert no failures
+        env:
+          NEEDS: ${{ toJson(needs) }}
+        run: exit $(echo "$NEEDS" | jq 'with_entries(select(.value.result == "failure")) | length')

cmd/root.go

@@ -8,15 +8,15 @@ import (
 	"github.com/grafana/grafana-image-renderer/cmd/config"
 	"github.com/grafana/grafana-image-renderer/cmd/healthcheck"
 	"github.com/grafana/grafana-image-renderer/cmd/server"
-	"github.com/grafana/grafana-image-renderer/pkg/version"
+	"github.com/grafana/grafana-image-renderer/pkg/service"
 	"github.com/urfave/cli/v3"
 )
 
 func NewRootCmd() *cli.Command {
 	return &cli.Command{
 		Name:    "grafana-image-renderer",
 		Usage:   "A service for Grafana to render images and documents from Grafana websites.",
-		Version: version.ServiceVersion(),
+		Version: service.NewVersionService().GetPrettyVersion(),
 		Flags: []cli.Flag{
 			&cli.StringFlag{
 				Name:    "log-level",

cmd/server/cmd.go

@@ -3,12 +3,11 @@ package server
 import (
 	"context"
 	"fmt"
-	"time"
 
 	"github.com/grafana/grafana-image-renderer/cmd/config"
 	"github.com/grafana/grafana-image-renderer/pkg/api"
-	"github.com/grafana/grafana-image-renderer/pkg/chromium"
 	"github.com/grafana/grafana-image-renderer/pkg/metrics"
+	"github.com/grafana/grafana-image-renderer/pkg/service"
 	"github.com/urfave/cli/v3"
 )
 
@@ -18,28 +17,39 @@ func NewCmd() *cli.Command {
 		Usage: "Run the server part of the service.",
 		Flags: []cli.Flag{
 			&cli.StringFlag{
-				Name:    "addr",
-				Usage:   "The address to listen on for HTTP requests.",
-				Value:   ":8081",
-				Sources: config.FromConfig("server.addr"),
+				Name:     "addr",
+				Usage:    "The address to listen on for HTTP requests.",
+				Category: "Server",
+				Value:    ":8081",
+				Sources:  config.FromConfig("server.addr"),
 			},
+			&cli.StringFlag{
+				Name:     "auth-token",
+				Usage:    "The X-Auth-Token header value that must be sent to the service to permit requests.",
+				Category: "Server",
+				Value:    "-",
+				Sources:  config.FromConfig("auth.token"),
+			},
+
 			&cli.StringFlag{
 				Name:      "browser",
 				Usage:     "The path to the browser's binary. This is resolved against PATH.",
+				Category:  "Browser",
 				TakesFile: true,
 				Value:     "chromium",
 				Sources:   config.FromConfig("browser.path"),
 			},
 			&cli.StringSliceFlag{
-				Name:    "browser-flags",
-				Usage:   "Flags to pass to the browser. These are syntaxed `<flag>` or `<flag>=<value>`. No -- should be passed in for the flag; these are implied.",
-				Sources: config.FromConfig("browser.flags"),
+				Name:     "browser-flags",
+				Usage:    "Flags to pass to the browser. These are syntaxed `<flag>` or `<flag>=<value>`. No -- should be passed in for the flag; these are implied.",
+				Category: "Browser",
+				Sources:  config.FromConfig("browser.flags"),
 			},
-			&cli.StringFlag{
-				Name:    "auth-token",
-				Usage:   "The X-Auth-Token header value that must be sent to the service to permit requests.",
-				Value:   "-",
-				Sources: config.FromConfig("auth.token"),
+			&cli.BoolFlag{
+				Name:     "browser-gpu",
+				Usage:    "Enable GPU support in the browser.",
+				Category: "Browser",
+				Sources:  config.FromConfig("browser.gpu"),
 			},
 		},
 		Action: run,
@@ -48,23 +58,11 @@ func NewCmd() *cli.Command {
 
 func run(ctx context.Context, c *cli.Command) error {
 	metrics := metrics.NewRegistry()
-	browser, err := chromium.NewBrowser(c.String("browser"), c.StringSlice("browser-flags"), chromium.RenderingOptions{
-		Width:              1000,
-		Height:             500,
-		TimeZone:           "Etc/UTC",
-		PaperSize:          chromium.PaperA4,
-		PrintBackground:    true,
-		Timeout:            time.Second * 30,
-		FullHeight:         false,
-		Landscape:          true,
-		Format:             chromium.RenderingFormatPDF,
-		DeviceScaleFactor:  2,
-		TimeBetweenScrolls: time.Millisecond * 50,
-	})
-	if err != nil {
-		return fmt.Errorf("failed to create browser: %w", err)
-	}
-	handler, err := api.NewHandler(metrics, browser, api.AuthToken(c.String("auth-token")))
+	browser := service.NewBrowserService(c.String("browser"), c.StringSlice("browser-flags"),
+		service.WithViewport(1000, 500),
+		service.WithGPU(c.Bool("browser-gpu")))
+	versions := service.NewVersionService()
+	handler, err := api.NewHandler(metrics, browser, api.AuthToken(c.String("auth-token")), versions)
 	if err != nil {
 		return fmt.Errorf("failed to create API handler: %w", err)
 	}

devenv/docker/enterprise-host/docker-compose.yaml

@@ -6,7 +6,13 @@ services:
       GF_RENDERING_SERVER_URL: http://localhost:8081/render
       GF_RENDERING_CALLBACK_URL: http://localhost:3000/
       GF_LOG_FILTERS: rendering:debug
+      GF_FEATURE_TOGGLES_ENABLE: sharingDashboardImage
+    volumes:
+      - grafana-data:/var/lib/grafana
 
   prometheus:
     image: prom/prometheus
     network_mode: host
+
+volumes:
+  grafana-data:

go.Dockerfile

@@ -70,5 +70,5 @@ EXPOSE 8081
 
 ENTRYPOINT ["tini", "--", "/usr/bin/grafana-image-renderer"]
 CMD ["server"]
-HEALTHCHECK --interval=10s --retries=3 --timeout=3s \
+HEALTHCHECK --interval=10s --retries=3 --timeout=3s --start-interval=250ms --start-period=30s \
     CMD ["/usr/bin/grafana-image-renderer", "healthcheck"]

go.mod

@@ -6,33 +6,85 @@ require (
 	github.com/Masterminds/semver/v3 v3.4.0
 	github.com/chromedp/cdproto v0.0.0-20250724212937-08a3db8b4327
 	github.com/chromedp/chromedp v0.14.1
+	github.com/docker/docker v28.3.3+incompatible
+	github.com/docker/go-connections v0.6.0
+	github.com/go-jose/go-jose/v4 v4.1.2
 	github.com/google/uuid v1.6.0
 	github.com/prometheus/client_golang v1.23.0
-	github.com/stretchr/testify v1.10.0
+	github.com/stretchr/testify v1.11.1
+	github.com/testcontainers/testcontainers-go v0.38.0
+	github.com/unidoc/unipdf/v4 v4.2.0
 	github.com/urfave/cli-altsrc/v3 v3.0.1
 	github.com/urfave/cli/v3 v3.4.1
 	golang.org/x/sync v0.16.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
+	dario.cat/mergo v1.0.2 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c // indirect
+	github.com/Microsoft/go-winio v0.6.2 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/chromedp/sysutil v1.1.0 // indirect
+	github.com/containerd/errdefs v1.0.0 // indirect
+	github.com/containerd/errdefs/pkg v0.3.0 // indirect
+	github.com/containerd/log v0.1.0 // indirect
+	github.com/containerd/platforms v0.2.1 // indirect
+	github.com/cpuguy83/dockercfg v0.3.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/distribution/reference v0.6.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/ebitengine/purego v0.8.4 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/go-json-experiment/json v0.0.0-20250725192818-e39067aee2d2 // indirect
+	github.com/go-logr/logr v1.4.3 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-ole/go-ole v1.3.0 // indirect
 	github.com/gobwas/httphead v0.1.0 // indirect
 	github.com/gobwas/pool v0.2.1 // indirect
 	github.com/gobwas/ws v1.4.0 // indirect
-	github.com/kr/text v0.2.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
+	github.com/lufia/plan9stats v0.0.0-20250827001030-24949be3fa54 // indirect
+	github.com/magiconair/properties v1.8.10 // indirect
+	github.com/moby/docker-image-spec v1.3.1 // indirect
+	github.com/moby/go-archive v0.1.0 // indirect
+	github.com/moby/patternmatcher v0.6.0 // indirect
+	github.com/moby/sys/sequential v0.6.0 // indirect
+	github.com/moby/sys/user v0.4.0 // indirect
+	github.com/moby/sys/userns v0.1.0 // indirect
+	github.com/moby/term v0.5.2 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.1.1 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 // indirect
 	github.com/prometheus/client_model v0.6.2 // indirect
 	github.com/prometheus/common v0.65.0 // indirect
 	github.com/prometheus/procfs v0.17.0 // indirect
+	github.com/shirou/gopsutil/v4 v4.25.7 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/tklauser/go-sysconf v0.3.15 // indirect
+	github.com/tklauser/numcpus v0.10.0 // indirect
+	github.com/yusufpapurcu/wmi v1.2.4 // indirect
+	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.62.0 // indirect
+	go.opentelemetry.io/otel v1.37.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.37.0 // indirect
+	go.opentelemetry.io/otel/metric v1.37.0 // indirect
+	go.opentelemetry.io/otel/trace v1.37.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.7.1 // indirect
+	golang.org/x/crypto v0.41.0 // indirect
+	golang.org/x/image v0.30.0 // indirect
 	golang.org/x/mod v0.27.0 // indirect
 	golang.org/x/sys v0.35.0 // indirect
+	golang.org/x/text v0.28.0 // indirect
 	golang.org/x/tools v0.36.0 // indirect
+	golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da // indirect
 	google.golang.org/protobuf v1.36.7 // indirect
 )