Statyczna analiza kodu dla języka Scala w SBT - część 2.

Jest to kontynuacja posta Statyczna analiza kodu dla języka Scala w SBT - część 1.

Wtyczki nie modyfikujące kodu źródłowego.

Jest to o wiele większy zestaw wtyczek niż poprzednio.

Scalastyle - Scala style checker

Scalastyle

Dodajemy Scalastyle do pliku project/plugins.sbt:

addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "1.0.0")

Generujemy domyślny plik konfiguracyjny scalastyle-config.xml zawierający reguły:

sbt scalastyleGenerateConfig

Wchodzimy do pliku scalastyle-config.xml i zmieniamy poziomy z warning na error.

Następnie wyłączamy sprawdzanie nagłówka:

 <check level="error" class="org.scalastyle.file.HeaderMatchesChecker" enabled="false"/>

A na końcu poprawiamy formatowanie dwuliniowej instrukcji if:

 <check level="error" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
  <parameters>
   <parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
   <parameter name="doubleLineAllowed"><![CDATA[true]]></parameter>
  </parameters>
 </check>

Teraz analizujemy kod i testy za pomocą polecenia:

sbt scalastyle test:scalastyle it:scalastyle

Pełna lista reguł jest dostępna pod linkiem rules-1.0.0.

Dla mnie najważniejszą funkcjonalnością jest liczenie złożoności cyklomatycznej:

 <check level="error" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" enabled="true">
  <parameters>
   <parameter name="maximum"><![CDATA[2]]></parameter>
  </parameters>
 </check>

WartRemover: a flexible scala linter

WartRemover jest to wtyczka do usuwania brodawek z kodu. Przez brodawkę autor rozumie brzydkie rzeczy, które można napisać w języku Scala, bo składnia języka jest zbyt liberalna. Nazwa wtyczki jest trochę na wyrost, ponieważ w tej chwili WartRemover pozwala tylko odnaleźć brodawki, a usunąć musimy je sami.

Dodajemy wartremover do pliku project/plugins.sbt:

addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.3.7")

W pliku build.sbt włączamy wartremover:

wartremoverErrors ++= Warts.unsafe

Od teraz przy każdej kompilacji będą poszukiwane brodawki. Pełna lista brodawkek

Scapegoat - Scala compiler plugin for static code analysis

Scapegoat to linter dla języka Scala.

Dodajemy scapegoat do pliku project/plugins.sbt:

addSbtPlugin("com.sksamuel.scapegoat" %% "sbt-scapegoat" % "1.3.8")

Ustawiamy wersję scapegoat w build.sbt:

scapegoatVersion := "1.1.0"

Analizujemy kod za pomocą polecenia:

sbt scapegoat

Linter - Static Analysis Compiler Plugin for Scala

Linter to niestety nie rozwijany już linter.

Dodajemy Linter do pliku project/plugins.sbt:

addCompilerPlugin("org.psywerx.hairyfotr" %% "linter" % "0.1.17")

Linter uruchamia się automatycznie podczas kompilacji.

Scala clippy - Good advice for Scala compiler errors

Scala clippy to wtyczka dodająca porady jak poprawić błędy kompilacji.

Dodajemy clippy do pliku project/plugins.sbt:

addSbtPlugin("com.softwaremill.clippy" % "plugin-sbt" % "0.5.3")

sbt-cpd - Copy & Paste Detector plugin using PMD for sbt.

sbt-cpd to wtyczka do wykrywania duplikatów kodu za pomocą Copy/Paste Detector (CPD) z projektu PMD.

Dodajemy sbt-cpd do pliku project/plugins.sbt:

addSbtPlugin("com.github.sbt" % "sbt-cpd" % "2.0.0")

I analizujemy kod za pomocą polecenia:

sbt cpd

stats - An sbt plugin for source code statistics

sbt-stats to wtyczka licząca ilość plików, linii i znaków w projekcie.

Dodajemy stats do pliku project/plugins.sbt:

addSbtPlugin("com.orrsella" % "sbt-stats" % "1.0.7")

Analizujemy kod za pomocą polecenia:

sbt stats

Podsumowanie

