# HG changeset patch
# User Denis Laxalde <denis.laxalde@logilab.fr>
# Date 1453105387 -3600
# Node ID 8c3155a0ae5b512af4255ce6d60a71f02ede4c33
# Parent  fdadf59be6127af520ad9095b07ddbfbbf6a0a9b
Handle virtualenv development mode

Looking for VIRTUAL_ENV environment variable as a sign of virtualenv
activation. This at least works for developing CubicWeb itself (not sure yet
about cubes). And it makes `tox --develop` work as well.

Add a test for cwconfig._find_prefix within a virtualenv.

In tox.ini, use `develop option`_ accordingly. This makes tox running
significantly faster since it avoids building and installing the sdist. Aside,
the "develop" install is now performed *after* all test requirements are
processed, which means that the cubicweb package should always be the one from
source -- instead of a released version pulled by a cube through test
dependencies, which may occur in "recreate" step.


.. _`develop option`: <http://tox.readthedocs.org/en/latest/config.html#confval-usedevelop=BOOL

diff -r fdadf59be612 -r 8c3155a0ae5b cubicweb/cwconfig.py
--- a/cubicweb/cwconfig.py	Thu Jan 14 18:17:23 2016 +0100
+++ b/cubicweb/cwconfig.py	Mon Jan 18 09:23:07 2016 +0100
@@ -23,7 +23,7 @@
 -------------
 
 Standard resource mode
-```````````````````````````
+``````````````````````
 
 A resource *mode* is a predefined set of settings for various resources
 directories, such as cubes, instances, etc. to ease development with the
@@ -44,24 +44,23 @@
   - temporary files (such as pid file) in :file:`/tmp`
 
 
-
-
 .. _CubicwebWithinVirtualEnv:
 
 Within virtual environment
-```````````````````````````
+``````````````````````````
 
 If you are not administrator of you machine or if you need to play with some
-specific version of |cubicweb| you can use `virtualenv`_ a tool to create
+specific version of |cubicweb| you can use virtualenv_ a tool to create
 isolated Python environments.
 
 - instances are stored in :file:`<VIRTUAL_ENV>/etc/cubicweb.d`
 - temporary files (such as pid file) in :file:`<VIRTUAL_ENV>/var/run/cubicweb`
 
-.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _virtualenv: http://pypi.python.org/pypi/virtualenv
+
 
 Custom resource location
-````````````````````````````````
+````````````````````````
 
 Notice that each resource path may be explicitly set using an environment
 variable if the default doesn't suit your needs. Here are the default resource
@@ -81,6 +80,7 @@
 
 Cubes search path is also affected, see the :ref:`Cube` section.
 
+
 Setting Cubicweb Mode
 `````````````````````
 
@@ -100,11 +100,14 @@
 
 .. _`cubicweb is used from a mercurial repository`: CubicwebDevelopmentMod_
 
+
 .. _CubicwebDevelopmentMod:
 
-Development Mode
-`````````````````````
-If :file:`.hg` directory is found into the cubicweb package, there are specific resource rules.
+Development Mode (source)
+`````````````````````````
+
+If :file:`.hg` directory is found into the cubicweb package, there are
+specific resource rules.
 
 `<CW_SOFTWARE_ROOT>` is the source checkout's ``cubicweb`` directory:
 
@@ -116,6 +119,16 @@
   instead of `<INSTALL_PREFIX>/share/cubicweb/migration/`.
 
 
+Development Mode (virtualenv)
+`````````````````````````````
+
+If a virtualenv is found to be activated (i.e. a VIRTUAL_ENV variable is found
+in environment), the virtualenv root is used as `<INSTALL_PREFIX>`. This, in
+particular, makes it possible to work in `setuptools development mode`_
+(``python setup.py develop``) without any further configuration.
+
+.. _`setuptools development mode`: https://pythonhosted.org/setuptools/setuptools.html#development-mode
+
 .. _ConfigurationEnv:
 
 Environment configuration
