Olivier Dony
a3732aef6e
99% of the contributors have signed the CLA The rest of them have been contacted by email and are free to either sign the CLA or ask for their contributions to be removed from Odoo Community Edition. See also: - https://www.odoo.com/cla - https://www.odoo.com/blog/odoo-news-5/post/adapting-our-open-source-license-245
492 lines
16 KiB
Python
492 lines
16 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import functools
|
|
import imp
|
|
import importlib
|
|
import inspect
|
|
import itertools
|
|
import logging
|
|
import os
|
|
import re
|
|
import sys
|
|
import time
|
|
import unittest
|
|
import threading
|
|
from os.path import join as opj
|
|
|
|
import unittest2
|
|
|
|
import openerp
|
|
import openerp.tools as tools
|
|
import openerp.release as release
|
|
from openerp.tools.safe_eval import safe_eval as eval
|
|
|
|
MANIFEST = '__openerp__.py'
|
|
README = ['README.rst', 'README.md', 'README.txt']
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
# addons path as a list
|
|
ad_paths = []
|
|
hooked = False
|
|
|
|
# Modules already loaded
|
|
loaded = []
|
|
|
|
class AddonsImportHook(object):
|
|
"""
|
|
Import hook to load OpenERP addons from multiple paths.
|
|
|
|
OpenERP implements its own import-hook to load its addons. OpenERP
|
|
addons are Python modules. Originally, they were each living in their
|
|
own top-level namespace, e.g. the sale module, or the hr module. For
|
|
backward compatibility, `import <module>` is still supported. Now they
|
|
are living in `openerp.addons`. The good way to import such modules is
|
|
thus `import openerp.addons.module`.
|
|
"""
|
|
|
|
def find_module(self, module_name, package_path):
|
|
module_parts = module_name.split('.')
|
|
if len(module_parts) == 3 and module_name.startswith('openerp.addons.'):
|
|
return self # We act as a loader too.
|
|
|
|
def load_module(self, module_name):
|
|
if module_name in sys.modules:
|
|
return sys.modules[module_name]
|
|
|
|
_1, _2, module_part = module_name.split('.')
|
|
# Note: we don't support circular import.
|
|
f, path, descr = imp.find_module(module_part, ad_paths)
|
|
mod = imp.load_module('openerp.addons.' + module_part, f, path, descr)
|
|
sys.modules['openerp.addons.' + module_part] = mod
|
|
return mod
|
|
|
|
def initialize_sys_path():
|
|
"""
|
|
Setup an import-hook to be able to import OpenERP addons from the different
|
|
addons paths.
|
|
|
|
This ensures something like ``import crm`` (or even
|
|
``import openerp.addons.crm``) works even if the addons are not in the
|
|
PYTHONPATH.
|
|
"""
|
|
global ad_paths
|
|
global hooked
|
|
|
|
dd = tools.config.addons_data_dir
|
|
if dd not in ad_paths:
|
|
ad_paths.append(dd)
|
|
|
|
for ad in tools.config['addons_path'].split(','):
|
|
ad = os.path.abspath(tools.ustr(ad.strip()))
|
|
if ad not in ad_paths:
|
|
ad_paths.append(ad)
|
|
|
|
# add base module path
|
|
base_path = os.path.abspath(os.path.join(os.path.dirname(os.path.dirname(__file__)), 'addons'))
|
|
if base_path not in ad_paths:
|
|
ad_paths.append(base_path)
|
|
|
|
if not hooked:
|
|
sys.meta_path.append(AddonsImportHook())
|
|
hooked = True
|
|
|
|
def get_module_path(module, downloaded=False, display_warning=True):
|
|
"""Return the path of the given module.
|
|
|
|
Search the addons paths and return the first path where the given
|
|
module is found. If downloaded is True, return the default addons
|
|
path if nothing else is found.
|
|
|
|
"""
|
|
initialize_sys_path()
|
|
for adp in ad_paths:
|
|
if os.path.exists(opj(adp, module)) or os.path.exists(opj(adp, '%s.zip' % module)):
|
|
return opj(adp, module)
|
|
|
|
if downloaded:
|
|
return opj(tools.config.addons_data_dir, module)
|
|
if display_warning:
|
|
_logger.warning('module %s: module not found', module)
|
|
return False
|
|
|
|
def get_module_filetree(module, dir='.'):
|
|
path = get_module_path(module)
|
|
if not path:
|
|
return False
|
|
|
|
dir = os.path.normpath(dir)
|
|
if dir == '.':
|
|
dir = ''
|
|
if dir.startswith('..') or (dir and dir[0] == '/'):
|
|
raise Exception('Cannot access file outside the module')
|
|
|
|
files = openerp.tools.osutil.listdir(path, True)
|
|
|
|
tree = {}
|
|
for f in files:
|
|
if not f.startswith(dir):
|
|
continue
|
|
|
|
if dir:
|
|
f = f[len(dir)+int(not dir.endswith('/')):]
|
|
lst = f.split(os.sep)
|
|
current = tree
|
|
while len(lst) != 1:
|
|
current = current.setdefault(lst.pop(0), {})
|
|
current[lst.pop(0)] = None
|
|
|
|
return tree
|
|
|
|
def get_resource_path(module, *args):
|
|
"""Return the full path of a resource of the given module.
|
|
|
|
:param module: module name
|
|
:param list(str) args: resource path components within module
|
|
|
|
:rtype: str
|
|
:return: absolute path to the resource
|
|
|
|
TODO make it available inside on osv object (self.get_resource_path)
|
|
"""
|
|
mod_path = get_module_path(module)
|
|
if not mod_path: return False
|
|
resource_path = opj(mod_path, *args)
|
|
if os.path.isdir(mod_path):
|
|
# the module is a directory - ignore zip behavior
|
|
if os.path.exists(resource_path):
|
|
return resource_path
|
|
return False
|
|
|
|
# backwards compatibility
|
|
get_module_resource = get_resource_path
|
|
|
|
def get_resource_from_path(path):
|
|
"""Tries to extract the module name and the resource's relative path
|
|
out of an absolute resource path.
|
|
|
|
If operation is successfull, returns a tuple containing the module name, the relative path
|
|
to the resource using '/' as filesystem seperator[1] and the same relative path using
|
|
os.path.sep seperators.
|
|
|
|
[1] same convention as the resource path declaration in manifests
|
|
|
|
:param path: absolute resource path
|
|
|
|
:rtype: tuple
|
|
:return: tuple(module_name, relative_path, os_relative_path) if possible, else None
|
|
"""
|
|
resource = [path.replace(adpath, '') for adpath in ad_paths if path.startswith(adpath)]
|
|
if resource:
|
|
relative = resource[0].split(os.path.sep)
|
|
if not relative[0]:
|
|
relative.pop(0)
|
|
module = relative.pop(0)
|
|
return (module, '/'.join(relative), os.path.sep.join(relative))
|
|
return None
|
|
|
|
def get_module_icon(module):
|
|
iconpath = ['static', 'description', 'icon.png']
|
|
if get_module_resource(module, *iconpath):
|
|
return ('/' + module + '/') + '/'.join(iconpath)
|
|
return '/base/' + '/'.join(iconpath)
|
|
|
|
def get_module_root(path):
|
|
"""
|
|
Get closest module's root begining from path
|
|
|
|
# Given:
|
|
# /foo/bar/module_dir/static/src/...
|
|
|
|
get_module_root('/foo/bar/module_dir/static/')
|
|
# returns '/foo/bar/module_dir'
|
|
|
|
get_module_root('/foo/bar/module_dir/')
|
|
# returns '/foo/bar/module_dir'
|
|
|
|
get_module_root('/foo/bar')
|
|
# returns None
|
|
|
|
@param path: Path from which the lookup should start
|
|
|
|
@return: Module root path or None if not found
|
|
"""
|
|
while not os.path.exists(os.path.join(path, MANIFEST)):
|
|
new_path = os.path.abspath(os.path.join(path, os.pardir))
|
|
if path == new_path:
|
|
return None
|
|
path = new_path
|
|
return path
|
|
|
|
def load_information_from_description_file(module, mod_path=None):
|
|
"""
|
|
:param module: The name of the module (sale, purchase, ...)
|
|
:param mod_path: Physical path of module, if not providedThe name of the module (sale, purchase, ...)
|
|
"""
|
|
|
|
if not mod_path:
|
|
mod_path = get_module_path(module)
|
|
terp_file = mod_path and opj(mod_path, MANIFEST) or False
|
|
if terp_file:
|
|
info = {}
|
|
if os.path.isfile(terp_file):
|
|
# default values for descriptor
|
|
info = {
|
|
'application': False,
|
|
'author': 'Odoo SA',
|
|
'auto_install': False,
|
|
'category': 'Uncategorized',
|
|
'depends': [],
|
|
'description': '',
|
|
'icon': get_module_icon(module),
|
|
'installable': True,
|
|
'license': 'LGPL-3',
|
|
'post_load': None,
|
|
'version': '1.0',
|
|
'web': False,
|
|
'website': 'http://www.odoo.com',
|
|
'sequence': 100,
|
|
'summary': '',
|
|
}
|
|
info.update(itertools.izip(
|
|
'depends data demo test init_xml update_xml demo_xml'.split(),
|
|
iter(list, None)))
|
|
|
|
f = tools.file_open(terp_file)
|
|
try:
|
|
info.update(eval(f.read()))
|
|
finally:
|
|
f.close()
|
|
|
|
if not info.get('description'):
|
|
readme_path = [opj(mod_path, x) for x in README
|
|
if os.path.isfile(opj(mod_path, x))]
|
|
if readme_path:
|
|
readme_text = tools.file_open(readme_path[0]).read()
|
|
info['description'] = readme_text
|
|
|
|
if 'active' in info:
|
|
# 'active' has been renamed 'auto_install'
|
|
info['auto_install'] = info['active']
|
|
|
|
info['version'] = adapt_version(info['version'])
|
|
return info
|
|
|
|
#TODO: refactor the logger in this file to follow the logging guidelines
|
|
# for 6.0
|
|
_logger.debug('module %s: no %s file found.', module, MANIFEST)
|
|
return {}
|
|
|
|
def init_module_models(cr, module_name, obj_list):
|
|
""" Initialize a list of models.
|
|
|
|
Call _auto_init and init on each model to create or update the
|
|
database tables supporting the models.
|
|
|
|
TODO better explanation of _auto_init and init.
|
|
|
|
"""
|
|
_logger.info('module %s: creating or updating database tables', module_name)
|
|
todo = []
|
|
for obj in obj_list:
|
|
result = obj._auto_init(cr, {'module': module_name})
|
|
if result:
|
|
todo += result
|
|
if hasattr(obj, 'init'):
|
|
obj.init(cr)
|
|
cr.commit()
|
|
for obj in obj_list:
|
|
obj._auto_end(cr, {'module': module_name})
|
|
cr.commit()
|
|
todo.sort(key=lambda x: x[0])
|
|
for t in todo:
|
|
t[1](cr, *t[2])
|
|
cr.commit()
|
|
|
|
def load_openerp_module(module_name):
|
|
""" Load an OpenERP module, if not already loaded.
|
|
|
|
This loads the module and register all of its models, thanks to either
|
|
the MetaModel metaclass, or the explicit instantiation of the model.
|
|
This is also used to load server-wide module (i.e. it is also used
|
|
when there is no model to register).
|
|
"""
|
|
global loaded
|
|
if module_name in loaded:
|
|
return
|
|
|
|
initialize_sys_path()
|
|
try:
|
|
mod_path = get_module_path(module_name)
|
|
__import__('openerp.addons.' + module_name)
|
|
|
|
# Call the module's post-load hook. This can done before any model or
|
|
# data has been initialized. This is ok as the post-load hook is for
|
|
# server-wide (instead of registry-specific) functionalities.
|
|
info = load_information_from_description_file(module_name)
|
|
if info['post_load']:
|
|
getattr(sys.modules['openerp.addons.' + module_name], info['post_load'])()
|
|
|
|
except Exception, e:
|
|
msg = "Couldn't load module %s" % (module_name)
|
|
_logger.critical(msg)
|
|
_logger.critical(e)
|
|
raise
|
|
else:
|
|
loaded.append(module_name)
|
|
|
|
def get_modules():
|
|
"""Returns the list of module names
|
|
"""
|
|
def listdir(dir):
|
|
def clean(name):
|
|
name = os.path.basename(name)
|
|
if name[-4:] == '.zip':
|
|
name = name[:-4]
|
|
return name
|
|
|
|
def is_really_module(name):
|
|
manifest_name = opj(dir, name, MANIFEST)
|
|
zipfile_name = opj(dir, name)
|
|
return os.path.isfile(manifest_name)
|
|
return map(clean, filter(is_really_module, os.listdir(dir)))
|
|
|
|
plist = []
|
|
initialize_sys_path()
|
|
for ad in ad_paths:
|
|
plist.extend(listdir(ad))
|
|
return list(set(plist))
|
|
|
|
def get_modules_with_version():
|
|
modules = get_modules()
|
|
res = dict.fromkeys(modules, adapt_version('1.0'))
|
|
for module in modules:
|
|
try:
|
|
info = load_information_from_description_file(module)
|
|
res[module] = info['version']
|
|
except Exception:
|
|
continue
|
|
return res
|
|
|
|
def adapt_version(version):
|
|
serie = release.major_version
|
|
if version == serie or not version.startswith(serie + '.'):
|
|
version = '%s.%s' % (serie, version)
|
|
return version
|
|
|
|
def get_test_modules(module):
|
|
""" Return a list of module for the addons potentially containing tests to
|
|
feed unittest2.TestLoader.loadTestsFromModule() """
|
|
# Try to import the module
|
|
modpath = 'openerp.addons.' + module
|
|
try:
|
|
mod = importlib.import_module('.tests', modpath)
|
|
except Exception, e:
|
|
# If module has no `tests` sub-module, no problem.
|
|
if str(e) != 'No module named tests':
|
|
_logger.exception('Can not `import %s`.', module)
|
|
return []
|
|
|
|
if hasattr(mod, 'fast_suite') or hasattr(mod, 'checks'):
|
|
_logger.warn(
|
|
"Found deprecated fast_suite or checks attribute in test module "
|
|
"%s. These have no effect in or after version 8.0.",
|
|
mod.__name__)
|
|
|
|
result = [mod_obj for name, mod_obj in inspect.getmembers(mod, inspect.ismodule)
|
|
if name.startswith('test_')]
|
|
return result
|
|
|
|
# Use a custom stream object to log the test executions.
|
|
class TestStream(object):
|
|
def __init__(self, logger_name='openerp.tests'):
|
|
self.logger = logging.getLogger(logger_name)
|
|
self.r = re.compile(r'^-*$|^ *... *$|^ok$')
|
|
def flush(self):
|
|
pass
|
|
def write(self, s):
|
|
if self.r.match(s):
|
|
return
|
|
first = True
|
|
level = logging.ERROR if s.startswith(('ERROR', 'FAIL', 'Traceback')) else logging.INFO
|
|
for c in s.splitlines():
|
|
if not first:
|
|
c = '` ' + c
|
|
first = False
|
|
self.logger.log(level, c)
|
|
|
|
current_test = None
|
|
|
|
def runs_at(test, hook, default):
|
|
# by default, tests do not run post install
|
|
test_runs = getattr(test, hook, default)
|
|
|
|
# for a test suite, we're done
|
|
if not isinstance(test, unittest.TestCase):
|
|
return test_runs
|
|
|
|
# otherwise check the current test method to see it's been set to a
|
|
# different state
|
|
method = getattr(test, test._testMethodName)
|
|
return getattr(method, hook, test_runs)
|
|
|
|
runs_at_install = functools.partial(runs_at, hook='at_install', default=True)
|
|
runs_post_install = functools.partial(runs_at, hook='post_install', default=False)
|
|
|
|
def run_unit_tests(module_name, dbname, position=runs_at_install):
|
|
"""
|
|
:returns: ``True`` if all of ``module_name``'s tests succeeded, ``False``
|
|
if any of them failed.
|
|
:rtype: bool
|
|
"""
|
|
global current_test
|
|
current_test = module_name
|
|
mods = get_test_modules(module_name)
|
|
threading.currentThread().testing = True
|
|
r = True
|
|
for m in mods:
|
|
tests = unwrap_suite(unittest2.TestLoader().loadTestsFromModule(m))
|
|
suite = unittest2.TestSuite(itertools.ifilter(position, tests))
|
|
|
|
if suite.countTestCases():
|
|
t0 = time.time()
|
|
t0_sql = openerp.sql_db.sql_counter
|
|
_logger.info('%s running tests.', m.__name__)
|
|
result = unittest2.TextTestRunner(verbosity=2, stream=TestStream(m.__name__)).run(suite)
|
|
if time.time() - t0 > 5:
|
|
_logger.log(25, "%s tested in %.2fs, %s queries", m.__name__, time.time() - t0, openerp.sql_db.sql_counter - t0_sql)
|
|
if not result.wasSuccessful():
|
|
r = False
|
|
_logger.error("Module %s: %d failures, %d errors", module_name, len(result.failures), len(result.errors))
|
|
|
|
current_test = None
|
|
threading.currentThread().testing = False
|
|
return r
|
|
|
|
def unwrap_suite(test):
|
|
"""
|
|
Attempts to unpack testsuites (holding suites or cases) in order to
|
|
generate a single stream of terminals (either test cases or customized
|
|
test suites). These can then be checked for run/skip attributes
|
|
individually.
|
|
|
|
An alternative would be to use a variant of @unittest2.skipIf with a state
|
|
flag of some sort e.g. @unittest2.skipIf(common.runstate != 'at_install'),
|
|
but then things become weird with post_install as tests should *not* run
|
|
by default there
|
|
"""
|
|
if isinstance(test, unittest.TestCase):
|
|
yield test
|
|
return
|
|
|
|
subtests = list(test)
|
|
# custom test suite (no test cases)
|
|
if not len(subtests):
|
|
yield test
|
|
return
|
|
|
|
for item in itertools.chain.from_iterable(
|
|
itertools.imap(unwrap_suite, subtests)):
|
|
yield item
|