Files
substrate/cmd/ateapi/internal/controlapi/workflow_testutil_test.go
T
Zoe Zhao 6d3afdd63b Resolve SandboxConfig from the ActorTemplate instead of the WorkerPool (#1446)
This PR moves sandbox config selection from the WorkerPool to the
ActorTemplate.

The existing behavior is preserved while we are designing the upgrade:
sandbox config still cannot be updated once set (ActorTemplates are
create-only and `sandbox_config` is immutable).

For now the ActorTemplate still *requires* `sandbox_config.config_name`
— there is no resolution of the cluster default (`spec.default`). This
is temporary while we figure out the defaulting design.

- [ ] Tests pass
- [x] Appropriate changes to documentation are included in the PR
2026-09-03 16:13:07 -07:00

111 lines
4.1 KiB
Go

// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package controlapi
import (
"context"
"errors"
"slices"
"testing"
"github.com/agent-substrate/substrate/cmd/ateapi/internal/store"
"github.com/agent-substrate/substrate/cmd/ateapi/internal/store/storetest"
"github.com/agent-substrate/substrate/internal/resources"
"github.com/agent-substrate/substrate/pkg/proto/ateapipb"
"github.com/google/uuid"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
// testWorkerUID derives a stable pod UID from a pod name, for Workers seeded
// straight into the store.
func testWorkerUID(podName string) string {
return uuid.NewSHA1(uuid.NameSpaceDNS, []byte(podName)).String()
}
// newTestActorWorkflow builds an ActorWorkflow backed by the given store,
// with one minimal ActorTemplate stored in tmplAtespace. Dependencies the
// unit tests never reach (worker cache, atelet dialer, k8s clients) are nil,
// so a step that unexpectedly executes against them fails the test loudly.
func newTestActorWorkflow(t *testing.T, st store.Interface, tmplAtespace, tmplName string) *ActorWorkflow {
t.Helper()
storetest.MustCreateAtespace(t, context.Background(), st, tmplAtespace)
if _, err := st.CreateActorTemplate(context.Background(), &ateapipb.ActorTemplate{
Metadata: &ateapipb.ResourceMetadata{Atespace: tmplAtespace, Name: tmplName},
SnapshotsConfig: &ateapipb.SnapshotsConfig{
StorageLocation: "gs://snapshots",
},
SandboxConfig: &ateapipb.SandboxConfig{
SandboxClass: ateapipb.SandboxClass_SANDBOX_CLASS_GVISOR,
ConfigName: "gvisor",
},
}); err != nil && !errors.Is(err, store.ErrAlreadyExists) {
t.Fatalf("create test ActorTemplate: %v", err)
}
return NewActorWorkflow(st, nil, nil, nil, nil, nil, "", nil)
}
// seedWorkflowActor stores an actor with the given state, bound to the given
// template (pass the same tmplAtespace/tmplName as newTestActorWorkflow).
// opts mutate the actor before it is stored.
func seedWorkflowActor(t *testing.T, ctx context.Context, st store.Interface, actorRef resources.ActorRef, tmplAtespace, tmplName string, actorState ateapipb.ActorState, opts ...func(*ateapipb.Actor)) {
t.Helper()
actor := &ateapipb.Actor{
Metadata: &ateapipb.ResourceMetadata{Name: actorRef.Name, Atespace: actorRef.Atespace},
Status: &ateapipb.ActorStatus{State: actorState},
ActorTemplate: &ateapipb.ObjectRef{Atespace: tmplAtespace, Name: tmplName},
}
for _, opt := range opts {
opt(actor)
}
storetest.MustCreateActor(t, ctx, st, actor)
}
// allActorStates enumerates every ActorState value, for exhaustive
// CheckPrerequisite table tests. It is derived from the generated enum map so
// states added to the proto are covered automatically.
var allActorStates = func() []ateapipb.ActorState {
nums := make([]int32, 0, len(ateapipb.ActorState_name))
for n := range ateapipb.ActorState_name {
nums = append(nums, n)
}
slices.Sort(nums)
states := make([]ateapipb.ActorState, 0, len(nums))
for _, n := range nums {
states = append(states, ateapipb.ActorState(n))
}
return states
}()
// assertPrerequisiteResult verifies a CheckPrerequisite outcome for one
// state: nil when allowed, FailedPrecondition otherwise.
func assertPrerequisiteResult(t *testing.T, st ateapipb.ActorState, err error, wantAllowed bool) {
t.Helper()
if wantAllowed {
if err != nil {
t.Errorf("state %v: CheckPrerequisite = %v, want nil", st, err)
}
return
}
if err == nil {
t.Errorf("state %v: CheckPrerequisite = nil, want FailedPrecondition", st)
return
}
if got := status.Code(err); got != codes.FailedPrecondition {
t.Errorf("state %v: status.Code = %v, want %v", st, got, codes.FailedPrecondition)
}
}