Support allow-list for SOP classes.

docs/api/rest/config.md

@@ -41,7 +41,8 @@ curl --location --request GET 'http://localhost:5000/config/ae'
     "workflows": ["brain-tumor", "b75cd27a-068a-4f9c-b3da-e5d4ea08c55a"],
     "grouping": "0020,000D",
     "timeout": 5,
-    "ignoredSopClasses": ["1.2.840.10008.5.1.4.1.1.1.1"]
+    "ignoredSopClasses": ["1.2.840.10008.5.1.4.1.1.1.1"],
+    "allowedSopClasses": ["1.2.840.10008.5.1.4.1.1.1.2"]
   },
   {
     "name": "liver-seg",

src/Api/MonaiApplicationEntity.cs

@@ -26,6 +26,7 @@ namespace Monai.Deploy.InformaticsGateway.Api
     ///     "workflows": [ "EXAM", "Delta", "b75cd27a-068a-4f9c-b3da-e5d4ea08c55a"],
     ///     "grouping": [ "0010,0020"],
     ///     "ignoredSopClasses": ["1.2.840.10008.5.1.4.1.1.1.1"],
+    ///     "allowedSopClasses": ["1.2.840.10008.5.1.4.1.1.1.2"],
     ///     "timeout": 300
     /// }
     /// </code>
@@ -58,9 +59,16 @@ public class MonaiApplicationEntity
 
         /// <summary>
         /// Optional field to specify SOP Class UIDs to ignore.
+        /// <see cref="IgnoredSopClasses"/> and <see cref="AllowedSopClasses"/> are mutually exclusive.
         /// </summary>
         public List<string> IgnoredSopClasses { get; set; }
 
+        /// <summary>
+        /// Optional field to specify accepted SOP Class UIDs.
+        /// <see cref="IgnoredSopClasses"/> and <see cref="AllowedSopClasses"/> are mutually exclusive.
+        /// </summary>
+        public List<string> AllowedSopClasses { get; set; }
+
         /// <summary>
         /// Timeout, in seconds, to wait for instances before notifying other subsystems of data arrival
         /// for the specified data group.
@@ -89,6 +97,11 @@ public void SetDefaultValues()
             {
                 IgnoredSopClasses = new List<string>();
             }
+
+            if (AllowedSopClasses is null)
+            {
+                AllowedSopClasses = new List<string>();
+            }
         }
     }
 }

src/CLI/Commands/AetCommand.cs

@@ -4,7 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.CommandLine;
-using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.CommandLine.Rendering;
 using System.CommandLine.Rendering.Views;
 using System.Linq;
@@ -65,20 +65,24 @@ private void SetupAddAetCommand()
             addCommand.AddOption(groupingOption);
             var timeoutOption = new Option<uint>(new string[] { "-t", "--timeout" }, getDefaultValue: () => 5, "Timeout, in seconds, to wait for instances") { IsRequired = false };
             addCommand.AddOption(timeoutOption);
-            var workflowsOption = new Option<string[]>(new string[] { "-w", "--workflows" }, () => Array.Empty<string>(), "A space separated list of workflow names or IDs to be associated with the SCP AE Title")
+            var workflowsOption = new Option<List<string>>(new string[] { "-w", "--workflows" }, description: "A space separated list of workflow names or IDs to be associated with the SCP AE Title")
             {
                 AllowMultipleArgumentsPerToken = true,
                 IsRequired = false,
-                Name = "--workflows"
             };
             addCommand.AddOption(workflowsOption);
-            var ignoredSopsOption = new Option<string[]>(new string[] { "-i", "--ignored-sops" }, () => Array.Empty<string>(), "A space separated list of SOP Class UIDs to be ignoredS")
+            var ignoredSopsOption = new Option<List<string>>(new string[] { "-i", "--ignored-sop-classes" }, description: "A space separated list of SOP Class UIDs to be ignored")
             {
                 AllowMultipleArgumentsPerToken = true,
                 IsRequired = false,
-                Name = "--ignored-sops"
             };
             addCommand.AddOption(ignoredSopsOption);
