feat: load and parse account management resources

cmd/monaco/deploy/acc/deploy.go

@@ -0,0 +1,39 @@
+/*
+ * @license
+ * Copyright 2023 Dynatrace LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package acc
+
+import (
+	"github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/persistence/account"
+	"github.com/spf13/afero"
+)
+
+// deployAcc triggers the deployment of account management resources for a given monaco project
+func deployAcc(fs afero.Fs, projectName string) error { // nolint:unused
+	accResources, err := account.Load(fs, projectName)
+	if err != nil {
+		return err
+	}
+
+	err = account.Validate(accResources)
+	if err != nil {
+		return err
+	}
+
+	// (tbd) convert acc resources to internal representation to be deployable and pass to pkg/deploy/acc::Deploy()
+
+	return nil
+}

internal/files/files.go

@@ -18,6 +18,8 @@ package files
 
 import (
 	"os"
+	"path"
+	"path/filepath"
 	"strings"
 
 	"github.com/spf13/afero"
@@ -57,6 +59,40 @@ func IsYamlFileExtension(file string) bool {
 	return false
 }
 
+// FindYamlFiles finds all YAML files within the given root directory.
+// Hidden directories (start with a dot (.)) are excluded.
+// Directories marked as hidden on Windows are not excluded.
+// If root is not existent the function returns nil, nil
+func FindYamlFiles(fs afero.Fs, root string) ([]string, error) {
+	var configFiles []string
+
+	exists, err := afero.Exists(fs, root)
+	if err != nil {
+		return configFiles, err
+	}
+
+	if !exists {
+		return nil, nil
+	}
+
+	err = afero.Walk(fs, root, func(curPath string, info os.FileInfo, err error) error {
+		name := info.Name()
+
+		if info.IsDir() {
+			if strings.HasPrefix(name, ".") {
+				return filepath.SkipDir
+			}
+		}
+
+		if IsYamlFileExtension(name) {
+			configFiles = append(configFiles, path.Join(curPath))
+		}
+		return nil
+	})
+
+	return configFiles, err
+}
+
 func ReplacePathSeparators(path string) (newPath string) {
 	newPath = strings.ReplaceAll(path, "\\", string(os.PathSeparator))
 	newPath = strings.ReplaceAll(newPath, "/", string(os.PathSeparator))

pkg/persistence/account/errors.go

@@ -0,0 +1,23 @@
+/*
+ * @license
+ * Copyright 2023 Dynatrace LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package account
+
+import "errors"
+
+var ErrRefMissing = errors.New("no referenced target found")
+var ErrIdFieldMissing = errors.New("no ref id field found")
+var ErrIdFieldNoString = errors.New("ref id field is not a string")

pkg/persistence/account/load.go

@@ -0,0 +1,100 @@
+/*
+ * @license
+ * Copyright 2023 Dynatrace LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package account
+
+import (
+	"fmt"
+	"github.com/dynatrace/dynatrace-configuration-as-code/v2/internal/files"
+	"github.com/mitchellh/mapstructure"
+	"github.com/spf13/afero"
+	"gopkg.in/yaml.v2"
+	"io"
+)
+
+// Load loads account management resources from YAML configuration files
+// located within the specified root directory path. It parses the YAML files, extracts policies,
+// groups, and users data, and organizes them into a AMResources struct, which is then returned.
+func Load(fs afero.Fs, rootPath string) (*AMResources, error) {
+	resources := &AMResources{
+		Policies: make(map[string]Policy, 0),
+		Groups:   make(map[string]Group, 0),
+		Users:    make(map[string]User, 0),
+	}
+
+	yamlFilePaths, err := files.FindYamlFiles(fs, rootPath)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, yamlFilePath := range yamlFilePaths {
+		yamlFile, err := fs.Open(yamlFilePath)
+		if err != nil {
+			return nil, err
+		}
+		content, err := decode(yamlFile)
+		if err != nil {
+			return nil, err
+		}
+
+		var policies Policies
+		err = mapstructure.Decode(content, &policies)
+		if err != nil {
+			return nil, err
+		}
+		for _, pol := range policies.Policies {
+			if _, exists := resources.Policies[pol.ID]; exists {
+				return nil, fmt.Errorf("found duplicate policy with id %q", pol.ID)
+			}
+			resources.Policies[pol.ID] = pol
+		}
+
+		var groups Groups
+		err = mapstructure.Decode(content, &groups)
+		if err != nil {
+			return nil, err
+		}
+		for _, gr := range groups.Groups {
+			if _, exists := resources.Groups[gr.ID]; exists {
+				return nil, fmt.Errorf("found duplicate group with id %q", gr.ID)
+			}
+			resources.Groups[gr.ID] = gr
+		}
+
+		var users Users
+		err = mapstructure.Decode(content, &users)
+		if err != nil {
+			return nil, err
+		}
+		for _, us := range users.Users {
+			if _, exists := resources.Users[us.Email]; exists {
+				return nil, fmt.Errorf("found duplicate user with id %q", us.Email)
+			}
+			resources.Users[us.Email] = us
+		}
+	}
+
+	return resources, nil
+}
+
+func decode(in io.ReadCloser) (map[string]any, error) {
+	defer in.Close()
+	var content map[string]interface{}
+	if err := yaml.NewDecoder(in).Decode(&content); err != nil {
+		return content, err
+	}
+	return content, nil
+}

pkg/persistence/account/load_test.go

@@ -0,0 +1,67 @@
+/*
+ * @license
+ * Copyright 2023 Dynatrace LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package account
+
+import (
+	"github.com/spf13/afero"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestLoad(t *testing.T) {
+	t.Run("Load single file", func(t *testing.T) {
+		loaded, err := Load(afero.NewOsFs(), "test-resources/valid.yaml")
+		assert.NoError(t, err)
+		assert.Len(t, loaded.Users, 1)
+		assert.Len(t, loaded.Groups, 1)
+		assert.Len(t, loaded.Policies, 1)
+	})
+
+	t.Run("Load multiple files", func(t *testing.T) {
+		loaded, err := Load(afero.NewOsFs(), "test-resources/multi")
+		assert.NoError(t, err)
+		assert.Len(t, loaded.Users, 1)
+		assert.Len(t, loaded.Groups, 1)
+		assert.Len(t, loaded.Policies, 1)
+	})
+
+	t.Run("Duplicate group", func(t *testing.T) {
+		_, err := Load(afero.NewOsFs(), "test-resources/duplicate-group.yaml")
+		assert.Error(t, err)
+	})
+
+	t.Run("Duplicate user", func(t *testing.T) {
+		_, err := Load(afero.NewOsFs(), "test-resources/duplicate-user.yaml")
+		assert.Error(t, err)
+	})
+
+	t.Run("Duplicate policy", func(t *testing.T) {
+		_, err := Load(afero.NewOsFs(), "test-resources/duplicate-policy.yaml")
+		assert.Error(t, err)
+	})
+
+	t.Run("root folder not found", func(t *testing.T) {
+		result, err := Load(afero.NewOsFs(), "test-resources/non-existent-folder")
+		assert.Equal(t, &AMResources{
+			Policies: make(map[string]Policy, 0),
+			Groups:   make(map[string]Group, 0),
+			Users:    make(map[string]User, 0),
+		}, result)
+		assert.NoError(t, err)
+	})
+
+}

pkg/persistence/account/test-resources/duplicate-group.yaml

@@ -0,0 +1,65 @@
+users:
+  - email: [email protected]
+    groups:
+      - type: reference
+        id: my-group
+      - Log viewer
+
+
+groups:
+  - name: My Group
+    id: my-group
+    description: This is my group
+    account:
+      permissions:
+        - View my Group Stuff
+      policies:
+        - Request My Group Stuff
+
+    environment:
+      - name: myenv123
+        permissions:
+          - View environment
+        policies:
+          - View environment
+          - type: reference
+            id: my-policy
+
+    managementZone:
+      - environment: env12345
+        managementZone: Mzone
+        permissions:
+          - View environment
+  - name: My Group
+    id: my-group
+    description: This is my group
+    account:
+      permissions:
+        - View my Group Stuff
+      policies:
+        - Request My Group Stuff
+
+    environment:
+      - name: myenv123
+        permissions:
+          - View environment
+        policies:
+          - View environment
+          - type: reference
+            id: my-policy
+
+    managementZone:
+      - environment: env12345
+        managementZone: Mzone
+        permissions:
+          - View environment
+
+policies:
+  - name: My Policy
+    id: my-policy
+    level:
+      type: account
+    description: abcde
+    policy: |-
+      ALLOW a:b:c;
+

pkg/persistence/account/test-resources/duplicate-policy.yaml

@@ -0,0 +1,17 @@
+policies:
+  - name: My Policy
+    id: my-policy
+    level:
+      type: account
+    description: abcde
+    policy: |-
+      ALLOW a:b:c;
+  - name: My Policy
+    id: my-policy
+    level:
+      type: account
+    description: abcde
+    policy: |-
+      ALLOW a:b:c;
+
+

pkg/persistence/account/test-resources/duplicate-user.yaml

@@ -0,0 +1,11 @@
+users:
+  - email: [email protected]
+    groups:
+      - type: reference
+        id: my-group
+      - Log viewer
+  - email: [email protected]
+    groups:
+      - type: reference
+        id: my-group
+      - Log viewer

pkg/persistence/account/test-resources/multi/a/a.yaml

@@ -0,0 +1,6 @@
+users:
+  - email: [email protected]
+    groups:
+      - type: reference
+        id: my-group
+      - Log viewer