Task/rdmp-1 Update Ticketing System

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [8.2.1] - Unreleased
+
+- Add Release status optiosn to the ticketing system
+
 ## [8.2.0] - Unreleased
 
 ## Changed

Rdmp.Core/Curation/Data/EncryptedString.cs

@@ -40,7 +40,7 @@ public string Value
                 }
                 catch (Exception e)
                 {
-                    if (e.Message.Contains("Bad Length") || e.Message.Contains("data too large for key size"))
+                   if (e.Message.Contains("Bad Length") || e.Message.Contains("data too large for key size"))
                         throw new InvalidOperationException(
                             $"The free text Value supplied to this class was too long to be encrypted (Length of string was {value.Length})",
                             e);

Rdmp.Core/Curation/Data/TicketingSystemConfiguration.cs

@@ -1,4 +1,4 @@
-// Copyright (c) The University of Dundee 2018-2019
+// Copyright (c) The University of Dundee 2018-2024
 // 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.
@@ -118,6 +118,14 @@ public TicketingSystemConfiguration(ICatalogueRepository repository, string name
         });
     }
 
+    /// <summary>
+    /// Fetches a list of acceptable release statuses set for the ticketing system
+    /// </summary>
+    public List<TicketingSystemReleaseStatus> GetReleaseStatuses()
+    {
+        return [.. Repository.GetAllObjectsWhere<TicketingSystemReleaseStatus>("TicketingSystemConfigurationID", this.ID)];
+    }
+
     /// <inheritdoc/>
     internal TicketingSystemConfiguration(ICatalogueRepository repository, DbDataReader r) : base(repository, r)
     {
@@ -127,4 +135,5 @@ internal TicketingSystemConfiguration(ICatalogueRepository repository, DbDataRea
         Name = r["Name"] as string;
         DataAccessCredentials_ID = ObjectToNullableInt(r["DataAccessCredentials_ID"]);
     }
+
 }

Rdmp.Core/Curation/TicketingSystemReleaseStatus.cs

@@ -0,0 +1,48 @@
+// Copyright (c) The University of Dundee 2024-2024
+// 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.
+// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
+
+using Rdmp.Core.Curation.Data;
+using Rdmp.Core.MapsDirectlyToDatabaseTable;
+using Rdmp.Core.Repositories;
+using Rdmp.Core.ReusableLibraryCode.Annotations;
+using System;
+using System.Collections.Generic;
+using System.Data.Common;
+namespace Rdmp.Core.Curation
+{
+    /// <summary>
+    /// Stored a status name and which ticketing system it coresponds to
+    /// </summary>
+    public class TicketingSystemReleaseStatus : DatabaseEntity
+    {
+
+        private string _status;
+        private int _ticketingSystemConfiguratonID;
+
+        [NotNull]
+        public string Status { get => _status; set => SetField(ref _status, value); }
+
+        [NotNull]
+        public int TicketingSystemConfigurationID { get => _ticketingSystemConfiguratonID; set => SetField(ref _ticketingSystemConfiguratonID, value); }
+
+        public TicketingSystemReleaseStatus() { }
+
+        public TicketingSystemReleaseStatus(ICatalogueRepository repository, string status, int? statusID, TicketingSystemConfiguration config) : base()
+        {
+            repository.InsertAndHydrate(this, new Dictionary<string, object>
+            {
+                {"Status", status},
+                {"TicketingSystemConfigurationID", config.ID }
+            });
+        }
+
+        public TicketingSystemReleaseStatus(ICatalogueRepository repository, DbDataReader r) : base(repository, r)
+        {
+            Status = r["Status"] as string;
+            TicketingSystemConfigurationID = int.Parse(r["TicketingSystemConfigurationID"].ToString());
+        }
+    }
+}

Rdmp.Core/DataExport/DataRelease/ReleaseEnvironmentPotential.cs

@@ -1,4 +1,4 @@
-// Copyright (c) The University of Dundee 2018-2019
+// Copyright (c) The University of Dundee 2018-2024
 // 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.
@@ -7,6 +7,7 @@
 using System;
 using System.Linq;
 using System.Threading;
+using Rdmp.Core.Curation;
 using Rdmp.Core.Curation.Data;
 using Rdmp.Core.DataExport.Data;
 using Rdmp.Core.Repositories;
