[#5] Updated "Test Directory" section
parent
4d50a40577
commit
80577e06b0
|
@ -131,18 +131,29 @@ exists.
|
||||||
@node Test Directory
|
@node Test Directory
|
||||||
@section Test Directory
|
@section Test Directory
|
||||||
The @file{test/} directory contains all the unit tests for the project. ease.js
|
The @file{test/} directory contains all the unit tests for the project. ease.js
|
||||||
follows a test-driven development model. Every single aspect of the framework is
|
follows a test-driven development model; every single aspect of the framework is
|
||||||
tested to ensure that features work as intended both server-side and across all
|
tested to ensure that features work as intended both server-side and across all
|
||||||
supported web browsers. The tests also ensure that bugs are not introduced for
|
supported web browsers. The tests also serve as regression tests, ensuring that
|
||||||
anything that has been covered. This should also give outside developers
|
bugs are not introduced for anything that has been covered. These tests should
|
||||||
confidence. If a developer makes a modification to ease.js and does not cause
|
also give outside developers confidence; if a developer makes a modification to
|
||||||
any failing tests, it's likely that their change didn't have negative
|
ease.js and does not cause any failing tests, it's likely that their change
|
||||||
consequences on the integrity of the framework.
|
didn't have negative consequences on the integrity of the framework.
|
||||||
|
|
||||||
All tests are prefixed with @samp{test-}, followed by the name of the module,
|
ease.js is currently in a transition period in regards to the style of the test
|
||||||
followed optionally by the specific part of the module that is being tested. The
|
cases. Tests written in the original format are prefixed with @samp{test-},
|
||||||
tests are written in JavaScript and use Node.js's @file{assert} module. They may
|
followed by the name of the module, followed optionally by the specific part of
|
||||||
be run individually or at once during the build process.
|
the module that is being tested. Newer test cases are prefixed with the
|
||||||
|
prototype name of the unit being tested, followed by @samp{Test.js}. If there
|
||||||
|
are a number of test cases for a given prototype, any number of tests will be
|
||||||
|
included (with the same suffix) in a directory with the same name as the
|
||||||
|
prototype. The tests are written in JavaScript and use Node.js's @file{assert}
|
||||||
|
module. Newer tests use a test case system that was developed to suit the needs
|
||||||
|
of the project (still using the @file{assert} module). They may be run
|
||||||
|
individually or all at once during the build process.
|
||||||
|
|
||||||
|
Developers interested in contributing to ease.js can aid in this transition
|
||||||
|
process by helping to move all @file{test-*} tests over to the new test case
|
||||||
|
format.
|
||||||
|
|
||||||
In addition, there exists a @file{test/perf/} directory that contains
|
In addition, there exists a @file{test/perf/} directory that contains
|
||||||
performance tests used for benchmarking.
|
performance tests used for benchmarking.
|
||||||
|
|
Loading…
Reference in New Issue