Chore/2141 cypress

[jtimpe]

Summary of Changes

Provide a brief summary of changes
Pull request closes #2141

How to Test

List the steps to test the PR
These steps are generic, please adjust as necessary.

# in separate terminals
cd tdrs-frontend && npm run start
cd tdrs-backend && docker-compose up

# in another terminal
docker-compose exec web python manage.py generate_cypress_users
cd ../tdrs-frontend
npm run test:e2e

1. Run the account.feature test file

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

• Determine if we're interested in smoke testing or more robust integration testing
• Define some criteria for what makes a "good" test given the end goal
• Research available test runners and/or open source or SaaS tools for each type, select a tool to use
• Start an automated suite by setting up the test runner(s)
• Set up a test suite using the selected runner. Create automated test(s) for an authenticated "hello world"
• Document the research criteria and decision in an ADR
• Update documentation with instructions for running tests locally and in each environment
• lfrohlich and/or adpennington confirmed that ACs are met.

A couple of relatively easy nice-to-haves

• Set up video/screenshots to save as artifacts in CircleCI; (and/or set up Cypress Cloud) (for named branches only)
• Set up a test reporter and integrate it with CircleCI
• Build/release develop into cloud gov and run tests against the live app
  • created created [DevOps] Deploy develop to a cloudgov environment after PR merge #2337
• Mattermost integration for failures (this may only be available as an extension library, or not exist at all. i haven't looked into it)

Refer to Cypress's CircleCI integration guide

Deliverable 2: Tested Code

• Are all areas of code introduced in this PR meaningfully tested?
  • If this PR introduces backend code changes, are they meaningfully tested?
  • If this PR introduces frontend code changes, are they meaningfully tested?
• Are code coverage minimums met?
  • Frontend coverage: [insert coverage %] (see CodeCov Report comment in PR)
  • Backend coverage: [insert coverage %] (see CodeCov Report comment in PR)

Deliverable 3: Properly Styled Code

• Are backend code style checks passing on CircleCI?
• Are frontend code style checks passing on CircleCI?
• Are code maintainability principles being followed?

Deliverable 4: Accessible

• Does this PR complete the epic?
• Are links included to any other gov-approved PRs associated with epic?
• Does PR include documentation for Raft's a11y review?
• Did automated and manual testing with iamjolly and ttran-hub using Accessibility Insights reveal any errors introduced in this PR?

Deliverable 5: Deployed

• Was the code successfully deployed via automated CircleCI process to development on Cloud.gov?

Deliverable 6: Documented

• Does this PR provide background for why coding decisions were made?
• If this PR introduces backend code, is that code easy to understand and sufficiently documented, both inline and overall?
• If this PR introduces frontend code, is that code easy to understand and sufficiently documented, both inline and overall?
• If this PR introduces dependencies, are their licenses documented?
• Can reviewer explain and take ownership of these elements presented in this code review?

Deliverable 7: Secure

• Does the OWASP Scan pass on CircleCI?
• Do manual code review and manual testing detect any new security issues?
• If new issues detected, is investigation and/or remediation plan documented?

Deliverable 8: User Research

Research product(s) clearly articulate(s):

• the purpose of the research
• methods used to conduct the research
• who participated in the research
• what was tested and how
• impact of research on TDP
• (if applicable) final design mockups produced for TDP development

[codecov]

Codecov Report

Merging #2305 (e63e723) into develop (70f47b7) will decrease coverage by 0.49%.
The diff coverage is 21.05%.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2305      +/-   ##
===========================================
- Coverage    94.04%   93.55%   -0.49%     
===========================================
  Files           96       96              
  Lines         2853     2872      +19     
  Branches       263      265       +2     
===========================================
+ Hits          2683     2687       +4     
- Misses         123      137      +14     
- Partials        47       48       +1     

Flag	Coverage Δ
dev-backend	93.34% <21.05%> (-0.67%)	⬇️
dev-frontend	94.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
tdrs-backend/tdpservice/users/api/login.py	88.66% <13.33%> (-6.02%)	⬇️
tdrs-backend/tdpservice/urls.py	92.59% <33.33%> (-7.41%)	⬇️
tdrs-backend/tdpservice/settings/common.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 70f47b7...e63e723. Read the comment docs.

[andrew-jameson]

Outside of a broken link and the email change, LGTM!

[andrew-jameson]

Just need to delete that extra parenthesis and good to go.

[ADPennington]

@jtimpe can you get the owasp scan to run on this ticket?

[ADPennington]

really nice intro discussion to automated testing. thank you @jtimpe

[ADPennington]

👍🏾 it'll be helpful to have a workflow diagram for this when we have this figured out. And figuring out where this will be deployed is another good topic for future discussion. To model production as close as possible, we currently have staging and prod matching at all times. id like to better understand how this testing will coincide with release branching strategy, if at all.

[ADPennington]

lgtm thanks @jtimpe 🚀

note: i noticed new endpoints related to cypress show up in the backend owasp scans. we should keep an eye on what comes up in the nightly scans to be sure no new or noteworthy issues are raised.