Merge pull request #638 from citation-file-format/610-cypress

Author: abelsiqueira

.eslintrc.js

@@ -42,6 +42,8 @@ module.exports = {
     'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability)
     // 'plugin:vue/vue3-recommended', // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)
 
+    'plugin:cypress/recommended',
+
     'standard'
 
   ],

.github/workflows/test.yml

@@ -24,4 +24,14 @@ jobs:
     - name: Run unit tests
       run: npm run test:unit:ci
 
-
+  cypress:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.head_ref }}
+    - name: Cypress run
+      uses: cypress-io/github-action@v4
+      with:
+        start: npm run dev
+        wait-on: 'http://localhost:8080/cff-initializer-javascript/#'

.gitignore

@@ -32,3 +32,8 @@ yarn-error.log*
 *.njsproj
 *.sln
 node_modules
+
+# Cypress
+cypress/downloads
+cypress/screenshots
+cypress/videos

README.dev.md

@@ -51,6 +51,8 @@ npm run build
 
 ## Tests
 
+### Unit tests
+
 We use `Jest` for unit tests. The unit tests can be found under `test/jest/__tests__/` folder.
 
 You can run the test with
@@ -65,6 +67,33 @@ You can also use the Majestic web interface to run the unit tests in your browse
 npm run test:unit:ui
 ```
 
+### End-to-end tests
+
+We use [Cypress](https://cypress.io) for end-to-end tests. These tests can be found under the `cypress/e2e` folder.
+
+You can start Cypress with
+
+```shell
+npm run cypress:open
+```
+
+Select "E2E Testing", which should be configured already and select the desired browser and click the start button.
+
+A browser will open with the list of tests, which can be explored.
+It should look like this:
+
+<figure style="text-align: center; width=80%;">
+  <img alt="Cypress E2E specs list" src="https://docs.cypress.io/_nuxt/img/spec-list-with-new-spec.61d015d.png">
+  <caption>
+    Cypress E2E specs list. Image is from https://docs.cypress.io/guides/end-to-end-testing/writing-your-first-end-to-end-test
+  </caption>
+</figure>
+
+Click on the spec file.
+The next screen will show the tests being executed.
+If anything goes wrong, you will see it in red.
+For more information, check <https://docs.cypress.io/guides/end-to-end-testing/testing-your-app#What-you-ll-learn>.
+
 ## Linting and formatting
 
 ```shell

cypress.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'cypress'
+
+export default defineConfig({
+    e2e: {
+        baseUrl: 'http://localhost:8080/cff-initializer-javascript/#',
+        supportFile: false // If the support/e2e.ts or support/commands.ts files are reinstated, delete this line
+    }
+})

cypress/e2e/spec.cy.ts

@@ -0,0 +1,40 @@
+const minimumCff = '# This CITATION.cff file was generated with cffinit.\n# Visit https://bit.ly/cffinit to generate yours today!\n\ncff-version: 1.2.0\ntitle: My Title\nmessage: >-\n  If you use this software, please cite it using the\n  metadata from this file.\ntype: software\nauthors:\n  - {}\n'
+
+describe('Minimum usage', () => {
+    it('Visit site, fill minimum information and download', () => {
+        // Main screen
+        cy.visit('/')
+        cy.contains('Generate your citation metadata files with ease')
+        cy.get('[data-cy="btn-create"]')
+            .click()
+
+        // Start screen
+        cy.url().should('include', '/start')
+        cy.get('[data-cy="input-title"]')
+            .type('My Title')
+            .should('have.value', 'My Title')
+        cy.get('[data-cy="input-message"]')
+            .should('have.value', 'If you use this software, please cite it using the metadata from this file.')
+        cy.get('[data-cy="btn-next"]')
+            .click()
+
+        // Author screen
+        cy.url().should('include', '/authors')
+        cy.get('[data-cy="btn-add-author"]')
+            .click()
+        cy.get('[data-cy="btn-done"]')
+            .click()
+        cy.get('[data-cy="btn-next"]')
+            .click()
+
+        // Finish Minimum screen
+        cy.url().should('include', '/finish-minimum')
+        cy.get('[data-cy="btn-download"]')
+            .click()
+        const downloadsFolder = Cypress.config('downloadsFolder')
+        const cfffile = `${downloadsFolder}/CITATION.cff`
+
+        cy.readFile(cfffile, 'binary', { timeout: 400 })
+            .should(buffer => expect(buffer).to.be.equal(minimumCff))
+    })
+})