DYN-5319 (#13441)

LongNguyenP · saintentropy · web-flow · commit 89db1f72bcde · 2022-11-09T23:11:19.000+07:00
* ADDED: Dynamo Preference Settings API to add, query, and remove Dynamo Player entry-point folders

* Made the dict public and removed related methods

* Reverted assembly version change

* Added ///summary for DynamoPlayerFolderItem class

* Move away from using Dictionary

* missing public

* Update test

* Fixed TestImportCopySettings failure

* Updated TestSettingsSerialization to include testing for the new DynamoPlayerFolderGroups

* Added some initial data for the test DynamoPlayerFolder object

* PR comments

* Remove all constructors as they are not really neccesary

Co-authored-by: Long Nguyen &lt;long.nguyen@autodesk.com&gt;
Co-authored-by: Craig Long &lt;craig.long@autodesk.com&gt;
diff --git a/src/DynamoCore/Configuration/DynamoPlayerFolder.cs b/src/DynamoCore/Configuration/DynamoPlayerFolder.cs
@@ -0,0 +1,51 @@
+using System.Collections.Generic;
+
+namespace Dynamo.Configuration
+{
+    /// <summary>
+    /// This class describes a folder (usually containing Dynamo graphs) added to the Dynamo Player or Generative Design
+    /// </summary>
+    public class DynamoPlayerFolder
+    {
+        /// <summary>
+        /// The full path of the folder
+        /// </summary>
+        public string Path { get; set; }
+
+        /// <summary>
+        /// The display name of the folder
+        /// </summary>
+        public string DisplayName { get; set; }
+
+        /// <summary>
+        /// The ID of the folder
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        /// Whether this folder is removable from the settings (Built-in folders are non-removable)
+        /// </summary>
+        public bool IsRemovable { get; set; } = true;
+
+        /// <summary>
+        /// The order of the folder
+        /// </summary>
+        public int Order { get; set; } = -1;
+    }
+
+    /// <summary>
+    /// This Class defines a group of folders assciated with a Dynamo Player or Generative Design entry point.
+    /// </summary>
+    public class DynamoPlayerFolderGroup
+    {
+        /// <summary>
+        /// The name of the Player entry point
+        /// </summary>
+        public string EntryPoint { get; set; }
+
+        /// <summary>
+        /// The List of Folder Items for this group
+        /// </summary>
+        public List<DynamoPlayerFolder> Folders { get; set; } = new List<DynamoPlayerFolder>();
+    }
+}
diff --git a/src/DynamoCore/Configuration/PreferenceSettings.cs b/src/DynamoCore/Configuration/PreferenceSettings.cs
@@ -18,7 +18,7 @@ namespace Dynamo.Configuration
     static class ExtensionMethods
     {
         /// <summary>
-        /// Copy Properties from a PreferenceSettings instance to another iterating the Properties of the destination instance and populate them from their source counterparts, excluding the properties that are obsolete and only read.  
+        /// Copy Properties from a PreferenceSettings instance to another iterating the Properties of the destination instance and populate them from their source counterparts, excluding the properties that are obsolete and only read.
         /// </summary>
         /// <param name="source"></param>
         /// <param name="destination"></param>
@@ -84,7 +84,7 @@ public class PreferenceSettings : NotificationObject, IPreferences, IRenderPreci
         /// <summary>
         /// Default time
         /// </summary>
-        public static readonly System.DateTime DynamoDefaultTime = new System.DateTime(1977, 4, 12, 12, 12, 0, 0);        
+        public static readonly System.DateTime DynamoDefaultTime = new System.DateTime(1977, 4, 12, 12, 12, 0, 0);
 
         #endregion
 
@@ -162,7 +162,7 @@ public bool IsADPAnalyticsReportingApproved
         public List<BackgroundPreviewActiveState> BackgroundPreviews { get; set; }
 
         /// <summary>
-        /// Returns active state of specified background preview 
+        /// Returns active state of specified background preview
         /// </summary>
         /// <param name="name">Background preview name</param>
         /// <returns>The active state</returns>
@@ -174,7 +174,7 @@ public bool GetIsBackgroundPreviewActive(string name)
         }
 
         /// <summary>
-        /// Sets active state of specified background preview 
+        /// Sets active state of specified background preview
         /// </summary>
         /// <param name="name">Background preview name</param>
         /// <param name="value">Active state</param>
@@ -373,7 +373,7 @@ private bool DeserializeDisableTrustWarnings(XmlNode preferenceSettingsElement)
             try
             {
                 return bool.Parse(preferenceSettingsElement.SelectSingleNode($@"//{nameof(DisableTrustWarnings)}").InnerText);
-                
+
             }
             catch (Exception ex)
             {
@@ -470,7 +470,7 @@ public string PythonTemplateFilePath
         public int BackupFilesCount { get; set; }
 
         /// <summary>
-        /// Indicates if the user has accepted the terms of 
+        /// Indicates if the user has accepted the terms of
         /// use for downloading packages from package manager.
         /// </summary>
         public bool PackageDownloadTouAccepted { get; set; }
@@ -644,7 +644,7 @@ public bool DisableCustomPackageLocations
 
         /// <summary>
         /// Limits the size of the tags used by the SearchDictionary
-        /// This static property is not serialized and is assigned NodeSearchTagSizeLimit's value 
+        /// This static property is not serialized and is assigned NodeSearchTagSizeLimit's value
         /// if found at deserialize time.
         /// </summary>
         internal static int nodeSearchTagSizeLimit = 300;
@@ -660,7 +660,7 @@ public int NodeSearchTagSizeLimit
 
         /// <summary>
         /// The Version of the IronPython package that Dynamo will download when it is found as missing in graphs.
-        /// This static property is not serialized and is assigned IronPythonResolveTargetVersion's value 
+        /// This static property is not serialized and is assigned IronPythonResolveTargetVersion's value
         /// if found at deserialize time.
         /// </summary>
         internal static Version ironPythonResolveTargetVersion = new Version(2, 4, 0);
@@ -680,6 +680,15 @@ public string IronPythonResolveTargetVersion
         public List<string> ReadNotificationIds { get; set; }
         #endregion
 
+        #region Dynamo Player and Generative Design settings
+
+        /// <summary>
+        /// Collections of folders used by individual Dynamo Player or Generative Design as entry points.
+        /// </summary>
+        public List<DynamoPlayerFolderGroup> DynamoPlayerFolderGroups { get; set; }
+
+        #endregion
+
         /// <summary>
         /// Initializes a new instance of the <see cref="PreferenceSettings"/> class.
         /// </summary>
@@ -719,7 +728,7 @@ public PreferenceSettings()
             BackupInterval = DefaultBackupInterval;
             BackupFilesCount = 1;
             BackupFiles = new List<string>();
-                        
+
             CustomPackageFolders = new List<string>();
 
             PythonTemplateFilePath = "";
@@ -732,6 +741,7 @@ public PreferenceSettings()
             ViewExtensionSettings = new List<ViewExtensionSettings>();
             GroupStyleItemsList = new List<GroupStyleItem>();
             ReadNotificationIds = new List<string>();
+            DynamoPlayerFolderGroups = new List<DynamoPlayerFolderGroup>();
         }
 
         /// <summary>
@@ -761,11 +771,11 @@ public bool Save(string filePath)
         }
 
         /// <summary>
