Merge branch 'main' into pack_extension

internal/build/lifecycle_execution.go

@@ -289,6 +289,9 @@ func (l *LifecycleExecution) Create(ctx context.Context, buildCache, launchCache
 		If(l.opts.SBOMDestinationDir != "", WithPostContainerRunOperations(
 			EnsureVolumeAccess(l.opts.Builder.UID(), l.opts.Builder.GID(), l.os, l.layersVolume, l.appVolume),
 			CopyOutTo(l.mountPaths.sbomDir(), l.opts.SBOMDestinationDir))),
+		If(l.opts.ReportDestinationDir != "", WithPostContainerRunOperations(
+			EnsureVolumeAccess(l.opts.Builder.UID(), l.opts.Builder.GID(), l.os, l.layersVolume, l.appVolume),
+			CopyOutTo(l.mountPaths.reportPath(), l.opts.ReportDestinationDir))),
 		If(l.opts.Interactive, WithPostContainerRunOperations(
 			EnsureVolumeAccess(l.opts.Builder.UID(), l.opts.Builder.GID(), l.os, l.layersVolume, l.appVolume),
 			CopyOut(l.opts.Termui.ReadLayers, l.mountPaths.layersDir(), l.mountPaths.appDir()))),
@@ -652,6 +655,9 @@ func (l *LifecycleExecution) Export(ctx context.Context, buildCache, launchCache
 		If(l.opts.SBOMDestinationDir != "", WithPostContainerRunOperations(
 			EnsureVolumeAccess(l.opts.Builder.UID(), l.opts.Builder.GID(), l.os, l.layersVolume, l.appVolume),
 			CopyOutTo(l.mountPaths.sbomDir(), l.opts.SBOMDestinationDir))),
+		If(l.opts.ReportDestinationDir != "", WithPostContainerRunOperations(
+			EnsureVolumeAccess(l.opts.Builder.UID(), l.opts.Builder.GID(), l.os, l.layersVolume, l.appVolume),
+			CopyOutTo(l.mountPaths.reportPath(), l.opts.ReportDestinationDir))),
 		If(l.opts.Interactive, WithPostContainerRunOperations(
 			EnsureVolumeAccess(l.opts.Builder.UID(), l.opts.Builder.GID(), l.os, l.layersVolume, l.appVolume),
 			CopyOut(l.opts.Termui.ReadLayers, l.mountPaths.layersDir(), l.mountPaths.appDir()))),

internal/build/lifecycle_execution_test.go

@@ -1007,6 +1007,21 @@ func testLifecycleExecution(t *testing.T, when spec.G, it spec.S) {
 			})
 		})
 
+		when("report destination directory is provided", func() {
+			lifecycleOps = append(lifecycleOps, func(opts *build.LifecycleOptions) {
+				opts.ReportDestinationDir = "a-destination-dir"
+			})
+
+			it("provides copy-sbom-func as a post container operation", func() {
+				h.AssertEq(t, fakePhase.CleanupCallCount, 1)
+				h.AssertEq(t, fakePhase.RunCallCount, 1)
+
+				h.AssertEq(t, len(configProvider.PostContainerRunOps()), 2)
+				h.AssertFunctionName(t, configProvider.PostContainerRunOps()[0], "EnsureVolumeAccess")
+				h.AssertFunctionName(t, configProvider.PostContainerRunOps()[1], "CopyOut")
+			})
+		})
+
 		when("--creation-time", func() {
 			when("platform < 0.9", func() {
 				platformAPI = api.MustParse("0.8")
@@ -1970,6 +1985,18 @@ func testLifecycleExecution(t *testing.T, when spec.G, it spec.S) {
 			})
 		})
 
+		when("report destination directory is provided", func() {
+			lifecycleOps = append(lifecycleOps, func(opts *build.LifecycleOptions) {
+				opts.ReportDestinationDir = "a-destination-dir"
+			})
+
+			it("provides copy-sbom-func as a post container operation", func() {
+				h.AssertEq(t, len(configProvider.PostContainerRunOps()), 2)
+				h.AssertFunctionName(t, configProvider.PostContainerRunOps()[0], "EnsureVolumeAccess")
+				h.AssertFunctionName(t, configProvider.PostContainerRunOps()[1], "CopyOut")
+			})
+		})
+
 		when("--creation-time", func() {
 			when("platform < 0.9", func() {
 				platformAPI = api.MustParse("0.8")

internal/build/lifecycle_executor.go

@@ -67,35 +67,36 @@ func init() {
 }
 
 type LifecycleOptions struct {
-	AppPath            string
-	Image              name.Reference
-	Builder            Builder
-	BuilderImage       string // differs from Builder.Name() and Builder.Image().Name() in that it includes the registry context
-	LifecycleImage     string
-	RunImage           string
-	ProjectMetadata    platform.ProjectMetadata
-	ClearCache         bool
-	Publish            bool
-	TrustBuilder       bool
-	UseCreator         bool
-	Interactive        bool
-	Termui             Termui
-	DockerHost         string
-	Cache              cache.CacheOpts
-	CacheImage         string
-	HTTPProxy          string
-	HTTPSProxy         string
-	NoProxy            string
-	Network            string
-	AdditionalTags     []string
-	Volumes            []string
-	DefaultProcessType string
-	FileFilter         func(string) bool
-	Workspace          string
-	GID                int
-	PreviousImage      string
-	SBOMDestinationDir string
-	CreationTime       *time.Time
+	AppPath              string
+	Image                name.Reference
+	Builder              Builder
+	BuilderImage         string // differs from Builder.Name() and Builder.Image().Name() in that it includes the registry context
+	LifecycleImage       string
+	RunImage             string
+	ProjectMetadata      platform.ProjectMetadata
+	ClearCache           bool
+	Publish              bool
+	TrustBuilder         bool
+	UseCreator           bool
+	Interactive          bool
+	Termui               Termui
+	DockerHost           string
+	Cache                cache.CacheOpts
+	CacheImage           string
+	HTTPProxy            string
+	HTTPSProxy           string
+	NoProxy              string
+	Network              string
+	AdditionalTags       []string
+	Volumes              []string
+	DefaultProcessType   string
+	FileFilter           func(string) bool
+	Workspace            string
+	GID                  int
+	PreviousImage        string
+	ReportDestinationDir string
+	SBOMDestinationDir   string
+	CreationTime         *time.Time
 }
 
 func NewLifecycleExecutor(logger logging.Logger, docker client.CommonAPIClient) *LifecycleExecutor {

internal/build/mount_paths.go

@@ -42,6 +42,10 @@ func (m mountPaths) projectPath() string {
 	return m.join(m.layersDir(), "project-metadata.toml")
 }
 
+func (m mountPaths) reportPath() string {
+	return m.join(m.layersDir(), "report.toml")
+}
+
 func (m mountPaths) appDirName() string {
 	return m.workspace
 }

internal/commands/build.go

@@ -22,32 +22,33 @@ import (
 )
 
 type BuildFlags struct {
-	Publish            bool
-	ClearCache         bool
-	TrustBuilder       bool
-	Interactive        bool
-	DockerHost         string
-	CacheImage         string
-	Cache              cache.CacheOpts
-	AppPath            string
-	Builder            string
-	Registry           string
-	RunImage           string
-	Policy             string
-	Network            string
-	DescriptorPath     string
-	DefaultProcessType string
-	LifecycleImage     string
-	Env                []string
-	EnvFiles           []string
-	Buildpacks         []string
-	Volumes            []string
-	AdditionalTags     []string
-	Workspace          string
-	GID                int
-	PreviousImage      string
-	SBOMDestinationDir string
-	DateTime           string
+	Publish              bool
+	ClearCache           bool
+	TrustBuilder         bool
+	Interactive          bool
+	DockerHost           string
+	CacheImage           string
+	Cache                cache.CacheOpts
+	AppPath              string
+	Builder              string
+	Registry             string
+	RunImage             string
+	Policy               string
+	Network              string
+	DescriptorPath       string
+	DefaultProcessType   string
+	LifecycleImage       string
+	Env                  []string
+	EnvFiles             []string
+	Buildpacks           []string
+	Volumes              []string
+	AdditionalTags       []string
+	Workspace            string
+	GID                  int
+	PreviousImage        string
+	SBOMDestinationDir   string
+	ReportDestinationDir string
+	DateTime             string
 }
 
 // Build an image from source code
@@ -171,6 +172,7 @@ func Build(logger logging.Logger, cfg config.Config, packClient PackClient) *cob
 				PreviousImage:            flags.PreviousImage,
 				Interactive:              flags.Interactive,
 				SBOMDestinationDir:       flags.SBOMDestinationDir,
+				ReportDestinationDir:     flags.ReportDestinationDir,
 				CreationTime:             dateTime,
 			}); err != nil {
 				return errors.Wrap(err, "failed to build")
@@ -238,6 +240,7 @@ This option may set DOCKER_HOST environment variable for the build container if
 	cmd.Flags().IntVar(&buildFlags.GID, "gid", 0, `Override GID of user's group in the stack's build and run images. The provided value must be a positive number`)
 	cmd.Flags().StringVar(&buildFlags.PreviousImage, "previous-image", "", "Set previous image to a particular tag reference, digest reference, or (when performing a daemon build) image ID")
 	cmd.Flags().StringVar(&buildFlags.SBOMDestinationDir, "sbom-output-dir", "", "Path to export SBoM contents.\nOmitting the flag will yield no SBoM content.")
+	cmd.Flags().StringVar(&buildFlags.ReportDestinationDir, "report-output-dir", "", "Path to export build report.toml.\nOmitting the flag yield no report file.")
 	cmd.Flags().BoolVar(&buildFlags.Interactive, "interactive", false, "Launch a terminal UI to depict the build process")
 	if !cfg.Experimental {
 		cmd.Flags().MarkHidden("interactive")

internal/commands/extension.go

@@ -16,9 +16,9 @@ func NewExtensionCommand(logger logging.Logger, cfg config.Config, client PackCl
 	}
 
 	cmd.AddCommand(ExtensionInspect(logger, cfg, client))
-	//client and packageConfigReader to be passed later on
+	// client and packageConfigReader to be passed later on
 	cmd.AddCommand(ExtensionPackage(logger, cfg))
-	//client to be passed later on
+	// client to be passed later on
 	cmd.AddCommand(ExtensionNew(logger))
 	cmd.AddCommand(ExtensionPull(logger, cfg, client))
 	cmd.AddCommand(ExtensionRegister(logger, cfg, client))

internal/commands/extension_inspect.go

@@ -24,18 +24,18 @@ func ExtensionInspect(logger logging.Logger, cfg config.Config, client PackClien
 			extensionName := args[0]
 			registry := flags.Registry
 			if registry == "" {
-				//fix registry for extension
+				// fix registry for extension
 			}
 
 			return extensionInspect(logger, extensionName, registry, flags, cfg, client)
 		}),
 	}
-    //flags will be added here
+	// flags will be added here
 	AddHelpFlag(cmd, "inspect")
 	return cmd
 }
 
 func extensionInspect(logger logging.Logger, extensionName, registry string, flags ExtensionInspectFlags, cfg config.Config, client PackClient) error {
-//logic to inspect extension
-return nil
-}
+	// logic to inspect extension
+	return nil
+}

internal/commands/extension_new.go

@@ -14,7 +14,7 @@ type ExtensionNewFlags struct {
 	Version string
 }
 
-//extensioncreator type to be added here and argument also to be added in the function
+// extensioncreator type to be added here and argument also to be added in the function
 
 // ExtensionNew generates the scaffolding of an extension
 func ExtensionNew(logger logging.Logger) *cobra.Command {
@@ -24,12 +24,12 @@ func ExtensionNew(logger logging.Logger) *cobra.Command {
 		Args:    cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
 		Example: "pack extension new <example-extension>",
 		RunE: logError(logger, func(cmd *cobra.Command, args []string) error {
-            //logic will go here
+			// logic will go here
 			return nil
 		}),
 	}
 
-    //flags will go here
+	// flags will go here
 
 	AddHelpFlag(cmd, "new")
 	return cmd

internal/commands/extension_package.go

@@ -17,23 +17,22 @@ type ExtensionPackageFlags struct {
 	Path              string
 }
 
-//Packager and PackageConfigReader to be added here and argument also to be added in the function
+// Packager and PackageConfigReader to be added here and argument also to be added in the function
 
 // ExtensionPackage packages (a) extension(s) into OCI format, based on a package config
 func ExtensionPackage(logger logging.Logger, cfg config.Config) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "package <name> --config <config-path>",
-		Short:   "Package an extension in OCI format.",
-		Args:    cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
+		Use:   "package <name> --config <config-path>",
+		Short: "Package an extension in OCI format.",
+		Args:  cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
 		RunE: logError(logger, func(cmd *cobra.Command, args []string) error {
-            //logic will be added here
+			// logic will be added here
 			return nil
 		}),
 	}
 
-	//flags will be added here
+	// flags will be added here
 
 	AddHelpFlag(cmd, "package")
 	return cmd
 }
-

internal/commands/extension_pull.go

@@ -22,11 +22,11 @@ func ExtensionPull(logger logging.Logger, cfg config.Config, pack PackClient) *c
 		Short:   "Pull an extension from a registry and store it locally",
 		Example: "pack extension pull <extension-example>",
 		RunE: logError(logger, func(cmd *cobra.Command, args []string) error {
-			//logic will be added here
+			// logic will be added here
 			return nil
 		}),
 	}
