Merge pull request #276 from q2ebanking/SeleniumWebDriverUpdate

AutomationPanda · web-flow · commit e45f53d9a33b · 2025-03-26T17:13:49.000-04:00
Update Selenium packages for Null Pointer vulnerability
diff --git a/.github/workflows/nuget-push.yml b/.github/workflows/nuget-push.yml
@@ -32,7 +32,7 @@ jobs:
       - name: Set up .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '7.0.x'
+          dotnet-version: '8.0.x'
 
 
       # Screenplay
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
@@ -15,7 +15,7 @@ jobs:
     steps:
 
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Build the solution
         run: dotnet build
@@ -38,31 +38,31 @@ jobs:
 
       - name: Archive Screenplay unit test results
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: Screenplay unit test results
           path: Boa.Constrictor.Screenplay.UnitTests/TestResults/ScreenplayResults.trx
           retention-days: 30
 
       - name: Archive Selenium unit test results
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: Selenium unit test results
           path: Boa.Constrictor.Selenium.UnitTests/TestResults/SeleniumResults.trx
           retention-days: 30
 
       - name: Archive RestSharp unit test results
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: RestSharp unit test results
           path: Boa.Constrictor.RestSharp.UnitTests/TestResults/RestSharpResults.trx
           retention-days: 30
 
       - name: Archive Xunit unit test results
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: Xunit unit test results
           path: Boa.Constrictor.Xunit.UnitTests/TestResults/XunitResults.trx
diff --git a/Boa.Constrictor.Example/Boa.Constrictor.Example.csproj b/Boa.Constrictor.Example/Boa.Constrictor.Example.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <Version>4.0.0</Version>
     <Authors>Pandy Knight and the PrecisionLender SETs</Authors>
     <Company>Q2</Company>
diff --git a/Boa.Constrictor.RestSharp.UnitTests/Boa.Constrictor.RestSharp.UnitTests.csproj b/Boa.Constrictor.RestSharp.UnitTests/Boa.Constrictor.RestSharp.UnitTests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>
diff --git a/Boa.Constrictor.Screenplay.UnitTests/Boa.Constrictor.Screenplay.UnitTests.csproj b/Boa.Constrictor.Screenplay.UnitTests/Boa.Constrictor.Screenplay.UnitTests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>
diff --git a/Boa.Constrictor.Selenium.UnitTests/Boa.Constrictor.Selenium.UnitTests.csproj b/Boa.Constrictor.Selenium.UnitTests/Boa.Constrictor.Selenium.UnitTests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>
diff --git a/Boa.Constrictor.Selenium.UnitTests/Equality/WebInteractionEqualityTest.cs b/Boa.Constrictor.Selenium.UnitTests/Equality/WebInteractionEqualityTest.cs
@@ -1,5 +1,4 @@
 ﻿using Boa.Constrictor.Screenplay;
-using Boa.Constrictor.Selenium;
 using FluentAssertions;
 using NUnit.Framework;
 using OpenQA.Selenium;
@@ -34,8 +33,8 @@ public class WebInteractionEqualityTest
             new object[] { CssValueList.For(LocatorA, "property"), CssValueList.For(LocatorA1, "property") },
             new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot"), CurrentScreenshot.SavedTo("/path/to/screenshot") },
             new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot", "file"), CurrentScreenshot.SavedTo("/path/to/screenshot", "file") },
-            new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot", "file").UsingFormat(ScreenshotImageFormat.Png), CurrentScreenshot.SavedTo("/path/to/screenshot", "file").UsingFormat(ScreenshotImageFormat.Png) },
-            new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(ScreenshotImageFormat.Png), CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(ScreenshotImageFormat.Png) },
+            new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot", "file").UsingFormat(".png"), CurrentScreenshot.SavedTo("/path/to/screenshot", "file").UsingFormat(".png") },
+            new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(".png"), CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(".png") },
             new object[] { CurrentUrl.FromBrowser(), CurrentUrl.FromBrowser() },
             new object[] { DomProperty.Of(LocatorA, "property"), DomProperty.Of(LocatorA1, "property") },
             new object[] { EnabledState.Of(LocatorA), EnabledState.Of(LocatorA1) },
@@ -127,7 +126,7 @@ public class WebInteractionEqualityTest
             new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot"), CurrentScreenshot.SavedTo("/path/to/screenshot2") },
             new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot", "file"), CurrentScreenshot.SavedTo("/path/to/screenshot") },
             new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot", "file"), CurrentScreenshot.SavedTo("/path/to/screenshot", "file2") },
-            new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(ScreenshotImageFormat.Png), CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(ScreenshotImageFormat.Jpeg) },
+            new object[] { CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(".png"), CurrentScreenshot.SavedTo("/path/to/screenshot").UsingFormat(".jpeg") },
             new object[] { CurrentUrl.FromBrowser(), Title.OfPage() },
             new object[] { DomProperty.Of(LocatorA, "property"), Title.OfPage() },
             new object[] { DomProperty.Of(LocatorA, "property"), DomProperty.Of(LocatorB, "property") },
