aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArthur She <arthur.she@linaro.org>2015-10-23 07:13:15 -0700
committerArthur She <arthur.she@linaro.org>2015-10-23 07:13:15 -0700
commitbe917aee1e8cd11ffd406e41f90fc33589499d2b (patch)
treea0e2ecc26f95c5b1734e6f1b38178b0af6f5dc8f
parentb9c144c1e6c105071671dd622305e312ece1ac3b (diff)
Add a simple README
new file: README
-rw-r--r--README46
1 files changed, 46 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..57f48a3
--- /dev/null
+++ b/README
@@ -0,0 +1,46 @@
+[Required python module]
+1. py3o.template
+2. jenkinsapi
+
+[How to run the script]
+1. Option '-h' shows all options
+ $./report_automation.py -h
+ usage: report_automation.py [-h] -bn BUILD_NO [-u JENKINS_URL]
+ [-job JENKINS_JOB_NAME]
+ [-a MANUAL_LAVA_JOBS [MANUAL_LAVA_JOBS ...]]
+ [-d EXCLUDE_LAVA_JOBS [EXCLUDE_LAVA_JOBS ...]]
+ [-temp TEMPLATE_FILE] [-o OUTPUT_FILE] [-f]
+
+ This script will collect all data and make a report.
+ The authentication credential for LAVA/Jenkins server should be put in ~/.netrc
+ e.g.
+ machine validation.linaro.org
+ login USERNAME
+ password AUTHENTICATION TOKEN
+
+ optional arguments:
+ -h, --help show this help message and exit
+ -bn BUILD_NO, --build-no BUILD_NO
+ Specify the Jenkins build number. This is MANDATORY.
+ -u JENKINS_URL, --jenkins-url JENKINS_URL
+ Specify the Jenkins URL. This is optional.
+ Default: https://android-build.linaro.org/jenkins/
+ -job JENKINS_JOB_NAME, --jenkins-job-name JENKINS_JOB_NAME
+ Specify the Jenkins job name.This is optional.
+ Default: linaro-android_lcr-member-juno
+ -a MANUAL_LAVA_JOBS [MANUAL_LAVA_JOBS ...], --manual-lava-jobs MANUAL_LAVA_JOBS [MANUAL_LAVA_JOBS ...]
+ Specify the test jobs that were submitted manually. This is optional.
+ -d EXCLUDE_LAVA_JOBS [EXCLUDE_LAVA_JOBS ...], --exclude-lava-jobs EXCLUDE_LAVA_JOBS [EXCLUDE_LAVA_JOBS ...]
+ Specify the test jobs that don't want to be included in the report. This is optional.
+ -temp TEMPLATE_FILE, --template TEMPLATE_FILE
+ Specify the report template. This is optional.
+ Default: py3o_report_juno_template.odt
+ -o OUTPUT_FILE, --output OUTPUT_FILE
+ Specify the output file name. This is optional.
+ Default: report_output.odt
+ -f, --force-report Generate report even there're some errors
+
+2. ** The authentication credential for LAVA server MUST be put in ~/.netrc as it showed in help message.
+3. Only '--build-no' argument is required.
+ Example.
+ $./report_automation.py --build-no 148