[v1.8.x] fix: build-cmd arg in pkgman-to-bundle (#5036)

* fix: build-cmd arg in pkgman-to-bundle

The custom build command in pkgman-to-bundle accepts the input and
executes it using `exec.Command()`. However, `exec.Command()` requires the
first argument to be the path or name of the binary. This change separates
the user input and considers first argument as the path.

Signed-off-by: varshaprasad96 <[email protected]>

* update docs for pkgman to bundle cmd

Signed-off-by: varshaprasad96 <[email protected]>

* add example command in doc

Signed-off-by: varshaprasad96 <[email protected]>

Co-authored-by: varshaprasad96 <[email protected]>

Author: openshift-cherrypick-robot

internal/cmd/operator-sdk/pkgmantobundle/cmd.go

@@ -74,36 +74,41 @@ INFO[0000] Creating bundle/bundle-0.0.1/bundle.Dockerfile
 INFO[0000] Creating bundle/bundle-0.0.1/metadata/annotations.yaml
 ...
 
-# After running the above command, the bundles will be generated in 'bundle/' directory.
-$ tree bundle/
-bundle/
+# After running the above command, the bundles will be generated in 'bundles/' directory.
+$ tree bundles/
+bundles/
 ├── bundle-0.0.1
-│   ├── bundle.Dockerfile
-│   ├── manifests
-│   │   ├── etcdcluster.crd.yaml
-│   │   ├── etcdoperator.clusterserviceversion.yaml
-│   ├── metadata
-│   │   └── annotations.yaml
-│   └── tests
-│       └── scorecard
-│           └── config.yaml
+│   ├── bundle
+│   │   ├── manifests
+│   │   │   ├── etcdcluster.crd.yaml
+│   │   │   ├── etcdoperator.clusterserviceversion.yaml
+│   │   ├── metadata
+│   │   │   └── annotations.yaml
+│   │   └── tests
+│   │       └── scorecard
+│   │           └── config.yaml
+│   └── bundle.Dockerfile
 └── bundle-0.0.2
-    ├── bundle.Dockerfile
-    ├── manifests
-    │   ├── etcdbackup.crd.yaml
-    │   ├── etcdcluster.crd.yaml
-    │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
-    │   ├── etcdrestore.crd.yaml
-    ├── metadata
-    │   └── annotations.yaml
-    └── tests
-        └── scorecard
-            └── config.yaml
-
-Also, images for the both the bundles will be built with the following names: quay.io/example/etcd:0.0.1 and quay.io/example/etcd:0.0.2.
+    ├── bundle
+    │   ├── manifests
+    │   │   ├── etcdbackup.crd.yaml
+    │   │   ├── etcdcluster.crd.yaml
+    │   │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
+    │   │   ├── etcdrestore.crd.yaml
+    │   └── metadata
+    │       └── annotations.yaml
+    └── bundle.Dockerfile
+
+A custom command to build bundle images can also be specified using the '--build-cmd' flag. For example,
+
+$ operator-sdk pkgman-to-bundle packagemanifests --image-tag-base quay.io/example/etcd --build-cmd "podman build -f bundle.Dockerfile . -t"
+
+Images for the both the bundles will be built with the following names: quay.io/example/etcd:0.0.1 and quay.io/example/etcd:0.0.2.
 `
 )
 
+var defaultSubBundleDir = "bundle"
+
 type pkgManToBundleCmd struct {
 	// Input packagemanifest directory.
 	pkgmanifestDir string
@@ -183,7 +188,7 @@ func (p *pkgManToBundleCmd) run() (err error) {
 			}
 
 			bundleMetaData := bundleutil.BundleMetaData{
-				BundleDir:       filepath.Join(p.outputDir, "bundle-"+dir.Name()),
+				BundleDir:       filepath.Join(p.outputDir, "bundle-"+dir.Name(), defaultSubBundleDir),
 				PackageName:     packageName,
 				Channels:        channels,
 				DefaultChannel:  defaultChannel,

internal/cmd/operator-sdk/pkgmantobundle/pkgmantobundle_test.go

@@ -34,7 +34,7 @@ var _ = Describe("Running pkgmanToBundle command", func() {
 	var (
 		p         pkgManToBundleCmd
 		pkgManDir string
-		outputDir string
+		outputDir string = "bundle-output"
 	)
 
 	BeforeEach(func() {
@@ -65,7 +65,6 @@ var _ = Describe("Running pkgmanToBundle command", func() {
 		It("should generate multiple bundles for each version of manifests", func() {
 			// Specify input package manifest directory and output directory
 			pkgManDir = filepath.Join("testdata", "packagemanifests")
-			outputDir = "bundles-output"
 
 			p.pkgmanifestDir = pkgManDir
 			p.outputDir = outputDir
@@ -88,19 +87,31 @@ var _ = Describe("Running pkgmanToBundle command", func() {
 
 				// Verifying that bundle contains required files
 				Expect(fileExists(filepath.Join(p.outputDir, bundle.Name(), "bundle.Dockerfile"))).To(BeTrue())
-				Expect(fileExists(filepath.Join(p.outputDir, bundle.Name(), "metadata", "annotations.yaml"))).To(BeTrue())
+				Expect(fileExists(filepath.Join(p.outputDir, bundle.Name(), defaultSubBundleDir, "metadata", "annotations.yaml"))).To(BeTrue())
 				Expect(b.CSV).NotTo(BeNil())
 				Expect(b.V1CRDs).NotTo(BeNil())
 
 				// Verify if scorecard config exiss in the bundle
 				if bundle.Name() == "bundle-0.0.1" {
-					Expect(fileExists(filepath.Join(p.outputDir, bundle.Name(), "tests", "scorecard", "config.yaml"))).To(BeTrue())
+					Expect(fileExists(filepath.Join(p.outputDir, bundle.Name(), defaultSubBundleDir, "tests", "scorecard", "config.yaml"))).To(BeTrue())
 				}
 			}
 		})
 
+		It("should build image when build command is provided", func() {
+			// Specify input package manifest directory and output directory
+			pkgManDir = filepath.Join("testdata", "packagemanifests")
+
+			p.pkgmanifestDir = pkgManDir
+			p.outputDir = outputDir
+			p.baseImg = "quay.io/example/memcached-operator"
+			p.buildCmd = "docker build -f bundle.Dockerfile . -t"
+
+			err := p.run()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
 		It("should error when output directory already exists", func() {
-			outputDir = "bundles-output"
 			err := os.Mkdir(outputDir, projutil.DirMode)
 			Expect(err).NotTo(HaveOccurred())
 

internal/util/bundleutil/bundleutil.go

@@ -22,6 +22,7 @@ import (
 	"os/exec"
 	"path/filepath"
 	"sort"
+	"strings"
 	"text/template"
 
 	log "github.com/sirupsen/logrus"
@@ -87,7 +88,7 @@ func (meta *BundleMetaData) GenerateMetadata() error {
 	// Create annotation values for both bundle.Dockerfile and annotations.yaml, which should
 	// hold the same set of values always.
 	values := annotationsValues{
-		BundleDir:                meta.BundleDir,
+		BundleDir:                filepath.Base(meta.BundleDir),
 		PackageName:              meta.PackageName,
 		Channels:                 meta.Channels,
 		DefaultChannel:           meta.DefaultChannel,
@@ -110,7 +111,7 @@ func (meta *BundleMetaData) GenerateMetadata() error {
 	// inside bundleDir, else its in the project directory.
 	// Remmove this, when pkgman-to-bundle migrate command is removed.
 	if len(meta.PkgmanifestPath) != 0 {
-		dockerfilePath = filepath.Join(meta.BundleDir, "bundle.Dockerfile")
+		dockerfilePath = filepath.Join(filepath.Dir(meta.BundleDir), "bundle.Dockerfile")
 	}
 
 	templateMap := map[string]*template.Template{
@@ -196,16 +197,40 @@ func (meta *BundleMetaData) BuildBundleImage(tag string) error {
 
 	img := fmt.Sprintf("%s:%s", meta.BaseImage, tag)
 
+	// switch back to current working directory, so that subsequent
+	// bundle version images can be built.
+	cwd, err := os.Getwd()
+	if err != nil {
+		return err
+	}
+
+	defer func() {
+		if err := os.Chdir(cwd); err != nil {
+			log.Error(cwd)
+		}
+	}()
+
+	if err := os.Chdir(filepath.Dir(meta.BundleDir)); err != nil {
+		return err
+	}
+
 	if len(meta.BuildCommand) != 0 {
 		// TODO(varsha): Make this more user friendly by accepting a template which
 		// can executed in each bundle subdirectory.
-		log.Infof("Using the specified command to build image %s", img)
-		cmd := exec.Command(meta.BuildCommand, img)
-		if err := cmd.Run(); err != nil {
+		log.Infof("Using the specified command to build image")
+		commandArg := strings.Split(meta.BuildCommand, " ")
+
+		// append the tag and build context to the command
+		cmd := exec.Command(commandArg[0], append(commandArg[1:], img)...)
+		output, err := cmd.CombinedOutput()
+		if err != nil || viper.GetBool(flags.VerboseOpt) {
+			fmt.Println(string(output))
+		}
+		if err != nil {
 			return err
 		}
 	} else {
-		output, err := exec.Command("docker", "build", "-f", filepath.Join(meta.BundleDir, "bundle.Dockerfile"), "-t", img, ".").CombinedOutput()
+		output, err := exec.Command("docker", "build", "-f", "bundle.Dockerfile", "-t", img, ".").CombinedOutput()
 		if err != nil || viper.GetBool(flags.VerboseOpt) {
 			fmt.Println(string(output))
 		}

website/content/en/docs/cli/operator-sdk_pkgman-to-bundle.md

@@ -55,33 +55,36 @@ INFO[0000] Creating bundle/bundle-0.0.1/bundle.Dockerfile
 INFO[0000] Creating bundle/bundle-0.0.1/metadata/annotations.yaml
 ...
 
-# After running the above command, the bundles will be generated in 'bundle/' directory.
-$ tree bundle/
-bundle/
+# After running the above command, the bundles will be generated in 'bundles/' directory.
+$ tree bundles/
+bundles/
 ├── bundle-0.0.1
-│   ├── bundle.Dockerfile
-│   ├── manifests
-│   │   ├── etcdcluster.crd.yaml
-│   │   ├── etcdoperator.clusterserviceversion.yaml
-│   ├── metadata
-│   │   └── annotations.yaml
-│   └── tests
-│       └── scorecard
-│           └── config.yaml
+│   ├── bundle
+│   │   ├── manifests
+│   │   │   ├── etcdcluster.crd.yaml
+│   │   │   ├── etcdoperator.clusterserviceversion.yaml
+│   │   ├── metadata
+│   │   │   └── annotations.yaml
+│   │   └── tests
+│   │       └── scorecard
+│   │           └── config.yaml
+│   └── bundle.Dockerfile
 └── bundle-0.0.2
-    ├── bundle.Dockerfile
-    ├── manifests
-    │   ├── etcdbackup.crd.yaml
-    │   ├── etcdcluster.crd.yaml
-    │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
-    │   ├── etcdrestore.crd.yaml
-    ├── metadata
-    │   └── annotations.yaml
-    └── tests
-        └── scorecard
-            └── config.yaml
-
-Also, images for the both the bundles will be built with the following names: quay.io/example/etcd:0.0.1 and quay.io/example/etcd:0.0.2.
+    ├── bundle
+    │   ├── manifests
+    │   │   ├── etcdbackup.crd.yaml
+    │   │   ├── etcdcluster.crd.yaml
+    │   │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
+    │   │   ├── etcdrestore.crd.yaml
+    │   └── metadata
+    │       └── annotations.yaml
+    └── bundle.Dockerfile
+
+A custom command to build bundle images can also be specified using the '--build-cmd' flag. For example,
+
+$ operator-sdk pkgman-to-bundle packagemanifests --image-tag-base quay.io/example/etcd --build-cmd "podman build -f bundle.Dockerfile . -t"
+
+Images for the both the bundles will be built with the following names: quay.io/example/etcd:0.0.1 and quay.io/example/etcd:0.0.2.
 
 ```
 

website/content/en/docs/olm-integration/quickstart-package-manifests.md

@@ -125,22 +125,28 @@ INFO[0000] Creating etcd-bundle/bundle-0.0.1/metadata/annotations.yaml
 This will create output bundles in the directory `etcd-bundle`. The output directory will look like:
 
 ```
+etcd-bundle/
 ├── bundle-0.0.1
-│   ├── bundle.Dockerfile
-│   ├── manifests
-│   │   ├── etcdcluster.crd.yaml
-│   │   ├── etcdoperator.clusterserviceversion.yaml
-│   ├── metadata
-│   │   └── annotations.yaml
+│   ├── bundle
+│   │   ├── manifests
+│   │   │   ├── etcdcluster.crd.yaml
+│   │   │   ├── etcdoperator.clusterserviceversion.yaml
+│   │   ├── metadata
+│   │   │   └── annotations.yaml
+│   │   └── tests
+│   │       └── scorecard
+│   │           └── config.yaml
+│   └── bundle.Dockerfile
 └── bundle-0.0.2
-    ├── bundle.Dockerfile
-    ├── manifests
-    │   ├── etcdbackup.crd.yaml
-    │   ├── etcdcluster.crd.yaml
-    │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
-    │   ├── etcdrestore.crd.yaml
-    ├── metadata
-        └── annotations.yaml
+    ├── bundle
+    │   ├── manifests
+    │   │   ├── etcdbackup.crd.yaml
+    │   │   ├── etcdcluster.crd.yaml
+    │   │   ├── etcdoperator.v0.0.2.clusterserviceversion.yaml
+    │   │   ├── etcdrestore.crd.yaml
+    │   └── metadata
+    │       └── annotations.yaml
+    └── bundle.Dockerfile
 ```
 
 To build images for the bundles, the base container image name can be provided using `--image-tag-base` flag. This name should be provided without the tag (`:` and characters following), as the command will tag each bundle image with its packagemanifests directory name, i.e. `<image-tag-base>:<dir-name>`. For example, the following command for the above `packagemnifests` directory would build the bundles `quay.io/example/etcd-bundle:0.0.1` and `quay.io/example/etcd-bundle:0.0.2`.
@@ -149,14 +155,19 @@ To build images for the bundles, the base container image name can be provided u
 operator-sdk pkgman-to-bundle packagemanifests --image-tag-base quay.io/example/etcd-bundle
 ```
 
-A custom command can also be specified to build images, using the `--build-cmd` flag. The default command is `docker build`. However, if using a custom command, it needs to be made sure that the command is in the `PATH` or a fully qualified path name is provided as input to the flag.
+A custom command can also be specified to build images, using the `--build-cmd` flag. The default command is `docker build`. For example:
 
-Once the command has finished building your bundle images and they have been added to a catalog image, delete all bundle directories except for the latest one. This directory will contain manifests for your operator's head bundle, and should be versioned with version control system like git. Rename this directory to `bundle`, and move `bundle.Dockerfile` to your project's root:
+```console
+$ operator-sdk pkgman-to-bundle packagemanifests --output-dir etcd-bundle/ --image-tag-base quay.io/example/etcd --build-cmd "podman build -f bundle.Dockerfile . -t"
+```
+
+However, if using a custom command, it needs to be made sure that the command is in the `PATH` or a fully qualified path name is provided as input to the flag.
+
+Once the command has finished building your bundle images and they have been added to a catalog image, delete all bundle directories except for the latest one. This directory will contain manifests for your operator's head bundle, and should be versioned with version control system like git. Move this directory and its `bundle.Dockerfile` to your project's root:
 
 ```console
-$ mv ./etcd-bundle/bundle-0.0.2 ./bundle
+$ cp -r ./etcd-bundle/bundle-0.0.2/* .
 $ rm -rf ./etcd-bundle
-$ mv bundle/bundle.Dockerfile .
 ```
 
 Try building then running your bundle on a live cluster to make sure it works as expected: