Update to "cube as package" layout

* Adjust "internal" imports in package and tests.
* Switch to py.test to run tests in tox (better, and lgc.pytest does not like
  absolute imports apparently -- maybe because of chdir that's performed prior
  to run tests).

__pkginfo__.py → cubicweb_dataprocessing/__pkginfo__.py

 # pylint: disable=W0622
 """cubicweb-dataprocessing application packaging information"""
 
-from os import listdir as _listdir
-from os.path import join, isdir
-from glob import glob
-
 
 modname = 'dataprocessing'
 distname = 'cubicweb-dataprocessing'
@@ -20,7 +16,7 @@ web = 'http://www.cubicweb.org/project/%s' % distname
 
 __depends__ = {
     'six': '>= 1.4.0',
-    'cubicweb': '>= 3.22.0',
+    'cubicweb': '>= 3.24.0.dev0',
     'cubicweb-file': None,
 }
 __recommends__ = {}
@@ -30,28 +26,4 @@ classifiers = [
     'Framework :: CubicWeb',
     'Programming Language :: Python',
     'Programming Language :: JavaScript',
-    ]
-
-THIS_CUBE_DIR = join('share', 'cubicweb', 'cubes', modname)
-
-
-def listdir(dirpath):
-    return [join(dirpath, fname) for fname in _listdir(dirpath)
-            if fname[0] != '.' and not fname.endswith('.pyc')
-            and not fname.endswith('~')
-            and not isdir(join(dirpath, fname))]
-
-
-data_files = [
-    # common files
-    [THIS_CUBE_DIR, [fname for fname in glob('*.py') if fname != 'setup.py']],
 ]
-# check for possible extended cube layout
-for dname in ('entities', 'views', 'sobjects', 'hooks', 'schema', 'data',
-              'wdoc', 'i18n', 'migration'):
-    if isdir(dname):
-        data_files.append([join(THIS_CUBE_DIR, dname), listdir(dname)])
-# Note: here, you'll need to add subdirectories if you want
-# them to be included in the debian package
-
-data_files.append([join(THIS_CUBE_DIR, 'test'), ['test/__init__.py']])

hooks.py → cubicweb_dataprocessing/hooks.py

