`
|
|
Sunday, July 8th, 2012
A |
Acceptance Criteria/Test, Automation, A/B Testing, Adaptive Planning, Appreciative inquiry |
B |
Backlog, Business Value, Burndown, Big Visible Charts, Behavior Driven Development, Bugs, Build Monkey, Big Design Up Front (BDUF) |
C |
Continuous Integration, Continuous Deployment, Continuous Improvement, Celebration, Capacity Planning, Code Smells, Customer Development, Customer Collaboration, Code Coverage, Cyclomatic Complexity, Cycle Time, Collective Ownership, Cross functional Team, C3 (Complexity, Coverage and Churn), Critical Chain |
D |
Definition of Done (DoD)/Doneness Criteria, Done Done, Daily Scrum, Deliverables, Dojos, Drum Buffer Rope |
E |
Epic, Evolutionary Design, Energized Work, Exploratory Testing |
F |
Flow, Fail-Fast, Feature Teams, Five Whys |
G |
Grooming (Backlog) Meeting, Gemba |
H |
Hungover Story |
I |
Impediment, Iteration, Inspect and Adapt, Informative Workspace, Information radiator, Immunization test, IKIWISI (I’ll Know It When I See It) |
J |
Just-in-time |
K |
Kanban, Kaizen, Knowledge Workers |
L |
Last responsible moment, Lead time, Lean Thinking |
M |
Minimum Viable Product (MVP), Minimum Marketable Features, Mock Objects, Mistake Proofing, MOSCOW Priority, Mindfulness, Muda |
N |
Non-functional Requirements, Non-value add |
O |
Onsite customer, Opportunity Backlog, Organizational Transformation, Osmotic Communication |
P |
Pivot, Product Discovery, Product Owner, Pair Programming, Planning Game, Potentially shippable product, Pull-based-planning, Predictability Paradox |
Q |
Quality First, Queuing theory |
R |
Refactoring, Retrospective, Reviews, Release Roadmap, Risk log, Root cause analysis |
S |
Simplicity, Sprint, Story Points, Standup Meeting, Scrum Master, Sprint Backlog, Self-Organized Teams, Story Map, Sashimi, Sustainable pace, Set-based development, Service time, Spike, Stakeholder, Stop-the-line, Sprint Termination, Single Click Deploy, Systems Thinking, Single Minute Setup, Safe Fail Experimentation |
T |
Technical Debt, Test Driven Development, Ten minute build, Theme, Tracer bullet, Task Board, Theory of Constraints, Throughput, Timeboxing, Testing Pyramid, Three-Sixty Review |
U |
User Story, Unit Tests, Ubiquitous Language, User Centered Design |
V |
Velocity, Value Stream Mapping, Vision Statement, Vanity metrics, Voice of the Customer, Visual controls |
W |
Work in Progress (WIP), Whole Team, Working Software, War Room, Waste Elimination |
X |
xUnit |
Y |
YAGNI (You Aren’t Gonna Need It) |
Z |
Zero Downtime Deployment, Zen Mind |
Posted in Agile | No Comments »
Sunday, October 9th, 2011
In Software, Quality is one of those badly abused term, which is getting harder and harder to define what it really means. I think we have a sense of quality. When we see something in a specific context, we can say its high quality or low quality, but its hard to define (and hence measure) what absolute quality really is.
You can measure somethings about quality, but don’t fool yourself to believe that IS quality.
Quality is subjective, relative and contextual.
Some might say things like code coverage, cyclomatic complexity and defect density is a good measure of quality. I would argue that those are attributes/aspects of quality, but not quality itself (symptoms not the disease itself.) Its a classic case of Fundamental Attribution Error. (If you go to France and see the first 50 Frenchmen wear glasses, you cannot conclude all Frenchmen wear glasses. Nor can you conclude that, if I wear glasses I’ll also be French.)
BTW people already differentiate between Internal/Intrinsic Quality and External/Extrinsic Quality. This is not enough to complicate things, evangelists would like to further slice and dice quality along different parameters (structural, functional, UX, etc.)
Some anecdotes:
Posted in Agile, Design, Metrics, Programming | No Comments »
Sunday, April 17th, 2011
Better productivity and collaboration via
improved feedback and high-quality information.
- Encourages an Evolutionary Design and Continuous Improvement culture
- On complex projects, forces a nicely decoupled design such that each modules can be independently tested. Also ensures that in production you can support different versions of each module.
- Team takes shared ownership of their development and build process
- The source control trunk is in an always-working-state (avoid multiple branch issues)
- No developer is blocked because they can’t get stable code
- Developers break down work into small end-to-end, testable slices and checks-in multiple times a day
- Developers are up-to date with other developer changes
- Team catches issues at the source and avoids last minute integration nightmares
- Developers get rapid feedback once they check-in their code
- Builds are optimized and parallelized for speed
- Builds are incremental in nature (not big bang over-night builds)
- Builds run all the automated tests (may be staged) to give realistic feedback
- Captures and visualizes build results and logs very effectively
- Display various source code quality metrics trends
- Code coverage, cyclomatic complexity, coding convention violation, version control activity, bug counts, etc.
- Influence the right behavior in the team by acting as Information Radiator in the team area
- Provide clear visual feedback about the build status
- Developers ask for an easy way to run and debug builds locally (or remotely)
- Broken builds are rare. However broken builds are rapidly fixed by developers
- Build results are intelligently archived
- Easy navigation between various build versions
- Easily visualization and comparison of the change sets
- Large monolithic builds are broken into smaller, self contained builds with a clear build promotion process
- Complete traceability exists
- Version Control, Project & Requirements Managements tool, Bug Tracking and Build system are completely integrated.
- CI page becomes the project dashboard for everyone (devs, testers, managers, etc.).
Any other impact you think is worth highlighting?
Posted in Agile, Continuous Deployment, Metrics, Organizational | No Comments »
Sunday, March 27th, 2011
public String execute() {
String resultStatus;
User user = getUser();
if (loggedIn(user)) {
String key = getParameter(KEY);
if (!isEmpty(key)) {
String id = findSourceIdFor(key);
Record record = new Record(user, key, id);
record.save();
resultStatus = "Successful";
} else {
logger.severe("Invalid key");
resultStatus = "Invalid Key";
}
} else
resultStatus = "User Not Logged In";
return resultStatus;
} |
public String execute() {
String resultStatus;
User user = getUser();
if (loggedIn(user)) {
String key = getParameter(KEY);
if (!isEmpty(key)) {
String id = findSourceIdFor(key);
Record record = new Record(user, key, id);
record.save();
resultStatus = "Successful";
} else {
logger.severe("Invalid key");
resultStatus = "Invalid Key";
}
} else
resultStatus = "User Not Logged In";
return resultStatus;
}
OR
public String execute() {
User user = getUser();
if (!loggedIn(user))
return "User Not Logged In";
String key = getParameter(KEY);
if (isEmpty(key)) {
logger.severe("Invalid key");
return "Invalid Key";
}
String id = findSourceIdFor(key);
new Record(user, key, id).save();
return "Successful";
} |
public String execute() {
User user = getUser();
if (!loggedIn(user))
return "User Not Logged In";
String key = getParameter(KEY);
if (isEmpty(key)) {
logger.severe("Invalid key");
return "Invalid Key";
}
String id = findSourceIdFor(key);
new Record(user, key, id).save();
return "Successful";
}
Personally I like the second code sample. I’m a big fan of the guard clause pattern. Even though the second code sample has multiple return statements (which some people hate), it has much lower cyclomatic complexity.
Posted in Code Smells, Design, Programming | 10 Comments »
Friday, March 25th, 2011
I find myself using the following heuristics:
More details: Long Method Smell: When is a method too big?
Posted in Agile, Code Smells, Design, legacy code, Programming | No Comments »
Tuesday, February 1st, 2011
I once worked for a manager (a.k.a Scrum Master) who insisted that we should have at least 85% code coverage on our project. If we did not meet the targeted coverage numbers this sprint, then the whole team would face the consequences during the upcoming performance appraisals. In spite of trying to talk to her, she insisted. I would like to believe that the manager had good intent and was trying to encourage developers to write clean, tested code.
However the ground reality was, my colleagues were not convinced about automated developer testing, they lacked basic knowledge and skill to do effective developer testing and the manager always kept them under high pressure. (Otherwise people would slack, she said.)
Now what do you expect to happened when managers push certain (poorly understood) metric down developers’ throats?
Humans are very good at gaming systems and they do a wonderful job.
- Some developers wrote automated tests with ZERO assert statements
- Others wrote complex, fragile test code which was an absolute maintenance nightmare. Their coverage numbers looked impressive.
- Me and my pair wrote a small test which would simply crawl all the code base. We were able to achieve 99% code coverage. (1% intensionally left, so we don’t look suspicious.)
- And so on…
The manager was very happy and so was the team. This went on for some sprints. One could find our manager showing off to her colleagues about how much the team respected her words and what a command she had on us.
Alas, her happiness lasted only for a few sprints. One fine Sprint demo day, I convinced the team to showcase our dirty little secret to all the stakeholders and management.
The event did shake up the management. It also sent out a clear message.
Code Coverage measures which line of code got executed (intensionally or accidentally) when you run the program or tests against the program. Code coverage tells you nothing about the quality of your tests, hence nothing about the quality of the code. Code coverage along with Cyclomatic Complexity can be used by the team to guide them, but not by management to judge the team.
Posted in Agile, Metrics, Organizational | 1 Comment »
Tuesday, August 31st, 2010
What tools do you use for Code Analysis of C/C++ projects?
This is a common questions a lot of teams have when we discuss Continuous Integration in C/C++.
I would recommend the following tools:
UPDATE: I strongly recommend looking at CppDepend (commercial), one stop solution for all kinds of metric. It has some very cool/useful features like Code Query Language, Customer Build Reporting, Comparing Builds, great visualization diagrams for dependency, treemaps, etc.
- Cyclomatic Complexity
- Code Coverage
- LOC Metric
- Most of the tools listed above would give you this measure
- LC2 – Open Source
- CNCC – Open Source
- Copy Paste Detector – PMD – Open Source
Wikipedia page on Static Code Analysis Tools has a list of many more tools.
Posted in Agile, Metrics, Tools | 1 Comment »
Thursday, October 1st, 2009
I have a treat for crappy code scavengers. Here is some code which has a Cyclomatic Complexity of 68 and NPath Complexity of 34,632 (this method is ONLY 189 lines long (154 NCSS)).
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
| /*
* Main reading method
*/
public void read(final ByteBuffer byteBuffer) throws Exception {
invalidateBuffer();
// Check that the buffer is not bigger than 1 Megabyte. For security reasons
// we will abort parsing when 1 Mega of queued chars was found.
if (buffer.length() > maxBufferSize)
throw new Exception("Stopped parsing never ending stanza");
CharBuffer charBuffer = encoder.decode(byteBuffer);
char[] buf = charBuffer.array();
int readByte = charBuffer.remaining();
// Just return if nothing was read
if (readByte == 0)
return;
// Verify if the last received byte is an incomplete double byte character
char lastChar = buf[readByte - 1];
if (lastChar >= 0xfff0) {
// Rewind the position one place so the last byte stays in the buffer
// The missing byte should arrive in the next iteration. Once we have both
// of bytes we will have the correct character
byteBuffer.position(byteBuffer.position() - 1);
// Decrease the number of bytes read by one
readByte--;
// Just return if nothing was read
if (readByte == 0)
return;
}
buffer.append(buf, 0, readByte);
// Do nothing if the buffer only contains white spaces
if (buffer.charAt(0) <= ' ' && buffer.charAt(buffer.length() - 1) <= ' ')
if ("".equals(buffer.toString().trim())) {
// Empty the buffer so there is no memory leak
buffer.delete(0, buffer.length());
return;
}
// Robot.
char ch;
boolean isHighSurrogate = false;
for (int i = 0; i < readByte; i++) {
ch = buf[i];
if (ch < 0x20 && ch != 0x9 && ch != 0xA && ch != 0xD && ch != 0x0)
// Unicode characters in the range 0x0000-0x001F other than 9, A, and D are not allowed in XML
// We need to allow the NULL character, however, for Flash XMLSocket clients to work.
throw new Exception("Disallowed character");
if (isHighSurrogate) {
if (Character.isLowSurrogate(ch))
// Everything is fine. Clean up traces for surrogates
isHighSurrogate = false;
else
// Trigger error. Found high surrogate not followed by low surrogate
throw new Exception("Found high surrogate not followed by low surrogate");
} else if (Character.isHighSurrogate(ch))
isHighSurrogate = true;
else if (Character.isLowSurrogate(ch))
// Trigger error. Found low surrogate char without a preceding high surrogate
throw new Exception("Found low surrogate char without a preceding high surrogate");
if (status == XMLLightweightParser.TAIL) {
// Looking for the close tag
if (depth < 1 && ch == head.charAt(tailCount)) {
tailCount++;
if (tailCount == head.length()) {
// Close stanza found!
// Calculate the correct start,end position of the message into the buffer
int end = buffer.length() - readByte + i + 1;
String msg = buffer.substring(startLastMsg, end);
// Add message to the list
foundMsg(msg);
startLastMsg = end;
}
} else {
tailCount = 0;
status = XMLLightweightParser.INSIDE;
}
} else if (status == XMLLightweightParser.PRETAIL) {
if (ch == XMLLightweightParser.CDATA_START[cdataOffset]) {
cdataOffset++;
if (cdataOffset == XMLLightweightParser.CDATA_START.length) {
status = XMLLightweightParser.INSIDE_CDATA;
cdataOffset = 0;
continue;
}
} else {
cdataOffset = 0;
status = XMLLightweightParser.INSIDE;
}
if (ch == '/') {
status = XMLLightweightParser.TAIL;
depth--;
} else if (ch == '!')
// This is a <! (comment) so ignore it
status = XMLLightweightParser.INSIDE;
else
depth++;
} else if (status == XMLLightweightParser.VERIFY_CLOSE_TAG) {
if (ch == '>') {
depth--;
status = XMLLightweightParser.OUTSIDE;
if (depth < 1) {
// Found a tag in the form <tag />
int end = buffer.length() - readByte + i + 1;
String msg = buffer.substring(startLastMsg, end);
// Add message to the list
foundMsg(msg);
startLastMsg = end;
}
} else if (ch == '<') {
status = XMLLightweightParser.PRETAIL;
insideChildrenTag = true;
} else
status = XMLLightweightParser.INSIDE;
} else if (status == XMLLightweightParser.INSIDE_PARAM_VALUE) {
if (ch == '"')
status = XMLLightweightParser.INSIDE;
} else if (status == XMLLightweightParser.INSIDE_CDATA) {
if (ch == XMLLightweightParser.CDATA_END[cdataOffset]) {
cdataOffset++;
if (cdataOffset == XMLLightweightParser.CDATA_END.length) {
status = XMLLightweightParser.OUTSIDE;
cdataOffset = 0;
}
} else
cdataOffset = 0;
} else if (status == XMLLightweightParser.INSIDE) {
if (ch == XMLLightweightParser.CDATA_START[cdataOffset]) {
cdataOffset++;
if (cdataOffset == XMLLightweightParser.CDATA_START.length) {
status = XMLLightweightParser.INSIDE_CDATA;
cdataOffset = 0;
continue;
}
} else {
cdataOffset = 0;
status = XMLLightweightParser.INSIDE;
}
if (ch == '"')
status = XMLLightweightParser.INSIDE_PARAM_VALUE;
else if (ch == '>') {
status = XMLLightweightParser.OUTSIDE;
if (insideRootTag
&& ("stream:stream>".equals(head.toString()) || "?xml>".equals(head.toString()) || "flash:stream>".equals(head
.toString()))) {
// Found closing stream:stream
int end = buffer.length() - readByte + i + 1;
// Skip LF, CR and other "weird" characters that could appear
while (startLastMsg < end && '<' != buffer.charAt(startLastMsg))
startLastMsg++;
String msg = buffer.substring(startLastMsg, end);
foundMsg(msg);
startLastMsg = end;
}
insideRootTag = false;
} else if (ch == '/')
status = XMLLightweightParser.VERIFY_CLOSE_TAG;
} else if (status == XMLLightweightParser.HEAD) {
if (ch == ' ' || ch == '>') {
// Append > to head to allow searching </tag>
head.append(">");
if (ch == '>')
status = XMLLightweightParser.OUTSIDE;
else
status = XMLLightweightParser.INSIDE;
insideRootTag = true;
insideChildrenTag = false;
continue;
} else if (ch == '/' && head.length() > 0) {
status = XMLLightweightParser.VERIFY_CLOSE_TAG;
depth--;
}
head.append(ch);
} else if (status == XMLLightweightParser.INIT) {
if (ch == '<') {
status = XMLLightweightParser.HEAD;
depth = 1;
} else
startLastMsg++;
} else if (status == XMLLightweightParser.OUTSIDE)
if (ch == '<') {
status = XMLLightweightParser.PRETAIL;
cdataOffset = 1;
insideChildrenTag = true;
}
}
if (head.length() > 0 && ("/stream:stream>".equals(head.toString()) || "/flash:stream>".equals(head.toString())))
// Found closing stream:stream
foundMsg("</stream:stream>");
} |
/*
* Main reading method
*/
public void read(final ByteBuffer byteBuffer) throws Exception {
invalidateBuffer();
// Check that the buffer is not bigger than 1 Megabyte. For security reasons
// we will abort parsing when 1 Mega of queued chars was found.
if (buffer.length() > maxBufferSize)
throw new Exception("Stopped parsing never ending stanza");
CharBuffer charBuffer = encoder.decode(byteBuffer);
char[] buf = charBuffer.array();
int readByte = charBuffer.remaining();
// Just return if nothing was read
if (readByte == 0)
return;
// Verify if the last received byte is an incomplete double byte character
char lastChar = buf[readByte - 1];
if (lastChar >= 0xfff0) {
// Rewind the position one place so the last byte stays in the buffer
// The missing byte should arrive in the next iteration. Once we have both
// of bytes we will have the correct character
byteBuffer.position(byteBuffer.position() - 1);
// Decrease the number of bytes read by one
readByte--;
// Just return if nothing was read
if (readByte == 0)
return;
}
buffer.append(buf, 0, readByte);
// Do nothing if the buffer only contains white spaces
if (buffer.charAt(0) <= ' ' && buffer.charAt(buffer.length() - 1) <= ' ')
if ("".equals(buffer.toString().trim())) {
// Empty the buffer so there is no memory leak
buffer.delete(0, buffer.length());
return;
}
// Robot.
char ch;
boolean isHighSurrogate = false;
for (int i = 0; i < readByte; i++) {
ch = buf[i];
if (ch < 0x20 && ch != 0x9 && ch != 0xA && ch != 0xD && ch != 0x0)
// Unicode characters in the range 0x0000-0x001F other than 9, A, and D are not allowed in XML
// We need to allow the NULL character, however, for Flash XMLSocket clients to work.
throw new Exception("Disallowed character");
if (isHighSurrogate) {
if (Character.isLowSurrogate(ch))
// Everything is fine. Clean up traces for surrogates
isHighSurrogate = false;
else
// Trigger error. Found high surrogate not followed by low surrogate
throw new Exception("Found high surrogate not followed by low surrogate");
} else if (Character.isHighSurrogate(ch))
isHighSurrogate = true;
else if (Character.isLowSurrogate(ch))
// Trigger error. Found low surrogate char without a preceding high surrogate
throw new Exception("Found low surrogate char without a preceding high surrogate");
if (status == XMLLightweightParser.TAIL) {
// Looking for the close tag
if (depth < 1 && ch == head.charAt(tailCount)) {
tailCount++;
if (tailCount == head.length()) {
// Close stanza found!
// Calculate the correct start,end position of the message into the buffer
int end = buffer.length() - readByte + i + 1;
String msg = buffer.substring(startLastMsg, end);
// Add message to the list
foundMsg(msg);
startLastMsg = end;
}
} else {
tailCount = 0;
status = XMLLightweightParser.INSIDE;
}
} else if (status == XMLLightweightParser.PRETAIL) {
if (ch == XMLLightweightParser.CDATA_START[cdataOffset]) {
cdataOffset++;
if (cdataOffset == XMLLightweightParser.CDATA_START.length) {
status = XMLLightweightParser.INSIDE_CDATA;
cdataOffset = 0;
continue;
}
} else {
cdataOffset = 0;
status = XMLLightweightParser.INSIDE;
}
if (ch == '/') {
status = XMLLightweightParser.TAIL;
depth--;
} else if (ch == '!')
// This is a <! (comment) so ignore it
status = XMLLightweightParser.INSIDE;
else
depth++;
} else if (status == XMLLightweightParser.VERIFY_CLOSE_TAG) {
if (ch == '>') {
depth--;
status = XMLLightweightParser.OUTSIDE;
if (depth < 1) {
// Found a tag in the form <tag />
int end = buffer.length() - readByte + i + 1;
String msg = buffer.substring(startLastMsg, end);
// Add message to the list
foundMsg(msg);
startLastMsg = end;
}
} else if (ch == '<') {
status = XMLLightweightParser.PRETAIL;
insideChildrenTag = true;
} else
status = XMLLightweightParser.INSIDE;
} else if (status == XMLLightweightParser.INSIDE_PARAM_VALUE) {
if (ch == '"')
status = XMLLightweightParser.INSIDE;
} else if (status == XMLLightweightParser.INSIDE_CDATA) {
if (ch == XMLLightweightParser.CDATA_END[cdataOffset]) {
cdataOffset++;
if (cdataOffset == XMLLightweightParser.CDATA_END.length) {
status = XMLLightweightParser.OUTSIDE;
cdataOffset = 0;
}
} else
cdataOffset = 0;
} else if (status == XMLLightweightParser.INSIDE) {
if (ch == XMLLightweightParser.CDATA_START[cdataOffset]) {
cdataOffset++;
if (cdataOffset == XMLLightweightParser.CDATA_START.length) {
status = XMLLightweightParser.INSIDE_CDATA;
cdataOffset = 0;
continue;
}
} else {
cdataOffset = 0;
status = XMLLightweightParser.INSIDE;
}
if (ch == '"')
status = XMLLightweightParser.INSIDE_PARAM_VALUE;
else if (ch == '>') {
status = XMLLightweightParser.OUTSIDE;
if (insideRootTag
&& ("stream:stream>".equals(head.toString()) || "?xml>".equals(head.toString()) || "flash:stream>".equals(head
.toString()))) {
// Found closing stream:stream
int end = buffer.length() - readByte + i + 1;
// Skip LF, CR and other "weird" characters that could appear
while (startLastMsg < end && '<' != buffer.charAt(startLastMsg))
startLastMsg++;
String msg = buffer.substring(startLastMsg, end);
foundMsg(msg);
startLastMsg = end;
}
insideRootTag = false;
} else if (ch == '/')
status = XMLLightweightParser.VERIFY_CLOSE_TAG;
} else if (status == XMLLightweightParser.HEAD) {
if (ch == ' ' || ch == '>') {
// Append > to head to allow searching </tag>
head.append(">");
if (ch == '>')
status = XMLLightweightParser.OUTSIDE;
else
status = XMLLightweightParser.INSIDE;
insideRootTag = true;
insideChildrenTag = false;
continue;
} else if (ch == '/' && head.length() > 0) {
status = XMLLightweightParser.VERIFY_CLOSE_TAG;
depth--;
}
head.append(ch);
} else if (status == XMLLightweightParser.INIT) {
if (ch == '<') {
status = XMLLightweightParser.HEAD;
depth = 1;
} else
startLastMsg++;
} else if (status == XMLLightweightParser.OUTSIDE)
if (ch == '<') {
status = XMLLightweightParser.PRETAIL;
cdataOffset = 1;
insideChildrenTag = true;
}
}
if (head.length() > 0 && ("/stream:stream>".equals(head.toString()) || "/flash:stream>".equals(head.toString())))
// Found closing stream:stream
foundMsg("</stream:stream>");
}
What does this code actually do?
This method is inside a LightWeightXMLParser. It reads data from a socket channel (java nio) and collects data until data is available on the channel. When a message is complete (fully formed XML), you can retrieve messages by invoking the getMsgs() method and you can invoke areThereMsgs() method to know if at least a message is presents.
86
87
88
89
90
91
92
93
94
95
96
| /*
* @return an array with all messages found
*/
public String[] getMsgs() {
String[] res = new String[msgs.size()];
for (int i = 0; i < res.length; i++)
res[i] = msgs.get(i);
msgs.clear();
invalidateBuffer();
return res;
} |
/*
* @return an array with all messages found
*/
public String[] getMsgs() {
String[] res = new String[msgs.size()];
for (int i = 0; i < res.length; i++)
res[i] = msgs.get(i);
msgs.clear();
invalidateBuffer();
return res;
}
Following Tests might help you understand the code slightly better:
16
17
18
19
20
21
22
23
| @Override
protected void setUp() throws Exception {
super.setUp();
// Create parser
parser = new LightWeightXMLParser(CHARSET);
// Crete byte buffer and append text
in = ByteBuffer.allocate(4096);
} |
@Override
protected void setUp() throws Exception {
super.setUp();
// Create parser
parser = new LightWeightXMLParser(CHARSET);
// Crete byte buffer and append text
in = ByteBuffer.allocate(4096);
}
25
26
27
28
29
30
| @Override
protected void tearDown() throws Exception {
super.tearDown();
// Release byte buffer
in.clear();
} |
@Override
protected void tearDown() throws Exception {
super.tearDown();
// Release byte buffer
in.clear();
}
32
33
34
35
36
37
38
39
40
41
| public void testHeader() throws Exception {
String msg1 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
assertEquals("Wrong stanza was parsed", msg1, parser.getMsgs()[0]);
} |
public void testHeader() throws Exception {
String msg1 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
assertEquals("Wrong stanza was parsed", msg1, parser.getMsgs()[0]);
}
43
44
45
46
47
48
49
50
51
52
53
54
55
56
| public void testHeaderWithXMLVersion() throws Exception {
String msg1 = "<?xml version=\"1.0\"?>";
String msg2 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
in.put((msg1 + msg2).getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 2, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
} |
public void testHeaderWithXMLVersion() throws Exception {
String msg1 = "<?xml version=\"1.0\"?>";
String msg2 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
in.put((msg1 + msg2).getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 2, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
}
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
| public void testStanzas() throws Exception {
String msg1 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg2 = "<starttls xmlns=\"urn:ietf:params:xml:ns:xmpp-tls\"/>";
String msg3 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg4 = "<iq id=\"428qP-0\" to=\"localhost\" type=\"get\"><query xmlns=\"jabber:iq:register\"></query></iq>";
String msg5 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg6 = "<presence id=\"428qP-5\"></presence>";
in.put(msg1.getBytes());
in.put(msg2.getBytes());
in.put(msg3.getBytes());
in.put(msg4.getBytes());
in.put(msg5.getBytes());
in.put(msg6.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 6, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
assertEquals("Wrong stanza was parsed", msg3, values[2]);
assertEquals("Wrong stanza was parsed", msg4, values[3]);
assertEquals("Wrong stanza was parsed", msg5, values[4]);
assertEquals("Wrong stanza was parsed", msg6, values[5]);
} |
public void testStanzas() throws Exception {
String msg1 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg2 = "<starttls xmlns=\"urn:ietf:params:xml:ns:xmpp-tls\"/>";
String msg3 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg4 = "<iq id=\"428qP-0\" to=\"localhost\" type=\"get\"><query xmlns=\"jabber:iq:register\"></query></iq>";
String msg5 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg6 = "<presence id=\"428qP-5\"></presence>";
in.put(msg1.getBytes());
in.put(msg2.getBytes());
in.put(msg3.getBytes());
in.put(msg4.getBytes());
in.put(msg5.getBytes());
in.put(msg6.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 6, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
assertEquals("Wrong stanza was parsed", msg3, values[2]);
assertEquals("Wrong stanza was parsed", msg4, values[3]);
assertEquals("Wrong stanza was parsed", msg5, values[4]);
assertEquals("Wrong stanza was parsed", msg6, values[5]);
}
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
| public void testCompleteStanzas() throws Exception {
String msg1 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg2 = "<starttls xmlns=\"urn:ietf:params:xml:ns:xmpp-tls\"/>";
String msg3 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg4 = "<iq id=\"428qP-0\" to=\"localhost\" type=\"get\"><query xmlns=\"jabber:iq:register\"></query></iq>";
String msg5 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg6 = "<presence id=\"428qP-5\"></presence>";
String msg7 = "</stream:stream>";
in.put(msg1.getBytes());
in.put(msg2.getBytes());
in.put(msg3.getBytes());
in.put(msg4.getBytes());
in.put(msg5.getBytes());
in.put(msg6.getBytes());
in.put(msg7.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 7, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
assertEquals("Wrong stanza was parsed", msg3, values[2]);
assertEquals("Wrong stanza was parsed", msg4, values[3]);
assertEquals("Wrong stanza was parsed", msg5, values[4]);
assertEquals("Wrong stanza was parsed", msg6, values[5]);
assertEquals("Wrong stanza was parsed", msg7, values[6]);
} |
public void testCompleteStanzas() throws Exception {
String msg1 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg2 = "<starttls xmlns=\"urn:ietf:params:xml:ns:xmpp-tls\"/>";
String msg3 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg4 = "<iq id=\"428qP-0\" to=\"localhost\" type=\"get\"><query xmlns=\"jabber:iq:register\"></query></iq>";
String msg5 = "<stream:stream to=\"localhost\" xmlns=\"jabber:client\" xmlns:stream=\"http://etherx.jabber.org/streams\" version=\"1.0\">";
String msg6 = "<presence id=\"428qP-5\"></presence>";
String msg7 = "</stream:stream>";
in.put(msg1.getBytes());
in.put(msg2.getBytes());
in.put(msg3.getBytes());
in.put(msg4.getBytes());
in.put(msg5.getBytes());
in.put(msg6.getBytes());
in.put(msg7.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 7, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
assertEquals("Wrong stanza was parsed", msg3, values[2]);
assertEquals("Wrong stanza was parsed", msg4, values[3]);
assertEquals("Wrong stanza was parsed", msg5, values[4]);
assertEquals("Wrong stanza was parsed", msg6, values[5]);
assertEquals("Wrong stanza was parsed", msg7, values[6]);
}
117
118
119
120
121
122
123
124
125
126
127
| public void testIQ() throws Exception {
String iq = "<iq type=\"set\" to=\"lachesis\" from=\"0sups/Connection Worker - 1\" id=\"360-22348\"><session xmlns=\"http://jabber.org/protocol/connectionmanager\" id=\"0sups87b1694\"><close/></session></iq>";
in.put(iq.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String parsedIQ = parser.getMsgs()[0];
assertEquals("Wrong stanza was parsed", iq, parsedIQ);
} |
public void testIQ() throws Exception {
String iq = "<iq type=\"set\" to=\"lachesis\" from=\"0sups/Connection Worker - 1\" id=\"360-22348\"><session xmlns=\"http://jabber.org/protocol/connectionmanager\" id=\"0sups87b1694\"><close/></session></iq>";
in.put(iq.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String parsedIQ = parser.getMsgs()[0];
assertEquals("Wrong stanza was parsed", iq, parsedIQ);
}
129
130
131
132
133
134
135
136
137
138
139
140
| public void testNestedElements() throws Exception {
String msg1 = "<message><message xmlns=\"e\">1</message></message>";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 1, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
} |
public void testNestedElements() throws Exception {
String msg1 = "<message><message xmlns=\"e\">1</message></message>";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 1, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
}
142
143
144
145
146
147
148
149
150
| public void testIncompleteStanza() throws Exception {
String msg1 = "<message><something xmlns=\"http://idetalk.com/namespace\">12";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertFalse("Found messages in incomplete stanza", parser.areThereMsgs());
} |
public void testIncompleteStanza() throws Exception {
String msg1 = "<message><something xmlns=\"http://idetalk.com/namespace\">12";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertFalse("Found messages in incomplete stanza", parser.areThereMsgs());
}
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
| public void testStanzaWithSpecialChars() throws Exception {
String msg1 = "<message><something xmlns=\"http://idetalk.com/namespace\">12/</something></message>";
String msg2 = "<message><something xmlns=\"http://idetalk.com/namespace\">12///</something></message>";
String msg3 = "<message><something xmlns=\"http://idetalk.com/namespace\">12/\\/</something></message>";
String msg4 = "<message><something xmlns=\"http://idetalk.com/namespace\">http://idetalk.com/namespace/</something></message>";
in.put(msg1.getBytes());
in.put(msg2.getBytes());
in.put(msg3.getBytes());
in.put(msg4.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("No messages were found in stanza", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 4, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
assertEquals("Wrong stanza was parsed", msg3, values[2]);
assertEquals("Wrong stanza was parsed", msg4, values[3]);
} |
public void testStanzaWithSpecialChars() throws Exception {
String msg1 = "<message><something xmlns=\"http://idetalk.com/namespace\">12/</something></message>";
String msg2 = "<message><something xmlns=\"http://idetalk.com/namespace\">12///</something></message>";
String msg3 = "<message><something xmlns=\"http://idetalk.com/namespace\">12/\\/</something></message>";
String msg4 = "<message><something xmlns=\"http://idetalk.com/namespace\">http://idetalk.com/namespace/</something></message>";
in.put(msg1.getBytes());
in.put(msg2.getBytes());
in.put(msg3.getBytes());
in.put(msg4.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("No messages were found in stanza", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 4, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
assertEquals("Wrong stanza was parsed", msg2, values[1]);
assertEquals("Wrong stanza was parsed", msg3, values[2]);
assertEquals("Wrong stanza was parsed", msg4, values[3]);
}
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
| public void testCompletedStanza() throws Exception {
String msg1 = "<message><something xmlns=\"http://idetalk.com/namespace\">12";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertFalse("Found messages in incomplete stanza", parser.areThereMsgs());
String msg2 = "</something></message>";
ByteBuffer in2 = ByteBuffer.allocate(4096);
in2.put(msg2.getBytes());
in2.flip();
// Fill parser with byte buffer content and parse it
parser.read(in2);
in2.clear();
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 1, values.length);
assertEquals("Wrong stanza was parsed", msg1 + msg2, values[0]);
} |
public void testCompletedStanza() throws Exception {
String msg1 = "<message><something xmlns=\"http://idetalk.com/namespace\">12";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertFalse("Found messages in incomplete stanza", parser.areThereMsgs());
String msg2 = "</something></message>";
ByteBuffer in2 = ByteBuffer.allocate(4096);
in2.put(msg2.getBytes());
in2.flip();
// Fill parser with byte buffer content and parse it
parser.read(in2);
in2.clear();
assertTrue("Stream header is not being correctly parsed", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 1, values.length);
assertEquals("Wrong stanza was parsed", msg1 + msg2, values[0]);
}
196
197
198
199
200
201
202
203
204
205
206
207
| public void testStanzaWithComments() throws Exception {
String msg1 = "<iq from=\"[email protected]/spark\"><query xmlns=\"jabber:iq:privacy\"><!-- silly comment --></query></iq>";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("No messages were found in stanza", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 1, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
} |
public void testStanzaWithComments() throws Exception {
String msg1 = "<iq from=\"[email protected]/spark\"><query xmlns=\"jabber:iq:privacy\"><!-- silly comment --></query></iq>";
in.put(msg1.getBytes());
in.flip();
// Fill parser with byte buffer content and parse it
parser.read(in);
// Make verifications
assertTrue("No messages were found in stanza", parser.areThereMsgs());
String[] values = parser.getMsgs();
assertEquals("Wrong number of parsed stanzas", 1, values.length);
assertEquals("Wrong stanza was parsed", msg1, values[0]);
}
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
| public void testWeirdoContent() throws Exception {
final String[] testStanzas = { "<?xml version=\"1.0\"?>",
"<stream:stream xmlns:stream=\"http://etherx.jabber.org/streams\" xmlns=\"jabber:client\" to=\"localhost\" >",
"<emppartag test=\"1\"/>", "<cdatatest><![CDATA[just<ignore everything& >>here<<<<< /> />]]>]]></cdatatest>",
"<esctest param=\"1\"> this \" is / a test /> test /> </esctest>",
"<comtest>this <!-- comment --> is a comment</comtest>", "<emptag/>",
"<iq type=\"get\" id=\"aab1a\" ><query xmlns=\"jabber:iq:roster\"/> <tag> text </tag></iq>",
"<iq type=\"get\" id=\"aab1a\" ><query xmlns=\"jabber:iq:roster\"/> </iq>",
"<message><body xmlns=\"http://idetalk.com/namespace\">12\"</body></message>",
"<message to=\"[email protected]\" id=\"XRk8p-X\"><body> /> /> </body></message>", };
String testMsg = "";
for (String s : testStanzas)
testMsg += s;
ByteBuffer mybuffer = ByteBuffer.wrap(testMsg.getBytes());
parser.read(mybuffer);
String[] msgs = parser.getMsgs();
for (int i = 0; i < testStanzas.length; i++) {
assertTrue(i < msgs.length);
assertEquals(testStanzas[i], msgs[i]);
}
} |
public void testWeirdoContent() throws Exception {
final String[] testStanzas = { "<?xml version=\"1.0\"?>",
"<stream:stream xmlns:stream=\"http://etherx.jabber.org/streams\" xmlns=\"jabber:client\" to=\"localhost\" >",
"<emppartag test=\"1\"/>", "<cdatatest><![CDATA[just<ignore everything& >>here<<<<< /> />]]>]]></cdatatest>",
"<esctest param=\"1\"> this \" is / a test /> test /> </esctest>",
"<comtest>this <!-- comment --> is a comment</comtest>", "<emptag/>",
"<iq type=\"get\" id=\"aab1a\" ><query xmlns=\"jabber:iq:roster\"/> <tag> text </tag></iq>",
"<iq type=\"get\" id=\"aab1a\" ><query xmlns=\"jabber:iq:roster\"/> </iq>",
"<message><body xmlns=\"http://idetalk.com/namespace\">12\"</body></message>",
"<message to=\"[email protected]\" id=\"XRk8p-X\"><body> /> /> </body></message>", };
String testMsg = "";
for (String s : testStanzas)
testMsg += s;
ByteBuffer mybuffer = ByteBuffer.wrap(testMsg.getBytes());
parser.read(mybuffer);
String[] msgs = parser.getMsgs();
for (int i = 0; i < testStanzas.length; i++) {
assertTrue(i < msgs.length);
assertEquals(testStanzas[i], msgs[i]);
}
}
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
| public void testRead() {
try {
LightWeightXMLParser parser = new LightWeightXMLParser("UTF-8");
String xml1 = "<ab>\u1000</a";
String xml2 = "b>";
ByteBuffer buffer1 = ByteBuffer.wrap(xml1.getBytes("UTF-8"));
ByteBuffer buffer2 = ByteBuffer.wrap(xml2.getBytes("UTF-8"));
parser.read(buffer1);
parser.read(buffer2);
if (!parser.areThereMsgs())
Assert.fail("No messages found");
String msgs[] = parser.getMsgs();
if (msgs.length > 1)
Assert.fail("More than one message found");
else
Assert.assertEquals(xml1 + xml2, msgs[0]);
} catch (Exception e) {
Assert.fail(e.getMessage());
}
} |
public void testRead() {
try {
LightWeightXMLParser parser = new LightWeightXMLParser("UTF-8");
String xml1 = "<ab>\u1000</a";
String xml2 = "b>";
ByteBuffer buffer1 = ByteBuffer.wrap(xml1.getBytes("UTF-8"));
ByteBuffer buffer2 = ByteBuffer.wrap(xml2.getBytes("UTF-8"));
parser.read(buffer1);
parser.read(buffer2);
if (!parser.areThereMsgs())
Assert.fail("No messages found");
String msgs[] = parser.getMsgs();
if (msgs.length > 1)
Assert.fail("More than one message found");
else
Assert.assertEquals(xml1 + xml2, msgs[0]);
} catch (Exception e) {
Assert.fail(e.getMessage());
}
}
Feel free to download the full project source code.
Posted in Design, Programming, Testing | No Comments »
Sunday, September 27th, 2009
Topic |
Before |
After |
Project Size |
Production Code
- Package =4
- Classes =30
- Methods = 90 (average 3/class)
- LOC = 480 (average 5.33/method and 16/class)
- Average Cyclomatic Complexity/Method = 1.89
Test Code
- Package =3
- Classes = 19
- Methods = 106
- LOC = 1379
|
Production Code
- Package = 2
- Classes =7
- Methods = 24 (average 3.43/class)
- LOC = 168 (average 6.42/method and 18.56/class)
- Average Cyclomatic Complexity/Method = 1.83
Test Code
- Package = 1
- Classes = 4
- Methods = 53
- LOC =243
|
Code Coverage |
- Line Coverage: 88%
- Block Coverage: 89%
|
- Line Coverage: 95%
- Block Coverage: 94%
|
Cyclomatic Complexity |
|
|
Coding Convention Violation |
85 |
0 |
Posted in Design, Programming, Testing | No Comments »
Tuesday, August 11th, 2009
I’ve become a big fan of displaying metric using Treemaps. Julias Shaw‘s Panpoticode is a great tool to produce useful design metric in the treemap format for your Java project.
In the past, I’ve used these graphs to show Before and After snapshots of various projects after a small refactoring effort. In this blog I want to show you a healthy project’s codebase and highlight somethings that makes me feel comfortable about the codebase. (Actually there is not much to talk, a picture is worth a thousand words.)
Following is the code coverage report from a project:
Couple of quick observations:
- Majority of the code has coverage over 75% (Our goal is not to have every single class with 100% code coverage. Code Coverage does not talk about Quality of your tests.)
- There is a decent distribution of code across packages, classes and methods. (No large boxes standing out.)
- You don’t see large black patches (ones you see are classes that were mocked out for testing).
Lets look at the complexity graph:
- Except for a couple of methods, most of them have Cyclomatic Complexity under 5.
- You don’t see large red or black boxes which are clear indicators of complex code.
Panopticode combined with CheckStyle, FindBugs and JDepends can give you a lot more info to check the real pulse of your codebase.
Posted in Agile, Design, Metrics, Programming, Testing, Tools | 2 Comments »
|