Opened 11 years ago

Last modified 10 years ago

#692 accepted defect

Proper documentation on how to author tests

Reported by: Christopher Allan Webber Owned by:
Priority: major Milestone:
Component: documentation Keywords: test
Cc: Parent Tickets:


We need better documentation on how to author unit tests. This should go in docs/source/devel/ on its own page, maybe "writing tests" or some such.

The following should be mentioned:

  • How to run tests (even though this is covered elsewhere)
  • What tools we use (pytest, webtest)
  • A simple "writing a unit test" example
  • Show to pass an application fixture into a test
  • Show how to set it up with different configs (I can explain this on IRC)

Change History (4)

comment:1 by Emily O'Leary, 11 years ago

Owner: set to Emily O'Leary
Status: newin_progress

As part of my OPW internship I will be implementing this.

comment:2 by Emily O'Leary, 11 years ago

I'm working on this in this repository:

Right now it's in the form of the docs/ folder in plain text but I plan to move it toward reStructuredText.

comment:3 by ShawnRisk, 10 years ago

Keywords: test added

comment:4 by Emily O'Leary, 10 years ago

Owner: Emily O'Leary removed
Status: in_progressaccepted

No progress on this on my end. It would probably be more fruitful to copy what I've written for functional tests and make it into reStructedText and then add more information about how to do Unit Tests.

Note: See TracTickets for help on using tickets.