added page models and sub-components

Author: CathLass

DfE.Data.SearchPrototype.Test/HomePageTests.cs

@@ -1,5 +1,6 @@
 using AngleSharp.Dom;
 using AngleSharp.Html.Dom;
+using DfE.Data.SearchPrototype.Test.PageModels;
 using DfE.Data.SearchPrototype.Test.Shared;
 using Microsoft.AspNetCore.Mvc.Testing;
 
@@ -15,18 +16,17 @@ public HomePageTests(WebApplicationFactory<Program> factory) : base(factory)
     public async Task HomePage_ContainsExpectedTitle()
     {
         // act
-        var response = await NavigateToPage("");
+        var response = await NavigateToPageAsync("");
 
         // assert
-        var headings = response.Heading();
-        Assert.Equal("Welcome", headings.InnerHtml);
+        Assert.Equal("Welcome", response.Heading().InnerHtml);
     }
 
     [Fact]
-    public async Task HomePage_ContainsPrivacyLink()
+    public async Task HomePage_HeaderContainsPrivacyLink()
     {
         // act
-        IDocument response = await NavigateToPage("");
+        IDocument response = await NavigateToPageAsync("");
 
         // Assert
         IHtmlAnchorElement privacyLink = 

DfE.Data.SearchPrototype.Test/HomePageTestsUsingPageModel.cs

@@ -0,0 +1,37 @@
+using DfE.Data.SearchPrototype.Test.PageModels;
+using DfE.Data.SearchPrototype.Test.Shared;
+using Microsoft.AspNetCore.Mvc.Testing;
+
+namespace DfE.Data.SearchPrototype.Test;
+
+/// <summary>
+/// test class using the new page model way for traversing the DOM
+/// </summary>
+public class HomePageTestsUsingPageModel : PageTestHelper
+{
+    public HomePageTestsUsingPageModel(WebApplicationFactory<Program> factory) : base(factory)
+    {
+    }
+
+    [Fact]
+    public async Task HomePage_ContainsExpectedTitle()
+    {
+        // act
+        var homePage = new HomePage(await NavigateToPageAsync(HomePage.Url));
+
+        // assert
+        Assert.Equal("Welcome", homePage.Title);
+    }
+
+    [Fact]
+    public async Task HomePage_ContainsLinkToPrivacyPage()
+    {
+        // act
+        var homePage = new HomePage(await NavigateToPageAsync(HomePage.Url));
+
+        var privacyPageLink = homePage.Header.PrivacyLink.Href;
+
+        // assert
+        Assert.Equal(PrivacyPage.Url, homePage.Header.PrivacyLink.Href);
+    }
+}

DfE.Data.SearchPrototype.Test/PageModels/HomePage.cs

@@ -0,0 +1,12 @@
+using AngleSharp.Dom;
+
+namespace DfE.Data.SearchPrototype.Test.PageModels;
+
+public class HomePage : Page
+{
+    public static string Url = "/";
+
+    public HomePage(IDocument pageResponse) : base(pageResponse)
+    {
+    }
+}

DfE.Data.SearchPrototype.Test/PageModels/HtmlElement.cs

@@ -0,0 +1,17 @@
+using AngleSharp.Dom;
+
+namespace DfE.Data.SearchPrototype.Test.PageModels;
+
+public class HtmlElement
+{
+    protected IElement _element;
+
+    public HtmlElement(IElement element)
+    {
+        _element = element;
+    }
+
+    public string? Id { get => _element.Id; }
+    public string? Class { get => _element.ClassName; }
+    public string InnerHtml { get => _element.InnerHtml; }
+}

DfE.Data.SearchPrototype.Test/PageModels/Link.cs

@@ -0,0 +1,13 @@
+using AngleSharp.Dom;
+
+namespace DfE.Data.SearchPrototype.Test.PageModels;
+
+public class Link : HtmlElement
+{
+    public Link(IElement element) : base(element)
+    {
+    }
+
+    public string? Href { get => _element.GetAttribute("href"); }
+    public string? TextContent { get => _element.TextContent; }
+}

DfE.Data.SearchPrototype.Test/PageModels/Page.cs

@@ -0,0 +1,21 @@
+using AngleSharp.Dom;
+
+namespace DfE.Data.SearchPrototype.Test.PageModels;
+
+public abstract class Page
+{
+    protected IDocument _DOM;
+
+    protected Page(IDocument pageResponse)
+    {
+        _DOM = pageResponse;
+    }
+
+    public string Title {
+        get => _DOM.GetElementsByTagName("h1").Single().InnerHtml;
+    }
+
+    public PageHeader Header {
+        get => new PageHeader(_DOM.GetElementsByTagName("header").Single());
+    }
+}

DfE.Data.SearchPrototype.Test/PageModels/PageHeader.cs

@@ -0,0 +1,14 @@
+using AngleSharp.Dom;
+
+namespace DfE.Data.SearchPrototype.Test.PageModels;
+
+public class PageHeader : HtmlElement
+{
+    public PageHeader(IElement element) : base(element)
+    {
+    }
+
+    public IEnumerable<Link> Links { get => _element.GetElementsByTagName("a").Select(x => new Link(x)); }
+
+    public Link PrivacyLink => Links.Single(link => link.TextContent == "Privacy");
+}

DfE.Data.SearchPrototype.Test/PageModels/PrivacyPage.cs

@@ -0,0 +1,12 @@
+using AngleSharp.Dom;
+
+namespace DfE.Data.SearchPrototype.Test.PageModels;
+
+public class PrivacyPage : Page
+{
+    public static string Url = "/Home/Privacy";
+
+    public PrivacyPage(IDocument pageResponse) : base(pageResponse)
+    {
+    }
+}

DfE.Data.SearchPrototype.Test/Shared/PageTestHelper.cs

@@ -16,7 +16,7 @@ public PageTestHelper(WebApplicationFactory<Program> factory) : base(factory)
         //--------------------------------------------------------------------
     }
 
