@dwp/govuk-casa 7.0.8 → 8.0.0-beta2

package/test/utils/BaseTestWaypoint.js

@@ -1,106 +0,0 @@
-const { URL } = require('url');
-
-class BaseTestWaypoint {
-  constructor({ mountUrl = '/', waypointId, dom }) {
-    this.mountUrl = mountUrl;
-    this.waypointId = waypointId; // must include origin, if applicable
-    this.dom = dom;
-  }
-
-  findField(field) {
-    // Convert field to a canonical format - lowerCamelCase
-    const fieldKey = field
-      .replace(/ ([a-z])/ig, (_, m) => (m.toUpperCase()))
-      .replace(/^[A-Z]/, (m) => (m.toLowerCase()));
-
-    // Lookup field selector and use that to find the field in the DOM. Where
-    // there is no selector (null / undefined), we try to lookup the field by
-    // "name".
-    // Where the selector ends with `:eq()`, we can use that to pick 1 element
-    // from multiple matching elements
-    const fieldSelectors = this.constructor.fieldSelectors();
-    const fieldSelector = (fieldSelectors[fieldKey] || `[name="${fieldKey}"]`);
-
-    const eqRegex = /:eq\(([0-9]+)\)$/;
-    const eqMatch = fieldSelector.match(eqRegex);
-    const eqIndex = eqMatch ? eqMatch[1] : null;
-
-    let $field = this.dom(fieldSelector.replace(eqRegex, ''));
-    if (!$field.length) {
-      throw new ReferenceError(`Cannot find field with reference "${fieldKey}" on waypoint "${this.waypointId}". Do you need to define a custom class for this waypoint?`)
-    }
-
-    // For results that contain more than one element, check if there's a custom
-    // `:eq(...)` selector in place
-    if ($field.length > 1) {
-      if (eqIndex === null) {
-        throw new ReferenceError(`Found more than one element (${$field.length}) matching selector "${fieldSelectors[fieldKey]}". You could try using the custom :eq() selector to pinpoint a specific element.`);
-      }
-      $field = $field.eq(eqIndex);
-    } else {
-      $field = $field.eq(0);
-    }
-
-    return $field;
-  }
-
-  static clickField($field) {
-    switch ($field.get(0).tagName) {
-    case 'input':
-      $field.attr('checked', !$field.attr('checked') === true);
-      break;
-    case 'a':
-      return $field.attr('href'); // TODO: need to make absolute somehow!
-    case 'option':
-      $field.attr('selected', !$field.attr('selected') === true);
-      break;
-    default:
-    }
-    return undefined;
-  }
-
-  /* ------------- the following should be implemented by the extending class */
-
-  static fieldSelectors() {
-    return Object.create(null);
-  }
-
-  // After interacting with a page, it _may_ result in the user being transferred
-  // away from the current page. In this case, the `nextUrl` result will contain
-  // that destination, otherwise it will remain undefined.
-  interact({ httpResponse, inputs = {} }) {
-    let nextUrl;
-
-    Object.keys(inputs || {}).forEach((field) => {
-      const value = inputs[field];
-      const $field = this.findField(field);
-      switch (value) {
-      case 'click()': nextUrl = this.constructor.clickField($field); break;
-      case 'select()': $field.attr('checked', true); break;
-      case 'deselect()': $field.attr('checked', false); break;
-      default:
-        $field.val(value);
-      }
-    });
-
-    // Convert URL to an absolute
-    if (nextUrl) {
-      const absUrl = new URL(nextUrl || '', httpResponse.request.url);
-      nextUrl = absUrl.href.replace(absUrl.origin, '');
-    }
-
-    return {
-      nextUrl,
-    };
-  }
-
-  /* eslint-disable-next-line no-unused-vars */
-  async progress({ httpResponse, httpAgent }) {
-    const formData = this.dom('.casa-journey-form').serialize();
-    return httpAgent.post(`${this.mountUrl}${this.waypointId}`).send(formData).then((response) => ({
-      nextUrl: (response.headers.location || `${this.mountUrl}${this.waypointId}`),
-    }));
-  }
-}
-
-module.exports = BaseTestWaypoint;

package/test/utils/concatWaypoints.js