@@ -25,7 +25,7 @@ from cubicweb.predicates import (on_fire_transition, score_entity,
 from cubicweb.server import hook
 from cubicweb.server.sources import storages
 
-from cubes.dataprocessing.entities import fspath_from_eid
+from cubicweb_dataprocessing.entities import fspath_from_eid
 
 
 class ServerStartupHook(hook.Hook):

migration/postcreate.py → cubicweb_dataprocessing/migration/postcreate.py

@@ -19,7 +19,7 @@
 the cube is added to an existing instance.
 """
 
-from cubes.dataprocessing.workflows import define_dataprocess_workflow
+from cubicweb_dataprocessing.workflows import define_dataprocess_workflow
 
 
 define_dataprocess_workflow(add_workflow)

schema.py → cubicweb_dataprocessing/schema.py

@@ -22,7 +22,7 @@ from yams.buildobjs import (ComputedRelation, EntityType, RelationDefinition,
 from cubicweb.schema import (RRQLExpression, ERQLExpression,
                              RQLConstraint, WorkflowableEntityType)
 
-from cubes.file.schema import File
+from cubicweb_file.schema import File
 
 
 _ = unicode

setup.py

 #!/usr/bin/env python
 # pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611
 #
-# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
 # contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
 #
-# This file is part of CubicWeb.
+# This file is part of cubicweb-dataprocessing.
 #
 # 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
@@ -18,189 +18,61 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
-"""Generic Setup script, takes package info from __pkginfo__.py file
+"""cubicweb_dataprocessing setup module using data from
+cubicweb_dataprocessing/__pkginfo__.py file
 """
-__docformat__ = "restructuredtext en"
 
-import os
-import sys
-import shutil
-from os.path import exists, join, walk
+from os.path import join, dirname
+
+from setuptools import find_packages, setup
+
+
+here = dirname(__file__)
+
+# load metadata from the __pkginfo__.py file so there is no risk of conflict
+# see https://packaging.python.org/en/latest/single_source_version.html
+pkginfo = join(here, 'cubicweb_dataprocessing', '__pkginfo__.py')
+__pkginfo__ = {}
+with open(pkginfo) as f:
+    exec(f.read(), __pkginfo__)
+
+# get required metadatas
+modname = __pkginfo__['modname']
+version = __pkginfo__['version']
+license = __pkginfo__['license']
+description = __pkginfo__['description']
+web = __pkginfo__['web']
+author = __pkginfo__['author']
+author_email = __pkginfo__['author_email']
+classifiers = __pkginfo__['classifiers']
+
+with open(join(here, 'README.rst')) as f:
+    long_description = f.read()
+
+# get optional metadatas
+distname = __pkginfo__.get('distname', modname)
+data_files = __pkginfo__.get('data_files', None)
+dependency_links = __pkginfo__.get('dependency_links', ())
+
+requires = {}
+for entry in ("__depends__",):  # "__recommends__"):
+    requires.update(__pkginfo__.get(entry, {}))
+install_requires = ["{0} {1}".format(d, v and v or "").strip()
+                    for d, v in requires.items()]
+
+
+setup(
+    name=distname,
+    version=version,
+    license=license,
+    description=description,
+    long_description=long_description,
+    author=author,
+    author_email=author_email,
+    url=web,
+    classifiers=classifiers,
+    packages=find_packages(exclude=['test']),
+    install_requires=install_requires,
+    zip_safe=False,
+)
 
-try:
-    if os.environ.get('NO_SETUPTOOLS'):
-        raise ImportError()  # do as there is no setuptools
-    from setuptools import setup
-    from setuptools.command import install_lib
-    USE_SETUPTOOLS = True
-except ImportError:
-    from distutils.core import setup
-    from distutils.command import install_lib
-    USE_SETUPTOOLS = False
-from distutils.command import install_data
-
-# import required features
-from __pkginfo__ import modname, version, license, description, web, \
-    author, author_email, classifiers
-
-if exists('README.rst'):
-    long_description = open('README.rst').read()
-else:
-    long_description = ''
-
-# import optional features
-import __pkginfo__
-if USE_SETUPTOOLS:
-    requires = {}
-    for entry in ("__depends__",):  # "__recommends__"):
-        requires.update(getattr(__pkginfo__, entry, {}))
-    install_requires = [("%s %s" % (d, v and v or "")).strip()
-                        for d, v in requires.items()]
-else:
-    install_requires = []
-
-distname = getattr(__pkginfo__, 'distname', modname)
-scripts = getattr(__pkginfo__, 'scripts', ())
-include_dirs = getattr(__pkginfo__, 'include_dirs', ())
-data_files = getattr(__pkginfo__, 'data_files', None)
-ext_modules = getattr(__pkginfo__, 'ext_modules', None)
-dependency_links = getattr(__pkginfo__, 'dependency_links', ())
-
-BASE_BLACKLIST = ('CVS', '.svn', '.hg', 'debian', 'dist', 'build')
-IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc', '~')
-
-
-def ensure_scripts(linux_scripts):
-    """
-    Creates the proper script names required for each platform
-    (taken from 4Suite)
-    """
-    from distutils import util
-    if util.get_platform()[:3] == 'win':
-        scripts_ = [script + '.bat' for script in linux_scripts]
-    else:
-        scripts_ = linux_scripts
-    return scripts_
-
-
-def export(from_dir, to_dir,
-           blacklist=BASE_BLACKLIST,
-           ignore_ext=IGNORED_EXTENSIONS,
-           verbose=True):
-    """make a mirror of from_dir in to_dir, omitting directories and files
-    listed in the black list
-    """
-    def make_mirror(arg, directory, fnames):
-        """walk handler"""
-        for norecurs in blacklist:
-            try:
-                fnames.remove(norecurs)
-            except ValueError:
-                pass
-        for filename in fnames:
-            # don't include binary files
-            if filename[-4:] in ignore_ext:
-                continue
-            if filename[-1] == '~':
-                continue
-            src = join(directory, filename)
-            dest = to_dir + src[len(from_dir):]
-            if verbose:
-                sys.stderr.write('%s -> %s\n' % (src, dest))
-            if os.path.isdir(src):
-                if not exists(dest):
-                    os.mkdir(dest)
-            else:
-                if exists(dest):
-                    os.remove(dest)
-                shutil.copy2(src, dest)
-    try:
-        os.mkdir(to_dir)
-    except OSError as ex:
-        # file exists ?
-        import errno
-        if ex.errno != errno.EEXIST:
-            raise
-    walk(from_dir, make_mirror, None)
-
-
-class MyInstallLib(install_lib.install_lib):
-    """extend install_lib command to handle  package __init__.py and
-    include_dirs variable if necessary
-    """
-    def run(self):
-        """overridden from install_lib class"""
-        install_lib.install_lib.run(self)
-        # manually install included directories if any
-        if include_dirs:
-            base = modname
-            for directory in include_dirs:
-                dest = join(self.install_dir, base, directory)
-                export(directory, dest, verbose=False)
-
-# re-enable copying data files in sys.prefix
-old_install_data = install_data.install_data
-if USE_SETUPTOOLS:
-    # overwrite InstallData to use sys.prefix instead of the egg directory
-    class MyInstallData(old_install_data):
-        """A class that manages data files installation"""
-        def run(self):
-            _old_install_dir = self.install_dir
-            if self.install_dir.endswith('egg'):
-                self.install_dir = sys.prefix
-            old_install_data.run(self)
-            self.install_dir = _old_install_dir
-    try:
-        # only if easy_install available
-        import setuptools.command.easy_install  # noqa
-        # monkey patch: Crack SandboxViolation verification
-        from setuptools.sandbox import DirectorySandbox as DS
-        old_ok = DS._ok
-
-        def _ok(self, path):
-            """Return True if ``path`` can be written during installation."""
-            out = old_ok(self, path)  # here for side effect from setuptools
-            realpath = os.path.normcase(os.path.realpath(path))
-            allowed_path = os.path.normcase(sys.prefix)
-            if realpath.startswith(allowed_path):
-                out = True
-            return out
-        DS._ok = _ok
-    except ImportError:
-        pass
-
-
-def install(**kwargs):
-    """setup entry point"""
-    if USE_SETUPTOOLS:
-        if '--force-manifest' in sys.argv:
-            sys.argv.remove('--force-manifest')
-    # install-layout option was introduced in 2.5.3-1~exp1
-    elif sys.version_info < (2, 5, 4) and '--install-layout=deb' in sys.argv:
-        sys.argv.remove('--install-layout=deb')
-    cmdclass = {'install_lib': MyInstallLib}
-    if USE_SETUPTOOLS:
-        kwargs['install_requires'] = install_requires
-        kwargs['dependency_links'] = dependency_links
-        kwargs['zip_safe'] = False
-        cmdclass['install_data'] = MyInstallData
-
-    return setup(name=distname,
-                 version=version,
-                 license=license,
-                 description=description,
-                 long_description=long_description,
-                 author=author,
-                 author_email=author_email,
-                 url=web,
-                 scripts=ensure_scripts(scripts),
-                 data_files=data_files,
-                 ext_modules=ext_modules,
-                 cmdclass=cmdclass,
-                 classifiers=classifiers,
-                 **kwargs
-                 )
-
-
-if __name__ == '__main__':
-    install()

test/unittest_entities.py

 """cubicweb-dataprocessing unit tests for entities"""
+from __future__ import absolute_import
+
 import json
 import unittest
 
 from cubicweb.devtools.testlib import CubicWebTC
 
-from cubes.dataprocessing.entities import process_type_from_etype
-from cubes.dataprocessing.test import (create_file, create_process,
-                                       script_from_file)
+from cubicweb_dataprocessing.entities import process_type_from_etype
+from . import create_file, create_process, script_from_file
 
 
 class ProcessTypeTC(unittest.TestCase):

test/unittest_hooks.py

-"""cubicweb-datacat test utilities"""
+"""cubicweb-dataprocessing hooks tests"""
+from __future__ import absolute_import
 
 from cubicweb.devtools.testlib import CubicWebTC
 
-from cubes.dataprocessing.test import (create_file, create_process,
-                                       script_from_file, script_from_code)
+from . import (create_file, create_process, script_from_file,
+               script_from_code)
 
 
 class DataProcessWorkflowHooksTC(CubicWebTC):

test/unittest_schema.py

 """cubicweb-dataprocessing unit tests for schema"""
 
+from __future__ import absolute_import
+
 from cubicweb import ValidationError
 from cubicweb.devtools import testlib
 
-from cubes.dataprocessing.test import create_file
+from . import create_file
 
 
 class TransformationSequenceTC(testlib.CubicWebTC):

tox.ini

@@ -2,18 +2,25 @@
 envlist = py27,flake8
 
 [testenv]
+sitepackages = true
+deps =
+  pytest
+  https://hg.logilab.org/review/cubicweb/archive/cd16d2458da9.tar.bz2#egg=cubicweb
 commands =
-  {envpython} -c 'from logilab.common import pytest; pytest.run()' -t test {posargs}
-
-[testenv:py27]
-basepython=python2
+  {envpython} -m pytest test {posargs}
 
 [testenv:flake8]
 skip_install = true
+whitelist_externals =
+  flake8
 deps =
   flake8
 commands = flake8
 
 [flake8]
-exclude = migration/*,test/data/*,setup.py,.tox/*
+exclude = cubicweb_dataprocessing/migration/*,test/data/*,setup.py,.tox/*
 max-line-length = 100
+
+[pytest]
+python_files = *test_*.py
+