-    protected async Task<IDocument> NavigateToPage(string webPage)
+    protected async Task<IDocument> NavigateToPageAsync(string webPage)
     {
         HttpResponseMessage response = await _httpClient.GetAsync(webPage);
 

SpecFlow.Specs/Features/HomePageTests.feature

@@ -4,5 +4,10 @@ Just some basic checks that the expected things appear on the page
 
 @tag1
 Scenario: Home page renders as expected
-	When I navigate to "/"
+	When I navigate to the home page
 	Then The page heading is "Welcome"
+
+#Scenario: Home page has link to Privacy page
+#	Given I am on the home page
+#	When I click on the Privacy link in the header
+#	Then I am taken to the privacy page

SpecFlow.Specs/Features/HomePageTests.feature.cs

@@ -0,0 +1,34 @@
+using AngleSharp.Dom;
+using DfE.Data.SearchPrototype.Test.Shared;
+using Microsoft.AspNetCore.Mvc.Testing;
+
+namespace SpecFlow.Specs.StepDefinitions;
+
+[Binding]
+public class PageStepDefinitions : PageTestHelper
+{
+    private IDocument _response { get; set; } = null!;
+
+    private Dictionary<string, string> _pageNameToUrlConverter = new Dictionary<string, string>()
+    {
+        { "home", "/" },
+        { "privacy", "/Home/Privacy" }
+    };
+
+    public PageStepDefinitions(WebApplicationFactory<Program> factory) : base(factory)
+    {
+    }
+
+    [StepDefinition(@"I (navigate to| am on) the (home| privacy) page")]
+    public async Task NavigateToThePage(string action, string pageName)
+    {
+        _response = await NavigateToPageAsync(_pageNameToUrlConverter[pageName]);
+    }
+
+    [Then(@"The page heading is ""(.*)""")]
+    public void PageHeadingIsExpected(string headingText)
+    {
+        // assert
+        Assert.Equal(headingText, _response.Heading().InnerHtml);
+    }
+}