Python Shell Other
Latest commit 8cb2ef5 Feb 27, 2017 @clebergnu clebergnu Merge remote-tracking branch 'ldoktor/abs-path-settings-dir'
Signed-off-by: Cleber Rosa <crosa@redhat.com>
Permalink
Failed to load latest commit information.
avocado data_dir: Alwas return abspath dir from settings Feb 24, 2017
contrib contrib: Add script which helps bisecting avocado execution Jan 24, 2017
docs Fix names of runners' packages in 46.0 release notes. Feb 20, 2017
etc/avocado sysinfo: Introduce a timeout for Command gathering Feb 7, 2017
examples data_dir: Alwas return abspath dir from settings Feb 24, 2017
libexec scripts.avocado-bash-utils: Add Avocado bash utils Mar 24, 2015
man HTML Result: move rendering code from core to the plugin itself Sep 7, 2016
optional_plugins remote runner: raise an exception when remote job fails Feb 16, 2017
scripts Pylint fixes Nov 7, 2016
selftests data_dir: Alwas return abspath dir from settings Feb 24, 2017
.gitattributes Add .gitattributes, marking some files as binary Apr 6, 2016
.gitignore .gitignore: Add .idea directory Jan 26, 2015
.travis.yml Merge branch 'clebergnu-drop_26_v2' Feb 6, 2017
LICENSE doc: Clarification about GPLv2+/GPLv2 licensing Jan 19, 2015
MANIFEST.in unittests: run them during the build of RPM packages Mar 29, 2015
Makefile Merge remote-tracking branch 'ldoktor/makefile' Feb 10, 2017
README avocado: Add a symbolic link to README.rst -> README Nov 26, 2014
README.rst README.rst: mention make develop (fixes #1496) Sep 29, 2016
VERSION Release 46.0 Feb 14, 2017
avocado.spec Fix #1798 Add missing requirement Feb 18, 2017
requirements-docs.txt HTML Result Plugin: remove plugin requirements from core definition Sep 8, 2016
requirements-selftests.txt update pydot version Nov 4, 2016
requirements-travis.txt Travis: pin setuptools version Feb 10, 2017
requirements.txt Remote/VM/Docker: make them optional plugins Feb 10, 2017
setup.py Remote/VM/Docker: make them optional plugins Feb 10, 2017
spell.ignore Spelling fixes for the 45th release Jan 16, 2017

README.rst

Avocado Test Framework

Avocado is a test framework that is built on the experience accumulated with autotest, while improving on its weaknesses and shortcomings.

The main goal of the Avocado project is to provide a set of smart tools for automated testing and continuous integration. Among them, we can highlight:

  • A powerful test runner;
  • A multiplexer that allows tests to be run with different sets of variables;
  • Test APIs for test writers;
  • A database for results, with a web interface;
  • A scheduler for setting up a test grid.

Using avocado

The most straightforward way of using avocado is to install packages available for your distro:

  1. Fedora/RHEL

    Avocado is not yet officially packed in Fedora/RHEL, but you can use avocado yum repositories by putting corresponding file into /etc/yum.repos.d.

    and install it by yum install avocado (or using dnf)

Once you install it, you can start exploring it by checking the output of avocado --help and the test runner man-page, accessible via man avocado.

If you want to develop avocado, or run it directly from the git repository, you have a couple of options:

  1. The avocado test runner was designed to run in tree, for rapid development prototypes. After running:

    $ make develop
    

    Just use:

    $ scripts/avocado --help
    
  2. Installing avocado in the system is also an option, although remember that distutils has no uninstall functionality:

    $ sudo python setup.py install
    $ avocado --help
    

Documentation

Avocado comes with in tree documentation about the most advanced features and its API. It can be built with sphinx, but a publicly available build of the latest master branch documentation and releases can be seen on read the docs:

http://avocado-framework.readthedocs.org/

If you want to build the documentation yourself:

  1. Make sure you have the package python-sphinx installed. For Fedora:

    $ sudo yum install python-sphinx
    
  2. For Mint/Ubuntu/Debian:

    $ sudo apt-get install python-sphinx
    
  3. Optionally, you can install the read the docs theme, that will make your in-tree documentation look just like the online version:

    $ sudo pip install sphinx_rtd_theme
    
  4. Build the docs:

    $ make -C docs html
    
  5. Once done, point your browser to:

    $ [your-browser] docs/build/html/index.html