Kotlin Static Analysis - Kotlin Everywhere 2019

Slides for my Kotlin Everywhere talk.

Transcript

1. Mantendo código Kotlin seguro: de ponta a ponta Matheus C. Candido Mobile Software Engineer @ Uber
2. Agenda 01 Análise estática 02 Ferramentas 03 Arquitetura 04 Customização 05 Automação
3. Análise estática Static program analysis is the analysis of computer software that is performed without actually executing programs
4. Ktlint Simples, drop-in
5. Ktlint Simples, drop-in Zero configuração
6. Ktlint Simples, drop-in Zero configuração Code styling*
7. Ktlint Simples, drop-in Zero configuração Code styling* Formatador
8. Ktlint Simples, drop-in Zero configuração Code styling* Formatador Baseado no Kotlin Style Guide, mas suporta Android Style Guide
9. Detekt Foco no detalhe
10. Detekt Foco no detalhe Totalmente configurável
11. Detekt Foco no detalhe Totalmente configurável Code styling
12. Detekt Foco no detalhe Totalmente configurável Code styling Performance
13. Detekt Foco no detalhe Totalmente configurável Code styling Performance Tratamento de exceções
14. Android Lint Java, Kotlin e Resources
15. Android Lint Java, Kotlin e Resources Regras especiais para Android
16. Android Lint Java, Kotlin e Resources Regras especiais para Android Super extensível
17. Android Lint Java, Kotlin e Resources Regras especiais para Android Super extensível Performance
18. Android Lint Java, Kotlin e Resources Regras especiais para Android Super extensível Performance Análise de recursos duplicados/não utilizados
19. Android Lint Java, Kotlin e Resources Regras especiais para Android Super extensível Performance Análise de recursos duplicados/não utilizados Funciona para projetos não-Android
20. Warning vs. Errors
21. Baseline
22. Ignorando issues conhecidos @SuppressLint("NewApi") @Suppress("NewApi")
23. Arquitetura
24. Arquitetura
26. Arquitetura
27. Criando novas regras
28. Issue registry @AutoService(IssueRegistry::class) class Registry() :fIssueRegistry() {f override val issues: List<Issue> = listOf(GetDrawableDetector.ISSUE) override val api: Int = CURRENT_API }f
29. Issue registry @AutoService(IssueRegistry::class) class Registry() :fIssueRegistry() {f override val issues: List<Issue> = listOf(GetDrawableDetector.ISSUE) override val api: Int = CURRENT_API }f
30. Issue registry @AutoService(IssueRegistry::class) class Registry() :fIssueRegistry() {f override val issues: List<Issue> = listOf(GetDrawableDetector.ISSUE) override val api: Int = CURRENT_API }f
31. Criando um detector /** *fDetector to check for usages of `ResourcesCompat.getDrawable` or `ContextCompat.getDrawable`. */ class GetDrawableDetector :fDetector(), SourceCodeScanner {f companion object {f val ISSUE =fIssue.create(f id =fISSUE_ID, briefDescription =fBRIEF_DESCRIPTION, explanation =fLINT_ERROR_MESSAGE, category =fCategory.CORRECTNESS,
32. Descrição da Issue val ISSUE =fIssue.create(f id =fISSUE_ID, briefDescription =fBRIEF_DESCRIPTION, explanation =fLINT_ERROR_MESSAGE, category =fCategory.CORRECTNESS, priority =f6, severity =fSeverity.ERROR, implementation =fcreate<GetDrawableDetector>()) }f override fun getApplicableMethodNames() = listOf("getDrawable") override fun visitMethodCall(f context:fJavaContext,
33. Descrição da Issue val ISSUE =fIssue.create(f id =fISSUE_ID, briefDescription =fBRIEF_DESCRIPTION, explanation =fLINT_ERROR_MESSAGE, category =fCategory.CORRECTNESS, priority =f6, severity =fSeverity.ERROR, implementation =fcreate<GetDrawableDetector>()) }f override fun getApplicableMethodNames() = listOf("getDrawable") override fun visitMethodCall(f context:fJavaContext,
34. Descrição da Issue val ISSUE =fIssue.create(f id =fISSUE_ID, briefDescription =fBRIEF_DESCRIPTION, explanation =fLINT_ERROR_MESSAGE, category =fCategory.CORRECTNESS, priority =f6, severity =fSeverity.ERROR, implementation =fcreate<GetDrawableDetector>()) }f override fun getApplicableMethodNames() = listOf("getDrawable") override fun visitMethodCall(f context:fJavaContext,
35. Descrição da Issue val ISSUE =fIssue.create(f id =fISSUE_ID, briefDescription =fBRIEF_DESCRIPTION, explanation =fLINT_ERROR_MESSAGE, category =fCategory.CORRECTNESS, priority =f6, severity =fSeverity.ERROR, implementation =fcreate<GetDrawableDetector>()) }f override fun getApplicableMethodNames() =f listOf("getDrawable") override fun visitMethodCall(f context:fJavaContext,
36. Filtrando a entrada overrideffunfgetApplicableMethodNames() =f listOf("getDrawable")f override fun visitMethodCall(f context:fJavaContext, node:fUCallExpression, method:fPsiMethod ){f iff(! getApplicableMethodNames().contains(node.methodName))freturn if (node.methodName == "getDrawable" && isBlacklisted(context.evaluator, node)) {f context.report(ISSUE, context.getLocation(node),
37. Detectando os problemas override fun visitMethodCall(f context:fJavaContext, node:fUCallExpression, method:fPsiMethod ){f iff(! getApplicableMethodNames().contains(node.methodName))freturn if (node.methodName == "getDrawable" && isBlacklisted(context.evaluator, node)) {f context.report(ISSUE, context.getLocation(node), LINT_ERROR_MESSAGE) }f
38. Detectando os problemas iff(! getApplicableMethodNames().contains(node.methodName))freturn if (node.methodName == "getDrawable" && isBlacklisted(context.evaluator, node)) {f context.report(ISSUE, context.getLocation(node), LINT_ERROR_MESSAGE) }f }f private fun isBlacklisted():fBoolean {f return evaluator.isMemberInClass(node.resolve(), "androidx.core.content.ContextCompat") ||f
39. Detectando os problemas iff(! getApplicableMethodNames().contains(node.methodName))freturn if (node.methodName == "getDrawable" && isBlacklisted(context.evaluator, node)) {f context.report(ISSUE, context.getLocation(node), LINT_ERROR_MESSAGE) }f }f private fun isBlacklisted():fBoolean {f return evaluator.isMemberInClass(node.resolve(), "androidx.core.content.ContextCompat") ||f
40. Detectando os problemas context.report(ISSUE, context.getLocation(node), LINT_ERROR_MESSAGE) }f }f private fun isBlacklisted():fBoolean {f return evaluator.isMemberInClass(node.resolve(),f "androidx.core.content.ContextCompat") ||f evaluator.isMemberInClass(node.resolve(), "androidx.core.content.res.ResourcesCompat")f }f }f
41. Usando a nova regra // no build.gradle dos outros projetos dependencies {f lintChecks project(":meu_detector") }f
42. Usando a nova regra // no build.gradle dos outros projetos dependencies {f lintChecks project(":meu_detector") }f
43. Relatórios
44. Relatórios
45. Relatórios
46. Evolução do código
48. Automação
49. Automação https://bit.cassiano.me/sa-automation
50. Automação https://bit.cassiano.me/sa-automation
51. Automação https://bit.cassiano.me/sa-comment-machine
52. Automação https://bit.cassiano.me/sa-git-hooks
53. Automação https://bit.cassiano.me/sa-git-hooks
54. Resumo Combine as ferramentas e aproveite o melhor de cada uma
55. Resumo Combine as ferramentas e aproveite o melhor de cada uma Aplique as regras que façam sentido para seu contexto
56. Resumo Combine as ferramentas e aproveite o melhor de cada uma Aplique as regras que façam sentido para seu contexto Automatize a formatação dos arquivos e partes do code review
57. https://bit.cassiano.me/sa-kotlin-conf-17-talk
58. https://bit.cassiano.me/sa-kotlin-conf-18-talk
59. …perguntas?