|
| 1 | +// Copyright (c) 2025 Uber Technologies, Inc. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +// Package fake provides a buildrunner.BuildRunner whose outcome is driven by the |
| 16 | +// triggered changes. With no marker every build immediately succeeds, behaving |
| 17 | +// as a best-case stub for wiring and baselines. Failures are injected by |
| 18 | +// embedding a marker token in a head change URI of the form "sq-fake=<token>": |
| 19 | +// |
| 20 | +// sq-fake=trigger-error -> Trigger returns a non-nil error |
| 21 | +// sq-fake=build-fail -> Status reports BuildStatusFailed |
| 22 | +// sq-fake=build-error -> Status returns a non-nil error |
| 23 | +// |
| 24 | +// The runner is stateless: Trigger encodes the desired terminal outcome into the |
| 25 | +// returned BuildID, and Status decides the result purely from the BuildID it is |
| 26 | +// given — no per-build bookkeeping. This means any runner instance can answer |
| 27 | +// Status for an ID minted by any other (Trigger and Status can even live in |
| 28 | +// different controllers/processes), and a single running stack can exercise the |
| 29 | +// negative paths purely by varying request payloads. It is intended for examples |
| 30 | +// and tests only, never production. |
| 31 | +package fake |
| 32 | + |
| 33 | +import ( |
| 34 | + "context" |
| 35 | + "crypto/rand" |
| 36 | + "encoding/hex" |
| 37 | + "fmt" |
| 38 | + "strings" |
| 39 | + |
| 40 | + "github.com/uber/submitqueue/submitqueue/core/fakemarker" |
| 41 | + "github.com/uber/submitqueue/submitqueue/entity" |
| 42 | + "github.com/uber/submitqueue/submitqueue/extension/buildrunner" |
| 43 | +) |
| 44 | + |
| 45 | +// Recognized marker tokens. See the package doc for the convention. |
| 46 | +const ( |
| 47 | + tokenTriggerError = "trigger-error" |
| 48 | + tokenFail = "build-fail" |
| 49 | + tokenError = "build-error" |
| 50 | +) |
| 51 | + |
| 52 | +// outcomeOK is the BuildID outcome segment for a build that should succeed. |
| 53 | +const outcomeOK = "ok" |
| 54 | + |
| 55 | +// runner is a buildrunner.BuildRunner that reports every build as succeeded |
| 56 | +// unless a marker token in a head change URI requests otherwise. It holds no |
| 57 | +// per-build state: the outcome is encoded in the BuildID at Trigger and read |
| 58 | +// back out at Status. Uniqueness comes from a random suffix per ID, so it needs |
| 59 | +// no shared counter and never collides across instances or processes. |
| 60 | +type runner struct{} |
| 61 | + |
| 62 | +// New returns a buildrunner.BuildRunner that defaults to succeeding and honors |
| 63 | +// marker tokens embedded in head change URIs. |
| 64 | +func New() buildrunner.BuildRunner { |
| 65 | + return &runner{} |
| 66 | +} |
| 67 | + |
| 68 | +// Trigger fails when a head change URI carries the trigger-error marker; |
| 69 | +// otherwise it returns a unique BuildID that encodes the terminal outcome the |
| 70 | +// build should report at Status time (decided from the head marker). The base |
| 71 | +// changes and metadata are ignored. |
| 72 | +func (r *runner) Trigger(_ context.Context, _ []entity.Change, head []entity.Change, _ entity.BuildMetadata) (entity.BuildID, error) { |
| 73 | + outcome := outcomeOK |
| 74 | + switch fakemarker.TokenInChanges(head) { |
| 75 | + case tokenTriggerError: |
| 76 | + return entity.BuildID{}, fmt.Errorf("fake: marked trigger error") |
| 77 | + case tokenFail: |
| 78 | + outcome = tokenFail |
| 79 | + case tokenError: |
| 80 | + outcome = tokenError |
| 81 | + } |
| 82 | + |
| 83 | + // Encode the outcome in the ID (e.g. "fake-build-fail-a1b2c3d4") so Status is |
| 84 | + // stateless. The random suffix keeps IDs globally unique across instances and |
| 85 | + // processes — the BuildID uniqueness contract — without any shared state. |
| 86 | + suffix, err := randomSuffix() |
| 87 | + if err != nil { |
| 88 | + return entity.BuildID{}, fmt.Errorf("fake: generating build id: %w", err) |
| 89 | + } |
| 90 | + id := fmt.Sprintf("fake-%s-%s", outcome, suffix) |
| 91 | + return entity.BuildID{ID: id}, nil |
| 92 | +} |
| 93 | + |
| 94 | +// randomSuffix returns a short random hex string used to keep fake BuildIDs |
| 95 | +// globally unique. Hex digits never spell the outcome marker tokens, so the |
| 96 | +// suffix cannot interfere with Status decoding the outcome via substring match. |
| 97 | +func randomSuffix() (string, error) { |
| 98 | + var b [4]byte |
| 99 | + if _, err := rand.Read(b[:]); err != nil { |
| 100 | + return "", err |
| 101 | + } |
| 102 | + return hex.EncodeToString(b[:]), nil |
| 103 | +} |
| 104 | + |
| 105 | +// Status decides the result purely from the BuildID's encoded outcome. IDs that |
| 106 | +// carry no recognized outcome (including those not minted by this fake) default |
| 107 | +// to succeeded, keeping the runner best-case. |
| 108 | +func (r *runner) Status(_ context.Context, buildID entity.BuildID) (entity.BuildStatus, entity.BuildMetadata, error) { |
| 109 | + switch { |
| 110 | + case strings.Contains(buildID.ID, tokenError): |
| 111 | + return entity.BuildStatusUnknown, nil, fmt.Errorf("fake: marked build error") |
| 112 | + case strings.Contains(buildID.ID, tokenFail): |
| 113 | + return entity.BuildStatusFailed, nil, nil |
| 114 | + default: |
| 115 | + return entity.BuildStatusSucceeded, nil, nil |
| 116 | + } |
| 117 | +} |
| 118 | + |
| 119 | +// Cancel is a no-op and always succeeds. |
| 120 | +func (r *runner) Cancel(_ context.Context, _ entity.BuildID) error { |
| 121 | + return nil |
| 122 | +} |
0 commit comments