chore: package dependencies debt

translator/common_fields.go

@@ -0,0 +1,61 @@
+// Copyright 2022 Red Hat, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package translator
+
+import (
+	"fmt"
+
+	"github.com/coreos/go-semver/semver"
+)
+
+type commonFields struct {
+	Variant string         `yaml:"variant"`
+	Version semver.Version `yaml:"version"`
+}
+
+func (c *commonFields) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	type plain commonFields
+	var raw plain
+
+	if err := unmarshal(&raw); err != nil {
+		return err
+	}
+
+	if raw.Variant == "" {
+		return fmt.Errorf("variant cannot be empty")
+	}
+
+	*c = commonFields(raw)
+	return nil
+}
+
+func (c *commonFields) asKey() string {
+	return fmt.Sprintf("%s+%s", c.Variant, c.Version.String())
+}
+
+func newCF(variant, version string) (commonFields, error) {
+	if variant == "" {
+		return commonFields{}, fmt.Errorf("variant cannot be empty")
+	}
+
+	v, err := semver.NewVersion(version)
+	if err != nil {
+		return commonFields{}, fmt.Errorf("invalid version: %w", err)
+	}
+
+	return commonFields{
+		Variant: variant,
+		Version: *v,
+	}, nil
+}

translator/interface.go

@@ -0,0 +1,23 @@
+// Copyright 2022 Red Hat, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package translator
+
+import (
+	"github.com/coreos/butane/config/common"
+	"github.com/coreos/vcontext/report"
+)
+
+type Translator interface {
+	TranslateBytes(input []byte, options common.TranslateBytesOptions) ([]byte, report.Report, error)
+}

translator/registery.go

@@ -0,0 +1,54 @@
+// Copyright 2022 Red Hat, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package translator
+
+import (
+	"fmt"
+
+	"github.com/coreos/butane/config/common"
+	"github.com/coreos/vcontext/report"
+	"gopkg.in/yaml.v3"
+)
+
+var TranslatorRegistry = &Registry{
+    translators: make(map[string]Translator),
+}
+
+type Registry struct {
+	translators map[string]Translator
+}
+
+func (r *Registry) RegisterTranslator(variant, version string, trans Translator) {
+	cf, err := newCF(variant, version)
+	if err != nil {
+		panic(fmt.Sprintf("tried to register a translator with an invalid key (%s+%s)", variant, version))
+	}
+	if _, ok := r.translators[cf.asKey()]; ok {
+		panic(fmt.Sprintf("tried to reregister existing translator (%s+%s)", variant, version))
+	}
+	r.translators[cf.asKey()] = trans
+}
+
+func (r *Registry) TranslateBytes(input []byte, options common.TranslateBytesOptions) ([]byte, report.Report, error) {
+	// first determine version; this will ignore most fields
+	cf := commonFields{}
+	if err := yaml.Unmarshal(input, &cf); err != nil {
+		return nil, report.Report{}, common.ErrUnmarshal{
+			Detail: err.Error(),
+		}
+	}
+
+	translator := r.translators[cf.asKey()]
+	return translator.TranslateBytes(input, options)
+}