Feature/multi file include (#28)

* Enable multi file include (#28)

* Sort resulting files of each include object (#28)

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+* [#26](https://github.com/bitgrip/cattlectl/issues/26) bash completion
+* [#28](https://github.com/bitgrip/cattlectl/issues/28) multi file includes
+  * directory includes
+  * pattern includes
+
 ### Changed
 
 * [#15](https://github.com/bitgrip/cattlectl/issues/15) `--values` can be used multiple times.

docs/project_descriptor.md

@@ -36,9 +36,11 @@ ProjectDescriptor Structur:
 
 #### include
 
-| Field    | Description                                |
-|----------|--------------------------------------------|
-| __file__ | The file (relative of absolute) to include |
+| Field         | Description                                                           |
+|---------------|-----------------------------------------------------------------------|
+| __file__      | The file (relative of absolute) to include                            |
+| __files__     | The files pattern (relative of absolute) to include all matching files|
+| __directory__ | The directory (relative of absolute) to include all YAML files from   |
 
 #### namespaces
 

internal/pkg/rancher/project/model/model.go

@@ -70,7 +70,9 @@ type ProjectMetadata struct {
 
 // Include is used to merge multiple descriptors into one
 type Include struct {
-	File string `yaml:"file"`
+	File      string `yaml:"file,omitempty"`
+	Files     string `yaml:"files,omitempty"`
+	Directory string `yaml:"directory,omitempty"`
 }
 
 // Namespace is a subsection of a Project and is represented in K8S as namespace

internal/pkg/rancher/project/parser.go

@@ -17,7 +17,9 @@ package project
 import (
 	"fmt"
 	"io/ioutil"
+	"os"
 	"path/filepath"
+	"sort"
 
 	"github.com/bitgrip/cattlectl/internal/pkg/rancher/descriptor"
 	projectModel "github.com/bitgrip/cattlectl/internal/pkg/rancher/project/model"
@@ -80,33 +82,94 @@ func (parser fileParser) Parse(projectData []byte, target interface{}) error {
 		return err
 	}
 	for _, include := range targetProject.Metadata.Includes {
-		var childProjectFile string
-		if filepath.IsAbs(include.File) {
-			childProjectFile = include.File
-		} else {
-			childProjectFile = filepath.Clean(fmt.Sprintf("%s/%s", filepath.Dir(parser.projectFile), include.File))
-		}
-		childFileContent, err := ioutil.ReadFile(childProjectFile)
+		includeFiles, err := parser.readIncludeFiles(include)
 		if err != nil {
 			return err
 		}
-		childProjectData, err := template.BuildTemplate(childFileContent, parser.values, filepath.Dir(childProjectFile), parser.pretty)
-		if err != nil {
-			return err
+		sort.Strings(includeFiles)
+		for _, includeFile := range includeFiles {
+			if err := parser.include(targetProject, includeFile, allProjectFiles); err != nil {
+				return err
+			}
 		}
-		childTarget := projectModel.Project{}
-		childParser := newProjectParser(childProjectFile, parser.values, parser.pretty, allProjectFiles)
-		err = childParser.Parse(childProjectData, &childTarget)
+	}
+
+	return nil
+}
+
+func (parser fileParser) readIncludeFiles(include projectModel.Include) ([]string, error) {
+	if include.File != "" && include.Files != "" && include.Directory != "" {
+		return nil, fmt.Errorf("only one of file, files or directory can have a value")
+	}
+	if include.File != "" {
+		return []string{include.File}, nil
+	}
+	if include.Files != "" {
+		var absFiles string
+		if filepath.IsAbs(include.Files) {
+			absFiles = include.Files
+		} else {
+			var err error
+			absFiles, err = filepath.Abs(filepath.Clean(fmt.Sprintf("%s/%s", filepath.Dir(parser.projectFile), include.Files)))
+			if err != nil {
+				return nil, err
+			}
+		}
+		matches, err := filepath.Glob(absFiles)
 		if err != nil {
-			return err
+			return nil, err
+		}
+		return matches, nil
+	}
+	if include.Directory != "" {
+		var absDirectory string
+		if filepath.IsAbs(include.Directory) {
+			absDirectory = include.Directory
+		} else {
+			absDirectory = filepath.Clean(fmt.Sprintf("%s/%s", filepath.Dir(parser.projectFile), include.Directory))
 		}
-		err = MergeProject(childTarget, targetProject)
+		var files []string
+		err := filepath.Walk(absDirectory, func(path string, info os.FileInfo, err error) error {
+			if info.IsDir() {
+				return nil
+			}
+			if filepath.Ext(path) == ".yaml" || filepath.Ext(path) == ".yml" {
+				file, _ := filepath.Abs(path)
+				files = append(files, file)
+			}
+			return nil
+		})
 		if err != nil {
-			return err
+			return nil, err
 		}
+		return files, nil
 	}
+	return nil, fmt.Errorf("one of file, files or directory must have a value")
+}
 
-	return nil
+func (parser fileParser) include(targetProject *projectModel.Project, file string, allProjectFiles []string) error {
+	var childProjectFile string
+	if filepath.IsAbs(file) {
+		childProjectFile = file
+	} else {
+		childProjectFile = filepath.Clean(fmt.Sprintf("%s/%s", filepath.Dir(parser.projectFile), file))
+	}
+	childFileContent, err := ioutil.ReadFile(childProjectFile)
+	if err != nil {
+		return err
+	}
+	childProjectData, err := template.BuildTemplate(childFileContent, parser.values, filepath.Dir(childProjectFile), parser.pretty)
+	if err != nil {
+		return err
+	}
+	childTarget := projectModel.Project{}
+	childParser := newProjectParser(childProjectFile, parser.values, parser.pretty, allProjectFiles)
+	err = childParser.Parse(childProjectData, &childTarget)
+	if err != nil {
+		return err
+	}
+	err = MergeProject(childTarget, targetProject)
+	return err
 }
 
 func isDescriptor(data []byte, kind string, logger *logrus.Entry) (bool, error) {

internal/pkg/rancher/project/parser_test.go

@@ -96,6 +96,8 @@ func TestWithGoldenFile(t *testing.T) {
 	tests := []string{
 		"simple-include",
 		"cycle-include",
+		"files-include",
+		"directory-include",
 	}
 	for _, test := range tests {
 		runTestWithGoldenFile(t, test)

internal/pkg/rancher/project/testdata/directory-include/child-directory/child.1.yaml

@@ -0,0 +1,56 @@
+api_version: v1.0
+kind: Project
+metadata:
+  name: include-child1
+namespaces:
+- name: child1-namespace
+resources:
+  certificates:
+  - name: child1-cert
+    key: |
+      -----BEGIN PRIVATE KEY-----
+        ...
+        ...
+      -----END PRIVATE KEY-----
+    certs: |
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+    namespace: child1-namespace
+  config_maps:
+  - name: child1-config-map
+    data:
+      abc: def
+      bca: fed
+  docker_credentials:
+  - name: child1-registry
+    registries:
+    - name: child1.private.registry
+      password: child1-docker-registry-password
+      username: child1-docker-registry-user
+  secrets:
+  - name: child1-secret
+    data:
+      abc: def
+      bca: fed
+storage_classes:
+- name: child1-storage-classe
+  provisioner: kubernetes.io/no-provisioner
+  reclaim_policy: Delete
+  volume_bind_mode: WaitForFirstConsumer
+persistent_volumes:
+  - name: child1-persistent-volume
+    storage_class_name: child1-storage-classe
+apps:
+- name: child1-app
+  catalog: library
+  chart: wordpress
+  version: 2.1.10
+  namespace: parent-namespace
+  answers:
+    ingress.enabled: "false"

internal/pkg/rancher/project/testdata/directory-include/child-directory/child.2.yaml

@@ -0,0 +1,56 @@
+api_version: v1.0
+kind: Project
+metadata:
+  name: include-child2
+namespaces:
+- name: child2-namespace
+resources:
+  certificates:
+  - name: child2-cert
+    key: |
+      -----BEGIN PRIVATE KEY-----
+        ...
+        ...
+      -----END PRIVATE KEY-----
+    certs: |
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+    namespace: child2-namespace
+  config_maps:
+  - name: child2-config-map
+    data:
+      abc: def
+      bca: fed
+  docker_credentials:
+  - name: child2-registry
+    registries:
+    - name: child2.private.registry
+      password: child2-docker-registry-password
+      username: child2-docker-registry-user
+  secrets:
+  - name: child2-secret
+    data:
+      abc: def
+      bca: fed
+storage_classes:
+- name: child2-storage-classe
+  provisioner: kubernetes.io/no-provisioner
+  reclaim_policy: Delete
+  volume_bind_mode: WaitForFirstConsumer
+persistent_volumes:
+  - name: child2-persistent-volume
+    storage_class_name: child2-storage-classe
+apps:
+- name: child2-app
+  catalog: library
+  chart: wordpress
+  version: 2.1.10
+  namespace: parent-namespace
+  answers:
+    ingress.enabled: "false"

internal/pkg/rancher/project/testdata/directory-include/project.yaml

@@ -0,0 +1,57 @@
+api_version: v1.0
+kind: Project
+metadata:
+  name: include-parent
+  includes:
+  - directory: child-directory
+namespaces:
+- name: parent-namespace
+resources:
+  certificates:
+  - name: parent-cert
+    key: |
+      -----BEGIN PRIVATE KEY-----
+        ...
+        ...
+      -----END PRIVATE KEY-----
+    certs: |
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+  config_maps:
+  - name: parent-config-map
+    data:
+      abc: def
+      bca: fed
+  docker_credentials:
+  - name: parent-registry
+    registries:
+    - name: parent.private.registry
+      password: parent-docker-registry-password
+      username: parent-docker-registry-user
+  secrets:
+  - name: parent-secret
+    data:
+      abc: def
+      bca: fed
+storage_classes:
+- name: parent-storage-classe
+  provisioner: kubernetes.io/no-provisioner
+  reclaim_policy: Delete
+  volume_bind_mode: WaitForFirstConsumer
+persistent_volumes:
+  - name: parent-persistent-volume
+    storage_class_name: parent-storage-classe
+apps:
+- name: parent-app
+  catalog: library
+  chart: wordpress
+  version: 2.1.10
+  namespace: parent-namespace
+  answers:
+    ingress.enabled: "false"

internal/pkg/rancher/project/testdata/files-include/child.1.yaml

@@ -0,0 +1,56 @@
+api_version: v1.0
+kind: Project
+metadata:
+  name: include-child1
+namespaces:
+- name: child1-namespace
+resources:
+  certificates:
+  - name: child1-cert
+    key: |
+      -----BEGIN PRIVATE KEY-----
+        ...
+        ...
+      -----END PRIVATE KEY-----
+    certs: |
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+      -----BEGIN CERTIFICATE-----
+        ...
+        ...
+      -----END CERTIFICATE-----
+    namespace: child1-namespace
+  config_maps:
+  - name: child1-config-map
+    data:
+      abc: def
+      bca: fed
+  docker_credentials:
+  - name: child1-registry
+    registries:
+    - name: child1.private.registry
+      password: child1-docker-registry-password
+      username: child1-docker-registry-user
+  secrets:
+  - name: child1-secret
+    data:
+      abc: def
+      bca: fed
+storage_classes:
+- name: child1-storage-classe
+  provisioner: kubernetes.io/no-provisioner
+  reclaim_policy: Delete
+  volume_bind_mode: WaitForFirstConsumer
+persistent_volumes:
+  - name: child1-persistent-volume
+    storage_class_name: child1-storage-classe
+apps:
+- name: child1-app
+  catalog: library
+  chart: wordpress
+  version: 2.1.10
+  namespace: parent-namespace
+  answers:
+    ingress.enabled: "false"