Integrate Allure report in all the sample projects

ERNI-Academy · May 24, 2024 · 0dbc559 · 0dbc559
1 parent d96e2d0
commit 0dbc559
Show file tree

Hide file tree

Showing 12 changed files with 140 additions and 33 deletions.
diff --git a/samples/TestWare.Samples.API/Hook.cs b/samples/TestWare.Samples.API/Hook.cs
@@ -1,4 +1,5 @@
-using TestWare.Reporting.ExtentReport;
+using TestWare.Reporting.AllureReport;
+using TestWare.Reporting.ExtentReport;
 
 namespace TestWare.Samples.API;
 
@@ -9,6 +10,7 @@ public sealed class Hook
     private int _stepCounter;
     private static readonly LifeCycle _lifeCycle = new();
     private static ExtentReport _testReport;
+    private static AllureReport _allureReport;
 
     public Hook(TestContext testContext)
     {
@@ -59,7 +61,11 @@ public void AfterScenario()
     public static void BeforeTestRun()
     {
         _lifeCycle.BeginTestExecution();
-        _testReport = new ExtentReport(_lifeCycle.GetCurrentResultsDirectory());
+        _testReport = new ExtentReport(_lifeCycle.GetCurrentResultsDirectory());
+        var allureConfiguration = _lifeCycle.TestConfiguration.Configurations.First(x => x.Tag == "AllureConfiguration");
+        _allureReport = new AllureReport(allureConfiguration.Capabilities.FirstOrDefault());
+        _allureReport.CleanResultsFolder();
+        _allureReport.GenerateAllureEnvironmentFile();
     }
 
     [AfterTestRun]
@@ -90,6 +96,7 @@ public void AfterStep(ScenarioContext scenarioContext)
         foreach (var evidence in evidencesPath)
         {
             _testReport.AddScreenshotToStep(evidence);
+            _allureReport.AddAttachment(evidence, Path.GetFileNameWithoutExtension(evidence));
             _testContext.AddResultFile(evidence);
         }
     }

diff --git a/samples/TestWare.Samples.API/TestConfiguration.API.json b/samples/TestWare.Samples.API/TestConfiguration.API.json
@@ -24,6 +24,25 @@
           "Timeout": 5000
         }
       ]
+    },
+    {
+      "Tag": "AllureConfiguration",
+      "Capabilities": [
+        {
+          "IssueTrackerBaseUrl": "https://www.myissuetracker.com/",
+          "TestManagementSystemBaseUrl": "https://www.mytms.com/",
+          "EnvironmentValues": [
+            {
+              "key": "System",
+              "value": "Windows"
+            },
+            {
+              "key": "Type",
+              "value": "API"
+            }
+          ]
+        }
+      ]
     }
   ],
   "TestResultPath": "C:\\workspace\\ERNI\\results\\"

diff --git a/samples/TestWare.Samples.API/TestWare.Samples.API.csproj b/samples/TestWare.Samples.API/TestWare.Samples.API.csproj
@@ -16,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\Core\TestWare.AllureReport\TestWare.AllureReport.csproj" />
     <ProjectReference Include="..\..\src\Core\TestWare.Core\TestWare.Core.csproj" />
     <ProjectReference Include="..\..\src\Core\TestWare.TestReport\TestWare.ExtentReport.csproj" />
     <ProjectReference Include="..\..\src\Engines\TestWare.Engines.API\TestWare.Engines.Restsharp.csproj" />
@@ -28,6 +29,9 @@
   </ItemGroup>
 
   <ItemGroup>
+    <None Update="specflow.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="TestConfiguration.API.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

diff --git a/samples/TestWare.Samples.API/specflow.json b/samples/TestWare.Samples.API/specflow.json
@@ -0,0 +1,5 @@
+{
+  "stepAssemblies": [
+    { "assembly": "Allure.SpecFlowPlugin" }
+  ]
+}
diff --git a/samples/TestWare.Samples.Appium.Mobile/Hook.cs b/samples/TestWare.Samples.Appium.Mobile/Hook.cs
@@ -1,4 +1,5 @@
-using TestWare.Reporting.ExtentReport;
+using TestWare.Reporting.AllureReport;
+using TestWare.Reporting.ExtentReport;
 
 namespace TestWare.Samples.Appium.Mobile;
 
@@ -8,7 +9,9 @@ public sealed class Hook
     private readonly TestContext _testContext;
     private int _stepCounter;
     private static readonly LifeCycle _lifeCycle = new();
