CI integration and tests creation

.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: Farol Verde Tests
+on: 
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  Cypress:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository content
+        uses: actions/checkout@v2
+      - name: Run Project containers
+        run: docker-compose up -d
+      - name: Run Migrate
+        run: docker exec farol_verde_server /bin/bash -c "python manage.py migrate"
+      - name: Run Cypress
+        run: docker exec farol_verde_tests /bin/bash -c "cd /tests && cypress run"
+
+  Black:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository content
+        uses: actions/checkout@v2 
+      - name: Run Project containers
+        run: docker-compose up -d
+      - name: Run Black Check
+        run: docker exec farolwagtail /bin/bash -c "black --check ."

.gitignore

@@ -2,3 +2,5 @@ __pycache__/
 *.pyc
 .vscode*
 landing/static
+/tests/cypress/videos
+/tests/cypress/screenshots

Makefile

@@ -1,8 +1,12 @@
-SERVER_CONTAINER=farol_verde_server
+SERVER_CONTAINER=farolwagtail
+TEST_CONTAINER=faroltests
 
 attach:
 	docker exec -it $(SERVER_CONTAINER) bash
 
+test-attach:
+	docker exec -it $(TEST_CONTAINER) bash
+
 up:
 	docker-compose up
 
@@ -12,6 +16,9 @@ stop:
 rm:
 	docker-compose rm
 
+test:
+	docker exec $(TEST_CONTAINER) /bin/bash -c "cd /tests && cypress run"
+
 createsu:
 	docker exec -it $(SERVER_CONTAINER) poetry run python manage.py createsuperuser
 

docker-compose.yml

@@ -2,7 +2,7 @@ version: "3.3"
 
 services:
 
-  farol_verde_server:
+  server:
     environment:
       - PYTHONUNBUFFERED=1
     env_file:
@@ -15,7 +15,7 @@ services:
       - ./landing:/landing
       - farol_verde:/tmp/farol_verde_db
       - media:/landing/media
-    container_name: farol_verde_server
+    container_name: farolwagtail
     depends_on:
       - farol_verde_db
     entrypoint: ["/bin/bash", "run.sh"]
@@ -38,6 +38,16 @@ services:
     ports:
       - "5656:5656"
 
+  tests:
+    image: cypress/included:10.7.0
+    container_name: faroltests
+    working_dir: /tests
+    volumes:
+      - ./tests:/tests
+    depends_on:
+      - server
+    entrypoint: ["tail", "-f", "/dev/null"]
+
 volumes:
   farol_verde:
   media:

tests/cypress.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  e2e: {
+    baseUrl: 'http://farolwagtail:8000',
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+};

tests/cypress/e2e/candidates/profile.cy.js

@@ -0,0 +1,11 @@
+describe('Test candidate profile page', () => {
+    it("Open UF board", () => {
+        cy.visit('/candidatos/');
+        cy.get('.right a').click();
+
+        cy.get('.candidate').each(candidate => {
+            cy.wrap(candidate)
+                .should('have.attr', 'href');
+        })
+    })
+});

tests/cypress/e2e/candidates/senators.cy.js

@@ -0,0 +1,23 @@
+describe('Test senators and deputies', () => {
+    it('Select "Senadores" and "Deputados"', () => {
+        cy.visit('/candidatos/');
+        cy.get('.right a').click();
+
+        cy.get('#deputies').click();
+        cy.wait(600);
+        cy.get('.candidate__info').each(info => {
+            cy.wrap(info)
+                .invoke('text')
+                .should('contain', 'Senador(a)');
+        });
+
+        cy.get('#deputies').click();
+        cy.get('#senators').click();
+        cy.wait(600);
+        cy.get('.candidate__info').each(info => {
+            cy.wrap(info)
+                .invoke('text')
+                .should('contain', 'Deputado(a)');
+        });
+    })
+})

tests/cypress/e2e/candidates/uf.cy.js

@@ -0,0 +1,22 @@
+describe('Test UF filter', () => {
+    it("Open UF board", () => {
+        cy.visit('/candidatos/');
+        cy.get('.right a').click();
+        cy.get('#uf .input-board__content label')
+            .each(stateBtn => {
+                cy.get('#uf button.input-board__btn').click();
+                cy.wrap(stateBtn)
+                    .click()
+                    .invoke('text')
+                    .then(state => {
+                        state = state.trim().replaceAll('\n', '');
+                        cy.wait(750);
+                        cy.get('.candidate__info').each(info => {
+                            cy.wrap(info)
+                                .invoke('text')
+                                .should('contain', state);
+                        });
+                    });
+            });
+    })
+});

tests/cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// 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) => { ... })

tests/cypress/support/e2e.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.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')