buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckAntCall.java
/*
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
*
*/
package com.nokia.helium.antlint.ant.types;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.apache.tools.ant.Target;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import com.nokia.helium.antlint.ant.AntlintException;
/**
* <code>CheckAntCall</code> is used to check whether antcall is used with no param elements and
* calls the target with no dependencies
*
* <pre>
* Usage:
*
* <antlint>
* <fileset id="antlint.files" dir="${antlint.test.dir}/data">
* <include name="*.ant.xml"/>
* <include name="*build.xml"/>
* <include name="*.antlib.xml"/>
* </fileset>
* <CheckAntCall" severity="error" enabled="true"/>
* </antlint>
* </pre>
*
* @ant.task name="CheckAntCall" category="AntLint"
*/
public class CheckAntCall extends AbstractCheck {
private File antFile;
/**
* {@inheritDoc}
*/
public void run(Element node) {
if (node.getName().equals("target")) {
checkAntCalls(node);
}
}
/**
* Check against the given node.
*
* @param node is the node to check.
*/
@SuppressWarnings("unchecked")
private void checkAntCalls(Element node) {
if (node.elements("antcall") != null) {
List<Element> antcallList = node.elements("antcall");
for (Element antcallElement : antcallList) {
String antcallName = antcallElement.attributeValue("target");
if (((node.elements("param") == null) || (node.elements("param") != null && node.elements("param").isEmpty()))
&& !checkTargetDependency(antcallName)) {
this.getReporter().report(this.getSeverity(), "<antcall> is used with no param elements and calls the target "
+ antcallName
+ " that has no dependencies! (<runtarget> could be used instead.)", this.getAntFile(), 0);
}
}
}
}
/*
* (non-Javadoc)
*
* @see com.nokia.helium.antlint.ant.types.Check#run(java.io.File)
*/
public void run(File antFilename) throws AntlintException {
this.antFile = antFilename;
SAXReader saxReader = new SAXReader();
Document doc;
List<Element> targetNodes = new ArrayList<Element>();
try {
doc = saxReader.read(antFilename);
elementTreeWalk(doc.getRootElement(), "target", targetNodes);
}
catch (DocumentException e) {
throw new AntlintException("Invalid XML file " + e.getMessage());
}
for (Element targetNode : targetNodes) {
run(targetNode);
}
}
/*
* (non-Javadoc)
*
* @see org.apache.tools.ant.types.DataType#toString()
*/
public String toString() {
return "CheckAntCall";
}
/**
* Check the availability dependent targets of the given target.
*
* @param targetName is the target for which dependent targets to be loked up.
* @return true, if the dependant targets are available; otherwise false
*/
private boolean checkTargetDependency(String targetName) {
boolean dependencyCheck = false;
Target targetDependency = (Target) getProject().getTargets().get(targetName);
dependencyCheck = targetDependency != null
&& targetDependency.getDependencies().hasMoreElements();
return dependencyCheck;
}
/*
* (non-Javadoc)
*
* @see com.nokia.helium.antlint.ant.types.Check#getAntFile()
*/
public File getAntFile() {
return this.antFile;
}
}