dotnet/src/webdriver/Safari/SafariDriver.cs

// <copyright file="SafariDriver.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 OpenQA.Selenium.Remote;
using System;
using System.Collections.Generic;
using System.IO;

namespace OpenQA.Selenium.Safari;

/// <summary>
/// Provides a way to access Safari to run your tests by creating a SafariDriver instance
/// </summary>
/// <remarks>
/// When the WebDriver object has been instantiated the browser will load. The test can then navigate to the URL under test and
/// start your test.
/// </remarks>
/// <example>
/// <code>
/// [TestFixture]
/// public class Testing
/// {
///     private IWebDriver driver;
///     <para></para>
///     [SetUp]
///     public void SetUp()
///     {
///         driver = new SafariDriver();
///     }
///     <para></para>
///     [Test]
///     public void TestGoogle()
///     {
///         driver.Navigate().GoToUrl("http://www.google.co.uk");
///         /*
///         *   Rest of the test
///         */
///     }
///     <para></para>
///     [TearDown]
///     public void TearDown()
///     {
///         driver.Quit();
///         driver.Dispose();
///     }
/// }
/// </code>
/// </example>
public class SafariDriver : WebDriver
{
    private const string AttachDebuggerCommand = "attachDebugger";
    private const string GetPermissionsCommand = "getPermissions";
    private const string SetPermissionsCommand = "setPermissions";

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class.
    /// </summary>
    public SafariDriver()
        : this(new SafariOptions())
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class using the specified <see cref="SafariOptions"/>.
    /// </summary>
    /// <param name="options">The <see cref="SafariOptions"/> to use for this <see cref="SafariDriver"/> instance.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="options"/> is <see langword="null"/>.</exception>
    public SafariDriver(SafariOptions options)
        : this(SafariDriverService.CreateDefaultService(), options)
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class using the specified driver service.
    /// </summary>
    /// <param name="service">The <see cref="SafariDriverService"/> used to initialize the driver.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="service"/> is <see langword="null"/>.</exception>
    public SafariDriver(SafariDriverService service)
        : this(service, new SafariOptions())
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class using the specified path
    /// to the directory containing <c>safaridriver</c>.
    /// </summary>
    /// <param name="safariDriverDirectory">The full path to the directory containing SafariDriver executable.</param>
    public SafariDriver(string safariDriverDirectory)
        : this(safariDriverDirectory, new SafariOptions())
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class using the specified path
    /// to the directory containing <c>safaridriver</c> and options.
    /// </summary>
    /// <param name="safariDriverDirectory">The full path to the directory containing SafariDriver executable.</param>
    /// <param name="options">The <see cref="SafariOptions"/> to be used with the Safari driver.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="options"/> is <see langword="null"/>.</exception>
    public SafariDriver(string safariDriverDirectory, SafariOptions options)
        : this(safariDriverDirectory, options, RemoteWebDriver.DefaultCommandTimeout)
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class using the specified path
    /// to the directory containing <c>safaridriver</c>, options, and command timeout.
    /// </summary>
    /// <param name="safariDriverDirectory">The full path to the directory containing SafariDriver executable.</param>
    /// <param name="options">The <see cref="SafariOptions"/> to be used with the Safari driver.</param>
    /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="options"/> is <see langword="null"/>.</exception>
    public SafariDriver(string safariDriverDirectory, SafariOptions options, TimeSpan commandTimeout)
        : this(SafariDriverService.CreateDefaultService(safariDriverDirectory), options, commandTimeout)
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class using the specified
    /// <see cref="SafariDriverService"/> and options.
    /// </summary>
    /// <param name="service">The <see cref="SafariDriverService"/> to use.</param>
    /// <param name="options">The <see cref="SafariOptions"/> used to initialize the driver.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="service"/> or <paramref name="options"/> are <see langword="null"/>.</exception>
    public SafariDriver(SafariDriverService service, SafariOptions options)
        : this(service, options, RemoteWebDriver.DefaultCommandTimeout)
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="SafariDriver"/> class using the specified <see cref="SafariDriverService"/>.
    /// </summary>
    /// <param name="service">The <see cref="SafariDriverService"/> to use.</param>
    /// <param name="options">The <see cref="SafariOptions"/> to be used with the Safari driver.</param>
    /// <param name="commandTimeout">The maximum amount of time to wait for each command.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="service"/> or <paramref name="options"/> are <see langword="null"/>.</exception>
    public SafariDriver(SafariDriverService service, SafariOptions options, TimeSpan commandTimeout)
        : base(GenerateDriverServiceCommandExecutor(service, options, commandTimeout), ConvertOptionsToCapabilities(options))
    {
        this.AddCustomSafariCommand(AttachDebuggerCommand, HttpCommandInfo.PostCommand, "/session/{sessionId}/apple/attach_debugger");
        this.AddCustomSafariCommand(GetPermissionsCommand, HttpCommandInfo.GetCommand, "/session/{sessionId}/apple/permissions");
        this.AddCustomSafariCommand(SetPermissionsCommand, HttpCommandInfo.PostCommand, "/session/{sessionId}/apple/permissions");
    }

