scripts/jjb-init-project.py

   1 #!/usr/bin/python
   2
   3 # @License EPL-1.0 <http://spdx.org/licenses/EPL-1.0>
   4 ##############################################################################
   5 # Copyright (c) 2014 The Linux Foundation and others.
   6 #
   7 # All rights reserved. This program and the accompanying materials
   8 # are made available under the terms of the Eclipse Public License v1.0
   9 # which accompanies this distribution, and is available at
  10 # http://www.eclipse.org/legal/epl-v10.html
  11 #
  12 # Contributors:
  13 #   Thanh Ha (The Linux Foundation) - Initial implementation
  14 ##############################################################################
  15
  16 import argparse
  17 import os
  18 import re
  19
  20 parser = argparse.ArgumentParser()
  21 parser.add_argument("project", help="project")
  22 parser.add_argument("-d", "--dependencies",
  23                     help=("Project dependencies\n\n"
  24                           "A comma-seperated (no spaces) list of projects "
  25                           "your project depends on. "
  26                           "This is used to create an integration job that "
  27                           "will trigger when a dependent project-merge job "
  28                           "is built successfully.\n\n"
  29                           "Example: aaa,controller,yangtools"))
  30 parser.add_argument("-t", "--templates", help="Job templates to use")
  31 parser.add_argument("-b", "--branches", help="Git Branches to build")
  32 parser.add_argument("-g", "--mvn-goals", help="Maven Goals")
  33 parser.add_argument("-o", "--mvn-opts", help="Maven Options")
  34 parser.add_argument("-a", "--archive-artifacts",
  35                     help="Comma-seperated list of patterns of artifacts to "
  36                          "archive on build completion. "
  37                          "See: http://ant.apache.org/manual/Types/fileset.html")  # noqa
  38 parser.add_argument("-z", "--no-cfg", action="store_true",
  39                     help=("Disable initializing the project.cfg file."))
  40 args = parser.parse_args()
  41
  42 project = args.project
  43 project_dir = os.path.join("jjb", project)
  44 project_file = os.path.join(project_dir, "%s.yaml" % project)
  45 templates = args.templates  # Defaults to all templates
  46 branches = args.branches    # Defaults to "master,stable/helium" if not passed
  47 mvn_goals = args.mvn_goals  # Defaults to "clean install" if not passsed
  48 mvn_opts = args.mvn_opts    # Defaults to blank if not passed
  49 dependencies = args.dependencies
  50 dependent_jobs = ""
  51 disabled = "true"   # Always disabled unless project has dependencies
  52 email_prefix = "[%s]" % project
  53 archive_artifacts = args.archive_artifacts
  54
  55 # The below 2 variables are used to determine if we should generate a CFG file
  56 # for a project automatically.
  57 #
  58 # no_cfg - is a commandline parameter that can be used by scripts such as the
  59 #          jjb-autoupdate-project script to explicitly disable generating CFG
  60 #          files.
  61 # make_cfg - is a internal variable used to decide if we should try to
  62 #            auto generate the CFG file for a project based on optional
  63 #            variables passed by the user on the commandline.
  64 no_cfg = args.no_cfg
  65 make_cfg = False  # Set to true if we need to generate initial CFG file
  66 cfg_string = []
  67
  68 if not templates:
  69     templates = "verify,merge,daily,integration,sonar"
  70 else:
  71     make_cfg = True
  72     cfg_string.append("JOB_TEMPLATES: %s" % templates)
  73
  74 if not branches:
  75     branches = "master,stable/helium"
  76     sonar_branch = "master"
  77 else:
  78     make_cfg = True
  79     cfg_string.append("BRANCHES: %s" % branches)
  80     # For projects who use a different development branch than master
  81     sonar_branch = branches.split(",")[0]
  82 # Create YAML to list branches to create jobs for
  83 streams = "stream:\n"
  84 for branch in branches.split(","):
  85     streams = streams + ("        - %s:\n"
  86                          "            branch: '%s'\n" %
  87                          (branch.replace('/', '-'),
  88                           branch))
  89
  90 if not mvn_goals:
  91     mvn_goals = ("clean install "
  92                  "-V "  # Show Maven / Java version before building
  93                  "-Dmaven.repo.local=/tmp/r "
  94                  "-Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r ")
  95 else:  # User explicitly set MAVEN_OPTS so create CFG
  96     make_cfg = True
  97     cfg_string.append("MAVEN_GOALS: %s" % mvn_goals)
  98
  99 if not mvn_opts:
 100     mvn_opts = "-Xmx1024m -XX:MaxPermSize=256m"
 101 else:  # User explicitly set MAVEN_OPTS so create CFG
 102     make_cfg = True
 103     cfg_string.append("MAVEN_OPTS: %s" % mvn_opts)
 104
 105 if not dependencies:
 106     dependencies = "odlparent"  # All projects depend on odlparent
 107 if dependencies:
 108     if dependencies.find("odlparent") < 0:  # If odlparent is not listed add it
 109         dependencies = "odlparent," + dependencies
 110     make_cfg = True
 111     disabled = "false"
 112     email_prefix = (email_prefix + " " +
 113                     " ".join(['[%s]' % d for d in dependencies.split(",")]))
 114     dependent_jobs = ",".join(
 115         ['%s-merge-{stream}' % d for d in dependencies.split(",")])
 116     cfg_string.append("DEPENDENCIES: %s" % dependencies)
 117
 118 if not archive_artifacts:
 119     archive_artifacts = ""
 120 else:
 121     cfg_string.append("ARCHIVE: %s" % archive_artifacts)
 122     archive_artifacts = ("- archive-artifacts:\n"
 123                          "            artifacts: '%s'" % archive_artifacts)
 124
 125 ##############################
 126 # Create configuration start #
 127 ##############################
 128
 129 # Create project directory if it doesn't exist
 130 if not os.path.exists(project_dir):
 131     os.makedirs(project_dir)
 132
 133 print("project: %s\n"
 134       "branches: %s\n"
 135       "goals: %s\n"
 136       "options: %s\n"
 137       "dependencies: %s\n"
 138       "artifacts: %s" %
 139       (project,
 140        branches,
 141        mvn_goals,
 142        mvn_opts,
 143        dependencies,
 144        archive_artifacts,))
 145
 146 # Create initial project CFG file
 147 if not no_cfg and make_cfg:
 148     print("Creating %s.cfg file" % project)
 149     cfg_file = os.path.join(project_dir, "%s.cfg" % project)
 150     with open(cfg_file, "w") as outstream:
 151         cfg = "\n".join(cfg_string)
 152         outstream.write(cfg)
 153
 154 # Create initial project YAML file
 155 use_templates = templates.split(",")
 156 use_templates.insert(0, "project")
 157 job_templates_yaml = ""
 158 for t in use_templates:
 159     if t == "project":  # This is not a job type but is used for templating
 160         pass
 161     elif t == "sonar":
 162         job_templates_yaml = job_templates_yaml + \
 163             "        - '%s-%s'\n" % (project, t)
 164     else:
 165         job_templates_yaml = job_templates_yaml + \
 166             "        - '%s-%s-{stream}'\n" % (project, t)
 167 with open(project_file, "w") as outfile:
 168     for t in use_templates:
 169         template_file = "jjb-templates/%s.yaml" % t
 170         with open(template_file, "r") as infile:
 171             for line in infile:
 172                 if not re.match("\s*#", line):
 173                     line = re.sub("JOB_TEMPLATES", job_templates_yaml, line)
 174                     line = re.sub("PROJECT", project, line)
 175                     line = re.sub("DISABLED", disabled, line)
 176                     line = re.sub("STREAMS", streams, line)
 177                     line = re.sub("MAVEN_GOALS", mvn_goals, line)
 178                     line = re.sub("MAVEN_OPTS", mvn_opts, line)
 179                     line = re.sub("DEPENDENCIES", dependent_jobs, line)
 180                     line = re.sub("EMAIL_PREFIX", email_prefix, line)
 181                     line = re.sub("SONAR_BRANCH", sonar_branch, line)
 182                     line = re.sub("ARCHIVE_ARTIFACTS", archive_artifacts, line)
 183                 outfile.write(line)
 184         outfile.write("\n")