Feature/rc4 (#1570)

* Syntax tidying
* Dependency updates
* Event handling singletons (ThrowImmediately and co)

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: James A Sutherland <>
Co-authored-by: James Friel <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/build.yml

@@ -55,6 +55,10 @@ jobs:
           mysql-version: '8.0'
           root-password: 'YourStrong!Passw0rd'
           auto-start: true
+      - name: Populate Databases.yaml 
+        shell: bash
+        run: |
+            find ./Tools/rdmp/Databases.yaml -type f -exec sed -i 's/RDMP_/TEST_/g' {} \;
       - name: Build
         run: dotnet build --configuration Release --verbosity minimal
       - name: Create MySql Logging, DQE and Cohort Building Cache Db
@@ -73,10 +77,10 @@ jobs:
           EOF
       - name: Run integration test scripts
         run: |
-            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/create_list_destroy_catalogue.yaml &&
-            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/create_cohort.yaml &&
-            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/create_dataload.yaml &&
-            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/orphan_extractable_column.yaml &&
+            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/create_list_destroy_catalogue.yaml 
+            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/create_cohort.yaml 
+            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/create_dataload.yaml 
+            dotnet run -c Release --no-build --project Tools/rdmp/rdmp.csproj -- -f ./scripts/orphan_extractable_column.yaml 
       - name: Test (DB)
         shell: bash
         run: |

Application/ResearchDataManagementPlatform/Menus/MenuItems/DataExportMenu.cs

@@ -1,4 +1,4 @@
-// Copyright (c) The University of Dundee 2018-2019
+// Copyright (c) The University of Dundee 2018-2023
 // This file is part of the Research Data Management Platform (RDMP).
 // RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 // RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
@@ -12,7 +12,7 @@
 
 namespace ResearchDataManagementPlatform.Menus.MenuItems;
 
-internal class DataExportMenu : RDMPToolStripMenuItem
+internal sealed class DataExportMenu : RDMPToolStripMenuItem
 {
     public DataExportMenu(IActivateItems activator) : base(activator, "Data Export Options")
     {

Application/ResearchDataManagementPlatform/Menus/MenuItems/DisableTutorialsMenuItem.cs

@@ -15,18 +15,18 @@ namespace ResearchDataManagementPlatform.Menus.MenuItems;
 /// Disables displaying Tutorials in RDMP
 /// </summary>
 [System.ComponentModel.DesignerCategory("")]
-public class DisableTutorialsMenuItem : ToolStripMenuItem
+public sealed class DisableTutorialsMenuItem : ToolStripMenuItem
 {
     private readonly TutorialTracker _tracker;
 
     public DisableTutorialsMenuItem(ToolStripMenuItem parent, TutorialTracker tracker)
     {
-        parent.DropDownOpened += parent_DropDownOpened;
+        parent.DropDownOpened += Parent_DropDownOpened;
         _tracker = tracker;
         Text = "Disable Tutorials";
     }
 
-    private void parent_DropDownOpened(object sender, EventArgs e)
+    private void Parent_DropDownOpened(object sender, EventArgs e)
     {
         Checked = UserSettings.DisableTutorials;
     }

Application/ResearchDataManagementPlatform/Menus/MenuItems/LaunchTutorialMenuItem.cs

@@ -17,15 +17,13 @@ namespace ResearchDataManagementPlatform.Menus.MenuItems;
 [System.ComponentModel.DesignerCategory("")]
 public class LaunchTutorialMenuItem : ToolStripMenuItem
 {
-    private IActivateItems _activator;
     private readonly Tutorial _tutorial;
     private readonly TutorialTracker _tracker;
 
     public LaunchTutorialMenuItem(ToolStripMenuItem parent, IActivateItems activator, Tutorial tutorial,
         TutorialTracker tracker)
     {
         parent.DropDownOpening += parent_DropDownOpening;
-        _activator = activator;
         _tutorial = tutorial;
         _tracker = tracker;
 

Application/ResearchDataManagementPlatform/Menus/MenuItems/ResetTutorialsMenuItem.cs

@@ -14,7 +14,7 @@ namespace ResearchDataManagementPlatform.Menus.MenuItems;
 /// Clears all user progress on Tutorials
 /// </summary>
 [System.ComponentModel.DesignerCategory("")]
-public class ResetTutorialsMenuItem : ToolStripMenuItem
+public sealed class ResetTutorialsMenuItem : ToolStripMenuItem
 {
     private readonly TutorialTracker _tracker;
 

Application/ResearchDataManagementPlatform/Menus/RDMPTopMenuStripUI.cs

@@ -82,7 +82,7 @@ public RDMPTopMenuStripUI()
 
     private void BuildSwitchInstanceMenuItems()
     {
-        var args = RDMPBootStrapper<RDMPMainForm>.ApplicationArguments;
+        var args = RDMPBootStrapper.ApplicationArguments;
 
         // somehow app was launched without populating the load args
         if (args == null) return;
@@ -103,7 +103,7 @@ private void BuildSwitchInstanceMenuItems()
         AddMenuItemsForSwitchingToInstancesInYamlFilesOf(origYamlFile, exeDir);
 
         // also add yaml files from wherever they got their original yaml file
-        if (origYamlFile?.FileLoaded != null && !exeDir.FullName.Equals(origYamlFile.FileLoaded.Directory.FullName))
+        if (origYamlFile?.FileLoaded != null && !exeDir.FullName.Equals(origYamlFile.FileLoaded.Directory?.FullName))
             AddMenuItemsForSwitchingToInstancesInYamlFilesOf(origYamlFile, origYamlFile.FileLoaded.Directory);
     }
 
@@ -120,14 +120,14 @@ private void AddMenuItemsForSwitchingToInstancesInYamlFilesOf(ConnectionStringsY
                                   yaml.FullName.Equals(origYamlFile.FileLoaded.FullName);
 
             var launchNew = new ToolStripMenuItem(connectionStrings.Name ?? yaml.Name, null,
-                (s, e) => { LaunchNew(connectionStrings); })
+                (_, _) => { LaunchNew(connectionStrings); })
             {
                 Checked = isSameAsCurrent,
                 ToolTipText = connectionStrings.Description ?? yaml.FullName
             };
 
             var switchTo = new ToolStripMenuItem(connectionStrings.Name ?? yaml.Name, null,
-                (s, e) => { SwitchTo(connectionStrings); })
+                (_, _) => { SwitchTo(connectionStrings); })
             {
                 Enabled = !isSameAsCurrent,
                 Checked = isSameAsCurrent,
@@ -244,7 +244,6 @@ private void generateClassTableSummaryToolStripMenuItem_Click(object sender, Eve
         report.GenerateReport(Activator.RepositoryLocator.CatalogueRepository.CommentStore,
             new PopupChecksUI("Generating class summaries", false),
             Activator.CoreIconProvider,
-            Activator.RepositoryLocator.CatalogueRepository.MEF,
             true);
     }
 
@@ -349,7 +348,7 @@ private IAtomicCommand[] GetNewCommands()
 
     private void WindowFactory_TabChanged(object sender, IDockContent newTab)
     {
-        closeToolStripMenuItem.Enabled = newTab != null && newTab is not PersistableToolboxDockContent;
+        closeToolStripMenuItem.Enabled = newTab is not null and not PersistableToolboxDockContent;
         showHelpToolStripMenuItem.Enabled = newTab is RDMPSingleControlTab;
 
         if (newTab is not RDMPSingleControlTab singleObjectControlTab)
@@ -484,8 +483,7 @@ private void checkForUpdatesToolStripMenuItem_Click(object sender, EventArgs e)
     private void ListAllTypesToolStripMenuItem_Click(object sender, EventArgs e)
     {
         var file = new FileInfo(Path.GetTempFileName());
-        File.WriteAllLines(file.FullName,
-            Activator.RepositoryLocator.CatalogueRepository.MEF.GetAllTypes().Select(t => t.FullName));
+        File.WriteAllLines(file.FullName, Rdmp.Core.Repositories.MEF.GetAllTypes().Select(t => t.FullName));
         UsefulStuff.ShowPathInWindowsExplorer(file);
     }
 

Application/ResearchDataManagementPlatform/Program.cs

@@ -18,22 +18,17 @@
 
 namespace ResearchDataManagementPlatform;
 
-internal static class Program
+internal static partial class Program
 {
-    [DllImport("kernel32.dll")]
-    [return: MarshalAs(UnmanagedType.Bool)]
-    private static extern bool AttachConsole([MarshalAs(UnmanagedType.U4)] int dwProcessId);
+    [LibraryImport("kernel32.dll")]
+    private static partial void AttachConsole(int dwProcessId);
 
     /// <summary>
     /// The main entry point for the application.
     /// </summary>
     [STAThread]
     private static void Main(string[] args)
     {
-        // if user has the command line built and runnable from the windows
-        // client then don't load the dlls (or we end up with 2 copies!).
-        SafeDirectoryCatalog.IgnoreDll = f => Path.GetFileName(f.DirectoryName)?.Equals("cli") == true;
-
         try
         {
             AttachConsole(-1);
@@ -47,14 +42,14 @@ private static void Main(string[] args)
 
         UsefulStuff.GetParser()
             .ParseArguments<ResearchDataManagementPlatformOptions>(args)
-            .MapResult(RunApp, err => -1);
+            .MapResult(RunApp, _ => -1);
     }
 
     private static object RunApp(ResearchDataManagementPlatformOptions arg)
     {
         try
         {
-            arg.PopulateConnectionStringsFromYamlIfMissing(new ThrowImmediatelyCheckNotifier());
+            arg.PopulateConnectionStringsFromYamlIfMissing(ThrowImmediatelyCheckNotifier.Quiet);
         }
         catch (Exception ex)
         {
@@ -63,11 +58,14 @@ private static object RunApp(ResearchDataManagementPlatformOptions arg)
         }
 
         var bootStrapper =
-            new RDMPBootStrapper<RDMPMainForm>(
-                new EnvironmentInfo(PluginFolders.Main | PluginFolders.Windows),
-                arg);
+            new RDMPBootStrapper(arg, locator =>
+            {
+                var form = new RDMPMainForm();
+                form.SetRepositoryLocator(locator);
+                return form;
+            });
 
-        bootStrapper.Show(false);
+        bootStrapper.Show();
         return 0;
     }
 }

Application/ResearchDataManagementPlatform/Properties/AssemblyInfo.cs

@@ -1,9 +1,9 @@
 using System.Runtime.InteropServices;
 
-// Setting ComVisible to false makes the types in this assembly not visible 
-// to COM components.  If you need to access a type in this assembly from 
+// Setting ComVisible to false makes the types in this assembly not visible
+// to COM components.  If you need to access a type in this assembly from
 // COM, set the ComVisible attribute to true on that type.
 [assembly: ComVisible(false)]
 
-// The following GUID is for the ID of the typelib if this project is exposed to COM
+// The following GUID is for the ID of the type library if this project is exposed to COM
 [assembly: Guid("cac9817c-fc66-48e8-9333-c740af6ab5b9")]

Application/ResearchDataManagementPlatform/RDMP.nuspec

@@ -8,7 +8,6 @@
 using System.Drawing;
 using System.IO;
 using System.Linq;
-using System.Reflection;
 using System.Text;
 using System.Windows.Forms;
 using Rdmp.Core.Curation.Data;
@@ -34,13 +33,12 @@ namespace ResearchDataManagementPlatform;
 /// <summary>
 /// Main entry point into the RDMP software.  Hosts all tab collections and document windows for all RDMP tasks.  See CatalogueCollectionUI , DataExportCollectionUI ,
 ///  TableInfoCollectionUI , LoadMetadataCollectionUI and CohortIdentificationCollectionUI
-/// See 
+/// See
 /// </summary>
 public partial class RDMPMainForm : RDMPForm
 {
     private readonly PersistenceDecisionFactory _persistenceFactory = new();
-    private ITheme _theme;
-
+    private readonly ITheme _theme;
     private IRDMPPlatformRepositoryServiceLocator RepositoryLocator { get; set; }
 
     /// <summary>
@@ -120,8 +118,7 @@ private void RDMPMainForm_Load(object sender, EventArgs e)
             var database = connectedTo.DiscoveredServer?.GetCurrentDatabase();
             var instanceDescription = "";
 
-            var connectionStringsFileLoaded =
-                RDMPBootStrapper<RDMPMainForm>.ApplicationArguments?.ConnectionStringsFileLoaded;
+            var connectionStringsFileLoaded = RDMPBootStrapper.ApplicationArguments?.ConnectionStringsFileLoaded;
             if (connectionStringsFileLoaded != null)
                 instanceDescription =
                     $" - {connectionStringsFileLoaded.Name ?? connectionStringsFileLoaded.FileLoaded.Name}";
@@ -144,12 +141,11 @@ private void RDMPMainForm_Load(object sender, EventArgs e)
         //if there is no persist file or user wants to show the home screen always on startup
         if (!_persistenceFile.Exists || UserSettings.ShowHomeOnStartup)
             _windowManager.PopHome();
-        else
+        else if (_persistenceFile.Exists)
             try
             {
-                if (_persistenceFile.Exists)
-                    LoadFromXml(new FileStream(_persistenceFile.FullName, FileMode.Open));
                 //load the state using the method
+                LoadFromXml(new FileStream(_persistenceFile.FullName, FileMode.Open));
             }
             catch (Exception ex)
             {
@@ -170,18 +166,18 @@ private void RDMPMainForm_Load(object sender, EventArgs e)
     public override string Text
     {
         get => base.Text;
-        set => base.Text = (value + " v" + _version + " " + _connectedTo).Trim();
+        set => base.Text = $"{value} v{_version} {_connectedTo}".Trim();
     }
 
-    public void LoadFromXml(Stream stream)
+    private void LoadFromXml(Stream stream)
     {
         if (dockPanel1.DocumentStyle == DocumentStyle.SystemMdi)
             foreach (var form in MdiChildren)
                 form.Close();
         else
             foreach (var document in dockPanel1.DocumentsToArray())
             {
-                // IMPORANT: dispose all panes.
+                // IMPORTANT: dispose all panes.
                 document.DockHandler.DockPanel = null;
                 document.DockHandler.Close();
             }
@@ -208,45 +204,24 @@ public void LoadFromXml(WindowLayout target)
         var uniEncoding = new UnicodeEncoding();
 
         // You might not want to use the outer using statement that I have
-        // I wasn't sure how long you would need the MemoryStream object    
-        using (var ms = new MemoryStream())
-        {
-            var sw = new StreamWriter(ms, uniEncoding);
-            try
-            {
-                sw.Write(target.LayoutData);
-                sw.Flush(); //otherwise you are risking empty stream
-                ms.Seek(0, SeekOrigin.Begin);
-
-                LoadFromXml(ms);
-            }
-            finally
-            {
-                sw.Dispose();
-            }
-        }
+        // I wasn't sure how long you would need the MemoryStream object
+        using var ms = new MemoryStream();
+        using var sw = new StreamWriter(ms, uniEncoding);
+        sw.Write(target.LayoutData);
+        sw.Flush(); //otherwise you are risking empty stream
+        ms.Seek(0, SeekOrigin.Begin);
+        LoadFromXml(ms);
     }
 
 
     public string GetCurrentLayoutXml()
     {
         var uniEncoding = new UnicodeEncoding();
 
-        using (var ms = new MemoryStream())
-        {
-            dockPanel1.SaveAsXml(ms, uniEncoding);
-
-            ms.Seek(0, SeekOrigin.Begin);
-
-            try
-            {
-                return new StreamReader(ms).ReadToEnd();
-            }
-            finally
-            {
-                ms.Dispose();
-            }
-        }
+        using var ms = new MemoryStream();
+        dockPanel1.SaveAsXml(ms, uniEncoding);
+        ms.Seek(0, SeekOrigin.Begin);
+        return new StreamReader(ms).ReadToEnd();
     }
 
     private void CloseForm(object sender, FormClosingEventArgs e)
@@ -265,13 +240,10 @@ private void CloseForm(object sender, FormClosingEventArgs e)
 
         try
         {
-            if (_persistenceFile != null)
-            {
-                if (!_persistenceFile.Directory.Exists)
-                    _persistenceFile.Directory.Create();
-
-                dockPanel1.SaveAsXml(_persistenceFile.FullName); //save when Form closes
-            }
+            if (_persistenceFile == null) return;
+            if (_persistenceFile.Directory?.Exists == false)
+                _persistenceFile.Directory.Create();
+            dockPanel1.SaveAsXml(_persistenceFile.FullName); //save when Form closes
         }
         catch (Exception ex)
         {