refactor(source): dedup shared helpers across static + dockerfile plugins
Extract the verbatim-duplicated helpers into shared homes: - buildEnv -> plugin.BuildWorkloadEnv (base plugin pkg; a sourceName param preserves each plugin's slog prefix / log-scraper text) - idShort -> plugin.IDShort - commitStatusReporter -> staticsite.CommitStatusReporter, re-parameterized on primitives (owner/repo/sha/targetURL/enabled) so staticsite needs no dependency on the plugin package; reporter tests ported to staticsite (plus a new nil-provider case) containerNameFor/imageTagFor are intentionally left per-plugin: their prefixes differ (dw-site- vs tf-build-) and name real Docker resources, so merging them would risk mis-routing. Behavior-preserving; the static/dockerfile test suites pass unchanged. Reviewed: go APPROVE (0 CRITICAL/HIGH).
This commit is contained in:
@@ -0,0 +1,55 @@
|
||||
package staticsite
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log/slog"
|
||||
)
|
||||
|
||||
// CommitStatusReporter pushes deploy outcomes back to the git provider as a
|
||||
// commit status, gated on the per-workload report_commit_status flag. It is
|
||||
// strictly best-effort: every call is wrapped so a reporting failure is logged
|
||||
// at Warn and NEVER propagates to fail or block the deploy.
|
||||
//
|
||||
// The provider + identifiers are captured once at deploy start so the hot
|
||||
// transition points (pending/success/failure) read as one-liners. A nil
|
||||
// receiver (reporting disabled) makes Report a no-op, so callers don't have to
|
||||
// guard each transition.
|
||||
//
|
||||
// It lives in the staticsite package (alongside GitProvider / CommitStatus)
|
||||
// rather than the plugin package so the source plugins can share it without
|
||||
// staticsite taking a dependency on plugin. It is parameterized on primitives
|
||||
// (not plugin.Workload) for the same reason.
|
||||
type CommitStatusReporter struct {
|
||||
provider GitProvider
|
||||
owner string
|
||||
repo string
|
||||
sha string
|
||||
targetURL string
|
||||
enabled bool
|
||||
}
|
||||
|
||||
// NewCommitStatusReporter builds a reporter from the resolved deploy inputs.
|
||||
// When enabled is false (report_commit_status off) or the SHA is empty, the
|
||||
// returned reporter's Report method is inert.
|
||||
func NewCommitStatusReporter(provider GitProvider, owner, repo, sha, targetURL string, enabled bool) *CommitStatusReporter {
|
||||
return &CommitStatusReporter{
|
||||
provider: provider,
|
||||
owner: owner,
|
||||
repo: repo,
|
||||
sha: sha,
|
||||
targetURL: targetURL,
|
||||
enabled: enabled,
|
||||
}
|
||||
}
|
||||
|
||||
// Report sends one commit status, swallowing (and logging) any error. Safe to
|
||||
// call on a nil/disabled reporter or with a nil provider/empty SHA.
|
||||
func (r *CommitStatusReporter) Report(ctx context.Context, workloadName, workloadID string, status CommitStatus, description string) {
|
||||
if r == nil || !r.enabled || r.provider == nil || r.sha == "" {
|
||||
return
|
||||
}
|
||||
if err := r.provider.SetCommitStatus(ctx, r.owner, r.repo, r.sha, status, r.targetURL, description); err != nil {
|
||||
slog.Warn("commit-status report failed (ignored)",
|
||||
"workload", workloadName, "workload_id", workloadID, "status", string(status), "error", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,122 @@
|
||||
package staticsite
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// fakeReporterProvider is a stub GitProvider that records SetCommitStatus
|
||||
// calls. Only the methods the reporter exercises are meaningful; the rest
|
||||
// satisfy the interface and panic if ever hit so a mis-wired test is loud.
|
||||
type fakeReporterProvider struct {
|
||||
calls []reporterStatusCall
|
||||
failErr error // when set, SetCommitStatus returns it (best-effort path)
|
||||
}
|
||||
|
||||
type reporterStatusCall struct {
|
||||
owner, repo, sha string
|
||||
status CommitStatus
|
||||
targetURL, descr string
|
||||
}
|
||||
|
||||
func (f *fakeReporterProvider) SetCommitStatus(_ context.Context, owner, repo, sha string, status CommitStatus, targetURL, description string) error {
|
||||
f.calls = append(f.calls, reporterStatusCall{owner, repo, sha, status, targetURL, description})
|
||||
return f.failErr
|
||||
}
|
||||
|
||||
func (*fakeReporterProvider) Name() string { return "fake" }
|
||||
func (*fakeReporterProvider) TestConnection(context.Context, string, string) error {
|
||||
panic("unused")
|
||||
}
|
||||
func (*fakeReporterProvider) ListRepos(context.Context, string) ([]RepoInfo, error) {
|
||||
panic("unused")
|
||||
}
|
||||
func (*fakeReporterProvider) ListBranches(context.Context, string, string) ([]string, error) {
|
||||
panic("unused")
|
||||
}
|
||||
func (*fakeReporterProvider) GetLatestCommitSHA(context.Context, string, string, string) (string, error) {
|
||||
panic("unused")
|
||||
}
|
||||
func (*fakeReporterProvider) ListTree(context.Context, string, string, string) ([]FolderEntry, error) {
|
||||
panic("unused")
|
||||
}
|
||||
func (*fakeReporterProvider) DownloadFolder(context.Context, string, string, string, string, string) error {
|
||||
panic("unused")
|
||||
}
|
||||
|
||||
// Enabled: forwards to the provider with the captured identifiers + target.
|
||||
func TestCommitStatusReporter_Enabled_Calls(t *testing.T) {
|
||||
fp := &fakeReporterProvider{}
|
||||
r := NewCommitStatusReporter(fp, "owner", "pages", "abc123", "https://app.example.com", true)
|
||||
|
||||
r.Report(context.Background(), "site", "wid-1", CommitStatusPending, "Tinyforge: deploying")
|
||||
r.Report(context.Background(), "site", "wid-1", CommitStatusSuccess, "Tinyforge: deployed")
|
||||
|
||||
if len(fp.calls) != 2 {
|
||||
t.Fatalf("calls = %d, want 2", len(fp.calls))
|
||||
}
|
||||
first := fp.calls[0]
|
||||
if first.owner != "owner" || first.repo != "pages" || first.sha != "abc123" {
|
||||
t.Errorf("identifiers wrong: %+v", first)
|
||||
}
|
||||
if first.status != CommitStatusPending {
|
||||
t.Errorf("first status = %q, want pending", first.status)
|
||||
}
|
||||
if first.targetURL != "https://app.example.com" {
|
||||
t.Errorf("targetURL = %q", first.targetURL)
|
||||
}
|
||||
if fp.calls[1].status != CommitStatusSuccess {
|
||||
t.Errorf("second status = %q, want success", fp.calls[1].status)
|
||||
}
|
||||
}
|
||||
|
||||
// Disabled: the reporter is inert.
|
||||
func TestCommitStatusReporter_Disabled_NoCalls(t *testing.T) {
|
||||
fp := &fakeReporterProvider{}
|
||||
r := NewCommitStatusReporter(fp, "owner", "pages", "abc123", "", false)
|
||||
|
||||
r.Report(context.Background(), "site", "wid-1", CommitStatusSuccess, "x")
|
||||
if len(fp.calls) != 0 {
|
||||
t.Fatalf("expected no calls when disabled, got %d", len(fp.calls))
|
||||
}
|
||||
}
|
||||
|
||||
// An empty SHA (e.g. a provider that couldn't resolve the branch) must not
|
||||
// produce a status call even when reporting is enabled.
|
||||
func TestCommitStatusReporter_EmptySHA_NoCalls(t *testing.T) {
|
||||
fp := &fakeReporterProvider{}
|
||||
r := NewCommitStatusReporter(fp, "owner", "pages", "", "", true)
|
||||
|
||||
r.Report(context.Background(), "site", "wid-1", CommitStatusPending, "x")
|
||||
if len(fp.calls) != 0 {
|
||||
t.Fatalf("expected no calls with empty SHA, got %d", len(fp.calls))
|
||||
}
|
||||
}
|
||||
|
||||
// A provider error must be swallowed (best-effort) — Report never panics or
|
||||
// propagates. We assert it returns normally after a failing provider call.
|
||||
func TestCommitStatusReporter_ProviderError_Swallowed(t *testing.T) {
|
||||
fp := &fakeReporterProvider{failErr: errors.New("boom")}
|
||||
r := NewCommitStatusReporter(fp, "owner", "pages", "abc123", "", true)
|
||||
|
||||
// Should not panic / propagate.
|
||||
r.Report(context.Background(), "site", "wid-1", CommitStatusFailure, "Tinyforge: deploy failed")
|
||||
if len(fp.calls) != 1 {
|
||||
t.Fatalf("expected the failing call to still be recorded, got %d", len(fp.calls))
|
||||
}
|
||||
}
|
||||
|
||||
// A nil reporter (constructed only when needed in some call paths) is safe.
|
||||
func TestCommitStatusReporter_NilSafe(t *testing.T) {
|
||||
var r *CommitStatusReporter
|
||||
// Must not panic.
|
||||
r.Report(context.Background(), "site", "wid-1", CommitStatusSuccess, "x")
|
||||
}
|
||||
|
||||
// A nil provider on an enabled reporter is also a no-op (defensive guard).
|
||||
func TestCommitStatusReporter_NilProvider_NoPanic(t *testing.T) {
|
||||
r := NewCommitStatusReporter(nil, "owner", "pages", "abc123", "", true)
|
||||
// Must not panic.
|
||||
r.Report(context.Background(), "site", "wid-1", CommitStatusSuccess, "x")
|
||||
}
|
||||
Reference in New Issue
Block a user