| | | 1 | | using AsiBackbone.AspNetCore.Endpoints; |
| | | 2 | | using AsiBackbone.Core.Decisions; |
| | | 3 | | using Microsoft.AspNetCore.Http; |
| | | 4 | | |
| | | 5 | | namespace AsiBackbone.Testing.Contracts; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Reusable contract fixture for <see cref="IEndpointCapabilityGrantValidator" /> implementations. |
| | | 9 | | /// </summary> |
| | | 10 | | public abstract class EndpointCapabilityGrantValidatorContract |
| | | 11 | | { |
| | | 12 | | /// <summary> |
| | | 13 | | /// Creates the capability-grant validator implementation under test. |
| | | 14 | | /// </summary> |
| | | 15 | | /// <returns>The capability-grant validator implementation to validate.</returns> |
| | | 16 | | protected abstract IEndpointCapabilityGrantValidator CreateValidator(); |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// Creates the HTTP context supplied to the validator implementation under test. |
| | | 20 | | /// </summary> |
| | | 21 | | /// <returns>The HTTP context to validate with.</returns> |
| | | 22 | | protected virtual HttpContext CreateHttpContext() |
| | | 23 | | { |
| | 7 | 24 | | return new DefaultHttpContext |
| | 7 | 25 | | { |
| | 7 | 26 | | TraceIdentifier = "asibackbone-contract-capability" |
| | 7 | 27 | | }; |
| | | 28 | | } |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Creates a descriptor containing a capability requirement for the invalid-grant contract path. |
| | | 32 | | /// </summary> |
| | | 33 | | /// <returns>The descriptor supplied to the validator implementation under test.</returns> |
| | | 34 | | protected virtual EndpointGovernanceDescriptor CreateCapabilityDescriptor() |
| | | 35 | | { |
| | 6 | 36 | | var endpoint = new Endpoint( |
| | 6 | 37 | | static _ => Task.CompletedTask, |
| | 6 | 38 | | new EndpointMetadataCollection(new RequireCapabilityGrantAttribute("asibackbone.contract.invalid")), |
| | 6 | 39 | | "asibackbone.contract.capability"); |
| | | 40 | | |
| | 6 | 41 | | return EndpointGovernanceDescriptor.FromEndpoint(endpoint); |
| | | 42 | | } |
| | | 43 | | |
| | | 44 | | /// <summary> |
| | | 45 | | /// Creates the current decision supplied to the validator implementation under test. |
| | | 46 | | /// </summary> |
| | | 47 | | /// <returns>The current governance decision.</returns> |
| | | 48 | | protected virtual GovernanceDecision CreateCurrentDecision() |
| | | 49 | | { |
| | 5 | 50 | | return GovernanceDecision.Allow( |
| | 5 | 51 | | correlationId: "asibackbone-contract-capability", |
| | 5 | 52 | | policyVersion: "contract-policy-v1", |
| | 5 | 53 | | policyHash: "contract-policy-hash"); |
| | | 54 | | } |
| | | 55 | | |
| | | 56 | | /// <summary> |
| | | 57 | | /// Allows derived contracts to place a known-invalid grant, token, header, or request state into the context. |
| | | 58 | | /// </summary> |
| | | 59 | | /// <param name="httpContext">The HTTP context supplied to the validator.</param> |
| | | 60 | | /// <param name="descriptor">The endpoint governance descriptor supplied to the validator.</param> |
| | | 61 | | protected virtual void ConfigureKnownInvalidCapabilityGrant( |
| | | 62 | | HttpContext httpContext, |
| | | 63 | | EndpointGovernanceDescriptor descriptor) |
| | | 64 | | { |
| | 5 | 65 | | } |
| | | 66 | | |
| | | 67 | | /// <summary> |
| | | 68 | | /// Verifies that a known invalid capability-grant scenario does not produce an allow decision. |
| | | 69 | | /// </summary> |
| | | 70 | | /// <param name="cancellationToken">A token that can cancel the contract validation.</param> |
| | | 71 | | /// <returns>The verified governance decision.</returns> |
| | | 72 | | public async ValueTask<GovernanceDecision> VerifyKnownInvalidCapabilityGrantDoesNotAllowAsync(CancellationToken canc |
| | | 73 | | { |
| | 9 | 74 | | IEndpointCapabilityGrantValidator validator = CreateValidator() |
| | 9 | 75 | | ?? throw new GovernanceContractViolationException("Capability-grant contract must provide a validator instan |
| | 8 | 76 | | HttpContext httpContext = CreateHttpContext() |
| | 8 | 77 | | ?? throw new GovernanceContractViolationException("Capability-grant contract must provide an HTTP context.") |
| | 7 | 78 | | EndpointGovernanceDescriptor descriptor = CreateCapabilityDescriptor() |
| | 7 | 79 | | ?? throw new GovernanceContractViolationException("Capability-grant contract must provide an endpoint descri |
| | 6 | 80 | | GovernanceDecision currentDecision = CreateCurrentDecision() |
| | 6 | 81 | | ?? throw new GovernanceContractViolationException("Capability-grant contract must provide a current decision |
| | | 82 | | |
| | 5 | 83 | | ConfigureKnownInvalidCapabilityGrant(httpContext, descriptor); |
| | | 84 | | |
| | | 85 | | try |
| | | 86 | | { |
| | 5 | 87 | | GovernanceDecision decision = await validator.ValidateAsync(httpContext, descriptor, currentDecision, cancel |
| | 2 | 88 | | return GovernanceDecisionContract.VerifyInvalidCapabilityGrantDoesNotAllow(decision, "Capability-grant valid |
| | | 89 | | } |
| | 1 | 90 | | catch (OperationCanceledException) |
| | | 91 | | { |
| | 1 | 92 | | throw; |
| | | 93 | | } |
| | 2 | 94 | | catch (GovernanceContractViolationException) |
| | | 95 | | { |
| | 2 | 96 | | throw; |
| | | 97 | | } |
| | 1 | 98 | | catch (Exception exception) |
| | | 99 | | { |
| | 1 | 100 | | throw new GovernanceContractViolationException( |
| | 1 | 101 | | "Capability-grant validators must fail closed, defer, or escalate for invalid grants instead of throwing |
| | 1 | 102 | | exception); |
| | | 103 | | } |
| | 1 | 104 | | } |
| | | 105 | | } |