Merge pull request #124 from dinhxuanvu/bundle-build-fix

Bug 1771273: Fix bundle build command with Docker and update documentation

Author: openshift-merge-robot

docs/design/operator-bundle.md

@@ -159,6 +159,12 @@ The `--package` or `-p` is the name of package fo the operator such as `etcd` wh
 
 All information in `annotations.yaml` is also existed in `LABEL` section of `Dockerfile`.
 
+The `Dockerfile` can be used manually to build the bundle image using container image tools such as Docker, Podman or Buildah. For example, the Docker build command would be:
+
+```bash
+$ docker build -f /path/to/Dockerfile -t quay.io/test/test-operator:latest /path/to/manifests/
+```
+
 ### Build Bundle Image
 
 Operator bundle image can be built from provided operator manifests using `build` command (see *Notes* below). The overall `bundle build` command usage is:
@@ -196,4 +202,3 @@ The `--package` or `-p` is the name of package fo the operator such as `etcd` wh
 *Notes:*
 * If there is `Dockerfile` existing in the directory, it will be overwritten.
 * If there is an existing `annotations.yaml` in `/metadata` directory, the cli will attempt to validate it and returns any found errors. If the ``annotations.yaml`` is valid, it will be used as a part of build process. The optional boolean `--overwrite/-o` flag can be enabled (false by default) to allow cli to overwrite the `annotations.yaml` if existed.
-* The directory where the operator manifests are located must be inside the context of the build which in this case is inside the directory where you run the command.

pkg/lib/bundle/build.go

@@ -17,9 +17,9 @@ func BuildBundleImage(directory, imageTag, imageBuilder string) (*exec.Cmd, erro
 
 	switch imageBuilder {
 	case "docker", "podman":
-		args = append(args, "build", "-f", dockerfilePath, "-t", imageTag, ".")
+		args = append(args, "build", "-f", dockerfilePath, "-t", imageTag, directory)
 	case "buildah":
-		args = append(args, "bud", "--format=docker", "-f", dockerfilePath, "-t", imageTag, ".")
+		args = append(args, "bud", "--format=docker", "-f", dockerfilePath, "-t", imageTag, directory)
 	default:
 		return nil, fmt.Errorf("%s is not supported image builder", imageBuilder)
 	}
@@ -54,8 +54,13 @@ func ExecuteCommand(cmd *exec.Cmd) error {
 // @channelDefault: The default channel for the bundle image
 // @overwrite: Boolean flag to enable overwriting annotations.yaml locally if existed
 func BuildFunc(directory, imageTag, imageBuilder, packageName, channels, channelDefault string, overwrite bool) error {
+	_, err := os.Stat(directory)
+	if os.IsNotExist(err) {
+		return err
+	}
+
 	// Generate annotations.yaml and Dockerfile
-	err := GenerateFunc(directory, packageName, channels, channelDefault, overwrite)
+	err = GenerateFunc(directory, packageName, channels, channelDefault, overwrite)
 	if err != nil {
 		return err
 	}

pkg/lib/bundle/build_test.go

@@ -22,21 +22,21 @@ func TestBuildBundleImage(t *testing.T) {
 			testOperatorDir,
 			"test",
 			"docker",
-			"docker build -f /test-operator/Dockerfile -t test .",
+			"docker build -f /test-operator/Dockerfile -t test /test-operator",
 			"",
 		},
 		{
 			testOperatorDir,
 			"test",
 			"buildah",
-			"buildah bud --format=docker -f /test-operator/Dockerfile -t test .",
+			"buildah bud --format=docker -f /test-operator/Dockerfile -t test /test-operator",
 			"",
 		},
 		{
 			testOperatorDir,
 			"test",
 			"podman",
-			"podman build -f /test-operator/Dockerfile -t test .",
+			"podman build -f /test-operator/Dockerfile -t test /test-operator",
 			"",
 		},
 		{

pkg/lib/bundle/generate.go

@@ -43,7 +43,10 @@ type AnnotationMetadata struct {
 // @channelDefault: The default channel for the bundle image
 // @overwrite: Boolean flag to enable overwriting annotations.yaml locally if existed
 func GenerateFunc(directory, packageName, channels, channelDefault string, overwrite bool) error {
-	var mediaType string
+	_, err := os.Stat(directory)
+	if os.IsNotExist(err) {
+		return err
+	}
 
 	// Determine mediaType
 	mediaType, err := GetMediaType(directory)
@@ -77,7 +80,7 @@ func GenerateFunc(directory, packageName, channels, channelDefault string, overw
 	log.Info("Building Dockerfile")
 
 	// Generate Dockerfile
-	content, err = GenerateDockerfile(directory, mediaType, ManifestsDir, MetadataDir, packageName, channels, channelDefault)
+	content, err = GenerateDockerfile(mediaType, ManifestsDir, MetadataDir, packageName, channels, channelDefault)
 	if err != nil {
 		return err
 	}
@@ -226,7 +229,7 @@ func GenerateAnnotations(mediaType, manifests, metadata, packageName, channels,
 // GenerateDockerfile builds Dockerfile with mediatype, manifests &
 // metadata directories in bundle image, package name, channels and default
 // channels information in LABEL section.
-func GenerateDockerfile(directory, mediaType, manifests, metadata, packageName, channels, channelDefault string) ([]byte, error) {
+func GenerateDockerfile(mediaType, manifests, metadata, packageName, channels, channelDefault string) ([]byte, error) {
 	var fileContent string
 
 	chanDefault, err := ValidateChannelDefault(channels, channelDefault)
@@ -246,8 +249,8 @@ func GenerateDockerfile(directory, mediaType, manifests, metadata, packageName,
 	fileContent += fmt.Sprintf("LABEL %s=%s\n\n", ChannelDefaultLabel, chanDefault)
 
 	// CONTENT
-	fileContent += fmt.Sprintf("ADD %s %s\n", filepath.Join(directory, "*.yaml"), "/manifests/")
-	fileContent += fmt.Sprintf("ADD %s %s%s\n", filepath.Join(directory, metadata, AnnotationsFile), "/metadata/", AnnotationsFile)
+	fileContent += fmt.Sprintf("COPY %s %s\n", "/*.yaml", "/manifests/")
+	fileContent += fmt.Sprintf("COPY %s %s%s\n", filepath.Join("/", metadata, AnnotationsFile), "/metadata/", AnnotationsFile)
 
 	return []byte(fileContent), nil
 }

pkg/lib/bundle/generate_test.go

@@ -212,11 +212,11 @@ func TestGenerateDockerfileFunc(t *testing.T) {
 		"LABEL operators.operatorframework.io.bundle.package.v1=test4\n"+
 		"LABEL operators.operatorframework.io.bundle.channels.v1=test5\n"+
 		"LABEL operators.operatorframework.io.bundle.channel.default.v1=test5\n\n"+
-		"ADD %s/*.yaml /manifests/\n"+
-		"ADD %s/annotations.yaml /metadata/annotations.yaml\n", MetadataDir, getTestDir(),
-		filepath.Join(getTestDir(), MetadataDir))
+		"COPY /*.yaml /manifests/\n"+
+		"COPY %s/annotations.yaml /metadata/annotations.yaml\n", MetadataDir,
+		filepath.Join("/", MetadataDir))
 
-	content, err := GenerateDockerfile(getTestDir(), "test1", "test2", MetadataDir, "test4", "test5", "")
+	content, err := GenerateDockerfile("test1", "test2", MetadataDir, "test4", "test5", "")
 	require.NoError(t, err)
 	require.Equal(t, output, string(content))
 }