Skip to content

Commit 6b06022

Browse files
committed
feat(sdk/go)!: align portable resource requirements
Use ResourceRequirements for both inline and reusable-template sandbox workloads, update deep-copy converters and fakes, and regenerate the Go protobuf binding. BREAKING CHANGE: SandboxWorkloadConfig.Resources now uses ResourceRequirements, and the template-only SandboxResources and SandboxGPURequirements types are removed. Part of #2838 Signed-off-by: Evan Lezar <[email protected]>
1 parent f5a9777 commit 6b06022

13 files changed

Lines changed: 1720 additions & 1550 deletions

File tree

‎sdk/go/openshell/v1/fake/sandbox.go‎

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,37 @@ func copySandboxSpec(s types.SandboxSpec) types.SandboxSpec {
5050
t := copySandboxTemplate(*s.Template)
5151
s.Template = &t
5252
}
53-
if s.GPUCount != nil {
54-
v := *s.GPUCount
55-
s.GPUCount = &v
56-
}
53+
s.ResourceRequirements = copyResourceRequirements(s.ResourceRequirements)
5754
s.Policy = copySandboxPolicy(s.Policy)
5855
return s
5956
}
6057

58+
// copyResourceRequirements returns a deep copy of a ResourceRequirements
59+
// pointer. All nested pointer fields are duplicated to prevent aliasing.
60+
func copyResourceRequirements(rr *types.ResourceRequirements) *types.ResourceRequirements {
61+
if rr == nil {
62+
return nil
63+
}
64+
cp := *rr
65+
if rr.GPU != nil {
66+
gpu := *rr.GPU
67+
if rr.GPU.Count != nil {
68+
v := *rr.GPU.Count
69+
gpu.Count = &v
70+
}
71+
cp.GPU = &gpu
72+
}
73+
if rr.CPU != nil {
74+
cpu := *rr.CPU
75+
cp.CPU = &cpu
76+
}
77+
if rr.Memory != nil {
78+
mem := *rr.Memory
79+
cp.Memory = &mem
80+
}
81+
return &cp
82+
}
83+
6184
// copySandboxPolicy returns a deep copy of a SandboxPolicy pointer.
6285
// All sub-policies, slices, and map entries are duplicated.
6386
func copySandboxPolicy(p *types.SandboxPolicy) *types.SandboxPolicy {
@@ -397,7 +420,7 @@ func validateTemplateCreateSpec(spec *types.SandboxSpec) error {
397420
if spec == nil {
398421
return nil
399422
}
400-
if spec.LogLevel != "" || len(spec.Environment) > 0 || spec.Template != nil || spec.GPU || spec.GPUCount != nil {
423+
if spec.LogLevel != "" || len(spec.Environment) > 0 || spec.Template != nil || spec.ResourceRequirements != nil {
401424
return &types.StatusError{Code: types.ErrorInvalidArgument, Message: "template creates only allow policy, providers, command, and tty in spec"}
402425
}
403426
return nil
@@ -413,36 +436,12 @@ func sandboxSpecFromWorkloadTemplate(template *types.SandboxWorkloadTemplate) ty
413436
spec.Environment = copyStringMap(workload.Environment)
414437
spec.Template = &types.SandboxTemplate{
415438
Image: workload.Image,
416-
Resources: sandboxTemplateResources(workload.Resources),
417439
DriverConfig: copyAnyMap(template.Spec.DriverConfig),
418440
}
419-
if workload.Resources != nil && workload.Resources.GPU != nil {
420-
spec.GPU = true
421-
if workload.Resources.GPU.Count != nil {
422-
count := *workload.Resources.GPU.Count
423-
spec.GPUCount = &count
424-
}
425-
}
441+
spec.ResourceRequirements = copyResourceRequirements(workload.Resources)
426442
return spec
427443
}
428444

429-
func sandboxTemplateResources(resources *types.SandboxResources) map[string]any {
430-
if resources == nil {
431-
return nil
432-
}
433-
limits := make(map[string]any)
434-
if resources.CPU != "" {
435-
limits["cpu"] = resources.CPU
436-
}
437-
if resources.Memory != "" {
438-
limits["memory"] = resources.Memory
439-
}
440-
if len(limits) == 0 {
441-
return nil
442-
}
443-
return map[string]any{"limits": limits}
444-
}
445-
446445
// Get retrieves a sandbox by name.
447446
func (c *fakeSandboxClient) Get(_ context.Context, workspace, name string) (*types.Sandbox, error) {
448447
if c.closedFunc() {

‎sdk/go/openshell/v1/fake/sandbox_template_test.go‎

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,10 @@ func TestSandboxTemplate_CreateSandboxFromTemplateResolvesWorkloadAndGovernance(
212212
Workload: &types.SandboxWorkloadConfig{
213213
Image: "registry.example.com/agent:latest",
214214
Environment: map[string]string{"FEATURE_FLAG": "on"},
215-
Resources: &types.SandboxResources{
216-
CPU: "2",
217-
Memory: "4Gi",
218-
GPU: &types.SandboxGPURequirements{Count: &gpuCount},
215+
Resources: &types.ResourceRequirements{
216+
CPU: &types.CPUResourceRequirements{Limit: "2"},
217+
Memory: &types.MemoryResourceRequirements{Limit: "4Gi"},
218+
GPU: &types.GPUResourceRequirements{Count: &gpuCount},
219219
},
220220
},
221221
DriverConfig: map[string]any{
@@ -242,11 +242,16 @@ func TestSandboxTemplate_CreateSandboxFromTemplateResolvesWorkloadAndGovernance(
242242
assert.Equal(t, map[string]string{"FEATURE_FLAG": "on"}, created.Spec.Environment)
243243
require.NotNil(t, created.Spec.Template)
244244
assert.Equal(t, "registry.example.com/agent:latest", created.Spec.Template.Image)
245-
assert.Equal(t, map[string]any{"limits": map[string]any{"cpu": "2", "memory": "4Gi"}}, created.Spec.Template.Resources)
245+
assert.Nil(t, created.Spec.Template.Resources)
246246
assert.Equal(t, "kata-containers", created.Spec.Template.DriverConfig["kubernetes"].(map[string]any)["runtime_class_name"])
247-
assert.True(t, created.Spec.GPU)
248-
require.NotNil(t, created.Spec.GPUCount)
249-
assert.Equal(t, uint32(1), *created.Spec.GPUCount)
247+
require.NotNil(t, created.Spec.ResourceRequirements)
248+
require.NotNil(t, created.Spec.ResourceRequirements.CPU)
249+
assert.Equal(t, "2", created.Spec.ResourceRequirements.CPU.Limit)
250+
require.NotNil(t, created.Spec.ResourceRequirements.Memory)
251+
assert.Equal(t, "4Gi", created.Spec.ResourceRequirements.Memory.Limit)
252+
require.NotNil(t, created.Spec.ResourceRequirements.GPU)
253+
require.NotNil(t, created.Spec.ResourceRequirements.GPU.Count)
254+
assert.Equal(t, uint32(1), *created.Spec.ResourceRequirements.GPU.Count)
250255
assert.Equal(t, []string{"github"}, created.Spec.Providers)
251256
require.NotNil(t, created.Spec.Policy)
252257
assert.Equal(t, uint32(1), created.Spec.Policy.Version)
@@ -276,11 +281,10 @@ func TestSandboxTemplate_CreateSandboxFromTemplateRejectsWorkloadOverrides(t *te
276281
"template": {
277282
Template: &types.SandboxTemplate{Image: "registry.example.com/override:latest"},
278283
},
279-
"gpu_count": {
280-
GPUCount: &gpuCount,
281-
},
282-
"gpu": {
283-
GPU: true,
284+
"resources": {
285+
ResourceRequirements: &types.ResourceRequirements{
286+
GPU: &types.GPUResourceRequirements{Count: &gpuCount},
287+
},
284288
},
285289
}
286290

@@ -306,8 +310,8 @@ func TestSandboxTemplate_DefaultGpuRequestRoundTripsTemplate(t *testing.T) {
306310
Name: "default-gpu",
307311
Spec: types.SandboxWorkloadTemplateSpec{
308312
Workload: &types.SandboxWorkloadConfig{
309-
Resources: &types.SandboxResources{
310-
GPU: &types.SandboxGPURequirements{},
313+
Resources: &types.ResourceRequirements{
314+
GPU: &types.GPUResourceRequirements{},
311315
},
312316
},
313317
},
@@ -333,8 +337,8 @@ func TestSandboxTemplate_CreateSandboxFromTemplatePreservesDefaultGPURequest(t *
333337
Spec: types.SandboxWorkloadTemplateSpec{
334338
Workload: &types.SandboxWorkloadConfig{
335339
Image: "registry.example.com/agent:latest",
336-
Resources: &types.SandboxResources{
337-
GPU: &types.SandboxGPURequirements{},
340+
Resources: &types.ResourceRequirements{
341+
GPU: &types.GPUResourceRequirements{},
338342
},
339343
},
340344
},
@@ -350,8 +354,9 @@ func TestSandboxTemplate_CreateSandboxFromTemplatePreservesDefaultGPURequest(t *
350354
)
351355

352356
require.NoError(t, err)
353-
assert.True(t, created.Spec.GPU)
354-
assert.Nil(t, created.Spec.GPUCount)
357+
require.NotNil(t, created.Spec.ResourceRequirements)
358+
require.NotNil(t, created.Spec.ResourceRequirements.GPU)
359+
assert.Nil(t, created.Spec.ResourceRequirements.GPU.Count)
355360
}
356361

357362
func TestSandboxTemplate_DeepCopy(t *testing.T) {
@@ -436,8 +441,8 @@ func TestSandboxTemplate_CreateRejectsInvalidTemplate(t *testing.T) {
436441
Spec: types.SandboxWorkloadTemplateSpec{
437442
Workload: &types.SandboxWorkloadConfig{
438443
Image: "registry.example.com/agent:latest",
439-
Resources: &types.SandboxResources{
440-
GPU: &types.SandboxGPURequirements{Count: &zeroGPUCount},
444+
Resources: &types.ResourceRequirements{
445+
GPU: &types.GPUResourceRequirements{Count: &zeroGPUCount},
441446
},
442447
},
443448
},

‎sdk/go/openshell/v1/internal/converter/copy.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ func CopyBoolPtr(p *bool) *bool {
2626
return &v
2727
}
2828

29+
// StringPtr returns a pointer to value unless it is empty. Empty resource
30+
// quantities are invalid, so use nil to preserve optional-field presence.
31+
func StringPtr(value string) *string {
32+
if value == "" {
33+
return nil
34+
}
35+
return &value
36+
}
37+
2938
// CopyInt32Ptr returns a copy of an *int32 pointer.
3039
func CopyInt32Ptr(p *int32) *int32 {
3140
if p == nil {

‎sdk/go/openshell/v1/internal/converter/coverage_test.go‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,6 @@ func TestConverterCoversAllProtoFields_SandboxWorkloadConfig(t *testing.T) {
8686
assertAllFieldsCovered(t, (&pb.SandboxWorkloadConfig{}).ProtoReflect().Descriptor(), handled, nil)
8787
}
8888

89-
func TestConverterCoversAllProtoFields_SandboxResources(t *testing.T) {
90-
handled := fieldSet{
91-
"cpu": true,
92-
"memory": true,
93-
"gpu": true,
94-
}
95-
96-
assertAllFieldsCovered(t, (&pb.SandboxResources{}).ProtoReflect().Descriptor(), handled, nil)
97-
}
98-
9989
func TestConverterCoversAllProtoFields_SandboxServiceLevel(t *testing.T) {
10090
handled := fieldSet{
10191
"startup": true,

‎sdk/go/openshell/v1/internal/converter/sandbox.go‎

Lines changed: 49 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -82,19 +82,33 @@ func sandboxSpecFromProto(spec *pb.SandboxSpec) types.SandboxSpec {
8282
}
8383

8484
if rr := spec.GetResourceRequirements(); rr != nil {
85-
if gpu := rr.GetGpu(); gpu != nil {
86-
result.GPU = true
87-
if gpu.Count != nil {
88-
result.GPUCount = gpu.Count
89-
}
90-
}
85+
result.ResourceRequirements = resourceRequirementsFromProto(rr)
9186
}
9287
result.Command = CopyStringSlice(spec.GetCommand())
9388
result.TTY = spec.GetTty()
9489

9590
return result
9691
}
9792

93+
// resourceRequirementsFromProto converts a proto ResourceRequirements to an
94+
// SDK ResourceRequirements.
95+
func resourceRequirementsFromProto(rr *pb.ResourceRequirements) *types.ResourceRequirements {
96+
if rr == nil {
97+
return nil
98+
}
99+
result := &types.ResourceRequirements{}
100+
if gpu := rr.GetGpu(); gpu != nil {
101+
result.GPU = &types.GPUResourceRequirements{Count: CopyUint32Ptr(gpu.Count)}
102+
}
103+
if cpu := rr.GetCpu(); cpu != nil {
104+
result.CPU = &types.CPUResourceRequirements{Limit: cpu.GetLimit(), Request: cpu.GetRequest()}
105+
}
106+
if mem := rr.GetMemory(); mem != nil {
107+
result.Memory = &types.MemoryResourceRequirements{Limit: mem.GetLimit(), Request: mem.GetRequest()}
108+
}
109+
return result
110+
}
111+
98112
func sandboxStatusFromProto(status *pb.SandboxStatus) types.SandboxStatus {
99113
result := types.SandboxStatus{
100114
SandboxName: status.GetSandboxName(),
@@ -264,12 +278,8 @@ func SandboxSpecToProto(spec *types.SandboxSpec) *pb.SandboxSpec {
264278
result.Template = tmpl
265279
}
266280

267-
if spec.GPU || spec.GPUCount != nil {
268-
result.ResourceRequirements = &pb.ResourceRequirements{
269-
Gpu: &pb.GpuResourceRequirements{
270-
Count: spec.GPUCount,
271-
},
272-
}
281+
if spec.ResourceRequirements != nil {
282+
result.ResourceRequirements = resourceRequirementsToProto(spec.ResourceRequirements)
273283
}
274284

275285
result.Command = CopyStringSlice(spec.Command)
@@ -278,6 +288,31 @@ func SandboxSpecToProto(spec *types.SandboxSpec) *pb.SandboxSpec {
278288
return result
279289
}
280290

291+
// resourceRequirementsToProto converts an SDK ResourceRequirements to a
292+
// proto ResourceRequirements.
293+
func resourceRequirementsToProto(rr *types.ResourceRequirements) *pb.ResourceRequirements {
294+
if rr == nil {
295+
return nil
296+
}
297+
result := &pb.ResourceRequirements{}
298+
if rr.GPU != nil {
299+
result.Gpu = &pb.GpuResourceRequirements{Count: CopyUint32Ptr(rr.GPU.Count)}
300+
}
301+
if rr.CPU != nil {
302+
result.Cpu = &pb.CpuResourceRequirements{
303+
Limit: StringPtr(rr.CPU.Limit),
304+
Request: StringPtr(rr.CPU.Request),
305+
}
306+
}
307+
if rr.Memory != nil {
308+
result.Memory = &pb.MemoryResourceRequirements{
309+
Limit: StringPtr(rr.Memory.Limit),
310+
Request: StringPtr(rr.Memory.Request),
311+
}
312+
}
313+
return result
314+
}
315+
281316
// SandboxSpecToProtoChecked converts an SDK SandboxSpec and reports values
282317
// that protobuf Struct cannot represent instead of silently dropping them.
283318
func SandboxSpecToProtoChecked(spec *types.SandboxSpec) (*pb.SandboxSpec, error) {
@@ -355,19 +390,7 @@ func SandboxWorkloadConfigFromProto(workload *pb.SandboxWorkloadConfig) *types.S
355390
return &types.SandboxWorkloadConfig{
356391
Image: workload.GetImage(),
357392
Environment: CopyStringMap(workload.GetEnvironment()),
358-
Resources: SandboxResourcesFromProto(workload.GetResources()),
359-
}
360-
}
361-
362-
// SandboxResourcesFromProto converts portable resource requirements.
363-
func SandboxResourcesFromProto(resources *pb.SandboxResources) *types.SandboxResources {
364-
if resources == nil {
365-
return nil
366-
}
367-
return &types.SandboxResources{
368-
CPU: resources.GetCpu(),
369-
Memory: resources.GetMemory(),
370-
GPU: sandboxResourceGpuFromProto(resources),
393+
Resources: resourceRequirementsFromProto(workload.GetResources()),
371394
}
372395
}
373396

@@ -437,34 +460,8 @@ func SandboxWorkloadConfigToProto(workload *types.SandboxWorkloadConfig) *pb.San
437460
return &pb.SandboxWorkloadConfig{
438461
Image: workload.Image,
439462
Environment: CopyStringMap(workload.Environment),
440-
Resources: SandboxResourcesToProto(workload.Resources),
441-
}
442-
}
443-
444-
// SandboxResourcesToProto converts portable resource requirements.
445-
func SandboxResourcesToProto(resources *types.SandboxResources) *pb.SandboxResources {
446-
if resources == nil {
447-
return nil
448-
}
449-
return &pb.SandboxResources{
450-
Cpu: resources.CPU,
451-
Memory: resources.Memory,
452-
Gpu: sandboxResourceGpuToProto(resources),
453-
}
454-
}
455-
456-
func sandboxResourceGpuToProto(resources *types.SandboxResources) *pb.GpuResourceRequirements {
457-
if resources == nil || resources.GPU == nil {
458-
return nil
459-
}
460-
return &pb.GpuResourceRequirements{Count: CopyUint32Ptr(resources.GPU.Count)}
461-
}
462-
463-
func sandboxResourceGpuFromProto(resources *pb.SandboxResources) *types.SandboxGPURequirements {
464-
if resources == nil || resources.GetGpu() == nil {
465-
return nil
463+
Resources: resourceRequirementsToProto(workload.Resources),
466464
}
467-
return &types.SandboxGPURequirements{Count: CopyUint32Ptr(resources.GetGpu().Count)}
468465
}
469466

470467
// SandboxServiceLevelToProto converts template service-level hints.

0 commit comments

Comments
 (0)