Footers are now customizable (#151)

* Footers are now customizable * Adding condition for default footer * Adding test for footer * Adding test for footer * Push verison increase --------- Co-authored-by: adamdavies1 <[email protected]>
communitiesuk · Apr 19, 2023 · 4698f28 · 4698f28
1 parent edefd56
commit 4698f28
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 18 deletions.
diff --git a/.github/workflows/dluhc-build-and-publish.yml b/.github/workflows/dluhc-build-and-publish.yml
@@ -13,7 +13,7 @@ on:
       ]
 
 env:
-  VERSION: "0.1.53" # Manually increment this version when pushing to main
+  VERSION: "0.1.54" # Manually increment this version when pushing to main
   IMAGE_NAME_STUB: "digital-form-builder-dluhc-"
   DOCKER_REGISTRY: ghcr.io
   IMAGE_REPO_PATH: "ghcr.io/${{github.repository_owner}}"

diff --git a/model/src/data-model/types.ts b/model/src/data-model/types.ts
@@ -143,6 +143,11 @@ export type Fee = {
   prefix?: string;
 };
 
+export type Footer = {
+  href: string;
+  text: string;
+};
+
 /**
  * `FormDefinition` is a typescript representation of `Schema`
  */
@@ -164,4 +169,5 @@ export type FormDefinition = {
   specialPages?: SpecialPages;
   paymentReferenceFormat?: string;
   backLinkText?: string;
+  footer?: Footer;
 };
diff --git a/model/src/schema/schema.ts b/model/src/schema/schema.ts
@@ -230,6 +230,11 @@ const phaseBannerSchema = joi.object().keys({
   phase: joi.string().valid("alpha", "beta"),
 });
 
+const footerSchema = joi.object().keys({
+  href: joi.string(),
+  text: joi.string(),
+});
+
 export const Schema = joi
   .object()
   .required()
@@ -252,6 +257,7 @@ export const Schema = joi
     phaseBanner: phaseBannerSchema,
     specialPages: specialPagesSchema.optional(),
     backLinkText: joi.string().allow("").optional(),
+    footer: joi.array().items(footerSchema).optional(),
   });
 
 /**

diff --git a/runner/src/server/forms/report-a-terrorist.json b/runner/src/server/forms/report-a-terrorist.json
@@ -285,5 +285,23 @@
         ]
       }
     }
+  ],
+  "footer": [
+    {
+      "href": "https://www.gov.uk/government/publications/community-ownership-fund-privacy-notice/community-ownership-fund-privacy-notice",
+      "text": "Privacy test"
+    },
+    {
+      "href": "https://www.google.com",
+      "text": "Cookies test"
+    },
+    {
+      "href": "https://www.gov.uk/government/publications/community-ownership-fund-privacy-notice/community-ownership-fund-privacy-notice",
+      "text": "Accessibility Statement test"
+    },
+    {
+      "href": "https://www.gov.uk/government/publications/community-ownership-fund-privacy-notice/community-ownership-fund-privacy-notice",
+      "text": "Contact Us test"
+    }
   ]
 }
diff --git a/runner/src/server/views/layout.html b/runner/src/server/views/layout.html
@@ -169,21 +169,32 @@ <h1 class="govuk-heading-l">Default page template</h1>
 
 
 {% block footer %}
-    {{ govukFooter({
-        meta: {
-            items: [{
-                href: 'https://www.gov.uk/government/publications/community-ownership-fund-privacy-notice/community-ownership-fund-privacy-notice',
-                text: 'Privacy'
-            }, {
-                href: cookiePolicyUrl,
-                text: 'Cookies'
-            }, {
-                href: accessibilityStatementUrl,
-                text: 'Accessibility Statement'
-            }, {
-                href: contactUsUrl,
-                text: 'Contact Us'
-            }]
-        }
-    }) }}
+  {% set footerItems = [] %}
+  {% if page.def.footer %}
+    {% for footerItem in page.def.footer %}
+      {% set _ = footerItems.push({
+        href: footerItem.href,
+        text: footerItem.text
+      }) %}
+    {% endfor %}  
+  {% else %}
+  {% set footerItems = [{
+        href: 'https://www.gov.uk/government/publications/community-ownership-fund-privacy-notice/community-ownership-fund-privacy-notice',
+        text: 'Privacy'
+    }, {
+        href: cookiePolicyUrl,
+        text: 'Cookies'
+    }, {
+        href: accessibilityStatementUrl,
+        text: 'Accessibility Statement'
+    }, {
+        href: contactUsUrl,
+        text: 'Contact Us'
+    }]%}
+  {% endif %}
+  {{ govukFooter({
+    meta: {
+      items: footerItems
+    }
+  }) }}
 {% endblock %}
diff --git a/smoke-tests/designer/features/completeAForm.feature b/smoke-tests/designer/features/completeAForm.feature
@@ -27,6 +27,10 @@ Feature: Complete a form
     Given I am at the start of the "runner components test" form
     When I complete the form
     Then the Summary page is displayed with my answers
+
+  Scenario: The footer and links are visible on start page
+    Given I am at the start of the "report a terrorist" form
+    Then I can see the footer at the bottom of the page
 
  Scenario: Back link is displayed
     Given I am at the start of the "report a terrorist" form

diff --git a/smoke-tests/designer/features/pageobjects/pages/formRunner.page.js b/smoke-tests/designer/features/pageobjects/pages/formRunner.page.js
@@ -13,6 +13,10 @@ class FormRunnerPage extends Page {
     return browser.$("h1");
   }
 
+  get govFooter() {
+    return browser.$("footer");
+  }
+
   /**
    * Locates the index of a checkbox by label name
    * @param labelText

diff --git a/smoke-tests/designer/features/steps/completeAForm.steps.js b/smoke-tests/designer/features/steps/completeAForm.steps.js
@@ -82,3 +82,11 @@ Then(/^the Summary page is displayed with my answers$/, function () {
     "[email protected]"
   );
 });
+
+Then("I can see the footer at the bottom of the page", function () {
+  let footer = formRunner.govFooter;
+  expect(footer).toHaveTextContaining("Privacy test");
+  expect(footer).toHaveTextContaining("Cookies test");
+  expect(footer).toHaveTextContaining("Accessibility Statement test");
+  expect(footer).toHaveTextContaining("Contact Us test");
+});