+            var allowedSopsOption = new Option<List<string>>(new string[] { "-s", "--allowed-sop-classes" }, description: "A space separated list of SOP Class UIDs to be accepted")
+            {
+                AllowMultipleArgumentsPerToken = true,
+                IsRequired = false,
+            };
+            addCommand.AddOption(allowedSopsOption);
 
             addCommand.Handler = CommandHandler.Create<MonaiApplicationEntity, IHost, bool, CancellationToken>(AddAeTitlehandlerAsync);
         }
@@ -139,8 +143,14 @@ private async Task<int> ListAeTitlehandlerAsync(IHost host, bool verbose, Cancel
                 };
                 table.AddColumn(p => p.Name, new ContentView("Name".Underline()));
                 table.AddColumn(p => p.AeTitle, new ContentView("AE Title".Underline()));
+                table.AddColumn(p => p.Timeout, new ContentView("Timeout".Underline()));
+                table.AddColumn(p => p.Grouping, new ContentView("Grouping".Underline()));
                 table.AddColumn(p => p.Workflows.IsNullOrEmpty() ? "n/a" : string.Join(", ", p.Workflows), new ContentView("Workflows".Underline()));
+                table.AddColumn(p => p.AllowedSopClasses.IsNullOrEmpty() ? "n/a" : string.Join(", ", p.AllowedSopClasses), new ContentView("Accepted SOP Classes".Underline()));
+                table.AddColumn(p => p.IgnoredSopClasses.IsNullOrEmpty() ? "n/a" : string.Join(", ", p.IgnoredSopClasses), new ContentView("Ignored SOP Classes".Underline()));
                 table.Render(consoleRenderer, consoleRegion.GetDefaultConsoleRegion());
+
+                logger.ListedNItems(items.Count);
             }
             return ExitCodes.Success;
         }
@@ -213,7 +223,12 @@ private async Task<int> AddAeTitlehandlerAsync(MonaiApplicationEntity entity, IH
                 if (result.IgnoredSopClasses.Any())
                 {
                     logger.MonaiAeIgnoredSops(string.Join(',', result.IgnoredSopClasses));
-                    logger.IgnoreSopClassesWarning();
+                    logger.IgnoredSopClassesWarning();
+                }
+                if (result.AllowedSopClasses.Any())
+                {
+                    logger.MonaiAeAllowedSops(string.Join(',', result.AllowedSopClasses));
+                    logger.AcceptedSopClassesWarning();
                 }
             }
             catch (ConfigurationException ex)

src/CLI/Commands/ConfigCommand.cs

@@ -3,7 +3,7 @@
 
 using System;
 using System.CommandLine;
-using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.Threading;
 using System.Threading.Tasks;
 using Ardalis.GuardClauses;

src/CLI/Commands/DestinationCommand.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.CommandLine;
 using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.CommandLine.Rendering;
 using System.CommandLine.Rendering.Views;
 using System.Linq;
@@ -130,6 +131,8 @@ private async Task<int> ListDestinationHandlerAsync(DestinationApplicationEntity
                 table.AddColumn(p => p.HostIp, new ContentView("Host/IP Address".Underline()));
                 table.AddColumn(p => p.Port, new ContentView("Port".Underline()));
                 table.Render(consoleRenderer, consoleRegion.GetDefaultConsoleRegion());
+
+                logger.ListedNItems(items.Count);
             }
             return ExitCodes.Success;
         }

src/CLI/Commands/RestartCommand.cs

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache License 2.0
 
 using System;
-using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.Threading;
 using System.Threading.Tasks;
 using Ardalis.GuardClauses;

src/CLI/Commands/SourceCommand.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.CommandLine;
 using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.CommandLine.Rendering;
 using System.CommandLine.Rendering.Views;
 using System.Linq;
