dotnet/test/common/Interactions/BasicWheelInterfaceTest.cs

// <copyright file="BasicWheelInterfaceTest.cs" company="Selenium Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
// </copyright>

using NUnit.Framework;
using System;

namespace OpenQA.Selenium.Interactions;

[TestFixture]
[IgnoreBrowser(Browser.IE, "IE does not support scrolling")]
public class BasicWheelInterfaceTest : DriverTestFixture
{
    [SetUp]
    public void SetupTest()
    {
        IActionExecutor actionExecutor = driver as IActionExecutor;
        if (actionExecutor != null)
        {
            actionExecutor.ResetInputState();
        }
        driver.SwitchTo().DefaultContent();
        ((IJavaScriptExecutor)driver).ExecuteScript("window.scrollTo(0, 0)");
    }

    [Test]
    public void ShouldSetActiveWheel()
    {
        Actions actionProvider = new Actions(driver);
        actionProvider.SetActiveWheel("test wheel");

        WheelInputDevice device = actionProvider.GetActiveWheel();

        Assert.That(device.DeviceName, Is.EqualTo("test wheel"));
    }

    [Test]
    [IgnoreBrowser(Browser.Firefox, "Incorrectly throws out of bounds exception")]
    public void ShouldAllowScrollingToAnElement()
    {
        driver.Url = scrollFrameOutOfViewport;
        IWebElement iframe = driver.FindElement(By.TagName("iframe"));

        Assert.That(IsInViewport(iframe), Is.False);

        new Actions(driver).ScrollToElement(iframe).Build().Perform();

        Assert.That(IsInViewport(iframe), Is.True);
    }

    [Test]
    [IgnoreBrowser(Browser.Firefox, "Incorrectly throws out of bounds exception")]
    public void ShouldScrollFromElementByGivenAmount()
    {
        driver.Url = scrollFrameOutOfViewport;
        IWebElement iframe = driver.FindElement(By.TagName("iframe"));
        WheelInputDevice.ScrollOrigin scrollOrigin = new WheelInputDevice.ScrollOrigin
        {
            Element = iframe
        };

        new Actions(driver).ScrollFromOrigin(scrollOrigin, 0, 200).Build().Perform();

        driver.SwitchTo().Frame(iframe);
        IWebElement checkbox = driver.FindElement(By.Name("scroll_checkbox"));
        Assert.That(IsInViewport(checkbox), Is.True);
    }

    [Test]
    [IgnoreBrowser(Browser.Firefox, "Incorrectly throws out of bounds exception")]
    public void ShouldAllowScrollingFromElementByGivenAmountWithOffset()
    {
        driver.Url = scrollFrameOutOfViewport;
        IWebElement footer = driver.FindElement(By.TagName("footer"));
        var scrollOrigin = new WheelInputDevice.ScrollOrigin
        {
            Element = footer,
            XOffset = 0,
            YOffset = -50
        };

        new Actions(driver).ScrollFromOrigin(scrollOrigin, 0, 200).Build().Perform();

        IWebElement iframe = driver.FindElement(By.TagName("iframe"));
        driver.SwitchTo().Frame(iframe);
        IWebElement checkbox = driver.FindElement(By.Name("scroll_checkbox"));
        Assert.That(IsInViewport(checkbox), Is.True);
    }

    [Test]
    public void ShouldNotAllowScrollingWhenElementOriginOutOfViewport()
    {
        driver.Url = scrollFrameOutOfViewport;
        IWebElement footer = driver.FindElement(By.TagName("footer"));
        var scrollOrigin = new WheelInputDevice.ScrollOrigin
        {
            Element = footer,
            XOffset = 0,
            YOffset = 50
        };

        Assert.That(() => new Actions(driver).ScrollFromOrigin(scrollOrigin, 0, 200).Build().Perform(),
            Throws.InstanceOf<MoveTargetOutOfBoundsException>());
    }

    [Test]
    [IgnoreBrowser(Browser.Firefox, "Does not work on Mac for some reason")]
    public void ShouldAllowScrollingFromViewportByGivenAmount()
    {
        driver.Url = scrollFrameOutOfViewport;
        IWebElement footer = driver.FindElement(By.TagName("footer"));
        int deltaY = footer.Location.Y;

        new Actions(driver).ScrollByAmount(0, deltaY).Build().Perform();

        Assert.That(IsInViewport(footer), Is.True);
    }

    [Test]
    public void ShouldAllowScrollingFromViewportByGivenAmountFromOrigin()
    {
        driver.Url = scrollFrameInViewport;
        var scrollOrigin = new WheelInputDevice.ScrollOrigin
        {
            Viewport = true,
            XOffset = 10,
            YOffset = 10
        };

        new Actions(driver).ScrollFromOrigin(scrollOrigin, 0, 200).Build().Perform();

        IWebElement iframe = driver.FindElement(By.TagName("iframe"));
        driver.SwitchTo().Frame(iframe);
        IWebElement checkbox = driver.FindElement(By.Name("scroll_checkbox"));
        Assert.That(IsInViewport(checkbox), Is.True);
    }

    [Test]
    public void ShouldNotAllowScrollingWhenOriginOffsetIsOutOfViewport()
    {
        driver.Url = scrollFrameInViewport;
        var scrollOrigin = new WheelInputDevice.ScrollOrigin
        {
            Viewport = true,
            XOffset = -10,
            YOffset = -10
        };

        Assert.That(() => new Actions(driver).ScrollFromOrigin(scrollOrigin, 0, 200).Build().Perform(),
            Throws.InstanceOf<MoveTargetOutOfBoundsException>());
    }

    private bool IsInViewport(IWebElement element)
    {
        String script =
            "for(var e=arguments[0],f=e.offsetTop,t=e.offsetLeft,o=e.offsetWidth,n=e.offsetHeight;\n"
            + "e.offsetParent;)f+=(e=e.offsetParent).offsetTop,t+=e.offsetLeft;\n"
            + "return f<window.pageYOffset+window.innerHeight&&t<window.pageXOffset+window.innerWidth&&f+n>\n"
            + "window.pageYOffset&&t+o>window.pageXOffset";
        IJavaScriptExecutor javascriptDriver = this.driver as IJavaScriptExecutor;

        return (bool)javascriptDriver.ExecuteScript(script, element);
    }
}