merge conflict resolved

Author: mihaj

.github/workflows/dotnet-core.yml

@@ -1,8 +1,6 @@
 name: Build .NET Library
 
 on:
-  push:
-    branches: [ develop ]
   pull_request:
     branches: [ develop, main ]
   release:

.github/workflows/sonarqube-analysis.yml

@@ -28,7 +28,7 @@ jobs:
         sonarOrganization: qatoolkit
         dotnetBuildArguments: ./src/QAToolKit.Source.Swagger/QAToolKit.Source.Swagger.csproj
         dotnetTestArguments: ./src/QAToolKit.Source.Swagger.Test/QAToolKit.Source.Swagger.Test.csproj /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
-        sonarBeginArguments: /d:sonar.verbose="true" /d:sonar.language="cs" /d:sonar.cs.opencover.reportsPaths="**/coverage.opencover.xml" /d:sonar.coverage.exclusions="**Tests.cs"
+        sonarBeginArguments: /d:sonar.verbose="true" /d:sonar.language="cs" /d:sonar.cs.opencover.reportsPaths="**/*.opencover.xml"
         sonarHostname: "https://sonarcloud.io"
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Directory.Build.props

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <Version>0.3.0</Version>
+    <Version>0.3.5</Version>
   </PropertyGroup>
 </Project>

README.md

@@ -1,8 +1,8 @@
 # QAToolKit.Source.Swagger
