|
| 1 | +package orchestrator |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "encoding/json" |
| 6 | + "net/http" |
| 7 | + "net/http/httptest" |
| 8 | + "strings" |
| 9 | + "testing" |
| 10 | + "time" |
| 11 | + |
| 12 | + "github.com/stretchr/testify/require" |
| 13 | +) |
| 14 | + |
| 15 | +func ownerSeq(n uint64) *uint64 { return &n } |
| 16 | + |
| 17 | +func ownerHeartbeatHTTP(t *testing.T, server *Server, req heartbeatRequest, credential string) *httptest.ResponseRecorder { |
| 18 | + t.Helper() |
| 19 | + body := map[string]any{"runner_id": req.RunnerID, "version": req.Version, "apps": req.Apps} |
| 20 | + if req.Seq != nil { |
| 21 | + body["seq"] = *req.Seq |
| 22 | + } |
| 23 | + return heartbeatHTTP(t, server, body, credential) |
| 24 | +} |
| 25 | + |
| 26 | +func TestOwnerSeqOrdering(t *testing.T) { |
| 27 | + registry, server := reviewServer(t, "http://127.0.0.1:1") |
| 28 | + defer server.Close() |
| 29 | + a := registeredApp("a") |
| 30 | + request := heartbeatRequest{RunnerID: "owner", Seq: ownerSeq(100), Apps: []appRequest{a}} |
| 31 | + initial := ownerHeartbeatHTTP(t, server, request, "bootstrap") |
| 32 | + require.Equal(t, 200, initial.Code, initial.Body.String()) |
| 33 | + var owner heartbeatResponse |
| 34 | + require.NoError(t, json.Unmarshal(initial.Body.Bytes(), &owner)) |
| 35 | + require.Nil(t, owner.Seq, "bootstrap cannot opt an issued credential into ordering") |
| 36 | + request.Seq = nil |
| 37 | + for range 2 { |
| 38 | + w := ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 39 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 40 | + require.NotContains(t, w.Body.String(), `"seq"`) |
| 41 | + } |
| 42 | + lastLegacy := registry.runners["owner"].Last |
| 43 | + for _, seq := range []string{`-1`, `1.5`, `"1"`, `18446744073709551616`, `true`, `[]`} { |
| 44 | + req := httptest.NewRequest(http.MethodPost, "/runners/heartbeat", strings.NewReader(`{"runner_id":"owner","seq":`+seq+`,"apps":[]}`)) |
| 45 | + req.Header.Set("Authorization", owner.HeartbeatSecret) |
| 46 | + w := httptest.NewRecorder() |
| 47 | + server.ServeHTTP(w, req) |
| 48 | + require.Equal(t, 400, w.Code, w.Body.String()) |
| 49 | + require.Nil(t, registry.runners["owner"].Seq) |
| 50 | + require.Equal(t, lastLegacy, registry.runners["owner"].Last) |
| 51 | + require.Contains(t, registry.apps, "a") |
| 52 | + } |
| 53 | + request.Seq = ownerSeq(0) |
| 54 | + w := ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 55 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 56 | + require.Contains(t, w.Body.String(), `"seq":0`, "zero enables ordering") |
| 57 | + request.Seq = nil |
| 58 | + w = ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 59 | + require.Equal(t, 409, w.Code, w.Body.String()) |
| 60 | + request.Seq = ownerSeq(5) |
| 61 | + w = ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 62 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 63 | + require.Contains(t, w.Body.String(), `"seq":5`) |
| 64 | + last := registry.runners["owner"].Last |
| 65 | + for _, seq := range []*uint64{nil, ownerSeq(0), ownerSeq(4), ownerSeq(5)} { |
| 66 | + request.Seq, request.Version = seq, "rejected" |
| 67 | + request.Apps[0].Status = "draining" |
| 68 | + w := ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 69 | + require.Equal(t, 409, w.Code, w.Body.String()) |
| 70 | + require.JSONEq(t, `{"error":"seq must increase after owner opt-in","seq":5}`, w.Body.String()) |
| 71 | + require.Equal(t, last, registry.runners["owner"].Last) |
| 72 | + require.Empty(t, registry.runners["owner"].Version) |
| 73 | + require.Equal(t, "ready", registry.apps["a"].Status) |
| 74 | + } |
| 75 | + other := appHeartbeat(t, registry, "other", "bootstrap", registeredApp("foreign")) |
| 76 | + request.Seq = ownerSeq(50) |
| 77 | + for _, credential := range []string{"", "invalid", "bootstrap", other.HeartbeatSecret} { |
| 78 | + w = ownerHeartbeatHTTP(t, server, request, credential) |
| 79 | + require.Equal(t, 401, w.Code, w.Body.String()) |
| 80 | + require.EqualValues(t, 5, *registry.runners["owner"].Seq) |
| 81 | + require.Equal(t, last, registry.runners["owner"].Last) |
| 82 | + } |
| 83 | + request.Apps[0] = registeredApp("foreign") |
| 84 | + w = ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 85 | + require.Equal(t, 409, w.Code) |
| 86 | + require.JSONEq(t, `{"error":"app id belongs to another runner"}`, w.Body.String()) |
| 87 | + require.EqualValues(t, 5, *registry.runners["owner"].Seq) |
| 88 | + require.Equal(t, last, registry.runners["owner"].Last) |
| 89 | + require.Equal(t, "ready", registry.apps["a"].Status) |
| 90 | + require.Same(t, registry.runners["owner"], registry.apps["a"].owner) |
| 91 | + require.Same(t, registry.runners["other"], registry.apps["foreign"].owner) |
| 92 | + request.Apps[0], request.Seq = a, ownerSeq(9) |
| 93 | + w = ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 94 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 95 | + require.EqualValues(t, 9, *registry.runners["owner"].Seq, "sequence gaps are allowed") |
| 96 | +} |
| 97 | + |
| 98 | +func TestHeartbeatSeqWithdrawalAfterRegistrarRestart(t *testing.T) { |
| 99 | + registry, server := reviewServer(t, "http://127.0.0.1:1") |
| 100 | + defer server.Close() |
| 101 | + a, b := registeredApp("a"), registeredApp("b") |
| 102 | + w := ownerHeartbeatHTTP(t, server, heartbeatRequest{RunnerID: "owner", Apps: []appRequest{a, b}}, "bootstrap") |
| 103 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 104 | + var saved heartbeatResponse |
| 105 | + require.NoError(t, json.Unmarshal(w.Body.Bytes(), &saved)) |
| 106 | + ready := heartbeatRequest{RunnerID: saved.RunnerID, Apps: []appRequest{a, b}, Seq: ownerSeq(1)} |
| 107 | + w = ownerHeartbeatHTTP(t, server, ready, saved.HeartbeatSecret) |
| 108 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 109 | + sidA, _, _, _, err := registry.Reserve("a") |
| 110 | + require.NoError(t, err) |
| 111 | + sidB, _, _, _, err := registry.Reserve("b") |
| 112 | + require.NoError(t, err) |
| 113 | + ctxA, _ := registry.sessionContext("a", sidA) |
| 114 | + ctxB, _ := registry.sessionContext("b", sidB) |
| 115 | + // A restarted registrar withdraws using its saved identity and a newer sequence. |
| 116 | + ready.Seq = ownerSeq(2) |
| 117 | + withdrawn := heartbeatRequest{RunnerID: saved.RunnerID, Apps: []appRequest{b}, Seq: ownerSeq(3)} |
| 118 | + w = ownerHeartbeatHTTP(t, server, withdrawn, saved.HeartbeatSecret) |
| 119 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 120 | + var observed heartbeatResponse |
| 121 | + require.NoError(t, json.Unmarshal(w.Body.Bytes(), &observed)) |
| 122 | + require.Equal(t, []appResponse{{ID: "b", Status: "ready", SessionIDs: []string{sidB}}, {ID: "a", Status: "draining", SessionIDs: []string{sidA}}}, observed.Apps) |
| 123 | + last := registry.runners[saved.RunnerID].Last |
| 124 | + w = ownerHeartbeatHTTP(t, server, ready, saved.HeartbeatSecret) |
| 125 | + require.Equal(t, 409, w.Code, w.Body.String()) |
| 126 | + require.True(t, registry.apps["a"].Removing) |
| 127 | + require.NoError(t, ctxA.Err(), "withdrawal preserves admitted work") |
| 128 | + require.NoError(t, ctxB.Err()) |
| 129 | + _, _, _, status, err := registry.Reserve("a") |
| 130 | + require.Error(t, err) |
| 131 | + require.Equal(t, 404, status) |
| 132 | + // Normal completion removes the withdrawn registration and its session resources. |
| 133 | + registry.ReleaseBySession(sidA, "completed") |
| 134 | + require.ErrorIs(t, ctxA.Err(), context.Canceled) |
| 135 | + require.NotContains(t, registry.apps, "a") |
| 136 | + w = ownerHeartbeatHTTP(t, server, ready, saved.HeartbeatSecret) |
| 137 | + require.Equal(t, 409, w.Code) |
| 138 | + require.NotContains(t, registry.apps, "a", "a stale ready request cannot revive a completed registration") |
| 139 | + require.Equal(t, last, registry.runners[saved.RunnerID].Last) |
| 140 | + withdrawn.Seq = ownerSeq(5) |
| 141 | + w = ownerHeartbeatHTTP(t, server, withdrawn, saved.HeartbeatSecret) |
| 142 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 143 | + require.NoError(t, json.Unmarshal(w.Body.Bytes(), &observed)) |
| 144 | + require.Equal(t, []appResponse{{ID: "b", Status: "ready", SessionIDs: []string{sidB}}}, observed.Apps) |
| 145 | + require.NoError(t, ctxB.Err()) |
| 146 | +} |
| 147 | + |
| 148 | +func TestOwnerSeqScopeReset(t *testing.T) { |
| 149 | + for _, reset := range []string{"expired", "unregistered", "restart"} { |
| 150 | + t.Run(reset, func(t *testing.T) { |
| 151 | + registry, server := reviewServer(t, "http://127.0.0.1:1") |
| 152 | + defer func() { server.Close() }() |
| 153 | + request := heartbeatRequest{RunnerID: "owner", Apps: []appRequest{registeredApp("a")}} |
| 154 | + owner, _, err := registry.Heartbeat(request, "bootstrap") |
| 155 | + require.NoError(t, err) |
| 156 | + request.Seq = ownerSeq(8) |
| 157 | + _, _, err = registry.Heartbeat(request, owner.HeartbeatSecret) |
| 158 | + require.NoError(t, err) |
| 159 | + sid, _, _, _, err := registry.Reserve("a") |
| 160 | + require.NoError(t, err) |
| 161 | + ctx, _ := registry.sessionContext("a", sid) |
| 162 | + switch reset { |
| 163 | + case "expired": |
| 164 | + registry.runners["owner"].Last = time.Now().Add(-2 * time.Minute) |
| 165 | + registry.Expire() |
| 166 | + case "unregistered": |
| 167 | + _, err = registry.Unregister("owner", owner.HeartbeatSecret) |
| 168 | + require.NoError(t, err) |
| 169 | + case "restart": |
| 170 | + server.Close() |
| 171 | + registry, server = reviewServer(t, "http://127.0.0.1:1") |
| 172 | + } |
| 173 | + require.Error(t, ctx.Err()) |
| 174 | + w := ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 175 | + require.Equal(t, 401, w.Code) |
| 176 | + replacement, _, err := registry.Heartbeat(request, "bootstrap") |
| 177 | + require.NoError(t, err) |
| 178 | + require.NotEqual(t, owner.HeartbeatSecret, replacement.HeartbeatSecret) |
| 179 | + require.Nil(t, replacement.Seq) |
| 180 | + w = ownerHeartbeatHTTP(t, server, request, owner.HeartbeatSecret) |
| 181 | + require.Equal(t, 401, w.Code) |
| 182 | + request.Seq = ownerSeq(1) |
| 183 | + w = ownerHeartbeatHTTP(t, server, request, replacement.HeartbeatSecret) |
| 184 | + require.Equal(t, 200, w.Code, w.Body.String()) |
| 185 | + require.Empty(t, registry.sessions) |
| 186 | + require.EqualValues(t, 1, *registry.runners["owner"].Seq) |
| 187 | + }) |
| 188 | + } |
| 189 | +} |
0 commit comments