Skip to content

Commit ca70adf

Browse files
steseestesee
committed
Migrated from Codeuctivity.PdfjsSharp -> PDFtoImage
1 parent e673bbc commit ca70adf

22 files changed

+48
-74
lines changed

‎.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -199,3 +199,24 @@ dotnet_naming_style.begins_with_i.required_prefix = I
199199
dotnet_naming_style.begins_with_i.required_suffix =
200200
dotnet_naming_style.begins_with_i.word_separator =
201201
dotnet_naming_style.begins_with_i.capitalization = pascal_case
202+
csharp_style_namespace_declarations = block_scoped:silent
203+
csharp_style_prefer_method_group_conversion = true:silent
204+
csharp_style_prefer_top_level_statements = true:silent
205+
csharp_style_prefer_primary_constructors = true:suggestion
206+
dotnet_diagnostic.S125.severity = suggestion
207+
208+
# CA1303: Do not pass literals as localized parameters
209+
dotnet_diagnostic.CA1303.severity = none
210+
211+
[*.{cs,vb}]
212+
dotnet_style_coalesce_expression = true:suggestion
213+
dotnet_style_null_propagation = true:suggestion
214+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
215+
dotnet_style_prefer_auto_properties = true:silent
216+
dotnet_style_object_initializer = true:suggestion
217+
dotnet_style_collection_initializer = true:suggestion
218+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
219+
tab_width = 4
220+
indent_size = 4
221+
end_of_line = crlf
222+
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion

‎.github/workflows/dotnet.yml

-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ jobs:
1919
uses: actions/setup-dotnet@v4
2020
with:
2121
dotnet-version: 8.0.x
22-
- uses: actions/setup-node@v4.0.2
23-
with:
24-
node-version: 20
2522
- name: Restore dependencies
2623
run: dotnet restore
2724
- name: Build

‎Codeuctivity.HtmlRenderer/Codeuctivity.HtmlRenderer.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@
3939

4040
<ItemGroup>
4141
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
42-
<PackageReference Include="PuppeteerSharp" Version="18.0.0" />
43-
<PackageReference Include="SonarAnalyzer.CSharp" Version="9.25.0.90414">
42+
<PackageReference Include="PuppeteerSharp" Version="18.0.1" />
43+
<PackageReference Include="SonarAnalyzer.CSharp" Version="9.26.0.92422">
4444
<PrivateAssets>all</PrivateAssets>
4545
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
4646
</PackageReference>

‎Codeuctivity.HtmlRenderer/Renderer.cs