@@ -1,26 +0,0 @@
-// Concatenate waypoint objects, making sure that duplicate keys are indexed
-// with an incrementing integer
-
-function getIndex(waypointId) {
-  const m = waypointId.match(/:([0-9]+)$/);
-  return m && m[1] ? parseInt(m[1]) : 0;
-}
-
-function bumpIndex(waypointId) {
-  const index = getIndex(waypointId);
-  return waypointId.replace(/:.*$/, '') + `:${index + 1}`;
-}
-
-module.exports = function concactWaypoints(...sources) {
-  return sources.reduce((obj, source) => {
-    Object.keys(source).forEach((key) => {
-      const value = source[key];
-      while(obj.hasOwnProperty(key)) {
-        key = bumpIndex(key);
-      }
-      obj[key] = value;
-    });
-
-    return obj;
-  }, {});
-};

package/test/utils/index.js

@@ -1,6 +0,0 @@
-/* eslint-disable global-require */
-module.exports = {
-  BaseTestWaypoint: require('./BaseTestWaypoint.js'),
-  testTraversal: require('./testTraversal.js'),
-  concatWaypoints: require('./concatWaypoints.js'),
-};

package/test/utils/testTraversal.js

@@ -1,90 +0,0 @@
-// IMPORTANT RATIONLE: we're using the DOM and full express application middleware
-// because each project's app may be doing stuff with session data at any point,
-// or using hooks, etc that manipulate data in very customised ways. So using
-// the entire app stack gives us an accurate representation of how the app runs
-// in the real world. We use to DOM as the primary interface to entering data,
-// because this will again pick up any custom rendering logic that may mean we
-// miss fields, or find fields where there shouldn't be any. It's a UI
-// integration test suite that sits in the middle of the testing triangle/trophy.
-
-const { strictEqual } = require('assert');
-const { URL } = require('url');
-const supertest = require('supertest');
-const cheerio = require('cheerio');
-const BaseTestWaypoint = require('./BaseTestWaypoint.js');
-
-function defaultWaypointFactory(args) {
-  return new BaseTestWaypoint(args);
-}
-
-async function followUrlRedirects({ httpAgent, url }) {
-  const response = await httpAgent.get(url);
-  if (Object.prototype.hasOwnProperty.call(response.headers, 'location')) {
-    return followUrlRedirects({ httpAgent, url: response.headers.location });
-  }
-  return url;
-}
-
-function stripIndex(waypointId) {
-  return waypointId.replace(/:[0-9]+$/, '');
-}
-
-module.exports = async function testTraversal({
-  app, mountUrl = '/', waypoints, waypointHandlerFactory = defaultWaypointFactory, agent = null, searchParams = ''
-}) {
-  // Create an agent instance so we can share cookies across all requests
-  // TODO: See https://github.com/facebook/jest/issues/6907#issuecomment-416909039 for
-  // possible solution to clashing ephemeral ports.
-  const httpAgent = agent || supertest.agent(app);
-
-  // Get next waypoint in the expected sequence.
-  // Revisited waypoints include a `:<index>` suffix in the ID, which needs to
-  // be stripped.
-  const wpoints = Object.assign(Object.create(null), waypoints);
-  let waypointId = Object.keys(wpoints).shift();
-  const waypointData = wpoints[waypointId];
-  delete wpoints[waypointId];
-  waypointId = stripIndex(waypointId);
-
-  // Issue the initial GET request
-  const httpResponse = await httpAgent.get(`${mountUrl}${waypointId}`).query(searchParams.toString()).expect(200);
-
-  // Complete the form (if present) and progress to next waypoint.
-  // Each waypoint ID must have a corresponding "waypoint handler", provided by
-  // the `waypointHandlerFactory`. See `defaultWaypointFactory()` for an
-  // example of how this works.
-  // This handler's `progress()` method must return a result that includes the
-  // next URL to be navigated to (this must be an absolute URL)
-  const dom = cheerio.load(httpResponse.text);
-  const waypointHandler = waypointHandlerFactory({ mountUrl, waypointId, dom })
-    || defaultWaypointFactory({ mountUrl, waypointId, dom });
-  let result;
-  result = waypointHandler.interact({ httpResponse, inputs: waypointData });
-  if (result.nextUrl === undefined) {
-    result = await waypointHandler.progress({ httpResponse, httpAgent });
-  }
-
-  // GET next URL including all redirects, if applicable, and extract the
-  // actual waypoint from that response.
-  let nextWaypoint = (await followUrlRedirects({ httpAgent, url: result.nextUrl }));
-  const nextUrl = new URL(nextWaypoint, 'http://placeholder.test');
-  nextWaypoint = nextUrl.pathname.replace(mountUrl, '').replace(/^\/+/, '');
-
-  // Check we have reached the expected next waypoint in the sequence
-  strictEqual(nextWaypoint, stripIndex(Object.keys(wpoints)[0]));
-
-  // If there's more waypoints to traverse to, continue on our merry way,
-  // otherwise stop here.
-  if (Object.keys(wpoints).length < 2) {
-    return true;
-  }
-
-  return testTraversal({
-    agent: httpAgent,
-    app,
-    mountUrl,
-    waypoints: wpoints,
-    waypointHandlerFactory,
-    searchParams: nextUrl.searchParams,
-  });
-};

