Before release merge to main

* new tests, updated with latest core library

* bombardier binaries update, more tests, bombardier inline JSON body instead of files, switch generation improvement

* bombardier generators refactorings

* helpers refactored, replacement values introduced, more tests

* alpha 1

* nuget tests update, readme file update

* POST and PUT tests

* custome xception, HTTP DELETE test, cleanup

* cleanup

* run real load tests only in debug

* xunit fact attribute

* relacement values to dictionary, additional tests

* code analysis yml and run build only on pull request

Author: mihaj

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,65 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+# ******** NOTE ********
+
+name: "CodeQL"
+
+on:
+  pull_request:
+    branches: [ develop ]
+  schedule:
+    - cron: '36 12 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'csharp' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/dotnet-core.yml

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

Directory.Build.props

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

README.md

@@ -1,42 +1,41 @@
 # QAToolKit.Engine.Bombardier
 ![.NET Core](https://github.com/qatoolkit/qatoolkit-engine-bombardier-net/workflows/.NET%20Core/badge.svg?branch=main)
 
-`QAToolKit.Engine.Bombardier` is a .NET standard library, which takes `IList<HttpTestRequest>` object and runs load tests with tool called [Bombardier](https://github.com/codesenberg/bombardier).
+`QAToolKit.Engine.Bombardier` is a .NET standard library, which takes `IEnumerable<HttpTestRequest>` object and runs load tests with tool called [Bombardier](https://github.com/codesenberg/bombardier).
 
 Library is a thin wrapper, that generates requests and parses results so you can export them to whatever format you prefer.
 
 Major features:
 
-- Library takes `IList<HttpTestRequest>` object, which can be produced in your code or can be imported from other sources. One example can be QAToolKit Swagger library that can produce that object with many options. Check it out [here](https://github.com/qatoolkit/qatoolkit-source-swagger-net).
+- Library takes `IEnumerable<HttpTestRequest>` object, which can be produced in your code or can be imported from other sources. One example can be QAToolKit Swagger library that can produce that object with many options. Check it out [here](https://github.com/qatoolkit/qatoolkit-source-swagger-net).
 - Generate a Bombardier report that can be exported to the format you want.
 
+Bombardier version [1.2.5](https://github.com/codesenberg/bombardier/releases/tag/v1.2.5) is used for `windows-amd64` and `linux-amd64`.
+
 ## Sample
 
 ```csharp
+//Generate requests from previously stored JSON file:
+var content = File.ReadAllText("Assets/getPetById.json");
+var httpRequest = JsonConvert.DeserializeObject<IEnumerable<HttpRequest>>(content);
 
-//Instantiate a Bombardier test generator, by specifying Bombardier options
+//Create bombardier tests generator
 var bombardierTestsGenerator = new BombardierTestsGenerator(options =>
 {
-    //if your api endpoints you are testing are protected by Oauth2 access tokens
-    options.AddOAuth2Token("eyJhbGciOiJSUzI1N....", AuthenticationType.Customer);
-    //if your api endpoints are protected by simple "ApiKey: <apikey>" authentication header
-    options.AddApiKey("myAPIKey123423456");
-    //if your api endpoints are protected by basic authentication
-    options.AddBasicAuthentication("username", "password");
     options.BombardierConcurrentUsers = 1;
     options.BombardierDuration = 1;
     options.BombardierTimeout = 30;
     options.BombardierUseHttp2 = true;
 });
-//Generate Bombardier Tests
-var bombardierTests = await bombardierTestsGenerator.Generate(requests);
+
+//Generate bomardier tests
+var bombardierTests = await bombardierTestsGenerator.Generate(httpRequest);
 
 //Run Bombardier Tests
-var bombardierTestsRunner = new BombardierTestsRunner(bombardierTests.ToList(),
-    options =>
-    {
-        options.ObfuscateAuthenticationHeader = false;
-    });
+var bombardierTestsRunner = new BombardierTestsRunner(bombardierTests.ToList(), options =>
+{
+    options.ObfuscateAuthenticationHeader = true;
+});
 var bombardierResults = await bombardierTestsRunner.Run();
 ```
 
@@ -80,27 +79,65 @@ Use `AddApiKey` if your APIs are protected by simple API Key. Pass Api Key in th
 ##### 1.3 AddBasicAuthentication
 Use `AddBasicAuthentication` if your APIs are protected by basic authentication. Pass username and password in the method. A basic `Authentication` HTTP header will be generated. This is not best practice, but it's here if you need it.
 
-#### 2. Bombardier parameters
+##### 1.4 AddReplacementValues
+When you use `AddReplacementValues` values those can set or replace URL and HTTP body parameters before executing the tests. Replacement values have precedence over the `example` values that are set in Swagger file.
 
-You can set 5 Bombardier properties:
-
-- `BombardierConcurrentUsers`: How many concurrent users should be used in Bombardier tests.
-- `BombardierDuration`: How long the Bombardier tests should execute in seconds. Use this depending on the type of test you want to perform and should not be used with `BombardierRateLimit`.
-- `BombardierTimeout`: What is the Bombardier timeout to wait for the requests to finish.
-- `BombardierUseHttp2`: Use HTTP2?
-- `BombardierRateLimit`: Rate limit Bombardier tests per second. Use this depending on the type of test you want to perform and should not be used with `BombardierDuration`.
+#### 2. Bombardier parameters
 
+You can also set those `BombardierGeneratorOptions` options:
+
+- `BombardierConcurrentUsers`: How many concurrent users should be used in Bombardier tests. Default is `3`.
+- `BombardierDuration`: How long the Bombardier tests should execute in seconds. Use this depending on the type of test you want to perform and should not be used with `BombardierRateLimit`. Default is `30` seconds.
+- `BombardierTimeout`: What is the Bombardier timeout to wait for the requests to finish. Default is `30` seconds.
+- `BombardierUseHttp2`: Use HTTP2 protocol. Otherwise HTTP1 is used. By default this is set to `true`.
+- `BombardierRateLimit`: Rate limit Bombardier tests per second. Use this depending on the type of test you want to perform and should not be used with `BombardierDuration`. By default rate limit is not set.
+- `BombardierNumberOfTotalRequests`: Limit the test to run only certain amount of requests. By default total number of requests is not set.
+- `BombardierInsecure`: Instead of HTTPS use HTTP protocol. Default value is `false`.
+- `BombardierBodyContentType`: Force only certain HTTP Content type. By default is set to `application/json`.
+ 
 #### 3. Obfuscate Auth tokens for Bombardier output
 
 Output is obfuscated by default, but you can turn it off with `options.ObfuscateAuthenticationHeader = false;` in `BombardierTestsRunner` options.
 
 ## How to use
 
-TO-DO
+In the sample code above we generate HTTP requests from previously generated object which was serialized to JSON.
+
+If you use Swagger files, you need to check the `QAToolKit.Source.Swagger` NuGet package, where you can generate that object from the Swagger file.
+
+Let's replace
+
+```csharp
+//Generate requests from previously stored JSON file:
+var content = File.ReadAllText("Assets/getPetById.json");
+var httpRequest = JsonConvert.DeserializeObject<IEnumerable<HttpRequest>>(content);
+```
+
+with
+
+```csharp
+//Setup Swagger source
+var urlSource = new SwaggerUrlSource(options =>
+{
+    options.AddBaseUrl(new Uri("https://qatoolkitapi.azurewebsites.net/"));
+    options.AddRequestFilters(new RequestFilter()
+    {
+        EndpointNameWhitelist = new string[] { "GetAllBikes" }
+    });
+    options.UseSwaggerExampleValues = true;
+});
+
+//Load requests object
+var requests = await urlSource.Load(new Uri[] {
+    new Uri("https://qatoolkitapi.azurewebsites.net/swagger/v1/swagger.json")
+});
+```
+
+in the sample code above. Check the [QAToolKit.Source.Swagger](https://github.com/qatoolkit/qatoolkit-source-swagger-net) library for more details.
 
 ## TO-DO
 
-N/A
+- Currently tested for GET, POST, PUT and DELETE HTTP methods. Need to extend support.
 
 ## License