Cleanup Bundle CRD when printing it

Author: ash2k

cmd/crd/BUILD.bazel

@@ -5,11 +5,7 @@ go_library(
     srcs = ["main.go"],
     importpath = "github.com/atlassian/smith/cmd/crd",
     visibility = ["//visibility:private"],
-    deps = [
-        "//pkg/resources:go_default_library",
-        "//vendor/github.com/ghodss/yaml:go_default_library",
-        "//vendor/github.com/pkg/errors:go_default_library",
-    ],
+    deps = ["//pkg/resources:go_default_library"],
 )
 
 go_binary(

cmd/crd/main.go

@@ -1,14 +1,11 @@
 package main
 
 import (
-	"encoding/json"
 	"flag"
 	"fmt"
 	"os"
 
 	"github.com/atlassian/smith/pkg/resources"
-	"github.com/ghodss/yaml"
-	"github.com/pkg/errors"
 )
 
 func main() {
@@ -23,26 +20,5 @@ func innerMain() error {
 	printBundle := flag.String("print-bundle", "yaml", "Print Bundle CRD and exit (specify format: json or yaml)")
 	flag.Parse()
 
-	switch *printBundle {
-	case "json":
-		enc := json.NewEncoder(os.Stdout)
-		enc.SetIndent("", "  ")
-		enc.SetEscapeHTML(false)
-		err := enc.Encode(resources.BundleCrd())
-		if err != nil {
-			return errors.Wrap(err, "failed to marshal Bundle CRD into JSON")
-		}
-	case "yaml":
-		data, err := yaml.Marshal(resources.BundleCrd())
-		if err != nil {
-			return errors.Wrap(err, "failed to marshal Bundle CRD into YAML")
-		}
-		_, err = os.Stdout.Write(data)
-		if err != nil {
-			return errors.Wrap(err, "failed to write Bundle CRD YAML to stdout")
-		}
-	default:
-		return errors.Errorf("unsupported Bundle CRD output format %q", *printBundle)
-	}
-	return nil
+	return resources.PrintCleanedObject(os.Stdout, *printBundle, resources.BundleCrd())
 }

pkg/controller/bundlec_test/BUILD.bazel

@@ -17,7 +17,6 @@ go_test(
         "no_actions_for_blocked_resources_test.go",
         "no_deletions_while_in_progress_test.go",
         "not_marked_crd_ignored_test.go",
-        "plugin_error_propagated_test.go",
         "plugin_schema_invalid_test.go",
         "plugin_spec_processed_test.go",
         "processing_continues_after_error_test.go",

pkg/resources/BUILD.bazel

@@ -15,11 +15,14 @@ go_library(
         "//vendor/github.com/atlassian/ctrl/logz:go_default_library",
         "//vendor/github.com/pkg/errors:go_default_library",
         "//vendor/go.uber.org/zap:go_default_library",
+        "//vendor/gopkg.in/yaml.v2:go_default_library",
         "//vendor/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1:go_default_library",
         "//vendor/k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset:go_default_library",
         "//vendor/k8s.io/apiextensions-apiserver/pkg/client/listers/apiextensions/v1beta1:go_default_library",
         "//vendor/k8s.io/apimachinery/pkg/api/errors:go_default_library",
         "//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library",
+        "//vendor/k8s.io/apimachinery/pkg/apis/meta/v1/unstructured:go_default_library",
+        "//vendor/k8s.io/apimachinery/pkg/runtime:go_default_library",
         "//vendor/k8s.io/apimachinery/pkg/util/wait:go_default_library",
         "//vendor/k8s.io/client-go/util/jsonpath:go_default_library",
     ],

pkg/resources/crd_helpers.go

@@ -2,6 +2,8 @@ package resources
 
 import (
 	"context"
+	"encoding/json"
+	"io"
 	"reflect"
 	"time"
 
@@ -11,14 +13,43 @@ import (
 	"github.com/atlassian/smith/pkg/util"
 	"github.com/pkg/errors"
 	"go.uber.org/zap"
+	yaml "gopkg.in/yaml.v2"
 	apiext_v1b1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
 	apiExtClientset "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset"
 	apiext_lst_v1b1 "k8s.io/apiextensions-apiserver/pkg/client/listers/apiextensions/v1beta1"
 	api_errors "k8s.io/apimachinery/pkg/api/errors"
 	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/util/wait"
 )
 
+func PrintCleanedObject(sink io.Writer, format string, obj runtime.Object) error {
+	u, err := runtime.DefaultUnstructuredConverter.ToUnstructured(obj)
+	if err != nil {
+		return errors.Wrap(err, "failed to convert objed to unstructured")
+	}
+	unstructured.RemoveNestedField(u, "metadata", "creationTimestamp")
+	unstructured.RemoveNestedField(u, "status")
+	switch format {
+	case "json":
+		enc := json.NewEncoder(sink)
+		enc.SetIndent("", "  ")
+		enc.SetEscapeHTML(false)
+		err := enc.Encode(u)
+		return errors.Wrap(err, "failed to marshal into JSON")
+	case "yaml":
+		data, err := yaml.Marshal(u)
+		if err != nil {
+			return errors.Wrap(err, "failed to marshal into YAML")
+		}
+		_, err = sink.Write(data)
+		return errors.Wrap(err, "failed to write to sink")
+	default:
+		return errors.Errorf("unsupported output format %q", format)
+	}
+}
+
 func BundleCrd() *apiext_v1b1.CustomResourceDefinition {
 	// Schema is based on:
 	// https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md