Test page titles (#1800)

* Remove one off test for command line title

* write tests to check h1 page title against clicked link

* fix syntax err in table of contents when running in cypress open

* package-lock

* Fix page titles that were incorrect - caught in tests

Author: jennifer-shehane

cypress/integration/i18n_spec.js

@@ -7,13 +7,6 @@ describe('i18n', () => {
     cy.url().should('contain', 'why-cypress')
   })
 
-  it('uses English in Command Line guide', () => {
-    cy.visit('/guides/guides/command-line.html')
-    cy.document().its('documentElement.lang').should('equal', 'en')
-    cy.get('meta[property="og:title"]').invoke('attr', 'content').should('equal', 'Command Line')
-    cy.contains('h1', 'Command Line')
-  })
-
   context('language select', () => {
     it('selects English by default', () => {
       cy.get('#lang-select').find('option')

cypress/integration/page_header_spec.js

@@ -1,8 +1,60 @@
+const YAML = require('yamljs')
+const _ = require('lodash')
+
 describe('Page Header', () => {
   beforeEach(() => {
     cy.server()
   })
 
+  it('displays correct page title', function () {
+    cy.wrap(this.langValues).each(function (lang) {
+      let sidebarYaml = 'source/_data/sidebar.yml'
+      let visitUrlPrefix = ''
+
+      if (lang !== 'en') {
+        sidebarYaml = `source/${lang}/_data/sidebar.yml`
+        visitUrlPrefix = lang
+      }
+
+      cy.wrap(this.MAIN_NAV).each((nav) => {
+        // the Plugin docs doesn't have a sidebar
+        // the API docs don't really need translations (since it's all commands)
+        if (nav.name === 'Plugins' || nav.name === 'API') return
+
+        cy.readFile(sidebarYaml)
+        .then(function (yamlString) {
+          this.navName = _.toLower(nav.name)
+
+          this.sidebar = YAML.parse(yamlString)
+          this.sidebarTitles = _.keys(this.sidebar[this.navName])
+
+          this.sidebarLinkNames = _.reduce(this.sidebar[this.navName], (memo, nestedObj) => memo.concat(_.keys(nestedObj))
+            , [])
+
+          this.sidebarLinks = _.reduce(this.sidebar[this.navName], (memo, nestedObj) => memo.concat(_.values(nestedObj))
+            , [])
+
+          cy.visit(`${visitUrlPrefix}${nav.path}.html`)
+
+          cy.get('.sidebar-link')
+          .each(($linkElement) => {
+            cy.request(`${$linkElement[0].href}`).its('body')
+            .then((body) => {
+              const page = _.last($linkElement[0].href.split('/'))
+
+              if (page !== 'assertions.html') {
+                const $body = Cypress.$(body)
+                const $h1 = $body.find('h1.article-title')
+
+                expect($h1.text(), `Page title '${$h1.text()}' in ${page} matches translated title in ${lang}.yml`).to.eq($linkElement.text().trim())
+              }
+            })
+          })
+        })
+      })
+    })
+  })
+
   it('should have link to edit doc', function () {
     cy.wrap(this.MAIN_NAV).each((nav) => {
       let path = `${nav.path}.html`

cypress/integration/sidebar_spec.js

@@ -20,10 +20,6 @@ context('Sidebar', () => {
   })
 
   context('Titles and links', () => {
-    beforeEach(() => {
-
-    })
-
     it('displays titles and links in sidebar', function () {
       cy.wrap(this.langValues).each(function (lang) {
         let sidebarYaml = 'source/_data/sidebar.yml'
@@ -71,8 +67,6 @@ context('Sidebar', () => {
             })
           })
         })
-
-
       })
     })
   })

cypress/integration/table_of_contents.js

@@ -3,7 +3,7 @@ const GUIDES_PATH = '/guides/overview/why-cypress.html'
 const API_PATH = '/api/api/table-of-contents'
 
 describe('Table of Contents', () => {
-  beforeEach(() => {
+  beforeEach(function () {
     //# skip running this test if we are in interactive mode
     if (Cypress.config('isInteractive')) {
       this.skip()