1// SPDX-License-Identifier: MIT
2
3package api_test
4
5import (
6 "errors"
7 "testing"
8
9 "connectrpc.com/connect"
10
11 "google.golang.org/protobuf/proto"
12 "google.golang.org/protobuf/reflect/protoreflect"
13 "google.golang.org/protobuf/types/known/fieldmaskpb"
14
15 "bnema.dev/ermite-api/gen/ermite"
16 "bnema.dev/ermite-api/gen/ermite/ermiteconnect"
17)
18
19// TestProcedures pins the procedure paths: they are the wire contract.
20func TestProcedures(t *testing.T) {
21 tests := []struct{ got, want string }{
22 {ermiteconnect.RepoServiceListReposProcedure, "/ermite.RepoService/ListRepos"},
23 {ermiteconnect.RepoServiceGetRepoProcedure, "/ermite.RepoService/GetRepo"},
24 {ermiteconnect.RepoServiceCreateRepoProcedure, "/ermite.RepoService/CreateRepo"},
25 {ermiteconnect.RepoServiceUpdateRepoProcedure, "/ermite.RepoService/UpdateRepo"},
26 {ermiteconnect.RepoServiceDeleteRepoProcedure, "/ermite.RepoService/DeleteRepo"},
27 {ermiteconnect.GitServiceListRefsProcedure, "/ermite.GitService/ListRefs"},
28 {ermiteconnect.GitServiceGetTreeProcedure, "/ermite.GitService/GetTree"},
29 {ermiteconnect.GitServiceListPathsProcedure, "/ermite.GitService/ListPaths"},
30 {ermiteconnect.GitServiceGetBlobProcedure, "/ermite.GitService/GetBlob"},
31 {ermiteconnect.GitServiceListCommitsProcedure, "/ermite.GitService/ListCommits"},
32 {ermiteconnect.GitServiceGetCommitProcedure, "/ermite.GitService/GetCommit"},
33 {ermiteconnect.GitServiceResolveRevisionProcedure, "/ermite.GitService/ResolveRevision"},
34 {ermiteconnect.TokenServiceCreateTokenProcedure, "/ermite.TokenService/CreateToken"},
35 {ermiteconnect.TokenServiceListTokensProcedure, "/ermite.TokenService/ListTokens"},
36 {ermiteconnect.TokenServiceRevokeTokenProcedure, "/ermite.TokenService/RevokeToken"},
37 {ermiteconnect.EventServiceWatchProcedure, "/ermite.EventService/Watch"},
38 {ermiteconnect.MergeRequestServiceCreateMergeRequestProcedure, "/ermite.MergeRequestService/CreateMergeRequest"},
39 {ermiteconnect.MergeRequestServiceListMergeRequestsProcedure, "/ermite.MergeRequestService/ListMergeRequests"},
40 {ermiteconnect.MergeRequestServiceGetMergeRequestProcedure, "/ermite.MergeRequestService/GetMergeRequest"},
41 {ermiteconnect.MergeRequestServiceAddCommentProcedure, "/ermite.MergeRequestService/AddComment"},
42 {ermiteconnect.MergeRequestServiceResolveCommentProcedure, "/ermite.MergeRequestService/ResolveComment"},
43 {ermiteconnect.MergeRequestServiceCloseMergeRequestProcedure, "/ermite.MergeRequestService/CloseMergeRequest"},
44 {ermiteconnect.MergeRequestServiceMergeMergeRequestProcedure, "/ermite.MergeRequestService/MergeMergeRequest"},
45 {ermiteconnect.MergeRequestServiceMarkReadProcedure, "/ermite.MergeRequestService/MarkRead"},
46 {ermiteconnect.SessionServiceCreateLoginLinkProcedure, "/ermite.SessionService/CreateLoginLink"},
47 {ermiteconnect.SessionServiceSignOutEverywhereProcedure, "/ermite.SessionService/SignOutEverywhere"},
48 {ermiteconnect.ServerServiceGetVersionProcedure, "/ermite.ServerService/GetVersion"},
49 {ermiteconnect.ServerServiceGetSigningKeyProcedure, "/ermite.ServerService/GetSigningKey"},
50 {ermiteconnect.RunnerServiceRegisterRunnerProcedure, "/ermite.RunnerService/RegisterRunner"},
51 {ermiteconnect.RunnerServiceFetchJobProcedure, "/ermite.RunnerService/FetchJob"},
52 {ermiteconnect.RunnerServiceUpdateJobProcedure, "/ermite.RunnerService/UpdateJob"},
53 {ermiteconnect.RunnerServiceAppendLogProcedure, "/ermite.RunnerService/AppendLog"},
54 {ermiteconnect.RunnerServiceHeartbeatProcedure, "/ermite.RunnerService/Heartbeat"},
55 {ermiteconnect.RunnerServiceWatchJobProcedure, "/ermite.RunnerService/WatchJob"},
56 {ermiteconnect.RunnerServiceCompleteJobProcedure, "/ermite.RunnerService/CompleteJob"},
57 {ermiteconnect.RunnerServiceResolveActionsProcedure, "/ermite.RunnerService/ResolveActions"},
58 {ermiteconnect.RunnerServiceUploadSummaryProcedure, "/ermite.RunnerService/UploadSummary"},
59 {ermiteconnect.RunServiceListRunsProcedure, "/ermite.RunService/ListRuns"},
60 {ermiteconnect.RunServiceGetRunProcedure, "/ermite.RunService/GetRun"},
61 {ermiteconnect.RunServiceGetJobProcedure, "/ermite.RunService/GetJob"},
62 {ermiteconnect.RunServiceGetJobLogProcedure, "/ermite.RunService/GetJobLog"},
63 {ermiteconnect.RunServiceListAnnotationsProcedure, "/ermite.RunService/ListAnnotations"},
64 {ermiteconnect.RunServiceGetStepSummariesProcedure, "/ermite.RunService/GetStepSummaries"},
65 {ermiteconnect.RunServiceCancelRunProcedure, "/ermite.RunService/CancelRun"},
66 {ermiteconnect.RunServiceRerunRunProcedure, "/ermite.RunService/RerunRun"},
67 {ermiteconnect.RunServiceDispatchWorkflowProcedure, "/ermite.RunService/DispatchWorkflow"},
68 {ermiteconnect.RunServiceListChecksProcedure, "/ermite.RunService/ListChecks"},
69 {ermiteconnect.RunServiceListRunnersProcedure, "/ermite.RunService/ListRunners"},
70 {ermiteconnect.RunServiceRemoveRunnerProcedure, "/ermite.RunService/RemoveRunner"},
71 {ermiteconnect.SecretServiceSetSecretProcedure, "/ermite.SecretService/SetSecret"},
72 {ermiteconnect.SecretServiceListSecretsProcedure, "/ermite.SecretService/ListSecrets"},
73 {ermiteconnect.SecretServiceDeleteSecretProcedure, "/ermite.SecretService/DeleteSecret"},
74 {ermiteconnect.VariableServiceSetVariableProcedure, "/ermite.VariableService/SetVariable"},
75 {ermiteconnect.VariableServiceGetVariableProcedure, "/ermite.VariableService/GetVariable"},
76 {ermiteconnect.VariableServiceListVariablesProcedure, "/ermite.VariableService/ListVariables"},
77 {ermiteconnect.VariableServiceDeleteVariableProcedure, "/ermite.VariableService/DeleteVariable"},
78 {ermiteconnect.EnvironmentServiceCreateEnvironmentProcedure, "/ermite.EnvironmentService/CreateEnvironment"},
79 {ermiteconnect.EnvironmentServiceListEnvironmentsProcedure, "/ermite.EnvironmentService/ListEnvironments"},
80 {ermiteconnect.EnvironmentServiceDeleteEnvironmentProcedure, "/ermite.EnvironmentService/DeleteEnvironment"},
81 }
82 for _, tt := range tests {
83 if tt.got != tt.want {
84 t.Errorf("procedure = %q, want %q", tt.got, tt.want)
85 }
86 }
87}
88
89// TestEnumNumbers pins enum numbers: they are part of the wire contract.
90func TestEnumNumbers(t *testing.T) {
91 if got := ermite.Scope_SCOPE_TOKEN_ADMIN; got != 9 {
92 t.Errorf("SCOPE_TOKEN_ADMIN = %d, want 9", got)
93 }
94 if got := ermite.FileStatus_FILE_STATUS_TYPE_CHANGED; got != 6 {
95 t.Errorf("FILE_STATUS_TYPE_CHANGED = %d, want 6", got)
96 }
97 if got := ermite.Visibility_VISIBILITY_PRIVATE; got != 2 {
98 t.Errorf("VISIBILITY_PRIVATE = %d, want 2", got)
99 }
100 if got := ermite.MergeMode_MERGE_MODE_SQUASH; got != 2 {
101 t.Errorf("MERGE_MODE_SQUASH = %d, want 2", got)
102 }
103 if got := ermite.MergeRequestState_MERGE_REQUEST_STATE_CLOSED; got != 3 {
104 t.Errorf("MERGE_REQUEST_STATE_CLOSED = %d, want 3", got)
105 }
106 if got := ermite.DiffSide_DIFF_SIDE_NEW; got != 2 {
107 t.Errorf("DIFF_SIDE_NEW = %d, want 2", got)
108 }
109 enums := []struct {
110 name string
111 got int32
112 want int32
113 }{
114 {"CI_STATUS_UNSPECIFIED", int32(ermite.CiStatus_CI_STATUS_UNSPECIFIED), 0},
115 {"CI_STATUS_QUEUED", int32(ermite.CiStatus_CI_STATUS_QUEUED), 1},
116 {"CI_STATUS_IN_PROGRESS", int32(ermite.CiStatus_CI_STATUS_IN_PROGRESS), 2},
117 {"CI_STATUS_COMPLETED", int32(ermite.CiStatus_CI_STATUS_COMPLETED), 3},
118 {"CI_STATUS_PENDING", int32(ermite.CiStatus_CI_STATUS_PENDING), 4},
119 {"CI_CONCLUSION_UNSPECIFIED", int32(ermite.CiConclusion_CI_CONCLUSION_UNSPECIFIED), 0},
120 {"CI_CONCLUSION_SUCCESS", int32(ermite.CiConclusion_CI_CONCLUSION_SUCCESS), 1},
121 {"CI_CONCLUSION_FAILURE", int32(ermite.CiConclusion_CI_CONCLUSION_FAILURE), 2},
122 {"CI_CONCLUSION_CANCELLED", int32(ermite.CiConclusion_CI_CONCLUSION_CANCELLED), 3},
123 {"CI_CONCLUSION_SKIPPED", int32(ermite.CiConclusion_CI_CONCLUSION_SKIPPED), 4},
124 {"CI_CONCLUSION_TIMED_OUT", int32(ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT), 5},
125 {"CI_CONCLUSION_NEUTRAL", int32(ermite.CiConclusion_CI_CONCLUSION_NEUTRAL), 6},
126 {"CI_CONCLUSION_ACTION_REQUIRED", int32(ermite.CiConclusion_CI_CONCLUSION_ACTION_REQUIRED), 7},
127 {"STEP_STATE_UNSPECIFIED", int32(ermite.StepState_STEP_STATE_UNSPECIFIED), 0},
128 {"STEP_STATE_PENDING", int32(ermite.StepState_STEP_STATE_PENDING), 1},
129 {"STEP_STATE_IN_PROGRESS", int32(ermite.StepState_STEP_STATE_IN_PROGRESS), 2},
130 {"STEP_STATE_COMPLETED", int32(ermite.StepState_STEP_STATE_COMPLETED), 3},
131 {"RUNNER_ISOLATION_UNSPECIFIED", int32(ermite.RunnerIsolation_RUNNER_ISOLATION_UNSPECIFIED), 0},
132 {"RUNNER_ISOLATION_VM", int32(ermite.RunnerIsolation_RUNNER_ISOLATION_VM), 1},
133 {"RUNNER_ISOLATION_CONTAINER_SYSBOX", int32(ermite.RunnerIsolation_RUNNER_ISOLATION_CONTAINER_SYSBOX), 2},
134 {"RUNNER_ISOLATION_CONTAINER_PRIVILEGED", int32(ermite.RunnerIsolation_RUNNER_ISOLATION_CONTAINER_PRIVILEGED), 3},
135 {"CANCEL_REASON_UNSPECIFIED", int32(ermite.CancelReason_CANCEL_REASON_UNSPECIFIED), 0},
136 {"CANCEL_REASON_USER", int32(ermite.CancelReason_CANCEL_REASON_USER), 1},
137 {"CANCEL_REASON_FAIL_FAST", int32(ermite.CancelReason_CANCEL_REASON_FAIL_FAST), 2},
138 {"CANCEL_REASON_TIMEOUT", int32(ermite.CancelReason_CANCEL_REASON_TIMEOUT), 3},
139 {"ANNOTATION_LEVEL_UNSPECIFIED", int32(ermite.AnnotationLevel_ANNOTATION_LEVEL_UNSPECIFIED), 0},
140 {"ANNOTATION_LEVEL_NOTICE", int32(ermite.AnnotationLevel_ANNOTATION_LEVEL_NOTICE), 1},
141 {"ANNOTATION_LEVEL_WARNING", int32(ermite.AnnotationLevel_ANNOTATION_LEVEL_WARNING), 2},
142 {"ANNOTATION_LEVEL_FAILURE", int32(ermite.AnnotationLevel_ANNOTATION_LEVEL_FAILURE), 3},
143 {"ACTION_SOURCE_UNSPECIFIED", int32(ermite.ActionSource_ACTION_SOURCE_UNSPECIFIED), 0},
144 {"ACTION_SOURCE_GITHUB", int32(ermite.ActionSource_ACTION_SOURCE_GITHUB), 1},
145 {"ACTION_SOURCE_ERMITE", int32(ermite.ActionSource_ACTION_SOURCE_ERMITE), 2},
146 }
147 for _, e := range enums {
148 if e.got != e.want {
149 t.Errorf("%s = %d, want %d", e.name, e.got, e.want)
150 }
151 }
152}
153
154// TestEventRoundTrip checks that an event with a oneof kind survives the wire.
155func TestEventRoundTrip(t *testing.T) {
156 in := &ermite.WatchResponse{Event: &ermite.Event{
157 Id: "42",
158 Kind: &ermite.Event_Pushed{Pushed: &ermite.Pushed{
159 Repo: "ermite",
160 RefUpdates: []*ermite.RefUpdate{
161 {Ref: "refs/heads/main", OldId: "a", NewId: "b"},
162 },
163 }},
164 }}
165 b, err := proto.Marshal(in)
166 if err != nil {
167 t.Fatal(err)
168 }
169 var out ermite.WatchResponse
170 if err := proto.Unmarshal(b, &out); err != nil {
171 t.Fatal(err)
172 }
173 if !proto.Equal(in, &out) {
174 t.Errorf("round trip mismatch: %v != %v", &out, in)
175 }
176 if out.GetEvent().GetPushed().GetRefUpdates()[0].GetNewId() != "b" {
177 t.Errorf("unexpected ref update: %v", &out)
178 }
179}
180
181// TestUpdateRepoMask checks that the request carries a field mask.
182func TestUpdateRepoMask(t *testing.T) {
183 req := &ermite.UpdateRepoRequest{
184 Repo: "ermite",
185 Visibility: ermite.Visibility_VISIBILITY_PUBLIC,
186 UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"visibility"}},
187 }
188 if got := req.GetUpdateMask().GetPaths(); len(got) != 1 || got[0] != "visibility" {
189 t.Errorf("paths = %v", got)
190 }
191}
192
193// TestMergeRequestEventRoundTrip checks the merge request event kinds and the
194// repository settings survive the wire.
195func TestMergeRequestEventRoundTrip(t *testing.T) {
196 in := &ermite.WatchResponse{Event: &ermite.Event{
197 Id: "43",
198 Kind: &ermite.Event_CommentAdded{CommentAdded: &ermite.CommentAdded{
199 Repo: "ermite",
200 Number: 7,
201 Comment: &ermite.Comment{
202 Id: "c1", Path: "a.go", Line: 3, Side: ermite.DiffSide_DIFF_SIDE_OLD, Text: "hi",
203 },
204 }},
205 }}
206 b, err := proto.Marshal(in)
207 if err != nil {
208 t.Fatal(err)
209 }
210 var out ermite.WatchResponse
211 if err := proto.Unmarshal(b, &out); err != nil {
212 t.Fatal(err)
213 }
214 if !proto.Equal(in, &out) {
215 t.Errorf("round trip mismatch: %v != %v", &out, in)
216 }
217 if got := out.GetEvent().GetCommentAdded().GetNumber(); got != 7 {
218 t.Errorf("number = %d, want 7", got)
219 }
220
221 req := &ermite.UpdateRepoRequest{
222 Repo: "ermite",
223 Settings: &ermite.RepoSettings{
224 AllowedMergeModes: []ermite.MergeMode{ermite.MergeMode_MERGE_MODE_SQUASH},
225 FailingChecksBlock: true,
226 },
227 UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"settings.allowed_merge_modes", "settings.failing_checks_block"}},
228 }
229 if got := req.GetSettings().GetAllowedMergeModes(); len(got) != 1 || got[0] != ermite.MergeMode_MERGE_MODE_SQUASH {
230 t.Errorf("modes = %v", got)
231 }
232}
233
234// TestCIEventRoundTrip checks that the CI event kinds keep their field numbers
235// and survive the wire.
236func TestCIEventRoundTrip(t *testing.T) {
237 in := &ermite.WatchResponse{Event: &ermite.Event{
238 Id: "44",
239 Kind: &ermite.Event_JobUpdated{JobUpdated: &ermite.JobUpdated{Job: &ermite.RunJob{
240 Id: "j1",
241 RunId: 9,
242 Attempt: 2,
243 Status: ermite.CiStatus_CI_STATUS_COMPLETED,
244 Conclusion: ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT,
245 Isolation: ermite.RunnerIsolation_RUNNER_ISOLATION_VM,
246 Steps: []*ermite.Step{{Number: 1, Name: "Set up job", LogStart: 0, LogEnd: 3}},
247 }}},
248 }}
249 b, err := proto.Marshal(in)
250 if err != nil {
251 t.Fatal(err)
252 }
253 var out ermite.WatchResponse
254 if err := proto.Unmarshal(b, &out); err != nil {
255 t.Fatal(err)
256 }
257 if !proto.Equal(in, &out) {
258 t.Errorf("round trip mismatch: %v != %v", &out, in)
259 }
260 f := (&ermite.Event{}).ProtoReflect().Descriptor().Fields()
261 for name, num := range map[string]int{"run_updated": 12, "job_updated": 13} {
262 if fd := f.ByName(protoreflect.Name(name)); fd == nil || int(fd.Number()) != num {
263 t.Errorf("event field %s: %v, want number %d", name, fd, num)
264 }
265 }
266}
267
268// TestJobRoundTrip checks the job handed to a runner survives the wire.
269func TestJobRoundTrip(t *testing.T) {
270 in := &ermite.FetchJobResponse{Job: &ermite.Job{
271 JobId: "j1", RunId: 9, Attempt: 1, JobToken: "tok", WorkflowPath: ".github/workflows/ci.yml",
272 WorkflowYaml: "on: push", JobKey: "build", Matrix: "{}", Contexts: "{}",
273 Labels: []string{"self-hosted"}, TimeoutMinutes: 360, Repo: "ermite",
274 Sha: "0123456789012345678901234567890123456789", Ref: "refs/heads/main",
275 }}
276 b, err := proto.Marshal(in)
277 if err != nil {
278 t.Fatal(err)
279 }
280 var out ermite.FetchJobResponse
281 if err := proto.Unmarshal(b, &out); err != nil {
282 t.Fatal(err)
283 }
284 if !proto.Equal(in, &out) {
285 t.Errorf("round trip mismatch: %v != %v", &out, in)
286 }
287}
288
289// TestWatchJobRoundTrip checks the three kinds of WatchJob message and the
290// JobEnded detail.
291func TestWatchJobRoundTrip(t *testing.T) {
292 msgs := []*ermite.WatchJobResponse{
293 {Msg: &ermite.WatchJobResponse_Keepalive{Keepalive: &ermite.Keepalive{}}},
294 {Msg: &ermite.WatchJobResponse_Cancel{Cancel: &ermite.CancelRequest{
295 Reason: ermite.CancelReason_CANCEL_REASON_FAIL_FAST, Message: "m",
296 }}},
297 {Msg: &ermite.WatchJobResponse_Ended{Ended: &ermite.JobEnded{
298 Conclusion: ermite.CiConclusion_CI_CONCLUSION_CANCELLED, Error: "e",
299 }}},
300 }
301 for _, in := range msgs {
302 b, err := proto.Marshal(in)
303 if err != nil {
304 t.Fatal(err)
305 }
306 var out ermite.WatchJobResponse
307 if err := proto.Unmarshal(b, &out); err != nil {
308 t.Fatal(err)
309 }
310 if !proto.Equal(in, &out) {
311 t.Errorf("round trip mismatch: %v != %v", &out, in)
312 }
313 }
314 // The detail travels in a Connect error.
315 d, err := connect.NewErrorDetail(&ermite.JobEnded{Conclusion: ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT})
316 if err != nil {
317 t.Fatal(err)
318 }
319 cerr := connect.NewError(connect.CodeFailedPrecondition, errors.New("job ended"))
320 cerr.AddDetail(d)
321 v, err := cerr.Details()[0].Value()
322 if err != nil {
323 t.Fatal(err)
324 }
325 if got := v.(*ermite.JobEnded).GetConclusion(); got != ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT {
326 t.Errorf("detail conclusion = %v", got)
327 }
328}
329
330// TestCompleteJobRoundTrip checks the final report of a job and its answer.
331func TestCompleteJobRoundTrip(t *testing.T) {
332 in := &ermite.CompleteJobRequest{
333 JobId: "j1",
334 Conclusion: ermite.CiConclusion_CI_CONCLUSION_CANCELLED,
335 Outputs: map[string]string{"a": "b"},
336 RunnerShutdown: true,
337 Steps: []*ermite.StepUpdate{{Number: 2, State: ermite.StepState_STEP_STATE_COMPLETED}},
338 }
339 b, err := proto.Marshal(in)
340 if err != nil {
341 t.Fatal(err)
342 }
343 var out ermite.CompleteJobRequest
344 if err := proto.Unmarshal(b, &out); err != nil {
345 t.Fatal(err)
346 }
347 if !proto.Equal(in, &out) {
348 t.Errorf("round trip mismatch: %v != %v", &out, in)
349 }
350 r := &ermite.CompleteJobResponse{Applied: false, Conclusion: ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT}
351 if r.GetApplied() || r.GetConclusion() != ermite.CiConclusion_CI_CONCLUSION_TIMED_OUT {
352 t.Errorf("unexpected response %v", r)
353 }
354}
355
356// TestRunNameField pins the number of Run.name, the GitHub name of the run
357// that sits next to workflow_name, and that it survives the wire.
358func TestRunNameField(t *testing.T) {
359 fd := (&ermite.Run{}).ProtoReflect().Descriptor().Fields().ByName("name")
360 if fd == nil || fd.Number() != 19 {
361 t.Fatalf("Run.name = %v, want field 19", fd)
362 }
363 in := &ermite.Run{WorkflowName: "Names Workflow", Name: "run push on branch by someone", Title: "run push on branch by someone"}
364 b, err := proto.Marshal(in)
365 if err != nil {
366 t.Fatal(err)
367 }
368 var out ermite.Run
369 if err := proto.Unmarshal(b, &out); err != nil {
370 t.Fatal(err)
371 }
372 if out.GetName() != in.GetName() || out.GetWorkflowName() != "Names Workflow" {
373 t.Errorf("round trip: name %q, workflow_name %q", out.GetName(), out.GetWorkflowName())
374 }
375}
376
377// TestCI2FieldNumbers pins the numbers of the fields added for CI-2.
378func TestCI2FieldNumbers(t *testing.T) {
379 tests := []struct {
380 msg proto.Message
381 fields map[string]int
382 }{
383 {&ermite.Job{}, map[string]int{"github_token": 15}},
384 {&ermite.UpdateJobRequest{}, map[string]int{"annotations": 3}},
385 {&ermite.CompleteJobRequest{}, map[string]int{"annotations": 6}},
386 {&ermite.StepUpdate{}, map[string]int{"outcome": 7}},
387 {&ermite.Step{}, map[string]int{"outcome": 9}},
388 {&ermite.Annotation{}, map[string]int{
389 "level": 1, "title": 2, "message": 3, "file": 4, "start_line": 5,
390 "end_line": 6, "start_column": 7, "end_column": 8, "step_number": 9,
391 }},
392 {&ermite.ActionRef{}, map[string]int{"uses": 1}},
393 {&ermite.ResolveActionsRequest{}, map[string]int{"job_id": 1, "refs": 2}},
394 {&ermite.ResolveActionsResponse{}, map[string]int{"actions": 1}},
395 {&ermite.ResolvedAction{}, map[string]int{
396 "ref": 1, "name_with_owner": 2, "path": 3, "resolved_sha": 4,
397 "tarball_url": 5, "token": 6, "source": 7, "error": 8,
398 }},
399 {&ermite.UploadSummaryRequest{}, map[string]int{"job_id": 1, "step_number": 2, "markdown": 3}},
400 {&ermite.ListAnnotationsRequest{}, map[string]int{"repo": 1, "run_id": 2, "attempt": 3, "job_id": 4}},
401 {&ermite.ListAnnotationsResponse{}, map[string]int{"annotations": 1, "truncated": 2}},
402 {&ermite.JobAnnotation{}, map[string]int{"job_id": 1, "annotation": 2}},
403 {&ermite.GetStepSummariesRequest{}, map[string]int{"repo": 1, "job_id": 2, "attempt": 3}},
404 {&ermite.GetStepSummariesResponse{}, map[string]int{"summaries": 1, "truncated": 2}},
405 {&ermite.StepSummary{}, map[string]int{"step_number": 1, "markdown": 2}},
406 }
407 for _, tt := range tests {
408 md := tt.msg.ProtoReflect().Descriptor()
409 for name, num := range tt.fields {
410 if fd := md.Fields().ByName(protoreflect.Name(name)); fd == nil || int(fd.Number()) != num {
411 t.Errorf("%s.%s: %v, want number %d", md.Name(), name, fd, num)
412 }
413 }
414 }
415}
416
417// TestCI2RoundTrip checks that the CI-2 messages survive the wire.
418func TestCI2RoundTrip(t *testing.T) {
419 msgs := []proto.Message{
420 &ermite.Job{JobId: "j1", GithubToken: "ermitegh_x"},
421 &ermite.UpdateJobRequest{
422 JobId: "j1",
423 Steps: []*ermite.StepUpdate{{
424 Number: 2, State: ermite.StepState_STEP_STATE_COMPLETED,
425 Conclusion: ermite.CiConclusion_CI_CONCLUSION_SUCCESS,
426 Outcome: ermite.CiConclusion_CI_CONCLUSION_FAILURE,
427 }},
428 Annotations: []*ermite.Annotation{{
429 Level: ermite.AnnotationLevel_ANNOTATION_LEVEL_WARNING, Title: "t", Message: "m",
430 File: "a.go", StartLine: 1, EndLine: 2, StartColumn: 3, EndColumn: 4, StepNumber: 2,
431 }},
432 },
433 &ermite.CompleteJobRequest{
434 JobId: "j1",
435 Conclusion: ermite.CiConclusion_CI_CONCLUSION_SUCCESS,
436 Annotations: []*ermite.Annotation{{Level: ermite.AnnotationLevel_ANNOTATION_LEVEL_FAILURE, Message: "m", StepNumber: 3}},
437 },
438 &ermite.ResolveActionsRequest{JobId: "j1", Refs: []*ermite.ActionRef{{Uses: "actions/checkout@v4"}, {Uses: "o/r/p@main"}}},
439 &ermite.ResolveActionsResponse{Actions: []*ermite.ResolvedAction{
440 {
441 Ref: "o/r/p@main", NameWithOwner: "o/r", Path: "p", ResolvedSha: "0123456789012345678901234567890123456789",
442 TarballUrl: "https://example.test/o/r.tar.gz", Token: "t", Source: ermite.ActionSource_ACTION_SOURCE_ERMITE,
443 },
444 {Ref: "x/y@z", Error: "Unable to resolve action `x/y@z`, unable to find version `z`"},
445 }},
446 &ermite.UploadSummaryRequest{JobId: "j1", StepNumber: 2, Markdown: "# hi"},
447 &ermite.ListAnnotationsResponse{Annotations: []*ermite.JobAnnotation{{JobId: "j1", Annotation: &ermite.Annotation{Message: "m"}}}, Truncated: true},
448 &ermite.GetStepSummariesResponse{Summaries: []*ermite.StepSummary{{StepNumber: 2, Markdown: "# hi"}}, Truncated: true},
449 &ermite.RunJob{Id: "j1", Steps: []*ermite.Step{{Number: 2, Outcome: ermite.CiConclusion_CI_CONCLUSION_FAILURE}}},
450 }
451 for _, in := range msgs {
452 b, err := proto.Marshal(in)
453 if err != nil {
454 t.Fatal(err)
455 }
456 out := in.ProtoReflect().New().Interface()
457 if err := proto.Unmarshal(b, out); err != nil {
458 t.Fatal(err)
459 }
460 if !proto.Equal(in, out) {
461 t.Errorf("%T: round trip mismatch: %v != %v", in, out, in)
462 }
463 }
464}
465
466// TestCI3FieldNumbers pins the numbers of the fields added for CI-3.
467func TestCI3FieldNumbers(t *testing.T) {
468 tests := []struct {
469 msg proto.Message
470 fields map[string]int
471 }{
472 {&ermite.Job{}, map[string]int{
473 "secrets": 16, "vars": 17, "environment": 18, "permissions": 19, "cache": 20, "trusted": 21,
474 }},
475 {&ermite.JobPermissions{}, map[string]int{"levels": 1}},
476 {&ermite.JobCache{}, map[string]int{"repository": 1, "write_ref": 2, "read_refs": 3}},
477 {&ermite.Run{}, map[string]int{"trusted": 20}},
478 {&ermite.RunJob{}, map[string]int{"concurrency_group": 20}},
479 {&ermite.DispatchWorkflowRequest{}, map[string]int{"repo": 1, "workflow_path": 2, "ref": 3, "inputs": 4}},
480 {&ermite.DispatchWorkflowResponse{}, map[string]int{"run": 1}},
481 {&ermite.SettingsScope{}, map[string]int{"instance": 1, "repo": 2, "environment": 3}},
482 {&ermite.EnvironmentRef{}, map[string]int{"repo": 1, "name": 2}},
483 {&ermite.Secret{}, map[string]int{"name": 1, "updated_at": 2}},
484 {&ermite.Variable{}, map[string]int{"name": 1, "value": 2, "updated_at": 3}},
485 {&ermite.Environment{}, map[string]int{"repo": 1, "name": 2, "created_at": 3}},
486 {&ermite.SetSecretRequest{}, map[string]int{"scope": 1, "name": 2, "value": 3}},
487 {&ermite.ListSecretsRequest{}, map[string]int{"scope": 1, "page_size": 2, "page_token": 3}},
488 {&ermite.ListSecretsResponse{}, map[string]int{"secrets": 1, "next_page_token": 2}},
489 {&ermite.ListVariablesResponse{}, map[string]int{"variables": 1, "next_page_token": 2}},
490 {&ermite.ListEnvironmentsRequest{}, map[string]int{"repo": 1, "page_size": 2, "page_token": 3}},
491 {&ermite.ListEnvironmentsResponse{}, map[string]int{"environments": 1, "next_page_token": 2}},
492 }
493 for _, tt := range tests {
494 md := tt.msg.ProtoReflect().Descriptor()
495 for name, num := range tt.fields {
496 if fd := md.Fields().ByName(protoreflect.Name(name)); fd == nil || int(fd.Number()) != num {
497 t.Errorf("%s.%s: %v, want number %d", md.Name(), name, fd, num)
498 }
499 }
500 }
501}
502
503// TestCI3RoundTrip checks that the CI-3 messages survive the wire.
504func TestCI3RoundTrip(t *testing.T) {
505 msgs := []proto.Message{
506 &ermite.Job{
507 JobId: "j1", Secrets: map[string]string{"TOKEN": "s3cret"}, Vars: map[string]string{"REGION": "eu"},
508 Environment: "staging", Trusted: true,
509 Permissions: &ermite.JobPermissions{Levels: map[string]string{"contents": "write", "packages": "none"}},
510 Cache: &ermite.JobCache{
511 Repository: "ermite", WriteRef: "refs/pull/7/merge",
512 ReadRefs: []string{"refs/pull/7/merge", "refs/heads/main"},
513 },
514 },
515 &ermite.Run{Id: 9, Event: "workflow_dispatch", Trusted: true},
516 &ermite.RunJob{Id: "j1", Status: ermite.CiStatus_CI_STATUS_PENDING, ConcurrencyGroup: "deploy"},
517 &ermite.DispatchWorkflowRequest{Repo: "ermite", WorkflowPath: "ci.yml", Ref: "main", Inputs: map[string]string{"debug": "true"}},
518 &ermite.DispatchWorkflowResponse{Run: &ermite.Run{Id: 9, Event: "workflow_dispatch"}},
519 &ermite.SetSecretRequest{Scope: &ermite.SettingsScope{Where: &ermite.SettingsScope_Instance{Instance: true}}, Name: "A", Value: "v"},
520 &ermite.SetSecretRequest{Scope: &ermite.SettingsScope{Where: &ermite.SettingsScope_Repo{Repo: "ermite"}}, Name: "A", Value: "v"},
521 &ermite.SetVariableRequest{
522 Scope: &ermite.SettingsScope{Where: &ermite.SettingsScope_Environment{Environment: &ermite.EnvironmentRef{Repo: "ermite", Name: "prod"}}},
523 Name: "A", Value: "v",
524 },
525 &ermite.ListSecretsResponse{Secrets: []*ermite.Secret{{Name: "A"}}, NextPageToken: "t"},
526 &ermite.ListEnvironmentsResponse{Environments: []*ermite.Environment{{Repo: "ermite", Name: "prod"}}},
527 }
528 for _, in := range msgs {
529 b, err := proto.Marshal(in)
530 if err != nil {
531 t.Fatal(err)
532 }
533 out := in.ProtoReflect().New().Interface()
534 if err := proto.Unmarshal(b, out); err != nil {
535 t.Fatal(err)
536 }
537 if !proto.Equal(in, out) {
538 t.Errorf("%T: round trip mismatch: %v != %v", in, out, in)
539 }
540 }
541}