-        /// Saves PreferenceSettings in a default directory when no path is 
+        /// Saves PreferenceSettings in a default directory when no path is
         /// specified.
         /// </summary>
         /// <param name="preferenceFilePath">The file path to save preference
-        /// settings to. If this parameter is null or empty string, preference 
+        /// settings to. If this parameter is null or empty string, preference
         /// settings will be saved to the default path.</param>
         /// <returns>True if file is saved successfully, false if an error occurred.</returns>
         public bool SaveInternal(string preferenceFilePath)
@@ -1016,7 +1026,7 @@ public bool IsTrustedLocation(string location)
             {
                 return false;
             }
-            
+
         }
 
         /// <summary>
diff --git a/test/DynamoCoreTests/Configuration/PreferenceSettingsTests.cs b/test/DynamoCoreTests/Configuration/PreferenceSettingsTests.cs
@@ -33,7 +33,7 @@ public void TestLoad()
 
         [Test]
         [Category("UnitTests")]
-        public void TestGetPythonTemplateFilePath()
+        public void TestGetPythonTemplateFilePath ()
         {
             string settingDirectory = Path.Combine(TestDirectory, "settings");
             string settingsFilePath = Path.Combine(settingDirectory, "DynamoSettings-PythonTemplate-initial.xml");
@@ -72,6 +72,7 @@ public void TestSettingsSerialization()
             Assert.AreEqual(settings.UseHardwareAcceleration, true);
             Assert.AreEqual(settings.ViewExtensionSettings.Count, 0);
             Assert.AreEqual(settings.DefaultRunType, RunType.Automatic);
+            Assert.AreEqual(settings.DynamoPlayerFolderGroups.Count, 0);
 
             // Save
             settings.Save(tempPath);
@@ -90,6 +91,7 @@ public void TestSettingsSerialization()
             Assert.AreEqual(settings.UseHardwareAcceleration, true);
             Assert.AreEqual(settings.ViewExtensionSettings.Count, 0);
             Assert.AreEqual(settings.DefaultRunType, RunType.Automatic);
+            Assert.AreEqual(settings.DynamoPlayerFolderGroups.Count, 0);
 
             // Change setting values
             settings.SetIsBackgroundPreviewActive("MyBackgroundPreview", false);
@@ -117,12 +119,28 @@ public void TestSettingsSerialization()
                     Status = WindowStatus.Maximized
                 }
             });