@@ -126,6 +127,8 @@ private async Task<int> ListSourceHandlerAsync(SourceApplicationEntity entity, I
                 table.AddColumn(p => p.AeTitle, new ContentView("AE Title".Underline()));
                 table.AddColumn(p => p.HostIp, new ContentView("Host/IP Address".Underline()));
                 table.Render(consoleRenderer, consoleRegion.GetDefaultConsoleRegion());
+
+                logger.ListedNItems(items.Count);
             }
             return ExitCodes.Success;
         }

src/CLI/Commands/StartCommand.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.Threading;
 using System.Threading.Tasks;
 using Ardalis.GuardClauses;

src/CLI/Commands/StatusCommand.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.Threading;
 using System.Threading.Tasks;
 using Ardalis.GuardClauses;

src/CLI/Commands/StopCommand.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.CommandLine.Invocation;
+using System.CommandLine.NamingConventionBinder;
 using System.Threading;
 using System.Threading.Tasks;
 using Ardalis.GuardClauses;

src/CLI/Logging/Log.cs

@@ -34,7 +34,7 @@ public static partial class Log
         public static partial void MonaiAeIgnoredSops(this ILogger logger, string ignoredSopClasses);
 
         [LoggerMessage(EventId = 30014, Level = LogLevel.Warning, Message = "Instances with matching SOP class UIDs are accepted but dropped.")]
-        public static partial void IgnoreSopClassesWarning(this ILogger logger);
+        public static partial void IgnoredSopClassesWarning(this ILogger logger);
 
         [LoggerMessage(EventId = 30015, Level = LogLevel.Critical, Message = "Error creating MONAI SCP AE Title {aeTitle}: {message}.")]
         public static partial void MonaiAeCreateCritical(this ILogger logger, string aeTitle, string message);
@@ -111,7 +111,7 @@ public static partial class Log
         [LoggerMessage(EventId = 30040, Level = LogLevel.Information, Message = "\t\t{name}: {status}")]
         public static partial void ServiceStatusItem(this ILogger logger, string name, ServiceStatus status);
 
-        [LoggerMessage(EventId = 30041, Level = LogLevel.Warning, Message = "Action cancelled.")]
+        [LoggerMessage(EventId = 30041, Level = LogLevel.Warning, Message = "Action canceled.")]
         public static partial void ActionCancelled(this ILogger logger);
 
         [LoggerMessage(EventId = 30042, Level = LogLevel.Critical, Message = "Error restarting {applicationName}: {message}.")]
@@ -138,6 +138,18 @@ public static partial class Log
         [LoggerMessage(EventId = 30049, Level = LogLevel.Information, Message = "Configuration updated successfully.")]
         public static partial void ConfigurationUpdated(this ILogger logger);
 
+        [LoggerMessage(EventId = 30050, Level = LogLevel.Information, Message = "\tAccepted SOP Classes: {alowedSopClasses}")]
+        public static partial void MonaiAeAllowedSops(this ILogger logger, string alowedSopClasses);
+
+        [LoggerMessage(EventId = 30051, Level = LogLevel.Warning, Message = "Instances without matching SOP class UIDs are accepted but dropped.")]
+        public static partial void AllowedSopClassesWarning(this ILogger logger);
+
+        [LoggerMessage(EventId = 30052, Level = LogLevel.Warning, Message = "Only instances with matching SOP class UIDs are accepted and stored.")]
+        public static partial void AcceptedSopClassesWarning(this ILogger logger);
+
+        [LoggerMessage(EventId = 30053, Level = LogLevel.Information, Message = "\n\nFound {count} items.")]
+        public static partial void ListedNItems(this ILogger logger, int count);
+
         // Docker Runner
         [LoggerMessage(EventId = 31000, Level = LogLevel.Debug, Message = "Checking for existing {applicationName} ({version}) containers...")]
         public static partial void CheckingExistingAppContainer(this ILogger logger, string applicationName, string version);

src/CLI/Monai.Deploy.InformaticsGateway.CLI.csproj

@@ -12,7 +12,7 @@ SPDX-License-Identifier: Apache License 2.0
     <SelfContained>true</SelfContained>
     <PublishTrimmed>false</PublishTrimmed>
     <PublishReadyToRun>true</PublishReadyToRun>
-    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
+    <RuntimeIdentifier>linux-x64</RuntimeIdentifier>
     <RuntimeIdentifiers>win-x64;linux-x64</RuntimeIdentifiers>
     <AssemblyName>mig-cli</AssemblyName>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
@@ -48,9 +48,9 @@ SPDX-License-Identifier: Apache License 2.0
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="6.0.0" />
-    <PackageReference Include="System.CommandLine" Version="2.0.0-beta1.21308.1" />
-    <PackageReference Include="System.CommandLine.Hosting" Version="0.3.0-alpha.21216.1" />
-    <PackageReference Include="System.CommandLine.Rendering" Version="0.3.0-alpha.21216.1" />
+    <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
+    <PackageReference Include="System.CommandLine.Hosting" Version="0.4.0-alpha.22272.1" />
+    <PackageReference Include="System.CommandLine.Rendering" Version="0.4.0-alpha.22272.1" />
     <PackageReference Include="System.IO.Abstractions" Version="17.0.18" />
   </ItemGroup>
 </Project>

src/CLI/Program.cs

@@ -29,15 +29,15 @@ private static async Task<int> Main(string[] args)
         internal static Parser BuildParser()
         {
             var verboseOption = new Option<bool>(new[] { "--verbose", "-v" }, () => false, "Show verbose output");
-            return new CommandLineBuilder(new RootCommand($"{Strings.ApplicationName} CLI"))
+            var commandLineBuilder = new CommandLineBuilder(new RootCommand($"{Strings.ApplicationName} CLI"))
                         .UseHost(
                             _ => Host.CreateDefaultBuilder(),
                             host =>
                             {
                                 _ = host.ConfigureLogging((context, logging) =>
                                 {
                                     var invocationContext = context.GetInvocationContext();
-                                    var verboseEnabled = invocationContext.ParseResult.ValueForOption(verboseOption);
+                                    var verboseEnabled = invocationContext.ParseResult.GetValueForOption(verboseOption);
                                     logging.ClearProviders();
 
                                     _ = logging.AddInformaticsGatewayConsole(options => options.MinimumLogLevel = verboseEnabled ? LogLevel.Trace : LogLevel.Information)
@@ -60,22 +60,22 @@ internal static Parser BuildParser()
                                     services.AddTransient<IDockerClient>(p => new DockerClientConfiguration().CreateClient());
                                 });
                             })
-                        .AddGlobalOption(verboseOption)
-                        .AddCommand(new ConfigCommand())
-                        .AddCommand(new StartCommand())
-                        .AddCommand(new StopCommand())
-                        .AddCommand(new RestartCommand())
-                        .AddCommand(new AetCommand())
-                        .AddCommand(new SourceCommand())
-                        .AddCommand(new DestinationCommand())
-                        .AddCommand(new StatusCommand())
                         .UseAnsiTerminalWhenAvailable()
                         .UseExceptionHandler((exception, context) =>
                         {
                             Console.Out.WriteLineAsync(Crayon.Output.Bright.Red($"Exception: {exception.Message}"));
                         })
-                        .UseDefaults()
-                        .Build();
+                        .UseDefaults();
+            commandLineBuilder.Command.AddGlobalOption(verboseOption);
+            commandLineBuilder.Command.AddCommand(new ConfigCommand());
+            commandLineBuilder.Command.AddCommand(new StartCommand());
+            commandLineBuilder.Command.AddCommand(new StopCommand());
+            commandLineBuilder.Command.AddCommand(new RestartCommand());
+            commandLineBuilder.Command.AddCommand(new AetCommand());
+            commandLineBuilder.Command.AddCommand(new SourceCommand());
+            commandLineBuilder.Command.AddCommand(new DestinationCommand());
+            commandLineBuilder.Command.AddCommand(new StatusCommand());
+            return commandLineBuilder.Build();
         }
     }
 }

