Adds tests for validating attribute visibility on schema generation based on attribute capabilities (#1056)

Author: mrnlts

test/OpenApiTests/AttributeTypes/AttributeCapabilitiesTests.cs

@@ -0,0 +1,71 @@
+using System.Text.Json;
+using JsonApiDotNetCore.Resources.Annotations;
+using TestBuildingBlocks;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace OpenApiTests.AttributeTypes;
+
+public sealed class AttributeCapabilitiesTests : IClassFixture<OpenApiTestContext<AttributeTypesStartup, AttributeTypesDbContext>>
+{
+    private enum RequestType{ Response, Create, Update }
+
+    private static readonly Dictionary<RequestType, AttrCapabilities> CapabilitiesByRequestType = new()
+    {
+        { RequestType.Response, AttrCapabilities.AllowView },
+        { RequestType.Create, AttrCapabilities.AllowCreate },
+        { RequestType.Update, AttrCapabilities.AllowChange }
+    };
+
+    private static readonly Dictionary<RequestType, string> SchemaPathByRequestType = new()
+    {
+        { RequestType.Response, "components.schemas.attributesInBookResponse.allOf[1].properties" },
+        { RequestType.Create, "components.schemas.attributesInCreateBookRequest.allOf[1].properties" },
+        { RequestType.Update, "components.schemas.attributesInUpdateBookRequest.allOf[1].properties" }
+    };
+
+    private static readonly Dictionary<AttrCapabilities, List<string>> BookModelAttrsByCapability = new()
+    {
+        { AttrCapabilities.AllowView,   ["title", "isbn", "publishedOn"] },
+        { AttrCapabilities.AllowChange, ["title", "internalNotes"] },
+        { AttrCapabilities.AllowCreate, ["draftContent"] },
+        { AttrCapabilities.None,        ["secretCode"] }
+    };
+
+    private readonly OpenApiTestContext<AttributeTypesStartup, AttributeTypesDbContext> _testContext;
+
+    public AttributeCapabilitiesTests(
+        OpenApiTestContext<AttributeTypesStartup, AttributeTypesDbContext> testContext,
+        ITestOutputHelper output)
+    {
+        _testContext = testContext;
+        _testContext.UseController<BooksController>();
+        _testContext.SetTestOutputHelper(output);
+    }
+
+    [Theory]
+    [InlineData(RequestType.Response)]
+    [InlineData(RequestType.Create)]
+    [InlineData(RequestType.Update)]
+    private async Task Generated_Schema_Includes_Only_Expected_Attrs_For_Request_Type_Async(RequestType requestType)
+    {
+        // Arrange
+        string path = SchemaPathByRequestType[requestType];
+        JsonElement document = await _testContext.GetSwaggerDocumentAsync();
+        JsonElement attrs = document.Should().ContainPath(path);
+
+        IList<string> bookExpectedAttrs = BookModelAttrsByCapability[CapabilitiesByRequestType[requestType]];
+        IList<string> bookUnexpectedAttrs = BookModelAttrsByCapability.SelectMany(kvPair => kvPair.Value)
+            .Except(bookExpectedAttrs).ToList();
+
+        // Assert
+        foreach (string attrName in bookExpectedAttrs)
+        {
+            attrs.Should().ContainProperty(attrName);
+        }
+        foreach (string attrName in bookUnexpectedAttrs)
+        {
+            attrs.Should().NotContainPath($"properties.{attrName}");
+        }
+    }
+}

test/OpenApiTests/AttributeTypes/AttributeTypesDbContext.cs

@@ -14,6 +14,7 @@ namespace OpenApiTests.AttributeTypes;
 public sealed class AttributeTypesDbContext(DbContextOptions<AttributeTypesDbContext> options)
     : TestableDbContext(options)
 {
+    public DbSet<Book> Books => Set<Book>();
     public DbSet<TypeContainer> TypeContainers => Set<TypeContainer>();
 
     protected override void ConfigureConventions(ModelConfigurationBuilder builder)

test/OpenApiTests/AttributeTypes/Book.cs

@@ -0,0 +1,34 @@
+using JetBrains.Annotations;
+using JsonApiDotNetCore.Resources;
+using JsonApiDotNetCore.Resources.Annotations;
+
+namespace OpenApiTests.AttributeTypes;
+
+[UsedImplicitly(ImplicitUseTargetFlags.Members)]
+[Resource(ControllerNamespace = "OpenApiTests.AttributeTypes")]
+public sealed class Book : Identifiable<int>
+{
+    // Visible in GET, PATCH, included in all operations
+    [Attr(Capabilities = AttrCapabilities.AllowView | AttrCapabilities.AllowChange)]
+    public string Title { get; set; } = null!;
+
+    // Only visible in GET
+    [Attr(Capabilities = AttrCapabilities.AllowView)]
+    public string ISBN { get; set; } = null!;
+
+    // Only visible in GET
+    [Attr(Capabilities = AttrCapabilities.AllowView)]
+    public DateOnly PublishedOn { get; set; }
+
+    // Only usable in POST
+    [Attr(Capabilities = AttrCapabilities.AllowCreate)]
+    public string DraftContent { get; set; } = null!;
+
+    // Only usable in PATCH
+    [Attr(Capabilities = AttrCapabilities.AllowChange)]
+    public string InternalNotes { get; set; } = null!;
+
+    // No visibility or modifiers whatsoever
+    [Attr(Capabilities = AttrCapabilities.None)]
+    public string SecretCode { get; set; } = null!;
+}