rspec/rules/S899/kotlin/rule.adoc

54 lines
1.2 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
include::../jvm-description.adoc[]
=== Noncompliant code example
2022-02-04 17:28:24 +01:00
[source,kotlin]
----
fun doSomething(file: File, lock: Lock) {
file.delete() // Noncompliant
// ...
lock.tryLock() // Noncompliant
}
----
=== Compliant solution
2022-02-04 17:28:24 +01:00
[source,kotlin]
----
fun doSomething(file: File, lock: Lock) {
if (!file.delete()) {
// file delete failed; take appropriate action
}
if (!lock.tryLock()) {
// lock failed; take appropriate action
}
}
----
== Resources
Although these resources talk about Java, the underlying information concerning the JVM is just as relevant for Kotlin.
* https://wiki.sei.cmu.edu/confluence/x/xzdGBQ[CERT, EXP00-J.] - Do not ignore values returned by methods
* https://wiki.sei.cmu.edu/confluence/x/TTZGBQ[CERT, FIO02-J.] - Detect and handle file-related errors
* CWE - https://cwe.mitre.org/data/definitions/754[CWE-754 - Improper Check for Unusual Exceptional Conditions]
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[]