visualize your architecture and information

Visualize your architecturePeter Norrhall, Chief Architect

[email protected]

Visualize your architecture© Extenda

Why Images?• ”A picture says more than 1000 words”

2


Thermometer

3

Microstates

Macrostate (Abstraction)


The holy number 7

4

7

1

13

2

21

95

Peter

Maria

Phrida

Linnea

Jakob

Moa

Alfons

1956 George Miller


Conscious Communication

5

7 = 2-3 bit / s


Unconscious Communication

6

Eyesight 10.000.000 bit/s

Touch 1.000.000 bit/s

Hearing 100.000 bit/s

Smell 100.000 bit/s

Taste 1.000 bit/s

M Zimmerman, Physiologie des Menchen


Les Misérables – Communication tree

7

Exformation -removed important information Association

Victor Hugo Publisher

?

!Tor Nörretranders, ”Märk Världen”


Pictures vs Text

8

Bla, bla, bla L-Mode

R-Mode + L-Mode


Why do we need Architect Documents?

9

Code

Xunit/BDD

Architect/Design Document


ISO 42010• Recommended practice for architectural description of software-

intensive systems

10


Architectural Views

11

Deployment

Functional

Process Non-Functional

Logical

Interface

Design

Intrastructure

Operational

Security

Data

http://www.codingthearchitecture.com/


Agile Development Documentation

12

Stakeholders

Developers

Architect/Developer

Code & Refactor

Refactor


Methods & Tools

13

Meta-model – UML/DDD/… – Association

Design Tools – White Board/Enterprise Architect/Visio/PPT/…

Exformation


The problem• Systems and software are evolving –> ”Document Dept” using

notioned based architecture or design• What is important and to whom? The sender or the receiver?

• http://martinfowler.com/ieeeSoftware/whoNeedsArchitect.pdf

• Perhaps the most important is to write/visualize• Andy Hunt, Pragmatic Thinking

14

http://martinfowler.com/ieeeSoftware/whoNeedsArchitect.pdf




Software Visualization• Generating images instead of doing it by hand when we want to

explore the information (microstates).

• Information visualization is essential in making sense out of large

data sets (microstates) by finding patterns.

• Generate and Display for a specific purpose

• Relationships between modules/components/classes/entities/…

• Code or Information dept

15


Visualize Software

16

Scanner/Parser

Data Source Code

Instrumentation

Running Systems

Mapper

Nodes: A, BEdges: A->B RendererModel

Diagram


Code Quality• The Code (source and test) is the actual system• Find Relations and dependencies

• Beneficial Relationships

• Finding unwanted relationships

• Code metrics

• Average Number of Methods (NOM) per Class

• Average Lines of Code (LOC) per method

• Average Cyclomatic Number (CYCLO) per line of code

• …

17


Code Metrics• Lines of Code• Average Number of Methods (NOM) per Class• Average Lines of Code (LOC) per method• Average Cyclomatic Number (CYCLO) per line of code • Duplication• Check-in counts / churn• Test Coverage• Coupling • …

18


Cyclomatic Complexity

19

if( c1() ) f1();else f2(); if( c2() ) f3();else f4();

http://en.wikipedia.org/wiki/Cyclomatic_complexity


Code Metrics• SonarSource

20


Code Metrics

21


Code Metrics – Industry Standard

22


Rules Compliance

23


Code Violations

24


Measure over time

25


Complexity Distribution

26

Visualize your architecture© Extenda 27


Find the truth

28


CodeCity

29


Dependencies

30


Dependencies• ”Design is beneficially related elements”, K Beck

• http://www.threeriversinstitute.org/blog/?p=111

• Predicting Subsystem Failures using Dependency Graph

Complexities

• http://research.microsoft.com/pubs/70340/tr-2006-126.pdf

31

http://www.threeriversinstitute.org/blog/?p=111

http://www.threeriversinstitute.org/blog/?p=111

http://research.microsoft.com/pubs/70340/tr-2006-126.pdf

http://research.microsoft.com/pubs/70340/tr-2006-126.pdf


Structure 101• Code Parser and Analyzer for Java, .Net and C/C++• Interactive explorer of relationships and quality of code finding and

displaying technical dept• CI ”integration”

32


Demo : Spring

33


Commercial Alternatives• Sotoarc/Sonargraph - http://www.hello2morrow.com/

34

http://en.wikipedia.org/wiki/Sotoarc


