[Settings Tests] Migrate General Settings tests (#5753)

* added MSTest project * migrated general settings tests * enabled settings tests run in the build pipeline * added tests * move relay command class to separate file * added a foldername parameter for general settings view model
2026-04-07 11:46:30 +02:00 · 2020-08-13 15:02:05 -07:00
parent e4ea8d2abd
commit 24d7232559
14 changed files with 725 additions and 83 deletions
--- a/src/core/Microsoft.PowerToys.Settings.UI.UnitTests/ModelsTests/SettingsUtilsTests.cs
+++ b/src/core/Microsoft.PowerToys.Settings.UI.UnitTests/ModelsTests/SettingsUtilsTests.cs
@@ -0,0 +1,123 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.IO;
+using System.Linq;
+using System.Text.Json;
+using Microsoft.PowerToys.Settings.UI.Lib;
+using Microsoft.PowerToys.Settings.UnitTest;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace CommonLibTest
+{
+    [TestClass]
+    public class SettingsUtilsTests
+    {
+        public SettingsUtilsTests()
+        {
+            string file_name = "\\test";
+            if (SettingsUtils.SettingsFolderExists(file_name))
+            {
+                DeleteFolder(file_name);
+            }
+        }
+
+        [TestCleanup]
+        public void Cleanup()
+        {
+            string file_name = "\\test";
+            if (SettingsUtils.SettingsFolderExists(file_name))
+            {
+                DeleteFolder(file_name);
+            }
+        }
+
+        [TestMethod]
+        public void SaveSettings_SaveSettingsToFile_WhenFilePathExists()
+        {
+            // Arrange
+            string file_name = "\\test";
+            string file_contents_correct_json_content = "{\"name\":\"powertoy module name\",\"version\":\"powertoy version\"}";
+
+            BasePTSettingsTest expected_json = JsonSerializer.Deserialize<BasePTSettingsTest>(file_contents_correct_json_content);
+
+            // Act
+            SettingsUtils.SaveSettings(file_contents_correct_json_content, file_name);
+            BasePTSettingsTest actual_json = SettingsUtils.GetSettings<BasePTSettingsTest>(file_name);
+
+            // Assert
+            Assert.IsTrue(actual_json.Equals(actual_json));
+        }
+
+        [TestMethod]
+        public void SaveSettings_ShouldCreateFile_WhenFilePathIsNotFound()
+        {
+            // Arrange
+            string file_name = "test\\Test Folder";
+            string file_contents_correct_json_content = "{\"name\":\"powertoy module name\",\"version\":\"powertoy version\"}";
+
+            BasePTSettingsTest expected_json = JsonSerializer.Deserialize<BasePTSettingsTest>(file_contents_correct_json_content);
+
+            // Act
+            if (SettingsUtils.SettingsFolderExists(file_name))
+            {
+                DeleteFolder(file_name);
+            }
+
+            SettingsUtils.SaveSettings(file_contents_correct_json_content, file_name);
+            BasePTSettingsTest actual_json = SettingsUtils.GetSettings<BasePTSettingsTest>(file_name);
+
+            // Assert
+            Assert.IsTrue(actual_json.Equals(actual_json));
+        }
+
+        [TestMethod]
+        public void SettingsFolderExists_ShouldReturnFalse_WhenFilePathIsNotFound()
+        {
+            // Arrange
+            string file_name_random = "test\\" + RandomString();
+            string file_name_exists = "test\\exists";
+            string file_contents_correct_json_content = "{\"name\":\"powertoy module name\",\"version\":\"powertoy version\"}";
+
+            // Act
+            bool pathNotFound = SettingsUtils.SettingsFolderExists(file_name_random);
+
+            SettingsUtils.SaveSettings(file_contents_correct_json_content, file_name_exists);
+            bool pathFound = SettingsUtils.SettingsFolderExists(file_name_exists);
+
+            // Assert
+            Assert.IsFalse(pathNotFound);
+            Assert.IsTrue(pathFound);
+        }
+
+        [TestMethod]
+        public void CreateSettingsFolder_ShouldCreateFolder_WhenSuccessful()
+        {
+            // Arrange
+            string file_name = "test\\" + RandomString();
+
+            // Act
+            SettingsUtils.CreateSettingsFolder(file_name);
+
+            // Assert
+            Assert.IsTrue(SettingsUtils.SettingsFolderExists(file_name));
+        }
+
+        public void DeleteFolder(string powertoy)
+        {
+            Directory.Delete(Path.Combine(SettingsUtils.LocalApplicationDataFolder(), $"Microsoft\\PowerToys\\{powertoy}"), true);
+        }
+
+        public static string RandomString()
+        {
+            Random random = new Random();
+            int length = 20;
+            const string chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
+
+            return new string(Enumerable.Repeat(chars, length)
+              .Select(s => s[random.Next(s.Length)]).ToArray());
+        }
+    }
+}