Top-level README for emtest

Headers

Purpose

Describe the organization of the project directory

State

Written.

About Emtest

Emtest is an extensible, modular testing package for emacs. It is written entirely in Elisp.

It is primarily for emacs but its display and control functionality is designed to accomodate anything that can send and receive its test-report format (TESTRAL).

In addition to its test running and displaying functionality, it includes a number of libraries that are helpful in testing Elisp.

File organization

docs

This directory contains documentation

• design docs
• maintainer docs
• user docs

lisp

Plan of lisp directories for Emtest:

emtest

runner

The test runner in Elisp

testhelp

code not required in emtest but useful in writing tests in Elisp

• Note “standard”, which should probably be loaded more aggressively than the others.
  • Perhaps whenever define is loaded, but let’s keep ‘em separate to leave some flexibility.

testhelp/mocks

Mocks of specific functionality

common

Code shared by viewer and Elisp tester.

viewer

Formatting & display code specific to Emtest

editing

Help for writing and editing elisp tests in emacs.

• When the editing is specific to some file FOO, it should go in FOO/editing.el

persistence

Code dealing with persistence