Cypress test to create CWU opportunity #111

BCerki · 2021-12-21T22:28:28Z

This PR partially addresses issue: #107

Includes tests? y
Rebased on main address to conflicts? n/a
Updated docs? y

Proposed changes:

write a Cypress test that checks if a gov user can create and save a draft of a CWU opportunity. This involved the following pre-reqs:
-- add an endpoint that authenticates a user for testing (endpoint only exists in dev)
-- create two fixtures
-- update docs with instructions for running the cypress tests and for using postgres locally (project only had instructions for containerized postgres, which is a pain for testing)
-- tweak some configs

Additional notes:

there are several things I'm unsure about/would love feedback on and I've made line notes

Update Dec 22:

running the cypress tests locally should work. Running them on CI doesn't--haven't figured out how to connect to the containerized postgres yet
Error: The Test Runner unexpectedly exited via a exit event with signal SIGSEGV cypress-io/cypress#18569

BCerki · 2021-12-21T22:32:39Z

cypress/integration/gov-create-opp.spec.js

+        // clean up db
+        cy.exec('dropdb -f digitalmarketplace')
+        // set up db
+        cy.exec('createdb digitalmarketplace')
+        cy.exec('npm run migrations:latest;')


I suspect this is inelegant--I would ultimately like to just truncate the tables using something like this, but was having trouble following. For first iteration, I think this is OK?

Let's track as a tech debt issue? There's the truncate option (per example) and there's also the option of running migrations within a transaction (even faster) depending on how our backend is architected.

BCerki · 2021-12-21T22:35:08Z

cypress/integration/gov-create-opp.spec.js

+        cy.contains('Get Started').first().click()
+
+        // 1. Overview tab
+        cy.get('#cwu-opportunity-title').type('Cypress Opp')


I know IDs aren't the best selectors, but since we're considering a refactor, I didn't want to add data-cy everywhere.

The recommendations are opinionated. I like https://testing-library.com/ 's philosophy of only relying on things a user can interact with for testing. There's actually a (cypress-testing-library)[https://testing-library.com/docs/cypress-testing-library/intro]! Haven't tried it yet, but this could allow you to write

cy.findByLabelText(/opportunity title/i).type('Cypress Opp')

Cool, thanks! I'll play with it in future tests

Feature ticket for adding testing-library support? I'll second the opinionated Guiding Principles of that project.

write tests that closely resemble how your web pages are used

I already installed it as part of this PR

BCerki · 2021-12-21T22:35:20Z

cypress/integration/gov-create-opp.spec.js

+        // 1. Overview tab
+        cy.get('#cwu-opportunity-title').type('Cypress Opp')
+        cy.get('#cwu-opportunity-teaser').type('Teaser text')
+        cy.get('#cwu-opportunity-remote-ok-0').check({force:true}) // is force OK?


Is force OK?

BCerki · 2021-12-21T22:35:54Z

cypress/integration/gov-create-opp.spec.js

+        cy.get('#cwu-opportunity-location').clear().type('Vancouver')
+        cy.get('#cwu-opportunity-reward').type('5000')
+        cy.get('#cwu-opportunity-skills').click()
+        cy.contains('Agile').click({force: true})


This is in a dropdown and what I've got here works, but it seemed sketchy?

Ideally we'd wait for the click that opens the dropdown to finish opening, ensuring this click is reachable (so we don't have to force). Tech debt?

BCerki · 2021-12-21T22:36:58Z

cypress/integration/gov-create-opp.spec.js

+        cy.get('#cwu-opportunity-remote-desc').should('have.value','Remote description text')
+        cy.get('#cwu-opportunity-location').should('have.value','Vancouver')
+        cy.get('#cwu-opportunity-reward').should('have.value','5000')
+        cy.contains('Agile').should('be.visible') // weak


I don't like this selector because the word "Agile" could appear elsewhere depending on the opportunity, so I look forward to your feedback!

Is this word in a section, or under a label that you could query?

BCerki · 2021-12-21T22:39:01Z

src/back-end/lib/routers/auth.ts

-    }
+    },
+    // /auth/createsession is for testing only, so only exists outside of production
+    // @ts-ignore


Since this is a testing endpoint, not a real one, it doesn't return the types the app expects. OK to use @ts-ignore here and below?

