Skip to content

Improve Error Handling in DefectDojo Persistence Provider#2833

Merged
Weltraumschaf merged 25 commits intosecureCodeBox:mainfrom
Weltraumschaf:improve_error_handling
Feb 7, 2025
Merged

Improve Error Handling in DefectDojo Persistence Provider#2833
Weltraumschaf merged 25 commits intosecureCodeBox:mainfrom
Weltraumschaf:improve_error_handling

Conversation

@Weltraumschaf
Copy link
Copy Markdown
Member

@Weltraumschaf Weltraumschaf commented Jan 7, 2025

Description

For Newbies it is quite cumbersome to fiddle out what argument and/or env var to configure where and when while setting up dev environment. For that reason I improved error handling and messages.

Checklist

  • Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
  • Make sure that all your commits are signed-off and that you are added to the Contributors file.
  • Make sure that all CI finish successfully.
  • Optional (but appreciated): Make sure that all commits are Verified.

@Weltraumschaf Weltraumschaf self-assigned this Jan 7, 2025
@netlify
Copy link
Copy Markdown

netlify bot commented Jan 7, 2025 •
edited
Loading

✅ Deploy Preview for docs-securecodebox canceled.

Name Link
🔨 Latest commit 0be20ca
🔍 Latest deploy log https://app.netlify.com/sites/docs-securecodebox/deploys/67a5dd6a0a53ab000812baa3

@Weltraumschaf Weltraumschaf added persistence Implement or update a persistence store hook Implement or update a hook java Pull requests that update Java code labels Jan 7, 2025
@Weltraumschaf Weltraumschaf requested a review from J12934 January 15, 2025 14:57
@Weltraumschaf
Use Lombok to Access Redonly Property
563e16c 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Improves GRammar of Exception Messages
d3e00b4 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Move Property to top of Class to the Others
decfdd3 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Make PersistenceProviderConfig Final to Prevent Extension
1600c8c 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Make Time Zone Final Becuase Never Changed
511c19b 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Move Cosntructor Before Methods As Expected
7deb89b 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Generate toString Method for Better Debugging
67b144b 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Use Generated Nullcheck to simplify Code
1dde6ac 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Group Properties Together in Class
294f303 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Make Inline Comment A Real JavaDoc to be Visible in Intellisense
87ee122 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Docuemnt Unchecked Exception Condition
a0974d5 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Improve and Test Wrong Argument Length Check
6e1eaf0 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Document Constructors of Exception
dfbbfad 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Show Helpfull Errormessage When K8s Env Vars Not Set
ee60cfa 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Implement Help Message for Easier Usage of Final Binary
cb28f63 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Verify Number of Passed In Arguments With Proper Error Message
c09cc78 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Tests For Help Flag
c2e7e80 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Log Warning When Running In Dev Mode To PRevent It In Production
d7419e7 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Close File Reader By Using Try-With-Resource
1467ec2 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Add Shorthand Script to Execute Jar File
fbb20fa 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Improve Error Message If Kubernetes Config Can't Be Read In Dev Mode
3730f86 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Handle Erros Parsing Kubernetes Config
2365ba7 
Since the error handling of Kubernetes lib and the used YAML parser lib
is quite shitty the resulting error message is not very precise.
The problem is that e.g. for empty file they just throw an NPE on a
underlying Map<>. For bad format it just throw random errors such as
class cast excpetions.

Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Show Env Vars Also In Help Message
6f4a291 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Add Missing License Headers
c31d600 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf
Add Missing SPDX Headers
0be20ca 
Signed-off-by: Sven Strittmatter <[email protected]>
@Weltraumschaf Weltraumschaf force-pushed the improve_error_handling branch from 4ca8be1 to 0be20ca Compare February 7, 2025 10:16
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Feb 7, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@Weltraumschaf Weltraumschaf enabled auto-merge (rebase) February 7, 2025 10:17
@Weltraumschaf Weltraumschaf merged commit 53d5779 into secureCodeBox:main Feb 7, 2025
51 checks passed
@Weltraumschaf Weltraumschaf deleted the improve_error_handling branch February 7, 2025 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@J12934 J12934 J12934 approved these changes

Assignees

@Weltraumschaf Weltraumschaf

Labels

hook Implement or update a hook java Pull requests that update Java code persistence Implement or update a persistence store

Projects

secureCodeBox
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Weltraumschaf @J12934