Merge pull request #6 from sarus-suite/mksquahsfs-options

Mksquahsfs options

Author: fcruzcscs

cmd/migration.go

@@ -334,11 +334,23 @@ func createSquashSidecarFromMount(srcDir, link string, cfg common.Config) error
 		if err := os.MkdirAll(filepath.Dir(squashPath), 0o755); err != nil {
 			return err
 		}
-		// TODO: how to expose options? particularly the compression?
-		cmd := exec.Command(cfg.MksquashfsPath,
-		srcDir, squashPath,
-		"-noappend", "-comp", "zstd", "-Xcompression-level", "1", "-noD", 
-		"-no-xattrs", "-e", "security.capability")
+
+		// Choose default or user provided flags
+		defaultFlags := []string {
+			"-noappend",
+			"-comp", "zstd",
+			"-Xcompression-level", "1",
+			"-noD", "-no-xattrs",
+			"-e", "security.capability", 
+		}
+		flags := defaultFlags
+		if len(cfg.MksquashfsOpts) > 0 {
+			flags = cfg.MksquashfsOpts
+		}
+
+		// Build mksquashfs command
+		arg := append([]string{srcDir, squashPath}, flags...)
+		cmd := exec.Command(cfg.MksquashfsPath, arg...)
 		if out, err := cmd.CombinedOutput(); err != nil {
 			return fmt.Errorf("mksquashfs: %v\n%s", err, out)
 		}

common/cli.go

@@ -7,6 +7,7 @@ import (
 	"os"
 
 	"github.com/sirupsen/logrus"
+	"github.com/mattn/go-shellwords"
 )
 
 // TODO: auto gen version field
@@ -35,6 +36,7 @@ Options:
         "podmanRoot",
         "roStoragePath",
         "mksquashfsPath",
+		"mksquashfs-opts",
         "log-level",
         "version",
     }
@@ -96,6 +98,7 @@ func ParseAndValidateFlags(fs *flag.FlagSet, args []string) (*CLI, error) {
 	podmanRoot := fs.String("podmanRoot", "/var/lib/containers/storage", "Path to Podman root storage directory")
 	roStorage  := fs.String("roStoragePath", "/mnt/nfs/podman", "Path to read-only storage location")
 	mksquashfs := fs.String("mksquashfsPath", "/usr/bin/mksquashfs", "Path to mksquashfs binary")
+	mksOptsF   := fs.String("mksquashfs-opts", "", "Parameters for mksquashfs")
 	image      := fs.String("image", "", "the name (:tag) of the image to remove")
 	logLevelF  := fs.String("log-level", "info", "Logging level (debug, info, warn, error, fatal, panic)")
 	migrateF   := fs.Bool("migrate", false, "Migrates an image")
@@ -141,13 +144,26 @@ func ParseAndValidateFlags(fs *flag.FlagSet, args []string) (*CLI, error) {
 		return nil, fmt.Errorf("Invalid log level %q", *logLevelF)
 	}
 
+	// Lets parse the mksquashfs options into a string[]
+	var opts []string
+	if *mksOptsF != "" {
+		parser := shellwords.NewParser()
+		parser.ParseBacktick = true
+		parsed, err := parser.Parse(*mksOptsF)
+		if err != nil {
+			return nil, fmt.Errorf("invalid mksquashfs-opts: %w", err)
+		}
+		opts = parsed
+	}
+
 	// We made it through checks we can init the CLI struct
 	return &CLI {
 		Config: Config {
 			PodmanRoot: *podmanRoot,
 			RoStoragePath: *roStorage,
 			MksquashfsPath: *mksquashfs,
 			Image: *image,
+			MksquashfsOpts: opts,
 		},
 		Op: map[bool]Operation{true: OpMigrate, false: OpRmi}[*migrateF], // inlined if/else
 		LogLevel: level,

common/config.go

@@ -6,10 +6,11 @@ import (
 )
 
 type Config struct {
-    PodmanRoot     string
-    RoStoragePath  string
-    MksquashfsPath string
-    Image          string
+    PodmanRoot        string
+    RoStoragePath     string
+    MksquashfsPath    string
+    Image             string
+	MksquashfsOpts    []string
 }
 
 func IsDir(path string) error {

tests/validate-mksquashfs-opts.bats

@@ -0,0 +1,51 @@
+load helpers.bash
+
+@test "migrate with custom mksquashfs compression level 3" {
+run \
+	"$PODMAN_BINARY" \
+		--root "$PODMAN_ROOT" \
+		--runroot "$PODMAN_RUNROOT" \
+		pull docker.io/library/hello-world:linux
+
+run \
+	"$PARALLAX_BINARY" \
+		--podmanRoot "$PODMAN_ROOT" \
+		--roStoragePath "$RO_STORAGE" \
+		--mksquashfsPath "$MKSQUASHFS_PATH" \
+		--mksquashfs-opts "-noappend -comp zstd -Xcompression-level 3 -noD -no-xattrs -e security.capability" \
+		--log-level info \
+		--migrate \
+		--image docker.io/library/hello-world:linux
+[ "$status" -eq 0 ]
+[[ "$output" =~ "Migration successfully completed" ]]
+
+run \
+	ls "$RO_STORAGE"/overlay/**/*.squash
+[ "$status" -eq 0 ]
+
+# Inspect squashfs metadata
+run \
+	bash -c 'SQUASH_FILE=$(ls "$RO_STORAGE"/overlay/**/*.squash | head -n1) && unsquashfs -s "$SQUASH_FILE"'
+[ "$status" -eq 0 ]
+[[ "$output" =~ "Compression zstd" ]]
+[[ "$output" =~ "level 3" ]]
+
+run \
+	"$PODMAN_BINARY" \
+		--root "$CLEAN_ROOT" \
+		--runroot "$PODMAN_RUNROOT" \
+		--storage-opt additionalimagestore=$RO_STORAGE \
+		--storage-opt mount_program=$MOUNT_PROGRAM_PATH \
+		run --rm --security-opt seccomp=unconfined docker.io/library/hello-world:linux
+[ "$status" -eq 0 ]
+[[ "$output" =~ "Hello from Docker!" ]]
+
+run \
+	"$PARALLAX_BINARY" \
+		--podmanRoot "$CLEAN_ROOT" \
+		--roStoragePath "$RO_STORAGE" \
+		--mksquashfsPath "$MKSQUASHFS_PATH" \
+		--log-level info \
+		--rmi \
+		--image docker.io/library/hello-world:linux
+}