Merge pull request openshift#1459 from JoelSpeed/schema-check-test

Add openshift/crd-schema-checker to verification steps

Author: openshift-merge-robot

Makefile

@@ -49,6 +49,7 @@ verify-scripts:
 	bash -x hack/verify-integration-tests.sh
 	bash -x hack/verify-group-versions.sh
 	bash -x hack/verify-prerelease-lifecycle-gen.sh
+	bash -x hack/verify-crd-schema-checker.sh
 
 .PHONY: verify
 verify: verify-scripts verify-codegen-crds

example/.codegen.yaml

@@ -4,6 +4,10 @@ deepcopy:
   disabled: false
   headerFilePath: ../hack/empty.txt
   outputFileBaseName: zz_generated.deepcopy
+schemacheck:
+  disabled: false
+  enabledValidators: []
+  disabledValidators: []
 schemapatch:
   disabled: false
   requiredFeatureSets:

hack/verify-crd-schema-checker.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+source "$(dirname "${BASH_SOURCE}")/lib/init.sh"
+
+# Use PULL_BASE_REF for CI, otherwise use master unless overriden.
+COMPARISON_BASE=${COMPARISON_BASE:-${PULL_BASE_SHA:-"master"}}
+
+GENERATOR=schemacheck EXTRA_ARGS=--schemacheck:comparison-base=${COMPARISON_BASE} ${SCRIPT_ROOT}/hack/update-codegen.sh

openapi/generated_openapi/zz_generated.openapi.go

@@ -45,7 +45,12 @@ var rootCmd = &cobra.Command{
 			return fmt.Errorf("could not build generation context: %w", err)
 		}
 
-		if err := executeGenerators(genCtx, allGenerators()...); err != nil {
+		generators := allGenerators()
+		if verify {
+			generators = append(generators, allVerifiers()...)
+		}
+
+		if err := executeGenerators(genCtx, generators...); err != nil {
 			return fmt.Errorf("could not run generators: %w", err)
 		}
 
@@ -130,6 +135,14 @@ func allGenerators() []generation.Generator {
 	}
 }
 
+// allVerifiers returns an ordered list of verifiers to run when
+// the root command is executed with the --verify flag.
+func allVerifiers() []generation.Generator {
+	return []generation.Generator{
+		newSchemaCheckGenerator(),
+	}
+}
+
 // allMultiGroupGenerators returns an ordered list of multi-group
 // generators to run when the root command is executed.
 func allMultiGroupGenerators() []generation.MultiGroupGenerator {

openapi/openapi.json

@@ -0,0 +1,53 @@
+package main
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/openshift/api/tools/codegen/pkg/generation"
+	"github.com/openshift/api/tools/codegen/pkg/schemacheck"
+	"github.com/openshift/crd-schema-checker/pkg/cmd/options"
+	"github.com/spf13/cobra"
+)
+
+var (
+	defaultComparisonConfig = options.NewComparatorOptions()
+	comparisonBase          = "master"
+)
+
+// schemacheckCmd represents the schemacheck command
+var schemacheckCmd = &cobra.Command{
+	Use:   "schemacheck",
+	Short: "schemacheck validates CRD API schemas based on the best practices",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		genCtx, err := generation.NewContext(generation.Options{
+			BaseDir:          baseDir,
+			APIGroupVersions: apiGroupVersions,
+		})
+		if err != nil {
+			return fmt.Errorf("could not build generation context: %w", err)
+		}
+
+		gen := newSchemaCheckGenerator()
+
+		return executeGenerators(genCtx, gen)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(schemacheckCmd)
+
+	knownComparators := strings.Join(defaultComparisonConfig.KnownComparators, ", ")
+	rootCmd.PersistentFlags().StringSliceVar(&defaultComparisonConfig.DisabledComparators, "schemacheck:disabled-validators", defaultComparisonConfig.DisabledComparators, fmt.Sprintf("list of comparators that must be disabled. Available comparators: %s", knownComparators))
+	rootCmd.PersistentFlags().StringSliceVar(&defaultComparisonConfig.EnabledComparators, "schemacheck:enabled-validators", defaultComparisonConfig.EnabledComparators, fmt.Sprintf("list of comparators that must be enabled. Available comparators: %s", knownComparators))
+	rootCmd.PersistentFlags().StringVar(&comparisonBase, "schemacheck:comparison-base", comparisonBase, "base branch/commit to compare against")
+}
+
+// newSchemaCheckGenerator builds a new schemacheck generator.
+func newSchemaCheckGenerator() generation.Generator {
+	return schemacheck.NewGenerator(schemacheck.Options{
+		EnabledComparators:  defaultComparisonConfig.EnabledComparators,
+		DisabledComparators: defaultComparisonConfig.DisabledComparators,
+		ComparisonBase:      comparisonBase,
+	})
+}

tools/codegen/cmd/root.go

@@ -15,6 +15,11 @@ type Config struct {
 	// When omitted, the default configuration will be used.
 	OpenAPI *OpenAPIConfig `json:"openapi,omitempty"`
 
+	// SchemaCheck represents the configuration for the schemacheck generator.
+	// When omitted, the default configuration will be used.
+	// When provided, any equivalent flag provided values are ignored.
+	SchemaCheck *SchemaCheckConfig `json:"schemacheck,omitempty"`
+
 	// SchemaPatch represents the configuration for the schemapatch generator.
 	// When omitted, the default configuration will be used.
 	// When provided, any equivalent flag provided values are ignored.
@@ -57,6 +62,21 @@ type OpenAPIConfig struct {
 	Disabled bool `json:"disabled,omitempty"`
 }
 
+// SchemaCheckConfig is the configuration for the schemacheck generator.
+type SchemaCheckConfig struct {
+	// Disabled determines whether the schemacheck generator should be run or not.
+	// This generator is enabled by default so this field defaults to false.
+	Disabled bool `json:"disabled,omitempty"`
+
+	// EnabledValidators is a list of the validators that should be enabled.
+	// If this is empty, the default validators are enabled.
+	EnabledValidators []string `json:"enabledValidators,omitempty"`
+
+	// DisabledValidators is a list of the validators that should be disabled.
+	// If this is empty, no default validators are disabled.
+	DisabledValidators []string `json:"disabledValidators,omitempty"`
+}
+
 // SchemaPatchConfig is the configuration for the schemapatch generator.
 type SchemaPatchConfig struct {
 	// Disabled determines whether the schemapatch generator should be run or not.