Drawbacks• Package Dependencies• CC metrics = # faults?

35


Graphviz• You are in charge• Simple textual input -> different graphical output• Automated graph layout tool based on graph theory

• Developed by A&T, Common Public Licence

36


Model & Diagram

digraph G {

a->b;

}

37

$ dot -Tpng simple.dot –o simple.png


Graphs• Directed Graph

digraph G {

a -> b;

b -> c;

a -> c;

}

• Undirected Graph

graph G {

a -- b;

b -- c;

a -- c;

}

38


Layout• Dot – Hierarchy graph• Neato – Undirected graph using spring model• Twopi – Radial Layout• Circo – Circular Layout• Fdp – Undirected graphs using force-directed spring model• Sfdp – Similar to Fdp

39


Output Formats• PostScript (ps)• Structured Vector Graphics (svg)• Images (png, gif)• Imagemap (imap)• …

40


Graph Attributes• Size = ”x, y”• Rankdir = LR | RL | BT• Rotate=90• Stylesheet=”.css”• …

41


Information Dept : E-Commerce Catalog

42

Books

Software Engineering

Agile

Agile Development

Management 3.0

Programming

Novels

18th Century


Country #1 – Dot layout

43


Graph Attribute• Rotate=90

44


neato

45

Category

Product

$ neato -Tpng catalog.dot –o catalog.png


Node Attributes• Blue Box• node [shape=box,height=0.1,width=0.1,color=blue,style=filled]• product56001;• product57001;

• …

• Red Circle• node [shape=circle,style=filled,color=red,height=0.1,label="”]• category10002;• category10003;

46


Node Attribute• node [shape=circle,style=filled,color=red,height=0.3,label=""];• category10002;

• node [shape=circle,style=filled,color=red,height=0.1,label=""];• category10003;• category10004;• …

47


Highlight root category

48


Twopi – Radial Layout

49


Country #2

50


Country #3

51


Other• Component Dependencies (Spring XML Bean Config)• Ant Target Dependencies• Maven Jar Dependencies• …

52


Other tools• Enterprise Architect – Code (better suited for user generated)• Erwin – Database ER-model

53


Summary

54

Practice Exformation

Use Visualization

Question Metrics


Questions?

55


Referenser• ”Märk Världen”, Tor Nörretranders, ISBN 9100570702• http://martinfowler.com/ieeeSoftware/whoNeedsArchitect.pdf• http://en.wikipedia.org/wiki/Cyclomatic_complexity• http://www.enerjy.com/blog/?p=198 - CC > 74 not good• http://www.leshatton.org/Documents/TAIC2008-29-08-2008.pdf -

Tools• http://www.headwaysoftware.com/ - Structure 101• http://www.hello2morrow.com/ - Sonargraph• http://www.sonarsource.org/ - SonarSource• http://www.graphviz.org/ - Graphviz• Similar presentations• http://www.jfokus.se/jfokus11/preso/jf11_VizualizationsForCodeMetrics.pdf• http://erik.doernenburg.com/wp-content/archive/Doernenburg_SoftwareQuality_ver2a.pdf• http://www.slideshare.net/girba/pragmatic-quality-assessment-tutorial-icse-2008• http://www.infoq.com/presentations/Where-Did-My-Architecture-Go





http://www.enerjy.com/blog/?p=198

http://www.enerjy.com/blog/?p=198

http://www.leshatton.org/Documents/TAIC2008-29-08-2008.pdf

http://www.leshatton.org/Documents/TAIC2008-29-08-2008.pdf

http://www.headwaysoftware.com/

http://www.headwaysoftware.com/

http://www.hello2morrow.com/

http://www.hello2morrow.com/

http://www.sonarsource.org/

http://www.sonarsource.org/

http://www.graphviz.org/

http://www.graphviz.org/

http://www.jfokus.se/jfokus11/preso/jf11_VizualizationsForCodeMetrics.pdf

http://www.jfokus.se/jfokus11/preso/jf11_VizualizationsForCodeMetrics.pdf

http://erik.doernenburg.com/wp-content/archive/Doernenburg_SoftwareQuality_ver2a.pdf

http://erik.doernenburg.com/wp-content/archive/Doernenburg_SoftwareQuality_ver2a.pdf

http://www.infoq.com/presentations/Where-Did-My-Architecture-Go









[email protected]@peternorrhallLinkedIn

57

visualize your architecture and information

Technology