[ci skip] extract variable, remove TODOs

johnstcn · johnstcn · commit 26484406b4f3 · 2025-02-04T11:44:33.000Z
diff --git a/agent/containers.go b/agent/containers.go
@@ -21,6 +21,7 @@ import (
 
 const (
 	defaultGetContainersCacheDuration = 10 * time.Second
+	dockerCreatedAtTimeFormat         = "2006-01-02 15:04:05 -0700 MST"
 	getContainersTimeout              = 5 * time.Second
 )
 
@@ -56,6 +57,8 @@ func (ch *containersHandler) getContainers(ctx context.Context) ([]codersdk.Work
 		ch.cacheDuration = defaultGetContainersCacheDuration
 	}
 	if ch.cl == nil {
+		// TODO(cian): we may need some way to select the desired
+		// implementation, but for now there is only one.
 		ch.cl = &dockerCLIContainerLister{}
 	}
 	if ch.containers == nil {
@@ -94,6 +97,8 @@ type ContainerLister interface {
 // dockerCLIContainerLister is a ContainerLister that lists containers using the docker CLI
 type dockerCLIContainerLister struct{}
 
+var _ ContainerLister = &dockerCLIContainerLister{}
+
 type dockerCLIList struct {
 	CreatedAt string `json:"CreatedAt"`
 	ID        string `json:"ID"`
@@ -107,7 +112,7 @@ func (*dockerCLIContainerLister) List(ctx context.Context) ([]codersdk.Workspace
 	cmd := exec.CommandContext(ctx, "docker", "ps", "--all", "--no-trunc", "--format=json")
 	cmd.Stdout = &buf
 	if err := cmd.Run(); err != nil {
-		return nil, xerrors.Errorf("list containers: %w", err)
+		return nil, xerrors.Errorf("run docker ps: %w", err)
 	}
 
 	// the output is returned with a single item per line, so we have to decode it
@@ -119,7 +124,7 @@ func (*dockerCLIContainerLister) List(ctx context.Context) ([]codersdk.Workspace
 			continue
 		}
 		if err := json.NewDecoder(strings.NewReader(line)).Decode(&tmp); err != nil {
-			return nil, xerrors.Errorf("list containers: %w", err)
+			return nil, xerrors.Errorf("decode docker ps output: %w", err)
 		}
 		out = append(out, convertDockerCLIList(tmp))
 	}
@@ -134,17 +139,17 @@ func convertDockerCLIList(in dockerCLIList) codersdk.WorkspaceAgentContainer {
 		Labels:       map[string]string{},
 	}
 
-	createdAt, err := time.Parse("2006-01-02 15:04:05 -0700 MST", in.CreatedAt)
+	createdAt, err := time.Parse(dockerCreatedAtTimeFormat, in.CreatedAt)
 	if err != nil {
-		createdAt = time.Time{} // TODO: how to handle invalid createdAt?
+		createdAt = time.Unix(0, 0)
 	}
 	out.CreatedAt = createdAt
 
 	labels := strings.Split(in.Labels, ",")
 	for _, label := range labels {
 		kvs := strings.Split(label, "=")
 		if len(kvs) != 2 {
-			continue // TODO: how should we handle this weirdness?
+			continue // skip invalid labels
 		}
 		out.Labels[kvs[0]] = kvs[1]
 	}
diff --git a/agent/containers_internal_test.go b/agent/containers_internal_test.go
@@ -31,7 +31,7 @@ func TestDockerCLIContainerLister(t *testing.T) {
 	pool, err := dockertest.NewPool("")
 	require.NoError(t, err, "Could not connect to docker")
 	testLabelValue := uuid.New().String()
-	res, err := pool.RunWithOptions(&dockertest.RunOptions{
+	ct, err := pool.RunWithOptions(&dockertest.RunOptions{
 		Repository: "busybox",
 		Tag:        "latest",
 		Cmd:        []string{"sleep", "infnity"},
@@ -42,30 +42,23 @@ func TestDockerCLIContainerLister(t *testing.T) {
 	})
 	require.NoError(t, err, "Could not start test docker container")
 	t.Cleanup(func() {
-		assert.NoError(t, pool.Purge(res), "Could not purge resource")
+		assert.NoError(t, pool.Purge(ct), "Could not purge resource")
 	})
 
-	expectedCt := codersdk.WorkspaceAgentContainer{
-		CreatedAt: res.Container.Created.Local().Truncate(time.Second),
-		ID:        res.Container.ID,
-		// For some reason, ory/dockertest pre-pends a forward slash to the container name.
-		FriendlyName: strings.TrimPrefix(res.Container.Name, "/"),
-		// ory/dockertest returns the sha256 digest of the image.
-		Image: "busybox:latest",
-		// Labels:       res.Container.Config.Labels, // unused
-	}
 	dcl := dockerCLIContainerLister{}
 	ctx := testutil.Context(t, testutil.WaitShort)
 	actual, err := dcl.List(ctx)
 	require.NoError(t, err, "Could not list containers")
 	var found bool
-	for _, ct := range actual {
-		if ct.Labels != nil && ct.Labels["com.coder.test"] == testLabelValue {
+	for _, foundContainer := range actual {
+		if foundContainer.ID == ct.Container.ID {
 			found = true
-			assert.Equal(t, expectedCt.CreatedAt, ct.CreatedAt)
-			assert.Equal(t, expectedCt.FriendlyName, ct.FriendlyName)
-			assert.Equal(t, expectedCt.ID, ct.ID)
-			assert.Equal(t, expectedCt.Image, ct.Image)
+			assert.Equal(t, ct.Container.Created.Local().Truncate(time.Second), foundContainer.CreatedAt)
+			// ory/dockertest pre-pends a forward slash to the container name.
+			assert.Equal(t, strings.TrimPrefix(ct.Container.Name, "/"), foundContainer.FriendlyName)
+			// ory/dockertest returns the sha256 digest of the image.
+			assert.Equal(t, "busybox:latest", foundContainer.Image)
+			assert.Equal(t, ct.Container.Config.Labels, foundContainer.Labels)
 			break
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import (`
`21`	`21`
`22`	`22`	`const (`
`23`	`23`	`defaultGetContainersCacheDuration = 10 * time.Second`
	`24`	`+ dockerCreatedAtTimeFormat = "2006-01-02 15:04:05 -0700 MST"`
`24`	`25`	`getContainersTimeout = 5 * time.Second`
`25`	`26`	`)`
`26`	`27`
`@@ -56,6 +57,8 @@ func (ch *containersHandler) getContainers(ctx context.Context) ([]codersdk.Work`
`56`	`57`	`ch.cacheDuration = defaultGetContainersCacheDuration`
`57`	`58`	`}`
`58`	`59`	`if ch.cl == nil {`
	`60`	`+ // TODO(cian): we may need some way to select the desired`
	`61`	`+ // implementation, but for now there is only one.`
`59`	`62`	`ch.cl = &dockerCLIContainerLister{}`
`60`	`63`	`}`
`61`	`64`	`if ch.containers == nil {`
`@@ -94,6 +97,8 @@ type ContainerLister interface {`
`94`	`97`	`// dockerCLIContainerLister is a ContainerLister that lists containers using the docker CLI`
`95`	`98`	`type dockerCLIContainerLister struct{}`
`96`	`99`
	`100`	`+var _ ContainerLister = &dockerCLIContainerLister{}`
	`101`	`+`
`97`	`102`	`type dockerCLIList struct {`
`98`	`103`	CreatedAt string `json:"CreatedAt"`
`99`	`104`	ID string `json:"ID"`
`@@ -107,7 +112,7 @@ func (*dockerCLIContainerLister) List(ctx context.Context) ([]codersdk.Workspace`
`107`	`112`	`cmd := exec.CommandContext(ctx, "docker", "ps", "--all", "--no-trunc", "--format=json")`
`108`	`113`	`cmd.Stdout = &buf`
`109`	`114`	`if err := cmd.Run(); err != nil {`
`110`		`- return nil, xerrors.Errorf("list containers: %w", err)`
	`115`	`+ return nil, xerrors.Errorf("run docker ps: %w", err)`
`111`	`116`	`}`
`112`	`117`
`113`	`118`	`// the output is returned with a single item per line, so we have to decode it`
`@@ -119,7 +124,7 @@ func (*dockerCLIContainerLister) List(ctx context.Context) ([]codersdk.Workspace`
`119`	`124`	`continue`
`120`	`125`	`}`
`121`	`126`	`if err := json.NewDecoder(strings.NewReader(line)).Decode(&tmp); err != nil {`
`122`		`- return nil, xerrors.Errorf("list containers: %w", err)`
	`127`	`+ return nil, xerrors.Errorf("decode docker ps output: %w", err)`
`123`	`128`	`}`
`124`	`129`	`out = append(out, convertDockerCLIList(tmp))`
`125`	`130`	`}`
`@@ -134,17 +139,17 @@ func convertDockerCLIList(in dockerCLIList) codersdk.WorkspaceAgentContainer {`
`134`	`139`	`Labels: map[string]string{},`
`135`	`140`	`}`
`136`	`141`
`137`		`- createdAt, err := time.Parse("2006-01-02 15:04:05 -0700 MST", in.CreatedAt)`
	`142`	`+ createdAt, err := time.Parse(dockerCreatedAtTimeFormat, in.CreatedAt)`
`138`	`143`	`if err != nil {`
`139`		`- createdAt = time.Time{} // TODO: how to handle invalid createdAt?`
	`144`	`+ createdAt = time.Unix(0, 0)`
`140`	`145`	`}`
`141`	`146`	`out.CreatedAt = createdAt`
`142`	`147`
`143`	`148`	`labels := strings.Split(in.Labels, ",")`
`144`	`149`	`for _, label := range labels {`
`145`	`150`	`kvs := strings.Split(label, "=")`
`146`	`151`	`if len(kvs) != 2 {`
`147`		`- continue // TODO: how should we handle this weirdness?`
	`152`	`+ continue // skip invalid labels`
`148`	`153`	`}`
`149`	`154`	`out.Labels[kvs[0]] = kvs[1]`
`150`	`155`	`}`