-2
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,6 @@ public static Task<Renderer> CreateAsync(BrowserFetcher browserFetcher, LaunchOp
9292

9393
private async Task<Renderer> InitializeAsync(BrowserFetcher browserFetcher)
9494
{
95-
9695
BrowserFetcher = browserFetcher;
9796
var revisionInfo = await BrowserFetcher.DownloadAsync(PuppeteerSharp.BrowserData.Chrome.DefaultBuildId).ConfigureAwait(false);
9897
LaunchOptions.ExecutablePath = revisionInfo.GetExecutablePath();
@@ -261,7 +260,6 @@ protected virtual void Dispose(bool disposing)
261260
if (disposing)
262261
{
263262
Browser?.Dispose();
264-
265263
}
266264
}
267265

‎Codeuctivity.HtmlRendererCliTests/Codeuctivity.HtmlRendererCliTests.csproj

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
</PropertyGroup>
88

99
<ItemGroup>
10-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
11-
<PackageReference Include="SonarAnalyzer.CSharp" Version="9.25.0.90414">
10+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
11+
<PackageReference Include="SonarAnalyzer.CSharp" Version="9.26.0.92422">
1212
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1313
<PrivateAssets>all</PrivateAssets>
1414
</PackageReference>
15-
<PackageReference Include="xunit" Version="2.8.0" />
16-
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.0">
15+
<PackageReference Include="xunit" Version="2.8.1" />
16+
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
1717
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1818
<PrivateAssets>all</PrivateAssets>
1919
</PackageReference>

‎Codeuctivity.HtmlRendererTests/Codeuctivity.HtmlRendererTests.csproj

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616

1717
<ItemGroup>
1818
<PackageReference Include="Codeuctivity.ImageSharpCompare" Version="4.0.258" />
19-
<PackageReference Include="Codeuctivity.PdfjsSharp" Version="2.0.164" />
20-
<PackageReference Include="SonarAnalyzer.CSharp" Version="9.25.0.90414">
19+
<PackageReference Include="PDFtoImage" Version="4.0.1" />
20+
<PackageReference Include="SonarAnalyzer.CSharp" Version="9.26.0.92422">
2121
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2222
<PrivateAssets>all</PrivateAssets>
2323
</PackageReference>
24-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
25-
<PackageReference Include="xunit" Version="2.8.0" />
26-
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.0">
24+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
25+
<PackageReference Include="xunit" Version="2.8.1" />
26+
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
2727
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2828
<PrivateAssets>all</PrivateAssets>
2929
</PackageReference>

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedConvertHtmlToPngBasicTextFormatted.html.png

-9.9 KB
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedConvertHtmlToPngBasicTextFormatted.html.png.diff.linux.png

33.6 KB
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedConvertHtmlToPngBasicTextFormatted.html.png.diff.win.png

-8.14 KB
Binary file not shown.

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedConvertHtmlToPngBasicTextFormattedInlineBackground.html.False.png

481 Bytes
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedConvertHtmlToPngBasicTextFormattedInlineBackground.html.True.png

-387 Bytes
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormatted.html.png

150 KB
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormatted.html.png.diff.linux.png

217 KB
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormatted.html.png.diff.win.png

-6.39 KB
Binary file not shown.

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormattedInlineBackground.html.False.png

148 KB
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormattedInlineBackground.html.False.png.diff.linux.png

224 KB
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormattedInlineBackground.html.True.png

141 KB
Loading

‎Codeuctivity.HtmlRendererTests/ExpectedTestOutcome/ExpectedFromHtmlConvertHtmlToPdfBasicTextFormattedInlineBackground.html.True.png.diff.linux.png

226 KB
Loading

‎Codeuctivity.HtmlRendererTests/Infrastructure/ChromiumProcessDisposedAsserter.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ namespace Codeuctivity.HtmlRendererTests.Infrastructure
77
{
88
public static class ChromiumProcessDisposedAsserter
99
{
10-
public static async Task AssertNoChromiumProcessIsRunning()
10+
public static async Task AssertNoChromiumProcessIsRunningExceptExpectedOrphanedBackgroundChromeProcesses()
1111
{
1212
for (var i = 0; i < 20 && CountChromiumTasks() > 0; i++)
1313
{
1414
await Task.Delay(200);
1515
}
16-
Assert.Equal(0, CountChromiumTasks());
16+
Assert.True(CountChromiumTasks() <= 5);
1717
}
1818

1919
public static int CountChromiumTasks()

‎Codeuctivity.HtmlRendererTests/Infrastructure/DocumentAsserter.cs

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ internal static void AssertImageIsEqual(string actualImagePath, string expectIma
1414
var expectFullPath = Path.GetFullPath(expectImageFilePath);
1515

1616
Assert.True(File.Exists(actualFullPath), $"actualImagePath not found {actualFullPath}");
17+
// File.Copy(actualFullPath, expectFullPath, true);
1718
Assert.True(File.Exists(expectFullPath), $"ExpectReferenceImagePath not found \n{expectFullPath}\n copy over \n{actualFullPath}\n if this is a new test case.");
1819

1920
if (ImageSharpCompare.ImageSharpCompare.ImagesAreEqual(actualFullPath, expectFullPath))
@@ -56,6 +57,7 @@ internal static void AssertImageIsEqual(string actualImagePath, string expectIma
5657

5758
if (allowedPixelErrorCount < result.PixelErrorCount)
5859
{
60+
// File.Copy(newDiffImage, allowedDiffImage);
5961
CopyToTestOutput(newDiffImage);
6062
CopyToTestOutput(actualImagePath);
6163
}

‎Codeuctivity.HtmlRendererTests/RendererTests.cs

+12-53
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,20 @@
11
using Codeuctivity.HtmlRenderer;
22
using Codeuctivity.HtmlRendererTests.Infrastructure;
3-
using Codeuctivity.PdfjsSharp;
4-
using Jering.Javascript.NodeJS;
53
using PuppeteerSharp;
64
using System;
75
using System.IO;
8-
using System.Linq;
96
using System.Runtime.InteropServices;
107
using System.Threading.Tasks;
118
using Xunit;
129

1310
namespace Codeuctivity.HtmlRendererTests
1411
{
15-
public class RendererTests : IDisposable
12+
public class RendererTests
1613
{
17-
private bool disposedValue;
18-
1914
public RendererTests()
2015
{
21-
Rasterize = new Rasterizer();
2216
}
2317

24-
public Rasterizer Rasterize { get; private set; }
25-
2618
[Theory]
2719
[InlineData("BasicTextFormatted.html")]
2820
public async Task ShouldConvertHtmlToPdf(string testFileName)
@@ -44,14 +36,12 @@ public async Task ShouldConvertHtmlToPdf(string testFileName)
4436

4537
if (!IsRunningOnAzureOrMacos())
4638
{
47-
var actualImages = await Rasterize.ConvertToPngAsync(actualFilePath, actualImagePathDirectory);
48-
Assert.Single(actualImages);
49-
// File.Copy(actualImages.Single(), expectReferenceFilePath, true);
50-
DocumentAsserter.AssertImageIsEqual(actualImages.Single(), expectReferenceFilePath, 8000);
39+
PDFtoImage.Conversion.SavePng(actualImagePathDirectory, await File.ReadAllBytesAsync(actualFilePath));
40+
DocumentAsserter.AssertImageIsEqual(actualImagePathDirectory, expectReferenceFilePath, 8080);
5141
}
5242
File.Delete(actualFilePath);
5343
}
54-
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
44+
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunningExceptExpectedOrphanedBackgroundChromeProcesses();
5545
}
5646

5747
[Theory]
@@ -72,26 +62,16 @@ public async Task ShouldConvertHtmlToPdfWithOptions(string testFileName, bool pr
7262
{
7363
await chromiumRenderer.ConvertHtmlToPdf(sourceHtmlFilePath, actualFilePath, new PdfOptions() { PrintBackground = printBackground });
7464

75-
var actualImagePathDirectory = Path.Combine(Path.GetTempPath(), testFileName);
65+
var actualImagePathDirectory = Path.Combine(Path.GetTempPath(), testFileName + ".png");
7666

7767
if (!IsRunningOnAzureOrMacos())
7868
{
79-
try
80-
{
81-
var actualImages = await Rasterize.ConvertToPngAsync(actualFilePath, actualImagePathDirectory);
82-
Assert.Single(actualImages);
83-
// File.Copy(actualImages.Single(), expectReferenceFilePath, true);
84-
DocumentAsserter.AssertImageIsEqual(actualImages.Single(), expectReferenceFilePath, allowedPixelDiff);
85-
}
86-
catch (InvocationException ex)
87-
{
88-
// Working around issue in Jering.Javascript.NodeJS, silencing false positive failing
89-
Assert.True(RuntimeInformation.IsOSPlatform(OSPlatform.Windows), ex.Message);
90-
}
69+
PDFtoImage.Conversion.SavePng(actualImagePathDirectory, await File.ReadAllBytesAsync(actualFilePath));
70+
DocumentAsserter.AssertImageIsEqual(actualImagePathDirectory, expectReferenceFilePath, allowedPixelDiff);
9171
}
9272
File.Delete(actualFilePath);
9373
}
94-
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
74+
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunningExceptExpectedOrphanedBackgroundChromeProcesses();
9575
}
9676

9777
private static bool IsRunningOnAzureOrMacos()
@@ -133,7 +113,7 @@ public async Task ShouldConvertHtmlToPng(string testFileName)
133113
}
134114

135115
File.Delete(actualFilePath);
136-
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
116+
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunningExceptExpectedOrphanedBackgroundChromeProcesses();
137117
}
138118

139119
[Theory]
@@ -158,12 +138,11 @@ public async Task ShouldConvertHtmlToPngScreenshotOptions(string testFileName, b
158138
};
159139

160140
await chromiumRenderer.ConvertHtmlToPng(sourceHtmlFilePath, actualFilePath, screenshotOptions);
161-
// File.Copy(actualFilePath, expectReferenceFilePath, true);
162141
DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, allowedPixelDiff);
163142
}
164143

165144
File.Delete(actualFilePath);
166-
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
145+
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunningExceptExpectedOrphanedBackgroundChromeProcesses();
167146
}
168147

