Extreme Programming with Ant: Building and Deploying Java Applications with JSP, EJB, XSLT, XDoclet, and JUnit (Developers Library)

457 Pages·2003·2.08 MB·English

by  Glenn Niemeyer

00 5624 FM 9/9/03 1:53 PM Page i
Glenn Niemeyer
Jeremy Poteet
Extreme Programming
with Ant
Building and Deploying Java™
Applications with JSP™, EJB™, XSLT,
xDoclet, and JUnit
800 East 96th Street, Indianapolis, Indiana 46240
00 5624 FM 9/9/03 1:53 PM Page ii
Extreme Programming with Ant Associate Publisher
Michael Stephens
Building and Deploying Java™ Applications
with JSP™, EJB™, XSLT, xDoclet, and JUnit Acquisitions Editor
Copyright2003 by Sams Publishing Todd Green
All rights reserved. No part of this book shall be reproduced, stored Development Editor
in a retrieval system, or transmitted by any means, electronic, Sean Dixon
mechanical, photocopying, recording, or otherwise, without
written permission from the publisher. No patent liability is Managing Editor
assumed with respect to the use of the information contained Charlotte Clapp
herein. Although every precaution has been taken in the prepara-
Project Editor
tion of this book, the publisher and author assume no responsibil-
Andy Beaster
ity for errors or omissions. Nor is any liability assumed for damages
resulting from the use of the information contained herein. Copy Editor
Margaret Berson
International Standard Book Number: 0-672-32562-4
Library of Congress Catalog Card Number: 2003102955 Indexer
Johnna Dinse
Printed in the United States of America
Proofreader
First Printing: June 2003
Kay Hoskin
05 04 03 4 3 2
Technical Editors
Ed Goodwin
Trademarks
Jeff Linwood
All terms mentioned in this book that are known to be trademarks
Team Coordinator
or service marks have been appropriately capitalized. Sams
Cindy Teeters
Publishing cannot attest to the accuracy of this information. Use of
a term in this book should not be regarded as affecting the validity
Interior Designer
of any trademark or service mark.
Gary Adair
Warning and Disclaimer Cover Designer
Aren Howell
Every effort has been made to make this book as complete and as
accurate as possible, but no warranty or fitness is implied. The Page Layout
information provided is on an “as is” basis. The author and the Stacey DeRome
publisher shall have neither liability nor responsibility to any Michelle Mitchell
person or entity with respect to any loss or damages arising from
the information contained in this book.
00 5624 FM 4/28/03 10:33 AM Page iii
Contents at a Glance
Introduction.................................................................................1
1 XP and Ant...................................................................................5
2 Creating Initial Spikes...................................................................21
3 The First Iteration........................................................................53
4 The First Complete Build Process....................................................99
5 Creating the Automated Nightly Build...........................................117
6 Deployment to a Test Environment...............................................145
7 The Team Size Increases...............................................................193
8 Deployment to a Production Environment.....................................231
9 Company Reorganized—Working with a New Subteam.....................259
10 Additional Teams Adopt the XP Process..........................................289
11 Creating an Enterprise-wide Solution.............................................329
Appendices
A Installing Ant............................................................................359
B Extending Ant...........................................................................367
C Ant 2........................................................................................395
D Complete Buildfile Listings..........................................................399
E Tool Version..............................................................................429
Index.......................................................................................431
00 5624 FM 4/28/03 10:33 AM Page iv
Table of Contents
Introduction 1
1 XP and Ant 5
What Is XP? .................................................................................5
Characteristics of XP ..............................................................5
The Core Values in XP ...........................................................6
Increased Productivity ............................................................8
The XP Process .............................................................................8
Iterations ...........................................................................10
The Need for Speed ..............................................................11
Sharing the Knowledge .........................................................11
Ant and the XP Process ................................................................12
Why Choose Ant? ...............................................................13
Build Alternatives ................................................................15
Custom and Proprietary Solutions ..........................................16
Integrated Development Environments (IDEs) ..........................17
Summary ...................................................................................17
The Scope of This Book ................................................................18
2 Creating Initial Spikes 21
Introduction to Ant .....................................................................22
Elements of a Buildfile .................................................................23
Projects ..............................................................................24
Targets ...............................................................................25
Tasks .................................................................................26
Ant Command-Line Options .........................................................28
Using an Ant Initialization File ..............................................30
A Basic Project-Management Buildfile .............................................31
Using Properties ..........................................................................33
Target Dependencies ....................................................................39
Directory-Based Tasks ...................................................................40
Patterns, Filesets, and Dirsets .................................................41
Adding the backupAdvancedTarget .................................................43
Entering a User ID/Password at Runtime .................................45
Summary ...................................................................................51
00 5624 FM 4/28/03 10:33 AM Page v
Contents v
3 The First Iteration 53
Benefits of Automated Testing .......................................................54
Benefits of Integrating Testing into Ant ...........................................56
Types of Automated Testing ..........................................................57
What Is Unit Testing? ..................................................................58
Test First Design ..........................................................................58
JUnit .........................................................................................59
Sample Class .......................................................................59
Sample Unit Test .................................................................61
Command-Line Unit Testing .................................................67
Simple JUnit Target ..............................................................68
Formatter ...........................................................................76
AlternativeTestRunners .......................................................81
Forking Unit Tests ...............................................................83
Version-Control Systems ...............................................................84
CVS Access and Logins .................................................................84
CVS Login ..........................................................................84
A Custom Task to Check for Required Input Parameters .............86
CVS Initialization ................................................................90
The CVS Task ......................................................................91
Basic Deployment .......................................................................95
Summary ...................................................................................97
4 The First Complete Build Process 99
Generating Documentation ..........................................................99
Generating Javadoc ..............................................................99
Use of Doclets ...................................................................104
batchtest ................................................................................105
Advanced JUnit Target ................................................................106
Tagging Source Code with CVS .............................................109
CleanImports ............................................................................111
Summary .................................................................................115
5 Creating the Automated Nightly Build 117
Loggers and Listeners .................................................................119
DefaultLogger ..................................................................119
NoBannerLogger .................................................................120
MailLogger .......................................................................121
00 5624 FM 4/28/03 10:33 AM Page vi
vi Extreme Programming with Ant
AnsiColorLogger ...............................................................122
XmlLogger.........................................................................122
Log4jListener ..................................................................124
Filemappers ..............................................................................126
Identity ............................................................................127
Flatten .............................................................................127
Merge ..............................................................................128
Glob ................................................................................128
Regexp ............................................................................128
Package ............................................................................129
Filtersets ..................................................................................130
Path-like Structures ....................................................................131
Nightly Build JUnit Target ...........................................................133
JUnitReport .............................................................................135
Format .............................................................................136
XSLT Files .........................................................................136
Reports on Sets of Tests ...............................................................138
CruiseControl ...........................................................................140
Summary .................................................................................144
6 Deployment to a Test Environment 145
Working with JAR Files ...............................................................146
Thefilesonly Attribute .....................................................151
Using Nested Filesets ..........................................................152
Signed JAR Files .................................................................156
Expanding a JAR File with <unjar> .......................................157
Deploying Applications as WAR Files ............................................158
Deployment with XDoclet ..........................................................162
Generating a Web Deployment Descriptor with XDoclet ..........163
Generating EJB Deployment Descriptors and Classes
with XDoclet ..................................................................170
Taglib Deployment with XDoclet ..........................................185
Creating an EAR File with the <ear>Task ......................................191
Summary .................................................................................192
7 The Team Size Increases 193
Why Have Coding Standards? ......................................................193
Enforcing Coding Standards ........................................................194
Jalopy ......................................................................................195
00 5624 FM 4/28/03 10:33 AM Page vii
Contents vii
PMD........................................................................................206
Checkstyle................................................................................211
iContract .................................................................................217
JDepend ...................................................................................221
Summary .................................................................................230
8 Deployment to a Production Environment 231
CVS Reporting ..........................................................................231
CVS Comments Report .......................................................232
Weekly CVS Report ............................................................234
Release CVS Report ............................................................236
Creating Technical Release Notes from CVS Comments ....................237
CVS Tag Report .................................................................238
Advanced Version Control Techniques for Ant ...............................240
Performing a Distributed Deployment with Remote Ant ...................241
Deploying Information to Databases .............................................246
Using the Ant SQL Task ......................................................247
Integrating Oracle SQL*Loader with Ant ................................249
Summary .................................................................................258
9 Company Reorganized—Working with a New Subteam 259
NetBeans IDE and Ant ................................................................259
Styler .......................................................................................261
Using the <tempfile>and<purge>Tasks .......................................265
AntEater...................................................................................267
Groups .............................................................................273
Session .............................................................................274
Creating Conditional Logic .................................................274
Custom Task for Detection of Missing Unit Tests .............................275
Code Coverage Tools for Use with JUnit ................................282
Ant’s Bean Scripting Framework Capability ....................................283
Mail Task ..........................................................................286
Summary .................................................................................287
10 Additional Teams Adopt the XP Process 289
Creating a Project-Level Buildfile ..................................................290
Using Jikes for Dependency Checking ...........................................294
Writing a Custom Task for NoUnit ...............................................297
00 5624 FM 4/28/03 10:33 AM Page viii
viii Extreme Programming with Ant
Increasing the Efficiency of Code Generation .................................306
Developing the smartCopy Target .........................................308
Creating Unique Build Numbers ..................................................317
Obfuscating JAR Files .................................................................319
Summary .................................................................................328
11 Creating an Enterprise-wide Solution 329
Encrypting the Output of a Build .................................................331
Incorporating JUnit into the Build Process .....................................336
Adding Targets to Control a WebLogic Server .................................340
Internationalization ...................................................................342
Generating UML Diagrams ..........................................................348
Summary .................................................................................357
Appendices
A Installing Ant 359
Choosing the Correct Edition of Ant .............................................359
Obtaining Ant ...........................................................................360
Binary ..............................................................................361
Source ..............................................................................361
CVS .................................................................................361
Building Ant .............................................................................361
Full Build .........................................................................362
Lightweight Build ..............................................................363
Installing Ant ............................................................................363
Debugging Your Installation ........................................................364
B Extending Ant 367
Custom Tasks ............................................................................367
Theexecute()Method .......................................................370
Using the Logging System ...................................................370
Configuring a Task for Use in a Buildfile ................................371
Classes for Extension ..........................................................372
Lifecycle of a Task ..............................................................372
Custom Listeners ......................................................................375
Custom Loggers ........................................................................377
Some Principles for Developing Custom Tasks, Loggers,
and Listeners ..........................................................................378
00 5624 FM 9/9/03 1:53 PM Page ix
Contents ix
Input Handlers ..........................................................................379
Selectors...................................................................................380
Filters ......................................................................................383
Mappers ...................................................................................387
Data Types ...............................................................................388
Summary .................................................................................392
C The Future of Ant 395
D Complete Buildfile Listings 399
eMarket Team Buildfile ...............................................................399
iNet Team Buildfile ....................................................................400
eSupplier Team Buildfile .............................................................404
Sales Department Buildfile ..........................................................405
Network Department Buildfile .....................................................408
NetworksByteDesign Common Buildfile ........................................408
E Tool Version 429
Development and Testing Platforms ..............................................429
Tool Versions ............................................................................429
Index 431