[dotnet] Add examples for BiDi W3C Browsing Context

examples/dotnet/SeleniumDocs/BaseTest.cs

@@ -37,8 +37,12 @@ protected void StartDriver(string browserVersion = "stable")
         {
             ChromeOptions options = new ChromeOptions
             {
-                BrowserVersion = browserVersion
+                BrowserVersion = browserVersion,
+                UseWebSocketUrl = true,
             };
+
+            options.AddArgument("--no-sandbox");
+
             driver = new ChromeDriver(options);
         }
 

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,40 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi.Modules.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 element = (await context.LocateNodesAsync(new CssLocator("#checky")))[0];
+
+        var screenshot = await context.CaptureScreenshotAsync(new() { Clip = new ElementClipRectangle(element) });
+
+        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.Modules.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);
+
+        await context.CloseAsync();
+    }
+
+    [TestMethod]
+    public async Task CloseWindow()
+    {
+        var context = await bidi.BrowsingContext.CreateAsync(ContextType.Window);
+
+        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.Modules.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);
+
+        Assert.IsNotNull(context);
+    }
+
+    [TestMethod]
+    public async Task OpenNewWindow()
+    {
+        var bidi = await driver.AsBiDiAsync();
+
+        var context = await bidi.BrowsingContext.CreateAsync(ContextType.Window);
+
+        Assert.IsNotNull(context);
+    }
+
+    [TestMethod]
+    public async Task OpenTabWithReferenceBrowsingContext()
+    {
+        var context1 = context;
+
+        var context2 = await context1.BiDi.BrowsingContext.CreateAsync(ContextType.Tab, new() { ReferenceContext = context1 });
+
+        Assert.IsNotNull(context2);
+    }
+
+    [TestMethod]
+    public async Task OpenWindowWithReferenceBrowsingContext()
+    {
+        var context1 = context;
+
+        var context2 = await context1.BiDi.BrowsingContext.CreateAsync(ContextType.Window, new() { ReferenceContext = context1 });
+
+        Assert.IsNotNull(context2);
+    }
+
+    [TestMethod]
+    public async Task UseExistingWindowHandle()
+    {
+        var context = (await bidi.BrowsingContext.GetTreeAsync())[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.Modules.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task BrowsingContextCreatedEvent()
+    {
+        TaskCompletionSource<BrowsingContextInfo> tcs = new();
+
+        await bidi.BrowsingContext.OnContextCreatedAsync(tcs.SetResult);
+
+        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.Modules.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task BrowsingContextDestroyedEvent()
+    {
+        TaskCompletionSource<BrowsingContextInfo> tcs = new();
+
+        await bidi.BrowsingContext.OnContextDestroyedAsync(tcs.SetResult);
+
+        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.Modules.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task BrowsingContextLoadedEvent()
+    {
+        TaskCompletionSource<NavigationInfo> tcs = new();
+
+        await context.OnLoadAsync(tcs.SetResult);
+
+        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.Modules.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task DomContentLoadedEvent()
+    {
+        TaskCompletionSource<NavigationInfo> tcs = new();
+
+        await context.OnDomContentLoadedAsync(tcs.SetResult);
+
+        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.Modules.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<NavigationInfo> tcs = new();
+
+        await context.OnFragmentNavigatedAsync(tcs.SetResult);
+
+        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.Modules.BrowsingContext;
+using System;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task NavigationStartedEvent()
+    {
+        TaskCompletionSource<NavigationInfo> tcs = new();
+
+        await context.OnNavigationStartedAsync(tcs.SetResult);
+
+        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,48 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium;
+using OpenQA.Selenium.BiDi.Modules.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; THhis event can be a part of context
+        await bidi.BrowsingContext.OnUserPromptOpenedAsync(tcs.SetResult);
+
+        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<UserPromptClosedEventArgs> tcs = new();
+
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/alerts.html", new() { Wait = ReadinessState.Complete });
+
+        //TODO; THhis event can be a part of context
+        await bidi.BrowsingContext.OnUserPromptClosedAsync(tcs.SetResult);
+
+        driver.FindElement(By.Id("prompt")).Click();
+
+        //await context.HandleUserPromptAsync();
+
+        var userPromptClosedEventArgs = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5));
+
+        Assert.IsNotNull(userPromptClosedEventArgs);
+        Console.WriteLine(userPromptClosedEventArgs);
+    }
+}

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

@@ -0,0 +1,43 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.BiDi;
+using OpenQA.Selenium.BiDi.Modules.BrowsingContext;
+using System.Threading.Tasks;
+
+namespace SeleniumDocs.BiDi.BrowsingContext;
+
+partial class BrowsingContextTest
+{
+    [TestMethod]
+    public async Task GetBrowsingContextTree()
+    {
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/iframes.html", new() { Wait = ReadinessState.Complete });
+
+        var contexts = await context.GetTreeAsync();
+
+        Assert.AreEqual(1, contexts.Count);
+        Assert.IsNotNull(contexts[0].Children);
+        Assert.IsTrue(contexts[0].Children.Count >= 1, "Context should contain iframes as children");
+    }
+
+    [TestMethod]
+    public async Task GetBrowsingContextTreeWithDepth()
+    {
+        await context.NavigateAsync("https://www.selenium.dev/selenium/web/iframes.html", new() { Wait = ReadinessState.Complete });
+
+        var contexts = await context.GetTreeAsync(new() { MaxDepth = 0 });
+
+        Assert.AreEqual(1, contexts.Count);
+        Assert.IsNull(contexts[0].Children, "Context should not contain iframes as children since depth is 0");
+    }
+
+    [TestMethod]
+    public async Task GetAllTopLevelBrowingContexts()
+    {
+        var window = await bidi.BrowsingContext.CreateAsync(ContextType.Window);
+
+        var contexts = await bidi.BrowsingContext.GetTreeAsync();
+
+        Assert.AreEqual(2, contexts.Count);
+        Assert.AreEqual(contexts[1].Context, window);
+    }
+}