Add composite veneer to opm alpha render-veneer ...

alpha/veneer/composite/builder.go

@@ -0,0 +1,321 @@
+package composite
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"io"
+	"os"
+	"os/exec"
+	"path"
+	"strings"
+
+	"github.com/operator-framework/operator-registry/alpha/declcfg"
+)
+
+const (
+	BasicVeneerBuilderSchema  = "olm.veneer.basic"
+	SemverVeneerBuilderSchema = "olm.veneer.semver"
+	RawVeneerBuilderSchema    = "olm.veneer.raw"
+	CustomVeneerBuilderSchema = "olm.veneer.custom"
+)
+
+type ContainerConfig struct {
+	ContainerTool string
+	BaseImage     string
+	WorkingDir    string
+}
+
+type BuilderConfig struct {
+	ContainerCfg     ContainerConfig
+	OutputType       string
+	CurrentDirectory string
+}
+
+type Builder interface {
+	Build(dir string, vd VeneerDefinition) error
+	Validate(dir string) error
+}
+
+type BasicBuilder struct {
+	builderCfg BuilderConfig
+}
+
+var _ Builder = &BasicBuilder{}
+
+func NewBasicBuilder(builderCfg BuilderConfig) *BasicBuilder {
+	return &BasicBuilder{
+		builderCfg: builderCfg,
+	}
+}
+
+func (bb *BasicBuilder) Build(dir string, vd VeneerDefinition) error {
+	if vd.Schema != BasicVeneerBuilderSchema {
+		return fmt.Errorf("schema %q does not match the basic veneer builder schema %q", vd.Schema, BasicVeneerBuilderSchema)
+	}
+	// Parse out the basic veneer configuration
+	basicConfig := &BasicVeneerConfig{}
+	err := json.Unmarshal(vd.Config, basicConfig)
+	if err != nil {
+		return fmt.Errorf("unmarshalling basic veneer config: %w", err)
+	}
+
+	// validate the basic config fields
+	valid := true
+	validationErrs := []string{}
+	if basicConfig.Input == "" {
+		valid = false
+		validationErrs = append(validationErrs, "basic veneer config must have a non-empty input (veneerDefinition.config.input)")
+	}
+
+	if basicConfig.Output == "" {
+		valid = false
+		validationErrs = append(validationErrs, "basic veneer config must have a non-empty output (veneerDefinition.config.output)")
+	}
+
+	if !valid {
+		return fmt.Errorf("basic veneer configuration is invalid: %s", strings.Join(validationErrs, ","))
+	}
+
+	// build the container command
+	containerCmd := exec.Command(bb.builderCfg.ContainerCfg.ContainerTool,
+		"run",
+		"--rm",
+		"-v",
+		fmt.Sprintf("%s:%s", bb.builderCfg.CurrentDirectory, bb.builderCfg.ContainerCfg.WorkingDir),
+		bb.builderCfg.ContainerCfg.BaseImage,
+		"alpha",
+		"render-veneer",
+		"basic",
+		path.Join(bb.builderCfg.ContainerCfg.WorkingDir, basicConfig.Input))
+
+	return build(containerCmd, path.Join(dir, basicConfig.Output), bb.builderCfg.OutputType)
+}
+
+func (bb *BasicBuilder) Validate(dir string) error {
+	return validate(bb.builderCfg.ContainerCfg, path.Join(bb.builderCfg.CurrentDirectory, dir))
+}
+
+type SemverBuilder struct {
+	builderCfg BuilderConfig
+}
+
+var _ Builder = &SemverBuilder{}
+
+func NewSemverBuilder(builderCfg BuilderConfig) *SemverBuilder {
+	return &SemverBuilder{
+		builderCfg: builderCfg,
+	}
+}
+
+func (sb *SemverBuilder) Build(dir string, vd VeneerDefinition) error {
+	if vd.Schema != SemverVeneerBuilderSchema {
+		return fmt.Errorf("schema %q does not match the semver veneer builder schema %q", vd.Schema, SemverVeneerBuilderSchema)
+	}
+	// Parse out the semver veneer configuration
+	semverConfig := &SemverVeneerConfig{}
+	err := json.Unmarshal(vd.Config, semverConfig)
+	if err != nil {
+		return fmt.Errorf("unmarshalling semver veneer config: %w", err)
+	}
+
+	// validate the semver config fields
+	valid := true
+	validationErrs := []string{}
+	if semverConfig.Input == "" {
+		valid = false
+		validationErrs = append(validationErrs, "semver veneer config must have a non-empty input (veneerDefinition.config.input)")
+	}
+
+	if semverConfig.Output == "" {
+		valid = false
+		validationErrs = append(validationErrs, "semver veneer config must have a non-empty output (veneerDefinition.config.output)")
+	}
+
+	if !valid {
+		return fmt.Errorf("semver veneer configuration is invalid: %s", strings.Join(validationErrs, ","))
+	}
+
+	// build the container command
+	containerCmd := exec.Command(sb.builderCfg.ContainerCfg.ContainerTool,
+		"run",
+		"--rm",
+		"-v",
+		fmt.Sprintf("%s:%s", sb.builderCfg.CurrentDirectory, sb.builderCfg.ContainerCfg.WorkingDir),
+		sb.builderCfg.ContainerCfg.BaseImage,
+		"alpha",
+		"render-veneer",
+		"semver",
+		path.Join(sb.builderCfg.ContainerCfg.WorkingDir, semverConfig.Input))
+
+	return build(containerCmd, path.Join(dir, semverConfig.Output), sb.builderCfg.OutputType)
+}
+
+func (sb *SemverBuilder) Validate(dir string) error {
+	return validate(sb.builderCfg.ContainerCfg, path.Join(sb.builderCfg.CurrentDirectory, dir))
+}
+
+type RawBuilder struct {
+	builderCfg BuilderConfig
+}
+
+var _ Builder = &RawBuilder{}
+
+func NewRawBuilder(builderCfg BuilderConfig) *RawBuilder {
+	return &RawBuilder{
+		builderCfg: builderCfg,
+	}
+}
+
+func (rb *RawBuilder) Build(dir string, vd VeneerDefinition) error {
+	if vd.Schema != RawVeneerBuilderSchema {
+		return fmt.Errorf("schema %q does not match the raw veneer builder schema %q", vd.Schema, RawVeneerBuilderSchema)
+	}
+	// Parse out the raw veneer configuration
+	rawConfig := &RawVeneerConfig{}
+	err := json.Unmarshal(vd.Config, rawConfig)
+	if err != nil {
+		return fmt.Errorf("unmarshalling raw veneer config: %w", err)
+	}
+
+	// validate the raw config fields
+	valid := true
+	validationErrs := []string{}
+	if rawConfig.Input == "" {
+		valid = false
+		validationErrs = append(validationErrs, "raw veneer config must have a non-empty input (veneerDefinition.config.input)")
+	}
+
+	if rawConfig.Output == "" {
+		valid = false
+		validationErrs = append(validationErrs, "raw veneer config must have a non-empty output (veneerDefinition.config.output)")
+	}
+
+	if !valid {
+		return fmt.Errorf("raw veneer configuration is invalid: %s", strings.Join(validationErrs, ","))
+	}
+
+	// build the container command
+	containerCmd := exec.Command(rb.builderCfg.ContainerCfg.ContainerTool,
+		"run",
+		"--rm",
+		"-v",
+		fmt.Sprintf("%s:%s", rb.builderCfg.CurrentDirectory, rb.builderCfg.ContainerCfg.WorkingDir),
+		"--entrypoint=cat", // This assumes that the `cat` command is available in the container -- Should we also build a `... render-veneer raw` command to ensure consistent operation? Does OPM already have a way to render a raw FBC?
+		rb.builderCfg.ContainerCfg.BaseImage,
+		path.Join(rb.builderCfg.ContainerCfg.WorkingDir, rawConfig.Input))
+
+	return build(containerCmd, path.Join(dir, rawConfig.Output), rb.builderCfg.OutputType)
+}
+
+func (rb *RawBuilder) Validate(dir string) error {
+	return validate(rb.builderCfg.ContainerCfg, path.Join(rb.builderCfg.CurrentDirectory, dir))
+}
+
+type CustomBuilder struct {
+	builderCfg BuilderConfig
+}
+
+var _ Builder = &CustomBuilder{}
+
+func NewCustomBuilder(builderCfg BuilderConfig) *CustomBuilder {
+	return &CustomBuilder{
+		builderCfg: builderCfg,
+	}
+}
+
+func (cb *CustomBuilder) Build(dir string, vd VeneerDefinition) error {
+	if vd.Schema != CustomVeneerBuilderSchema {
+		return fmt.Errorf("schema %q does not match the custom veneer builder schema %q", vd.Schema, CustomVeneerBuilderSchema)
+	}
+	// Parse out the raw veneer configuration
+	customConfig := &CustomVeneerConfig{}
+	err := json.Unmarshal(vd.Config, customConfig)
+	if err != nil {
+		return fmt.Errorf("unmarshalling custom veneer config: %w", err)
+	}
+
+	// validate the custom config fields
+	valid := true
+	validationErrs := []string{}
+	if customConfig.Command == "" {
+		valid = false
+		validationErrs = append(validationErrs, "custom veneer config must have a non-empty command (veneerDefinition.config.command)")
+	}
+
+	if customConfig.Output == "" {
+		valid = false
+		validationErrs = append(validationErrs, "custom veneer config must have a non-empty output (veneerDefinition.config.output)")
+	}
+
+	if !valid {
+		return fmt.Errorf("custom veneer configuration is invalid: %s", strings.Join(validationErrs, ","))
+	}
+	// build the command to execute
+	cmd := exec.Command(customConfig.Command, customConfig.Args...)
+	cmd.Dir = cb.builderCfg.CurrentDirectory
+
+	// custom veneer should output a valid FBC to STDOUT so we can
+	// build the FBC just like all the other veneers.
+	return build(cmd, path.Join(dir, customConfig.Output), cb.builderCfg.OutputType)
+}
+
+func (cb *CustomBuilder) Validate(dir string) error {
+	return validate(cb.builderCfg.ContainerCfg, path.Join(cb.builderCfg.CurrentDirectory, dir))
+}
+
+func writeDeclCfg(dcfg declcfg.DeclarativeConfig, w io.Writer, output string) error {
+	switch output {
+	case "yaml":
+		return declcfg.WriteYAML(dcfg, w)
+	case "json":
+		return declcfg.WriteJSON(dcfg, w)
+	default:
+		return fmt.Errorf("invalid --output value %q, expected (json|yaml)", output)
+	}
+}
+
+func validate(containerCfg ContainerConfig, dir string) error {
+	// build the container command
+	containerCmd := exec.Command(containerCfg.ContainerTool,
+		"run",
+		"--rm",
+		"-v",
+		fmt.Sprintf("%s:%s", dir, containerCfg.WorkingDir),
+		containerCfg.BaseImage,
+		"validate",
+		containerCfg.WorkingDir)
+
+	_, err := containerCmd.Output()
+	if err != nil {
+		return fmt.Errorf("running command %q: %w", containerCmd.String(), err)
+	}
+	return nil
+}
+
+func build(cmd *exec.Cmd, outPath string, outType string) error {
+	out, err := cmd.Output()
+	if err != nil {
+		return fmt.Errorf("running command %q: %w", cmd.String(), err)
+	}
+
+	// parse out to dcfg
+	dcfg, err := declcfg.LoadReader(bytes.NewReader(out))
+	if err != nil {
+		return fmt.Errorf("parsing builder output: %w", err)
+	}
+
+	// write the dcfg
+	file, err := os.Create(outPath)
+	if err != nil {
+		return fmt.Errorf("creating output file %q: %w", outPath, err)
+	}
+	defer file.Close()
+
+	err = writeDeclCfg(*dcfg, file, outType)
+	if err != nil {
+		return fmt.Errorf("writing to output file %q: %w", outPath, err)
+	}
+
+	return nil
+}