aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntonio Terceiro <antonio.terceiro@linaro.org>2014-05-09 16:44:33 -0300
committerAntonio Terceiro <antonio.terceiro@linaro.org>2014-05-09 16:44:33 -0300
commit9880951bb7a1ecb0a3602f7f1af1d08e4713fbd5 (patch)
tree02364bcc257385b1f571e756521b349e1640a0fd
parent9cf5f0f41a2b3a3c5e651cfc47ba2ccfa8a927fb (diff)
parentd54e5433231d40c59fec95392cb3f7d3e73daac3 (diff)
Merge tag 'upstream/0.11.1'
Upstream version 0.11.1 # gpg: Signature made Sex 09 Mai 2014 16:44:30 BRT using RSA key ID CD460BDE # gpg: Good signature from "Antonio Terceiro <terceiro@softwarelivre.org>" # gpg: aka "Antonio Terceiro <terceiro@dcc.ufba.br>" # gpg: aka "Antonio Terceiro <terceiro@colivre.coop.br>" # gpg: aka "Antonio Terceiro <terceiro@debian.org>" # gpg: aka "Antonio Terceiro <antonio.terceiro@linaro.org>" # gpg: aka "Antonio Terceiro <terceiro@cs.ubc.ca>"
-rw-r--r--MANIFEST.in1
-rw-r--r--PKG-INFO2
-rw-r--r--lava_tool.egg-info/PKG-INFO2
-rw-r--r--lava_tool.egg-info/SOURCES.txt6
-rw-r--r--man/Makefile153
-rw-r--r--man/conf.py213
-rw-r--r--man/index.rst4
-rw-r--r--man/lava-tool.rst465
-rwxr-xr-xsetup.py3
9 files changed, 844 insertions, 5 deletions
diff --git a/MANIFEST.in b/MANIFEST.in
index e269e45..6b9b5dc 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -11,6 +11,7 @@ include README
include setup.py
include setup.cfg
include integration-tests
+include man/*
recursive-include integration-tests.d/ *
recursive-include lava/ *.py
recursive-include lava_dashboard_tool/ *.py
diff --git a/PKG-INFO b/PKG-INFO
index 74a95bb..27e07b3 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: lava-tool
-Version: 0.11
+Version: 0.11.1
Summary: Command line utility for Linaro validation services
Home-page: https://launchpad.net/lava-tool
Author: Zygmunt Krynicki
diff --git a/lava_tool.egg-info/PKG-INFO b/lava_tool.egg-info/PKG-INFO
index 74a95bb..27e07b3 100644
--- a/lava_tool.egg-info/PKG-INFO
+++ b/lava_tool.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: lava-tool
-Version: 0.11
+Version: 0.11.1
Summary: Command line utility for Linaro validation services
Home-page: https://launchpad.net/lava-tool
Author: Zygmunt Krynicki
diff --git a/lava_tool.egg-info/SOURCES.txt b/lava_tool.egg-info/SOURCES.txt
index d89f612..b31b369 100644
--- a/lava_tool.egg-info/SOURCES.txt
+++ b/lava_tool.egg-info/SOURCES.txt
@@ -83,4 +83,8 @@ lava_tool/tests/__init__.py
lava_tool/tests/test_auth_commands.py
lava_tool/tests/test_authtoken.py
lava_tool/tests/test_commands.py
-lava_tool/tests/test_utils.py \ No newline at end of file
+lava_tool/tests/test_utils.py
+man/Makefile
+man/conf.py
+man/index.rst
+man/lava-tool.rst \ No newline at end of file
diff --git a/man/Makefile b/man/Makefile
new file mode 100644
index 0000000..64c999e
--- /dev/null
+++ b/man/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LAVATool.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LAVATool.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/LAVATool"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LAVATool"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/man/conf.py b/man/conf.py
new file mode 100644
index 0000000..9245ba0
--- /dev/null
+++ b/man/conf.py
@@ -0,0 +1,213 @@
+# -*- coding: utf-8 -*-
+#
+# LAVA Server documentation build configuration file, created by
+# sphinx-quickstart on Mon Dec 27 16:39:47 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.append(os.path.abspath('..'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage']
+
+# Configuration for sphinx.ext.todo
+todo_include_todos = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'LAVA Tool'
+copyright = u'2010-2013, Linaro Limited'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+import versiontools
+import lava.tool
+version = "%d.%d" % lava.tool.__version__[0:2]
+# The full version, including alpha/beta/rc tags.
+release = versiontools.format_version(lava.tool.__version__)
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'LAVADocumentation'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'LAVATool.tex', u'LAVA Tool Documentation',
+ u'Linaro Validation Team', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('lava-tool', 'lava-tool', u'LAVA Tool Command Line Support',
+ [u'Linaro Validation Team'], 1)
+]
diff --git a/man/index.rst b/man/index.rst
new file mode 100644
index 0000000..f1d4c9e
--- /dev/null
+++ b/man/index.rst
@@ -0,0 +1,4 @@
+.. toctree::
+ :maxdepth: 2
+
+ lava-tool.rst
diff --git a/man/lava-tool.rst b/man/lava-tool.rst
new file mode 100644
index 0000000..42ed653
--- /dev/null
+++ b/man/lava-tool.rst
@@ -0,0 +1,465 @@
+Description
+============
+
+Summary
+#######
+
+``lava-tool`` is a command-line tool to interact with LAVA.
+
+Usage
+#####
+
+lava-tool [-h] <subcommand> [args]
+
+Optional arguments
+##################
+
+ -h, --help show this help message and exit
+
+Subcommands
+###########
+
+Type ``lava-tool <subcommand> -h`` for help on a specific subcommand.
+
+Available subcommands
+#####################
+
+data-views
+ Show data views defined on the server
+
+ Usage:
+ lava-tool data-views [-h] --dashboard-url URL [--verbose-xml-rpc]
+ [--experimental-notice]
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+ Experimental commands:
+ --experimental-notice
+ Explain the nature of experimental commands
+
+job-output
+ Get job output from the scheduler
+
+ Usage:
+ lava-tool job-output [-h] [--overwrite] [--output OUTPUT] SERVER JOB_ID
+
+ Positional arguments:
+ SERVER
+ Host to download job output from
+ JOB_ID
+ Job ID to download output file
+
+ Optional arguments:
+ -h, --help show this help message and exit
+ --overwrite Overwrite files on the local disk
+ --output OUTPUT, -o OUTPUT
+ Alternate name of the output file
+
+help
+ Show a summary of all available commands
+
+deserialize
+ Deserialize a bundle on the server
+
+ Usage:
+ lava-tool deserialize [-h] --dashboard-url URL [--verbose-xml-rpc] SHA1
+
+ Positional arguments:
+ SHA1
+ SHA1 of the bundle to deserialize
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+get
+ Download a bundle from the server
+
+ Usage:
+ lava-tool get [-h] --dashboard-url URL [--verbose-xml-rpc]
+ [--overwrite] [--output OUTPUT] SHA1
+
+ Positional arguments:
+ SHA1
+ SHA1 of the bundle to download
+
+ Optional arguments:
+ -h, --help show this help message and exit
+ --overwrite Overwrite files on the local disk
+ --output OUTPUT, -o OUTPUT Alternate name of the output file
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+auth-add
+ Add an authentication token
+
+ Usage:
+ lava-tool auth-add [-h] [--token-file TOKEN_FILE] [--no-check] HOST
+
+ Positional arguments:
+ HOST
+ Endpoint to add token for, in the form scheme://username@host. The
+ username will default to the currently logged in user.
+
+ Optional arguments:
+ -h, --help show this help message and exit
+ --token-file TOKEN_FILE
+ Read the secret from here rather than prompting
+ for it.
+ --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.
+
+put
+ Upload a bundle on the server
+
+ Usage:
+ lava-tool put [-h] --dashboard-url URL [--verbose-xml-rpc] LOCAL
+ [REMOTE]
+
+ Positional arguments:
+ LOCAL
+ pathname on the local file system
+ REMOTE
+ pathname on the server
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+bundles
+ Show bundles in the specified stream
+
+ Usage:
+ lava-tool bundles [-h] --dashboard-url URL [--verbose-xml-rpc]
+ [PATHNAME]
+
+ Positional arguments:
+ PATHNAME
+ pathname on the server (defaults to /anonymous/)
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+server-version
+ Display dashboard server version
+
+ Usage:
+ lava-tool server-version [-h] --dashboard-url URL [--verbose-xml-rpc]
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+cancel-job
+ Cancel job
+
+ Usage:
+ lava-tool cancel-job [-h] SERVER JOB_ID
+
+ Positional arguments:
+ SERVER
+ Host to cancel job on
+ JOB_ID
+ Job ID to cancel
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+resubmit-job
+ Resubmit job
+
+ Usage:
+ lava-tool resubmit-job [-h] SERVER JOB_ID
+
+ Positional arguments:
+ SERVER
+ Host to resubmit job on
+ JOB_ID
+ Job ID to resubmit
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+version
+ Show dashboard client version
+
+ Usage:
+ lava-tool version [-h]
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+restore
+ Restore a dashboard instance from backup
+
+ Usage:
+ lava-tool restore [-h] --dashboard-url URL [--verbose-xml-rpc]
+ BACKUP_DIR
+
+ Positional arguments:
+ BACKUP_DIR
+ Directory to backup from
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+query-data-view
+ Invoke a specified data view
+
+ Usage:
+ lava-tool restore [-h] --dashboard-url URL [--verbose-xml-rpc]
+ [--experimental-notice] QUERY
+
+ Positional arguments:
+ QUERY
+ Data view name and any optional and required arguments
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+ Experimental commands:
+ --experimental-notice Explain the nature of experimental commands
+
+submit-job
+ Submit a job to lava-scheduler
+
+ Usage:
+ lava-tool submit-job [-h] SERVER JSON_FILE
+
+ Positional arguments:
+ SERVER
+ Host to resubmit job on
+ JSON_FILE
+ JSON file with test defenition to submit
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Experimental commands:
+ --experimental-notice Explain the nature of experimental commands
+
+streams
+ Show streams you have access to
+
+ Usage:
+ lava-tool streams [-h] --dashboard-url URL [--verbose-xml-rpc]
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+backup
+ Backup data uploaded to a dashboard instance.
+
+ Usage:
+ lava-tool backup [-h] --dashboard-url URL [--verbose-xml-rpc]
+ BACKUP_DIR
+
+ Positional arguments:
+ BACKUP_DIR
+ Directory to backup to
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+ Not all data is preserved. The following data is lost: identity of the
+ user that uploaded each bundle, time of uploading and deserialization on
+ the server, name of the bundle stream that contained the data.
+
+make-stream
+ Create a bundle stream on the server
+
+ Usage:
+ lava-tool make-stream [-h] --dashboard-url URL [--verbose-xml-rpc]
+ [--name NAME] pathname
+
+ Positional arguments:
+ pathname
+ Pathname of the bundle stream to create
+
+ Optional arguments:
+ -h, --help show this help message and exit
+ --name NAME Name of the bundle stream (description)
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+pull
+ Copy bundles and bundle streams from one dashboard to another
+
+ Usage:
+ lava-tool pull [-h] --dashboard-url URL [--verbose-xml-rpc]
+ [--experimental-notice] FROM [STREAM [STREAM ...]]
+
+ Positional arguments:
+ FROM
+ URL of the remote validation dashboard
+
+ Optional arguments:
+ -h, --help show this help message and exit
+
+ Dashboard specific arguments:
+ --dashboard-url URL URL of your validation dashboard
+
+ STREAM
+ Streams to pull from (all by default)
+
+ Debugging arguments:
+ --verbose-xml-rpc Show XML-RPC data
+
+ Experimental commands:
+ --experimental-notice Explain the nature of experimental commands
+
+ This command checks for two environment varialbes: The value of
+ DASHBOARD_URL is used as a replacement for --dashbard-url. The value of
+ REMOTE_DASHBOARD_URL as a replacement for FROM. Their presence
+ automatically makes the corresponding argument optional.
+
+
+LAVA test definitions
+#####################
+
+A LAVA Test Definition comprises of two parts:
+
+* the data to setup the test, expressed as a JSON file.
+* the instructions to run inside the test, expressed as a YAML file.
+
+This allows the same tests to be easily migrated to a range of different
+devices, environments and purposes by using the same YAML files in
+multiple JSON files. It also allows tests to be built from a range of
+components by aggregating YAML files inside a single JSON file.
+
+Contents of the JSON file
+#########################
+
+The JSON file is submitted to the LAVA server and contains:
+
+* Demarcation as a health check or a user test.
+* The default timeout of each action within the test.
+* The logging level for the test, DEBUG or INFO.
+* The name of the test, shown in the list of jobs.
+* The location of all support files.
+* All parameters necessary to use the support files.
+* The declaration of which device(s) to use for the test.
+* The location to which the results should be uploaded.
+* The JSON determines how the test is deployed onto the device and
+ where to find the tests to be run.
+
+Basic JSON file
+###############
+
+Your first LAVA test should use the ``DEBUG`` logging level so that it
+is easier to see what is happening.
+
+A suitable ``timeout`` for your first tests is 900 seconds.
+
+Make the ``job_name`` descriptive and explanatory, you will want to be
+able to tell which job is which when reviewing the results.
+
+Make sure the ``device_type`` matches exactly with one of the suitable
+device types listed on the server to which you want to submit this job.
+
+Change the stream to one to which you are allowed to upload results, on
+your chosen server.
+
+::
+
+ {
+ "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/"
+ }
+ }
+ ]
+ }
+
+Note
+####
+
+Always check your JSON syntax. A useful site for this is http://jsonlint.com.
diff --git a/setup.py b/setup.py
index 2d0459a..aea1622 100755
--- a/setup.py
+++ b/setup.py
@@ -25,7 +25,7 @@ entry_points = open(join(dirname(__file__), 'entry_points.ini')).read()
setup(
name='lava-tool',
- version=":versiontools:lava.tool:__version__",
+ version="0.11.1",
author="Zygmunt Krynicki",
author_email="zygmunt.krynicki@linaro.org",
namespace_packages=['lava'],
@@ -54,7 +54,6 @@ setup(
'versiontools >= 1.3.1',
'pyxdg >= 0.19',
],
- setup_requires=['versiontools >= 1.3.1'],
tests_require=[
'mocker >= 1.0',
'mock >= 0.7.2'