Add ParseFS failure unit tests

Signed-off-by: Per Goncalves da Silva <[email protected]>

Author: Per Goncalves da Silva

internal/rukpak/convert/registryv1.go

@@ -69,6 +69,14 @@ func RegistryV1ToHelmChart(ctx context.Context, rv1 fs.FS, installNamespace stri
 	return chrt, nil
 }
 
+// ParseFS converts the rv1 filesystem into a RegistryV1.
+// ParseFS expects the filesystem to conform to the registry+v1 format:
+// metadata/annotations.yaml
+// manifests/
+//   - csv.yaml
+//   - ...
+//
+// manifests directory does not contain subdirectories
 func ParseFS(ctx context.Context, rv1 fs.FS) (RegistryV1, error) {
 	l := log.FromContext(ctx)
 
@@ -84,6 +92,7 @@ func ParseFS(ctx context.Context, rv1 fs.FS) (RegistryV1, error) {
 	reg.PackageName = annotationsFile.Annotations.PackageName
 
 	const manifestsDir = "manifests"
+	foundCSV := false
 	if err := fs.WalkDir(rv1, manifestsDir, func(path string, e fs.DirEntry, err error) error {
 		if err != nil {
 			return err
@@ -119,6 +128,7 @@ func ParseFS(ctx context.Context, rv1 fs.FS) (RegistryV1, error) {
 					return err
 				}
 				reg.CSV = csv
+				foundCSV = true
 			default:
 				reg.Others = append(reg.Others, *info.Object.(*unstructured.Unstructured))
 			}
@@ -131,6 +141,10 @@ func ParseFS(ctx context.Context, rv1 fs.FS) (RegistryV1, error) {
 		return reg, err
 	}
 
+	if !foundCSV {
+		return reg, fmt.Errorf("no ClusterServiceVersion found in %q", manifestsDir)
+	}
+
 	if err := copyMetadataPropertiesToCSV(&reg.CSV, rv1); err != nil {
 		return reg, err
 	}

internal/rukpak/convert/registryv1_test.go

@@ -3,10 +3,11 @@ package convert_test
 import (
 	"context"
 	"fmt"
-	"github.com/operator-framework/operator-controller/internal/rukpak/convert"
+	"io/fs"
 	"os"
 	"strings"
 	"testing"
+	"testing/fstest"
 
 	"github.com/stretchr/testify/require"
 	appsv1 "k8s.io/api/apps/v1"
@@ -21,12 +22,17 @@ import (
 
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
 	"github.com/operator-framework/operator-registry/alpha/property"
+
+	"github.com/operator-framework/operator-controller/internal/rukpak/convert"
 )
 
 const (
 	olmNamespaces    = "olm.targetNamespaces"
 	olmProperties    = "olm.properties"
 	installNamespace = "testInstallNamespace"
+
+	bundlePathAnnotations = "metadata/annotations.yaml"
+	bundlePathCSV         = "manifests/csv.yaml"
 )
 
 func getCsvAndService() (v1alpha1.ClusterServiceVersion, corev1.Service) {
@@ -466,6 +472,48 @@ func TestRegistryV1SuiteReadBundleFileSystem(t *testing.T) {
 	require.JSONEq(t, `[{"type":"from-csv-annotations-key","value":"from-csv-annotations-value"},{"type":"from-file-key","value":"from-file-value"}]`, chrt.Metadata.Annotations[olmProperties])
 }
 
+func TestParseFSFails(t *testing.T) {
+	for _, tt := range []struct {
+		name string
+		FS   fs.FS
+	}{
+		{
+			name: "bundle missing ClusterServiceVersion manifest",
+			FS:   removePaths(newBundleFS(), bundlePathCSV),
+		}, {
+			name: "bundle missing metadata/annotations.yaml",
+			FS:   removePaths(newBundleFS(), bundlePathAnnotations),
+		}, {
+			name: "bundle missing metadata/ directory",
+			FS:   removePaths(newBundleFS(), "metadata/"),
+		}, {
+			name: "bundle missing manifests/ directory",
+			FS:   removePaths(newBundleFS(), "manifests/"),
+		},
+	} {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err := convert.ParseFS(context.Background(), tt.FS)
+			require.Error(t, err)
+		})
+	}
+}
+
+func TestRegistryV1SuiteReadBundleFileSystemFailsOnNoCSV(t *testing.T) {
+	t.Log("convert.RegistryV1 Suite Convert")
+	t.Log("It should generate objects successfully based on target namespaces")
+
+	t.Log("It should read the registry+v1 bundle filesystem correctly")
+	t.Log("It should include metadata/properties.yaml and csv.metadata.annotations['olm.properties'] in chart metadata")
+	fsys := os.DirFS("testdata/combine-properties-bundle")
+
+	chrt, err := convert.RegistryV1ToHelmChart(context.Background(), fsys, "", nil)
+	require.NoError(t, err)
+	require.NotNil(t, chrt)
+	require.NotNil(t, chrt.Metadata)
+	require.Contains(t, chrt.Metadata.Annotations, olmProperties)
+	require.JSONEq(t, `[{"type":"from-csv-annotations-key","value":"from-csv-annotations-value"},{"type":"from-file-key","value":"from-file-value"}]`, chrt.Metadata.Annotations[olmProperties])
+}
+
 func TestRegistryV1SuiteGenerateNoWebhooks(t *testing.T) {
 	t.Log("convert.RegistryV1 Suite Convert")
 	t.Log("It should generate objects successfully based on target namespaces")
@@ -543,3 +591,40 @@ func findObjectByName(name string, result []client.Object) client.Object {
 	}
 	return nil
 }
+
+func newBundleFS() fstest.MapFS {
+	annotationsYml := `
+annotations:
+  operators.operatorframework.io.bundle.mediatype.v1: registry+v1
+  operators.operatorframework.io.bundle.package.v1: test
+`
+
+	csvYml := `
+apiVersion: operators.operatorframework.io/v1alpha1
+kind: ClusterServiceVersion
+metadata:
+  name: test.v1.0.0
+  annotations:
+    olm.properties: '[{"type":"from-csv-annotations-key", "value":"from-csv-annotations-value"}]'
+spec:
+  installModes:
+    - type: AllNamespaces
+      supported: true
+`
+
+	return fstest.MapFS{
+		bundlePathAnnotations: &fstest.MapFile{Data: []byte(strings.Trim(annotationsYml, "\n"))},
+		bundlePathCSV:         &fstest.MapFile{Data: []byte(strings.Trim(csvYml, "\n"))},
+	}
+}
+
+func removePaths(mapFs fstest.MapFS, paths ...string) fstest.MapFS {
+	for k := range mapFs {
+		for _, path := range paths {
+			if strings.HasPrefix(k, path) {
+				delete(mapFs, k)
+			}
+		}
+	}
+	return mapFs
+}