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     :gerrit_clm_triggers: Override Gerrit Triggers.
 103     :gerrit_trigger_file_paths: Override file paths which used to filter which
 104         file modifications will trigger a build. Refer to JJB documentation for
 105         "file-path" details.
 106         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 107
 108
 109 Python Sonar with Tox
 110 ---------------------
 111
 112 Sonar scans for Python based repos. This job will perform a tox call which
 113 runs the coverage command to gather tests results. These test results get
 114 published back into Sonar after running the Sonar goals.
 115
 116 To get the Sonar coverage results, tox.ini needs to exist and configured
 117 with coverage commands to run.
 118
 119 The coverage commands define the code that gets executed by the test suites.
 120 It does not guarantee that the code tests executed properly, but it will help
 121 pointing out the code that is not tested at all.
 122
 123 For example:
 124
 125 .. code-block:: bash
 126
 127     [testenv:py27]
 128     commands =
 129             coverage run --module pytest --junitxml xunit-results.xml
 130             coverage xml --omit=".tox/py27/*","tests/*"
 131             coverage report --omit=".tox/py27/*","tests/*"
 132
 133 For more details refer to coverage and sonar documentation:
 134
 135 https://coverage.readthedocs.io/
 136
 137 https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import
 138
 139 :Template Names:
 140
 141     - {project-name}-tox-sonar
 142     - gerrit-tox-sonar
 143     - github-tox-sonar
 144
 145 :Comment Trigger: run-sonar
 146
 147 :Required parameters:
 148
 149     :build-node: The node to run build on.
 150     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 151         get configured in defaults.yaml)
 152     :mvn-settings: The name of settings file containing credentials for the project.
 153
 154 :Optional parameters:
 155
 156     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 157     :build-timeout: Timeout in minutes before aborting build. (default: 60)
 158     :cron: Cron schedule when to trigger the job. This parameter also
 159         supports multiline input via YAML pipe | character in cases where
 160         one may want to provide more than 1 cron timer.  (default: H 11 * * *
 161         to run once a day)
 162     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 163     :java-version: Version of Java to use for the build. (default: openjdk8)
 164     :mvn-global-settings: The name of the Maven global settings to use for
 165         Maven configuration. (default: global-settings)
 166     :mvn-version: Version of maven to use. (default: mvn35)
 167     :stream: Keyword used to represent a release code-name.
 168         Often the same as the branch. (default: master)
 169     :submodule-recursive: Whether to checkout submodules recursively.
 170         (default: true)
 171     :gerrit_sonar_triggers: Override Gerrit Triggers.
 172     :gerrit_trigger_file_paths: Override file paths which used to filter which
 173         file modifications will trigger a build. Refer to JJB documentation for
 174         "file-path" details.
 175         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 176
 177
 178 Tox Verify
 179 ----------
 180
 181 Tox runner to verify a project. This job is pyenv aware so if the image
 182 contains an installation of pyenv at /opt/pyenv it will pick it up and run
 183 Python tests with the appropriate Python versions. This job will set the
 184 following pyenv variables before running.
 185
 186 .. code:: bash
 187
 188    export PYENV_ROOT="/opt/pyenv"
 189    export PATH="$PYENV_ROOT/bin:$PATH"
 190
 191 :Template Names:
 192
 193     - {project-name}-tox-verify-{stream}
 194     - gerrit-tox-verify
 195     - github-tox-verify
 196
 197 :Comment Trigger: recheck|reverify
 198
 199 :Required Parameters:
 200
 201     :build-node: The node to run build on.
 202     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 203         in defaults.yaml)
 204
 205 :Optional Parameters:
 206
 207     :branch: The branch to build against. (default: master)
 208     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 209     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 210     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 211     :python-version: Version of Python to configure as a base in virtualenv.
 212         (default: python3)
 213     :stream: Keyword representing a release code-name.
 214         Often the same as the branch. (default: master)
 215     :submodule-recursive: Whether to checkout submodules recursively.
 216         (default: true)
 217     :tox-dir: Directory containing the project's tox.ini relative to
 218         the workspace. Empty works if tox.ini is at project root.
 219         (default: '')
 220     :tox-envs: Tox environments to run. If blank run everything described
 221         in tox.ini. (default: '')
 222     :gerrit_trigger_file_paths: Override file paths which used to filter which
 223         file modifications will trigger a build. Refer to JJB documentation for
 224         "file-path" details.
 225         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit