Welcome to CleverSheep’s documentation!

CleverSheep is a Python package largely focused on high-level automated testing. It provides a number of features including a test runner, support for custom command line arguments and the ability to write asynchronous tests through the test event store.

Some key features include:

• A built in test runner with a wealth of command line options.
• Support for user defined command line options.
• Support for complex test selection logic.

If you want to raise an issue visit https://gitlab.com/LCaraccio/clever-sheep

If you are interested in only using the event store see https://lcaraccio.gitlab.io/tes-lib

Warning

It is not recommended to use CleverSheep for new projects, see the FAQ for more.

Release Notes

See the Release Notes for the details of each release.

Installation

You can simply install CleverSheep using pip:

pip install CleverSheep

Or if you prefer you can get the latest version from the Downloads page.

FAQ

Got a question, see the FAQ page.

Documentation

• Basics
  • Overview
  • Example Test File
  • Project Root
  • Logging
  • Terminal output
  • Running the tests
  • Marking tests
• CleverSheep Tests
  • The Building Blocks
  • Under The Hood
  • Failure Behaviour
• Command Line Options
  • Behaviour
  • Examples
  • Usage
  • Standard Options
  • Documentation Options
  • Journalling Options
  • Debugging Options
  • Adding user defined options
• CleverSheep Testing Model
  • What is testing?
• Library Options
  • Public Library params
  • Config items
• Poll Manager
  • Basic Use
  • General rules when using the PollManager
  • More about sockets
  • Other Frameworks
• Test Event Store
  • Background
  • Using the TestEventStore
  • Using the store with control.expect
  • Drop events from the event store
• Mock Support
  • What is the purpose of Mocks in high level testing?
  • CleverSheep Mocks
  • A Simple example
• Troubleshooting
  • Common Points
  • Don’t use time.sleep()
  • Where’s my standard out/standard err output?
  • Accessing CleverSheep elements from suite __init__
  • My mock is unreliable
  • I can’t find my event in the event store
• Code Snippets
  • Log the event store contents
  • Output the test results as xml
  • Run a post test check
  • Add a repeating timeout
  • Add custom command line options
  • Use the twisted or tornado event loop managers
  • Track log file changes
  • Standard Imports
• CleverSheep Glossary

Indices and tables

• Index
• Module Index
• Search Page

Credits

CleverSheep contains some code that has been reused or simply copied.

Module	Information
ultraTB.py	A neat module written by Nathan Gray.
Struct.py	Inspired by an ASPN recipe by Brian McErlean. It is possible that some snippits of his code have made it into mine.

If you think this list is incomplete email cleversheepframework@gmail.com and let us know.

A big thanks to the original author of CleverSheep Paul Ollis.