From 27d9e60d0f796b2e7c7fdb02f6608b6a79971bc9 Mon Sep 17 00:00:00 2001 From: Blade Barringer Date: Thu, 22 Oct 2015 20:05:31 -0500 Subject: [PATCH] Update api legacy test readme --- test/api-legacy/README.md | 33 +++------------------------------ 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/test/api-legacy/README.md b/test/api-legacy/README.md index 2f3dc40681..9157af554d 100644 --- a/test/api-legacy/README.md +++ b/test/api-legacy/README.md @@ -1,32 +1,5 @@ -# API Tests +# Legacy API Tests -Our API tests are written in [coffeescript](http://coffeescript.org/) using the [Mocha testing framework](http://mochajs.org/). +These tests have been deprecated. Any tests that you see in this folder should be converted to ES2015 and ported to the `/test/api` directory. -There's a variety of ways to run the tests: - -```bash -# Individually -mocha test/api/name_of_test.coffee -# The entire collection of api tests -mocha test/api -# As part of the whole test suite -npm test -``` - -### Modules - -Some modules are declared in the [api-helper.coffee](api-helper.coffee) file for use in any of the api tests: - -* `moment` - time manipulation -* `async` - run async processes, good for before blocks -* `lodash (_)` - many utilities -* `shared` - generate uuids -* `expect` - making assertions -* `User` - look up a User in the db - -### Helper Methods - -There are helper methods declared in the [api-helper.coffee](api-helper.coffee) file. Some useful methods contained there: - -* `registerNewUser(callback, main)` - Theres a global user variable that gets overwritten with the new user whenever you call `registerNewUser` unless you pass false in as the second argument. -* `registerManyUsers(number, callback)` - Good for testing things that require many users. The callback function returns new users as and array in the second argument. +Once all tests have been ported, this directory will be removed.