override baseUrl if set, xml comments updates

mihaj · web-flow · commit e0fc6ad2e0e3 · 2020-11-27T18:56:19.000+01:00
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <Version>0.3.5</Version>
+    <Version>0.3.6</Version>
   </PropertyGroup>
 </Project>
diff --git a/src/QAToolKit.Source.Swagger.Test/SwaggerFileSourceIntegrationTest.cs b/src/QAToolKit.Source.Swagger.Test/SwaggerFileSourceIntegrationTest.cs
@@ -6,6 +6,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Net.Http;
 using Xunit;
 using Xunit.Abstractions;
 
@@ -87,7 +88,44 @@ public async void SwaggerFileSourceYamlWithWhitelistTest_Fails()
 
             _logger.LogInformation(JsonConvert.SerializeObject(requests));
 
+            Assert.Equal("https://petstore3.swagger.io/api/support/v2", requests.FirstOrDefault().BasePath);
+            Assert.Equal(HttpMethod.Get, requests.FirstOrDefault().Method);
+            Assert.Equal("getSupportTicketCasesList", requests.FirstOrDefault().OperationId);
+            Assert.Empty(requests.FirstOrDefault().RequestBodies);
+            Assert.Equal(4, requests.FirstOrDefault().Responses.Count);
+            Assert.Equal(2, requests.FirstOrDefault().Parameters.Count);
+            Assert.Null(requests.FirstOrDefault().Parameters.FirstOrDefault(p => p.Name == "Area").Value);
             Assert.Single(requests);
         }
+
+        [Fact]
+        public async void SwaggerFileSourceYamlWithWhitelistAndExampleTest_Fails()
+        {
+            var fileSource = new SwaggerFileSource(options =>
+            {
+                options.AddBaseUrl(new Uri("http://localhost/"));
+                options.AddRequestFilters(new RequestFilter()
+                {
+                    EndpointNameWhitelist = new string[] { "getSupportTicketsList" }
+                });
+                options.UseSwaggerExampleValues = true;
+            });
+
+            var requests = await fileSource.Load(new List<FileInfo>() {
+                new FileInfo("Assets/support-tickets.yaml")
+            });
+
+            _logger.LogInformation(JsonConvert.SerializeObject(requests));
+
+            Assert.Equal("http://localhost/api/support/v2", requests.FirstOrDefault().BasePath);
+            Assert.Equal(HttpMethod.Get, requests.FirstOrDefault().Method);
+            Assert.Equal("getSupportTicketsList", requests.FirstOrDefault().OperationId);
+            Assert.Empty(requests.FirstOrDefault().RequestBodies);
+            Assert.Equal(4, requests.FirstOrDefault().Responses.Count);
+            Assert.Equal(2, requests.FirstOrDefault().Parameters.Count);
+            Assert.Equal("Company", requests.FirstOrDefault().Parameters.FirstOrDefault(p => p.Name == "Area").Value);
+            Assert.Single(requests);
+        }
+
     }
 }
diff --git a/src/QAToolKit.Source.Swagger.Test/SwaggerTests/BicycleApi/Get/SwaggerProcessorGetBicycleByIdTests.cs b/src/QAToolKit.Source.Swagger.Test/SwaggerTests/BicycleApi/Get/SwaggerProcessorGetBicycleByIdTests.cs
@@ -68,5 +68,50 @@ public async Task PetsSwaggerGetPetByIdWithExampleValuesTest_Successfull()
             });
             Assert.Empty(requests.FirstOrDefault().TestTypes);
         }
+
+        [Fact]
+        public async Task PetsSwaggerGetPetByIdWithExampleValuesAndDifferentBaseAddressTest_Successfull()
+        {
+            var urlSource = new SwaggerUrlSource(options =>
+            {
+                options.AddBaseUrl(new Uri("http://localhost/"));
+                options.AddRequestFilters(new RequestFilter()
+                {
+                    EndpointNameWhitelist = new string[] { "GetAllBikes" }
+                });
+                options.UseSwaggerExampleValues = true;
+            });
+
+            var requests = await urlSource.Load(new Uri[] {
+                new Uri("https://qatoolkitapi.azurewebsites.net/swagger/v1/swagger.json")
+            });
+
+            _logger.LogInformation(JsonConvert.SerializeObject(requests, Formatting.Indented));
+
+            Assert.NotNull(requests);
+            Assert.Single(requests);
+            Assert.Empty(requests.FirstOrDefault().AuthenticationTypes);
+            Assert.Equal("http://localhost/", requests.FirstOrDefault().BasePath);
+            Assert.Equal("Get all bikes", requests.FirstOrDefault().Description);
+            Assert.Equal(HttpMethod.Get, requests.FirstOrDefault().Method);
+            Assert.Equal("GetAllBikes", requests.FirstOrDefault().OperationId);
+            Assert.Equal(3, requests.FirstOrDefault().Parameters.Count);
+            Assert.Equal("/api/bicycles", requests.FirstOrDefault().Path);
+            Assert.Empty(requests.FirstOrDefault().RequestBodies);
+            Assert.Equal(2, requests.FirstOrDefault().Responses.Count);
+
+            var getBikesParameters = BicyclesParameters.Get(true).ToExpectedObject();
+            getBikesParameters.ShouldEqual(requests.FirstOrDefault().Parameters);
+
+            var expectedPetsResponse = GetBicycleByIdResponse.Get().ToExpectedObject();
+            expectedPetsResponse.ShouldEqual(requests.FirstOrDefault().Responses);
+
+            Assert.Equal("Get all bikes by filter", requests.FirstOrDefault().Summary);
+            Assert.Collection(requests.FirstOrDefault().Tags, item =>
+            {
+                item = "Public";
+            });
+            Assert.Empty(requests.FirstOrDefault().TestTypes);
+        }
     }
 }
