TestNotifyConfigUpdateWithAgentYaml updates

to verify the behavior of Landscape client config tags: - tags=wsl by default - preserve user provided tags otherwise And use goldens to ease coping with serialization mismatches.
canonical · Jun 26, 2024 · 1ba7b03 · 1ba7b03
1 parent 63c4324
commit 1ba7b03
Show file tree

Hide file tree

Showing 13 changed files with 94 additions and 12 deletions.
diff --git a/windows-agent/internal/proservices/landscape/landscape_test.go b/windows-agent/internal/proservices/landscape/landscape_test.go
@@ -919,13 +919,12 @@ func TestNotifyConfigUpdateWithAgentYaml(t *testing.T) {
 
 	testcases := map[string]struct {
 		conf string
-
-		want               string
-		wantNotInAgentYaml []string
 	}{
 
-		"Task and agent.yaml don't contain [host] section":    {conf: "[host]\nurl=localhost\n[client]\ncomputer_title=another\n", want: "[client]\ncomputer_title=another\n", wantNotInAgentYaml: []string{"host:", "url:"}},
-		"Task and agent.yaml only contains [client] section)": {conf: "[irrelevant]\nnothing=important\n[host]\nurl=localhost\n[client]\ncomputer_title=another\n", want: "[client]\ncomputer_title=another\n", wantNotInAgentYaml: []string{"irrelevant:", "nothing:", "host:", "url:"}},
+		"Task and agent.yaml don't contain [host] section":    {conf: "[host]\nurl=localhost\n[client]\ncomputer_title=another\n"},
+		"Task and agent.yaml only contains [client] section)": {conf: "[irrelevant]\nnothing=important\n[host]\nurl=localhost\n[client]\ncomputer_title=another\n"},
+		"Task and agent.yaml with default tags":               {conf: "[host]\nurl=localhost\n[client]\ncomputer_title=another\n"},
+		"Task and agent.yaml with supplied tags":              {conf: "[host]\nurl=localhost\n[client]\ntags=another\n"},
 	}
 
 	for name, tc := range testcases {
@@ -969,17 +968,20 @@ func TestNotifyConfigUpdateWithAgentYaml(t *testing.T) {
 
 			b, err := os.ReadFile(tasksFiles[0])
 			require.NoError(t, err, "NotifyConfigUpdate: should have caused creation of a tasks file")
-			task := strings.TrimSpace(strings.ReplaceAll(string(b), " ", ""))
+			task := string(b)
 			require.NotEmpty(t, task, "NotifyConfigUpdate: tasks file should not be empty")
 
+			require.Contains(t, task, tasks.LandscapeConfigure{}.String(), "NotifyConfigUpdate: tasks file should contain a LandscapeConfigure task")
+
+			basepath := testutils.TestFixturePath(t)
+
+			wantTask := testutils.LoadWithUpdateFromGolden(t, task, testutils.WithGoldenPath(filepath.Join(basepath, "golden.tasks")))
+			require.Equal(t, wantTask, task, "NotifyConfigUpdate: tasks file should contain the expected Landscape client config")
+
 			agentYaml, err := os.ReadFile(filepath.Join(homedir, ".cloud-init", "agent.yaml"))
 			require.NoError(t, err, "NotifyConfigUpdate: could not read agent.yaml")
-			for _, wantNot := range tc.wantNotInAgentYaml {
-				require.NotContains(t, agentYaml, wantNot, "NotifyConfigUpdate: agent.yaml should be empty")
-			}
-
-			require.Contains(t, task, tasks.LandscapeConfigure{}.String(), "NotifyConfigUpdate: tasks file should contain a LandscapeConfigure task")
-			require.Contains(t, task, tc.want, "NotifyConfigUpdate: tasks file should contain the expected Landscape client config")
+			wantAgentYaml := testutils.LoadWithUpdateFromGolden(t, string(agentYaml), testutils.WithGoldenPath(filepath.Join(basepath, "agent.yaml")))
+			require.Equal(t, wantAgentYaml, string(agentYaml), "NotifyConfigUpdate: tasks file and agent.yaml don't match")
 		})
 	}
 }

