hcsoci: address PR review comments

- Remove Affinity uint64 from schema2/Processor (not a real HCS API field);
  preserve ConvertCPUAffinity validation with a TODO to wire it properly once
  the correct schema field is confirmed
- Define sentinel errors (ErrCPUAffinityMultipleGroups, ErrCPUAffinityNonZeroGroup,
  ErrCPUAffinityMaskZero) and replace strings.Contains checks in tests with
  errors.Is for more robust error identity verification

Signed-off-by: Weyang1 <weyang1@microsoft.com>

Author: Weyang1

cmd/containerd-shim-runhcs-v1/task_hcs.go

@@ -935,19 +935,18 @@ func (ht *hcsTask) updateWCOWContainerCPU(ctx context.Context, cpu *specs.Window
 			req.Weight = int32(*cpu.Shares)
 		}
 		if len(cpu.Affinity) > 0 {
-			// Create a temporary spec to reuse the existing ConvertCPUAffinity validation
+			// Validate CPU affinity. TODO: wire through to HCS once the
+			// correct Processor schema field is confirmed.
 			tempSpec := &specs.Spec{
 				Windows: &specs.Windows{
 					Resources: &specs.WindowsResources{
 						CPU: cpu,
 					},
 				},
 			}
-			affinity, err := hcsoci.ConvertCPUAffinity(tempSpec)
-			if err != nil {
+			if _, err := hcsoci.ConvertCPUAffinity(tempSpec); err != nil {
 				return err
 			}
-			req.Affinity = affinity
 		}
 		return ht.requestUpdateContainer(ctx, resourcepaths.SiloProcessorResourcePath, req)
 	}

internal/hcs/schema2/processor.go

@@ -15,6 +15,4 @@ type Processor struct {
 	Maximum int32 `json:"Maximum,omitempty"`
 
 	Weight int32 `json:"Weight,omitempty"`
-
-	Affinity uint64 `json:"Affinity,omitempty"`
 }

internal/hcsoci/hcsdoc_wcow.go

@@ -31,6 +31,13 @@ import (
 
 const createContainerSubdirectoryForProcessDumpSuffix = "{container_id}"
 
+// Sentinel errors returned by ConvertCPUAffinity.
+var (
+	ErrCPUAffinityMultipleGroups = errors.New("cpu affinity with multiple processor groups is not supported")
+	ErrCPUAffinityNonZeroGroup   = errors.New("cpu affinity processor group is not supported")
+	ErrCPUAffinityMaskZero       = errors.New("cpu affinity mask must be non-zero")
+)
+
 // A simple wrapper struct around the container mount configs that should be added to the
 // container.
 type mountsConfig struct {
@@ -108,13 +115,13 @@ func ConvertCPUAffinity(spec *specs.Spec) (uint64, error) {
 
 	affinity := spec.Windows.Resources.CPU.Affinity
 	if len(affinity) != 1 {
-		return 0, fmt.Errorf("cpu affinity with multiple processor groups is not supported")
+		return 0, fmt.Errorf("%w: %d entries", ErrCPUAffinityMultipleGroups, len(affinity))
 	}
 	if affinity[0].Group != 0 {
-		return 0, fmt.Errorf("cpu affinity processor group %d is not supported", affinity[0].Group)
+		return 0, fmt.Errorf("%w: %d", ErrCPUAffinityNonZeroGroup, affinity[0].Group)
 	}
 	if affinity[0].Mask == 0 {
-		return 0, fmt.Errorf("cpu affinity mask must be non-zero")
+		return 0, fmt.Errorf("%w", ErrCPUAffinityMaskZero)
 	}
 	return affinity[0].Mask, nil
 }
@@ -209,8 +216,9 @@ func createWindowsContainerDocument(ctx context.Context, coi *createOptionsInter
 		return nil, nil, err
 	}
 
-	cpuAffinity, err := ConvertCPUAffinity(coi.Spec)
-	if err != nil {
+	// Validate CPU affinity from the spec. TODO: wire through to HCS once the
+	// correct Processor schema field is confirmed.
+	if _, err := ConvertCPUAffinity(coi.Spec); err != nil {
 		return nil, nil, err
 	}
 
@@ -263,10 +271,9 @@ func createWindowsContainerDocument(ctx context.Context, coi *createOptionsInter
 	v1.ProcessorWeight = uint64(cpuWeight)
 
 	v2Container.Processor = &hcsschema.Processor{
-		Count:    cpuCount,
-		Maximum:  cpuLimit,
-		Weight:   cpuWeight,
-		Affinity: cpuAffinity,
+		Count:   cpuCount,
+		Maximum: cpuLimit,
+		Weight:  cpuWeight,
 	}
 
 	// Memory Resources

internal/hcsoci/hcsdoc_wcow_test.go

@@ -3,7 +3,7 @@
 package hcsoci
 
 import (
-	"strings"
+	"errors"
 	"testing"
 
 	specs "github.com/opencontainers/runtime-spec/specs-go"
@@ -49,7 +49,7 @@ func TestConvertCPUAffinity_MultiGroupRejected(t *testing.T) {
 	if err == nil {
 		t.Fatal("expected error for multiple affinity entries")
 	}
-	if !strings.Contains(err.Error(), "multiple processor groups") {
+	if !errors.Is(err, ErrCPUAffinityMultipleGroups) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 }
@@ -71,7 +71,7 @@ func TestConvertCPUAffinity_NonZeroGroupRejected(t *testing.T) {
 	if err == nil {
 		t.Fatal("expected error for non-zero affinity group")
 	}
-	if !strings.Contains(err.Error(), "processor group") {
+	if !errors.Is(err, ErrCPUAffinityNonZeroGroup) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 }
@@ -93,7 +93,7 @@ func TestConvertCPUAffinity_ZeroMaskRejected(t *testing.T) {
 	if err == nil {
 		t.Fatal("expected error for zero affinity mask")
 	}
-	if !strings.Contains(err.Error(), "mask must be non-zero") {
+	if !errors.Is(err, ErrCPUAffinityMaskZero) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 }