Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2677 - Add sendgrid api key to deploy-backend #3019

Merged
merged 4 commits into from
Jun 4, 2024

Conversation

jtimpe
Copy link

@jtimpe jtimpe commented Jun 2, 2024

Summary of Changes

Pull request closes #2677

How to Test

  1. In the TDRS Project Settings in circleci, add a new Environment Variable: SENDGRID_API_KEY (or verify/modify the existing value). If you change it, you'll be able to see the change in the final step
  2. Trigger a circleci deployment to a cloud.gov environment of your choice
  3. In the tdrs-backend-{env} environment variables in cloud.gov, verify the value from circleci is in place for SENDGRID_API_KEY

Proof from my test
image

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

  • add SENDGRID_API_KEY to deploy-backend.sh to be managed by circleci
  • document that all environment variables should be managed by circleci
  • lfrohlich and/or adpennington confirmed that ACs are met.

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

@jtimpe jtimpe changed the title add sendgrid api key 2677 - Add sendgrid api key to deploy-backend Jun 2, 2024
Copy link

codecov bot commented Jun 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.96%. Comparing base (01c4117) to head (1693205).
Report is 2 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #3019      +/-   ##
===========================================
- Coverage    93.11%   92.96%   -0.15%     
===========================================
  Files          273      276       +3     
  Lines         7087     7140      +53     
  Branches       598      603       +5     
===========================================
+ Hits          6599     6638      +39     
- Misses         395      407      +12     
- Partials        93       95       +2     
Flag Coverage Δ
dev-backend 93.02% <ø> (-0.17%) ⬇️
dev-frontend 92.62% <ø> (ø)

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

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

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

@jtimpe jtimpe self-assigned this Jun 2, 2024
@jtimpe jtimpe added the Deploy with CircleCI-raft Deploy to https://tdp-frontend-raft.app.cloud.gov through CircleCI label Jun 3, 2024
@jtimpe jtimpe added the raft review This issue is ready for raft review label Jun 3, 2024
Copy link

@elipe17 elipe17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked CirCI and the Raft env and verified the var was there.

Copy link

@raftmsohani raftmsohani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jtimpe jtimpe added QASP Review and removed raft review This issue is ready for raft review Deploy with CircleCI-raft Deploy to https://tdp-frontend-raft.app.cloud.gov through CircleCI labels Jun 4, 2024
@jtimpe jtimpe requested a review from ADPennington June 4, 2024 15:31
@ADPennington ADPennington added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jun 4, 2024
Copy link
Collaborator

@ADPennington ADPennington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

backend before deployment
sendgridpr1

backend after deployment
sendgridpr2

email sent ✔️
sendgridpr3

@ADPennington ADPennington added Ready to Merge and removed QASP Review Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI labels Jun 4, 2024
@jtimpe jtimpe merged commit 7e0cb82 into develop Jun 4, 2024
26 checks passed
@jtimpe jtimpe deleted the 2677-managed-sendgrid-in-circleci branch June 4, 2024 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add SENDGRID_API_KEY to deploy.backend.sh
4 participants