[ci skip] skip docker integration test on non-linux

johnstcn · johnstcn · commit 4061ab66dca7 · 2025-02-04T11:44:33.000Z
diff --git a/agent/containers_internal_test.go b/agent/containers_internal_test.go
@@ -1,6 +1,7 @@
 package agent
 
 import (
+	"runtime"
 	"strings"
 	"testing"
 	"time"
@@ -17,8 +18,15 @@ import (
 	"github.com/coder/quartz"
 )
 
+// TestDockerCLIContainerLister tests the happy path of the
+// dockerCLIContainerLister.List method. It starts a container with a known
+// label, lists the containers, and verifies that the expected container is
+// returned. The container is deleted after the test is complete.
 func TestDockerCLIContainerLister(t *testing.T) {
 	t.Parallel()
+	if runtime.GOOS != "linux" {
+		t.Skip("creating containers on non-linux runners is slow and flaky")
+	}
 
 	pool, err := dockertest.NewPool("")
 	require.NoError(t, err, "Could not connect to docker")
@@ -64,6 +72,8 @@ func TestDockerCLIContainerLister(t *testing.T) {
 	assert.True(t, found, "Expected to find container with label 'com.coder.test=%s'", testLabelValue)
 }
 
+// TestContainersHandler tests the containersHandler.getContainers method using
+// a mock implementation. It specifically tests caching behavior.
 func TestContainersHandler(t *testing.T) {
 	t.Parallel()
 
