Statische Code-Analyse für Groovy & Grails mit CodeNarccamelcasecon.de/pdf/groovy/CamelCaseCon2011_CodeNarc_StefanGlase.pdf · Statische Code-Analyse für Groovy & Grails mit CodeNarc

© OPITZ CONSULTING GmbH 2011 Folie 1Statische Code-Analyse für Groovy & Grails mit CodeNarc

Statische Code-Analyse für Groovy & Grails mit CodeNarc

CamelCaseCon 2011

Vortrag von Stefan Glase

am 07.09.2011


Stefan Glase, OPITZ CONSULTING

Software-EntwicklerJava EE, Spring, Groovy, Grails

Trainer und Coach

Sprecher und Autor


Märkte

Java

SOA

ORACLE

BI/DWH

Outtasking

Kunden

Branchen-

übergreifend

Über 600

Kunden

Leistungs-

angebot

IT-Strategie

Beratung

Implementierung

Betrieb

Training

Fakten

Gründung 1990

400 Mitarbeiter

8 Standorte in

D/PL

Industrie / Versorger /

Telekommunikation

29%

Handel / Logistik /

Dienstleistungen

29%

42%

Öffentliche Auftraggeber /

Banken & Versicherungen /

Vereine & Verbände

© OPITZ CONSULTING GmbH 2011


Agenda

Was ist CodeNarc?

CodeNarc Regeln und Regelwerke

CodeNarc im Browser

Eigene CodeNarc Regeln erstellen

Integration in Gradle-basierte Groovy-Anwendungen

Integration in Grails-Anwendungen

Weitere Integrationsmöglichkeiten

Fazit


1Was ist CodeNarc?


„ “

Was ist CodeNarc?

CodeNarc analyzes Groovy code for defects,

bad practices, inconsistencies, style issues

and more.

http://codenarc.sourceforge.net/



Was ist CodeNarc?

Aktuelle Version 0.15

Bibliothek ist im Maven Central Repository verfügbar

264 Regeln in kategorisierten Regelwerken

Verschiedene Arten von Reports: XML, HTML, Text

Kontakt zu den Entwicklern Chris Mair und Hamlet D'Arcy

via Mailing-Liste, BugTracker oder Twitter

<dependency><groupId>org.codenarc</groupId><artifactId>CodeNarc</artifactId><version>0.15</version>

</dependency>


Was ist CodeNarc?

Beispiel HTML-Report


2CodeNarc Regeln und Regelwerke



Regeln (Rule) werden zu Regelwerken

(RuleSet) zusammengefasst und liefern

Verstöße (Violation) im untersuchten

Code (SourceCode)

Analyse des Abstract Syntax Tree (AST)

mittels Visitor-Objekten (AstVisitor)

Inklusive Hilfsklasse AstUtil für

übliche Operationen auf dem AST

Erzeugung von Verstößen (Violation)

mittels einfacher API im AstVisitor



264 Regeln… und die Zahl ist stetig wachsend!

BigDecimalInstantiationRule

BooleanMethodReturnsNullRule

CloneableWithoutCloneRule

ConstantTernaryExpressionRule

ConstantIfExpressionRule

RemoveAllOnSelfRule

DuplicateCaseStatementRule

EqualsAndHashCodeRule

EmptyElseBlockRule

EmptyFinallyBlockRule

EmptyForStatementRule

EmptySwitchStatementRule

EmptySynchronizedStatementRule

EmptyTryBlockRule

SerializableClassMustDefineSerialVersionUIDRule

BooleanGetBooleanRule

BrokenOddnessCheckRule

ConsecutiveLiteralAppendsRule

… und viele weitere!



Ein paar Beispiele…

def a = '' + 123



abstract class CodeMonster {

static { }

int hashCode() { return 1 }

}



Regeln liegen in Form von XML-Dokumenten zur einfachen

Einbindung und Konfiguration der anzuwendenden Regeln

vor


3CodeNarc im Browser


CodeNarc im Browser

http://meetcodenarc.appspot.com/



CodeNarc im Browser


4Eigene CodeNarc Regeln erstellen



Anforderungen

( )



Checkout der Sourcen von SourceForgesvn checkout https://codenarc.svn.sourceforge.net/svnroot/codenarc codenarc



