|
| 1 | +namespace Sigtran.NET.Core.Utilities; |
| 2 | + |
| 3 | +/// <summary> |
| 4 | +/// Describes verification required for one commercial evidence execution artifact. |
| 5 | +/// </summary> |
| 6 | +public sealed class SigtranCommercialEvidenceExecutionVerificationItem |
| 7 | +{ |
| 8 | + /// <summary>Creates a commercial evidence execution verification item.</summary> |
| 9 | + /// <param name="artifactPath">The retained artifact path.</param> |
| 10 | + /// <param name="kind">The checklist artifact kind.</param> |
| 11 | + /// <param name="requiresDigest">Whether digest verification is required.</param> |
| 12 | + /// <param name="requiresRedactionReview">Whether redaction review is required.</param> |
| 13 | + public SigtranCommercialEvidenceExecutionVerificationItem( |
| 14 | + string artifactPath, |
| 15 | + SigtranCommercialEvidenceChecklistKind kind, |
| 16 | + bool requiresDigest, |
| 17 | + bool requiresRedactionReview) |
| 18 | + { |
| 19 | + ArtifactPath = string.IsNullOrWhiteSpace(artifactPath) ? throw new ArgumentException("Artifact path is required.", nameof(artifactPath)) : artifactPath; |
| 20 | + Kind = kind; |
| 21 | + RequiresDigest = requiresDigest; |
| 22 | + RequiresRedactionReview = requiresRedactionReview; |
| 23 | + } |
| 24 | + |
| 25 | + /// <summary>The retained artifact path.</summary> |
| 26 | + public string ArtifactPath { get; } |
| 27 | + |
| 28 | + /// <summary>The checklist artifact kind.</summary> |
| 29 | + public SigtranCommercialEvidenceChecklistKind Kind { get; } |
| 30 | + |
| 31 | + /// <summary>Whether digest verification is required.</summary> |
| 32 | + public bool RequiresDigest { get; } |
| 33 | + |
| 34 | + /// <summary>Whether redaction review is required.</summary> |
| 35 | + public bool RequiresRedactionReview { get; } |
| 36 | + |
| 37 | + /// <summary>Whether this item satisfies verification requirements for its artifact kind.</summary> |
| 38 | + public bool IsReady => RequiresDigest |
| 39 | + && (!IsTraceBearingKind(Kind) || RequiresRedactionReview); |
| 40 | + |
| 41 | + /// <summary>Checks whether an artifact kind carries traffic, logs, or configuration.</summary> |
| 42 | + /// <param name="kind">The artifact kind.</param> |
| 43 | + /// <returns><c>true</c> when redaction review is required for the kind; otherwise, <c>false</c>.</returns> |
| 44 | + public static bool IsTraceBearingKind(SigtranCommercialEvidenceChecklistKind kind) |
| 45 | + { |
| 46 | + return kind is SigtranCommercialEvidenceChecklistKind.PacketCapture |
| 47 | + or SigtranCommercialEvidenceChecklistKind.PeerLog |
| 48 | + or SigtranCommercialEvidenceChecklistKind.SdkTrace |
| 49 | + or SigtranCommercialEvidenceChecklistKind.Configuration |
| 50 | + or SigtranCommercialEvidenceChecklistKind.ComparisonReport |
| 51 | + or SigtranCommercialEvidenceChecklistKind.BenchmarkReport; |
| 52 | + } |
| 53 | +} |
| 54 | + |
| 55 | +/// <summary> |
| 56 | +/// Describes the commercial evidence execution digest and redaction verification plan. |
| 57 | +/// </summary> |
| 58 | +public sealed class SigtranCommercialEvidenceExecutionVerificationPlan |
| 59 | +{ |
| 60 | + /// <summary>Creates a commercial evidence execution verification plan.</summary> |
| 61 | + /// <param name="manifest">The artifact manifest.</param> |
| 62 | + /// <param name="items">The verification items.</param> |
| 63 | + public SigtranCommercialEvidenceExecutionVerificationPlan( |
| 64 | + SigtranCommercialEvidenceExecutionArtifactManifest manifest, |
| 65 | + IReadOnlyList<SigtranCommercialEvidenceExecutionVerificationItem> items) |
| 66 | + { |
| 67 | + Manifest = manifest ?? throw new ArgumentNullException(nameof(manifest)); |
| 68 | + ArgumentNullException.ThrowIfNull(items); |
| 69 | + Items = items.Count == 0 ? throw new ArgumentException("At least one verification item is required.", nameof(items)) : items.ToArray(); |
| 70 | + } |
| 71 | + |
| 72 | + /// <summary>The artifact manifest.</summary> |
| 73 | + public SigtranCommercialEvidenceExecutionArtifactManifest Manifest { get; } |
| 74 | + |
| 75 | + /// <summary>The verification items.</summary> |
| 76 | + public IReadOnlyList<SigtranCommercialEvidenceExecutionVerificationItem> Items { get; } |
| 77 | + |
| 78 | + /// <summary>Whether every artifact has a verification item.</summary> |
| 79 | + public bool CoversArtifacts => Manifest.Artifacts.All(artifact => Items.Any(item => item.ArtifactPath == artifact.Path)); |
| 80 | + |
| 81 | + /// <summary>Whether every artifact requires digest verification.</summary> |
| 82 | + public bool RequiresDigestForAllArtifacts => Items.All(static item => item.RequiresDigest); |
| 83 | + |
| 84 | + /// <summary>Whether trace-bearing artifacts require redaction review.</summary> |
| 85 | + public bool RequiresRedactionForTraceArtifacts => Items |
| 86 | + .Where(static item => SigtranCommercialEvidenceExecutionVerificationItem.IsTraceBearingKind(item.Kind)) |
| 87 | + .All(static item => item.RequiresRedactionReview); |
| 88 | + |
| 89 | + /// <summary>Whether the verification plan is ready for evidence review.</summary> |
| 90 | + public bool IsReady => Manifest.IsReady |
| 91 | + && CoversArtifacts |
| 92 | + && RequiresDigestForAllArtifacts |
| 93 | + && RequiresRedactionForTraceArtifacts |
| 94 | + && Items.All(static item => item.IsReady); |
| 95 | + |
| 96 | + /// <summary>Formats a compact verification plan summary.</summary> |
| 97 | + /// <returns>The verification plan summary.</returns> |
| 98 | + public string Describe() |
| 99 | + { |
| 100 | + return $"commercialEvidenceVerificationReady={IsReady} items={Items.Count}"; |
| 101 | + } |
| 102 | +} |
| 103 | + |
| 104 | +/// <summary> |
| 105 | +/// Provides commercial evidence execution verification plan helpers. |
| 106 | +/// </summary> |
| 107 | +public static class SigtranCommercialEvidenceExecutionVerifications |
| 108 | +{ |
| 109 | + /// <summary>Creates the default digest and redaction verification plan.</summary> |
| 110 | + /// <param name="manifest">The artifact manifest.</param> |
| 111 | + /// <returns>The default verification plan.</returns> |
| 112 | + public static SigtranCommercialEvidenceExecutionVerificationPlan CreateDefault(SigtranCommercialEvidenceExecutionArtifactManifest manifest) |
| 113 | + { |
| 114 | + ArgumentNullException.ThrowIfNull(manifest); |
| 115 | + |
| 116 | + return new( |
| 117 | + manifest, |
| 118 | + manifest.Artifacts |
| 119 | + .Select(static artifact => new SigtranCommercialEvidenceExecutionVerificationItem( |
| 120 | + artifact.Path, |
| 121 | + artifact.Kind, |
| 122 | + requiresDigest: true, |
| 123 | + requiresRedactionReview: SigtranCommercialEvidenceExecutionVerificationItem.IsTraceBearingKind(artifact.Kind))) |
| 124 | + .ToArray()); |
| 125 | + } |
| 126 | +} |
0 commit comments