Max flash based code quality is there a canary in your coal mine-

© 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
FlexPMD: Your canary in a coal mine
Xavier Agnetti & Xavi Beumala

What does our title mean?
 Early coal mines did not feature ventilation systems.
 Canaries are especially sensitive to methane and carbon monoxide,
which made them ideal for detecting any dangerous gas build-ups.
 As long as the canary in a coal mine kept singing, the miners knew their
air supply was safe.
 Do you want a canary on your project to keep it safe?

Who are we?
 Xavier Agnetti
 RIA Sales Engineer and former Adobe
RIA consultant
 Original creator of FlexPMD
 FlexPMD leader of the core engine
 Based out in Paris, France
Also Called the X-
Team
 Xavi Beumala
 Technical Architect at Technical and eXperience
Innovation (TXI) department at Adobe
 FlexPMD leader of the Eclipse plugin
 Based out in Barcelona, Spain

1. Introduction on software
quality
2. What could your canary
detect?
3. What are the main FlexPMD
rules?
4. How to tune your canary?
5. How would your canary
environment look like?

Quotes on software quality – 1/4
“Any fool can write code that a
computer can understand.
Good programmers write code
that humans can understand.”
~Martin Fowler

“You can't control what you can't
measure.” ~Tom DeMarco

“Controlling complexity is the
essence of computer
programming” ~ Brian Kernighan

 “Programs for sale: fast, reliable,
cheap - choose two.” ~Unknown author
 “The thing about quick and dirty
fixes is that the dirty remains long
after the quick has been
forgotten” ~Unknown author

Quality will get your customers addicted

Cost of fixing software bugs
Req Design Code DevT AccT Ops
1x 5x 10x
20x
50x
150x

Good workmen have good tools

Common quality criteria
Stability
Usability
MaintainabilityEfficiency
Portability

What would your canary detect
 Coding standards violations
 Code (Bug) duplication
 Big size file
 Large code complexity
 Unhandled exceptions
 Dead code
 Unused variables, parameters,
methods, classes
 ...

How is your canary called?

What are your canary abilities? – 1/2
 Code anti-patterns (FlexPMD)
 Code duplications (FlexCPD)
 Code metrics (FlexMetrics)
 Code complexity (FlexPMD +
FlexMetrics)
 Parameterize rule
 Ignore rule violations

What are your canary abilities? – 2/2
Despite its name, FlexPMD
can analyze any AS3-
based projects (not only
Flex ones)
even if some rules are Flex-specific
(MXML or incorrect usage of the Flex
SDK)

quality
detect?
3. What are the main
FlexPMD rules?
4. How to tune your canary?

FlexPMD rules

quality
detect?
3. What are the main FlexPMD
rules?
4. How to tune your
canary?

Build your ruleset - Pick up your rules

Build your ruleset – Prioritize the rules
Communicate and formalize your quality requirements
Qualification Icon Explanation
Error
Development or design
problem
Warning
Code smells or potential
risks
Information
Possible good practices
violation

Or create your own ones

Flash quality in Continuous Integration
 Possible invocations
 Ant task
 Maven plugin
 Reports pretty printing
in Hudson using:
 Violations plugin
 PMD plugin

Flash quality web portal: Sonar
 Sonar is an open
platform to manage
code quality. As
such, it covers the 7
axes of code quality:

Flash quality in the IDE
 Eclipse plugin
 The Eclipse Plugin is a plugin to streamline the development process in
regards to FlexPMD violations
 It analyses the code and marks the violations inline in the code so that
developers can see them as they develop
 It allows easy navigation between the list of violations and the associated code

Eclipse plugin: Workflows
 Development workflow
 Proactively analyses code as you develop and considers violations first class
citizen during compilation
 Code review workflow
 Audit and review the quality of an entire project or any given functional area in
terms of PMD violations.

Eclpise Plugin: Development Workflow
 Ideal for
 Projects that start using FlexPMD from the very beginning
 Teams that proactively want to promote Collective code and team best
practices
 Benefits
 FlexPMD recomendations become a first class citizen during development.
During compilation FlexPMD errors can prevent the entire build to succeed and
will be displayed in the standard Eclipse Errors view
 FlexPMD execute automatically on every compilation

Eclipse Plugin: Code Review Workflow
 Ideal for
 Projects that didn’t use FlexPMD from the very beginning
 Projects where not all developers use FlexPMD
 Code or Applicatoin reviews to check the health of the code
 Audit specific functional areas
 Benefits
 FlexPMD recomendations are displayed in a specific panel and can be sorted
attending its relevance or violation type

Eclipse Plugin: FlexCPD
 Executes on demand
 Creates a list of snippets of duplicated code
 You can navigate to the source code file by double clicking on the items

Eclipse Plugin: Installation
 The installation and uninstallation process follow Eclipse standard
mechanisms
 Installation using the update site
 Uninstallation using Eclipse > About > Installation Details
 The latest version comes with FlexPMD 1.2 bundled

Eclipse Plugin: Installation

Eclipse Plugin: Configuration

Eclipse Plugin: Development Workflow

Eclipse Plugin: Review Workflow

Key factors of success
 Explain code base quality to
stakeholders
 Make the developers adhering to
software quality
 Don’t hold on test and quality
measurement until the project
end
 Formalize your quality
requirements
 Measuring with targets
 Integrated and correct tools
 Provide executive briefings to
managers

Next steps : Let’s dive in

Acknowledgments
 To Francois Le Droff, Technical Architect on Adobe
Hendrix, who showed us the way from quality
management to FlexPMD
 For French speaking attendees, check out his session about
Quality Open Source Software:
 http://www.slideshare.net/francoisledroff/soire-qualite-
logicielle-paris-jug-tour-dhorizon-des-outils-open-
source?from=ss_embed

Max flash based code quality is there a canary in your coal mine-

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

En vedette

En vedette (18)

Similaire à Max flash based code quality is there a canary in your coal mine-

Similaire à Max flash based code quality is there a canary in your coal mine- (20)

Dernier

Dernier (20)

Max flash based code quality is there a canary in your coal mine-

Notes de l'éditeur