rspec/rules/S1075/java/rule.adoc

58 lines
1.4 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
include::../description.adoc[]
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 12:47:33 +02:00
----
public class Foo {
public Collection<User> listUsers() {
2021-06-09 15:24:12 +02:00
File userList = new File("/home/mylogin/Dev/users.txt"); // Noncompliant
2020-06-30 12:47:33 +02:00
Collection<User> users = parse(userList);
return users;
}
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 12:47:33 +02:00
----
public class Foo {
// Configuration is a class that returns customizable properties: it can be mocked to be injected during tests.
private Configuration config;
public Foo(Configuration myConfig) {
this.config = myConfig;
}
public Collection<User> listUsers() {
// Find here the way to get the correct folder, in this case using the Configuration object
String listingFolder = config.getProperty("myApplication.listingFolder");
// and use this parameter instead of the hard coded path
File userList = new File(listingFolder, "users.txt"); // Compliant
Collection<User> users = parse(userList);
return users;
}
}
----
== Resources
* https://wiki.sei.cmu.edu/confluence/x/OjdGBQ[CERT, MSC03-J.] - Never hard code sensitive information
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]