summaryrefslogtreecommitdiffstats
path: root/scripts/BuildHelpers.py
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/BuildHelpers.py')
-rw-r--r--scripts/BuildHelpers.py160
1 files changed, 160 insertions, 0 deletions
diff --git a/scripts/BuildHelpers.py b/scripts/BuildHelpers.py
new file mode 100644
index 0000000000..be21c0f721
--- /dev/null
+++ b/scripts/BuildHelpers.py
@@ -0,0 +1,160 @@
+#coding=UTF-8
+
+## Collection of helpers for Build scripts ##
+
+import sys, argparse, subprocess, platform
+from xml.etree import ElementTree
+from os.path import join, isdir, isfile, basename, exists
+from os import listdir, getcwd, mkdir
+from shutil import copy
+from glob import glob
+
+class VersionObject(object):
+ pass
+
+# Staging repo base url
+repo = "http://oss.sonatype.org/content/repositories/comvaadin-%d"
+
+# Directory where the resulting war files are stored
+# TODO: deploy results
+resultPath = "result"
+
+if not exists(resultPath):
+ mkdir(resultPath)
+elif not isdir(resultPath):
+ print("Result path is not a directory.")
+ sys.exit(1)
+
+args = None
+
+# Parse command line arguments <version> <framework-repo-id> <archetype-repo-id> <plugin-repo-id>
+def parseArgs():
+ # Command line arguments for this script
+ parser = argparse.ArgumentParser(description="Automated staging validation")
+ parser.add_argument("version", type=str, help="Vaadin version to use")
+ parser.add_argument("framework", type=int, help="Framework repo id (comvaadin-XXXX)", nargs='?')
+ parser.add_argument("archetype", type=int, help="Archetype repo id (comvaadin-XXXX)", nargs='?')
+ parser.add_argument("plugin", type=int, help="Maven Plugin repo id (comvaadin-XXXX)", nargs='?')
+
+ # If no args, give help
+ if len(sys.argv) == 1:
+ args = parser.parse_args(["-h"])
+ else:
+ args = parser.parse_args()
+
+ return args
+
+# Function for determining the path for maven executable
+def getMavenCommand():
+ # This method uses .split("\n")[0] which basically chooses the first result where/which returns.
+ # Fixes the case with multiple maven installations available on PATH
+ if platform.system() == "Windows":
+ try:
+ return subprocess.check_output(["where", "mvn.cmd"], universal_newlines=True).split("\n")[0]
+ except:
+ try:
+ return subprocess.check_output(["where", "mvn.bat"], universal_newlines=True).split("\n")[0]
+ except:
+ print("Unable to locate mvn with where. Is the maven executable in your PATH?")
+ else:
+ try:
+ return subprocess.check_output(["which", "mvn"], universal_newlines=True).split("\n")[0]
+ except:
+ print("Unable to locate maven executable with which. Is the maven executable in your PATH?")
+ return None
+
+mavenCmd = getMavenCommand()
+
+# Get command line arguments. Parses arguments if needed.
+def getArgs():
+ global args
+ if args is None:
+ args = parseArgs()
+ return args
+
+# Maven Package and Validation
+def mavenValidate(artifactId, mvnCmd = mavenCmd, logFile = sys.stdout, repoIds = None):
+ if repoIds is None:
+ repoIds = getArgs()
+
+ print("Do maven clean package validate")
+ cmd = [mvnCmd]
+ if hasattr(repoIds, "version") and repoIds.version is not None:
+ cmd.append("-Dvaadin.version=%s" % (repoIds.version))
+ cmd.extend(["clean", "package", "validate"])
+ print("executing: %s" % (" ".join(cmd)))
+ subprocess.check_call(cmd, cwd=join(getcwd(), artifactId), stdout=logFile)
+
+# Collect .war files to given folder with given naming
+def copyWarFiles(artifactId, resultDir = resultPath, name = None):
+ if name is None:
+ name = artifactId
+ warFiles = glob(join(getcwd(), artifactId, "target", "*.war"))
+ warFiles.extend(glob(join(getcwd(), artifactId, "*", "target", "*.war")))
+ for warFile in warFiles:
+ if len(warFiles) == 1:
+ deployName = "%s.war" % (name)
+ else:
+ deployName = "%s-%d.war" % (name, warFiles.index(warFile))
+ print("Copying .war file %s as %s to result folder" % (basename(warFile), deployName))
+ copy(warFile, join(resultDir, "%s" % (deployName)))
+
+# Recursive pom.xml update script
+def updateRepositories(path, repoIds = None, repoUrl = repo):
+ # If versions are not supplied, parse arguments
+ if repoIds is None:
+ repoIds = getArgs()
+
+ # Read pom.xml
+ pomXml = join(path, "pom.xml")
+ if isfile(pomXml):
+ # pom.xml namespace workaround
+ root = ElementTree.parse(pomXml).getroot()
+ nameSpace = root.tag[1:root.tag.index('}')]
+ ElementTree.register_namespace('', nameSpace)
+
+ # Read the pom.xml correctly
+ tree = ElementTree.parse(pomXml)
+
+ # NameSpace needed for finding the repositories node
+ repoNode = tree.getroot().find("{%s}repositories" % (nameSpace))
+ else:
+ return
+
+ if repoNode is not None:
+ print("Add staging repositories to " + pomXml)
+
+ if hasattr(repoIds, "framework") and repoIds.framework is not None:
+ # Add framework staging repository
+ addRepo(repoNode, "repository", "vaadin-%s-staging" % (repoIds.version), repoUrl % (repoIds.framework))
+
+ # Find the correct pluginRepositories node
+ pluginRepo = tree.getroot().find("{%s}pluginRepositories" % (nameSpace))
+ if pluginRepo is None:
+ # Add pluginRepositories node if needed
+ pluginRepo = ElementTree.SubElement(tree.getroot(), "pluginRepositories")
+
+ if hasattr(repoIds, "plugin") and repoIds.plugin is not None:
+ # Add plugin staging repository
+ addRepo(pluginRepo, "pluginRepository", "vaadin-%s-plugin-staging" % (repoIds.version), repoUrl % (repoIds.plugin))
+
+ # Overwrite the modified pom.xml
+ tree.write(pomXml, encoding='UTF-8')
+
+ # Recursive pom.xml search.
+ for i in listdir(path):
+ file = join(path, i)
+ if isdir(file):
+ updateRepositories(join(path, i), repoIds, repoUrl)
+
+# Add a repository of repoType to given repoNode with id and URL
+def addRepo(repoNode, repoType, id, url):
+ newRepo = ElementTree.SubElement(repoNode, repoType)
+ idElem = ElementTree.SubElement(newRepo, "id")
+ idElem.text = id
+ urlElem = ElementTree.SubElement(newRepo, "url")
+ urlElem.text = url
+
+# Get a logfile for given artifact
+def getLogFile(artifact, resultDir = resultPath):
+ return open(join(resultDir, "%s.log" % (artifact)), 'w')