Skip to content

Commit 2456bc1

Browse files
bkoelmanbkoelman
committed
Add OpenAPI tests for the presence of meta
1 parent 8c494be commit 2456bc1

7 files changed

Lines changed: 174 additions & 1 deletion

File tree

‎test/OpenApiTests/Meta/JigsawPuzzle.cs‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
using JetBrains.Annotations;
2+
using JsonApiDotNetCore.Resources;
3+
using JsonApiDotNetCore.Resources.Annotations;
4+
5+
namespace OpenApiTests.Meta;
6+
7+
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8+
[Resource(ControllerNamespace = "OpenApiTests.Meta")]
9+
public sealed class JigsawPuzzle : Identifiable<long>
10+
{
11+
[Attr]
12+
public string Title { get; set; } = null!;
13+
14+
[HasOne]
15+
public JigsawPuzzlePicture FrontPicture { get; set; } = null!;
16+
17+
[HasOne]
18+
public JigsawPuzzlePicture? BackPicture { get; set; }
19+
20+
[HasMany]
21+
public ISet<JigsawPuzzlePiece> Pieces { get; set; } = new HashSet<JigsawPuzzlePiece>();
22+
}

‎test/OpenApiTests/Meta/JigsawPuzzlePicture.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
using JetBrains.Annotations;
2+
using JsonApiDotNetCore.Resources;
3+
using JsonApiDotNetCore.Resources.Annotations;
4+
5+
namespace OpenApiTests.Meta;
6+
7+
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8+
[Resource(ControllerNamespace = "OpenApiTests.Meta")]
9+
public sealed class JigsawPuzzlePicture : Identifiable<long>
10+
{
11+
[Attr]
12+
public string ImageUrl { get; set; } = null!;
13+
}

‎test/OpenApiTests/Meta/JigsawPuzzlePiece.cs‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
using JetBrains.Annotations;
2+
using JsonApiDotNetCore.Resources;
3+
using JsonApiDotNetCore.Resources.Annotations;
4+
5+
namespace OpenApiTests.Meta;
6+
7+
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8+
[Resource(ControllerNamespace = "OpenApiTests.Meta")]
9+
public sealed class JigsawPuzzlePiece : Identifiable<long>
10+
{
11+
[Attr]
12+
public string ImageUrl { get; set; } = null!;
13+
14+
[HasOne]
15+
public JigsawPuzzle Puzzle { get; set; } = null!;
16+
}

‎test/OpenApiTests/Meta/MetaDbContext.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
using JetBrains.Annotations;
2+
using Microsoft.EntityFrameworkCore;
3+
using TestBuildingBlocks;
4+
5+
namespace OpenApiTests.Meta;
6+
7+
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8+
public sealed class MetaDbContext(DbContextOptions<MetaDbContext> options)
9+
: TestableDbContext(options)
10+
{
11+
public DbSet<JigsawPuzzle> Puzzles => Set<JigsawPuzzle>();
12+
}

