fixup! Update CRD generator to support experimental CRDs

Author: tmshort

hack/tools/crd-generator/main.go

@@ -57,6 +57,7 @@ func main() {
 func runGenerator(args ...string) {
 	outputDir := "config/crd"
 	ctVer := ""
+	crdRoot := "github.com/operator-framework/operator-controller/api/v1"
 	if len(args) >= 1 {
 		// Get the output directory
 		outputDir = args[0]
@@ -65,10 +66,15 @@ func runGenerator(args ...string) {
 		// get the controller-tools version
 		ctVer = args[1]
 	}
+	if len(args) >= 3 {
+		crdRoot = args[2]
+	}
+
+	log.Printf("crdRoot: %s", crdRoot)
 
 	roots, err := loader.LoadRoots(
 		"k8s.io/apimachinery/pkg/runtime/schema", // Needed to parse generated register functions.
-		"github.com/operator-framework/operator-controller/api/v1",
+		crdRoot,
 	)
 	if err != nil {
 		log.Fatalf("failed to load package roots: %s", err)
@@ -90,6 +96,7 @@ func runGenerator(args ...string) {
 
 	crd.AddKnownTypes(parser)
 	for _, r := range roots {
+		log.Printf("Looking at package %v", r)
 		parser.NeedPackage(r)
 	}
 
@@ -137,6 +144,7 @@ func runGenerator(args ...string) {
 
 			conv, err := crd.AsVersion(*channelCrd, apiextensionsv1.SchemeGroupVersion)
 			if err != nil {
+				log.Printf("CRD: %v", *channelCrd)
 				log.Fatalf("failed to convert CRD: %s", err)
 			}
 
@@ -166,6 +174,8 @@ func runGenerator(args ...string) {
 				out = append(breakLine, out...)
 			}
 
+			log.Printf("writing %v bytes", len(out))
+
 			fileName := fmt.Sprintf("%s/%s/%s_%s.yaml", outputDir, channel, crdRaw.Spec.Group, crdRaw.Spec.Names.Plural)
 			err = os.WriteFile(fileName, out, 0o600)
 			if err != nil {
@@ -206,6 +216,8 @@ func opconTweaks(channel string, name string, jsonProps apiextensionsv1.JSONSche
 	numExpressions := strings.Count(jsonProps.Description, validationPrefix)
 	numValid := 0
 	if numExpressions > 0 {
+		log.Printf("found validations")
+
 		enumRe := regexp.MustCompile(validationPrefix + "Enum=([A-Za-z;]*)>")
 		enumMatches := enumRe.FindAllStringSubmatch(jsonProps.Description, 64)
 		for _, enumMatch := range enumMatches {
@@ -220,7 +232,7 @@ func opconTweaks(channel string, name string, jsonProps apiextensionsv1.JSONSche
 			}
 		}
 
-		celRe := regexp.MustCompile(validationPrefix + "XValidation:message=\"([^\"]*)\",rule=\"([^\"]*)\">")
+		celRe := regexp.MustCompile(validationPrefix + "XValidation:rule=\"([^\"]*)\",message=\"([^\"]*)\">")
 		celMatches := celRe.FindAllStringSubmatch(jsonProps.Description, 64)
 		for _, celMatch := range celMatches {
 			if len(celMatch) != 3 {
@@ -262,6 +274,7 @@ func formatDescription(description string, channel string, name string) string {
 			log.Fatalf("Invalid <opcon:experimental:description> tag for %s", name)
 		}
 		description = re.ReplaceAllString(description, "\n\n")
+		log.Printf("found experimental:description")
 	} else {
 		description = strings.ReplaceAll(description, startTag, "")
 		description = strings.ReplaceAll(description, endTag, "")
@@ -279,6 +292,7 @@ func formatDescription(description string, channel string, name string) string {
 			log.Fatalf("Invalid <opcon:util:excludeFromCRD> tag for %s", name)
 		}
 		description = re.ReplaceAllString(description, "\n\n\n")
+		log.Printf("found excludeFromCRD")
 	}
 
 	opconRe := regexp.MustCompile(`<opcon:.*>`)

hack/tools/crd-generator/main_test.go

@@ -11,37 +11,64 @@ import (
 )
 
 func TestRunGenerator(t *testing.T) {
+	here, err := os.Getwd()
+	require.NoError(t, err)
 	// Get to repo root
-	err := os.Chdir("../../..")
+	err = os.Chdir("../../..")
 	require.NoError(t, err)
+	defer os.Chdir(here)
 	dir, err := os.MkdirTemp("", "crd-generate-*")
 	require.NoError(t, err)
 	defer os.RemoveAll(dir)
 	require.NoError(t, os.Mkdir(filepath.Join(dir, "standard"), 0o700))
 	require.NoError(t, os.Mkdir(filepath.Join(dir, "experimental"), 0o700))
 	runGenerator(dir, "v0.17.3")
 
-	f1 := filepath.Join(dir, "/standard/olm.operatorframework.io_clusterextensions.yaml")
+	f1 := filepath.Join(dir, "standard/olm.operatorframework.io_clusterextensions.yaml")
 	f2 := "config/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml"
 	fmt.Printf("comparing: %s to %s\n", f1, f2)
 	compareFiles(t, f1, f2)
 
-	f1 = filepath.Join(dir, "/standard/olm.operatorframework.io_clustercatalogs.yaml")
+	f1 = filepath.Join(dir, "standard/olm.operatorframework.io_clustercatalogs.yaml")
 	f2 = "config/base/catalogd/crd/standard/olm.operatorframework.io_clustercatalogs.yaml"
 	fmt.Printf("comparing: %s to %s\n", f1, f2)
 	compareFiles(t, f1, f2)
 
-	f1 = filepath.Join(dir, "/experimental/olm.operatorframework.io_clusterextensions.yaml")
+	f1 = filepath.Join(dir, "experimental/olm.operatorframework.io_clusterextensions.yaml")
 	f2 = "config/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml"
 	fmt.Printf("comparing: %s to %s\n", f1, f2)
 	compareFiles(t, f1, f2)
 
-	f1 = filepath.Join(dir, "/experimental/olm.operatorframework.io_clustercatalogs.yaml")
+	f1 = filepath.Join(dir, "experimental/olm.operatorframework.io_clustercatalogs.yaml")
 	f2 = "config/base/catalogd/crd/experimental/olm.operatorframework.io_clustercatalogs.yaml"
 	fmt.Printf("comparing: %s to %s\n", f1, f2)
 	compareFiles(t, f1, f2)
 }
 
+func TestTags(t *testing.T) {
+	here, err := os.Getwd()
+	require.NoError(t, err)
+	err = os.Chdir("testdata")
+	defer os.Chdir(here)
+	require.NoError(t, err)
+	dir, err := os.MkdirTemp("", "crd-generate-*")
+	require.NoError(t, err)
+	defer os.RemoveAll(dir)
+	require.NoError(t, os.Mkdir(filepath.Join(dir, "standard"), 0o700))
+	require.NoError(t, os.Mkdir(filepath.Join(dir, "experimental"), 0o700))
+	runGenerator(dir, "v0.17.3", "github.com/operator-framework/operator-controller/hack/tools/crd-generator/testdata/api/v1")
+
+	f1 := filepath.Join(dir, "standard/olm.operatorframework.io_clusterextensions.yaml")
+	f2 := "output/standard/olm.operatorframework.io_clusterextensions.yaml"
+	fmt.Printf("comparing: %s to %s\n", f1, f2)
+	compareFiles(t, f1, f2)
+
+	f1 = filepath.Join(dir, "experimental/olm.operatorframework.io_clusterextensions.yaml")
+	f2 = "output/experimental/olm.operatorframework.io_clusterextensions.yaml"
+	fmt.Printf("comparing: %s to %s\n", f1, f2)
+	compareFiles(t, f1, f2)
+}
+
 func compareFiles(t *testing.T, file1, file2 string) {
 	f1, err := os.Open(file1)
 	require.NoError(t, err)