Running Cypress in Docker #3688

alismx · 2022-04-21T18:12:07Z

Cypress PULL REQUEST

resolves #1770
resolves #3280
resolves #3637

Related Issue

Clean up cypress implementation
Make use of standard docker setup
Increase integration testing coverage of a live environment

Changes Proposed

Run Cypress in docker
Add Test to our ci pipeline
Run Cypress against a remote environment
Move Cypress directory out of the frontend directory
Update Cypress tests to handle more variable data
Handle cypress user having access to multiple facilities
Update Okta mocks for local runs
Update .env files for use in docker
Parameterize okta request for authenication
Block staging/prod deploys if cypress fails against test

Additional Information

Add swap space to the local run is pretty straightforward and seems to have had a positive impact on preventing Cypress from hanging and other failures, I used an open source repo to do this but could easily add a new action. Open to preferences and thoughts.
It would be nice to decouple wiremock from running in the cypress container

Testing

Double check the deployStg file as it's hasn't officially been run with everything in place
Passing Cypress run against localhost.simplereport.gov
Passing Cypress run against test.simplereport.gov
Failing Cypress run against test.simplereport.gov

Checklist for Primary Reviewer

Infrastructure

Consult the results of the terraform-plan job inside the "Terraform Checks" workflow run for this PR. Confirm that there are no unexpected changes!

Security

Changes with security implications have been approved by a security engineer (changes to authentication, encryption, handling of PII, etc.)
Any dependencies introduced have been vetted and discussed

Cloud

If there are changes that cannot be tested locally, this has been deployed to our Azure test, dev, or pentest environment for verification

This has been tested by 3 devs locally.

georgehager · 2022-08-11T18:53:29Z

frontend/ci-git-fix.sh

+#!/bin/bash
+
+echo "git config --global --add safe.directory /app"
+git config --global --add safe.directory /app


What does this do? Curious what problem it resolves

This is a workaround to a reported bug, it resolves a "dubious" permissions error when running the frontend with docker. We run a git command on frontend startup and this is required to do that.

georgehager · 2022-08-11T20:06:08Z

cypress/stubs/orgSignUp/mappings/api_v1_users-d2c41957-0331-4c20-a597-7002630980ab.json

@@ -5,14 +5,14 @@
    "url" : "/api/v1/users?activate=false",
    "method" : "POST",
    "bodyPatterns" : [ {
-      "equalToJson" : "{\"profile\":{\"firstName\":\"Greg\",\"lastName\":\"McTester\",\"login\":\"[email protected]\",\"email\":\"[email protected]\"},\"groupIds\":[\"00g228nyd7uuGaG1L1d7\",\"00g228nrj9QDJ10y61d7\"]}",
+      "equalToJson" : "{\"profile\":{\"firstName\":\"Greg\",\"lastName\":\"McTester\",\"login\":\"${json-unit.any-string}\",\"email\":\"${json-unit.any-string}\"},\"groupIds\":[\"00g228nyd7uuGaG1L1d7\",\"00g228nrj9QDJ10y61d7\"]}",


this is a neat trick!

thought I'm realizing this is in an auto-generated file 🤣

@georgehager mostly auto-generated! It's created by WireMock but this any-string piece is hand-touched :)

This was a manual update to allow for any email. Doing so lets us add more people and not need to clean the db every time.

Neat! I saw in the test we type in user.email so that makes sense!

georgehager · 2022-08-11T20:12:52Z

cypress/README.md

+- Run Cypress locally and open interactive mode. Do this if you're running the apps locally with docker-compose with Okta enabled.
+  - `yarn e2e:nginx:okta`
+
+### Potential issues:


Super helpful!

.gitignore

georgehager

Looks great! this will make running e2es locally so much easier 🙌

georgehager · 2022-08-11T20:33:28Z

@alismx did you decide not to add a command for running all e2e tests headless locally outside of docker? It's something I imagine wanting to do occasionally, so I don't think it's super critical and might not be worth the effort of adding another separate command since they can all be run in open mode.

alismx · 2022-08-11T20:43:58Z

@alismx did you decide not to add a command for running all e2e tests headless locally outside of docker? It's something I imagine wanting to do occasionally, so I don't think it's super critical and might not be worth the effort of adding another separate command since they can all be run in open mode.

What do you say about making a follow-up ticket? I can write that up and link it here.

georgehager · 2022-08-11T20:58:02Z

What do you say about making a follow-up ticket? I can write that up and link it here.

Yep I think that's great! Like I said, not super critical 😁

emyl3

Couple questions for you alis! Thank you for your all your work on this! 😭 🙌

emyl3 · 2022-08-12T01:51:13Z

.env.cypress.remote.sample

+CYPRESS_OKTA_SECRET=
+CYPRESS_OKTA_REDIRECT_URI="https%3A%2F%2Ftest.simplereport.gov%2Fapp%2F"
+CYPRESS_OKTA_SCOPE="simple_report_test"
+CYPRESS_OKTA_CLIENT_ID="0oa1khettjHnj3EPT1d7"


is this ok to have checked in? 🤔

Committing this value to the repo is fine. The client id is very easy to find in our auth flow as it gets passed around in the URL of the auth requests. We don't want to expose API keys or secrets.

Got it! Thank you @alismx :D

.github/workflows/deployTest.yml

cypress/support/commands.js

emyl3 · 2022-08-12T02:05:46Z

cypress/README.md

@@ -0,0 +1,123 @@
+## E2E tests


thank you for so thoroughly updating this!

+1, this is awesome! Once this is merged, would you mind also adding it to the wiki? (or just linking to this README somewhere on our getting started wiki page)

emyl3

LGTM!! Thank you!! 😹

emmastephenson

Looks awesome Alis, thanks for all your work on this! 🙌

emmastephenson · 2022-08-15T16:27:09Z

.github/workflows/deployDev.yml

-    runs-on: ubuntu-latest
-    needs: [deploy]
-    defaults:
-      run:


Curious why we're no longer verifying the release for dev?

This check is the first test of the cypress suite, which happens locally during the PR process and against the test environment once a merge goes through. This was only in place until we could run the whole suite against a remote environment in its entirety.

I wouldn't mind this type of check for all of our remote environments, but it does take some time because of its dependence on spinning up cypress.

I see, thanks for the explanation!

emmastephenson · 2022-08-15T16:30:32Z

cypress/README.md

@@ -0,0 +1,123 @@
+## E2E tests


+1, this is awesome! Once this is merged, would you mind also adding it to the wiki? (or just linking to this README somewhere on our getting started wiki page)

alismx · 2022-08-15T17:37:37Z

I can't seem to merge this until the sonar job is fixed.

snesm · 2022-08-17T17:56:47Z

@alismx, it looks like "test Expected — Waiting for status to be reported" is the hold up. The sonar check is not "required"

rin-skylight · 2022-08-17T17:59:23Z

@snesm Sonar is the issue. There is a dependent check in the "test" workflow. PR is already in with the bypass.

alismx · 2022-08-17T19:16:57Z

@snesm @rin-skylight @emmastephenson Not sure what I'm missing, but it seems like this "test" check is only blocking this PR. I thought it was because of the Sonar issue failing, but now that we've merged in that sonar bypass, I believe that's been ruled out. Has anybody seen this before? Does anybody see any issues with the github workflows in this PR?

rin-skylight · 2022-08-17T19:24:38Z

@alismx This can happen on occasion. Creating a PR with a new branch, that has all of your existing changes, will likely be the easiest thing to kick the checks into gear. I've forced a re-run of the test workflow, but that reporting hook still might not function correctly.

Run Cypress integration tests against the remote stg environment

5e52e4a

alismx force-pushed the alis/1770-3280 branch 3 times, most recently from 93bd050 to 91f6ca6 Compare April 22, 2022 23:19

alismx temporarily deployed to Test April 22, 2022 23:27 Inactive

alismx force-pushed the alis/1770-3280 branch from 91f6ca6 to 8368630 Compare April 22, 2022 23:47

alismx had a problem deploying to Test April 22, 2022 23:54 Error

alismx force-pushed the alis/1770-3280 branch from 8368630 to 8a1455f Compare April 22, 2022 23:54

alismx temporarily deployed to Test April 23, 2022 00:01 Inactive

alismx force-pushed the alis/1770-3280 branch from 8a1455f to edd3d32 Compare April 23, 2022 00:21

alismx temporarily deployed to Test April 23, 2022 00:27 Inactive

alismx force-pushed the alis/1770-3280 branch from edd3d32 to a89b3e0 Compare April 23, 2022 01:07

alismx temporarily deployed to Test April 23, 2022 01:13 Inactive

alismx temporarily deployed to Test April 23, 2022 04:19 Inactive

alismx force-pushed the alis/1770-3280 branch 4 times, most recently from 78b2a6d to a92d049 Compare April 23, 2022 05:26

alismx temporarily deployed to Test April 23, 2022 05:32 Inactive

alismx force-pushed the alis/1770-3280 branch 2 times, most recently from 2cb95c2 to 554c13c Compare April 23, 2022 05:51

alismx temporarily deployed to Test April 23, 2022 05:57 Inactive

alismx force-pushed the alis/1770-3280 branch from 554c13c to f1375df Compare April 25, 2022 16:56

alismx temporarily deployed to Test April 25, 2022 17:03 Inactive

alismx force-pushed the alis/1770-3280 branch from f1375df to c02a9a7 Compare April 25, 2022 17:30

alismx temporarily deployed to Test April 25, 2022 17:37 Inactive

alismx force-pushed the alis/1770-3280 branch from c02a9a7 to 1c36def Compare April 25, 2022 18:43

alismx temporarily deployed to Test April 25, 2022 18:50 Inactive

alismx force-pushed the alis/1770-3280 branch from 1c36def to 9d14978 Compare April 25, 2022 19:46

alismx temporarily deployed to Test April 25, 2022 19:53 Inactive

alismx added 3 commits August 9, 2022 10:51

update readme

bd4da8e

update readme

3168e0f

update nginx version and delete unused nginx config

f7fea35

snesm mentioned this pull request Aug 10, 2022

Bump dockerfile nginx:1.21.1-alpine to nginx:1.23-alpine #4137

Closed

8 tasks

alismx added 2 commits August 10, 2022 11:29

Merge branch 'main' into alis/1770-3280

450a649

update readme

7b7f304

add note about mkcrt

8f7f3a8

georgehager reviewed Aug 11, 2022

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

remove reference to cypress env file in the frontend dir

439f105

georgehager approved these changes Aug 11, 2022

View reviewed changes

emyl3 reviewed Aug 12, 2022

View reviewed changes

emyl3 approved these changes Aug 12, 2022

View reviewed changes

emmastephenson reviewed Aug 15, 2022

View reviewed changes

Merge branch 'main' into alis/1770-3280

10ed980

alismx closed this Aug 17, 2022

alismx reopened this Aug 17, 2022

alismx merged commit 80a6dae into main Aug 17, 2022

alismx deleted the alis/1770-3280 branch August 17, 2022 20:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Running Cypress in Docker #3688

Running Cypress in Docker #3688

alismx commented Apr 21, 2022 •

edited

Loading

georgehager Aug 11, 2022 •

edited

Loading

alismx Aug 11, 2022

georgehager Aug 11, 2022

georgehager Aug 11, 2022

emmastephenson Aug 11, 2022

alismx Aug 11, 2022

georgehager Aug 11, 2022

georgehager Aug 11, 2022

georgehager left a comment

georgehager commented Aug 11, 2022

alismx commented Aug 11, 2022

georgehager commented Aug 11, 2022 •

edited

Loading

emyl3 left a comment

emyl3 Aug 12, 2022

alismx Aug 12, 2022

emyl3 Aug 12, 2022

emyl3 Aug 12, 2022

alismx Aug 12, 2022

emmastephenson Aug 15, 2022

emyl3 left a comment

emmastephenson left a comment

emmastephenson Aug 15, 2022

alismx Aug 15, 2022

emmastephenson Aug 16, 2022

emmastephenson Aug 15, 2022

alismx commented Aug 15, 2022

snesm commented Aug 17, 2022

rin-skylight commented Aug 17, 2022

alismx commented Aug 17, 2022

rin-skylight commented Aug 17, 2022

Running Cypress in Docker #3688

Running Cypress in Docker #3688

Conversation

alismx commented Apr 21, 2022 • edited Loading

Cypress PULL REQUEST

Related Issue

Changes Proposed

Additional Information

Testing

Checklist for Primary Reviewer

Infrastructure

Security

Cloud

georgehager Aug 11, 2022 • edited Loading

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

georgehager left a comment

Choose a reason for hiding this comment

georgehager commented Aug 11, 2022

alismx commented Aug 11, 2022

georgehager commented Aug 11, 2022 • edited Loading

emyl3 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

Choose a reason for hiding this comment

emyl3 left a comment

Choose a reason for hiding this comment

emmastephenson 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

alismx commented Aug 15, 2022

snesm commented Aug 17, 2022

rin-skylight commented Aug 17, 2022

alismx commented Aug 17, 2022

rin-skylight commented Aug 17, 2022

alismx commented Apr 21, 2022 •

edited

Loading

georgehager Aug 11, 2022 •

edited

Loading

georgehager commented Aug 11, 2022 •

edited

Loading