poc for schema import

Author: grokspawn

alpha/action/render.go

@@ -450,10 +450,7 @@ BundleLoop:
 func combineConfigs(cfgs []declcfg.DeclarativeConfig) *declcfg.DeclarativeConfig {
 	out := &declcfg.DeclarativeConfig{}
 	for _, in := range cfgs {
-		out.Packages = append(out.Packages, in.Packages...)
-		out.Channels = append(out.Channels, in.Channels...)
-		out.Bundles = append(out.Bundles, in.Bundles...)
-		out.Others = append(out.Others, in.Others...)
+		out.Merge(&in)
 	}
 	return out
 }

alpha/declcfg/declcfg.go

@@ -16,16 +16,18 @@ import (
 )
 
 const (
-	SchemaPackage = "olm.package"
-	SchemaChannel = "olm.channel"
-	SchemaBundle  = "olm.bundle"
+	SchemaPackage     = "olm.package"
+	SchemaChannel     = "olm.channel"
+	SchemaBundle      = "olm.bundle"
+	SchemaDeprecation = "olm.catalog.deprecation"
 )
 
 type DeclarativeConfig struct {
-	Packages []Package
-	Channels []Channel
-	Bundles  []Bundle
-	Others   []Meta
+	Packages     []Package
+	Channels     []Channel
+	Bundles      []Bundle
+	Deprecations map[string]Deprecation // mapping package name to deprecation
+	Others       []Meta
 }
 
 type Package struct {
@@ -90,6 +92,19 @@ type RelatedImage struct {
 	Image string `json:"image"`
 }
 
+type Deprecation struct {
+	Schema       string             `json:"schema"`
+	Package      string             `json:"package"`
+	Name         string             `json:"name,omitempty"`
+	Deprecations []DeprecationEntry `json:"deprecations"`
+}
+
+type DeprecationEntry struct {
+	Schema  string          `json:"schema"`
+	Name    string          `json:"name,omitempty"`
+	Message json.RawMessage `json:"message"`
+}
+
 type Meta struct {
 	Schema  string
 	Package string
@@ -181,3 +196,27 @@ func extractUniqueMetaKeys(blobMap map[string]any, m *Meta) error {
 	}
 	return nil
 }
+
+func (destination *DeclarativeConfig) Merge(src *DeclarativeConfig) error {
+	destination.Packages = append(destination.Packages, src.Packages...)
+	destination.Channels = append(destination.Channels, src.Channels...)
+	destination.Bundles = append(destination.Bundles, src.Bundles...)
+	destination.Others = append(destination.Others, src.Others...)
+	if err := destination.mergeDeprecations(src); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (destination *DeclarativeConfig) mergeDeprecations(src *DeclarativeConfig) error {
+	for p, d := range src.Deprecations {
+		if _, ok := destination.Deprecations[p]; ok {
+			return fmt.Errorf("deprecation for package %q already exists", d.Package)
+		}
+		if destination.Deprecations == nil {
+			destination.Deprecations = make(map[string]Deprecation)
+		}
+		destination.Deprecations[p] = d
+	}
+	return nil
+}

alpha/declcfg/load.go

@@ -227,12 +227,8 @@ func mergeCfgs(ctx context.Context, cfgChan <-chan *DeclarativeConfig, fcfg *Dec
 			if !ok {
 				return nil
 			}
-			fcfg.Packages = append(fcfg.Packages, cfg.Packages...)
-			fcfg.Channels = append(fcfg.Channels, cfg.Channels...)
-			fcfg.Bundles = append(fcfg.Bundles, cfg.Bundles...)
-			fcfg.Others = append(fcfg.Others, cfg.Others...)
+			fcfg.Merge(cfg)
 		}
-
 	}
 }
 
@@ -272,7 +268,7 @@ func extractCSV(objs []string) string {
 
 // LoadReader reads yaml or json from the passed in io.Reader and unmarshals it into a DeclarativeConfig struct.
 func LoadReader(r io.Reader) (*DeclarativeConfig, error) {
-	cfg := &DeclarativeConfig{}
+	cfg := &DeclarativeConfig{Deprecations: make(map[string]Deprecation)}
 
 	if err := WalkMetasReader(r, func(in *Meta, err error) error {
 		if err != nil {
@@ -297,6 +293,15 @@ func LoadReader(r io.Reader) (*DeclarativeConfig, error) {
 				return fmt.Errorf("parse bundle: %v", err)
 			}
 			cfg.Bundles = append(cfg.Bundles, b)
+		case SchemaDeprecation:
+			var d Deprecation
+			if err := json.Unmarshal(in.Blob, &d); err != nil {
+				return fmt.Errorf("parse deprecation: %v", err)
+			}
+			if _, ok := cfg.Deprecations[d.Package]; ok {
+				return fmt.Errorf("deprecation for package %q already exists", d.Package)
+			}
+			cfg.Deprecations[d.Package] = d
 		case "":
 			return fmt.Errorf("object '%s' is missing root schema field", string(in.Blob))
 		default:

alpha/declcfg/load_test.go

@@ -418,13 +418,20 @@ func writeToEncoder(cfg DeclarativeConfig, enc encoder) error {
 				return err
 			}
 		}
+
+		if _, ok := cfg.Deprecations[pName]; ok {
+			if err := enc.Encode(cfg.Deprecations[pName]); err != nil {
+				return err
+			}
+		}
 	}
 
 	for _, o := range othersByPackage[""] {
 		if err := enc.Encode(o); err != nil {
 			return err
 		}
 	}
+
 	return nil
 }
 

alpha/declcfg/write.go

@@ -387,10 +387,7 @@ func newChannel(pkgName string, chName string) *declcfg.Channel {
 func combineConfigs(cfgs []declcfg.DeclarativeConfig) *declcfg.DeclarativeConfig {
 	out := &declcfg.DeclarativeConfig{}
 	for _, in := range cfgs {
-		out.Packages = append(out.Packages, in.Packages...)
-		out.Channels = append(out.Channels, in.Channels...)
-		out.Bundles = append(out.Bundles, in.Bundles...)
-		out.Others = append(out.Others, in.Others...)
+		out.Merge(&in)
 	}
 	return out
 }