[ADD] add base_module_quality module

bzr revid: mra@tinyerp.com-20090703052040-3rokridr4h3z33xj

2 files changed, 200 insertions, 0 deletions

diff --git a/addons/base_module_quality/structure_test/__init__.py b/addons/base_module_quality/structure_test/__init__.py
new file mode 100644
index 00000000000..cfc1f614751
--- /dev/null
+++ b/addons/base_module_quality/structure_test/__init__.py
@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
+#    $Id$
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+
+# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
diff --git a/addons/base_module_quality/structure_test/structure_test.py b/addons/base_module_quality/structure_test/structure_test.py
new file mode 100644
index 00000000000..93b49b46c3d
--- /dev/null
+++ b/addons/base_module_quality/structure_test/structure_test.py
@@ -0,0 +1,176 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
+#    $Id$
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU 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 General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+import os
+
+from tools.translate import _
+from base_module_quality import base_module_quality
+
+class quality_test(base_module_quality.abstract_quality_check):
+
+    def __init__(self):
+        super(quality_test, self).__init__()
+        self.name = _("Structure Test")
+        self.note = _("""
+This test checks if the module satisfy tiny structure
+""")
+        self.bool_installed_only = False
+        self.result_dict = {}
+        self.module_score = 0.0
+        self.count = 0
+        self.recur = True
+        return None
+
+    def run_test_struct(self, cr, uid, module_path):
+        len_module = len(module_path.split('/'))
+        module_name = module_path.split('/')
+        module_name = module_name[len_module-1]
+        list_files = os.listdir(module_path)
+        self.result_dict = {}
+        f_list = []
+        module_dict = {}
+        module_dict['module'] = []
+#        count = 0
+        final_score = 0.0
+
+        if not module_name.islower():
+            self.result_dict[module_name] = [module_name, 'Module name should have in lowercase']
+        for file_struct in list_files:
+            if file_struct.split('.')[-1] != 'pyc':
+                path = os.path.join(module_path, file_struct)
+                if file_struct == 'wizard' and os.path.isdir(path):
+                    module_dict[file_struct] = []
+                elif file_struct == 'report' and os.path.isdir(path):
+                    module_dict[file_struct] = []
+                elif file_struct == 'security' and os.path.isdir(path):
+                    module_dict[file_struct] = []
+                elif file_struct == 'process' and os.path.isdir(path):
+                    module_dict[file_struct] = []
+                elif file_struct != 'i18n' and os.path.isdir(path):
+#                    self.counter += 1
+                    self.run_test(cr, uid, path)
+                module_dict['module'].append(file_struct)
+                f_list.append(file_struct)
+        for i in f_list:
+            path = os.path.join(module_path, i)
+            if os.path.isdir(path) and not i == 'i18n':
+                for j in os.listdir(path):
+                    if i in ['report', 'wizard', 'security', 'module', 'process'] and j.split('.')[-1] != 'pyc':
+                        module_dict[i].append(j)
+                        f_list.append(os.path.join(i, j))
+
+        # module files calculation (module.py,module_view.xml,etc..)
+        com_list = ['_unit_test.xml', '.py', '_view.xml', '_workflow.xml' , '_wizard.xml', '_report.xml', '_data.xml', '_demo.xml', '_security.xml', '_sequence.xml', '_graph.xml']
+        com_list = map(lambda x: module_name + x, com_list)
+        main_file = ['__init__.py', '__terp__.py']
+        com_list.extend(main_file)
+        module_dict['module'] = filter(lambda x: len(x.split(".")) > 1, module_dict['module'])
+        score = self.get_score(module_dict['module'], com_list)
+        self.count = self.count + 1
+        final_score += score
+
+        # report folder checking...
+        if module_dict.has_key('report'):
+            report_pys = filter(lambda x: (len(x.split('.'))>1 and x.split('.')[1] == 'py') and x != '__init__.py', module_dict['report'])
+            report_pys = map(lambda x:x.split('.')[0], report_pys)
+            reports = ['.sxw', '.rml', '.xsl', '.py', '.xml']
+            org_list_rep = []
+            for pys in report_pys:
+                for report in reports:
+                    org_list_rep.append(pys + report)
+            org_list_rep.append('__init__.py')
+            score_report = self.get_score(module_dict['report'], org_list_rep, 'report/')
+            self.count = self.count + 1
+            final_score += score_report
+
+        # wizard folder checking...
+        if module_dict.has_key('wizard'):
+            wizard_pys = filter(lambda x: (len(x.split('.'))>1 and x.split('.')[1] == 'py') and x != '__init__.py', module_dict['wizard'])
+            wizard_pys = map(lambda x:x.split('.')[0], wizard_pys)
+            wizards = ['_view.xml', '_workflow.xml', '.py']
+            org_list_wiz = []
+            for pys in wizard_pys:
+                for report in wizards:
+                    org_list_wiz.append(pys + report)
+            org_list_wiz.append('__init__.py')
+            score_wizard = self.get_score(module_dict['wizard'], org_list_wiz, 'wizard/')
+            self.count = self.count + 1
+            final_score += score_wizard
+
+        # security folder checking...
+        if module_dict.has_key('security'):
+            security = [module_name + '_security.xml']
+            security.extend(['ir.model.access.csv'])
+            score_security = self.get_score(module_dict['security'], security, 'security/')
+            self.count = self.count + 1
+            final_score += score_security
+
+        # process folder checking...
+        if module_dict.has_key('process'):
+            process = [module_name + '_process.xml']
+            score_process = self.get_score(module_dict['process'], process, 'process/')
+            self.count = self.count + 1
+            final_score += score_process
+
+        # final score
+        self.module_score +=  final_score
+        self.score = self.module_score / (self.count)
+        self.result = self.get_result({ module_name: [module_name, int(self.score*100)]})
+#        self.result_details += self.get_result_details(self.result_dict)
+        return None
+
+    def run_test(self, cr, uid, module_path):
+        self.run_test_struct(cr, uid, module_path)
+        if self.score != 1:
+            self.result_details = self.get_result_details(self.result_dict)
+        return None
+
+
+    def get_result(self, dict_struct):
+        header = ('{| border="1" cellspacing="0" cellpadding="5" align="left" \n! %-40s \n! %-10s \n', [_('Module Name'), _('Result in %')])
+        if not self.error:
+            return self.format_table(header, data_list=dict_struct)
+        return ""
+
+    def get_score(self, module_list, original_files, mod_folder=''):
+        score = 0
+        module_length = len(module_list)
+        for i in module_list:
+            if i in original_files:
+                score += 1
+            else:
+                if mod_folder != 'wizard/':
+                    self.result_dict[i] = [mod_folder + i, 'File name does not follow naming standards.']
+                    score -= 1
+                    module_length -= 1
+        score = module_length and float(score) / float(module_length)
+        return score
+
+    def get_result_details(self, dict_struct):
+        str_html = '''<html><head></head><body><table>'''
+        header = ('<tr><th>%s</th><th>%s</th></tr>', [_('File Name'), _('Feedback about structure of module')])
+        if not self.error:
+            res = str_html + self.format_html_table(header, data_list=dict_struct) + '</table></body></html>'
+            return res
+        return ""
+
+# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
+