docs/jjb/lf-python-jobs.rst

   1 ###########
   2 Python Jobs
   3 ###########
   4
   5 Job Groups
   6 ==========
   7
   8 .. include:: ../job-groups.rst
   9
  10 Below is a list of Maven job groups:
  11
  12 .. literalinclude:: ../../jjb/lf-python-job-groups.yaml
  13    :language: yaml
  14
  15
  16 Macros
  17 ======
  18
  19 lf-infra-clm-python
  20 -------------------
  21
  22 Run CLM scanning against a Python project.
  23
  24 :Required Parameters:
  25
  26     :clm-project-name: Project name in Nexus IQ to send results to.
  27
  28 lf-infra-tox-install
  29 --------------------
  30
  31 Install Tox into a virtualenv.
  32
  33 :Required Parameters:
  34
  35     :python-version: Version of Python to install into the Tox virtualenv.
  36         Eg. python2 / python3
  37
  38 lf-infra-tox-sonar
  39 ------------------
  40
  41 Runs Sonar scanning against a Python project.
  42
  43 :Required Parameters:
  44
  45     :java-version: Version of Java to use to run Sonar.
  46     :mvn-version: Version of Maven to use to run Sonar.
  47
  48 lf-tox-install
  49 --------------
  50
  51 Runs a shell script that installs tox in a Python virtualenv.
  52
  53 :Required Parameters:
  54
  55     :python-version: Base Python version to use in the virtualenv. For example
  56         python2 or python3.
  57
  58
  59 Job Templates
  60 =============
  61
  62 Python XC CLM
  63 -------------
  64
  65 CLM scans for Python based repos. This job will call the Nexus IQ CLI
  66 directly to run the scans.
  67
  68 A new credential named "nexus-iq-xc-clm" needs to exist in the Jenkins credentials.
  69 The credential should contain the username and password to access Nexus
  70 IQ Server.
  71
  72 :Template Names:
  73
  74     - {project-name}-python-clm-{stream}
  75     - gerrit-python-xc-clm
  76     - github-python-xc-clm
  77
  78 :Comment Trigger: run-clm
  79
  80 :Required parameters:
  81
  82     :build-node: The node to run build on.
  83     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
  84         get configured in defaults.yaml)
  85
  86 :Optional parameters:
  87
  88     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  89     :nexus-iq-cli-version: Nexus IQ CLI package version to download and use.
  90         (default: 1.44.0-01)
  91     :nexus-iq-namespace: Insert a namespace to project AppID for projects that
  92         share a Nexus IQ system to avoid project name collision. We recommend
  93         inserting a trailing - dash if using this parameter.
  94         For example 'odl-'. (default: '')
  95     :build-timeout: Timeout in minutes before aborting build. (default: 60)
  96     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  97     :java-version: Version of Java to use for the build. (default: openjdk8)
  98     :stream: Keyword used to represent a release code-name.
  99         Often the same as the branch. (default: master)
 100     :submodule-recursive: Whether to checkout submodules recursively.
 101         (default: true)
 102     :submodule-timeout: Timeout (in minutes) for checkout operation.
 103         (default: 10)
 104     :submodule-disable: Disable submodule checkout operation.
 105         (default: false)
 106     :gerrit_clm_triggers: Override Gerrit Triggers.
 107     :gerrit_trigger_file_paths: Override file paths which used to filter which
 108         file modifications will trigger a build. Refer to JJB documentation for
 109         "file-path" details.
 110         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 111
 112
 113 Python Sonar with Tox
 114 ---------------------
 115
 116 Sonar scans for Python based repos. This job will perform a tox call which
 117 runs the coverage command to gather tests results. These test results get
 118 published back into Sonar after running the Sonar goals.
 119
 120 To get the Sonar coverage results, tox.ini needs to exist and configured
 121 with coverage commands to run.
 122
 123 The coverage commands define the code that gets executed by the test suites.
 124 It does not guarantee that the code tests executed properly, but it will help
 125 pointing out the code that is not tested at all.
 126
 127 For example:
 128
 129 .. code-block:: bash
 130
 131     [testenv:py27]
 132     commands =
 133             coverage run --module pytest --junitxml xunit-results.xml
 134             coverage xml --omit=".tox/py27/*","tests/*"
 135             coverage report --omit=".tox/py27/*","tests/*"
 136
 137 For more details refer to coverage and sonar documentation:
 138
 139 https://coverage.readthedocs.io/
 140
 141 https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import
 142
 143 :Template Names:
 144
 145     - {project-name}-tox-sonar
 146     - gerrit-tox-sonar
 147     - github-tox-sonar
 148
 149 :Comment Trigger: run-sonar
 150
 151 :Required parameters:
 152
 153     :build-node: The node to run build on.
 154     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 155         get configured in defaults.yaml)
 156     :mvn-settings: The name of settings file containing credentials for the project.
 157
 158 :Optional parameters:
 159
 160     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 161     :build-timeout: Timeout in minutes before aborting build. (default: 60)
 162     :cron: Cron schedule when to trigger the job. This parameter also
 163         supports multiline input via YAML pipe | character in cases where
 164         one may want to provide more than 1 cron timer.  (default: H 11 * * *
 165         to run once a day)
 166     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 167     :java-version: Version of Java to use for the build. (default: openjdk8)
 168     :mvn-global-settings: The name of the Maven global settings to use for
 169         Maven configuration. (default: global-settings)
 170     :mvn-version: Version of maven to use. (default: mvn35)
 171     :stream: Keyword used to represent a release code-name.
 172         Often the same as the branch. (default: master)
 173     :submodule-recursive: Whether to checkout submodules recursively.
 174         (default: true)
 175     :submodule-timeout: Timeout (in minutes) for checkout operation.
 176         (default: 10)
 177     :submodule-disable: Disable submodule checkout operation.
 178         (default: false)
 179     :gerrit_sonar_triggers: Override Gerrit Triggers.
 180     :gerrit_trigger_file_paths: Override file paths which used to filter which
 181         file modifications will trigger a build. Refer to JJB documentation for
 182         "file-path" details.
 183         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 184
 185
 186 Tox Verify
 187 ----------
 188
 189 Tox runner to verify a project. This job is pyenv aware so if the image
 190 contains an installation of pyenv at /opt/pyenv it will pick it up and run
 191 Python tests with the appropriate Python versions. This job will set the
 192 following pyenv variables before running.
 193
 194 .. code:: bash
 195
 196    export PYENV_ROOT="/opt/pyenv"
 197    export PATH="$PYENV_ROOT/bin:$PATH"
 198
 199 :Template Names:
 200
 201     - {project-name}-tox-verify-{stream}
 202     - gerrit-tox-verify
 203     - github-tox-verify
 204
 205 :Comment Trigger: recheck|reverify
 206
 207 :Required Parameters:
 208
 209     :build-node: The node to run build on.
 210     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 211         in defaults.yaml)
 212
 213 :Optional Parameters:
 214
 215     :branch: The branch to build against. (default: master)
 216     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 217     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 218     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 219     :python-version: Version of Python to configure as a base in virtualenv.
 220         (default: python3)
 221     :stream: Keyword representing a release code-name.
 222         Often the same as the branch. (default: master)
 223     :submodule-recursive: Whether to checkout submodules recursively.
 224         (default: true)
 225     :submodule-timeout: Timeout (in minutes) for checkout operation.
 226         (default: 10)
 227     :submodule-disable: Disable submodule checkout operation.
 228         (default: false)
 229     :tox-dir: Directory containing the project's tox.ini relative to
 230         the workspace. Empty works if tox.ini is at project root.
 231         (default: '')
 232     :tox-envs: Tox environments to run. If blank run everything described
 233         in tox.ini. (default: '')
 234     :gerrit_trigger_file_paths: Override file paths which used to filter which
 235         file modifications will trigger a build. Refer to JJB documentation for
 236         "file-path" details.
 237         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit