-
Notifications
You must be signed in to change notification settings - Fork 293
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1661 from itsdarshankumar/extension-package
Extension package
- Loading branch information
Showing
15 changed files
with
980 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,115 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| "context" | ||
| "path/filepath" | ||
|
|
||
| "github.com/pkg/errors" | ||
| "github.com/spf13/cobra" | ||
|
|
||
| pubbldpkg "github.com/buildpacks/pack/buildpackage" | ||
| "github.com/buildpacks/pack/internal/config" | ||
| "github.com/buildpacks/pack/internal/style" | ||
| "github.com/buildpacks/pack/pkg/client" | ||
| "github.com/buildpacks/pack/pkg/image" | ||
| "github.com/buildpacks/pack/pkg/logging" | ||
| ) | ||
|
|
||
| // ExtensionPackageFlags define flags provided to the ExtensionPackage command | ||
| type ExtensionPackageFlags struct { | ||
| PackageTomlPath string | ||
| Format string | ||
| Publish bool | ||
| Policy string | ||
| ExtensionRegistry string | ||
| Path string | ||
| PackageTomlPath string | ||
| Format string | ||
| Publish bool | ||
| Policy string | ||
| } | ||
|
|
||
| // Packager and PackageConfigReader to be added here and argument also to be added in the function | ||
| // ExtensionPackager packages extensions | ||
| type ExtensionPackager interface { | ||
| PackageExtension(ctx context.Context, options client.PackageBuildpackOptions) error | ||
| } | ||
|
|
||
| // ExtensionPackage packages (a) extension(s) into OCI format, based on a package config | ||
| func ExtensionPackage(logger logging.Logger, cfg config.Config) *cobra.Command { | ||
| func ExtensionPackage(logger logging.Logger, cfg config.Config, packager ExtensionPackager, packageConfigReader PackageConfigReader) *cobra.Command { | ||
| var flags ExtensionPackageFlags | ||
| cmd := &cobra.Command{ | ||
| 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 | ||
| if err := validateExtensionPackageFlags(&flags); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| stringPolicy := flags.Policy | ||
| if stringPolicy == "" { | ||
| stringPolicy = cfg.PullPolicy | ||
| } | ||
|
|
||
| pullPolicy, err := image.ParsePullPolicy(stringPolicy) | ||
| if err != nil { | ||
| return errors.Wrap(err, "parsing pull policy") | ||
| } | ||
|
|
||
| exPackageCfg := pubbldpkg.DefaultExtensionConfig() | ||
| relativeBaseDir := "" | ||
| if flags.PackageTomlPath != "" { | ||
| exPackageCfg, err = packageConfigReader.Read(flags.PackageTomlPath) | ||
| if err != nil { | ||
| return errors.Wrap(err, "reading config") | ||
| } | ||
|
|
||
| relativeBaseDir, err = filepath.Abs(filepath.Dir(flags.PackageTomlPath)) | ||
| if err != nil { | ||
| return errors.Wrap(err, "getting absolute path for config") | ||
| } | ||
| } | ||
| name := args[0] | ||
| if flags.Format == client.FormatFile { | ||
| switch ext := filepath.Ext(name); ext { | ||
| case client.CNBExtension: | ||
| case "": | ||
| name += client.CNBExtension | ||
| default: | ||
| logger.Warnf("%s is not a valid extension for a packaged extension. Packaged extensions must have a %s extension", style.Symbol(ext), style.Symbol(client.CNBExtension)) | ||
| } | ||
| } | ||
|
|
||
| if err := packager.PackageExtension(cmd.Context(), client.PackageBuildpackOptions{ | ||
| RelativeBaseDir: relativeBaseDir, | ||
| Name: name, | ||
| Format: flags.Format, | ||
| Config: exPackageCfg, | ||
| Publish: flags.Publish, | ||
| PullPolicy: pullPolicy, | ||
| }); err != nil { | ||
| return err | ||
| } | ||
| action := "created" | ||
| if flags.Publish { | ||
| action = "published" | ||
| } | ||
| location := "docker daemon" | ||
| if flags.Format == client.FormatFile { | ||
| location = "file" | ||
| } | ||
|
|
||
| logger.Infof("Successfully %s package %s and saved to %s", action, style.Symbol(name), location) | ||
| return nil | ||
| }), | ||
| } | ||
|
|
||
| // flags will be added here | ||
|
|
||
| cmd.Flags().StringVarP(&flags.PackageTomlPath, "config", "c", "", "Path to package TOML config") | ||
| cmd.Flags().StringVarP(&flags.Format, "format", "f", "", `Format to save package as ("image" or "file")`) | ||
| cmd.Flags().BoolVar(&flags.Publish, "publish", false, `Publish to registry (applies to "--format=image" only)`) | ||
| cmd.Flags().StringVar(&flags.Policy, "pull-policy", "", "Pull policy to use. Accepted values are always, never, and if-not-present. The default is always") | ||
| AddHelpFlag(cmd, "package") | ||
| return cmd | ||
| } | ||
|
|
||
| func validateExtensionPackageFlags(p *ExtensionPackageFlags) error { | ||
| if p.Publish && p.Policy == image.PullNever.String() { | ||
| return errors.Errorf("--publish and --pull-policy=never cannot be used together. The --publish flag requires the use of remote images.") | ||
| } | ||
| return nil | ||
| } |
Oops, something went wrong.