Skip to content

Commit 969f4f2

Browse files
monopolemonopole
committed
Pull factories out of the bowels.
1 parent 5715f4b commit 969f4f2

File tree

9 files changed

+95
-99
lines changed

9 files changed

+95
-99
lines changed

‎pkg/app/application.go

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import (
2626
"github.com/ghodss/yaml"
2727
"github.com/golang/glog"
2828

29+
"github.com/kubernetes-sigs/kustomize/pkg/configmapandsecret"
2930
"github.com/kubernetes-sigs/kustomize/pkg/constants"
3031
"github.com/kubernetes-sigs/kustomize/pkg/crds"
3132
"github.com/kubernetes-sigs/kustomize/pkg/fs"
@@ -44,13 +45,13 @@ import (
4445
// https://github.com/kubernetes-sigs/kustomize/blob/master/docs/glossary.md#target
4546
type Application struct {
4647
kustomization *types.Kustomization
47-
loader loader.Loader
48+
ldr loader.Loader
4849
fSys fs.FileSystem
4950
}
5051

5152
// NewApplication returns a new instance of Application primed with a Loader.
52-
func NewApplication(loader loader.Loader, fSys fs.FileSystem) (*Application, error) {
53-
content, err := loader.Load(constants.KustomizationFileName)
53+
func NewApplication(ldr loader.Loader, fSys fs.FileSystem) (*Application, error) {
54+
content, err := ldr.Load(constants.KustomizationFileName)
5455
if err != nil {
5556
return nil, err
5657
}
@@ -60,7 +61,8 @@ func NewApplication(loader loader.Loader, fSys fs.FileSystem) (*Application, err
6061
if err != nil {
6162
return nil, err
6263
}
63-
return &Application{kustomization: &m, loader: loader, fSys: fSys}, nil
64+
65+
return &Application{kustomization: &m, ldr: ldr, fSys: fSys}, nil
6466
}
6567

6668
func unmarshal(y []byte, o interface{}) error {
@@ -136,18 +138,19 @@ func (a *Application) loadCustomizedResMap() (resmap.ResMap, error) {
136138
if err != nil {
137139
errs.Append(errors.Wrap(err, "loadResMapFromBasesAndResources"))
138140
}
139-
err = crds.RegisterCRDs(a.loader, a.kustomization.CRDs)
141+
err = crds.RegisterCRDs(a.ldr, a.kustomization.CRDs)
140142
if err != nil {
141143
errs.Append(errors.Wrap(err, "RegisterCRDs"))
142144
}
143-
144145
cms, err := resmap.NewResMapFromConfigMapArgs(
145-
a.loader, a.fSys, a.kustomization.ConfigMapGenerator)
146+
configmapandsecret.NewConfigMapFactory(a.fSys, a.ldr),
147+
a.kustomization.ConfigMapGenerator)
146148
if err != nil {
147149
errs.Append(errors.Wrap(err, "NewResMapFromConfigMapArgs"))
148150
}
149151
secrets, err := resmap.NewResMapFromSecretArgs(
150-
a.loader.Root(), a.fSys, a.kustomization.SecretGenerator)
152+
configmapandsecret.NewSecretFactory(a.fSys, a.ldr.Root()),
153+
a.kustomization.SecretGenerator)
151154
if err != nil {
152155
errs.Append(errors.Wrap(err, "NewResMapFromSecretArgs"))
153156
}
@@ -161,7 +164,7 @@ func (a *Application) loadCustomizedResMap() (resmap.ResMap, error) {
161164
return nil, err
162165
}
163166

164-
patches, err := resmap.NewResourceSliceFromPatches(a.loader, a.kustomization.Patches)
167+
patches, err := resmap.NewResourceSliceFromPatches(a.ldr, a.kustomization.Patches)
165168
if err != nil {
166169
errs.Append(errors.Wrap(err, "NewResourceSliceFromPatches"))
167170
}
@@ -192,7 +195,7 @@ func (a *Application) loadCustomizedResMap() (resmap.ResMap, error) {
192195
// Gets Bases and Resources as advertised.
193196
func (a *Application) loadResMapFromBasesAndResources() (resmap.ResMap, error) {
194197
bases, errs := a.loadCustomizedBases()
195-
resources, err := resmap.NewResMapFromFiles(a.loader, a.kustomization.Resources)
198+
resources, err := resmap.NewResMapFromFiles(a.ldr, a.kustomization.Resources)
196199
if err != nil {
197200
errs.Append(errors.Wrap(err, "rawResources failed to read Resources"))
198201
}
@@ -208,7 +211,7 @@ func (a *Application) loadCustomizedBases() (resmap.ResMap, *interror.Kustomizat
208211
var list []resmap.ResMap
209212
errs := &interror.KustomizationErrors{}
210213
for _, path := range a.kustomization.Bases {
211-
ldr, err := a.loader.New(path)
214+
ldr, err := a.ldr.New(path)
212215
if err != nil {
213216
errs.Append(errors.Wrap(err, "couldn't make ldr for "+path))
214217
continue
@@ -236,7 +239,7 @@ func (a *Application) loadBasesAsFlatList() ([]*Application, error) {
236239
var result []*Application
237240
errs := &interror.KustomizationErrors{}
238241
for _, path := range a.kustomization.Bases {
239-
ldr, err := a.loader.New(path)
242+
ldr, err := a.ldr.New(path)
240243
if err != nil {
241244
errs.Append(err)
242245
continue

‎pkg/commands/configmap.go

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,10 @@ func newCmdAddConfigMap(fSys fs.FileSystem) *cobra.Command {
5959
if err != nil {
6060
return err
6161
}
62-
6362
// Add the flagsAndArgs map to the kustomization file.
64-
err = addConfigMap(kustomization, flagsAndArgs, fSys)
63+
err = addConfigMap(
64+
kustomization, flagsAndArgs,
65+
configmapandsecret.NewConfigMapFactory(fSys, nil))
6566
if err != nil {
6667
return err
6768
}
@@ -93,24 +94,22 @@ func newCmdAddConfigMap(fSys fs.FileSystem) *cobra.Command {
9394
}
9495

9596
// addConfigMap adds a configmap to a kustomization file.
96-
// Note: error may leave kustomization file in an undefined state. Suggest passing a copy
97-
// of kustomization file.
98-
func addConfigMap(k *types.Kustomization, flagsAndArgs cMapFlagsAndArgs, fSys fs.FileSystem) error {
97+
// Note: error may leave kustomization file in an undefined state.
98+
// Suggest passing a copy of kustomization file.
99+
func addConfigMap(
100+
k *types.Kustomization,
101+
flagsAndArgs cMapFlagsAndArgs,
102+
factory *configmapandsecret.ConfigMapFactory) error {
99103
cmArgs := makeConfigMapArgs(k, flagsAndArgs.Name)
100-
101104
err := mergeFlagsIntoCmArgs(&cmArgs.DataSources, flagsAndArgs)
102105
if err != nil {
103106
return err
104107
}
105-
106-
factory := configmapandsecret.NewConfigMapFactory(cmArgs, nil, fSys)
107-
108108
// Validate by trying to create corev1.configmap.
109-
_, _, err = factory.MakeUnstructAndGenerateName()
109+
_, _, err = factory.MakeUnstructAndGenerateName(cmArgs)
110110
if err != nil {
111111
return err
112112
}
113-
114113
return nil
115114
}
116115

‎pkg/configmapandsecret/configmapfactory.go

Lines changed: 37 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,20 @@ import (
3838

3939
// ConfigMapFactory makes ConfigMaps.
4040
type ConfigMapFactory struct {
41-
args *types.ConfigMapArgs
4241
fSys fs.FileSystem
4342
ldr loader.Loader
4443
}
4544

4645
// NewConfigMapFactory returns a new ConfigMapFactory.
4746
func NewConfigMapFactory(
48-
args *types.ConfigMapArgs,
49-
l loader.Loader,
50-
fSys fs.FileSystem) *ConfigMapFactory {
51-
return &ConfigMapFactory{args: args, ldr: l, fSys: fSys}
47+
fSys fs.FileSystem, l loader.Loader) *ConfigMapFactory {
48+
return &ConfigMapFactory{fSys: fSys, ldr: l}
5249
}
5350

5451
// MakeUnstructAndGenerateName returns an configmap and the name appended with a hash.
55-
func (f *ConfigMapFactory) MakeUnstructAndGenerateName() (*unstructured.Unstructured, string, error) {
56-
cm, err := f.MakeConfigMap1()
52+
func (f *ConfigMapFactory) MakeUnstructAndGenerateName(
53+
args *types.ConfigMapArgs) (*unstructured.Unstructured, string, error) {
54+
cm, err := f.MakeConfigMap1(args)
5755
if err != nil {
5856
return nil, "", err
5957
}
@@ -76,31 +74,32 @@ func objectToUnstructured(in runtime.Object) (*unstructured.Unstructured, error)
7674
return &out, err
7775
}
7876

79-
func (f *ConfigMapFactory) makeFreshConfigMap() *corev1.ConfigMap {
77+
func (f *ConfigMapFactory) makeFreshConfigMap(
78+
args *types.ConfigMapArgs) *corev1.ConfigMap {
8079
cm := &corev1.ConfigMap{}
8180
cm.APIVersion = "v1"
8281
cm.Kind = "ConfigMap"
83-
cm.Name = f.args.Name
82+
cm.Name = args.Name
8483
cm.Data = map[string]string{}
8584
return cm
8685
}
8786

8887
// MakeConfigMap1 returns a new ConfigMap, or nil and an error.
89-
func (f *ConfigMapFactory) MakeConfigMap1() (*corev1.ConfigMap, error) {
90-
cm := f.makeFreshConfigMap()
91-
92-
if f.args.EnvSource != "" {
93-
if err := f.handleConfigMapFromEnvFileSource(cm); err != nil {
88+
func (f *ConfigMapFactory) MakeConfigMap1(
89+
args *types.ConfigMapArgs) (*corev1.ConfigMap, error) {
90+
cm := f.makeFreshConfigMap(args)
91+
if args.EnvSource != "" {
92+
if err := f.handleConfigMapFromEnvFileSource(cm, args); err != nil {
9493
return nil, err
9594
}
9695
}
97-
if f.args.FileSources != nil {
98-
if err := f.handleConfigMapFromFileSources(cm); err != nil {
96+
if args.FileSources != nil {
97+
if err := f.handleConfigMapFromFileSources(cm, args); err != nil {
9998
return nil, err
10099
}
101100
}
102-
if f.args.LiteralSources != nil {
103-
if err := f.handleConfigMapFromLiteralSources(cm); err != nil {
101+
if args.LiteralSources != nil {
102+
if err := f.handleConfigMapFromLiteralSources(cm, args); err != nil {
104103
return nil, err
105104
}
106105
}
@@ -109,35 +108,30 @@ func (f *ConfigMapFactory) MakeConfigMap1() (*corev1.ConfigMap, error) {
109108

110109
// MakeConfigMap2 returns a new ConfigMap, or nil and an error.
111110
// TODO: Get rid of the nearly duplicated code in MakeConfigMap1 vs MakeConfigMap2
112-
func (f *ConfigMapFactory) MakeConfigMap2() (*corev1.ConfigMap, error) {
111+
func (f *ConfigMapFactory) MakeConfigMap2(
112+
args *types.ConfigMapArgs) (*corev1.ConfigMap, error) {
113113
var envPairs, literalPairs, filePairs []kvPair
114114
var err error
115-
116-
cm := f.makeFreshConfigMap()
117-
118-
if f.args.EnvSource != "" {
119-
envPairs, err = keyValuesFromEnvFile(f.ldr, f.args.EnvSource)
115+
cm := f.makeFreshConfigMap(args)
116+
if args.EnvSource != "" {
117+
envPairs, err = keyValuesFromEnvFile(f.ldr, args.EnvSource)
120118
if err != nil {
121119
return nil, fmt.Errorf(
122120
"error reading keys from env source file: %s %v",
123-
f.args.EnvSource, err)
121+
args.EnvSource, err)
124122
}
125123
}
126-
127-
literalPairs, err = keyValuesFromLiteralSources(f.args.LiteralSources)
124+
literalPairs, err = keyValuesFromLiteralSources(args.LiteralSources)
128125
if err != nil {
129126
return nil, fmt.Errorf(
130127
"error reading key values from literal sources: %v", err)
131128
}
132-
133-
filePairs, err = keyValuesFromFileSources(f.ldr, f.args.FileSources)
129+
filePairs, err = keyValuesFromFileSources(f.ldr, args.FileSources)
134130
if err != nil {
135131
return nil, fmt.Errorf(
136132
"error reading key values from file sources: %v", err)
137133
}
138-
139134
allPairs := append(append(envPairs, literalPairs...), filePairs...)
140-
141135
// merge key value pairs from all the sources
142136
for _, kv := range allPairs {
143137
err = addKV(cm.Data, kv)
@@ -163,8 +157,8 @@ func keyValuesFromLiteralSources(sources []string) ([]kvPair, error) {
163157
// handleConfigMapFromLiteralSources adds the specified literal source
164158
// information into the provided configMap.
165159
func (f *ConfigMapFactory) handleConfigMapFromLiteralSources(
166-
configMap *v1.ConfigMap) error {
167-
for _, literalSource := range f.args.LiteralSources {
160+
configMap *v1.ConfigMap, args *types.ConfigMapArgs) error {
161+
for _, literalSource := range args.LiteralSources {
168162
keyName, value, err := ParseLiteralSource(literalSource)
169163
if err != nil {
170164
return err
@@ -195,8 +189,9 @@ func keyValuesFromFileSources(ldr loader.Loader, sources []string) ([]kvPair, er
195189

196190
// handleConfigMapFromFileSources adds the specified file source information
197191
// into the provided configMap
198-
func (f *ConfigMapFactory) handleConfigMapFromFileSources(configMap *v1.ConfigMap) error {
199-
for _, fileSource := range f.args.FileSources {
192+
func (f *ConfigMapFactory) handleConfigMapFromFileSources(
193+
configMap *v1.ConfigMap, args *types.ConfigMapArgs) error {
194+
for _, fileSource := range args.FileSources {
200195
keyName, filePath, err := ParseFileSource(fileSource)
201196
if err != nil {
202197
return err
@@ -241,14 +236,15 @@ func keyValuesFromEnvFile(l loader.Loader, path string) ([]kvPair, error) {
241236

242237
// HandleConfigMapFromEnvFileSource adds the specified env file source information
243238
// into the provided configMap
244-
func (f *ConfigMapFactory) handleConfigMapFromEnvFileSource(configMap *v1.ConfigMap) error {
245-
if !f.fSys.Exists(f.args.EnvSource) {
246-
return fmt.Errorf("unable to read configmap env file %s", f.args.EnvSource)
239+
func (f *ConfigMapFactory) handleConfigMapFromEnvFileSource(
240+
configMap *v1.ConfigMap, args *types.ConfigMapArgs) error {
241+
if !f.fSys.Exists(args.EnvSource) {
242+
return fmt.Errorf("unable to read configmap env file %s", args.EnvSource)
247243
}
248-
if f.fSys.IsDir(f.args.EnvSource) {
249-
return fmt.Errorf("env config file %s cannot be a directory", f.args.EnvSource)
244+
if f.fSys.IsDir(args.EnvSource) {
245+
return fmt.Errorf("env config file %s cannot be a directory", args.EnvSource)
250246
}
251-
return addFromEnvFile(f.args.EnvSource, func(key, value string) error {
247+
return addFromEnvFile(args.EnvSource, func(key, value string) error {
252248
return addKeyFromLiteralToConfigMap(configMap, key, value)
253249
})
254250
}

‎pkg/configmapandsecret/configmapfactory_test.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,11 +133,10 @@ func TestConstructConfigMap(t *testing.T) {
133133
},
134134
}
135135

136+
// TODO: all tests should use a FakeFs
137+
f := NewConfigMapFactory(fs.MakeRealFS(), nil)
136138
for _, tc := range testCases {
137-
// TODO: all tests should use a FakeFs
138-
fSys := fs.MakeRealFS()
139-
f := NewConfigMapFactory(&tc.input, nil, fSys)
140-
cm, err := f.MakeConfigMap1()
139+
cm, err := f.MakeConfigMap1(&tc.input)
141140
if err != nil {
142141
t.Fatalf("unexpected error: %v", err)
143142
}

‎pkg/configmapandsecret/secretfactory.go

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,40 @@ package configmapandsecret
22

33
import (
44
"context"
5+
"os/exec"
6+
"path/filepath"
7+
"time"
8+
59
"github.com/kubernetes-sigs/kustomize/pkg/fs"
610
"github.com/kubernetes-sigs/kustomize/pkg/types"
711
"github.com/pkg/errors"
812
corev1 "k8s.io/api/core/v1"
9-
"os/exec"
10-
"path/filepath"
11-
"time"
1213
)
1314

1415
// SecretFactory makes Secrets.
1516
type SecretFactory struct {
16-
args types.SecretArgs
1717
fSys fs.FileSystem
18+
wd string
1819
}
1920

2021
// NewSecretFactory returns a new SecretFactory.
21-
func NewSecretFactory(args types.SecretArgs, fSys fs.FileSystem) *SecretFactory {
22-
return &SecretFactory{args: args, fSys: fSys}
22+
func NewSecretFactory(fSys fs.FileSystem, wd string) *SecretFactory {
23+
return &SecretFactory{fSys: fSys, wd: wd}
2324
}
2425

2526
// MakeSecret returns a new secret.
26-
func (f *SecretFactory) MakeSecret(wd string) (*corev1.Secret, error) {
27+
func (f *SecretFactory) MakeSecret(args types.SecretArgs) (*corev1.Secret, error) {
2728
s := &corev1.Secret{}
2829
s.APIVersion = "v1"
2930
s.Kind = "Secret"
30-
s.Name = f.args.Name
31-
s.Type = corev1.SecretType(f.args.Type)
31+
s.Name = args.Name
32+
s.Type = corev1.SecretType(args.Type)
3233
if s.Type == "" {
3334
s.Type = corev1.SecretTypeOpaque
3435
}
3536
s.Data = map[string][]byte{}
36-
for k, v := range f.args.Commands {
37-
out, err := f.createSecretKey(wd, v)
37+
for k, v := range args.Commands {
38+
out, err := f.createSecretKey(v)
3839
if err != nil {
3940
return nil, errors.Wrap(err, "createSecretKey")
4041
}
@@ -44,16 +45,16 @@ func (f *SecretFactory) MakeSecret(wd string) (*corev1.Secret, error) {
4445
}
4546

4647
// Run a command, return its output as the secret.
47-
func (f *SecretFactory) createSecretKey(wd string, command string) ([]byte, error) {
48-
if !f.fSys.IsDir(wd) {
49-
wd = filepath.Dir(wd)
50-
if !f.fSys.IsDir(wd) {
51-
return nil, errors.New("not a directory: " + wd)
48+
func (f *SecretFactory) createSecretKey(command string) ([]byte, error) {
49+
if !f.fSys.IsDir(f.wd) {
50+
f.wd = filepath.Dir(f.wd)
51+
if !f.fSys.IsDir(f.wd) {
52+
return nil, errors.New("not a directory: " + f.wd)
5253
}
5354
}
5455
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
5556
defer cancel()
5657
cmd := exec.CommandContext(ctx, "sh", "-c", command)
57-
cmd.Dir = wd
58+
cmd.Dir = f.wd
5859
return cmd.Output()
5960
}

0 commit comments

Comments
 (0)