|
| 1 | +using Sigtran.NET.Layers.MAP; |
| 2 | +using Sigtran.NET.Layers.SCCP; |
| 3 | +using Sigtran.NET.Layers.TCAP; |
| 4 | + |
| 5 | +namespace Sigtran.NET.Core.Utilities; |
| 6 | + |
| 7 | +/// <summary> |
| 8 | +/// Aggregates SCCP, TCAP, and MAP SMS protocol evidence validation results. |
| 9 | +/// </summary> |
| 10 | +public sealed class SigtranProtocolEvidenceBundleReport |
| 11 | +{ |
| 12 | + private readonly SigtranProtocolEvidenceVector[] _vectors; |
| 13 | + private readonly SigtranProtocolEvidenceValidationReport[] _validationReports; |
| 14 | + private readonly string[] _duplicateVectorIds; |
| 15 | + |
| 16 | + /// <summary>Creates a protocol evidence bundle report.</summary> |
| 17 | + /// <param name="vectors">The evidence vectors.</param> |
| 18 | + /// <param name="validationReports">The validation reports.</param> |
| 19 | + /// <param name="duplicateVectorIds">Duplicate vector ids found in the bundle.</param> |
| 20 | + public SigtranProtocolEvidenceBundleReport( |
| 21 | + IReadOnlyList<SigtranProtocolEvidenceVector> vectors, |
| 22 | + IReadOnlyList<SigtranProtocolEvidenceValidationReport> validationReports, |
| 23 | + IReadOnlyList<string> duplicateVectorIds) |
| 24 | + { |
| 25 | + _vectors = (vectors ?? throw new ArgumentNullException(nameof(vectors))).ToArray(); |
| 26 | + _validationReports = (validationReports ?? throw new ArgumentNullException(nameof(validationReports))).ToArray(); |
| 27 | + _duplicateVectorIds = (duplicateVectorIds ?? throw new ArgumentNullException(nameof(duplicateVectorIds))).ToArray(); |
| 28 | + } |
| 29 | + |
| 30 | + /// <summary>The evidence vectors.</summary> |
| 31 | + public IReadOnlyList<SigtranProtocolEvidenceVector> Vectors => _vectors.ToArray(); |
| 32 | + |
| 33 | + /// <summary>The validation reports.</summary> |
| 34 | + public IReadOnlyList<SigtranProtocolEvidenceValidationReport> ValidationReports => _validationReports.ToArray(); |
| 35 | + |
| 36 | + /// <summary>Duplicate vector ids found in the bundle.</summary> |
| 37 | + public IReadOnlyList<string> DuplicateVectorIds => _duplicateVectorIds.ToArray(); |
| 38 | + |
| 39 | + /// <summary>The total vector count.</summary> |
| 40 | + public int VectorCount => _vectors.Length; |
| 41 | + |
| 42 | + /// <summary>The number of passed validation reports.</summary> |
| 43 | + public int PassedValidationCount => _validationReports.Count(static report => report.Passed); |
| 44 | + |
| 45 | + /// <summary>Whether every validation report passed.</summary> |
| 46 | + public bool AllValidationPassed => _validationReports.Length == _vectors.Length && _validationReports.All(static report => report.Passed); |
| 47 | + |
| 48 | + /// <summary>Whether the bundle contains all required vectors without duplicate ids.</summary> |
| 49 | + public bool IsComplete => VectorCount == SigtranProtocolEvidenceBundle.RequiredVectorCount && _duplicateVectorIds.Length == 0; |
| 50 | + |
| 51 | + /// <summary>Whether the bundle is complete and every validation report passed.</summary> |
| 52 | + public bool EvidenceBacked => IsComplete && AllValidationPassed; |
| 53 | + |
| 54 | + /// <summary>Returns the vector count for a protocol surface.</summary> |
| 55 | + /// <param name="surface">The protocol surface.</param> |
| 56 | + /// <returns>The vector count for the requested surface.</returns> |
| 57 | + public int CountBySurface(SigtranProtocolInteropSurface surface) |
| 58 | + { |
| 59 | + return _vectors.Count(vector => vector.Surface == surface); |
| 60 | + } |
| 61 | + |
| 62 | + /// <summary>Formats a compact bundle summary.</summary> |
| 63 | + /// <returns>The bundle summary.</returns> |
| 64 | + public string Describe() |
| 65 | + { |
| 66 | + return $"vectors={VectorCount}/{SigtranProtocolEvidenceBundle.RequiredVectorCount} passed={PassedValidationCount}/{_validationReports.Length} duplicates={_duplicateVectorIds.Length} complete={IsComplete} evidenceBacked={EvidenceBacked}"; |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +/// <summary> |
| 71 | +/// Provides a cross-layer SCCP, TCAP, and MAP SMS evidence bundle. |
| 72 | +/// </summary> |
| 73 | +public static class SigtranProtocolEvidenceBundle |
| 74 | +{ |
| 75 | + /// <summary>The required cross-layer evidence vector count.</summary> |
| 76 | + public const int RequiredVectorCount = 11; |
| 77 | + |
| 78 | + /// <summary>Creates the current cross-layer evidence bundle report.</summary> |
| 79 | + /// <returns>The current evidence bundle report.</returns> |
| 80 | + public static SigtranProtocolEvidenceBundleReport Create() |
| 81 | + { |
| 82 | + SigtranProtocolEvidenceVector[] vectors = |
| 83 | + [ |
| 84 | + .. SccpEvidenceVectors.GetVectors(), |
| 85 | + .. TcapEvidenceVectors.GetVectors(), |
| 86 | + .. MapSmsEvidenceVectors.GetVectors() |
| 87 | + ]; |
| 88 | + |
| 89 | + SigtranProtocolEvidenceValidationReport[] reports = |
| 90 | + [ |
| 91 | + .. SccpEvidenceVectors.ValidateEncoders(), |
| 92 | + .. TcapEvidenceVectors.ValidateEncoders(), |
| 93 | + .. MapSmsEvidenceVectors.ValidateEncoders() |
| 94 | + ]; |
| 95 | + |
| 96 | + string[] duplicates = vectors |
| 97 | + .GroupBy(static vector => vector.Id, StringComparer.Ordinal) |
| 98 | + .Where(static group => group.Count() > 1) |
| 99 | + .Select(static group => group.Key) |
| 100 | + .OrderBy(static id => id, StringComparer.Ordinal) |
| 101 | + .ToArray(); |
| 102 | + |
| 103 | + return new(vectors, reports, duplicates); |
| 104 | + } |
| 105 | +} |
0 commit comments