Wszystkie wymienione wyżej wtyczki dodałem do projektu [resentiment](https://github.com/writeonly/resentiment.)

Moja komenda generowania raportów wygląda następująco:

sbt scalastyle test:scalastyle it:scalastyle && \
sbt scapegoat && \
sbt cpd && \
sbt stats

Niestety, ponieważ używam metody println w klasie Core, muszę obniżyć poziom raportowania błędów dla reguły org.scalastyle.file.RegexChecker w ScalaStyle z error na warning.

Statyczna analiza kodu dla języka Scala w SBT - część 1.

Wprowadzenie

Statyczna analiza programu to analiza oprogramowania komputerowego wykonywanego bez faktycznego uruchamiania programów, w przeciwieństwie do analizy dynamicznej, która jest analizą wykonywaną na programach podczas ich wykonywania.

Termin ten jest zwykle stosowany do analizy wykonywanej przez zautomatyzowane narzędzie, analiza wykonywana przez człowieka jest nazywana przeglądem kodu.

Za wikipedią.

Jest to moja ulubiona część konfigurowania projektu, ponieważ odpowiednio dobrany zestaw wtyczek do statycznej analizy kodu potrafi znacząco skrócić czas potrzebny do zrobienia przeglądu kodu.

Wtyczki modyfikujące kod źródłowy

Z powodu ogromu różnego rodzaju wtyczek do statycznej analizy kodu dla języka Scala w tym poście skupię się tylko na wtyczkach modyfikujących kod źródłowy.

sbt-scalariform - sbt plugin adding support for source code formatting using Scalariform

sbt-scalariform to wtyczka sbt dodająca obsługę formatowania kodu źródłowego przy użyciu formatera kodu Scalariform

Dodajemy scalariform do pliku projektu/plugins.sbt:

addSbtPlugin("org.scalariform" % "sbt-scalariform" % "1.8.2")

Konfiguracja jest możliwa za pomocą:

  • zmiennej scalariformPreferences w pliku build.sbt
  • pliku .scalariform.conf

Formatowanie kodu jest wykonywane automatycznie podczas kompilacji:

sbt compile test:compile it:compile

Scalafmt - Code formatter for Scala

Scalafmt to formater kodu dla języka Scala.

Dodajemy scalafmt do pliku projektu/plugins.sbt:

addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "1.5.1")

Konfiguracja jest możliwa za pomocą pliku .scalafmt.conf, np.:

style=IntelliJ
maxColumn=80

Formatowanie domyślnie nie wykonuje się podczas kompilacji. Aby sformatować kod należy wykonać:

sbt scalafmtSbt scalafmt test:scalafmt it:scalafmt

Kolejno formatowany jest plik build.sbt, kod produkcyjny, testy jednostkowe i testy integracyjne.

Możliwe jest także tylko sprawdzenie czy kod jest sformatowany poprawnie za pomocą polecenia:

sbt scalafmtSbtCheck scalafmtCheck test:scalafmtCheck it:scalafmtCheck

Scalafix - Refactoring and linting tool for Scala

Scalafix to narzędzie do analizy statycznej kodu w języku Scala. Jest to jedyne narzędzie, które potrafi znalezione błędy poprawić.

Dodajemy scalafix do pliku projektu/plugins.sbt:

addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.0")

W pliku build.sbt dodajemy następujące linie:

  addCompilerPlugin(scalafixSemanticdb)
  scalacOptions ++= Seq(
    //"-Xfatal-warnings",   // it should be disabled for scalafix
     "-Ywarn-adapted-args", // for NoAutoTupling
     "-Ywarn-unused",       // for RemoveUnused
  )

Konfiguracja jest możliwa za pomocą pliku .scalafix.conf. Poniższa konfiguracja włącza wszystkie istniejące obecnie reguły:

rules = [

// Semantic Rules - Reguły semantyczne
  NoAutoTupling
  RemoveUnused
  
// Syntactic Rules - Reguły składniowe
  DisableSyntax
  LeakingImplicitClassVal
  NoValInForComprehension
  ProcedureSyntax
]

DisableSyntax.noVars = true
DisableSyntax.noThrows = true
DisableSyntax.noNulls = true
DisableSyntax.noReturns = true
DisableSyntax.noAsInstanceOf = true
DisableSyntax.noIsInstanceOf = true
DisableSyntax.noXml = true
DisableSyntax.noDefaultArgs = true
DisableSyntax.noFinalVal = true
DisableSyntax.noFinalize = true
DisableSyntax.noValPatterns = true
DisableSyntax.noUniversalEquality = true
DisableSyntax.noUniversalEqualityMessage = "== is unsafe since it allows comparing two unrelated types"
DisableSyntax.regex = []

Aby naprawić kod należy wykonać:

sbt scalafix test:scalafix it:scalafix

Kolejno naprawiany jest kod produkcyjny, testy jednostkowe i testy integracyjne.

Możliwe jest także tylko sprawdzenie czy kod nie zawiera błędów za pomocą polecenia:

sbt 'scalafix --check' 'test:scalafix --check' 'it:scalafix --check'

Podsumowanie

Wszystkie wymienione wyżej wtyczki dodałem do projektu resentiment.

Na chwilę obecna moja komenda do zbudowania tego projektu to:

sbt clean compile test:compile it:compile re/test && \
sbt coverage reJVM/test reJS/test && \
sbt coverageReport

Wcześniej jednak powinienem wywołać komendę refaktoryzującą i formatującą kod:

sbt scalafix test:scalafix it:scalafix && \
sbt scalafmtSbt scalafmt test:scalafmt it:scalafmt

Ewentualnie, gdy robię przegląd kodu mogę sprawdzić czy kod jest poprawny za pomocą komendy:

sbt 'scalafix --check' 'test:scalafix --check' 'it:scalafix --check' && \
sbt scalafmtSbtCheck scalafmtCheck test:scalafmtCheck it:scalafmtCheck 

Niestety ponieważ w testach używam porównania == musiałem zakomentować linię DisableSyntax.noUniversalEquality w pliku .scalafix.conf. Problem ten rozwiąże w następnym poście.

Follow