/usr/share/doc/lava-server-doc/html/overview.html is in lava-server-doc 2014.09.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>LAVA Overview — LAVA Server 2014.09.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2014.09.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="LAVA Server 2014.09.1 documentation" href="index.html" />
<link rel="next" title="LAVA Installation" href="installation.html" />
<link rel="prev" title="LAVA Manual" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="installation.html" title="LAVA Installation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="LAVA Manual"
accesskey="P">previous</a> |</li>
<li><a href="index.html">LAVA Server 2014.09.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="lava-overview">
<h1>LAVA Overview<a class="headerlink" href="#lava-overview" title="Permalink to this headline">¶</a></h1>
<div class="section" id="what-is-lava">
<span id="index-0"></span><h2>What is LAVA?<a class="headerlink" href="#what-is-lava" title="Permalink to this headline">¶</a></h2>
<p>LAVA is the Linaro Automation and Validation Architecture.</p>
<p>LAVA is a continuous integration system for deploying operating
systems onto physical and virtual hardware for running tests.
Tests can be simple boot testing, bootloader testing and system
level testing, although extra hardware may be required for some
system tests. Results are tracked over time and data can be
exported for further analysis.</p>
<p>LAVA is a collection of participating components, the overall idea and
evolving architecture that allows us to make testing, quality control
and automation. LAVA-the-stack aims to make systematic, automatic and
manual quality control more approachable for projects of all sizes.</p>
<p>LAVA is for validation - telling whether the code the other Linaro
engineers are producing “works” in whatever sense that means. It could
be a simple compile or boot test for the kernel, testing whether the
code produced by gcc is smaller or faster, whether a kernel scheduler
change reduces power consumption for a certain workload, or many other
things.</p>
<p>Beyond simple validation though, what LAVA really about is automated
validation. LAVA builds and tests the kernel on all supported boards
every day. LAVA builds and tests proposed android changes in gerrit
before they are landed, and the same for the gcc work. There is a
validation lab in Cambridge - the boards from the Linaro members we
want to test on, but also Cyclades serial console servers, routers,
and a few servers.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This overview document explains LAVA using
<a class="reference external" href="http://validation.linaro.org/">http://validation.linaro.org/</a> which is the official
production instance of LAVA hosted by Linaro. Where examples
reference <tt class="docutils literal"><span class="pre">validation.linaro.org</span></tt>, replace with the fully
qualified domain name of your LAVA instance.</p>
</div>
</div>
<div class="section" id="logging-in">
<span id="index-1"></span><h2>Logging In<a class="headerlink" href="#logging-in" title="Permalink to this headline">¶</a></h2>
<p>Each LAVA instance offers a <a class="reference internal" href="#local-user"><em>Local User Account</em></a> and can also be configured
to offer an alternative authentication method:</p>
<ul class="simple">
<li><a class="reference internal" href="installation.html#launchpad-openid"><em>Using Launchpad OpenID</em></a></li>
<li><a class="reference internal" href="installation.html#google-openid"><em>Using Google+ OpenID</em></a></li>
<li><a class="reference internal" href="installation.html#ldap-authentication"><em>Using Lightweight Directory Access Protocol (LDAP)</em></a></li>
</ul>
<p>Whichever authentication method is used, there is no difference in how
users interact with LAVA, once logged in.</p>
<div class="section" id="local-user-account">
<span id="local-user"></span><h3>Local User Account<a class="headerlink" href="#local-user-account" title="Permalink to this headline">¶</a></h3>
<p>A local user account can be created by an administrator within LAVA. The
administrator grants different permissions which allows the user to
perform various operations within LAVA. A typical login screen will
look like the following. In order to login with an username and
password enter your credentials in the provided text boxes and click
“Sign in with username and password” button</p>
<p>Local user accounts can be particularly useful for automated users like
build systems or continuous integration scripts using the XMLRPC API.
The local admin can create the user with a secure password, login as
that user to create a token and then supply the token to the scripts.</p>
<img alt="_images/local-user-login.png" src="_images/local-user-login.png" />
</div>
<div class="section" id="logging-into-the-validation-lab-in-cambridge">
<h3>Logging into the validation lab in Cambridge<a class="headerlink" href="#logging-into-the-validation-lab-in-cambridge" title="Permalink to this headline">¶</a></h3>
<p>The validation lab in Cambridge is accessible via
<a class="reference external" href="http://validation.linaro.org/">http://validation.linaro.org/</a> which is the official production
instance of LAVA.</p>
<img alt="_images/lava-scheduler-page.png" src="_images/lava-scheduler-page.png" />
<p>The validation lab in Cambridge is currently accessed using Launchpad
OpenID. In order to login with Launchpad click on “Sign in with OpenID”
button, which will take you a Launchpad login screen in order to confirm
that you want to allow LAVA to use your Launchpad profile to authenticate.</p>
<p>A successful authentication will redirect you to <a class="reference external" href="http://validation.linaro.org/">http://validation.linaro.org/</a></p>
</div>
</div>
<div class="section" id="authentication-tokens">
<span id="index-2"></span><span id="id1"></span><h2>Authentication Tokens<a class="headerlink" href="#authentication-tokens" title="Permalink to this headline">¶</a></h2>
<p>In order to securely access LAVA resources via XML-RPC APIs using
lava-tool or XML-RPC clients, an Authentication token should be
created by the user.</p>
<p>Once the user is logged in to a LAVA instance
(e.g. <a class="reference external" href="http://validation.linaro.org/">http://validation.linaro.org/</a>) click on the “API” link which will
bring up a drop down menu on which click on “Authentication Tokens” link.
The following page will appear</p>
<img alt="_images/authentication-tokens-page.png" src="_images/authentication-tokens-page.png" />
<p>Click on “new” button on the above page which raises a dialog box
asking for a “Description” of the token to help you identify and
delete tokens - if required at a later stage.</p>
<img alt="_images/create-new-authentication-token.png" src="_images/create-new-authentication-token.png" />
<p>Click on the “Create” button to generate the token. The token
will be assigned a token number (which is autogenerated by LAVA).</p>
<img alt="_images/sample-token-page.png" src="_images/sample-token-page.png" />
<p>To display the token that was generated above click on the green “display
this token” button in the Actions column on the above page.</p>
<img alt="_images/token-display-page.png" src="_images/token-display-page.png" />
<p>If a token is compromised it can be removed by clicking on the red “delete
this token” button in the Actions column. Anyone using that token will no longer be able to
authenticate as You in the system.</p>
</div>
<div class="section" id="lava-tool-overview">
<span id="lava-tool"></span><span id="index-3"></span><h2>lava-tool overview<a class="headerlink" href="#lava-tool-overview" title="Permalink to this headline">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">lava-tool</span></tt> is the command-line tool for interacting with the various
services offered by LAVA via XML-RPC APIs. The full list of API calls
is visible on the <strong>Available methods</strong> link from the API menu:</p>
<div class="highlight-python"><div class="highlight"><pre>http://localhost/api/help
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">lava-tool</span></tt> is primarily designed to assist users and uses desktop
integration hooks provided by <tt class="docutils literal"><span class="pre">python-keyring</span></tt> and <tt class="docutils literal"><span class="pre">gnome-keyring</span></tt>.
When scripts need to interact with LAVA, the XMLRPC API calls should be
used directly so that the scripts do not need to prompt for a password
to the local user keyring. Scripts used by build servers and continuous
integration tools should use a dedicated user created by the
administrator of a particular instance),</p>
<p>The API help page includes an example python script to connect to the
local instance. To add token support, use the syntax <em>username:token</em>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">server</span> <span class="o">=</span> <span class="n">xlrpclib</span><span class="o">.</span><span class="n">ServerProxy</span><span class="p">(</span><span class="s">"http://</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">@localhost/RPC2"</span> <span class="o">%</span> <span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">token</span><span class="p">))</span>
</pre></div>
</div>
<div class="section" id="installing-lava-tool">
<h3>Installing lava-tool<a class="headerlink" href="#installing-lava-tool" title="Permalink to this headline">¶</a></h3>
<p><tt class="docutils literal"><span class="pre">lava-tool</span></tt> is installed alongside LAVA by default, when the top
level <tt class="docutils literal"><span class="pre">lava</span></tt> package is installed on a <a class="reference internal" href="installing_on_debian.html#debian-installation"><em>Debian-based distributions</em></a>.
<tt class="docutils literal"><span class="pre">lava-tool</span></tt> can also be installed on any remote machine running a
Debian-based distribution, without needing the rest of LAVA, to allow
a remote user to interact with any LAVA instance on which the user has
an account.:</p>
<div class="highlight-python"><div class="highlight"><pre>$ sudo apt-get update
$ sudo apt-get install lava-tool
</pre></div>
</div>
</div>
<div class="section" id="using-lava-tool">
<h3>Using lava-tool<a class="headerlink" href="#using-lava-tool" title="Permalink to this headline">¶</a></h3>
<p>Once the token is created add it to lava-tool as follows. Click on
“display the token” link on the “Authentication Tokens” page and copy
the token. e.g. if your token was created on validation.linaro.org:</p>
<div class="highlight-python"><div class="highlight"><pre>$ lava-tool auth-add http://<username>@validation.linaro.org/RPC2/
Paste token for http://<username>@validation.linaro.org/RPC2/:
Please set a password for your new keyring:
Please confirm the password:
Token added successfully for user <username>.
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Paste the token copied previously when it is asked
above. Replace <em>username</em> with your username. If the keyring is
created newly, set a password for the same, else enter the
password for the keyring already created.</p>
</div>
</div>
</div>
<div class="section" id="bundle-stream-overview">
<span id="bundle-stream"></span><span id="index-4"></span><h2>Bundle Stream Overview<a class="headerlink" href="#bundle-stream-overview" title="Permalink to this headline">¶</a></h2>
<div class="section" id="what-is-a-bundle-stream">
<h3>What is a Bundle Stream?<a class="headerlink" href="#what-is-a-bundle-stream" title="Permalink to this headline">¶</a></h3>
<p>LAVA runs tests which produce results with multiple tests being run for
each submitted job. The collection of results from any one submitted
job is termed a Result Bundle. Each bundle can contain multiple sets
of test results, as well as other information about the system where the
testing was performed.</p>
<p>Within a single result bundle are the results of each test definition
execution, termed a Test Run. Each Test Run is typically a single YAML
file and is listed in the bundle via the description of the test
definition. The individual id and result of a single test within a test
run is called the Test Case, typically a single line in the YAML file.
If the job ran across multiple devices, the bundle can include test
runs from each device from that job.</p>
<p>Result Bundles are uploaded to the server at the end of the test run
into a Bundle Stream which is a way of organising related results
bundles. A bundle stream could be imagined as a folder within which all
related result bundle will be stored. A bundle stream could be private
or anonymous. The name of the stream is specified in the job definition to
determine where the result bundle from the job should be submitted.</p>
</div>
<div class="section" id="how-to-setup-a-bundle-stream">
<h3>How to setup a Bundle Stream?<a class="headerlink" href="#how-to-setup-a-bundle-stream" title="Permalink to this headline">¶</a></h3>
<p>A public/anonymous bundle stream could be setup with the help of
lava-tool as follows,</p>
<div class="highlight-python"><div class="highlight"><pre>$ lava-tool make-stream --dashboard-url
http://<username>@validation.linaro.org/RPC2/ /anonymous/USERNAME/
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Replace <em>username</em> and <em>USERNAME</em> with your
username. Alternatively an existing stream like
anonymous/test could be used for initial testing purposes.</p>
</div>
</div>
</div>
<div class="section" id="submitting-your-first-job">
<span id="submit-first-job"></span><span id="index-5"></span><h2>Submitting your first job<a class="headerlink" href="#submitting-your-first-job" title="Permalink to this headline">¶</a></h2>
<p>A job defines what image to deploy on the DUT and further actions that
should be performed on the DUT. Jobs are defined in <em>JSON</em> files.</p>
<div class="section" id="job-definition">
<h3>Job Definition<a class="headerlink" href="#job-definition" title="Permalink to this headline">¶</a></h3>
<p>Here’s a minimal job that could be executed</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">"job_name"</span><span class="p">:</span> <span class="s">"kvm-test"</span><span class="p">,</span>
<span class="s">"device_type"</span><span class="p">:</span> <span class="s">"kvm"</span><span class="p">,</span>
<span class="s">"timeout"</span><span class="p">:</span> <span class="mi">1800</span><span class="p">,</span>
<span class="s">"actions"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"deploy_linaro_image"</span><span class="p">,</span>
<span class="s">"parameters"</span><span class="p">:</span>
<span class="p">{</span>
<span class="s">"image"</span><span class="p">:</span> <span class="s">"http://images.validation.linaro.org/kvm-debian-wheezy.img.gz"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"boot_linaro_image"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"submit_results"</span><span class="p">,</span>
<span class="s">"parameters"</span><span class="p">:</span>
<span class="p">{</span>
<span class="s">"server"</span><span class="p">:</span> <span class="s">"http://<username>@validation.linaro.org/RPC2/"</span><span class="p">,</span>
<span class="s">"stream"</span><span class="p">:</span> <span class="s">"/anonymous/test/"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Replace <em>username</em> with your username.</p>
</div>
</div>
<div class="section" id="job-submission">
<span id="id2"></span><h3>Job Submission<a class="headerlink" href="#job-submission" title="Permalink to this headline">¶</a></h3>
<p>A job could be submitted either from the command line (using
lava-tool) or via the web UI.</p>
<div class="section" id="command-line-job-submission">
<h4>Command Line Job Submission<a class="headerlink" href="#command-line-job-submission" title="Permalink to this headline">¶</a></h4>
<p>Once you have copied the above job definition to a file, for example
<em>/tmp/job.json</em> Use the lava-tool as shown below,</p>
<div class="highlight-python"><div class="highlight"><pre>$ lava-tool submit-job https://<username>@validation.linaro.org/RPC2/
/tmp/job.json
Please enter password for encrypted keyring:
submitted as job id: 82287
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Replace <em>username</em> with your username. Enter the password
for the encrypted keyring which is the same that was used
when adding authentication token.</p>
</div>
<p>Once the job is submitted successfully, the job-id is returned back,
which could be used in order to check the status of the job on the
UI. In the above submission job-id returned is 82287. Visit
<tt class="docutils literal"><span class="pre">http://validation.linaro.org/scheduler/job/<job-id></span></tt> in order to see
the details of the job run.</p>
</div>
</div>
<div class="section" id="id3">
<h3>Job Definition<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>Here’s a minimal job that could be executed</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">"job_name"</span><span class="p">:</span> <span class="s">"kvm-test"</span><span class="p">,</span>
<span class="s">"device_type"</span><span class="p">:</span> <span class="s">"kvm"</span><span class="p">,</span>
<span class="s">"timeout"</span><span class="p">:</span> <span class="mi">1800</span><span class="p">,</span>
<span class="s">"actions"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"deploy_linaro_image"</span><span class="p">,</span>
<span class="s">"parameters"</span><span class="p">:</span>
<span class="p">{</span>
<span class="s">"image"</span><span class="p">:</span> <span class="s">"http://images.validation.linaro.org/kvm-debian-wheezy.img.gz"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"boot_linaro_image"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"submit_results"</span><span class="p">,</span>
<span class="s">"parameters"</span><span class="p">:</span>
<span class="p">{</span>
<span class="s">"server"</span><span class="p">:</span> <span class="s">"http://<username>@validation.linaro.org/RPC2/"</span><span class="p">,</span>
<span class="s">"stream"</span><span class="p">:</span> <span class="s">"/anonymous/test/"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Replace <em>username</em> with your username.</p>
</div>
</div>
<div class="section" id="id4">
<h3>Job Submission<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>A job could be submitted either from the command line (using
lava-tool) or via the web UI.</p>
<div class="section" id="id5">
<h4>Command Line Job Submission<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h4>
<p>Once you have copied the above job definition to a file, for example
<em>/tmp/job.json</em> Use the lava-tool as shown below,</p>
<div class="highlight-python"><div class="highlight"><pre>$ lava-tool submit-job https://<username>@validation.linaro.org/RPC2/
/tmp/job.json
Please enter password for encrypted keyring:
submitted as job id: 82287
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Replace <em>username</em> with your username. Enter the password
for the encrypted keyring which is the same that was used
when adding authentication token.</p>
</div>
<p>Once the job is submitted successfully, the job-id is returned back,
which could be used in order to check the status of the job on the
UI. In the above submission job-id returned is 82287. Visit
<tt class="docutils literal"><span class="pre">http://validation.linaro.org/scheduler/job/<job-id></span></tt> in order to see
the details of the job run.</p>
</div>
<div class="section" id="web-based-job-submission">
<h4>Web Based Job Submission<a class="headerlink" href="#web-based-job-submission" title="Permalink to this headline">¶</a></h4>
<p>Visit <a class="reference external" href="http://validation.linaro.org/scheduler/jobsubmit">http://validation.linaro.org/scheduler/jobsubmit</a> and paste your
json file into the window and click “Submit” button. The job
submission screen is shown below,</p>
<img alt="_images/job-submission-screen.png" src="_images/job-submission-screen.png" />
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If a link to job json file is pasted on the above screen,
the JSON file will be fetched and displayed in the text box
for submission.</p>
</div>
<p>Once the job is successfully submitted, the following screen appears,
from which the user can navigate to the job details or the list of
jobs page.</p>
<img alt="_images/web-ui-job-submission-success.png" src="_images/web-ui-job-submission-success.png" />
<p>Viewing the submitted job will show something like this.</p>
<img alt="_images/job-details.png" src="_images/job-details.png" />
</div>
</div>
<div class="section" id="test-jobs">
<h3>Test Jobs<a class="headerlink" href="#test-jobs" title="Permalink to this headline">¶</a></h3>
<p>In order to run a test, a test definition is required. A test
definition is expressed in YAML format. A minimal test definition
would look like the following</p>
<div class="highlight-python"><div class="highlight"><pre>metadata:
name: passfail
format: "Lava-Test-Shell Test Definition 1.0"
description: "Pass/Fail test."
version: 1.0
run:
steps:
- "lava-test-case passtest --result pass"
- "lava-test-case failtest --result pass"
</pre></div>
</div>
<p>In order to run the above test definition with a minimal job file, the
following job json could be used and submitted in the same way as
explained above</p>
<div class="highlight-python"><div class="highlight"><pre>run:
steps:
- "lava-test-case passtest --result pass"
- "lava-test-case failtest --result pass"
</pre></div>
</div>
<p>In order to run the above test definition with a minimal job file, the
following job json could be used and submitted in the same way as
explained above</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">"job_name"</span><span class="p">:</span> <span class="s">"kvm-test"</span><span class="p">,</span>
<span class="s">"device_type"</span><span class="p">:</span> <span class="s">"kvm"</span><span class="p">,</span>
<span class="s">"timeout"</span><span class="p">:</span> <span class="mi">1800</span><span class="p">,</span>
<span class="s">"actions"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"deploy_linaro_image"</span><span class="p">,</span>
<span class="s">"parameters"</span><span class="p">:</span> <span class="p">{</span>
<span class="s">"image"</span><span class="p">:</span>
<span class="s">"http://images.validation.linaro.org/kvm-debian-wheezy.img.gz"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"lava_test_shell"</span><span class="p">,</span>
<span class="s">"parameters"</span><span class="p">:</span> <span class="p">{</span>
<span class="s">"testdef_urls"</span><span class="p">:</span> <span class="p">[</span>
<span class="s">"http://people.linaro.org/~senthil.kumaran/test.yaml"</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"boot_linaro_image"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">"command"</span><span class="p">:</span> <span class="s">"submit_results"</span><span class="p">,</span>
<span class="s">"parameters"</span><span class="p">:</span> <span class="p">{</span>
<span class="s">"server"</span><span class="p">:</span>
<span class="s">"http://stylesen@validation.linaro.org/RPC2/"</span><span class="p">,</span>
<span class="s">"stream"</span><span class="p">:</span> <span class="s">"/anonymous/test/"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The test definition is uploaded to an URL that will be
accessible over http which is referred in the job json.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Test definitions could be referred from git
repositories. The official upstream Linaro git repository
for test definitions is
<a class="reference external" href="https://git.linaro.org/gitweb?p=qa/test-definitions.git">https://git.linaro.org/gitweb?p=qa/test-definitions.git</a></p>
</div>
</div>
</div>
</div>
<div class="section" id="using-tables-in-lava">
<h1>Using tables in LAVA<a class="headerlink" href="#using-tables-in-lava" title="Permalink to this headline">¶</a></h1>
<p>LAVA presents much of the data about jobs, devices, results and tasks
inside tables. The length of a table can be controlled, the table
can be sorted by selected columns and the data itself can be searched.
All options can be controlled from the query string in the browser
address bar. This allows particular views of a table to be shared as
links. See <a class="reference internal" href="#time-queries"><em>Custom table queries</em></a>.</p>
<p>For pages which only contain a single table, the number of rows displayed
in each page of data is controlled via the <strong>length</strong> parameter. For
convenience, there is a drop down box on the left of each table where the
table length can be selected.</p>
<div class="section" id="table-search-support">
<h2>Table search support<a class="headerlink" href="#table-search-support" title="Permalink to this headline">¶</a></h2>
<p>Unless specified explicitly, all searches are case-sensitive.</p>
<div class="section" id="simple-text-search">
<h3>Simple text search<a class="headerlink" href="#simple-text-search" title="Permalink to this headline">¶</a></h3>
<p>The search box above each table allows arbitrary text strings to be
used as filters on the data within the table. Each table has support for
matching simple text strings against certain columns within the table
and these searches are additive - the data in the row will be included
in the results if the text matches any of the search fields.</p>
<p>The fields which support text search are listed above each table.</p>
</div>
<div class="section" id="custom-table-queries">
<span id="time-queries"></span><h3>Custom table queries<a class="headerlink" href="#custom-table-queries" title="Permalink to this headline">¶</a></h3>
<p>Some tables also support customised queries on specific fields, typically
these will be <strong>time based fields</strong> like <em>submit_time</em>, <em>end_time</em> and
<em>duration</em>. These queries allow a specific function to be called within
the filter to match only results where the timestamp occurred within
the specified number of minutes, hours or days, relative to the current
time on the server.</p>
<p>The queries supported by a table are listed above the table, along with
details of whether that query is based on minutes, hours or days.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Time based queries will always take the current time on the
server into account, so links containing such queries may not give the
same results when viewed at a later time.</p>
</div>
<p>Time based queries can take calculations in the query string as well,
e.g. <tt class="docutils literal"><span class="pre">end_time</span></tt> is based on hours, so <tt class="docutils literal"><span class="pre">?end_time=4*24</span></tt> matches
<tt class="docutils literal"><span class="pre">end_time</span></tt> within the last 4 days (the search summary will still show
the <tt class="docutils literal"><span class="pre">4*24</span></tt>.)</p>
</div>
<div class="section" id="exclusive-table-searches">
<span id="discrete-queries"></span><h3>Exclusive table searches<a class="headerlink" href="#exclusive-table-searches" title="Permalink to this headline">¶</a></h3>
<p>Fields used in simple text searches can also be used as exclusive searches
by adding the exclusive search field to the querystring. The data in
the row will be included in the results only if the text matches all of the
search fields:</p>
<div class="highlight-python"><div class="highlight"><pre>?device=mx5&length=25&description=ARMMP&status=Incom
</pre></div>
</div>
<p>This querystring would only show rows where the <em>device hostname</em> contains
<tt class="docutils literal"><span class="pre">mx5</span></tt> <strong>and</strong> the <em>description</em> contains <tt class="docutils literal"><span class="pre">ARMMP</span></tt> <strong>and</strong> the <em>status</em> of
the job contains <tt class="docutils literal"><span class="pre">Incom</span></tt>, therefore showing up to 25 results for jobs
on such devices with that description which finished with a status of
Incomplete.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Exclusive searches are not supported via the search box in the table
header. Add to the querystring directly.</p>
</div>
<p>Exclusive text search can be combined with simple text search by using
the <strong>search</strong> variable in the querystring.</p>
<div class="highlight-python"><div class="highlight"><pre>?device=mx5&length=25&description=ARMMP&status=Incom&search=single
</pre></div>
</div>
<p>The fields which support exclusive search are listed above each table.</p>
</div>
<div class="section" id="other-filters">
<h3>Other filters<a class="headerlink" href="#other-filters" title="Permalink to this headline">¶</a></h3>
<p>Individual tables may also provide filters via javascript or other
support.</p>
</div>
<div class="section" id="resetting-a-table">
<h3>Resetting a table<a class="headerlink" href="#resetting-a-table" title="Permalink to this headline">¶</a></h3>
<p>The breadcrumb link should take you back to the default table. Alternatively,
clear the querystring in the browser address bar manually.</p>
</div>
<div class="section" id="unavailable-entries">
<h3>Unavailable entries<a class="headerlink" href="#unavailable-entries" title="Permalink to this headline">¶</a></h3>
<p>Certain tables may contain data relating to a <a class="reference internal" href="glossary.html#term-hidden-device-type"><em class="xref std std-term">hidden device type</em></a>
which would show as <tt class="docutils literal"><span class="pre">Unavailable</span></tt> if the user viewing the table does
not own a device of this type. It is not possible to search these tables
for details of the hidden type and the <tt class="docutils literal"><span class="pre">Unavailable</span></tt> label itself does
not match as a search term.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/linaro.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">LAVA Overview</a><ul>
<li><a class="reference internal" href="#what-is-lava">What is LAVA?</a></li>
<li><a class="reference internal" href="#logging-in">Logging In</a><ul>
<li><a class="reference internal" href="#local-user-account">Local User Account</a></li>
<li><a class="reference internal" href="#logging-into-the-validation-lab-in-cambridge">Logging into the validation lab in Cambridge</a></li>
</ul>
</li>
<li><a class="reference internal" href="#authentication-tokens">Authentication Tokens</a></li>
<li><a class="reference internal" href="#lava-tool-overview">lava-tool overview</a><ul>
<li><a class="reference internal" href="#installing-lava-tool">Installing lava-tool</a></li>
<li><a class="reference internal" href="#using-lava-tool">Using lava-tool</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bundle-stream-overview">Bundle Stream Overview</a><ul>
<li><a class="reference internal" href="#what-is-a-bundle-stream">What is a Bundle Stream?</a></li>
<li><a class="reference internal" href="#how-to-setup-a-bundle-stream">How to setup a Bundle Stream?</a></li>
</ul>
</li>
<li><a class="reference internal" href="#submitting-your-first-job">Submitting your first job</a><ul>
<li><a class="reference internal" href="#job-definition">Job Definition</a></li>
<li><a class="reference internal" href="#job-submission">Job Submission</a><ul>
<li><a class="reference internal" href="#command-line-job-submission">Command Line Job Submission</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id3">Job Definition</a></li>
<li><a class="reference internal" href="#id4">Job Submission</a><ul>
<li><a class="reference internal" href="#id5">Command Line Job Submission</a></li>
<li><a class="reference internal" href="#web-based-job-submission">Web Based Job Submission</a></li>
</ul>
</li>
<li><a class="reference internal" href="#test-jobs">Test Jobs</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#using-tables-in-lava">Using tables in LAVA</a><ul>
<li><a class="reference internal" href="#table-search-support">Table search support</a><ul>
<li><a class="reference internal" href="#simple-text-search">Simple text search</a></li>
<li><a class="reference internal" href="#custom-table-queries">Custom table queries</a></li>
<li><a class="reference internal" href="#exclusive-table-searches">Exclusive table searches</a></li>
<li><a class="reference internal" href="#other-filters">Other filters</a></li>
<li><a class="reference internal" href="#resetting-a-table">Resetting a table</a></li>
<li><a class="reference internal" href="#unavailable-entries">Unavailable entries</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">LAVA Manual</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">LAVA Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/overview.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="installation.html" title="LAVA Installation"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="LAVA Manual"
>previous</a> |</li>
<li><a href="index.html">LAVA Server 2014.09.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2014, Linaro Limited.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|