src/CLI/Test/AetCommandTest.cs

@@ -53,8 +53,8 @@ public AetCommandTest()
                             services.AddSingleton<IInformaticsGatewayClient>(p => _informaticsGatewayClient.Object);
                             services.AddSingleton<IConfigurationService>(p => _configurationService.Object);
                         });
-                    })
-                .AddCommand(new AetCommand());
+                    });
+            _commandLineBuilder.Command.AddCommand(new AetCommand());
             _paser = _commandLineBuilder.Build();
 
             _loggerFactory.Setup(p => p.CreateLogger(It.IsAny<string>())).Returns(_logger.Object);
@@ -110,6 +110,54 @@ public async Task AetAdd_Command()
                     It.IsAny<CancellationToken>()), Times.Once());
         }
 
+        [Fact(DisplayName = "aet add comand with allowed & ignored SOP classes")]
+        public async Task AetAdd_Command_AllowedIgnoredSopClasses()
+        {
+            var command = "aet add -n MyName -a MyAET --workflows App MyCoolApp TheApp -i A B C -s D E F";
+            var result = _paser.Parse(command);
+            Assert.Equal(ExitCodes.Success, result.Errors.Count);
+
+            var entity = new MonaiApplicationEntity()
+            {
+                Name = result.CommandResult.Children[0].Tokens[0].Value,
+                AeTitle = result.CommandResult.Children[1].Tokens[0].Value,
+                Workflows = result.CommandResult.Children[2].Tokens.Select(p => p.Value).ToList(),
+                IgnoredSopClasses = result.CommandResult.Children[3].Tokens.Select(p => p.Value).ToList(),
+                AllowedSopClasses = result.CommandResult.Children[4].Tokens.Select(p => p.Value).ToList(),
+            };
+            Assert.Equal("MyName", entity.Name);
+            Assert.Equal("MyAET", entity.AeTitle);
+            Assert.Collection(entity.Workflows,
+                item => item.Equals("App"),
+                item => item.Equals("MyCoolApp"),
+                item => item.Equals("TheApp"));
+            Assert.Collection(entity.AllowedSopClasses,
+                item => item.Equals("D"),
+                item => item.Equals("E"),
+                item => item.Equals("F"));
+            Assert.Collection(entity.IgnoredSopClasses,
+                item => item.Equals("A"),
+                item => item.Equals("B"),
+                item => item.Equals("C"));
+
+            _informaticsGatewayClient.Setup(p => p.MonaiScpAeTitle.Create(It.IsAny<MonaiApplicationEntity>(), It.IsAny<CancellationToken>()))
+                .ReturnsAsync(entity);
+
+            int exitCode = await _paser.InvokeAsync(command);
+
+            Assert.Equal(ExitCodes.Success, exitCode);
+
+            _informaticsGatewayClient.Verify(p => p.ConfigureServiceUris(It.IsAny<Uri>()), Times.Once());
+            _informaticsGatewayClient.Verify(
+                p => p.MonaiScpAeTitle.Create(
+                    It.Is<MonaiApplicationEntity>(o => o.AeTitle == entity.AeTitle &&
+                                                        o.Name == entity.Name &&
+                                                        Enumerable.SequenceEqual(o.Workflows, entity.Workflows) &&
+                                                        Enumerable.SequenceEqual(o.AllowedSopClasses, entity.AllowedSopClasses) &&
+                                                        Enumerable.SequenceEqual(o.IgnoredSopClasses, entity.IgnoredSopClasses)),
+                    It.IsAny<CancellationToken>()), Times.Once());
+        }
+
         [Fact(DisplayName = "aet add comand exception")]
         public async Task AetAdd_Command_Exception()
         {