Plainbox¶
See also
See what’s new in Plainbox 0.17
Plainbox is a toolkit consisting of python3 library, development tools, documentation and examples. It is targeted at developers working on testing or certification applications and authors creating tests for such applications.
Plainbox can be used to both create simple and comprehensive test tools as well as to develop and execute test jobs and test scenarios. It was created as a refined and rewritten core of the Checkbox project. It has a well tested and documented core, small but active development community and a collection of associated projects that use it as a lower-level engine/back-end library.
Plainbox has a novel approach to discovering (and probing) hardware and software that is extensible and not hardwired into the system. It allows test developers to express association between a particular test and the hardware, software and configuration constraints that must be met for the test to execute meaningfully. This feature, along with pluggable test definitions, makes Plainbox flexible and applicable to many diverse testing situations, ranging from mobile phones, traditional desktop computers, servers and up to testing “cloud” installations.
What are you interested in?¶
Are you a test author, application developer or core developer?
Table of contents¶
- Installation
- Basic Usage
- Manual Pages
- CHECKBOX_DATA (7)
- CHECKBOX_SHARE (7)
- PLAINBOX_PROVIDER_DATA (7)
- PLAINBOX_SESSION_SHARE (7)
- plainbox (1)
- plainbox-category-units (7)
- plainbox-check-config (1)
- plainbox-dev (1)
- plainbox-dev-analyze (1)
- plainbox-dev-crash (1)
- plainbox-dev-list (1)
- plainbox-dev-logtest (1)
- plainbox-dev-parse (1)
- plainbox-dev-script (1)
- plainbox-dev-special (1)
- plainbox-device (1)
- plainbox-exporter-units (7)
- plainbox-file-units (7)
- plainbox-job-units (7)
- Extension of the job format
- manage.py
- plainbox-manifest-entry-units (7)
- plainbox-packaging-meta-data-units (7)
- plainbox-qml-shell (1)
- plainbox-run (1)
- plainbox-self-test (1)
- plainbox-session (1)
- plainbox-session-archive (1)
- plainbox-session-export (1)
- plainbox-session-list (1)
- plainbox-session-remove (1)
- plainbox-session-show (1)
- plainbox-session-structure (7)
- plainbox-startprovider (1)
- plainbox-template-units (7)
- plainbox-test-plan-units (7)
- plainbox-trusted-launcher-1
- plainbox.conf (5)
- ChangeLog
- Plainbox 0.25 (unreleased)
- Plainbox 0.24
- Plainbox 0.23
- Plainbox 0.18
- Plainbox 0.17
- Plainbox 0.16
- Plainbox 0.15
- Plainbox 0.14
- Plainbox 0.13
- Plainbox 0.12
- Plainbox 0.11
- Plainbox 0.10
- Plainbox 0.9
- Plainbox 0.8
- Plainbox 0.7
- Plainbox 0.6
- Plainbox 0.5.4
- Plainbox 0.5.3
- Plainbox 0.5.2
- Plainbox 0.5.1
- Plainbox 0.5
- Plainbox 0.4
- Plainbox 0.4 beta 2
- Plainbox 0.4 beta 1
- Plainbox 0.3
- Plainbox 0.2
- Plainbox 0.1
- Job and Test Developers
- Application developers
- Core Developers
- API Reference
plainbox
– main packageplainbox.abc
– abstract base classesplainbox.impl
– implementation packageplainbox.impl.applogic
– application logicplainbox.impl.box
– command line interfaceplainbox.impl.buildsystems
– build system interfacesplainbox.impl.clitools
– support code for command line utilitiesplainbox.impl.color
– ANSI color codesplainbox.impl.commands
– shared code for plainbox sub-commandsplainbox.impl.commands.analyze
– analyze sub-commandplainbox.impl.commands.check_config
– check-config sub-commandplainbox.impl.commands.checkbox
– mix-in for checkbox commandsplainbox.impl.commands.crash
– crash sub-commandplainbox.impl.commands.dev
– dev sub-commandplainbox.impl.commands.list
– list sub-commandplainbox.impl.commands.logtest
– logtest sub-commandplainbox.impl.commands.parser
– parser sub-commandplainbox.impl.commands.run
– run sub-commandplainbox.impl.commands.script
– script sub-commandplainbox.impl.commands.selftest
– selftest sub-commandplainbox.impl.commands.session
– run sub-commandplainbox.impl.commands.special
– special sub-commandplainbox.impl.ctrl
– Controller Classesplainbox.impl.depmgr
plainbox.impl.exporter
– shared code for session state exportersplainbox.impl.exporter.jinja2
– exporter using jinja2 templatesplainbox.impl.exporter.text
– plain text exporterplainbox.impl.highlevel
– High-level APIplainbox.impl.integration_tests
– integration testsplainbox.impl.job
– job definitionplainbox.impl.logging
– configuration for loggingplainbox.impl.parsers
– generic parser interfaceplainbox.impl.pod
plainbox.impl.providers
– providers packageplainbox.impl.providers.special
– various special providersplainbox.impl.providers.v1
– Implementation of V1 providerplainbox.impl.resource
– job resourcesplainbox.impl.result
– job resultplainbox.impl.runner
– job runnerplainbox.impl.secure
– code for external (trusted) launchersplainbox.impl.config
– configurationplainbox.impl.secure.launcher1
– plainbox-trusted-launcher-1plainbox.impl.secure.origin
– origin objectsplainbox.impl.secure.plugins
– interface for accessing extension pointsplainbox.impl.secure.providers
– providers packageplainbox.impl.secure.providers.v1
– Implementation of V1 providerplainbox.impl.secure.qualifiers
– Job Qualifiersplainbox.impl.secure.rfc822
– RFC822 parserplainbox.impl.session
– session handlingplainbox.impl.session.assistant
– session assistantplainbox.impl.session.jobs
– jobs state handlingplainbox.impl.session.manager
– manager for sessionsplainbox.impl.session.resume
– session resume handlingplainbox.impl.session.state
– session state handlingplainbox.impl.session.storage
– storage for sessionsplainbox.impl.session.suspend
– session suspend supportplainbox.impl.symbol
– Symbol Typeplainbox.impl.testing_utils
– plainbox specific test toolsplainbox.impl.transport
– shared code for test data transportsplainbox.impl.unit
– package with all of the unitsplainbox.impl.unit.job
– job unitplainbox.impl.template
– template unitplainbox.impl.xparsers
– parsers for various plainbox formatsplainbox.provider_manager
– CLI tools for managing providersplainbox.testing_utils
- generic testing utilitiesplainbox.testing_utils.cwd
– tools for testing in another directoryplainbox.testing_utils.io
– tools for testing IOplainbox.testing_utils.resource
plainbox.testing_utils.testcases
– additional TestCase classesplainbox.vendor
– vendorized packages
- Glossary