‎test/OpenApiTests/Meta/MetaTests.cs‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
using System.Text.Json;
2+
using TestBuildingBlocks;
3+
using Xunit;
4+
using Xunit.Abstractions;
5+
6+
namespace OpenApiTests.Meta;
7+
8+
public sealed class MetaTests : IClassFixture<OpenApiTestContext<OpenApiStartup<MetaDbContext>, MetaDbContext>>
9+
{
10+
private readonly OpenApiTestContext<OpenApiStartup<MetaDbContext>, MetaDbContext> _testContext;
11+
12+
public MetaTests(OpenApiTestContext<OpenApiStartup<MetaDbContext>, MetaDbContext> testContext, ITestOutputHelper testOutputHelper)
13+
{
14+
_testContext = testContext;
15+
16+
testContext.UseController<JigsawPuzzlesController>();
17+
testContext.UseController<JigsawPuzzlePicturesController>();
18+
testContext.UseController<JigsawPuzzlePiecesController>();
19+
testContext.UseController<OperationsController>();
20+
21+
testContext.SetTestOutputHelper(testOutputHelper);
22+
}
23+
24+
[Fact]
25+
public async Task Includes_meta_definition()
26+
{
27+
// Act
28+
JsonElement document = await _testContext.GetSwaggerDocumentAsync();
29+
30+
// Assert
31+
document.Should().ContainPath("components.schemas.meta").With(metaElement =>
32+
{
33+
metaElement.Should().BeJson("""
34+
{
35+
"type": "object",
36+
"additionalProperties": {
37+
"nullable": true
38+
}
39+
}
40+
""");
41+
});
42+
}
43+
44+
[Theory]
45+
[InlineData("atomicOperation")]
46+
[InlineData("atomicResult")]
47+
[InlineData("createJigsawPuzzlePictureRequestDocument")]
48+
[InlineData("createJigsawPuzzlePieceRequestDocument")]
49+
[InlineData("createJigsawPuzzleRequestDocument")]
50+
[InlineData("errorObject")]
51+
[InlineData("errorResponseDocument")]
52+
[InlineData("identifierInRequest")]
53+
[InlineData("jigsawPuzzleCollectionResponseDocument")]
54+
[InlineData("jigsawPuzzleIdentifierInResponse")]
55+
[InlineData("jigsawPuzzleIdentifierResponseDocument")]
56+
[InlineData("jigsawPuzzlePictureCollectionResponseDocument")]
57+
[InlineData("jigsawPuzzlePictureIdentifierInResponse")]
58+
[InlineData("jigsawPuzzlePictureIdentifierResponseDocument")]
59+
[InlineData("jigsawPuzzlePieceCollectionResponseDocument")]
60+
[InlineData("jigsawPuzzlePieceIdentifierCollectionResponseDocument")]
61+
[InlineData("jigsawPuzzlePieceIdentifierInResponse")]
62+
[InlineData("nullableJigsawPuzzlePictureIdentifierResponseDocument")]
63+
[InlineData("nullableSecondaryJigsawPuzzlePictureResponseDocument")]
64+
[InlineData("nullableToOneJigsawPuzzlePictureInRequest")]
65+
[InlineData("nullableToOneJigsawPuzzlePictureInResponse")]
66+
[InlineData("operationsRequestDocument")]
67+
[InlineData("operationsResponseDocument")]
68+
[InlineData("primaryJigsawPuzzlePictureResponseDocument")]
69+
[InlineData("primaryJigsawPuzzlePieceResponseDocument")]
70+
[InlineData("primaryJigsawPuzzleResponseDocument")]
71+
[InlineData("resourceInCreateRequest")]
72+
[InlineData("resourceInResponse")]
73+
[InlineData("resourceInUpdateRequest")]
74+
[InlineData("secondaryJigsawPuzzlePictureResponseDocument")]
75+
[InlineData("secondaryJigsawPuzzleResponseDocument")]
76+
[InlineData("toManyJigsawPuzzlePieceInRequest")]
77+
[InlineData("toManyJigsawPuzzlePieceInResponse")]
78+
[InlineData("toOneJigsawPuzzleInRequest")]
79+
[InlineData("toOneJigsawPuzzleInResponse")]
80+
[InlineData("toOneJigsawPuzzlePictureInRequest")]
81+
[InlineData("toOneJigsawPuzzlePictureInResponse")]
82+
[InlineData("updateJigsawPuzzlePictureRequestDocument")]
83+
[InlineData("updateJigsawPuzzlePieceRequestDocument")]
84+
[InlineData("updateJigsawPuzzleRequestDocument")]
85+
public async Task Includes_meta_property(string schemaId)
86+
{
87+
// Act
88+
JsonElement document = await _testContext.GetSwaggerDocumentAsync();
89+
90+
// Assert
91+
document.Should().ContainPath($"components.schemas.{schemaId}.properties").With(propertiesElement =>
92+
{
93+
JsonElement metaElement = propertiesElement.Should().ContainPath("meta.allOf[0]");
94+
metaElement.Should().HaveProperty("$ref", "#/components/schemas/meta");
95+
});
96+
}
97+
}

‎test/OpenApiTests/Meta/OperationsController.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
using JsonApiDotNetCore.AtomicOperations;
2+
using JsonApiDotNetCore.Configuration;
3+
using JsonApiDotNetCore.Controllers;
4+
using JsonApiDotNetCore.Middleware;
5+
using JsonApiDotNetCore.Resources;
6+
using Microsoft.Extensions.Logging;
7+
8+
namespace OpenApiTests.Meta;
9+
10+
public sealed class OperationsController(
11+
IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IOperationsProcessor processor, IJsonApiRequest request,
12+
ITargetedFields targetedFields, IAtomicOperationFilter operationFilter)
13+
: JsonApiOperationsController(options, resourceGraph, loggerFactory, processor, request, targetedFields, operationFilter);

‎test/OpenApiTests/OpenApiTests.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Project Sdk="Microsoft.NET.Sdk">
1+
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
33
<TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
44
<GenerateDocumentationFile>True</GenerateDocumentationFile>

0 commit comments

Comments
 (0)