169148
[Theory]
@@ -189,13 +168,12 @@ public async Task ShouldConvertHtmlToPngBufferOptions(string testFileName, bool
189168

190169
var fileContent = await File.ReadAllTextAsync(sourceHtmlFilePath);
191170
var pngData = await chromiumRenderer.ConvertHtmlStringToPngData(fileContent, screenshotOptions);
192-
// File.Copy(actualFilePath, expectReferenceFilePath, true);
193171
await File.WriteAllBytesAsync(actualFilePath, pngData);
194172
DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, allowedPixelDiff);
195173
}
196174

197175
File.Delete(actualFilePath);
198-
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
176+
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunningExceptExpectedOrphanedBackgroundChromeProcesses();
199177
}
200178

201179
[Fact]
@@ -232,26 +210,7 @@ public async Task ShouldConvertHtmlToPngNoSandbox(string testFileName)
232210
}
233211

234212
File.Delete(actualFilePath);
235-
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
236-
}
237-
238-
protected virtual void Dispose(bool disposing)
239-
{
240-
if (!disposedValue)
241-
{
242-
if (disposing)
243-
{
244-
Rasterize?.Dispose();
245-
}
246-
247-
disposedValue = true;
248-
}
249-
}
250-
251-
public void Dispose()
252-
{
253-
Dispose(disposing: true);
254-
GC.SuppressFinalize(this);
213+
await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunningExceptExpectedOrphanedBackgroundChromeProcesses();
255214
}
256215
}
257216
}

‎README.md

-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ await chromiumRenderer.ConvertHtmlToPng(actualFilePath, pathRasterizedHtml);
2727

2828
```bash
2929
sudo apt install libgbm-dev libatk-bridge2.0-0 libnss3 libcups2 libxkbcommon0 libxcomposite1 libxdamage1 libxfixes3 libxrandr2 libpango-1.0-0 libcairo2 libasound2
30-
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
31-
exit
32-
nvm install 18
3330
```
3431

3532
... and if that fails you can either find out which dependency is missing on your system or you take a shortcut

0 commit comments

Comments
 (0)