.\" Man page generated from reStructuredText. . .TH "LAVA-TOOL" "1" "August 23, 2017" "0.21 " "LAVA Tool" .SH NAME lava-tool \- LAVA Tool Command Line Support . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SUMMARY .sp \fBlava\-tool\fP is a command\-line tool to interact with LAVA. .SH USAGE .sp lava\-tool [\-h] [args] .SH OPTIONAL ARGUMENTS .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .SH SUBCOMMANDS .sp Type \fBlava\-tool \-h\fP for help on a specific subcommand. .SH AVAILABLE SUBCOMMANDS .INDENT 0.0 .TP .B data\-views Show data views defined on the server \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool data\-views [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] [\-\-experimental\-notice] .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .TP .B Experimental commands: .INDENT 7.0 .TP .B \-\-experimental\-notice Explain the nature of experimental commands .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B job\-output Get job output from the scheduler .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool job\-output [\-h] [\-\-overwrite] [\-\-output OUTPUT] SERVER JOB_ID .TP .B Positional arguments: .INDENT 7.0 .TP .B SERVER Host to download job output from .TP .B JOB_ID Job ID to download output file .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-overwrite Overwrite files on the local disk .TP .BI \-\-output \ OUTPUT\fP,\fB \ \-o \ OUTPUT Alternate name of the output file .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B devices\-list .INDENT 7.0 .TP .B Get list of devices from the scheduler. .INDENT 7.0 .TP .B Usage: lava\-tool devices\-list [\-h] SERVER .TP .B Positional arguments: .INDENT 7.0 .TP .B SERVER Host to query for the list of devices .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .TP .B help Show a summary of all available commands .TP .B deserialize Deserialize a bundle on the server \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool deserialize [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] SHA1 .TP .B Positional arguments: .INDENT 7.0 .TP .B SHA1 SHA1 of the bundle to deserialize .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B get Download a bundle from the server \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool get [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] [\-\-overwrite] [\-\-output OUTPUT] SHA1 .TP .B Positional arguments: .INDENT 7.0 .TP .B SHA1 SHA1 of the bundle to download .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-overwrite Overwrite files on the local disk .TP .BI \-\-output \ OUTPUT\fP,\fB \ \-o \ OUTPUT Alternate name of the output file .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B auth\-add Add an authentication token .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool auth\-add [\-h] [\-\-token\-file TOKEN_FILE] [\-\-no\-check] HOST .TP .B Positional arguments: .INDENT 7.0 .TP .B HOST Endpoint to add token for, in the form scheme://username@host. The username will default to the currently logged in user. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-token\-file \ TOKEN_FILE Read the secret from here rather than prompting for it. .TP .B \-\-no\-check By default, a call to the remote server is made to check that the added token works before remembering it. Passing this option prevents this check. .TP .BI \-\-user\-shortcut \ USER_SHORTCUT Shortcut name for the user. .TP .BI \-\-endpoint\-shortcut \ ENDPOINT_SHORTCUT Shortcut name for the endpoint. .TP .B \-\-default\-user Set this user as default user for the endpoint .UNINDENT .UNINDENT .UNINDENT .UNINDENT .UNINDENT .sp auth\-config .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool auth\-config [\-h] [\-\-user\-shortcut USER_SHORTCUT] [\-\-endpoint\-shortcut ENDPOINT_SHORTCUT] [\-\-default\-user] HOST .TP .B Positional arguments: .INDENT 7.0 .TP .B HOST Endpoint to add token for, in the form scheme://username@host. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-user\-shortcut \ USER_SHORTCUT Shortcut name for the user. .TP .BI \-\-endpoint\-shortcut \ ENDPOINT_SHORTCUT Shortcut name for the endpoint. .TP .B \-\-default\-user Set this user as default user for the endpoint. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B put Upload a bundle on the server \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool put [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] LOCAL [REMOTE] .TP .B Positional arguments: .INDENT 7.0 .TP .B LOCAL pathname on the local file system .TP .B REMOTE pathname on the server .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B bundles Show bundles in the specified stream \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool bundles [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] [PATHNAME] .TP .B Positional arguments: .INDENT 7.0 .TP .B PATHNAME pathname on the server (defaults to /anonymous/) .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B server\-version Display dashboard server version \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool server\-version [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B cancel\-job Cancel job .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool cancel\-job [\-h] SERVER JOB_ID .TP .B Positional arguments: .INDENT 7.0 .TP .B SERVER Host to cancel job on .TP .B JOB_ID Job ID to cancel .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B resubmit\-job Resubmit job .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool resubmit\-job [\-h] SERVER JOB_ID .TP .B Positional arguments: .INDENT 7.0 .TP .B SERVER Host to resubmit job on .TP .B JOB_ID Job ID to resubmit .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B version Show dashboard client version .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool version [\-h] .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B query\-data\-view Invoke a specified data view \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool restore [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] [\-\-experimental\-notice] QUERY .TP .B Positional arguments: .INDENT 7.0 .TP .B QUERY Data view name and any optional and required arguments .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .TP .B Experimental commands: .INDENT 7.0 .TP .B \-\-experimental\-notice Explain the nature of experimental commands .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B submit\-job Submit a job to lava\-scheduler .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool submit\-job [\-h] [\-\-block] SERVER JOB_FILE .TP .B Positional arguments: .INDENT 7.0 .TP .B SERVER Host to resubmit job on .TP .B JOB_FILE JOB file with test definition to submit .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-publish\-artifacts Publish all \fI\%file:///\fP references within job definition via publishing API and rewrite URL\(aqs. Job definition file must contain the \(aqsecrets\(aq section which includes API_USER and API_KEY which are used to authenticate with remote artifacts server. .TP .BI \-\-artifacts\-url \ ARTIFACTS_URL Remote server which accepts file uploads via curl. Defaults to \fI\%https://archive.validation.linaro.org\fP If non\-default url is used, user is responsible for setting up the artifacts upload server as well as relevant account and secret. .TP .BI \-\-artifacts\-path \ ARTIFACTS_PATH Location on the remote server to which artifacts will be uploaded. Defaults to team/lava. .TP .B \-\-block Blocks until the job gets executed. Deprecated. This option adds unnecessary load on the server. Please use wait\-job\-events command instead. .UNINDENT .TP .B Experimental commands: .INDENT 7.0 .TP .B \-\-experimental\-notice Explain the nature of experimental commands .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B wait\-job\-events Wait for a job events from lava\-publisher. Can also submit a job and wait for that particular one. .INDENT 7.0 .TP .B Usage: lava\-tool wait\-job\-events [\-h] (\-\-job\-definition JOB_DEFINITION | \-\-job\-id JOB_ID) [\-\-timeout TIMEOUT] [\-\-quiet] SERVER .TP .B Positional arguments: .INDENT 7.0 .TP .B SERVER Host to submit job on and/or listen to job events from. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-job\-definition \ JOB_DEFINITION Definition file path of the job that will be submitted. .TP .BI \-\-job\-id \ JOB_ID ID of the job to wait for. If this argument is provided, this command will not submit new job. .TP .BI \-\-timeout \ TIMEOUT Time to wait until the job is finished. Default will wait until manually canceled. .TP .B \-\-publish\-artifacts Publish all \fI\%file:///\fP references within job definition via publishing API and rewrite URL\(aqs. Job definition file must contain the \(aqsecrets\(aq section which includes API_USER and API_KEY which are used to authenticate with remote artifacts server. .TP .BI \-\-artifacts\-url \ ARTIFACTS_URL Remote server which accepts file uploads via curl. Defaults to \fI\%https://archive.validation.linaro.org\fP If non\-default url is used, user is responsible for setting up the artifacts upload server as well as relevant account and secret. .TP .BI \-\-artifacts\-path \ ARTIFACTS_PATH Location on the remote server to which artifacts will be uploaded. Defaults to team/lava. .TP .B \-\-quiet\fP,\fB \-q Do not print out interim messages (when job becomes Submitted or Running) but only when the job is finished. .UNINDENT .UNINDENT .TP .B validate\-pipeline\-devices Validate pipeline devices on the specified server. Print output in the form of "device_hostname: {\(aqValid\(aq: null} | {\(aqInvalid\(aq: message}" .INDENT 7.0 .TP .B Usage: lava\-tool validate\-pipeline\-devices [\-h] [\-\-name NAME] SERVER .TP .B Positional arguments: SERVER .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-name \ NAME Hostname of the device or device_type name. .UNINDENT .UNINDENT .TP .B streams Show streams you have access to \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool streams [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B make\-stream Create a bundle stream on the server \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool make\-stream [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] [\-\-name NAME] pathname .TP .B Positional arguments: .INDENT 7.0 .TP .B pathname Pathname of the bundle stream to create .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-name \ NAME Name of the bundle stream (description) .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B compare\-device\-conf Compare device configurations and output a diff. .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool compare\-device\-conf [\-h] [\-\-wdiff] [\-\-use\-stored USE_STORED] [\-\-dispatcher\-config\-dir DISPATCHER_CONFIG_DIR] [CONFIGS [CONFIGS ...]] .TP .B Positional arguments: .INDENT 7.0 .TP .B CONFIGS List of device config paths, at least one, max two. .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-wdiff\fP,\fB \-w Use wdiff for parsing output .TP .BI \-\-use\-stored \ USE_STORED\fP,\fB \ \-u \ USE_STORED Use stored device config with specified device .TP .BI \-\-dispatcher\-config\-dir \ DISPATCHER_CONFIG_DIR Where to find the device_type templates. .UNINDENT .UNINDENT .UNINDENT .UNINDENT .TP .B pull Copy bundles and bundle streams from one dashboard to another \fBDEPRECATED\fP .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 .TP .B Usage: lava\-tool pull [\-h] \-\-dashboard\-url URL [\-\-verbose\-xml\-rpc] [\-\-experimental\-notice] FROM [STREAM [STREAM ...]] .TP .B Positional arguments: .INDENT 7.0 .TP .B FROM URL of the remote validation dashboard .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .UNINDENT .TP .B Dashboard specific arguments: .INDENT 7.0 .TP .BI \-\-dashboard\-url \ URL URL of your validation dashboard .UNINDENT .INDENT 7.0 .TP .B STREAM Streams to pull from (all by default) .UNINDENT .TP .B Debugging arguments: .INDENT 7.0 .TP .B \-\-verbose\-xml\-rpc Show XML\-RPC data .UNINDENT .TP .B Experimental commands: .INDENT 7.0 .TP .B \-\-experimental\-notice Explain the nature of experimental commands .UNINDENT .UNINDENT .sp This command checks for two environment variables: The value of DASHBOARD_URL is used as a replacement for \-\-dashboard\-url. The value of REMOTE_DASHBOARD_URL as a replacement for FROM. Their presence automatically makes the corresponding argument optional. .UNINDENT .UNINDENT .TP .B get\-pipeline\-device\-config Get pipeline device configuration to a local file or stdout. .INDENT 7.0 .TP .B Usage: lava\-tool get\-pipeline\-device\-config [\-h] [\-\-overwrite] [\-\-output OUTPUT] [\-\-output\-to\-stdout] SERVER DEVICE_HOSTNAME .TP .B Positional arguments: .INDENT 7.0 .TP .B SERVER Host to download pipeline device configuration from .TP .B DEVICE_HOSTNAME HOSTNAME of the pipeline device for which configuration is required .UNINDENT .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-overwrite Overwrite files on the local disk .TP .BI \-\-output \ OUTPUT\fP,\fB \ \-o \ OUTPUT Alternate name of the output file .TP .B \-\-stdout Write output to stdout .UNINDENT .UNINDENT .TP .B device\-dictionary Update or export device dictionary data as jinja2 data. [Superusers only.] Either [\-\-update | \-u] or [\-\-export | \-e] must be used. Wraps the import\-device\-dictionary and export\-device\-dictionary XMLRPC API calls on the specified server. .INDENT 7.0 .TP .B Usage: lava\-tool device\-dictionary [\-h] [\-\-update UPDATE] [\-\-export] SERVER DEVICE_HOSTNAME .TP .B Positional arguments: SERVER Host to query or update the device dictionary on DEVICE_HOSTNAME DEVICE_HOSTNAME to query or update .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .BI \-\-update \ UPDATE\fP,\fB \ \-u \ UPDATE Load a jinja2 file to update the device dictionary .TP .B \-\-export\fP,\fB \-e Export the device dictionary for this device as jinja2 .UNINDENT .UNINDENT .TP .B job\-results Download job results in either YAML or CSV format. .sp Usage: lava\-tool job\-results [\-h] [\-\-csv] SERVER JOB_ID .INDENT 7.0 .TP .B Positional arguments: SERVER Host from where to download the results. JOB_ID ID of the job to get results for. .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-csv If this is specified, results will be printed out in CSV format, otherwise in YAML. .UNINDENT .UNINDENT .TP .B test\-suite\-results Download test suite results in either YAML or CSV format. .sp Usage: lava\-tool test\-suite\-results [\-h] [\-\-csv] SERVER JOB_ID SUITE_NAME .INDENT 7.0 .TP .B Positional arguments: SERVER Host from where to download the results. JOB_ID ID of the job to get results from. SUITE_NAME Name of the suite to get results for. .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-csv If this is specified, results will be printed out in CSV format, otherwise in YAML. .UNINDENT .UNINDENT .TP .B test\-case\-results Download test case results in either YAML or CSV format. .sp Usage: lava\-tool test\-case\-results [\-h] [\-\-csv] SERVER JOB_ID SUITE_NAME TEST_CASE .INDENT 7.0 .TP .B Positional arguments: SERVER Host from where to download the results. JOB_ID ID of the job to get results from. SUITE_NAME Name of the suite to get results from. TEST_CASE Name of the test case to get results for. .TP .B Optional arguments: .INDENT 7.0 .TP .B \-h\fP,\fB \-\-help show this help message and exit .TP .B \-\-csv If this is specified, results will be printed out in CSV format, otherwise in YAML. .UNINDENT .UNINDENT .UNINDENT .SH LAVA TEST DEFINITIONS .sp A LAVA Test Definition comprises of two parts: .INDENT 0.0 .IP \(bu 2 the data to setup the test, the job definition. .IP \(bu 2 the instructions to run inside the test, expressed as a YAML file. .UNINDENT .sp For help on writing job definitions and test definitions, please see the help available on the LAVA instance you want to use to run the test. .sp As a reminder, JSON job submissions relate to the \fBdeprecated\fP LAVA V1 support which is superseded by LAVA V2 using YAML for the job submission. .sp The latest information and help on LAVA V2 is available via the staging instance: .sp \fI\%https://staging.validation.linaro.org/static/docs/v2/\fP .sp The following instructions relate only to the deprecated V1 support. .SH CONTENTS OF THE JSON FILE .sp \fBDEPRECATED\fP .sp The JSON file is submitted to the LAVA server and contains: .INDENT 0.0 .IP \(bu 2 Demarcation as a health check or a user test. .IP \(bu 2 The default timeout of each action within the test. .IP \(bu 2 The logging level for the test, DEBUG or INFO. .IP \(bu 2 The name of the test, shown in the list of jobs. .IP \(bu 2 The location of all support files. .IP \(bu 2 All parameters necessary to use the support files. .IP \(bu 2 The declaration of which device(s) to use for the test. .IP \(bu 2 The location to which the results should be uploaded. .IP \(bu 2 The JSON determines how the test is deployed onto the device and where to find the tests to be run. .UNINDENT .SH BASIC JSON FILE .sp \fBDEPRECATED\fP .sp Your first LAVA test should use the \fBDEBUG\fP logging level so that it is easier to see what is happening. .sp A suitable \fBtimeout\fP for your first tests is 900 seconds. .sp Make the \fBjob_name\fP descriptive and explanatory, you will want to be able to tell which job is which when reviewing the results. .sp Make sure the \fBdevice_type\fP matches exactly with one of the suitable device types listed on the server to which you want to submit this job. .sp Change the stream to one to which you are allowed to upload results, on your chosen server. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { "health_check": false, "logging_level": "DEBUG", "timeout": 900, "job_name": "kvm\-basic\-test", "device_type": "kvm", "actions": [ { "command": "deploy_linaro_image", "parameters": { "image": "http://images.validation.linaro.org/kvm\-debian\-wheezy.img.gz" } }, { "command": "lava_test_shell", "parameters": { "testdef_repos": [ { "git\-repo": "git://git.linaro.org/qa/test\-definitions.git", "testdef": "ubuntu/smoke\-tests\-basic.yaml" } ], "timeout": 900 } }, { "command": "submit_results_on_host", "parameters": { "stream": "/anonymous/example/", "server": "http://localhost/RPC2/" } } ] } .ft P .fi .UNINDENT .UNINDENT .SH NOTE .sp Always check your JSON syntax. A useful site for this is \fI\%http://jsonlint.com\fP\&. YAML syntax can be checked at \fI\%http://yaml\-online\-parser.appspot.com/?yaml=\fP .SH BUGS AND ISSUES .sp General hints and tips on \fBlava\-tool\fP and LAVA are available on the Linaro wiki: \fI\%https://wiki.linaro.org/Platform/LAVA/LAVA_Tips\fP\&. (Login is not required to read this page, only to edit.) .sp \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 \fBlava\-tool\fP is intended for user command line interaction. For all scripting requirements use XMLRPC support directly. Help on using XMLRPC with python is in the API | Available Methods section of the LAVA instance. e.g. \fI\%https://validation.linaro.org/api/help/\fP Other languages also have XMLRPC support. .UNINDENT .UNINDENT .SH TESTING CHANGES TO LAVA-TOOL .sp Adding new commands to \fBlava\-tool\fP requires changes to the \fBentrypoints.ini\fP file and these changes need to be picked up by setuptools. The local test directory can use any name \- just remember to remove the directory before committing your local changes for review. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C python setup.py install \-\-root=./_dev/lava\-tool/ \-\-install\-layout=deb PYTHONPATH=. python ./_dev/lava\-tool/usr/bin/lava\-tool \-\-help rm \-rf ./_dev/ .ft P .fi .UNINDENT .UNINDENT .SH AUTHOR Linaro Validation Team .SH COPYRIGHT 2010-2017, Linaro Limited .\" Generated by docutils manpage writer. .