@@ -44,7 +45,6 @@ private void MakeAssessment()
         var configuration = _repository.CatalogueRepository
             .GetAllObjectsWhere<TicketingSystemConfiguration>("IsActive", 1).SingleOrDefault();
         if (configuration == null) return;
-
         var factory = new TicketingSystemFactory(_repository.CatalogueRepository);
 
 
@@ -66,7 +66,7 @@ private void MakeAssessment()
         try
         {
             Assesment = ticketingSystem.GetDataReleaseabilityOfTicket(Project.MasterTicket,
-                Configuration.RequestTicket, Configuration.ReleaseTicket, out var reason, out var e);
+                Configuration.RequestTicket, Configuration.ReleaseTicket, configuration.GetReleaseStatuses(), out var reason, out var e);
             Exception = e;
             Reason = reason;
         }

Rdmp.Core/Databases/CatalogueDatabase/up/085_AddTicketingReleaseStatuses.sql

@@ -0,0 +1,19 @@
+--Version: 8.2.1
+--Description: Add lookup table of release status names for a ticketing configuration
+
+
+if not exists (select 1 from sys.tables where name = 'TicketingSystemReleaseStatus')
+BEGIN
+CREATE TABLE [dbo].[TicketingSystemReleaseStatus](
+	[ID] [int] IDENTITY(1,1) NOT NULL,
+	[Status] [nvarchar](250) NOT NULL,
+	[TicketingSystemConfigurationID] [int] NOT NULL,
+	    FOREIGN KEY (TicketingSystemConfigurationID) REFERENCES TicketingSystemConfiguration(ID) ON DELETE CASCADE,
+
+CONSTRAINT [PK_TicketingSystemReleaseStatus] PRIMARY KEY CLUSTERED 
+(
+	[ID] ASC
+)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
+) ON [PRIMARY]
+END
+GO

Rdmp.Core/Icons/IconProvision/CatalogueIcons.resx

@@ -757,7 +757,10 @@
   <data name="LoadMetadataCatalogueLinkage" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\LoadMetadataCatalogueLinkage.png;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
   </data>
-	<data name="Setting" type="System.Resources.ResXFileRef, System.Windows.Forms">
-		<value>..\famfamfam\cog.png;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
-	</data>
-</root>
+  <data name="Setting" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>..\famfamfam\cog.png;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </data>
+  <data name="TicketingSystemReleaseStatus" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>..\TicketingSystemReleaseStatus.png;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </data>
+</root>

Rdmp.Core/Icons/IconProvision/RDMPConcept.cs

@@ -205,5 +205,6 @@ public enum RDMPConcept
     TableInfoDatabaseNode,
     Dataset,
     LoadMetadataCatalogueLinkage,
-    Setting
+    Setting,
+    TicketingSystemReleaseStatus
 }

Rdmp.Core/Rdmp.Core.csproj

@@ -127,6 +127,7 @@
 		<None Remove="Databases\CatalogueDatabase\up\082_AddCohortVersioning.sql" />
 		<None Remove="Databases\CatalogueDatabase\up\083_AddGroupBy.sql" />
 		<None Remove="Databases\CatalogueDatabase\up\084_AddLoadDirectorySplit.sql" />
+		<None Remove="Databases\CatalogueDatabase\up\085_AddTicketingReleaseStatuses.sql" />
 		<None Remove="Databases\DataExportDatabase\runAfterCreateDatabase\CreateDataExportManager.sql" />
 		<None Remove="Databases\DataExportDatabase\up\001_AddUsernamePasswordFieldsToExternalCohortTable.sql" />
 		<None Remove="Databases\DataExportDatabase\up\002_FixServerAndDatabaseNameOnExternalCohort.sql" />
@@ -251,6 +252,7 @@
 		<EmbeddedResource Include="Databases\CatalogueDatabase\up\077_AddDataSetMapping.sql" />
 		<EmbeddedResource Include="Databases\CatalogueDatabase\up\078_AddLastLoadTimeToLoadMetadata.sql" />
 		<EmbeddedResource Include="Databases\CatalogueDatabase\up\084_AddLoadDirectorySplit.sql" />
