Merge pull request #4471 from Shubhranshu153/feat-add-image-to-inspect

feat: Add image info to inspect commands

Author: AkihiroSuda

cmd/nerdctl/container/container_inspect_linux_test.go

@@ -17,6 +17,7 @@
 package container
 
 import (
+	"encoding/json"
 	"fmt"
 	"os"
 	"os/exec"
@@ -29,6 +30,7 @@ import (
 
 	"github.com/containerd/nerdctl/mod/tigron/expect"
 	"github.com/containerd/nerdctl/mod/tigron/test"
+	"github.com/containerd/nerdctl/mod/tigron/tig"
 
 	"github.com/containerd/nerdctl/v2/pkg/infoutil"
 	"github.com/containerd/nerdctl/v2/pkg/inspecttypes/dockercompat"
@@ -185,6 +187,35 @@ func TestContainerInspectContainsInternalLabel(t *testing.T) {
 	assert.Equal(base.T, expectedLabelMount, labelMount)
 }
 
+func TestContainerInspectConfigImage(t *testing.T) {
+	nerdtest.Setup()
+
+	testCase := &test.Case{
+		Description: "Container inspect contains Config.Image field",
+		Setup: func(data test.Data, helpers test.Helpers) {
+			helpers.Ensure("run", "-d", "--name", data.Identifier(), testutil.AlpineImage, "sleep", "infinity")
+		},
+		Cleanup: func(data test.Data, helpers test.Helpers) {
+			helpers.Anyhow("rm", "-f", data.Identifier())
+		},
+		Command: func(data test.Data, helpers test.Helpers) test.TestableCommand {
+			return helpers.Command("inspect", data.Identifier())
+		},
+		Expected: test.Expects(0, nil, func(stdout string, t tig.T) {
+			var containers []dockercompat.Container
+			err := json.Unmarshal([]byte(stdout), &containers)
+			assert.NilError(t, err, "Unable to unmarshal output\n")
+			assert.Equal(t, 1, len(containers), "Expected exactly one container in inspect output")
+
+			container := containers[0]
+			assert.Assert(t, container.Config != nil, "container Config should not be nil")
+			assert.Assert(t, container.Config.Image != "", "Config.Image should not be empty")
+		}),
+	}
+
+	testCase.Run(t)
+}
+
 func TestContainerInspectState(t *testing.T) {
 	t.Parallel()
 	testContainer := testutil.Identifier(t)

cmd/nerdctl/image/image_inspect_test.go

@@ -66,6 +66,18 @@ func TestImageInspectSimpleCases(t *testing.T) {
 				Command:     test.Command("image", "inspect", testutil.CommonImage, "--format", "{{.ID}}"),
 				Expected:    test.Expects(0, nil, nil),
 			},
+			{
+				Description: "Config.Image field is set",
+				Command:     test.Command("image", "inspect", testutil.CommonImage),
+				Expected: test.Expects(0, nil, func(stdout string, t tig.T) {
+					var dc []dockercompat.Image
+					err := json.Unmarshal([]byte(stdout), &dc)
+					assert.NilError(t, err, "Unable to unmarshal output\n")
+					assert.Equal(t, 1, len(dc), "Unexpectedly got multiple results\n")
+					assert.Assert(t, dc[0].Config != nil, "image Config should not be nil")
+					assert.Assert(t, dc[0].Config.Image != "", "Config.Image should not be empty")
+				}),
+			},
 			{
 				Description: "Error for image not found",
 				Command:     test.Command("image", "inspect", "dne:latest", "dne2:latest"),

pkg/inspecttypes/dockercompat/dockercompat.go

@@ -215,7 +215,7 @@ type Config struct {
 	Cmd         []string                 `json:",omitempty"` // Command to run when starting the container
 	Healthcheck *healthcheck.Healthcheck `json:",omitempty"` // Healthcheck describes how to check the container is healthy
 	// TODO: ArgsEscaped     bool                `json:",omitempty"` // True if command is already escaped (meaning treat as a command line) (Windows specific).
-	// TODO: Image           string              // Name of the image as it was passed by the operator (e.g. could be symbolic)
+	Image      string              `json:",omitempty"` // Name of the image as it was passed by the operator (e.g. could be symbolic)
 	Volumes    map[string]struct{} `json:",omitempty"` // List of volumes (mounts) used for the container
 	WorkingDir string              `json:",omitempty"` // Current directory (PWD) in the command will be launched
 	Entrypoint []string            `json:",omitempty"` // Entrypoint to run when starting the container
@@ -549,6 +549,7 @@ func ContainerFromNative(n *native.Container) (*Container, error) {
 	c.State = cs
 	c.Config = &Config{
 		Labels: n.Labels,
+		Image:  c.Image,
 	}
 	if n.Labels[labels.Hostname] != "" {
 		hostname = n.Labels[labels.Hostname]
@@ -648,6 +649,7 @@ func ImageFromNative(nativeImage *native.Image) (*Image, error) {
 		Entrypoint:   imgOCI.Config.Entrypoint,
 		Labels:       imgOCI.Config.Labels,
 		ExposedPorts: portSet,
+		Image:        nativeImage.Image.Name,
 	}
 
 	// Add health check if present in labels