Parts of the documentation:
|
+<#if !ant?keys?seq_contains("sf")>
Release notes Quick Start Guide E-learning Feature list Manual |
Customer documentation:
| @@ -60,5 +59,5 @@ development teams |
CheckAntCall is used to check whether antcall is used with no
- * param elements and calls the target with no dependencies
+ * CheckAntCall is used to check whether antcall is used with no param elements and
+ * calls the target with no dependencies
*
*
* Usage:
@@ -63,8 +63,7 @@
/**
* Check against the given node.
*
- * @param node
- * is the node to check.
+ * @param node is the node to check.
*/
@SuppressWarnings("unchecked")
private void checkAntCalls(Element node) {
@@ -72,18 +71,11 @@
List 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(),
- " is used with no param elements and calls the target "
- + antcallName
- + " that has no dependencies! ( could be used instead.)",
- this.getAntFile(), 0);
+ if (((node.elements("param") == null) || (node.elements("param") != null && node.elements("param").isEmpty()))
+ && !checkTargetDependency(antcallName)) {
+ this.getReporter().report(this.getSeverity(), " is used with no param elements and calls the target "
+ + antcallName
+ + " that has no dependencies! ( could be used instead.)", this.getAntFile(), 0);
}
}
}
@@ -104,7 +96,8 @@
try {
doc = saxReader.read(antFilename);
elementTreeWalk(doc.getRootElement(), "target", targetNodes);
- } catch (DocumentException e) {
+ }
+ catch (DocumentException e) {
throw new AntlintException("Invalid XML file " + e.getMessage());
}
@@ -125,16 +118,14 @@
/**
* Check the availability dependent targets of the given target.
*
- * @param targetName
- * is the target for which dependent targets to be loked up.
+ * @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);
+ Target targetDependency = (Target) getProject().getTargets().get(targetName);
dependencyCheck = targetDependency != null
- && targetDependency.getDependencies().hasMoreElements();
+ && targetDependency.getDependencies().hasMoreElements();
return dependencyCheck;
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckDuplicateNames.java
--- a/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckDuplicateNames.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckDuplicateNames.java Mon Sep 13 13:11:19 2010 +0800
@@ -56,13 +56,14 @@
for (String macroName : macros) {
if (macros.contains(macroName + "Macro")
- || macros.contains(macroName + "macro"))
+ || macros.contains(macroName + "macro")) {
this.getReporter()
.report(
this.getSeverity(),
macroName + " and " + macroName + "Macro"
+ " found duplicate name",
this.getAntFile(), 0);
+ }
}
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckIndentation.java
--- a/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckIndentation.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckIndentation.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,12 +17,13 @@
package com.nokia.helium.antlint.ant.types;
import java.io.File;
+import java.io.IOException;
+import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
-import javax.xml.parsers.ParserConfigurationException;
+
import org.xml.sax.SAXException;
-import java.io.IOException;
import com.nokia.helium.antlint.AntLintHandler;
import com.nokia.helium.antlint.ant.AntlintException;
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckProjectName.java
--- a/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckProjectName.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckProjectName.java Mon Sep 13 13:11:19 2010 +0800
@@ -53,9 +53,6 @@
/**
* {@inheritDoc}
- *
- * @throws SAXException
- * @throws ParserConfigurationException
*/
public void run(Element node) {
if (node.getName().equals("project")) {
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckPropertyName.java
--- a/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckPropertyName.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckPropertyName.java Mon Sep 13 13:11:19 2010 +0800
@@ -23,7 +23,6 @@
import java.util.regex.Pattern;
import org.dom4j.Document;
-
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckPythonTasks.java
--- a/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckPythonTasks.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckPythonTasks.java Mon Sep 13 13:11:19 2010 +0800
@@ -18,10 +18,10 @@
import java.io.File;
import java.io.FileOutputStream;
+import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;
-import java.io.IOException;
import org.apache.tools.ant.BuildException;
import org.dom4j.Document;
@@ -93,8 +93,9 @@
PrintWriter output = new PrintWriter(new FileOutputStream(file));
if (!text.equals("")) {
output.write("def abc():");
- for (String line : text.split("\n"))
+ for (String line : text.split("\n")) {
output.write(" " + line + "\n");
+ }
}
output.close();
} catch (IOException e) {
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckScriptDef.java
--- a/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckScriptDef.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckScriptDef.java Mon Sep 13 13:11:19 2010 +0800
@@ -18,12 +18,12 @@
import java.io.File;
import java.io.FileOutputStream;
+import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-import java.io.IOException;
import org.apache.tools.ant.BuildException;
import org.dom4j.Document;
@@ -127,19 +127,22 @@
PrintWriter output = new PrintWriter(new FileOutputStream(file));
for (String line : text.split("\n")) {
- if (line.trim().startsWith("import"))
+ if (line.trim().startsWith("import")) {
output.write(line + "\n");
+ }
}
output.write("/**\n * x\n */\npublic final class " + scriptdefname
+ " {\n");
- output.write("private " + scriptdefname + "() { }\n");
- output.write("public static void main(String[] args) {\n");
+ output.write(" private " + scriptdefname + "() { }\n");
+ output.write(" public static void main(String[] args) {\n");
for (String line : text.split("\n")) {
- if (!line.trim().startsWith("import"))
- output.write(line + "\n");
+ if (!line.trim().startsWith("import")) {
+ output.write(" " + line + "\n");
+ }
}
- output.write("} }");
+ output.write(" }\n");
+ output.write("}\n");
output.close();
} catch (IOException e) {
throw new BuildException("Not able to write Beanshell File "
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckTabCharacter.java
--- a/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckTabCharacter.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckTabCharacter.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,15 +17,16 @@
package com.nokia.helium.antlint.ant.types;
import java.io.File;
+import java.io.IOException;
import java.util.List;
-import java.io.IOException;
+import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
-import javax.xml.parsers.ParserConfigurationException;
-import org.xml.sax.SAXException;
+
import org.dom4j.Element;
import org.dom4j.Node;
+import org.xml.sax.SAXException;
import com.nokia.helium.antlint.AntLintHandler;
import com.nokia.helium.antlint.ant.AntlintException;
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckTryCatchBlock.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/antlint/src/com/nokia/helium/antlint/ant/types/CheckTryCatchBlock.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,134 @@
+/*
+ * 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.io.IOException;
+
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.parsers.SAXParser;
+import javax.xml.parsers.SAXParserFactory;
+
+import org.xml.sax.Attributes;
+import org.xml.sax.Locator;
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
+
+import com.nokia.helium.antlint.ant.AntlintException;
+
+/**
+ * CheckTryCatchBlock is used to check for empty and more than one
+ * catch elements in a given try-catch block.
+ *
+ *
+ * Usage:
+ *
+ * <antlint>
+ * <fileset id="antlint.files" dir="${antlint.test.dir}/data">
+ * <include name="*.ant.xml"/>
+ * <include name="*build.xml"/>
+ * <include name="*.antlib.xml"/>
+ * </fileset>
+ * <checkTryCatchBlock" severity="error" enabled="true" />
+ * </antlint>
+ *
+ *
+ * @ant.task name="checkTryCatchBlock" category="AntLint"
+ *
+ */
+public class CheckTryCatchBlock extends AbstractCheck {
+
+ private File antFile;
+
+ /**
+ * {@inheritDoc}
+ */
+ public File getAntFile() {
+ return antFile;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void run(File antFilename) throws AntlintException {
+ try {
+ this.antFile = antFilename;
+ SAXParserFactory saxFactory = SAXParserFactory.newInstance();
+ saxFactory.setNamespaceAware(true);
+ saxFactory.setValidating(true);
+ SAXParser parser = saxFactory.newSAXParser();
+ TryCatchBlockHandler handler = new TryCatchBlockHandler();
+ parser.parse(antFilename, handler);
+ } catch (ParserConfigurationException e) {
+ throw new AntlintException("Not able to parse XML file "
+ + e.getMessage());
+ } catch (SAXException e) {
+ throw new AntlintException("Not able to parse XML file "
+ + e.getMessage());
+ } catch (IOException e) {
+ throw new AntlintException("Not able to find XML file "
+ + e.getMessage());
+ }
+ }
+
+ public String toString() {
+ return "CheckTryCatchBlock";
+ }
+
+ private class TryCatchBlockHandler extends DefaultHandler {
+
+ private Locator locator;
+ private int catchCounter;
+
+ /**
+ * {@inheritDoc}
+ */
+ public void setDocumentLocator(Locator locator) {
+ this.locator = locator;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void startElement(String uri, String localName, String qName,
+ Attributes attributes) throws SAXException {
+ if (localName.equals("trycatch")) {
+ catchCounter = 0;
+ } else if (localName.equals("catch")) {
+ catchCounter++;
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void endElement(String uri, String localName, String qName)
+ throws SAXException {
+ if (localName.equals("trycatch") && catchCounter == 0) {
+ getReporter().report(getSeverity(),
+ " block found without element",
+ getAntFile(), locator.getLineNumber());
+ } else if (localName.equals("trycatch") && catchCounter > 1) {
+ getReporter().report(
+ getSeverity(),
+ " block found with " + catchCounter
+ + " elements.", getAntFile(),
+ locator.getLineNumber());
+ }
+ }
+ }
+}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/tests/antunit/test_antlint.ant.xml
--- a/buildframework/helium/sf/java/antlint/tests/antunit/test_antlint.ant.xml Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/tests/antunit/test_antlint.ant.xml Mon Sep 13 13:11:19 2010 +0800
@@ -329,5 +329,23 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/antlint/tests/data/sample.ant.xml
--- a/buildframework/helium/sf/java/antlint/tests/data/sample.ant.xml Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/antlint/tests/data/sample.ant.xml Mon Sep 13 13:11:19 2010 +0800
@@ -247,5 +247,52 @@
checking indentation
+
+ checking for empty catch block in try-catch
+
+
+
+
+
+
+
+ checking for empty catch block in try-catch
+
+
+
+
+ inside finally
+
+
+
+
+
+ checking for empty catch block in try-catch
+
+
+
+
+ inside catch
+
+
+
+
+
+ checking for empty catch block in try-catch
+
+
+
+
+ inside catch1
+
+
+ inside catch2
+
+
+
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/taskdefs/CcmTask.java
--- a/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/taskdefs/CcmTask.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/taskdefs/CcmTask.java Mon Sep 13 13:11:19 2010 +0800
@@ -27,6 +27,8 @@
import java.util.jar.JarFile;
import java.util.zip.ZipEntry;
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.Task;
import org.python.util.PythonInterpreter;
import com.nokia.helium.ccmtask.ant.commands.AddTask;
@@ -34,6 +36,8 @@
import com.nokia.helium.ccmtask.ant.commands.ChangeReleaseTag;
import com.nokia.helium.ccmtask.ant.commands.Checkout;
import com.nokia.helium.ccmtask.ant.commands.Close;
+import com.nokia.helium.ccmtask.ant.commands.CreateReleaseTag;
+import com.nokia.helium.ccmtask.ant.commands.DeleteReleaseTag;
import com.nokia.helium.ccmtask.ant.commands.Reconcile;
import com.nokia.helium.ccmtask.ant.commands.Role;
import com.nokia.helium.ccmtask.ant.commands.Snapshot;
@@ -41,10 +45,6 @@
import com.nokia.helium.ccmtask.ant.commands.Update;
import com.nokia.helium.ccmtask.ant.commands.Workarea;
import com.nokia.helium.ccmtask.ant.types.SessionSet;
-import com.nokia.helium.ccmtask.ant.commands.CreateReleaseTag;
-import com.nokia.helium.ccmtask.ant.commands.DeleteReleaseTag;
-import org.apache.tools.ant.BuildException;
-import org.apache.tools.ant.Task;
/**
* Synergy task.
@@ -220,7 +220,6 @@
/**
* Returns the jar file name containing this class
* @return a File object or null if not found.
- * @throws IMakerException
*/
protected File getJarFile() {
URL url = this.getClass().getClassLoader().getResource(this.getClass().getName().replace('.', '/') + ".class");
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/taskdefs/ccmtask.py
--- a/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/taskdefs/ccmtask.py Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/taskdefs/ccmtask.py Mon Sep 13 13:11:19 2010 +0800
@@ -36,18 +36,18 @@
logger = logging.getLogger("ccm.ant")
session = None
-def execute_update(command):
+def execute_update(session, command):
java_ccmtask.log(str('Updating project: ' + command.getProject()))
project = session.create(command.getProject())
project.update()
-def execute_role(command):
+def execute_role(session, command):
if not command.getRole():
raise Exception("The 'role' attribute has not been defined.")
java_ccmtask.log(str('Updating role: ' + command.getRole()))
session.role = command.getRole()
-def execute_synchronize(command):
+def execute_synchronize(session, command):
if not command.getProject():
raise Exception("The 'project' attribute has not been defined.")
java_ccmtask.log(str('Synchronizing project: ' + command.getProject()))
@@ -55,14 +55,14 @@
project = session.create(command.getProject())
project.sync(command.getRecursive())
-def execute_reconcile(command):
+def execute_reconcile(session, command):
if not command.getProject():
raise Exception("The 'project' attribute has not been defined.")
java_ccmtask.log(str('Reconciling project: ' + command.getProject()))
project = session.create(command.getProject())
project.reconcile()
-def execute_snapshot(command):
+def execute_snapshot(session, command):
if not command.getProject():
raise Exception("The 'project' attribute has not been defined.")
if not command.getDir():
@@ -74,7 +74,7 @@
else:
project.snapshot(command.getDir(), command.getRecursive())
-def execute_changereleasetag(command):
+def execute_changereleasetag(session, command):
if not command.getFolder():
raise Exception("The 'folder' attribute has not been defined.")
if not command.getReleaseTag():
@@ -86,7 +86,7 @@
if task.release != str(command.getReleaseTag()):
task.release = str(command.getReleaseTag())
-def execute_checkout(command):
+def execute_checkout(session, command):
if not command.getProject():
raise Exception("The 'project' attribute has not been defined.")
java_ccmtask.log(str('Checking out project: ' + command.getProject() + ' with release tag ' + command.getRelease()))
@@ -114,7 +114,7 @@
purpose = None
project.checkout(session.create(command.getRelease()), version, purpose, recursive)
-def execute_createreleasetag(command):
+def execute_createreleasetag(session, command):
java_ccmtask.log(str('creating a release tag'))
if not command.getProject():
raise Exception("The 'project' attribute has not been defined.")
@@ -123,7 +123,7 @@
new_release_tag = command.getNewTag();
project.create_release_tag(command.getRelease(), new_release_tag)
-def execute_deletereleasetag(command):
+def execute_deletereleasetag(session, command):
java_ccmtask.log(str('deleting a release tag'))
if not command.getProject():
raise Exception("The 'project' attribute has not been defined.")
@@ -132,7 +132,7 @@
new_release_tag = command.getNewTag();
project.delete_release_tag(command.getRelease(), new_release_tag)
-def execute_workarea(command):
+def execute_workarea(session, command):
if not command.getProject():
raise Exception("The 'project' attribute has not been defined.")
java_ccmtask.log(str('Modifying work area for the project : ' + command.getProject()))
@@ -163,11 +163,11 @@
wat = None
project.work_area(maintain, recursive, relative, path, pst, wat)
-def execute_addtask(command):
+def execute_addtask(session, command):
if command.getFolder() != None:
tasks = []
ccmfolder = session.create("Folder " + command.getFolder())
- role = find_folder_information(command)
+ role = find_folder_information(session, command)
if role == "build_mgr":
java_ccmtask.log("Changing role to %s" % role)
session.role = "build_mgr"
@@ -181,7 +181,7 @@
for task in tasks:
ccmfolder.append(task)
-def find_folder_information(command):
+def find_folder_information(session, command):
cmdline = "folder -sh i " + command.getFolder()
result = session.execute(cmdline)
result_array = str(result).split('\r')
@@ -193,7 +193,7 @@
else:
return "developer"
-def execute_exists(command):
+def execute_exists(session, command):
fpn = None
if command.getObject() != None:
fpn = command.getObject()
@@ -210,12 +210,11 @@
else:
raise Exception("Could not find '%s'." % ccmo)
-def execute_close(command):
- global session
- java_ccmtask.log(str("Closing session %s." % session))
- session.close_on_exit = True
+def execute_close(session, command):
+ java_ccmtask.log(str("Closing session %s." % str(session)))
+ if hasattr(session, 'close_on_exit'):
+ session.close_on_exit = True
session.close()
- session = None
def referenceToObject(obj):
if obj.isReference() == 1:
@@ -235,9 +234,9 @@
sessionid = sessionIds.pop()
session = ccm.Session(username=None, engine=None, dbpath=None, ccm_addr=sessionid, close_on_exit=False)
else:
- username = java_ccmtask.getUsername()
- password = java_ccmtask.getPassword()
- session = ccm.open_session(username=username, password=password)
+ username = java_ccmtask.getUsername()
+ password = java_ccmtask.getPassword()
+ session = ccm.open_session(username=username, password=password)
if java_ccmtask.getVerbose() == 1:
logging.getLogger("ccm").setLevel(logging.DEBUG)
@@ -249,7 +248,7 @@
method_name = 'execute_' + command.getName()
method = sys.modules['__main__'].__dict__[method_name]
try:
- method(command)
+ method(session, command)
except Exception, e:
if java_ccmtask.getVerbose() == 1:
import traceback
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/types/SessionSet.java
--- a/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/types/SessionSet.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/types/SessionSet.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,8 +17,9 @@
package com.nokia.helium.ccmtask.ant.types;
+import java.util.Vector;
+
import org.apache.tools.ant.types.DataType;
-import java.util.Vector;
/**
* This class implement an Ant Datatype that represents a set of
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/types/TaskSet.java
--- a/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/types/TaskSet.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/ccmtask/src/com/nokia/helium/ccmtask/ant/types/TaskSet.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,8 +17,9 @@
package com.nokia.helium.ccmtask.ant.types;
+import java.util.Vector;
+
import org.apache.tools.ant.types.DataType;
-import java.util.Vector;
/**
* This class abstract a synergy session.
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/CheckEngine.java
--- a/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/CheckEngine.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/CheckEngine.java Mon Sep 13 13:11:19 2010 +0800
@@ -46,7 +46,7 @@
/**
* Method verifies Ant version.
*/
- public void verifyAntVersion() {
+ public void verifyAntVersion() throws CheckToolException {
String expVersion = configuration.getProperty("ant.version");
String errorMsg = "Supported Ant version is not defined in 'helium.basic.tools.config' file under helium config folder.";
verifyIsExpectedToolVersionConfigured(expVersion, errorMsg);
@@ -59,7 +59,7 @@
/**
* Method verifies Python version.
*/
- public void verifyPythonVersion() {
+ public void verifyPythonVersion() throws CheckToolException {
String expVersion = configuration.getProperty("python.version");
String errorMsg = "Supported Python version is not defined in 'helium.basic.tools.config' file under helium config folder.";
verifyIsExpectedToolVersionConfigured(expVersion, errorMsg);
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/CheckToolException.java
--- a/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/CheckToolException.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/CheckToolException.java Mon Sep 13 13:11:19 2010 +0800
@@ -21,7 +21,7 @@
* failure occurred during checking of tools required by the Helium.
*
*/
-public class CheckToolException extends RuntimeException {
+public class CheckToolException extends Exception {
private static final long serialVersionUID = 1L;
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/HeliumToolsCheckerMain.java
--- a/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/HeliumToolsCheckerMain.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/HeliumToolsCheckerMain.java Mon Sep 13 13:11:19 2010 +0800
@@ -14,6 +14,7 @@
* Description:
*
*/
+
package com.nokia.helium.checktools;
import java.io.FileInputStream;
@@ -21,12 +22,11 @@
import java.util.Properties;
/**
- * HeliumToolsCheckerMain is the main class which is used to trigger the
- * checking of basic tools required by the Helium.
+ * HeliumToolsCheckerMain is the main class which is used to trigger the checking of basic tools
+ * required by the Helium.
*
- * Note: HeliumToolsCheckerMain requires a '-config' parameter to be passed as
- * the argument. The config parameter should be followed by a valid location of
- * the configuration file.
+ * Note: HeliumToolsCheckerMain requires a '-config' parameter to be passed as the argument. The
+ * config parameter should be followed by a valid location of the configuration file.
*
*/
public final class HeliumToolsCheckerMain {
@@ -34,12 +34,10 @@
private Properties configuration;
private CheckEngine checkEngine;
-
/**
* Create an instance of HeliumToolsCheckerMain.
*
- * @param configFile
- * is the config file to read.
+ * @param configFile is the config file to read.
*/
private HeliumToolsCheckerMain(String configFile) {
loadConfiguration(configFile);
@@ -54,7 +52,7 @@
try {
checkEngine.verifyAntVersion();
} catch (CheckToolException e) {
- System.out.println("*** Error: " + e.getMessage());
+ println("*** Error: " + e.getMessage());
}
}
@@ -65,7 +63,7 @@
try {
checkEngine.verifyPythonVersion();
} catch (CheckToolException e) {
- System.out.println("*** Error: " + e.getMessage());
+ println("*** Error: " + e.getMessage());
}
}
@@ -81,16 +79,14 @@
/**
* Method loads the configuration details from the given file.
*
- * @param configFile
- * is the configuration file to be loaded.
+ * @param configFile is the configuration file to be loaded.
*/
private void loadConfiguration(String configFile) {
try {
configuration = new Properties();
configuration.load(new FileInputStream(configFile));
} catch (IOException th) {
- System.out.println("Error occured while loading config file: "
- + configFile);
+ println("Error occured while loading config file: " + configFile);
System.exit(-1);
}
}
@@ -98,8 +94,7 @@
/**
* Main method to trigger tool check.
*
- * @param args
- * contains command line arguments passed.
+ * @param args contains command line arguments passed.
* @throws Exception
*/
public static void main(String[] args) throws Exception {
@@ -108,29 +103,31 @@
// check for configuration file
if (args.length == 2 && args[0].equalsIgnoreCase("-config")) {
- if (args[1] == null
- || (args[1] != null && args[1].trim().isEmpty())) {
- System.out.println("*** Error: Parameter '-config' not set for HeliumToolsCheckerMain");
+ if (args[1] == null || (args[1] != null && args[1].trim().isEmpty())) {
+ println("*** Error: Parameter '-config' not set for HeliumToolsCheckerMain");
System.exit(-1);
}
configFile = args[1];
}
if (configFile != null) {
- HeliumToolsCheckerMain checkerMain = new HeliumToolsCheckerMain(
- configFile);
+ HeliumToolsCheckerMain checkerMain = new HeliumToolsCheckerMain(configFile);
checkerMain.checkAnt();
checkerMain.checkPython();
if (checkerMain.checkFailed()) {
System.exit(-1);
}
- } else {
- System.out.println("*** Error: Missing '-config' argument for HeliumToolsCheckerMain");
- System.out
- .println("Usage: java [main-class-name] -config [location of configuration file]");
- System.out
- .println("Example: java com.nokia.helium.checktools.HeliumToolsCheckerMain -config \"config/helium.basic.tools.config\"");
+ }
+ else {
+ println("*** Error: Missing '-config' argument for HeliumToolsCheckerMain");
+ println("Usage: java [main-class-name] -config [location of configuration file]");
+ println("Example: java com.nokia.helium.checktools.HeliumToolsCheckerMain -config \"config/helium.basic.tools.config\"");
System.exit(-1);
}
}
+
+ @SuppressWarnings("PMD.SystemPrintln")
+ public static void println(String text) {
+ System.out.println(text);
+ }
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/OSResolver.java
--- a/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/OSResolver.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/OSResolver.java Mon Sep 13 13:11:19 2010 +0800
@@ -48,7 +48,7 @@
* is the command to be formatted.
* @return the formatted OS specific command string.
*/
- public static String getCommand(String cmd) {
+ public static String getCommand(String cmd) throws CheckToolException {
StringBuffer buffer = new StringBuffer();
if (isOs("windows")) {
if (!isOs("win9x")) {
@@ -71,7 +71,7 @@
* The OS family
* @return true if the OS matches; otherwise false.
*/
- public static boolean isOs(String family) {
+ public static boolean isOs(String family) throws CheckToolException {
boolean retValue = false;
if (family != null) {
// windows probing logic relies on the word 'windows' in
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/ToolChecker.java
--- a/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/ToolChecker.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/checktools/src/com/nokia/helium/checktools/ToolChecker.java Mon Sep 13 13:11:19 2010 +0800
@@ -38,7 +38,7 @@
* is the message to be displayed on failure.
*/
public void verifyIsExpectedToolVersionConfigured(String expVersion,
- String errorMsg) {
+ String errorMsg) throws CheckToolException {
if (expVersion == null
|| (expVersion != null && expVersion.trim().isEmpty())) {
raiseError(errorMsg);
@@ -58,16 +58,17 @@
* is the message to be displayed on failure.
*/
public void verifyToolVersion(String command, String expVersion,
- String versionString2match, String errorMsg) {
+ String versionString2match, String errorMsg) throws CheckToolException {
String[] versions = expVersion.split(",");
String installedVersion = getInstalledToolVersion(command);
boolean valid = false;
for (String expver : versions) {
- if (!valid)
+ if (!valid) {
valid = installedVersion.contains(versionString2match + expver);
+ }
}
if (!valid) {
- System.out.println("Installed Version : " + installedVersion);
+ HeliumToolsCheckerMain.println("Installed Version : " + installedVersion);
raiseError(errorMsg);
}
}
@@ -78,7 +79,7 @@
* @param message
* is the failure message.
*/
- public void raiseError(String message) {
+ public void raiseError(String message) throws CheckToolException {
incrementErrorCount();
throw new CheckToolException(message);
}
@@ -90,7 +91,7 @@
* is the command string to execute.
* @return the actual tool version.
*/
- public String getInstalledToolVersion(String cmd) {
+ public String getInstalledToolVersion(String cmd) throws CheckToolException {
String input = null;
String error = null;
try {
@@ -129,10 +130,12 @@
versionString = os.toString();
} finally {
try {
- if (os != null)
+ if (os != null) {
os.close();
- if (is != null)
+ }
+ if (is != null) {
is.close();
+ }
} catch (IOException e) {
e = null; // ignore the exception
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/checktools/tests/src/com/nokia/helium/checktools/tests/TestCheckEngine.java
--- a/buildframework/helium/sf/java/checktools/tests/src/com/nokia/helium/checktools/tests/TestCheckEngine.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/checktools/tests/src/com/nokia/helium/checktools/tests/TestCheckEngine.java Mon Sep 13 13:11:19 2010 +0800
@@ -53,7 +53,7 @@
/**
* Method tests the ant version with valid version set.
*/
- public void testVerifyAntVersionValid() {
+ public void testVerifyAntVersionValid() throws CheckToolException {
CheckToolException cte = null;
Properties props = new Properties();
String str = new ToolChecker().getInstalledToolVersion(OSResolver
@@ -73,7 +73,7 @@
/**
* Method tests the python version with invalid version set.
*/
- public void testVerifyPythonVersionInValid() {
+ public void testVerifyPythonVersionInValid() throws CheckToolException {
CheckToolException cte = null;
Properties props = new Properties();
props.setProperty("python.version", "0.0.0.0");
@@ -91,7 +91,7 @@
/**
* Method tests the python version with valid version set.
*/
- public void testVerifyPythonVersionValid() {
+ public void testVerifyPythonVersionValid() throws CheckToolException {
CheckToolException cte = null;
Properties props = new Properties();
String str = new ToolChecker().getInstalledToolVersion(OSResolver
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/checktools/tests/src/com/nokia/helium/checktools/tests/TestOSResolver.java
--- a/buildframework/helium/sf/java/checktools/tests/src/com/nokia/helium/checktools/tests/TestOSResolver.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/checktools/tests/src/com/nokia/helium/checktools/tests/TestOSResolver.java Mon Sep 13 13:11:19 2010 +0800
@@ -31,8 +31,9 @@
/**
* Method to test getCommand.
+ * @throws CheckToolException
*/
- public void testGetCommand() {
+ public void testGetCommand() throws CheckToolException {
String result = OSResolver.getCommand("test");
String osName = System.getProperty("os.name").toLowerCase(Locale.US);
boolean isWindows = osName.indexOf("windows") > -1;
@@ -50,7 +51,7 @@
/**
* Method to test whether the given os is of Windows family or not.
*/
- public void testIsOSWindowsFamily() {
+ public void testIsOSWindowsFamily() throws CheckToolException {
String osName = System.getProperty("os.name").toLowerCase(Locale.US);
boolean isWindows = osName.indexOf("windows") > -1;
boolean result = OSResolver.isOs("windows");
@@ -64,7 +65,7 @@
/**
* Method to test whether the given os is of unix family or not.
*/
- public void testIsOSUnixFamily() {
+ public void testIsOSUnixFamily() throws CheckToolException {
String osName = System.getProperty("os.name").toLowerCase(Locale.US);
String pathSeparator = System.getProperty("path.separator");
boolean isUnix = pathSeparator.equals(":")
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/EmailDataSender.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/EmailDataSender.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/EmailDataSender.java Mon Sep 13 13:11:19 2010 +0800
@@ -19,20 +19,27 @@
import java.util.Arrays;
import java.util.Properties;
-import java.util.Hashtable;
import java.util.zip.GZIPOutputStream;
import java.io.BufferedInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
-import javax.mail.*;
-import javax.mail.internet.*;
-import javax.naming.*;
-import javax.naming.directory.*;
+
+import javax.mail.BodyPart;
+import javax.mail.Message;
+import javax.mail.MessagingException;
+import javax.mail.Session;
+import javax.mail.Transport;
+import javax.mail.internet.InternetAddress;
+import javax.mail.internet.MimeBodyPart;
+import javax.mail.internet.MimeMessage;
+import javax.mail.internet.MimeMultipart;
import javax.activation.DataHandler;
import javax.mail.util.ByteArrayDataSource;
+import javax.mail.internet.AddressException;
+
import org.apache.log4j.Logger;
import org.apache.commons.io.FileUtils;
@@ -46,7 +53,7 @@
// Address email is sent from
private String from;
-
+
// The target address
private String[] toAddressList;
@@ -57,18 +64,15 @@
// Configured smtp server address
private String smtpServerAddress;
+
/**
- * Constructor
- *
- * @param String
- * comma separeted email recepients list
- * @param String
- * smtp server
- * @param String
- * ldap server
- */
- public EmailDataSender(String toStrings, String smtpServer,
- String ldapAddress) {
+ * Constructor
+ *
+ * @param String comma separeted email recepients list
+ * @param String smtp server
+ * @param String ldap server
+ */
+ public EmailDataSender(String toStrings, String smtpServer, String ldapAddress) {
if (toStrings != null) {
String[] splitList = toStrings.split(",");
toAddressList = splitList;
@@ -76,152 +80,128 @@
smtpServerAddress = smtpServer;
ldapURL = ldapAddress;
}
+
/**
- * Constructor
- *
- * @param String
- * email recepient list in array
- * @param String
- * smtp server
- * @param String
- * ldap server
- */
- public EmailDataSender(String[] toList, String smtpServer,
- String ldapAddress) {
+ * Constructor
+ *
+ * @param String email recepient list in array
+ * @param String smtp server
+ * @param String ldap server
+ */
+ public EmailDataSender(String[] toList, String smtpServer, String ldapAddress) {
toAddressList = toList;
smtpServerAddress = smtpServer;
ldapURL = ldapAddress;
}
+
/**
- * Constructor
- *
- * @param String
- * email recepients list in array
- * @param String
- * smtp server
- * @param String
- * ldap server
- * @param String
- * root domain in ldap server
- */
- public EmailDataSender(String[] toList, String smtpServer,
- String ldapAddress, String rootdn) {
+ * Constructor
+ *
+ * @param String email recepients list in array
+ * @param String smtp server
+ * @param String ldap server
+ * @param String root domain in ldap server
+ */
+ public EmailDataSender(String[] toList, String smtpServer, String ldapAddress, String rootdn) {
toAddressList = toList;
smtpServerAddress = smtpServer;
ldapURL = ldapAddress;
this.rootdn = rootdn;
}
+
/**
- * Set sender address.
- *
- * @param String
- * mail sender address
- */
+ * Set sender address.
+ *
+ * @param String mail sender address
+ */
public void setFrom(String from) {
this.from = from;
}
+
/**
- * Add current user to recipient list.
- *
- */
- public void addCurrentUserToAddressList() {
+ * Add current user to recipient list.
+ *
+ */
+ public void addCurrentUserToAddressList() throws EmailSendException {
// Create an empty array if needed
- if (toAddressList == null)
+ if (toAddressList == null) {
toAddressList = new String[0];
+ }
try {
- String userEmail;
- userEmail = getUserEmail();
- toAddressList = Arrays.copyOf(toAddressList,
- toAddressList.length + 1);
- toAddressList[toAddressList.length - 1] = userEmail;
- } catch (javax.mail.internet.AddressException e) {
- return; //does this so that it passes checkstyle and builds
- } catch (javax.naming.NamingException e) {
- return; //without it build complains that errors are thrown and not caught
- //methods are used else where and are caught and exercised.
+ String[] tmpToAddressList = Arrays.copyOf(toAddressList, toAddressList.length + 1);
+ tmpToAddressList[tmpToAddressList.length - 1] = getUserEmail();
+ toAddressList = tmpToAddressList;
+ } catch (LDAPException ex) {
+ throw new EmailSendException(ex.getMessage(), ex);
}
}
+
/**
- * Get recipient address list.
- *
- * @return
- * Recipient address list.
- */
+ * Get recipient address list.
+ *
+ * @return Recipient address list.
+ */
private InternetAddress[] getToAddressList() {
int toListLength = 0;
- if (toAddressList != null)
+ if (toAddressList != null) {
toListLength = toAddressList.length;
+ }
InternetAddress[] addressList = new InternetAddress[toListLength];
try {
- log.debug("getToAddressList:length: "
- + toListLength);
+ log.debug("getToAddressList:length: " + toListLength);
for (int i = 0; i < toListLength; i++) {
- log.debug("getToAddressList:address:"
- + toAddressList[i]);
+ log.debug("getToAddressList:address:" + toAddressList[i]);
addressList[i] = new InternetAddress(toAddressList[i]);
}
- } catch (javax.mail.internet.AddressException aex) {
+ }
+ catch (AddressException aex) {
log.error("AddressException: " + aex);
}
return addressList;
}
+
/**
- * Send xml data without compression
- *
- * @param String
- * purpose of this email
- * @param String
- * file to send
- * @param String
- * mime type
- * @param String
- * subject of email
- * @param String
- * header of email
- */
- public void sendData(String purpose, String fileToSend, String mimeType,
- String subject, String header) {
+ * Send xml data without compression
+ *
+ * @param String purpose of this email
+ * @param String file to send
+ * @param String mime type
+ * @param String subject of email
+ * @param String header of email
+ */
+ public void sendData(String purpose, File fileToSend, String mimeType,
+ String subject, String header) throws EmailSendException {
sendData(purpose, fileToSend, mimeType, subject, header, false);
}
-
/**
- * Sending the XML data(compressed) through email.
- *
- * @param String
- * purpose of this email
- * @param String
- * file to send
- * @param String
- * subject of email
- * @param String
- * header of email
- */
- public void compresseAndSendData(String purpose, String fileToSend,
- String subject, String header) {
+ * Sending the XML data(compressed) through email.
+ *
+ * @param String purpose of this email
+ * @param String file to send
+ * @param String subject of email
+ * @param String header of email
+ */
+ public void compresseAndSendData(String purpose, File fileToSend,
+ String subject, String header) throws EmailSendException {
sendData(purpose, fileToSend, null, subject, header, true);
}
+
/**
- * Send xml data
- *
- * @param String
- * purpose of this email
- * @param String
- * file to send
- * @param String
- * mime type
- * @param String
- * subject of email
- * @param String
- * header of mail
- * @param boolean
- * compress data if true
- */
- public void sendData(String purpose, String fileToSend, String mimeType,
- String subject, String header, boolean compressData) {
+ * Send xml data
+ *
+ * @param String purpose of this email
+ * @param String file to send
+ * @param String mime type
+ * @param String subject of email
+ * @param String header of mail
+ * @param boolean compress data if true
+ */
+ public void sendData(String purpose, File fileToSend, String mimeType,
+ String subject, String header, boolean compressData) throws EmailSendException {
try {
log.debug("sendData:Send file: " + fileToSend + " and mimetype: " + mimeType);
- if (fileToSend != null) {
+ if (fileToSend != null && fileToSend.exists()) {
InternetAddress[] toAddresses = getToAddressList();
Properties props = new Properties();
if (smtpServerAddress != null) {
@@ -230,27 +210,22 @@
}
Session mailSession = Session.getDefaultInstance(props, null);
MimeMessage message = new MimeMessage(mailSession);
- String subjectToSend = subject;
- if (subject == null) {
- subjectToSend = "";
- }
- message.setSubject(subjectToSend);
+ message.setSubject(subject == null ? "" : subject);
MimeMultipart multipart = new MimeMultipart("related");
BodyPart messageBodyPart = new MimeBodyPart();
ByteArrayDataSource dataSrc = null;
- String fileName = new File(fileToSend).getName();
+ String fileName = fileToSend.getName();
if (compressData) {
log.debug("Sending compressed data");
dataSrc = compressFile(fileToSend);
dataSrc.setName(fileName + ".gz");
messageBodyPart.setFileName(fileName + ".gz");
- } else {
+ }
+ else {
log.debug("Sending uncompressed data:");
- dataSrc = new ByteArrayDataSource(new FileInputStream(
- new File(fileToSend)), mimeType);
+ dataSrc = new ByteArrayDataSource(new FileInputStream(fileToSend), mimeType);
- message.setContent(FileUtils.readFileToString(new File(
- fileToSend)), "text/html");
+ message.setContent(FileUtils.readFileToString(fileToSend), "text/html");
multipart = null;
}
String headerToSend = null;
@@ -266,113 +241,82 @@
message.setContent(multipart);
}
try {
- InternetAddress fromAddress = getFromAddress();
- message.setFrom(fromAddress);
- } catch (HlmAntLibException e) {
- // We are Ignoring the errors as no need to fail the build.
- log.debug("Error retrieving current user email address: " + e.getMessage(), e);
- } catch (javax.mail.internet.AddressException e) {
- // We are Ignoring the errors as no need to fail the build.
- log.debug("Error retrieving current user email address: " + e.getMessage(), e);
- } catch (javax.naming.NamingException e) {
- // We are Ignoring the errors as no need to fail the build.
- log.debug("Error retrieving current user email address: " + e.getMessage(), e);
+ message.setFrom(getFromAddress());
+ }
+ catch (AddressException e) {
+ throw new EmailSendException("Error retrieving the from address: " + e.getMessage(), e);
+ } catch (LDAPException e) {
+ throw new EmailSendException("Error retrieving the from address: " + e.getMessage(), e);
}
message.addRecipients(Message.RecipientType.TO, toAddresses);
log.info("Sending email alert: " + subject);
Transport.send(message);
}
- } catch (javax.mail.MessagingException e) {
- String errorMessage = e.getMessage();
+ } catch (MessagingException e) {
String fullErrorMessage = "Failed sending e-mail: " + purpose;
- if (errorMessage != null) {
- fullErrorMessage += " " + errorMessage;
+ if (e.getMessage() != null) {
+ fullErrorMessage += ": " + e.getMessage();
}
- } catch (java.io.IOException e) {
- String errorMessage = e.getMessage();
+ throw new EmailSendException(fullErrorMessage, e);
+ } catch (IOException e) {
String fullErrorMessage = "Failed sending e-mail: " + purpose;
- if (errorMessage != null) {
- fullErrorMessage += " " + errorMessage;
+ if (e.getMessage() != null) {
+ fullErrorMessage += ": " + e.getMessage();
}
// We are Ignoring the errors as no need to fail the build.
- log.info(fullErrorMessage);
+ throw new EmailSendException(fullErrorMessage, e);
}
}
/**
* GZipping a string.
*
- * @param data
- * the content to be gzipped.
- * @param filename
- * the name for the file.
+ * @param data the content to be gzipped.
+ * @param filename the name for the file.
* @return a ByteArrayDataSource.
*/
- protected ByteArrayDataSource compressFile(String fileName)
- throws IOException {
+ protected ByteArrayDataSource compressFile(File fileName) throws IOException {
ByteArrayOutputStream out = new ByteArrayOutputStream();
GZIPOutputStream gz = new GZIPOutputStream(out);
- BufferedInputStream bufferedInputStream = new BufferedInputStream(
- new FileInputStream(new File(fileName)));
+ BufferedInputStream bufferedInputStream = new BufferedInputStream(new FileInputStream(fileName));
byte[] dataBuffer = new byte[512];
while ((bufferedInputStream.read(dataBuffer)) != -1) {
gz.write(dataBuffer);
}
gz.close();
bufferedInputStream.close();
- ByteArrayDataSource dataSrc = new ByteArrayDataSource(
- out.toByteArray(), "application/x-gzip");
+ ByteArrayDataSource dataSrc = new ByteArrayDataSource(out.toByteArray(), "application/x-gzip");
return dataSrc;
}
+
/**
- * Get sender address.
- *
- * @return
- * sender address.
- */
- private InternetAddress getFromAddress() throws javax.mail.internet.AddressException, javax.naming.NamingException {
+ * Get sender address.
+ *
+ * @return sender address.
+ * @throws AddressException
+ * @throws LDAPException
+ */
+ private InternetAddress getFromAddress() throws AddressException, LDAPException {
if (from != null) {
return new InternetAddress(from);
}
return new InternetAddress(getUserEmail());
}
-
+
/**
* Getting user email.
*
- * @return
- * the user email address.
+ * @return the user email address.
*/
- protected String getUserEmail() throws javax.mail.internet.AddressException, javax.naming.NamingException {
- String username = System.getProperty("user.name");
- log.debug("EmailDataSender:getUserEmail:username: " + username);
-
- // Set up environment for creating initial context
- Hashtable env = new Hashtable(11);
- env.put(Context.INITIAL_CONTEXT_FACTORY,
- "com.sun.jndi.ldap.LdapCtxFactory");
- env.put(Context.PROVIDER_URL, ldapURL + "/" + rootdn);
-
- // Create initial context
- DirContext ctx = new InitialDirContext(env);
- SearchControls controls = new SearchControls();
- controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
- try {
- NamingEnumeration en = ctx.search("", "uid=" + username, controls);
- if (en.hasMore()) {
- SearchResult sr = en.next();
- if (sr.getAttributes().get("mail") != null) {
- String email = (String) sr.getAttributes().get("mail").get();
- log.debug("getUserEmail:" + email);
- return email;
- }
+ protected String getUserEmail() throws LDAPException {
+ if (ldapURL != null) {
+ LDAPHelper helper = new LDAPHelper(this.ldapURL, this.rootdn);
+ String email = helper.getUserAttributeAsString(LDAPHelper.EMAIL_ATTRIBUTE_NAME);
+ if (email == null) {
+ throw new LDAPException("Could not find email for current user. (" + System.getProperty("user.name") + ")");
}
- } catch (javax.naming.NameNotFoundException ex) {
- throw new HlmAntLibException("Error finding user email for " + username );
+ return email;
}
- throw new HlmAntLibException("Could not find user email in LDAP.");
+ throw new LDAPException("LDAP url is not defined.");
}
}
-
-
-
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/EmailSendException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/EmailSendException.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2010-2011 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.core;
+
+/**
+ * Email sending exception handling class
+ */
+public class EmailSendException extends Exception {
+
+ private static final long serialVersionUID = 7997902958106522082L;
+
+ /**
+ * Constructor
+ *
+ * @param String
+ * exception message
+ */
+ public EmailSendException(String exception) {
+ super(exception);
+ }
+
+ public EmailSendException(String exception, Throwable cause) {
+ super(exception, cause);
+ }
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/HlmAntLibException.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/HlmAntLibException.java Mon Sep 06 09:57:24 2010 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,48 +0,0 @@
-/*
- * 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.core;
-
-/**
- * HlmAntlib exception handling class
- */
-public class HlmAntLibException extends RuntimeException {
-
- private static final long serialVersionUID = -2504337723465536053L;
-
- /**
- * Constructor
- *
- * @param String
- * exception message
- */
- public HlmAntLibException(String msg) {
- super("HlmAntLibException:generic:" + msg);
- }
-
- /**
- * Constructor
- *
- * @param String
- * module which throws the exception
- * @param String
- * exception message
- */
- public HlmAntLibException(String module, String msg) {
- super("HlmAntLibException:" + module + ":" + msg);
- }
-}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/LDAPException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/LDAPException.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2010-2011 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.core;
+
+/**
+ * Exception occuring during LDAP search.
+ *
+ */
+public class LDAPException extends Exception {
+
+ private static final long serialVersionUID = -4843665216704377558L;
+
+ /**
+ * Create an exception with a message.
+ * @param message the error message
+ */
+ public LDAPException(String message) {
+ super(message);
+ }
+
+ /**
+ * Create an exception with a message and a root cause.
+ * @param message the error message
+ * @param cause the root cause
+ */
+ public LDAPException(String message, Throwable cause) {
+ super(message, cause);
+ }
+}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/LDAPHelper.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/LDAPHelper.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2010-2011 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.core;
+
+import java.util.Hashtable;
+
+import javax.naming.Context;
+import javax.naming.NameNotFoundException;
+import javax.naming.NamingEnumeration;
+import javax.naming.NamingException;
+import javax.naming.directory.DirContext;
+import javax.naming.directory.InitialDirContext;
+import javax.naming.directory.SearchControls;
+import javax.naming.directory.SearchResult;
+
+/**
+ * Simpler LDAP interface to retrieve user base attribute.
+ *
+ */
+public class LDAPHelper {
+ public static final String EMAIL_ATTRIBUTE_NAME = "mail";
+ private String ldapURL;
+ private String rootdn;
+
+ /**
+ * Construct a LDAP helper for a specific server.
+ * @param ldapURL the ldap url (e.g: ldap://server:389)
+ * @param rootdn the rootdn value.
+ */
+ public LDAPHelper(String ldapURL, String rootdn) {
+ if (ldapURL == null) {
+ throw new IllegalArgumentException("The ldap server url cannot be null.");
+ }
+ if (rootdn == null) {
+ throw new IllegalArgumentException("The rootdn cannot be null.");
+ }
+ this.ldapURL = ldapURL;
+ this.rootdn = rootdn;
+ }
+
+ /**
+ * Get the value of the LDAP attribute for a filter.
+ * @param filter the filter to search for
+ * @param attribute the attribute name.
+ * @return the value of the attribute as a string., if the value is not a String then it is
+ * stringify using toString. Returns null if not found.
+ * @throws LDAPException
+ */
+ public String getAttributeAsString(String filter, String attribute) throws LDAPException {
+ if (filter == null) {
+ throw new IllegalArgumentException("filter cannot be null.");
+ }
+ if (attribute == null) {
+ throw new IllegalArgumentException("attribute cannot be null.");
+ }
+ // Set up environment for creating initial context
+ Hashtable env = new Hashtable(11);
+ env.put(Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.ldap.LdapCtxFactory");
+ env.put(Context.PROVIDER_URL, ldapURL + "/" + rootdn);
+
+ // Create initial context
+ try {
+ DirContext ctx = new InitialDirContext(env);
+ SearchControls controls = new SearchControls();
+ controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
+ NamingEnumeration en = ctx.search("", filter, controls);
+ if (en.hasMore()) {
+ SearchResult sr = en.next();
+ if (sr.getAttributes().get(attribute) != null) {
+ Object value = sr.getAttributes().get(attribute).get();
+ if (value instanceof String) {
+ return (String)value;
+ } else {
+ return value.toString();
+ }
+ }
+ }
+ } catch (NameNotFoundException ex) {
+ throw new LDAPException("Could not find " + filter + " attribute " + attribute + " in LDAP: " + ex.getMessage(), ex);
+ } catch (NamingException ex) {
+ throw new LDAPException("Could not find " + filter + " attribute " + attribute + " in LDAP: " + ex.getMessage(), ex);
+ }
+ return null;
+ }
+
+ /**
+ * Get the value of the LDAP attribute for current user. (based on user.name).
+ * @param attribute the attribute name.
+ * @return the value of the attribute as a string., if the value is not a String then it is
+ * stringify using toString. Returns null if not found.
+ * @throws LDAPException
+ */
+ public String getUserAttributeAsString(String attribute) throws LDAPException {
+ return getUserAttributeAsString(System.getProperty("user.name"), attribute);
+ }
+
+ /**
+ * Get the value of the LDAP attribute for username.
+ * @param username the user to search for
+ * @param attribute the attribute name.
+ * @return the value of the attribute as a string., if the value is not a String then it is
+ * stringify using toString. Returns null if not found.
+ * @throws LDAPException
+ */
+ public String getUserAttributeAsString(String username, String attribute) throws LDAPException {
+ return getAttributeAsString("uid=" + username, attribute);
+ }
+
+}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/LogSource.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/LogSource.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/LogSource.java Mon Sep 13 13:11:19 2010 +0800
@@ -28,9 +28,9 @@
*/
public class LogSource extends DataType {
- public File getFilename() {
+ public File getFilename() throws LogSourceException {
//will be implemented by subclasses
- throw new HlmAntLibException("Improper logsource usage");
+ throw new LogSourceException("Improper logsource usage");
}
}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/LogSourceException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/LogSourceException.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2010-2011 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.core;
+
+/**
+ * LogSource exception handling class
+ */
+public class LogSourceException extends Exception {
+
+
+ /**
+ * Constructor
+ *
+ * @param String
+ * exception message
+ */
+ public LogSourceException(String exception) {
+ super(exception);
+ }
+
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/MessageCreationException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/MessageCreationException.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,36 @@
+/*
+* 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.core;
+
+/**
+ * Exception class for Messagecreation implementation
+ *
+ */
+public class MessageCreationException extends Exception {
+
+ /**
+ * Constructor
+ *
+ * @exception - exception to be processed.
+ */
+
+ public MessageCreationException(String exception) {
+ super("Message Creation Error: " + exception);
+ }
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/MultiCauseBuildException.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/MultiCauseBuildException.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,164 @@
+/*
+ * 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.core;
+
+import java.io.PrintStream;
+import java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Vector;
+
+import org.apache.tools.ant.BuildException;
+
+/**
+ * A MultiCauseBuildException class used by the HeliumExecutor plugin to store
+ * the failures caused in the course of a build.
+ *
+ */
+public class MultiCauseBuildException extends BuildException {
+
+ private static final long serialVersionUID = -4843675216704377447L;
+
+ private Vector causes = new Vector();
+
+ /**
+ * Construct a new multicause build exception with no detail message and no
+ * cause.
+ */
+ public MultiCauseBuildException() {
+ super();
+ }
+
+ /**
+ * Construct a new multi-cause build exception with the given detail message
+ * and no cause.
+ *
+ * @param msg
+ * Detail message.
+ */
+ public MultiCauseBuildException(String msg) {
+ super(msg);
+ }
+
+ /**
+ * Construct a new multi-cause build exception with no detail message and
+ * the given cause.
+ *
+ * @param cause
+ * the cause of failure.
+ */
+ public MultiCauseBuildException(Throwable cause) {
+ super();
+ causes.add(cause);
+ }
+
+ /**
+ * Construct a new multi-cause exception with the given detail message and
+ * the given cause.
+ *
+ * @param msg
+ * Detail message.
+ * @param cause
+ * the cause of failure
+ *
+ */
+ public MultiCauseBuildException(String msg, Throwable cause) {
+ super(msg);
+ causes.add(cause);
+ }
+
+ /**
+ * Method adds the given throwable instance.
+ *
+ * @param th
+ * the throwbale instance to be added.
+ */
+ public void add(Throwable th) {
+ causes.add(th);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public StackTraceElement[] getStackTrace() {
+ List stackTraceElements = new ArrayList();
+ for (Throwable th : causes) {
+ stackTraceElements.addAll(Arrays.asList(th.getStackTrace()));
+ }
+ return stackTraceElements
+ .toArray(new StackTraceElement[stackTraceElements.size()]);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void printStackTrace(PrintStream ps) {
+ synchronized (ps) {
+ super.printStackTrace(ps);
+ int i = 1;
+ for (Throwable cause : causes) {
+ ps.printf("MultiCauseBuildException caused by [%d]: ", i++);
+ cause.printStackTrace(ps);
+ }
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void printStackTrace(PrintWriter pw) {
+ synchronized (pw) {
+ super.printStackTrace(pw);
+ int i = 1;
+ for (Throwable cause : causes) {
+ pw.printf("MultiCauseBuildException caused by [%d]: ", i++);
+ cause.printStackTrace(pw);
+ }
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public String getMessage() {
+ String message = super.getMessage();
+ for (Throwable th : causes) {
+ if (message == null) {
+ message = th.getMessage();
+ } else {
+ message += "\n" + th.getMessage();
+ }
+ }
+ return message;
+ }
+
+ /**
+ * Returns the location of the error and the error message.
+ *
+ * @return the location of the error and the error message
+ */
+ public String toString() {
+ StringBuffer buffer = new StringBuffer();
+ for (Throwable th : causes) {
+ buffer.append(th);
+ buffer.append("\n");
+ }
+ return buffer.toString();
+ }
+
+}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/PPHash.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/PPHash.java Mon Sep 06 09:57:24 2010 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,151 +0,0 @@
-/*
-* 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.core;
-
-import java.io.File;
-import java.util.HashMap;
-import java.util.Map;
-
-import freemarker.template.ObjectWrapper;
-import freemarker.template.SimpleCollection;
-import freemarker.template.SimpleScalar;
-import freemarker.template.TemplateCollectionModel;
-import freemarker.template.TemplateHashModelEx;
-import freemarker.template.TemplateModel;
-import fmpp.Engine;
-import fmpp.models.AddTransform;
-import fmpp.models.ClearTransform;
-import fmpp.models.CopyWritableVariableMethod;
-import fmpp.models.NewWritableHashMethod;
-import fmpp.models.NewWritableSequenceMethod;
-import fmpp.models.RemoveTransform;
-import fmpp.models.SetTransform;
-
-/**
- * Downgraded implementation which makes the PPHash public (from FMPP).
- */
-public class PPHash implements TemplateHashModelEx {
- private Map map = new HashMap();
-
- /**
- * Constructor
- *
- */
- public PPHash() {
- // transforms
- put("set", new SetTransform());
- put("add", new AddTransform());
- put("remove", new RemoveTransform());
- put("clear", new ClearTransform());
-
- // methods
- put("newWritableSequence", new NewWritableSequenceMethod());
- put("newWritableHash", new NewWritableHashMethod());
- put("copyWritable", new CopyWritableVariableMethod());
-
- // constants
- put("slash", File.separator);
- put("version", Engine.getVersionNumber());
- put("freemarkerVersion", Engine.getFreeMarkerVersionNumber());
-
- }
- /**
- * Get number of templates.
- *
- * @return
- * Number of templates.
- */
- public int size() {
- return map.size();
- }
-
- /**
- * Get templates.
- *
- * @return
- * templates.
- */
- public TemplateCollectionModel keys() {
- return new SimpleCollection(map.keySet(), ObjectWrapper.SIMPLE_WRAPPER);
- }
-
- /**
- * Get template values.
- *
- * @return
- * template values.
- */
- public TemplateCollectionModel values() {
- return new SimpleCollection(map.values(), ObjectWrapper.SIMPLE_WRAPPER);
- }
-
- /**
- * Get a template.
- *
- * @param String
- * key for template
- * @return
- * a template.
- */
- public TemplateModel get(String key) {
- return map.get(key);
- }
-
- /**
- * Check if there are any template.
- *
- * @return
- * True if no template.
- */
- public boolean isEmpty() {
- return map.isEmpty();
- }
- /**
- * Add template
- *
- * @param String
- * name of template
- * @param TemplateModel
- * value
- */
- public void put(String name, TemplateModel value) {
- map.put(name, value);
- }
- /**
- * Add template
- *
- * @param String
- * name of template
- * @param String
- * value
- */
- public void put(String name, String value) {
- map.put(name, new SimpleScalar(value));
- }
-
- /**
- * Delete template
- *
- * @param String
- * name of template
- */
- public void remove(String name) {
- map.remove(name);
- }
-}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/PPInputSource.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/PPInputSource.java Mon Sep 06 09:57:24 2010 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,47 +0,0 @@
-/*
-* 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.core;
-/**
- * Template source.
- */
-public class PPInputSource implements TemplateInputSource {
-
- private String name = "pp";
-
- /**
- * Get source name
- *
- * @return
- * name of source
- */
- @Override
- public String getSourceName() {
- return name;
- }
-
- /**
- * Get hash
- *
- * @return
- * hash
- */
- public PPHash getPPHash() {
- return new PPHash();
- }
-}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/TemplateProcessor.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/TemplateProcessor.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/TemplateProcessor.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,16 +17,17 @@
package com.nokia.helium.core;
-import freemarker.template.Template;
-import freemarker.template.Configuration;
-
+import java.io.File;
import java.io.FileWriter;
-import java.io.File;
+import java.util.HashMap;
import java.util.List;
-import java.util.HashMap;
import java.util.Map;
+
import org.apache.log4j.Logger;
+import freemarker.template.Configuration;
+import freemarker.template.Template;
+
/**
* Template processor.
*
@@ -61,10 +62,6 @@
PropertiesSource propSource = (PropertiesSource) source;
templateMap.put(propSource.getSourceName(), propSource
.getProperties());
- } else if (source instanceof PPInputSource) {
- PPInputSource ppSource = (PPInputSource) source;
- templateMap.put(ppSource.getSourceName(), ppSource
- .getPPHash());
}
}
} catch (java.io.IOException e) {
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HeliumExecutor.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HeliumExecutor.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HeliumExecutor.java Mon Sep 13 13:11:19 2010 +0800
@@ -14,262 +14,283 @@
* Description:
*
*/
-
package com.nokia.helium.core.ant;
-import java.util.StringTokenizer;
-import java.util.Vector;
-import java.util.Enumeration;
-import java.util.List;
-import java.io.BufferedReader;
-import java.io.FileWriter;
-import java.io.InputStream;
import java.io.File;
import java.io.IOException;
-import java.io.InputStreamReader;
-import java.net.JarURLConnection;
+import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
-
-import org.apache.tools.ant.taskdefs.ImportTask;
-import org.apache.tools.ant.helper.DefaultExecutor;
-import org.apache.tools.ant.Project;
-import org.apache.tools.ant.BuildException;
-import org.apache.tools.ant.Target;
-import org.apache.tools.ant.Location;
-import com.nokia.helium.core.ant.types.*;
-
-import java.util.HashMap;
+import java.util.Enumeration;
+import java.util.Hashtable;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
-import org.apache.log4j.Logger;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.BuildListener;
+import org.apache.tools.ant.BuildLogger;
+import org.apache.tools.ant.Project;
+import org.apache.tools.ant.ProjectHelper;
+import org.apache.tools.ant.helper.DefaultExecutor;
+
+import com.nokia.helium.core.MultiCauseBuildException;
+import com.nokia.helium.core.ant.types.HlmDefList;
/**
* This class implements a flexible Ant Executor which allows dynamic discovery
* and automatic loading of new features. It also supports pre/post actions to
* be executed.
+ *
*/
public class HeliumExecutor extends DefaultExecutor {
- private HashMap> preOperations = new HashMap>();
- private HashMap> postOperations = new HashMap>();
- private HashMap> exceptionHandlers = new HashMap>();
- private Project project;
- private Logger log = Logger.getLogger(HeliumExecutor.class);
+
+ private static final String HELP_TARGET = "help";
+
+ private List hlmDefCache = new ArrayList();
+ private MultiCauseBuildException failure;
/**
- * Override the default Ant executor.
+ * Execute the specified Targets for the specified Project.
*
* @param project
- * Object of the project
+ * the Ant Project.
* @param targetNames
- * Array of target names to execute
- *
+ * String[] of Target names.
+ * @throws BuildException
+ * on error
*/
public void executeTargets(Project project, String[] targetNames) {
- this.project = project;
- log.debug("Running executeTargets");
- BuildException failure = null;
- try {
- loadModules(project);
- doOperations(preOperations, project, targetNames);
- super.executeTargets(project, targetNames);
- } catch (BuildException e) {
- // Saving current issue
- // We are Ignoring the errors as no need to fail the build.
- failure = e;
+ if (targetNames.length > 1 && targetNames[0].equals(HELP_TARGET)) {
+ displayHelp(project, targetNames);
+ } else {
+ executeRegularTargets(project, targetNames);
}
+ }
+ /**
+ * Execute the given targets.
+ *
+ * @param project
+ * is the ant project
+ * @param targetNames
+ * array of target names to be executed.
+ */
+ public void executeRegularTargets(Project project, String[] targetNames) {
+ project.log("Running executeTargets", Project.MSG_DEBUG);
+ loadModules(project);
+ handlePreBuildActions(project, targetNames);
try {
- doOperations(postOperations, project, targetNames);
- } catch (BuildException e) {
- // Treating possible new issues...
- if (failure != null) {
- failure = new BuildException(e.toString() + failure.toString());
- } else {
- failure = e;
- }
- }
- // Propagating any raised issues.
- if (failure != null) {
- handleExceptions(project, failure);
- throw failure;
+ super.executeTargets(project, targetNames);
+ } catch (BuildException be) {
+ recordFailure(be);
+ } finally {
+ handlePostBuildActions(project, targetNames);
+ // Propagating any raised issues.
+ handleException(project);
}
}
/**
- * Loading all the discovered modules.
+ * Method loads all the available helium modules from the system classpath.
*
- * @param module
- * @param prj
+ * @param project
+ * is the ant project.
*/
- private void loadModules(Project prj) {
- List moduleList = loadAvailableModules();
- for (File moduleName : moduleList) {
- loadModule(moduleName, prj);
+ @SuppressWarnings("unchecked")
+ private void loadModules(Project project) {
+ try {
+ List modules = getAvailableModules();
+ project.log("Total no of modules available : " + modules.size(), Project.MSG_DEBUG);
+ for (URL module : modules) {
+ loadModule(project, module);
+ }
+ Map references = (Hashtable)project.getReferences();
+ for (String key : references.keySet()) {
+ Object refObj = references.get(key);
+ if (refObj instanceof HlmDefList) {
+ hlmDefCache.add((HlmDefList)refObj);
+ project.log("Total pre build actions : "
+ + ((HlmDefList)refObj).getPreBuildActions().size(), Project.MSG_DEBUG);
+ project.log("Total post build actions : "
+ + ((HlmDefList)refObj).getPostBuildActions().size(), Project.MSG_DEBUG);
+ project.log("Total exception handlers : "
+ + ((HlmDefList)refObj).getExceptionHandlers().size(), Project.MSG_DEBUG);
+ }
+ }
+ } catch (BuildException be) {
+ recordFailure(be);
}
}
/**
- * Load a specific module.
+ * Returns a list of available helium modules from the system classpath.
*
- * @param moduleLib
- * @param prj
+ * @return a list of helium module files.
*/
- private void loadModule(File moduleLib, Project prj) {
- String file = getHlmAntLibFile(moduleLib);
- if (file == null) {
- return;
- }
- log.debug("Loading " + moduleLib.getName());
- ImportTask task = new ImportTask();
- Target target = new Target();
- target.setName("");
- target.setProject(prj);
- task.setOwningTarget(target);
- task.setLocation(new Location(file));
- task.setFile(file);
- task.setProject(prj);
- task.execute();
- String moduleName = getModuleName(moduleLib);
- Object refObject = prj.getReference(moduleName + ".list");
-
- if (refObject == null) {
- log.debug(moduleName + ".list not found");
+ private List getAvailableModules() {
+ List moduleList = new ArrayList();
+ String classpathString = System.getProperty("java.class.path");
+ String[] modules = classpathString.split(File.pathSeparator);
+ File module = null;
+ URL url = null;
+ for (String moduleName : modules) {
+ module = new File(moduleName);
+ if (module != null && module.isFile()
+ && module.getName().endsWith(".jar")) {
+ try {
+ String hlmAntlibXmlFile = findHeliumAntlibXml(new JarFile(
+ module));
+ if (hlmAntlibXmlFile != null) {
+ url = new URL("jar:" + module.toURI().toString() + "!/"
+ + hlmAntlibXmlFile);
+ moduleList.add(url);
+ }
+ } catch (MalformedURLException me) {
+ throw new BuildException(
+ "Error occured while getting helium module "
+ + module + " : ", me);
+ } catch (IOException ioe) {
+ throw new BuildException("Error reading file " + module
+ + ": " + ioe.getMessage(), ioe);
+ }
+ }
}
- if (refObject != null && refObject instanceof HlmDefList) {
- HlmDefList defList = (HlmDefList) refObject;
- Vector tempDefList = new Vector(
- defList.getPreDefList());
- if (tempDefList != null) {
- preOperations.put(moduleName, tempDefList);
- }
- Vector tempPostDefList = new Vector(
- defList.getPostDefList());
- if (tempPostDefList != null) {
- postOperations.put(moduleName, tempPostDefList);
- }
- Vector tempExceptionDefList = defList
- .getExceptionHandlerList();
- if (tempExceptionDefList != null) {
- exceptionHandlers.put(moduleName, tempExceptionDefList);
- }
- log.debug("loadModule:pre-opsize: "
- + preOperations.size());
- log.debug("loadModule:post-opsize: "
- + postOperations.size());
- log.debug("loadModule:exception-opsize: "
- + exceptionHandlers.size());
- log.debug("Checking " + moduleLib);
- }
+ return moduleList;
}
/**
* Search for helium.antlib.xml under the module Jar.
*
- * @param moduleLib
- * @return
- * @throws IOException
+ * @param jarFile
+ * is the jar to be searched in.
+ * @return the helium.antlib.xml
*/
- protected URL findHeliumAntlibXml(File moduleLib) throws IOException {
- JarFile jarFile = new JarFile(moduleLib);
- Enumeration jee = jarFile.entries();
- while (jee.hasMoreElements()) {
- JarEntry je = jee.nextElement();
+ private String findHeliumAntlibXml(JarFile jarFile) {
+ String hlmAntlibXmlFile = null;
+ for (Enumeration jarEntries = jarFile.entries(); jarEntries
+ .hasMoreElements();) {
+ JarEntry je = jarEntries.nextElement();
if (je.getName().endsWith("/helium.antlib.xml")) {
- return new URL("jar:" + moduleLib.toURI().toString() + "!/"
- + je.getName());
+ hlmAntlibXmlFile = je.getName();
+ break;
}
}
- return null;
+ return hlmAntlibXmlFile;
}
/**
- * Retrieve the found helium.antlib.xml. TODO improve if possible without
- * extracting the file.
+ * Method loads the specified module .
*
- * @param moduleLib
- * @return
+ * @param project
+ * is the ant project.
+ * @param module
+ * the helium module to be loaded.
*/
- private String getHlmAntLibFile(File moduleLib) {
- log.debug("[HeliumExecutor] Checking " + moduleLib);
- try {
- URL url = findHeliumAntlibXml(moduleLib);
- if (url == null)
- return null;
- log.debug("Getting " + url);
-
- JarURLConnection jarConnection = (JarURLConnection) url
- .openConnection();
- JarEntry jarEntry = jarConnection.getJarEntry();
- JarFile jarFile = new JarFile(moduleLib);
- InputStream is = jarFile.getInputStream(jarEntry);
- InputStreamReader isr = new InputStreamReader(is);
- BufferedReader reader = new BufferedReader(isr);
- File file = File.createTempFile("helium", "antlib.xml");
- file.deleteOnExit();
- FileWriter writer = new FileWriter(file);
- String line;
- while ((line = reader.readLine()) != null) {
- writer.write(line + "\n");
- }
- writer.close();
- reader.close();
- log.debug("Temp file " + file.getAbsolutePath());
- return file.getAbsolutePath();
- } catch (IOException ex) {
- log.error("Error: " + ex.getMessage(), ex);
- return null;
- }
+ private void loadModule(Project project, URL module) {
+ project.log("Loading module : " + module.toString(), Project.MSG_DEBUG);
+ ProjectHelper helper = (ProjectHelper) project
+ .getReference(ProjectHelper.PROJECTHELPER_REFERENCE);
+ helper.parse(project, module);
}
- private void doOperations(
- HashMap> operations, Project prj,
- String[] targetNames) {
- log.debug("doOperations: start");
- for (String moduleName : operations.keySet()) {
- log.debug("doOperations: module: " + moduleName);
- for (HlmDefinition definition : operations.get(moduleName)) {
- definition.execute(prj, moduleName, targetNames);
+ /**
+ * Method handles all the pre build events.
+ *
+ * @param project
+ * is the ant project.
+ * @param targets
+ * an array of target names.
+ */
+ private void handlePreBuildActions(Project project, String[] targets) {
+ for (HlmDefList hlmDefList : hlmDefCache) {
+ for (PreBuildAction event : hlmDefList.getPreBuildActions()) {
+ try {
+ event.executeOnPreBuild(project, targets);
+ } catch (BuildException be) {
+ // Saving current issue
+ // We are Ignoring the errors as no need to fail the build.
+ recordFailure(be);
+ }
}
}
}
- private void handleExceptions(Project prj, Exception e) {
- for (String moduleName : this.exceptionHandlers.keySet()) {
- log.debug("handleExceptions: module: " + moduleName);
- for (HlmExceptionHandler exceptionHandler : this.exceptionHandlers
- .get(moduleName)) {
- exceptionHandler.handleException(prj, moduleName, e);
+ /**
+ * Method handles all the post build events.
+ *
+ * @param project
+ * is the ant project.
+ * @param targets
+ * an array of target names.
+ */
+ private void handlePostBuildActions(Project project, String[] targets) {
+ for (HlmDefList hlmDefList : hlmDefCache) {
+ for (PostBuildAction event : hlmDefList.getPostBuildActions()) {
+ try {
+ event.executeOnPostBuild(project, targets);
+ } catch (BuildException be) {
+ // Treating possible new issues...
+ recordFailure(be);
+ }
}
}
}
- private String getModuleName(File moduleLib) {
- String name = moduleLib.getName();
- name = name.substring(0, name.lastIndexOf('.'));
- // The module name can ends with a version
- if (name.matches("(\\w|-)+-\\d+(\\.\\d+)+")) {
- name = name.substring(0, name.lastIndexOf('-'));
+ /**
+ * Records a build failure.
+ *
+ * @param be
+ * a build failure.
+ */
+ private void recordFailure(BuildException be) {
+ if (failure == null) {
+ failure = new MultiCauseBuildException();
}
- return name;
+ failure.add(be);
}
- private List loadAvailableModules() {
- List moduleList = new ArrayList();
- String classpathString = System.getProperty("java.class.path");
- StringTokenizer tokenizier = new StringTokenizer(classpathString,
- File.pathSeparator);
- String token;
- while (tokenizier.hasMoreTokens()) {
- token = (String) tokenizier.nextToken();
- if (new File(token).isFile() && token.endsWith(".jar")) {
- moduleList.add(new File(token));
+ /**
+ * Method handles the recored build failures if any.
+ *
+ * @param project
+ * is the ant project.
+ */
+ private void handleException(Project project) {
+ if (failure != null) {
+ for (HlmDefList hlmDefList : hlmDefCache) {
+ for (HlmExceptionHandler handler : hlmDefList
+ .getExceptionHandlers()) {
+ try {
+ handler.handleException(project, failure);
+ } catch (BuildException be) {
+ // Treating possible new issues...
+ recordFailure(be);
+ }
+ }
+ }
+ throw failure;
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ private void displayHelp(Project project, String[] targetNames) {
+ if (targetNames.length > 1) {
+ project.setProperty("help.item", targetNames[1]);
+ }
+ // Set Emacs mode to true for all listeners, so that help text does
+ // not have [echo] at the start of each line
+ Iterator iter = project.getBuildListeners().iterator();
+ while (iter.hasNext()) {
+ BuildListener listener = iter.next();
+ if (listener instanceof BuildLogger) {
+ BuildLogger logger = (BuildLogger) listener;
+ logger.setEmacsMode(true);
}
}
- return moduleList;
+ // Run the 'help' target
+ project.executeTarget(HELP_TARGET);
}
-
- protected Project getProject() {
- return project;
- }
-}
\ No newline at end of file
+}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HlmDefinition.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HlmDefinition.java Mon Sep 06 09:57:24 2010 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,35 +0,0 @@
-/*
-* 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.core.ant;
-
-import org.apache.tools.ant.Project;
-
-/**
- * This interface defines the API of an HeliumExecutor task.
- */
-public interface HlmDefinition {
-
- /**
- * This method will implement the action to be performed by the
- * HeliumExecutor plugin.
- * @param prj
- * @param module
- */
- void execute(Project prj, String module, String[] targetNames);
-}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HlmExceptionHandler.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HlmExceptionHandler.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/HlmExceptionHandler.java Mon Sep 13 13:11:19 2010 +0800
@@ -1,36 +1,35 @@
/*
-* 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:
-*
-*/
-
+ * 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.core.ant;
import org.apache.tools.ant.Project;
/**
- * This interface defines the API of an HeliumExecutor task.
+ * This interface defines the API of an HeliumExecutor task and is used for
+ * exception handling in helium.
*/
public interface HlmExceptionHandler {
-
+
/**
- * This method will implement the action to be performed by the
- * HeliumExecutor plugin.
- * @param project
- * @param module
- * @param exception
+ * Method handles the given exception.
+ *
+ * @param project is the ant project.
+ * @param exception is the exception to be handled.
*/
- void handleException(Project project, String module, Exception exception);
+ void handleException(Project project, Exception exception);
}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/Message.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/Message.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,36 @@
+/*
+* 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.core.ant;
+
+import java.io.InputStream;
+import com.nokia.helium.core.MessageCreationException;
+
+/**
+ * Interface describing the method a Message must implements.
+ *
+ */
+public interface Message {
+
+ /**
+ * Get an InputStream on the serialize the message
+ * @return an InputStream
+ * @throws MessageCreationException happens in case of serialization error.
+ */
+ InputStream getInputStream() throws MessageCreationException;
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/PostBuildAction.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/PostBuildAction.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,38 @@
+/*
+* 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.core.ant;
+
+import org.apache.tools.ant.Project;
+
+/**
+ * This interface defines the API of an HeliumExecutor task. The Sub classes
+ * performing any post build actions should implement this interface.
+ *
+ */
+public interface PostBuildAction {
+
+ /**
+ * Method executes a post build action.
+ *
+ * @param project
+ * is the ant project.
+ * @param targetNames
+ * an array of target names.
+ */
+ void executeOnPostBuild(Project project, String[] targetNames);
+
+}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/PreBuildAction.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/PreBuildAction.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,37 @@
+/*
+* 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.core.ant;
+
+import org.apache.tools.ant.Project;
+
+/**
+ * This interface defines the API of an HeliumExecutor task. The Sub classes
+ * performing any pre build actions should implement this interface.
+ *
+ */
+public interface PreBuildAction {
+
+ /**
+ * Method executes a pre build action.
+ *
+ * @param project
+ * is the ant project.
+ * @param targetNames
+ * an array of target names.
+ */
+ void executeOnPreBuild(Project project, String[] targetNames);
+}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/antlib.xml
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/antlib.xml Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/antlib.xml Mon Sep 13 13:11:19 2010 +0800
@@ -39,9 +39,13 @@
* Example:
*
@@ -42,23 +43,24 @@
* <hlm:argSet refid="test.variableSet"/>
* </hlm:getVariableValue>
*
+ *
* @ant.task name="getVariableValue"
*/
public class GetValueFromVariableSetTask extends Task {
private String name;
private String property;
private boolean failOnError = true;
-
- private Vector variableMaps = new Vector();
-
+
+ private Vector variableMaps = new Vector();
+
public void setName(String name) {
this.name = name;
}
/**
- * Helper function to set failonerror attribute for the task.
- * @param failStatus, if true will fail the build if no variable is found for
- * matching name.
+ * Helper function to set failonerror attribute for the task.
+ *
+ * @param failStatus, if true will fail the build if no variable is found for matching name.
*/
public void setFailOnError(boolean failStatus) {
failOnError = failStatus;
@@ -66,6 +68,7 @@
/**
* Helper function to store the name of the property where the value to be stored
+ *
* @param property name of the property where the result to be stored
*/
public void setProperty(String property) {
@@ -73,7 +76,8 @@
}
/**
- * Helper function to create the VariableIFImpl object.
+ * Helper function to create the VariableIFImpl object.
+ *
* @return created VariableIFImpl instance
*/
public VariableSet createVariableIFImpl() {
@@ -82,9 +86,9 @@
return var;
}
-
/**
* Helper function to add the newly created variable set. Called by ant.
+ *
* @param vs variable set to be added.
*/
public void add(VariableMap vs) {
@@ -95,23 +99,24 @@
if (variableMaps.isEmpty()) {
throw new BuildException("variable interface cannot be null");
}
- if (variableMaps.size() > 1 ) {
+ if (variableMaps.size() > 1) {
throw new BuildException("maximum one variable interface can be set");
}
return variableMaps.elementAt(0);
}
-
/**
* Task to get the name / value pair
+ *
* @return return the name / value pair for the variable set.
*/
public void execute() {
- if (name == null)
+ if (name == null) {
throw new BuildException("'name' attribute has not been defined.");
- if (property == null)
- throw new BuildException(
- "'property' attribute has not been defined.");
+ }
+ if (property == null) {
+ throw new BuildException("'property' attribute has not been defined.");
+ }
VariableMap variableMap = getVariableInterface();
for (MappedVariable var : variableMap.getVariables()) {
if (var.getName().equals(name)) {
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/LDAPTask.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/LDAPTask.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/LDAPTask.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,11 +17,12 @@
package com.nokia.helium.core.ant.taskdefs;
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
-import org.apache.tools.ant.BuildException;
-import javax.naming.*;
-import javax.naming.directory.*;
-import java.util.Hashtable;
+
+import com.nokia.helium.core.LDAPException;
+import com.nokia.helium.core.LDAPHelper;
/**
* Task is to search data from LDAP server.
@@ -41,43 +42,41 @@
private String filter;
private String key;
private String property;
+ private boolean failOnError = true;
/**
* Method executes current task.
*/
public void execute() {
- if (url == null)
+ if (url == null) {
throw new BuildException("'url' attribute is not defined");
- if (rootdn == null)
+ }
+ if (rootdn == null) {
throw new BuildException("'rootdn' attribute is not defined");
- if (filter == null)
+ }
+ if (filter == null) {
throw new BuildException("'filter' attribute is not defined");
- if (property == null)
+ }
+ if (property == null) {
throw new BuildException("'property' attribute is not defined");
- if (key == null)
+ }
+ if (key == null) {
throw new BuildException("'key' attribute is not defined");
+ }
- // Set up environment for creating initial context
- Hashtable env = new Hashtable();
- env.put(Context.INITIAL_CONTEXT_FACTORY,
- "com.sun.jndi.ldap.LdapCtxFactory");
- env.put(Context.PROVIDER_URL, url + "/" + rootdn);
-
- // Create initial context
try {
- DirContext ctx = new InitialDirContext(env);
- SearchControls controls = new SearchControls();
- controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
- NamingEnumeration en = ctx.search("", filter,
- controls);
- if (en.hasMore()) {
- SearchResult sr = en.next();
- getProject().setProperty(property,
- (String) sr.getAttributes().get(key).get());
- return;
+ LDAPHelper helper = new LDAPHelper(url, rootdn);
+ String value = helper.getAttributeAsString(filter, key);
+ if (value != null) {
+ getProject().setNewProperty(property, value);
+ } else {
+ log("Could not find value for key: " + key, Project.MSG_WARN);
}
- } catch (NamingException exc) {
- throw new BuildException(exc.getMessage());
+ } catch (LDAPException exc) {
+ log(exc.getMessage(), Project.MSG_ERR);
+ if (failOnError) {
+ throw new BuildException(exc.getMessage(), exc);
+ }
}
}
@@ -175,4 +174,14 @@
public void setKey(String key) {
this.key = key;
}
+
+ /**
+ * Defines if the task should fail on error or not found.
+ * @param failOnError
+ * @ant.not-required Default is true
+ */
+ public void setFailOnError(boolean failOnError) {
+ this.failOnError = failOnError;
+ }
+
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/PythonTask.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/PythonTask.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/PythonTask.java Mon Sep 13 13:11:19 2010 +0800
@@ -23,6 +23,7 @@
import java.io.PrintWriter;
import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.ExecTask;
import org.apache.tools.ant.types.Commandline;
@@ -153,11 +154,12 @@
execTask.setOutput(output);
try {
execTask.execute();
- } catch (BuildException t) {
- if (iFailonerror)
- throw new BuildException(t.getMessage());
- else
- log(t.getMessage(), 0); // MSG_ERR=0
+ } catch (BuildException ex) {
+ if (iFailonerror) {
+ throw new BuildException(ex.getMessage(), ex);
+ } else {
+ log(ex.getMessage(), Project.MSG_ERR);
+ }
}
} else if (iText != null) {
// Write the content of the script using Echo task
@@ -188,15 +190,16 @@
if (!fileDeleted && iFailonerror) {
throw new BuildException("Could not delete script file!");
}
- } catch (IOException e) {
+ } catch (IOException ex) {
if (iFailonerror) {
- throw new BuildException(e.getMessage());
+ throw new BuildException(ex.getMessage(), ex);
}
- log("Error while running python task " + e.getMessage());
+ log("Error while running python task: " + ex.getMessage(), Project.MSG_ERR);
} finally {
// make sure we delete the file anyway
- if (tempfile != null)
+ if (tempfile != null) {
tempfile.delete();
+ }
}
}
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/RetryTask.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/RetryTask.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/RetryTask.java Mon Sep 13 13:11:19 2010 +0800
@@ -24,7 +24,7 @@
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.TaskContainer;
-import org.apache.tools.ant.taskdefs.*;
+import org.apache.tools.ant.taskdefs.Sleep;
/**
* Retries the nested task a set number of times
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/SerializePathTask.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/SerializePathTask.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/SerializePathTask.java Mon Sep 13 13:11:19 2010 +0800
@@ -18,12 +18,20 @@
package com.nokia.helium.core.ant.taskdefs;
-import java.io.*;
-import java.util.Vector;
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStreamWriter;
+import java.io.UnsupportedEncodingException;
import java.util.Iterator;
+import java.util.Vector;
+import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
-import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.types.Path;
/**
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/ValidateUserLoginTask.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/ValidateUserLoginTask.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/ValidateUserLoginTask.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,12 +17,21 @@
package com.nokia.helium.core.ant.taskdefs;
-import org.apache.tools.ant.Task;
-import org.apache.tools.ant.Project;
+import java.util.Hashtable;
+
+import javax.naming.Context;
+import javax.naming.NamingEnumeration;
+import javax.naming.NamingException;
+import javax.naming.directory.Attribute;
+import javax.naming.directory.Attributes;
+import javax.naming.directory.DirContext;
+import javax.naming.directory.InitialDirContext;
+import javax.naming.directory.SearchControls;
+import javax.naming.directory.SearchResult;
+
import org.apache.tools.ant.BuildException;
-import javax.naming.*;
-import javax.naming.directory.*;
-import java.util.Hashtable;
+import org.apache.tools.ant.Project;
+import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.condition.Condition;
/**
@@ -61,8 +70,9 @@
public void execute()
{
- if (property == null)
+ if (property == null) {
throw new BuildException("'property' attribute is not defined");
+ }
validateParameters(url, rootdn, filter, key, searchdn, password);
log("Authenticating the user...");
if (authenticateUser(url, searchUser(url, rootdn, filter, key, searchdn))) {
@@ -113,18 +123,24 @@
public void validateParameters(String url, String rootdn, String filter, String key, String searchdn, String password) {
- if (url == null)
+ if (url == null) {
throw new BuildException("'url' attribute is not defined");
- if (rootdn == null)
+ }
+ if (rootdn == null) {
throw new BuildException("'rootdn' attribute is not defined");
- if (filter == null)
+ }
+ if (filter == null) {
throw new BuildException("'filter' attribute is not defined");
- if (key == null)
+ }
+ if (key == null) {
throw new BuildException("'key' attribute is not defined");
- if (searchdn == null)
+ }
+ if (searchdn == null) {
throw new BuildException("'searchdn' attribute is not defined");
- if (password == null)
+ }
+ if (password == null) {
throw new BuildException("'password' attribute is not defined");
+ }
}
public boolean authenticateUser(String ldapurl, String rooTdn) {
@@ -136,7 +152,7 @@
env.put(Context.SECURITY_PRINCIPAL, rooTdn);
env.put(Context.SECURITY_CREDENTIALS, password);
try {
- DirContext authContext = new InitialDirContext(env);
+ DirContext authContext = new InitialDirContext(env); //NOPMD
return true;
} catch (NamingException e) {
// We are Ignoring the errors as no need to fail the build.
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/XMLLogCountTask.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/XMLLogCountTask.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/taskdefs/XMLLogCountTask.java Mon Sep 13 13:11:19 2010 +0800
@@ -21,6 +21,7 @@
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
+
import com.nokia.helium.core.ant.conditions.XMLLogCondition;
/**
@@ -78,8 +79,9 @@
* @throws BuildException
*/
public void execute() {
- if (property == null)
+ if (property == null) {
throw new BuildException("'property' attribute is not defined");
+ }
XMLLogCondition cond = new XMLLogCondition();
cond.setFile(fileName);
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/ConditionType.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/ConditionType.java Mon Sep 06 09:57:24 2010 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,32 +0,0 @@
-/*
-* 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.core.ant.types;
-
-import org.apache.tools.ant.ProjectComponent;
-import org.apache.tools.ant.taskdefs.condition.Condition;
-
-/**
- * Base class for conditions.
- */
-public class ConditionType extends ProjectComponent implements Condition {
-
- public boolean eval() {
- return false;
- }
-}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/FMPPMessage.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/FMPPMessage.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,97 @@
+/*
+* 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.core.ant.types;
+
+import java.io.File;
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.types.DataType;
+import org.apache.log4j.Logger;
+import fmpp.tools.AntTask;
+import fmpp.tools.AntTask.AntAttributeSubstitution;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.FileInputStream;
+import com.nokia.helium.core.MessageCreationException;
+import com.nokia.helium.core.ant.Message;
+
+
+/**
+ * Helper class to store the list of targets to be recorded and to be sent for diamonds.
+ *
+ * Example 1:
+ *
+ * <hlm:fmppMessage target="diamonds" sourceFile="tool.xml.ftl">
+ * <data expandProperties="yes">
+ * ant: antProperties()
+ * </data>
+ * </hlm:fmppMessage>
+ *
+ * @ant.type name="fmppMessage" category="Core"
+ */
+public class FMPPMessage extends DataType implements Message {
+
+ private File outputFile;
+
+ private AntTask task = new AntTask();
+
+ private Logger log = Logger.getLogger(FMPPMessage.class);
+
+ public void setSourceFile(File sourceFile) {
+ if (!sourceFile.exists()) {
+ throw new BuildException("input file : " + sourceFile + " doesn't exists");
+ }
+ task.setSourceFile(sourceFile);
+ }
+
+ public void setFreemarkerLinks(String freemarkerLinks) {
+ task.setFreemarkerLinks(freemarkerLinks);
+ }
+
+ public void addConfiguredData(AntAttributeSubstitution ats) {
+ task.addConfiguredData(ats);
+ }
+
+ public void addConfiguredFreemarkerLinks(AntAttributeSubstitution ats) {
+ task.addConfiguredFreemarkerLinks(ats);
+ }
+ public void setTemplateData(String templateData) {
+ task.setTemplateData(templateData);
+ }
+
+ public InputStream getInputStream() throws MessageCreationException {
+ InputStream stream = null;
+ try {
+ task.setProject(getProject());
+ outputFile = File.createTempFile("fmppmessage", ".xml");
+ outputFile.deleteOnExit();
+ task.setTaskName("fmpp");
+ task.setOutputFile(outputFile);
+ task.execute();
+ log.debug("outputfile in getinputstream: " + outputFile);
+ stream = new FileInputStream(outputFile);
+ } catch (BuildException bex) {
+ throw new MessageCreationException(bex.getMessage());
+ }
+ catch (IOException iex) {
+ throw new MessageCreationException(iex.getMessage());
+ }
+ return stream;
+ }
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/FileMessage.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/FileMessage.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,70 @@
+/*
+* 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.core.ant.types;
+
+import java.io.File;
+import com.nokia.helium.core.MessageCreationException;
+import com.nokia.helium.core.ant.Message;
+
+import org.apache.tools.ant.types.DataType;
+
+import java.io.FileNotFoundException;
+import java.io.InputStream;
+import java.io.FileInputStream;
+
+/**
+ * Helper class to store the list of targets to be recorded and to be sent for diamonds.
+ *
+ * Example 1:
+ *
+ * <hlm:filemessage id="initial-message" file="${build.output.dir}/temp.xml" />
+ *
+ *
+ * @ant.type name="fileMessage" category="Core"
+ */
+public class FileMessage extends DataType implements Message {
+
+ private File file;
+
+ /**
+ * Helper function set file to send as message
+ *
+ * @param inputFile to be sent.
+ */
+ public void setFile(File inputFile) {
+ file = inputFile;
+ }
+
+ /**
+ * Helper function to the stream for the file
+ *
+ * @return stream of the file content
+ */
+ public InputStream getInputStream() throws MessageCreationException {
+ if (file == null) {
+ throw new MessageCreationException("file attribute is not defined at " + this.getLocation().toString());
+ }
+ try {
+ return new FileInputStream(file);
+ } catch (FileNotFoundException ex) {
+ throw new MessageCreationException("file Not found:" + file);
+ }
+ }
+
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmDefList.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmDefList.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmDefList.java Mon Sep 13 13:11:19 2010 +0800
@@ -1,108 +1,85 @@
/*
-* 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:
-*
-*/
-
+ * 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.core.ant.types;
import java.util.Vector;
+
import org.apache.tools.ant.types.DataType;
+
import com.nokia.helium.core.ant.HlmExceptionHandler;
+import com.nokia.helium.core.ant.PostBuildAction;
+import com.nokia.helium.core.ant.PreBuildAction;
/**
+ * HlmDefList is a class used to store the pre/post build events and the
+ * exception handlers.
*
+ * @ant.type name="deflist" category="Core"
*/
public class HlmDefList extends DataType {
- private Vector preDefList = new Vector();
- private Vector postDefList = new Vector();
- private Vector exceptionHandlerList = new Vector();
-
- /**
- * Creates an empty hlm post-action definition and adds it to the list.
- */
- public HlmPreDefImpl createHlmPreDefImpl() {
- HlmPreDefImpl def = new HlmPreDefImpl();
- add(def);
- return (HlmPreDefImpl) def;
- }
+ private Vector preBuildActions = new Vector();
+ private Vector postBuildActions = new Vector();
+ private Vector exceptionHandlers = new Vector();
/**
- * Creates an empty hlm post-action definition and adds it to the list.
+ * Method to add a pre/post build action or an exception handler.
+ *
+ * @param type
+ * is the datatype representing a pre/post build action or an
+ * exception handler.
*/
- public HlmPostDefImpl createHlmPostDefImpl() {
- HlmPostDefImpl def = new HlmPostDefImpl();
- add(def);
- return (HlmPostDefImpl) def;
- }
-
- /**
- * Add a given variable to the list
- *
- * @param var
- * variable to add
- */
- public void add(HlmPreDefImpl definition) {
- if (definition != null) {
- preDefList.add(definition);
+ public void add(DataType type) {
+ if (type instanceof PreBuildAction) {
+ preBuildActions.add((PreBuildAction) type);
+ }
+ if (type instanceof PostBuildAction) {
+ postBuildActions.add((PostBuildAction) type);
+ }
+ if (type instanceof HlmExceptionHandler) {
+ exceptionHandlers.add((HlmExceptionHandler) type);
}
}
/**
- * Add a post-action to the list.
+ * Get the list of pre build actions.
+ *
+ * @return the list of pre build actions.
*/
- public void add(HlmPostDefImpl definition) {
- if (definition != null) {
- postDefList.add(definition);
- }
- }
-
- /**
- * Add a exception handler to the list.
- */
- public void add(HlmExceptionHandler exceptionHandler) {
- if (exceptionHandler != null) {
- exceptionHandlerList.add(exceptionHandler);
- }
+ public Vector getPreBuildActions() {
+ return preBuildActions;
}
/**
- * Get the pre-action list.
+ * Get the list of post build actions.
*
- * @return a vector containing all the pre-actions
+ * @return the list of post build actions.
*/
- public Vector getPreDefList() {
- return preDefList;
+ public Vector getPostBuildActions() {
+ return postBuildActions;
}
/**
- * Get the post-action list.
+ * Get the list of exception handlers.
*
- * @return a vector containing all the post-actions
+ * @return the list of exception handlers
*/
- public Vector getPostDefList() {
- return postDefList;
- }
-
- /**
- * Get the exception handler list.
- *
- * @return a vector containing all the exception handlers
- */
- public Vector getExceptionHandlerList() {
- return exceptionHandlerList;
+ public Vector getExceptionHandlers() {
+ return exceptionHandlers;
}
}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmFinalTargetDef.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmFinalTargetDef.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmFinalTargetDef.java Mon Sep 13 13:11:19 2010 +0800
@@ -1,54 +1,62 @@
/*
-* 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:
-*
-*/
+ * 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.core.ant.types;
+import java.util.Hashtable;
+
+import org.apache.log4j.Logger;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Target;
-import java.util.Hashtable;
-import org.apache.log4j.Logger;
+import org.apache.tools.ant.types.DataType;
+import com.nokia.helium.core.ant.PostBuildAction;
/**
- * Class to execute the final target as post operation.
+ * Class to execute the final target as post build action.
+ *
+ * @ant.type name="finaltargetdef" category="Core"
*/
-public class HlmFinalTargetDef extends HlmPostDefImpl
-{
+public class HlmFinalTargetDef extends DataType implements PostBuildAction {
private Logger log = Logger.getLogger(HlmFinalTargetDef.class);
-
+
/**
* This post action will execute the final target if any to be executed.
+ *
* @param prj
* @param module
* @param targetNames
*
*/
- public void execute(Project prj, String module, String[] targetNames) {
- String finalTargetName = prj.getProperty("hlm.target.final");
- log.debug("Calling final target" + finalTargetName);
+ @SuppressWarnings("unchecked")
+ public void executeOnPostBuild(Project project, String[] targetNames) {
+ String finalTargetName = project.getProperty("hlm.target.final");
+ log.debug("Calling final target : " + finalTargetName);
if (finalTargetName != null) {
- Hashtable targets = prj.getTargets();
- Target finalTarget = (Target)targets.get(finalTargetName);
+ // verify the target exists.
+ Hashtable targets = project.getTargets();
+ Target finalTarget = (Target) targets.get(finalTargetName);
if (finalTarget == null) {
- log.info("The final target : " + finalTargetName + " not available skipping");
+ log.info("The final target : " + finalTargetName
+ + " not available skipping");
return;
}
- finalTarget.execute();
+ // let's the project execute the target.
+ project.executeTarget(finalTargetName);
}
}
}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmImportDef.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmImportDef.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmImportDef.java Mon Sep 13 13:11:19 2010 +0800
@@ -1,41 +1,43 @@
/*
-* 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:
-*
-*/
-
+ * 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.core.ant.types;
+import java.io.File;
+
import org.apache.log4j.Logger;
-import org.apache.tools.ant.taskdefs.ImportTask;
-import org.apache.tools.ant.Target;
import org.apache.tools.ant.Location;
import org.apache.tools.ant.Project;
+import org.apache.tools.ant.Target;
+import org.apache.tools.ant.taskdefs.ImportTask;
+import org.apache.tools.ant.types.DataType;
-import java.io.File;
+import com.nokia.helium.core.ant.PreBuildAction;
/**
* This class implements an Executor importer pre-action.
*
* @ant.type name="importdef" category="Core"
*/
-public class HlmImportDef extends HlmPreDefImpl {
+public class HlmImportDef extends DataType implements PreBuildAction {
private static Logger log = Logger.getLogger(HlmImportDef.class);
-
- private File file ;
+
+ private File file;
public void setFile(File file) {
this.file = file;
@@ -44,16 +46,17 @@
/**
* Will import the given file.
*/
- public void execute(Project prj, String module, String[] targetNames) {
- log.debug("importdef:prj name" + prj.getName() + ". fileName" + file.toString());
+ public void executeOnPreBuild(Project project, String[] targetNames) {
+ log.debug("importdef:prj name" + project.getName() + ". fileName"
+ + file.toString());
ImportTask task = new ImportTask();
Target target = new Target();
target.setName("");
- target.setProject(prj);
+ target.setProject(project);
task.setOwningTarget(target);
task.setLocation(new Location(file.getAbsolutePath()));
task.setFile(file.toString());
- task.setProject(prj);
+ task.setProject(project);
task.execute();
}
}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmListenerDef.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmListenerDef.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmListenerDef.java Mon Sep 13 13:11:19 2010 +0800
@@ -1,33 +1,36 @@
/*
-* 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:
-*
-*/
-
+ * 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.core.ant.types;
-import org.apache.tools.ant.Project;
+import org.apache.log4j.Logger;
+import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.BuildListener;
-import org.apache.log4j.Logger;
+import org.apache.tools.ant.Project;
+import org.apache.tools.ant.types.DataType;
+
+import com.nokia.helium.core.ant.PreBuildAction;
/**
* This class implements a listener registration action.
*
* @ant.type name="listenerdef" category="Core"
*/
-public class HlmListenerDef extends HlmPreDefImpl {
+public class HlmListenerDef extends DataType implements PreBuildAction {
private String classname;
private Logger log = Logger.getLogger(HlmListenerDef.class);
@@ -39,18 +42,22 @@
/**
* Register given listener to the project.
*/
- public void execute(Project prj, String module, String[] targetNames) {
+ public void executeOnPreBuild(Project project, String[] targetNames) {
try {
Class listenerClass = Class.forName(classname);
BuildListener listener = (BuildListener) listenerClass
.newInstance();
- prj.addBuildListener(listener);
+ project.addBuildListener(listener);
+ log.debug(classname + " is registered");
} catch (ClassNotFoundException ex) {
- log.debug("Class not found exception:" + ex.getMessage(), ex);
+ throw new BuildException("Class not found exception:"
+ + ex.getMessage(), ex);
} catch (InstantiationException ex1) {
- log.debug("Class Instantiation exception:" + ex1.getMessage(), ex1);
+ throw new BuildException("Class Instantiation exception:"
+ + ex1.getMessage(), ex1);
} catch (IllegalAccessException ex1) {
- log.debug("Illegal Class Access exception:" + ex1.getMessage(), ex1);
+ throw new BuildException("Illegal Class Access exception:"
+ + ex1.getMessage(), ex1);
}
}
}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmPostDefImpl.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmPostDefImpl.java Mon Sep 06 09:57:24 2010 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,40 +0,0 @@
-/*
-* 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.core.ant.types;
-
-import org.apache.tools.ant.Project;
-import org.apache.tools.ant.types.DataType;
-import org.apache.log4j.Logger;
-
-import com.nokia.helium.core.ant.HeliumExecutor;
-import com.nokia.helium.core.ant.HlmDefinition;
-
-/**
- * Implement an abstract post-action.
- */
-public class HlmPostDefImpl extends DataType implements HlmDefinition {
- private Logger log = Logger.getLogger(HeliumExecutor.class);
-
- /**
- * Do nothing.
- */
- public void execute(Project prj, String module, String[] targetNames) {
- // Empty method. Implemented by extending classes.
- }
-}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmPreDefImpl.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/HlmPreDefImpl.java Mon Sep 06 09:57:24 2010 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,36 +0,0 @@
-/*
-* 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.core.ant.types;
-
-import org.apache.tools.ant.Project;
-import org.apache.tools.ant.types.DataType;
-
-import com.nokia.helium.core.ant.HlmDefinition;
-
-/**
- * Implement an abstract pre-action.
- */
-public class HlmPreDefImpl extends DataType implements HlmDefinition {
- /**
- * Do nothing.
- */
- public void execute(Project prj, String module, String[] targetNames) {
- // empty will implemented by the sub classes.
- }
-}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/Stage.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/Stage.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,107 @@
+/*
+* 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.core.ant.types;
+
+import org.apache.tools.ant.types.DataType;
+import org.apache.tools.ant.BuildException;
+import org.apache.log4j.Logger;
+
+/**
+ * A Stage is a Data type which stores Stage information.
+ *
+ *
+ * A Stage is defined by setting three attributes name, start and end targets, both should be a
+ * valid target name in the project.
+ *
+ *
+ * Usage:
+ *
+ *
+ * <hlm:stage id="preparation" starttarget="stagetest" endtarget="stagetest"/>
+ *
+ *
+ * @ant.type name="stage" category="Core"
+ *
+ */
+public class Stage extends DataType {
+
+ //Default id is used as the stage name so overriding is possible.
+ private Logger log = Logger.getLogger(Stage.class);
+ private String stageName;
+
+ private String startTarget;
+
+ private String endTarget;
+
+ public void setStageName(String name) {
+ log.debug("stage-name:" + name);
+ if (stageName != null) {
+ throw new BuildException("no supported attribute stageName externally");
+ }
+ stageName = name;
+ }
+
+ public String getStageName() {
+ return stageName;
+ }
+ /**
+ * Returns the stage start target.
+ * @return stage start target name.
+ */
+ public String getStartTarget() {
+ return startTarget;
+ }
+
+ /**
+ * Returns the stage end target.
+ * @return end target name
+ */
+ public String getEndTarget() {
+ return endTarget;
+ }
+
+ /**
+ * Set the starting target.
+ *
+ * @param start is the starting point to set.
+ * @ant.required
+ */
+ public void setStartTarget(String name) {
+ startTarget = name;
+ }
+
+ /**
+ * Set the end target.
+ *
+ * @param end is the end point to set.
+ * @ant.required
+ */
+ public void setEndTarget(String name) {
+ endTarget = name;
+ }
+
+ /** Check is the end target set to current target.
+ *
+ * @param target
+ * @return
+ */
+ public boolean isEndTarget( String target ) {
+ return this.endTarget.equals( target );
+ }
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/TargetMessageTrigger.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/TargetMessageTrigger.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,95 @@
+/*
+* 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.core.ant.types;
+
+import java.util.List;
+
+import org.apache.tools.ant.types.DataType;
+import java.util.ArrayList;
+import com.nokia.helium.core.ant.Message;
+
+/**
+ * Helper class to store the list of targets to be recorded and to be sent for diamonds.
+ *
+ * Example 1:
+ *
+ * <hlm:targetMessageTrigger id="diamonds.id" target="diamonds">
+ * <hlm:fmppMessage>
+ * <converterTask id="tools-conversion" sourceFile="${helium.dir}/tools/common/templates/diamonds/tool.xml.ftl" outputFile="${build.output.dir}/tool.xml">
+ * <data expandProperties="yes">
+ * ant: antProperties()
+ * </data>
+ * </converterTask>
+ * </hlm:fmppMessage>
+ * </hlm:targetMessageTrigger>
+ *
+ * @ant.type name="TargetMessageTrigger" category="Core"
+ */
+
+
+public class TargetMessageTrigger extends DataType {
+
+ private String targetName;
+
+ private boolean condition = true;
+
+ private List messageList = new ArrayList();
+
+ /**
+ * Helper function to add message to the list.
+ *
+ * @param message message to be added to the list
+ */
+ public void add(Message message) {
+ messageList.add(message);
+ }
+
+ public void setCondition(boolean condition) {
+ this.condition = condition;
+ }
+ public boolean isTriggerNeeded() {
+ return condition;
+ }
+ /**
+ * To get the message list to be processed further.
+ *
+ * @return the message list.
+ */
+ public List getMessageList() {
+ return messageList;
+ }
+
+ /**
+ * Sets the target name for which the message to be processed.
+ *
+ * @param name of the target.
+ */
+ public void setTarget(String name) {
+ targetName = name;
+ }
+
+ /**
+ * Helper function to get the target name for which the message is processed.
+ *
+ * @return target name.
+ */
+ public String getTargetName() {
+ return targetName;
+ }
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/TextMessage.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/TextMessage.java Mon Sep 13 13:11:19 2010 +0800
@@ -0,0 +1,74 @@
+/*
+* 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.core.ant.types;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.io.UnsupportedEncodingException;
+
+import org.apache.tools.ant.types.DataType;
+
+import com.nokia.helium.core.MessageCreationException;
+import com.nokia.helium.core.ant.Message;
+
+
+/**
+ * Helper class to store the text message.
+ *
+ * Example 1:
+ *
+ * <hlm:textMessage id="initial-message" text="helloworld" />
+ *
+ * @ant.type name="textMessage" category="Core"
+ */
+public class TextMessage extends DataType implements Message {
+ private String text;
+
+ /**
+ * Helper function to set the text to be sent.
+ *
+ * @param text to be sent.
+ */
+ /**
+ * Helper function to return the contents as stream.
+ *
+ * @return content as input stream.
+ */
+ public InputStream getInputStream() throws MessageCreationException {
+ if (text == null) {
+ throw new MessageCreationException("text attribute is not defined at " + this.getLocation());
+ }
+ try {
+ return new ByteArrayInputStream(text.getBytes("UTF-8"));
+ } catch (UnsupportedEncodingException uex) {
+ throw new MessageCreationException(uex.getMessage());
+ }
+ }
+
+ /**
+ * Text message to send.
+ *
+ * @param text to be sent.
+ * @ant.required
+ */
+ public void setText(String text) {
+ this.text = text;
+ }
+
+}
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/VariableImpl.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/VariableImpl.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/VariableImpl.java Mon Sep 13 13:11:19 2010 +0800
@@ -18,14 +18,14 @@
package com.nokia.helium.core.ant.types;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.List;
+import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.types.DataType;
-import org.apache.tools.ant.BuildException;
-import org.apache.commons.lang.StringUtils;
+import org.codehaus.plexus.util.StringUtils;
import com.nokia.helium.core.ant.MappedVariable;
-import java.util.Arrays;
/**
* Helper class to store the command line variables
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/VariableSet.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/VariableSet.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/ant/types/VariableSet.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,19 +17,18 @@
package com.nokia.helium.core.ant.types;
+import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.types.DataType;
+
import com.nokia.helium.core.ant.MappedVariable;
import com.nokia.helium.core.ant.Variable;
import com.nokia.helium.core.ant.VariableMap;
-
-import org.apache.tools.ant.BuildException;
-import org.apache.tools.ant.types.DataType;
-import java.util.ArrayList;
-
/**
* Helper class to store the variable set (list of variables
* with name / value pair)
@@ -108,8 +107,9 @@
for (Variable variable : variables) {
if (variable instanceof MappedVariable) {
allVariables.put(((MappedVariable)variable).getName(), (MappedVariable)variable);
- } else if (variable instanceof VariableSet)
+ } else if (variable instanceof VariableSet) {
allVariables.putAll(((VariableSet)variable).getVariablesMap());
+ }
}
return allVariables;
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/CommandBase.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/CommandBase.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/CommandBase.java Mon Sep 13 13:11:19 2010 +0800
@@ -1,19 +1,20 @@
/*
-* 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:
-*
-*/
+ * 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.core.plexus;
import java.io.File;
@@ -21,18 +22,17 @@
import java.util.Vector;
import org.apache.log4j.Logger;
-import org.codehaus.plexus.util.Os;
+import org.apache.tools.ant.taskdefs.condition.Os;
import org.codehaus.plexus.util.cli.CommandLineException;
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.codehaus.plexus.util.cli.Commandline;
import org.codehaus.plexus.util.cli.StreamConsumer;
/**
- * This abstract class implements some basic support to execute commands and
- * redirect outputs to StreamConsumer. You can have common stream consumers or
- * execution base streamconsumers. The exception type raised
- * can be controlled by the implementing class.
- *
+ * This abstract class implements some basic support to execute commands and redirect outputs to
+ * StreamConsumer. You can have common stream consumers or execution base streamconsumers. The
+ * exception type raised can be controlled by the implementing class.
+ *
* @param
*/
public abstract class CommandBase {
@@ -42,12 +42,14 @@
/**
* Get the executable name.
+ *
* @return
*/
protected abstract String getExecutable();
/**
* Throw an exception with message and cause.
+ *
* @param message
* @param t
* @throws T
@@ -56,6 +58,7 @@
/**
* Throw an exception with message only.
+ *
* @param message
* @throws T
*/
@@ -64,18 +67,18 @@
}
/**
- * Location where to execute the command. The default location
- * is the current directory.
+ * Location where to execute the command. The default location is the current directory.
+ *
* @return a File object pointing to a directory.
*/
public File getWorkingDir() {
return new File(".");
}
-
+
/**
- * Add a LineHandler to the CommandBase instance.
- * LineHandlers could be used to record/log the output stream
- * command invocation.
+ * Add a LineHandler to the CommandBase instance. LineHandlers could be used to record/log the
+ * output stream command invocation.
+ *
* @param lineHandler a lineHandle instance
*/
public void addOutputLineHandler(StreamConsumer lineHandler) {
@@ -83,11 +86,11 @@
outputHandlers.add(lineHandler);
}
}
-
+
/**
- * Add a LineHandler to the CommandBase instance.
- * LineHandlers could be used to record/log the output error stream
- * command invocation.
+ * Add a LineHandler to the CommandBase instance. LineHandlers could be used to record/log the
+ * output error stream command invocation.
+ *
* @param lineHandler a lineHandle instance
*/
public void addErrorLineHandler(StreamConsumer lineHandler) {
@@ -107,13 +110,11 @@
}
/**
- * Execute the command given by getExecutable with args as list of arguments and custom StreamConsumer.
+ * Execute the command given by getExecutable with args as list of arguments and custom
+ * StreamConsumer.
*
- * @param args
- * an array representing blocks arguments
- * @param output
- * the StreamConsumer to analyze the output with. If null it is
- * ignored.
+ * @param args an array representing blocks arguments
+ * @param output the StreamConsumer to analyze the output with. If null it is ignored.
* @throws T
*/
public void execute(String[] args, StreamConsumer output) throws T {
@@ -121,20 +122,16 @@
}
/**
- * Execute the command given by getExecutable with args as list of arguments and custom StreamConsumer.
- * Also env content will be added to the environment.
+ * Execute the command given by getExecutable with args as list of arguments and custom
+ * StreamConsumer. Also env content will be added to the environment.
*
- * @param args
- * an array representing blocks arguments
- * @param env
- * additional key to add the environment
- * @param output
- * the StreamConsumer to analyze the output with. If null it is
- * ignored.
+ * @param args an array representing blocks arguments
+ * @param env additional key to add the environment
+ * @param output the StreamConsumer to analyze the output with. If null it is ignored.
* @throws T
*/
public void executeCmdLine(String argLine, Map env, StreamConsumer output)
- throws T {
+ throws T {
Commandline cmdLine = new Commandline();
cmdLine.createArg().setValue(getExecutable());
if (argLine != null) {
@@ -143,19 +140,19 @@
executeCmd(cmdLine, env, output);
}
- private void executeCmd(Commandline cmdLine, Map env, StreamConsumer output) throws T {
+ private void executeCmd(Commandline cmdLine, Map env, StreamConsumer output)
+ throws T {
if (env != null) {
for (Map.Entry entry : env.entrySet()) {
cmdLine.addEnvironment(entry.getKey(), entry.getValue());
}
}
cmdLine.setWorkingDirectory(getWorkingDir());
-
+
// This is only needed on windows.
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
- cmdLine.createArg().setLine("&& exit %%ERRORLEVEL%%");
+ cmdLine.createArg().setLine("&& exit %%ERRORLEVEL%%");
}
-
StreamMultiplexer inputMux = new StreamMultiplexer();
if (output != null) {
@@ -173,36 +170,28 @@
}
try {
- int err = CommandLineUtils.executeCommandLine(cmdLine, inputMux,
- errorMux);
+ int err = CommandLineUtils.executeCommandLine(cmdLine, inputMux, errorMux);
// check its exit value
log.debug("Execution of " + getExecutable() + " returned: " + err);
if (err != 0) {
- throwException(errorRecorder.getBuffer() + " (return code: " + err
- + ")");
+ throwException(errorRecorder.getBuffer() + " (return code: " + err + ")");
}
- } catch (CommandLineException e) {
- throwException(
- "Error executing " + getExecutable() + ": "
- + e.toString());
+ }
+ catch (CommandLineException e) {
+ throwException("Error executing " + getExecutable() + ": " + e.toString());
}
}
/**
- * Execute the command given by getExecutable with args as list of arguments and custom StreamConsumer.
- * Also env content will be added to the environment.
+ * Execute the command given by getExecutable with args as list of arguments and custom
+ * StreamConsumer. Also env content will be added to the environment.
*
- * @param args
- * an array representing blocks arguments
- * @param env
- * additional key to add the environment
- * @param output
- * the StreamConsumer to analyze the output with. If null it is
- * ignored.
+ * @param args an array representing blocks arguments
+ * @param env additional key to add the environment
+ * @param output the StreamConsumer to analyze the output with. If null it is ignored.
* @throws T
*/
- public void execute(String[] args, Map env, StreamConsumer output)
- throws T {
+ public void execute(String[] args, Map env, StreamConsumer output) throws T {
Commandline cmdLine = new Commandline();
cmdLine.createArg().setValue(getExecutable());
if (args != null) {
@@ -210,5 +199,5 @@
}
executeCmd(cmdLine, env, output);
}
-
+
}
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/FileStreamConsumer.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/FileStreamConsumer.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/FileStreamConsumer.java Mon Sep 13 13:11:19 2010 +0800
@@ -16,12 +16,12 @@
*/
package com.nokia.helium.core.plexus;
+import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
-import java.io.BufferedWriter;
import org.apache.log4j.Logger;
import org.codehaus.plexus.util.cli.StreamConsumer;
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/StreamMultiplexer.java
--- a/buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/StreamMultiplexer.java Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/StreamMultiplexer.java Mon Sep 13 13:11:19 2010 +0800
@@ -17,6 +17,7 @@
package com.nokia.helium.core.plexus;
import java.util.Vector;
+
import org.codehaus.plexus.util.cli.StreamConsumer;
/**
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/tests/antunit/executor/build.xml
--- a/buildframework/helium/sf/java/core/tests/antunit/executor/build.xml Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/tests/antunit/executor/build.xml Mon Sep 13 13:11:19 2010 +0800
@@ -22,9 +22,14 @@
-->
Helium antlib core executor test config.
+
Running target.
+
+
+ final-target is executed as postbuild action
+
\ No newline at end of file
diff -r 0e65f93be3cb -r ac0bbc1e5d79 buildframework/helium/sf/java/core/tests/antunit/executor/test_executor.ant.xml
--- a/buildframework/helium/sf/java/core/tests/antunit/executor/test_executor.ant.xml Mon Sep 06 09:57:24 2010 +0100
+++ b/buildframework/helium/sf/java/core/tests/antunit/executor/test_executor.ant.xml Mon Sep 13 13:11:19 2010 +0800
@@ -72,12 +72,6 @@
* <emakeEngine id="imaker.ec" /> ** * Emake engine with some custom configuration. - *