@@ -220,24 +233,34 @@
                                  % (directory, modes))
     return modes[0]
 
-def _find_prefix(start_path=CW_SOFTWARE_ROOT):
-    """Runs along the parent directories of *start_path* (default to cubicweb source directory)
-    looking for one containing a 'share/cubicweb' directory.
-    The first matching directory is assumed as the prefix installation of cubicweb
+def _find_prefix(start_path=None):
+    """Return the prefix path of CubicWeb installation.
 
-    Returns the matching prefix or None.
+    Walk parent directories of `start_path` looking for one containing a
+    'share/cubicweb' directory. The first matching directory is assumed as the
+    prefix installation of CubicWeb.
+
+    If run from within a virtualenv, the virtualenv root is used as
+    `start_path`. Otherwise, `start_path` defaults to cubicweb package
+    directory path.
     """
-    prefix = start_path
+    if start_path is None:
+        try:
+            prefix = os.environ['VIRTUAL_ENV']
+        except KeyError:
+            prefix = CW_SOFTWARE_ROOT
+    else:
+        prefix = start_path
+    if not isdir(prefix):
+        prefix = dirname(prefix)
     old_prefix = None
-    if not isdir(start_path):
-        prefix = dirname(start_path)
     while (not isdir(join(prefix, 'share', 'cubicweb'))
-          or prefix.endswith('.egg')) and prefix != old_prefix:
+           or prefix.endswith('.egg')):
+        if prefix == old_prefix:
+            return sys.prefix
         old_prefix = prefix
         prefix = dirname(prefix)
-    if isdir(join(prefix, 'share', 'cubicweb')):
-        return prefix
-    return sys.prefix
+    return prefix
 
 # persistent options definition
 PERSISTENT_OPTIONS = (
@@ -333,7 +356,10 @@
 
     quick_start = False
 
-    if (CWDEV and _forced_mode != 'system'):
+    if 'VIRTUAL_ENV' in os.environ:
+        _CUBES_DIR = join(_INSTALL_PREFIX, 'share', 'cubicweb', 'cubes')
+        mode = 'user'
+    elif CWDEV and _forced_mode != 'system':
         mode = 'user'
         _CUBES_DIR = join(CW_SOFTWARE_ROOT, '../../cubes')
     else:
diff -r fdadf59be612 -r 8c3155a0ae5b cubicweb/test/unittest_cwconfig.py
--- a/cubicweb/test/unittest_cwconfig.py	Thu Jan 14 18:17:23 2016 +0100
+++ b/cubicweb/test/unittest_cwconfig.py	Mon Jan 18 09:23:07 2016 +0100
@@ -218,5 +218,17 @@
         prefix = tempfile.tempdir
         self.assertEqual(_find_prefix(prefix), sys.prefix)
 
+    @with_tempdir
+    def test_virtualenv(self):
+        venv = os.environ.get('VIRTUAL_ENV')
+        try:
+            prefix = os.environ['VIRTUAL_ENV'] = tempfile.tempdir
+            self.make_dirs('share', 'cubicweb')
+            self.assertEqual(_find_prefix(), prefix)
+        finally:
+            if venv:
+                os.environ['VIRTUAL_ENV'] = venv
+
+
 if __name__ == '__main__':
     unittest_main()
diff -r fdadf59be612 -r 8c3155a0ae5b tox.ini
--- a/tox.ini	Thu Jan 14 18:17:23 2016 +0100
+++ b/tox.ini	Mon Jan 18 09:23:07 2016 +0100
@@ -2,6 +2,7 @@
 envlist = cubicweb,dataimport,devtools,entities,etwist,ext,hooks,server,sobjects,web,wsgi
 
 [testenv]
+usedevelop = True
 sitepackages = True
 deps =
   cubicweb: -r{toxinidir}/cubicweb/test/requirements.txt