Bump PuppeteerSharp from 6.2.0 to 7.0.0

stesee · web-flow · commit f2b46ef75b9b · 2022-04-18T23:52:27.000+02:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,5 +1,11 @@
 version: 2
 updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: weekly
+    rebase-strategy: auto
+
   - package-ecosystem: "nuget" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
@@ -15,6 +21,6 @@ updates:
       - dependency-name: "xunit.runner.visualstudio"
       - dependency-name: "MSTest.TestAdapter"
       - dependency-name: "MSTest.TestFramework"
-      - dependency-name: "ImageSharpCompare"
-      - dependency-name: "PdfjsSharp"
+      - dependency-name: "Codeuctivity.ImageSharpCompare"
+      - dependency-name: "Codeuctivity.PdfjsSharp"
       - dependency-name: "Microsoft.SourceLink.GitHub"
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -1,6 +1,6 @@
 name: .NET build and test
 env:
-  CURRENT_VERSION: 2.0.${{ github.run_number }}
+  CURRENT_VERSION: 2.1.${{ github.run_number }}
   LAST_COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
 
 on:
@@ -14,78 +14,90 @@ jobs:
       matrix:
         os: [windows-latest, ubuntu-latest]
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 6.0.x
-    - uses: actions/setup-node@v2
-      with:
-        node-version: 14
-    - name: Restore dependencies
-      run: dotnet restore
-    - name: Build
-      run: dotnet build --configuration Release --no-restore
-    - name: Test
-      run: dotnet test --no-build --verbosity normal --configuration Release
+      - uses: actions/checkout@v3
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v2
+        with:
+          dotnet-version: 6.0.x
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - name: Restore dependencies
+        run: dotnet restore
+      - name: Build
+        run: dotnet build --configuration Release --no-restore
+      - name: Test
+        run: dotnet test --no-build --verbosity normal --configuration Release
+      - name: Publish Unit Test Results
+        uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: TestResult
+          path: "TestResult/**/*"
 
   deployRelease:
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
-    needs: build 
+    needs: build
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 6.0.x
-    - name: Restore dependencies
-      run: dotnet restore
-    - name: Build
-      run: dotnet build --configuration Release --no-restore
-    - name: Publish
-      run: dotnet publish ./Codeuctivity.HtmlRendererCli --configuration Release -p:PublishProfile=FolderProfile
-    - name: NugetPush
-      run: |
+      - uses: actions/checkout@v3
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v2
+        with:
+          dotnet-version: 6.0.x
+      - name: Restore dependencies
+        run: dotnet restore
+      - name: Build
+        run: dotnet build --configuration Release --no-restore
+      - name: Publish
+        run: dotnet publish ./Codeuctivity.HtmlRendererCli --configuration Release -p:PublishProfile=FolderProfile
+      - name: NugetPush
+        env:
+          NUGET_TOKEN_EXISTS: ${{ secrets.NUGET_TOKEN }}
+        if: env.NUGET_TOKEN_EXISTS != ''
+        run: |
           dotnet nuget push ./Codeuctivity.HtmlRenderer/bin/Release/*.nupkg --skip-duplicate --api-key ${{secrets.NUGET_TOKEN}} --source https://api.nuget.org/v3/index.json
-    - uses: "marvinpinto/action-automatic-releases@latest"
-      with:
-        repo_token: "${{ secrets.GITHUB_TOKEN }}"
-        automatic_release_tag: ${{ env.CURRENT_VERSION }}
-        prerelease: false
-        title: "Release Build"
-        files: |
-          ./Codeuctivity.HtmlRenderer/bin/Release/*.nupkg
-          ./Codeuctivity.HtmlRenderer/bin/Release/*.snupkg
-          ./Codeuctivity.HtmlRendererCli/bin/Release/net6.0/publish/win-x86/Codeuctivity.HtmlRendererCli.exe
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: ${{ env.CURRENT_VERSION }}
+          prerelease: false
+          title: "Release Build"
+          files: |
+            ./Codeuctivity.HtmlRenderer/bin/Release/*.nupkg
+            ./Codeuctivity.HtmlRenderer/bin/Release/*.snupkg
+            ./Codeuctivity.HtmlRendererCli/bin/Release/net6.0/publish/win-x86/Codeuctivity.HtmlRendererCli.exe
 
   deployTest:
     if: github.ref != 'refs/heads/main'
     runs-on: ubuntu-latest
-    needs: build 
+    needs: build
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 6.0.x
-    - name: Restore dependencies
-      run: dotnet restore
-    - name: Build
-      run: dotnet build --configuration Release --no-restore
-    - name: Publish
-      run: dotnet publish ./Codeuctivity.HtmlRendererCli --configuration Release -p:PublishProfile=FolderProfile
-    - name: NugetPush
-      run: |
+      - uses: actions/checkout@v3
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v2
+        with:
+          dotnet-version: 6.0.x
+      - name: Restore dependencies
+        run: dotnet restore
+      - name: Build
+        run: dotnet build --configuration Release --no-restore
+      - name: Publish
+        run: dotnet publish ./Codeuctivity.HtmlRendererCli --configuration Release -p:PublishProfile=FolderProfile
+      - name: NugetPush
+        env:
+          NUGET_TOKEN_EXISTS: ${{ secrets.NUGET_TEST_TOKEN }}
+        if: env.NUGET_TOKEN_EXISTS != ''
+        run: |
           ls ./Codeuctivity.HtmlRenderer/bin/Release
           dotnet nuget push ./Codeuctivity.HtmlRenderer/bin/Release/*.nupkg --skip-duplicate --api-key ${{secrets.NUGET_TEST_TOKEN}} --source https://apiint.nugettest.org/v3/index.json
-    - uses: "marvinpinto/action-automatic-releases@latest"
-      with:
-        repo_token: "${{ secrets.GITHUB_TOKEN }}"
-        automatic_release_tag: "latest-prerelease"
-        prerelease: true
-        title: "Prerelease Build"
-        files: |
-          ./Codeuctivity.HtmlRenderer/bin/Release/*.nupkg
-          ./Codeuctivity.HtmlRenderer/bin/Release/*.snupkg
-          ./Codeuctivity.HtmlRendererCli/bin/Release/net6.0/publish/win-x86/Codeuctivity.HtmlRendererCli.exe
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest-prerelease"
+          prerelease: true
+          title: "Prerelease Build"
+          files: |
+            ./Codeuctivity.HtmlRenderer/bin/Release/*.nupkg
+            ./Codeuctivity.HtmlRenderer/bin/Release/*.snupkg
+            ./Codeuctivity.HtmlRendererCli/bin/Release/net6.0/publish/win-x86/Codeuctivity.HtmlRendererCli.exe
diff --git a/Codeuctivity.HtmlRenderer/Codeuctivity.HtmlRenderer.csproj b/Codeuctivity.HtmlRenderer/Codeuctivity.HtmlRenderer.csproj
@@ -38,8 +38,8 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="all" />
-		<PackageReference Include="PuppeteerSharp" Version="6.2.0" />
-		<PackageReference Include="SonarAnalyzer.CSharp" Version="8.36.1.44192">
+		<PackageReference Include="PuppeteerSharp" Version="7.0.0" />
+		<PackageReference Include="SonarAnalyzer.CSharp" Version="8.37.0.45539">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
diff --git a/Codeuctivity.HtmlRenderer/Renderer.cs b/Codeuctivity.HtmlRenderer/Renderer.cs
@@ -2,6 +2,7 @@
 using System;
 using System.IO;
 using System.Net;
+using System.Runtime.InteropServices;
 using System.Threading.Tasks;
 
 namespace Codeuctivity.HtmlRenderer
@@ -41,14 +42,29 @@ public static Task<Renderer> CreateAsync(BrowserFetcher browserFetcher)
 
         private async Task<Renderer> InitializeAsync(BrowserFetcher browserFetcher)
         {
-            BrowserFetcher = browserFetcher;
+            BrowserFetcher = browserFetcher ?? throw new ArgumentNullException(nameof(browserFetcher));
             BrowserFetcher.DownloadProgressChanged += DownloadProgressChanged;
 
             await BrowserFetcher.DownloadAsync(BrowserFetcher.DefaultChromiumRevision);
-            Browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true });
+            Browser = await Puppeteer.LaunchAsync(SystemSpecificConfig());
             return this;
         }
 
+        private static LaunchOptions SystemSpecificConfig()
+        {
+            if (IsRunningOnWsl())
+            {
+                return new LaunchOptions { Headless = true, Args = new string[] { "--no-sandbox" } };
+            }
+
+            return new LaunchOptions { Headless = true };
+        }
+
+        private static bool IsRunningOnWsl()
+        {
+            return RuntimeInformation.IsOSPlatform(OSPlatform.Linux) && File.ReadAllText("/proc/version").Contains("Microsoft");
+        }
+
         /// <summary>
         /// Converts a HTML file to a PDF
         /// </summary>
diff --git a/Codeuctivity.HtmlRendererCliTests/Codeuctivity.HtmlRendererCliTests.csproj b/Codeuctivity.HtmlRendererCliTests/Codeuctivity.HtmlRendererCliTests.csproj
@@ -8,7 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.36.1.44192">
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.37.0.45539">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
diff --git a/Codeuctivity.HtmlRendererTests/Codeuctivity.HtmlRendererTests.csproj b/Codeuctivity.HtmlRendererTests/Codeuctivity.HtmlRendererTests.csproj
@@ -16,9 +16,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Codeuctivity.ImageSharpCompare" Version="2.0.18" />
+    <PackageReference Include="Codeuctivity.ImageSharpCompare" Version="2.0.25" />
     <PackageReference Include="Codeuctivity.PdfjsSharp" Version="1.2.27" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.36.1.44192">
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.37.0.45539">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
diff --git a/Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedConvertHtmlToPngBasicTextFormated.html.png b/Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedConvertHtmlToPngBasicTextFormated.html.png
diff --git a/Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormated.html.png b/Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormated.html.png
diff --git a/Codeuctivity.HtmlRendererTests/Infrastructure/ChromiumProcessDisposedAsserter.cs b/Codeuctivity.HtmlRendererTests/Infrastructure/ChromiumProcessDisposedAsserter.cs
@@ -3,7 +3,7 @@
 using System.Threading.Tasks;
 using Xunit;
 
-namespace Codeuctivity.HtmlRendererTests.Infrastrukture
+namespace Codeuctivity.HtmlRendererTests.Infrastructure
 {
     public static class ChromiumProcessDisposedAsserter
     {
diff --git a/Codeuctivity.HtmlRendererTests/Infrastructure/DocumentAsserter.cs b/Codeuctivity.HtmlRendererTests/Infrastructure/DocumentAsserter.cs
@@ -1,20 +1,20 @@
-﻿using System;
-using System.IO;
+﻿using System.IO;
 using System.Runtime.InteropServices;
 using Xunit;
 
-namespace Codeuctivity.HtmlRendererTests.Infrastrukture
+namespace Codeuctivity.HtmlRendererTests.Infrastructure
 {
     internal static class DocumentAsserter
     {
+        private const string TestOutputFirectory = "../../../../TestResult";
+
         internal static void AssertImageIsEqual(string actualImagePath, string expectImageFilePath, int allowedPixelErrorCount)
         {
             var actualFullPath = Path.GetFullPath(actualImagePath);
             var expectFullPath = Path.GetFullPath(expectImageFilePath);
 
             Assert.True(File.Exists(actualFullPath), $"actualImagePath not found {actualFullPath}");
             Assert.True(File.Exists(expectFullPath), $"ExpectReferenceImagePath not found \n{expectFullPath}\n copy over \n{actualFullPath}\n if this is a new test case.");
-            var base64fyedActualImage = Convert.ToBase64String(File.ReadAllBytes(actualFullPath));
 
             if (ImageSharpCompare.ImageSharpCompare.ImagesAreEqual(actualFullPath, expectFullPath))
             {
@@ -30,13 +30,19 @@ internal static void AssertImageIsEqual(string actualImagePath, string expectIma
             {
                 SixLabors.ImageSharp.ImageExtensions.SaveAsPng(maskImage, fileStreamDifferenceMask);
             }
-            var base64fyedImageDiff = Convert.ToBase64String(File.ReadAllBytes(newDiffImage));
 
             if (File.Exists(allowedDiffImage))
             {
                 var resultWithAllowedDiff = ImageSharpCompare.ImageSharpCompare.CalcDiff(actualFullPath, expectFullPath, allowedDiffImage);
 
-                Assert.True(resultWithAllowedDiff.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {resultWithAllowedDiff.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n {base64fyedActualImage}\n \n Diff is {newDiffImage} \n {base64fyedImageDiff}\n");
+                if (allowedPixelErrorCount < resultWithAllowedDiff.PixelErrorCount)
+                {
+                    CopyToTestOutput(actualImagePath);
+                    CopyToTestOutput(expectImageFilePath);
+                    CopyToTestOutput(newDiffImage);
+                }
+
+                Assert.True(resultWithAllowedDiff.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {resultWithAllowedDiff.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n Diff is {newDiffImage}");
                 return;
             }
 
@@ -48,7 +54,26 @@ internal static void AssertImageIsEqual(string actualImagePath, string expectIma
 
             var result = ImageSharpCompare.ImageSharpCompare.CalcDiff(actualFullPath, expectFullPath);
 
-            Assert.True(result.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {result.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n {base64fyedActualImage}\n \n Diff is {newDiffImage} \n {base64fyedImageDiff}\nReplace {actualFullPath} with the new value or store the diff as {allowedDiffImage}.");
+            if (allowedPixelErrorCount < result.PixelErrorCount)
+            {
+                CopyToTestOutput(newDiffImage);
+                CopyToTestOutput(actualImagePath);
+            }
+
+            Assert.True(result.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {result.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n Diff is {newDiffImage}\nReplace {actualFullPath} with the new value or store the diff as {allowedDiffImage}.");
+        }
+
+        private static void CopyToTestOutput(string testOutputFile)
+        {
+            if (string.IsNullOrEmpty(testOutputFile))
+            {
+                throw new System.ArgumentException($"'{nameof(testOutputFile)}' cannot be null or empty.", nameof(testOutputFile));
+            }
+
+            if (!Directory.Exists(TestOutputFirectory))
+                Directory.CreateDirectory(TestOutputFirectory);
+
+            File.Copy(testOutputFile, Path.Combine(TestOutputFirectory, Path.GetFileName(testOutputFile)), true);
         }
     }
 }
diff --git a/Codeuctivity.HtmlRendererTests/RendererTests.cs b/Codeuctivity.HtmlRendererTests/RendererTests.cs
@@ -1,5 +1,5 @@
 ﻿using Codeuctivity.HtmlRenderer;
-using Codeuctivity.HtmlRendererTests.Infrastrukture;
+using Codeuctivity.HtmlRendererTests.Infrastructure;
 using Codeuctivity.PdfjsSharp;
 using System.IO;
 using System.Linq;
@@ -33,7 +33,7 @@ public async Task ShouldConvertHtmlToPdf(string testFileName)
                 var actualImages = await rasterize.ConvertToPngAsync(actualFilePath, actualImagePathDirectory);
 
                 Assert.Single(actualImages);
-                DocumentAsserter.AssertImageIsEqual(actualImages.Single(), expectReferenceFilePath, 50);
+                DocumentAsserter.AssertImageIsEqual(actualImages.Single(), expectReferenceFilePath, 2000);
             }
             await ChromiumProcessDisposedAsserter.AssertNoChromeProcessIsRunning();
         }
@@ -55,7 +55,7 @@ public async Task ShouldConvertHtmlToPng(string testFileName)
             {
                 await chromiumRenderer.ConvertHtmlToPng(sourceHtmlFilePath, actualFilePath);
 
-                DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 3500);
+                DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 7000);
             }
 
             await ChromiumProcessDisposedAsserter.AssertNoChromeProcessIsRunning();
diff --git a/README.md b/README.md
@@ -27,5 +27,8 @@ await chromiumRenderer.ConvertHtmlToPng(actualFilePath, pathRasterizedHtml);
 ### Linux
 
 ```bash
-sudo apt install libgbm-dev
+sudo apt install libgbm-dev libatk-bridge2.0-0
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+exit
+nvm install 16
 ```

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`using System.Threading.Tasks;`
`4`	`4`	`using Xunit;`
`5`	`5`
`6`		`-namespace Codeuctivity.HtmlRendererTests.Infrastrukture`
	`6`	`+namespace Codeuctivity.HtmlRendererTests.Infrastructure`
`7`	`7`	`{`
`8`	`8`	`public static class ChromiumProcessDisposedAsserter`
`9`	`9`	`{`