-            settings.GroupStyleItemsList.Add(new GroupStyleItem 
+            settings.GroupStyleItemsList.Add(new GroupStyleItem
             {
-                Name = "TestGroup", 
-                HexColorString = "000000" 
+                Name = "TestGroup",
+                HexColorString = "000000"
+            });
+            settings.DynamoPlayerFolderGroups.Add(new DynamoPlayerFolderGroup()
+            {
+                EntryPoint = "GenerativeDesign",
+                Folders = new List<DynamoPlayerFolder>()
+                {
+                    new DynamoPlayerFolder()
+                    {
+                        Path = @"C:\MyGenerativeDesignFolder",
+                        DisplayName = "My Generative Design Folder",
+                        Id = "41B5B0F7-1B21-42A8-A938-E2C34521EF61",
+                        IsRemovable = true,
+                        Order = -1,
+                    }
+                }
             });
 
+
             // Save
             settings.Save(tempPath);
             settings = PreferenceSettings.Load(tempPath);
@@ -156,6 +174,8 @@ public void TestSettingsSerialization()
             var styleItemsList = settings.GroupStyleItemsList[0];
             Assert.AreEqual(styleItemsList.Name, "TestGroup");
             Assert.AreEqual(styleItemsList.HexColorString, "000000");
+            Assert.AreEqual(settings.DynamoPlayerFolderGroups.Count, 1);
+            Assert.AreEqual(settings.DynamoPlayerFolderGroups[0].Folders.Count, 1);
         }
 
         [Test]
@@ -212,7 +232,7 @@ public void TestSerializationTrustedLocations()
             Assert.AreEqual(1, settingsLoaded.TrustedLocations.Count);
 
             Assert.IsTrue(settingsLoaded.IsTrustedLocation(Path.GetTempPath()));
-        }        
+        }
 
         /// <summary>
         /// Struct to support the comparison between two PreferenceSettings instances
