feat context: Add ability to import extra variables from files

Kontemplate context specifications can now load extra variables from YAML
or JSON files by specifying a list of files (relative to the context file)
under the `import` key.
This commit is contained in:
Vincent Ambo 2017-06-22 17:01:36 +02:00
parent 68e1e48459
commit 9d26c17f13
6 changed files with 96 additions and 4 deletions

View file

@ -17,10 +17,11 @@ type ResourceSet struct {
}
type Context struct {
Name string `json:"context"`
Global map[string]interface{} `json:"global"`
ResourceSets []ResourceSet `json:"include"`
BaseDir string
Name string `json:"context"`
Global map[string]interface{} `json:"global"`
ResourceSets []ResourceSet `json:"include"`
VariableImports []string `json:"import"`
BaseDir string
}
type ContextLoadingError struct {
@ -44,9 +45,34 @@ func LoadContextFromFile(filename string) (*Context, error) {
c.BaseDir = path.Dir(filename)
c.ResourceSets = loadAllDefaultValues(&c)
err = c.loadImportedVariables()
if err != nil {
return nil, meep.New(
&ContextLoadingError{Filename: filename},
meep.Cause(err),
)
}
return &c, nil
}
// Kontemplate supports specifying additional variable files with the `import` keyword. This function loads those
// variable files and merges them together with the context's other global variables.
func (ctx *Context) loadImportedVariables() error {
for _, file := range ctx.VariableImports {
var importedVars map[string]interface{}
err := util.LoadJsonOrYaml(path.Join(ctx.BaseDir, file), &importedVars)
if err != nil {
return err
}
ctx.Global = *util.Merge(&ctx.Global, &importedVars)
}
return nil
}
// Flattens resource set collections, i.e. resource sets that themselves have an additional 'include' field set.
// Those will be regarded as a short-hand for including multiple resource sets from a subfolder.
// See https://github.com/tazjin/kontemplate/issues/9 for more information.

View file

@ -159,3 +159,47 @@ func TestDefaultValuesLoading(t *testing.T) {
t.Fail()
}
}
func TestImportValuesLoading(t *testing.T) {
ctx, err := LoadContextFromFile("testdata/import-vars-simple.yaml")
if err != nil {
t.Error(err)
t.Fail()
}
expected := map[string]interface{}{
"override": "true",
"music": map[string]interface{}{
"artist": "Pallida",
"track": "Tractor Beam",
},
}
if !reflect.DeepEqual(ctx.Global, expected) {
t.Error("Expected global values after loading imports did not match!")
t.Fail()
}
}
func TestImportValuesOverride(t *testing.T) {
ctx, err := LoadContextFromFile("testdata/import-vars-override.yaml")
if err != nil {
t.Error(err)
t.Fail()
}
expected := map[string]interface{}{
"override": float64(3),
"music": map[string]interface{}{
"artist": "Pallida",
"track": "Tractor Beam",
},
"place": "Oslo",
"globalVar": "very global!",
}
if !reflect.DeepEqual(ctx.Global, expected) {
t.Error("Expected global values after loading imports did not match!")
t.Fail()
}
}

View file

@ -0,0 +1,9 @@
---
context: k8s.prod.mydomain.com
global:
globalVar: very global!
override: 1
import:
- test-vars.yaml
- test-vars-override.yaml
include: []

View file

@ -0,0 +1,5 @@
---
context: k8s.prod.mydomain.com
import:
- test-vars.yaml
include: []

View file

@ -0,0 +1,3 @@
---
override: 3
place: Oslo

5
context/testdata/test-vars.yaml vendored Normal file
View file

@ -0,0 +1,5 @@
---
override: 'true'
music:
artist: Pallida
track: Tractor Beam