Bauen des Projektes mit Mavenmvn install



Erstellen der Regel mit CodeNarc eigenem Groovy Scriptgroovy codenarc.groovy create-rule



Editieren des MessageBundle (korrekte Sortierung)src/main/resources/codenarc-base-messages.properties



Implementierung des Tests zur Absicherung der Regelsrc/test/groovy/org.codenarc.rule.exceptions.AvoidPrintStackTraceRuleTest



Implementierung der Regel und des AST-Visitorssrc/main/groovy/org.codenarc.rule.exceptions.AvoidPrintStackTraceRule



Bereitstellen der eigenen Regel

1. Patch erstellen

2. Eintrag im BugTracker mit

angehängtem Patch erstellen



Mehr Informationen für Entwickler auf der CodeNarc Webseite

http://codenarc.sourceforge.net/codenarc-developer-

guide.html

http://codenarc.sourceforge.net/codenarc-developer-guide.html






5 Integration in Gradle-basierte Groovy-Anwendungen



CodeNarc ist fest integriert im Gradle Code Quality Plugin Gradle 1.0 Milestone 3 enthält CodeNarc 0.13

http://www.gradle.org/code_quality_plugin.html

Code Qualitity Plugin verwendet Checkstyle für Java-Code

CodeNarc für Groovy-Code

CodeNarc Plugin als eigenständiges Plugin Version von CodeNarc ist frei konfigurierbar

http://evgeny-goldin.com/wiki/Gradle-CodeNarc-plugin

http://www.gradle.org/code_quality_plugin.html










Live-Demo… bitte Daumen drücken!


6 Integration in Grails-Anwendungen


Was ist Grails?


„ “

Was ist Grails?

Grails is an advanced and innovative open source web

application platform that delivers new levels of developer

productivity by applying principles like Convention over

Configuration. Grails helps development teams embrace agile

methodologies, deliver quality applications in reduced

amounts of time, and focus on what really matters: creating

high quality, easy to use applications that delight users.

Grails naturally complements Java application development

since it is built on Spring and based on Groovy, the leading

dynamic language for the Java platform.

http://www.springsource.com/developer/grails

http://www.springsource.com/developer/grails



Zur Integration von CodeNarc in Grails existiert das CodeNarc Plugin

http://grails.org/plugin/codenarc

http://grails.org/plugin/codenarc



Live-Demo… bitte noch einmal Daumen drücken!


7Weitere Integrationsmöglichkeiten


Weitere Integrationsmöglichkeiten

IDEs IntelliJ………………………............................ (IDEA CodeNarc Plugin)

Application Frameworks Grails ………………………............................ (Grails CodeNarc Plugin)

Griffon ………………………………………….. (Griffon CodeNarc Plugin)

Build- und Code-Analyse-Werkzeuge Gradle ………………………………………….. (Gradle Code Quality Plugin)

Maven ………………………………………….. (Maven CodeNarc Plugin)

Hudson/Jenkins ……………………………..... (Hudson Violations Plugin)

Sonar …………………………………………... (Sonar Groovy Plugin)

http://codenarc.sourceforge.net/codenarc-other-tools-frameworks.html










Fazit


Im Netz...

CodeNarc:

http://codenarc.sourceforge.net

http://meetcodenarc.appspot.com

http://www.youtube.com/watch?v=ZPu8FaZZwRw

Beispiele:

https://github.com/codescape/presentations

Twitter:

@stefanglase



http://www.youtube.com/watch?v=ZPu8FaZZwRw

https://github.com/codescape/presentations

http://twitter.com/stefanglase

http://twitter.com/stefanglase


Fragen und Antworten


Kontakt

Stefan GlaseSenior Consultant

OPITZ CONSULTING Gummersbach GmbH

Kirchstr. 6, 51647 Gummersbach

Tel. +49 (2261) 6001 – 0

[email protected]

mailto:[email protected]



Statische Code-Analyse für Groovy & Grails mit CodeNarccamelcasecon.de/pdf/groovy/CamelCaseCon2011_CodeNarc_StefanGlase.pdf · Statische Code-Analyse für Groovy & Grails mit CodeNarc

Documents