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.

Sign up for GitHub

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

Jump to bottom

Code Refactoring for more Type Safety #36

Closed
Weltraumschaf opened this issue Jul 2, 2023 · 3 comments
Closed

Code Refactoring for more Type Safety #36

Weltraumschaf opened this issue Jul 2, 2023 · 3 comments
Assignees
@Weltraumschaf

Comments

@Weltraumschaf
Copy link
Member

Class ImportScanService uses ...Map<String, Object> which is an unnecessary anti pattern in Java. We should use <String,String> Instead, since the underlying REST call only deals with string anyway.
@Weltraumschaf Weltraumschaf self-assigned this Jul 2, 2023
@Weltraumschaf Weltraumschaf moved this from Backlog to In Progress in secureCodeBox v4 Jul 2, 2023
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Reformatting
4a6eead 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Rename factory method for RestTemplate
5d2d614 
In most languages it is a convention that getter/setter are side effect free
and do nothing more than get or set a value.

So I renamed this method to reflect that it is a factory method.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Give variable a name to reflect what it is
ebcf6f6 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Make some vars final to avoid accidental reassign
866c9c1 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Simplify code
8dd55dd 
Use var and better names to unclutter the code.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Move overloaded method beneath the origin method
87f17a6 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Explixit call to super for dedicated constructor
6d2c7f4 
This is to avoid uninitialized state of parent properties, if some
type hierarchy is added afterwards.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Prohibit null as ctr argument
c5fdf64 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Make fields private and final bc internal state must…
82ed551 
… not be changed accidentaly from outside

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Use API constant instead of hard coded header name
dba557b 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Remove unused imports
2f0be23 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Rename getter bc getter by convention just return a …
bcb6f36 
…vule w/o any computation

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 More menaigfull var name and make it final
a9cad46 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Use format string to avoid accidentally string conca…
7eed4ff 
…t errors

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Fix typos and remove javadoc fmt bc the whole commen…
4c5c17b 
…t does not meet the requiremtns for method javadoc

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Use same var name as in createFindings method
7914e89 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Refnes fixme tag message
c35a8f7 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Use interface type instead of implementation in meth…
5a1a9f0 
…od signature

It should be avoided to use concrete implementations as types in an API,
if there is an interface because this gives the oportunity to switch
implementations at runtime w/o recompiling, whih is decoupling from
implementation details.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Add some FIXME tags so we remember where to do furth…
8f88c6f 
…er refactorings

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Better naming of loop var
f095a8d 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Use of <String,String:> as generic types instead of …
1360158 
…<String,Object>

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Reformatting
84877de 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Rename factory method for RestTemplate
aee1810 
In most languages it is a convention that getter/setter are side effect free
and do nothing more than get or set a value.

So I renamed this method to reflect that it is a factory method.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Give variable a name to reflect what it is
e5708c6 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Jul 2, 2023
@Weltraumschaf
secureCodeBox#36 Make some vars final to avoid accidental reassign
c78903e 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 4, 2023
@Weltraumschaf
#36 Make the code identical to duplicated one
29f1bd5 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 4, 2023
@Weltraumschaf
#36 Extract duplicated code to create rest template
b378f13 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 4, 2023
@Weltraumschaf
#36 Add missing SPDX headers
3218fca 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 4, 2023
@Weltraumschaf
#36 Fix license header to meet SPDX spec
6646f9a 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 4, 2023
@Weltraumschaf
#36 Add missing SPDX headers
2e35251 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 4, 2023
@Weltraumschaf
secureCodeBox#36 Add tests for auth header generation
c0feea3 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 4, 2023
@Weltraumschaf
secureCodeBox#36 USe better name forfacotry method
cb4352d 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 4, 2023
@Weltraumschaf
secureCodeBox#36 Simplify syntax of method
a238f26 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 4, 2023
@Weltraumschaf
secureCodeBox#36 Decompose method to make code testable
97d74cb 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 4, 2023
@Weltraumschaf
secureCodeBox#36 Decompose method to make code testable
b557e84 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 4, 2023
@Weltraumschaf
secureCodeBox#36 Decompose method to make code testable
7696009 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 4, 2023
@Weltraumschaf
secureCodeBox#36 Reformatting
83d45b7 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 5, 2023
@Weltraumschaf
secureCodeBox#36 Reformatting
386d1a6 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 5, 2023
@Weltraumschaf
secureCodeBox#36 Decompose method to make code testable
be1437d 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 5, 2023
@Weltraumschaf
secureCodeBox#36 Use method chaining for better readability
943769b 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit to Weltraumschaf/defectdojo-client-java that referenced this issue Sep 5, 2023
@Weltraumschaf
secureCodeBox#36 We assume a configured proxy only if username/passwo…
8c053c9 
…rd are set

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Add tests for auth header generation
d68a4ab 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 USe better name forfacotry method
9bd1dc3 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Simplify syntax of method
eea31b1 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Decompose method to make code testable
887d8b7 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Decompose method to make code testable
cabc1c5 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Decompose method to make code testable
281d53f 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Reformatting
a64fcf6 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Decompose method to make code testable
07aef76 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 Use method chaining for better readability
9626012 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
Weltraumschaf added a commit that referenced this issue Sep 5, 2023
@Weltraumschaf
#36 We assume a configured proxy only if username/password are set
b8654ca 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf Weltraumschaf moved this from In Progress to Todo in secureCodeBox v4 Dec 1, 2023
@Weltraumschaf
Copy link
Member Author

Type safty is improved, but not perfect. We want to remove Spring anyway, so closed.

@github-project-automation github-project-automation bot moved this from Todo to Done in secureCodeBox v4 Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Weltraumschaf Weltraumschaf

Labels
None yet
Projects
secureCodeBox v4
Archived in project
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Weltraumschaf @ManuelNeuer