[tests][m]- Setup Integration Tests with Cypress #26

lauragift21 · 2020-06-18T14:55:09Z

Install and setup Cypress
Write tests
Setup CI

fixes:#21

vercel · 2020-06-18T14:55:18Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/datopian1/portal/nioyvp6by
✅ Preview: https://portal-git-setup-integration-tests-with-cypress.datopian1.vercel.app

anuveyatsu · 2020-06-25T11:26:32Z

package.json

@@ -36,6 +41,8 @@
    "@types/react": "^16.9.35",
    "babel-jest": "^26.0.1",
    "babel-plugin-graphql-tag": "^2.5.0",
+    "cypress": "^4.8.0",
+    "dotenv": "^8.2.0",


@lauragift21 do you need dotenv or is it leftover?

I don't think so I'll take it out.

anuveyatsu · 2020-06-25T11:30:27Z

cypress/integration/pages/home_page_spec.ts

+    cy.contains('Find, Share and Publish Quality Data with Datahub');
+  });
+  it('displays a search form', () => {
+    cy.get('form').type('dataset').contains('Search').click();


Can we test if it actually works? E.g., it should redirect you to search page with results for your query.

anuveyatsu · 2020-06-25T11:30:52Z

cypress/integration/pages/home_page_spec.ts

+    cy.get('form').type('dataset').contains('Search').click();
+  });
+  it('show the recent datasets', () => {
+    cy.contains('Recent Datasets');


Can we test if it shows expected number of recent datasets?

anuveyatsu · 2020-06-25T11:31:12Z

cypress/integration/pages/search_spec.ts

+describe('Test Search Page', () => {
+  it('has a search form', () => {
+    cy.visit('/search');
+    cy.location('pathname').should('equal', '/search');


Not sure if this is valuable here.

anuveyatsu · 2020-06-25T11:31:53Z

cypress/integration/pages/search_spec.ts

+    cy.visit('/search');
+    cy.location('pathname').should('equal', '/search');
+    cy.get('form').find('input').type('world population');
+    cy.get('form').submit();


I think we can have separate case for testing if the search form actually works.. eg, you type in and submit and get some results.

Again, I'd test for expected result when you type "world population":

query param

it returns X number of results

anuveyatsu · 2020-06-25T11:32:43Z

@lauragift21 I've added number of comments above.

How the CI works? I've seen github actions and Travis.. Why are we using both?

lauragift21 · 2020-06-25T12:18:41Z

@anuveyatsu I added GitHub Actions first before seeing you requested doing the setup for Travis CI. We can take GitHub Actions out if it's not necessary.

rufuspollock · 2020-06-25T12:52:42Z

@anuveyatsu I added GitHub Actions first before seeing you requested doing the setup for Travis CI. We can take GitHub Actions out if it's not necessary.

@anuveyatsu i think github actions by default atm (and no travis) unless big reason not to, wdyt?

anuveyatsu · 2020-06-25T12:55:29Z

@rufuspollock @lauragift21 I only mentioned Travis because Cypress had official docs about setting up Travis. If we can use GitHub actions to run Cypress then no problem at all.

@lauragift21 is it running with GitHub actions?

lauragift21 · 2020-06-25T13:00:26Z

Alright. Yeah it is running with GitHub Actions. I'll suggest we can have both configured it's good to have double checks wdyt? @rufuspollock @anuveyatsu

anuveyatsu · 2020-06-25T13:23:35Z

@lauragift21 no, we don't want to maintain both of them. Let's remove Travis then.

anuveyatsu · 2020-06-26T05:53:47Z

cypress/integration/pages/home_page_spec.ts

+  });
+  it('submits the search form', () => {
+    cy.get('form').find('[type="text"]').type('my-dataset');
+    cy.get('form').submit();


To understand if search form works, we need to test what is the result of the form submission. E.g., you typed "my-dataset" and you'd expect to receive X number of datasets listed on the search page. So you'd test:

it redirects you to search page with query param, eg, /search?q=my-dataset

it returns X number of results

Also, I think the form selector is not explicit. It should be specifically searching form elements.

anuveyatsu · 2020-06-26T05:54:15Z

cypress/integration/pages/home_page_spec.ts

+  it('shows the recent datasets', () => {
+    cy.contains('Recent Datasets');
+  });
+  it('returns the expected number of datasets', () => {


Did you mean "the expected number of recent datasets"?

anuveyatsu · 2020-06-26T05:54:44Z

cypress/integration/pages/home_page_spec.ts

+    cy.get('.recent')
+      .find('div')
+      .should(($div) => {
+        expect($div).to.have.length(3);


Against which DMS backend are we testing? If against mocks then I'd expect length of 2.

Testing against CKAN API and not the mocks.

@lauragift21 ok, which CKAN API? Where can we set it up?

anuveyatsu · 2020-06-26T05:56:21Z

cypress/integration/pages/search_spec.ts

+    cy.get('form').find('input').type('world population');
+    cy.get('form').submit();
+  });
+  it('should return a search result', () => {});


I see you've booted this test case which is the most important re search page.

anuveyatsu · 2020-06-26T05:57:19Z

@lauragift21 I've added new comments.

anuveyatsu · 2020-06-29T11:43:29Z

@lauragift21 any updates here?

lauragift21 · 2020-06-29T11:55:11Z

@anuveyatsu I'll resolve these comments today. I was out on Friday.

[fix][s]- fix typescript bug 'All files must be modules when the '--isolatedModules' flag is provided' by adding an 'export {}' to all test files

anuveyatsu · 2020-07-02T18:48:23Z

cypress/integration/pages/home_page_spec.ts

+    cy.url().should('include', '/search?q=my-dataset&sort=');
+    cy.get('.text-3xl')
+      .should('be.visible')
+      .should('have.text', '366 results found');


Since you're testing against live CKAN API, this number will change almost every day.

@anuveyatsu This is true and I will check how to make it flexible.

anuveyatsu · 2020-07-02T18:49:19Z

cypress/integration/pages/search_spec.ts

+    cy.get('form').find('[type="text"]').type('world population');
+    cy.get('form').submit();
+    cy.url().should('include', 'search?q=world%20population&sort=');
+    cy.get('.text-3xl').should('have.text', '1 results found');


Again, if I go and publish another dataset for that query, this test would fail.

abhishekgahlot · 2020-07-16T18:19:57Z

@anuveyatsu Can you review this so that we can merge it tomorrow?

rufuspollock · 2020-07-17T15:16:02Z

LGTM.

vercel bot deployed to Preview June 18, 2020 15:14 View deployment

vercel bot deployed to Preview June 18, 2020 15:21 View deployment

vercel bot deployed to Preview June 22, 2020 10:22 View deployment

vercel bot deployed to Preview June 22, 2020 12:24 View deployment

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from e19c95a to b13b846 Compare June 23, 2020 10:11

vercel bot deployed to Preview June 23, 2020 10:11 View deployment

vercel bot deployed to Preview June 23, 2020 10:12 View deployment

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from 8c9be03 to 07bde93 Compare June 23, 2020 10:57

vercel bot deployed to Preview June 23, 2020 10:57 View deployment

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from 07bde93 to 2b9f8fd Compare June 24, 2020 08:51

vercel bot deployed to Preview June 24, 2020 08:52 View deployment

vercel bot deployed to Preview June 24, 2020 09:05 View deployment

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from 1adc150 to c66e159 Compare June 24, 2020 09:09

vercel bot deployed to Preview June 24, 2020 09:09 View deployment

vercel bot deployed to Preview June 24, 2020 09:48 View deployment

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from 672da21 to b4ada35 Compare June 24, 2020 09:55

vercel bot deployed to Preview June 24, 2020 09:55 View deployment

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from b4ada35 to 4f7f619 Compare June 24, 2020 10:26

vercel bot deployed to Preview June 24, 2020 10:26 View deployment

anuveyatsu reviewed Jun 25, 2020

View reviewed changes

vercel bot deployed to Preview June 25, 2020 13:51 View deployment

anuveyatsu reviewed Jun 26, 2020

View reviewed changes

rufuspollock mentioned this pull request Jun 29, 2020

[epic] MVP of Full Portal/Catalog app: site components, bootstrap app etc (June 2020) #16

Closed

57 tasks

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from 23a7493 to 02a610b Compare June 29, 2020 12:25

vercel bot deployed to Preview June 29, 2020 12:25 View deployment

[cypress][s]-setup-integration=with-cypress

f5ffde7

[fix][s]- fix typescript bug 'All files must be modules when the '--isolatedModules' flag is provided' by adding an 'export {}' to all test files

lauragift21 force-pushed the setup-integration-tests-with-cypress branch from 02a610b to f5ffde7 Compare June 30, 2020 14:04

vercel bot deployed to Preview June 30, 2020 14:04 View deployment

anuveyatsu reviewed Jul 2, 2020

View reviewed changes

anuveyatsu mentioned this pull request Jul 7, 2020

Setup integration tests using cypress #21

Closed

6 tasks

rufuspollock added this to In Review in v1 Overview Jul 16, 2020

Fixes of cypress tests

2c23247

vercel bot deployed to Preview July 16, 2020 18:08 View deployment

Use yarn everywhere not npm

789c752

vercel bot deployed to Preview July 16, 2020 18:14 View deployment

rufuspollock merged commit d9b5c4d into master Jul 17, 2020

v1 Overview automation moved this from In Review to Done Jul 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[tests][m]- Setup Integration Tests with Cypress #26

[tests][m]- Setup Integration Tests with Cypress #26

lauragift21 commented Jun 18, 2020 •

edited

vercel bot commented Jun 18, 2020 •

edited

anuveyatsu Jun 25, 2020

lauragift21 Jun 25, 2020

anuveyatsu Jun 25, 2020

anuveyatsu Jun 25, 2020

anuveyatsu Jun 25, 2020

anuveyatsu Jun 25, 2020

anuveyatsu Jun 26, 2020

anuveyatsu commented Jun 25, 2020

lauragift21 commented Jun 25, 2020

rufuspollock commented Jun 25, 2020

anuveyatsu commented Jun 25, 2020

lauragift21 commented Jun 25, 2020

anuveyatsu commented Jun 25, 2020

anuveyatsu Jun 26, 2020

abhishekgahlot Jul 16, 2020

anuveyatsu Jun 26, 2020

anuveyatsu Jun 26, 2020

lauragift21 Jun 30, 2020

anuveyatsu Jul 2, 2020

anuveyatsu Jun 26, 2020 •

edited

anuveyatsu commented Jun 26, 2020

anuveyatsu commented Jun 29, 2020

lauragift21 commented Jun 29, 2020

anuveyatsu Jul 2, 2020

abhishekgahlot Jul 16, 2020

anuveyatsu Jul 2, 2020

abhishekgahlot commented Jul 16, 2020

rufuspollock commented Jul 17, 2020

[tests][m]- Setup Integration Tests with Cypress #26

[tests][m]- Setup Integration Tests with Cypress #26

Conversation

lauragift21 commented Jun 18, 2020 • edited

vercel bot commented Jun 18, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anuveyatsu commented Jun 25, 2020

lauragift21 commented Jun 25, 2020

rufuspollock commented Jun 25, 2020

anuveyatsu commented Jun 25, 2020

lauragift21 commented Jun 25, 2020

anuveyatsu commented Jun 25, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anuveyatsu Jun 26, 2020 • edited

Choose a reason for hiding this comment

anuveyatsu commented Jun 26, 2020

anuveyatsu commented Jun 29, 2020

lauragift21 commented Jun 29, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abhishekgahlot commented Jul 16, 2020

rufuspollock commented Jul 17, 2020

lauragift21 commented Jun 18, 2020 •

edited

vercel bot commented Jun 18, 2020 •

edited

anuveyatsu Jun 26, 2020 •

edited