dotnet/src/webdriver/Internal/ResourceUtilities.cs

// <copyright file="ResourceUtilities.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 System.Globalization;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;

namespace OpenQA.Selenium.Internal;

/// <summary>
/// Encapsulates methods for finding and extracting WebDriver resources.
/// </summary>
internal static class ResourceUtilities
{
    private static string? productVersion;
    private static string? platformFamily;

    /// <summary>
    /// Gets a string representing the informational version of the Selenium product.
    /// </summary>
    public static string ProductVersion
    {
        get
        {
            if (productVersion == null)
            {
                Assembly executingAssembly = Assembly.GetExecutingAssembly();
                var assemblyInformationalVersionAttribute = executingAssembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>();
                if (assemblyInformationalVersionAttribute == null)
                {
                    productVersion = "Unknown";
                }
                else
                {
                    productVersion = assemblyInformationalVersionAttribute.InformationalVersion;
                }
            }

            return productVersion;
        }
    }

    /// <summary>
    /// Gets a string representing the platform family on which the Selenium assembly is executing.
    /// </summary>
    public static string PlatformFamily => platformFamily ??= GetPlatformString();

    /// <summary>
    /// Gets a <see cref="Stream"/> that contains the resource to use.
    /// </summary>
    /// <param name="fileName">A file name in the file system containing the resource to use.</param>
    /// <param name="resourceId">A string representing the resource name embedded in the
    /// executing assembly, if it is not found in the file system.</param>
    /// <returns>A Stream from which the resource can be read.</returns>
    /// <exception cref="WebDriverException">Thrown if neither the file nor the embedded resource can be found.</exception>
    /// <remarks>
    /// The GetResourceStream method searches for the specified resource using the following
    /// algorithm:
    /// <para>
    /// <list type="numbered">
    /// <item>In the same directory as the calling assembly.</item>
    /// <item>In the full path specified by the <paramref name="fileName"/> argument.</item>
    /// <item>Inside the calling assembly as an embedded resource.</item>
    /// </list>
    /// </para>
    /// </remarks>
    public static Stream GetResourceStream(string fileName, string resourceId)
    {
        Stream? resourceStream;
        string resourceFilePath = Path.Combine(FileUtilities.GetCurrentDirectory(), Path.GetFileName(fileName));
        if (File.Exists(resourceFilePath))
        {
            resourceStream = new FileStream(resourceFilePath, FileMode.Open, FileAccess.Read);
        }
        else if (File.Exists(fileName))
        {
            resourceStream = new FileStream(fileName, FileMode.Open, FileAccess.Read);
        }
        else
        {
            if (string.IsNullOrEmpty(resourceId))
            {
                throw new WebDriverException("The file specified does not exist, and you have specified no internal resource ID");
            }

            Assembly executingAssembly = Assembly.GetExecutingAssembly();
            resourceStream = executingAssembly.GetManifestResourceStream(resourceId);
        }

        if (resourceStream == null)
        {
            throw new WebDriverException(string.Format(CultureInfo.InvariantCulture, "Cannot find a file named '{0}' or an embedded resource with the id '{1}'.", resourceFilePath, resourceId));
        }

        return resourceStream;
    }

    private static string GetPlatformString()
    {
        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
        {
            return "windows";
        }
        else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
        {
            return "linux";
        }
        else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
        {
            return "mac";
        }
        else
        {
            return "unknown";
        }
    }
}