feat!: Replace dynamic OCI arguments with generic options (#660)

Approved-by: Alexander Jung <[email protected]>
unikraft · Jul 24, 2023 · 8ea7051 · 8ea7051
2 parents 20225fb + 1773573
commit 8ea7051
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 55 deletions.
diff --git a/cmd/kraft/pkg/pkg.go b/cmd/kraft/pkg/pkg.go
@@ -66,7 +66,7 @@ func New() *cobra.Command {
 		`, "`"),
 		Example: heredoc.Doc(`
 			# Package a project as an OCI archive and embed the target's KConfig.
-			$ kraft pkg --as oci --oci-tag unikraft.org/nginx:latest --with-kconfig`),
+			$ kraft pkg --as oci --name unikraft.org/nginx:latest --with-kconfig`),
 		Annotations: map[string]string{
 			cmdfactory.AnnotationHelpGroup: "pkg",
 		},
@@ -204,9 +204,10 @@ func (opts *Pkg) Run(cmd *cobra.Command, args []string) error {
 
 					popts := []packmanager.PackOption{
 						packmanager.PackArgs(cmdShellArgs...),
+						packmanager.PackInitrd(opts.Initrd),
 						packmanager.PackKConfig(opts.WithKConfig),
+						packmanager.PackName(opts.Name),
 						packmanager.PackOutput(opts.Output),
-						packmanager.PackInitrd(opts.Initrd),
 					}
 
 					if ukversion, ok := targ.KConfig().Get(unikraft.UK_FULLVERSION); ok {

diff --git a/oci/init.go b/oci/init.go
@@ -5,7 +5,6 @@
 package oci
 
 import (
-	"kraftkit.sh/cmdfactory"
 	"kraftkit.sh/packmanager"
 )
 
@@ -19,24 +18,4 @@ func init() {
 		WithDefaultRegistries(),
 		WithDetectHandler(),
 	)
-
-	// Register additional command-line flags
-	cmdfactory.RegisterFlag(
-		"kraft pkg",
-		cmdfactory.StringVar(
-			&flagTag,
-			"oci-tag",
-			"",
-			"Set the OCI image tag.",
-		),
-	)
-	cmdfactory.RegisterFlag(
-		"kraft pkg",
-		cmdfactory.BoolVar(
-			&flagUseMediaTypes,
-			"oci-use-media-types",
-			false,
-			"Use media types as opposed to well-known paths (experimental).",
-		),
-	)
 }
diff --git a/oci/oci.go b/oci/oci.go
@@ -4,11 +4,6 @@
 // You may not use this file except in compliance with the License.
 package oci
 
-var (
-	flagTag           string
-	flagUseMediaTypes bool
-)
-
 const (
 	DefaultRegistry  = "unikraft.org"
 	DefaultNamespace = "default"

diff --git a/oci/pack.go b/oci/pack.go
@@ -73,8 +73,8 @@ func NewPackageFromTarget(ctx context.Context, targ target.Target, opts ...packm
 		command: popts.Args(),
 	}
 
-	if flagTag != "" {
-		ocipack.ref, err = name.ParseReference(flagTag,
+	if popts.Name() != "" {
+		ocipack.ref, err = name.ParseReference(popts.Name(),
 			name.WithDefaultRegistry(DefaultRegistry),
 		)
 	} else {
@@ -147,32 +147,18 @@ func NewPackageFromTarget(ctx context.Context, targ target.Target, opts ...packm
 		"dest": WellKnownKernelPath,
 	}).Debug("oci: including kernel")
 
-	if flagUseMediaTypes {
-		blob, err := NewBlobFromFile(ctx,
-			MediaTypeImageKernel,
-			ocipack.Kernel(),
-		)
-		if err != nil {
-			return nil, err
-		}
-
-		if _, err := image.AddBlob(ctx, blob); err != nil {
-			return nil, err
-		}
-	} else {
-		layer, err := NewLayerFromFile(ctx,
-			ocispec.MediaTypeImageLayer,
-			ocipack.Kernel(),
-			WellKnownKernelPath,
-			WithLayerAnnotation(AnnotationKernelPath, WellKnownKernelPath),
-		)
-		if err != nil {
-			return nil, err
-		}
+	layer, err := NewLayerFromFile(ctx,
+		ocispec.MediaTypeImageLayer,
+		ocipack.Kernel(),
+		WellKnownKernelPath,
+		WithLayerAnnotation(AnnotationKernelPath, WellKnownKernelPath),
+	)
+	if err != nil {
+		return nil, err
+	}
 
-		if _, err := image.AddLayer(ctx, layer); err != nil {
-			return nil, err
-		}
+	if _, err := image.AddLayer(ctx, layer); err != nil {
+		return nil, err
 	}
 
 	if popts.Initrd() != "" {

diff --git a/packmanager/pack_options.go b/packmanager/pack_options.go
@@ -15,6 +15,7 @@ type PackOptions struct {
 	kernelLibraryObjects             bool
 	kernelSourceFiles                bool
 	kernelVersion                    string
+	name                             string
 	output                           string
 }
 
@@ -60,6 +61,11 @@ func (popts *PackOptions) KernelVersion() string {
 	return popts.kernelVersion
 }
 
+// Name returns the name of the package.
+func (popts *PackOptions) Name() string {
+	return popts.name
+}
+
 // Output returns the location of the package.
 func (popts *PackOptions) Output() string {
 	return popts.output
@@ -127,6 +133,13 @@ func PackWithKernelVersion(version string) PackOption {
 	}
 }
 
+// PackName sets the name of the package.
+func PackName(name string) PackOption {
+	return func(popts *PackOptions) {
+		popts.name = name
+	}
+}
+
 // PackOutput sets the location of the output artifact package.
 func PackOutput(output string) PackOption {
 	return func(popts *PackOptions) {