Ideally we'd cast this endpoint's output to return prod types. Tech debt

https://github.com/button-inc/digital_marketplace/issues/119

BCerki · 2021-12-22T19:03:06Z

src/back-end/lib/routers/auth.ts

+    },
+    // /auth/createsession is for testing only, so only exists outside of production
+    // @ts-ignore
+    ...(process.env.NODE_ENV === 'development' ? [{


Is this enough to ensure this endpoint will never exist in prod?

No, this means that your endpoint will only exist in your development build. When testing with cypress you want to test against your production build.
NODE_ENV is only telling you whether you're looking at a development build (enabling, hot module reloading, react dev tools, etc) or a production build, it is not related to your dev/test/prod environment.

What you want here is an opt-in feature flag, e.g. ENABLE_MOCK_AUTH, and you'll want to run your server with that flag when starting it for your cypress tests (example).

If your application container is aware of which namespace it's running in, e.g. via a NAMESPACE env variable, you could also ensure that this feature flag cannot be enabled when the application is deployed on OpenShift (no matter the namespace).
e.g.

export const ENABLE_MOCK_AUTH = process.argv.includes("ENABLE_MOCK_AUTH") && process.env.NAMESPACE === undefined;

Yes, I'd say this is safe. Tech debt here is we eventually want a validated configuration (eg. convict, among many others) but this is good for now.

https://github.com/button-inc/digital_marketplace/issues/120

wenzowski

Let's document tech debt as issues on the repo and shipit

wenzowski · 2021-12-22T19:18:16Z

cypress/integration/gov-create-opp.spec.js

+        // clean up db
+        cy.exec('dropdb -f digitalmarketplace')
+        // set up db
+        cy.exec('createdb digitalmarketplace')
+        cy.exec('npm run migrations:latest;')


Let's track as a tech debt issue? There's the truncate option (per example) and there's also the option of running migrations within a transaction (even faster) depending on how our backend is architected.

wenzowski · 2021-12-22T19:21:39Z

cypress/integration/gov-create-opp.spec.js

+        cy.contains('Get Started').first().click()
+
+        // 1. Overview tab
+        cy.get('#cwu-opportunity-title').type('Cypress Opp')


Feature ticket for adding testing-library support? I'll second the opinionated Guiding Principles of that project.

write tests that closely resemble how your web pages are used

wenzowski · 2021-12-22T19:22:47Z

cypress/integration/gov-create-opp.spec.js

+        cy.get('#cwu-opportunity-location').clear().type('Vancouver')
+        cy.get('#cwu-opportunity-reward').type('5000')
+        cy.get('#cwu-opportunity-skills').click()
+        cy.contains('Agile').click({force: true})


Ideally we'd wait for the click that opens the dropdown to finish opening, ensuring this click is reachable (so we don't have to force). Tech debt?

wenzowski · 2021-12-22T19:25:42Z

src/back-end/lib/routers/auth.ts

+    },
+    // /auth/createsession is for testing only, so only exists outside of production
+    // @ts-ignore
+    ...(process.env.NODE_ENV === 'development' ? [{


Yes, I'd say this is safe. Tech debt here is we eventually want a validated configuration (eg. convict, among many others) but this is good for now.

wenzowski · 2021-12-22T19:26:23Z

src/back-end/lib/routers/auth.ts

-    }
+    },
+    // /auth/createsession is for testing only, so only exists outside of production
+    // @ts-ignore


Ideally we'd cast this endpoint's output to return prod types. Tech debt

BCerki · 2022-01-07T23:31:44Z

Work finished in #121

BCerki commented Dec 21, 2021

View reviewed changes

BCerki marked this pull request as draft December 21, 2021 22:51

BCerki mentioned this pull request Dec 22, 2021

47 user stories #103

Closed

BCerki changed the title ~~107 cy login~~ Cypress test to create CWU opportunity Dec 22, 2021

BCerki commented Dec 22, 2021

View reviewed changes

BCerki marked this pull request as ready for review December 22, 2021 19:03

wenzowski previously approved these changes Dec 22, 2021

View reviewed changes

BCerki dismissed wenzowski’s stale review via 2b749e2 December 22, 2021 21:28

This was referenced Dec 22, 2021

Tech debt: Better beforeEach db cleanup and seed for cypress tests #117

Closed

Tech debt: Better handling of dropdowns in cypress tests #118

Closed

BCerki added 15 commits December 22, 2021 13:34

test: create test user fixture

3ef82e7

test: rename fixture data for clarity

76b23e2

style: set ts-ignore errors to warn

913db49

test: create test endpoint for creating gov session

ac942db

test: conditionally render test endpoint

8856653

test: set cypress config to desktop viewport size

16fb443

test: create gov-create-opportunity test

baa0adc

test: install cypress-file-upload

6efab44

test: add cypress-file-upload to commands

4a0b7c9

test: continue work on gov create opp test

ffe5125

test: add image fixutre

5de9c15

test: continue gov create opp

e5f264b

test: continue gov create opp

4a54078

test: clean and reset db

7f5332c

test: adds cypress convenience script

5ae5a5e

BCerki added 19 commits January 4, 2022 10:46

test: update cypress start command

03af989

test: update cypress env variables

2e6e8b3

test: update cypress action

33b9c63

test: update cypress env variables

560eace

test: update cypress env variables

1459983

test: update cypress env variables

80de06b

test: troubleshoot cypress CI

651d542

test: troubleshoot cypress CI

c6cc54e

test: increase cypress exec timeout

8a944c6

test: increase cypress exec timeout

6ea0679

test: adjust beforeEach

fcaee9d

test: adjust beforeEach

433e800

test: increase cypress exec timeout

f156abe

test: troubleshoot cypress CI

34d39c6

test: save CI failure screenshots

6839721

test: save CI failure screenshots

cfb9f1b

test: save CI failure screenshots

1ad1adb

test: save CI failure screenshots

60decfb

test: give bad hostname to test CI connection

6e562e9

BCerki force-pushed the 107-cy-login branch from 70d0a21 to 6e562e9 Compare January 4, 2022 22:39

BCerki added 4 commits January 4, 2022 14:39

test: remove CI failure screenshots

f8d768b

test: troubleshoot cypress CI

8dae127

test: add github action debugger

5276d97

test: update cypress env variables

c707ab4

BCerki mentioned this pull request Jan 7, 2022

Cypress: set up locally and in CI, write first test #121

Merged

BCerki closed this Jan 7, 2022

This was referenced Jan 20, 2022

Tech debt: Validated configuration bcgov/digital_marketplace#221

Open

Tech debt: Make test endpoint return prod types bcgov/digital_marketplace#222

Open

BCerki mentioned this pull request Feb 25, 2022

241 proposal status #141

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cypress test to create CWU opportunity #111

Cypress test to create CWU opportunity #111

BCerki commented Dec 21, 2021 •

edited

BCerki Dec 21, 2021 •

edited

wenzowski Dec 22, 2021

BCerki Dec 22, 2021

BCerki Dec 21, 2021

matthieu-foucault Dec 22, 2021

BCerki Dec 22, 2021

wenzowski Dec 22, 2021

BCerki Dec 22, 2021

BCerki Dec 21, 2021

BCerki Dec 21, 2021

wenzowski Dec 22, 2021

BCerki Dec 22, 2021

BCerki Dec 21, 2021 •

edited

matthieu-foucault Dec 22, 2021

BCerki Dec 21, 2021

wenzowski Dec 22, 2021

BCerki Dec 22, 2021

BCerki Dec 22, 2021

matthieu-foucault Dec 22, 2021

wenzowski Dec 22, 2021

BCerki Dec 22, 2021

wenzowski left a comment

wenzowski Dec 22, 2021

wenzowski Dec 22, 2021

wenzowski Dec 22, 2021

wenzowski Dec 22, 2021

wenzowski Dec 22, 2021

BCerki commented Jan 7, 2022

Cypress test to create CWU opportunity #111

Cypress test to create CWU opportunity #111

Conversation

BCerki commented Dec 21, 2021 • edited

BCerki Dec 21, 2021 • 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

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

BCerki Dec 21, 2021 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wenzowski left a 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

BCerki commented Jan 7, 2022

BCerki commented Dec 21, 2021 •

edited

BCerki Dec 21, 2021 •

edited

BCerki Dec 21, 2021 •

edited