采用Ant进行诊断测试
2008-01-05 18:16:55 来源:WEB开发网 闂傚倸鍊搁崐鎼佸磹閹间礁纾归柟闂寸绾惧綊鏌熼梻瀵割槮缁炬儳缍婇弻鐔兼⒒鐎靛壊妲紒鐐劤缂嶅﹪寮婚悢鍏尖拻閻庨潧澹婂Σ顔剧磼閻愵剙鍔ょ紓宥咃躬瀵鎮㈤崗灏栨嫽闁诲酣娼ф竟濠偽i鍓х<闁绘劦鍓欓崝銈囩磽瀹ュ拑韬€殿喖顭烽幃銏ゅ礂鐏忔牗瀚介梺璇查叄濞佳勭珶婵犲伣锝夘敊閸撗咃紲闂佺粯鍔﹂崜娆撳礉閵堝洨纾界€广儱鎷戦煬顒傗偓娈垮枛椤兘骞冮姀銈呯閻忓繑鐗楃€氫粙姊虹拠鏌ュ弰婵炰匠鍕彾濠电姴浼i敐澶樻晩闁告挆鍜冪床闂備胶绮崝锕傚礈濞嗘挸绀夐柕鍫濇川绾剧晫鈧箍鍎遍幏鎴︾叕椤掑倵鍋撳▓鍨灈妞ゎ厾鍏橀獮鍐閵堝懐顦ч柣蹇撶箲閻楁鈧矮绮欏铏规嫚閺屻儱寮板┑鐐板尃閸曨厾褰炬繝鐢靛Т娴硷綁鏁愭径妯绘櫓闂佸憡鎸嗛崪鍐簥闂傚倷娴囬鏍垂鎼淬劌绀冮柨婵嗘閻﹂亶姊婚崒娆掑厡妞ゃ垹锕ら埢宥夊即閵忕姷顔夐梺鎼炲労閸撴瑩鎮橀幎鑺ョ厸闁告劑鍔庢晶鏇犵磼閳ь剟宕橀埞澶哥盎闂婎偄娲ゅù鐑剿囬敃鈧湁婵犲﹤鐗忛悾娲煛鐏炶濡奸柍瑙勫灴瀹曞崬鈻庤箛鎾寸槗缂傚倸鍊烽梽宥夊礉鎼达絽鍨濇い鏍仜妗呴梺鍛婃处閸ㄦ壆绮婚幎鑺ュ€甸柨婵嗙凹缁ㄨ棄霉閻樿崵鐣烘慨濠冩そ濡啫鈽夊▎鎰€烽梺璇插閻噣宕¢幎鑺ュ仒妞ゆ洍鍋撶€规洖鐖奸、妤佸緞鐎n偅鐝┑鐘愁問閸n垳寰婇崜褉鍋撶粭娑樻搐缁犳煡鏌涢妷顔煎闁藉啰鍠栭弻锝夊棘閹稿孩鍠愰梺鑽ゅ枎缂嶅﹪寮诲☉鈶┾偓锕傚箣濠靛洨浜俊鐐€ら崜娆撴偋閸℃稈鈧棃宕橀鍢壯囧箹缁厜鍋撻懠顒€鍤紓鍌氬€风欢锟犲窗濡ゅ懎绠伴柟闂寸劍閸嬧晠鏌i幋锝嗩棄缁绢厸鍋撻梻浣虹帛閸旀洜绮旈棃娴虫盯宕橀鍏兼К闂侀€炲苯澧柕鍥у楠炴帡骞嬪┑鎰磻闁诲氦顫夐幐椋庣矆娓氣偓閸╃偤骞嬮敂钘変汗闂佸湱绮敮鈺傚閳ь剛绱撴担鐟板姢鐟滄壆鍋熼崚鎺戔枎閹惧疇鎽曞┑鐐村灦閻喖鈻介鍫熺厵閻熸瑥瀚慨鍥ㄣ亜閵夛妇绠炴慨濠冩そ閺屽懘鎮欓懠璺侯伃婵犫拃鍌氬祮闁哄瞼鍠栭幖褰掝敃閿濆懐锛撻梻浣瑰缁诲嫰宕戝☉銏犵厴闁瑰濮崑鎾绘晲鎼存ê浜炬い鎾寸⊕濞呭﹪鏌$仦鐣屝f繛纰变邯楠炲繒浠﹂挊澶婅厫闂傚倷鐒﹂惇褰掑磹閺囥垹绠犻柟閭﹀枟椤洟鏌熼幆褏鎽犲┑顖涙尦閺屾盯骞橀弶鎴犵シ闂佸憡鎸稿畷顒勨€旈崘顔嘉ч柛鈩冾殘娴犳悂姊洪懡銈呮毐闁哄懏鐩幃楣冩倻閽樺)銊ф喐婢舵劕纾婚柟鍓х帛閺呮煡骞栫划鐟板⒉闁诲繐绉瑰铏圭磼濡闉嶅┑鐐插级閿曘垺淇婇悽绋跨妞ゆ牗姘ㄩ悿鈧梻鍌氬€搁悧濠勭矙閹邦喛濮抽柤娴嬫櫇绾捐棄霉閿濆牊顥夐柣鎾村姈閹便劌螣缁嬪灝顬嬪┑鈥冲级閸旀瑩鐛Ο鍏煎珰闁肩⒈鍓﹀Σ浼存⒒娴gǹ鏆遍柟纰卞亰瀹曟劖绻濆В绋挎喘瀵埖鎯旈幘瀛樻澑婵$偑鍊栧濠氬Υ鐎n亶鍟呴柕澶涜礋娴滄粍銇勯幘璺轰粶婵℃彃顭烽弻锝夋晲閸パ冨箣濡ょ姷鍋炵敮锟犵嵁鐎n喖绫嶉柍褜鍓熼幃妤佺節濮橆厸鎷洪柣鐔哥懃鐎氼參宕曞Δ鍛厱婵☆垵銆€閸嬫捇鎮㈤幓鎺戠阀濠电姷鏁告慨鐑藉极閸涘﹥鍙忛柣鎴f閺嬩線鏌涘☉姗堟敾闁告瑥绻戦妵鍕箻閸楃偟浠肩紒鐐劤椤兘寮婚悢鐓庣鐟滃繒鏁☉銏$厓闂佸灝顑呴悘锕傛煏閸パ冾伃妤犵偞甯″畷鍗烆渻閹屾缂傚倸鍊搁崐椋庣矆娓氣偓钘濋梺顒€绉撮弸浣糕攽閻樿櫕鐨戠€规挷绶氶弻娑㈠焺閸愵亖濮囬梺绋匡功閸忔﹢寮诲☉妯锋斀闁糕剝顨忔导鈧俊鐐€栧褰掑礉閺囥垹鐓橀柟杈鹃檮閸婂鏌涢妷銏℃珖閺嶏繝姊绘担鍛婂暈闁圭ǹ顭烽幃鐑芥晜閻e备鏀虫繝鐢靛Т濞诧箓宕甸崘顔界厓闁告繂瀚弳鐔兼煥濞戞瑧鐭掓慨濠囩細閵囨劙骞掗幋婊冩瀳闂備礁鎲¢悷銉︻殽閹间礁鐓濋柟鐐灱閸亪鏌涢銈呮灁闁告ɑ鎮傞弻锝堢疀閺囩偘鎴风紒缁㈠幖閻栫厧鐣烽幋锕€绠婚悹鍥皺閻も偓濠电偠鎻徊浠嬪箟閿熺姴纾规い鏍仦閳锋垹鐥鐐村櫣濞存粌缍婇幃璺衡槈閺嵮冨Е闂佺硶鏂侀崑鎾愁渻閵堝棗绗掗柛鐕佸亰閹啫煤椤忓懐鍘告繛杈剧到濠€杈ㄦ櫠椤忓牊鐓冮悷娆忓閻忔挳鏌熼鐣屾噰鐎殿喖鐖奸獮瀣偐鏉堫煈鏁囬梻鍌氬€风粈浣革耿鏉堛劎浠氶梻浣侯攰婵倗鍒掓惔銊ョ闁圭儤顨呯猾宥夋煕椤愩倕鏋庡ù鐘烘缁辨挻鎷呴崜鎻掑壍濡炪倖娲樻繛濠囧极閸愵喖纾兼繛鎴炶壘楠炲牓姊绘担鍛婃儓婵炲眰鍨藉畷婵嗙暆閸曨剙鈧爼鏌eΟ鑲╁笡闁绘挻娲熼弻鐔兼嚋椤掆偓婵$厧霉濠婂嫬鍔ら柍瑙勫灴閺佸秹宕熼鈩冩線闂備胶枪閿曘儵鎮ч悩鑼殾婵犻潧顑嗛弲婵嬫煃瑜滈崜鐔煎灳閿曞倸閿ゆ俊銈傚亾闁绘帒鐏氶妵鍕箳瀹ュ牆鍘$紓浣哄Т婢т粙鍩€椤掆偓閸樻粓宕戦幘鏂ユ斀闁绘ǹ浜粣鏃堟煕鐎n偒娈旈柍瑙勫灴椤㈡瑧娑甸悜鐣屽弽婵犵數鍋涢幏鎴犲緤閸啣锝夊箛閺夎法顔婇梺鐟板暱绾绢參宕伴幘璇茬闁绘ḿ绮崵鎴︽煠缁嬭法浠涙慨锝嗗姍濮婂宕掑顑藉亾閻戣姤鍤勯柤鍝ユ暩娴犳碍绻濋悽闈涗粶妞ゆ洦鍙冨畷妤€螣娓氼垰娈ㄥ銈嗗姂閸婃牜鈧碍姘ㄩ埀顒傛嚀婢瑰﹪宕伴弽褉鏋旈柕濠忓缁♀偓闂佹眹鍨藉ḿ褎鐗庣紓浣哄亾濠㈡ḿ绮旈悷閭﹀殨闁哄被鍎辩粻鐢告煙閻戞ḿ绠橀柛鐐垫暬閺岋綁鎮╅悜姗嗕哗闁诲繐绻堥崝宀勵敊韫囨稑唯鐟滃宕戦幘鑸靛枂闁告洦鍓欑喊宥呪攽閳藉棗浜濈紒璇插€块敐鐐剁疀濞戞瑦鍎梺闈╁瘜閸橀箖鏁嶅⿰鍐f斀闁宠棄妫楅悘鐘绘煙绾板崬浜伴柨婵堝仜椤撳ジ宕堕埡鍐跨闯濠电偠鎻紞渚€藟閹捐绀夌€广儱顦伴悡娆戠磼鐎n亞浠㈤柡鍡涗憾閺岋綁鏁愰崶褍骞嬪Δ鐘靛仜椤戝寮崘顔肩劦妞ゆ帒鍊绘稉宥呪攽閻樺磭顣查柛瀣剁秮閺屾盯濡烽幋婵嗘殶濡ょ姴娲幃妤冩喆閸曨剙纰嶇紓浣割槹閹告娊鍨鹃弮鍫濈妞ゆ柨妲堣閺屾盯鍩勯崗鐙€浜Λ鍕吋閸モ晝锛濇繛杈剧到婢瑰﹪宕曢幇鐗堢厱闁靛ǹ鍎遍。宕囩磼椤旂⒈鍎忔い鎾冲悑瀵板嫮鈧綆浜栭崑鎾绘煥鐎c劋绨婚梺鐟版惈缁夊爼藝閿旈敮鍋撳▓鍨灈闁诲繑绻堥崺鐐哄箣閿曗偓閻擄繝鏌涢埄鍐炬畼濞寸媭鍨跺娲川婵犲海鍔堕梺鍛婃处閸欏骸煤閸涘﹣绻嗛柕鍫濈箳閸掍即鏌涢悤浣哥仸鐎规洘鍔欏畷褰掝敃閿濆懎浼庢繝纰樻閸ㄦ娊宕㈣缁傚秵銈i崘鈺佲偓鍨叏濡厧浜鹃悗姘炬嫹

