[dotnet] Add examples for BiDi W3C Browsing Context

examples/dotnet/SeleniumDocs/BaseTest.cs

@@ -36,6 +36,7 @@ public void Cleanup()
         protected void StartDriver(string browserVersion = null)
         {
             ChromeOptions options = new ChromeOptions();
+            options.UseWebSocketUrl = true;
             if (browserVersion != null)
             {
                 options.BrowserVersion = browserVersion;

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Activate.cs

@@ -0,0 +1,13 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task Activate()
+    {
+        await context.ActivateAsync();
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.CaptureScreenshot.cs

@@ -0,0 +1,42 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task CaptureScreenshot()
+    {
+        var screenshot = await context.CaptureScreenshotAsync();
+
+        Assert.IsNotNull(screenshot);
+        Assert.IsNotNull(screenshot.Data);
+        Assert.IsNotNull(screenshot.ToByteArray());
+    }
+
+    [TestMethod]
+    public async Task CaptureViewportScreenshot()
+    {
+        var screenshot = await context.CaptureScreenshotAsync(new() { Clip = new BoxClipRectangle(5, 5, 10, 10) });
+
+        Assert.IsNotNull(screenshot);
+        Assert.IsNotNull(screenshot.Data);
+    }
+
+    [TestMethod]
+    public async Task CaptureElementScreenshot()
+    {
+        driver.Url = "https://www.selenium.dev/selenium/web/formPage.html";
+
+        var nodes = (await context.LocateNodesAsync(new CssLocator("#checky"))).Nodes;
+
+        Assert.IsTrue(nodes.Length > 0, "Expected to locate #checky");
+
+        var screenshot = await context.CaptureScreenshotAsync(new() { Clip = new ElementClipRectangle(nodes[0]) });
+
+        Assert.IsNotNull(screenshot);
+        Assert.IsNotNull(screenshot.Data);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Close.cs

@@ -0,0 +1,24 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task CloseTab()
+    {
+        var context = (await bidi.BrowsingContext.CreateAsync(ContextType.Tab)).Context;
+
+        await context.CloseAsync();
+    }
+
+    [TestMethod]
+    public async Task CloseWindow()
+    {
+        var context = (await bidi.BrowsingContext.CreateAsync(ContextType.Window)).Context;
+
+        await context.CloseAsync();
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Create.cs

@@ -0,0 +1,57 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task OpenNewTab()
+    {
+        var bidi = await driver.AsBiDiAsync();
+
+        var context = (await bidi.BrowsingContext.CreateAsync(ContextType.Tab)).Context;
+
+        Assert.IsNotNull(context);
+    }
+
+    [TestMethod]
+    public async Task OpenNewWindow()
+    {
+        var bidi = await driver.AsBiDiAsync();
+
+        var context = (await bidi.BrowsingContext.CreateAsync(ContextType.Window)).Context;
+
+        Assert.IsNotNull(context);
+    }
+
+    [TestMethod]
+    public async Task OpenTabWithReferenceBrowsingContext()
+    {
+        var context1 = context;
+
+        var context2 = (await context1.BiDi.BrowsingContext.CreateAsync(ContextType.Tab, new() { ReferenceContext = context1 })).Context;
+
+        Assert.IsNotNull(context2);
+    }
+
+    [TestMethod]
+    public async Task OpenWindowWithReferenceBrowsingContext()
+    {
+        var context1 = context;
+
+        var context2 = (await context1.BiDi.BrowsingContext.CreateAsync(ContextType.Window, new() { ReferenceContext = context1 })).Context;
+
+        Assert.IsNotNull(context2);
+    }
+
+    [TestMethod]
+    public async Task UseExistingWindowHandle()
+    {
+        var context = (await bidi.BrowsingContext.GetTreeAsync()).Contexts[0].Context;
+
+        Assert.IsNotNull(context);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Event.BrowsingContextCreated.cs

@@ -0,0 +1,24 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task BrowsingContextCreatedEvent()
+    {
+        TaskCompletionSource<ContextCreatedEventArgs> tcs = new();
+
+        await bidi.BrowsingContext.ContextCreated.SubscribeAsync(args => tcs.TrySetResult(args));
+
+        driver.SwitchTo().NewWindow(OpenQA.Selenium.WindowType.Window);
+
+        var info = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(info);
+        Console.WriteLine(info);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Event.BrowsingContextDestroyed.cs

@@ -0,0 +1,25 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task BrowsingContextDestroyedEvent()
+    {
+        TaskCompletionSource<ContextDestroyedEventArgs> tcs = new();
+
+        await bidi.BrowsingContext.ContextDestroyed.SubscribeAsync(args => tcs.TrySetResult(args));
+
+        await context.CloseAsync();
+
+        var contextInfo = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(contextInfo);
+        Assert.AreEqual(context, contextInfo.Context);
+        Console.WriteLine(contextInfo);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Event.BrowsingContextLoaded.cs

@@ -0,0 +1,24 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task BrowsingContextLoadedEvent()
+    {
+        TaskCompletionSource<LoadEventArgs> tcs = new();
+
+        await context.Load.SubscribeAsync(args => tcs.TrySetResult(args));
+
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html", new() { Wait = ReadinessState.Complete });
+
+        var navigationInfo = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(navigationInfo);
+        Console.WriteLine(navigationInfo);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Event.DomContentLoaded.cs

@@ -0,0 +1,24 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task DomContentLoadedEvent()
+    {
+        TaskCompletionSource<DomContentLoadedEventArgs> tcs = new();
+
+        await context.DomContentLoaded.SubscribeAsync(args => tcs.TrySetResult(args));
+
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html", new() { Wait = ReadinessState.Complete });
+
+        var navigationInfo = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(navigationInfo);
+        Console.WriteLine(navigationInfo);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Event.FragmentNavigated.cs

@@ -0,0 +1,26 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task FragmentNavigatedEvent()
+    {
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/linked_image.html", new() { Wait = ReadinessState.Complete });
+
+        TaskCompletionSource<FragmentNavigatedEventArgs> tcs = new();
+
+        await context.FragmentNavigated.SubscribeAsync(args => tcs.TrySetResult(args));
+
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/linked_image.html#linkToAnchorOnThisPage", new() { Wait = ReadinessState.Complete });
+
+        var navigationInfo = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(navigationInfo);
+        Console.WriteLine(navigationInfo);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Event.NavigationStarted.cs

@@ -0,0 +1,23 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task NavigationStartedEvent()
+    {
+        TaskCompletionSource<NavigationStartedEventArgs> tcs = new();
+
+        await context.NavigationStarted.SubscribeAsync(args => tcs.TrySetResult(args));
+
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html", new() { Wait = ReadinessState.Complete });
+
+        var info = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(info);
+    }
+}

examples/dotnet/SeleniumDocs/BiDi/BrowsingContext/BrowsingContextTest.Event.UserPrompt.cs

@@ -0,0 +1,61 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium;
+using OpenQA.Selenium.BiDi;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task UserPromptOpenedEvent()
+    {
+        TaskCompletionSource<UserPromptOpenedEventArgs> tcs = new();
+
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/alerts.html", new() { Wait = ReadinessState.Complete });
+
+        // TODO: this event can be a part of context
+        await bidi.BrowsingContext.UserPromptOpened.SubscribeAsync(args => tcs.TrySetResult(args));
+
+        driver.FindElement(By.Id("prompt")).Click();
+
+        var userPromptOpenedEventArgs = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(userPromptOpenedEventArgs);
+        Console.WriteLine(userPromptOpenedEventArgs);
+    }
+
+    [TestMethod]
+    public async Task UserPromptClosedEvent()
+    {
+        TaskCompletionSource<UserPromptOpenedEventArgs> opened = new();
+        TaskCompletionSource<UserPromptClosedEventArgs> closed = new();
+
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/alerts.html", new() { Wait = ReadinessState.Complete });
+
+        // TODO: these events can be a part of context
+        await bidi.BrowsingContext.UserPromptOpened.SubscribeAsync(args => opened.TrySetResult(args));
+        await bidi.BrowsingContext.UserPromptClosed.SubscribeAsync(args => closed.TrySetResult(args));
+
+        driver.FindElement(By.Id("prompt")).Click();
+
+        await opened.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        try
+        {
+            // Chrome's default unhandled prompt behavior may already have closed the
+            // prompt by this point; tolerate that instead of treating it as a failure.
+            await context.HandleUserPromptAsync(new() { Accept = true });
+        }
+        catch (BiDiException ex) when (ex.Message.Contains("no such alert"))
+        {
+        }
+
+        var userPromptClosedEventArgs = await closed.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(userPromptClosedEventArgs);
+        Console.WriteLine(userPromptClosedEventArgs);
+    }
+}