    /// <summary>
    /// Uses DriverFinder to set Service attributes if necessary when creating the command executor
    /// </summary>
    /// <param name="service"></param>
    /// <param name="commandTimeout"></param>
    /// <param name="options"></param>
    /// <returns></returns>
    private static ICommandExecutor GenerateDriverServiceCommandExecutor(DriverService service, DriverOptions options, TimeSpan commandTimeout)
    {
        if (service is null)
        {
            throw new ArgumentNullException(nameof(service));
        }

        if (options is null)
        {
            throw new ArgumentNullException(nameof(options));
        }

        if (service.DriverServicePath == null)
        {
            DriverFinder finder = new DriverFinder(options);
            string fullServicePath = finder.GetDriverPath();
            service.DriverServicePath = Path.GetDirectoryName(fullServicePath);
            service.DriverServiceExecutableName = Path.GetFileName(fullServicePath);
        }
        return new DriverServiceCommandExecutor(service, commandTimeout);
    }

    /// <summary>
    /// This opens Safari's Web Inspector.
    /// If driver subsequently executes script of "debugger;"
    /// the execution will pause, no additional commands will be processed, and the code will time out.
    /// </summary>
    public void AttachDebugger()
    {
        Dictionary<string, object?> parameters = new Dictionary<string, object?>();
        parameters["attachDebugger"] = null;
        this.Execute(AttachDebuggerCommand, parameters);
    }

    /// <summary>
    /// Set permission of an item on the browser. The only supported permission at this time is "getUserMedia".
    /// </summary>
    /// <param name="permissionName">The name of the item to set permission on.</param>
    /// <param name="permissionValue">Whether the permission has been granted.</param>
    /// <exception cref="ArgumentException">If <paramref name="permissionName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</exception>
    public void SetPermission(string permissionName, bool permissionValue)
    {
        if (string.IsNullOrEmpty(permissionName))
        {
            throw new ArgumentNullException(nameof(permissionName), "permission must not be null or the empty string");
        }

        Dictionary<string, object> permissions = new Dictionary<string, object>();
        permissions[permissionName] = permissionValue;
        Dictionary<string, object> parameters = new Dictionary<string, object>();
        parameters["permissions"] = permissions;
        this.Execute(SetPermissionsCommand, parameters);
    }

    /// <summary>
    /// Returns Each available permission item and whether it is allowed or not.
    /// </summary>
    /// <returns>whether the item is allowed or not.</returns>
    public object? GetPermissions()
    {
        Response response = this.Execute(GetPermissionsCommand, null);
        return response.Value;
    }

    /// <summary>
    /// Gets or sets the <see cref="IFileDetector"/> responsible for detecting
    /// sequences of keystrokes representing file paths and names.
    /// </summary>
    /// <remarks>The Safari driver does not allow a file detector to be set,
    /// as the server component of the Safari driver (the Safari extension) only
    /// allows uploads from the local computer environment. Attempting to set
    /// this property has no effect, but does not throw an exception. If you
    /// are attempting to run the Safari driver remotely, use <see cref="RemoteWebDriver"/>
    /// in conjunction with a standalone WebDriver server.</remarks>
    public override IFileDetector FileDetector
    {
        get => base.FileDetector;
        set { }
    }

    private static ICapabilities ConvertOptionsToCapabilities(SafariOptions options)
    {
        if (options == null)
        {
            throw new ArgumentNullException(nameof(options), "options must not be null");
        }

        return options.ToCapabilities();
    }

    private void AddCustomSafariCommand(string commandName, string method, string resourcePath)
    {
        HttpCommandInfo commandInfoToAdd = new HttpCommandInfo(method, resourcePath);
        this.CommandExecutor.TryAddCommand(commandName, commandInfoToAdd);
    }
}