核心提示: 用户可能碰到什么样的问题呢?首先,假如用户没有完全按照正确的安装步骤,采用Ant进行诊断测试,在安装过程中就可能会出现问题了,即使安装成功了,然后你就可以使用已知的正确版本来替换被改变的类文件了,另一方面,之后问题仍然可能出现,配置(像java_HOME环境变量)的改变或者目录结构的
用户可能碰到什么样的问题呢?首先,假如用户没有完全按照正确的安装步骤,在安装过程中就可能会出现问题了。即使安装成功了,之后问题仍然可能出现。配置(像java_HOME环境变量)的改变或者目录结构的改变无疑会导致问题。在本文中,我们将要开发一个Ant脚本来为一个Java程序运行诊断测试。我们将着眼于建立一个可能出现的问题的列表以及如何来解决这些问题。Ant需要提前被安装在用户的机器上,这意味着你的安装程序可能需要提供Ant。
系统配置
在除错时你需要知道的第一件事就是系统配置——操作系统,Java版本,类路径等等。由于Ant提供了对所有Java系统属性的访问,实现这一功能是很轻易的。下面是一个示例:
basedir=".">
示例将有如下输出:
$ ant -f diagnostic.xml现在,假如哪个方面出现了问题,你就可以在系统属性中找到问题的源头了,比如错误的Java版本或者类路径等等。
Buildfile: diagnostic.xml
systemProperties:
[echo] Java Runtime Environment version:
1.4.2_05
[echo] Java Runtime Environment vendor:
Apple Computer, Inc.
[echo] Java Runtime Environment vendor URL:
http://apple.com/
...
[echo] Default temp file path: /tmp
[echo] Operating system name: Mac OS X
[echo] Operating system architecture: ppc
[echo] Operating system version: 10.3.9
文件和类路径的有效性
我们可以进一步实现一些自动测试来检测一个文件或类能否被找到:
property="fop.available"/>
property="scriptsdir.exists"/>
unless="fop.available">
depends="files" unless="scriptsdir.exists">
第一个目标执行两项测试:首先它检查org.apache.fop.apps.Fop类能否在类路径中被找到,然后检查目录directory build/scripts是否存在。将type改为file的话,有效性测试就可以检查指定文件是否存在。假如类或者目录不存在的话,后面两个目标将分别显示出错误信息。
Java版本的最低需求
我们可以做更多,但是这需要我们编写定制的Ant任务。我们就来检查一下已经安装的Java版本是否高于我们的代码所要求的最低版本。假如版本不符合要求,诊断编译文件就会提示错误信息。JavaVersionTask类的源代码如下:
import org.apache.tools.ant.*;
/**
JavaVersionTask is an Ant task for testing if
the installed Java version is greater than a
minimum required version.
**/
public class JavaVersionTask extends Task {
// Minimum required Java version.
private String minVersion;
// Installed Java version.
private String installedVersion;
// The name of the property that gets set when
// the installed Java version is ok.
private String propertyName;
/**
* ConstrUCtor of the JavaVersionTask class.
**/
public JavaVersionTask() {
super();
installedVersion = System.getProperty
("java.version");
}
/**
* Set the attribute minVersion.
**/
public void setMinVersion(String version) {
minVersion = version;
}
/**
Set the property name that the task sets when
the installed Java version is ok.
**/
public void setProperty(String propName) {
propertyName = propName;
}
/**
* Execute the task.
**/
public void execute() throws BuildException {
if (propertyName==null) {
throw new BuildException("No property name
set.");
} else if (minVersion==null) {
throw new BuildException("No minimum version
set.");
}
if(installedVersion.compareTo(minVersion)
>= 0) {
getProject().setProperty(propertyName,
"true");
}
}
}
假如你建立一个定制任务,它的类需要扩展org.apache.tools.ant.Task类。任务的编译文件中每一个属性都使用一个设置方法来设置,方法的名字以“set”开头,接着是属性的名字,名字的首字母需要大写(这是JavaBeans的约定)。例如,属性minVersion使用方法setMinVersion来设置,同样属性property使用方法setProperty来设置。
当编译文件调用任务的时候,方法execute将被执行。首先我们检查属性是否已被设置,然后我们执行任务的核心:假如已安装的Java版本高于或者等同于最低要求的Java版本,我们就把指定名字的属性值设为真。
版本以字符串对象的形式储存,因此我们可以用按照字母顺序来比较两个字符串的compareTo方法来比较它们。假如第一个串小于第二个串,该方法则返回-1,相等则返回0,假如第一个串按照字母顺序大于第二个串则返回+1。这样任务就可以认为1.5大于1.4,也大于1.4.2或者1.4.2_05。
为了在Ant编译文件中使用定制任务,我们首先需要定义一个包含最低所需Java版本的编译属性:
在目标systemProperties中我们加入下列代码:
classname="JavaVersionTask" classpath="."/>
property="javaversion.ok"/>
第一行定义了一个名叫javaversion的新任务,接着是实现这一任务的Java类名:JavaVersionTask。下一行执行指定了最低所需Java版本的javaversion任务。当已安装的Java版本高于所需版本时,javaversion.ok则被赋值。
然后我们加入一个目标javaVersion:
unless="javaversion.ok">
接下来,我们把目标加入到目标all的依存关系中。它只有在javaversion.ok属性没有被设置的时候才执行。此时,目标将显示一条错误信息,提示出找到的Java版本和所需的Java版本。这是一个输出的示例:
javaVersion: [echo] ERROR: Java version与JavaVersionTask相似,我们也可以写一个任务来执行其他的版本检查,例如已安装的库或者操作系统的版本。
too old: found 1.4.2_05, needs 1.5.
被改变的文件
当问题发生时,了解在安装之后是否有文件被改变是十分重要的。有可能是标准配置被改变或者被替换掉的文件引起了问题。为了调查这一点,我们可以使用Ant的校验和:在我们软件的安装编译文件中,我们为每一个文件生成一个校验和,在诊断测试中我们就可以验证这些校验和。这样我们就可以在安装之后了解哪个文件被改变了,并且该任务缩小了搜索引起问题原因的范围。在安装编译文件中,我们可以为每个可能被改变的重要文件生成一个md5校验和,在诊断编译文件中我们就可以校验它。当然,被改变的二进制文件与被改变的配置文件是有区别的,前者不应该被改变,后者被改变了就可能会引起问题,也可能不会。
在我们的安装编译文件中,我们像这样来生成校验和:
Ant为build目录及其子目录中所有扩展名为.class的文件生成MD5校验和。校验和将以原文件名保存,加上扩展名.MD5。对于配置文件config.xml也是一样。在所有的文件都被编译之后,目标checksum就将被执行。
在诊断编译文件中,我们验证校验和:
unless="binary.unchanged">
unless="config.unchanged">
将目标加入到目标all的依存关系中。
首先,目标checksum将被执行。假如所有类文件的校验和与之前所生成的校验和相符,属性binary.unchanged将被设为真。但假如至少一个文件被改变了,该属性则不会被赋值。然后,假如config.xml文件没有被改变,属性config.unchanged则被设为真。依靠于目标checksum的目标binaryChanged只有在binary.unchanged没有值的时候才被执行,也就是在至少一个类文件被改变的时候,然后将输出一条错误信息。对于配置文件也是一样,但是我们将输出一条警告信息。
假如没有文件被改变,我们的诊断编译脚本输出入下信息:
checksum:
[echo] Verifying checksums of binary files...
[echo] Verifying checksum of configuration file...
binaryChanged:
configChanged:
all:
BUILD SUCCESSFUL
Total time: 1 second
假设我们改变了配置文件,然后我们会得到这样的输出:
checksum:
[echo] Verifying checksums of binary files...
[echo] Verifying checksum of configuration file...
binaryChanged:
configChanged:
[echo] WARNING: Configuration file changed.
all:
BUILD SUCCESSFUL
Total time: 1 second
假如我们的软件开放源代码,我们可以做得更好,甚至可以将被改变的文件恢复成标准版本。对于特定的类文件,这意味着我们需要编译Java文件。当然,你的客户需要拥有完整的JDK(不只是Java运行时)和你的源代码及其编译文件。为了恢复被改变的类文件,我们删除他们然后调用安装编译文件的编译任务。这一任务的细节取决于你的编译系统。
作为另外一种选择(例如你的软件为封闭源代码),你可以在安全的位置将已知为正确版本的类文件存放在一个.jar或者.zip文件中并且解包它们。然后你就可以使用已知的正确版本来替换被改变的类文件了。
另一方面,配置文件可以从源文件夹中拷贝过来。我们可以适当地扩展目标configChanged并且添加一个目标configRestore来实现这一功能:
depends="checksum" unless="config.unchanged">
and restore original? " validargs="y,n"> addproperty="config.restore"/>
depends="configChanged" if="config.copy">
tofile="build/config.xml.1" overwrite="true"/>
overwrite="true"/>
更多精彩
赞助商链接