Nutstone.Selenium.Core 1.0.38

There is a newer version of this package available.
See the version list below for details.
dotnet add package Nutstone.Selenium.Core --version 1.0.38
NuGet\Install-Package Nutstone.Selenium.Core -Version 1.0.38
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nutstone.Selenium.Core" Version="1.0.38" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Nutstone.Selenium.Core --version 1.0.38
#r "nuget: Nutstone.Selenium.Core, 1.0.38"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Nutstone.Selenium.Core as a Cake Addin
#addin nuget:?package=Nutstone.Selenium.Core&version=1.0.38

// Install Nutstone.Selenium.Core as a Cake Tool
#tool nuget:?package=Nutstone.Selenium.Core&version=1.0.38

Introduction

Hi. this package is written out of boredom with havng to run UI tests manually whilst developing .net core (5) full-stack applications.

It provides a fluent interface for writing selenium based unit TESTS, but could be used to create full functioning selenium applications.

it is not complete , but is basically functional (hence the readme)

David.

Installation

Install-Package Nutstone.Selenium.Core

install the selenium package of your choice.

This package ONLY (currently) supports ChromeDriver , but can be extended be implementing by implementing ISeleniumWebDriver.

note this package makes extensive use of the excellent Scrutor package so ALL supported interfaces will be loaded at startup , you do not have to register them yourself

for example:-

using Nutstone.Selenium.Core.Browser.Drivers;
using Nutstone.Selenium.Core.Configuration;
using OpenQA.Selenium;
using OpenQA.Selenium.Edge;
using System.IO;

namespace test_nutstone_selenium.Drivers
{
    public class SeleniumEdgeDriver : ISeleniumWebDriver
    {
        public string BrowserType => DriverConstants.Edge;
        public IWebDriver GetDriver(DriverConfiguration driverConfiguration)
        {
            var edgeOptions = new EdgeOptions
            {
                LeaveBrowserRunning = driverConfiguration.LeaveBrowserRunning,
                BinaryLocation = Path.Combine(driverConfiguration.DriverPath, "msedgedriver.exe")
            };
            return new EdgeDriver(edgeOptions);
        }

        public string GetDriverExecutable()
        {
            return "msedgedriver";
        }
    }
}

Getting Started

Define your page models


using Nutstone.Selenium.Core.Attributes;

namespace test_nutstone_selenium.Tests
{
    public class TestModel
    {
        [SeleniumModel(SelectorType.Xpath, "//*[@id='simpletests']")]
        public bool SimpleTestsButton { get; set; } = false;

        [SeleniumModel(SelectorType.Xpath, "//*[@id='firstname']")]
        public string FirstName { get; set; }

        [SeleniumModel(SelectorType.Xpath, "//*[@id='surname']")]
        public string Surname { get; set; }

        [SeleniumModel(SelectorType.Xpath, "//*[@id='amount']")]
        public decimal? Amount { get; set; } = null;

        [SeleniumModel(SelectorType.Xpath, "//*[@id='amountText']")]
        public string AmountText { get; set; } = null;

        [SeleniumModel(SelectorType.Xpath, "//*[@id='sex']")]
        public string Sex { get; set; } = null;

        [SeleniumModel(SelectorType.Xpath, "//*[@id='email']")]
        public string Email { get; set; } = null;

        public DateTime DateOfBirth { get; set; } 
    }
}

Define your page processor

using Nutstone.Selenium.Core.Custom.Page;
using Nutstone.Selenium.Core.Test.Service;
using Nutstone.Selenium.Core.Webdriver.Extensions;

namespace test_nutstone_selenium.Tests
{
    public class TestPage : CustomSeleniumPage<TestModel>
    {
        public TestPage(IWebDriverProxy webDriverProxy, IWebTestService webTestService) : base(webDriverProxy, webTestService)
        {
        }

        public override IWebTestService Run()
        {
            this
                .WithClick(x => x.SimpleTestsButton)    // click on a page
                .WithUrl("/simplepage")                 // wait or this url to contain  
                .WithInput(x => x.FirstName)            // populate firstname  
                .WithInput(x => x.Surname)
                .WithInput(x => x.Amount)
                .WithSelect(x => x.Sex)
                .WithInput(x => x.Email)
                .Assert();                              // run any assertions
            return this.webTestService;
        }
    }
}

Run your test

using NUnit.Framework;
using Nutstone.Selenium.Core.Configuration;
using Nutstone.Selenium.Core.Loggers.LoggerFile;
using Nutstone.Selenium.Core.Testing;