diff --git a/src/QAToolKit.Source.Swagger/SwaggerOptions.cs b/src/QAToolKit.Source.Swagger/SwaggerOptions.cs
@@ -6,7 +6,7 @@
 namespace QAToolKit.Source.Swagger
 {
     /// <summary>
-    /// Swagger options
+    /// Swagger processor options
     /// </summary>
     public class SwaggerOptions
     {
@@ -15,15 +15,15 @@ public class SwaggerOptions
         /// </summary>
         internal RequestFilter RequestFilter { get; private set; }
         /// <summary>
-        /// Is Swagger protected with Basic authentication?
+        /// Is Swagger protected with Basic authentication
         /// </summary>
         internal bool UseBasicAuth { get; private set; } = false;
         /// <summary>
-        /// Is Swagger protected with NTLM authentication?
+        /// Is Swagger protected with NTLM authentication
         /// </summary>
         internal bool UseNTLMAuth { get; private set; } = false;
         /// <summary>
-        /// Use request filters?
+        /// Use request filters, to process only selected endpoints.
         /// </summary>
         internal bool UseRequestFilter { get; private set; } = false;
         /// <summary>
@@ -35,20 +35,20 @@ public class SwaggerOptions
         /// </summary>
         internal string Password { get; private set; }
         /// <summary>
-        /// Set custom base API URL
+        /// Set custom base API URL to the resulting HttpRequest list.
         /// </summary>
         internal Uri BaseUrl { get; private set; }
         /// <summary>
-        /// Use Swagger example values that come with Swagger file
+        /// Use Swagger example values that come with Swagger file. Default us 'false'.
         /// </summary>
         public bool UseSwaggerExampleValues { get; set; } = false;
         /// <summary>
-        /// Disable SSL validation when accessing swagger.json file
+        /// Disable SSL validation when accessing swagger.json file. Default is 'false'.
         /// </summary>
         public bool DisableSSLValidation { get; set; } = false;
 
         /// <summary>
-        /// Add basic authentication
+        /// Add basic authentication to access swagger.json file.
         /// </summary>
         /// <param name="userName"></param>
         /// <param name="password"></param>
@@ -68,7 +68,7 @@ public SwaggerOptions AddBasicAuthentication(string userName, string password)
         }
 
         /// <summary>
-        /// Add NTLM authentication
+        /// Add NTLM authentication to access swagger.json file. Normally used when swagger is hosted in IIS.
         /// </summary>
         /// <param name="userName"></param>
         /// <param name="password"></param>
@@ -101,7 +101,7 @@ public SwaggerOptions AddNTLMAuthentication()
         }
 
         /// <summary>
-        /// Use request filters
+        /// Use request filters, to process only selected endpoints.
         /// </summary>
         /// <param name="requestFilter"></param>
         /// <returns></returns>
@@ -113,7 +113,7 @@ public SwaggerOptions AddRequestFilters(RequestFilter requestFilter)
         }
 
         /// <summary>
-        /// Add base url
+        /// Add base url, which will override swagger.json URL in the 'HttpRequest' list
         /// </summary>
         /// <param name="baseUrl"></param>
         /// <returns></returns>
diff --git a/src/QAToolKit.Source.Swagger/SwaggerRequestFilter.cs b/src/QAToolKit.Source.Swagger/SwaggerRequestFilter.cs
@@ -6,7 +6,7 @@
 namespace QAToolKit.Source.Swagger
 {
     /// <summary>
-    /// Swagger request filtering
+    /// Swagger request filtering by OperationId, TestType or AuthenticationType
     /// </summary>
     public class SwaggerRequestFilter
     {
diff --git a/src/QAToolKit.Source.Swagger/SwaggerUrlSource.cs b/src/QAToolKit.Source.Swagger/SwaggerUrlSource.cs
@@ -14,7 +14,7 @@
 namespace QAToolKit.Source.Swagger
 {
     /// <summary>
-    /// Swagger Url source
+    /// Load Swagger from url source
     /// </summary>
     public class SwaggerUrlSource : ITestSource<Uri[], IEnumerable<HttpRequest>>
     {
@@ -92,7 +92,17 @@ private async Task<IEnumerable<HttpRequest>> LoadInternal(Uri[] source)
                         var textWritter = new OpenApiJsonWriter(new StringWriter());
                         openApiDocument.SerializeAsV3(textWritter);
 
-                        var requests = processor.MapFromOpenApiDocument(new Uri($"{uri.Scheme}://{uri.Host}"), openApiDocument);
+                        Uri url;
+                        if (_swaggerOptions.BaseUrl != null)
+                        {
+                            url = _swaggerOptions.BaseUrl;
+                        }
+                        else
+                        {
+                            url = new Uri($"{uri.Scheme}://{uri.Host}");
+                        }
+
+                        var requests = processor.MapFromOpenApiDocument(url, openApiDocument);
 
                         restRequests.AddRange(requests);
                     }

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`namespace QAToolKit.Source.Swagger`
`7`	`7`	`{`
`8`	`8`	`/// <summary>`
`9`		`- /// Swagger request filtering`
	`9`	`+ /// Swagger request filtering by OperationId, TestType or AuthenticationType`
`10`	`10`	`/// </summary>`
`11`	`11`	`public class SwaggerRequestFilter`
`12`	`12`	`{`