{{ 'abc' | foo__strong }}
-{% endblock %}
-`
-const filtersAddition = `
-const govukPrototypeKit = require('govuk-prototype-kit')
-const addFilter = govukPrototypeKit.views.addFilter
-addFilter('foo__strong', (content) => '' + content + '', { renderAsHtml: true })
-`
-describe('Filters Test', () => {
- beforeEach(() => {
- // Restore filters file from prototype starter
- cy.task('createFile', { filename: appFiltersPath, data: filtersAddition })
- cy.task('createFile', { filename: appFiltersViewPath, data: filtersViewMarkup })
- })
-
- afterEach(restoreStarterFiles)
-
- it('view the filters html file', () => {
- waitForApplication('/filters')
- cy.get('#test-foo-strong-filter')
- .should('have.html', 'abc')
- })
-})
diff --git a/cypress/e2e/dev/1-watch-files/watch-functions.cypress.js b/cypress/e2e/dev/1-watch-files/watch-functions.cypress.js
deleted file mode 100644
index 4600651022..0000000000
--- a/cypress/e2e/dev/1-watch-files/watch-functions.cypress.js
+++ /dev/null
@@ -1,32 +0,0 @@
-const path = require('path')
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const appFunctionsPath = path.join(Cypress.env('projectFolder'), 'app', 'functions.js')
-const appFiltersViewPath = path.join(Cypress.env('projectFolder'), 'app', 'views', 'functions.html')
-
-const functionsViewMarkup = `
-{% extends "layouts/main.html" %}
-{% block content %}
-{{ fooEmphasize('def') }}
-{% endblock %}
-`
-const functionsAddition = `
-const govukPrototypeKit = require('govuk-prototype-kit')
-const addFunction = govukPrototypeKit.views.addFunction
-addFunction('fooEmphasize', (content) => '' + content + '', { renderAsHtml: true })
-`
-describe('Functions Test', () => {
- beforeEach(() => {
- // Restore functions file from prototype starter
- cy.task('createFile', { filename: appFunctionsPath, data: functionsAddition })
- cy.task('createFile', { filename: appFiltersViewPath, data: functionsViewMarkup })
- })
-
- afterEach(restoreStarterFiles)
-
- it('view the functions html file', () => {
- waitForApplication('/functions')
- cy.get('#test-foo-emphasize-function')
- .should('have.html', 'def')
- })
-})
diff --git a/cypress/e2e/dev/1-watch-files/watch-images.cypress.js b/cypress/e2e/dev/1-watch-files/watch-images.cypress.js
deleted file mode 100644
index 1a5ea07ecf..0000000000
--- a/cypress/e2e/dev/1-watch-files/watch-images.cypress.js
+++ /dev/null
@@ -1,64 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const imageFile = 'larry-the-cat.jpg'
-const cypressImages = path.join(Cypress.config('fixturesFolder'), 'images')
-const appImages = path.join(Cypress.env('projectFolder'), 'app', 'assets', 'images')
-const publicImages = 'public/images'
-
-const pageFixture = 'larry-the-cat'
-const pageFixtureName = `${pageFixture}.html`
-const pageFixturePath = path.join(Cypress.config('fixturesFolder'), 'views', pageFixtureName)
-const pageAppPath = path.join(Cypress.env('projectFolder'), 'app', 'views', pageFixtureName)
-
-describe('watch image files', () => {
- afterEach(restoreStarterFiles)
-
- it(`image created in ${appImages} should be copied to ${publicImages} and accessible from the browser`, () => {
- const source = path.join(cypressImages, imageFile)
- const target = path.join(appImages, imageFile)
- const publicImage = `${publicImages}/${imageFile}`
-
- cy.task('log', 'Creating a page to view our image')
- cy.task('copyFile', { source: pageFixturePath, target: pageAppPath })
-
- cy.task('log', 'Our page should be missing its image')
-
- waitForApplication()
- cy.visit(`/${pageFixture}`)
- cy.get('img#larry')
- .should('be.visible')
- .and(($img) => {
- // "naturalWidth" and "naturalHeight" are set when the image loads
- expect($img[0].naturalWidth).to.equal(0)
- })
-
- cy.task('log', 'Copying the image to the app folder')
- cy.task('copyFile', { source, target })
-
- cy.task('log', 'Wait for the image to be loaded')
- cy.waitForResource(imageFile)
-
- // FIXME: the expected behaviour is that the page should update itself,
- // however there is a bug in our setup where on Windows the image doesn't
- // show up without a page reload. When this is fixed, remove this step.
- // See issue #1440 for other details.
- cy.task('log', 'Reload the page')
- cy.reload()
-
- cy.task('log', 'Our page should now have its image')
- cy.get('img#larry')
- .should('be.visible')
- .and(($img) => {
- // "naturalWidth" and "naturalHeight" are set when the image loads
- expect($img[0].naturalWidth).not.to.equal(0)
- })
-
- cy.task('log', `Requesting ${publicImage}`)
- cy.request(`/${publicImage}`, { retryOnStatusCodeFailure: true })
- .then(response => expect(response.status).to.eq(200))
- })
-})
diff --git a/cypress/e2e/dev/1-watch-files/watch-javascripts.cypress.js b/cypress/e2e/dev/1-watch-files/watch-javascripts.cypress.js
deleted file mode 100644
index 716cd67efe..0000000000
--- a/cypress/e2e/dev/1-watch-files/watch-javascripts.cypress.js
+++ /dev/null
@@ -1,37 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const appJsPath = path.join('app', 'assets', 'javascripts', 'application.js')
-const appJs = path.join(Cypress.env('projectFolder'), appJsPath)
-
-const heading = 'Test Heading'
-
-const scriptToAdd = `
- document.querySelector("h1").innerHTML = "${heading}"
-`
-
-describe('watch application.js', () => {
- afterEach(restoreStarterFiles)
-
- it('changes to application.js should be reflected in browser', () => {
- waitForApplication()
-
- cy.get('h1').should('not.contain.text', heading)
-
- const markerText = '// Add JavaScript here'
-
- cy.task('replaceTextInFile', {
- filename: appJs,
- originalText: markerText,
- newText: markerText + scriptToAdd
- })
-
- cy.get('h1').contains(heading)
-
- // Restore application.js from prototype starter
- cy.task('copyFromStarterFiles', { filename: appJsPath })
- })
-})
diff --git a/cypress/e2e/dev/1-watch-files/watch-routes.cypress.js b/cypress/e2e/dev/1-watch-files/watch-routes.cypress.js
deleted file mode 100644
index 7edc68d18f..0000000000
--- a/cypress/e2e/dev/1-watch-files/watch-routes.cypress.js
+++ /dev/null
@@ -1,44 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const appRoutesPath = path.join('app', 'routes.js')
-
-const routesFixture = path.join(Cypress.config('fixturesFolder'), 'routes.js')
-const appRoutes = path.join(Cypress.env('projectFolder'), appRoutesPath)
-const pagePath = '/cypress-test'
-
-describe('watch route file', () => {
- afterEach(restoreStarterFiles)
-
- it(`add and remove ${pagePath} route`, () => {
- waitForApplication()
-
- cy.task('log', 'The cypress test page should not be found')
- cy.visit(pagePath, { failOnStatusCode: false })
- cy.get('body')
- .contains(`There is no page at ${pagePath}`)
-
- cy.task('log', `Replace ${appRoutes} with Cypress routes`)
- cy.task('copyFile', { source: routesFixture, target: appRoutes })
-
- waitForApplication()
-
- cy.task('log', 'The cypress test page should be displayed')
- cy.visit(pagePath)
- cy.get('h1')
- .contains('CYPRESS TEST PAGE')
-
- cy.task('log', `Restore ${appRoutesPath}`)
- cy.task('copyFromStarterFiles', { filename: appRoutesPath })
-
- waitForApplication()
-
- cy.task('log', 'The cypress test page should not be found')
- cy.visit(pagePath, { failOnStatusCode: false })
- cy.get('body')
- .contains(`There is no page at ${pagePath}`)
- })
-})
diff --git a/cypress/e2e/dev/1-watch-files/watch-views.cypress.js b/cypress/e2e/dev/1-watch-files/watch-views.cypress.js
deleted file mode 100644
index af18a3792d..0000000000
--- a/cypress/e2e/dev/1-watch-files/watch-views.cypress.js
+++ /dev/null
@@ -1,30 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const templatesView = path.join(Cypress.config('fixturesFolder'), 'views', 'start.html')
-const appView = path.join(Cypress.env('projectFolder'), 'app', 'views', 'start.html')
-const pagePath = '/start'
-
-describe('watching start page', () => {
- afterEach(restoreStarterFiles)
-
- it('Add and remove the start page', () => {
- waitForApplication()
-
- cy.task('log', 'The start page should not be found')
- cy.visit(pagePath, { failOnStatusCode: false })
- cy.get('body')
- .contains(`There is no page at ${pagePath}`)
-
- cy.task('log', `Copy ${templatesView} to ${appView}`)
- cy.task('copyFile', { source: templatesView, target: appView })
-
- cy.task('log', 'The start page should be displayed')
- cy.visit(pagePath)
- cy.get('.govuk-button--start')
- .contains('Start now')
- })
-})
diff --git a/cypress/e2e/dev/2-page-component-tests/checkboxes.cypress.js b/cypress/e2e/dev/2-page-component-tests/checkboxes.cypress.js
deleted file mode 100644
index d6de02c248..0000000000
--- a/cypress/e2e/dev/2-page-component-tests/checkboxes.cypress.js
+++ /dev/null
@@ -1,54 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const templatesView = path.join(Cypress.config('fixturesFolder'), 'views', 'checkbox-test.html')
-const appView = path.join(Cypress.env('projectFolder'), 'app', 'views', 'checkbox-test.html')
-
-const pagePath = '/checkbox-test'
-
-describe('checkbox tests', () => {
- before(() => {
- cy.task('log', `Copy ${templatesView} to ${appView}`)
- cy.task('copyFile', { source: templatesView, target: appView })
- })
-
- after(restoreStarterFiles)
-
- const loadTestView = async () => {
- cy.task('log', 'The checkbox-test page should be displayed')
- cy.visit(pagePath)
- cy.get('h1')
- .contains('Checkbox tests')
- }
-
- const submitAndCheck = async (matchData) => {
- cy.intercept('POST', pagePath).as('submitPage')
- cy.get('button[data-module="govuk-button"]')
- .contains('Continue')
- .click()
- cy.wait('@submitPage').its('request.body')
- .then((body) => {
- const data = decodeURIComponent(body).split('&')
- cy.expect(data.length).equal(matchData.length)
- matchData.forEach((match) => {
- cy.expect(data).includes(match)
- })
- })
- }
-
- it('request should include the _unchecked option only', () => {
- waitForApplication()
- loadTestView()
- submitAndCheck(['vehicle1[vehicle-features]=_unchecked'])
- })
-
- it('when the GPS checkbox is selected, the request should include the GPS option', () => {
- waitForApplication()
- loadTestView()
- cy.get('input[value="GPS"]').check()
- submitAndCheck(['vehicle1[vehicle-features]=_unchecked', 'vehicle1[vehicle-features]=GPS'])
- })
-})
diff --git a/cypress/e2e/dev/3-link-page-tests/branching-journey.cypress.js b/cypress/e2e/dev/3-link-page-tests/branching-journey.cypress.js
deleted file mode 100644
index 98f5e8dd81..0000000000
--- a/cypress/e2e/dev/3-link-page-tests/branching-journey.cypress.js
+++ /dev/null
@@ -1,44 +0,0 @@
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-const { setUpPages, setUpBranchingPages } = require('./link-page-utils')
-
-const jugglingBallsPath = '/juggling-balls'
-
-const eligibleHowManyBalls = '3 or more'
-const ineligibleHowManyBalls = '1 or 2'
-
-describe('Branching journey', async () => {
- before(() => {
- setUpPages()
- setUpBranchingPages()
- waitForApplication()
- })
-
- after(restoreStarterFiles)
-
- it('eligible journey', () => {
- // Visit Juggling balls page, click continue
- cy.visit(jugglingBallsPath)
- cy.task('log', 'The juggling balls page should be displayed')
- cy.get('h1').contains('How many balls can you juggle?')
- cy.get(`input[value="${eligibleHowManyBalls}"]`).check()
- cy.get('button.govuk-button').contains('Continue').click()
-
- // Juggling trick page should be displayed correctly
- cy.task('log', 'The juggling trick page should be displayed')
- cy.get('h1').contains('What is your most impressive juggling trick?')
- })
-
- it('Ineligible journey', () => {
- // Visit Juggling balls page, click continue
- cy.visit(jugglingBallsPath)
- cy.task('log', 'The juggling balls page should be displayed')
- cy.get('h1').contains('How many balls can you juggle?')
- cy.get(`input[value="${ineligibleHowManyBalls}"]`).check()
- cy.get('button.govuk-button').contains('Continue').click()
-
- // Juggling trick page should be displayed correctly
- cy.task('log', 'The juggling trick page should be displayed')
- cy.get('h1').contains('Sorry, you are ineligible for juggling tricks')
- })
-})
diff --git a/cypress/e2e/dev/3-link-page-tests/change-answers.cypress.js b/cypress/e2e/dev/3-link-page-tests/change-answers.cypress.js
deleted file mode 100644
index 4976c15d72..0000000000
--- a/cypress/e2e/dev/3-link-page-tests/change-answers.cypress.js
+++ /dev/null
@@ -1,73 +0,0 @@
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-const { setUpPages, setUpData } = require('./link-page-utils')
-
-const checkAnswersPath = '/check-answers'
-
-const howManyBalls = '3 or more'
-const mostImpressiveTrick = 'Standing on my head'
-
-const defaultHowManyBalls = 'None - I cannot juggle'
-const defaultMostImpressiveTrick = 'None - I cannot do tricks'
-
-describe('Change answers', async () => {
- before(() => {
- setUpPages()
- setUpData()
- })
-
- after(restoreStarterFiles)
-
- it('Change juggling balls journey', () => {
- // Visit Check answers page, click change juggling balls
- waitForApplication()
- cy.task('log', 'The check answers page should be displayed')
- cy.visit(checkAnswersPath)
- cy.get('h1').contains('Check your answers before sending your application')
- cy.get('.govuk-summary-list__value:first').contains(defaultHowManyBalls)
- cy.get('.govuk-summary-list__value:last').contains(defaultMostImpressiveTrick)
- cy.get('a[href="/juggling-balls"]').contains('Change').click()
-
- // On Juggling balls page, click continue
- cy.task('log', 'The juggling balls page should be displayed')
- cy.get('h1').contains('How many balls can you juggle?')
- cy.get(`input[value="${defaultHowManyBalls}"]`).should('be.checked')
- cy.get(`input[value="${howManyBalls}"]`).check()
- cy.get('button.govuk-button').contains('Continue').click()
-
- // On Juggling trick page, click continue
- cy.task('log', 'The juggling trick page should be displayed')
- cy.get('h1').contains('What is your most impressive juggling trick?')
- cy.get('textarea#most-impressive-trick').contains(defaultMostImpressiveTrick)
- cy.get('button.govuk-button').contains('Continue').click()
-
- // On Check answers page, click accept and send
- cy.task('log', 'The check answers page should be displayed')
- cy.get('h1').contains('Check your answers before sending your application')
- cy.get('.govuk-summary-list__value:first').contains(howManyBalls)
- cy.get('.govuk-summary-list__value:last').contains(defaultMostImpressiveTrick)
- })
-
- it('Change juggling trick journey', () => {
- // Visit Check answers page, click change juggling trick
- waitForApplication()
- cy.task('log', 'The check answers page should be displayed')
- cy.visit(checkAnswersPath)
- cy.get('h1').contains('Check your answers before sending your application')
- cy.get('.govuk-summary-list__value:first').contains(defaultHowManyBalls)
- cy.get('.govuk-summary-list__value:last').contains(defaultMostImpressiveTrick)
- cy.get('a[href="/juggling-trick"]').contains('Change').click()
-
- // On Juggling trick page, click continue
- cy.task('log', 'The juggling trick page should be displayed')
- cy.get('h1').contains('What is your most impressive juggling trick?')
- cy.get('textarea#most-impressive-trick').contains(defaultMostImpressiveTrick).type(mostImpressiveTrick)
- cy.get('button.govuk-button').contains('Continue').click()
-
- // On Check answers page, click accept and send
- cy.task('log', 'The check answers page should be displayed')
- cy.get('h1').contains('Check your answers before sending your application')
- cy.get('.govuk-summary-list__value:first').contains(defaultHowManyBalls)
- cy.get('.govuk-summary-list__value:last').contains(mostImpressiveTrick)
- })
-})
diff --git a/cypress/e2e/dev/3-link-page-tests/link-index-to-start.cypress.js b/cypress/e2e/dev/3-link-page-tests/link-index-to-start.cypress.js
deleted file mode 100644
index 1063cebd26..0000000000
--- a/cypress/e2e/dev/3-link-page-tests/link-index-to-start.cypress.js
+++ /dev/null
@@ -1,38 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, copyFile, restoreStarterFiles } = require('../../utils')
-
-const appViewsPath = path.join('app', 'views')
-const indexViewPath = path.join(appViewsPath, 'index.html')
-
-const indexView = path.join(Cypress.env('projectFolder'), indexViewPath)
-const startView = path.join(Cypress.env('projectFolder'), appViewsPath, 'start.html')
-const templateStartView = path.join(Cypress.config('fixturesFolder'), 'views', 'start.html')
-
-const commentText = '{% include "govuk-prototype-kit/includes/homepage-bottom.njk" %}'
-
-const startText = 'Click here to start'
-
-const linkText = `${startText}`
-
-describe('Link index page to start page', async () => {
- beforeEach(() => {
- copyFile(templateStartView, startView)
- cy.task('replaceTextInFile', {
- filename: indexView,
- originalText: commentText,
- newText: linkText
- })
- })
-
- afterEach(restoreStarterFiles)
-
- it('click start link', () => {
- waitForApplication()
- cy.get('a[href="/start"]').contains(startText).click()
- cy.get('a[role="button"]')
- .contains('Start')
- })
-})
diff --git a/cypress/e2e/dev/3-link-page-tests/link-page-utils.js b/cypress/e2e/dev/3-link-page-tests/link-page-utils.js
deleted file mode 100644
index 54b203bd80..0000000000
--- a/cypress/e2e/dev/3-link-page-tests/link-page-utils.js
+++ /dev/null
@@ -1,103 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { copyFile } = require('../../utils')
-
-const templates = path.join(Cypress.config('fixturesFolder'), 'views')
-const startTemplate = path.join(templates, 'start.html')
-const questionTemplate = path.join(templates, 'question.html')
-const confirmationTemplate = path.join(templates, 'confirmation.html')
-const contentTemplate = path.join(templates, 'content.html')
-
-const fixtures = path.join(Cypress.config('fixturesFolder'))
-
-const fixtureViews = path.join(fixtures, 'views')
-const jugglingCheckAnswersFixtureView = path.join(fixtureViews, 'juggling-check-answers.html')
-
-const components = path.join(fixtures, 'components')
-const jugglingBallsComponent = path.join(components, 'juggling-balls-component.html')
-const jugglingTrickComponent = path.join(components, 'juggling-trick-component.html')
-const jugglingBallsAnswerComponent = path.join(components, 'juggling-balls-route-component.js')
-
-const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views')
-const startView = path.join(appViews, 'start.html')
-const jugglingBallsView = path.join(appViews, 'juggling-balls.html')
-const jugglingTrickView = path.join(appViews, 'juggling-trick.html')
-const checkAnswersView = path.join(appViews, 'check-answers.html')
-const confirmationView = path.join(appViews, 'confirmation.html')
-const ineligibleView = path.join(appViews, 'ineligible.html')
-
-const appRoutesPath = path.join('app', 'routes.js')
-const appRoutes = path.join(Cypress.env('projectFolder'), appRoutesPath)
-
-const appDataFile = path.join(Cypress.env('projectFolder'), 'app', 'data', 'session-data-defaults.js')
-
-const jugglingBallsPath = '/juggling-balls'
-const jugglingTrickPath = '/juggling-trick'
-const checkAnswersPath = '/check-answers'
-
-const jugglingBallsAnswerRoute = '/juggling-balls-answer'
-
-const defaultHowManyBalls = 'None - I cannot juggle'
-const defaultMostImpressiveTrick = 'None - I cannot do tricks'
-
-const createQuestionView = (view, content, nextPath) => {
- copyFile(questionTemplate, view)
- cy.task('replaceMultipleTextInFile', {
- filename: view,
- list: [
- { originalText: 'Heading or question goes here
', newText: '' }, - { originalText: '[See the GOV.UK Design System for examples]
', newText: '' }, - { originalText: '[Insert question content here]
', source: content }, - { originalText: '/url/of/next/page', newText: nextPath } - ] - }) -} - -const setUpPages = () => { - // Set up start view - copyFile(startTemplate, startView) - cy.task('replaceTextInFile', { filename: startView, originalText: ' { - cy.task('replaceTextInFile', { filename: appDataFile, originalText: '// Insert values here', newText: `"how-many-balls": "${defaultHowManyBalls}", "most-impressive-trick": "${defaultMostImpressiveTrick}"` }) -} - -const setUpBranchingPages = () => { - // Set up ineligible view - copyFile(contentTemplate, ineligibleView) - cy.task('replaceMultipleTextInFile', { - filename: ineligibleView, - list: [ - { originalText: 'Heading goes here', newText: 'Sorry, you are ineligible for juggling tricks' }, - { originalText: 'This is a paragraph of text. It explains in more detail what has happened and wraps across several lines.', newText: 'Keep practicing and when you can juggle 3 or more balls, you will be eligible for tricks.' }, - { originalText: 'Read more about this topic.
', newText: '' } - ] - }) - - // Update the juggling balls action - cy.task('replaceTextInFile', { filename: jugglingBallsView, originalText: jugglingTrickPath, newText: jugglingBallsAnswerRoute }) - - // Update routes with juggling balls answer component - cy.task('replaceTextInFile', { filename: appRoutes, originalText: '// Add your routes here', source: jugglingBallsAnswerComponent }) -} - -module.exports = { - setUpPages, - setUpBranchingPages, - setUpData -} diff --git a/cypress/e2e/dev/3-link-page-tests/simple-journey.cypress.js b/cypress/e2e/dev/3-link-page-tests/simple-journey.cypress.js deleted file mode 100644 index 36e8832af2..0000000000 --- a/cypress/e2e/dev/3-link-page-tests/simple-journey.cypress.js +++ /dev/null @@ -1,48 +0,0 @@ -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') -const { setUpPages } = require('./link-page-utils') - -const startPath = '/start' - -const howManyBalls = '3 or more' -const mostImpressiveTrick = 'Standing on my head' - -describe('Question journey', async () => { - beforeEach(() => { - setUpPages() - }) - - afterEach(restoreStarterFiles) - - it('Happy path journey', () => { - waitForApplication() - // Visit start page and click start - cy.task('log', 'The start page should be displayed') - cy.visit(startPath) - cy.get('body').contains('Start now') - cy.get('a.govuk-button--start').click() - - // On Juggling balls page, click continue - cy.task('log', 'The juggling balls page should be displayed') - cy.get('h1').contains('How many balls can you juggle?') - cy.get(`input[value="${howManyBalls}"]`).check() - cy.get('button.govuk-button').contains('Continue').click() - - // On Juggling trick page, click continue - cy.task('log', 'The juggling trick page should be displayed') - cy.get('h1').contains('What is your most impressive juggling trick?') - cy.get('textarea#most-impressive-trick').type(mostImpressiveTrick) - cy.get('button.govuk-button').contains('Continue').click() - - // On Check answers page, click accept and send - cy.task('log', 'The check answers page should be displayed') - cy.get('h1').contains('Check your answers before sending your application') - cy.get('.govuk-summary-list__value:first').contains(howManyBalls) - cy.get('.govuk-summary-list__value:last').contains(mostImpressiveTrick) - cy.get('button.govuk-button').contains('Accept and send').click() - - // Confirmation page should be displayed correctly - cy.task('log', 'The confirmation page should be displayed') - cy.get('h1.govuk-panel__title').contains('Application complete') - }) -}) diff --git a/cypress/e2e/dev/4-step-by-step-tests/step-by-step-journey.cypress.js b/cypress/e2e/dev/4-step-by-step-tests/step-by-step-journey.cypress.js deleted file mode 100644 index a301e852ad..0000000000 --- a/cypress/e2e/dev/4-step-by-step-tests/step-by-step-journey.cypress.js +++ /dev/null @@ -1,108 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { copyFile, waitForApplication, installPlugin, restoreStarterFiles } = require('../../utils') -const { - assertHidden, - assertVisible, - showHideAllLinkQuery, - titleQuery, - toggleButtonQuery -} = require('../../step-by-step-utils') - -const plugin = '@govuk-prototype-kit/step-by-step@1' - -const projectFolder = Cypress.env('projectFolder') - -const appViews = path.join(projectFolder, 'app', 'views') - -const stepByStepTestData = [{ - name: 'step-by-step-navigation', - heading: 'Learn to drive a car: step by step', - title1: 'Check you\'re allowed to drive', - title2: 'Get a provisional licence' -}, { - name: 'start-with-step-by-step', - heading: 'Check what age you can drive', - title1: 'Check you\'re allowed to drive', - title2: 'Get a provisional licence' -}] - -stepByStepTestData.forEach(({ name, heading, title1, title2 }) => { - const stepByStepTemplateView = path.join(Cypress.config('fixturesFolder'), 'views', `${name}.html`) - const stepByStepView = path.join(appViews, `${name}.html`) - const stepByStepPath = `/${name}` - - describe(`${name} journey`, async () => { - before(() => { - copyFile(stepByStepTemplateView, stepByStepView) - }) - - after(restoreStarterFiles) - - const loadPage = async () => { - cy.visit(stepByStepPath) - cy.get('h1').contains(heading) - } - - it('renders ok', () => { - waitForApplication() - - installPlugin(plugin) - - waitForApplication() - - loadPage() - cy.get(titleQuery(1)).should('contain.text', title1) - cy.get(titleQuery(2)).should('contain.text', title2) - assertHidden(1) - assertHidden(2) - }) - - it('toggle step 1', () => { - waitForApplication() - - loadPage() - // click toggle button and check that only step 1 details are visible - cy.get(toggleButtonQuery(1)).click() - assertVisible(1) - assertHidden(2) - - // click toggle button and check that only both steps are hidden - cy.get(toggleButtonQuery(1)).click() - assertHidden(1) - assertHidden(2) - }) - - it('toggle step 2', () => { - waitForApplication() - - loadPage() - // click toggle button and check that only step 1 details are visible - cy.get(toggleButtonQuery(2)).click() - assertHidden(1) - assertVisible(2) - - // click toggle button and check that only both steps are hidden - cy.get(toggleButtonQuery(2)).click() - assertHidden(1) - assertHidden(2) - }) - - it('toggle all steps', () => { - waitForApplication() - - loadPage() - // click toggle button and check that all steps details are visible - cy.get(showHideAllLinkQuery).contains('Show all').click() - assertVisible(1) - assertVisible(2) - - // click toggle button and check that all steps details are hidden - cy.get(showHideAllLinkQuery).contains('Hide all').click() - assertHidden(1) - assertHidden(2) - }) - }) -}) diff --git a/cypress/e2e/dev/5-management-tests/change-service-name.cypress.js b/cypress/e2e/dev/5-management-tests/change-service-name.cypress.js deleted file mode 100644 index 5d06efaa38..0000000000 --- a/cypress/e2e/dev/5-management-tests/change-service-name.cypress.js +++ /dev/null @@ -1,48 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const appConfigPath = path.join('app', 'config.json') -const appConfig = path.join(Cypress.env('projectFolder'), appConfigPath) - -const originalText = 'Service name goes here' -const newText = 'Cypress test' - -const serverNameQuery = 'a.govuk-header__link.govuk-header__service-name, a.govuk-header__link--service-name' - -const managePagePath = '/manage-prototype' - -describe('change service name', () => { - afterEach(restoreStarterFiles) - - it('The service name should change to "cypress test" and the task should be set to "Done"', () => { - waitForApplication() - - cy.task('log', 'Visit the index page and navigate to the manage your prototype page') - cy.visit('/') - cy.get('.govuk-heading-xl').contains(originalText) - cy.get('p strong').contains(appConfigPath) - cy.get(`main a[href="${managePagePath}"]`).contains('Manage your prototype').click() - - cy.task('log', 'Visit the manage prototype page') - - cy.get(serverNameQuery).contains(originalText) - cy.get('.govuk-prototype-kit-manage-prototype-task-list__item') - .contains(appConfigPath) - .get('.govuk-prototype-kit-manage-prototype-task-list__tag').contains('To do') - - cy.task('replaceTextInFile', { filename: appConfig, originalText, newText }) - - waitForApplication(managePagePath) - - cy.get(serverNameQuery).contains(newText) - cy.get('.govuk-prototype-kit-manage-prototype-task-list__item') - .contains(appConfigPath) - .get('.govuk-prototype-kit-manage-prototype-task-list__tag').contains('Done') - - cy.visit('/index') - cy.get('.govuk-heading-xl').contains(newText) - }) -}) diff --git a/cypress/e2e/dev/5-management-tests/clear-data-page.cypress.js b/cypress/e2e/dev/5-management-tests/clear-data-page.cypress.js deleted file mode 100644 index 644ee88310..0000000000 --- a/cypress/e2e/dev/5-management-tests/clear-data-page.cypress.js +++ /dev/null @@ -1,84 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { - copyFile, - createFile, - replaceInFile, - waitForApplication, restoreStarterFiles -} = require('../../utils') - -const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views') -const templates = path.join(Cypress.config('fixturesFolder'), 'views') -const components = path.join(Cypress.config('fixturesFolder'), 'components') - -const questionComponent = path.join(components, 'juggling-trick-component.html') -const questionTemplate = path.join(templates, 'question.html') - -const questionView = path.join(appViews, 'question.html') -const questionCheckView = path.join(appViews, 'question-check.html') - -const questionTestMarkUp = ` -{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %} - -{% block content %} - -question results
- -
-
-
-{% endblock %}
-`
-
-function clearData () {
- cy.get('footer a[href*="/manage-prototype/clear-data"]').click()
- cy.get('h1').should('contain.text', 'Clear session data')
- cy.get('button').should('contain.text', 'Clear the data').click()
- cy.get('main h1').should('contain.text', 'Data cleared')
- cy.get('main a').should('contain.text', 'Prototype home page').click()
-}
-
-const answer = 'Standing on my head'
-
-describe('clear data page', () => {
- before(() => {
- copyFile(questionTemplate, questionView)
- replaceInFile(questionView, '
-
-Answer: {{ data['most-impressive-trick'] }}
-[Insert question content here]
', questionComponent) - replaceInFile(questionView, '/url/of/next/page', '', '/question-check') - createFile(questionCheckView, { data: questionTestMarkUp }) - cy.task('copyFromStarterFiles', { filename: 'app/data/session-data-defaults.js' }) - }) - - after(restoreStarterFiles) - - it('save and clear data', () => { - waitForApplication() - - cy.task('log', 'Check data is cleared initially') - cy.visit('/index') - clearData() - cy.visit('/question-check') - cy.get('#answer').should('have.text', '') - - cy.task('log', 'Add some data') - cy.visit('/question') - cy.get('form textarea').type(answer) - cy.get('form').submit() - - cy.task('log', 'Check data has been saved') - cy.get('#answer').should('contain.text', answer) - cy.visit('/question') - cy.get('form textarea').should('contain.value', answer) - - cy.task('log', 'Check data can be cleared') - cy.visit('/index') - clearData() - cy.visit('/question-check') - cy.get('#answer').should('have.text', '') - }) -}) diff --git a/cypress/e2e/dev/5-management-tests/edit-home-page.cypress.js b/cypress/e2e/dev/5-management-tests/edit-home-page.cypress.js deleted file mode 100644 index 513aaf1174..0000000000 --- a/cypress/e2e/dev/5-management-tests/edit-home-page.cypress.js +++ /dev/null @@ -1,41 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const appHomePath = path.join('app', 'views', 'index.html') -const appHome = path.join(Cypress.env('projectFolder'), appHomePath) - -const originalText = 'Service name goes here' -const newText = 'Cypress test service' - -const managePagePath = '/manage-prototype' - -describe('edit home page', () => { - afterEach(restoreStarterFiles) - - it(`The home page heading should change to "${newText}" and the task should be set to "Done"`, () => { - waitForApplication(managePagePath) - - cy.task('log', 'Visit the manage prototype templates page') - - cy.get('.govuk-prototype-kit-manage-prototype-task-list__item') - .contains(appHomePath) - .get('.govuk-prototype-kit-manage-prototype-task-list__tag').contains('To do') - - cy.visit('/index') - cy.get('.govuk-heading-xl').contains(originalText) - - cy.task('replaceTextInFile', { filename: appHome, originalText: '{{ serviceName }}', newText }) - - waitForApplication(managePagePath) - - cy.get('.govuk-prototype-kit-manage-prototype-task-list__item') - .contains(appHomePath) - .get('.govuk-prototype-kit-manage-prototype-task-list__tag').contains('Done') - - cy.visit('/index') - cy.get('.govuk-heading-xl').contains(newText) - }) -}) diff --git a/cypress/e2e/dev/5-management-tests/management-available.cypress.js b/cypress/e2e/dev/5-management-tests/management-available.cypress.js deleted file mode 100644 index 6ef0a89e58..0000000000 --- a/cypress/e2e/dev/5-management-tests/management-available.cypress.js +++ /dev/null @@ -1,29 +0,0 @@ -// local dependencies -const { waitForApplication } = require('../../utils') - -describe('management available', () => { - it('when attempting to visit "/manage-prototype" page', () => { - waitForApplication() - cy.visit('/manage-prototype') - cy.get('h1').should('contain.text', 'Manage your prototype') - }) - - it('manage prototype link should exist on the home page', () => { - waitForApplication() - cy.visit('/') - cy.get('main a[href="/manage-prototype"]').should('contain.text', 'Manage your prototype') - }) - - it('manage prototype link should exist in the footer', () => { - waitForApplication() - cy.visit('/') - cy.get('footer a[href="/manage-prototype"]').should('contain.text', 'Manage your prototype') - }) - - it('clear data link should exist in the footer and work correctly', () => { - waitForApplication() - cy.visit('/') - cy.get('footer a[href="/manage-prototype/clear-data"]').should('contain.text', 'Clear data').click() - cy.get('h1').should('contain.text', 'Clear session data') - }) -}) diff --git a/cypress/e2e/dev/5-management-tests/no-autodatastore-on-management-pages.cypress.js b/cypress/e2e/dev/5-management-tests/no-autodatastore-on-management-pages.cypress.js deleted file mode 100644 index 8a0f1e75c8..0000000000 --- a/cypress/e2e/dev/5-management-tests/no-autodatastore-on-management-pages.cypress.js +++ /dev/null @@ -1,67 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { - copyFile, - createFile, - waitForApplication, restoreStarterFiles -} = require('../../utils') - -const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views') -const templates = path.join(Cypress.config('fixturesFolder'), 'views') - -const questionTemplate = path.join(templates, 'question.html') - -const questionView = path.join(appViews, 'question.html') -const questionCheckView = path.join(appViews, 'question-check.html') - -const dataOutputNjk = ` -{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %} - -{% block content %} -Answer: {{ data['most-impressive-trick'] }}
-Should be empty: {{ data['abc'] }}
-{% endblock %} -` - -const answer = 'Standing on my head' - -function clearData () { - cy.get('footer a[href*="/manage-prototype/clear-data"]').click() - cy.get('h1').should('contain.text', 'Clear session data') - cy.get('button').should('contain.text', 'Clear the data').click() - cy.get('main h1').should('contain.text', 'Data cleared') - cy.get('main a').should('contain.text', 'Prototype home page').click() -} -describe('clear data page', () => { - before(() => { - copyFile(questionTemplate, questionView) - createFile(questionCheckView, { data: dataOutputNjk }) - cy.task('copyFromStarterFiles', { filename: 'app/data/session-data-defaults.js' }) - }) - - after(restoreStarterFiles) - - it('add data from query string, but not in magnagement pages', () => { - waitForApplication() - - cy.task('log', 'Check data is cleared initially') - cy.visit('/index') - clearData() - cy.visit('/question-check') - cy.get('#answer').should('have.text', '') - cy.get('#empty').should('have.text', '') - - cy.task('log', 'Add some data') - cy.visit(`/question-check?most-impressive-trick=${encodeURIComponent(answer)}`) - cy.get('.govuk-header__logotype') - cy.visit('/manage-prototype/plugins?abc=def') - cy.get('.govuk-header__logotype') - - cy.task('log', 'Check data has been saved') - cy.visit('/question-check') - cy.get('#answer').should('have.text', answer) - cy.get('#empty').should('have.text', '') - }) -}) diff --git a/cypress/e2e/dev/6-layout-tests/default-layout.cypress.js b/cypress/e2e/dev/6-layout-tests/default-layout.cypress.js deleted file mode 100644 index db406feadc..0000000000 --- a/cypress/e2e/dev/6-layout-tests/default-layout.cypress.js +++ /dev/null @@ -1,37 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const defaultLayoutFilePath = path.join('app', 'views', 'layouts', 'main.html') -const backupLayoutComment = '' - -const comments = el => cy.wrap( - [...el.childNodes] - .filter(node => node.nodeName === '#comment') - .map(commentNode => '') -) - -describe('default-layout', () => { - afterEach(restoreStarterFiles) - - it('deleting default layout does not cause pages to fail to render', () => { - waitForApplication() - cy.visit('/') - - cy.document().then(doc => - comments(doc.head).should('not.contain', backupLayoutComment) - ) - - cy.task('deleteFile', { filename: path.join(Cypress.env('projectFolder'), defaultLayoutFilePath) }) - - cy.visit('/', { failOnStatusCode: false }) - cy.get('body').should('not.contains.text', 'Error: template not found') - - cy.document().then(doc => { - cy.log('head content', doc.head.innerHTML) - comments(doc.head).should('contain', backupLayoutComment) - }) - }) -}) diff --git a/cypress/e2e/dev/6-layout-tests/title-variable.cypress.js b/cypress/e2e/dev/6-layout-tests/title-variable.cypress.js deleted file mode 100644 index 1c227465c5..0000000000 --- a/cypress/e2e/dev/6-layout-tests/title-variable.cypress.js +++ /dev/null @@ -1,56 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const indexFile = path.join('app', 'views', 'index.html') - -describe('', () => { - afterEach(restoreStarterFiles) - - it('should allow title to be set in multiple ways', () => { - waitForApplication() - cy.visit('/') - - cy.task('log', 'Should display standard home page title') - - cy.title().should('eq', 'Home - Service name goes here - GOV.UK') - - cy.task('log', 'Update index.html using "set pageName" to display customised page title') - - cy.task('createFile', { - filename: path.join(Cypress.env('projectFolder'), indexFile), - data: ` - {% extends "layouts/main.html" %} - - {% set pageName="This is my custom title" %}`, - replace: true - }) - - cy.visit('/') - - cy.task('log', 'Should display customised page title') - - cy.title().should('eq', 'This is my custom title - Service name goes here - GOV.UK') - - cy.task('log', 'Update index.html using "block pageTitle" to display overridden page title') - - cy.task('createFile', { - filename: path.join(Cypress.env('projectFolder'), indexFile), - data: ` - {% extends "layouts/main.html" %} - - {% block pageTitle %} - This is my override title - {% endblock %}`, - replace: true - }) - - cy.visit('/') - - cy.task('log', 'Should display overridden page title') - - cy.title().should('eq', 'This is my override title') - }) -}) diff --git a/cypress/e2e/errors/1-error-page-tests/fatal-error.cypress.js b/cypress/e2e/errors/1-error-page-tests/fatal-error.cypress.js deleted file mode 100644 index 6bb31caf23..0000000000 --- a/cypress/e2e/errors/1-error-page-tests/fatal-error.cypress.js +++ /dev/null @@ -1,40 +0,0 @@ -const path = require('path') -const { restoreStarterFiles } = require('../../utils') -const completelyBrokenRoutesFixture = path.join(Cypress.config('fixturesFolder'), 'completely-broken-routes.js') -const appRoutesPath = path.join('app', 'routes.js') -const appRoutes = path.join(Cypress.env('projectFolder'), appRoutesPath) - -const pageName = 'There is an error' -const contactSupportText = 'Get support' -const expectedErrorFileAndLine = `${['app', 'routes.js'].join(Cypress.config('pathSeparator'))} (line 1)` -const expectedErrorMessage = 'lkewjflkjadsf is not defined' - -const homePageName = 'GOV.UK Prototype Kit' - -describe('Fatal Error Test', () => { - afterEach(restoreStarterFiles) - - it('fatal error should show an error page', () => { - cy.task('waitUntilAppRestarts') - cy.visit('/', { failOnStatusCode: false }) - - cy.get('.govuk-heading-l').contains(homePageName) - - cy.task('log', `Replace ${appRoutes} with Broken routes`) - cy.task('copyFile', { source: completelyBrokenRoutesFixture, target: appRoutes }) - - cy.wait(5000) - - cy.get('.govuk-heading-l').contains(pageName) - cy.get('.govuk-body .govuk-link').contains(contactSupportText) - cy.get('#govuk-prototype-kit-error-file').contains(expectedErrorFileAndLine) - cy.get('#govuk-prototype-kit-error-message').contains(expectedErrorMessage) - - cy.task('log', `Restore ${appRoutes} with original routes`) - cy.task('copyFromStarterFiles', { filename: appRoutesPath }) - - cy.wait(5000) - - cy.get('.govuk-heading-l').contains(homePageName) - }) -}) diff --git a/cypress/e2e/errors/1-error-page-tests/page-not-found-error.cypress.js b/cypress/e2e/errors/1-error-page-tests/page-not-found-error.cypress.js deleted file mode 100644 index b6827ee371..0000000000 --- a/cypress/e2e/errors/1-error-page-tests/page-not-found-error.cypress.js +++ /dev/null @@ -1,28 +0,0 @@ -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const pageName = 'Page not found' -const checkPageNotFoundText = 'There is no page at /p4ge-n0t-f0und' -const helpText = 'This may be because:' -const helpList = [ - 'you typed or pasted the web address incorrectly', - 'a link in your code is wrong', - 'a form in your code is wrong', - 'you have not created the page yet'] -const contactSupportText = 'You can try and fix this yourself or contact the GOV.UK Prototype Kit team if you need help.' - -describe('Internal error Test', () => { - afterEach(restoreStarterFiles) - - it('internal server error results in 500 page being displayed correctly', () => { - waitForApplication() - - cy.visit('/p4ge-n0t-f0und', { failOnStatusCode: false }) - cy.get('.govuk-heading-l').contains(pageName) - cy.get('.govuk-body').contains(checkPageNotFoundText) - cy.get('.govuk-body').contains(helpText) - for (const hint of helpList) { - cy.get('li').contains(hint) - } - cy.get('.govuk-body').contains(contactSupportText) - }) -}) diff --git a/cypress/e2e/errors/1-error-page-tests/server-error.cypress.js b/cypress/e2e/errors/1-error-page-tests/server-error.cypress.js deleted file mode 100644 index ca1ddf70d1..0000000000 --- a/cypress/e2e/errors/1-error-page-tests/server-error.cypress.js +++ /dev/null @@ -1,74 +0,0 @@ -const path = require('path') -const { waitForApplication, restoreStarterFiles } = require('../../utils') -const routesFixture = path.join(Cypress.config('fixturesFolder'), 'routes.js') -const appRoutesPath = path.join('app', 'routes.js') -const appRoutes = path.join(Cypress.env('projectFolder'), appRoutesPath) - -const homePageName = 'GOV.UK Prototype Kit' -const errorPageName = 'There is an error' -const contactSupportText = 'Get support' - -describe('Server Error Test', () => { - beforeEach(() => { - cy.task('log', `Replace ${appRoutes} with Cypress routes`) - cy.task('copyFile', { source: routesFixture, target: appRoutes }) - }) - - afterEach(restoreStarterFiles) - - it('internal server error results in 500 page being displayed correctly', () => { - const expectedErrorFileAndLine = `${['app', 'routes.js'].join(Cypress.config('pathSeparator'))} (line 18)` - const expectedErrorMessage = 'test error' - - waitForApplication() - - cy.visit('/error', { failOnStatusCode: false }) - - cy.get('.govuk-heading-l').contains(errorPageName) - cy.get('.govuk-body .govuk-link').contains(contactSupportText) - cy.get('#govuk-prototype-kit-error-file').contains(expectedErrorFileAndLine) - cy.get('#govuk-prototype-kit-error-message').contains(expectedErrorMessage) - }) - - it('shows an error if a template cannot be found', () => { - const templateNotFoundText = 'template not found: test-page.html' - - waitForApplication() - - cy.visit('/test-page', { failOnStatusCode: false }) - - cy.get('.govuk-heading-l').contains(errorPageName) - cy.get('.govuk-body .govuk-link').contains(contactSupportText) - cy.get('#govuk-prototype-kit-error-message').contains(templateNotFoundText) - }) - - it('shows an error if sass is broken', () => { - const brokenStylesFixture = path.join(Cypress.config('fixturesFolder'), 'sass', 'broken-styles.scss') - const appSassPath = path.join('app', 'assets', 'sass', 'application.scss') - const appSass = path.join(Cypress.env('projectFolder'), appSassPath) - const brokenSassText = 'color red' - - waitForApplication() - - // Page has no error - cy.get('.govuk-heading-l').contains(homePageName) - - // Break the application.scss - cy.task('copyFile', { source: brokenStylesFixture, target: appSass }) - - cy.wait(2000) - - // Page now shows an error - cy.get('.govuk-heading-l').contains(errorPageName) - cy.get('.govuk-body .govuk-link').contains(contactSupportText) - cy.get('#govuk-prototype-kit-error-line').contains(brokenSassText) - - // Restore the application.scss from prototype starter - cy.task('copyFromStarterFiles', { filename: appSassPath }) - - waitForApplication() - - // Page should recover with no error - cy.get('.govuk-heading-l').contains(homePageName) - }) -}) diff --git a/cypress/e2e/plugins/0-mock-plugin-tests/install-plugin-via-cli-test.cypress.js b/cypress/e2e/plugins/0-mock-plugin-tests/install-plugin-via-cli-test.cypress.js deleted file mode 100644 index cb6b97ed92..0000000000 --- a/cypress/e2e/plugins/0-mock-plugin-tests/install-plugin-via-cli-test.cypress.js +++ /dev/null @@ -1,60 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, installPlugin, createFile, restoreStarterFiles } = require('../../utils') - -const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views') -const pluginBazView = path.join(appViews, 'plugin-baz.html') -const fixtures = path.join(Cypress.config('fixturesFolder')) -const pluginLocation = path.join(fixtures, 'plugins', 'plugin-baz') - -const CYAN = 'rgb(0, 255, 255)' -const MAGENTA = 'rgb(255, 0, 255)' - -const pluginBazViewMarkup = ` -{% extends "layouts/main.html" %} - -{% block content %} -{% include "baz.njk" %} -{% endblock %} - -{% block pageScripts %} - -{% endblock %} -` - -function installBaz () { - createFile(pluginBazView, { data: pluginBazViewMarkup }) - installPlugin(`file:${pluginLocation}`) - return waitForApplication('/plugin-baz') -} - -describe('Install Plugin via CLI Test', async () => { - afterEach(restoreStarterFiles) - - it('Loads plugin-baz view correctly', () => { - installBaz() - cy.get('.plugin-baz') - .contains('Plugin Baz') - }) - - it('Loads plugin-baz style correctly', () => { - installBaz() - cy.get('.plugin-baz') - .should('have.css', 'background-color', MAGENTA) - .should('have.css', 'border-color', CYAN) - }) - - it('Loads plugin-baz script correctly', () => { - installBaz() - cy.get('.plugin-baz').click() - cy.get('.plugin-baz') - .should('have.css', 'background-color', CYAN) - .should('have.css', 'border-color', MAGENTA) - }) -}) diff --git a/cypress/e2e/plugins/0-mock-plugin-tests/install-plugin-via-ui-test.cypress.js b/cypress/e2e/plugins/0-mock-plugin-tests/install-plugin-via-ui-test.cypress.js deleted file mode 100644 index 630978c6ba..0000000000 --- a/cypress/e2e/plugins/0-mock-plugin-tests/install-plugin-via-ui-test.cypress.js +++ /dev/null @@ -1,107 +0,0 @@ -const { restoreStarterFiles, log } = require('../../utils') -const path = require('path') -const { - loadTemplatesPage, - managePluginsPagePath, - performPluginAction, - initiatePluginAction, - provePluginInstalled, - provePluginTemplatesInstalled, - provePluginTemplatesUninstalled -} = require('../plugin-utils') - -const panelCompleteQuery = '[aria-live="polite"] #panel-complete' -const fixtures = path.join(Cypress.config('fixturesFolder')) -const dependentPlugin = 'plugin-fee' -const dependentPluginName = 'Plugin Fee' -const dependentPluginLocation = [fixtures, 'plugins', dependentPlugin].join(Cypress.config('pathSeparator')) -const dependencyPlugin = 'govuk-frontend' -const dependencyPluginName = 'GOV.UK Frontend' - -describe('Install and uninstall Local Plugin via UI Test', async () => { - afterEach(restoreStarterFiles) - - it(`The ${dependentPlugin} plugin will be installed`, () => { - log(`The ${dependentPlugin} plugin templates are not available`) - loadTemplatesPage() - provePluginTemplatesUninstalled(dependentPlugin) - - // ------------------------ - - log(`Install the ${dependentPlugin} plugin`) - cy.task('waitUntilAppRestarts') - cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(dependentPlugin)}&version=${encodeURIComponent(dependentPluginLocation)}`) - cy.get('#plugin-action-button').click() - - cy.get(panelCompleteQuery, { timeout: 20000 }) - .should('be.visible') - cy.get('a').contains('Back to plugins').click() - - provePluginInstalled(dependentPlugin, dependentPluginName) - - // ------------------------ - - log(`The ${dependentPlugin} plugin templates are available`) - cy.get('a').contains('Templates').click() - provePluginTemplatesInstalled(dependentPlugin) - - // ------------------------ - - log('Uninstall the local plugin') - cy.get('a').contains('Plugins').click() - - initiatePluginAction('uninstall', dependentPlugin, dependentPluginName) - - // ------------------------ - - log(`The ${dependentPlugin} plugin templates are not available`) - cy.get('a').contains('Templates').click() - provePluginTemplatesUninstalled(dependentPlugin) - }) - - it(`The ${dependentPlugin} plugin and ${dependencyPlugin} will be installed`, () => { - log(`The ${dependentPlugin} plugin templates are not available`) - loadTemplatesPage() - provePluginTemplatesUninstalled(dependentPlugin) - - // ------------------------ - - log(`Uninstall the ${dependencyPlugin} to force the UI to ask for it later`) - cy.task('waitUntilAppRestarts') - cy.visit(`${managePluginsPagePath}/uninstall?package=${encodeURIComponent(dependencyPlugin)}`) - cy.get('#plugin-action-button').click() - performPluginAction('uninstall', dependencyPlugin, dependencyPluginName) - - // ------------------------ - - log(`Install the ${dependentPlugin} plugin and the ${dependencyPlugin}`) - cy.task('waitUntilAppRestarts') - cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(dependentPlugin)}&version=${encodeURIComponent(dependentPluginLocation)}`) - // Should list the dependency plugin - cy.get('li').contains(dependencyPluginName) - cy.get('#plugin-action-button').click() - performPluginAction('install', dependentPlugin, dependentPluginName) - - // ------------------------ - - log(`The ${dependentPlugin} plugin templates are available`) - cy.get('a').contains('Templates').click() - provePluginTemplatesInstalled(dependentPlugin) - - // ------------------------ - - log('Uninstall the dependency plugin') - cy.task('waitUntilAppRestarts') - cy.visit(`${managePluginsPagePath}/uninstall?package=${encodeURIComponent(dependencyPlugin)}`) - // Should list the dependent plugin - cy.get('li').contains(dependentPluginName) - cy.get('#plugin-action-button').click() - performPluginAction('uninstall', dependencyPlugin, dependencyPluginName) - - // ------------------------ - - log(`The ${dependentPlugin} plugin templates are not available`) - cy.get('a').contains('Templates').click() - provePluginTemplatesUninstalled(dependentPlugin) - }) -}) diff --git a/cypress/e2e/plugins/0-mock-plugin-tests/multi-combined-plugin-test.cypress.js b/cypress/e2e/plugins/0-mock-plugin-tests/multi-combined-plugin-test.cypress.js deleted file mode 100644 index 1722582f8b..0000000000 --- a/cypress/e2e/plugins/0-mock-plugin-tests/multi-combined-plugin-test.cypress.js +++ /dev/null @@ -1,104 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views') -const pluginFooBarView = path.join(appViews, 'plugin-foo-bar.html') - -const WHITE = 'rgb(255, 255, 255)' -const RED = 'rgb(255, 0, 0)' -const YELLOW = 'rgb(255, 255, 0)' -const BLUE = 'rgb(0, 0, 255)' - -const pluginFooBarCombinedViewMarkup = ` -{% extends "layouts/main.html" %} - -{% block content %} -{% set testVar="Hello" %} -Plugin Foo Bar
-{{testVar | foo__strong}}
-{{testVar | bar__link('https://gov.uk/')}}
-{% endblock %} - -{% block pageScripts %} - -{% endblock %} -` - -describe('Multiple Plugin test', async () => { - before(() => { - cy.task('createFile', { filename: pluginFooBarView, data: pluginFooBarCombinedViewMarkup }) - }) - - after(restoreStarterFiles) - - describe('Plugin Bar', () => { - it('Loads plugin-bar view correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-bar') - .contains('Plugin Foo Bar') - }) - - it('Loads plugin-bar style correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-bar') - .should('have.css', 'background-color', YELLOW) - .should('have.css', 'border-color', WHITE) - }) - - it('Loads plugin-bar script correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-bar').click() - cy.get('.plugin-bar') - .should('have.css', 'background-color', BLUE) - .should('have.css', 'border-color', RED) - }) - it('Uses the foo filter correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('#filter-test-bar') - .should('contain.html', 'Hello') - }) - }) - - describe('Plugin Foo', () => { - it('Loads plugin-foo view correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-foo') - .contains('Plugin Foo Bar') - }) - - it('Loads plugin-foo style correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-foo') - .should('have.css', 'background-color', YELLOW) - .should('have.css', 'border-color', WHITE) - }) - - it('Loads plugin-foo script correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-foo').click() - cy.get('.plugin-foo').should('have.css', 'background-color', BLUE) - .should('have.css', 'border-color', RED) - }) - it('Uses the bar filter correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('#filter-test-foo') - .should('contain.html', 'Hello') - }) - }) -}) diff --git a/cypress/e2e/plugins/0-mock-plugin-tests/multi-plugin-test.cypress.js b/cypress/e2e/plugins/0-mock-plugin-tests/multi-plugin-test.cypress.js deleted file mode 100644 index 57c2127452..0000000000 --- a/cypress/e2e/plugins/0-mock-plugin-tests/multi-plugin-test.cypress.js +++ /dev/null @@ -1,91 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views') -const pluginFooBarView = path.join(appViews, 'plugin-foo-bar.html') - -const WHITE = 'rgb(255, 255, 255)' -const RED = 'rgb(255, 0, 0)' -const GREEN = 'rgb(0, 255, 0)' -const YELLOW = 'rgb(255, 255, 0)' -const BLUE = 'rgb(0, 0, 255)' - -const pluginFooBarSeparatedViewMarkup = ` -{% extends "layouts/main.html" %} - -{% block content %} -{% include "bar.njk" %} -{% include "foo.njk" %} -{% endblock %} - -{% block pageScripts %} - -{% endblock %} -` - -describe('Plugins test', async () => { - before(() => { - cy.task('createFile', { filename: pluginFooBarView, data: pluginFooBarSeparatedViewMarkup }) - }) - - after(restoreStarterFiles) - - describe('Plugin Bar', () => { - it('Loads plugin-bar view correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-bar') - .contains('Plugin Bar') - }) - - it('Loads plugin-bar style correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-bar') - .should('have.css', 'background-color', RED) - .should('have.css', 'border-color', GREEN) - }) - - it('Loads plugin-bar script correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-bar').click() - cy.get('.plugin-bar').should('have.css', 'background-color', GREEN) - .should('have.css', 'border-color', RED) - }) - }) - - describe('Plugin Foo', () => { - it('Loads plugin-foo view correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-foo') - .contains('Plugin Foo') - }) - - it('Loads plugin-foo style correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-foo') - .should('have.css', 'background-color', YELLOW) - .should('have.css', 'border-color', WHITE) - }) - - it('Loads plugin-foo script correctly', () => { - waitForApplication() - cy.visit('/plugin-foo-bar') - cy.get('.plugin-foo').click() - cy.get('.plugin-foo') - .should('have.css', 'background-color', BLUE) - .should('have.css', 'border-color', WHITE) - }) - }) -}) diff --git a/cypress/e2e/plugins/0-mock-plugin-tests/single-plugin-test.cypress.js b/cypress/e2e/plugins/0-mock-plugin-tests/single-plugin-test.cypress.js deleted file mode 100644 index 985e9da41b..0000000000 --- a/cypress/e2e/plugins/0-mock-plugin-tests/single-plugin-test.cypress.js +++ /dev/null @@ -1,89 +0,0 @@ -// core dependencies -const path = require('path') - -// local dependencies -const { waitForApplication, restoreStarterFiles } = require('../../utils') - -const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views') -const pluginFooView = path.join(appViews, 'plugin-foo.html') - -const WHITE = 'rgb(255, 255, 255)' -const YELLOW = 'rgb(255, 255, 0)' -const BLUE = 'rgb(0, 0, 255)' - -const pluginFooViewMarkup = ` -{% extends "layouts/main.html" %} - -{% block content %} -{% include "foo.njk" %} -{{ 'abc' | foo__strong }}
-{{ fooEmphasize('def') }}
-{{ fooField('pass', value='ghi') }}
-{% endblock %}
-
-{% block pageScripts %}
-
-{% endblock %}
-`
-
-describe('Single Plugin Test', async () => {
- before(() => {
- cy.task('createFile', { filename: pluginFooView, data: pluginFooViewMarkup })
- })
-
- after(restoreStarterFiles)
-
- it('Loads plugin-foo view correctly', () => {
- waitForApplication()
- cy.visit('/plugin-foo')
- cy.get('.plugin-foo')
- .contains('Plugin Foo')
- })
-
- it('Loads plugin-foo style correctly', () => {
- waitForApplication()
- cy.visit('/plugin-foo')
- cy.get('.plugin-foo')
- .should('have.css', 'background-color', YELLOW)
- .should('have.css', 'border-color', WHITE)
- })
-
- it('Loads plugin-foo filter correctly', () => {
- waitForApplication()
- cy.visit('/plugin-foo')
- cy.get('#test-foo-strong-filter')
- .should('have.html', 'abc')
- })
-
- it('Loads plugin-foo function correctly', () => {
- waitForApplication()
- cy.visit('/plugin-foo')
- cy.get('#test-foo-emphasize-function')
- .should('have.html', 'def')
- })
-
- it('Loads plugin-foo foo-field macro correctly', () => {
- waitForApplication()
- cy.visit('/plugin-foo')
- cy.get('#test-foo-field-macro input')
- .should('have.value', 'ghi')
- })
-
- it('Loads plugin-foo script correctly', () => {
- waitForApplication()
- cy.visit('/plugin-foo')
- cy.get('.plugin-foo').click()
- cy.get('.plugin-foo').should('have.css', 'background-color', BLUE)
- cy.get('.plugin-foo').should('have.css', 'border-color', WHITE)
- })
-
- it('Loads plugin-foo module correctly', () => {
- waitForApplication()
- cy.visit('/plugin-foo')
- cy.get('#foo-module').contains('The foo result is: 3')
- })
-})
diff --git a/cypress/e2e/plugins/1-available-plugins-tests/available-plugins.cypress.js b/cypress/e2e/plugins/1-available-plugins-tests/available-plugins.cypress.js
deleted file mode 100644
index 96896fc24a..0000000000
--- a/cypress/e2e/plugins/1-available-plugins-tests/available-plugins.cypress.js
+++ /dev/null
@@ -1,97 +0,0 @@
-// local dependencies
-const { uninstallPlugin, restoreStarterFiles, log } = require('../../utils')
-const {
- managePluginsPagePath,
- loadTemplatesPage,
- loadPluginsPage,
- manageTemplatesPagePath,
- provePluginUninstalled,
- performPluginAction,
- initiatePluginAction,
- provePluginTemplatesUninstalled,
- provePluginTemplatesInstalled
-} = require('../plugin-utils')
-
-const panelCompleteQuery = '[aria-live="polite"] #panel-complete'
-
-async function installPluginTests ({ plugin, templates, version }) {
- describe(plugin, () => {
- after(restoreStarterFiles)
-
- it(`The ${plugin} templates will be installed`, () => {
- log(`The ${plugin} plugin templates are not available`)
- uninstallPlugin(plugin)
- loadTemplatesPage()
- provePluginTemplatesUninstalled(plugin)
-
- // ------------------------
-
- log(`Install the ${plugin} plugin`)
- if (version) {
- cy.task('waitUntilAppRestarts')
- cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(plugin)}&version=${version}`)
-
- cy.get('#plugin-action-button').click()
- } else {
- loadPluginsPage()
- provePluginUninstalled(plugin)
- log(`Install the ${plugin} plugin`)
- performPluginAction('install', plugin)
- }
-
- cy.get(panelCompleteQuery, { timeout: 20000 })
- .should('be.visible')
- cy.get('a').contains('Back to plugins').click()
-
- // ------------------------
-
- log(`The ${plugin} plugin templates are available`)
- cy.get('a').contains('Templates').click()
-
- provePluginTemplatesInstalled(plugin)
-
- // ------------------------
-
- templates.forEach(({ name, filename }) => {
- log(`View ${name} template`)
- cy.visit(manageTemplatesPagePath)
- cy.get(`[data-plugin-package-name="${plugin}"] a`).contains(`View ${name} page`).click()
- cy.url().then(url => expect(url).to.contain(filename))
- })
-
- // ------------------------
-
- log(`Uninstall the ${plugin} plugin`)
- cy.visit(managePluginsPagePath)
-
- initiatePluginAction('uninstall', plugin)
-
- provePluginUninstalled(plugin)
- })
- })
-}
-
-describe('Plugin tests', () => {
- after(restoreStarterFiles)
-
- installPluginTests({
- plugin: '@govuk-prototype-kit/common-templates',
- version: '1.1.1',
- templates: [
- { name: 'Blank GOV.UK', filename: 'blank-govuk.html' },
- { name: 'Blank unbranded', filename: 'blank-unbranded.html' },
- { name: 'Check answers', filename: 'check-answers.html' },
- { name: 'Confirmation', filename: 'confirmation.html' },
- { name: 'Content', filename: 'content.html' },
- { name: 'Mainstream guide', filename: 'mainstream-guide.html' },
- { name: 'Start', filename: 'start.html' },
- { name: 'Question', filename: 'question.html' }
- ]
- })
-
- installPluginTests({
- plugin: '@govuk-prototype-kit/task-list',
- version: '1.0.0',
- templates: [{ name: 'Task list', filename: 'task-list.html' }]
- })
-})
diff --git a/cypress/e2e/plugins/1-available-plugins-tests/install-available-plugin.cypress.js b/cypress/e2e/plugins/1-available-plugins-tests/install-available-plugin.cypress.js
deleted file mode 100644
index 327f6a9c8c..0000000000
--- a/cypress/e2e/plugins/1-available-plugins-tests/install-available-plugin.cypress.js
+++ /dev/null
@@ -1,180 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { deleteFile, uninstallPlugin, installPlugin, restoreStarterFiles, log } = require('../../utils')
-const {
- failAction,
- performPluginAction,
- managePluginsPagePath,
- getTemplateLink,
- loadInstalledPluginsPage,
- loadPluginsPage,
- manageInstalledPluginsPagePath,
- initiatePluginAction,
- provePluginUpdated
-} = require('../plugin-utils')
-const { showHideAllLinkQuery, assertVisible, assertHidden } = require('../../step-by-step-utils')
-
-const appViews = path.join(Cypress.env('projectFolder'), 'app', 'views')
-const plugin = '@govuk-prototype-kit/step-by-step'
-const version1 = '1.0.0'
-const version2 = 'latest'
-const pluginName = 'Step By Step'
-const pluginPageTemplate = '/templates/step-by-step-navigation.html'
-const pluginPageTitle = 'Step by step navigation'
-const pluginPagePath = '/step-by-step-navigation'
-
-const provePluginFunctionalityWorks = () => {
- log(`Prove ${pluginName} functionality works`)
-
- cy.visit(pluginPagePath)
-
- // click toggle button and check that all steps details are visible
- cy.get(showHideAllLinkQuery).contains('Show all').click()
- assertVisible(1)
- assertVisible(2)
-
- // click toggle button and check that all steps details are hidden
- cy.get(showHideAllLinkQuery).contains('Hide all').click()
- assertHidden(1)
- assertHidden(2)
-}
-
-const provePluginFunctionalityFails = () => {
- cy.on('uncaught:exception', (err) => {
- console.log(err)
- // returning false here prevents Cypress from
- // failing a test when javascript in the browser fails
- return false
- })
-
- log(`Prove ${pluginName} functionality fails`)
-
- cy.visit(pluginPagePath)
-
- cy.get(showHideAllLinkQuery).should('not.exist')
-}
-
-describe('Management plugins: ', () => {
- afterEach(restoreStarterFiles)
-
- it('CSRF Protection on POST action', () => {
- // Load the plugins page, so we don't get any network errors when running the test
- loadPluginsPage()
- // Now run the test
- const installUrl = `${managePluginsPagePath}/install`
- log(`Posting to ${installUrl} without csrf protection`)
- cy.request({
- url: `${managePluginsPagePath}/install`,
- method: 'POST',
- failOnStatusCode: false,
- body: { package: plugin }
- }).then(response => {
- expect(response.status).to.eq(403)
- expect(response.body).to.have.property('error', 'invalid csrf token')
- })
- })
-
- it(`Update the ${plugin} plugin`, () => {
- log(`Install ${plugin}@${version1} directly`)
- uninstallPlugin(plugin)
-
- loadPluginsPage()
-
- cy.get('#plugins-updates-available-message').should('not.exist')
-
- cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(plugin)}&version=${version1}`)
-
- cy.get('#plugin-action-button').click()
-
- performPluginAction('install', plugin, pluginName)
-
- cy.get('#plugins-updates-available-message').contains('1 UPDATE AVAILABLE')
-
- // ------------------------
-
- log(`Update the ${plugin}@${version1} plugin to ${plugin}@${version2}`)
- installPlugin(plugin, version1)
-
- loadInstalledPluginsPage()
-
- log(`Update the ${plugin} plugin`)
- initiatePluginAction('update', plugin, pluginName)
- provePluginUpdated(plugin)
-
- cy.get('#plugins-updates-available-message').should('not.exist')
- })
-
- it(`Create a page using a template from the ${plugin} plugin`, () => {
- log('Install the plugin, create the page, and test the functionality')
- deleteFile(path.join(appViews, 'step-by-step-navigation.html'))
- installPlugin(plugin, version2)
-
- loadInstalledPluginsPage()
- cy.get('a[href*="/templates"]')
- .contains('Templates').click()
-
- cy.get('h2').contains(pluginName)
-
- // ------------------------
-
- log(`Create a new ${pluginPageTitle} page`)
-
- cy.get(`a[href="${getTemplateLink('install', '@govuk-prototype-kit/step-by-step', pluginPageTemplate)}"]`).click()
-
- // create step-by-step-navigation page
- cy.get('.govuk-heading-l')
- .contains(`Create new ${pluginPageTitle} page`)
- cy.get('#chosen-url')
- .type(pluginPagePath)
- cy.get('.govuk-button').contains('Create page').click()
-
- provePluginFunctionalityWorks()
-
- // ------------------------
-
- log(`Uninstall the ${plugin} plugin`)
-
- cy.visit(manageInstalledPluginsPagePath)
- initiatePluginAction('uninstall', plugin, pluginName)
-
- provePluginFunctionalityFails()
-
- // ------------------------
-
- log(`Reinstall the ${plugin} plugin`)
-
- cy.visit(managePluginsPagePath)
- initiatePluginAction('install', plugin, pluginName)
-
- provePluginFunctionalityWorks()
- })
-
- it('Get plugin page directly', () => {
- log('Pass when installing a plugin already installed')
- cy.task('waitUntilAppRestarts')
- log(`Simulate refreshing the install ${plugin} plugin confirmation page`)
- cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(plugin)}`)
-
- cy.get('#plugin-action-button').click()
-
- performPluginAction('install', plugin, pluginName)
-
- // ------------------------
-
- log('Fail when installing a non existent plugin')
- const pkg = 'invalid-prototype-kit-plugin'
- const invalidPluginName = 'Invalid Prototype Kit Plugin'
- cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(pkg)}`)
- cy.get('h2').contains(`Install ${invalidPluginName}`)
- failAction('install')
-
- // ------------------------
-
- log('Fail when installing a plugin with a non existent version')
- cy.visit(`${managePluginsPagePath}/install?package=${encodeURIComponent(plugin)}&version=0.0.1`)
- cy.get('h2').contains(`Install ${pluginName}`)
- failAction('install')
- })
-})
diff --git a/cypress/e2e/plugins/1-available-plugins-tests/install-common-templates-plugin-from-templates-page.cypress.js b/cypress/e2e/plugins/1-available-plugins-tests/install-common-templates-plugin-from-templates-page.cypress.js
deleted file mode 100644
index 50de2257a7..0000000000
--- a/cypress/e2e/plugins/1-available-plugins-tests/install-common-templates-plugin-from-templates-page.cypress.js
+++ /dev/null
@@ -1,33 +0,0 @@
-const { waitForApplication, uninstallPlugin, restoreStarterFiles } = require('../../utils')
-const { provePluginTemplatesInstalled } = require('../plugin-utils')
-
-const manageTemplatesPagePath = '/manage-prototype/templates'
-const panelCompleteQuery = '[aria-live="polite"] #panel-complete'
-const plugin = '@govuk-prototype-kit/common-templates'
-
-async function loadTemplatesPage () {
- cy.task('log', 'Visit the manage prototype templates page')
- await waitForApplication(manageTemplatesPagePath)
-}
-
-describe('Install common templates from templates page', () => {
- before(() => {
- uninstallPlugin(plugin)
- })
-
- after(restoreStarterFiles)
-
- it('install', () => {
- loadTemplatesPage()
- cy.get('a').contains('Install common templates').click()
-
- cy.get(panelCompleteQuery, { timeout: 20000 })
- .should('be.visible')
-
- cy.get('a').contains('Back to templates').click()
-
- provePluginTemplatesInstalled(plugin)
-
- cy.get('a.govuk-button').should('not.exist')
- })
-})
diff --git a/cypress/e2e/plugins/1-available-plugins-tests/preview-template-view.cypress.js b/cypress/e2e/plugins/1-available-plugins-tests/preview-template-view.cypress.js
deleted file mode 100644
index f7cb4e03fd..0000000000
--- a/cypress/e2e/plugins/1-available-plugins-tests/preview-template-view.cypress.js
+++ /dev/null
@@ -1,35 +0,0 @@
-// local dependencies
-const { installPlugin, waitForApplication, restoreStarterFiles, uninstallPlugin } = require('../../utils')
-const { showHideAllLinkQuery, assertVisible, assertHidden } = require('../../step-by-step-utils')
-const { manageTemplatesPagePath, getTemplateLink } = require('../plugin-utils')
-
-const plugin = '@govuk-prototype-kit/step-by-step'
-const pluginName = 'Step By Step'
-const pluginPageTemplate = '/templates/step-by-step-navigation.html'
-const pluginPageTitle = 'Step by step navigation'
-
-describe('Management plugins: ', () => {
- after(restoreStarterFiles)
-
- it(`Preview a ${plugin} template`, () => {
- cy.task('log', 'Visit the manage prototype plugins page')
- installPlugin(plugin, 'latest')
- waitForApplication(manageTemplatesPagePath)
-
- cy.get('h2').contains(pluginName)
-
- cy.task('log', `Preview the ${pluginPageTitle} template`)
-
- cy.get(`a[href="${getTemplateLink('view', '@govuk-prototype-kit/step-by-step', pluginPageTemplate)}"]`).click()
-
- cy.task('log', `Prove the ${pluginName} functionality works`)
-
- assertHidden(1)
- assertHidden(2)
- cy.get(showHideAllLinkQuery).contains('Show all').click()
- assertVisible(1)
- assertVisible(2)
-
- uninstallPlugin(plugin)
- })
-})
diff --git a/cypress/e2e/plugins/1-available-plugins-tests/view-template-with-default-layout.cypress.js b/cypress/e2e/plugins/1-available-plugins-tests/view-template-with-default-layout.cypress.js
deleted file mode 100644
index 8afda8069f..0000000000
--- a/cypress/e2e/plugins/1-available-plugins-tests/view-template-with-default-layout.cypress.js
+++ /dev/null
@@ -1,59 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, installPlugin, restoreStarterFiles } = require('../../utils')
-const { manageTemplatesPagePath, getTemplateLink } = require('../plugin-utils')
-
-const plugin = '@govuk-prototype-kit/step-by-step'
-const pluginPageTemplate = '/templates/step-by-step-navigation.html'
-const pluginPageTitle = 'Step by step navigation'
-
-const defaultLayoutFilePath = path.join('app', 'views', 'layouts', 'main.html')
-const backupLayoutComment = ''
-
-const comments = el => cy.wrap(
- [...el.childNodes]
- .filter(node => node.nodeName === '#comment')
- .map(commentNode => '')
-)
-
-describe('view template with default layout', () => {
- beforeEach(() => {
- installPlugin(plugin, 'latest')
- })
-
- afterEach(restoreStarterFiles)
-
- it('deleting default layout does not cause viewing a template to fail to render', () => {
- cy.task('log', 'Visit the manage prototype plugins page')
-
- waitForApplication(manageTemplatesPagePath)
- cy.visit(manageTemplatesPagePath)
-
- cy.task('log', `Preview the ${pluginPageTitle} template`)
-
- cy.get(`a[href="${getTemplateLink('view', '@govuk-prototype-kit/step-by-step', pluginPageTemplate)}"]`).click()
-
- cy.document().then(doc =>
- comments(doc.head).should('not.contain', backupLayoutComment)
- )
-
- cy.task('deleteFile', { filename: path.join(Cypress.env('projectFolder'), defaultLayoutFilePath) })
-
- waitForApplication(manageTemplatesPagePath)
- cy.visit(manageTemplatesPagePath)
-
- cy.task('log', `Preview the ${pluginPageTitle} template`)
-
- cy.get(`a[href="${getTemplateLink('view', '@govuk-prototype-kit/step-by-step', pluginPageTemplate)}"]`).click()
-
- cy.visit('/', { failOnStatusCode: false })
- cy.get('body').should('not.contains.text', 'Error: template not found')
-
- cy.document().then(doc => {
- cy.log('head content', doc.head.innerHTML)
- comments(doc.head).should('contain', backupLayoutComment)
- })
- })
-})
diff --git a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/allow-upgrade-in-url.cypress.js b/cypress/e2e/plugins/2-prototype-kit-plugin-tests/allow-upgrade-in-url.cypress.js
deleted file mode 100644
index 22e59cf9dd..0000000000
--- a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/allow-upgrade-in-url.cypress.js
+++ /dev/null
@@ -1,29 +0,0 @@
-const { replaceInFile, waitForApplication, restoreStarterFiles, log } = require('../../utils')
-const path = require('path')
-const { performPluginAction } = require('../plugin-utils')
-const plugin = '@govuk-prototype-kit/task-list'
-const pluginVersion = '1.1.1'
-const originalText = '"dependencies": {'
-const replacementText = `"dependencies": { "${plugin}": "${pluginVersion}",`
-const pkgJsonFile = path.join(Cypress.env('projectFolder'), 'package.json')
-
-describe('Allow upgrade in URLs', () => {
- after(restoreStarterFiles)
-
- it('When updating the old upgrade URL should still work', () => {
- waitForApplication()
-
- log(`Add an old version of ${plugin} within the package.json`)
- replaceInFile(pkgJsonFile, originalText, '', replacementText)
- cy.exec(`cd ${Cypress.env('projectFolder')} && npm install`)
-
- log('Make sure old upgrade URL still works')
- cy.visit(`/manage-prototype/plugins/upgrade?package=${encodeURIComponent(plugin)}`)
- cy.get('button#plugin-action-button')
- .contains('Update')
- .click()
-
- log('Force the plugins to be installed with an npm install')
- performPluginAction('update', plugin, 'Task List')
- })
-})
diff --git a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/handle-plugin-installation-mismatch.cypress.js b/cypress/e2e/plugins/2-prototype-kit-plugin-tests/handle-plugin-installation-mismatch.cypress.js
deleted file mode 100644
index 77d68fdb83..0000000000
--- a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/handle-plugin-installation-mismatch.cypress.js
+++ /dev/null
@@ -1,38 +0,0 @@
-const {
- replaceInFile,
- waitForApplication,
- restoreStarterFiles,
- log
-} = require('../../utils')
-const path = require('path')
-const {
- provePluginUninstalled,
- provePluginInstalledOldVersion
-} = require('../plugin-utils')
-const plugin = '@govuk-prototype-kit/task-list'
-const pluginVersion = '1.1.1'
-const originalText = '"dependencies": {'
-const replacementText = `"dependencies": { "${plugin}": "${pluginVersion}",`
-const pkgJsonFile = path.join(Cypress.env('projectFolder'), 'package.json')
-
-describe('Handle a plugin installation mismatch', () => {
- after(restoreStarterFiles)
-
- it('where the prototype package.json specifies a dependency that has not been installed', () => {
- waitForApplication()
-
- log(`Add ${plugin} to the dependencies within the package.json`)
- replaceInFile(pkgJsonFile, originalText, '', replacementText)
-
- log(`Make sure ${plugin} is displayed as not installed`)
- provePluginUninstalled(plugin)
-
- log('Force the plugins to be installed with an npm install')
- cy.exec(`cd ${Cypress.env('projectFolder')} && npm install`)
-
- log(`Make sure ${plugin} is displayed as installed`)
- waitForApplication()
-
- provePluginInstalledOldVersion(plugin)
- })
-})
diff --git a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/handle-plugin-update-when-a-dependency-is-now-required.cypress.js b/cypress/e2e/plugins/2-prototype-kit-plugin-tests/handle-plugin-update-when-a-dependency-is-now-required.cypress.js
deleted file mode 100644
index 2425f3561d..0000000000
--- a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/handle-plugin-update-when-a-dependency-is-now-required.cypress.js
+++ /dev/null
@@ -1,60 +0,0 @@
-import path from 'path'
-
-import {
- installPlugin,
- restoreStarterFiles,
- uninstallPlugin,
- waitForApplication
-} from '../../utils'
-
-import {
- initiatePluginAction,
- provePluginInstalled,
- provePluginUninstalled
-} from '../plugin-utils'
-
-const plugin = '@govuk-prototype-kit/common-templates'
-const pluginVersion = '1.1.1'
-const pluginsPage = '/manage-prototype/plugins'
-
-const dependencyPlugin = 'govuk-frontend'
-const dependencyPluginName = 'GOV.UK Frontend'
-
-const additionalScssPath = path.join(Cypress.env('projectFolder'), 'app', 'assets', 'sass', 'settings.scss')
-const additionalScssContents = `
-@mixin govuk-text-colour {
- color: black;
-}
-@mixin govuk-font($size, $weight: regular, $tabular: false, $line-height: false) {
- font-size: $size
-}
-@mixin govuk-media-query($from) {
- @media (min-width: $from) { @content; }
-}`
-
-describe('Handle a plugin update', () => {
- after(restoreStarterFiles)
-
- it('when a dependency is now required', () => {
- cy.task('createFile', { filename: additionalScssPath, data: additionalScssContents })
- installPlugin(plugin, pluginVersion)
- uninstallPlugin(dependencyPlugin)
-
- waitForApplication(pluginsPage)
-
- provePluginUninstalled(dependencyPlugin)
-
- initiatePluginAction('update', plugin, null, {
- confirmation: () => {
- cy.get('#plugin-action-confirmation')
- .find('ul')
- .contains(dependencyPluginName)
-
- cy.get('#plugin-action-button').click()
- }
- })
-
- provePluginInstalled(plugin)
- provePluginInstalled(dependencyPlugin, dependencyPluginName)
- })
-})
diff --git a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/prevent-uninstalling-kit-from-ui.cypress.js b/cypress/e2e/plugins/2-prototype-kit-plugin-tests/prevent-uninstalling-kit-from-ui.cypress.js
deleted file mode 100644
index ddae11b29c..0000000000
--- a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/prevent-uninstalling-kit-from-ui.cypress.js
+++ /dev/null
@@ -1,18 +0,0 @@
-// local dependencies
-const { failAction, managePluginsPagePath } = require('../plugin-utils')
-const { restoreStarterFiles } = require('../../utils')
-
-const plugin = 'govuk-prototype-kit'
-const pluginName = 'GOV.UK Prototype Kit'
-
-describe('Prevent uninstalling kit from ui', () => {
- after(restoreStarterFiles)
-
- it('Should fail', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit(`${managePluginsPagePath}/uninstall?package=${plugin}`)
- cy.get('h2')
- .contains(`Uninstall ${pluginName}`)
- failAction('uninstall')
- })
-})
diff --git a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/remove-govuk-frontend.cypress.js b/cypress/e2e/plugins/2-prototype-kit-plugin-tests/remove-govuk-frontend.cypress.js
deleted file mode 100644
index 872fe1987c..0000000000
--- a/cypress/e2e/plugins/2-prototype-kit-plugin-tests/remove-govuk-frontend.cypress.js
+++ /dev/null
@@ -1,53 +0,0 @@
-const {
- managePluginsPagePath,
- performPluginAction,
- provePluginInstalled,
- provePluginUninstalled,
- initiatePluginAction
-} = require('../plugin-utils')
-const { uninstallPlugin, restoreStarterFiles } = require('../../utils')
-
-const plugin = 'govuk-frontend'
-const pluginName = 'GOV.UK Frontend'
-const dependentPlugin = '@govuk-prototype-kit/common-templates'
-
-describe('Manage prototype pages without govuk-frontend', () => {
- afterEach(restoreStarterFiles)
-
- it('Uninstall govuk-frontend', () => {
- cy.task('addToConfigJson', { allowGovukFrontendUninstall: true })
-
- uninstallPlugin(dependentPlugin)
-
- cy.task('waitUntilAppRestarts')
- cy.visit(`${managePluginsPagePath}/uninstall?package=${plugin}`)
-
- cy.get('#plugin-action-button').contains('Uninstall').click()
-
- performPluginAction('uninstall', plugin, pluginName)
-
- cy.task('log', 'Make sure govuk-frontend is uninstalled')
-
- provePluginUninstalled(plugin)
-
- cy.task('log', 'Test home page')
- cy.get('a').contains('Home').click()
- cy.get('h1').contains('Manage your prototype')
-
- cy.task('log', 'Test templates page')
- cy.get('a').contains('Templates').click()
- cy.get('h1').contains('Templates')
-
- cy.task('log', 'Test plugins page')
- cy.get('a').contains('Plugins').click()
- cy.get('h1').contains('Plugins')
-
- cy.task('log', `Install the ${plugin} plugin`)
-
- initiatePluginAction('install', plugin, pluginName)
-
- cy.task('log', 'Make sure govuk-frontend is installed')
-
- provePluginInstalled(plugin, pluginName)
- })
-})
diff --git a/cypress/e2e/plugins/plugin-utils.js b/cypress/e2e/plugins/plugin-utils.js
deleted file mode 100644
index 8a8416ab16..0000000000
--- a/cypress/e2e/plugins/plugin-utils.js
+++ /dev/null
@@ -1,214 +0,0 @@
-// npm dependencies
-const { capitalize } = require('lodash')
-const { urlencode } = require('nunjucks/src/filters')
-const { waitForApplication } = require('../utils')
-
-const manageTemplatesPagePath = '/manage-prototype/templates'
-const managePluginsPagePath = '/manage-prototype/plugins'
-const manageInstalledPluginsPagePath = '/manage-prototype/plugins-installed'
-
-const panelProcessingQuery = '[aria-live="polite"] #panel-processing'
-const panelCompleteQuery = '[aria-live="polite"] #panel-complete'
-const panelErrorQuery = '[aria-live="polite"] #panel-error'
-
-function getTemplateLink (type, packageName, path) {
- const queryString = `?package=${urlencode(packageName)}&template=${urlencode(path)}`
- return `${manageTemplatesPagePath}/${type}${queryString}`
-}
-
-async function loadPluginsPage () {
- cy.task('log', 'Visit the manage prototype plugins page')
- await waitForApplication(managePluginsPagePath)
-}
-
-async function loadInstalledPluginsPage () {
- cy.task('log', 'Visit the manage prototype plugins page')
- await waitForApplication(manageInstalledPluginsPagePath)
-}
-
-async function loadTemplatesPage () {
- cy.task('log', 'Visit the manage prototype templates page')
- await waitForApplication(manageTemplatesPagePath)
-}
-
-function provePluginTemplatesInstalled (plugin) {
- cy.visit(manageTemplatesPagePath)
- cy.get(`[data-plugin-package-name="${plugin}"]`).should('exist')
-}
-
-function provePluginTemplatesUninstalled (plugin) {
- cy.visit(manageTemplatesPagePath)
- cy.get(`[data-plugin-package-name="${plugin}"]`).should('not.exist')
-}
-
-function initiatePluginAction (action, plugin, pluginName, options = {}) {
- if (action === 'install') {
- cy.visit(managePluginsPagePath)
- } else {
- cy.visit(manageInstalledPluginsPagePath)
- }
-
- if (pluginName) {
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .scrollIntoView()
- .find('h4')
- .contains(pluginName)
- }
-
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .scrollIntoView()
- .find('button')
- .contains(capitalize(action))
- .click()
-
- if (options.confirmation) {
- options.confirmation()
- }
-
- performPluginAction(action, plugin, pluginName)
-}
-
-function provePluginInstalled (plugin, pluginName) {
- cy.visit(managePluginsPagePath)
- if (pluginName) {
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .scrollIntoView()
- .find('h4')
- .contains(pluginName)
- }
-
- cy.get(`[data-plugin-package-name="${plugin}"] strong.govuk-tag`)
- .contains('Installed')
-
- cy.get('#installed-plugins-link').click()
-
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .should('exist')
-}
-
-function provePluginUninstalled (plugin, pluginName) {
- cy.visit(managePluginsPagePath)
- if (pluginName) {
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .scrollIntoView()
- .find('h4')
- .contains(pluginName)
- }
-
- cy.get(`[data-plugin-package-name="${plugin}"] strong.govuk-tag`)
- .should('not.exist')
-
- cy.get('#installed-plugins-link').click()
-
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .should('not.exist')
-}
-
-function provePluginUpdated (plugin, pluginName) {
- provePluginInstalled(plugin, pluginName)
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .scrollIntoView()
- .find('button')
- .contains(capitalize('update')).should('not.exist')
-}
-
-function provePluginInstalledOldVersion (plugin, pluginName) {
- cy.visit(managePluginsPagePath)
- if (pluginName) {
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .scrollIntoView()
- .find('h4')
- .contains(pluginName)
- }
-
- cy.get('#installed-plugins-link').click()
-
- cy.get(`[data-plugin-package-name="${plugin}"]`)
- .should('exist')
-}
-
-function performPluginAction (action, plugin, pluginName) {
- cy.task('log', `The ${plugin} plugin should be displayed`)
-
- if (pluginName) {
- cy.get('h2')
- .contains(pluginName)
- }
-
- const processingText = `${action === 'update' ? 'Updat' : action}ing ...`
-
- if (Cypress.env('skipPluginActionInterimStep') !== 'true') {
- cy.get(panelCompleteQuery, { timeout: 20000 })
- .should('not.be.visible')
- cy.get(panelErrorQuery)
- .should('not.be.visible')
- cy.get(panelProcessingQuery)
- .should('be.visible')
- .contains(capitalize(processingText))
- }
-
- cy.task('log', `The ${plugin} plugin is ${action === 'update' ? 'updat' : action}ing`)
-
- cy.get(panelProcessingQuery, { timeout: 20000 })
- .should('not.be.visible')
- cy.get(panelErrorQuery)
- .should('not.be.visible')
- cy.get(panelCompleteQuery)
- .should('be.visible')
- .contains(`${capitalize(action)} complete`)
-
- cy.task('log', `The ${plugin} plugin ${action} has completed`)
-
- cy.get('#instructions-complete a')
- .contains('Back to plugins')
- .click()
-
- cy.task('log', 'Returning to plugins page')
-
- cy.get('h1').contains('Plugins')
-}
-
-function failAction (action) {
- cy.get('#plugin-action-button').click()
-
- if (Cypress.env('skipPluginActionInterimStep') !== 'true') {
- cy.get(panelCompleteQuery, { timeout: 20000 })
- .should('not.be.visible')
- cy.get(panelErrorQuery)
- .should('not.be.visible')
- cy.get(panelProcessingQuery)
- .should('be.visible')
- .contains(`${capitalize(action === 'update' ? 'Updat' : action)}ing ...`)
- }
-
- cy.get(panelProcessingQuery, { timeout: 40000 })
- .should('not.be.visible')
- cy.get(panelCompleteQuery)
- .should('not.be.visible')
- cy.get(panelErrorQuery)
- .should('be.visible')
-
- cy.get(`${panelErrorQuery} .govuk-panel__title`)
- .contains(`There was a problem ${action === 'update' ? 'Updat' : action}ing`)
- cy.get(`${panelErrorQuery} a`)
- .contains('Please contact support')
-}
-
-module.exports = {
- managePluginsPagePath,
- manageInstalledPluginsPagePath,
- manageTemplatesPagePath,
- loadPluginsPage,
- loadInstalledPluginsPage,
- loadTemplatesPage,
- getTemplateLink,
- initiatePluginAction,
- performPluginAction,
- provePluginInstalled,
- provePluginUninstalled,
- provePluginUpdated,
- provePluginInstalledOldVersion,
- provePluginTemplatesInstalled,
- provePluginTemplatesUninstalled,
- failAction
-}
diff --git a/cypress/e2e/prod/1-home-page-tests/home-page-in-production.cypress.js b/cypress/e2e/prod/1-home-page-tests/home-page-in-production.cypress.js
deleted file mode 100644
index 9f51a6d3b9..0000000000
--- a/cypress/e2e/prod/1-home-page-tests/home-page-in-production.cypress.js
+++ /dev/null
@@ -1,13 +0,0 @@
-// local dependencies
-const { authenticate, restoreStarterFiles } = require('../../utils')
-
-describe('home page in production', () => {
- after(restoreStarterFiles)
-
- it('should load as expected', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/')
- authenticate()
- cy.get('h1').contains('Service name goes here')
- })
-})
diff --git a/cypress/e2e/prod/2-management-tests/management-not-available.cypress.js b/cypress/e2e/prod/2-management-tests/management-not-available.cypress.js
deleted file mode 100644
index 3a7b1e0841..0000000000
--- a/cypress/e2e/prod/2-management-tests/management-not-available.cypress.js
+++ /dev/null
@@ -1,56 +0,0 @@
-// local dependencies
-const { authenticate, restoreStarterFiles } = require('../../utils')
-
-describe('management not available', () => {
- after(restoreStarterFiles)
-
- it('when attempting to visit "/manage-prototype" page', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/manage-prototype')
- authenticate()
- cy.get('h1').should('contain.text', 'How to manage your prototype')
- })
-
- it('when attempting to visit "/manage-prototype/templates" page', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/manage-prototype/templates')
- authenticate()
- cy.get('h1').should('contain.text', 'How to manage your prototype')
- })
-
- it('when attempting to visit "/manage-prototype/plugins" page', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/manage-prototype/plugins')
- authenticate()
- cy.get('h1').should('contain.text', 'How to manage your prototype')
- })
-
- it('when attempting to visit "/manage-prototype/foo" page', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/manage-prototype/foo')
- authenticate()
- cy.get('h1').should('contain.text', 'How to manage your prototype')
- })
-
- it('manage prototype link should not exist on the home page', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/')
- authenticate()
- cy.get('main a[href="/manage-prototype"]').should('not.exist')
- })
-
- it('manage prototype link should not exist in the footer', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/')
- authenticate()
- cy.get('footer a[href="/manage-prototype"]').should('not.exist')
- })
-
- it('clear data link should exist in the footer and work correctly', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit('/')
- authenticate()
- cy.get('footer a[href="/manage-prototype/clear-data"]').should('contain.text', 'Clear data').click()
- cy.get('h1').should('contain.text', 'Clear session data')
- })
-})
diff --git a/cypress/e2e/prod/2-management-tests/password-page.cypress.js b/cypress/e2e/prod/2-management-tests/password-page.cypress.js
deleted file mode 100644
index 19b8755576..0000000000
--- a/cypress/e2e/prod/2-management-tests/password-page.cypress.js
+++ /dev/null
@@ -1,53 +0,0 @@
-const { restoreStarterFiles, log } = require('../../utils')
-const homePath = '/index'
-const passwordPath = '/manage-prototype/password'
-const errorQuery = 'error=wrong-password'
-const returnURLQuery = `returnURL=${encodeURIComponent(homePath)}`
-const additionalPasswords = Cypress.env('additionalPasswords') || []
-
-describe('password page', () => {
- after(restoreStarterFiles)
-
- it('valid password', () => {
- const password = Cypress.env('password')
- cy.task('waitUntilAppRestarts')
- cy.visit(homePath)
- cy.url().then(passwordUrl => {
- const urlObject = new URL(passwordUrl)
- expect(passwordUrl).equal(`${urlObject.origin + passwordPath}?${returnURLQuery}`)
- log(`Authenticating with ${password}`)
- cy.get('input#password').type(password)
- cy.get('form').submit()
- cy.url().should('eq', urlObject.origin + homePath)
- })
- })
-
- it('invalid password', () => {
- cy.task('waitUntilAppRestarts')
- cy.visit(homePath)
- cy.url().then(passwordUrl => {
- const urlObject = new URL(passwordUrl)
- expect(passwordUrl).equal(`${urlObject.origin + passwordPath}?${returnURLQuery}`)
- cy.get('input#password').type('invalid')
- cy.get('form').submit()
- cy.get('.govuk-error-summary__list').contains('The password is not correct')
- cy.get('#password-error').contains('The password is not correct')
- cy.url().should('eq', `${urlObject.origin + passwordPath}?${errorQuery}&${returnURLQuery}`)
- })
- })
-
- additionalPasswords.map(password =>
- it(`valid additional password "${password}"`, () => {
- cy.task('waitUntilAppRestarts')
- cy.visit(homePath)
- cy.url().then(passwordUrl => {
- const urlObject = new URL(passwordUrl)
- expect(passwordUrl).equal(`${urlObject.origin + passwordPath}?${returnURLQuery}`)
- log(`Authenticating with ${password}`)
- cy.get('input#password').type(password)
- cy.get('form').submit()
- cy.url().should('eq', urlObject.origin + homePath)
- })
- })
- )
-})
diff --git a/cypress/e2e/smoke/0-smoke-tests/index-page.cypress.js b/cypress/e2e/smoke/0-smoke-tests/index-page.cypress.js
deleted file mode 100644
index 1d5c2e8628..0000000000
--- a/cypress/e2e/smoke/0-smoke-tests/index-page.cypress.js
+++ /dev/null
@@ -1,25 +0,0 @@
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-describe('smoke test', () => {
- after(restoreStarterFiles)
-
- it('index page', () => {
- waitForApplication('/')
- cy.get('h2').contains('GOV.UK Prototype Kit')
- })
-
- it('GOV.UK Frontend fonts loaded', () => {
- waitForApplication('/manage-prototype')
-
- const fontUrl = '/manage-prototype/dependencies/govuk-frontend/dist/govuk/assets/fonts/bold-b542beb274-v2.woff2'
-
- cy.task('log', 'Requesting govuk-frontend font')
- cy.request(`/${fontUrl}`, { retryOnStatusCodeFailure: true })
- .then(response => expect(response.status).to.eq(200))
-
- cy.task('log', 'Check page has loaded fonts successfully')
- cy.document()
- .invoke('fonts.check', '16px GDS Transport')
- .should('be.true')
- })
-})
diff --git a/cypress/e2e/step-by-step-utils.js b/cypress/e2e/step-by-step-utils.js
deleted file mode 100644
index 81748d3a5a..0000000000
--- a/cypress/e2e/step-by-step-utils.js
+++ /dev/null
@@ -1,24 +0,0 @@
-const showHideAllLinkQuery = '.app-step-nav__controls button'
-const toggleButtonQuery = (step) => `[data-position="${step}"]`
-const showHideLinkQuery = (step) => `[data-position="${step}"]`
-const panelQuery = (step) => `[data-position="${step}.1"]`
-const titleQuery = (step) => `[data-position="${step}"] .js-step-title-text`
-
-const assertVisible = (step) => {
- cy.get(showHideLinkQuery(step)).contains('Hide')
- cy.get(panelQuery(step)).should('be.visible')
-}
-
-const assertHidden = (step) => {
- cy.get(panelQuery(step)).should('not.be.visible')
- cy.get(showHideLinkQuery(step)).contains('Show')
-}
-
-module.exports = {
- showHideAllLinkQuery,
- toggleButtonQuery,
- showHideLinkQuery,
- titleQuery,
- assertVisible,
- assertHidden
-}
diff --git a/cypress/e2e/styles/1-watch-styles/watch-custom-styles.cypress.js b/cypress/e2e/styles/1-watch-styles/watch-custom-styles.cypress.js
deleted file mode 100644
index 8996acd2e8..0000000000
--- a/cypress/e2e/styles/1-watch-styles/watch-custom-styles.cypress.js
+++ /dev/null
@@ -1,63 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const customStylesFixture = 'custom-styles'
-const customStylesFixtureName = `${customStylesFixture}.scss`
-const customStylesFixturePath = path.join(Cypress.config('fixturesFolder'), 'sass', customStylesFixtureName)
-const customStylesAppPath = path.join(Cypress.env('projectFolder'), 'app', 'assets', 'sass', customStylesFixtureName)
-const customStylesPublicPath = 'public/stylesheets/custom-styles.css'
-
-const pageFixture = 'custom-styles'
-const pageFixtureName = `${pageFixture}.html`
-const pageFixturePath = path.join(Cypress.config('fixturesFolder'), 'views', pageFixtureName)
-const pageAppPath = path.join(Cypress.env('projectFolder'), 'app', 'views', pageFixtureName)
-
-describe('watch custom sass files', () => {
- describe(`sass file ${customStylesFixtureName} should be created and linked within ${pageFixturePath} and accessible from the browser as /${customStylesPublicPath}`, () => {
- afterEach(restoreStarterFiles)
-
- it('The colour of the paragraph should be changed to green', () => {
- waitForApplication()
- cy.visit('/')
-
- // FIXME: the expected behaviour is that it shouldn't make a difference
- // whether the stylesheet exists or not, but currently for Browsersync to
- // update the page properly the stylesheet has to be created first, so we
- // create an empty one. See issue #1440 for more details.
- cy.task('log', 'Create an empty custom stylesheet')
- cy.task('createFile', { filename: customStylesAppPath, data: '// Custom styles\n' })
-
- cy.task('log', 'Create a page to view our custom styles')
- cy.task('copyFile', {
- source: pageFixturePath,
- target: pageAppPath
- })
-
- cy.task('log', 'The colour of the paragraph should be black')
- cy.visit(`/${pageFixture}`)
- cy.get('p.app-custom-style').should('have.css', 'background-color', 'rgba(0, 0, 0, 0)')
-
- cy.task('log', `Create ${customStylesAppPath}`)
- cy.task('copyFile', {
- source: customStylesFixturePath,
- target: customStylesAppPath
- })
-
- // When we add our stylesheet, we expect Browsersync to detect that and
- // tell the browser to fetch it, so let's wait for that resource to
- // become available.
- cy.task('log', 'Wait for the stylesheet to be loaded')
- cy.waitForResource(`${customStylesFixture}.css`)
-
- cy.task('log', 'The colour of the paragraph should be changed to green')
- cy.get('p.app-custom-style').should('have.css', 'background-color', 'rgb(0, 255, 0)')
-
- cy.task('log', `Request ${customStylesPublicPath}`)
- cy.request(`/${customStylesPublicPath}`, { retryOnNetworkFailure: true, timeout: 4000 })
- .then(response => expect(response.status).to.eq(200))
- })
- })
-})
diff --git a/cypress/e2e/styles/1-watch-styles/watch-settings-styles.cypress.js b/cypress/e2e/styles/1-watch-styles/watch-settings-styles.cypress.js
deleted file mode 100644
index 6caba07cdb..0000000000
--- a/cypress/e2e/styles/1-watch-styles/watch-settings-styles.cypress.js
+++ /dev/null
@@ -1,48 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, createFile, deleteFile, replaceInFile, restoreStarterFiles } = require('../../utils')
-
-const appStylesPath = path.join('app', 'assets', 'sass')
-const appStylesFolder = path.join(Cypress.env('projectFolder'), appStylesPath)
-
-const settingsStyle = path.join(appStylesFolder, 'settings.scss')
-
-const RED = 'rgb(255, 0, 0)'
-const GREEN = 'rgb(0, 255, 0)'
-
-const settingsContent = `$govuk-brand-colour: ${RED}`
-const changedSettingsContent = `$govuk-brand-colour: ${GREEN}`
-
-describe('watching settings.scss', () => {
- afterEach(restoreStarterFiles)
-
- it('Successfully reload settings changes', () => {
- waitForApplication()
-
- cy.task('log', 'The colour of the header bottom border should be as designed')
- cy.get('.govuk-header__container').should('not.have.css', 'border-bottom-color', RED)
-
- createFile(settingsStyle, { data: settingsContent })
-
- waitForApplication()
-
- cy.task('log', 'The colour of the header bottom border should be changed to red')
- cy.get('.govuk-header__container').should('have.css', 'border-bottom-color', RED)
-
- replaceInFile(settingsStyle, settingsContent, '', changedSettingsContent)
-
- waitForApplication()
-
- cy.task('log', 'The colour of the header bottom border should be changed to green')
- cy.get('.govuk-header__container').should('have.css', 'border-bottom-color', GREEN)
-
- deleteFile(settingsStyle)
-
- waitForApplication()
-
- cy.task('log', 'The colour of the header bottom border should be as designed')
- cy.get('.govuk-header__container').should('not.have.css', 'border-bottom-color', GREEN)
- })
-})
diff --git a/cypress/e2e/styles/1-watch-styles/watch-styles.cypress.js b/cypress/e2e/styles/1-watch-styles/watch-styles.cypress.js
deleted file mode 100644
index df30e2a796..0000000000
--- a/cypress/e2e/styles/1-watch-styles/watch-styles.cypress.js
+++ /dev/null
@@ -1,51 +0,0 @@
-// core dependencies
-const path = require('path')
-
-// local dependencies
-const { waitForApplication, restoreStarterFiles } = require('../../utils')
-
-const appStylesPath = path.join('app', 'assets', 'sass')
-const appStylesheetPath = path.join(appStylesPath, 'application.scss')
-const appStylesFolder = path.join(Cypress.env('projectFolder'), appStylesPath)
-const appStylesheet = path.join(Cypress.env('projectFolder'), appStylesheetPath)
-
-const cypressTestStyles = 'cypress-test'
-const cypressTestStylePattern = path.join(appStylesFolder, 'patterns', `_${cypressTestStyles}.scss`)
-const publicStylesheet = 'public/stylesheets/application.css'
-
-const RED = 'rgb(255, 0, 0)'
-const BLACK = 'rgb(11, 12, 12)'
-
-describe('watch sass files', () => {
- describe(`sass file ${cypressTestStylePattern} should be created and included within the ${appStylesheet} and accessible from the browser as /${publicStylesheet}`, () => {
- const cssStatement = `
- .govuk-header { background: red; }
- `
-
- afterEach(restoreStarterFiles)
-
- it('The colour of the header should be changed to red then back to black', () => {
- waitForApplication()
-
- cy.task('log', 'The colour of the header should be black')
- cy.get('.govuk-header').should('have.css', 'background-color', BLACK)
-
- cy.task('log', `Create ${cypressTestStylePattern}`)
- cy.task('createFile', {
- filename: cypressTestStylePattern,
- data: cssStatement
- })
-
- cy.task('log', `Amend ${appStylesheet} to import ${cypressTestStyles}`)
- cy.task('appendFile', {
- filename: appStylesheet,
- data: `
- @import "patterns/${cypressTestStyles}";
- `
- })
-
- cy.task('log', 'The colour of the header should be changed to red')
- cy.get('.govuk-header').should('have.css', 'background-color', RED)
- })
- })
-})
diff --git a/cypress/e2e/utils.js b/cypress/e2e/utils.js
deleted file mode 100644
index 04ae35eead..0000000000
--- a/cypress/e2e/utils.js
+++ /dev/null
@@ -1,76 +0,0 @@
-const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
-
-const log = (message) => cy.task('log', message)
-
-const authenticate = () => {
- const password = Cypress.env('password')
- if (password) {
- log(`Authenticating with ${password}`)
- cy.get('input#password').type(password)
- cy.get('form').submit()
- }
-}
-
-const waitForApplication = async (path = '/index') => {
- log(`Waiting for app to restart and load ${path} page`)
- cy.task('waitUntilAppRestarts')
- cy.visit(path)
- cy.get('.govuk-header__logotype')
- .contains('GOV.UK')
-}
-
-const copyFile = (source, target) => {
- log(`Copy ${source} to ${target}`)
- cy.task('copyFile', { source, target })
-}
-
-const deleteFile = (filename) => {
- log(`Delete ${filename}`)
- cy.task('deleteFile', { filename })
-}
-
-const createFile = (filename, options) => {
- log(`Create ${filename}`)
- cy.task('createFile', { filename, ...options })
-}
-
-const replaceInFile = (filename, originalText, source, newText) => {
- cy.task('replaceTextInFile', { filename, originalText, source, newText })
-}
-
-const restoreStarterFiles = () => {
- cy.task('restoreStarterFiles')
-}
-
-function uninstallPlugin (plugin) {
- log(`Uninstalling ${plugin}`)
- cy.exec(`cd ${Cypress.env('projectFolder')} && npm uninstall ${plugin}`)
- cy.task('pluginUninstalled', { plugin, timeout: 15000 })
-}
-
-function installPlugin (plugin, version = '') {
- if (version) {
- version = '@' + version
- }
- log(`Installing ${plugin}${version}`)
- cy.exec(`cd ${Cypress.env('projectFolder')} && npm install ${plugin}${version} --save-exact `)
- if (plugin.startsWith('file:')) {
- plugin = plugin.substring(plugin.lastIndexOf('/') + 1)
- }
- log(`Waiting for ${plugin}${version} to be installed`)
- cy.task('pluginInstalled', { plugin, version, timeout: 15000 })
-}
-
-module.exports = {
- authenticate,
- sleep,
- log,
- waitForApplication,
- copyFile,
- deleteFile,
- createFile,
- replaceInFile,
- installPlugin,
- uninstallPlugin,
- restoreStarterFiles
-}
diff --git a/cypress/events/index.js b/cypress/events/index.js
deleted file mode 100644
index 2161b7d4c7..0000000000
--- a/cypress/events/index.js
+++ /dev/null
@@ -1,385 +0,0 @@
-/// Plugin Bar
diff --git a/cypress/fixtures/plugins/plugin-baz/filters.js b/cypress/fixtures/plugins/plugin-baz/filters.js deleted file mode 100644 index de7e7af043..0000000000 --- a/cypress/fixtures/plugins/plugin-baz/filters.js +++ /dev/null @@ -1,6 +0,0 @@ -// local dependencies -const { addFilter } = require('govuk-prototype-kit').views - -addFilter('baz__link', - (content, url) => `${content}`, - { renderAsHtml: true }) diff --git a/cypress/fixtures/plugins/plugin-baz/govuk-prototype-kit.config.json b/cypress/fixtures/plugins/plugin-baz/govuk-prototype-kit.config.json deleted file mode 100644 index c31f235a68..0000000000 --- a/cypress/fixtures/plugins/plugin-baz/govuk-prototype-kit.config.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "nunjucksFilters": "/filters.js", - "nunjucksPaths": "/views", - "scripts": "/scripts/baz.js", - "sass": "/sass/baz.scss" -} diff --git a/cypress/fixtures/plugins/plugin-baz/package.json b/cypress/fixtures/plugins/plugin-baz/package.json deleted file mode 100644 index a82a10fde4..0000000000 --- a/cypress/fixtures/plugins/plugin-baz/package.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "name": "plugin-baz", - "version": "1.0.0", - "dependencies": { - "govuk-prototype-kit": "file:../../../.." - } -} diff --git a/cypress/fixtures/plugins/plugin-baz/sass/baz.scss b/cypress/fixtures/plugins/plugin-baz/sass/baz.scss deleted file mode 100644 index 960759381a..0000000000 --- a/cypress/fixtures/plugins/plugin-baz/sass/baz.scss +++ /dev/null @@ -1,8 +0,0 @@ -.plugin-baz { - border: rgb(0, 255, 255) solid 10px; - background: rgb(255, 0, 255); - &.plugin-baz-clicked { - border: rgb(255, 0, 255) solid 10px;; - background: rgb(0, 255, 255); - } -} \ No newline at end of file diff --git a/cypress/fixtures/plugins/plugin-baz/scripts/baz.js b/cypress/fixtures/plugins/plugin-baz/scripts/baz.js deleted file mode 100644 index abaa61e2f8..0000000000 --- a/cypress/fixtures/plugins/plugin-baz/scripts/baz.js +++ /dev/null @@ -1,19 +0,0 @@ -window.BAZ = window.BAZ || {} -window.BAZ.Modules = window.BAZ.Modules || {}; - -((Modules) => { - class PluginBaz { - constructor (query) { - console.log('Instantiate Plugin Baz') - const baz = document.querySelector(query) - baz.classList.add('plugin-baz') - baz.addEventListener('click', () => this.onClick(baz)) - } - - onClick (baz) { - baz.classList.add('plugin-baz-clicked') - } - } - - Modules.PluginBaz = PluginBaz -})(window.BAZ.Modules) diff --git a/cypress/fixtures/plugins/plugin-baz/views/baz.njk b/cypress/fixtures/plugins/plugin-baz/views/baz.njk deleted file mode 100644 index 92c3ecd1a1..0000000000 --- a/cypress/fixtures/plugins/plugin-baz/views/baz.njk +++ /dev/null @@ -1 +0,0 @@ -Plugin Baz
diff --git a/cypress/fixtures/plugins/plugin-fee/govuk-prototype-kit.config.json b/cypress/fixtures/plugins/plugin-fee/govuk-prototype-kit.config.json deleted file mode 100644 index d08deab419..0000000000 --- a/cypress/fixtures/plugins/plugin-fee/govuk-prototype-kit.config.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "templates": [ - { - "name": "Plugin Fee page", - "path": "/templates/fee.njk", - "type": "nunjucks" - } - ], - "sass": "/sass/fee.scss", - "pluginDependencies": [{ - "packageName": "govuk-frontend", - "minVersion": "4.5.0" - }] -} diff --git a/cypress/fixtures/plugins/plugin-fee/package.json b/cypress/fixtures/plugins/plugin-fee/package.json deleted file mode 100644 index 8cd96be3f3..0000000000 --- a/cypress/fixtures/plugins/plugin-fee/package.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "name": "plugin-fee", - "version": "1.0.0", - "dependencies": { - "govuk-prototype-kit": "file:../../../.." - } -} diff --git a/cypress/fixtures/plugins/plugin-fee/sass/fee.scss b/cypress/fixtures/plugins/plugin-fee/sass/fee.scss deleted file mode 100644 index 4b2b144f81..0000000000 --- a/cypress/fixtures/plugins/plugin-fee/sass/fee.scss +++ /dev/null @@ -1,4 +0,0 @@ -.plugin-fee-paragraph { - background: #d4351c; - color: #ffdd00; -} \ No newline at end of file diff --git a/cypress/fixtures/plugins/plugin-fee/templates/fee.njk b/cypress/fixtures/plugins/plugin-fee/templates/fee.njk deleted file mode 100644 index 376fd00812..0000000000 --- a/cypress/fixtures/plugins/plugin-fee/templates/fee.njk +++ /dev/null @@ -1,10 +0,0 @@ -{% extends "layouts/main.html" %} - -{% block pageTitle %} - GOV.UK page template – {{ serviceName }} – GOV.UK Prototype Kit -{% endblock %} - -{% block content %} -Plugin fee styled paragraph
- -{% endblock %} diff --git a/cypress/fixtures/plugins/plugin-foo/filters.js b/cypress/fixtures/plugins/plugin-foo/filters.js deleted file mode 100644 index 268fa9ce6f..0000000000 --- a/cypress/fixtures/plugins/plugin-foo/filters.js +++ /dev/null @@ -1,2 +0,0 @@ -const { addFilter } = require('govuk-prototype-kit').views -addFilter('foo__strong', (content) => `${content}`, { renderAsHtml: true }) diff --git a/cypress/fixtures/plugins/plugin-foo/functions.js b/cypress/fixtures/plugins/plugin-foo/functions.js deleted file mode 100644 index 1ba0031835..0000000000 --- a/cypress/fixtures/plugins/plugin-foo/functions.js +++ /dev/null @@ -1,2 +0,0 @@ -const { addFunction } = require('govuk-prototype-kit').views -addFunction('fooEmphasize', (content) => `${content}`, { renderAsHtml: true }) diff --git a/cypress/fixtures/plugins/plugin-foo/govuk-prototype-kit.config.json b/cypress/fixtures/plugins/plugin-foo/govuk-prototype-kit.config.json deleted file mode 100644 index c99b343e55..0000000000 --- a/cypress/fixtures/plugins/plugin-foo/govuk-prototype-kit.config.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "assets": [ - "/scripts" - ], - "nunjucksFilters": [ - "/filters.js" - ], - "nunjucksFunctions": [ - "/functions.js" - ], - "nunjucksPaths": [ - "/views", - "/macros" - ], - "scripts": [ - "/scripts/foo.js", - { - "path": "/scripts/foo-module.js", - "type": "module" - } - ], - "sass": [ - "/sass/foo.scss" - ], - "nunjucksMacros": [ - { - "importFrom": "foo-field.njk", - "macroName": "fooField" - } - ] -} diff --git a/cypress/fixtures/plugins/plugin-foo/macros/foo-field.html b/cypress/fixtures/plugins/plugin-foo/macros/foo-field.html deleted file mode 100644 index da01c348bd..0000000000 --- a/cypress/fixtures/plugins/plugin-foo/macros/foo-field.html +++ /dev/null @@ -1,6 +0,0 @@ -{% macro fooField(name, value='', type='text') %} -
-
-
-{% endmacro %}
\ No newline at end of file
diff --git a/cypress/fixtures/plugins/plugin-foo/package.json b/cypress/fixtures/plugins/plugin-foo/package.json
deleted file mode 100644
index 22686c3c61..0000000000
--- a/cypress/fixtures/plugins/plugin-foo/package.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "name": "plugin-foo",
- "version": "1.0.0",
- "dependencies": {
- "govuk-prototype-kit": "file:../../../.."
- }
-}
diff --git a/cypress/fixtures/plugins/plugin-foo/sass/foo.scss b/cypress/fixtures/plugins/plugin-foo/sass/foo.scss
deleted file mode 100644
index e122853b82..0000000000
--- a/cypress/fixtures/plugins/plugin-foo/sass/foo.scss
+++ /dev/null
@@ -1,7 +0,0 @@
-.plugin-foo {
- border: rgb(255, 255, 255) solid 10px;
- background: rgb(255, 255, 0);
- &.plugin-foo-clicked {
- background: rgb(0, 0, 255);
- }
-}
diff --git a/cypress/fixtures/plugins/plugin-foo/scripts/foo-module.js b/cypress/fixtures/plugins/plugin-foo/scripts/foo-module.js
deleted file mode 100644
index 30eb13cb46..0000000000
--- a/cypress/fixtures/plugins/plugin-foo/scripts/foo-module.js
+++ /dev/null
@@ -1,10 +0,0 @@
-import fooSubmodule from './foo-submodule.js'
-
-const fooParagraph = document.getElementById('foo-module')
-
-if (fooParagraph) {
- fooParagraph.hidden = false
- setTimeout(() => {
- fooParagraph.innerHTML = 'The foo result is: ' + fooSubmodule(1, 2)
- }, 500)
-}
diff --git a/cypress/fixtures/plugins/plugin-foo/scripts/foo-submodule.js b/cypress/fixtures/plugins/plugin-foo/scripts/foo-submodule.js
deleted file mode 100644
index 6fb4511de2..0000000000
--- a/cypress/fixtures/plugins/plugin-foo/scripts/foo-submodule.js
+++ /dev/null
@@ -1,3 +0,0 @@
-export default function fooSubmodule (x, y) {
- return x + y
-}
diff --git a/cypress/fixtures/plugins/plugin-foo/scripts/foo.js b/cypress/fixtures/plugins/plugin-foo/scripts/foo.js
deleted file mode 100644
index 612814c04c..0000000000
--- a/cypress/fixtures/plugins/plugin-foo/scripts/foo.js
+++ /dev/null
@@ -1,19 +0,0 @@
-window.FOO = window.FOO || {}
-window.FOO.Modules = window.FOO.Modules || {};
-
-((Modules) => {
- class PluginFoo {
- constructor (query) {
- console.log('Instantiate Plugin Foo')
- const foo = document.querySelector(query)
- foo.classList.add('plugin-foo')
- foo.addEventListener('click', () => this.onClick(foo))
- }
-
- onClick (foo) {
- foo.classList.add('plugin-foo-clicked')
- }
- }
-
- Modules.PluginFoo = PluginFoo
-})(window.FOO.Modules)
diff --git a/cypress/fixtures/plugins/plugin-foo/views/foo.njk b/cypress/fixtures/plugins/plugin-foo/views/foo.njk
deleted file mode 100644
index 472b286b61..0000000000
--- a/cypress/fixtures/plugins/plugin-foo/views/foo.njk
+++ /dev/null
@@ -1,2 +0,0 @@
-Plugin Foo
-calculating
diff --git a/cypress/fixtures/routes.js b/cypress/fixtures/routes.js deleted file mode 100644 index 774790a2db..0000000000 --- a/cypress/fixtures/routes.js +++ /dev/null @@ -1,23 +0,0 @@ -const router = require('govuk-prototype-kit').requests.setupRouter() - -router.get('/cypress-test', (req, res) => { - const heading = 'CYPRESS TEST PAGE' - res.send(` - - -${heading}
- - -`) -}) - -router.get('/error', (req, res, next) => { - next(new Error('test error')) -}) - -router.get('/test-page', (req, res, next) => { - res.render('test-page.html') -}) diff --git a/cypress/fixtures/sass/broken-styles.scss b/cypress/fixtures/sass/broken-styles.scss deleted file mode 100644 index 642992b10d..0000000000 --- a/cypress/fixtures/sass/broken-styles.scss +++ /dev/null @@ -1,5 +0,0 @@ -// Broken styles - -.broken-style { - color red -} diff --git a/cypress/fixtures/sass/custom-styles.scss b/cypress/fixtures/sass/custom-styles.scss deleted file mode 100644 index 5c6dd5bf89..0000000000 --- a/cypress/fixtures/sass/custom-styles.scss +++ /dev/null @@ -1,2 +0,0 @@ -// Custom styles -.app-custom-style { background: rgb(0, 255, 0); } diff --git a/cypress/fixtures/views/checkbox-test.html b/cypress/fixtures/views/checkbox-test.html deleted file mode 100644 index 7ceb841abc..0000000000 --- a/cypress/fixtures/views/checkbox-test.html +++ /dev/null @@ -1,48 +0,0 @@ -{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %} -{% from "govuk/components/checkboxes/macro.njk" import govukCheckboxes %} - -{% block content %} - -Checkbox tests
- -
-
-{% endblock %}
diff --git a/cypress/fixtures/views/confirmation.html b/cypress/fixtures/views/confirmation.html
deleted file mode 100644
index 5de7aeb2a3..0000000000
--- a/cypress/fixtures/views/confirmation.html
+++ /dev/null
@@ -1,13 +0,0 @@
-{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}
-
-{% block pageTitle %}
- Confirmation page template – {{ serviceName }} – GOV.UK Prototype Kit
-{% endblock %}
-
-{% block content %}
-
-
-
-
-
-
-
-
-
-{% endblock %}
diff --git a/cypress/fixtures/views/content.html b/cypress/fixtures/views/content.html
deleted file mode 100644
index 7aec81ab90..0000000000
--- a/cypress/fixtures/views/content.html
+++ /dev/null
@@ -1,27 +0,0 @@
-{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}
-
-{% block pageTitle %}
- Content page template – {{ serviceName }} – GOV.UK Prototype Kit
-{% endblock %}
-
-{% block beforeContent %}
- Back
-{% endblock %}
-
-{% block content %}
-
- Application complete
-
-
-
-{% endblock %}
diff --git a/cypress/fixtures/views/custom-styles.html b/cypress/fixtures/views/custom-styles.html
deleted file mode 100644
index ec50f5aa2d..0000000000
--- a/cypress/fixtures/views/custom-styles.html
+++ /dev/null
@@ -1,14 +0,0 @@
-{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}
-
-{% block stylesheets %}
- {{ super() }}
-
-{% endblock stylesheets %}
-
-{% block pageTitle %}
- Custom styles – {{ serviceName }} – GOV.UK Prototype Kit
-{% endblock %}
-
-{% block content %}
-
-
-
- - Heading goes here -
- -This is a paragraph of text. It explains in more detail what has happened and wraps across several lines.
- -Read more about this topic.
- -This is a paragraph of text. It has a custom style.
-{% endblock %} diff --git a/cypress/fixtures/views/juggling-check-answers.html b/cypress/fixtures/views/juggling-check-answers.html deleted file mode 100644 index aee7ca9d57..0000000000 --- a/cypress/fixtures/views/juggling-check-answers.html +++ /dev/null @@ -1,58 +0,0 @@ -{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %} - -{% block pageTitle %} - Check your answers template – {{ serviceName }} – GOV.UK Prototype Kit -{% endblock %} - -{% block beforeContent %} - Back -{% endblock %} - -{% block content %} -
-
-{% endblock %}
diff --git a/cypress/fixtures/views/larry-the-cat.html b/cypress/fixtures/views/larry-the-cat.html
deleted file mode 100644
index 9f977bca9b..0000000000
--- a/cypress/fixtures/views/larry-the-cat.html
+++ /dev/null
@@ -1,9 +0,0 @@
-{% extends "layouts/main.html" %}
-
-{% block pageTitle %}
- Larry the cat – {{ serviceName }} – GOV.UK Prototype Kit
-{% endblock %}
-
-{% block content %}
-
-
-
- Check your answers before sending your application
- -Personal details
- --
-
- - Number of balls you can juggle - -
- - {{ data['how-many-balls'] }} - -
- - - Change - number of balls you can juggle - - -
- - Your most impressive juggling trick - -
- - {{ data['most-impressive-trick'] }} - -
- - - Change - your most impressive juggling trick - - -
-
-
-
- 
-{% endblock %}
diff --git a/cypress/fixtures/views/question.html b/cypress/fixtures/views/question.html
deleted file mode 100644
index d0051fb852..0000000000
--- a/cypress/fixtures/views/question.html
+++ /dev/null
@@ -1,31 +0,0 @@
-{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}
-
-{% block pageTitle %}
- Question page template – {{ serviceName }} – GOV.UK Prototype Kit
-{% endblock %}
-
-{% block beforeContent %}
- Back
-{% endblock %}
-
-{% block content %}
-
-
-
-
-{% endblock %}
diff --git a/cypress/fixtures/views/start-with-step-by-step.html b/cypress/fixtures/views/start-with-step-by-step.html
deleted file mode 100644
index 17998b9f90..0000000000
--- a/cypress/fixtures/views/start-with-step-by-step.html
+++ /dev/null
@@ -1,60 +0,0 @@
-{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}
-
-{% from "govuk/components/header/macro.njk" import govukHeader %}
-
-{% block beforeContent %}
-
-
-
- Heading or question goes here
- - - -
- Part of
-
- Learn to drive a car: step by step
-
-
-{% endblock %}
-
-{% block content %}
- - Check what age you can drive -
- - -{% endblock %} diff --git a/cypress/fixtures/views/start.html b/cypress/fixtures/views/start.html deleted file mode 100644 index fe98923c8a..0000000000 --- a/cypress/fixtures/views/start.html +++ /dev/null @@ -1,23 +0,0 @@ -{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %} -{% from "govuk/components/header/macro.njk" import govukHeader %} - -{% block pageTitle %} - Start page template – {{ serviceName }} – GOV.UK Prototype Kit -{% endblock %} - -{% block header %} - - {{ govukHeader() }} -{% endblock %} - -{% block content %} - -- {% if serviceName %} {{ serviceName }} {% endif %} -
- - - Start now - - -{% endblock %} diff --git a/cypress/fixtures/views/step-by-step-navigation.html b/cypress/fixtures/views/step-by-step-navigation.html deleted file mode 100644 index 051193e853..0000000000 --- a/cypress/fixtures/views/step-by-step-navigation.html +++ /dev/null @@ -1,47 +0,0 @@ -{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %} -{% from "govuk/components/header/macro.njk" import govukHeader %} - -{% block content %} -- Learn to drive a car: step by step -
- - -{% endblock %} diff --git a/cypress/scripts/run-starter-prototype.js b/cypress/scripts/run-starter-prototype.js deleted file mode 100644 index 79667f1b40..0000000000 --- a/cypress/scripts/run-starter-prototype.js +++ /dev/null @@ -1,28 +0,0 @@ -// core dependencies -const os = require('os') -const path = require('path') - -// local dependencies -const { mkPrototype, startPrototype, installPlugins } = require('../../__tests__/utils') - -const defaultKitPath = path.join(os.tmpdir(), 'cypress', 'test-prototype') - -const testDir = path.resolve(process.env.KIT_TEST_DIR || defaultKitPath) - -;(async () => { - await mkPrototype(testDir, { overwrite: true, allowTracking: false, npmInstallLinks: true }) - - const fooLocation = path.join(__dirname, '..', 'fixtures', 'plugins', 'plugin-foo') - const barLocation = path.join(__dirname, '..', 'fixtures', 'plugins', 'plugin-bar') - - await installPlugins(testDir, [ - `"file:${fooLocation}"`, - `"file:${barLocation}"`] - ) - - if (process.argv.includes('--prodtest')) { - await startPrototype(testDir, 'production') - } else { - await startPrototype(testDir) - } -})() diff --git a/cypress/support/commands.js b/cypress/support/commands.js deleted file mode 100644 index ca8ea656a8..0000000000 --- a/cypress/support/commands.js +++ /dev/null @@ -1,108 +0,0 @@ -/** - * Adds command "cy.waitForResource(name)" that checks performance entries - * for resource that ends with the given name. - * - * @see https://developers.google.com/web/tools/chrome-devtools/network/understanding-resource-timing - * - * Copied from https://github.com/cypress-io/cypress-example-recipes/blob/434f3b9b62555e53134c160b1f051b0c74a714e2/examples/testing-dom__wait-for-resource/cypress/e2e/spec.cy.js - */ -Cypress.Commands.add('waitForResource', (name, options = {}) => { - if (Cypress.browser.family === 'firefox') { - cy.log('Skip waitForResource in Firefox') - - return - } - - cy.log(`Waiting for resource ${name}`) - - const log = false // let's not log inner commands - const timeout = options.timeout || Cypress.config('defaultCommandTimeout') - - cy.window({ log }).then( - // note that ".then" method has options first, callback second - // https://on.cypress.io/then - { log, timeout }, - (win) => { - return new Cypress.Promise((resolve, reject) => { - let foundResource - - // control how long we should try finding the resource - // and if it is still not found. An explicit "reject" - // allows us to show nice informative message - setTimeout(() => { - if (foundResource) { - // nothing needs to be done, successfully found the resource - return - } - - clearInterval(interval) - reject(new Error(`Timed out waiting for resource ${name}`)) - }, timeout) - - const interval = setInterval(() => { - foundResource = win.performance - .getEntriesByType('resource') - .find((item) => item.name.endsWith(name)) - - if (!foundResource) { - // resource not found, will try again - return - } - - clearInterval(interval) - // because cy.log changes the subject, let's resolve the returned promise - // with log + returned actual result - resolve( - cy.log('✅ success').then(() => { - // let's resolve with the found performance object - // to allow tests to inspect it - return foundResource - }) - ) - }, 100) - }) - } - ) -}) - -Cypress.Commands.add( - 'download', - { prevSubject: true }, - (subject) => { - return cy.get(subject) - .invoke('attr', 'href') - .then((filename) => { - cy.url().then((uri) => { - const url = new URL(uri) - cy.task('log', `Downloading ${url.origin}${filename}`) - cy.task('download', { filename: `${url.origin}${filename}` }) - }) - }) - } -) - -// *********************************************** -// This example commands.js shows you how to -// create various custom commands and overwrite -// existing commands. -// -// For more comprehensive examples of custom -// commands please read more here: -// https://on.cypress.io/custom-commands -// *********************************************** -// -// -// -- This is a parent command -- -// Cypress.Commands.add('login', (email, password) => { ... }) -// -// -// -- This is a child command -- -// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... }) -// -// -// -- This is a dual command -- -// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... }) -// -// -// -- This will overwrite an existing command -- -// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... }) diff --git a/cypress/support/e2e.js b/cypress/support/e2e.js deleted file mode 100644 index 0f22b26ae9..0000000000 --- a/cypress/support/e2e.js +++ /dev/null @@ -1,20 +0,0 @@ -// *********************************************************** -// This example support/index.js is processed and -// loaded automatically before your test files. -// -// This is a great place to put global configuration and -// behavior that modifies Cypress. -// -// You can change the location of this file or turn off -// automatically serving support files with the -// 'supportFile' configuration option. -// -// You can read more here: -// https://on.cypress.io/configuration -// *********************************************************** - -// Import commands.js using ES2015 syntax: -// import './commands' - -// Alternatively you can use CommonJS syntax: -require('./commands') diff --git a/features/plugins/install-and-uninstall.feature b/features/plugins/install-and-uninstall.feature new file mode 100644 index 0000000000..6445258d76 --- /dev/null +++ b/features/plugins/install-and-uninstall.feature @@ -0,0 +1,24 @@ +@plugins +Feature: Installing and uninstalling plugins + + Scenario: Installed - show on installed plugins + When I visit the installed plugins page + Then I should see the plugin "Common Templates" in the list + + Scenario: Installed - tag as installed + When I visit the available plugins page + Then I should see the plugin "Common Templates" in the list + And The "Common Templates" plugin should be tagged as "Installed" + + Scenario: Uninstalled - hide on installed plugins + Given I uninstall the "installed:@govuk-prototype-kit/common-templates" plugin + And I wait for the uninstall to complete + When I visit the installed plugins page + Then I should not see the plugin "Common Templates" in the list + + Scenario: Uninstalled - don't tag as installed + Given I uninstall the "installed:@govuk-prototype-kit/common-templates" plugin + And I wait for the uninstall to complete + When I visit the available plugins page + Then I should see the plugin "Common Templates" in the list + And The "Common Templates" plugin should not be tagged as "Installed" diff --git a/features/plugins/update.feature b/features/plugins/update.feature new file mode 100644 index 0000000000..53c6d576fb --- /dev/null +++ b/features/plugins/update.feature @@ -0,0 +1,19 @@ +@plugins +Feature: Handle plugin update + + Scenario: When a dependency is now required + Given I have a the required SCSS to avoid plugins breaking when GOV.UK Frontend is uninstalled + And I install the "npm:@govuk-prototype-kit/common-templates:1.1.1" plugin + And I wait for the uninstall to complete + And I uninstall the "govuk-frontend" plugin using the command line + And I visit the installed plugins page + And I should not see the plugin "GOV.UK Frontend" in the list + When I update the "installed:@govuk-prototype-kit/common-templates" plugin + And I should be informed that "GOV.UK Frontend" will also be installed + And I continue with the update + And I wait for the update to complete + And I visit the installed plugins page + Then I should see the plugin "Common Templates" in the list + And I should see the plugin "GOV.UK Frontend" in the list + + diff --git a/features/screenshots/Installed - show on installed plugins1705851320555.png b/features/screenshots/Installed - show on installed plugins1705851320555.png new file mode 100644 index 0000000000..93b4125b30 Binary files /dev/null and b/features/screenshots/Installed - show on installed plugins1705851320555.png differ diff --git a/features/screenshots/Installed - show on installed plugins1705851862086.png b/features/screenshots/Installed - show on installed plugins1705851862086.png new file mode 100644 index 0000000000..4a4a29fff6 Binary files /dev/null and b/features/screenshots/Installed - show on installed plugins1705851862086.png differ diff --git a/features/screenshots/Installed - show on installed plugins1705851983005.png b/features/screenshots/Installed - show on installed plugins1705851983005.png new file mode 100644 index 0000000000..4a4a29fff6 Binary files /dev/null and b/features/screenshots/Installed - show on installed plugins1705851983005.png differ diff --git a/features/screenshots/Installed - show on installed plugins1705852212770.png b/features/screenshots/Installed - show on installed plugins1705852212770.png new file mode 100644 index 0000000000..4a4a29fff6 Binary files /dev/null and b/features/screenshots/Installed - show on installed plugins1705852212770.png differ diff --git a/features/screenshots/Installed - tag as installed1705851329511.png b/features/screenshots/Installed - tag as installed1705851329511.png new file mode 100644 index 0000000000..be647f2306 Binary files /dev/null and b/features/screenshots/Installed - tag as installed1705851329511.png differ diff --git a/features/screenshots/Installed - tag as installed1705852487701.png b/features/screenshots/Installed - tag as installed1705852487701.png new file mode 100644 index 0000000000..be647f2306 Binary files /dev/null and b/features/screenshots/Installed - tag as installed1705852487701.png differ diff --git a/features/screenshots/Installed - tag as installed1705852702154.png b/features/screenshots/Installed - tag as installed1705852702154.png new file mode 100644 index 0000000000..be647f2306 Binary files /dev/null and b/features/screenshots/Installed - tag as installed1705852702154.png differ diff --git a/features/screenshots/Installed - tag as installed1705852793308.png b/features/screenshots/Installed - tag as installed1705852793308.png new file mode 100644 index 0000000000..be647f2306 Binary files /dev/null and b/features/screenshots/Installed - tag as installed1705852793308.png differ diff --git a/features/screenshots/Uninstalled - don't tag as installed1705851465392.png b/features/screenshots/Uninstalled - don't tag as installed1705851465392.png new file mode 100644 index 0000000000..735c46f458 Binary files /dev/null and b/features/screenshots/Uninstalled - don't tag as installed1705851465392.png differ diff --git a/features/screenshots/Uninstalled - don't tag as installed1705852504805.png b/features/screenshots/Uninstalled - don't tag as installed1705852504805.png new file mode 100644 index 0000000000..7fabf82106 Binary files /dev/null and b/features/screenshots/Uninstalled - don't tag as installed1705852504805.png differ diff --git a/features/screenshots/Uninstalled - hide on installed plugins1705851396257.png b/features/screenshots/Uninstalled - hide on installed plugins1705851396257.png new file mode 100644 index 0000000000..735c46f458 Binary files /dev/null and b/features/screenshots/Uninstalled - hide on installed plugins1705851396257.png differ diff --git a/features/screenshots/Uninstalled - hide on installed plugins1705852496272.png b/features/screenshots/Uninstalled - hide on installed plugins1705852496272.png new file mode 100644 index 0000000000..7fabf82106 Binary files /dev/null and b/features/screenshots/Uninstalled - hide on installed plugins1705852496272.png differ diff --git a/features/screenshots/Uninstalled - hide on installed plugins1705852907288.png b/features/screenshots/Uninstalled - hide on installed plugins1705852907288.png new file mode 100644 index 0000000000..7fabf82106 Binary files /dev/null and b/features/screenshots/Uninstalled - hide on installed plugins1705852907288.png differ diff --git a/features/screenshots/Uninstalled - hide on installed plugins1705853008419.png b/features/screenshots/Uninstalled - hide on installed plugins1705853008419.png new file mode 100644 index 0000000000..7fabf82106 Binary files /dev/null and b/features/screenshots/Uninstalled - hide on installed plugins1705853008419.png differ diff --git a/features/screenshots/Uninstalled - hide on installed plugins1705853139785.png b/features/screenshots/Uninstalled - hide on installed plugins1705853139785.png new file mode 100644 index 0000000000..735c46f458 Binary files /dev/null and b/features/screenshots/Uninstalled - hide on installed plugins1705853139785.png differ diff --git a/features/screenshots/Uninstalled - hide on installed plugins1705859059804.png b/features/screenshots/Uninstalled - hide on installed plugins1705859059804.png new file mode 100644 index 0000000000..b32c06f25d Binary files /dev/null and b/features/screenshots/Uninstalled - hide on installed plugins1705859059804.png differ diff --git a/features/screenshots/When a dependency is now required1705851533948.png b/features/screenshots/When a dependency is now required1705851533948.png new file mode 100644 index 0000000000..6ea3b815dd Binary files /dev/null and b/features/screenshots/When a dependency is now required1705851533948.png differ diff --git a/features/screenshots/When a dependency is now required1705859719866.png b/features/screenshots/When a dependency is now required1705859719866.png new file mode 100644 index 0000000000..a3a6ec2831 Binary files /dev/null and b/features/screenshots/When a dependency is now required1705859719866.png differ diff --git a/features/support/global/DefaultCustomWorld.js b/features/support/global/DefaultCustomWorld.js new file mode 100644 index 0000000000..a353269051 --- /dev/null +++ b/features/support/global/DefaultCustomWorld.js @@ -0,0 +1,123 @@ +// CustomWorld.js +const { World } = require('@cucumber/cucumber') +const seleniumWebdriver = require('selenium-webdriver') +const chrome = require('selenium-webdriver/chrome') +const firefox = require('selenium-webdriver/firefox') +const { startKit, resetState } = require('./initKit') +const { verboseLogging, browserName, browserWidth, browserHeight, browserHeadless, fnRetryDelay, fnRetries } = require('./config') +const verboseLog = verboseLogging ? console.log : () => {} +const sharedState = {} + +class CustomWorld extends World { + driver = null + + async init () { + await Promise.all([ + this.startKitIfNotRunning(), + this.getDriver() + ]) + } + + async getDriver () { + const setOptions = (obj) => { + let objUpdated = obj + if (browserHeadless) { + objUpdated = objUpdated.headless() + } + objUpdated.windowSize({ + width: browserWidth, + height: browserHeight + }) + return objUpdated + } + if (!sharedState.driver) { + sharedState.driver = await new seleniumWebdriver.Builder().forBrowser(browserName) + .setChromeOptions(setOptions(new chrome.Options())) + .setFirefoxOptions(setOptions(new firefox.Options())) + .build() + + await sharedState.driver.manage().setTimeouts({ implicit: 2000 }) + } + this.driver = sharedState.driver + return this.driver + } + + async startKitIfNotRunning (config) { + if (!sharedState.runningKit) { + this.runningKit = sharedState.runningKit = await this.retryOnFailure(async ({ attemptNumber, previousError }) => { + verboseLog('Previous error', previousError) + verboseLog('starting kit, attempt [%s]', attemptNumber) + return await startKit(config) + }) + console.log('Kit running at:', this.runningKit.directory) + } + this.runningKit = sharedState.runningKit + return this.runningKit + } + + async resetState () { + if (!sharedState.runningKit) { + return + } + await resetState(sharedState.runningKit) + } + + static async CleanupEverything () { + if (sharedState.driver) { + sharedState.driver.quit() + } + if (sharedState.runningKit) { + sharedState.runningKit.close() + } + } + + async wait (millis) { + return new Promise((resolve, reject) => { + setTimeout(resolve, millis) + }) + } + + async retryOnFailure (fn) { + const delayBetweenRetries = fnRetryDelay + let attemptNumber = 1 + let retries = fnRetries + + let previousError + + while (true) { + try { + return await fn({ + attemptNumber: attemptNumber++, + previousError + }) + } catch (e) { + if (--retries > 0) { + previousError = e + await this.wait(delayBetweenRetries) + } else { + throw e + } + } + } + } + + async visit (relativeUrl, checkContent = async () => {}) { + if (!sharedState.driver) { + throw new Error(`Can't visit the URL ${relativeUrl} because WebDriver - fix this by running .init`) + } + if (!sharedState.runningKit) { + throw new Error(`Can't visit the URL ${relativeUrl} because the kit isn't running - fix this by running .startKitIfNotRunning or .startKitAndReplaceIfRunning`) + } + const url = `${sharedState.runningKit.serverAddress}${relativeUrl}` + await this.retryOnFailure(async ({ attemptNumber, previousError }) => { + verboseLog('previousError ' + previousError) + verboseLog('loading [%s] attempt [%s], time [%s]', url, attemptNumber++, new Date().toISOString()) + await sharedState.driver.get(url) + await checkContent(attemptNumber) + }) + } +} + +module.exports = { + CustomWorld +} diff --git a/features/support/global/config.js b/features/support/global/config.js new file mode 100644 index 0000000000..0af6d9e742 --- /dev/null +++ b/features/support/global/config.js @@ -0,0 +1,30 @@ +const os = require('os') +const verboseLogging = process.env.NPI_CUKE_VERBOSE === 'true' +const shortTimeout = Number(process.env.NPI_CUKE_SHORT_TIMEOUT || '3000') +const mediumTimeout = Number(process.env.NPI_CUKE_MEDIUM_TIMEOUT || '10000') +const longTimeout = Number(process.env.NPI_CUKE_LONG_TIMEOUT || '60000') +const fnRetries = Number(process.env.NPI_CUKE_FN_RETRIES || '10') +const fnRetryDelay = Number(process.env.NPI_CUKE_FN_RETRY_DELAY || '500') +const startingPort = Number(process.env.NPI_CUKE_STARTING_PORT || '18888') +const browserWidth = Number(process.env.NPI_CUKE_BROWSER_WIDTH || '1024') +const browserHeight = Number(process.env.NPI_CUKE_BROWSER_HEIGHT || '768') +const browserHeadless = process.env.NPI_CUKE_BROWSER_HEADLESS !== 'false' +const browserName = process.env.NPI_CUKE_BROWSER_NAME || 'chrome' +const screenshotOnFailure = process.env.NPI_CUKE_SCREENSHOT_ON_FAILURE !== false +const baseDir = process.env.NPI_CUKE_BASE_DIR || os.tmpdir() + +module.exports = { + verboseLogging, + shortTimeout, + mediumTimeout, + longTimeout, + startingPort, + browserName, + browserWidth, + browserHeight, + browserHeadless, + screenshotOnFailure, + baseDir, + fnRetries, + fnRetryDelay +} diff --git a/features/support/global/initKit.js b/features/support/global/initKit.js new file mode 100644 index 0000000000..38c6435e40 --- /dev/null +++ b/features/support/global/initKit.js @@ -0,0 +1,143 @@ +const { spawn: crossSpawn } = require('cross-spawn') +const cp = require('child_process') +const path = require('path') +const events = require('events') + +const { startingPort, verboseLogging, baseDir } = require('./config') + +let nextPort = startingPort + +function addInitialGitCommitToConfig (config) { + return new Promise((resolve, reject) => { + cp.exec('git log --pretty="%H"', { cwd: config.directory }, (err, stdout, stderr) => { + if (err) { + reject(err) + } + const result = (stdout || '').split(/[\n\r]+/)[0] + if (result && result.trim()) { + resolve({ ...config, initialCommit: result.trim() }) + } else { + resolve({ ...config }) + } + }) + }) +} + +function resetState (config) { + if (!config?.initialCommit) { + throw new Error('It\'s not possible to reset the state as no innitial commit exists in the config.') + } + return new Promise((resolve, reject) => { + cp.exec(`git reset --hard ${config.initialCommit} && npm prune && npm install`, { cwd: config.directory }, (err) => { + if (err) { + reject(err) + } else { + config.kitStartedEventEmitter.on('started', () => { + resolve() + }) + } + }) + }) +} + +function initKit (config) { + if (config.directory) { + return Promise.resolve({ startCommand: 'npm run dev', ...config }) + } + const tmpDir = config.directory || path.join(baseDir, new Date().getTime() + '_' + ('' + Math.random()).split('.')[1]) + const rootDir = path.resolve(__dirname, '../../..') + + return new Promise((resolve, reject) => { + let startCommand + const initProcess = crossSpawn('npx', [`now-prototype-it-govuk@${rootDir}`, 'create', `--version=${rootDir}`, tmpDir], { cwd: rootDir }) + initProcess.stderr.on('data', (data) => console.warn('[stderr]', data.toString())) + initProcess.stdout.on('data', (data) => { + const str = data.toString() + if (verboseLogging) { + console.log(str) + } + // eslint-disable-next-line no-unused-vars + const [_, command] = str.split('To run your prototype:') + if (command && command.trim()) { + startCommand = command.trim() + } + }) + initProcess.on('error', (error) => { + reject(error) + }) + + initProcess.on('close', code => { + if (startCommand) { + resolve({ ...config, startCommand, directory: tmpDir, kitStartedEventEmitter: new events.EventEmitter() }) + } else { + reject(new Error('initialisation failed')) + } + }) + }) +} + +async function setUsageDataPermission (config) { + // const filePath = path.join(config.directory, 'usage-data-config.json') + // console.log('Writing usage data file', filePath) + // await fse.writeJson(filePath, { collectUsageData: false }) + // console.log('Written usage data file', filePath) + return config +} + +function runKit (config) { + let hasReturned = false + + return new Promise((resolve, reject) => { + const [command, ...args] = config.startCommand.split(' ') + const kitProcess = crossSpawn(command, args, { + cwd: config.directory, + detached: true, + env: { + ...process.env, + PORT: nextPort++, + GPK_NO_STDIN: 'true' + } + }) + + kitProcess.stderr.on('data', (data) => console.warn('[stderr]', data.toString())) + kitProcess.stdout.on('data', (data) => { + const str = data.toString() + const regExpMatchArray = str.match(/(http:\/\/localhost:\d+)/) + if (regExpMatchArray && regExpMatchArray[1]) { + config.kitStartedEventEmitter.emit('started') + if (hasReturned) { + return + } + hasReturned = true + resolve({ + ...config, + serverAddress: regExpMatchArray[1].trim(), + close: () => { + kitProcess.stdin.pause() + try { + process.kill(-kitProcess.pid, 'SIGTERM') + } catch (err) { + console.error('error while stopping process') + console.error(err) + } + } + }) + } + }) + kitProcess.on('error', (error) => { + reject(error) + }) + + kitProcess.on('close', code => { + reject(new Error('initialisation failed')) + }) + }) +} + +module.exports = { + startKit: (config = {}) => initKit(config) + .then(setUsageDataPermission) + .then(addInitialGitCommitToConfig) + .then(runKit), + resetState +} diff --git a/features/support/setup.js b/features/support/setup.js new file mode 100644 index 0000000000..0ba2c6863d --- /dev/null +++ b/features/support/setup.js @@ -0,0 +1,31 @@ +// setup.js +const { Status, Before, After, setWorldConstructor, AfterAll } = require('@cucumber/cucumber') +const { CustomWorld } = require('./global/DefaultCustomWorld') +const fsp = require('fs/promises') +const fse = require('fs-extra') +const path = require('path') +const { longTimeout, screenshotOnFailure } = require('./global/config') + +setWorldConstructor(CustomWorld) + +Before({ timeout: longTimeout }, async function (scenario) { + await this.init(scenario) + await this.resetState() +}) + +After({ timeout: longTimeout }, async function (testCase) { + if (testCase.result.status === Status.FAILED && screenshotOnFailure) { + const screenshot = await this.driver.takeScreenshot() + const filePath = path.join(__dirname, '..', 'screenshots', `${testCase.pickle.name}${new Date().getTime()}.png`) + await fse.ensureDir(path.dirname(filePath)) + await fsp.writeFile(filePath, screenshot, 'base64') + this.attach(screenshot, { + mediaType: 'base64:image/png', + fileName: 'screenshot.png' + }) + } +}) + +AfterAll(async function () { + await CustomWorld.CleanupEverything() +}) diff --git a/features/support/steps.js b/features/support/steps.js new file mode 100644 index 0000000000..ee7c826686 --- /dev/null +++ b/features/support/steps.js @@ -0,0 +1,132 @@ +const { expect } = require('expect') +const { Given, When, Then } = require('@cucumber/cucumber') +const { By, until } = require('selenium-webdriver') +const { longTimeout } = require('./global/config') +const fsp = require('fs/promises') +const path = require('path') +const util = require('util') +const exec = util.promisify(require('child_process').exec) + +const installedPluginsUrl = '/manage-prototype/plugins-installed' +const pluginsUrl = '/manage-prototype/plugins' + +const lookForH1 = self => async () => { + return await self.driver.findElement(By.tagName('h1')) +} + +When('I visit the installed plugins page', { timeout: longTimeout }, async function () { + await this.visit(installedPluginsUrl, lookForH1(this)) +}) +When('I visit the available plugins page', { timeout: longTimeout }, async function () { + await this.visit(pluginsUrl, lookForH1(this)) +}) + +async function getPluginListItems (self) { + return await Promise.all(await self.driver.findElements(By.className('nowprototypeit-manage-prototype-plugin-list-plugin-list__item'))) +} + +async function getNamesOfPluginsOnPage (self) { + const pluginListItems = await getPluginListItems(self) + return await Promise.all(pluginListItems.map(async x => await x.findElement(By.className('plugin-details-link')).getText())) +} + +Then('I should see the plugin {string} in the list', async function (pluginName) { + expect(await getNamesOfPluginsOnPage(this)).toContain(pluginName) +}) + +Then('I should not see the plugin {string} in the list', async function (pluginName) { + expect(await getNamesOfPluginsOnPage(this)).not.toContain(pluginName) +}) + +async function getTagsForPlugin (self, pluginName) { + const tags = [] + await Promise.all((await getPluginListItems(self)).map(async x => { + const text = (await x.findElement(By.className('plugin-details-link')).getText()) + if (text === pluginName) { + const tagElems = await x.findElements(By.className('govuk-tag')) + const names = await Promise.all(tagElems.map(elem => elem.getText())) + names.forEach(z => tags.push(z)) + } + })) + return tags +} + +Then('The {string} plugin should be tagged as {string}', async function (pluginName, tag) { + expect((await getTagsForPlugin(this, pluginName)).map(x => x.toUpperCase())).toContain(tag.toUpperCase()) +}) + +Then('The {string} plugin should not be tagged as {string}', async function (pluginName, tag) { + expect(await getTagsForPlugin(this, pluginName)).not.toContain(tag.toUpperCase()) +}) + +Given('I install the {string} plugin', async function (pluginNameOrRef) { + // TODO: Support names as well as refs + await this.visit(`/manage-prototype/plugin/${encodeURIComponent(pluginNameOrRef)}/install`) + const installButton = await this.driver.findElement(By.id('plugin-action-button')) + installButton.click() +}) + +Given('I uninstall the {string} plugin', async function (pluginNameOrRef) { + // TODO: Support names as well as refs + await this.visit(`/manage-prototype/plugin/${encodeURIComponent(pluginNameOrRef)}`, lookForH1(this)) + const uninstallButton = await this.driver.findElement(By.className('nowprototypeit-plugin-uninstall-button')) + uninstallButton.click() +}) + +Given('I update the {string} plugin', async function (pluginNameOrRef) { + // TODO: Support names as well as refs + await this.visit(`/manage-prototype/plugin/${encodeURIComponent(pluginNameOrRef)}`, lookForH1(this)) + const updateButton = await this.driver.findElement(By.className('nowprototypeit-plugin-update-button')) + updateButton.click() +}) + +Given(/I wait for the (?:uninstall|uninstall|update) to complete/, { timeout: longTimeout }, async function () { + await this.retryOnFailure(async () => { + await this.retryOnFailure(async () => { + await this.driver.findElement(By.tagName('h1')) + }) + const completed = await this.driver.wait(until.elementLocated(By.id('instructions-complete'))) + await this.driver.wait(until.elementIsVisible(completed), 20000) + }) +}) + +Given('I uninstall the {string} plugin using the command line', { timeout: longTimeout }, async function (npmPluginName) { + await exec(`npm uninstall ${npmPluginName}`, { cwd: this.runningKit.directory }) + await new Promise((resolve) => { + this.runningKit.kitStartedEventEmitter.once('started', async () => { + await this.wait(1000) + resolve() + }) + }) +}) + +Given('I have a the required SCSS to avoid plugins breaking when GOV.UK Frontend is uninstalled', async function () { + const additionalScssPath = path.join(this.runningKit.directory, 'app', 'assets', 'sass', 'settings.scss') + const additionalScssContents = ` +@mixin govuk-text-colour { + color: black; +} +@mixin govuk-font($size, $weight: regular, $tabular: false, $line-height: false) { + font-size: $size +} +@mixin govuk-media-query($from) { + @media (min-width: $from) { @content; } +}` + await fsp.writeFile(additionalScssPath, additionalScssContents, 'utf8') +}) + +When('I should be informed that {string} will also be installed', async function (pluginName) { + const heading = await this.driver.findElement(By.id('dependency-heading')) + const listItems = await heading.findElements(By.tagName('li')) + const matchinglistItems = (await Promise.all(listItems.map(async listItem => await listItem.getText()))).filter(name => pluginName) + expect(matchinglistItems).toHaveLength(1) +}) + +When('I continue with the update', async function () { + const button = await this.driver.findElement(By.id('plugin-action-button')) + button.click() +}) + +Given('I wait {int} seconds', { timeout: longTimeout }, async function (seconds) { + await this.wait(seconds * 1000) +}) diff --git a/internal_docs/linting.md b/internal_docs/linting.md deleted file mode 100644 index 3e3ebd087e..0000000000 --- a/internal_docs/linting.md +++ /dev/null @@ -1,53 +0,0 @@ -# Linting - -The GOV.UK Prototype Kit uses [standardjs](http://standardjs.com/), an opinionated JavaScript linter. All JavaScript files follow its conventions, and it runs on CI to ensure that new pull requests are in line with them. - -## Running standard manually - -To check the whole codebase, run: - -```bash -npm run lint -``` - -## Running standard in your editor - -Easier than running standard manually is to install it as a plugin in your editor. This way, it will run automatically while you work, catching errors as they happen on a per-file basis. - -### Sublime Text - -Using [Package Control](https://packagecontrol.io/), install [SublimeLinter](http://www.sublimelinter.com/en/latest/) and [SublimeLinter-contrib-standard](https://packagecontrol.io/packages/SublimeLinter-contrib-standard). - -For automatic formatting on save, install [StandardFormat](https://packagecontrol.io/packages/StandardFormat). - -### Atom - -Install [linter-js-standard](https://atom.io/packages/linter-js-standard). - -For automatic formatting, install [standard-formatter](https://atom.io/packages/standard-formatter). For snippets, install [standardjs-snippets](https://atom.io/packages/standardjs-snippets). - -### Other editors - -There are [official guides for most of the popular editors](http://standardjs.com/index.html#text-editor-plugins). - -## Do I need to respect this? - -If you want to submit a pull request to the GOV.UK Prototype Kit, your code will need to pass the linter. - -If you're just using the GOV.UK Prototype Kit in a separate project, then no, you aren't forced to use standard, or any other linter for that matter. Just write code as you would normally. - -## Why lint? - -Automated linting ensures project-wide consistency and limits (ideally eliminates) bikeshedding discussions involving spacing, naming conventions, quotes, and others during the pull request review process. It frees the reviewer to focus on the actual substance rather than stylistic issues. - -More importantly, linting will catch some low hanging programmer errors, such as calling an undefined function or assigning a value and then never reading it. These allow the programmer to catch some bugs before having to test the code. - -## Why standard? - -Linting rules can be a contentious subject, and a lot of them are down to personal preference. The core idea of standard is to be opinionated and limit the amount of initial bikeshedding discussions around which linting rules to pick, because in the end, it's not as important which rules you pick as it is to just be consistent about it. This is why we chose standard: because we want to be consistent about how we write code, but don't want to spend unnecessary time picking different rules (which all have valid points). - -The standard docs have a [complete list of rules and some reasoning behind them](http://standardjs.com/rules.html). - -Standard is also [widely used (warning: large file)](https://github.com/feross/standard-packages/blob/master/all.json) (which means community familiarity) and has a [good ecosystem of plugins](http://standardjs.com/awesome.html). - -If we decide to move away from it, standard is effectively just a preconfigured bundle of eslint, so it can easily be replaced by switching to a generic `.eslintrc` setup. diff --git a/internal_docs/releasing/releasing-from-a-support-branch.md b/internal_docs/releasing/releasing-from-a-support-branch.md deleted file mode 100644 index 57b61b84d0..0000000000 --- a/internal_docs/releasing/releasing-from-a-support-branch.md +++ /dev/null @@ -1,124 +0,0 @@ -# Releasing from a support branch - -This document is for Prototype team developers who need to publish a support branch of the GOV.UK Prototype Kit. For example, you might need to release a fix as part of a: - -- patch release, after the team has started to merge changes for a new feature release into the `main` branch - for example, a 13.14.x release once we've started merging changes for 13.15.0 -- release, after the team has started to merge changes for a new breaking release into the `main` branch - for example, a 12.x.x release once we've started merging changes for 13.0.0 -- release for a previous major version - for example, a 12.x.x release after we've released 13.0.0 - -If you want to publish the `main` branch for the Prototype Kit, [follow the steps in releasing a new version of the Prototype Kit](./releasing.md). - -If the `main` branch only has a few unreleasable changes, you can temporarily revert these changes. - -1. Revert the unreleasable changes on the `main` branch. -2. Publish the Prototype Kit. -3. Add the reverted changes back into the `main` branch. - -However, this approach has risks. For example, it creates a messy commit history on the `main` branch. - -## Before you release - -1. Draft release notes in a Google Doc. - -## Release a new version of the Prototype Kit from the support branch - -### Change the code - -1. Find out which major version this release will be targeting, for example, if you're releasing v12.x.x, the major version is version 12. To check out the support branch for that major version, run `git checkout support/There is an error
') - fileContentsParts.push('') - fileContentsParts.push('You can try and fix this yourself or contact the GOV.UK Prototype Kit team if you need help.') fileContentsParts.push('
') fileContentsParts.push('')
fileContentsParts.push(error.stack)
diff --git a/lib/final-backup-nunjucks/layouts/main.html b/lib/final-backup-nunjucks/layouts/main.html
index 2ceb4be401..4951bd1d0f 100644
--- a/lib/final-backup-nunjucks/layouts/main.html
+++ b/lib/final-backup-nunjucks/layouts/main.html
@@ -1,6 +1,6 @@
{# this file exists as a backup in case the user has deleted their `app/views/layouts/main.html` template #}
-{% extends "govuk-prototype-kit/layouts/govuk-branded.njk" %}
+{% extends "nowprototypeit/layouts/govuk-branded.njk" %}
{% block meta %}
diff --git a/lib/manage-prototype-handlers.js b/lib/manage-prototype-handlers.js
index bfd51f90fd..516c948b15 100644
--- a/lib/manage-prototype-handlers.js
+++ b/lib/manage-prototype-handlers.js
@@ -9,20 +9,12 @@ const { doubleCsrf } = require('csrf-csrf')
// local dependencies
const config = require('./config')
const plugins = require('./plugins/plugins')
-const { exec } = require('./exec')
const { govukFrontendPaths } = require('./govukFrontendPaths')
const { prototypeAppScripts } = require('./utils')
-const { projectDir, packageDir, appViewsDir } = require('./utils/paths')
+const { projectDir, packageDir, appViewsDir, commandsDir } = require('./utils/paths')
const nunjucksConfiguration = require('./nunjucks/nunjucksConfiguration')
const syncChanges = require('./sync-changes')
-const {
- lookupPackageInfo,
- getInstalledPackages,
- getAllPackages,
- getDependentPackages,
- getDependencyPackages,
- waitForPackagesCache
-} = require('./plugins/packages')
+const { plugins: knownPlugins } = require('../known-plugins.json')
const contextPath = '/manage-prototype'
@@ -39,22 +31,22 @@ const nunjucksManagementEnv = nunjucksConfiguration.getNunjucksAppEnv(
govukFrontendPaths([packageDir, projectDir])
)
-let kitRestarted = false
-
const {
- name: currentKitName,
version: currentKitVersion
} = require(path.join(packageDir, 'package.json'))
-
-async function isValidVersion (packageName, version) {
- const { versions = [], localVersion } = await lookupPackageInfo(packageName, version)
- const validVersions = [...versions, localVersion].filter(version => version)
- const isVersionValid = validVersions.includes(version)
- if (!isVersionValid) {
- console.log('version', version, ' is not valid, valid options are:\n\n', validVersions)
- }
- return isVersionValid
-}
+const pluginDetails = require('./utils/packageDetails')
+const {
+ getPluginDetailsFromFileSystem,
+ getPluginDetailsFromGithub,
+ getPluginDetailsFromNpm,
+ getLatestPluginDetailsFromNpm,
+ getPluginDetailsFromRef,
+ getInstalledPackages,
+ getKnownPlugins,
+ getInstalledPluginDetails,
+ isInstalled
+} = pluginDetails
+const { getConfig } = require('./config')
function getManagementView (filename) {
return ['views', 'manage-prototype', filename].join('/')
@@ -137,15 +129,6 @@ function developmentOnlyMiddleware (req, res, next) {
}
}
-// Middleware to ensure pages load when plugin cache has been initially loaded
-async function pluginCacheMiddleware (req, res, next) {
- await Promise.race([
- waitForPackagesCache(),
- new Promise((resolve) => setTimeout(resolve, 1000))
- ])
- next()
-}
-
const managementLinks = [
{
text: 'Home',
@@ -178,18 +161,19 @@ async function getHomeHandler (req, res) {
const originalHomepage = await fse.readFile(path.join(packageDir, 'prototype-starter', 'app', 'views', 'index.html'), 'utf8')
const currentHomepage = await readFileIfExists(path.join(appViewsDir, 'index.html'))
- const kitPackage = await lookupPackageInfo('govuk-prototype-kit')
+ const kitPackage = await pluginDetails.getLatestPluginDetailsFromNpm('@nowprototypeit/govuk')
const viewData = {
...req.app.locals,
currentUrl: req.originalUrl,
currentSection: pageName,
links: managementLinks,
- kitUpdateAvailable: kitPackage.latestVersion !== currentKitVersion,
- latestAvailableKit: kitPackage.latestVersion,
+ kitUpdateAvailable: kitPackage?.latestVersion && kitPackage?.version !== currentKitVersion,
+ latestAvailableKit: kitPackage?.version,
+ latestKitUrl: kitPackage?.links?.pluginDetails,
tasks: [
{
- done: serviceName !== 'Service name goes here' && serviceName !== 'GOV.UK Prototype Kit',
+ done: serviceName !== 'Service name goes here' && serviceName !== 'Now Prototype It - GOV.UK Prototype Kit',
html: 'Change the service name in the file app/config.json'
}, {
done: currentHomepage !== undefined && originalHomepage !== currentHomepage,
@@ -243,11 +227,12 @@ async function getTemplatesHandler (req, res) {
const commonTemplatesPackageName = '@govuk-prototype-kit/common-templates'
const govukFrontendPackageName = 'govuk-frontend'
let commonTemplatesDetails
- const installedPlugins = (await getInstalledPackages()).map((pkg) => pkg.packageName)
+ const installedPlugins = (await pluginDetails.getInstalledPackages()).map((pkg) => pkg.packageName)
if (installedPlugins.includes(govukFrontendPackageName) && !installedPlugins.includes(commonTemplatesPackageName)) {
+ const plugin = await getLatestPluginDetailsFromNpm(commonTemplatesPackageName)
commonTemplatesDetails = {
- pluginDisplayName: plugins.preparePackageNameForDisplay(commonTemplatesPackageName),
- installLink: `${contextPath}/plugins/install?package=${encodeURIComponent(commonTemplatesPackageName)}&returnTo=templates`
+ pluginDisplayName: plugin?.name,
+ installLink: plugin?.links?.install
}
}
@@ -404,50 +389,47 @@ function getTemplatesPostInstallHandler (req, res) {
}))
}
-function buildPluginData (pluginData) {
- if (pluginData === undefined) {
- return
- }
- const {
- packageName,
- installed,
- installedLocally,
- updateAvailable,
- latestVersion,
- installedVersion,
- required,
- localVersion,
- pluginConfig = {}
- } = pluginData
- const preparedPackageNameForDisplay = plugins.preparePackageNameForDisplay(packageName)
+async function buildPluginData (plugin) {
+ const latestVersion = (await getLatestPluginDetailsFromNpm(plugin.packageName))?.version
+ const installedPlugin = await getInstalledPluginDetails(plugin.packageName)
+ const installedVersion = installedPlugin?.version
+
return {
- ...preparedPackageNameForDisplay,
- ...pluginConfig.meta,
- packageName,
- latestVersion,
- installedLocally,
- installLink: `${contextPath}/plugins/install?package=${encodeURIComponent(packageName)}`,
- installCommand: `npm install ${packageName}`,
- updateLink: updateAvailable ? `${contextPath}/plugins/update?package=${encodeURIComponent(packageName)}` : undefined,
- updateCommand: latestVersion && `npm install ${packageName}@${latestVersion}`,
- uninstallLink: installed && !required ? `${contextPath}/plugins/uninstall?package=${encodeURIComponent(packageName)}${installedLocally ? `&version=${encodeURIComponent(localVersion)}` : ''}` : undefined,
- uninstallCommand: `npm uninstall ${packageName}`,
- installedVersion
+ ...plugin,
+ installedVersion,
+ isInstalled: !!installedVersion,
+ updateAvailable: latestVersion && installedVersion && installedVersion !== latestVersion,
+ description: plugin.pluginConfig?.meta?.description,
+ pluginDetailsLink: installedPlugin?.links?.pluginDetails || plugin.links.pluginDetails
+ }
+}
+
+function getTimeSummary (date) {
+ const epochDate = date.getTime()
+ const epochNow = new Date().getTime()
+ const timeDifferenceInDays = (epochNow - epochDate) / 1000 / 60 / 60 / 24
+ if (timeDifferenceInDays < 1) {
+ return 'today'
+ }
+ if (timeDifferenceInDays < 2) {
+ return 'yesterday'
+ }
+ if (timeDifferenceInDays < 14) {
+ return Math.floor(timeDifferenceInDays) + ' days ago'
}
+ return Math.floor(timeDifferenceInDays / 7) + ' weeks ago'
}
async function prepareForPluginPage (isInstalledPage, search) {
- const allPackages = await getAllPackages()
- const allPlugins = allPackages.filter(({ pluginConfig }) => !!pluginConfig)
- const installedPackages = await getInstalledPackages()
- const installedPlugins = installedPackages.filter(({ pluginConfig }) => !!pluginConfig)
+ const allPlugins = await getKnownPlugins()
+ const installedPlugins = await getInstalledPackages()
const plugins = isInstalledPage
? installedPlugins
: allPlugins.filter(plugin => {
- const { packageName, available, installed } = plugin || {}
+ const { packageName } = plugin || {}
const pluginName = packageName?.toLowerCase()
- if (!pluginName || (!available && !installed)) {
+ if (!pluginName) {
return false
}
return pluginName.indexOf(search.toLowerCase()) >= 0
@@ -455,50 +437,12 @@ async function prepareForPluginPage (isInstalledPage, search) {
return {
status: isInstalledPage ? 'installed' : 'search',
- plugins: plugins.map(buildPluginData),
+ plugins: await Promise.all(plugins.map(buildPluginData)),
found: plugins.length,
updates: installedPlugins.filter(plugin => plugin.updateAvailable).length
}
}
-function getCommand (mode, chosenPlugin) {
- let {
- updateCommand,
- installCommand,
- uninstallCommand,
- version,
- dependencyPlugins,
- dependentPlugins
- } = chosenPlugin
- const dependents = dependentPlugins?.map(({ packageName }) => packageName).join(' ')
- const dependencies = dependencyPlugins?.map(({
- packageName,
- latestVersion
- }) => packageName + '@' + latestVersion).join(' ')
-
- if (version && installCommand) {
- installCommand += `@${version}`
- }
-
- if (dependents) {
- uninstallCommand += ' ' + dependents
- }
-
- if (dependencies) {
- installCommand += ' ' + dependencies
- updateCommand += ' ' + dependencies
- }
-
- switch (mode) {
- case 'update':
- return updateCommand + ' --save-exact'
- case 'install':
- return installCommand + ' --save-exact'
- case 'uninstall':
- return uninstallCommand
- }
-}
-
const verbs = {
update: {
title: 'Update',
@@ -525,7 +469,17 @@ const verbs = {
async function getPluginsHandler (req, res) {
const isInstalledPage = req.route.path.endsWith('installed')
- const { search = '' } = req.query || {}
+ const {
+ search = '',
+ error,
+ fsPath,
+ githubOrg,
+ githubProject,
+ githubBranch,
+ npmPackage,
+ npmVersion,
+ source
+ } = req.query || {}
const pageName = 'Plugins'
const { plugins, status, updates = 0, found = 0 } = await prepareForPluginPage(isInstalledPage, search)
const foundMessage = found === 1 ? found + ' Plugin found' : found + ' Plugins found'
@@ -535,14 +489,26 @@ async function getPluginsHandler (req, res) {
currentSection: pageName,
links: managementLinks,
isInstalledPage,
+ showPluginLookup: getConfig().showPluginLookup,
isSearchPage: !isInstalledPage,
search,
plugins,
updatesMessage,
foundMessage,
- status
+ status,
+ playback: {
+ error,
+ fsPath,
+ githubOrg,
+ githubProject,
+ githubBranch,
+ npmPackage,
+ npmVersion,
+ source
+ }
}
- res.send(nunjucksManagementEnv.render(getManagementView('plugins.njk'), model))
+
+ res.render(getManagementView('plugins.njk'), model)
}
async function postPluginsHandler (req, res) {
@@ -550,91 +516,250 @@ async function postPluginsHandler (req, res) {
res.redirect(contextPath + req.route.path + query)
}
-async function getPluginForRequest (req) {
- const packageName = req.query.package || req.body.package
- const version = req.query.version || req.body.version
- const mode = getModeFromRequest(req)
- let chosenPlugin
+async function postPluginDetailsHandler (req, res) {
+ let found
+ const {
+ fsPath,
+ githubOrg,
+ githubProject,
+ githubBranch,
+ npmPackage,
+ npmVersion,
+ source,
+ notFoundErrorUrl
+ } = req.body
+
+ if (source === 'fs') {
+ found = await getPluginDetailsFromFileSystem(fsPath)
+ } else if (source === 'github') {
+ found = await getPluginDetailsFromGithub(githubOrg, githubProject, githubBranch)
+ } else if (source === 'npm' && npmVersion) {
+ found = await getPluginDetailsFromNpm(npmPackage, npmVersion)
+ } else if (source === 'npm') {
+ found = await getLatestPluginDetailsFromNpm(npmPackage)
+ }
+
+ if (found && found.exists && found.pluginConfig) {
+ res.redirect(found.links.pluginDetails)
+ } else {
+ const [url, query] = notFoundErrorUrl.split('?')
+ const queryParts = [query].concat([
+ 'fsPath',
+ 'githubOrg',
+ 'githubProject',
+ 'githubBranch',
+ 'npmPackage',
+ 'npmVersion',
+ 'source'
+ ].map(x => {
+ return x && `${encodeURIComponent(x)}=${encodeURIComponent(req.body[x])}`
+ })).filter(x => x)
+ res.redirect([url, queryParts.join('&')].join('?'))
+ }
+}
+
+async function getPluginDetailsHandler (req, res, next) {
+ const config = getConfig()
+ const plugin = await getPluginDetailsFromRef(req.params.packageRef).catch(e => undefined)
+
+ if (!plugin?.pluginConfig) {
+ console.warn('No page found for plugin ref', req.params.packageRef)
+ const err = new Error('Plugin not found')
+ err.status = 404
+ next(err)
+ return
+ }
+
+ if (req.originalUrl !== plugin.links.pluginDetails) {
+ const redirectUrl = plugin.links.pluginDetails
+ console.log('redirecting from:', req.originalUrl)
+ console.log('redirecting to:', redirectUrl)
+ res.redirect(redirectUrl)
+ return
+ }
+
+ const latestVersionPromise = plugin.origin === 'NPM' ? getLatestPluginDetailsFromNpm(plugin.packageName) : Promise.resolve(undefined)
+ const installedVersionPromise = getInstalledPluginDetails(plugin.packageName)
- if (packageName) {
- chosenPlugin = buildPluginData(await lookupPackageInfo(packageName, version))
- if (!chosenPlugin) {
- return // chosen plugin will be invalid
+ function replaceUrlVars (url) {
+ return url && url
+ .replace('{{version}}', plugin.version || plugin.latestVersion)
+ .replace('{{kitVersion}}', currentKitVersion)
+ }
+
+ function getInThisPluginDetails () {
+ const list = []
+ if (plugin.pluginConfig.nunjucksMacros && plugin.pluginConfig.nunjucksMacros.length > 0) {
+ list.push({
+ title: 'Components',
+ items: plugin.pluginConfig.nunjucksMacros.map(x => x.macroName)
+ })
}
- if (version) {
- if (await isValidVersion(packageName, version)) {
- chosenPlugin.version = version
- } else if (chosenPlugin.installedLocally) {
- chosenPlugin.version = chosenPlugin.installedVersion
- } else {
- return // chosen plugin will be invalid
- }
+ if (plugin.pluginConfig.templates && plugin.pluginConfig.templates.length > 0) {
+ list.push({
+ title: 'Templates',
+ items: plugin.pluginConfig.templates.map(x => x.name)
+ })
}
+ return list
}
- const dependentPlugins = (await getDependentPackages(chosenPlugin.packageName, version, mode))
- .filter(({ installed }) => installed || mode !== 'uninstall')
- .map(buildPluginData)
+ const model = {
+ currentSection: 'Plugins',
+ links: managementLinks,
+ plugin,
+ pluginDescription: plugin?.pluginConfig?.meta?.description,
+ version: plugin.version,
+ releaseTimeSummary: plugin.releaseDateTime && getTimeSummary(new Date(plugin.releaseDateTime)),
+ inThisPlugin: getInThisPluginDetails(),
+ preparedPluginLinks: {
+ documentation: replaceUrlVars(plugin?.pluginConfig?.meta?.urls?.documentation),
+ versionHistory: replaceUrlVars(plugin?.pluginConfig?.meta?.urls?.versionHistory),
+ releaseNotes: replaceUrlVars(plugin?.pluginConfig?.meta?.urls?.releaseNotes)
+ }
+ }
+
+ const epochDateBookmark = '#' + new Date().getTime()
+ const latestVersion = await latestVersionPromise
+ const installedVersion = await installedVersionPromise
- if (dependentPlugins.length) {
- chosenPlugin.dependentPlugins = dependentPlugins
+ if (latestVersion?.version && latestVersion.version !== plugin.version) {
+ model.newerLink = latestVersion.links.pluginDetails
+ model.newerVersion = latestVersion.version
+ }
+ if (installedVersion?.version && installedVersion.version !== plugin.version) {
+ model.installedLinkAsDifferentLink = installedVersion.links.pluginDetails
+ model.installedLinkAsDifferentVersion = installedVersion.version
+ }
+ if (installedVersion?.version && latestVersion?.version !== installedVersion?.version) {
+ model.updateLink = latestVersion?.links?.update
+ }
+ if (await isInstalled(plugin.internalRef)) {
+ if (!getRequiredPlugins().includes(plugin.packageName)) {
+ model.uninstallLink = plugin.links.uninstall
+ }
+ } else {
+ model.installLink = plugin.links.install
+ }
+ if (config.showPluginDowngradeButtons && installedVersion?.version !== plugin.version) {
+ model.installLink = plugin.links.install
+ model.installLinkText = 'Install this version'
}
- const dependencyPlugins = (await getDependencyPackages(chosenPlugin.packageName, version, mode)).map(buildPluginData)
+ ;['updateLink', 'uninstallLink', 'installLink'].forEach(key => {
+ model[key] = model[key] && model[key] + epochDateBookmark
+ })
- if (dependencyPlugins.length) {
- chosenPlugin.dependencyPlugins = dependencyPlugins
+ if (config.showPluginDebugInfo) {
+ model.debugInfo = [
+ '',
+ 'versions:',
+ '',
+ `viewing: ${plugin?.version}`,
+ `latest: ${latestVersion?.version}`,
+ `installed: ${installedVersion?.version}`,
+ '',
+ 'origin:',
+ '',
+ `viewing: ${plugin?.origin}`,
+ `latest: ${latestVersion?.origin}`,
+ `installed: ${installedVersion?.origin}`
+ ].join('\n')
}
- return chosenPlugin
+ res.set('Cache-control', 'no-cache, no-store')
+
+ res.render(getManagementView('pluginDetails.njk'), model)
+}
+
+async function getRelatedPluginsForUninstall (chosenPlugin) {
+ const installed = await getInstalledPackages()
+ return installed.filter(x => {
+ return (x.pluginConfig?.pluginDependencies || []).some(y => (y.packageName || y) === chosenPlugin.packageName)
+ })
}
-function modeIsComplete (mode, { installedVersion, latestVersion, version, installedLocally }) {
- switch (mode) {
- case 'update':
- return installedVersion === latestVersion
- case 'install':
- return installedLocally || (version ? installedVersion === version : !!installedVersion)
- case 'uninstall':
- return !installedVersion
+async function getRelatedPluginsForInstallOrUpdate (chosenPlugin) {
+ const output = {}
+ const installed = (await getInstalledPackages()).map(x => x.packageName)
+
+ async function addDependenciesToOutputRecursive (plugin) {
+ const deps = plugin.pluginConfig?.pluginDependencies || []
+ const depsAsObjects = (await Promise.all(deps.map(dep => getLatestPluginDetailsFromNpm(dep.packageName || dep))))
+ .filter(depObj => {
+ return !Object.keys(output).includes(depObj.internalRef) && !installed.includes(depObj.packageName)
+ })
+
+ depsAsObjects.forEach(x => {
+ output[x.internalRef] = x
+ })
+
+ await Promise.all(depsAsObjects.map(depObj => addDependenciesToOutputRecursive(depObj)))
+
+ return output
}
+
+ await addDependenciesToOutputRecursive(chosenPlugin)
+ return Object.values(output)
}
-async function getPluginsModeHandler (req, res) {
+async function getPluginsModeHandler (req, res, next) {
const isSameOrigin = req.headers['sec-fetch-site'] === 'same-origin'
- const mode = getModeFromRequest(req)
- const { version } = req.query
+ const { packageRef, mode } = req.params
const verb = verbs[mode]
- if (!verb) {
- res.status(404).send(`Page not found: ${req.path}`)
- return
- }
+ const plugin = await getPluginDetailsFromRef(packageRef)
+
+ const err = getErrorIfModeNotAllowedForPlugin(mode, plugin)
- const chosenPlugin = await getPluginForRequest(req) || plugins.preparePackageNameForDisplay(req.query.package, version)
+ if (err) {
+ return next(err)
+ }
- const pageName = `${verb.title} ${chosenPlugin.name}`
+ const command = plugin?.commands && plugin?.commands[mode]
- const templatesReturnLink = {
- href: '/manage-prototype/templates',
- text: 'Back to templates'
+ if (!plugin) {
+ const err = new Error('Plugin not found.')
+ err.status = 404
+ return next(err)
}
- const pluginsReturnLink = {
- href: '/manage-prototype/plugins',
- text: 'Back to plugins'
+
+ if (!command) {
+ const err = new Error(`Command not found for mode "${mode}", options are ${Object.keys(plugin?.commands || {}).join(', ')}`)
+ err.status = 404
+ return next(err)
}
- const returnLink = req.query.returnTo === 'templates' ? templatesReturnLink : pluginsReturnLink
+ const pageName = `${verb.title} ${plugin.name}`
- const fullPluginName = `${chosenPlugin.name}${chosenPlugin.version ? ` version ${chosenPlugin.version} ` : ''}${chosenPlugin.scope ? ` from ${chosenPlugin.scope}` : ''}`
+ let returnLink
+ let cancelLink = plugin?.links.pluginDetails
+
+ if (req.query.returnTo === 'templates') {
+ returnLink = {
+ href: `${contextPath}/templates`,
+ text: 'Back to templates'
+ }
+ cancelLink = returnLink.href
+ } else if (mode === 'uninstall') {
+ returnLink = {
+ href: `${contextPath}/plugins`,
+ text: 'Back to plugins'
+ }
+ } else {
+ returnLink = {
+ href: `${contextPath}/plugin/installed:${encodeURIComponent(plugin.packageName)}`,
+ text: 'Back to plugin details'
+ }
+ }
- const pluginHeading = `${verb.title} ${fullPluginName}`
let dependencyHeading = ''
- if (chosenPlugin?.dependentPlugins?.length) {
- dependencyHeading = `Other plugins need ${fullPluginName}`
- } else if (chosenPlugin?.dependencyPlugins?.length) {
- dependencyHeading = `${fullPluginName} needs other plugins`
+ const relatedPlugins = mode === 'uninstall' ? await getRelatedPluginsForUninstall(plugin) : await getRelatedPluginsForInstallOrUpdate(plugin)
+
+ if (relatedPlugins.length > 0) {
+ const plural = relatedPlugins.length > 1
+ dependencyHeading = `To ${mode} this plugin, you also need to ${mode === 'update' ? 'install' : mode} ${(plural ? 'other plugins' : 'another plugin')}`
}
res.send(nunjucksManagementEnv.render(getManagementView('plugin-install-or-uninstall.njk'), {
@@ -643,115 +768,90 @@ async function getPluginsModeHandler (req, res) {
pageName,
currentUrl: req.originalUrl,
links: managementLinks,
- chosenPlugin,
- command: getCommand(mode, chosenPlugin),
- pluginHeading,
+ plugin,
+ command,
dependencyHeading,
verb,
isSameOrigin,
- returnLink
+ returnLink,
+ cancelLink,
+ relatedPlugins
}))
}
-function setKitRestarted (state) {
- kitRestarted = state
-}
+async function queueCommand (command) {
+ await fse.ensureDir(commandsDir)
-function getModeFromRequest (req) {
- const { mode } = req.params
- if (mode === 'upgrade') {
- return 'update'
- }
- return mode
+ const commandId = new Date().getTime()
+ const filePath = path.join(commandsDir, commandId + '.json')
+
+ await fse.writeJson(filePath, { command, restartOnCompletion: true, status: 'pending' })
+ return commandId
}
-async function postPluginsStatusHandler (req, res) {
- const mode = getModeFromRequest(req)
- let status = 'processing'
- try {
- if (kitRestarted) {
- const chosenPlugin = await getPluginForRequest(req)
- if (chosenPlugin) {
- if (modeIsComplete(mode, chosenPlugin)) {
- status = 'completed'
- } else if (chosenPlugin.installedLocally && mode === 'uninstall') {
- status = 'completed'
- }
- }
+function getErrorIfModeNotAllowedForPlugin (mode, plugin) {
+ if (mode === 'uninstall') {
+ if (getRequiredPlugins().includes(plugin.packageName)) {
+ const err = new Error('Uninstall restricted for this plugin')
+ err.status = 403
+ return err
}
- } catch (e) {
- if (mode !== 'uninstall') {
- console.log(e)
- }
- }
- if (status === 'completed') {
- setKitRestarted(false)
}
- res.json({ status })
}
-async function postPluginsModeMiddleware (req, res, next) {
- // Redirect to the GET route of the same url when the post request is not an ajax request
- if (req.headers['content-type'].indexOf('json') === -1) {
- res.redirect(req.originalUrl)
- } else {
- next()
- }
-}
+async function runPluginMode (req, res, next) {
+ const { mode, packageRef } = req.params
+ const plugin = await getPluginDetailsFromRef(packageRef)
-async function postPluginsModeHandler (req, res) {
- const mode = getModeFromRequest(req)
+ const err = getErrorIfModeNotAllowedForPlugin(mode, plugin)
- // Allow smooth update from 13.1.0 as the status route is incorrectly matched
- if (mode === 'status') {
- req.params.mode = 'update'
- return postPluginsStatusHandler(req, res)
+ if (err) {
+ return next(err)
}
- // Reset to false so the status route will only return completed when the prototype has restarted
- setKitRestarted(false)
+ let command = plugin.commands && plugin.commands[mode]
- const verb = verbs[mode]
-
- if (!verb) {
- res.json({ status: 'error' })
- return
+ if (mode === 'uninstall') {
+ const related = await getRelatedPluginsForUninstall(plugin)
+ command = command.replace('npm uninstall ', `npm uninstall ${related.map(x => x.packageName).join(' ')} `)
+ } else {
+ const related = await getRelatedPluginsForInstallOrUpdate(plugin)
+ command = command.replace('npm install ', `npm install ${related.map(x => x.packageName).join(' ')} `)
}
- // Prevent uninstalling the kit itself
- if (req.body.package === currentKitName && mode === 'uninstall') {
- res.json({ status: 'error' })
- return
- }
+ const commandId = await queueCommand(command)
- let status = 'processing'
+ res.send({
+ mode,
+ commandId,
+ statusUrl: `${contextPath}/command/${commandId}/status`
+ })
+}
+
+async function getCommandStatus (req, res) {
+ const { commandId } = req.params
try {
- const chosenPlugin = await getPluginForRequest(req)
- if (!chosenPlugin) {
- status = 'error'
- } else if (modeIsComplete(mode, chosenPlugin)) {
- status = 'completed'
- } else {
- const command = getCommand(mode, chosenPlugin)
- await exec(command, { cwd: projectDir })
- .finally(() => {
- console.log(`Completed ${command}`)
- // force the application to stop after a delay as nodemon restart does not always work on Windows when running acceptance tests
- setTimeout(() => {
- process.exit(1)
- }, 6000)
- })
- }
+ const status = await fse.readJson(path.join(commandsDir, commandId + '.json'))
+ res.send(status)
} catch (e) {
- console.log(e)
- status = 'error'
+ console.error(e)
+ res.status(400).send(e)
+ }
+}
+
+function getRequiredPlugins () {
+ const output = knownPlugins.required.filter(pluginName => pluginName !== 'govuk-frontend' || !getConfig().allowGovukFrontendUninstall)
+ return output
+}
+
+function legacyUpdateStatusCompatibilityHandler (req, res) {
+ if (req.body.package === 'govuk-prototype-kit') {
+ res.send({ status: 'completed' })
}
- res.json({ status })
}
module.exports = {
contextPath,
- setKitRestarted,
csrfProtection: [doubleCsrfProtection, csrfErrorHandler],
getPageLoadedHandler,
getCsrfTokenHandler,
@@ -760,7 +860,6 @@ module.exports = {
getPasswordHandler,
postPasswordHandler,
developmentOnlyMiddleware,
- pluginCacheMiddleware,
getHomeHandler,
getTemplatesHandler,
getTemplatesViewHandler,
@@ -769,8 +868,10 @@ module.exports = {
getTemplatesPostInstallHandler,
getPluginsHandler,
postPluginsHandler,
+ getPluginDetailsHandler,
+ postPluginDetailsHandler,
getPluginsModeHandler,
- postPluginsStatusHandler,
- postPluginsModeMiddleware,
- postPluginsModeHandler
+ getCommandStatus,
+ runPluginMode,
+ legacyUpdateStatusCompatibilityHandler
}
diff --git a/lib/manage-prototype-handlers.test.js b/lib/manage-prototype-handlers.test.js
index a0d0b57385..c5ccd320cc 100644
--- a/lib/manage-prototype-handlers.test.js
+++ b/lib/manage-prototype-handlers.test.js
@@ -8,12 +8,9 @@ const fse = require('fs-extra')
// local dependencies
const config = require('./config')
-const { requestHttpsJson } = require('./utils/requestHttps')
-const exec = require('./exec')
const plugins = require('./plugins/plugins')
-const packages = require('./plugins/packages')
-const projectPackage = require('../package.json')
-const knownPlugins = require('../known-plugins.json')
+
+const pluginDetails = require('./utils/packageDetails')
const mockNunjucksRender = jest.fn()
const mockNunjucksAppEnv = jest.fn(() => ({
@@ -27,30 +24,23 @@ jest.doMock('./nunjucks/nunjucksConfiguration', () => ({
}))
const {
- setKitRestarted,
getPasswordHandler,
getClearDataHandler,
- getHomeHandler,
postClearDataHandler,
postPasswordHandler,
developmentOnlyMiddleware,
- getTemplatesHandler,
getTemplatesViewHandler,
getTemplatesInstallHandler,
postTemplatesInstallHandler,
getTemplatesPostInstallHandler,
- getPluginsHandler,
- postPluginsStatusHandler,
- postPluginsModeMiddleware,
- getPluginsModeHandler,
- postPluginsModeHandler,
- postPluginsHandler
+ getHomeHandler,
+ getTemplatesHandler
} = require('./manage-prototype-handlers')
-const { projectDir } = require('./utils/paths')
// mocked dependencies
jest.mock('../package.json', () => {
return {
+ version: '1.0.0',
dependencies: {}
}
})
@@ -91,53 +81,6 @@ jest.mock('./plugins/plugins', () => {
}
})
-jest.mock('./plugins/plugin-utils', () => {
- return {
- getProxyPluginConfig: jest.fn().mockReturnValue({})
- }
-})
-
-jest.mock('./plugins/packages', () => {
- const packageWithPluginConfig = {
- packageName: 'test-package',
- installed: false,
- available: true,
- required: false,
- latestVersion: '2.0.0',
- versions: [
- '2.0.0',
- '1.0.0'
- ],
- packageJson: {},
- pluginConfig: {}
- }
- const packageWithoutPluginConfig = {
- packageName: 'test-package-not-a-plugin',
- installed: false,
- available: true,
- required: false,
- latestVersion: '2.0.0',
- versions: [
- '2.0.0',
- '1.0.0'
- ],
- packageJson: {}
- }
- return {
- lookupPackageInfo: jest.fn().mockImplementation((packageName) => {
- if (packageName === packageWithPluginConfig.packageName) {
- return packageWithPluginConfig
- } else {
- return undefined
- }
- }),
- getInstalledPackages: jest.fn().mockResolvedValue([]),
- getAllPackages: jest.fn().mockResolvedValue([packageWithPluginConfig, packageWithoutPluginConfig]),
- getDependentPackages: jest.fn().mockResolvedValue([]),
- getDependencyPackages: jest.fn().mockResolvedValue([])
- }
-})
-
jest.mock('./exec', () => {
return {
exec: jest.fn().mockReturnValue({ finally: jest.fn() })
@@ -233,14 +176,26 @@ describe('manage-prototype-handlers', () => {
})
it('getHomeHandler', async () => {
- packages.lookupPackageInfo.mockResolvedValue({ packageName: 'govuk-prototype-kit', latestVersion: '1.0.0' })
+ jest.spyOn(pluginDetails, 'getLatestPluginDetailsFromNpm').mockImplementation((packageName) => {
+ if (packageName === '@nowprototypeit/govuk') {
+ return {
+ version: '99.99.1',
+ latestVersion: '99.99.1',
+ links: {
+ pluginDetails: '/abc'
+ }
+ }
+ }
+ })
+
await getHomeHandler(req, res)
expect(mockNunjucksRender).toHaveBeenCalledWith(
'views/manage-prototype/index.njk',
expect.objectContaining({
- ...req.app.locals,
currentSection: 'Home',
- latestAvailableKit: '1.0.0'
+ latestAvailableKit: '99.99.1',
+ kitUpdateAvailable: true,
+ latestKitUrl: '/abc'
})
)
})
@@ -264,7 +219,6 @@ describe('manage-prototype-handlers', () => {
describe('templates handlers', () => {
const packageName = 'test-package'
const templateName = 'A page with everything'
- const pluginDisplayName = { name: 'Test Package' }
const templatePath = '/template'
const encodedTemplatePath = encodeURIComponent(templatePath)
const chosenUrl = '/chosen-url'
@@ -284,6 +238,7 @@ describe('manage-prototype-handlers', () => {
})
it('getTemplatesHandler', async () => {
+ jest.spyOn(pluginDetails, 'getInstalledPackages').mockResolvedValue([])
await getTemplatesHandler(req, res)
expect(mockNunjucksRender).toHaveBeenCalledWith(
'views/manage-prototype/templates.njk',
@@ -292,7 +247,7 @@ describe('manage-prototype-handlers', () => {
currentSection: 'Templates',
availableTemplates: [{
packageName,
- pluginDisplayName,
+ pluginDisplayName: { name: 'Test Package' },
templates: [{
installLink: `/manage-prototype/templates/install?package=${packageName}&template=${encodedTemplatePath}`,
name: templateName,
@@ -417,7 +372,7 @@ describe('manage-prototype-handlers', () => {
}).forEach(testPostTemplatesInstallHandler)
// Test each invalid character
- "!$&'()*+,;=:?#[]@.% "
+ '!$&\'()*+,;=:?#[]@.% '
.split('')
.map(invalidCharacter => ['invalid', `/${invalidCharacter}/abc`])
.forEach(testPostTemplatesInstallHandler)
@@ -439,257 +394,4 @@ describe('manage-prototype-handlers', () => {
)
})
})
-
- describe('plugins handlers', () => {
- const csrfToken = 'x-csrf-token'
- const packageName = 'test-package'
- const latestVersion = '2.0.0'
- const previousVersion = '1.0.0'
- const pluginDisplayName = { name: 'Test Package' }
- const availablePlugin = {
- installCommand: `npm install ${packageName}`,
- installLink: `/manage-prototype/plugins/install?package=${packageName}`,
- latestVersion,
- name: pluginDisplayName.name,
- packageName,
- uninstallCommand: `npm uninstall ${packageName}`,
- updateCommand: `npm install ${packageName}@${latestVersion}`
- }
-
- beforeEach(() => {
- knownPlugins.plugins = { available: [packageName] }
- projectPackage.dependencies = {}
- const versions = {}
- versions[latestVersion] = {}
- versions[previousVersion] = {}
- requestHttpsJson.mockResolvedValue({
- name: packageName,
- 'dist-tags': {
- latest: latestVersion,
- 'latest-1': previousVersion
- },
- versions
- })
- // mocking the reading of the local package.json
- fse.readJsonSync.mockReturnValue(undefined)
- packages.lookupPackageInfo.mockResolvedValue(Promise.resolve(availablePlugin))
- res.json = jest.fn().mockReturnValue({})
- })
-
- describe('getPluginsHandler', () => {
- it('plugins installed', async () => {
- fse.readJsonSync.mockReturnValue(undefined)
- req.route.path = 'plugins-installed'
- await getPluginsHandler(req, res)
- expect(mockNunjucksRender).toHaveBeenCalledWith(
- 'views/manage-prototype/plugins.njk',
- expect.objectContaining({
- ...req.app.locals,
- currentSection: 'Plugins',
- isSearchPage: false,
- isInstalledPage: true,
- plugins: [],
- status: 'installed'
- })
- )
- })
- it('plugins available', async () => {
- fse.readJsonSync.mockReturnValue(undefined)
- req.route.path = 'plugins'
- await getPluginsHandler(req, res)
- expect(mockNunjucksRender).toHaveBeenCalledWith(
- 'views/manage-prototype/plugins.njk',
- expect.objectContaining({
- ...req.app.locals,
- currentSection: 'Plugins',
- isSearchPage: true,
- isInstalledPage: false,
- plugins: [availablePlugin],
- status: 'search'
- })
- )
- })
- })
-
- it('postPluginsHandler', async () => {
- const search = 'task list'
- const routePath = '/plugins-installed'
- const fullPath = '/manage-prototype' + routePath
- req.body.search = search
- req.route.path = routePath
- await postPluginsHandler(req, res)
- expect(res.redirect).toHaveBeenCalledWith(fullPath + '?search=' + search)
- })
-
- it('getPluginsModeHandler', async () => {
- req.params.mode = 'install'
- req.query.package = packageName
- req.csrfToken = jest.fn().mockReturnValue(csrfToken)
- await getPluginsModeHandler(req, res)
- expect(mockNunjucksRender).toHaveBeenCalledWith(
- 'views/manage-prototype/plugin-install-or-uninstall.njk',
- expect.objectContaining({
- ...req.app.locals,
- chosenPlugin: availablePlugin,
- command: `npm install ${packageName} --save-exact`,
- currentSection: 'Plugins',
- pageName: `Install ${pluginDisplayName.name}`,
- currentUrl: req.originalUrl,
- isSameOrigin: false,
- returnLink: {
- href: '/manage-prototype/plugins',
- text: 'Back to plugins'
- }
- })
- )
- })
-
- describe('postPluginsModeHandler', () => {
- beforeEach(() => {
- req.params.mode = 'install'
- req.body.package = packageName
- })
-
- it('processing', async () => {
- await postPluginsModeHandler(req, res)
- expect(exec.exec).toHaveBeenCalledWith(
- availablePlugin.installCommand + ' --save-exact',
- { cwd: projectDir }
- )
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'processing'
- })
- )
- })
-
- it('processing specific version', async () => {
- packages.lookupPackageInfo.mockResolvedValue({
- packageName: 'test-package',
- installed: false,
- versions: ['1.0.0']
- })
- req.body.version = previousVersion
- const installSpecificCommand = availablePlugin.installCommand + `@${previousVersion}`
- await postPluginsModeHandler(req, res)
- expect(exec.exec).toHaveBeenCalledWith(
- installSpecificCommand + ' --save-exact',
- { cwd: projectDir }
- )
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'processing'
- })
- )
- })
-
- it('error invalid package', async () => {
- packages.lookupPackageInfo.mockResolvedValue(undefined)
- req.body.package = 'invalid-package'
- await postPluginsModeHandler(req, res)
- expect(exec.exec).not.toHaveBeenCalled()
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'error'
- })
- )
- })
-
- it('error invalid version', async () => {
- req.body.version = '1.0.0-invalid'
- await postPluginsModeHandler(req, res)
- expect(exec.exec).not.toHaveBeenCalled()
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'error'
- })
- )
- })
-
- it('is passed on to the postPluginsStatusHandler when status matches mode during update from 13.1 to 13.2.4 and upwards', async () => {
- req.params.mode = 'status'
- setKitRestarted(true)
- await postPluginsModeHandler(req, res)
-
- // req.params.mode should change to update
- expect(req.params.mode).toEqual('update')
-
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'processing'
- })
- )
- })
- })
-
- describe('postPluginsStatusHandler', () => {
- let pkg
-
- beforeEach(() => {
- req.params.mode = 'install'
- req.query.package = packageName
- pkg = {
- name: packageName,
- version: latestVersion,
- dependencies: { [packageName]: latestVersion }
- }
- fse.readJsonSync.mockReturnValue(pkg)
- })
-
- it('is processing', async () => {
- await postPluginsStatusHandler(req, res)
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'processing'
- })
- )
- })
-
- it('is completed', async () => {
- packages.lookupPackageInfo.mockResolvedValue({
- packageName: 'test-package',
- installedVersion: '2.0.0'
- })
- setKitRestarted(true)
- await postPluginsStatusHandler(req, res)
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'completed'
- })
- )
- })
-
- it('uninstall local plugin is completed', async () => {
- const localPlugin = 'local-plugin'
- req.params.mode = 'uninstall'
- req.query.package = localPlugin
- pkg.dependencies[localPlugin] = 'file:../../local-plugin'
- packages.lookupPackageInfo.mockResolvedValue({
- packageName: 'test-package',
- installed: false
- })
- setKitRestarted(true)
- await postPluginsStatusHandler(req, res)
- expect(res.json).toHaveBeenCalledWith(
- expect.objectContaining({
- status: 'completed'
- })
- )
- })
- })
-
- describe('postPluginsModeMiddleware', () => {
- it('with AJAX', async () => {
- req.headers['content-type'] = 'application/json'
- await postPluginsModeMiddleware(req, res, next)
- expect(next).toHaveBeenCalled()
- })
-
- it('without AJAX', async () => {
- req.headers['content-type'] = 'document/html'
- await postPluginsModeMiddleware(req, res, next)
- expect(res.redirect).toHaveBeenCalledWith(req.originalUrl)
- })
- })
- })
})
diff --git a/lib/manage-prototype-routes.js b/lib/manage-prototype-routes.js
index 42c824c03e..be02eb931f 100644
--- a/lib/manage-prototype-routes.js
+++ b/lib/manage-prototype-routes.js
@@ -3,7 +3,6 @@ const express = require('express')
const {
contextPath,
- setKitRestarted,
csrfProtection,
getPageLoadedHandler,
getCsrfTokenHandler,
@@ -19,12 +18,13 @@ const {
postTemplatesInstallHandler,
getTemplatesPostInstallHandler,
getPluginsHandler,
+ postPluginsHandler,
+ getPluginDetailsHandler,
+ postPluginDetailsHandler,
+ runPluginMode,
+ getCommandStatus,
getPluginsModeHandler,
- postPluginsModeMiddleware,
- postPluginsModeHandler,
- postPluginsStatusHandler,
- pluginCacheMiddleware,
- postPluginsHandler
+ legacyUpdateStatusCompatibilityHandler
} = require('./manage-prototype-handlers')
const { packageDir, projectDir } = require('./utils/paths')
const { govukFrontendPaths } = require('./govukFrontendPaths')
@@ -51,8 +51,6 @@ router.post('/password', postPasswordHandler)
// view when the prototype is not running in development
router.use(developmentOnlyMiddleware)
-router.use(pluginCacheMiddleware)
-
router.get('/', getHomeHandler)
router.get('/templates', getTemplatesHandler)
@@ -69,21 +67,33 @@ router.get('/plugins', getPluginsHandler)
router.post('/plugins', postPluginsHandler)
router.get('/plugins-installed', getPluginsHandler)
-// Be aware that changing this path for monitoring the status of a plugin will affect the
-// kit update process as the browser request and server route would be out of sync.
-router.post('/plugins/:mode/status', postPluginsStatusHandler)
-
-router.get('/plugins/:mode', csrfProtection, getPluginsModeHandler)
+router.get('/plugin/:packageRef', getPluginDetailsHandler)
+router.post('/plugin', postPluginDetailsHandler)
+router.get('/plugin/:packageRef/:mode', getPluginsModeHandler)
+router.post('/plugin/:packageRef/:mode', csrfProtection, runPluginMode)
-router.post('/plugins/:mode', postPluginsModeMiddleware)
+router.get('/command/:commandId/status', getCommandStatus)
-router.post('/plugins/:mode', csrfProtection, postPluginsModeHandler)
+// // Be aware that changing this path for monitoring the status of a plugin will affect the
+// // kit update process as the browser request and server route would be out of sync.
+router.post('/plugins/:mode', legacyUpdateStatusCompatibilityHandler)
// Find GOV.UK Frontend (via internal package, project fallback)
router.use('/dependencies/govuk-frontend', express.static(
govukFrontendPaths([packageDir, projectDir]).baseDir)
)
-setKitRestarted(true)
+router.use((err, req, res, next) => {
+ if (err.status === 404) {
+ next(err)
+ } else {
+ res.status(err.status || 500).render('views/error-handling/server-error.njk', {
+ error: {
+ message: err.message,
+ errorStack: err.stack
+ }
+ })
+ }
+})
module.exports = router
diff --git a/lib/nunjucks/govuk-prototype-kit/includes/homepage-bottom.njk b/lib/nunjucks/nowprototypeit/includes/homepage-bottom.njk
similarity index 100%
rename from lib/nunjucks/govuk-prototype-kit/includes/homepage-bottom.njk
rename to lib/nunjucks/nowprototypeit/includes/homepage-bottom.njk
diff --git a/lib/nunjucks/govuk-prototype-kit/includes/homepage-top.njk b/lib/nunjucks/nowprototypeit/includes/homepage-top.njk
similarity index 62%
rename from lib/nunjucks/govuk-prototype-kit/includes/homepage-top.njk
rename to lib/nunjucks/nowprototypeit/includes/homepage-top.njk
index 3f15dcdeed..2a35ef2c83 100644
--- a/lib/nunjucks/govuk-prototype-kit/includes/homepage-top.njk
+++ b/lib/nunjucks/nowprototypeit/includes/homepage-top.njk
@@ -1,8 +1,8 @@
-
- GOV.UK Prototype Kit
+
+ Now Prototype It Kit
-{% if (GOVUKPrototypeKit.isDevelopment) %}
+{% if (NowPrototypeIt.isDevelopment) %}
diff --git a/lib/nunjucks/govuk-prototype-kit/includes/scripts.njk b/lib/nunjucks/nowprototypeit/includes/scripts.njk
similarity index 100%
rename from lib/nunjucks/govuk-prototype-kit/includes/scripts.njk
rename to lib/nunjucks/nowprototypeit/includes/scripts.njk
diff --git a/lib/nunjucks/govuk-prototype-kit/includes/stylesheets-plugins.njk b/lib/nunjucks/nowprototypeit/includes/stylesheets-plugins.njk
similarity index 100%
rename from lib/nunjucks/govuk-prototype-kit/includes/stylesheets-plugins.njk
rename to lib/nunjucks/nowprototypeit/includes/stylesheets-plugins.njk
diff --git a/lib/nunjucks/govuk-prototype-kit/includes/stylesheets.njk b/lib/nunjucks/nowprototypeit/includes/stylesheets.njk
similarity index 100%
rename from lib/nunjucks/govuk-prototype-kit/includes/stylesheets.njk
rename to lib/nunjucks/nowprototypeit/includes/stylesheets.njk
diff --git a/lib/nunjucks/nowprototypeit/layouts/branded.njk b/lib/nunjucks/nowprototypeit/layouts/branded.njk
new file mode 100644
index 0000000000..ea3f1fdcb5
--- /dev/null
+++ b/lib/nunjucks/nowprototypeit/layouts/branded.njk
@@ -0,0 +1,67 @@
+{%- set assetPath = assetPath | default('/plugin-assets/govuk-frontend' + govukFrontend.assetPath) -%}
+
+
+
+ {% block head %}
+ {% block meta %}{% endblock %}
+ {% block stylesheets %}
+ {% include "govuk-prototype-kit/includes/stylesheets.njk" %}
+ {% endblock %}
+ {% endblock %}
+
+ {% block pageTitle %}
+ {% if pageName %}{{ pageName }} - {% endif %}{{ serviceName }} - Now Prototype It
+ {% endblock %}
+
+
+
+
+{% block header %}
+
+
+
+ Now Prototype It
+
+
+{% endblock %}
+
+
+ {% block content %}{% endblock %}
+
+
+{% block bodyEnd %}
+ {% block scripts %}
+ {% include "govuk-prototype-kit/includes/scripts.njk" %}
+ {% block pageScripts %}{% endblock %}
+ {% endblock %}
+{% endblock %}
+
diff --git a/lib/nunjucks/govuk-prototype-kit/layouts/govuk-branded.njk b/lib/nunjucks/nowprototypeit/layouts/govuk-branded.njk
similarity index 100%
rename from lib/nunjucks/govuk-prototype-kit/layouts/govuk-branded.njk
rename to lib/nunjucks/nowprototypeit/layouts/govuk-branded.njk
diff --git a/lib/nunjucks/govuk-prototype-kit/layouts/unbranded.njk b/lib/nunjucks/nowprototypeit/layouts/unbranded.njk
similarity index 62%
rename from lib/nunjucks/govuk-prototype-kit/layouts/unbranded.njk
rename to lib/nunjucks/nowprototypeit/layouts/unbranded.njk
index a759fc767d..aeffb57036 100644
--- a/lib/nunjucks/govuk-prototype-kit/layouts/unbranded.njk
+++ b/lib/nunjucks/nowprototypeit/layouts/unbranded.njk
@@ -1,7 +1,7 @@
-{% extends "govuk-prototype-kit/layouts/govuk-branded.njk" %}
+{% extends "nowprototypeit/layouts/govuk-branded.njk" %}
{% block headIcons %}
-
+
{% endblock %}
{% block stylesheets %}
diff --git a/lib/nunjucks/nunjucksLoader.js b/lib/nunjucks/nunjucksLoader.js
index 7c5b06d5c0..822b2fb5c5 100644
--- a/lib/nunjucks/nunjucksLoader.js
+++ b/lib/nunjucks/nunjucksLoader.js
@@ -69,6 +69,12 @@ const NunjucksLoader = nunjucks.Loader.extend({
}
if (!pathToFile) {
+ if (name.startsWith('govuk-prototype-kit')) {
+ try {
+ return this.getSource(name.replace('govuk-prototype-kit', 'nowprototypeit'))
+ } catch (e) {}
+ }
+ console.log('error getting', name)
endPerformanceTimer('getSource (failure)', timer)
const error = new Error(`template not found: ${name}`)
error.internalErrorCode = 'TEMPLATE_NOT_FOUND'
diff --git a/lib/nunjucks/views/backup-homepage.njk b/lib/nunjucks/views/backup-homepage.njk
index fb31047f95..6756e8ef66 100644
--- a/lib/nunjucks/views/backup-homepage.njk
+++ b/lib/nunjucks/views/backup-homepage.njk
@@ -1,7 +1,7 @@
-{% extends "govuk-prototype-kit/layouts/unbranded.njk" %}
+{% extends "now-prototype-it-govuk/layouts/unbranded.njk" %}
{% block pageTitle %}
-Home – GOV.UK Prototype Kit
+Home – Now Prototype It Kit
{% endblock %}
{% block content %}
diff --git a/lib/nunjucks/views/error-handling/page-not-found.njk b/lib/nunjucks/views/error-handling/page-not-found.njk
index 25617cae87..657df6f7fb 100644
--- a/lib/nunjucks/views/error-handling/page-not-found.njk
+++ b/lib/nunjucks/views/error-handling/page-not-found.njk
@@ -1,7 +1,7 @@
{% extends "views/manage-prototype/layout.njk" %}
{% block pageTitle %}
- Page not found – {{ serviceName }} – GOV.UK Prototype Kit
+ Page not found – Now Prototype It
{% endblock %}
{% set mainClasses = "govuk-main-wrapper--l" %}
@@ -21,9 +21,6 @@
a form in your code is wrong
you have not created the page yet
-
- You can try and fix this yourself or contact the GOV.UK Prototype Kit team if you need help.
-
{% endblock %}
diff --git a/lib/nunjucks/views/error-handling/server-error.njk b/lib/nunjucks/views/error-handling/server-error.njk
index 7359f7b682..d8650d19e9 100644
--- a/lib/nunjucks/views/error-handling/server-error.njk
+++ b/lib/nunjucks/views/error-handling/server-error.njk
@@ -1,11 +1,11 @@
{% extends "views/manage-prototype/layout.njk" %}
{% block pageTitle %}
- Error {% if serviceName %}– {{ serviceName }}{% endif %} – GOV.UK Prototype Kit
+ Error – Now Prototype It
{% endblock %}
{% block header %}
-
+
{{ super() }}
{% endblock %}
@@ -17,26 +17,26 @@
There is an error
{% if error.filePath %}
-
- File: {{ error.filePath }} {% if error.line %}(line {{ error.line }}){% endif %}
+
+ File: {{ error.filePath }} {% if error.line %}(line {{ error.line }}){% endif %}
{% endif %}
-
- Error: {{ error.message }}
+
+ Error: {{ error.message }}
{% if error.sourceCode %}
- {{ error.sourceCode.before }}
{{ error.sourceCode.error }}
{{ error.sourceCode.after }}
+ {{ error.sourceCode.before }}
{{ error.sourceCode.error }}
{{ error.sourceCode.after }}
{% endif %}
-