namespace test_nutstone_selenium.Tests
{
    public class NutstoneCoreTests : SeleniumTestIntergrationFixture
    {
        
        public NutstoneCoreTests()
        {
            this.Initialise((logBuilder) => 
            {
                logBuilder.AddFileLogger(@"The-full-filename-of-the-log-file");  
            }, () => 
            {
                return DriverConfiguration.WithChrome()
                                      .SetDriverPathFromLocation(@"The-Fullpath-of-the-seleniumdriver")
                                      .SetLeaveBrowserRunng(true)
                                      .SetFullscreen(true)
                                      .SetTakeScreenShots(true)
                                      .SetClearScreenShots(true)
                                      .SetScreenShotDirectoryPath(@"Wherever-You-Want-TheScreenShots-directory");
            });
        }

        [Test]
        public void Can_Run_A_Selenium_Test()
        {
            this.RunWebTest(() =>
            {
                var basicModel = new TestModel();

                this.webTestService.OpenUrl("http://localhost:4200")
                    .WithCustomPage(basicModel)
                       .SetValue(x => x.SimpleTestsButton, true)
                       .SetValue(x => x.FirstName, "Tess")
                       .SetValue(x => x.Surname, "nutstone")
                       .SetValue(x => x.Amount, 200.34M)
                       .WithAssertion(x => x.FirstName).IsEqualTo(basicModel.FirstName)
                       .WithAssertion(x => x.AmountText).IsMonetaryEqualTo(200.34M)
                    .Run();
            });
        } 
    
    }
}

Extending your page functionality

Each custom page has access to the underlying WebDriverProxy interface and the underlying IWebdriver interface (via webDriverProxy.Driver).

so you can extend the functionaly o your page relatvely easily. In this case we are going to populate a date of birth element that has 3 html input elements:-

using Nutstone.Selenium.Core.Custom.Page;
using Nutstone.Selenium.Core.Test.Service;
using Nutstone.Selenium.Core.Webdriver.Extensions;
using OpenQA.Selenium;

namespace test_nutstone_selenium.Tests
{
    public class TestPage : CustomSeleniumPage<TestModel>
    {
        public TestPage(IWebDriverProxy webDriverProxy, IWebTestService webTestService) : base(webDriverProxy, webTestService)
        {
        }

        private TestPage WithDate()
        {
            var dobAsStringArray = this.Model.DateOfBirth.ToShortDateString()
                .Split("/");
            this.webDriverProxy
                .WithInput(By.XPath("//*[@id='dob-dd']"), dobAsStringArray[0], true)
                .WithInput(By.XPath("//*[@id='dob-mm']"), dobAsStringArray[1], true)
                .WithInput(By.XPath("//*[@id='dob-yy']"), dobAsStringArray[2], true);
            return this;
        } 

        public override IWebTestService Run()
        {
            this
                .WithClick(x => x.SimpleTestsButton)    // click on a page
                .WithUrl("/simplepage")                 // wait or this url to contain  
                .WithInput(x => x.FirstName)            // populate firstname  
                .WithInput(x => x.Surname)
                .WithInput(x => x.Amount)
                .WithSelect(x => x.Sex);
            this.WithDate();    
            this
                .WithInput(x => x.Email)
                .Assert();                              // run any assertions
            return this.webTestService;
        }
    }
}

Extending your page functionality using an injected service

You can define your own transient service to supply extra functionality to your page(s).

define an interface that implements the pseudo interface ICustomWebProxyDriver

using Nutstone.Selenium.Core.Webdriver.Extensions;
using System;

namespace test_nutstone_selenium.Tests
{
    public interface ITestCustomWebProxyDriver : ICustomWebDriverProxy
    {
        void WithDate(DateTime date);
    }
}

Implement the interface

using Nutstone.Selenium.Core.Loggers.Extended.Logger;
using Nutstone.Selenium.Core.Webdriver.Extensions;
using OpenQA.Selenium;
using System;

namespace test_nutstone_selenium.Tests
{
    public class TestCustomWebProxyDriver : ITestCustomWebProxyDriver
    {
        private readonly IExtendedLogger log;

        private readonly IWebDriverProxy webDriverProxy;


        public TestCustomWebProxyDriver(IExtendedLogger extendedLogger, 
                                        IWebDriverProxy webDriverProxy)
        {
            this.log = extendedLogger;
            this.webDriverProxy = webDriverProxy;
        }

        public void WithDate(DateTime date)
        {
            var dobAsStringArray = date.ToShortDateString()
                .Split("/");
            this.webDriverProxy
                .WithInput(By.XPath("//*[@id='dob-dd']"), dobAsStringArray[0], true)
                .WithInput(By.XPath("//*[@id='dob-mm']"), dobAsStringArray[1], true)
                .WithInput(By.XPath("//*[@id='dob-yy']"), dobAsStringArray[2], true);
        }
    }
}

