Commit 2fd25910 authored by Nsukami Patrick's avatar Nsukami Patrick
Browse files

New style: Convert cube to new layout

- move cube files to new folder
- update MANIFEST.in, setup.py, __pkginfo__.py
- replace cube's old style import by new style import
parent 2b75a2aec984
include *.py
include */*.py
recursive-include data external_resources *.gif *.png *.css *.ico *.js
recursive-include i18n *.pot *.po
recursive-include wdoc *
recursive-include cubicweb_trustedauth *.py
recursive-include cubicweb_trustedauth/data *.gif *.png *.ico *.css *.js
recursive-include cubicweb_trustedauth/i18n *.po
recursive-include test/data bootstrap_cubes *.py
include *.ini
recursive-include debian changelog compat control copyright rules
include cubicweb-trustedauth.spec
......@@ -20,7 +20,7 @@ BuildArch: noarch
BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot
BuildRequires: %{python} %{python}-setuptools
Requires: cubicweb >= 3.17.0
Requires: cubicweb >= 3.26.0
Requires: python-crypto
%description
......
......@@ -31,7 +31,7 @@ def includeme(config):
See also :ref:`defaults_module`
"""
from cubes.trustedauth.pconfig import TrustedAuthenticationPolicy
from cubicweb_trustedauth.pconfig import TrustedAuthenticationPolicy
policy = TrustedAuthenticationPolicy()
# # add some bw compat methods
......
......@@ -24,46 +24,23 @@ numversion = (0, 4, 0)
version = '.'.join(str(num) for num in numversion)
license = 'LGPL'
author = 'LOGILAB S.A. (Paris, FRANCE)'
author_email = 'contact@logilab.fr'
author_email = 'contact@logilab.fr'
description = ('authentication plugin for cubicweb instances behind a trusted '
'reverse proxy managing authentication (eg. apache + kerberos)')
web = 'http://www.cubicweb.org/project/%s' % distname
classifiers = [
'Environment :: Web Environment',
'Framework :: CubicWeb',
'Programming Language :: Python',
]
from os import listdir as _listdir
from os.path import join, isdir, exists
from glob import glob
__depends__ = {
'cubicweb': '>= 3.26.0',
'pycrypto': None,
}
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
__depends__ = {'cubicweb': '>= 3.17.0',
'pycrypto': None,
}
__recommends__ = {}
classifiers = [
'Environment :: Web Environment',
'Framework :: CubicWeb',
'Programming Language :: Python',
]
......@@ -30,7 +30,7 @@ import base64
from cubicweb import AuthenticationError
from cubicweb.server.sources import native
from cubes.trustedauth.cryptutils import build_cypher
from cubicweb_trustedauth.cryptutils import build_cypher
class XRemoteUserAuthentifier(native.BaseAuthentifier):
""" a source authentifier plugin
......
......@@ -19,7 +19,7 @@ import os.path as osp
from cubicweb.server import hook
from cubes.trustedauth.authplugin import XRemoteUserAuthentifier
from cubicweb_trustedauth.authplugin import XRemoteUserAuthentifier
class ServerStartupHook(hook.Hook):
"""register authentifier at startup"""
......
......@@ -30,7 +30,7 @@ from logilab.common.registry import objectify_predicate
from cubicweb.web.views import authentication, actions, basecontrollers
from cubes.trustedauth.cryptutils import build_cypher
from cubicweb_trustedauth.cryptutils import build_cypher
# web authentication info retreiver ############################################
......
#!/usr/bin/env python
# pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611
#
# copyright 2003-2015 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 signedrequest cube.
# This file is part of a cubicweb_trustedauth cube.
#
# 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
......@@ -14,196 +14,71 @@
# 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/>.
"""Generic Setup script, takes package info from __pkginfo__.py file
# 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_trustedauth setup module using data from
cubicweb_trustedauth/__pkginfo__.py file
"""
__docformat__ = "restructuredtext en"
import os
import sys
import shutil
from os.path import isdir, exists, join, walk, dirname
from os.path import join, dirname
from setuptools import find_packages, setup
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
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
base_dir = dirname(__file__)
pkginfo = {}
with open(join(base_dir, "__pkginfo__.py")) as f:
exec(f.read(), pkginfo)
pkginfo = join(here, 'cubicweb_trustedauth', '__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(base_dir, 'README')) as f:
distname = __pkginfo__['distname']
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')) as f:
long_description = f.read()
# get optional metadatas
distname = pkginfo.get('distname', modname)
scripts = pkginfo.get('scripts', ())
include_dirs = pkginfo.get('include_dirs', ())
data_files = pkginfo.get('data_files', None)
ext_modules = pkginfo.get('ext_modules', None)
dependency_links = pkginfo.get('dependency_links', ())
if USE_SETUPTOOLS:
requires = {}
for entry in ("__depends__",): # "__recommends__"):
requires.update(pkginfo.get(entry, {}))
install_requires = [("%s %s" % (d, v and v or "")).strip()
for d, v in requires.iteritems()]
else:
install_requires = []
BASE_BLACKLIST = ('CVS', '.svn', '.hg', '.git', '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:
import setuptools.command.easy_install # only if easy_install available
# 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')
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()
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,
include_package_data=True,
entry_points={
'cubicweb.cubes': [
'trustedauth=cubicweb_trustedauth',
],
},
zip_safe=False,
)
......@@ -2,7 +2,7 @@ from operator import itemgetter
import webtest
from pyramid_cubicweb.tests import PyramidCWTest
from cubes.trustedauth import includeme
from cubicweb_trustedauth import includeme
from cubicweb.web.controller import Controller
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment