feat: Add annotations option (#238)

Signed-off-by: Arjun Raja Yogidas <[email protected]>

Author: coderbirju

api/handlers/container/create.go

@@ -108,16 +108,6 @@ func (h *handler) create(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	// Annotations: TODO - available in nerdctl 2.0
-	// Annotations are passed in as a map of strings,
-	// but nerdctl expects an array of strings with format [annotations1=VALUE1, annotations2=VALUE2, ...].
-	// annotations := []string{}
-	// if req.HostConfig.Annotations != nil {
-	// 	for key, val := range req.HostConfig.Annotations {
-	// 		annotations = append(annotations, fmt.Sprintf("%s=%s", key, val))
-	// 	}
-	// }
-
 	ulimits := []string{}
 	if req.HostConfig.Ulimits != nil {
 		for _, ulimit := range req.HostConfig.Ulimits {
@@ -279,8 +269,9 @@ func (h *handler) create(w http.ResponseWriter, r *http.Request) {
 		// #endregion
 
 		// #region for metadata flags
-		Name:  name,   // container name
-		Label: labels, // container labels
+		Name:        name,   // container name
+		Label:       labels, // container labels
+		Annotations: translateAnnotations(req.HostConfig.Annotations),
 		// #endregion
 
 		// #region for logging flags
@@ -430,3 +421,12 @@ func translateSysctls(sysctls map[string]string) []string {
 	}
 	return result
 }
+
+// translateAnnotations converts a map of annotations to a slice of strings in the format "KEY=VALUE".
+func translateAnnotations(annotations map[string]string) []string {
+	var result []string
+	for key, val := range annotations {
+		result = append(result, fmt.Sprintf("%s=%s", key, val))
+	}
+	return result
+}

api/handlers/container/create_test.go

@@ -928,6 +928,52 @@ var _ = Describe("Container Create API ", func() {
 			Expect(rr.Body).Should(MatchJSON(jsonResponse))
 		})
 
+		It("should set specified annotation", func() {
+			body := []byte(`{
+				"Image": "test-image",
+				"HostConfig": {
+					"Annotations": {
+						"com.example.key": "value1"
+					}
+				}
+			}`)
+			req, _ := http.NewRequest(http.MethodPost, "/containers/create", bytes.NewReader(body))
+
+			// Create a copy of default options and add annotation
+			expectedCreateOpt := createOpt
+			expectedCreateOpt.Annotations = []string{"com.example.key=value1"}
+
+			service.EXPECT().Create(gomock.Any(), "test-image", nil, equalTo(expectedCreateOpt), equalTo(netOpt)).Return(
+				cid, nil)
+
+			h.create(rr, req)
+			Expect(rr).Should(HaveHTTPStatus(http.StatusCreated))
+			Expect(rr.Body).Should(MatchJSON(jsonResponse))
+		})
+
+		It("should set specified annotation", func() {
+			body := []byte(`{
+				"Image": "test-image",
+				"HostConfig": {
+					"Annotations": {
+						"com.example.key": "value1"
+					}
+				}
+			}`)
+			req, _ := http.NewRequest(http.MethodPost, "/containers/create", bytes.NewReader(body))
+
+			// Create a copy of default options and add annotation
+			expectedCreateOpt := createOpt
+			expectedCreateOpt.Annotations = []string{"com.example.key=value1"}
+
+			service.EXPECT().Create(gomock.Any(), "test-image", nil, equalTo(expectedCreateOpt), equalTo(netOpt)).Return(
+				cid, nil)
+
+			h.create(rr, req)
+			Expect(rr).Should(HaveHTTPStatus(http.StatusCreated))
+			Expect(rr.Body).Should(MatchJSON(jsonResponse))
+		})
+
 		Context("translate port mappings", func() {
 			It("should return empty if port mappings is nil", func() {
 				Expect(translatePortMappings(nil)).Should(BeEmpty())
@@ -1036,6 +1082,38 @@ var _ = Describe("Container Create API ", func() {
 				Expect(translateTmpfs(input)).Should(Equal(expected))
 			})
 		})
+
+		Context("translate annotations", func() {
+			It("should return nil for nil input", func() {
+				Expect(translateAnnotations(nil)).Should(BeNil())
+			})
+
+			It("should return empty slice for empty map", func() {
+				Expect(translateAnnotations(map[string]string{})).Should(BeEmpty())
+			})
+
+			It("should handle single annotation", func() {
+				input := map[string]string{
+					"com.example.key": "value1",
+				}
+				expected := []string{"com.example.key=value1"}
+				Expect(translateAnnotations(input)).Should(Equal(expected))
+			})
+
+			It("should handle multiple annotations", func() {
+				input := map[string]string{
+					"com.example.key1":  "value1",
+					"com.example.key2":  "value2",
+					"io.containerd.key": "value3",
+				}
+				result := translateAnnotations(input)
+				Expect(result).Should(ConsistOf(
+					"com.example.key1=value1",
+					"com.example.key2=value2",
+					"io.containerd.key=value3",
+				))
+			})
+		})
 	})
 })
 

api/types/container_types.go

@@ -69,7 +69,7 @@ type ContainerHostConfig struct {
 	VolumesFrom     []string      // List of volumes to take from other container
 	// TODO: VolumeDriver    string            // Name of the volume driver used to mount volumes
 	// TODO: ConsoleSize     [2]uint           // Initial console size (height,width)
-	// TODO: Annotations     map[string]string `json:",omitempty"` // Arbitrary non-identifying metadata attached to container and provided to the runtime
+	Annotations map[string]string `json:",omitempty"` // Arbitrary non-identifying metadata attached to container and provided to the runtime
 
 	// Applicable to UNIX platforms
 	CapAdd  []string // List of kernel capabilities to add to the container

e2e/tests/container_create.go

@@ -1382,6 +1382,36 @@ func ContainerCreate(opt *option.Option) {
 			Expect(ok).Should(BeTrue())
 			Expect(readonly).Should(BeTrue())
 		})
+
+		It("should create a container with specified annotation", func() {
+			// Define options
+			options.Cmd = []string{"sleep", "Infinity"}
+			options.HostConfig.Annotations = map[string]string{
+				"com.example.key": "test-value",
+			}
+
+			// Create container
+			statusCode, ctr := createContainer(uClient, url, testContainerName, options)
+			Expect(statusCode).Should(Equal(http.StatusCreated))
+			Expect(ctr.ID).ShouldNot(BeEmpty())
+
+			// Start container
+			command.Run(opt, "start", testContainerName)
+
+			// Inspect using native format to verify annotation
+			nativeResp := command.Stdout(opt, "inspect", "--mode=native", testContainerName)
+			var nativeInspect []map[string]interface{}
+			err := json.Unmarshal(nativeResp, &nativeInspect)
+			Expect(err).Should(BeNil())
+			Expect(nativeInspect).Should(HaveLen(1))
+
+			// Verify annotation in container spec
+			spec, ok := nativeInspect[0]["Spec"].(map[string]interface{})
+			Expect(ok).Should(BeTrue())
+			annotations, ok := spec["annotations"].(map[string]interface{})
+			Expect(ok).Should(BeTrue())
+			Expect(annotations["com.example.key"]).Should(Equal("test-value"))
+		})
 	})
 }