Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ public class AnnotationsOperationFilter : IOperationFilter
{
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
IEnumerable<object> controllerAttributes = Array.Empty<object>();
IEnumerable<object> actionAttributes = Array.Empty<object>();
IEnumerable<object> metadataAttributes = Array.Empty<object>();
IEnumerable<object> controllerAttributes = [];
IEnumerable<object> actionAttributes = [];
IEnumerable<object> metadataAttributes = [];

if (context.MethodInfo != null)
{
Expand Down Expand Up @@ -86,7 +86,7 @@ public static void ApplySwaggerOperationFilterAttributes(
}
}

private void ApplySwaggerResponseAttributes(
private static void ApplySwaggerResponseAttributes(
OpenApiOperation operation,
OperationFilterContext context,
IEnumerable<object> controllerAndActionAttributes)
Expand All @@ -97,10 +97,7 @@ private void ApplySwaggerResponseAttributes(
{
var statusCode = swaggerResponseAttribute.StatusCode.ToString();

if (operation.Responses == null)
{
operation.Responses = new OpenApiResponses();
}
operation.Responses ??= [];

if (!operation.Responses.TryGetValue(statusCode, out OpenApiResponse response))
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Readers;
using System;
using System;
using System.IO;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Readers;

namespace Swashbuckle.AspNetCore.ApiTesting
{
public static class ApiTestRunnerOptionsExtensions
{
public static void AddOpenApiFile(this ApiTestRunnerOptions options, string documentName, string filePath)
{
using (var fileStream = File.OpenRead(filePath))
{
var openApiDocument = new OpenApiStreamReader().Read(fileStream, out OpenApiDiagnostic diagnostic);
options.OpenApiDocs.Add(documentName, openApiDocument);
}
using var fileStream = File.OpenRead(filePath);

var openApiDocument = new OpenApiStreamReader().Read(fileStream, out var diagnostic);
options.OpenApiDocs.Add(documentName, openApiDocument);
}

public static OpenApiDocument GetOpenApiDocument(this ApiTestRunnerOptions options, string documentName)
{
if (!options.OpenApiDocs.TryGetValue(documentName, out OpenApiDocument document))
{
throw new InvalidOperationException($"Document with name '{documentName}' not found");
}

return document;
}
Expand Down
19 changes: 8 additions & 11 deletions src/Swashbuckle.AspNetCore.ApiTesting/JsonContentValidator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,22 @@ namespace Swashbuckle.AspNetCore.ApiTesting
{
public class JsonContentValidator : IContentValidator
{
private readonly JsonValidator _jsonValidator;
private readonly JsonValidator _jsonValidator = new();

public JsonContentValidator()
{
_jsonValidator = new JsonValidator();
}

public bool CanValidate(string mediaType)
{
return mediaType.Contains("json");
}
public bool CanValidate(string mediaType) => mediaType.Contains("json");

public void Validate(OpenApiMediaType mediaTypeSpec, OpenApiDocument openApiDocument, HttpContent content)
{
if (mediaTypeSpec?.Schema == null) return;
if (mediaTypeSpec?.Schema == null)
{
return;
}

var instance = JToken.Parse(content.ReadAsStringAsync().Result);
if (!_jsonValidator.Validate(mediaTypeSpec.Schema, openApiDocument, instance, out IEnumerable<string> errorMessages))
{
throw new ContentDoesNotMatchSpecException(string.Join(Environment.NewLine, errorMessages));
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,9 @@

namespace Swashbuckle.AspNetCore.ApiTesting
{
public class JsonAllOfValidator : IJsonValidator
public class JsonAllOfValidator(JsonValidator jsonValidator) : IJsonValidator
{
private JsonValidator _jsonValidator;

public JsonAllOfValidator(JsonValidator jsonValidator)
{
_jsonValidator = jsonValidator;
}
private JsonValidator _jsonValidator = jsonValidator;

public bool CanValidate(OpenApiSchema schema) => schema.AllOf != null && schema.AllOf.Any();

Expand All @@ -26,14 +21,16 @@ public bool Validate(

var allOfArray = schema.AllOf.ToArray();

for (int i=0;i<allOfArray.Length;i++)
for (int i = 0; i < allOfArray.Length; i++)
{
if (!_jsonValidator.Validate(allOfArray[i], openApiDocument, instance, out IEnumerable<string> subErrorMessages))
{
errorMessagesList.AddRange(subErrorMessages.Select(msg => $"{msg} (allOf[{i}])"));
}
}

errorMessages = errorMessagesList;
return !errorMessages.Any();
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
using System.Linq;
using System.Collections.Generic;
using System.Linq;
using Microsoft.OpenApi.Models;
using Newtonsoft.Json.Linq;

namespace Swashbuckle.AspNetCore.ApiTesting
{
public class JsonAnyOfValidator : IJsonValidator
public class JsonAnyOfValidator(JsonValidator jsonValidator) : IJsonValidator
{
private JsonValidator _jsonValidator;

public JsonAnyOfValidator(JsonValidator jsonValidator)
{
_jsonValidator = jsonValidator;
}
private JsonValidator _jsonValidator = jsonValidator;

public bool CanValidate(OpenApiSchema schema) => schema.AnyOf != null && schema.AnyOf.Any();

Expand All @@ -26,11 +21,11 @@ public bool Validate(

var anyOfArray = schema.AnyOf.ToArray();

for (int i=0;i<anyOfArray.Length;i++)
for (int i = 0; i < anyOfArray.Length; i++)
{
if (_jsonValidator.Validate(anyOfArray[i], openApiDocument, instance, out IEnumerable<string> subErrorMessages))
{
errorMessages = Enumerable.Empty<string>();
errorMessages = [];
return true;
}

Expand All @@ -41,4 +36,4 @@ public bool Validate(
return !errorMessages.Any();
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
using System;
using System.Linq;
using System.Collections.Generic;
using System.Linq;
using Microsoft.OpenApi.Models;
using Newtonsoft.Json.Linq;

namespace Swashbuckle.AspNetCore.ApiTesting
{
public class JsonArrayValidator : IJsonValidator
public class JsonArrayValidator(IJsonValidator jsonValidator) : IJsonValidator
{
private readonly IJsonValidator _jsonValidator;

public JsonArrayValidator(IJsonValidator jsonValidator)
{
_jsonValidator = jsonValidator;
}
private readonly IJsonValidator _jsonValidator = jsonValidator;

public bool CanValidate(OpenApiSchema schema) => schema.Type == "array";

Expand All @@ -25,7 +19,7 @@ public bool Validate(
{
if (instance.Type != JTokenType.Array)
{
errorMessages = new[] { $"Path: {instance.Path}. Instance is not of type 'array'" };
errorMessages = [$"Path: {instance.Path}. Instance is not of type 'array'"];
return false;
}

Expand All @@ -38,24 +32,32 @@ public bool Validate(
foreach (var itemInstance in arrayInstance)
{
if (!_jsonValidator.Validate(schema.Items, openApiDocument, itemInstance, out IEnumerable<string> itemErrorMessages))
{
errorMessagesList.AddRange(itemErrorMessages);
}
}
}

// maxItems
if (schema.MaxItems.HasValue && (arrayInstance.Count() > schema.MaxItems.Value))
if (schema.MaxItems.HasValue && (arrayInstance.Count > schema.MaxItems.Value))
{
errorMessagesList.Add($"Path: {instance.Path}. Array size is greater than maxItems");
}

// minItems
if (schema.MinItems.HasValue && (arrayInstance.Count() < schema.MinItems.Value))
if (schema.MinItems.HasValue && (arrayInstance.Count < schema.MinItems.Value))
{
errorMessagesList.Add($"Path: {instance.Path}. Array size is less than minItems");
}

// uniqueItems
if (schema.UniqueItems.HasValue && (arrayInstance.Count() != arrayInstance.Distinct().Count()))
if (schema.UniqueItems.HasValue && (arrayInstance.Count != arrayInstance.Distinct().Count()))
{
errorMessagesList.Add($"Path: {instance.Path}. Array does not contain uniqueItems");
}

errorMessages = errorMessagesList;
return !errorMessages.Any();
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
using System.Collections.Generic;
using System.Linq;
using Microsoft.OpenApi.Models;
using Newtonsoft.Json.Linq;

Expand All @@ -17,12 +16,12 @@ public bool Validate(
{
if (instance.Type != JTokenType.Boolean)
{
errorMessages = new[] { $"Path: {instance.Path}. Instance is not of type 'boolean'" };
errorMessages = [$"Path: {instance.Path}. Instance is not of type 'boolean'"];
return false;
}

errorMessages = Enumerable.Empty<string>();
errorMessages = [];
return true;
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
using System.Collections.Generic;
using System.Linq;
using Microsoft.OpenApi.Models;
using Newtonsoft.Json.Linq;

Expand All @@ -17,12 +16,12 @@ public bool Validate(
{
if (instance.Type != JTokenType.Null)
{
errorMessages = new[] { $"Path: {instance.Path}. Instance is not of type 'null'" };
errorMessages = [$"Path: {instance.Path}. Instance is not of type 'null'"];
return false;
}

errorMessages = Enumerable.Empty<string>();
errorMessages = [];
return true;
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using System.Linq;
using System.Collections.Generic;
using System.Linq;
using Microsoft.OpenApi.Models;
using Newtonsoft.Json.Linq;

Expand All @@ -15,9 +15,9 @@ public bool Validate(
JToken instance,
out IEnumerable<string> errorMessages)
{
if (!new[] { JTokenType.Float, JTokenType.Integer }.Contains(instance.Type))
if (instance.Type is not JTokenType.Float and not JTokenType.Integer)
{
errorMessages = new[] { $"Path: {instance.Path}. Instance is not of type 'number'" };
errorMessages = [$"Path: {instance.Path}. Instance is not of type 'number'"];
return false;
}

Expand All @@ -26,32 +26,42 @@ public bool Validate(

// multipleOf
if (schema.MultipleOf.HasValue && ((numberValue % schema.MultipleOf.Value) != 0))
{
errorMessagesList.Add($"Path: {instance.Path}. Number is not evenly divisible by multipleOf");
}

// maximum & exclusiveMaximum
if (schema.Maximum.HasValue)
{
var exclusiveMaximum = schema.ExclusiveMaximum.HasValue ? schema.ExclusiveMaximum.Value : false;
var exclusiveMaximum = schema.ExclusiveMaximum ?? false;

if (exclusiveMaximum && (numberValue >= schema.Maximum.Value))
{
errorMessagesList.Add($"Path: {instance.Path}. Number is greater than, or equal to, maximum");
}
else if (numberValue > schema.Maximum.Value)
{
errorMessagesList.Add($"Path: {instance.Path}. Number is greater than maximum");
}
}

// minimum & exclusiveMinimum
if (schema.Minimum.HasValue)
{
var exclusiveMinimum = schema.ExclusiveMinimum.HasValue ? schema.ExclusiveMinimum.Value : false;
var exclusiveMinimum = schema.ExclusiveMinimum ?? false;

if (exclusiveMinimum && (numberValue <= schema.Minimum.Value))
{
errorMessagesList.Add($"Path: {instance.Path}. Number is less than, or equal to, minimum");
}
else if (numberValue < schema.Minimum.Value)
{
errorMessagesList.Add($"Path: {instance.Path}. Number is less than minimum");
}
}

errorMessages = errorMessagesList;
return !errorMessages.Any();
}
}
}
}
Loading