swagger servers section support, filters bug fix, tests

Author: mihaj

Directory.Build.props

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <Version>0.1.0</Version>
+    <Version>0.1.1</Version>
   </PropertyGroup>
 </Project>

src/QAToolKit.Source.Swagger.Test/QAToolKit.Source.Swagger.Test.csproj

@@ -19,4 +19,8 @@
     </PackageReference>
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\QAToolKit.Source.Swagger\QAToolKit.Source.Swagger.csproj" />
+  </ItemGroup>
+
 </Project>

src/QAToolKit.Source.Swagger.Test/SwaggerUrlSourceTests.cs

@@ -0,0 +1,63 @@
+using QAToolKit.Core.Models;
+using System;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace QAToolKit.Source.Swagger.Test
+{
+    public class SwaggerUrlSourceTests
+    {
+        [Fact]
+        public async Task SwaggerUrlSourceWithoutOptionsV3Test_Successfull()
+        {
+            var urlSource = new SwaggerUrlSource();
+            var requests = await urlSource.Load(
+                new Uri[]
+                {
+                      new Uri("https://petstore3.swagger.io/api/v3/openapi.json")
+                });
+
+            Assert.NotNull(requests);
+        }
+
+        [Fact]
+        public async Task SwaggerUrlSourceWithOptionsV3Test_Successfull()
+        {
+            var swaggerSource = new SwaggerUrlSource(
+              options =>
+              {
+                  options.AddRequestFilters(new RequestFilter()
+                  {
+                      EndpointNameWhitelist = new string[] { "getPetById" }
+                  });
+                  options.AddReplacementValues(new ReplacementValue[] {
+              new ReplacementValue()
+                  {
+                      Key = "petId",
+                      Value = "1"
+                  }
+                  });
+              });
+
+            var requests = await swaggerSource.Load(new Uri[] {
+                   new Uri("https://petstore3.swagger.io/api/v3/openapi.json")
+              });
+
+            Assert.NotNull(requests);
+        }
+
+
+        /* [Fact]
+         public async Task SwaggerUrlSourceWithoutOptionsV2Test_Successfull()
+         {
+             var urlSource = new SwaggerUrlSource();
+             var requests = await urlSource.Load(
+                 new Uri[]
+                 {
+                       new Uri("https://petstore.swagger.io/v2/swagger.json"),
+                 });
+
+             Assert.NotNull(requests);
+         }*/
+    }
+}

src/QAToolKit.Source.Swagger/QAToolKit.Source.Swagger.csproj

@@ -34,7 +34,7 @@
 	<ItemGroup>
 		<PackageReference Include="Microsoft.OpenApi" Version="1.2.3" />
 		<PackageReference Include="Microsoft.OpenApi.Readers" Version="1.2.3" />
-		<PackageReference Include="QAToolKit.Core" Version="0.1.0" />
+		<PackageReference Include="QAToolKit.Core" Version="0.1.1" />
 	</ItemGroup>
 
 </Project>

src/QAToolKit.Source.Swagger/SwaggerProcessor.cs

