[doc] Explain tests setup
authorDenis Laxalde <denis.laxalde@logilab.fr>
Thu, 18 Dec 2014 11:11:40 +0100
changeset 45 5e3ef3b319cf
parent 44 359eb926e733
child 46 cb011e37fd3c
[doc] Explain tests setup
README
--- a/README	Thu Dec 18 11:03:00 2014 +0100
+++ b/README	Thu Dec 18 11:11:40 2014 +0100
@@ -24,3 +24,21 @@
 which is abstract and should thus subclass by setting its `rtype` attribute.
 
 See ``test/data`` for a minimal example.
+
+
+Testing
+-------
+
+Testing this cube requires a running CKAN instance with a (dedicated)
+organization and a user with editors permission in the organization.
+Corresponding information are expected in the `test/ckanconfig.py` file.
+
+::
+
+    baseurl = '<url-of-ckan-instance>'
+    organization = '<organization-name>'
+    apikey  = '<api-key-of-user-with-editors-permissions-on-organization>'
+
+Note that, since CKAN does not expose an API function to purge datasets, we
+can only *delete* them in tests. So, one has to manually purge test datasets
+from the CKAN at `<baseurl>/ckan-admin/trash`.