1.1.0 milestone: security, lint, and bootstrap fixes (#199)
Check / check (push) Successful in 5s
Check / check (push) Successful in 5s
Reviewed-on: #199
This commit was merged in pull request #199.
This commit is contained in:
@@ -0,0 +1,2 @@
|
|||||||
|
# Vendored, minified third-party bundles must never be reformatted.
|
||||||
|
*.min.js
|
||||||
+5
-1
@@ -8,8 +8,12 @@ RUN go mod download
|
|||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
|
# golangci-lint is invoked directly here, not via `make lint`: script/lint
|
||||||
|
# now runs the linter by building Dockerfile.lint, and shelling out to
|
||||||
|
# `docker build` from inside this image build would be docker-in-docker.
|
||||||
|
# This image is golangci/golangci-lint, so the pinned linter is on PATH.
|
||||||
RUN make fmt-check
|
RUN make fmt-check
|
||||||
RUN make lint
|
RUN golangci-lint run --config .golangci.yml ./...
|
||||||
|
|
||||||
# Build stage — tests and compilation
|
# Build stage — tests and compilation
|
||||||
# golang:1.25-alpine
|
# golang:1.25-alpine
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Lint image — runs golangci-lint inside a container so every lint uses
|
||||||
|
# the pinned linter, never a host binary. Linting is a build step, so a
|
||||||
|
# successful build is a clean lint. Built by script/lint.
|
||||||
|
# golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07
|
||||||
|
FROM golangci/golangci-lint:v2.12.2@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240
|
||||||
|
|
||||||
|
WORKDIR /src
|
||||||
|
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Caching is waived for linting: on an unchanged tree a cached build runs
|
||||||
|
# no linter and still exits 0 in under a second. script/lint passes a
|
||||||
|
# fresh GATE_RUN every time, and referencing it here forces this step to
|
||||||
|
# re-run, so the linter always executes.
|
||||||
|
#
|
||||||
|
# `golangci-lint config verify` is deliberately NOT run: it fetches its
|
||||||
|
# JSON schema over an unpinned live HTTPS call, which REPO_POLICIES.md
|
||||||
|
# forbids (all external references must be pinned by hash).
|
||||||
|
ARG GATE_RUN
|
||||||
|
RUN echo "lint run: ${GATE_RUN}"; golangci-lint run --config .golangci.yml ./...
|
||||||
@@ -20,6 +20,24 @@ main cannot regress.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-09-22: Fixed the flaky `t.TempDir` cleanup race in
|
||||||
|
`internal/service/webhook` by tracking the async deployment goroutine
|
||||||
|
in a `sync.WaitGroup` and exposing `WaitForDeployments`; tests now
|
||||||
|
synchronize on completion instead of sleeping (#198).
|
||||||
|
- 2026-09-22: Linting now runs only in Docker. Added `Dockerfile.lint`
|
||||||
|
(pinned golangci-lint v2.12.2, cache-busted via a `GATE_RUN` build arg
|
||||||
|
so the linter always executes), reduced `script/lint` to building it,
|
||||||
|
dropped the golangci-lint install from `script/bootstrap`, and switched
|
||||||
|
the `Dockerfile` lint stage to invoke `golangci-lint` directly instead
|
||||||
|
of `make lint` to avoid docker-in-docker (#188).
|
||||||
|
- 2026-09-22: Added `.prettierignore` so `make fmt` no longer rewrites
|
||||||
|
the vendored `static/js/alpine.min.js` bundle (#185).
|
||||||
|
- 2026-09-22: Fixed the gosec G703 path-traversal finding in the deploy
|
||||||
|
log download handler by verifying the resolved path stays within the
|
||||||
|
deploy log directory before serving, returning 404 on escape (#177).
|
||||||
|
- 2026-09-22: `script/bootstrap` now installs a pinned `goimports`
|
||||||
|
(`golang.org/x/tools` v0.49.0) into `/usr/local/bin`, so `make fmt`
|
||||||
|
succeeds on a fresh machine after `make bootstrap` (#184).
|
||||||
- 2026-09-09: Fixed four deployability blockers found by QA: CSRF origin
|
- 2026-09-09: Fixed four deployability blockers found by QA: CSRF origin
|
||||||
check over plain HTTP (`UPAAS_PLAINTEXT_HTTP`, #189), pulling the git
|
check over plain HTTP (`UPAAS_PLAINTEXT_HTTP`, #189), pulling the git
|
||||||
image when absent (#190), the env-var editor CSRF token lookup (#191),
|
image when absent (#190), the env-var editor CSRF token lookup (#191),
|
||||||
|
|||||||
@@ -611,7 +611,13 @@ func (h *Handlers) HandleDeploymentLogDownload() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get the log file path from deploy service
|
// The log path is derived from request data (the app is looked
|
||||||
|
// up by a URL parameter), so open it through an os.Root confined
|
||||||
|
// to the deploy log directory. Root.Open rejects any path that
|
||||||
|
// escapes the root, so a traversal attempt fails rather than
|
||||||
|
// serving an arbitrary file.
|
||||||
|
logDir := h.deploy.GetLogDir()
|
||||||
|
|
||||||
logPath := h.deploy.GetLogFilePath(application, deployment)
|
logPath := h.deploy.GetLogFilePath(application, deployment)
|
||||||
if logPath == "" {
|
if logPath == "" {
|
||||||
http.NotFound(writer, request)
|
http.NotFound(writer, request)
|
||||||
@@ -619,28 +625,43 @@ func (h *Handlers) HandleDeploymentLogDownload() http.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if file exists — logPath is constructed internally, not from user input
|
relPath, relErr := filepath.Rel(logDir, logPath)
|
||||||
_, err := os.Stat(logPath) // #nosec G703 -- internal path, not user input
|
if relErr != nil {
|
||||||
if os.IsNotExist(err) {
|
|
||||||
http.NotFound(writer, request)
|
http.NotFound(writer, request)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if err != nil {
|
root, rootErr := os.OpenRoot(logDir)
|
||||||
h.log.Error("failed to stat log file", "error", err, "path", logPath)
|
if rootErr != nil {
|
||||||
|
http.NotFound(writer, request)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer func() { _ = root.Close() }()
|
||||||
|
|
||||||
|
file, openErr := root.Open(relPath)
|
||||||
|
if openErr != nil {
|
||||||
|
http.NotFound(writer, request)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer func() { _ = file.Close() }()
|
||||||
|
|
||||||
|
info, statErr := file.Stat()
|
||||||
|
if statErr != nil {
|
||||||
|
h.log.Error("failed to stat log file", "error", statErr, "path", logPath)
|
||||||
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
|
http.Error(writer, "Internal Server Error", http.StatusInternalServerError)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Extract filename for Content-Disposition header
|
|
||||||
filename := filepath.Base(logPath)
|
filename := filepath.Base(logPath)
|
||||||
|
|
||||||
writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
||||||
writer.Header().Set("Content-Disposition", "attachment; filename=\""+filename+"\"")
|
writer.Header().Set("Content-Disposition", "attachment; filename=\""+filename+"\"")
|
||||||
|
|
||||||
http.ServeFile(writer, request, logPath) // #nosec G703 -- internal path
|
http.ServeContent(writer, request, filename, info.ModTime(), file)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -42,6 +42,7 @@ type testContext struct {
|
|||||||
database *database.Database
|
database *database.Database
|
||||||
authSvc *auth.Service
|
authSvc *auth.Service
|
||||||
appSvc *app.Service
|
appSvc *app.Service
|
||||||
|
deploySvc *deploy.Service
|
||||||
middleware *middleware.Middleware
|
middleware *middleware.Middleware
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -186,6 +187,7 @@ func setupTestHandlers(t *testing.T) *testContext {
|
|||||||
database: dbInstance,
|
database: dbInstance,
|
||||||
authSvc: authSvc,
|
authSvc: authSvc,
|
||||||
appSvc: appSvc,
|
appSvc: appSvc,
|
||||||
|
deploySvc: deploySvc,
|
||||||
middleware: mw,
|
middleware: mw,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,121 @@
|
|||||||
|
package handlers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"sneak.berlin/go/upaas/internal/models"
|
||||||
|
)
|
||||||
|
|
||||||
|
// doLogDownload issues a log-download request for the given app and
|
||||||
|
// deployment and returns the recorder.
|
||||||
|
func doLogDownload(
|
||||||
|
t *testing.T,
|
||||||
|
testCtx *testContext,
|
||||||
|
appID string,
|
||||||
|
deploymentID int64,
|
||||||
|
) *httptest.ResponseRecorder {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
idStr := strconv.FormatInt(deploymentID, 10)
|
||||||
|
|
||||||
|
request := httptest.NewRequestWithContext(
|
||||||
|
t.Context(),
|
||||||
|
http.MethodGet,
|
||||||
|
"/apps/"+appID+"/deployments/"+idStr+"/log",
|
||||||
|
nil,
|
||||||
|
)
|
||||||
|
request = addChiURLParams(request, map[string]string{
|
||||||
|
"id": appID,
|
||||||
|
"deploymentID": idStr,
|
||||||
|
})
|
||||||
|
|
||||||
|
recorder := httptest.NewRecorder()
|
||||||
|
testCtx.handlers.HandleDeploymentLogDownload().ServeHTTP(recorder, request)
|
||||||
|
|
||||||
|
return recorder
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleDeploymentLogDownloadServesLegitimateFile verifies a normal
|
||||||
|
// log file is served for download.
|
||||||
|
func TestHandleDeploymentLogDownloadServesLegitimateFile(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
testCtx := setupTestHandlers(t)
|
||||||
|
createdApp := createTestApp(t, testCtx, "log-download-app")
|
||||||
|
|
||||||
|
deployment := models.NewDeployment(testCtx.database)
|
||||||
|
deployment.AppID = createdApp.ID
|
||||||
|
deployment.Status = models.DeploymentStatusSuccess
|
||||||
|
require.NoError(t, deployment.Save(context.Background()))
|
||||||
|
|
||||||
|
// Write the log file where the handler will look for it.
|
||||||
|
logPath := testCtx.deploySvc.GetLogFilePath(createdApp, deployment)
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(logPath), 0o750))
|
||||||
|
require.NoError(t, os.WriteFile(logPath, []byte("deploy log contents"), 0o600))
|
||||||
|
|
||||||
|
recorder := doLogDownload(t, testCtx, createdApp.ID, deployment.ID)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusOK, recorder.Code)
|
||||||
|
assert.Contains(t, recorder.Body.String(), "deploy log contents")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestHandleDeploymentLogDownloadRejectsPathTraversal verifies the
|
||||||
|
// os.Root containment guard. A traversal-shaped app name drives the
|
||||||
|
// resolved log path out of the deploy log directory onto a sentinel
|
||||||
|
// file that really exists. The handler must refuse to serve it (404)
|
||||||
|
// rather than leak its contents. Removing the guard makes this test
|
||||||
|
// fail, which the earlier version — pointed at a non-existent path that
|
||||||
|
// 404s either way — did not.
|
||||||
|
func TestHandleDeploymentLogDownloadRejectsPathTraversal(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
testCtx := setupTestHandlers(t)
|
||||||
|
createdApp := createTestApp(t, testCtx, "log-traversal-app")
|
||||||
|
|
||||||
|
createdApp.Name = "../.."
|
||||||
|
require.NoError(t, createdApp.Save(context.Background()))
|
||||||
|
|
||||||
|
// The log root must exist so os.OpenRoot succeeds and the rejection
|
||||||
|
// comes from the containment check, not a missing directory.
|
||||||
|
logDir := testCtx.deploySvc.GetLogDir()
|
||||||
|
require.NoError(t, os.MkdirAll(logDir, 0o750))
|
||||||
|
|
||||||
|
deployment := models.NewDeployment(testCtx.database)
|
||||||
|
deployment.AppID = createdApp.ID
|
||||||
|
deployment.Status = models.DeploymentStatusSuccess
|
||||||
|
require.NoError(t, deployment.Save(context.Background()))
|
||||||
|
|
||||||
|
// Where the handler resolves the log path to. The traversal name
|
||||||
|
// makes this land outside logDir; require that it truly escapes so
|
||||||
|
// the test cannot silently stop covering the guard.
|
||||||
|
escapedPath := testCtx.deploySvc.GetLogFilePath(createdApp, deployment)
|
||||||
|
relPath, relErr := filepath.Rel(logDir, escapedPath)
|
||||||
|
require.NoError(t, relErr)
|
||||||
|
require.True(t, strings.HasPrefix(relPath, ".."),
|
||||||
|
"resolved path must escape the log dir, got %q", relPath)
|
||||||
|
|
||||||
|
// Plant a sentinel where the traversal points; a missing guard would
|
||||||
|
// open and serve it.
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(escapedPath), 0o750))
|
||||||
|
|
||||||
|
const sentinel = "SENTINEL-outside-log-dir-must-not-be-served"
|
||||||
|
|
||||||
|
require.NoError(t, os.WriteFile(escapedPath, []byte(sentinel), 0o600))
|
||||||
|
t.Cleanup(func() { _ = os.Remove(escapedPath) })
|
||||||
|
|
||||||
|
recorder := doLogDownload(t, testCtx, createdApp.ID, deployment.ID)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusNotFound, recorder.Code)
|
||||||
|
assert.NotContains(t, recorder.Body.String(), sentinel,
|
||||||
|
"containment guard must not serve a file outside the log dir")
|
||||||
|
}
|
||||||
@@ -294,6 +294,12 @@ func (svc *Service) GetLogFilePath(
|
|||||||
return filepath.Join(svc.config.DataDir, "logs", hostname, app.Name, filename)
|
return filepath.Join(svc.config.DataDir, "logs", hostname, app.Name, filename)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetLogDir returns the root directory under which all deployment log
|
||||||
|
// files live. Paths returned by GetLogFilePath are always inside it.
|
||||||
|
func (svc *Service) GetLogDir() string {
|
||||||
|
return filepath.Join(svc.config.DataDir, "logs")
|
||||||
|
}
|
||||||
|
|
||||||
// HasActiveDeploy returns true if there is an active deployment for the given app.
|
// HasActiveDeploy returns true if there is an active deployment for the given app.
|
||||||
func (svc *Service) HasActiveDeploy(appID string) bool {
|
func (svc *Service) HasActiveDeploy(appID string) bool {
|
||||||
_, ok := svc.activeDeploys.Load(appID)
|
_, ok := svc.activeDeploys.Load(appID)
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import (
|
|||||||
"database/sql"
|
"database/sql"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
|
"sync"
|
||||||
|
|
||||||
"go.uber.org/fx"
|
"go.uber.org/fx"
|
||||||
|
|
||||||
@@ -31,6 +32,10 @@ type Service struct {
|
|||||||
db *database.Database
|
db *database.Database
|
||||||
deploy *deploy.Service
|
deploy *deploy.Service
|
||||||
params *ServiceParams
|
params *ServiceParams
|
||||||
|
|
||||||
|
// deployments tracks the deployment goroutines started by
|
||||||
|
// triggerDeployment so callers can wait for them to finish.
|
||||||
|
deployments sync.WaitGroup
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a new webhook Service.
|
// New creates a new webhook Service.
|
||||||
@@ -108,6 +113,14 @@ func (svc *Service) HandleWebhook(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WaitForDeployments blocks until every deployment goroutine started by
|
||||||
|
// HandleWebhook has finished, including all writes under the data
|
||||||
|
// directory. It exists so callers and tests can synchronize on async
|
||||||
|
// deployment completion instead of polling or sleeping.
|
||||||
|
func (svc *Service) WaitForDeployments() {
|
||||||
|
svc.deployments.Wait()
|
||||||
|
}
|
||||||
|
|
||||||
func (svc *Service) triggerDeployment(
|
func (svc *Service) triggerDeployment(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
app *models.App,
|
app *models.App,
|
||||||
@@ -117,7 +130,7 @@ func (svc *Service) triggerDeployment(
|
|||||||
eventID := event.ID
|
eventID := event.ID
|
||||||
appName := app.Name
|
appName := app.Name
|
||||||
|
|
||||||
go func() {
|
svc.deployments.Go(func() {
|
||||||
// Use context.WithoutCancel to ensure deployment completes
|
// Use context.WithoutCancel to ensure deployment completes
|
||||||
// even if the HTTP request context is cancelled.
|
// even if the HTTP request context is cancelled.
|
||||||
deployCtx := context.WithoutCancel(ctx)
|
deployCtx := context.WithoutCancel(ctx)
|
||||||
@@ -130,5 +143,5 @@ func (svc *Service) triggerDeployment(
|
|||||||
// Mark event as processed
|
// Mark event as processed
|
||||||
event.Processed = true
|
event.Processed = true
|
||||||
_ = event.Save(deployCtx)
|
_ = event.Save(deployCtx)
|
||||||
}()
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
@@ -828,8 +827,9 @@ func TestExtractBranch(testingT *testing.T) {
|
|||||||
)
|
)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Allow async deployment goroutine to complete before test cleanup
|
// Wait for the async deployment goroutine to finish so its
|
||||||
time.Sleep(100 * time.Millisecond)
|
// writes under the temp dir complete before test cleanup.
|
||||||
|
svc.WaitForDeployments()
|
||||||
|
|
||||||
events, err := app.GetWebhookEvents(context.Background(), 10)
|
events, err := app.GetWebhookEvents(context.Background(), 10)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@@ -867,8 +867,9 @@ func TestHandleWebhookMatchingBranch(t *testing.T) {
|
|||||||
)
|
)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Allow async deployment goroutine to complete before test cleanup
|
// Wait for the async deployment goroutine to finish so its writes
|
||||||
time.Sleep(100 * time.Millisecond)
|
// under the temp dir complete before test cleanup.
|
||||||
|
svc.WaitForDeployments()
|
||||||
|
|
||||||
events, err := app.GetWebhookEvents(context.Background(), 10)
|
events, err := app.GetWebhookEvents(context.Background(), 10)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@@ -962,8 +963,9 @@ func assertHandleWebhookDeploys(
|
|||||||
err := svc.HandleWebhook(context.Background(), app, source, pushEventType, payload)
|
err := svc.HandleWebhook(context.Background(), app, source, pushEventType, payload)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Allow async deployment goroutine to complete before test cleanup
|
// Wait for the async deployment goroutine to finish so its writes
|
||||||
time.Sleep(100 * time.Millisecond)
|
// under the temp dir complete before test cleanup.
|
||||||
|
svc.WaitForDeployments()
|
||||||
|
|
||||||
events, err := app.GetWebhookEvents(context.Background(), 10)
|
events, err := app.GetWebhookEvents(context.Background(), 10)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|||||||
+28
-53
@@ -3,18 +3,18 @@
|
|||||||
# this repo. Idempotent: every install is guarded by a check so already
|
# this repo. Idempotent: every install is guarded by a check so already
|
||||||
# installed tools are skipped. Base tooling comes from nix, apt, brew,
|
# installed tools are skipped. Base tooling comes from nix, apt, brew,
|
||||||
# or apk (detected in that order); assumes NOTHING is present (not git,
|
# or apk (detected in that order); assumes NOTHING is present (not git,
|
||||||
# make, or go). golangci-lint is packaged in nix, brew, and apk; on apt
|
# make, or go). goimports is installed with `go install` at a pinned
|
||||||
# it is installed from a hash-verified GitHub release archive (never
|
# version (integrity via the Go module checksum database) into
|
||||||
# curl | sh).
|
# /usr/local/bin so it is on PATH. The linter is not installed here: it
|
||||||
|
# runs only in Docker via script/lint, so docker is its sole prerequisite.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
# Pinned versions, 2026-08-07. Never "latest"; exact versions only.
|
# Pinned versions. Never "latest"; exact versions only.
|
||||||
GOLANGCI_LINT_VERSION="2.12.2"
|
# golang.org/x/tools goimports, 2026-08-13. v0.49.0 requires Go 1.25 (matches
|
||||||
# sha256 of golangci-lint-2.12.2-linux-<arch>.tar.gz release archives
|
# go.mod); v0.50.0 needs Go 1.26. Integrity via the Go module checksum database.
|
||||||
GOLANGCI_LINT_SHA256_AMD64="8df580d2670fed8fa984aac0507099af8df275e665215f5c7a2ae3943893a553"
|
GOIMPORTS_VERSION="v0.49.0"
|
||||||
GOLANGCI_LINT_SHA256_ARM64="44cd40a8c76c86755375adfeea52cfd3533cb43d7bd647771e0ae065e166df3a"
|
|
||||||
|
|
||||||
PKGMGR=""
|
PKGMGR=""
|
||||||
SUDO=""
|
SUDO=""
|
||||||
@@ -56,50 +56,17 @@ missing() {
|
|||||||
! command -v "$1" >/dev/null 2>&1
|
! command -v "$1" >/dev/null 2>&1
|
||||||
}
|
}
|
||||||
|
|
||||||
# verify_sha256 <file> <expected-hash>
|
# goimports is not packaged uniformly across nix/apt/brew/apk, so install it
|
||||||
verify_sha256() {
|
# with `go install` at a pinned version and place the binary in /usr/local/bin
|
||||||
if command -v sha256sum >/dev/null 2>&1; then
|
# so it is on PATH regardless of shell config. Requires go, which main
|
||||||
actual="$(sha256sum "$1" | cut -d' ' -f1)"
|
# installs first.
|
||||||
else
|
ensure_goimports() {
|
||||||
actual="$(shasum -a 256 "$1" | cut -d' ' -f1)"
|
if ! missing goimports; then return 0; fi
|
||||||
fi
|
|
||||||
if [ "$actual" != "$2" ]; then
|
|
||||||
echo "bootstrap: sha256 mismatch for $1" >&2
|
|
||||||
echo " expected: $2" >&2
|
|
||||||
echo " actual: $actual" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# apt has no golangci-lint package: install a pinned release archive
|
|
||||||
# from GitHub, verified by hardcoded sha256 (never curl | sh).
|
|
||||||
install_golangci_lint_release() {
|
|
||||||
case "$(uname -m)" in
|
|
||||||
x86_64) goarch="amd64"; sha="$GOLANGCI_LINT_SHA256_AMD64" ;;
|
|
||||||
aarch64|arm64) goarch="arm64"; sha="$GOLANGCI_LINT_SHA256_ARM64" ;;
|
|
||||||
*)
|
|
||||||
echo "bootstrap: unsupported architecture $(uname -m)" >&2
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
if missing curl; then pkg_install curl curl curl curl; fi
|
|
||||||
name="golangci-lint-${GOLANGCI_LINT_VERSION}-linux-${goarch}"
|
|
||||||
tmp="$(mktemp -d)"
|
|
||||||
curl -fsSL -o "$tmp/$name.tar.gz" \
|
|
||||||
"https://github.com/golangci/golangci-lint/releases/download/v${GOLANGCI_LINT_VERSION}/${name}.tar.gz"
|
|
||||||
verify_sha256 "$tmp/$name.tar.gz" "$sha"
|
|
||||||
tar -xzf "$tmp/$name.tar.gz" -C "$tmp"
|
|
||||||
$SUDO install -m 0755 "$tmp/$name/golangci-lint" /usr/local/bin/golangci-lint
|
|
||||||
rm -rf "$tmp"
|
|
||||||
}
|
|
||||||
|
|
||||||
ensure_golangci_lint() {
|
|
||||||
if ! missing golangci-lint; then return 0; fi
|
|
||||||
detect_pkgmgr
|
detect_pkgmgr
|
||||||
case "$PKGMGR" in
|
tmp="$(mktemp -d)"
|
||||||
apt) install_golangci_lint_release ;;
|
GOBIN="$tmp" go install "golang.org/x/tools/cmd/goimports@${GOIMPORTS_VERSION}"
|
||||||
*) pkg_install golangci-lint golangci-lint golangci-lint golangci-lint ;;
|
$SUDO install -m 0755 "$tmp/goimports" /usr/local/bin/goimports
|
||||||
esac
|
rm -rf "$tmp"
|
||||||
}
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
@@ -109,9 +76,17 @@ main() {
|
|||||||
if missing git; then pkg_install git git git git; fi
|
if missing git; then pkg_install git git git git; fi
|
||||||
if missing make; then pkg_install gnumake make make make; fi
|
if missing make; then pkg_install gnumake make make make; fi
|
||||||
|
|
||||||
# Go toolchain and linter
|
# Go toolchain
|
||||||
if missing go; then pkg_install go golang go go; fi
|
if missing go; then pkg_install go golang go go; fi
|
||||||
ensure_golangci_lint
|
ensure_goimports
|
||||||
|
|
||||||
|
# The linter runs only in Docker (script/lint). Warn, don't fail: the
|
||||||
|
# rest of the repo works without it.
|
||||||
|
if missing docker; then
|
||||||
|
echo "bootstrap: WARNING: docker not found; make lint and" >&2
|
||||||
|
echo "bootstrap: make check require it. Install docker to run" >&2
|
||||||
|
echo "bootstrap: the linter." >&2
|
||||||
|
fi
|
||||||
|
|
||||||
go mod download
|
go mod download
|
||||||
|
|
||||||
|
|||||||
+14
-2
@@ -1,12 +1,24 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/lint: run the linter.
|
# script/lint: run golangci-lint. The linter is never installed on the
|
||||||
|
# host; it runs only inside Docker, from the pinned image in
|
||||||
|
# Dockerfile.lint, so every run uses the same linter version everywhere.
|
||||||
|
# Linting is a build step there, so a successful build is a clean lint.
|
||||||
|
#
|
||||||
|
# GATE_RUN differs every run so the lint layer always executes; a cached
|
||||||
|
# build would otherwise exit 0 in under a second having linted nothing.
|
||||||
|
# --output=type=cacheonly discards the image and keeps only build cache,
|
||||||
|
# so no tagged image is left behind.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
golangci-lint run --config .golangci.yml ./...
|
docker build \
|
||||||
|
--build-arg GATE_RUN="$(date +%s)-$$" \
|
||||||
|
--output=type=cacheonly \
|
||||||
|
-f Dockerfile.lint \
|
||||||
|
.
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user