530 lines
17 KiB
Python
530 lines
17 KiB
Python
# -*- coding: utf-8 -*-
|
|
##############################################################################
|
|
#
|
|
# OpenERP, Open Source Management Solution
|
|
# Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
|
|
# Copyright (C) 2010-2012 OpenERP s.a. (<http://openerp.com>).
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This program 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 Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
##############################################################################
|
|
|
|
import imp
|
|
import itertools
|
|
import os
|
|
from os.path import join as opj
|
|
import sys
|
|
import types
|
|
import zipimport
|
|
|
|
import openerp.tools as tools
|
|
import openerp.tools.osutil as osutil
|
|
from openerp.tools.safe_eval import safe_eval as eval
|
|
|
|
import zipfile
|
|
import openerp.release as release
|
|
|
|
import re
|
|
import base64
|
|
from zipfile import PyZipFile, ZIP_DEFLATED
|
|
from cStringIO import StringIO
|
|
|
|
import logging
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
_ad = os.path.join(os.path.dirname(os.path.dirname(__file__)), 'addons') # default addons path (base)
|
|
ad_paths = []
|
|
|
|
# Modules already loaded
|
|
loaded = []
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
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):
|
|
|
|
module_parts = module_name.split('.')
|
|
if len(module_parts) == 3 and module_name.startswith('openerp.addons.'):
|
|
module_part = module_parts[2]
|
|
if module_name in sys.modules:
|
|
return sys.modules[module_name]
|
|
|
|
# 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
|
|
if ad_paths:
|
|
return
|
|
|
|
ad_paths = map(lambda m: os.path.abspath(tools.ustr(m.strip())), tools.config['addons_path'].split(','))
|
|
ad_paths.append(os.path.abspath(_ad)) # for get_module_path
|
|
sys.meta_path.append(AddonsImportHook())
|
|
|
|
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(_ad, 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')
|
|
|
|
if not os.path.isdir(path):
|
|
# zipmodule
|
|
zip = zipfile.ZipFile(path + ".zip")
|
|
files = ['/'.join(f.split('/')[1:]) for f in zip.namelist()]
|
|
else:
|
|
files = 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 zip_directory(directory, b64enc=True, src=True):
|
|
"""Compress a directory
|
|
|
|
@param directory: The directory to compress
|
|
@param base64enc: if True the function will encode the zip file with base64
|
|
@param src: Integrate the source files
|
|
|
|
@return: a string containing the zip file
|
|
"""
|
|
|
|
RE_exclude = re.compile('(?:^\..+\.swp$)|(?:\.py[oc]$)|(?:\.bak$)|(?:\.~.~$)', re.I)
|
|
|
|
def _zippy(archive, path, src=True):
|
|
path = os.path.abspath(path)
|
|
base = os.path.basename(path)
|
|
for f in osutil.listdir(path, True):
|
|
bf = os.path.basename(f)
|
|
if not RE_exclude.search(bf) and (src or bf == '__openerp__.py' or not bf.endswith('.py')):
|
|
archive.write(os.path.join(path, f), os.path.join(base, f))
|
|
|
|
archname = StringIO()
|
|
archive = PyZipFile(archname, "w", ZIP_DEFLATED)
|
|
|
|
# for Python 2.5, ZipFile.write() still expects 8-bit strings (2.6 converts to utf-8)
|
|
directory = tools.ustr(directory).encode('utf-8')
|
|
|
|
archive.writepy(directory)
|
|
_zippy(archive, directory, src=src)
|
|
archive.close()
|
|
archive_data = archname.getvalue()
|
|
archname.close()
|
|
|
|
if b64enc:
|
|
return base64.encodestring(archive_data)
|
|
|
|
return archive_data
|
|
|
|
def get_module_as_zip(modulename, b64enc=True, src=True):
|
|
"""Generate a module as zip file with the source or not and can do a base64 encoding
|
|
|
|
@param modulename: The module name
|
|
@param b64enc: if True the function will encode the zip file with base64
|
|
@param src: Integrate the source files
|
|
|
|
@return: a stream to store in a file-like object
|
|
"""
|
|
|
|
ap = get_module_path(str(modulename))
|
|
if not ap:
|
|
raise Exception('Unable to find path for module %s' % modulename)
|
|
|
|
ap = ap.encode('utf8')
|
|
if os.path.isfile(ap + '.zip'):
|
|
val = file(ap + '.zip', 'rb').read()
|
|
if b64enc:
|
|
val = base64.encodestring(val)
|
|
else:
|
|
val = zip_directory(ap, b64enc, src)
|
|
|
|
return val
|
|
|
|
|
|
def get_module_resource(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 name it get_resource_path
|
|
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
|
|
elif zipfile.is_zipfile(mod_path + '.zip'):
|
|
zip = zipfile.ZipFile( mod_path + ".zip")
|
|
files = ['/'.join(f.split('/')[1:]) for f in zip.namelist()]
|
|
resource_path = '/'.join(args)
|
|
if resource_path in files:
|
|
return opj(mod_path, resource_path)
|
|
return False
|
|
|
|
def get_module_icon(module):
|
|
iconpath = ['static', 'src', 'img', 'icon.png']
|
|
if get_module_resource(module, *iconpath):
|
|
return ('/' + module + '/') + '/'.join(iconpath)
|
|
return '/base/' + '/'.join(iconpath)
|
|
|
|
def load_information_from_description_file(module):
|
|
"""
|
|
:param module: The name of the module (sale, purchase, ...)
|
|
"""
|
|
|
|
terp_file = get_module_resource(module, '__openerp__.py')
|
|
mod_path = get_module_path(module)
|
|
if terp_file:
|
|
info = {}
|
|
if os.path.isfile(terp_file) or zipfile.is_zipfile(mod_path+'.zip'):
|
|
# default values for descriptor
|
|
info = {
|
|
'application': False,
|
|
'author': '',
|
|
'auto_install': False,
|
|
'category': 'Uncategorized',
|
|
'depends': [],
|
|
'description': '',
|
|
'icon': get_module_icon(module),
|
|
'installable': True,
|
|
'license': 'AGPL-3',
|
|
'name': False,
|
|
'post_load': None,
|
|
'version': '1.0',
|
|
'web': False,
|
|
'website': '',
|
|
'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 '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 __openerp__.py file found.', module)
|
|
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()
|
|
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)
|
|
zip_mod_path = '' if not mod_path else mod_path + '.zip'
|
|
if not os.path.isfile(zip_mod_path):
|
|
__import__('openerp.addons.' + module_name)
|
|
else:
|
|
zimp = zipimport.zipimporter(zip_mod_path)
|
|
zimp.load_module(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:
|
|
mt = isinstance(e, zipimport.ZipImportError) and 'zip ' or ''
|
|
msg = "Couldn't load %smodule %s" % (mt, 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, '__openerp__.py')
|
|
zipfile_name = opj(dir, name)
|
|
return os.path.isfile(manifest_name) or zipfile.is_zipfile(zipfile_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, submodule, explode):
|
|
"""
|
|
Return a list of submodules containing tests.
|
|
`submodule` can be:
|
|
- None
|
|
- the name of a submodule
|
|
- '__fast_suite__'
|
|
- '__sanity_checks__'
|
|
"""
|
|
# Turn command-line module, submodule into importable names.
|
|
if module is None:
|
|
pass
|
|
elif module == 'openerp':
|
|
module = 'openerp.tests'
|
|
else:
|
|
module = 'openerp.addons.' + module + '.tests'
|
|
|
|
# Try to import the module
|
|
try:
|
|
__import__(module)
|
|
except Exception, e:
|
|
if explode:
|
|
print 'Can not `import %s`.' % module
|
|
import logging
|
|
logging.exception('')
|
|
sys.exit(1)
|
|
else:
|
|
if str(e) == 'No module named tests':
|
|
# It seems the module has no `tests` sub-module, no problem.
|
|
pass
|
|
else:
|
|
_logger.exception('Can not `import %s`.', module)
|
|
return []
|
|
|
|
# Discover available test sub-modules.
|
|
m = sys.modules[module]
|
|
submodule_names = sorted([x for x in dir(m) \
|
|
if x.startswith('test_') and \
|
|
isinstance(getattr(m, x), types.ModuleType)])
|
|
submodules = [getattr(m, x) for x in submodule_names]
|
|
|
|
def show_submodules_and_exit():
|
|
if submodule_names:
|
|
print 'Available submodules are:'
|
|
for x in submodule_names:
|
|
print ' ', x
|
|
sys.exit(1)
|
|
|
|
if submodule is None:
|
|
# Use auto-discovered sub-modules.
|
|
ms = submodules
|
|
elif submodule == '__fast_suite__':
|
|
# Obtain the explicit test sub-modules list.
|
|
ms = getattr(sys.modules[module], 'fast_suite', None)
|
|
# `suite` was used before the 6.1 release instead of `fast_suite`.
|
|
ms = ms if ms else getattr(sys.modules[module], 'suite', None)
|
|
if ms is None:
|
|
if explode:
|
|
print 'The module `%s` has no defined test suite.' % (module,)
|
|
show_submodules_and_exit()
|
|
else:
|
|
ms = []
|
|
elif submodule == '__sanity_checks__':
|
|
ms = getattr(sys.modules[module], 'checks', None)
|
|
if ms is None:
|
|
if explode:
|
|
print 'The module `%s` has no defined sanity checks.' % (module,)
|
|
show_submodules_and_exit()
|
|
else:
|
|
ms = []
|
|
else:
|
|
# Pick the command-line-specified test sub-module.
|
|
m = getattr(sys.modules[module], submodule, None)
|
|
ms = [m]
|
|
|
|
if m is None:
|
|
if explode:
|
|
print 'The module `%s` has no submodule named `%s`.' % \
|
|
(module, submodule)
|
|
show_submodules_and_exit()
|
|
else:
|
|
ms = []
|
|
|
|
return ms
|
|
|
|
def run_unit_tests(module_name):
|
|
"""
|
|
Return True or False if some tests were found and succeeded or failed.
|
|
Return None if no test was found.
|
|
"""
|
|
import unittest2
|
|
ms = get_test_modules(module_name, '__fast_suite__', explode=False)
|
|
# TODO: No need to try again if the above call failed because of e.g. a syntax error.
|
|
ms.extend(get_test_modules(module_name, '__sanity_checks__', explode=False))
|
|
suite = unittest2.TestSuite()
|
|
for m in ms:
|
|
suite.addTests(unittest2.TestLoader().loadTestsFromModule(m))
|
|
if ms:
|
|
_logger.info('module %s: executing %s `fast_suite` and/or `checks` sub-modules', module_name, len(ms))
|
|
# Use a custom stream object to log the test executions.
|
|
class MyStream(object):
|
|
def __init__(self):
|
|
self.r = re.compile(r'^-*$|^ *... *$|^ok$')
|
|
def flush(self):
|
|
pass
|
|
def write(self, s):
|
|
if self.r.match(s):
|
|
return
|
|
first = True
|
|
for c in s.split('\n'):
|
|
if not first:
|
|
c = '` ' + c
|
|
first = False
|
|
_logger.info(c)
|
|
result = unittest2.TextTestRunner(verbosity=2, stream=MyStream()).run(suite)
|
|
if result.wasSuccessful():
|
|
return True
|
|
else:
|
|
_logger.error('module %s: at least one error occurred in a test', module_name)
|
|
return False
|
|
|
|
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
|