Skip to content

Commit 510771b

Browse files
mihajmihaj
committed
XML comments
1 parent 829acb8 commit 510771b

File tree

6 files changed

+85
-6
lines changed

6 files changed

+85
-6
lines changed

‎src/QAToolKit.Engine.Bombardier/BombardierResult.cs‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,75 @@
33

44
namespace QAToolKit.Engine.Bombardier
55
{
6+
/// <summary>
7+
/// Results of Bombardier test
8+
/// </summary>
69
public class BombardierResult : ILoadTestResult
710
{
11+
/// <summary>
12+
/// Test start time
13+
/// </summary>
814
public DateTime TestStart { get; set; }
15+
/// <summary>
16+
/// Test stop time
17+
/// </summary>
918
public DateTime TestStop { get; set; }
19+
/// <summary>
20+
/// Test execution duration in seconds
21+
/// </summary>
1022
public double Duration { get; set; }
23+
/// <summary>
24+
/// Load test command
25+
/// </summary>
1126
public string Command { get; set; }
27+
/// <summary>
28+
/// Counter for 1xx HTTP status codes
29+
/// </summary>
1230
public int Counter1xx { get; set; }
31+
/// <summary>
32+
/// Counter for 2xx HTTP status codes
33+
/// </summary>
1334
public int Counter2xx { get; set; }
35+
/// <summary>
36+
/// Counter for 3xx HTTP status codes
37+
/// </summary>
1438
public int Counter3xx { get; set; }
39+
/// <summary>
40+
/// Counter for 4xx HTTP status codes
41+
/// </summary>
1542
public int Counter4xx { get; set; }
43+
/// <summary>
44+
/// Counter for 5xx HTTP status codes
45+
/// </summary>
1646
public int Counter5xx { get; set; }
47+
/// <summary>
48+
/// Average latency
49+
/// </summary>
1750
public decimal AverageLatency { get; set; }
51+
/// <summary>
52+
/// Average requests per second
53+
/// </summary>
1854
public decimal AverageRequestsPerSecond { get; set; }
55+
/// <summary>
56+
/// Maximum latency
57+
/// </summary>
1958
public decimal MaxLatency { get; set; }
59+
/// <summary>
60+
/// Maximum requests per second
61+
/// </summary>
2062
public decimal MaxRequestsPerSecond { get; set; }
63+
/// <summary>
64+
/// Standard deviation latency
65+
/// </summary>
2166
public decimal StdevLatency { get; set; }
67+
/// <summary>
68+
/// Standard deviation requests per second
69+
/// </summary>
2270
public decimal StdevRequestsPerSecond { get; set; }
23-
71+
/// <summary>
72+
/// Set object to string
73+
/// </summary>
74+
/// <returns></returns>
2475
public override string ToString()
2576
{
2677
return $"1xx - {Counter1xx}, 2xx - {Counter2xx}, 3xx - {Counter3xx}, 4xx - {Counter4xx}, 5xx - {Counter5xx}, avg lat {AverageLatency}ms, std lat {StdevLatency}ms, max lat {MaxLatency}ms, avg rps {AverageRequestsPerSecond}, std rps {StdevRequestsPerSecond}, max rps {MaxRequestsPerSecond}";

‎src/QAToolKit.Engine.Bombardier/BombardierTest.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
namespace QAToolKit.Engine.Bombardier
22
{
3+
/// <summary>
4+
/// Bombardier test
5+
/// </summary>
36
public class BombardierTest
47
{
8+
/// <summary>
9+
/// Bombardier HTTP request method
10+
/// </summary>
511
public string Method { get; set; }
12+
/// <summary>
13+
/// Bombardier HTTP request Url
14+
/// </summary>
615
public string Url { get; set; }
16+
/// <summary>
17+
/// Bombardier command
18+
/// </summary>
719
public string Command { get; set; }
820
}
921
}

‎src/QAToolKit.Engine.Bombardier/BombardierTestsGenerator.cs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,17 @@
1111

1212
namespace QAToolKit.Engine.Bombardier
1313
{
14+
/// <summary>
15+
/// Bombardier test generator
16+
/// </summary>
1417
public class BombardierTestsGenerator : IGenerator<IList<HttpTestRequest>, IEnumerable<BombardierTest>>
1518
{
1619
private readonly BombardierGeneratorOptions _bombardierGeneratorOptions;
1720

21+
/// <summary>
22+
/// Bombardier test generator constructor
23+
/// </summary>
24+
/// <param name="options"></param>
1825
public BombardierTestsGenerator(Action<BombardierGeneratorOptions> options)
1926
{
2027
_bombardierGeneratorOptions = new BombardierGeneratorOptions();

‎src/QAToolKit.Engine.Bombardier/BombardierTestsRunner.cs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,19 @@
1010

1111
namespace QAToolKit.Engine.Bombardier
1212
{
13+
/// <summary>
14+
/// Bombardier test runner
15+
/// </summary>
1316
public class BombardierTestsRunner
1417
{
1518
private readonly IList<BombardierTest> _bombardierTests;
1619
private readonly BombardierOutputOptions _bombardierParserOptions;
1720

21+
/// <summary>
22+
/// Bombardier test runner constructor
23+
/// </summary>
24+
/// <param name="bombardierTests"></param>
25+
/// <param name="options"></param>
1826
public BombardierTestsRunner(IList<BombardierTest> bombardierTests, Action<BombardierOutputOptions> options = null)
1927
{
2028
_bombardierTests = bombardierTests;

‎src/QAToolKit.Engine.Bombardier/Helpers/GeneratorHelper.cs‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ internal static string GenerateContentTypeHeader(HttpTestRequest request)
4949
/// Generate and replace URL parameters with replacement values
5050
/// </summary>
5151
/// <param name="request"></param>
52-
/// <param name="replacementValues"></param>
5352
/// <returns></returns>
5453
internal static string GenerateUrlParameters(HttpTestRequest request)
5554
{
@@ -70,7 +69,6 @@ internal static string GenerateUrlParameters(HttpTestRequest request)
7069
/// Generate JSON body
7170
/// </summary>
7271
/// <param name="request"></param>
73-
/// <param name="replacementValues"></param>
7472
/// <returns></returns>
7573
internal static string GenerateJsonBody(HttpTestRequest request)
7674
{
@@ -97,9 +95,7 @@ internal static string GenerateJsonBody(HttpTestRequest request)
9795
/// Generate Authentication header for HTTP request
9896
/// </summary>
9997
/// <param name="request"></param>
100-
/// <param name="customerAccessToken"></param>
101-
/// <param name="administratorAccessToken"></param>
102-
/// <param name="apiKey"></param>
98+
/// <param name="bombardierOptions"></param>
10399
/// <returns></returns>
104100
internal static string GenerateAuthHeader(HttpTestRequest request, BombardierGeneratorOptions bombardierOptions)
105101
{

‎src/QAToolKit.Engine.Bombardier/QAToolKit.Engine.Bombardier.csproj‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<PropertyGroup>
44
<TargetFrameworks>netstandard2.0;netstandard2.1;netcoreapp3.1</TargetFrameworks>
55
<LangVersion>latest</LangVersion>
6+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
67
<!-- NuGet Metadata -->
78
<IsPackable>true</IsPackable>
89
<PackageVersion>$(Version)</PackageVersion>
@@ -20,6 +21,10 @@
2021
<Configurations>Debug;Release;Debug With Project References</Configurations>
2122
</PropertyGroup>
2223

24+
<PropertyGroup>
25+
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
26+
</PropertyGroup>
27+
2328
<ItemGroup>
2429
<None Include="..\..\qatoolkit-64x64.png" Pack="true" PackagePath="\" />
2530
<None Include="..\..\LICENSE" Pack="true" PackagePath="" />

0 commit comments

Comments
 (0)