package/views/casa/partials/cookie_message.njk

@@ -1,3 +0,0 @@
-<p>
-  <!-- Override this template to set your own cookie message -->
-</p>

package/views/casa/partials/phase_banner_alpha.njk

@@ -1,8 +0,0 @@
-{% from "govuk/components/phase-banner/macro.njk" import govukPhaseBanner %}
-
-{{ govukPhaseBanner({
-  tag: {
-    text: "alpha"
-  },
-  html: 'This is a new service – your <a class="govuk-link" href="' + casa.mountUrl + 'feedback">feedback</a> will help us to improve it.'
-}) }}

package/views/casa/partials/phase_banner_beta.njk

@@ -1,8 +0,0 @@
-{% from "govuk/components/phase-banner/macro.njk" import govukPhaseBanner %}
-
-{{ govukPhaseBanner({
-  tag: {
-    text: "beta"
-  },
-  html: 'This is a new service – your <a class="govuk-link" href="' + casa.mountUrl + 'feedback">feedback</a> will help us to improve it.'
-}) }}

package/views/casa/review/page-block.njk

@@ -1,8 +0,0 @@
-{% if reviewErrors[waypointId] %}
-  <span class="govuk-caption-m casa-review-page-error">{{ t('review:block.containsErrors') }}</span>
-{% endif %}
-<h2 class="govuk-heading-m">
-  {% block pageBlockTitle %}{% endblock %}
-</h2>
-
-{% block reviewBlock %}{% endblock %}

package/views/casa/review/review.njk

@@ -1,47 +0,0 @@
-{% extends "casa/layouts/main.njk" %}
-
-{% from "govuk/components/button/macro.njk" import govukButton %}
-{% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
-{% from "casa/components/journey-form/macro.njk" import casaJourneyForm with context %}
-
-{% block casaPageTitle %}
-  {{ t('review:pageTitle') }}
-{% endblock %}
-
-{% block content %}
-  <div class="govuk-grid-row">
-    <div class="govuk-grid-column-two-thirds-from-desktop">
-      {% if formErrorsGovukArray %}
-        {{ govukErrorSummary({
-          titleText: t("error:summary.h1"),
-          descriptionText: errorDescription or t('error:summary.defaultDescription'),
-          errorList: formErrorsGovukArray
-        }) }}
-      {% endif %}
-
-      {% call casaJourneyForm({
-        csrfToken: casa.csrfToken,
-        activeContextId: activeContextId,
-        buttonBarHidden: true
-      }) %}
-        <input type="hidden" name="reviewed" value="true" />
-
-        <h1 class="govuk-heading-xl">{{ t('review:h1') }}</h1>
-
-        <!-- Include blocks for all pages in the user's journey -->
-        {% for block in reviewBlocks %}
-          {% set waypointId = block.waypointId %}
-          {% set waypointEditUrl = block.waypointEditUrl %}
-          {% include block.reviewBlockView ignore missing %}
-        {% endfor %}
-
-        <p class="govuk-body">
-          {{ govukButton({
-            text: t('common:form.buttons.next.label'),
-            type: 'submit'
-          }) }}
-        </p>
-      {% endcall %}
-    </div>
-  </div>
-{% endblock %}