Update OCI Linux Resource Tests Failing (on a host w/o swap controller)

[Jenkins-J]

Description

The TestUpdateOCILinuxResource tests are failing in pkg/cri/server and pkg/cri/sbserver. All tests fail due to the expected swap value not matching the received swap value.

These test cases were recently changed in pull request #7783, which disables swap by setting the value of the swap resource equal to the memory limit. Instead of the swap value being updated to match the expected value (the memory limit), in this case the swap value is left unchanged causing the test cases to fail (see test output below).

Steps to reproduce the issue

1. Clone the containerd repository
2. Navigate to the pkg/cri/server or pkg/cri/sbserver directories
3. go test -run TestUpdateOCILinuxResource

Describe the results you received and expected

Expected: All tests to pass

Received:

--- FAIL: TestUpdateOCILinuxResource (0.00s)
    --- FAIL: TestUpdateOCILinuxResource/should_skip_empty_fields (0.00s)
        container_update_resources_linux_test.go:239: 
            	Error Trace:	/home/containerd_test/containerd/pkg/cri/server/container_update_resources_linux_test.go:239
            	Error:      	Not equal: 
            	            	expected: &specs.Spec{Version:"", Process:(*specs.Process)(0xc00029c5a0), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc00029c690), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	actual  : &specs.Spec{Version:"", Process:(*specs.Process)(0xc00029cf00), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc00029cff0), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -38,3 +38,3 @@
            	            	     Reservation: (*int64)(<nil>),
            	            	-    Swap: (*int64)(54321),
            	            	+    Swap: (*int64)(<nil>),
            	            	     Kernel: (*int64)(<nil>),
            	Test:       	TestUpdateOCILinuxResource/should_skip_empty_fields
    --- FAIL: TestUpdateOCILinuxResource/should_be_able_to_fill_empty_fields (0.00s)
        container_update_resources_linux_test.go:239: 
            	Error Trace:	/home/containerd_test/containerd/pkg/cri/server/container_update_resources_linux_test.go:239
            	Error:      	Not equal: 
            	            	expected: &specs.Spec{Version:"", Process:(*specs.Process)(0xc00029c960), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc00029ca50), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	actual  : &specs.Spec{Version:"", Process:(*specs.Process)(0xc00029d0e0), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc00029d1d0), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -38,3 +38,3 @@
            	            	     Reservation: (*int64)(<nil>),
            	            	-    Swap: (*int64)(54321),
            	            	+    Swap: (*int64)(<nil>),
            	            	     Kernel: (*int64)(<nil>),
            	Test:       	TestUpdateOCILinuxResource/should_be_able_to_fill_empty_fields
    --- FAIL: TestUpdateOCILinuxResource/should_be_able_to_patch_the_unified_map (0.00s)
        container_update_resources_linux_test.go:239: 
            	Error Trace:	/home/containerd_test/containerd/pkg/cri/server/container_update_resources_linux_test.go:239
            	Error:      	Not equal: 
            	            	expected: &specs.Spec{Version:"", Process:(*specs.Process)(0xc00029cd20), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc00029ce10), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	actual  : &specs.Spec{Version:"", Process:(*specs.Process)(0xc00029d2c0), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc00029d3b0), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -38,3 +38,3 @@
            	            	     Reservation: (*int64)(<nil>),
            	            	-    Swap: (*int64)(54321),
            	            	+    Swap: (*int64)(<nil>),
            	            	     Kernel: (*int64)(<nil>),
            	Test:       	TestUpdateOCILinuxResource/should_be_able_to_patch_the_unified_map
    --- FAIL: TestUpdateOCILinuxResource/should_be_able_to_update_each_resource (0.00s)
        container_update_resources_linux_test.go:239: 
            	Error Trace:	/home/containerd_test/containerd/pkg/cri/server/container_update_resources_linux_test.go:239
            	Error:      	Not equal: 
            	            	expected: &specs.Spec{Version:"", Process:(*specs.Process)(0xc00029c1e0), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc00029c2d0), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	actual  : &specs.Spec{Version:"", Process:(*specs.Process)(0xc0001ca3c0), Root:(*specs.Root)(nil), Hostname:"", Domainname:"", Mounts:[]specs.Mount(nil), Hooks:(*specs.Hooks)(nil), Annotations:map[string]string(nil), Linux:(*specs.Linux)(0xc0001ca4b0), Solaris:(*specs.Solaris)(nil), Windows:(*specs.Windows)(nil), VM:(*specs.VM)(nil), ZOS:(*specs.ZOS)(nil)}
            	            	
            	            	Diff:
            	            	--- Expected
            	            	+++ Actual
            	            	@@ -38,3 +38,3 @@
            	            	     Reservation: (*int64)(<nil>),
            	            	-    Swap: (*int64)(54321),
            	            	+    Swap: (*int64)(<nil>),
            	            	     Kernel: (*int64)(<nil>),
            	Test:       	TestUpdateOCILinuxResource/should_be_able_to_update_each_resource
FAIL
exit status 1
FAIL	github.com/containerd/containerd/pkg/cri/server	0.020s

What version of containerd are you using?

containerd github.com/containerd/containerd v1.7.0-beta.1-121-g28e8e247b.m 28e8e24.m

Any other relevant information

No response

Show configuration if it is related to CRI plugin.

No response

[Jenkins-J]

It looks like a discussion on this was also started in pull request #7836 (#7836 (comment)).

[AkihiroSuda]

How do you run the test? It is passing on the CI (Ubuntu 20.04, Fedora 37, Rocky 8)

[Jenkins-J]

Steps to reproduce the issue

1. Clone the containerd repository

2. Navigate to the `pkg/cri/server` or `pkg/cri/sbserver` directories

3. `go test -run TestUpdateOCILinuxResource`

This issue has been appearing for me while running make test and by using the steps described above.

[AkihiroSuda]

On what environment?

[Jenkins-J]

I have tested the same process on Ubuntu 20.04 on both Power ppc64le and x86 CPUs.

[Jenkins-J]

@AkihiroSuda Looking at these lines: https://github.com/AkihiroSuda/containerd/blob/41575038819551c255ea2385dfe6c63cb7048dca/pkg/cri/opts/spec_linux.go#L484-L486

Since s.Linux.Resources.Memory.Swap is set when there is a swap controller available and the tests expect the swap value to be set, does this mean that I have to enable swap somehow in order for the tests to pass?

[mqasimsarfraz]

@AkihiroSuda I proposed a fix for this issue please let me know what do you think about it?