dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat(cli): notification smtp update --transport smtp|ews

Browse Source
This commit is contained in:
Joseph Doherty
2026-08-10 06:35:33 -04:00
parent 4e633b1e64
commit 0fe1972960
2 changed files with 64 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ZB.MOM.WW.ScadaBridge.CLI/Commands/NotificationCommands.cs
+19 -3
View File
@@ -144,6 +144,7 @@ public static class NotificationCommands
updateCmd.Add(SmtpCredentialsOption);
updateCmd.Add(SmtpOAuth2AuthorityOption);
updateCmd.Add(SmtpOAuth2ScopeOption);
updateCmd.Add(SmtpTransportOption);
updateCmd.SetAction(async (ParseResult result) =>
{
return await CommandHelpers.ExecuteCommandAsync(
@@ -187,6 +188,20 @@ public static class NotificationCommands
"(optional; preserves existing / M365 default if omitted)",
};
private static readonly Option<string?> SmtpTransportOption = CreateTransportOption();
private static Option<string?> CreateTransportOption()
{
var option = new Option<string?>("--transport")
{
Description = "Email transport: Smtp or Ews (optional; preserves existing if omitted). " +
"Under Ews, --server is the full EWS URL (https://…/ews/exchange.asmx), " +
"--auth-mode must be basic, and --port/--tls-mode are unused.",
};
option.AcceptOnlyFromAmong("Smtp", "Ews");
return option;
}
private static Option<string?> CreateTlsModeOption()
{
var option = new Option<string?>("--tls-mode")
@@ -200,8 +215,8 @@ public static class NotificationCommands
/// <summary>
/// Builds the <see cref="UpdateSmtpConfigCommand"/> from a parsed <c>smtp update</c>
/// invocation. The optional <c>--tls-mode</c> / <c>--credentials</c> /
/// <c>--oauth2-authority</c> / <c>--oauth2-scope</c> flags map to null when omitted
/// so the server-side handler preserves the existing values.
/// <c>--oauth2-authority</c> / <c>--oauth2-scope</c> / <c>--transport</c> flags map to
/// null when omitted so the server-side handler preserves the existing values.
/// </summary>
/// <param name="result">The parsed command-line result from the <c>smtp update</c> invocation.</param>
/// <returns>An <see cref="UpdateSmtpConfigCommand"/> populated from the parsed result.</returns>
@@ -216,7 +231,8 @@ public static class NotificationCommands
var credentials = result.GetValue(SmtpCredentialsOption);
var oauth2Authority = result.GetValue(SmtpOAuth2AuthorityOption);
var oauth2Scope = result.GetValue(SmtpOAuth2ScopeOption);
return new UpdateSmtpConfigCommand(id, server, port, authMode, from, tlsMode, credentials, oauth2Authority, oauth2Scope);
var transport = result.GetValue(SmtpTransportOption);
return new UpdateSmtpConfigCommand(id, server, port, authMode, from, tlsMode, credentials, oauth2Authority, oauth2Scope, transport);
}
private static Command BuildSms(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
tests/ZB.MOM.WW.ScadaBridge.CLI.Tests/Commands/SmtpUpdateCommandTests.cs
+45 -4
View File
@@ -6,10 +6,11 @@ namespace ZB.MOM.WW.ScadaBridge.CLI.Tests.Commands;
/// <summary>
/// Tests for the <c>scadabridge notification smtp update</c> subcommand. The command
/// gained two optional flags — <c>--tls-mode</c> and <c>--credentials</c> — that plumb
/// through to <see cref="UpdateSmtpConfigCommand"/>. These tests pin that the flags
/// parse, are genuinely optional (non-breaking), and that <c>--tls-mode</c> rejects
/// values outside the canonical {None, StartTLS, SSL} set.
/// gained optional flags — <c>--tls-mode</c>, <c>--credentials</c> and <c>--transport</c> —
/// that plumb through to <see cref="UpdateSmtpConfigCommand"/>. These tests pin that the
/// flags parse, are genuinely optional (non-breaking), that <c>--tls-mode</c> rejects
/// values outside the canonical {None, StartTLS, SSL} set, and that <c>--transport</c>
/// rejects values outside {Smtp, Ews}.
/// </summary>
public class SmtpUpdateCommandTests
{
@@ -91,6 +92,46 @@ public class SmtpUpdateCommandTests
Assert.NotEmpty(parse.Errors);
}
[Fact]
public void Update_WithTransportEws_ProducesCommandCarryingIt()
{
var parse = ParseUpdate(
"--id", "1", "--server", "https://mail.example.com/ews/exchange.asmx", "--port", "443",
"--auth-mode", "Basic", "--from-address", "noreply@example.com",
"--transport", "Ews");
Assert.Empty(parse.Errors);
var cmd = NotificationCommands.BuildUpdateSmtpConfigCommand(parse);
Assert.Equal("Ews", cmd.Transport);
}
[Fact]
public void Update_WithoutTransport_ProducesCommandWithNullTransport()
{
var parse = ParseUpdate(
"--id", "2", "--server", "smtp.example.com", "--port", "25",
"--auth-mode", "Basic", "--from-address", "noreply@example.com");
Assert.Empty(parse.Errors);
var cmd = NotificationCommands.BuildUpdateSmtpConfigCommand(parse);
Assert.Null(cmd.Transport);
}
[Theory]
[InlineData("Graph")]
[InlineData("ews")] // AcceptOnlyFromAmong is case-sensitive: constrain to canonical spelling
public void Update_TransportOption_RejectsValuesOutsideCanonicalSet(string value)
{
var parse = ParseUpdate(
"--id", "1", "--server", "smtp.example.com", "--port", "587",
"--auth-mode", "Basic", "--from-address", "noreply@example.com",
"--transport", value);
Assert.NotEmpty(parse.Errors);
}
[Fact]
public void Update_TlsModeAndCredentials_AreNotRequired()
{