inject the interface into your page

using Nutstone.Selenium.Core.Custom.Page;
using Nutstone.Selenium.Core.Test.Service;
using Nutstone.Selenium.Core.Webdriver.Extensions;

namespace test_nutstone_selenium.Tests
{
    public class TestPage : CustomSeleniumPage<TestModel>
    {
        private readonly ITestCustomWebProxyDriver testCustomWebProxyDriver;


        public TestPage(ITestCustomWebProxyDriver testCustomWebProxyDriver, IWebDriverProxy webDriverProxy, IWebTestService webTestService) : base(webDriverProxy, webTestService)
        {
            this.testCustomWebProxyDriver = testCustomWebProxyDriver;
        }

        public override IWebTestService Run()
        {
            this
                .WithClick(x => x.SimpleTestsButton)    // click on a page
                .WithUrl("/simplepage")                 // wait or this url to contain  
                .WithInput(x => x.FirstName)            // populate firstname  
                .WithInput(x => x.Surname)
                .WithInput(x => x.Amount)
                .WithSelect(x => x.Sex);
            this.testCustomWebProxyDriver.WithDate(this.Model.DateOfBirth);   
            this
                .WithInput(x => x.Email)
                .Assert();                              // run any assertions
            return this.webTestService;
        }
    }
}

Defining an Application to Chain Pages

To create an application that will chain pages together in a predefinied order first create a custom application model that contains all the properties from the various pages you want to include in the application. The property names and types should EXACTLY match the names/types of the target pages:-

    public class BasicTestSeleniumApplication
    {
        public string FirstName { get; set; }

        public string Surname { get; set; }

        public decimal? Amount { get; set; }

        public string Sex { get; set; }

        public string Email { get; set; }

        public string MatInput { get; set; }

    }

Then create your application.

    public class BasicCustomApplication : CustomSeleniumApplication<BasicTestSeleniumApplication>
    {
        public BasicCustomApplication(IWebTestService webTestService, IExtendedLogger logger)
        : base(webTestService, logger)
        {
        }

        /// <summary>
        /// Register all the pages we are going to use in our application
        /// </summary>
        public override void RegisterPages()
        {
            this
                .RegisterPage(new BasicTestSeleniumModel())
                .RegisterPage(new BasicMaterialSeleniumModel());
        }

        public override IWebTestService Run()
        {
            this.MapByConvention(); // map our model to the pages we have registered

            // Run that application pages in the order we want
            return this.webTestService
                .WithCustomPage<BasicTestSeleniumModel>()
                   .SetValue(x => x.SimpleTestsButton, true)
                .Run() // assertions are run as part of the model run
                .WithCustomPage<BasicMaterialSeleniumModel>()
                   .SetValue(x => x.MaterialTestsButton, true)
                .Run();
        }
    }

You must register the pages you are going to use. call MapByConvetion method of the base class if you want it to automatically map (using reflection) the values in your application model to the associated properties in the page models (that you have registered)

Run the test!

note to run assertions in your application test you must reference the assertion of the page model directly.

        [Test]
        public void Can_RunSimple_Application_With_Assertions()
        {
            this.RunWebTest(() =>
            {
                this.webTestService
                    .OpenUrl(baseUrl)
                    .WithApplication(new BasicTestSeleniumApplication()
                    {
                        Amount = 20012.43M,
                        FirstName = "Tess",
                        Surname = "Nuttall",
                        Sex = "Female",
                        Email = "Tess@somewhere.com",
                        MatInput = "This is a mat input"
                    })
                    .WithPage<BasicTestSeleniumModel>((page) => 
                    {
                        page
                        .WithAssertion(x => x.FirstName).IsEqualTo("Tess");
                    })
                    .Run();
            });
        }

Contact

nutstone.selenium@gmail.com

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Nutstone.Selenium.Core:

Package Downloads
Nutstone.Selenium.Mongo.Provider

Generic mongo selenium page/configuration provider for use with nutstone.selenium.core

Nutstone.Selenium.Core.Testing

Provides selenium testfixture and test runner for nutstone.selenium

Nutstone.Selenium.Mongo.Custom.Provider

