[ONOS-7461]: Add Description to QA Jobs using JJB in ONOS Jenkins
Change-Id: I0a94cac66932a7660c5e395ab2472702d1e5eabc
diff --git a/jjb/OnosSystemTest/onos-test-freestyle.yaml b/jjb/OnosSystemTest/onos-test-freestyle.yaml
index 13baf14..a7a9328 100644
--- a/jjb/OnosSystemTest/onos-test-freestyle.yaml
+++ b/jjb/OnosSystemTest/onos-test-freestyle.yaml
@@ -41,6 +41,13 @@
# post_Job
- job-template:
name: postjob-{station-type}
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ Click on the "Last Successful Artifacts" to view all of the graphs (also accessible when logged out).<br />
+ <font color="red">Unless debugging, DO NOT MANUALLY BUILD THIS PIPELINE.</font><br />
+ <br />
+ Created by Devin Lim - devin@opennetworking.org<br />
+ Copyright (c) 2017 Open Networking Foundation (ONF)
<<: *test-free-job-boiler-plate
@@ -71,6 +78,9 @@
- job-template:
name: test-station-log-cleanup-VM
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ clean up periodically ~/OnosSystemTest/TestON/logs - delete logs older than $DAYS_OLD days.
<<: *test-free-job-boiler-plate
<<: *inject-env-variable-plate
@@ -101,6 +111,9 @@
- job-template:
name: test-station-log-cleanup-BM
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ clean up periodically ~/OnosSystemTest/TestON/logs - delete logs older than $DAYS_OLD days.
<<: *test-free-job-boiler-plate
<<: *inject-env-variable-plate
@@ -132,6 +145,10 @@
- job-template:
name: test-station-log-cleanup-CHO
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+
+
<<: *test-free-job-boiler-plate
<<: *inject-env-variable-plate
@@ -162,6 +179,46 @@
- job-template:
name: QA-check-style
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ <h3>ONOS QA Code Style:</h3>
+ At Open Networking Foundation, we have adopted the <a href="https://github.com/mininet/mininet/wiki/Mininet-Python-Style">Mininet Python Style</a> for our drivers and testcases. The one exception is that TestON does not correctly parse multiline comments in testcases when the ending triple double quotes are on the same line as the comment. Therefore, in the testcases, the ending triple double quotes must be on it's own line.<br />
+ All .py files that are in the most recent patchset will be style checked.<br />
+ <br />
+ Jenkins User will give +1 if all files pass the style check, -1 if there is at least one style check failure.<br />
+ Jenkins will not comment on Gerrit if there are no .py files to test. This is caused by failing the job with exit code 2.<br />
+ <br />
+ Click on the link in the Gerrit patchset comment to view the results of the style check.<br />
+ Alternatively, you can check the console output to view the files checked and style check raw output.<br />
+ <br />
+ You may also manually run this job by selecting "Build with Parameters", then providing the 5-digit change number from Gerrit.<br />
+ <br />
+ <h3>Important Notes:</h3>
+ A build that is "Unstable" has failed the style check. A build with state "Error" means that there were no .py files to check.<br />
+ Build numbers that are 1 build apart may NOT necessarily correspond to the same patchset!<br />
+ Manually running this job will NOT leave a comment after the most recent patchset in Gerrit.<br />
+ <br />
+ <h3>Style Check PEP8 Exclusions:</h3>
+ This job mainly follows PEP8 style check, but excludes many errors and warnings.<br />
+ The following errors and warnings are excluded from the PEP8 check portion of the job:
+ <ul>
+ <li>E251</li>
+ <li>E201</li>
+ <li>E302</li>
+ <li>E202</li>
+ <li>E126</li>
+ <li>E127</li>
+ <li>E203</li>
+ <li>E226</li>
+ <li>E501</li>
+ <li>W391</li>
+ </ul>
+ <h3>Credits:</h3>
+ This job is modeled from <a href="https://jenkins.onosproject.org/view/all/job/onos-master-release-build-verify/">onos-master-release-build-verify</a><br />
+ The check style portion of the job is modeled from "HA-Jobs/codecheck_test"<br />
+ Created by Jeremy Ronquillo: jeremyr@opennetworking.org or j_ronquillo@u.pacific.edu<br />
+ <br />
+ Copyright (c) 2017 Open Networking Foundation (ONF)
<<: *test-free-job-boiler-plate
properties:
@@ -224,6 +281,8 @@
- job-template:
name: delta-nightly
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
<<: *test-free-job-boiler-plate
properties:
@@ -237,7 +296,7 @@
name: 'NIGHTLY_FILE_NAME'
default: ''
description: |
- Name of ONOS nightly build file
+ Name of ONOS nightly build file <br />
will be set to the latest file if not specified here
- string:
@@ -288,6 +347,11 @@
- job-template:
name: init-CHO
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ 1) Set a specific onos branch to test; <br />
+ 2) pull and checkout the branch; <br />
+ 3) build onos and package to tar.gz <br />
<<: *test-free-job-boiler-plate
properties:
@@ -301,8 +365,8 @@
name: 'ONOSBranch'
default: 'master'
description: |
- set onos branch to test. default to "master",
- but can also be set at "onos-1.2", etc.
+ set onos branch to test. default to "master", <br />
+ but can also be set at "onos-1.2", etc. <br />
This parameter is also use to trigger where the test results to be posted
- string:
diff --git a/jjb/OnosSystemTest/onos-test-pipeline.yaml b/jjb/OnosSystemTest/onos-test-pipeline.yaml
index 8d32791..9b29fb8 100644
--- a/jjb/OnosSystemTest/onos-test-pipeline.yaml
+++ b/jjb/OnosSystemTest/onos-test-pipeline.yaml
@@ -48,6 +48,15 @@
- job-template:
name: all-pipeline-trigger
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ All_Pipeline_Trigger can trigger any TestON test on any branch of ONOS and TestON, by running the test category pipeline that contains the test. <br />
+ This pipeline is triggered by timer for the nightly builds. <br />
+ You may manually trigger this pipeline as well - provide the tests to run and the branch of ONOS and TestON. <br /> <br />
+ Note: <i>The console output for this job does <b>not</b> contain any test result logs.</i><br />
+ Visit the test category pipelines (such as <a href="https://jenkins.onosproject.org/view/QA/job/FUNC-pipeline-master/">FUNC-pipeline-master</a>) to view the test logs. <br /> <br />
+ Created by Devin Lim - devin@opennetworking.org<br />
+ Copyright (c) 2017 Open Networking Foundation (ONF)
<<: *var-init-boiler-plate
<<: *test-pipe-job-boiler-plate
@@ -58,22 +67,22 @@
name: manual_run
default: false
description: |
- Check this option if you are manually running this job (you most likely are).
+ Check this option if you are manually running this job (you most likely are). <br />
You must specify which tests to run in the text field below.
- bool:
name: PostResult
default: false
description: |
- Check this option if you want to update the results on the wiki.
- When manually run, this will update the wiki pages corresponding to the tests that were run.
+ Check this option if you want to update the results on the wiki. <br />
+ When manually run, this will update the wiki pages corresponding to the tests that were run. <br />
This option will always be selected during nightly builds.
- bool:
name: isOldFlow
default: true
description: |
- Check this option if you prefer to run the old flow rule over the new one.
+ Check this option if you prefer to run the old flow rule over the new one. <br />
* This only applies to SCPF tests.
- choice:
@@ -121,6 +130,13 @@
- job-template:
name: '{type}-pipeline-{version}'
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ This pipeline contains the test results and logs of the corresponding test category and ONOS version. <br /><br />
+ Visit <a href="https://jenkins.onosproject.org/view/QA/job/all-pipeline-trigger/">all-pipeline-trigger</a> to trigger a build in this pipeline.<br />
+ <font color="red">Unless debugging, DO NOT MANUALLY BUILD THIS PIPELINE.</font><br /><br />
+ Created by Devin Lim - devin@opennetworking.org<br />
+ Copyright (c) 2017 Open Networking Foundation (ONF)
<<: *test-pipe-job-boiler-plate
@@ -130,7 +146,7 @@
name: TRIGGER_ONLY_WHEN_PREVIOUS_JOB_WAS_BUILT_HERE
default: 'DO_NOT_MANUALLY_TRIGGER_A_BUILD_HERE'
description: |
- <a href=https://onos-jenkins.onlab.us/job/ALL_Pipeline_Trigger/>ALL_Pipeline_Trigger</a> triggers this pipeline automatically.
+ <a href="https://jenkins.onosproject.org/view/QA/job/all-pipeline-trigger/">all-pipeline-trigger</a> triggers this pipeline automatically.
- lf-infra-parameters:
project: 'OnosSystemTest'
@@ -150,6 +166,14 @@
- job-template:
name: 'manual-graph-generator-SCPF'
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ Refresh the wiki graphs here. Useful when there is a change in the graph scripts.<br />
+ <br />
+ You may also generate a graph trend that displays any number of builds here.<br />
+ However, keep in mind that only the 50 build graphs will be displayed on the wiki, unless they are manually changed on the wiki.<br >
+ <br >
+ Graphs are stored in the <a href="https://jenkins.onosproject.org/view/QA/job/postjob-BM/">postjob-BM<a> workspace.
<<: *var-init-boiler-plate
<<: *test-pipe-job-boiler-plate
@@ -190,6 +214,11 @@
- job-template:
name: 'manual-graph-generator-trend'
+ description: |
+ <!-- Managed by Jenkins Job Builder -->
+ Refresh the trend graphs here. Useful when there is a change in the graph scripts. <br />
+ Graphs are stored in their respective Postjob pipeline.
+
<<: *var-init-boiler-plate
<<: *test-pipe-job-boiler-plate
@@ -210,7 +239,7 @@
- VM
- BM
description: |
- Node cluster where the test graphs in the list are located.
+ Node cluster where the test graphs in the list are located. <br />
List of the tests will be refreshed depends on the node cluster.
- text: