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

Backend package structure updates and OpenAPI annotation first-pass for API #14356

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

jpandersen87
Copy link
Collaborator

Fixes #14354

This PR ...

If you are suggesting a fix for a currently exploitable issue, please disclose the issue to the prime-reportstream team directly outside of GitHub instead of filing a PR, so we may immediately patch the affected systems before a disclosure. See SECURITY.md/Reporting a Vulnerability for more information.

Test Steps:

  1. Include steps to test these changes

Changes

  • Include a comprehensive list of changes in this PR
  • (For web UI changes) Include screenshots/video of changes

Checklist

Testing

  • Tested locally?
  • Ran ./prime test or ./gradlew testSmoke against local Docker ReportStream container?
  • (For Changes to /frontend-react/...) Ran npm run lint:write?
  • Added tests?

Process

  • Are there licensing issues with any new dependencies introduced?
  • Includes a summary of what a code reviewer should test/verify?
  • Updated the release notes?
  • Database changes are submitted as a separate PR?
  • DevOps team has been notified if PR requires ops support?

Linked Issues

  • Fixes #issue

To Be Done

Create GitHub issues to track the work remaining, if any

  • #issue

Specific Security-related subjects a reviewer should pay specific attention to

  • Does this PR introduce new endpoints?
    • new endpoint A
    • new endpoint B
  • Does this PR include changes in authentication and/or authorization of existing endpoints?
  • Does this change introduce new dependencies that need vetting?
  • Does this change require changes to our infrastructure?
  • Does logging contain sensitive data?
  • Does this PR include or remove any sensitive information itself?

If you answered 'yes' to any of the questions above, conduct a detailed Review that addresses at least:

  • What are the potential security threats and mitigations? Please list the STRIDE threats and how they are mitigated
    • Spoofing (faking authenticity)
      • Threat T, which could be achieved by A, is mitigated by M
    • Tampering (influence or sabotage the integrity of information, data, or system)
    • Repudiation (the ability to dispute the origin or originator of an action)
    • Information disclosure (data made available to entities who should not have it)
    • Denial of service (make a resource unavailable)
    • Elevation of Privilege (reduce restrictions that apply or gain privileges one should not have)
  • Have you ensured logging does not contain sensitive data?
  • Have you received any additional approvals needed for this change?

@jpandersen87 jpandersen87 self-assigned this May 10, 2024
…-updates-and-OpenAPI-annotation-first-pass-for-API
Copy link

github-actions bot commented May 10, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

Copy link

github-actions bot commented May 10, 2024

Test Results

1 171 tests  ±0   1 167 ✅ ±0   7m 0s ⏱️ -2s
  147 suites ±0       4 💤 ±0 
  147 files   ±0       0 ❌ ±0 

Results for commit 928bafe. ± Comparison against base commit 7f63bbc.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented May 10, 2024

Integration Test Results

 62 files  ±0   62 suites  ±0   33m 34s ⏱️ +45s
393 tests ±0  383 ✅ ±0  10 💤 ±0  0 ❌ ±0 
396 runs  ±0  386 ✅ ±0  10 💤 ±0  0 ❌ ±0 

Results for commit 928bafe. ± Comparison against base commit 7f63bbc.

♻️ This comment has been updated with latest results.

Copy link

sonarcloud bot commented May 10, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
4 Security Hotspots
50.9% Coverage on New Code (required ≥ 80%)
3.7% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Backend package structure updates and OpenAPI annotation first-pass for API
1 participant