summaryrefslogtreecommitdiff
path: root/odoo/addons/test_lint
diff options
context:
space:
mode:
authorChristophe Monniez <moc@odoo.com>2019-05-28 14:01:23 +0000
committerChristophe Monniez <moc@odoo.com>2019-05-30 11:22:10 +0000
commitb27077bb0c3977c29597054d6206cea5e4d70265 (patch)
treeb76570fc685602c55040c33eda6323e678949cd7 /odoo/addons/test_lint
parentd85451800f7b6d6404757b40400e3d5e4d25fa55 (diff)
[MOV] test_pylint, test_lint: add es-check linter
Because Odoo still supports Android Kitkat and Internet Explorer, ES5 is the highest ECMAScript allowed version. This commit adds a new test that parses each javascript file found in addons. The test fails if unsupported js code is found. As ES6 is allowed during tests, the files under a path that contains 'static/test' are just skipped. This test uses the es-check tool (https://www.npmjs.com/package/es-check). If the es-check tool cannot be found, the test is simply skipped. Also the test_pylint module is renamed to a more generic name test_lint, that way, every linter test can find a shelter here. closes odoo/odoo#33724 Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
Diffstat (limited to 'odoo/addons/test_lint')
-rw-r--r--odoo/addons/test_lint/__init__.py13
-rw-r--r--odoo/addons/test_lint/__manifest__.py12
-rw-r--r--odoo/addons/test_lint/tests/__init__.py2
-rw-r--r--odoo/addons/test_lint/tests/test_ecmascript.py48
-rw-r--r--odoo/addons/test_lint/tests/test_pylint.py68
5 files changed, 143 insertions, 0 deletions
diff --git a/odoo/addons/test_lint/__init__.py b/odoo/addons/test_lint/__init__.py
new file mode 100644
index 00000000000..0e68430dabe
--- /dev/null
+++ b/odoo/addons/test_lint/__init__.py
@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import api, SUPERUSER_ID
+
+
+# TO REMOVE in master
+def uninstall_test_pylint(cr):
+ env = api.Environment(cr, SUPERUSER_ID, {})
+ env['ir.module.module'].search([
+ ('name', '=', 'test_pylint'),
+ ('state', '=', 'installed')
+ ]).write({'state': 'uninstalled'})
diff --git a/odoo/addons/test_lint/__manifest__.py b/odoo/addons/test_lint/__manifest__.py
new file mode 100644
index 00000000000..554e20ba3b2
--- /dev/null
+++ b/odoo/addons/test_lint/__manifest__.py
@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+{
+ 'name': 'test-lint',
+ 'version': '0.1',
+ 'category': 'Tests',
+ 'description': """A module to test Odoo code with various linters.""",
+ 'maintainer': 'Odoo SA',
+ 'depends': ['base'],
+ 'installable': True,
+ 'auto_install': False,
+ 'pre_init_hook': 'uninstall_test_pylint'
+}
diff --git a/odoo/addons/test_lint/tests/__init__.py b/odoo/addons/test_lint/tests/__init__.py
new file mode 100644
index 00000000000..03f1bd714d1
--- /dev/null
+++ b/odoo/addons/test_lint/tests/__init__.py
@@ -0,0 +1,2 @@
+import test_pylint
+import test_ecmascript
diff --git a/odoo/addons/test_lint/tests/test_ecmascript.py b/odoo/addons/test_lint/tests/test_ecmascript.py
new file mode 100644
index 00000000000..46008b0587d
--- /dev/null
+++ b/odoo/addons/test_lint/tests/test_ecmascript.py
@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+import logging
+import os
+import re
+import subprocess
+from unittest import skipIf
+from odoo.tests.common import TransactionCase
+from odoo import tools
+from odoo.modules import get_modules, get_module_path
+
+MAX_ES_VERSION = 'es5'
+
+_logger = logging.getLogger(__name__)
+
+try:
+ es_check = tools.misc.find_in_path('es-check')
+except IOError:
+ es_check = None
+
+
+@skipIf(es_check is None, "es-check tool not found on this system")
+class TestECMAScriptVersion(TransactionCase):
+
+ longMessage = True
+
+ def test_ecmascript_version(self):
+ """ Test that there is no unsupported ecmascript in javascript files """
+
+ black_re = re.compile(r'summernote.+(intro\.js|outro.js)$')
+
+ mod_paths = [get_module_path(m) for m in get_modules()]
+ files_to_check = []
+ for p in mod_paths:
+ for dp, _, file_names in os.walk(p):
+ if 'static/test' in dp:
+ continue
+ for fn in file_names:
+ fullpath_name = os.path.join(dp, fn)
+ if fullpath_name.endswith('.js') and not black_re.search(fullpath_name):
+ files_to_check.append(fullpath_name)
+
+ _logger.info('Testing %s js files', len(files_to_check))
+ cmd = [es_check, MAX_ES_VERSION] + files_to_check
+ process = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ out, err = process.communicate()
+ self.assertEqual(process.returncode, 0, msg=out)
diff --git a/odoo/addons/test_lint/tests/test_pylint.py b/odoo/addons/test_lint/tests/test_pylint.py
new file mode 100644
index 00000000000..fd31bafe161
--- /dev/null
+++ b/odoo/addons/test_lint/tests/test_pylint.py
@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+import logging
+try:
+ import pylint
+except ImportError:
+ pylint = None
+import subprocess
+from distutils.version import LooseVersion
+from os import devnull
+from os.path import join
+
+from odoo.tests.common import TransactionCase
+from odoo import tools
+from odoo.modules import get_modules, get_module_path
+
+
+_logger = logging.getLogger(__name__)
+
+
+class TestPyLint(TransactionCase):
+
+ ENABLED_CODES = [
+ 'E0601', # using variable before assignment
+ 'W0123', # eval used
+ 'W0101', # unreachable code
+
+ 'mixed-indentation',
+ 'deprecated-module',
+ ]
+
+ BAD_MODULES = [
+ ] + list(tools.SUPPORTED_DEBUGGER)
+
+ def _skip_test(self, reason):
+ _logger.warn(reason)
+ self.skipTest(reason)
+
+ def test_pylint(self):
+ if pylint is None:
+ self._skip_test('please install pylint')
+ if LooseVersion(getattr(pylint, '__version__', '0.0.1')) < LooseVersion('1.6.4'):
+ self._skip_test('please upgrade pylint to >= 1.6.4')
+
+ paths = [tools.config['root_path']]
+ for module in get_modules():
+ module_path = get_module_path(module)
+ if not module_path.startswith(join(tools.config['root_path'], 'addons')):
+ paths.append(module_path)
+
+ options = [
+ '--disable=all',
+ '--enable=%s' % ','.join(self.ENABLED_CODES),
+ '--reports=n',
+ "--msg-template='{msg} ({msg_id}) at {path}:{line}'",
+ '--deprecated-modules=%s' % ','.join(self.BAD_MODULES),
+ ]
+
+ try:
+ with open(devnull, 'w') as devnull_file:
+ process = subprocess.Popen(['pylint'] + options + paths, stdout=subprocess.PIPE, stderr=devnull_file)
+ except (OSError, IOError):
+ self._skip_test('pylint executable not found in the path')
+ else:
+ out = process.communicate()[0]
+ if process.returncode:
+ self.fail(msg="\n" + out)