Ant in Action

Ant in Action, 2nd Edition......Page 1
contents......Page 10
preface to the second edition......Page 20
foreword to the first edition......Page 22
preface to the first edition......Page 24
acknowledgments......Page 26
about this book......Page 28
about the authors......Page 32
about the cover illustration......Page 33
Welcome to Ant in Action......Page 34
Part 1 - Learning Ant......Page 36
1.1 What is Ant?......Page 38
1.1.1 The core concepts of Ant......Page 39
1.1.2 Ant in action: an example project......Page 41
1.2 What makes Ant so special?......Page 44
1.3 When to use Ant......Page 45
1.5.1 IDEs......Page 46
1.5.2 Make......Page 47
1.6 The ongoing evolution of Ant......Page 49
1.7 Summary......Page 50
2.1 Defining our first project......Page 52
2.3 Step one: verifying the tools are in place......Page 53
2.4.1 Examining the build file......Page 54
2.5.1 If the build fails......Page 56
2.5.2 Looking at the build in more detail......Page 58
2.6 Step four: imposing structure......Page 60
2.6.1 Laying out the source directories......Page 61
2.6.3 Laying out the distribution directories......Page 62
2.6.4 Creating the build file......Page 64
2.6.5 Target dependencies......Page 65
2.6.6 Running the new build file......Page 66
2.6.7 Incremental builds......Page 67
2.6.8 Running multiple targets on the command line......Page 68
2.7.1 Why execute from inside Ant?......Page 69
2.7.2 Adding an "execute" target......Page 70
2.7.3 Running the new target......Page 71
2.8 Ant command-line options......Page 72
2.8.1 Specifying which build file to run......Page 73
2.8.2 Controlling the amount of information provided......Page 74
2.8.4 Getting information about a project......Page 75
2.9 Examining the final build file......Page 76
2.10 Running the build under an IDE......Page 77
2.11 Summary......Page 78
Understanding Ant datatypes and properties......Page 80
3.1.2 Property overview......Page 81
3.2 Introducing datatypes and properties with ......Page 82
3.3 Paths......Page 85
3.4 Filesets......Page 86
3.4.1 Patternsets......Page 87
3.5 Selectors......Page 91
3.6 Additional Ant datatypes......Page 92
3.7 Properties......Page 94
3.7.1 Setting properties with the  task......Page 95
3.7.2 Checking for the availability of files: ......Page 99
3.7.3 Testing conditions with ......Page 100
3.7.4 Creating a build timestamp with ......Page 102
3.8 Controlling Ant with properties......Page 103
3.8.1 Conditional target execution......Page 104
3.8.3 Conditional patternset inclusion/exclusion......Page 105
3.9.1 Viewing datatypes......Page 106
3.10 Managing library dependencies......Page 108
3.12 Best practices......Page 109
3.13 Summary......Page 110
Testing with JUnit......Page 112
4.1 What is testing, and why do it?......Page 113
4.2.1 The application: a diary......Page 114
4.3 How to test a program......Page 116
4.4 Introducing JUnit......Page 117
4.4.2 Running a test case......Page 119
4.4.3 Asserting desired results......Page 120
4.4.4 Adding JUnit to Ant......Page 123
4.4.5 Writing the code......Page 125
4.5 The JUnit task: ......Page 126
4.5.1 Fitting JUnit into the build process......Page 127
4.5.3 Viewing test results......Page 129
4.5.4 Running multiple tests with ......Page 131
4.6 Generating HTML test reports......Page 132
4.6.1 Halting the builds after generating reports......Page 134
4.7 Advanced  techniques......Page 135
4.8 Best practices......Page 139
4.8.1 The future of JUnit......Page 140
4.9 Summary......Page 141
Packaging projects......Page 143
5.1 Working with files......Page 144
5.1.1 Deleting files......Page 145
5.1.2 Copying files......Page 146
5.2 Introducing mappers......Page 147
5.3 Modifying files as you go......Page 152
5.4 Preparing to package......Page 153
5.4.1 Adding data files to the classpath......Page 154
5.4.2 Generating documentation......Page 155
5.4.3 Patching line endings for target platforms......Page 157
5.5 Creating JAR files......Page 159
5.5.1 Testing the JAR file......Page 161
5.5.2 Creating JAR manifests......Page 162
5.5.3 Adding extra metadata to the JAR......Page 164
5.5.5 Signing JAR files......Page 165
5.6 Testing with JAR files......Page 168
5.7 Creating Zip files......Page 169
5.7.1 Creating a binary Zip distribution......Page 170
5.7.2 Creating a source distribution......Page 171
5.8.1 Tar files......Page 172
5.9.1 A formal definition of a resource......Page 176
5.9.2 What resources are there?......Page 177
5.9.3 Resource collections......Page 178
5.10 Summary......Page 180
6.1 Running programs under Ant- an introduction......Page 182
6.1.1 Introducing the  task......Page 184
6.1.2 Setting the classpath......Page 185
6.1.3 Arguments......Page 186
6.1.4 Defining system properties......Page 188
6.1.5 Running the program in a new JVM......Page 189
6.1.6 JVM tuning......Page 190
6.1.7 Handling errors......Page 191
6.1.8 Executing JAR files......Page 193
6.2 Running native programs......Page 194
6.2.2 Executing shell commands......Page 195
6.2.3 Running under different Operating Systems......Page 196
6.2.4 Probing for a program......Page 199
6.3.1 Setting environment variables......Page 200
6.3.2 Handling timeouts......Page 201
6.3.3 Running a program in the background......Page 202
6.3.4 Input and output......Page 203
6.3.5 Piped I/O with an I/O redirector......Page 204
6.3.6 FilterChains and FilterReaders......Page 205
6.4 Bulk operations with ......Page 207
6.5.1 ......Page 209
6.6 Best practices......Page 210
6.7 Summary......Page 211
Distributing our application......Page 212
7.1 Preparing for distribution......Page 213
7.1.1 Securing our distribution......Page 214
7.2 FTP-based distribution of a packaged application......Page 216
7.2.1 Uploading to Unix......Page 217
7.2.2 Uploading to a Windows FTP server......Page 218
7.2.3 Uploading to SourceForge......Page 219
7.2.4 FTP dependency logic......Page 220
7.3 Email-based distribution of a packaged application......Page 221
7.3.1 Sending HTML messages......Page 224
7.4 Secure distribution with SSH and SCP......Page 225
7.4.1 Uploading files with SCP......Page 226
7.4.2 Downloading files with ......Page 228
7.4.4 Troubleshooting the SSH tasks......Page 230
7.5 HTTP download......Page 231
7.5.1 How to probe for a server or web page......Page 232
7.5.2 Fetching remote files with ......Page 233
7.5.3 Performing the download......Page 234
7.6.1 Calling targets with ......Page 236
7.6.2 Distributing with ......Page 239
7.7 Summary......Page 241
8.1 How to write good build files......Page 242
8.2.1 Starting the project......Page 243
8.2.2 The public entry points......Page 244
8.2.3 Setting up the build......Page 245
8.2.4 Compiling and testing......Page 249
8.2.5 Packaging and creating a distribution......Page 251
8.2.6 Distribution......Page 255
8.3 Adopting Ant......Page 258
8.4 Building an existing project under Ant......Page 261
8.5 Summary......Page 263
Part 2 - Applying Ant......Page 264
Beyond Ant’s core tasks......Page 266
9.1 The many different categories of Ant tasks......Page 267
9.2 Installing optional tasks......Page 269
9.2.1 Troubleshooting......Page 271
9.3.1 Manipulating property files......Page 272
9.3.2 Improving  with dependency checking......Page 274
9.4 Software configuration management under Ant......Page 276
9.5 Using third-party tasks......Page 278
9.5.1 Defining tasks with ......Page 279
9.5.2 Declaring tasks defined in property files......Page 280
9.5.3 Defining tasks into a unique namespace......Page 281
9.5.4 Defining tasks from an Antlib......Page 282
9.6 The Ant-contrib tasks......Page 283
9.6.1 The Ant-contrib tasks in action......Page 286
9.7 Code auditing with Checkstyle......Page 292
9.8 Summary......Page 296
Working with big projects......Page 297
10.1 Master builds: managing large projects......Page 298
10.1.1 Introducing the  task......Page 299
10.1.2 Designing a scalable, flexible master build file......Page 301
10.2.1 Setting properties in child projects......Page 303
10.2.2 Passing down properties and references in ......Page 305
10.3 Advanced delegation......Page 308
10.3.1 Getting data back......Page 309
10.4.1 XML entity inclusion......Page 310
10.4.2 Importing build files with ......Page 311
10.4.3 How Ant overrides targets......Page 312
10.4.4 Calling overridden targets......Page 313
10.4.5 The special properties of ......Page 314
10.5.1 Extending an existing build file......Page 316
10.5.2 Creating a base build file for many projects......Page 317
10.5.3 Mixin build files......Page 319
10.5.4 Best practices with ......Page 320
10.6.1 Redefining tasks with ......Page 321
10.6.2 The hazards of ......Page 323
10.7 Writing macros with ......Page 324
10.7.1 Passing data to a macro......Page 325
10.7.2 Local variables......Page 327
10.7.3 Effective macro use......Page 328
10.8 Summary......Page 329
Managing dependencies......Page 330
11.1.1 The core concepts of Ivy......Page 332
11.2 Installing Ivy......Page 334
11.2.1 Configuring Ivy......Page 335
11.3 Resolving, reporting, and retrieving......Page 337
11.3.1 Creating a dependency report......Page 338
11.3.2 Retrieving artifacts......Page 339
11.3.3 Setting up the classpaths with Ivy......Page 340
11.4.1 Sharing artifacts between projects......Page 341
11.4.2 Using published artifacts in other projects......Page 343
11.4.3 Using Ivy to choreograph builds......Page 346
11.5.1 Managing file versions through Ivy variables......Page 348
11.5.2 Finding artifacts on the central repository......Page 349
11.5.4 Private repositories......Page 350
11.6 Summary......Page 351
Developing for the Web......Page 353
12.1 Developing a web application......Page 354
12.1.1 Writing a feed servlet......Page 356
12.1.2 Libraries in web applications......Page 357
12.1.3 Writing web pages......Page 358
12.1.4 Creating a web.xml file......Page 360
12.2 Building the WAR file......Page 361
12.3 Deployment......Page 362
12.3.1 Deployment by copy......Page 363
12.4.1 Probing for server availability......Page 364
12.5 Testing web applications with HttpUnit......Page 366
12.5.1 Writing HttpUnit tests......Page 367
12.5.2 Compiling the HttpUnit tests......Page 370
12.5.3 Running the HttpUnit tests......Page 371
12.6 Summary......Page 372
Working with XML......Page 373
13.2 Writing XML......Page 374
13.3 Validating XML......Page 376
13.3.1 Validating documents using DTD files......Page 378
13.3.2 Validating documents with XML Schema......Page 380
13.3.3 Validating RelaxNG documents......Page 382
13.4 Reading XML data......Page 385
13.5 Transforming XML with XSLT......Page 386
13.5.1 Defining the structure of the constants file......Page 387
13.5.3 Creating XSL style sheets......Page 388
13.5.4 Initializing the build file......Page 391
13.6 Summary......Page 395
Enterprise Java......Page 396
14.1 Evolving the diary application......Page 397
14.2 Making an Enterprise application......Page 398
14.3 Creating the beans......Page 399
14.3.1 Compiling Java EE-annotated classes......Page 401
14.3.2 Adding a session bean......Page 402
14.4 Extending the web application......Page 404
14.5 Building the Enterprise application......Page 406
14.7 Server-side testing with Apache Cactus......Page 411
14.7.1 Writing a Cactus test......Page 412
14.7.2 Building Cactus tests......Page 413
14.7.3 The Cactus Ant tasks......Page 414
14.7.4 Adding Cactus to an EAR file......Page 415
14.7.5 Running Cactus tests......Page 416
14.7.6 Diagnosing EJB deployment problems......Page 417
14.8 Summary......Page 418
Continuous integration......Page 420
15.1 Introducing continuous integration......Page 421
15.1.1 What do you need for continuous integration?......Page 423
15.2 Luntbuild......Page 424
15.2.2 Running Luntbuild......Page 426
15.2.3 Configuring Luntbuild......Page 427
15.2.4 Luntbuild in action......Page 433
15.2.5 Review of Luntbuild......Page 434
15.3 Moving to continuous integration......Page 435
15.4 Summary......Page 437
Deployment......Page 439
16.1 How to survive deployment......Page 440
16.2 Deploying with Ant......Page 443
16.3 Database setup in Ant......Page 444
16.3.1 Creating and configuring a database from Ant......Page 445
16.3.2 Issuing database administration commands......Page 446
16.4.1 SmartFrog: a new way of thinking about deployment......Page 448
16.4.2 The concepts in more detail......Page 450
16.4.3 The SmartFrog components......Page 458
16.5 Using SmartFrog with Ant......Page 459
16.5.1 Deploying with SmartFrog......Page 461
16.5.2 Deploying with the  task......Page 466
16.5.3 Summary of SmartFrog......Page 468
16.6 Embracing deployment......Page 469
16.7 Summary......Page 471
Part 3 - Extending Ant......Page 474
Writing Ant tasks......Page 476
17.1 What exactly is an Ant task?......Page 477
17.1.1 The life of a task......Page 478
17.2 Introducing Ant’s Java API......Page 479
17.2.1 Ant’s utility classes......Page 484
17.3.1 Writing the task......Page 486
17.3.2 How Ant configures tasks......Page 488
17.3.3 Configuring the  task......Page 490
17.4.1 Using AntUnit......Page 491
17.4.2 Testing the  task......Page 493
17.4.3 Running the tests......Page 494
17.5.1 Enumerations......Page 496
17.6 Supporting nested elements......Page 498
17.7 Working with resources......Page 500
17.7.1 Using a resource-enabled task......Page 503
17.8 Delegating to other tasks......Page 504
17.8.1 Setting up classpaths in a task......Page 505
17.9 Other task techniques......Page 509
17.10 Making an Antlib library......Page 511
17.11 Summary......Page 514
Extending Ant further......Page 516
18.1 Scripting within Ant......Page 517
18.1.1 Writing new tasks with ......Page 519
18.1.2 Scripting summary......Page 522
18.2 Conditions......Page 523
18.2.1 Writing a conditional task......Page 525
18.3 Writing a custom resource......Page 526
18.3.2 How Ant datatypes handle references......Page 529
18.4 Selectors......Page 530
18.5 Developing a custom mapper......Page 532
18.6 Implementing a custom filter......Page 534
18.7 Handling Ant’s input and output......Page 536
18.7.1 Writing a custom listener......Page 538
18.7.2 Writing a custom logger......Page 542
18.7.3 Using loggers and listeners......Page 544
18.8 Embedding Ant......Page 545
18.9 Summary......Page 547
Before you begin......Page 549
Setting up Ant on Windows......Page 550
Setting up Ant on Unix......Page 551
Troubleshooting installation......Page 553
XML Primer......Page 558
XML namespaces......Page 562
How IDEs use Ant......Page 564
Eclipse http://www.eclipse.org/......Page 566
Sun NetBeans http://www.netbeans.org/......Page 572
IntelliJ IDEA http://intellij.com/......Page 576
Building with Ant and an IDE......Page 579
A......Page 582
B......Page 583
C......Page 584
D......Page 586
E......Page 587
G......Page 588
I......Page 589
J......Page 590
L......Page 592
N......Page 593
P......Page 594
S......Page 595
T......Page 596
X......Page 598
Z......Page 599