buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckAntCall.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 588 c7c26511138f
child 645 b8d81fa19e7d
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     1
/*
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     3
 * All rights reserved.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     8
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
     9
 * Initial Contributors:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    11
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    12
 * Contributors:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    13
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    14
 * Description: 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    15
 *
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    16
 */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    17
package com.nokia.helium.antlint.ant.types;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    18
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    19
import java.io.File;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    20
import java.util.ArrayList;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    21
import java.util.List;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    22
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    23
import org.apache.tools.ant.Target;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    24
import org.dom4j.Document;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    25
import org.dom4j.DocumentException;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    26
import org.dom4j.Element;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    27
import org.dom4j.io.SAXReader;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    28
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    29
import com.nokia.helium.antlint.ant.AntlintException;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    30
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    31
/**
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    32
 * <code>CheckAntCall</code> is used to check whether antcall is used with no param elements and
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    33
 * calls the target with no dependencies
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    34
 * 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    35
 * <pre>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    36
 * Usage:
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    37
 * 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    38
 *  &lt;antlint&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    39
 *       &lt;fileset id=&quot;antlint.files&quot; dir=&quot;${antlint.test.dir}/data&quot;&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    40
 *               &lt;include name=&quot;*.ant.xml&quot;/&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    41
 *               &lt;include name=&quot;*build.xml&quot;/&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    42
 *               &lt;include name=&quot;*.antlib.xml&quot;/&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    43
 *       &lt;/fileset&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    44
 *       &lt;CheckAntCall&quot; severity=&quot;error&quot; enabled=&quot;true&quot;/&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    45
 *  &lt;/antlint&gt;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    46
 * </pre>
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    47
 * 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    48
 * @ant.task name="CheckAntCall" category="AntLint"
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    49
 */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    50
public class CheckAntCall extends AbstractCheck {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    51
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    52
    private File antFile;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    53
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    54
    /**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    55
     * {@inheritDoc}
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    56
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    57
    public void run(Element node) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    58
        if (node.getName().equals("target")) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    59
            checkAntCalls(node);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    60
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    61
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    62
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    63
    /**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    64
     * Check against the given node.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    65
     * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    66
     * @param node is the node to check.
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    67
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    68
    @SuppressWarnings("unchecked")
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    69
    private void checkAntCalls(Element node) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    70
        if (node.elements("antcall") != null) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    71
            List<Element> antcallList = node.elements("antcall");
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    72
            for (Element antcallElement : antcallList) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    73
                String antcallName = antcallElement.attributeValue("target");
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    74
                if (((node.elements("param") == null) || (node.elements("param") != null && node.elements("param").isEmpty()))
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    75
                    && !checkTargetDependency(antcallName)) {
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    76
                    this.getReporter().report(this.getSeverity(), "<antcall> is used with no param elements and calls the target "
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    77
                        + antcallName
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    78
                        + " that has no dependencies! (<runtarget> could be used instead.)", this.getAntFile(), 0);
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    79
                }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    80
            }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    81
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    82
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    83
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    84
    /*
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    85
     * (non-Javadoc)
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    86
     * 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    87
     * @see com.nokia.helium.antlint.ant.types.Check#run(java.io.File)
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    88
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    89
    public void run(File antFilename) throws AntlintException {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    90
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    91
        this.antFile = antFilename;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    92
        SAXReader saxReader = new SAXReader();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    93
        Document doc;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    94
        List<Element> targetNodes = new ArrayList<Element>();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    95
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    96
        try {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    97
            doc = saxReader.read(antFilename);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
    98
            elementTreeWalk(doc.getRootElement(), "target", targetNodes);
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    99
        }
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
   100
        catch (DocumentException e) {
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   101
            throw new AntlintException("Invalid XML file " + e.getMessage());
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   102
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   103
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   104
        for (Element targetNode : targetNodes) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   105
            run(targetNode);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   106
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   107
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   108
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   109
    /*
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   110
     * (non-Javadoc)
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   111
     * 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   112
     * @see org.apache.tools.ant.types.DataType#toString()
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   113
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   114
    public String toString() {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   115
        return "CheckAntCall";
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   116
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   117
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   118
    /**
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   119
     * Check the availability dependent targets of the given target.
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   120
     * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
   121
     * @param targetName is the target for which dependent targets to be loked up.
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   122
     * @return true, if the dependant targets are available; otherwise false
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   123
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   124
    private boolean checkTargetDependency(String targetName) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   125
        boolean dependencyCheck = false;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
   126
        Target targetDependency = (Target) getProject().getTargets().get(targetName);
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   127
        dependencyCheck = targetDependency != null
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
   128
            && targetDependency.getDependencies().hasMoreElements();
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   129
        return dependencyCheck;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   130
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   131
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   132
    /*
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   133
     * (non-Javadoc)
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   134
     * 
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   135
     * @see com.nokia.helium.antlint.ant.types.Check#getAntFile()
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   136
     */
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   137
    public File getAntFile() {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   138
        return this.antFile;
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   139
    }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   140
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents:
diff changeset
   141
}