-    private static ExtentReport _testReport;
+    private static ExtentReport _testReport;
+    private static AllureReport _allureReport;
+
 
     public Hook(TestContext testContext)
     {
@@ -59,7 +62,11 @@ public void AfterScenario()
     public static void BeforeTestRun()
     {
         _lifeCycle.BeginTestExecution();
-        _testReport = new ExtentReport(_lifeCycle.GetCurrentResultsDirectory());
+        _testReport = new ExtentReport(_lifeCycle.GetCurrentResultsDirectory());
+        var allureConfiguration = _lifeCycle.TestConfiguration.Configurations.First(x => x.Tag == "AllureConfiguration");
+        _allureReport = new AllureReport(allureConfiguration.Capabilities.FirstOrDefault());
+        _allureReport.CleanResultsFolder();
+        _allureReport.GenerateAllureEnvironmentFile();
     }
 
     [AfterTestRun]
@@ -90,6 +97,7 @@ public void AfterStep(ScenarioContext scenarioContext)
         foreach (var evidence in evidencesPath)
         {
             _testReport.AddScreenshotToStep(evidence);
+            _allureReport.AddAttachment(evidence, Path.GetFileNameWithoutExtension(evidence));
             _testContext.AddResultFile(evidence);
         }
     }

diff --git a/samples/TestWare.Samples.Appium.Mobile/TestConfiguration.Mobile.json b/samples/TestWare.Samples.Appium.Mobile/TestConfiguration.Mobile.json
@@ -86,6 +86,25 @@
           ]
         }
       ]
+    },
+    {
+      "Tag": "AllureConfiguration",
+      "Capabilities": [
+        {
+          "IssueTrackerBaseUrl": "https://www.myissuetracker.com/",
+          "TestManagementSystemBaseUrl": "https://www.mytms.com/",
+          "EnvironmentValues": [
+            {
+              "key": "System",
+              "value": "Windows"
+            },
+            {
+              "key": "Type",
+              "value": "Mobile"
+            }
+          ]
+        }
+      ]
     }
   ],
   "TestResultPath": "C:\\workspace\\ERNI\\results\\"

diff --git a/samples/TestWare.Samples.Appium.Mobile/TestWare.Samples.Appium.Mobile.csproj b/samples/TestWare.Samples.Appium.Mobile/TestWare.Samples.Appium.Mobile.csproj
@@ -20,6 +20,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\Core\TestWare.AllureReport\TestWare.AllureReport.csproj" />
     <ProjectReference Include="..\..\src\Core\TestWare.Core\TestWare.Core.csproj" />
     <ProjectReference Include="..\..\src\Core\TestWare.TestReport\TestWare.ExtentReport.csproj" />
     <ProjectReference Include="..\..\src\Engines\TestWare.Engines.Appium\TestWare.Engines.Appium.csproj" />
@@ -32,6 +33,9 @@
     <None Update="ExternalResources\SwagLabs.apk">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="specflow.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="TestConfiguration.Mobile.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

diff --git a/samples/TestWare.Samples.Appium.Mobile/specflow.json b/samples/TestWare.Samples.Appium.Mobile/specflow.json
@@ -0,0 +1,5 @@
+{
+  "stepAssemblies": [
+    { "assembly": "Allure.SpecFlowPlugin" }
+  ]
+}
diff --git a/samples/TestWare.Samples.WinAppDriver/Hook.cs b/samples/TestWare.Samples.WinAppDriver/Hook.cs
@@ -1,4 +1,5 @@
-using TestWare.Reporting.ExtentReport;
+using TestWare.Reporting.AllureReport;
+using TestWare.Reporting.ExtentReport;
 
 namespace TestWare.Samples.WinAppDriver.Desktop;
 
@@ -8,7 +9,9 @@ public sealed class Hook
   private readonly TestContext _testContext;
     private int _stepCounter;
     private static readonly LifeCycle _lifeCycle = new();
-    private static ExtentReport _testReport;
+    private static ExtentReport _testReport;
+    private static AllureReport _allureReport;
+
 
     public Hook(TestContext testContext)
     {
@@ -59,7 +62,11 @@ public void AfterScenario()
     public static void BeforeTestRun()
     {
         _lifeCycle.BeginTestExecution();
-        _testReport = new ExtentReport(_lifeCycle.GetCurrentResultsDirectory());
+        _testReport = new ExtentReport(_lifeCycle.GetCurrentResultsDirectory());
+        var allureConfiguration = _lifeCycle.TestConfiguration.Configurations.First(x => x.Tag == "AllureConfiguration");
+        _allureReport = new AllureReport(allureConfiguration.Capabilities.FirstOrDefault());
+        _allureReport.CleanResultsFolder();
+        _allureReport.GenerateAllureEnvironmentFile();
     }
 
     [AfterTestRun]
@@ -90,6 +97,7 @@ public void AfterStep(ScenarioContext scenarioContext)
         foreach (var evidence in evidencesPath)
         {
             _testReport.AddScreenshotToStep(evidence);
+            _allureReport.AddAttachment(evidence, Path.GetFileNameWithoutExtension(evidence));
             _testContext.AddResultFile(evidence);
         }
     }

