X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-python-jobs.rst;h=4972e69638740c7591f019fce3032bc81c72d986;hb=refs%2Fchanges%2F50%2F61650%2F2;hp=c1bf65ab7ef227e465d87b600505f84435a6b473;hpb=7f9ae14335b6f2ef54626fed349d8a8f36d6d902;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst index c1bf65ab..4972e696 100644 --- a/docs/jjb/lf-python-jobs.rst +++ b/docs/jjb/lf-python-jobs.rst @@ -35,16 +35,6 @@ Install Tox into a virtualenv. :python-version: Version of Python to install into the Tox virtualenv. Eg. python2 / python3 -lf-infra-tox-sonar ------------------- - -Runs Sonar scanning against a Python project. - -:Required Parameters: - - :java-version: Version of Java to use to run Sonar. - :mvn-version: Version of Maven to use to run Sonar. - lf-tox-install -------------- @@ -95,10 +85,17 @@ IQ Server. :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 @@ -109,16 +106,21 @@ IQ Server. Python Sonar with Tox --------------------- -Sonar scans for Python based repos. This job will perform a tox call which -runs the coverage command to gather tests results. These test results get -published back into Sonar after running the Sonar goals. +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, tox.ini needs to exist and configured -with coverage commands to run. +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. -It does not guarantee that the code tests executed properly, but it will help -pointing out the code that is not tested at all. +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: @@ -149,25 +151,37 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import :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 settings file containing credentials for the project. + :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 - Maven configuration. (default: global-settings) + :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 @@ -208,12 +222,19 @@ following pyenv variables before running. :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: '')