-    //flags will be added here
+	// flags will be added here
 	AddHelpFlag(cmd, "pull")
 	return cmd
 }

internal/commands/extension_register.go

@@ -19,11 +19,11 @@ func ExtensionRegister(logger logging.Logger, cfg config.Config, pack PackClient
 		Short:   "Register an extension to a registry",
 		Example: "pack extension register <extension-example>",
 		RunE: logError(logger, func(cmd *cobra.Command, args []string) error {
-			//logic will be added here
+			// logic will be added here
 			return nil
 		}),
 	}
-   //flags will be added here
+	// flags will be added here
 	AddHelpFlag(cmd, "register")
 	return cmd
 }

internal/commands/extension_yank.go

@@ -20,11 +20,11 @@ func ExtensionYank(logger logging.Logger, cfg config.Config, pack PackClient) *c
 		Short:   "Yank an extension from a registry",
 		Example: "pack yank <extension-example>",
 		RunE: logError(logger, func(cmd *cobra.Command, args []string) error {
-			//logic will be added here
+			// logic will be added here
 			return nil
 		}),
 	}
-    //flags will be added here
+	// flags will be added here
 	AddHelpFlag(cmd, "yank")
 
 	return cmd

internal/commands/rebase.go

@@ -49,6 +49,7 @@ func Rebase(logger logging.Logger, cfg config.Config, pack PackClient) *cobra.Co
 	cmd.Flags().BoolVar(&opts.Publish, "publish", false, "Publish to registry")
 	cmd.Flags().StringVar(&opts.RunImage, "run-image", "", "Run image to use for rebasing")
 	cmd.Flags().StringVar(&policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always")
+	cmd.Flags().StringVar(&opts.ReportDestinationDir, "report-output-dir", "", "Path to export build report.toml.\nOmitting the flag yield no report file.")
 
 	AddHelpFlag(cmd, "rebase")
 	return cmd