Simplified 'list' command code

cmd/list.go

@@ -16,32 +16,26 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var (
-	defaultCheckpointPath     = "/var/lib/kubelet/checkpoints/"
-	additionalCheckpointPaths []string
-)
+var defaultCheckpointPath = "/var/lib/kubelet/checkpoints/"
 
 func List() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "list",
-		Short: "List checkpoints stored in the default and additional paths",
-		RunE:  list,
+		Use:                   "list [directories]",
+		Short:                 "List checkpoints stored in the default and additional directories",
+		RunE:                  list,
+		DisableFlagsInUseLine: true,
 	}
 
-	flags := cmd.Flags()
-	flags.StringSliceVarP(
-		&additionalCheckpointPaths,
-		"paths",
-		"p",
-		[]string{},
-		"Specify additional paths to include in checkpoint listing",
-	)
-
 	return cmd
 }
 
 func list(cmd *cobra.Command, args []string) error {
-	allPaths := append([]string{defaultCheckpointPath}, additionalCheckpointPaths...)
+	allPaths := func() []string {
+		if len(args) == 0 {
+			return []string{defaultCheckpointPath}
+		}
+		return args
+	}()
 	showTable := false
 
 	table := tablewriter.NewWriter(os.Stdout)
@@ -92,7 +86,7 @@ func list(cmd *cobra.Command, args []string) error {
 	}
 
 	if !showTable {
-		fmt.Println("No checkpoints found")
+		fmt.Printf("No checkpoints found in %v\n", allPaths)
 		return nil
 	}
 

docs/checkpointctl-list.adoc

@@ -3,21 +3,18 @@ include::footer.adoc[]
 
 == Name
 
-*checkpointctl-list* - List checkpoints stored in the default and additional paths
+*checkpointctl-list* - List checkpoints stored in the default and additional directories
 
 == Synopsis
 
-*checkpointctl list* [_OPTION_]... _FOLDER_...
+*checkpointctl list* [_directories_]
 
 == Options
 
 *-h*, *--help*::
   Show help for checkpointctl list
 
-*-p*, *--path*::
-  Specify additional paths to include in checkpoint listing
-
-== Default Path
+== Default Directory
 
 The default path for checking checkpoints is `/var/lib/kubelet/checkpoints/`.
 

internal/config_extractor.go

@@ -1,10 +1,8 @@
 package internal
 
 import (
-	"encoding/json"
 	"log"
 	"os"
-	"path/filepath"
 	"time"
 
 	metadata "github.com/checkpoint-restore/checkpointctl/lib"
@@ -31,46 +29,25 @@ func ExtractConfigDump(checkpointPath string) (*ChkptConfig, error) {
 		return nil, err
 	}
 
-	specDumpPath := filepath.Join(tempDir, "spec.dump")
-	specContent, err := os.ReadFile(specDumpPath)
+	info := &checkpointInfo{}
+	info.configDump, _, err = metadata.ReadContainerCheckpointConfigDump(tempDir)
 	if err != nil {
-		log.Printf("Error reading spec.dump file: %v\n", err)
 		return nil, err
 	}
-
-	configDumpPath := filepath.Join(tempDir, "config.dump")
-	configContent, err := os.ReadFile(configDumpPath)
+	info.specDump, _, err = metadata.ReadContainerCheckpointSpecDump(tempDir)
 	if err != nil {
-		log.Printf("Error reading config.dump file: %v\n", err)
-		return nil, err
-	}
-
-	return extractConfigDumpContent(configContent, specContent)
-}
-
-func extractConfigDumpContent(configContent []byte, specContent []byte) (*ChkptConfig, error) {
-	var spec metadata.Spec
-	var config metadata.ContainerConfig
-
-	if err := json.Unmarshal(configContent, &config); err != nil {
 		return nil, err
 	}
 
-	if err := json.Unmarshal(specContent, &spec); err != nil {
+	info.containerInfo, err = getContainerInfo(info.specDump, info.configDump)
+	if err != nil {
 		return nil, err
 	}
-
-	namespace := spec.Annotations["io.kubernetes.pod.namespace"]
-	timestamp := config.CheckpointedAt
-	pod := spec.Annotations["io.kubernetes.pod.name"]
-	container := spec.Annotations["io.kubernetes.container.name"]
-	containerManager := spec.Annotations["io.container.manager"]
-
 	return &ChkptConfig{
-		Namespace:        namespace,
-		Pod:              pod,
-		Container:        container,
-		ContainerManager: containerManager,
-		Timestamp:        timestamp,
+		Namespace:        info.containerInfo.Namespace,
+		Pod:              info.containerInfo.Pod,
+		Container:        info.containerInfo.Name,
+		ContainerManager: info.containerInfo.Engine,
+		Timestamp:        info.configDump.CheckpointedAt,
 	}, nil
 }

internal/container.go

@@ -30,11 +30,13 @@ type containerMetadata struct {
 }
 
 type containerInfo struct {
-	Name    string
-	IP      string
-	MAC     string
-	Created string
-	Engine  string
+	Name      string
+	IP        string
+	MAC       string
+	Created   string
+	Engine    string
+	Namespace string
+	Pod       string
 }
 
 type checkpointInfo struct {
@@ -54,9 +56,11 @@ func getPodmanInfo(containerConfig *metadata.ContainerConfig, _ *spec.Spec) *con
 
 func getContainerdInfo(containerConfig *metadata.ContainerConfig, specDump *spec.Spec) *containerInfo {
 	return &containerInfo{
-		Name:    specDump.Annotations["io.kubernetes.cri.container-name"],
-		Created: containerConfig.CreatedTime.Format(time.RFC3339),
-		Engine:  "containerd",
+		Name:      specDump.Annotations["io.kubernetes.cri.container-name"],
+		Created:   containerConfig.CreatedTime.Format(time.RFC3339),
+		Engine:    "containerd",
+		Namespace: specDump.Annotations["io.kubernetes.cri.sandbox-namespace"],
+		Pod:       specDump.Annotations["io.kubernetes.cri.sandbox-name"],
 	}
 }
 
@@ -67,10 +71,12 @@ func getCRIOInfo(_ *metadata.ContainerConfig, specDump *spec.Spec) (*containerIn
 	}
 
 	return &containerInfo{
-		IP:      specDump.Annotations["io.kubernetes.cri-o.IP.0"],
-		Name:    cm.Name,
-		Created: specDump.Annotations["io.kubernetes.cri-o.Created"],
-		Engine:  "CRI-O",
+		IP:        specDump.Annotations["io.kubernetes.cri-o.IP.0"],
+		Name:      cm.Name,
+		Created:   specDump.Annotations["io.kubernetes.cri-o.Created"],
+		Engine:    "CRI-O",
+		Namespace: specDump.Annotations["io.kubernetes.pod.namespace"],
+		Pod:       specDump.Annotations["io.kubernetes.pod.name"],
 	}, nil
 }
 

test/checkpointctl.bats

@@ -20,8 +20,9 @@ function setup() {
 }
 
 function teardown() {
-	[ "$TEST_TMP_DIR1" != "" ] && rm -rf "$TEST_TMP_DIR1"
-	[ "$TEST_TMP_DIR2" != "" ] && rm -rf "$TEST_TMP_DIR2"
+	#[ "$TEST_TMP_DIR1" != "" ] && rm -rf "$TEST_TMP_DIR1"
+	#[ "$TEST_TMP_DIR2" != "" ] && rm -rf "$TEST_TMP_DIR2"
+	echo hu
 }
 
 @test "Run checkpointctl" {
@@ -644,43 +645,42 @@ function teardown() {
 
 @test "Run checkpointctl list with empty directory" {
     mkdir "$TEST_TMP_DIR1"/empty
-    checkpointctl list -p "$TEST_TMP_DIR1"/empty/
+    checkpointctl list "$TEST_TMP_DIR1"/empty/
     [ "$status" -eq 0 ]
     [[ ${lines[0]} == *"No checkpoints found"* ]]
 }
 
 @test "Run checkpointctl list with non existing directory" {
-	checkpointctl list -p /does-not-exist
+	checkpointctl list /does-not-exist
 	[ "$status" -eq 0 ]
 	[[ ${lines[0]} == *"No checkpoints found"* ]]
 }
 
 @test "Run checkpointctl list with empty tar file" {
 	touch "$TEST_TMP_DIR1"/checkpoint-nginx-empty.tar
-	checkpointctl list -p "$TEST_TMP_DIR1"
+	checkpointctl list "$TEST_TMP_DIR1"
 	[ "$status" -eq 0 ]
-	[[ "${lines[1]}" == *"Error reading spec.dump file"* ]]
-	[[ "${lines[2]}" == *"Error extracting information"* ]]
+	[[ "${lines[1]}" == *"Error extracting information"* ]]
 }
 
 @test "Run checkpointctl list with tar file with valid spec.dump and empty config.dump" {
 	touch "$TEST_TMP_DIR1"/config.dump
 	cp data/list_config_spec.dump/spec.dump "$TEST_TMP_DIR1"
 	mkdir "$TEST_TMP_DIR1"/checkpoint
 	( cd "$TEST_TMP_DIR1" && tar cf "$TEST_TMP_DIR2"/checkpoint-config.tar . )
-	checkpointctl list -p "$TEST_TMP_DIR2"
+	checkpointctl list "$TEST_TMP_DIR2"
 	[ "$status" -eq 0 ]
-	[[ "${lines[1]}" == *"Error extracting information from $TEST_TMP_DIR2/checkpoint-config.tar: unexpected end of JSON input"* ]]
+	[[ "${lines[1]}" == *"Error extracting information from $TEST_TMP_DIR2/checkpoint-config.tar: failed to unmarshal"* ]]
 }
 
 @test "Run checkpointctl list with tar file with valid config.dump and empty spec.dump" {
 	touch "$TEST_TMP_DIR1"/spec.dump
 	cp data/list_config_spec.dump/config.dump "$TEST_TMP_DIR1"
 	mkdir "$TEST_TMP_DIR1"/checkpoint
 	( cd "$TEST_TMP_DIR1" && tar cf "$TEST_TMP_DIR2"/checkpoint-config.tar . )
-	checkpointctl list -p "$TEST_TMP_DIR2"
+	checkpointctl list "$TEST_TMP_DIR2"
 	[ "$status" -eq 0 ]
-	[[ ${lines[1]} == *"Error extracting information from $TEST_TMP_DIR2/checkpoint-config.tar: unexpected end of JSON input" ]]
+	[[ ${lines[1]} == *"Error extracting information from $TEST_TMP_DIR2/checkpoint-config.tar: failed to unmarshal"* ]]
 }
 
 @test "Run checkpointctl list with tar file with valid config.dump and spec.dump" {
@@ -691,10 +691,10 @@ function teardown() {
 	jq '.["annotations"]["io.kubernetes.pod.name"] = "modified-pod-name"' "$TEST_TMP_DIR1"/spec.dump > "$TEST_TMP_DIR1"/spec_modified.dump
 	mv "$TEST_TMP_DIR1"/spec_modified.dump "$TEST_TMP_DIR1"/spec.dump
 	( cd "$TEST_TMP_DIR1" && tar cf "$TEST_TMP_DIR2"/checkpoint-valid-config-modified.tar . )
-	checkpointctl list -p "$TEST_TMP_DIR2"
+	checkpointctl list "$TEST_TMP_DIR2"
 	[ "$status" -eq 0 ]
-	[[ "${lines[4]}" == *"| default   | modified-pod-name | container-name | cri-o  |"* ]]
+	[[ "${lines[4]}" == *"| default   | modified-pod-name | container-name | CRI-O  |"* ]]
 	[[ "${lines[4]}" == *"| checkpoint-valid-config-modified.tar |"* ]]
-	[[ "${lines[6]}" == *"| default   | pod-name          | container-name | cri-o  |"* ]]
+	[[ "${lines[6]}" == *"| default   | pod-name          | container-name | CRI-O  |"* ]]
 	[[ "${lines[6]}" == *"| checkpoint-valid-config.tar          |"* ]]
 }

test/data/list_config_spec.dump/spec.dump

@@ -1,9 +1,10 @@
 {
 	"annotations": {
-	    "io.container.manager": "cri-o",
+		"io.container.manager": "cri-o",
 		"io.kubernetes.container.hash": "1511917a",
 		"io.kubernetes.container.name": "container-name",
 		"io.kubernetes.pod.name": "pod-name",
-		"io.kubernetes.pod.namespace": "default"
+		"io.kubernetes.pod.namespace": "default",
+		"io.kubernetes.cri-o.Metadata": "{\"name\":\"container-name\"}"
 	}
-}
+}