Skip to content

Commit 7b01577

Browse files
rachit-lambdatestrachit-lambdatest
committed
Adding playwright support in c#
1 parent 0cb2e2b commit 7b01577

File tree

5 files changed

+320
-1
lines changed

5 files changed

+320
-1
lines changed

‎LambdaTest.Playwright.Driver/LambdaTest.Playwright.Driver.csproj‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<TargetFramework>net8.0</TargetFramework>
4+
<PackageId>LambdaTest.Playwright.Driver</PackageId>
5+
<Version>1.0.0</Version>
6+
<Authors>Lambdatest-SmartUI</Authors>
7+
<Company>LambdaTest</Company>
8+
<Description>LambdaTest C# Playwright SDK with SmartUI support</Description>
9+
<ImplicitUsings>enable</ImplicitUsings>
10+
<Nullable>enable</Nullable>
11+
</PropertyGroup>
12+
<ItemGroup>
13+
<PackageReference Include="LambdaTest.Sdk.Utils" Version="1.0.3" />
14+
<PackageReference Include="Microsoft.Playwright" Version="1.47.0" />
15+
<PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
16+
<PackageReference Include="Microsoft.Extensions.Logging.Console" Version="8.0.0" />
17+
</ItemGroup>
18+
</Project>

‎LambdaTest.Playwright.Driver/SmartUI.cs‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text.Json;
4+
using System.Threading.Tasks;
5+
using Microsoft.Extensions.Logging;
6+
using Microsoft.Playwright;
7+
using LambdaTest.Sdk.Utils;
8+
9+
namespace LambdaTest.Playwright.Driver
10+
{
11+
public static class SmartUISnapshot
12+
{
13+
private static readonly ILogger SmartUILogger = Logger.CreateLogger("Lambdatest.Playwright.Driver");
14+
15+
public static async Task CaptureSnapshot(IPage page, string name, Dictionary<string, object>? options = null)
16+
{
17+
if (string.IsNullOrEmpty(name))
18+
{
19+
throw new ArgumentException("The `snapshotName` argument is required.", nameof(name));
20+
}
21+
22+
if (!await LambdaTest.Sdk.Utils.SmartUI.IsSmartUIEnabled())
23+
{
24+
throw new Exception("Cannot find SmartUI server.");
25+
}
26+
27+
try
28+
{
29+
var domSerializerResponse = await LambdaTest.Sdk.Utils.SmartUI.FetchDomSerializer();
30+
if (domSerializerResponse == null)
31+
{
32+
throw new Exception("Failed to fetch DOM serializer script response.");
33+
}
34+
var domSerializerScript = JsonSerializer.Deserialize<FetchDomSerializerResponse>(domSerializerResponse, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
35+
if (domSerializerScript?.Data?.Dom == null)
36+
{
37+
throw new Exception("Failed to json serialize the DOM serializer script.");
38+
}
39+
40+
string script = domSerializerScript.Data.Dom;
41+
42+
// Execute the DOM serializer script in the page context
43+
await page.EvaluateAsync(script);
44+
var optionsJSON = JsonSerializer.Serialize(options);
45+
var snapshotScript = @"
46+
() => {
47+
var options = " + optionsJSON + @";
48+
return JSON.stringify({
49+
dom: SmartUIDOM.serialize(options),
50+
url: document.URL
51+
});
52+
}";
53+
54+
var domJSON = await page.EvaluateAsync<string>(snapshotScript);
55+
if (domJSON == null)
56+
{
57+
throw new Exception("Failed to capture DOM object.");
58+
}
59+
60+
var domContent = JsonSerializer.Deserialize<DomDeserializerResponse>(domJSON, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
61+
62+
if (domContent == null)
63+
{
64+
throw new Exception("Failed to convert DOM object into JSON");
65+
}
66+
67+
var dom = new LambdaTest.Sdk.Utils.SmartUI.DomObject
68+
{
69+
Dom = new LambdaTest.Sdk.Utils.SmartUI.DomContent
70+
{
71+
html = domContent.Dom.html,
72+
warnings = domContent.Dom.warnings,
73+
resources = domContent.Dom.resources,
74+
hints = domContent.Dom.hints
75+
},
76+
Name = name,
77+
Url = domContent.Url
78+
};
79+
80+
var apiResponseJSON = await LambdaTest.Sdk.Utils.SmartUI.PostSnapshot(dom, "Lambdatest.Playwright.Driver", options);
81+
var apiResponse = JsonSerializer.Deserialize<ApiResponse>(apiResponseJSON, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
82+
83+
if (apiResponse?.Data?.Warnings != null && apiResponse.Data.Warnings.Count > 0)
84+
{
85+
foreach (var warning in apiResponse.Data.Warnings)
86+
{
87+
SmartUILogger.LogWarning(warning);
88+
}
89+
}
90+
91+
SmartUILogger.LogInformation($"Snapshot captured: {name}");
92+
}
93+
catch (Exception e)
94+
{
95+
SmartUILogger.LogError($"Playwright snapshot failed: {name}");
96+
SmartUILogger.LogError(e.ToString());
97+
throw;
98+
}
99+
}
100+
101+
public static async Task CaptureSnapshot(IBrowserContext context, string name, Dictionary<string, object>? options = null)
102+
{
103+
// Capture snapshot from the first page in the context
104+
var pages = context.Pages;
105+
if (pages.Count > 0)
106+
{
107+
await CaptureSnapshot(pages[0], name, options);
108+
}
109+
else
110+
{
111+
throw new Exception("No pages available in the browser context for snapshot capture.");
112+
}
113+
}
114+
115+
public static async Task CaptureSnapshot(IBrowser browser, string name, Dictionary<string, object>? options = null)
116+
{
117+
// Capture snapshot from the first context in the browser
118+
var contexts = browser.Contexts;
119+
if (contexts.Count > 0)
120+
{
121+
await CaptureSnapshot(contexts[0], name, options);
122+
}
123+
else
124+
{
125+
throw new Exception("No browser contexts available for snapshot capture.");
126+
}
127+
}
128+
129+
private class ApiResponse
130+
{
131+
public ApiData Data { get; set; } = new ApiData();
132+
}
133+
134+
private class ApiData
135+
{
136+
public string Message { get; set; } = string.Empty;
137+
public List<string> Warnings { get; set; } = new List<string>();
138+
}
139+
140+
private class FetchDomSerializerResponse
141+
{
142+
public FetchDomSerializerData Data { get; set; } = new FetchDomSerializerData();
143+
}
144+
145+
private class FetchDomSerializerData
146+
{
147+
public string Dom { get; set; } = string.Empty;
148+
}
149+
150+
private class DomJSONContent
151+
{
152+
public string html { get; set; } = string.Empty;
153+
public List<string> warnings { get; set; } = new List<string>();
154+
public List<LambdaTest.Sdk.Utils.SmartUI.Resource> resources { get; set; } = new List<LambdaTest.Sdk.Utils.SmartUI.Resource>();
155+
public List<string> hints { get; set; } = new List<string>();
156+
}
157+
158+
private class DomDeserializerResponse
159+
{
160+
public DomJSONContent Dom { get; set; } = new DomJSONContent();
161+
public string Url { get; set; } = string.Empty;
162+
}
163+
}
164+
}

‎README.md‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
The LambdaTest C# SDK provides a set of utilities and integrations for working with LambdaTest's SmartUI and Selenium services. This SDK is designed to streamline the process of capturing and analyzing SmartUI snapshots using various testing frameworks.
5+
The LambdaTest C# SDK provides a set of utilities and integrations for working with LambdaTest's SmartUI and Selenium & Playwright services. This SDK is designed to streamline the process of capturing and analyzing SmartUI snapshots using various testing frameworks.
66

77
## Packages
88

@@ -21,14 +21,57 @@ LambdaTest.Selenium.Driver integrates seamlessly with Selenium WebDriver to capt
2121

2222
- SmartUI snapshot capture using Selenium WebDriver
2323
- Integration with LambdaTest SmartUI CLI
24+
- Support for RemoteWebDriver and local WebDriver instances
25+
26+
### LambdaTest.Playwright.Driver
27+
28+
LambdaTest.Playwright.Driver provides Playwright integration with LambdaTest SmartUI for capturing visual snapshots during automated testing. Features include:
29+
30+
- SmartUI snapshot capture using Playwright
31+
- Multi-level support (Page, BrowserContext, Browser)
32+
- Cross-browser support (Chromium, Firefox, WebKit)
2433

2534
## Installation
2635

2736
To install the packages, use the .NET CLI:
2837

2938
```sh
39+
# Core utilities
3040
dotnet add package LambdaTest.Sdk.Utils --version 1.0.3
41+
42+
# Selenium integration
3143
dotnet add package LambdaTest.Selenium.Driver --version 1.0.3
44+
45+
# Playwright integration
46+
dotnet add package LambdaTest.Playwright.Driver --version 1.0.0
47+
```
48+
49+
## Quick Start
50+
51+
### Selenium Example
52+
53+
```csharp
54+
using OpenQA.Selenium;
55+
using LambdaTest.Selenium.Driver;
56+
57+
var driver = new ChromeDriver();
58+
driver.Navigate().GoToUrl("https://example.com");
59+
60+
await SmartUISnapshot.CaptureSnapshot(driver, "my-snapshot");
61+
```
62+
63+
### Playwright Example
64+
65+
```csharp
66+
using Microsoft.Playwright;
67+
using LambdaTest.Playwright.Driver;
68+
69+
using var playwright = await Playwright.CreateAsync();
70+
await using var browser = await playwright.Chromium.LaunchAsync();
71+
var page = await browser.NewPageAsync();
72+
73+
await page.GotoAsync("https://example.com");
74+
await SmartUISnapshot.CaptureSnapshot(page, "my-snapshot");
3275
```
3376

3477
## License

‎Tests/Program.cs‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Threading.Tasks;
4+
using Microsoft.Playwright;
5+
using LambdaTest.Playwright.Driver;
6+
7+
namespace Tests
8+
{
9+
class Program
10+
{
11+
static async Task Main(string[] args)
12+
{
13+
Console.WriteLine("LambdaTest Playwright Driver Test");
14+
Console.WriteLine("===============================");
15+
16+
try
17+
{
18+
// Initialize Playwright
19+
using var playwright = await Playwright.CreateAsync();
20+
var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions
21+
{
22+
Headless = true
23+
});
24+
25+
var context = await browser.NewContextAsync();
26+
var page = await context.NewPageAsync();
27+
28+
// Navigate to a test page
29+
await page.GotoAsync("https://example.com");
30+
Console.WriteLine("✓ Successfully navigated to test page");
31+
32+
// Test basic snapshot capture
33+
try
34+
{
35+
await SmartUISnapshot.CaptureSnapshot(page, "test-snapshot");
36+
Console.WriteLine("✓ Basic snapshot capture successful");
37+
}
38+
catch (Exception ex)
39+
{
40+
Console.WriteLine($"x Snapshot capture failed (expected if SmartUI server not running): {ex.Message}");
41+
}
42+
43+
// Test context-level snapshot
44+
try
45+
{
46+
await SmartUISnapshot.CaptureSnapshot(context, "context-snapshot");
47+
Console.WriteLine("✓ Context-level snapshot capture successful");
48+
}
49+
catch (Exception ex)
50+
{
51+
Console.WriteLine($"x Context-level snapshot capture failed: {ex.Message}");
52+
}
53+
54+
// Test browser-level snapshot
55+
try
56+
{
57+
await SmartUISnapshot.CaptureSnapshot(browser, "browser-snapshot");
58+
Console.WriteLine("✓ Browser-level snapshot capture successful");
59+
}
60+
catch (Exception ex)
61+
{
62+
Console.WriteLine($"x Browser-level snapshot capture failed: {ex.Message}");
63+
}
64+
65+
// Cleanup
66+
await page.CloseAsync();
67+
await context.CloseAsync();
68+
await browser.CloseAsync();
69+
70+
Console.WriteLine("\n✓ All operations completed!");
71+
}
72+
catch (Exception ex)
73+
{
74+
Console.WriteLine($"Operation failed: {ex.Message}");
75+
}
76+
}
77+
}
78+
}

‎Tests/Tests.csproj‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<ItemGroup>
4+
<ProjectReference Include="..\LambdaTest.Playwright.Driver\LambdaTest.Playwright.Driver.csproj" />
5+
<ProjectReference Include="..\LambdaTest.Sdk.Utils\LambdaTest.Sdk.Utils.csproj"/>
6+
<PackageReference Include="Microsoft.Playwright" Version="1.54.0" />
7+
</ItemGroup>
8+
9+
<PropertyGroup>
10+
<OutputType>Exe</OutputType>
11+
<TargetFramework>net9.0</TargetFramework>
12+
<ImplicitUsings>enable</ImplicitUsings>
13+
<Nullable>enable</Nullable>
14+
</PropertyGroup>
15+
16+
</Project>

0 commit comments

Comments
 (0)