rename: prefix gateway projects/namespaces with ZB.MOM.WW + sln→slnx
Apply the ZB.MOM.WW. prefix to all gateway-side projects, folders,
.csproj/.sln contents, C# namespaces, using directives, generated proto
C# (csharp_namespace + checked-in generated files), InternalsVisibleTo
attributes, project-name string literals (LoadProject, .sln lookups,
worker exe paths, staticwebassets manifest), and the install/script/doc
references that point at any of the above. Migrate the solution from
.sln to .slnx via `dotnet sln migrate` and delete the old file.
External-runtime identifiers are intentionally NOT prefixed so external
configuration keeps working:
- GatewayMetrics.cs MeterName ("MxGateway.Server")
- DashboardAuthenticationDefaults Scheme/Policy ("MxGateway.Dashboard")
- GatewayRequestLoggingMiddleware logger category ("MxGateway.Request")
- StaRuntime thread name ("MxGateway.Worker.STA")
- appsettings.json root section "MxGateway" + env-var prefix
MxGateway__... and secret-name MxGateway:ApiKeyPepper
- C:\ProgramData\MxGateway\ data dir paths
Also fixes two tests that were not rename-related but became visible
while validating the rename:
- WorkerLiveMxAccessSmokeTests.ShutDownAsync: cancellation that the
gateway service correctly maps to RpcException(Cancelled) per gRPC
convention was being misclassified as a stream fault. Added a sibling
catch on RpcException with StatusCode.Cancelled.
- IntegrationTestEnvironment.ResolveRepositoryRoot: extracted IsRepositoryRoot
and made it accept either a .git marker OR a .sln/.slnx next to src/
so the worker-exe walker works in non-git working copies.
clients/proto/proto-inputs.json's protoRoot updated to point at
src/ZB.MOM.WW.MxGateway.Contracts/Protos.
Verified by `dotnet build` and a full `dotnet test` of the .slnx with
MXGATEWAY_RUN_LIVE_{MXACCESS,LDAP,GALAXY}_TESTS=1:
Tests: 472/472 pass
Worker.Tests: 280/280 pass (4 dev-rig [Fact(Skip=...)] skipped)
IntegrationTests: 18/18 pass
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,107 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Xml.Linq;
|
||||
|
||||
namespace ZB.MOM.WW.MxGateway.Worker.Tests.ProjectStructure;
|
||||
|
||||
public sealed class WorkerProjectReferenceTests
|
||||
{
|
||||
/// <summary>Verifies that the worker project targets .NET Framework 4.8 with x86 platform.</summary>
|
||||
[Fact]
|
||||
public void WorkerProject_TargetsNet48AndX86()
|
||||
{
|
||||
XDocument project = LoadProject("ZB.MOM.WW.MxGateway.Worker");
|
||||
|
||||
Assert.Equal("net48", ElementValue(project, "TargetFramework"));
|
||||
Assert.Equal("x86", ElementValue(project, "PlatformTarget"));
|
||||
Assert.Equal("true", ElementValue(project, "Prefer32Bit"));
|
||||
}
|
||||
|
||||
/// <summary>Verifies that the worker test project targets .NET Framework 4.8 with x86 platform.</summary>
|
||||
[Fact]
|
||||
public void WorkerTestProject_TargetsNet48AndX86()
|
||||
{
|
||||
XDocument project = LoadProject("ZB.MOM.WW.MxGateway.Worker.Tests");
|
||||
|
||||
Assert.Equal("net48", ElementValue(project, "TargetFramework"));
|
||||
Assert.Equal("x86", ElementValue(project, "PlatformTarget"));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Verifies that the MXAccess COM interop is referenced only by the
|
||||
/// worker project and its test project — never by the gateway server
|
||||
/// or the contracts project. The gateway must never load MXAccess COM
|
||||
/// directly (see <c>gateway.md</c>); the worker test project
|
||||
/// legitimately references the interop so it can exercise the
|
||||
/// COM-facing worker code (e.g. <c>WnWrapAlarmConsumer</c>).
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void MxAccessInteropReference_ExistsOnlyInWorkerAndWorkerTestProjects()
|
||||
{
|
||||
DirectoryInfo repositoryRoot = FindRepositoryRoot();
|
||||
string[] projectFiles = Directory.GetFiles(repositoryRoot.FullName, "*.csproj", SearchOption.AllDirectories)
|
||||
.Where(path => path.IndexOf($"{Path.DirectorySeparatorChar}bin{Path.DirectorySeparatorChar}", StringComparison.OrdinalIgnoreCase) < 0)
|
||||
.Where(path => path.IndexOf($"{Path.DirectorySeparatorChar}obj{Path.DirectorySeparatorChar}", StringComparison.OrdinalIgnoreCase) < 0)
|
||||
.ToArray();
|
||||
|
||||
IReadOnlyList<string> projectsWithMxAccessReference = projectFiles
|
||||
.Where(ProjectReferencesMxAccess)
|
||||
.Select(path => Path.GetFileNameWithoutExtension(path))
|
||||
.OrderBy(name => name, StringComparer.Ordinal)
|
||||
.ToArray();
|
||||
|
||||
Assert.Equal(
|
||||
["ZB.MOM.WW.MxGateway.Worker", "ZB.MOM.WW.MxGateway.Worker.Tests"],
|
||||
projectsWithMxAccessReference);
|
||||
}
|
||||
|
||||
private static bool ProjectReferencesMxAccess(string projectPath)
|
||||
{
|
||||
XDocument project = XDocument.Load(projectPath);
|
||||
|
||||
return project
|
||||
.Descendants()
|
||||
.Where(element => element.Name.LocalName is "Reference" or "COMReference" or "COMFileReference" or "PackageReference")
|
||||
.Select(element => (string?)element.Attribute("Include") ?? string.Empty)
|
||||
.Concat(project.Descendants().Where(element => element.Name.LocalName == "HintPath").Select(element => element.Value))
|
||||
.Any(reference =>
|
||||
reference.IndexOf("MxAccess", StringComparison.OrdinalIgnoreCase) >= 0
|
||||
|| reference.IndexOf("ArchestrA.MXAccess", StringComparison.OrdinalIgnoreCase) >= 0
|
||||
|| reference.IndexOf("LMXProxy", StringComparison.OrdinalIgnoreCase) >= 0);
|
||||
}
|
||||
|
||||
private static XDocument LoadProject(string projectName)
|
||||
{
|
||||
DirectoryInfo repositoryRoot = FindRepositoryRoot();
|
||||
string projectPath = Path.Combine(repositoryRoot.FullName, projectName, $"{projectName}.csproj");
|
||||
|
||||
return XDocument.Load(projectPath);
|
||||
}
|
||||
|
||||
private static string ElementValue(XDocument project, string elementName)
|
||||
{
|
||||
return project
|
||||
.Descendants()
|
||||
.Single(element => element.Name.LocalName == elementName)
|
||||
.Value;
|
||||
}
|
||||
|
||||
private static DirectoryInfo FindRepositoryRoot()
|
||||
{
|
||||
DirectoryInfo? current = new(AppContext.BaseDirectory);
|
||||
|
||||
while (current is not null)
|
||||
{
|
||||
if (File.Exists(Path.Combine(current.FullName, "ZB.MOM.WW.MxGateway.slnx")))
|
||||
{
|
||||
return current;
|
||||
}
|
||||
|
||||
current = current.Parent;
|
||||
}
|
||||
|
||||
throw new DirectoryNotFoundException("Could not locate src/ZB.MOM.WW.MxGateway.slnx from the test output directory.");
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user