diff --git a/...tNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_default_tags/agent.yaml b/...tNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_default_tags/agent.yaml
@@ -0,0 +1,7 @@
+# cloud-init
+# This file was generated automatically and must not be edited
+landscape:
+    client:
+        computer_title: another
+        hostagent_uid: landscapeUID
+        tags: wsl
diff --git a/...otifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_default_tags/golden.tasks b/...otifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_default_tags/golden.tasks
@@ -0,0 +1,7 @@
+- task:
+    config: |
+        [client]
+        computer_title = another
+        tags           = wsl
+        hostagent_uid  = landscapeUID
+  type: tasks.LandscapeConfigure
diff --git a/...NotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_supplied_tags/agent.yaml b/...NotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_supplied_tags/agent.yaml
@@ -0,0 +1,6 @@
+# cloud-init
+# This file was generated automatically and must not be edited
+landscape:
+    client:
+        hostagent_uid: landscapeUID
+        tags: another
diff --git a/...tifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_supplied_tags/golden.tasks b/...tifyConfigUpdateWithAgentYaml/task_and_agent.yaml_both_contain_supplied_tags/golden.tasks
@@ -0,0 +1,6 @@
+- task:
+    config: |
+        [client]
+        tags          = another
+        hostagent_uid = landscapeUID
+  type: tasks.LandscapeConfigure
diff --git a/...tifyConfigUpdateWithAgentYaml/task_and_agent.yaml_don't_contain_[host]_section/agent.yaml b/...tifyConfigUpdateWithAgentYaml/task_and_agent.yaml_don't_contain_[host]_section/agent.yaml
@@ -0,0 +1,7 @@
+# cloud-init
+# This file was generated automatically and must not be edited
+landscape:
+    client:
+        computer_title: another
+        hostagent_uid: landscapeUID
+        tags: wsl
diff --git a/...fyConfigUpdateWithAgentYaml/task_and_agent.yaml_don't_contain_[host]_section/golden.tasks b/...fyConfigUpdateWithAgentYaml/task_and_agent.yaml_don't_contain_[host]_section/golden.tasks
@@ -0,0 +1,7 @@
+- task:
+    config: |
+        [client]
+        computer_title = another
+        tags           = wsl
+        hostagent_uid  = landscapeUID
+  type: tasks.LandscapeConfigure
diff --git a/...yConfigUpdateWithAgentYaml/task_and_agent.yaml_only_contains_[client]_section)/agent.yaml b/...yConfigUpdateWithAgentYaml/task_and_agent.yaml_only_contains_[client]_section)/agent.yaml
@@ -0,0 +1,7 @@
+# cloud-init
+# This file was generated automatically and must not be edited
+landscape:
+    client:
+        computer_title: another
+        hostagent_uid: landscapeUID
+        tags: wsl
diff --git a/...onfigUpdateWithAgentYaml/task_and_agent.yaml_only_contains_[client]_section)/golden.tasks b/...onfigUpdateWithAgentYaml/task_and_agent.yaml_only_contains_[client]_section)/golden.tasks
@@ -0,0 +1,7 @@
+- task:
+    config: |
+        [client]
+        computer_title = another
+        tags           = wsl
+        hostagent_uid  = landscapeUID
+  type: tasks.LandscapeConfigure
diff --git a/...data/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_default_tags/agent.yaml b/...data/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_default_tags/agent.yaml
@@ -0,0 +1,7 @@
+# cloud-init
+# This file was generated automatically and must not be edited
+landscape:
+    client:
+        computer_title: another
+        hostagent_uid: landscapeUID
+        tags: wsl
diff --git a/...ta/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_default_tags/golden.tasks b/...ta/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_default_tags/golden.tasks
@@ -0,0 +1,7 @@
+- task:
+    config: |
+        [client]
+        computer_title = another
+        tags           = wsl
+        hostagent_uid  = landscapeUID
+  type: tasks.LandscapeConfigure
diff --git a/...ata/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_supplied_tags/agent.yaml b/...ata/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_supplied_tags/agent.yaml
@@ -0,0 +1,6 @@
+# cloud-init
+# This file was generated automatically and must not be edited
+landscape:
+    client:
+        hostagent_uid: landscapeUID
+        tags: another
diff --git a/...a/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_supplied_tags/golden.tasks b/...a/TestNotifyConfigUpdateWithAgentYaml/task_and_agent.yaml_with_supplied_tags/golden.tasks
@@ -0,0 +1,6 @@
+- task:
+    config: |
+        [client]
+        tags          = another
+        hostagent_uid = landscapeUID
+  type: tasks.LandscapeConfigure