+		<EmbeddedResource Include="Databases\CatalogueDatabase\up\085_AddTicketingReleaseStatuses.sql" />
 		<EmbeddedResource Include="Databases\CatalogueDatabase\up\079_AddProcessTaskConfiguration.sql" />
 		<EmbeddedResource Include="Databases\CatalogueDatabase\up\082_AddCohortVersioning.sql" />
 		<EmbeddedResource Include="Databases\CatalogueDatabase\up\083_AddGroupBy.sql" />

Rdmp.Core/Ticketing/ITicketingSystem.cs

@@ -5,6 +5,8 @@
 // You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
 
 using System;
+using System.Collections.Generic;
+using Rdmp.Core.Curation;
 using Rdmp.Core.ReusableLibraryCode.Checks;
 
 namespace Rdmp.Core.Ticketing;
@@ -41,13 +43,16 @@ public interface ITicketingSystem : ICheckable
     /// <param name="masterTicket"></param>
     /// <param name="requestTicket"></param>
     /// <param name="releaseTicket"></param>
+    /// <param name="acceptedStatuses"></param>
     /// <param name="reason"></param>
     /// <param name="exception"></param>
     /// <returns></returns>
     TicketingReleaseabilityEvaluation GetDataReleaseabilityOfTicket(string masterTicket, string requestTicket,
-        string releaseTicket, out string reason, out Exception exception);
+        string releaseTicket, List<TicketingSystemReleaseStatus> acceptedStatuses,out string reason, out Exception exception);
 
     string GetProjectFolderName(string masterTicket);
+
+    List<string> GetAvailableStatuses();
 }
 
 public enum TicketingReleaseabilityEvaluation

Rdmp.Core/Ticketing/PluginTicketingSystem.cs

@@ -5,6 +5,8 @@
 // You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
 
 using System;
+using System.Collections.Generic;
+using Rdmp.Core.Curation;
 using Rdmp.Core.ReusableLibraryCode.Checks;
 using Rdmp.Core.ReusableLibraryCode.DataAccess;
 
@@ -26,7 +28,10 @@ protected PluginTicketingSystem(TicketingSystemConstructorParameters parameters)
     public abstract void NavigateToTicket(string ticketName);
 
     public abstract TicketingReleaseabilityEvaluation GetDataReleaseabilityOfTicket(string masterTicket,
-        string requestTicket, string releaseTicket, out string reason, out Exception exception);
+        string requestTicket, string releaseTicket, List<TicketingSystemReleaseStatus> acceptedStatuses,out string reason, out Exception exception);
 
     public abstract string GetProjectFolderName(string masterTicket);
+
+    public abstract List<string> GetAvailableStatuses();
+
 }

Rdmp.Core/Ticketing/SimpleTicketingSystem.cs

@@ -5,6 +5,8 @@
 // You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
 
 using System;
+using System.Collections.Generic;
+using Rdmp.Core.Curation;
 using Rdmp.Core.ReusableLibraryCode;
 using Rdmp.Core.ReusableLibraryCode.Checks;
 using Rdmp.Core.ReusableLibraryCode.DataAccess;
@@ -45,7 +47,7 @@ public void NavigateToTicket(string ticketName)
     }
 
     public TicketingReleaseabilityEvaluation GetDataReleaseabilityOfTicket(string masterTicket, string requestTicket,
-        string releaseTicket, out string reason, out Exception exception)
+        string releaseTicket, List<TicketingSystemReleaseStatus> acceptedStatuses, out string reason, out Exception exception)
     {
         reason = null;
         exception = null;
@@ -55,4 +57,9 @@ public TicketingReleaseabilityEvaluation GetDataReleaseabilityOfTicket(string ma
 
     public string GetProjectFolderName(string masterTicket) =>
         UsefulStuff.RegexThingsThatAreNotNumbersOrLettersOrUnderscores.Replace(masterTicket, "");
+
+    public List<string> GetAvailableStatuses()
+    {
+        return new List<string>();
+    }
 }

Rdmp.Core/Ticketing/TicketingSystemConstructorParameters.cs

@@ -1,11 +1,10 @@
-// Copyright (c) The University of Dundee 2018-2019
+// Copyright (c) The University of Dundee 2018-2024
 // 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.
 // You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
 
 using Rdmp.Core.ReusableLibraryCode.DataAccess;
-
 namespace Rdmp.Core.Ticketing;
 
 /// <summary>