diff --git a/samples/TestWare.Samples.WinAppDriver/TestConfiguration.Desktop.json b/samples/TestWare.Samples.WinAppDriver/TestConfiguration.Desktop.json
@@ -1,35 +1,54 @@
 {
-    "Configurations": [
-        {
-            "Tag": "WinAppDriver",
-          "Capabilities": [
+  "Configurations": [
+    {
+      "Tag": "WinAppDriver",
+      "Capabilities": [
 
+        {
+          "Name": "Notepad",
+          "ApplicationPath": "C:\\Windows\\System32\\notepad.exe",
+          "ApplicationName": "Notepad",
+          "ApplicationClassName": "Notepad",
+          "WinAppDriverUrl": "http://127.0.0.1:4723/",
+          "CommandTimeOutInMinutes": 5
+        },
+        {
+          "Name": "Calculator",
+          "ApplicationPath": ".\\ExternalResources\\mini-calc.exe",
+          "ApplicationName": "Mini Calculator Classic",
+          "ApplicationClassName": "",
+          "WinAppDriverUrl": "http://127.0.0.1:4723/",
+          "CommandTimeOutInMinutes": 5
+        },
+        {
+          "Name": "WindowsCalculator",
+          "ApplicationId": "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
+          "ApplicationName": "Calculator",
+          "ApplicationClassName": "",
+          "WinAppDriverUrl": "http://127.0.0.1:4723/",
+          "CommandTimeOutInMinutes": 5
+        }
+      ]
+    },
+    {
+      "Tag": "AllureConfiguration",
+      "Capabilities": [
+        {
+          "IssueTrackerBaseUrl": "https://www.myissuetracker.com/",
+          "TestManagementSystemBaseUrl": "https://www.mytms.com/",
+          "EnvironmentValues": [
             {
-              "Name": "Notepad",
-              "ApplicationPath": "C:\\Windows\\System32\\notepad.exe",
-              "ApplicationName": "Notepad",
-              "ApplicationClassName": "Notepad",
-              "WinAppDriverUrl": "http://127.0.0.1:4723/",
-              "CommandTimeOutInMinutes": 5
-            },
-            {
-              "Name": "Calculator",
-              "ApplicationPath": ".\\ExternalResources\\mini-calc.exe",
-              "ApplicationName": "Mini Calculator Classic",
-              "ApplicationClassName": "",
-              "WinAppDriverUrl": "http://127.0.0.1:4723/",
-              "CommandTimeOutInMinutes": 5
+              "key": "System",
+              "value": "Windows"
             },
             {
-              "Name": "WindowsCalculator",
-              "ApplicationId": "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
-              "ApplicationName": "Calculator",
-              "ApplicationClassName": "",
-              "WinAppDriverUrl": "http://127.0.0.1:4723/",
-              "CommandTimeOutInMinutes": 5
+              "key": "Type",
+              "value": "Desktop"
             }
           ]
-        }    
+        }
+      ]
+    }
   ],
   "TestResultPath": "C:\\workspace\\ERNI\\results\\"
 }
diff --git a/samples/TestWare.Samples.WinAppDriver/TestWare.Samples.WinAppDriver.Desktop.csproj b/samples/TestWare.Samples.WinAppDriver/TestWare.Samples.WinAppDriver.Desktop.csproj
@@ -16,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\Core\TestWare.AllureReport\TestWare.AllureReport.csproj" />
     <ProjectReference Include="..\..\src\Core\TestWare.Core\TestWare.Core.csproj" />
     <ProjectReference Include="..\..\src\Core\TestWare.TestReport\TestWare.ExtentReport.csproj" />
     <ProjectReference Include="..\..\src\Engines\TestWare.Engines.Appium\TestWare.Engines.Appium.csproj" />
@@ -26,6 +27,9 @@
     <None Update="ExternalResources\mini-calc.exe">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="specflow.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="TestConfiguration.Desktop.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

diff --git a/samples/TestWare.Samples.WinAppDriver/specflow.json b/samples/TestWare.Samples.WinAppDriver/specflow.json
@@ -0,0 +1,5 @@
+{
+  "stepAssemblies": [
+    { "assembly": "Allure.SpecFlowPlugin" }
+  ]
+}