Selenium data provider using mongo

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.2 207 4/24/2023
1.1.1 239 3/19/2023
1.0.130 540 7/22/2022
1.0.129 405 7/22/2022
1.0.128 422 7/19/2022
1.0.127 417 7/19/2022
1.0.126 440 7/19/2022
1.0.125 437 7/18/2022
1.0.124 409 7/18/2022
1.0.123 448 7/11/2022
1.0.122 420 7/11/2022
1.0.121 429 7/11/2022
1.0.120 426 7/11/2022
1.0.119 433 7/11/2022
1.0.118 429 7/11/2022
1.0.117 618 6/29/2022
1.0.116 420 6/27/2022
1.0.115 799 6/8/2022
1.0.114 412 6/8/2022
1.0.113 412 6/8/2022
1.0.112 433 6/8/2022
1.0.111 432 6/8/2022
1.0.110 415 6/8/2022
1.0.109 450 6/7/2022
1.0.108 562 6/7/2022
1.0.107 670 6/7/2022
1.0.106 451 6/7/2022
1.0.105 482 6/7/2022
1.0.104 495 6/7/2022
1.0.103 425 6/5/2022
1.0.102 791 5/30/2022
1.0.101 2,955 5/6/2022
1.0.100 433 5/5/2022
1.0.99 468 5/5/2022
1.0.98 437 5/5/2022
1.0.97 428 5/5/2022
1.0.96 721 5/5/2022
1.0.95 1,173 4/25/2022
1.0.94 479 4/9/2022
1.0.93 464 4/8/2022
1.0.92 451 4/8/2022
1.0.91 454 4/5/2022
1.0.90 1,097 3/29/2022
1.0.89 976 3/23/2022
1.0.88 449 3/23/2022
1.0.87 454 3/18/2022
1.0.86 475 3/16/2022
1.0.85 1,146 3/14/2022
1.0.84 470 3/9/2022
1.0.83 451 3/9/2022
1.0.82 450 3/8/2022
1.0.81 448 3/7/2022
1.0.80 440 3/6/2022
1.0.79 453 3/4/2022
1.0.78 432 3/4/2022
1.0.77 449 3/4/2022
1.0.76 451 3/3/2022
1.0.75 458 3/2/2022
1.0.74 442 3/2/2022
1.0.73 457 2/23/2022
1.0.72 439 2/22/2022
1.0.71 461 2/21/2022
1.0.70 461 2/21/2022
1.0.69 472 2/20/2022
1.0.68 441 2/18/2022
1.0.67 480 2/18/2022
1.0.66 446 2/18/2022
1.0.65 457 2/18/2022
1.0.64 439 2/18/2022
1.0.63 426 2/18/2022
1.0.62 1,379 2/6/2022
1.0.61 469 2/5/2022
1.0.60 467 2/5/2022
1.0.59 477 2/5/2022
1.0.58 454 1/31/2022
1.0.57 452 1/31/2022
1.0.56 458 1/29/2022
1.0.55 468 1/26/2022
1.0.54 468 1/26/2022
1.0.53 448 1/26/2022
1.0.52 469 1/26/2022
1.0.51 448 1/26/2022
1.0.50 464 1/26/2022
1.0.49 483 1/25/2022
1.0.48 495 1/25/2022
1.0.47 476 1/25/2022
1.0.46 470 1/25/2022
1.0.45 1,443 1/24/2022
1.0.44 441 1/24/2022
1.0.43 455 1/24/2022
1.0.42 1,012 1/21/2022
1.0.41 472 1/21/2022
1.0.40 460 1/21/2022
1.0.39 440 1/21/2022
1.0.38 448 1/21/2022
1.0.37 466 1/19/2022
1.0.36 476 1/19/2022
1.0.35 480 1/19/2022
1.0.34 439 1/19/2022
1.0.33 457 1/19/2022
1.0.32 1,006 1/18/2022
1.0.31 981 1/18/2022
1.0.30 970 1/17/2022
1.0.29 451 1/15/2022
1.0.28 1,371 1/9/2022
1.0.27 274 12/29/2021
1.0.26 298 12/29/2021
1.0.25 325 12/29/2021
1.0.24 307 12/28/2021
1.0.23 285 12/22/2021
1.0.22 306 12/22/2021
1.0.21 647 12/22/2021
1.0.20 646 12/21/2021
1.0.19 683 12/20/2021
1.0.18 327 12/2/2021
1.0.17 343 12/2/2021
1.0.16 316 12/2/2021
1.0.15 310 12/2/2021
1.0.14 1,016 12/1/2021
1.0.13 289 11/28/2021
1.0.12 1,577 11/26/2021
1.0.11 303 11/22/2021
1.0.10 403 11/18/2021
1.0.9 435 11/18/2021
1.0.8 386 11/14/2021
1.0.7 356 11/13/2021