Add interoperability readiness report

Author: ammarheidari

README.md

@@ -34,7 +34,7 @@ The first production milestone is M3UA over a transport abstraction. SCCP, TCAP,
 | TCAP readiness | Foundation readiness report with capability count; external TCAP interoperability vectors and MAP profile validation remain the production gate |
 | MAP | Phase 5 foundation complete: SMS operation metadata, BER context-specific parameter containers, TBCD address primitives, MO/MT-ForwardSM codecs, SendRoutingInfoForSM, ReportSM-DeliveryStatus, AlertServiceCentre, error mapping, extension containers, and TCAP client facade |
 | MAP readiness | Foundation readiness report with capability count; external MAP SMS interoperability vectors and operator-profile validation remain the production gate |
-| Interoperability tooling | Phase 6 started with logger-neutral trace frames, Wireshark-friendly hex dump formatting, conformance vector registry, built-in M3UA/MAP golden vectors, simulator scripts, MAP SMS flow builders, local TCP sample scenarios, sample catalog, and CI verification profile |
+| Interoperability tooling | Phase 6 foundation-ready: trace frames, Wireshark-friendly hex dumps, conformance vectors, built-in M3UA/MAP vectors, simulator scripts, MAP SMS flow builders, local TCP samples, sample catalog, CI profile, and readiness report; production gate is external interoperability lab evidence |
 
 ## Requirements
 

docs/INTEROPERABILITY.md

@@ -89,3 +89,17 @@ The scenario carries M3UA PPID metadata and endpoint names that can be reused by
 | `local-tcp-m3ua` | Development-only TCP adapter traffic |
 
 The catalog is intentionally metadata-only so documentation, tests, examples, and future CI jobs can share the same stable sample ids.
+
+## Readiness Report
+
+`SigtranInteroperabilityReadiness.GetReport()` summarizes the Phase 6 tooling foundation.
+
+```csharp
+SigtranInteroperabilityReadinessReport report = SigtranInteroperabilityReadiness.GetReport();
+bool foundationReady = report.FoundationReady;
+bool productionReady = report.IsProductionReady;
+```
+
+The foundation gate is complete when trace formatting, conformance vectors, built-in vectors, simulator scripts, MAP SMS flows, transport samples, sample catalog, and CI profile are all present.
+
+Production readiness remains false until external interoperability lab evidence is captured against real peer stacks and packet traces.

src/sigtran.net.Tests/Program.cs

@@ -18,6 +18,7 @@
 Run("SIGTRAN local TCP sample describes M3UA transport", SigtranLocalTcpSampleDescribesM3uaTransport);
 Run("SIGTRAN sample catalog exposes supported scenarios", SigtranSampleCatalogExposesSupportedScenarios);
 Run("SIGTRAN CI verification profile exposes official commands", SigtranCiVerificationProfileExposesOfficialCommands);
+Run("SIGTRAN interoperability readiness reports foundation status", SigtranInteroperabilityReadinessReportsFoundationStatus);
 Run("TCAP BER element encodes short and long lengths", TcapBerElementEncodesShortAndLongLengths);
 Run("TCAP transaction identifiers use BER context tags", TcapTransactionIdentifiersUseBerContextTags);
 Run("TCAP BER Invoke component round-trips", TcapBerInvokeComponentRoundTrips);
@@ -246,6 +247,17 @@ static void SigtranCiVerificationProfileExposesOfficialCommands()
     Assert(commands[2].Contains("dotnet pack", StringComparison.Ordinal), commands[2]);
 }
 
