dohertj2/scadalink-design
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add HTTP Management API, migrate CLI from Akka ClusterClient to HTTP

Browse Source 
Replace the CLI's Akka.NET ClusterClient transport with a simple HTTP client
targeting a new POST /management endpoint on the Central Host. The endpoint
handles Basic Auth, LDAP authentication, role resolution, and ManagementActor
dispatch in a single round-trip — eliminating the CLI's Akka, LDAP, and
Security dependencies.

Also fixes DCL ReSubscribeAll losing subscriptions on repeated reconnect by
deriving the tag list from _subscriptionsByInstance instead of _subscriptionIds.
This commit is contained in:
Joseph Doherty
2026-03-20 23:55:31 -04:00
parent 7740a3bcf9
commit 1a540f4f0a
38 changed files with 863 additions and 758 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
tests/ScadaLink.CLI.Tests/CliConfigTests.cs
View File

@@ -5,68 +5,43 @@ namespace ScadaLink.CLI.Tests;
public class CliConfigTests
{
[Fact]
public void Load_DefaultValues_WhenNoConfigExists()
public void Load_DefaultFormat_IsJson()
{
// Clear environment variables that might affect the test
var origContact = Environment.GetEnvironmentVariable("SCADALINK_CONTACT_POINTS");
var origLdap = Environment.GetEnvironmentVariable("SCADALINK_LDAP_SERVER");
var origUrl = Environment.GetEnvironmentVariable("SCADALINK_MANAGEMENT_URL");
var origFormat = Environment.GetEnvironmentVariable("SCADALINK_FORMAT");
try
{
Environment.SetEnvironmentVariable("SCADALINK_CONTACT_POINTS", null);
Environment.SetEnvironmentVariable("SCADALINK_LDAP_SERVER", null);
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", null);
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", null);
var config = CliConfig.Load();
Assert.Equal(636, config.LdapPort);
Assert.True(config.LdapUseTls);
// DefaultFormat is always "json" unless overridden by config file or env var
Assert.Equal("json", config.DefaultFormat);
}
finally
{
Environment.SetEnvironmentVariable("SCADALINK_CONTACT_POINTS", origContact);
Environment.SetEnvironmentVariable("SCADALINK_LDAP_SERVER", origLdap);
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", origUrl);
Environment.SetEnvironmentVariable("SCADALINK_FORMAT", origFormat);
}
}
[Fact]
public void Load_ContactPoints_FromEnvironment()
public void Load_ManagementUrl_FromEnvironment()
{
var orig = Environment.GetEnvironmentVariable("SCADALINK_CONTACT_POINTS");
var orig = Environment.GetEnvironmentVariable("SCADALINK_MANAGEMENT_URL");
try
{
Environment.SetEnvironmentVariable("SCADALINK_CONTACT_POINTS", "host1:8080,host2:8080");
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", "http://central:5000");
var config = CliConfig.Load();
Assert.Equal(2, config.ContactPoints.Count);
Assert.Equal("host1:8080", config.ContactPoints[0]);
Assert.Equal("host2:8080", config.ContactPoints[1]);
Assert.Equal("http://central:5000", config.ManagementUrl);
}
finally
{
Environment.SetEnvironmentVariable("SCADALINK_CONTACT_POINTS", orig);
}
}
[Fact]
public void Load_LdapServer_FromEnvironment()
{
var orig = Environment.GetEnvironmentVariable("SCADALINK_LDAP_SERVER");
try
{
Environment.SetEnvironmentVariable("SCADALINK_LDAP_SERVER", "ldap.example.com");
var config = CliConfig.Load();
Assert.Equal("ldap.example.com", config.LdapServer);
}
finally
{
Environment.SetEnvironmentVariable("SCADALINK_LDAP_SERVER", orig);
Environment.SetEnvironmentVariable("SCADALINK_MANAGEMENT_URL", orig);
}
}

63
tests/ScadaLink.CLI.Tests/CommandHelpersTests.cs
View File

@@ -1,17 +1,17 @@
using ScadaLink.CLI;
using ScadaLink.CLI.Commands;
using ScadaLink.Commons.Messages.Management;
namespace ScadaLink.CLI.Tests;
public class CommandHelpersTests
{
[Fact]
public void HandleResponse_ManagementSuccess_JsonFormat_ReturnsZero()
public void HandleResponse_Success_JsonFormat_ReturnsZero()
{
var writer = new StringWriter();
Console.SetOut(writer);
var response = new ManagementSuccess("corr-1", "{\"id\":1,\"name\":\"test\"}");
var response = new ManagementResponse(200, "{\"id\":1,\"name\":\"test\"}", null, null);
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(0, exitCode);
@@ -21,13 +21,13 @@ public class CommandHelpersTests
}
[Fact]
public void HandleResponse_ManagementSuccess_TableFormat_ArrayData_ReturnsZero()
public void HandleResponse_Success_TableFormat_ArrayData_ReturnsZero()
{
var writer = new StringWriter();
Console.SetOut(writer);
var json = "[{\"Id\":1,\"Name\":\"Alpha\"},{\"Id\":2,\"Name\":\"Beta\"}]";
var response = new ManagementSuccess("corr-1", json);
var response = new ManagementResponse(200, json, null, null);
var exitCode = CommandHelpers.HandleResponse(response, "table");
Assert.Equal(0, exitCode);
@@ -41,13 +41,13 @@ public class CommandHelpersTests
}
[Fact]
public void HandleResponse_ManagementSuccess_TableFormat_ObjectData_ReturnsZero()
public void HandleResponse_Success_TableFormat_ObjectData_ReturnsZero()
{
var writer = new StringWriter();
Console.SetOut(writer);
var json = "{\"Id\":1,\"Name\":\"Alpha\",\"Status\":\"Active\"}";
var response = new ManagementSuccess("corr-1", json);
var response = new ManagementResponse(200, json, null, null);
var exitCode = CommandHelpers.HandleResponse(response, "table");
Assert.Equal(0, exitCode);
@@ -61,12 +61,12 @@ public class CommandHelpersTests
}
[Fact]
public void HandleResponse_ManagementSuccess_TableFormat_EmptyArray_ShowsNoResults()
public void HandleResponse_Success_TableFormat_EmptyArray_ShowsNoResults()
{
var writer = new StringWriter();
Console.SetOut(writer);
var response = new ManagementSuccess("corr-1", "[]");
var response = new ManagementResponse(200, "[]", null, null);
var exitCode = CommandHelpers.HandleResponse(response, "table");
Assert.Equal(0, exitCode);
@@ -76,12 +76,12 @@ public class CommandHelpersTests
}
[Fact]
public void HandleResponse_ManagementError_ReturnsOne()
public void HandleResponse_Error_ReturnsOne()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementError("corr-1", "Something failed", "FAIL_CODE");
var response = new ManagementResponse(400, null, "Something failed", "FAIL_CODE");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
@@ -91,12 +91,12 @@ public class CommandHelpersTests
}
[Fact]
public void HandleResponse_ManagementUnauthorized_ReturnsTwo()
public void HandleResponse_Unauthorized_ReturnsTwo()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementUnauthorized("corr-1", "Access denied");
var response = new ManagementResponse(403, null, "Access denied", "UNAUTHORIZED");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(2, exitCode);
@@ -106,26 +106,47 @@ public class CommandHelpersTests
}
[Fact]
public void HandleResponse_UnexpectedType_ReturnsOne()
public void HandleResponse_AuthFailure_ReturnsOne()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var exitCode = CommandHelpers.HandleResponse("unexpected", "json");
var response = new ManagementResponse(401, null, "Invalid credentials", "AUTH_FAILED");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
Assert.Contains("Unexpected response type", errWriter.ToString());
Assert.Contains("Invalid credentials", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
[Fact]
public void NewCorrelationId_ReturnsNonEmpty32CharHex()
public void HandleResponse_ConnectionFailure_ReturnsOne()
{
var id = CommandHelpers.NewCorrelationId();
var errWriter = new StringWriter();
Console.SetError(errWriter);
Assert.NotNull(id);
Assert.Equal(32, id.Length);
Assert.True(id.All(c => "0123456789abcdef".Contains(c)));
var response = new ManagementResponse(0, null, "Connection failed: No such host", "CONNECTION_FAILED");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
Assert.Contains("Connection failed", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
[Fact]
public void HandleResponse_Timeout_ReturnsOne()
{
var errWriter = new StringWriter();
Console.SetError(errWriter);
var response = new ManagementResponse(504, null, "Request timed out.", "TIMEOUT");
var exitCode = CommandHelpers.HandleResponse(response, "json");
Assert.Equal(1, exitCode);
Assert.Contains("timed out", errWriter.ToString());
Console.SetError(new StreamWriter(Console.OpenStandardError()) { AutoFlush = true });
}
}

2
tests/ScadaLink.Commons.Tests/ArchitecturalConstraintTests.cs
View File

@@ -157,6 +157,8 @@ public class ArchitecturalConstraintTests
.Where(t => t.Namespace != null
&& t.Namespace.Contains(".Messages.")
&& !t.IsEnum && !t.IsInterface
&& !(t.IsAbstract && t.IsSealed) // exclude static classes (utilities)
&& !t.Name.StartsWith("<") // exclude compiler-generated types
&& (t.IsClass || (t.IsValueType && !t.IsPrimitive)));
foreach (var type in messageTypes)

2
tests/ScadaLink.Commons.Tests/Messages/MessageConventionTests.cs
View File

@@ -13,6 +13,8 @@ public class MessageConventionTests
&& t.Namespace.Contains(".Messages.")
&& !t.IsEnum
&& !t.IsInterface
&& !(t.IsAbstract && t.IsSealed) // exclude static classes (utilities)
&& !t.Name.StartsWith("<") // exclude compiler-generated types
&& (t.IsClass || (t.IsValueType && !t.IsPrimitive)));
[Fact]