From df29f9f5c9be33b668a0318e3632090378e235fb Mon Sep 17 00:00:00 2001 From: Mario de Frutos Date: Wed, 9 Dec 2015 14:11:27 +0100 Subject: [PATCH] README for integration tests --- test/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 test/README.md diff --git a/test/README.md b/test/README.md new file mode 100644 index 0000000..d1e8028 --- /dev/null +++ b/test/README.md @@ -0,0 +1,20 @@ +# Geocoder API integration tests +This are the automatic integration tests for geocoder api (both client and server) + +### Usage +In order to execute the tests you have to execute the `run_tests` python script: + +``` python run_tests.py [--host=cartodb.com] username api_key``` + +You can define the host where is going to execute the SQL API queries to test the +geocoder API. By default the value is `cartodb.com` but you can put the host you need. + +### Tests + +This suite of tests test the following parts of the geocoding API through the SQL API: + +- Admin 0 functions +- Admin 1 functions +- Named places functions +- Postal code functions +- Ip address functions