From c88e8cc0573b8c5ea5ec77dd8bd4ea88308c9c8f Mon Sep 17 00:00:00 2001 From: jregan Date: Sun, 20 Oct 2019 17:22:49 -0700 Subject: [PATCH] Make new nesting place for generated builtin code. --- .../accumulator/loadconfigfromcrds.go | 2 +- .../accumulator/loadconfigfromcrds_test.go | 2 +- .../accumulator/namereferencetransformer.go | 2 +- .../namereferencetransformer_test.go | 2 +- api/internal/accumulator/resaccumulator.go | 2 +- .../accumulator/resaccumulator_test.go | 2 +- .../builtinconfig/consts/commonannotations.go | 0 .../builtinconfig/consts/commonlabels.go | 0 .../builtinconfig/consts/defaultconfig.go | 0 api/{ => plugins}/builtinconfig/consts/doc.go | 0 .../builtinconfig/consts/images.go | 0 .../builtinconfig/consts/nameprefix.go | 0 .../builtinconfig/consts/namereference.go | 0 .../builtinconfig/consts/namespace.go | 0 .../builtinconfig/consts/replicas.go | 0 .../builtinconfig/consts/varreference.go | 0 api/{ => plugins}/builtinconfig/doc.go | 0 .../builtinconfig/loaddefaultconfig.go | 0 .../builtinconfig/loaddefaultconfig_test.go | 0 .../builtinconfig/namebackreferences.go | 0 .../builtinconfig/namebackreferences_test.go | 0 .../builtinconfig/transformerconfig.go | 2 +- .../builtinconfig/transformerconfig_test.go | 2 +- .../builtinplugintype_string.go | 37 +++++++++ .../{builtins => builtinhelpers}/builtins.go | 34 ++++---- .../builtins/builtinplugintype_string.go | 37 --------- api/plugins/builtins/doc.go | 8 ++ api/plugins/config/config.go | 2 + api/plugins/loader/loader.go | 8 +- api/target/kusttarget.go | 10 +-- api/target/kusttarget_configplugin.go | 82 +++++++++---------- api/testutils/kusttest/kusttestharness.go | 2 +- api/transform/maptransformer_test.go | 2 +- docs/plugins/builtins.md | 2 +- examples/configureBuiltinPlugin.md | 2 +- kustomize/internal/commands/config/config.go | 2 +- 36 files changed, 127 insertions(+), 117 deletions(-) rename api/{ => plugins}/builtinconfig/consts/commonannotations.go (100%) rename api/{ => plugins}/builtinconfig/consts/commonlabels.go (100%) rename api/{ => plugins}/builtinconfig/consts/defaultconfig.go (100%) rename api/{ => plugins}/builtinconfig/consts/doc.go (100%) rename api/{ => plugins}/builtinconfig/consts/images.go (100%) rename api/{ => plugins}/builtinconfig/consts/nameprefix.go (100%) rename api/{ => plugins}/builtinconfig/consts/namereference.go (100%) rename api/{ => plugins}/builtinconfig/consts/namespace.go (100%) rename api/{ => plugins}/builtinconfig/consts/replicas.go (100%) rename api/{ => plugins}/builtinconfig/consts/varreference.go (100%) rename api/{ => plugins}/builtinconfig/doc.go (100%) rename api/{ => plugins}/builtinconfig/loaddefaultconfig.go (100%) rename api/{ => plugins}/builtinconfig/loaddefaultconfig_test.go (100%) rename api/{ => plugins}/builtinconfig/namebackreferences.go (100%) rename api/{ => plugins}/builtinconfig/namebackreferences_test.go (100%) rename api/{ => plugins}/builtinconfig/transformerconfig.go (98%) rename api/{ => plugins}/builtinconfig/transformerconfig_test.go (98%) create mode 100644 api/plugins/builtinhelpers/builtinplugintype_string.go rename api/plugins/{builtins => builtinhelpers}/builtins.go (99%) delete mode 100644 api/plugins/builtins/builtinplugintype_string.go create mode 100644 api/plugins/builtins/doc.go diff --git a/api/internal/accumulator/loadconfigfromcrds.go b/api/internal/accumulator/loadconfigfromcrds.go index ef661ff18..11c667b57 100644 --- a/api/internal/accumulator/loadconfigfromcrds.go +++ b/api/internal/accumulator/loadconfigfromcrds.go @@ -10,8 +10,8 @@ import ( "github.com/go-openapi/spec" "github.com/pkg/errors" "k8s.io/kube-openapi/pkg/common" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" "sigs.k8s.io/kustomize/v3/api/ifc" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resid" "sigs.k8s.io/kustomize/v3/api/types" "sigs.k8s.io/yaml" diff --git a/api/internal/accumulator/loadconfigfromcrds_test.go b/api/internal/accumulator/loadconfigfromcrds_test.go index 55ed307da..fda53374c 100644 --- a/api/internal/accumulator/loadconfigfromcrds_test.go +++ b/api/internal/accumulator/loadconfigfromcrds_test.go @@ -7,10 +7,10 @@ import ( "reflect" "testing" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" "sigs.k8s.io/kustomize/v3/api/ifc" . "sigs.k8s.io/kustomize/v3/api/internal/accumulator" "sigs.k8s.io/kustomize/v3/api/internal/loadertest" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resid" "sigs.k8s.io/kustomize/v3/api/types" ) diff --git a/api/internal/accumulator/namereferencetransformer.go b/api/internal/accumulator/namereferencetransformer.go index ba6ceeac8..299e9ba4d 100644 --- a/api/internal/accumulator/namereferencetransformer.go +++ b/api/internal/accumulator/namereferencetransformer.go @@ -7,7 +7,7 @@ import ( "fmt" "log" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resid" "sigs.k8s.io/kustomize/v3/api/resmap" "sigs.k8s.io/kustomize/v3/api/resource" diff --git a/api/internal/accumulator/namereferencetransformer_test.go b/api/internal/accumulator/namereferencetransformer_test.go index d7994409f..54804eeea 100644 --- a/api/internal/accumulator/namereferencetransformer_test.go +++ b/api/internal/accumulator/namereferencetransformer_test.go @@ -7,8 +7,8 @@ import ( "strings" "testing" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" "sigs.k8s.io/kustomize/v3/api/k8sdeps/kunstruct" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resid" "sigs.k8s.io/kustomize/v3/api/resmap" "sigs.k8s.io/kustomize/v3/api/resource" diff --git a/api/internal/accumulator/resaccumulator.go b/api/internal/accumulator/resaccumulator.go index 2f98395f9..880e3616c 100644 --- a/api/internal/accumulator/resaccumulator.go +++ b/api/internal/accumulator/resaccumulator.go @@ -8,7 +8,7 @@ import ( "log" "strings" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resid" "sigs.k8s.io/kustomize/v3/api/resmap" "sigs.k8s.io/kustomize/v3/api/types" diff --git a/api/internal/accumulator/resaccumulator_test.go b/api/internal/accumulator/resaccumulator_test.go index f78c15bb5..02cf01ce4 100644 --- a/api/internal/accumulator/resaccumulator_test.go +++ b/api/internal/accumulator/resaccumulator_test.go @@ -10,9 +10,9 @@ import ( "strings" "testing" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" . "sigs.k8s.io/kustomize/v3/api/internal/accumulator" "sigs.k8s.io/kustomize/v3/api/k8sdeps/kunstruct" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resid" "sigs.k8s.io/kustomize/v3/api/resmap" "sigs.k8s.io/kustomize/v3/api/resource" diff --git a/api/builtinconfig/consts/commonannotations.go b/api/plugins/builtinconfig/consts/commonannotations.go similarity index 100% rename from api/builtinconfig/consts/commonannotations.go rename to api/plugins/builtinconfig/consts/commonannotations.go diff --git a/api/builtinconfig/consts/commonlabels.go b/api/plugins/builtinconfig/consts/commonlabels.go similarity index 100% rename from api/builtinconfig/consts/commonlabels.go rename to api/plugins/builtinconfig/consts/commonlabels.go diff --git a/api/builtinconfig/consts/defaultconfig.go b/api/plugins/builtinconfig/consts/defaultconfig.go similarity index 100% rename from api/builtinconfig/consts/defaultconfig.go rename to api/plugins/builtinconfig/consts/defaultconfig.go diff --git a/api/builtinconfig/consts/doc.go b/api/plugins/builtinconfig/consts/doc.go similarity index 100% rename from api/builtinconfig/consts/doc.go rename to api/plugins/builtinconfig/consts/doc.go diff --git a/api/builtinconfig/consts/images.go b/api/plugins/builtinconfig/consts/images.go similarity index 100% rename from api/builtinconfig/consts/images.go rename to api/plugins/builtinconfig/consts/images.go diff --git a/api/builtinconfig/consts/nameprefix.go b/api/plugins/builtinconfig/consts/nameprefix.go similarity index 100% rename from api/builtinconfig/consts/nameprefix.go rename to api/plugins/builtinconfig/consts/nameprefix.go diff --git a/api/builtinconfig/consts/namereference.go b/api/plugins/builtinconfig/consts/namereference.go similarity index 100% rename from api/builtinconfig/consts/namereference.go rename to api/plugins/builtinconfig/consts/namereference.go diff --git a/api/builtinconfig/consts/namespace.go b/api/plugins/builtinconfig/consts/namespace.go similarity index 100% rename from api/builtinconfig/consts/namespace.go rename to api/plugins/builtinconfig/consts/namespace.go diff --git a/api/builtinconfig/consts/replicas.go b/api/plugins/builtinconfig/consts/replicas.go similarity index 100% rename from api/builtinconfig/consts/replicas.go rename to api/plugins/builtinconfig/consts/replicas.go diff --git a/api/builtinconfig/consts/varreference.go b/api/plugins/builtinconfig/consts/varreference.go similarity index 100% rename from api/builtinconfig/consts/varreference.go rename to api/plugins/builtinconfig/consts/varreference.go diff --git a/api/builtinconfig/doc.go b/api/plugins/builtinconfig/doc.go similarity index 100% rename from api/builtinconfig/doc.go rename to api/plugins/builtinconfig/doc.go diff --git a/api/builtinconfig/loaddefaultconfig.go b/api/plugins/builtinconfig/loaddefaultconfig.go similarity index 100% rename from api/builtinconfig/loaddefaultconfig.go rename to api/plugins/builtinconfig/loaddefaultconfig.go diff --git a/api/builtinconfig/loaddefaultconfig_test.go b/api/plugins/builtinconfig/loaddefaultconfig_test.go similarity index 100% rename from api/builtinconfig/loaddefaultconfig_test.go rename to api/plugins/builtinconfig/loaddefaultconfig_test.go diff --git a/api/builtinconfig/namebackreferences.go b/api/plugins/builtinconfig/namebackreferences.go similarity index 100% rename from api/builtinconfig/namebackreferences.go rename to api/plugins/builtinconfig/namebackreferences.go diff --git a/api/builtinconfig/namebackreferences_test.go b/api/plugins/builtinconfig/namebackreferences_test.go similarity index 100% rename from api/builtinconfig/namebackreferences_test.go rename to api/plugins/builtinconfig/namebackreferences_test.go diff --git a/api/builtinconfig/transformerconfig.go b/api/plugins/builtinconfig/transformerconfig.go similarity index 98% rename from api/builtinconfig/transformerconfig.go rename to api/plugins/builtinconfig/transformerconfig.go index 5484b2a7f..4ee755ab7 100644 --- a/api/builtinconfig/transformerconfig.go +++ b/api/plugins/builtinconfig/transformerconfig.go @@ -7,8 +7,8 @@ import ( "log" "sort" - "sigs.k8s.io/kustomize/v3/api/builtinconfig/consts" "sigs.k8s.io/kustomize/v3/api/ifc" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig/consts" "sigs.k8s.io/kustomize/v3/api/types" ) diff --git a/api/builtinconfig/transformerconfig_test.go b/api/plugins/builtinconfig/transformerconfig_test.go similarity index 98% rename from api/builtinconfig/transformerconfig_test.go rename to api/plugins/builtinconfig/transformerconfig_test.go index d968ea68b..2b71bd940 100644 --- a/api/builtinconfig/transformerconfig_test.go +++ b/api/plugins/builtinconfig/transformerconfig_test.go @@ -7,7 +7,7 @@ import ( "reflect" "testing" - . "sigs.k8s.io/kustomize/v3/api/builtinconfig" + . "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resid" "sigs.k8s.io/kustomize/v3/api/types" ) diff --git a/api/plugins/builtinhelpers/builtinplugintype_string.go b/api/plugins/builtinhelpers/builtinplugintype_string.go new file mode 100644 index 000000000..6c9e3cd2a --- /dev/null +++ b/api/plugins/builtinhelpers/builtinplugintype_string.go @@ -0,0 +1,37 @@ +// Code generated by "stringer -type=BuiltinPluginType"; DO NOT EDIT. + +package builtinhelpers + +import "strconv" + +func _() { + // An "invalid array index" compiler error signifies that the constant values have changed. + // Re-run the stringer command to generate them again. + var x [1]struct{} + _ = x[Unknown-0] + _ = x[AnnotationsTransformer-1] + _ = x[ConfigMapGenerator-2] + _ = x[HashTransformer-3] + _ = x[ImageTagTransformer-4] + _ = x[InventoryTransformer-5] + _ = x[LabelTransformer-6] + _ = x[LegacyOrderTransformer-7] + _ = x[NamespaceTransformer-8] + _ = x[PatchJson6902Transformer-9] + _ = x[PatchStrategicMergeTransformer-10] + _ = x[PatchTransformer-11] + _ = x[PrefixSuffixTransformer-12] + _ = x[ReplicaCountTransformer-13] + _ = x[SecretGenerator-14] +} + +const _BuiltinPluginType_name = "UnknownAnnotationsTransformerConfigMapGeneratorHashTransformerImageTagTransformerInventoryTransformerLabelTransformerLegacyOrderTransformerNamespaceTransformerPatchJson6902TransformerPatchStrategicMergeTransformerPatchTransformerPrefixSuffixTransformerReplicaCountTransformerSecretGenerator" + +var _BuiltinPluginType_index = [...]uint16{0, 7, 29, 47, 62, 81, 101, 117, 139, 159, 183, 213, 229, 252, 275, 290} + +func (i BuiltinPluginType) String() string { + if i < 0 || i >= BuiltinPluginType(len(_BuiltinPluginType_index)-1) { + return "BuiltinPluginType(" + strconv.FormatInt(int64(i), 10) + ")" + } + return _BuiltinPluginType_name[_BuiltinPluginType_index[i]:_BuiltinPluginType_index[i+1]] +} diff --git a/api/plugins/builtins/builtins.go b/api/plugins/builtinhelpers/builtins.go similarity index 99% rename from api/plugins/builtins/builtins.go rename to api/plugins/builtinhelpers/builtins.go index 1a1d26c24..cf8e60596 100644 --- a/api/plugins/builtins/builtins.go +++ b/api/plugins/builtinhelpers/builtins.go @@ -1,7 +1,7 @@ // Copyright 2019 The Kubernetes Authors. // SPDX-License-Identifier: Apache-2.0 -package builtins +package builtinhelpers import ( "sigs.k8s.io/kustomize/v3/api/resmap" @@ -13,20 +13,20 @@ type BuiltinPluginType int const ( Unknown BuiltinPluginType = iota - SecretGenerator + AnnotationsTransformer ConfigMapGenerator - ReplicaCountTransformer + HashTransformer + ImageTagTransformer + InventoryTransformer + LabelTransformer + LegacyOrderTransformer NamespaceTransformer PatchJson6902Transformer PatchStrategicMergeTransformer PatchTransformer - LabelTransformer - AnnotationsTransformer PrefixSuffixTransformer - ImageTagTransformer - HashTransformer - InventoryTransformer - LegacyOrderTransformer + ReplicaCountTransformer + SecretGenerator ) var stringToBuiltinPluginTypeMap map[string]BuiltinPluginType @@ -55,21 +55,21 @@ func GetBuiltinPluginType(n string) BuiltinPluginType { } var GeneratorFactories = map[BuiltinPluginType]func() resmap.GeneratorPlugin{ - SecretGenerator: builtin.NewSecretGeneratorPlugin, ConfigMapGenerator: builtin.NewConfigMapGeneratorPlugin, + SecretGenerator: builtin.NewSecretGeneratorPlugin, } var TransformerFactories = map[BuiltinPluginType]func() resmap.TransformerPlugin{ + AnnotationsTransformer: builtin.NewAnnotationsTransformerPlugin, + HashTransformer: builtin.NewHashTransformerPlugin, + ImageTagTransformer: builtin.NewImageTagTransformerPlugin, + InventoryTransformer: builtin.NewInventoryTransformerPlugin, + LabelTransformer: builtin.NewLabelTransformerPlugin, + LegacyOrderTransformer: builtin.NewLegacyOrderTransformerPlugin, NamespaceTransformer: builtin.NewNamespaceTransformerPlugin, - ReplicaCountTransformer: builtin.NewReplicaCountTransformerPlugin, PatchJson6902Transformer: builtin.NewPatchJson6902TransformerPlugin, PatchStrategicMergeTransformer: builtin.NewPatchStrategicMergeTransformerPlugin, PatchTransformer: builtin.NewPatchTransformerPlugin, - LabelTransformer: builtin.NewLabelTransformerPlugin, - AnnotationsTransformer: builtin.NewAnnotationsTransformerPlugin, PrefixSuffixTransformer: builtin.NewPrefixSuffixTransformerPlugin, - ImageTagTransformer: builtin.NewImageTagTransformerPlugin, - HashTransformer: builtin.NewHashTransformerPlugin, - InventoryTransformer: builtin.NewInventoryTransformerPlugin, - LegacyOrderTransformer: builtin.NewLegacyOrderTransformerPlugin, + ReplicaCountTransformer: builtin.NewReplicaCountTransformerPlugin, } diff --git a/api/plugins/builtins/builtinplugintype_string.go b/api/plugins/builtins/builtinplugintype_string.go deleted file mode 100644 index 3c8e7f93d..000000000 --- a/api/plugins/builtins/builtinplugintype_string.go +++ /dev/null @@ -1,37 +0,0 @@ -// Code generated by "stringer -type=BuiltinPluginType"; DO NOT EDIT. - -package builtins - -import "strconv" - -func _() { - // An "invalid array index" compiler error signifies that the constant values have changed. - // Re-run the stringer command to generate them again. - var x [1]struct{} - _ = x[Unknown-0] - _ = x[SecretGenerator-1] - _ = x[ConfigMapGenerator-2] - _ = x[ReplicaCountTransformer-3] - _ = x[NamespaceTransformer-4] - _ = x[PatchJson6902Transformer-5] - _ = x[PatchStrategicMergeTransformer-6] - _ = x[PatchTransformer-7] - _ = x[LabelTransformer-8] - _ = x[AnnotationsTransformer-9] - _ = x[PrefixSuffixTransformer-10] - _ = x[ImageTagTransformer-11] - _ = x[HashTransformer-12] - _ = x[InventoryTransformer-13] - _ = x[LegacyOrderTransformer-14] -} - -const _BuiltinPluginType_name = "UnknownSecretGeneratorConfigMapGeneratorReplicaCountTransformerNamespaceTransformerPatchJson6902TransformerPatchStrategicMergeTransformerPatchTransformerLabelTransformerAnnotationsTransformerPrefixSuffixTransformerImageTagTransformerHashTransformerInventoryTransformerLegacyOrderTransformer" - -var _BuiltinPluginType_index = [...]uint16{0, 7, 22, 40, 63, 83, 107, 137, 153, 169, 191, 214, 233, 248, 268, 290} - -func (i BuiltinPluginType) String() string { - if i < 0 || i >= BuiltinPluginType(len(_BuiltinPluginType_index)-1) { - return "BuiltinPluginType(" + strconv.FormatInt(int64(i), 10) + ")" - } - return _BuiltinPluginType_name[_BuiltinPluginType_index[i]:_BuiltinPluginType_index[i+1]] -} diff --git a/api/plugins/builtins/doc.go b/api/plugins/builtins/doc.go new file mode 100644 index 000000000..582922791 --- /dev/null +++ b/api/plugins/builtins/doc.go @@ -0,0 +1,8 @@ +// Copyright 2019 The Kubernetes Authors. +// SPDX-License-Identifier: Apache-2.0 + +// Package builtins holds code generated from the builting plugins. +// The "builtin" plugins are written as normal plugins and can +// be used as such, but they are also used to generate the code +// in this package so they can be statically linked to client code. +package builtins diff --git a/api/plugins/config/config.go b/api/plugins/config/config.go index 9ecb4b515..530d310df 100644 --- a/api/plugins/config/config.go +++ b/api/plugins/config/config.go @@ -1,6 +1,8 @@ // Copyright 2019 The Kubernetes Authors. // SPDX-License-Identifier: Apache-2.0 +// Package config provides configuration methods and constants +// for general plugins. package config import ( diff --git a/api/plugins/loader/loader.go b/api/plugins/loader/loader.go index 9ea82380a..b341fab81 100644 --- a/api/plugins/loader/loader.go +++ b/api/plugins/loader/loader.go @@ -12,7 +12,7 @@ import ( "github.com/pkg/errors" "sigs.k8s.io/kustomize/v3/api/ifc" - "sigs.k8s.io/kustomize/v3/api/plugins/builtins" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinhelpers" "sigs.k8s.io/kustomize/v3/api/plugins/config" "sigs.k8s.io/kustomize/v3/api/plugins/execplugin" "sigs.k8s.io/kustomize/v3/api/resid" @@ -134,11 +134,11 @@ func (l *Loader) loadAndConfigurePlugin( } func (l *Loader) makeBuiltinPlugin(r resid.Gvk) (resmap.Configurable, error) { - bpt := builtins.GetBuiltinPluginType(r.Kind) - if f, ok := builtins.GeneratorFactories[bpt]; ok { + bpt := builtinhelpers.GetBuiltinPluginType(r.Kind) + if f, ok := builtinhelpers.GeneratorFactories[bpt]; ok { return f(), nil } - if f, ok := builtins.TransformerFactories[bpt]; ok { + if f, ok := builtinhelpers.TransformerFactories[bpt]; ok { return f(), nil } return nil, errors.Errorf("unable to load builtin %s", r) diff --git a/api/target/kusttarget.go b/api/target/kusttarget.go index 542b8710e..1c7f252d9 100644 --- a/api/target/kusttarget.go +++ b/api/target/kusttarget.go @@ -13,11 +13,11 @@ import ( "strings" "github.com/pkg/errors" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" "sigs.k8s.io/kustomize/v3/api/ifc" "sigs.k8s.io/kustomize/v3/api/internal/accumulator" "sigs.k8s.io/kustomize/v3/api/pgmconfig" - "sigs.k8s.io/kustomize/v3/api/plugins/builtins" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinhelpers" "sigs.k8s.io/kustomize/v3/api/plugins/loader" "sigs.k8s.io/kustomize/v3/api/resmap" "sigs.k8s.io/kustomize/v3/api/transform" @@ -165,7 +165,7 @@ func (kt *KustTarget) makeCustomizedResMap( func (kt *KustTarget) addHashesToNames( ra *accumulator.ResAccumulator) error { p := builtin.NewHashTransformerPlugin() - err := kt.configureBuiltinPlugin(p, nil, builtins.HashTransformer) + err := kt.configureBuiltinPlugin(p, nil, builtinhelpers.HashTransformer) if err != nil { return err } @@ -194,7 +194,7 @@ func (kt *KustTarget) computeInventory( c.Namespace = inv.ConfigMap.Namespace c.Policy = garbagePolicy.String() p := builtin.NewInventoryTransformerPlugin() - err := kt.configureBuiltinPlugin(p, c, builtins.InventoryTransformer) + err := kt.configureBuiltinPlugin(p, c, builtinhelpers.InventoryTransformer) if err != nil { return err } @@ -372,7 +372,7 @@ func (kt *KustTarget) accumulateFile( } func (kt *KustTarget) configureBuiltinPlugin( - p resmap.Configurable, c interface{}, bpt builtins.BuiltinPluginType) (err error) { + p resmap.Configurable, c interface{}, bpt builtinhelpers.BuiltinPluginType) (err error) { var y []byte if c != nil { y, err = yaml.Marshal(c) diff --git a/api/target/kusttarget_configplugin.go b/api/target/kusttarget_configplugin.go index cb973ef4e..ff057e473 100644 --- a/api/target/kusttarget_configplugin.go +++ b/api/target/kusttarget_configplugin.go @@ -4,8 +4,8 @@ package target import ( - "sigs.k8s.io/kustomize/v3/api/builtinconfig" - "sigs.k8s.io/kustomize/v3/api/plugins/builtins" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinhelpers" "sigs.k8s.io/kustomize/v3/api/resmap" "sigs.k8s.io/kustomize/v3/api/types" ) @@ -27,12 +27,12 @@ import ( func (kt *KustTarget) configureBuiltinGenerators() ( result []resmap.Generator, err error) { - for _, bpt := range []builtins.BuiltinPluginType{ - builtins.ConfigMapGenerator, - builtins.SecretGenerator, + for _, bpt := range []builtinhelpers.BuiltinPluginType{ + builtinhelpers.ConfigMapGenerator, + builtinhelpers.SecretGenerator, } { r, err := generatorConfigurators[bpt]( - kt, bpt, builtins.GeneratorFactories[bpt]) + kt, bpt, builtinhelpers.GeneratorFactories[bpt]) if err != nil { return nil, err } @@ -44,19 +44,19 @@ func (kt *KustTarget) configureBuiltinGenerators() ( func (kt *KustTarget) configureBuiltinTransformers( tc *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { - for _, bpt := range []builtins.BuiltinPluginType{ - builtins.PatchStrategicMergeTransformer, - builtins.PatchTransformer, - builtins.NamespaceTransformer, - builtins.PrefixSuffixTransformer, - builtins.LabelTransformer, - builtins.AnnotationsTransformer, - builtins.PatchJson6902Transformer, - builtins.ReplicaCountTransformer, - builtins.ImageTagTransformer, + for _, bpt := range []builtinhelpers.BuiltinPluginType{ + builtinhelpers.PatchStrategicMergeTransformer, + builtinhelpers.PatchTransformer, + builtinhelpers.NamespaceTransformer, + builtinhelpers.PrefixSuffixTransformer, + builtinhelpers.LabelTransformer, + builtinhelpers.AnnotationsTransformer, + builtinhelpers.PatchJson6902Transformer, + builtinhelpers.ReplicaCountTransformer, + builtinhelpers.ImageTagTransformer, } { r, err := transformerConfigurators[bpt]( - kt, bpt, builtins.TransformerFactories[bpt], tc) + kt, bpt, builtinhelpers.TransformerFactories[bpt], tc) if err != nil { return nil, err } @@ -67,11 +67,11 @@ func (kt *KustTarget) configureBuiltinTransformers( type gFactory func() resmap.GeneratorPlugin -var generatorConfigurators = map[builtins.BuiltinPluginType]func( +var generatorConfigurators = map[builtinhelpers.BuiltinPluginType]func( kt *KustTarget, - bpt builtins.BuiltinPluginType, + bpt builtinhelpers.BuiltinPluginType, factory gFactory) (result []resmap.Generator, err error){ - builtins.SecretGenerator: func(kt *KustTarget, bpt builtins.BuiltinPluginType, f gFactory) ( + builtinhelpers.SecretGenerator: func(kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f gFactory) ( result []resmap.Generator, err error) { var c struct { types.GeneratorOptions @@ -92,7 +92,7 @@ var generatorConfigurators = map[builtins.BuiltinPluginType]func( return }, - builtins.ConfigMapGenerator: func(kt *KustTarget, bpt builtins.BuiltinPluginType, f gFactory) ( + builtinhelpers.ConfigMapGenerator: func(kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f gFactory) ( result []resmap.Generator, err error) { var c struct { types.GeneratorOptions @@ -116,13 +116,13 @@ var generatorConfigurators = map[builtins.BuiltinPluginType]func( type tFactory func() resmap.TransformerPlugin -var transformerConfigurators = map[builtins.BuiltinPluginType]func( +var transformerConfigurators = map[builtinhelpers.BuiltinPluginType]func( kt *KustTarget, - bpt builtins.BuiltinPluginType, + bpt builtinhelpers.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) (result []resmap.Transformer, err error){ - builtins.NamespaceTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( + builtinhelpers.NamespaceTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { var c struct { types.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"` @@ -139,8 +139,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( return }, - builtins.PatchJson6902Transformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, _ *builtinconfig.TransformerConfig) ( + builtinhelpers.PatchJson6902Transformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, _ *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { var c struct { Target types.PatchTarget `json:"target,omitempty" yaml:"target,omitempty"` @@ -160,8 +160,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( } return }, - builtins.PatchStrategicMergeTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, _ *builtinconfig.TransformerConfig) ( + builtinhelpers.PatchStrategicMergeTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, _ *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { if len(kt.kustomization.PatchesStrategicMerge) == 0 { return @@ -179,8 +179,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( result = append(result, p) return }, - builtins.PatchTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, _ *builtinconfig.TransformerConfig) ( + builtinhelpers.PatchTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, _ *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { if len(kt.kustomization.Patches) == 0 { return @@ -203,8 +203,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( } return }, - builtins.LabelTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( + builtinhelpers.LabelTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { var c struct { Labels map[string]string @@ -220,8 +220,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( result = append(result, p) return }, - builtins.AnnotationsTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( + builtinhelpers.AnnotationsTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { var c struct { Annotations map[string]string @@ -237,8 +237,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( result = append(result, p) return }, - builtins.PrefixSuffixTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( + builtinhelpers.PrefixSuffixTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { var c struct { Prefix string @@ -256,8 +256,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( result = append(result, p) return }, - builtins.ImageTagTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( + builtinhelpers.ImageTagTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { var c struct { ImageTag types.Image @@ -275,8 +275,8 @@ var transformerConfigurators = map[builtins.BuiltinPluginType]func( } return }, - builtins.ReplicaCountTransformer: func( - kt *KustTarget, bpt builtins.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( + builtinhelpers.ReplicaCountTransformer: func( + kt *KustTarget, bpt builtinhelpers.BuiltinPluginType, f tFactory, tc *builtinconfig.TransformerConfig) ( result []resmap.Transformer, err error) { var c struct { Replica types.Replica diff --git a/api/testutils/kusttest/kusttestharness.go b/api/testutils/kusttest/kusttestharness.go index b97d1b601..523ee1cd0 100644 --- a/api/testutils/kusttest/kusttestharness.go +++ b/api/testutils/kusttest/kusttestharness.go @@ -9,12 +9,12 @@ import ( "strings" "testing" - "sigs.k8s.io/kustomize/v3/api/builtinconfig/consts" "sigs.k8s.io/kustomize/v3/api/internal/loadertest" "sigs.k8s.io/kustomize/v3/api/k8sdeps/kunstruct" "sigs.k8s.io/kustomize/v3/api/k8sdeps/transformer" fLdr "sigs.k8s.io/kustomize/v3/api/loader" "sigs.k8s.io/kustomize/v3/api/pgmconfig" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig/consts" "sigs.k8s.io/kustomize/v3/api/plugins/config" pLdr "sigs.k8s.io/kustomize/v3/api/plugins/loader" "sigs.k8s.io/kustomize/v3/api/resmap" diff --git a/api/transform/maptransformer_test.go b/api/transform/maptransformer_test.go index 932eb7339..1a0984a79 100644 --- a/api/transform/maptransformer_test.go +++ b/api/transform/maptransformer_test.go @@ -6,8 +6,8 @@ package transform_test import ( "testing" - "sigs.k8s.io/kustomize/v3/api/builtinconfig" "sigs.k8s.io/kustomize/v3/api/k8sdeps/kunstruct" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig" "sigs.k8s.io/kustomize/v3/api/resource" "sigs.k8s.io/kustomize/v3/api/testutils/resmaptest" . "sigs.k8s.io/kustomize/v3/api/transform" diff --git a/docs/plugins/builtins.md b/docs/plugins/builtins.md index 51eb86836..014416ee7 100644 --- a/docs/plugins/builtins.md +++ b/docs/plugins/builtins.md @@ -36,7 +36,7 @@ complete plugin argument specification. [types.GeneratorOptions]: ../../api/types/generatoroptions.go [types.SecretArgs]: ../../api/types/secretargs.go [types.ConfigMapArgs]: ../../api/types/configmapargs.go -[config.FieldSpec]: ../../api/builtinconfig/fieldspec.go +[config.FieldSpec]: ../../api/plugins/builtinconfig/fieldspec.go [types.ObjectMeta]: ../../api/types/objectmeta.go [types.Selector]: ../../api/types/selector.go [types.Replica]: ../../api/types/replica.go diff --git a/examples/configureBuiltinPlugin.md b/examples/configureBuiltinPlugin.md index 7e3ab4c57..cd968c9f1 100644 --- a/examples/configureBuiltinPlugin.md +++ b/examples/configureBuiltinPlugin.md @@ -4,7 +4,7 @@ [plugin]: ../docs/plugins [fields]: ../docs/fields.md [fields in a kustomization file]: ../docs/fields.md -[TransformerConfig]: ../api/builtinconfig/transformerconfig.go +[TransformerConfig]: ../api/plugins/builtinconfig/transformerconfig.go [kustomization]: ../docs/glossary.md#kustomization # Customizing kustomize diff --git a/kustomize/internal/commands/config/config.go b/kustomize/internal/commands/config/config.go index 92e8addb9..801aa5cca 100644 --- a/kustomize/internal/commands/config/config.go +++ b/kustomize/internal/commands/config/config.go @@ -9,8 +9,8 @@ import ( "github.com/spf13/cobra" - "sigs.k8s.io/kustomize/v3/api/builtinconfig/consts" "sigs.k8s.io/kustomize/v3/api/filesys" + "sigs.k8s.io/kustomize/v3/api/plugins/builtinconfig/consts" ) // NewCmdConfig returns an instance of 'config' subcommand.