Files
substrate/cmd/ateapi/internal/controlapi/create_actor_test.go
T
Benjamin Elder da8414bbd2 api: move the pause image from ActorTemplate to SandboxConfig (#848)
The pause image holds the sandbox's namespaces and runs no workload
code. It is an implementation detail of the sandbox, not something actor
authors pick, so it belongs with the sandbox binaries that already moved
off the ActorTemplate onto the cluster-scoped SandboxConfig.

It now travels with those binaries end to end: resolved from the pool's
SandboxConfig, carried on ateletpb.SandboxAssets rather than
WorkloadSpec, and recorded in the per-actor sandbox record so Checkpoint
pins it into the snapshot manifest and Restore rebuilds the sandbox from
the image the snapshot was taken with (the golden's on a DATA_ON_GOLDEN
restore). A record without one is rejected outright rather than pulling
an empty image.


- [x] Tests pass
- [x] Appropriate changes to documentation are included in the PR
2026-08-11 10:14:03 -04:00

265 lines
11 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"
"testing"
"time"
"go.opentelemetry.io/otel/attribute"
"github.com/agent-substrate/substrate/internal/ateattr"
atev1alpha1 "github.com/agent-substrate/substrate/pkg/api/v1alpha1"
"github.com/agent-substrate/substrate/pkg/proto/ateapipb"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/validation/field"
"k8s.io/apimachinery/pkg/util/wait"
)
// CreateActor is the only lifecycle op with the full identity (incl. version)
// available in the request, so the whole ate.* set should land on its span.
func TestCreateActor_StampsFullSpanIdentity(t *testing.T) {
ns := namespaceForTest("ns-span-create")
tc := setupTest(t, ns)
defer tc.cleanup()
createTemplate(t, tc, ns)
attrs := recordRootSpanAttrs(t, func(ctx context.Context) {
if _, err := tc.service.CreateActor(ctx, &ateapipb.CreateActorRequest{
Actor: &ateapipb.Actor{
Metadata: &ateapipb.ResourceMetadata{Atespace: testAtespace, Name: testActorID},
ActorTemplateNamespace: ns,
ActorTemplateName: "tmpl1",
},
}); err != nil {
t.Fatalf("CreateActor: %v", err)
}
})
assertSpanStr(t, attrs, ateattr.AtespaceKey, testAtespace)
assertSpanStr(t, attrs, ateattr.ActorNameKey, testActorID)
assertSpanStr(t, attrs, ateattr.TemplateNameKey, "tmpl1")
assertSpanStr(t, attrs, ateattr.TemplateNamespaceKey, ns)
// uid is server-assigned on create, so assert it is present and non-empty
// rather than a fixed value.
if v, ok := attrs[ateattr.ActorUIDKey]; !ok || v.Type() != attribute.STRING || v.AsString() == "" {
t.Errorf("%s = %v, want non-empty server-assigned uid", ateattr.ActorUIDKey, v.Emit())
}
if v, ok := attrs[ateattr.ActorVersionKey]; !ok || v.Type() != attribute.INT64 || v.AsInt64() != 1 {
t.Errorf("%s = %v, want int64 1", ateattr.ActorVersionKey, v.Emit())
}
}
func TestValidateCreateActorRequest(t *testing.T) {
validActor := func(mutate func(*ateapipb.Actor)) *ateapipb.CreateActorRequest {
a := &ateapipb.Actor{
Metadata: &ateapipb.ResourceMetadata{Atespace: "ns1", Name: "id1"},
ActorTemplateNamespace: "ns1",
ActorTemplateName: "tmpl1",
}
if mutate != nil {
mutate(a)
}
return &ateapipb.CreateActorRequest{Actor: a}
}
tests := []struct {
name string
req *ateapipb.CreateActorRequest
want field.ErrorList
}{{
"valid",
validActor(nil),
nil,
}, {
"missing actor",
&ateapipb.CreateActorRequest{},
field.ErrorList{field.Required(field.NewPath("actor"), "")},
}, {
"missing actor.metadata.atespace",
validActor(func(a *ateapipb.Actor) { a.Metadata.Atespace = "" }),
field.ErrorList{field.Required(field.NewPath("actor", "metadata", "atespace"), "")},
}, {
"invalid actor.metadata.atespace",
validActor(func(a *ateapipb.Actor) { a.Metadata.Atespace = "NS1" }),
field.ErrorList{field.Invalid(field.NewPath("actor", "metadata", "atespace"), "NS1", "")},
}, {
"missing actor.metadata.name",
validActor(func(a *ateapipb.Actor) { a.Metadata.Name = "" }),
field.ErrorList{field.Required(field.NewPath("actor", "metadata", "name"), "")},
}, {
"invalid actor.metadata.name",
validActor(func(a *ateapipb.Actor) { a.Metadata.Name = "ID1" }),
field.ErrorList{field.Invalid(field.NewPath("actor", "metadata", "name"), "ID1", "")},
}, {
"missing actor_template_namespace",
validActor(func(a *ateapipb.Actor) { a.ActorTemplateNamespace = "" }),
field.ErrorList{field.Required(field.NewPath("actor", "actor_template_namespace"), "")},
}, {
"invalid actor_template_namespace",
validActor(func(a *ateapipb.Actor) { a.ActorTemplateNamespace = "invalid value" }),
field.ErrorList{field.Invalid(field.NewPath("actor", "actor_template_namespace"), "invalid value", "")},
}, {
"missing actor_template_name",
validActor(func(a *ateapipb.Actor) { a.ActorTemplateName = "" }),
field.ErrorList{field.Required(field.NewPath("actor", "actor_template_name"), "")},
}, {
"invalid actor_template_name",
validActor(func(a *ateapipb.Actor) { a.ActorTemplateName = "invalid value" }),
field.ErrorList{field.Invalid(field.NewPath("actor", "actor_template_name"), "invalid value", "")},
}, {
"worker_selector with nil match_labels",
validActor(func(a *ateapipb.Actor) { a.WorkerSelector = &ateapipb.Selector{} }),
nil,
}, {
"worker_selector with empty match_labels",
validActor(func(a *ateapipb.Actor) { a.WorkerSelector = &ateapipb.Selector{MatchLabels: map[string]string{}} }),
nil,
}, {
"valid worker_selector",
validActor(func(a *ateapipb.Actor) {
a.WorkerSelector = &ateapipb.Selector{MatchLabels: map[string]string{"tier": "1"}}
}),
nil,
}, {
"worker_selector with exactly max match_labels",
validActor(func(a *ateapipb.Actor) { a.WorkerSelector = &ateapipb.Selector{MatchLabels: selectorLabelsOfSize(10)} }),
nil,
}, {
"invalid worker_selector label key",
validActor(func(a *ateapipb.Actor) {
a.WorkerSelector = &ateapipb.Selector{MatchLabels: map[string]string{"bad key!": "1"}}
}),
field.ErrorList{field.Invalid(field.NewPath("actor", "worker_selector", "match_labels").Key("bad key!"), "bad key!", "")},
}, {
"invalid worker_selector label value",
validActor(func(a *ateapipb.Actor) {
a.WorkerSelector = &ateapipb.Selector{MatchLabels: map[string]string{"tier": "not valid!"}}
}),
field.ErrorList{field.Invalid(field.NewPath("actor", "worker_selector", "match_labels").Key("tier"), "not valid!", "")},
}, {
"too many worker_selector.match_labels",
validActor(func(a *ateapipb.Actor) { a.WorkerSelector = &ateapipb.Selector{MatchLabels: selectorLabelsOfSize(11)} }),
field.ErrorList{field.TooMany(field.NewPath("actor", "worker_selector", "match_labels"), 11, 10)},
}}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
assertValidateErr(t, validateCreateActorRequest(tt.req), tt.want)
})
}
}
func TestCreateActor_RejectsDifferentTemplateForDataSnapshot(t *testing.T) {
ns := namespaceForTest("ns-data-snapshot-template")
tc := setupTest(t, ns)
defer tc.cleanup()
createTemplate(t, tc, ns)
createTemplateWithSelector(t, tc, ns, "tmpl2", nil)
tmpl, err := tc.actorTemplateLister.ActorTemplates(ns).Get("tmpl1")
if err != nil {
t.Fatalf("Get source ActorTemplate: %v", err)
}
snapshot, err := tc.persistence.CreateActorSnapshot(context.Background(), &ateapipb.ActorSnapshot{
Metadata: &ateapipb.ResourceMetadata{Atespace: testAtespace, Name: "data-snapshot"},
SourceActor: &ateapipb.ObjectRef{Atespace: testAtespace, Name: "source"},
ActorTemplateUid: string(tmpl.GetUID()),
ContentScope: ateapipb.SnapshotContentScope_SNAPSHOT_CONTENT_SCOPE_DATA,
SnapshotUri: "gs://snapshots/snapshots/" + testAtespace + "/data-snapshot",
})
if err != nil {
t.Fatalf("CreateActorSnapshot: %v", err)
}
if _, err := tc.persistence.TagActorSnapshot(context.Background(), testAtespace, snapshot.GetMetadata().GetName(), &ateapipb.ActorSnapshotTag{
Metadata: &ateapipb.ResourceMetadata{Atespace: testAtespace, Name: "data-snapshot"},
Scope: ateapipb.ActorSnapshotTagScope_ACTOR_SNAPSHOT_TAG_SCOPE_ATESPACE,
}); err != nil {
t.Fatalf("TagActorSnapshot: %v", err)
}
_, err = tc.service.CreateActor(context.Background(), &ateapipb.CreateActorRequest{
Actor: &ateapipb.Actor{
Metadata: &ateapipb.ResourceMetadata{Atespace: testAtespace, Name: "clone"},
ActorTemplateNamespace: ns,
ActorTemplateName: "tmpl2",
},
SourceSnapshot: &ateapipb.ActorSnapshotRef{Reference: &ateapipb.ActorSnapshotRef_Tag{Tag: &ateapipb.ObjectRef{Atespace: testAtespace, Name: "data-snapshot"}}},
})
if status.Code(err) != codes.FailedPrecondition {
t.Fatalf("CreateActor status = %v, want FailedPrecondition", status.Code(err))
}
}
func TestCreateActor_RejectsSnapshotWithExternalVolumes(t *testing.T) {
ns := namespaceForTest("ns-snapshot-external-volume")
tc := setupTest(t, ns)
defer tc.cleanup()
template, err := tc.substrateClient.ApiV1alpha1().ActorTemplates(ns).Create(context.Background(), &atev1alpha1.ActorTemplate{
ObjectMeta: metav1.ObjectMeta{Name: "tmpl1", Namespace: ns},
Spec: atev1alpha1.ActorTemplateSpec{
SnapshotsConfig: atev1alpha1.SnapshotsConfig{Location: "gs://snapshots"},
Containers: []atev1alpha1.Container{{
Name: "main", Image: "main@sha256:abc", VolumeMounts: []atev1alpha1.VolumeMount{{Name: "data", MountPath: "/data"}},
}},
Volumes: []atev1alpha1.Volume{{
Name: "data",
VolumeSource: atev1alpha1.VolumeSource{ExternalVolumeTemplate: &atev1alpha1.ExternalVolumeTemplate{
Capacity: resource.MustParse("1Gi"), StorageClassName: "standard",
}},
}},
},
}, metav1.CreateOptions{})
if err != nil {
t.Fatalf("Create ActorTemplate: %v", err)
}
if err := wait.PollUntilContextTimeout(context.Background(), 100*time.Millisecond, 5*time.Second, true, func(ctx context.Context) (bool, error) {
got, err := tc.actorTemplateLister.ActorTemplates(ns).Get("tmpl1")
return err == nil && len(got.Spec.Volumes) == 1, nil
}); err != nil {
t.Fatalf("wait for ActorTemplate update: %v", err)
}
snapshot, err := tc.persistence.CreateActorSnapshot(context.Background(), &ateapipb.ActorSnapshot{
Metadata: &ateapipb.ResourceMetadata{Atespace: testAtespace, Name: "external-volume-snapshot"},
ActorTemplateUid: string(template.GetUID()),
SnapshotUri: "gs://snapshots/snapshots/" + testAtespace + "/external-volume-snapshot",
})
if err != nil {
t.Fatalf("CreateActorSnapshot: %v", err)
}
tagRef := &ateapipb.ObjectRef{Atespace: testAtespace, Name: "external-volume-snapshot"}
if _, err := tc.persistence.TagActorSnapshot(context.Background(), testAtespace, snapshot.GetMetadata().GetName(), &ateapipb.ActorSnapshotTag{
Metadata: &ateapipb.ResourceMetadata{Atespace: tagRef.GetAtespace(), Name: tagRef.GetName()},
Scope: ateapipb.ActorSnapshotTagScope_ACTOR_SNAPSHOT_TAG_SCOPE_ATESPACE,
}); err != nil {
t.Fatalf("TagActorSnapshot: %v", err)
}
_, err = tc.service.CreateActor(context.Background(), &ateapipb.CreateActorRequest{
Actor: &ateapipb.Actor{
Metadata: &ateapipb.ResourceMetadata{Atespace: testAtespace, Name: "clone"},
ActorTemplateNamespace: ns,
ActorTemplateName: "tmpl1",
},
SourceSnapshot: &ateapipb.ActorSnapshotRef{Reference: &ateapipb.ActorSnapshotRef_Tag{Tag: tagRef}},
})
if status.Code(err) != codes.FailedPrecondition {
t.Fatalf("CreateActor status = %v, want FailedPrecondition", status.Code(err))
}
}