+static void SigtranInteroperabilityReadinessReportsFoundationStatus()
+{
+    SigtranInteroperabilityReadinessReport report = SigtranInteroperabilityReadiness.GetReport();
+
+    Assert(report.FoundationReady, "interoperability tooling foundation should be ready");
+    Assert(!report.IsProductionReady, "interoperability tooling should wait for external lab evidence");
+    AssertEqual(8, report.FoundationCapabilityCount, "interoperability foundation capability count");
+    AssertEqual(SigtranInteroperabilityReadiness.RequiredFoundationCapabilityCount, report.FoundationCapabilityCount, "interoperability required capability count");
+    Assert(report.Describe().Contains("externalLab=False", StringComparison.Ordinal), report.Describe());
+}
+
 static void TcapBerElementEncodesShortAndLongLengths()
 {
     Span<byte> shortBuffer = stackalloc byte[8];

src/sigtran.net/Core/Utilities/SigtranInteroperabilityReadiness.cs

@@ -0,0 +1,120 @@
+namespace sigtran.net.Core.Utilities;
+
+/// <summary>
+/// Describes Phase 6 interoperability tooling readiness.
+/// </summary>
+public sealed class SigtranInteroperabilityReadinessReport
+{
+    /// <summary>Creates an interoperability tooling readiness report.</summary>
+    /// <param name="hasTraceFormatter">Whether trace formatting is available.</param>
+    /// <param name="hasConformanceRegistry">Whether a conformance vector registry is available.</param>
+    /// <param name="hasBuiltInVectors">Whether built-in vectors are available.</param>
+    /// <param name="hasSimulatorScripts">Whether simulator scripts are available.</param>
+    /// <param name="hasMapSmsFlows">Whether MAP SMS simulator flows are available.</param>
+    /// <param name="hasTransportSamples">Whether local transport sample scenarios are available.</param>
+    /// <param name="hasSampleCatalog">Whether the sample catalog is available.</param>
+    /// <param name="hasCiProfile">Whether the CI verification profile is available.</param>
+    /// <param name="hasExternalInteroperabilityLab">Whether external interoperability lab evidence is available.</param>
+    public SigtranInteroperabilityReadinessReport(
+        bool hasTraceFormatter,
+        bool hasConformanceRegistry,
+        bool hasBuiltInVectors,
+        bool hasSimulatorScripts,
+        bool hasMapSmsFlows,
+        bool hasTransportSamples,
+        bool hasSampleCatalog,
+        bool hasCiProfile,
+        bool hasExternalInteroperabilityLab)
+    {
+        HasTraceFormatter = hasTraceFormatter;
+        HasConformanceRegistry = hasConformanceRegistry;
+        HasBuiltInVectors = hasBuiltInVectors;
+        HasSimulatorScripts = hasSimulatorScripts;
+        HasMapSmsFlows = hasMapSmsFlows;
+        HasTransportSamples = hasTransportSamples;
+        HasSampleCatalog = hasSampleCatalog;
+        HasCiProfile = hasCiProfile;
+        HasExternalInteroperabilityLab = hasExternalInteroperabilityLab;
+    }
+
+    /// <summary>Whether trace formatting is available.</summary>
+    public bool HasTraceFormatter { get; }
+
+    /// <summary>Whether a conformance vector registry is available.</summary>
+    public bool HasConformanceRegistry { get; }
+
+    /// <summary>Whether built-in vectors are available.</summary>
+    public bool HasBuiltInVectors { get; }
+
+    /// <summary>Whether simulator scripts are available.</summary>
+    public bool HasSimulatorScripts { get; }
+
+    /// <summary>Whether MAP SMS simulator flows are available.</summary>
+    public bool HasMapSmsFlows { get; }
+
+    /// <summary>Whether local transport sample scenarios are available.</summary>
+    public bool HasTransportSamples { get; }
+
+    /// <summary>Whether the sample catalog is available.</summary>
+    public bool HasSampleCatalog { get; }
+
+    /// <summary>Whether the CI verification profile is available.</summary>
+    public bool HasCiProfile { get; }
+
+    /// <summary>Whether external interoperability lab evidence is available.</summary>
+    public bool HasExternalInteroperabilityLab { get; }
+
+    /// <summary>Whether all Phase 6 foundation capabilities are available.</summary>
+    public bool FoundationReady => FoundationCapabilityCount == SigtranInteroperabilityReadiness.RequiredFoundationCapabilityCount;
+
+    /// <summary>Whether the interoperability tooling can be treated as production-ready.</summary>
+    public bool IsProductionReady => FoundationReady && HasExternalInteroperabilityLab;
+
+    /// <summary>The implemented foundation capability count.</summary>
+    public int FoundationCapabilityCount =>
+        Count(HasTraceFormatter)
+        + Count(HasConformanceRegistry)
+        + Count(HasBuiltInVectors)
+        + Count(HasSimulatorScripts)
+        + Count(HasMapSmsFlows)
+        + Count(HasTransportSamples)
+        + Count(HasSampleCatalog)
+        + Count(HasCiProfile);
+
+    /// <summary>Formats a compact readiness summary.</summary>
+    /// <returns>The readiness summary.</returns>
+    public string Describe()
+    {
+        return $"interopFoundationReady={FoundationReady} interopProductionReady={IsProductionReady} foundationCapabilities={FoundationCapabilityCount}/{SigtranInteroperabilityReadiness.RequiredFoundationCapabilityCount} trace={HasTraceFormatter} vectors={HasConformanceRegistry} builtInVectors={HasBuiltInVectors} simulators={HasSimulatorScripts} mapSmsFlows={HasMapSmsFlows} transportSamples={HasTransportSamples} sampleCatalog={HasSampleCatalog} ci={HasCiProfile} externalLab={HasExternalInteroperabilityLab}";
+    }
+
+    private static int Count(bool value)
+    {
+        return value ? 1 : 0;
+    }
+}
+
+/// <summary>
+/// Provides the Phase 6 interoperability tooling readiness report.
+/// </summary>
+public static class SigtranInteroperabilityReadiness
+{
+    /// <summary>The required foundation capability count.</summary>
+    public const int RequiredFoundationCapabilityCount = 8;
+
+    /// <summary>Returns the current interoperability tooling readiness report.</summary>
+    /// <returns>The current readiness report.</returns>
+    public static SigtranInteroperabilityReadinessReport GetReport()
+    {
+        return new(
+            hasTraceFormatter: true,
+            hasConformanceRegistry: true,
+            hasBuiltInVectors: true,
+            hasSimulatorScripts: true,
+            hasMapSmsFlows: true,
+            hasTransportSamples: true,
+            hasSampleCatalog: true,
+            hasCiProfile: true,
+            hasExternalInteroperabilityLab: false);
+    }
+}