Add GET /quadlets/{name}/file

Fixes: https://issues.redhat.com/browse/RUN-3716

Signed-off-by: Nicola Sella <[email protected]>

Author: inknos

pkg/api/handlers/libpod/quadlets.go

@@ -35,3 +35,25 @@ func ListQuadlets(w http.ResponseWriter, r *http.Request) {
 
 	utils.WriteResponse(w, http.StatusOK, quadlets)
 }
+
+func GetQuadlet(w http.ResponseWriter, r *http.Request) {
+	runtime := r.Context().Value(api.RuntimeKey).(*libpod.Runtime)
+	name := utils.GetName(r)
+
+	containerEngine := abi.ContainerEngine{Libpod: runtime}
+
+	// Use QuadletPrint to get the raw file contents
+	quadletContents, err := containerEngine.QuadletPrint(r.Context(), name)
+	if err != nil {
+		utils.Error(w, http.StatusNotFound, fmt.Errorf("no such quadlet: %s: %w", name, err))
+		return
+	}
+
+	// Set content type to text/plain and write the raw file contents
+	w.Header().Set("Content-Type", "text/plain")
+	w.WriteHeader(http.StatusOK)
+	if _, err := w.Write([]byte(quadletContents)); err != nil {
+		utils.Error(w, http.StatusInternalServerError, fmt.Errorf("failed to write quadlet contents: %w", err))
+		return
+	}
+}

pkg/api/handlers/swagger/errors.go

@@ -79,6 +79,13 @@ type podNotFound struct {
 	Body errorhandling.ErrorModel
 }
 
+// No such quadlet
+// swagger:response
+type quadletNotFound struct {
+	// in:body
+	Body errorhandling.ErrorModel
+}
+
 // No such manifest
 // swagger:response
 type manifestNotFound struct {

pkg/api/handlers/swagger/responses.go

@@ -527,3 +527,10 @@ type quadletListResponse struct {
 	// in:body
 	Body []entities.ListQuadlet
 }
+
+// Quadlet file
+// swagger:response
+type quadletFileResponse struct {
+	// in:body
+	Body string
+}

pkg/api/server/register_quadlets.go

@@ -32,5 +32,27 @@ func (s *APIServer) registerQuadletHandlers(r *mux.Router) error {
 	//   500:
 	//     $ref: "#/responses/internalError"
 	r.HandleFunc(VersionedPath("/libpod/quadlets/json"), s.APIHandler(libpod.ListQuadlets)).Methods(http.MethodGet)
+	// swagger:operation GET /libpod/quadlets/{name}/file libpod QuadletFileLibpod
+	// ---
+	// tags:
+	//   - quadlets
+	// summary: Get quadlet file
+	// description: Get the contents of a Quadlet, displaying the file including all comments
+	// produces:
+	// - text/plain
+	// parameters:
+	//  - in: path
+	//    name: name
+	//    type: string
+	//    required: true
+	//    description: the name of the quadlet with extension (e.g., "myapp.container")
+	// responses:
+	//   200:
+	//     $ref: "#/responses/quadletFileResponse"
+	//   404:
+	//     $ref: "#/responses/quadletNotFound"
+	//   500:
+	//     $ref: "#/responses/internalError"
+	r.HandleFunc(VersionedPath("/libpod/quadlets/{name}/file"), s.APIHandler(libpod.GetQuadlet)).Methods(http.MethodGet)
 	return nil
 }

test/apiv2/36-quadlets.at

@@ -6,10 +6,56 @@
 # NOTE: Once podman-remote quadlet support is added we can enable the podman quadlet tests in
 #       test/system/253-podman-quadlet.bats which should cover it in more detail then.
 
-## list volume
+## Test list endpoint
 t GET libpod/quadlets/json 200
 
-# Example with filter applied (uncomment once needed)
-# t GET libpod/quadlets/json?filters='{"name":["name.*"]}' 200
+# Test 404 for non-existent quadlet
+t GET libpod/quadlets/nonexistent.container 404
+
+# Install a quadlet with a unique name
+quadlet_name=quadlet-test-$(cat /proc/sys/kernel/random/uuid)
+
+quadlet_container_name="$quadlet_name.container"
+quadlet_build_name="$quadlet_name.build"
+
+quadlet_container_file_name="$HOME/.config/containers/systemd/$quadlet_container_name"
+quadlet_build_file_name="$HOME/.config/containers/systemd/$quadlet_build_name"
+
+quadlet_container_file_content=$(cat << EOF
+[Container]
+Image=$IMAGE
+EOF
+)
+
+quadlet_build_file_content=$(cat << EOF
+[Build]
+ImageTag=localhost/$quadlet_name
+EOF
+)
+
+echo "$quadlet_container_file_content" > $quadlet_container_file_name
+echo "$quadlet_build_file_content" > $quadlet_build_file_name
+
+filter_param=$(printf '{"name":["%s"]}' "$quadlet_name")
+t GET "libpod/quadlets/json?filters=$filter_param" 200 \
+    length=2 \
+   .[0].Name="$quadlet_build_name" \
+   .[1].Name="$quadlet_container_name"
+
+filter_param=$(printf '{"name":["%s"]}' "$quadlet_container_name")
+t GET "libpod/quadlets/json?filters=$filter_param" 200 \
+    length=1 \
+   .[0].Name="$quadlet_container_name"
+
+t GET "libpod/quadlets/$quadlet_name/file" 404
+
+t GET "libpod/quadlets/$quadlet_container_name/file" 200
+is "$output" "$quadlet_container_file_content"
+
+t GET "libpod/quadlets/$quadlet_build_name/file" 200
+is "$output" "$quadlet_build_file_content"
+
+rm $quadlet_container_file_name
+rm $quadlet_build_file_name
 
 # vim: filetype=sh