@@ -221,7 +241,7 @@ struct PreferencesComparison
         {
             public List<string> Properties { get; set; }
             public List<String> SamePropertyValues { get; set; }
-            public List<String> DifferentPropertyValues { get; set; }          
+            public List<String> DifferentPropertyValues { get; set; }
         }
 
         /// <summary>
@@ -264,6 +284,11 @@ PreferencesComparison comparePrefenceSettings(PreferenceSettings defaultSettings
             {
                 var sourcePi = newGeneralSettings.GetType().GetProperty(destinationPi.Name);
 
+                if (sourcePi.Name == "DynamoPlayerFolderGroups")
+                {
+                    string a = "";
+                }
+
                 if (!PropertyHasExcludedAttributes(destinationPi) && !PropertyHasStaticField(defaultSettings, destinationPi))
                 {
                     evaluatedProperties.Add(destinationPi.Name);
@@ -319,6 +344,18 @@ PreferencesComparison comparePrefenceSettings(PreferenceSettings defaultSettings
                             propertiesWithDifferentValue.Add(destinationPi.Name);
                         }
                     }
+                    else if (destinationPi.PropertyType == typeof(List<DynamoPlayerFolderGroup>))
+                    {
+                        if (((List<DynamoPlayerFolderGroup>)sourcePi.GetValue(newGeneralSettings, null)).Count ==
+                            ((List<DynamoPlayerFolderGroup>)destinationPi.GetValue(defaultSettings, null)).Count)
+                        {
+                            propertiesWithSameValue.Add(destinationPi.Name);
+                        }
+                        else
+                        {
+                            propertiesWithDifferentValue.Add(destinationPi.Name);
+                        }
+                    }
                     else
                     {
                         if (newValue?.ToString() == oldValue?.ToString())
@@ -332,7 +369,7 @@ PreferencesComparison comparePrefenceSettings(PreferenceSettings defaultSettings
                     }
                 }
             }
-            
+
             result.SamePropertyValues = propertiesWithSameValue;
             result.DifferentPropertyValues = propertiesWithDifferentValue;
             result.Properties = evaluatedProperties;
@@ -375,7 +412,7 @@ public void TestImportCopySettings()
             defaultSettings.SetTrustedLocations(newSettings.TrustedLocations);
 
             // checking if the default Setting instance has the same property values of the new one
-            var checkEquality = comparePrefenceSettings(defaultSettings, newSettings);            
+            var checkEquality = comparePrefenceSettings(defaultSettings, newSettings);
             Assert.IsTrue(checkEquality.SamePropertyValues.Count == checkEquality.Properties.Count);
         }
 
@@ -399,7 +436,7 @@ public void TestAskForTrustedLocation()
             bool isOpenedFile = true;
             bool isHomeSpace = true;
             bool isShowStartPage = false;
-            bool isFileInTrustedLocation = false;            
+            bool isFileInTrustedLocation = false;
             bool isDisableTrustWarnings = false;
 
             // getting result
@@ -410,7 +447,7 @@ public void TestAskForTrustedLocation()
                 isShowStartPage,
                 isDisableTrustWarnings);
 
-            // checking the result            
+            // checking the result
             Assert.IsTrue(result == PreferenceSettings.AskForTrustedLocationResult.Ask, $"Conditions info: is opened file : {isOpenedFile} | is file in trusted location : {isFileInTrustedLocation} | is home space : {isHomeSpace} | is show Start page : {isShowStartPage} | is disable trust warnings : {isDisableTrustWarnings}");
         }
     }
diff --git a/test/settings/DynamoSettings-NewSettings.xml b/test/settings/DynamoSettings-NewSettings.xml
@@ -123,4 +123,7 @@
   <ReadNotificationIds>
     <string>1</string>
   </ReadNotificationIds>
+  <DynamoPlayerFolderGroups>
+   <DynamoPlayerFolderGroup/>
+  </DynamoPlayerFolderGroups>
 </PreferenceSettings>