diff --git a/Boa.Constrictor.Selenium.UnitTests/Questions/CurrentScreenshotTest.cs b/Boa.Constrictor.Selenium.UnitTests/Questions/CurrentScreenshotTest.cs
@@ -76,7 +76,7 @@ public void TestSaveFileWithExtension()
         [Test]
         public void TestSaveFileWithJpegFormat()
         {
-            var image = Actor.AsksFor(CurrentScreenshot.SavedTo(Dir, "webpage").UsingFormat(ScreenshotImageFormat.Jpeg));
+            var image = Actor.AsksFor(CurrentScreenshot.SavedTo(Dir, "webpage").UsingFormat(".jpeg"));
             ImagesToDelete.Add(image);
             image.Should().Match(Dir + Path.DirectorySeparatorChar + "webpage*.jpeg");
             Logger.Messages.Should().ContainMatch($"*Screenshots: {Dir}{Path.DirectorySeparatorChar}webpage*.jpeg");
@@ -86,7 +86,7 @@ public void TestSaveFileWithJpegFormat()
         [Test]
         public void TestSaveFileWithBmpFormatNoName()
         {
-            var image = Actor.AsksFor(CurrentScreenshot.SavedTo(Dir).UsingFormat(ScreenshotImageFormat.Bmp));
+            var image = Actor.AsksFor(CurrentScreenshot.SavedTo(Dir).UsingFormat(".bmp"));
             ImagesToDelete.Add(image);
             image.Should().Match(Dir + Path.DirectorySeparatorChar + "Screenshot*.bmp");
             Logger.Messages.Should().ContainMatch($"*Screenshots: {Dir}{Path.DirectorySeparatorChar}Screenshot*.bmp");
diff --git a/Boa.Constrictor.Selenium/Boa.Constrictor.Selenium.csproj b/Boa.Constrictor.Selenium/Boa.Constrictor.Selenium.csproj
@@ -27,8 +27,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Selenium.Support" Version="4.6.0" />
-    <PackageReference Include="Selenium.WebDriver" Version="4.6.0" />
+    <PackageReference Include="Selenium.Support" Version="4.28.0" />
+    <PackageReference Include="Selenium.WebDriver" Version="4.28.0" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(Configuration)' == 'Release'">
diff --git a/Boa.Constrictor.Selenium/CHANGELOG.md b/Boa.Constrictor.Selenium/CHANGELOG.md
@@ -17,7 +17,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-(none)
+### Changed
+
+- Updated `Selenium.Support` and `Selenium.Webdriver` to Version 4.28.0
+- Replaced `ScreenshotImageFormat` with `string` to append to screenshot file formatting path
+- Updated corresponding unit tests to correct for necessary changes
 
 
 ## [4.2.0] - 2024-06-11
diff --git a/Boa.Constrictor.Selenium/Questions/CurrentScreenshot.cs b/Boa.Constrictor.Selenium/Questions/CurrentScreenshot.cs
@@ -15,7 +15,7 @@ public class CurrentScreenshot : AbstractWebQuestion<string>
         /// <summary>
         /// The default screenshot image format.
         /// </summary>
-        public const ScreenshotImageFormat DefaultImageFormat = ScreenshotImageFormat.Png;
+        public const string DefaultImageFormat = ".png";
 
         #endregion
 
@@ -48,7 +48,7 @@ private CurrentScreenshot(string outputDir, string fileName)
         /// <summary>
         /// Image file format.
         /// </summary>
-        private ScreenshotImageFormat Format { get; set; }
+        private string Format { get; set; }
 
         /// <summary>
         /// The path to the output directory where screenshot image files will be saved.
@@ -73,7 +73,7 @@ public static CurrentScreenshot SavedTo(string outputDir, string fileName = null
         /// </summary>
         /// <param name="format">Image file format.</param>
         /// <returns></returns>
-        public CurrentScreenshot UsingFormat(ScreenshotImageFormat format)
+        public CurrentScreenshot UsingFormat(string format)
         {
             Format = format;
             return this;
@@ -119,7 +119,7 @@ public override string RequestAs(IActor actor, IWebDriver driver)
 
             // Capture and save the screenshot.
             string path = Path.Combine(OutputDir, $"{fileName}.{Format.ToString().ToLower()}");
-            (driver as ITakesScreenshot).GetScreenshot().SaveAsFile(path, Format);
+            (driver as ITakesScreenshot).GetScreenshot().SaveAsFile(path);
             actor.Logger.LogArtifact(ArtifactTypes.Screenshots, path);
 
             // Return the path to the screenshot image file.
diff --git a/Boa.Constrictor.Xunit.UnitTests/Boa.Constrictor.Xunit.UnitTests.csproj b/Boa.Constrictor.Xunit.UnitTests/Boa.Constrictor.Xunit.UnitTests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>
diff --git a/Boa.Constrictor/CHANGELOG.md b/Boa.Constrictor/CHANGELOG.md
@@ -17,7 +17,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-(none)
+### Changed
+
+- Changed target framework for the unit tests and example projects to .NET 8
+- Changed github artifact actions from `v3` to `v4`
 
 
 ## [4.0.0] - 2023-05-29
diff --git a/docs/pages/main-docs/tutorial/part-3-rest-api-testing.md b/docs/pages/main-docs/tutorial/part-3-rest-api-testing.md
@@ -1006,7 +1006,7 @@ However, you should consider using a better output path when running tests in a
 Rerun the tests, and make sure they all pass.
 Then, check the assembly directory for the dumped files.
 (The assembly file is most likely located at
-`boa-constrictor\Boa.Constrictor.Example\bin\Debug\net7.0`.)
+`boa-constrictor\Boa.Constrictor.Example\bin\Debug\net8.0`.)
 It should contain the following directories:
 
 ```
