JsonApiDotNetCore/test/OpenApiTests/Capabilities/AttributeCapabilitiesTests.cs at bf43f3992217ba00508b4d371b7dd507d1341fd3 · json-api-dotnet/JsonApiDotNetCore · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
using System.Text.Json;
using TestBuildingBlocks;
using Xunit;
using Xunit.Abstractions;

namespace OpenApiTests.Capabilities;

public sealed class AttributeCapabilitiesTests : IClassFixture<OpenApiTestContext<OpenApiStartup<CapabilitiesDbContext>, CapabilitiesDbContext>>
{
    private readonly OpenApiTestContext<OpenApiStartup<CapabilitiesDbContext>, CapabilitiesDbContext> _testContext;

    public AttributeCapabilitiesTests(OpenApiTestContext<OpenApiStartup<CapabilitiesDbContext>, CapabilitiesDbContext> testContext, ITestOutputHelper testOutputHelper)
    {
        _testContext = testContext;

        testContext.UseController<BooksController>();

        testContext.SetTestOutputHelper(testOutputHelper);
        testContext.SwaggerDocumentOutputDirectory = $"{GetType().Namespace!.Replace('.', '/')}/GeneratedSwagger";
    }

    [Theory]
    [InlineData("title")]
    [InlineData("isbn")]
    [InlineData("publishedOn")]
    [InlineData("hasEmptyTitle")]
    public async Task Attribute_with_AllowView_capability_appears_in_response_schema(string attributeName)
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInBookResponse.allOf[1].properties").With(properties =>
        {
            properties.Should().ContainProperty(attributeName);
        });
    }

    [Theory]
    [InlineData("draftContent")]
    [InlineData("internalNotes")]
    [InlineData("secretCode")]
    [InlineData("isDeleted")]
    public async Task Attribute_without_AllowView_capability_does_not_appear_in_response_schema(string attributeName)
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInBookResponse.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath(attributeName);
        });
    }

    [Theory]
    [InlineData("draftContent")]
    [InlineData("isDeleted")]
    public async Task Attribute_with_AllowCreate_capability_appears_in_create_request_schema(string attributeName)
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInCreateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().ContainProperty(attributeName);
        });
    }

    [Theory]
    [InlineData("title")]
    [InlineData("isbn")]
    [InlineData("publishedOn")]
    [InlineData("internalNotes")]
    [InlineData("secretCode")]
    [InlineData("hasEmptyTitle")]
    public async Task Attribute_without_AllowCreate_capability_does_not_appear_in_create_request_schema(string attributeName)
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInCreateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath(attributeName);
        });
    }

    [Theory]
    [InlineData("title")]
    [InlineData("internalNotes")]
    [InlineData("isDeleted")]
    public async Task Attribute_with_AllowChange_capability_appears_in_update_request_schema(string attributeName)
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInUpdateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().ContainProperty(attributeName);
        });
    }

    [Theory]
    [InlineData("isbn")]
    [InlineData("publishedOn")]
    [InlineData("draftContent")]
    [InlineData("secretCode")]
    [InlineData("hasEmptyTitle")]
    public async Task Attribute_without_AllowChange_capability_does_not_appear_in_update_request_schema(string attributeName)
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInUpdateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath(attributeName);
        });
    }

    [Fact]
    public async Task Attribute_with_None_capability_does_not_appear_in_any_schema()
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInBookResponse.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath("secretCode");
        });

        document.Should().ContainPath("components.schemas.attributesInCreateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath("secretCode");
        });

        document.Should().ContainPath("components.schemas.attributesInUpdateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath("secretCode");
        });
    }

    [Fact]
    public async Task Get_only_property_only_appears_in_response_schema()
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInBookResponse.allOf[1].properties").With(properties =>
        {
            properties.Should().ContainProperty("hasEmptyTitle");
        });

        document.Should().ContainPath("components.schemas.attributesInCreateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath("hasEmptyTitle");
        });

        document.Should().ContainPath("components.schemas.attributesInUpdateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath("hasEmptyTitle");
        });
    }

    [Fact]
    public async Task Set_only_property_only_appears_in_request_schemas()
    {
        // Act
        JsonElement document = await _testContext.GetSwaggerDocumentAsync();

        // Assert
        document.Should().ContainPath("components.schemas.attributesInBookResponse.allOf[1].properties").With(properties =>
        {
            properties.Should().NotContainPath("isDeleted");
        });

        document.Should().ContainPath("components.schemas.attributesInCreateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().ContainProperty("isDeleted");
        });

        document.Should().ContainPath("components.schemas.attributesInUpdateBookRequest.allOf[1].properties").With(properties =>
        {
            properties.Should().ContainProperty("isDeleted");
        });
    }
}