fix(ci): add int test to travis, add docs, remove kitchensink

Author: duncdrum

.gitignore

@@ -8,3 +8,6 @@ node_modules/*
 node/*
 
 maven-archiver/
+
+src/test/cypress/videos/*.mp4
+src/test/cypress/screenshots/**/*.png

.travis.yml

@@ -27,6 +27,7 @@ before_script:
 script:
   - mvn validate
   - mvn test
+  - npm run cypress
 
 after_success:
   - docker ps

README.md

@@ -39,7 +39,14 @@ Should you encounter documentation for features that are deprecated in the minim
 3.  Install this file via the Dashboard > Package Manager.
 
 ## (WIP) Testing
-Tests are executed locally by maven or on travis. To validate xml files run `mvn validate`, to run the javascript tests `mvn test` (xQsuite coming soon). We do **not** support testing via node alone, aka `npm test`, use the maven command instead.
+
+### Unit tests
+The full test-suite consists of validation, unit, and integration tests, it runs automatically on travis. To be able to run integration tests locally, contributors should run `npm i` to download and install [cypress.js](https://www.cypress.io). This is only required once. To execute the tests run the following commands:          
+-   To validate xml files run `mvn validate`,
+-   to run the javascript tests `mvn test` (xQsuite coming soon). We do **not** support testing via node alone, aka `npm test`, use the maven command instead.
+-   To run the Integrations tests `npm run cypress`.
+
+Both unit and integration tests, expect a running instance of exist with a copy of the documentation app installed reachable at `localhost:8080` and an empty admin password. 
 
 ## License
 LGPLv2.1 [eXist-db.org](http://exist-db.org/exist/apps/homepage/index.html)

package.json

@@ -4,7 +4,7 @@
   "description": "Documentation package for eXist-db",
   "scripts": {
     "test": "mocha src/test/mocha/ --recursive --exit",
-    "cypress": "cypress run" 
+    "cypress": "cypress run"
   },
   "repository": {
     "type": "git",

src/test/cypress/fixtures/users.json

@@ -0,0 +1,19 @@
+/// <reference types="cypress" />
+
+// This is very slow and therefore skipped. Once diagnostics are re-written
+// we might bring this back. In the meantime dead-links are tested via xQsuite
+// see #
+
+context.skip('Diagnostics', () => {
+  before(() => {
+    cy.visit('/diagnostics.html', {responseTimeout: 60000})
+
+  })
+  it('should not find dead links', () => {
+    cy.get('h1')
+      .contains('Documentation link diagnostics')
+      .parents('#main')
+      .find('ul')
+      .contains('advanced-installation.xml')
+  })
+})

src/test/cypress/integration/diagnostic_spec.js

@@ -0,0 +1,70 @@
+/// <reference types="cypress" />
+
+context('Documentation', () => {
+  beforeEach(() => {
+    cy.visit('/')
+  })
+  describe('landing article', () => {
+    it('should have content prose', () => {
+      cy.title('documentation')
+      cy.get('h1')
+        .contains('Documentation')
+        .parents('article')
+        .find('section > h2')
+        .contains('Alphabetical index')
+        .parents('article')
+        .contains('Subject index')
+    })
+
+    describe('generated indexes', () => {
+      it('should contain articles by alphabet', () => {
+        cy.get('[name=alphabetical-index]')
+          .parents('section')
+          .contains('Integration Testing')
+      })
+
+      it('should contain articles by subject', () => {
+        cy.get('[name=subject-index]')
+          .parents('section')
+          .contains('Integration Testing')
+      })
+
+    })
+
+    it('should have ToC links', () => {
+      cy.get('#sidebar')
+        .find('.toc')
+        .within(($toc) => {
+          cy.get('li')
+            .contains('Getting Started')
+            .click()
+            .url()
+            .should('include', '#start')
+        })
+    })
+
+    describe('navbar', () => {
+      it('should enable simple search', () => {
+        cy.get('.search-query')
+          .type('testing{enter}')
+          .url().should('include', 'search.html')
+        cy.get('body')
+          .find('#f-results')
+          .contains('Integration Testing')
+          .click()
+          .url()
+          .should('include', 'integration-testing.xml')
+      })
+
+      it('should reference author guidelines', () => {
+        cy.get('.navbar')
+          .find('#documentation')
+          .click()
+          .contains('author guidelines')
+          .click()
+          .url()
+          .should('include', 'author-reference.xml')
+      })
+    })
+  })
+})