X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-python-jobs.rst;h=175f0e26d55b11c068b905ab227b3c45009fa2b8;hb=5f28702c4a74e49627390ffd108c1beea141a27b;hp=02fff2b377c5acc63485f6786b277eaa066b4d6a;hpb=2069fa3b9c656c59fc93c77bf0ba80a18c0ddc00;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst index 02fff2b3..175f0e26 100644 --- a/docs/jjb/lf-python-jobs.rst +++ b/docs/jjb/lf-python-jobs.rst @@ -5,31 +5,202 @@ Python Jobs Job Groups ========== -{project-name}-python-jobs --------------------------- +.. include:: ../job-groups.rst -Jobs for Python projects using Gerrit. +Below is a list of Maven job groups: -:Includes: +.. literalinclude:: ../../jjb/lf-python-job-groups.yaml + :language: yaml - - gerrit-tox-verify -{project-name}-github-python-jobs ---------------------------------- +Macros +====== -Jobs for Python projects using GitHub. +lf-infra-clm-python +------------------- -:Includes: +Run CLM scanning against a Python project. + +:Required Parameters: + + :clm-project-name: Project name in Nexus IQ to send results to. + +lf-infra-tox-install +-------------------- + +Install Tox into a virtualenv. + +:Required Parameters: + + :python-version: Version of Python to install into the Tox virtualenv. + Eg. python2 / python3 + +lf-tox-install +-------------- + +Runs a shell script that installs tox in a Python virtualenv. + +:Required Parameters: + + :python-version: Base Python version to use in the virtualenv. For example + python2 or python3. - - github-tox-verify Job Templates ============= +Python XC CLM +------------- + +CLM scans for Python based repos. This job will call the Nexus IQ CLI +directly to run the scans. + +A new credential named "nexus-iq-xc-clm" needs to exist in the Jenkins credentials. +The credential should contain the username and password to access Nexus +IQ Server. + +:Template Names: + + - {project-name}-python-clm-{stream} + - gerrit-python-xc-clm + - github-python-xc-clm + +:Comment Trigger: run-clm + +:Required parameters: + + :build-node: The node to run build on. + :jenkins-ssh-credential: Credential to use for SSH. (Generally should + get configured in defaults.yaml) + +:Optional parameters: + + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :nexus-iq-cli-version: Nexus IQ CLI package version to download and use. + (default: 1.44.0-01) + :nexus-iq-namespace: Insert a namespace to project AppID for projects that + share a Nexus IQ system to avoid project name collision. We recommend + inserting a trailing - dash if using this parameter. + For example 'odl-'. (default: '') + :build-timeout: Timeout in minutes before aborting build. (default: 60) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :java-version: Version of Java to use for the build. (default: openjdk8) + :pre-build-script: Shell script to execute before the CLM builder. + For example, install prerequisites or move files to the repo root. + (default: a string with a shell comment) + :stream: Keyword used to represent a release code-name. + Often the same as the branch. (default: master) + :submodule-recursive: Whether to checkout submodules recursively. + (default: true) + :submodule-timeout: Timeout (in minutes) for checkout operation. + (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) + :gerrit_clm_triggers: Override Gerrit Triggers. + :gerrit_trigger_file_paths: Override file paths which used to filter which + file modifications will trigger a build. Refer to JJB documentation for + "file-path" details. + https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + + +Python Sonar with Tox +--------------------- + +Sonar scans for Python based repos. This job invokes tox to run tests and +gather coverage statistics from the test results, then invokes Maven to +publish the results to a Sonar server. + +To get the Sonar coverage results, file tox.ini must exist and contain coverage +commands to run. + +The coverage commands define the code that gets executed by the test suites. +Checking coverage does not guarantee that the tests execute properly, but it +identifies code that is not executed by any test. + +This job reuses the Sonar builder used in Java/Maven projects which runs maven +twice. The first invocation does nothing for Python projects, so the job uses +the goal 'validate' by default. The second invocation publishes results using +the goal 'sonar:sonar' by default. + +For example: + +.. code-block:: bash + + [testenv:py27] + commands = + coverage run --module pytest --junitxml xunit-results.xml + coverage xml --omit=".tox/py27/*","tests/*" + coverage report --omit=".tox/py27/*","tests/*" + +For more details refer to coverage and sonar documentation: + +https://coverage.readthedocs.io/ + +https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import + +:Template Names: + + - {project-name}-tox-sonar + - gerrit-tox-sonar + - github-tox-sonar + +:Comment Trigger: run-sonar + +:Required parameters: + + :build-node: The node to run build on. + :jenkins-ssh-credential: Credential to use for SSH. (Generally should + get configured in defaults.yaml) + :mvn-settings: The name of the settings file with credentials for the project. + +:Optional parameters: + + :branch: Git branch, should be master (default: master) + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :build-timeout: Timeout in minutes before aborting build. (default: 60) + :cron: Cron schedule when to trigger the job. This parameter also + supports multiline input via YAML pipe | character in cases where + one may want to provide more than 1 cron timer. (default: H 11 * * * + to run once a day) + :disable-job: Whether to disable the job (default: false) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :github-url: URL for Github. (default: https://github.com) + :java-version: Version of Java to use for the build. (default: openjdk8) + :mvn-global-settings: The name of the Maven global settings to use for + :mvn-goals: The Maven goal to run first. (default: validate) + :mvn-version: Version of maven to use. (default: mvn35) + :pre-build-script: Shell script to execute before the Sonar builder. + For example, install prerequisites or move files to the repo root. + (default: a string with a comment) + :python-version: Python version (default: python2) + :sonar-mvn-goal: The Maven goal to run the Sonar plugin. (default: sonar:sonar) + :stream: Keyword used to represent a release code-name. + Often the same as the branch. (default: master) + :submodule-recursive: Whether to checkout submodules recursively. + (default: true) + :submodule-timeout: Timeout (in minutes) for checkout operation. + (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) + :gerrit_sonar_triggers: Override Gerrit Triggers. + :gerrit_trigger_file_paths: Override file paths which used to filter which + file modifications will trigger a build. Refer to JJB documentation for + "file-path" details. + https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + + Tox Verify ---------- -Tox runner to verify a project +Tox runner to verify a project on creation of a patch set. +This job is pyenv aware so if the image contains an installation of pyenv +at /opt/pyenv it will pick it up and run Python tests with the appropriate +Python versions. This job will set the following pyenv variables before running. + +.. code:: bash + + export PYENV_ROOT="/opt/pyenv" + export PATH="$PYENV_ROOT/bin:$PATH" :Template Names: @@ -37,24 +208,96 @@ Tox runner to verify a project - gerrit-tox-verify - github-tox-verify +:Comment Trigger: recheck|reverify + :Required Parameters: :build-node: The node to run build on. - :jenkins-ssh-credential: Credential to use for SSH. (Generally should - be configured in defaults.yaml) + :jenkins-ssh-credential: Credential to use for SSH. (Generally set + in defaults.yaml) + +:Optional Parameters: + + :branch: The branch to build against. (default: master) + :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) + :build-timeout: Timeout in minutes before aborting build. (default: 10) + :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) + :pre-build-script: Shell script to execute before the Tox builder. + For example, install prerequisites or move files to the repo root. + (default: a string with a shell comment) + :python-version: Version of Python to configure as a base in virtualenv. + (default: python3) + :stream: Keyword representing a release code-name. + Often the same as the branch. (default: master) + :submodule-recursive: Whether to checkout submodules recursively. + (default: true) + :submodule-timeout: Timeout (in minutes) for checkout operation. + (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) + :tox-dir: Directory containing the project's tox.ini relative to + the workspace. Empty works if tox.ini is at project root. + (default: '') + :tox-envs: Tox environments to run. If blank run everything described + in tox.ini. (default: '') + :gerrit_trigger_file_paths: Override file paths used to filter which + file modifications will trigger a build. Refer to JJB documentation for + "file-path" details. + https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit + + +Tox Merge +--------- + +Tox runner to verify a project after merge of a patch set. +This job is pyenv aware so if the image contains an installation of pyenv +at /opt/pyenv it will pick it up and run Python tests with the appropriate +Python versions. This job will set the following pyenv variables before running. + +.. code:: bash + + export PYENV_ROOT="/opt/pyenv" + export PATH="$PYENV_ROOT/bin:$PATH" + +:Template Names: + + - {project-name}-tox-merge-{stream} + - gerrit-tox-merge + - github-tox-merge + +:Comment Trigger: remerge + +:Required Parameters: + + :build-node: The node to run build on. + :jenkins-ssh-credential: Credential to use for SSH. (Generally set + in defaults.yaml) :Optional Parameters: :branch: The branch to build against. (default: master) :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7) - :build-timeout: Timeout in seconds before aborting build. (default: 10) + :build-timeout: Timeout in minutes before aborting build. (default: 10) :git-url: URL clone project from. (default: $GIT_URL/$PROJECT) - :stream: Keyword that can be used to represent a release code-name. + :pre-build-script: Shell script to execute before the CLM builder. + For example, install prerequisites or move files to the repo root. + (default: a string with only a comment) + :python-version: Version of Python to configure as a base in virtualenv. + (default: python3) + :stream: Keyword representing a release code-name. Often the same as the branch. (default: master) :submodule-recursive: Whether to checkout submodules recursively. (default: true) + :submodule-timeout: Timeout (in minutes) for checkout operation. + (default: 10) + :submodule-disable: Disable submodule checkout operation. + (default: false) :tox-dir: Directory containing the project's tox.ini relative to the workspace. Empty works if tox.ini is at project root. (default: '') :tox-envs: Tox environments to run. If blank run everything described in tox.ini. (default: '') + :gerrit_trigger_file_paths: Override file paths used to filter which + file modifications will trigger a build. Refer to JJB documentation for + "file-path" details. + https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit