feat: add new options to windows install script and installer

* fix test error * add validation for empty opamp folder when remotely managed * more opamp tests
SumoLogic · Feb 8, 2024 · 1b1358a · 1b1358a
1 parent 285bef8
commit 1b1358a
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 9 deletions.
diff --git a/packaging/msi/SumoLogic.wixext/SumoLogic.wixext/ConfigUpdater.cs b/packaging/msi/SumoLogic.wixext/SumoLogic.wixext/ConfigUpdater.cs
@@ -28,6 +28,11 @@ public ConfigUpdater(StreamReader streamReader) {
 
         public void Update(Config config)
         {
+            if (config.RemotelyManaged && string.IsNullOrEmpty(config.OpAmpFolder))
+            {
+                throw new MissingConfigurationException("OpAmpFolder");
+            }
+
             YamlMappingNode root = (YamlMappingNode)this.Document.RootNode;
 
             EnsureMapKey(root, "extensions");

diff --git a/packaging/msi/SumoLogic.wixext/SumoLogic.wixext/CustomAction.cs b/packaging/msi/SumoLogic.wixext/SumoLogic.wixext/CustomAction.cs
@@ -70,6 +70,12 @@ public static ActionResult UpdateConfig(Session session)
             var opAmpFolder = session.CustomActionData[pOpAmpFolder];
             var api = session.CustomActionData[pApi];
 
+            if (remotelyManaged && string.IsNullOrEmpty(opAmpFolder))
+            {
+                ShowErrorMessage(session, ecMissingCustomActionData, pOpAmpFolder);
+                return ActionResult.Failure;
+            }
+
             // Load config from disk and replace values
             Config config = new Config { InstallationToken = installationToken, RemotelyManaged = remotelyManaged, Ephemeral = ephemeral,
                 OpAmpFolder = opAmpFolder, Api = api };

diff --git a/packaging/msi/SumoLogic.wixext/SumoLogic.wixext/Exceptions.cs b/packaging/msi/SumoLogic.wixext/SumoLogic.wixext/Exceptions.cs
@@ -34,4 +34,9 @@ public class TagValueLengthExceededException : Exception
     {
         public TagValueLengthExceededException(string message) { }
     }
+
+    public class MissingConfigurationException : Exception
+    {
+        public MissingConfigurationException(string message) { }
+    }
 }
diff --git a/packaging/msi/SumoLogic.wixext/SumoLogicTests/ConfigUpdaterTests.cs b/packaging/msi/SumoLogic.wixext/SumoLogicTests/ConfigUpdaterTests.cs
@@ -55,7 +55,7 @@ public void InstallationTokenAssertions(Config config, StreamReader sr)
             Assert.AreEqual("yaz", collectorFields.Children["xaz"]);
         }
 
-        public void OpAmpAssertion(Config config, StreamReader sr)
+        public void OpAmpAssertions(Config config, StreamReader sr)
         {
             YamlStream ys = new YamlStream();
             ys.Load(sr);
@@ -65,13 +65,20 @@ public void OpAmpAssertion(Config config, StreamReader sr)
             Assert.AreEqual(YamlNodeType.Mapping, root.Children["extensions"].NodeType);
             var extensions = (YamlMappingNode)root.Children["extensions"];
 
-            Assert.IsTrue(extensions.Children.ContainsKey("opamp"));
-            Assert.AreEqual(YamlNodeType.Mapping, extensions.Children["opamp"].NodeType);
-            var opamp = (YamlMappingNode)extensions.Children["opamp"];
+            if (config.RemotelyManaged)
+            {
+                Assert.IsTrue(extensions.Children.ContainsKey("opamp"));
+                Assert.AreEqual(YamlNodeType.Mapping, extensions.Children["opamp"].NodeType);
+                var opamp = (YamlMappingNode)extensions.Children["opamp"];
 
-            Assert.IsTrue(opamp.Children.ContainsKey("remote_configuration_directory"));
-            Assert.AreEqual(YamlNodeType.Scalar, opamp.Children["remote_configuration_directory"].NodeType);
-            Assert.AreEqual(config.OpAmpFolder, opamp.Children["remote_configuration_directory"].ToString());
+                Assert.IsTrue(opamp.Children.ContainsKey("remote_configuration_directory"));
+                Assert.AreEqual(YamlNodeType.Scalar, opamp.Children["remote_configuration_directory"].NodeType);
+                Assert.AreEqual(config.OpAmpFolder, opamp.Children["remote_configuration_directory"].ToString());
+            }
+            else
+            {
+                Assert.IsFalse(extensions.Children.ContainsKey("opamp"));
+            }
 
             Assert.IsTrue(root.Children.ContainsKey("service"));
             Assert.AreEqual(YamlNodeType.Mapping, root.Children["service"].NodeType);
@@ -80,7 +87,14 @@ public void OpAmpAssertion(Config config, StreamReader sr)
             Assert.IsTrue(service.Children.ContainsKey("extensions"));
             Assert.AreEqual(YamlNodeType.Sequence, service.Children["extensions"].NodeType);
             var serviceExtensions = (YamlSequenceNode)service.Children["extensions"];
-            Assert.IsTrue(serviceExtensions.Contains("opamp"));
+            if (config.RemotelyManaged)
+            {
+                Assert.IsTrue(serviceExtensions.Children.Contains("opamp"));
+            }
+            else
+            {
+                Assert.IsFalse(serviceExtensions.Children.Contains("opamp"));
+            }
         }
 
         [TestMethod]
@@ -215,8 +229,52 @@ public void TestUpdate_OpAmp()
 
                 ms.Seek(0, SeekOrigin.Begin);
 
-                OpAmpAssertion(config, sr);
+                OpAmpAssertions(config, sr);
+            }
+        }
+
+        [TestMethod]
+        [ExpectedException(typeof(MissingConfigurationException), "OpAmpFolder")]
+        public void TestUpdate_OpAmpNoFolder()
+        {
+            var filePath = Path.Combine(testDataPath, "with-extensions-block.yaml");
+            var config = new Config { InstallationToken = "foobar", Ephemeral = true, RemotelyManaged = true };
+            config.SetCollectorFieldsFromTags(@"foo=bar,baz=kaz,xaz=yaz");
+
+            using (MemoryStream ms = new MemoryStream())
+            {
+                var configUpdater = new ConfigUpdater(new StreamReader(filePath));
+                configUpdater.Update(config);
+                configUpdater.Save(new StreamWriter(ms));
+            }
+        }
+
+        [TestMethod]
+        public void TestUpdate_NoOpAmpWithFolder()
+        {
+            var filePath = Path.Combine(testDataPath, "with-extensions-block.yaml");
+            var config = new Config { InstallationToken = "foobar", Ephemeral = true, RemotelyManaged = false, OpAmpFolder = "/opamp" };
+            config.SetCollectorFieldsFromTags(@"foo=bar,baz=kaz,xaz=yaz");
+
+            using (MemoryStream ms = new MemoryStream())
+            {
+                var configUpdater = new ConfigUpdater(new StreamReader(filePath));
+                configUpdater.Update(config);
+                configUpdater.Save(new StreamWriter(ms));
+
+                ms.Seek(0, SeekOrigin.Begin);
+
+                StreamReader sr = new StreamReader(ms);
+                while (!sr.EndOfStream)
+                {
+                    Console.WriteLine(sr.ReadLine());
+                }
+
+                ms.Seek(0, SeekOrigin.Begin);
+
+                OpAmpAssertions(config, sr);
             }
         }
+
     }
 }