Welcome to ufotest’s documentation!

ufotest is a framework for continuous automated hardware testing.

Section Overview

Explanations for the top level sections of this documentation

ufotest

The Github README of the project

Quickstart

Most common instructions to install, setup & configure the application and execute the first test

Getting Started

More in depth explanations of how to setup and configure the system

Command Line Reference

Available command line controls

Concepts

Additional resources about the software architecture for developers

Plugin Development Guide

Guide to develop custom plugins to extend ufotest

Hook Reference

Listing of all available hooks for plugin development

Troubleshooting

Common errors and how to solve them

Advanced Topics

Advanced topics not common enough for the getting started guide

Contents:

• ufotest
  • Installation
  • Usage
  • Development
  • Features
• Quickstart
  • Installation
  • Setup
  • Configuration
  • Running a test case
  • Web Interface
  • Further Reading
• Getting Started
  • Setting up
  • Configuration
  • Working with Plugins
  • Custom Test cases
  • Automated Builds
• Command Line Reference
• Concepts
  • Interaction with the Hardware
  • The plugin system
  • The Hooks System for Plugins
• Plugin Development Guide
  • How to setup a new plugin with Cookiecutter
  • Example 1: A hello world plugin
• Hook Reference
  • plugin_commands - Filter
  • pre_test - Action
  • pre_test_{test_name} - Action

Indices and tables

• Index