-![https://github.com/qatoolkit/qatoolkit-source-swagger-net/actions](https://github.com/qatoolkit/qatoolkit-source-swagger-net/workflows/.NET%20Core/badge.svg)
-![https://github.com/qatoolkit/qatoolkit-source-swagger-net/security/code-scanning](https://github.com/qatoolkit/qatoolkit-source-swagger-net/workflows/CodeQL%20Analyze/badge.svg)
-![https://sonarcloud.io/dashboard?id=qatoolkit_qatoolkit-source-swagger-net](https://github.com/qatoolkit/qatoolkit-source-swagger-net/workflows/Sonarqube%20Analyze/badge.svg)
-![https://www.nuget.org/packages/QAToolKit.Source.Swagger/](https://img.shields.io/nuget/v/QAToolKit.Source.Swagger?label=QAToolKit.Source.Swagger)
+[![Build .NET Library](https://github.com/qatoolkit/qatoolkit-source-swagger-net/workflows/.NET%20Core/badge.svg)](https://github.com/qatoolkit/qatoolkit-source-swagger-net/actions)
+[![CodeQL](https://github.com/qatoolkit/qatoolkit-source-swagger-net/workflows/CodeQL%20Analyze/badge.svg)](https://github.com/qatoolkit/qatoolkit-source-swagger-net/security/code-scanning)
+[![Sonarcloud Quality gate](https://github.com/qatoolkit/qatoolkit-source-swagger-net/workflows/Sonarqube%20Analyze/badge.svg)](https://sonarcloud.io/dashboard?id=qatoolkit_qatoolkit-source-swagger-net)
+[![NuGet package](https://img.shields.io/nuget/v/QAToolKit.Source.Swagger?label=QAToolKit.Source.Swagger)](https://www.nuget.org/packages/QAToolKit.Source.Swagger/)
 
 ## Description
 `QAToolKit.Source.Swagger` is a .NET library, which generates `IEnumerable<HttpRequest>` object that is the input for other components.
@@ -50,10 +50,29 @@ The above code is quite simple, but it needs some explanation.
 #### 1. AddBasicAuthentication
 If your Swagger.json files are protected by basic authentication, you can set those with `AddBasicAuthentication`.
 
-#### 2. AddRequestFilters
+#### 2. AddNTLMAuthentication
+If your Swagger.json files are protected by Windows (NTLM) authentication, you can add it with `AddNTLMAuthentication`. There are two overrides which you can use.
+
+```csharp
+SwaggerUrlSource swaggerSource = new SwaggerUrlSource(
+    options =>
+    {
+        options.AddNTLMAuthentication("myuser", "mypassword");
+    ....
+
+//or use default security context (logged in user)
+
+SwaggerUrlSource swaggerSource = new SwaggerUrlSource(
+    options =>
+    {
+        options.AddNTLMAuthentication();
+    ...
+```
+
+#### 3. AddRequestFilters
 Filters comprise of different types. Those are `AuthenticationTypes`, `TestTypes` and `EndpointNameWhitelist`. All are optional.
 
-##### 2.1. AuthenticationTypes
+##### 3.1. AuthenticationTypes
 Here we specify a list of Authentication types, that will be filtered out from the whole swagger file. This is where QA Tool Kit presents a convention.
 The built-in types are:
 - `AuthenticationType.Customer` which specifies a string `"@customer"`,
@@ -81,7 +100,7 @@ This is an example from swagger.json excerpt:
 
 Parser then finds those string in the description field and populates the `RequestFilter` property.
 
-##### 2.2 TestTypes
+##### 3.2 TestTypes
 Similarly as in the `AuthenticationTypes` you can filter out certain endpoints to be used in different test scenarios. Currently library supports:
 
 - TestType.LoadTest which specifies a string `"@loadtest"`,
@@ -103,13 +122,13 @@ The same swagger.json excerpt which support test type tags might look like this:
 
 If you feed the list of `HttpRequest` objects with load type tags to the library like `QAToolKit.Engine.Bombardier`, only those requests will be tested.
 
-##### 2.3 EndpointNameWhitelist
+##### 3.3 EndpointNameWhitelist
 Final `RequestFilter` option is `EndpointNameWhitelist`. You can specify a list of endpoints that will be included in the results.
 
 Every other endpoint will be excluded from the results. In the sample above we have set the result to include only `GetCategories` endpoint. 
 That corresponds to the `operationId` in the swagger file above.
 
-#### 3. AddBaseUrl
+#### 4. AddBaseUrl
 Your swagger file has a `Server section`, where you can specify an server URI and can be absolute or relative. An example of relative server section is:
 ```json
 "servers": [
@@ -120,7 +139,7 @@ Your swagger file has a `Server section`, where you can specify an server URI an
 ```
 In case of relative paths you need to add an absolute base URL to `Swagger Processor` with `AddBaseUrl`, otherwise the one from the `Servers section` will be used.
 
-#### 4. UseSwaggerExampleValues
+#### 5. UseSwaggerExampleValues
 You can set `UseSwaggerExampleValues = true` in the SwaggerOptions when creating new Swagger source object. This will
 check Swagger for example files and populate those.
 

qatoolkit-64x64.png

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>net5.0</TargetFramework>
-
+	<LangVersion>latest</LangVersion>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 

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

@@ -28,8 +28,43 @@ public void SwaggerBasicAuthTest_Successful()
             Assert.Equal("user", options.UserName);
             Assert.Equal("password", options.Password);
             Assert.True(options.UseBasicAuth);
+            Assert.False(options.UseNTLMAuth);
         }
 
+        [Fact]
+        public void SwaggerNTLMAuthTest_Successful()
+        {
+            var options = new SwaggerOptions();
+            options.AddNTLMAuthentication("user", "password");
+
+            Assert.Equal("user", options.UserName);
+            Assert.Equal("password", options.Password);
+            Assert.False(options.UseBasicAuth);
+            Assert.True(options.UseNTLMAuth);
+        }
+
+        [Theory]
+        [InlineData("","")]
+        [InlineData(null, null)]
+        [InlineData(null, "test")]
+        [InlineData("test", null)]
+        public void SwaggerNTLMAuthTest_Fails(string userName, string password)
+        {
+            var options = new SwaggerOptions();
+            Assert.Throws<ArgumentNullException>(() => options.AddNTLMAuthentication(userName, password));
+        }
+
+        [Fact]
+        public void SwaggerNTLMAuthWithDefaultUserTest_Successful()
+        {
+            var options = new SwaggerOptions();
+            options.AddNTLMAuthentication();
+
+            Assert.Null(options.UserName);
+            Assert.Null( options.Password);
+            Assert.False(options.UseBasicAuth);
+            Assert.True(options.UseNTLMAuth);
+        }
 
         [Fact]
         public void SwaggerAuthenticationTypeRequestFiltersTest_Successful()

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

@@ -86,5 +86,49 @@ await Assert.ThrowsAsync<ArgumentNullException>(async () => await urlSource.Load
                       new Uri("https://github.com")
                 }));
         }
+
+        [Fact]
+        public async Task SwaggerUrlSourceWithBasicAuthTest_Successfull()
+        {
+            var swaggerSource = new SwaggerUrlSource(
+              options =>
+              {
+                  options.AddRequestFilters(new RequestFilter()
+                  {
+                      EndpointNameWhitelist = new string[] { "getPetById", "addPet" }
+                  });
+                  options.AddBasicAuthentication("test", "test");
+              });
+
+            var requests = await swaggerSource.Load(new Uri[] {
+                   new Uri("https://petstore3.swagger.io/api/v3/openapi.json")
+              });
+
+            _logger.LogInformation(JsonConvert.SerializeObject(requests, Formatting.Indented));
+
+            Assert.NotNull(requests);
+        }
+
+        [Fact]
+        public async Task SwaggerUrlSourceWithNTLMAuthTest_Successfull()
+        {
+            var swaggerSource = new SwaggerUrlSource(
+              options =>
+              {
+                  options.AddRequestFilters(new RequestFilter()
+                  {
+                      EndpointNameWhitelist = new string[] { "getPetById", "addPet" }
+                  });
+                  options.AddNTLMAuthentication("test", "test");
+              });
+
+            var requests = await swaggerSource.Load(new Uri[] {
+                   new Uri("https://petstore3.swagger.io/api/v3/openapi.json")
+              });
+
+            _logger.LogInformation(JsonConvert.SerializeObject(requests, Formatting.Indented));
+
+            Assert.NotNull(requests);
+        }
     }
 }

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

@@ -19,8 +19,8 @@
 		<PackageProjectUrl>https://github.com/qatoolkit/qatoolkit-source-swagger-net</PackageProjectUrl>
 		<PackageIcon>qatoolkit-64x64.png</PackageIcon>
 		<RepositoryUrl>https://github.com/qatoolkit/qatoolkit-source-swagger-net</RepositoryUrl>
-		<PackageTags>qatoolkit-source-swagger-net;.net;c#;f#;swagger;dotnet;netstandard</PackageTags>
-		<Configurations>Debug;Release;Debug With Project References</Configurations>
+		<PackageTags>qatoolkit-source-swagger-net;.net;c#;f#;swagger;dotnet;netstandard;net5</PackageTags>
+		<Configurations>Debug;Release</Configurations>
 	</PropertyGroup>
 
 	<PropertyGroup>

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

@@ -19,6 +19,10 @@ public class SwaggerOptions
         /// </summary>
         internal bool UseBasicAuth { get; private set; } = false;
         /// <summary>
+        /// Is Swagger protected with NTLM authentication?
+        /// </summary>
+        internal bool UseNTLMAuth { get; private set; } = false;
+        /// <summary>
         /// Use request filters?
         /// </summary>
         internal bool UseRequestFilter { get; private set; } = false;
@@ -38,6 +42,10 @@ public class SwaggerOptions
         /// Use Swagger example values that come with Swagger file
         /// </summary>
         public bool UseSwaggerExampleValues { get; set; } = false;
+        /// <summary>
+        /// Disable SSL validation when accessing swagger.json file
+        /// </summary>
+        public bool DisableSSLValidation { get; set; } = false;
 
         /// <summary>
         /// Add basic authentication
@@ -48,16 +56,50 @@ public class SwaggerOptions
         public SwaggerOptions AddBasicAuthentication(string userName, string password)
         {
             if (string.IsNullOrEmpty(userName))
-                throw new ArgumentException(nameof(userName));
+                throw new ArgumentNullException($"{nameof(userName)} is null.");
             if (string.IsNullOrEmpty(password))
-                throw new ArgumentException(nameof(password));
+                throw new ArgumentNullException($"{nameof(password)} is null.");
 
             UseBasicAuth = true;
+            UseNTLMAuth = false;
             UserName = userName;
             Password = password;
             return this;
         }
 
+        /// <summary>
+        /// Add NTLM authentication
+        /// </summary>
+        /// <param name="userName"></param>
+        /// <param name="password"></param>
+        /// <returns></returns>
+        public SwaggerOptions AddNTLMAuthentication(string userName, string password)
+        {
+            if (string.IsNullOrEmpty(userName))
+                throw new ArgumentNullException($"{nameof(userName)} is null.");
+            if (string.IsNullOrEmpty(password))
+                throw new ArgumentNullException($"{nameof(password)} is null.");
+
+            UseBasicAuth = false;
+            UseNTLMAuth = true;
+            UserName = userName;
+            Password = password;
+            return this;
+        }
+
+        /// <summary>
+        /// Add Default NTLM authentication which represents the authentication credentials for the current security context in which the application is running.
+        /// </summary>
+        /// <returns></returns>
+        public SwaggerOptions AddNTLMAuthentication()
+        {
+            UseBasicAuth = false;
+            UseNTLMAuth = true;
+            UserName = null;
+            Password = null;
+            return this;
+        }
+
         /// <summary>
         /// Use request filters
         /// </summary>
@@ -66,7 +108,7 @@ public SwaggerOptions AddBasicAuthentication(string userName, string password)
         public SwaggerOptions AddRequestFilters(RequestFilter requestFilter)
         {
             UseRequestFilter = true;
-            RequestFilter = requestFilter ?? throw new ArgumentException(nameof(requestFilter));
+            RequestFilter = requestFilter ?? throw new ArgumentNullException($"{nameof(requestFilter)} is null.");
             return this;
         }
 
@@ -77,7 +119,7 @@ public SwaggerOptions AddRequestFilters(RequestFilter requestFilter)
         /// <returns></returns>
         public SwaggerOptions AddBaseUrl(Uri baseUrl)
         {
-            BaseUrl = baseUrl ?? throw new ArgumentException(nameof(baseUrl));
+            BaseUrl = baseUrl ?? throw new ArgumentNullException($"{nameof(baseUrl)} is null.");
             return this;
         }
     }

src/QAToolKit.Source.Swagger/SwaggerOptions.cs

@@ -5,6 +5,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Net;
 using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Text;
@@ -48,24 +49,53 @@ private async Task<IEnumerable<HttpRequest>> LoadInternal(Uri[] source)
 
             foreach (var uri in source)
             {
-                using (var httpClient = new HttpClient())
+                using (var handler = new HttpClientHandler())
                 {
-                    if (_swaggerOptions.UseBasicAuth)
+                    if (_swaggerOptions.UseNTLMAuth)
                     {
-                        var authenticationString = $"{_swaggerOptions.UserName}:{_swaggerOptions.Password}";
-                        var base64EncodedAuthenticationString = Convert.ToBase64String(ASCIIEncoding.ASCII.GetBytes(authenticationString));
-                        httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", base64EncodedAuthenticationString);
+                        var credentials = new NetworkCredential();
+                        if (string.IsNullOrEmpty(_swaggerOptions.UserName) || string.IsNullOrEmpty(_swaggerOptions.Password))
+                        {
+                            credentials = CredentialCache.DefaultNetworkCredentials;
+                        }
+                        else
+                        {
+                            credentials = new NetworkCredential(_swaggerOptions.UserName, _swaggerOptions.Password);
+                        }
+
+                        var credentialsCache = new CredentialCache { { uri, "NTLM", credentials } };
+                        handler.Credentials = credentialsCache;
                     }
 
-                    var stream = await httpClient.GetStreamAsync(uri);
+                    if (_swaggerOptions.DisableSSLValidation && (uri.Scheme == Uri.UriSchemeHttp || uri.Scheme == Uri.UriSchemeHttps))
+                    {
+                        handler.ClientCertificateOptions = ClientCertificateOption.Manual;
+                        handler.ServerCertificateCustomValidationCallback =
+                        (httpRequestMessage, cert, cetChain, policyErrors) =>
+                        {
+                            return true;
+                        };
+                    }
 
-                    var openApiDocument = new OpenApiStreamReader().Read(stream, out var diagnostic);
-                    var textWritter = new OpenApiJsonWriter(new StringWriter());
-                    openApiDocument.SerializeAsV3(textWritter);
+                    using (var httpClient = new HttpClient(handler))
+                    {
+                        if (_swaggerOptions.UseBasicAuth)
+                        {
+                            var authenticationString = $"{_swaggerOptions.UserName}:{_swaggerOptions.Password}";
+                            var base64EncodedAuthenticationString = Convert.ToBase64String(ASCIIEncoding.ASCII.GetBytes(authenticationString));
+                            httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", base64EncodedAuthenticationString);
+                        }
 
-                    var requests = processor.MapFromOpenApiDocument(new Uri($"{uri.Scheme}://{uri.Host}"), openApiDocument);
+                        var stream = await httpClient.GetStreamAsync(uri);
 
-                    restRequests.AddRange(requests);
+                        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);
+
+                        restRequests.AddRange(requests);
+                    }
                 }
             }