/
ExitOutsideMain.kt
67 lines (61 loc) · 2.31 KB
/
ExitOutsideMain.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
package io.gitlab.arturbosch.detekt.rules.bugs
import io.gitlab.arturbosch.detekt.api.CodeSmell
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.Debt
import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Issue
import io.gitlab.arturbosch.detekt.api.Rule
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.internal.RequiresTypeResolution
import io.gitlab.arturbosch.detekt.rules.isMainFunction
import org.jetbrains.kotlin.psi.KtCallExpression
import org.jetbrains.kotlin.psi.KtNamedFunction
import org.jetbrains.kotlin.psi.psiUtil.getStrictParentOfType
import org.jetbrains.kotlin.resolve.calls.util.getResolvedCall
import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameOrNull
/**
* Flags use of System.exit() and Kotlin's exitProcess() when used outside the `main` function. This makes code more
* difficult to test, causes unexpected behaviour on Android, and is a poor way to signal a failure in the program. In
* almost all cases it is more appropriate to throw an exception.
*
* <noncompliant>
* fun randomFunction() {
* val result = doWork()
* if (result == FAILURE) {
* exitProcess(2)
* } else {
* exitProcess(0)
* }
* }
* </noncompliant>
*
* <compliant>
* fun main() {
* val result = doWork()
* if (result == FAILURE) {
* exitProcess(2)
* } else {
* exitProcess(0)
* }
* }
* </compliant>
*
*/
@RequiresTypeResolution
class ExitOutsideMain(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
javaClass.simpleName,
Severity.Warning,
"Do not directly exit the process outside the `main` function. Throw an exception instead.",
Debt.TEN_MINS
)
@Suppress("ReturnCount")
override fun visitCallExpression(expression: KtCallExpression) {
super.visitCallExpression(expression)
if (expression.getStrictParentOfType<KtNamedFunction>()?.isMainFunction() == true) return
val fqName = expression.getResolvedCall(bindingContext)?.resultingDescriptor?.fqNameOrNull() ?: return
if (fqName.asString() in setOf("kotlin.system.exitProcess", "java.lang.System.exit")) {
report(CodeSmell(issue, Entity.from(expression), issue.description))
}
}
}