Add --clobber command to windows script (#211)

* SUMO-272481 add clobber flag to script

* SUMO-272481 use correct flag

* SUMO-272481 remove unused variable

* SUMO-272481 change clobber to boolean

* SUMO-272481 add tests for unix script

* SUMO-272481 add windows install script

* SUMO-272481 fix bug during build

* SUMO-272481 add windows test for clobber

* SUMO-272481 fix bugs

* SUMO-272481 trigger new workflow

* SUMO-272481 change to bool

* SUMO-272481 fix test

* SUMO-272481 change assertion to string

* SUMO-272481 update installOptions of windows

* SUMO-272481 add new tests

* SUMO-272481 fix lowercase typo

* SUMO-272481 pass flag to powershell script in test

* SUMO-272481 make common function windows specific

* SUMO-272481 change function name

Author: shubham-sumo

install-script/install.ps1

@@ -30,6 +30,8 @@ param (
     # The Timezone option is used to specify the timezone of the collector.
     [string] $Timezone,
 
+    [bool] $Clobber,
+
     # The API URL used to communicate with the SumoLogic backend
     [string] $Api,
 
@@ -461,6 +463,9 @@ try {
     if ($Timezone.Length -gt 0) {
         $msiProperties += "TIMEZONE=`"${Timezone}`""
     }
+    if ($Clobber -eq $true) {
+        $msiAddLocal += "CLOBBER"
+    }
     if ($msiAddLocal.Count -gt 0) {
         $addLocalStr = $msiAddLocal -Join ","
         $msiProperties += "ADDLOCAL=${addLocalStr}"

install-script/test/check_windows.go

@@ -89,6 +89,20 @@ func checkEphemeralInConfig(p string) func(c check) bool {
 	}
 }
 
+func checkClobberInSumoConfig(p string) func(c check) bool {
+	return func(c check) bool {
+		assert.True(c.test, c.installOptions.clobber, "clobber was not specified")
+
+		conf, err := getConfig(p)
+		if !assert.NoError(c.test, err, "error while reading configuration") {
+			return false
+		}
+
+		assert.True(c.test, conf.Extensions.Sumologic.Clobber, "clobber is not true")
+		return true
+	}
+}
+
 func checkTokenInConfig(c check) bool {
 	if !assert.NotEmpty(c.test, c.installOptions.installToken, "installation token has not been provided") {
 		return false

install-script/test/command_windows.go

@@ -45,6 +45,10 @@ func (io *installOptions) string() []string {
 		opts = append(opts, "-Ephemeral", "1")
 	}
 
+	if io.clobber {
+		opts = append(opts, "-Clobber", "1")
+	}
+
 	if len(io.tags) > 0 {
 		opts = append(opts, "-Tags", getTagOptValue(io.tags))
 	}

install-script/test/install_windows_test.go

@@ -145,6 +145,44 @@ func TestInstallScript(t *testing.T) {
 				checkTags,
 			},
 		},
+		{
+			name: "installation token and clobber",
+			options: installOptions{
+				installToken: installToken,
+				clobber:      true,
+			},
+			preChecks: []checkFunc{checkBinaryNotCreated, checkConfigNotCreated, checkUserConfigNotCreated},
+			postChecks: []checkFunc{
+				checkBinaryCreated,
+				checkBinaryIsRunning,
+				checkConfigCreated,
+				checkConfigFilesOwnershipAndPermissions(localSystemSID),
+				checkUserConfigCreated,
+				checkTokenInConfig,
+				checkEphemeralNotInConfig(userConfigPath),
+				checkHostmetricsConfigNotCreated,
+				checkClobberInSumoConfig(userConfigPath),
+			},
+		},
+		{
+			name: "installation token, remotely-managed, and clobber",
+			options: installOptions{
+				installToken:    installToken,
+				remotelyManaged: true,
+				clobber:         true,
+			},
+			preChecks: []checkFunc{checkBinaryNotCreated, checkConfigNotCreated, checkUserConfigNotCreated},
+			postChecks: []checkFunc{
+				checkBinaryCreated,
+				checkBinaryIsRunning,
+				checkConfigCreated,
+				checkConfigFilesOwnershipAndPermissions(localSystemSID),
+				checkRemoteConfigDirectoryCreated,
+				checkTokenInSumoConfig,
+				checkEphemeralNotInConfig(configPath),
+				checkClobberInSumoConfig(configPath),
+			},
+		},
 	} {
 		t.Run(spec.name, func(t *testing.T) {
 			if err := runTest(t, &spec); err != nil {

msi/SumoLogic.wixext/SumoLogic.wixext/Config.cs

@@ -14,6 +14,7 @@ public class Config
         public string Api { get; set; }
         public string OpAmpApi { get; set; }
         public string Timezone { get; set; }
+        public bool Clobber { get; set; }
 
         public Config() {
             this.CollectorFields = new Dictionary<string, string>();

msi/SumoLogic.wixext/SumoLogic.wixext/ConfigUpdater.cs

@@ -101,6 +101,12 @@ public void Update(Config config)
                 sumologic.Children["time_zone"] = config.Timezone;
             }
 
+            if (config.Clobber)
+            {
+                EnsureScalarKey(sumologic, "clobber");
+                sumologic.Children["clobber"] = "true";
+            }
+
 
             // Make sure the sumologic processor node is a map node, otherwise an empty string
             // is generated as the value instead of an empty node.

msi/SumoLogic.wixext/SumoLogic.wixext/CustomAction.cs

@@ -25,6 +25,7 @@ public class CustomActions
         private const string pOpAmpFolder = "OpAmpFolder";
         private const string pOpAmpApi = "OpAmpApi";
         private const string pTimezone = "Timezone";
+        private const string pClobber = "Clobber";
         private const string pConfigFragmentsFolder = "ConfigFragmentsFolder";
 
         // WiX features
@@ -72,6 +73,7 @@ public static ActionResult UpdateConfig(Session session)
             var opAmpFolder = session.CustomActionData[pOpAmpFolder];
             var opAmpApi = session.CustomActionData[pOpAmpApi];
             var timezone = session.CustomActionData[pTimezone];
+            var clobber = (session.CustomActionData.ContainsKey(pClobber) && session.CustomActionData[pClobber] == "true");
             var api = session.CustomActionData[pApi];
 
             if (remotelyManaged && string.IsNullOrEmpty(opAmpFolder))
@@ -82,7 +84,7 @@ public static ActionResult UpdateConfig(Session session)
 
             // Load config from disk and replace values
             Config config = new Config { InstallationToken = installationToken, RemotelyManaged = remotelyManaged, Ephemeral = ephemeral,
-                OpAmpFolder = opAmpFolder, OpAmpApi = opAmpApi, Api = api, Timezone = timezone };
+                OpAmpFolder = opAmpFolder, OpAmpApi = opAmpApi, Api = api, Timezone = timezone, Clobber = clobber };
             config.SetCollectorFieldsFromTags(tags);
 
             var configFile = remotelyManaged ? sumoLogicConfigPath : commonConfigPath;

msi/SumoLogic.wixext/SumoLogicTests/ConfigUpdaterTests.cs

@@ -187,6 +187,34 @@ public void TimezoneAssertions(Config config, StreamReader sr)
             Assert.AreEqual(config.Timezone, endpoint.ToString());
         }
 
+        public void ClobberAssertions(Config config, StreamReader sr)
+        {
+            YamlStream ys = new YamlStream();
+            ys.Load(sr);
+            YamlMappingNode root = (YamlMappingNode)ys.Documents[0].RootNode;
+
+            Assert.IsTrue(root.Children.ContainsKey("extensions"));
+            Assert.AreEqual(YamlNodeType.Mapping, root.Children["extensions"].NodeType);
+            var extensions = (YamlMappingNode)root.Children["extensions"];
+
+            Assert.IsTrue(extensions.Children.ContainsKey("sumologic"));
+            Assert.AreEqual(YamlNodeType.Mapping, extensions.Children["sumologic"].NodeType);
+            var sumologic = (YamlMappingNode)extensions.Children["sumologic"];
+            var endpoint = (YamlScalarNode)sumologic.Children["clobber"];
+            if(config.Clobber){
+                Assert.IsTrue(sumologic.Children.ContainsKey("clobber"));
+                Assert.AreEqual(YamlNodeType.Scalar, sumologic.Children["clobber"].NodeType);
+                Assert.AreEqual("true", endpoint.ToString());
+            }
+            else{
+                if(sumologic.Children.ContainsKey("clobber")){
+                    Assert.AreEqual(YamlNodeType.Scalar, sumologic.Children["clobber"].NodeType);
+                    Assert.AreEqual("false", endpoint.ToString());
+                }
+            }
+        }
+
+
 
         [TestMethod]
         public void TestUpdate_WithExtensionsBlock()
@@ -476,6 +504,7 @@ public void TestUpdate_OpAmpApi()
         }
 
 
+
         [TestMethod]
         public void TestUpdate_Timezone()
         {
@@ -503,5 +532,32 @@ public void TestUpdate_Timezone()
             }
         }
 
+        [TestMethod]
+        public void TestUpdate_Clobber()
+        {
+            var filePath = Path.Combine(testDataPath, "with-extensions-block.yaml");
+            var config = new Config { InstallationToken = "foobar", Clobber = 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));
+
+                ms.Seek(0, SeekOrigin.Begin);
+
+                StreamReader sr = new StreamReader(ms);
+                while (!sr.EndOfStream)
+                {
+                    Console.WriteLine(sr.ReadLine());
+                }
+
+                ms.Seek(0, SeekOrigin.Begin);
+
+                ClobberAssertions(config, sr);
+            }
+        }
+
     }
 }

msi/wix/package.wxs

@@ -77,6 +77,7 @@
     <!-- Whether or not the remotely managed and ephemeral features are selected -->
     <Property Id="REMOTELYMANAGEDSELECTED" Value="false" Hidden="yes" />
     <Property Id="EPHEMERALSELECTED" Value="false" Hidden="yes" />
+    <Property Id="CLOBBERSELECTED" Value="false" Hidden="yes" />
 
     <!-- The API base URL if overriden -->
     <Property Id="API" Hidden="yes" />
@@ -105,12 +106,13 @@
     <CustomAction Id="UpdateConfigActionData1" Property="UpdateConfigAction1"
       Value="CommonConfigPath=[ConfigFragmentsFolder]common.yaml;SumoLogicConfigPath=[ConfigFolder]sumologic.yaml;InstallToken=[INSTALLTOKEN];InstallationToken=[INSTALLATIONTOKEN]" />
     <CustomAction Id="UpdateConfigActionData2" Property="UpdateConfigAction2"
-      Value="Tags=[TAGS];OpAmpFolder=[OpAmpFolder];OpAmpApi=[OPAMPAPI];Timezone=[TIMEZONE];Ephemeral=[EPHEMERALSELECTED];RemotelyManaged=[REMOTELYMANAGEDSELECTED];Api=[API]" />
+      Value="Tags=[TAGS];OpAmpFolder=[OpAmpFolder];OpAmpApi=[OPAMPAPI];Timezone=[TIMEZONE];Ephemeral=[EPHEMERALSELECTED];Clobber=[CLOBBERSELECTED];RemotelyManaged=[REMOTELYMANAGEDSELECTED];Api=[API]" />
     <CustomAction Id="UpdateConfigActionData" Property="UpdateConfigAction" Value="[UpdateConfigAction1];[UpdateConfigAction2]" />
 
     <!-- Before updating the config files set the properties indicating whether or not the remotely managed and ephemeral features are selected -->
     <SetProperty Id="REMOTELYMANAGEDSELECTED" Value="true" Sequence="execute" Before="UpdateConfigActionData"  Condition="&amp;REMOTELYMANAGED=3" />
     <SetProperty Id="EPHEMERALSELECTED" Value="true" Sequence="execute" Before="UpdateConfigActionData" Condition="&amp;EPHEMERAL=3" />
+    <SetProperty Id="CLOBBERSELECTED" Value="true" Sequence="execute" Before="UpdateConfigActionData" Condition="&amp;CLOBBER=3" />
 
     <!-- Execute Sequence -->
     <InstallExecuteSequence>
@@ -143,6 +145,10 @@
       <Feature Id="EPHEMERAL" Title="Ephemeral" Level="2" AllowAbsent="yes" AllowAdvertise="no" TypicalDefault="install" >
         <Component Id="EphemeralComponent" Location="local" Directory="INSTALLFOLDER" Guid="4095b4ee-d011-49c3-b7a7-755aa36fcc5e" />
       </Feature>
+
+      <Feature Id="CLOBBER" Title="Clobber" Level="2" AllowAbsent="yes" AllowAdvertise="no" TypicalDefault="install" >
+              <Component Id="ClobberComponent" Location="local" Directory="INSTALLFOLDER" Guid="6448c76f-83a7-4534-bcc9-e008da4c2bb7" />
+      </Feature>
     </Feature>
 
     <!-- UI -->