Whether a developer runs CKAN using paster or going through CKAN test suite, there are a number of error messages seen that are the result of setup problems. As people experience them, please add them to the list here.
These instructions assume you have the python virtual environment enabled (. pyenv/bin/activate
) and the current directory is the top of the ckan source, which is probably: ../pyenv/src/ckan/
.
This error can result when you run nosetests for two reasons:
- Pylons nose plugin failed to run. If this is the case, then within a couple of lines of running nosetests you'll see this warning: Unable to load plugin pylons followed by an error message. Fix the error here first.
The Python module 'Pylons' is not installed into you Python environment. Confirm this with:
python -c "import pylons"
This error usually results from running a test which involves search functionality, which requires using a PostgreSQL database, but another (such as SQLite) is configured. The particular test is either missing a @search_related decorator or there is a mixup with the test configuration files leading to the wrong database being used.
The python entry point for the worker has not been generated. This occurs during the 'pip install' of the CKAN source, and needs to be done again if switching from older code that didn't have it. To recitify it:
python setup.py egg_info
This can be caused by an out of date pyc file. Delete all your pyc files and start again:
find . -name "*.pyc" | xargs rm
This is caused by using a version of WebOb that is too new (it has deprecated UnicodeMultiDict). Check the version like this (ensure you have activated your python environment first):
pip freeze | grep -i webob
Now install the version specified in requires/lucid_present.txt. e.g.:
pip install webob==1.0.8
Nose is either unable to find ckan/ckan_nose_plugin.py in the python environment it is running in, or there is an error loading it. If there is an error, this will surface it:
nosetests --version
There are a few things to try to remedy this:
Commonly this is because the nosetests isn't running in the python environment. You need to have nose actually installed in the python environment. To see which you are running, do this:
which nosetests
If you have activated the environment and this still reports
/usr/bin/nosetests
then you need to:pip install --ignore-installed nose
If
nose --version
still fails, ensure that ckan is installed in your environment:cd pyenv/src/ckan python setup.py develop
One final check - the version of nose should be at least 1.0. Check with:
pip freeze | grep -i nose
This can be caused by using repoze.who version 1.0.18 when 1.0.19 is required. Check what you have with:
pip freeze | grep -i repoze.who=
See what version you need with:
grep -f requires/*.txt |grep repoze\.who=
Then install the version you need (having activated the environment):
pip install repoze.who==1.0.19
The sqlalchemy module version is too old.
This occurs when trying to install ApacheMiddleware using a version of Mercurial of 1.7 or later (Lucid comes with 1.4.X). It checks SSL certificates, so you need to provide them in your mercurial config. Edit you ~/.hgrc file and add these two sections to the end:
[web]
cacerts = /etc/ssl/certs/ca-certificates.crt
[hostfingerprints]
hg.3aims.com = A6:4F:F0:24:A7:FB:EF:B4:84:BD:ED:32:10:F1:18:65:B4:67:4B:9D
Now retry just the ApacheMiddleware install:
pip install -e hg+https://hg.3aims.com/public/ApacheMiddleware@tip#egg=apachemiddleware
And it should complete this time.
This suggests that the config file specified with the paster --config
parameter (e.g. myconfig.ini
) is incorrectly formatted. This may be true, but this error is also printed if you specify an incorrect filename for the config file!
This occurs when trying to import migrate.exceptions
and is due to the version of sqlalchemy-migrate being used is too old - check the requires files for the version needed.
This sort of message may be seen if you swap between different branches of CKAN. The .pyc file for database migration 46 exists, but the .py file no longer exists by swapping to an earlier branch. The solution is to delete all pyc files (which is harmless):
find . -name "*.pyc" |xargs rm
This occurs when installing CKAN source to a virtual environment when using an old version of pip. (e.g. pip 0.3.1 which comes with Ubuntu). Instead you should use pip 1.0.2 or higher, which will be found in your virtual environment: pyenv/bin/pip