[config] Make available_cubes aware of cubes installed as packages
For this add a "cubicweb.cubes" entry points group which will be scanned
through to find out installed cubes. Entries in this group are expected to
expose the module name of a cube (i.e. `cubicweb_foo`).
Note that CubicWebConfiguration's available_cubes method will return the
module name of cubes as packages (cubicweb_foo), so we had to add a special
"key" sorting function to keep cubes sorted as before, despite possible
different distribution schemes. This makes it possible to handle loading of
CTL plugins in an almost similar manner as before (just tweaking the package
name from cube name in load_cwctl_plugins method).
I had to tweak (again?) the test_cubes_path method in unittest_cwconfig.py but
did not find out why.
Apart from unforeseen bugs and pending documentation, this finishes the work
on porting cubes to standard Python packages. Closes #13001466.
# copyright 2003-2012 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>.
"""cubicweb.cwconfig unit tests"""
import sys
import os
import tempfile
from os.path import dirname, join, abspath
from pkg_resources import EntryPoint, Distribution
import unittest
from mock import patch
from six import PY3
from logilab.common.modutils import cleanup_sys_modules
from logilab.common.testlib import with_tempdir
from logilab.common.changelog import Version
from cubicweb.devtools import ApptestConfiguration, testlib
from cubicweb.cwconfig import _find_prefix
def unabsolutize(path):
parts = path.split(os.sep)
for i, part in reversed(tuple(enumerate(parts))):
if part.startswith('cubicweb_'):
return os.sep.join([part[len('cubicweb_'):]] + parts[i+1:])
if part.startswith('cubicweb') or part == 'legacy_cubes':
return os.sep.join(parts[i+1:])
raise Exception('duh? %s' % path)
class CubicWebConfigurationTC(testlib.BaseTestCase):
@classmethod
def setUpClass(cls):
sys.path.append(cls.datapath('libpython'))
@classmethod
def tearDownClass(cls):
sys.path.remove(cls.datapath('libpython'))
def setUp(self):
self.config = ApptestConfiguration('data', __file__)
self.config._cubes = ('email', 'file')
def tearDown(self):
ApptestConfiguration.CUBES_PATH = []
def iter_entry_points(group, name):
"""Mock pkg_resources.iter_entry_points to yield EntryPoint from
packages found in test/data/libpython even though these are not
installed.
"""
libpython = CubicWebConfigurationTC.datapath('libpython')
prefix = 'cubicweb_'
for pkgname in os.listdir(libpython):
if not pkgname.startswith(prefix):
continue
location = join(libpython, pkgname)
yield EntryPoint(pkgname[len(prefix):], pkgname,
dist=Distribution(location))
@patch('pkg_resources.iter_entry_points', side_effect=iter_entry_points)
def test_available_cubes(self, mock_iter_entry_points):
expected_cubes = [
'card', 'cubicweb_comment', 'cubicweb_email', 'file',
'cubicweb_file', 'cubicweb_forge', 'localperms',
'cubicweb_mycube', 'tag',
]
self._test_available_cubes(expected_cubes)
mock_iter_entry_points.assert_called_once_with(
group='cubicweb.cubes', name=None)
def _test_available_cubes(self, expected_cubes):
self.assertEqual(self.config.available_cubes(), expected_cubes)
def test_reorder_cubes(self):
# forge depends on email and file and comment
# email depends on file
self.assertEqual(self.config.reorder_cubes(['file', 'email', 'forge']),
('forge', 'email', 'file'))
self.assertEqual(self.config.reorder_cubes(['email', 'file', 'forge']),
('forge', 'email', 'file'))
self.assertEqual(self.config.reorder_cubes(['email', 'forge', 'file']),
('forge', 'email', 'file'))
self.assertEqual(self.config.reorder_cubes(['file', 'forge', 'email']),
('forge', 'email', 'file'))
self.assertEqual(self.config.reorder_cubes(['forge', 'file', 'email']),
('forge', 'email', 'file'))
self.assertEqual(self.config.reorder_cubes(('forge', 'email', 'file')),
('forge', 'email', 'file'))
def test_reorder_cubes_recommends(self):
from cubicweb_comment import __pkginfo__ as comment_pkginfo
self._test_reorder_cubes_recommends(comment_pkginfo)
def _test_reorder_cubes_recommends(self, comment_pkginfo):
comment_pkginfo.__recommends_cubes__ = {'file': None}
try:
# email recommends comment
# comment recommends file
self.assertEqual(self.config.reorder_cubes(('forge', 'email', 'file', 'comment')),
('forge', 'email', 'comment', 'file'))
self.assertEqual(self.config.reorder_cubes(('forge', 'email', 'comment', 'file')),
('forge', 'email', 'comment', 'file'))
self.assertEqual(self.config.reorder_cubes(('forge', 'comment', 'email', 'file')),
('forge', 'email', 'comment', 'file'))
self.assertEqual(self.config.reorder_cubes(('comment', 'forge', 'email', 'file')),
('forge', 'email', 'comment', 'file'))
finally:
comment_pkginfo.__recommends_cubes__ = {}
def test_expand_cubes(self):
self.assertEqual(self.config.expand_cubes(('email', 'comment')),
['email', 'comment', 'file'])
def test_appobjects_path(self):
path = [unabsolutize(p) for p in self.config.appobjects_path()]
self.assertEqual(path[0], 'entities')
self.assertCountEqual(path[1:4], ['web/views', 'sobjects', 'hooks'])
self.assertEqual(path[4], 'file/entities')
self.assertCountEqual(path[5:7],
['file/views.py', 'file/hooks'])
self.assertEqual(path[7], 'email/entities.py')
self.assertCountEqual(path[8:10],
['email/views', 'email/hooks.py'])
self.assertEqual(path[10:], ['test/data/entities.py', 'test/data/views.py'])
class CubicWebConfigurationWithLegacyCubesTC(CubicWebConfigurationTC):
@classmethod
def setUpClass(cls):
pass
@classmethod
def tearDownClass(cls):
pass
def setUp(self):
self.custom_cubes_dir = self.datapath('legacy_cubes')
cleanup_sys_modules([self.custom_cubes_dir, ApptestConfiguration.CUBES_DIR])
super(CubicWebConfigurationWithLegacyCubesTC, self).setUp()
self.config.__class__.CUBES_PATH = [self.custom_cubes_dir]
self.config.adjust_sys_path()
def tearDown(self):
ApptestConfiguration.CUBES_PATH = []
def test_available_cubes(self):
expected_cubes = sorted(set([
# local cubes
'comment', 'email', 'file', 'forge', 'mycube',
# test dependencies
'card', 'file', 'localperms', 'tag',
]))
self._test_available_cubes(expected_cubes)
def test_reorder_cubes_recommends(self):
from cubes.comment import __pkginfo__ as comment_pkginfo
self._test_reorder_cubes_recommends(comment_pkginfo)
def test_cubes_path(self):
# make sure we don't import the email cube, but the stdlib email package
import email
self.assertNotEqual(dirname(email.__file__), self.config.CUBES_DIR)
self.config.__class__.CUBES_PATH = [self.custom_cubes_dir]
self.assertEqual(self.config.cubes_search_path(),
[self.custom_cubes_dir, self.config.CUBES_DIR])
self.config.__class__.CUBES_PATH = [self.custom_cubes_dir,
self.config.CUBES_DIR, 'unexistant']
# filter out unexistant and duplicates
self.assertEqual(self.config.cubes_search_path(),
[self.custom_cubes_dir,
self.config.CUBES_DIR])
self.assertIn('mycube', self.config.available_cubes())
# test cubes python path
self.config.adjust_sys_path()
import cubes
self.assertEqual(cubes.__path__, self.config.cubes_search_path())
# this import should succeed once path is adjusted
from cubes import mycube
self.assertEqual(mycube.__path__, [join(self.custom_cubes_dir, 'mycube')])
# file cube should be overriden by the one found in data/cubes
if sys.modules.pop('cubes.file', None) and PY3:
del cubes.file
from cubes import file
self.assertEqual(file.__path__, [join(self.custom_cubes_dir, 'file')])
class FindPrefixTC(unittest.TestCase):
def make_dirs(self, *args):
path = join(tempfile.tempdir, *args)
if not os.path.exists(path):
os.makedirs(path)
return path
def make_file(self, *args):
self.make_dirs(*args[: -1])
file_path = join(tempfile.tempdir, *args)
file_obj = open(file_path, 'w')
file_obj.write('""" None """')
file_obj.close()
return file_path
@with_tempdir
def test_samedir(self):
prefix = tempfile.tempdir
self.make_dirs('share', 'cubicweb')
self.assertEqual(_find_prefix(prefix), prefix)
@with_tempdir
def test_samedir_filepath(self):
prefix = tempfile.tempdir
self.make_dirs('share', 'cubicweb')
file_path = self.make_file('bob.py')
self.assertEqual(_find_prefix(file_path), prefix)
@with_tempdir
def test_dir_inside_prefix(self):
prefix = tempfile.tempdir
self.make_dirs('share', 'cubicweb')
dir_path = self.make_dirs('bob')
self.assertEqual(_find_prefix(dir_path), prefix)
@with_tempdir
def test_file_in_dir_inside_prefix(self):
prefix = tempfile.tempdir
self.make_dirs('share', 'cubicweb')
file_path = self.make_file('bob', 'toto.py')
self.assertEqual(_find_prefix(file_path), prefix)
@with_tempdir
def test_file_in_deeper_dir_inside_prefix(self):
prefix = tempfile.tempdir
self.make_dirs('share', 'cubicweb')
file_path = self.make_file('bob', 'pyves', 'alain', 'adim', 'syt', 'toto.py')
self.assertEqual(_find_prefix(file_path), prefix)
@with_tempdir
def test_multiple_candidate_prefix(self):
self.make_dirs('share', 'cubicweb')
prefix = self.make_dirs('bob')
self.make_dirs('bob', 'share', 'cubicweb')
file_path = self.make_file('bob', 'pyves', 'alain', 'adim', 'syt', 'toto.py')
self.assertEqual(_find_prefix(file_path), prefix)
@with_tempdir
def test_sister_candidate_prefix(self):
prefix = tempfile.tempdir
self.make_dirs('share', 'cubicweb')
self.make_dirs('bob', 'share', 'cubicweb')
file_path = self.make_file('bell', 'toto.py')
self.assertEqual(_find_prefix(file_path), prefix)
@with_tempdir
def test_multiple_parent_candidate_prefix(self):
self.make_dirs('share', 'cubicweb')
prefix = self.make_dirs('share', 'cubicweb', 'bob')
self.make_dirs('share', 'cubicweb', 'bob', 'share', 'cubicweb')
file_path = self.make_file('share', 'cubicweb', 'bob', 'pyves', 'alain', 'adim', 'syt', 'toto.py')
self.assertEqual(_find_prefix(file_path), prefix)
@with_tempdir
def test_upper_candidate_prefix(self):
prefix = tempfile.tempdir
self.make_dirs('share', 'cubicweb')
self.make_dirs('bell','bob', 'share', 'cubicweb')
file_path = self.make_file('bell', 'toto.py')
self.assertEqual(_find_prefix(file_path), prefix)
@with_tempdir
def test_no_prefix(self):
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()