@@ -23,6 +23,20 @@ public IList<HttpTestRequest> MapFromOpenApiDocument(Uri baseUri, OpenApiDocumen
         {
             var requests = new List<HttpTestRequest>();
 
+            var server = openApiDocument.Servers.FirstOrDefault();
+            if (server != null)
+            {
+                var tempUri = new Uri(server.Url, UriKind.RelativeOrAbsolute);
+                if (tempUri.IsAbsoluteUri)
+                {
+                    baseUri = tempUri;
+                }
+                else
+                {
+                    baseUri = new Uri(baseUri, tempUri);
+                }
+            }
+
             foreach (var path in openApiDocument.Paths)
             {
                 requests.AddRange(GetRestRequestsForPath(baseUri, path, replacementValues));
@@ -46,7 +60,7 @@ private IList<HttpTestRequest> GetRestRequestsForPath(Uri baseUri, KeyValuePair<
                     Description = GetDescription(operation),
                     OperationId = GetOperationId(operation),
                     Parameters = ReplaceUrlParameters(GetParameters(operation).ToList(), replacementValues).ToList(),
-                    RequestBody = ReplaceRequestBodyModel(GetRequestBody(operation), replacementValues),
+                    RequestBodies = ReplaceRequestBodyModel(GetRequestBodies(operation), replacementValues),
                     Responses = GetResponses(operation),
                     Tags = GetTags(operation),
                     AuthenticationTypes = GetAuthenticationTypes(operation),
@@ -128,9 +142,12 @@ private string GetPath(string path)
 
         private string ReplacePathParameters(string path, ReplacementValue[] replacementValues)
         {
-            foreach (var replacementValue in replacementValues)
+            if (replacementValues != null)
             {
-                path = path.Replace("{" + replacementValue.Key + "}", replacementValue.Value);
+                foreach (var replacementValue in replacementValues)
+                {
+                    path = path.Replace("{" + replacementValue.Key + "}", replacementValue.Value);
+                }
             }
 
             return path;
@@ -195,93 +212,107 @@ private IList<Parameter> GetParameters(KeyValuePair<OperationType, OpenApiOperat
 
         private IList<Parameter> ReplaceUrlParameters(List<Parameter> urlParameters, ReplacementValue[] replacementValues)
         {
-            foreach (var replacementValue in replacementValues)
+            if (replacementValues != null)
             {
-                foreach (var parameter in urlParameters)
+                foreach (var replacementValue in replacementValues)
                 {
-                    if (parameter.Name == replacementValue.Key)
+                    foreach (var parameter in urlParameters)
                     {
-                        parameter.Value = replacementValue.Value;
+                        if (parameter.Name == replacementValue.Key)
+                        {
+                            parameter.Value = replacementValue.Value;
+                        }
                     }
                 }
             }
 
             return urlParameters;
         }
 
-        private RequestBody GetRequestBody(KeyValuePair<OperationType, OpenApiOperation> openApiOperation)
+        private List<RequestBody> GetRequestBodies(KeyValuePair<OperationType, OpenApiOperation> openApiOperation)
         {
             try
             {
+                var requests = new List<RequestBody>();
+
                 if (openApiOperation.Value.RequestBody == null)
                 {
-                    return new RequestBody();
+                    return new List<RequestBody>();
                 }
 
                 if (openApiOperation.Value.RequestBody.Content.Count == 0)
                 {
-                    return new RequestBody();
-                }
-
-                if (openApiOperation.Value.RequestBody.Content.FirstOrDefault().Value.Schema.Properties.Count == 0)
-                {
-                    return new RequestBody();
+                    return new List<RequestBody>();
                 }
 
-                var requestBody = new RequestBody
+                foreach (var contentType in openApiOperation.Value.RequestBody.Content)
                 {
-                    Name = openApiOperation.Value.RequestBody.Content.FirstOrDefault().Value.Schema.Reference.Id,
-                    Properties = new List<Property>()
-                };
+                    var requestBody = new RequestBody
+                    {
+                        Name = contentType.Value.Schema.Reference != null ? contentType.Value.Schema.Reference.Id : "N/A",
+                        ContentType = contentType.Key,
+                        Properties = new List<Property>()
+                    };
 
-                foreach (var property in openApiOperation.Value.RequestBody.Content.FirstOrDefault().Value.Schema.Properties)
-                {
-                    requestBody.Properties.Add(new Property()
+                    foreach (var property in contentType.Value.Schema.Properties)
                     {
-                        Name = property.Key,
-                        Description = property.Value.Description,
-                        Type = property.Value.Type,
-                    });
+                        requestBody.Properties.Add(new Property()
+                        {
+                            Name = property.Key,
+                            Description = property.Value.Description,
+                            Type = property.Value.Type,
+                        });
+                    }
+
+                    requests.Add(requestBody);
                 }
 
-                return requestBody;
+                return requests;
             }
             catch (Exception ex)
             {
                 var msg = ex.Message;
-                return new RequestBody();
+                return new List<RequestBody>();
             }
         }
 
-        private RequestBody ReplaceRequestBodyModel(RequestBody requestBody, ReplacementValue[] replacementValues)
+        private List<RequestBody> ReplaceRequestBodyModel(List<RequestBody> requestBodies, ReplacementValue[] replacementValues)
         {
-            if (requestBody.Properties == null)
-            {
-                return requestBody;
-            }
 
-            var requestBodyResult = new RequestBody
+            foreach (var requestBody in requestBodies)
             {
-                Name = requestBody.Name
-            };
+                if (requestBody.Properties == null)
+                {
+                    continue;
+                }
 
-            foreach (var replacementValue in replacementValues)
-            {
-                var prop = requestBody.Properties.FirstOrDefault(p => p.Name == replacementValue.Key);
+                var requestBodyResult = new RequestBody
+                {
+                    Name = requestBody.Name,
+                    Properties = new List<Property>()
+                };
 
-                if (prop != null)
+                if (replacementValues != null)
                 {
-                    requestBodyResult.Properties.Add(new Property()
+                    foreach (var replacementValue in replacementValues)
                     {
-                        Description = prop.Description,
-                        Name = prop.Name,
-                        Type = prop.Type,
-                        Value = replacementValue.Value
-                    });
+                        var prop = requestBody.Properties.FirstOrDefault(p => p.Name == replacementValue.Key);
+
+                        if (prop != null)
+                        {
+                            requestBodyResult.Properties.Add(new Property()
+                            {
+                                Description = prop.Description,
+                                Name = prop.Name,
+                                Type = prop.Type,
+                                Value = replacementValue.Value
+                            });
+                        }
+                    }
                 }
             }
 
-            return requestBodyResult;
+            return requestBodies;
         }
 
         private List<Response> GetResponses(KeyValuePair<OperationType, OpenApiOperation> openApiOperation)

src/QAToolKit.Source.Swagger/SwaggerUrlSource.cs

@@ -1,8 +1,10 @@
 using Microsoft.OpenApi.Readers;
+using Microsoft.OpenApi.Writers;
 using QAToolKit.Core.Interfaces;
 using QAToolKit.Core.Models;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Net.Http;
 using System.Net.Http.Headers;
@@ -55,6 +57,8 @@ public async Task<IList<HttpTestRequest>> Load(Uri[] source)
                     var stream = await httpClient.GetStreamAsync(uri);
 
                     var openApiDocument = new OpenApiStreamReader().Read(stream, out var diagnostic);
+                    var textWritter = new OpenApiJsonWriter(new StringWriter());
+                    openApiDocument.SerializeAsV3(textWritter);
 
                     var requests = processor.MapFromOpenApiDocument(new Uri($"{uri.Scheme}://{uri.Host}"), openApiDocument, _swaggerOptions.ReplacementValues);
 
@@ -81,12 +85,12 @@ private List<HttpTestRequest> FilterRequests(IList<HttpTestRequest> requests, Re
                 requestsLocal.AddRange(requests.Where(request => requestFilter.AuthenticationTypes.ToList().Any(x => x == request.AuthenticationTypes)));
             }
 
-            if (requestFilter.EndpointNameWhitelist != null)
+            if (requestFilter.TestTypes != null)
             {
                 requestsLocal.AddRange(requests.Where(request => requestFilter.TestTypes.ToList().Any(x => x == request.TestTypes)));
             }
 
-            if (requestFilter.TestTypes != null)
+            if (requestFilter.EndpointNameWhitelist != null)
             {
                 requestsLocal.AddRange(requests.Where(request => requestFilter.EndpointNameWhitelist.Any(x => x == request.OperationId)));
             }