# Part of Odoo. See LICENSE file for full copyright and licensing details. from lxml import etree, html import logging import re from odoo.addons.http_routing.tests.common import MockRequest from odoo.tests import tagged, TransactionCase from odoo.tools import escape_psql _logger = logging.getLogger(__name__) CONFLICTUAL_CLASSES = [ ['btn-outline-primary', 'btn-primary', 'btn-secondary'], ['btn-block', 'btn-outline-primary'], ['container', 'container-fluid', 'o_container_small'], ['d-block', 'd-flex', 'd-inline-block', 'd-none'], ['d-block', 'd-lg-block', 'd-md-block'], ['d-flex', 'd-md-flex'], ['flex-column', 'flex-column-reverse', 'flex-row', 'flex-row-reverse'], ['g-0', 'g-col-lg-2', 'g-col-lg-3', 'g-col-lg-4', 'g-col-lg-5', 'g-col-lg-6'], ['g-0', 'g-height-5', 'g-height-8', 'g-height-10'], ['h-100', 'o_half_screen_height', 'o_full_screen_height'], ['justify-content-center', 'justify-content-start'], ['nav-link', 'nav-pills', 'nav-tabs'], ['o_cc1', 'o_cc2', 'o_cc3', 'o_cc4', 'o_cc5'], ['o_spc-medium', 'o_spc-none', 'o_spc-small'], ['oi-arrows-h', 'oi-arrows-v', 'oi-chevron-left', 'oi-chevron-right', 'oi-search'], ['position-absolute', 'position-relative'], ['s_carousel_default', 's_carousel_rounded'], ['s_image_gallery_indicators_arrows_boxed', 's_image_gallery_indicators_arrows_rounded'], ['text-center', 'text-end', 'text-start'], ] # For each RE, associates a whitelist CONFLICTUAL_CLASSES_RE = { # Align re.compile(r'^align-(?!(self|items)-).+'): [], re.compile(r'^align-self-(?:start|center|end)$'): [], re.compile(r'^align-self-sm-(?:start|center|end)$'): [], re.compile(r'^align-self-md-(?:start|center|end)$'): [], re.compile(r'^align-self-lg-(?:start|center|end)$'): [], re.compile(r'^align-self-xl-(?:start|center|end)$'): [], re.compile(r'^align-self-xxl-(?:start|center|end)$'): [], re.compile(r'^align-items-.+'): [], # BG re.compile(r'^bg(-|_)'): [ 'bg_option_menu_gradient', ], # Col re.compile(r'^col-\d+$'): [], re.compile(r'^col-lg-.+'): [], re.compile(r'^offset-\d+$'): [], re.compile(r'^offset-lg-.+'): [], # Display re.compile(r'^display-\d$'): [], re.compile(r'^display-\d-fs$'): [], # Margin, padding re.compile(r'^m-(\d|auto)$'): [], re.compile(r'^m(x|s)-\d$'): [], re.compile(r'^m(x|e)-\d$'): [], re.compile(r'^m(y|t)-\d$'): [], re.compile(r'^m(y|b)-\d$'): [], re.compile(r'^p-?\d+$'): [], re.compile(r'^(p(x|s)-?\d+|padding-.+)$'): [], re.compile(r'^(p(x|e)-?\d+|padding-.+)$'): [], re.compile(r'^(p(y|t)-?\d+|padding-.+)$'): [], # p0+pb32 appears in Bewise and Graphene re.compile(r'^(p(y|b)?-?\d+|padding-.+)$'): ['p0'], # Font awesome re.compile(r'^fa-\dx$'): [], # Whitelist workaround for s_social_media inner snippet Layout: None re.compile(r'^fa-...+'): ['fa-stack'], # Rounded re.compile(r'^rounded-.+'): [], # Shadow re.compile(r'^shadow-.+'): [], # Shapes re.compile(r'^o_html_builder_[A-Z].+'): [], # Text re.compile(r'^text-(?!(center|end|start|bg-|lg-)).*$'): [ 'text-break', 'text-decoration-none', 'text-reset', ], re.compile(r'^text-bg-.*$'): [], re.compile(r'^text-lg-.*$'): [], # Width re.compile(r'^w-\d*$'): [], } # Special case for "s_" classes that respect our convention: classes that share # the same base and follow the naming pattern (s_some, s_some_button) are not # flagged as conflicting. Explicitly whitelist exceptions that don't follow the # pattern only. # TODO all these classes were processed but we might want to re-check them all # to minimize the list if possible. S_CLASSES_WHITELIST = [ # Classes that rightfully belong here at the moment 's_col_no_bgcolor', 's_col_no_resize', 's_allow_columns', 's_nb_column_fixed', 's_dialog_preview', 's_parallax_is_fixed', 's_parallax_bg', 's_parallax_no_overflow_hidden', 's_carousel_cards_card', 's_timeline_card', 's_blog_posts', 's_events', 's_appointments', # Classes that should not be here... but are here by compatibility (not # following our "s_" conventions correctly). 's_process_step', 's_process_step_svg_defs', 's_number', 's_tabs_common', 's_process_steps_connector_line', 's_tabs_nav', 's_tabs_main', 's_tabs_nav_vertical', 's_tabs_nav_with_descriptions', 's_tabs_content', 's_carousel', 's_carousel_default', 's_carousel_boxed', 's_carousel_intro', 's_carousel_rounded', 's_carousel_cards', 's_carousel_indicators_numbers', 's_carousel_indicators_dots', 's_quotes_carousel', 's_rating_no_title', 's_blog_post_big_picture', 's_blog_post_card', 's_blog_post_horizontal', 's_blog_post_list', 's_blog_post_single_aside', 's_blog_post_single_full', 's_blog_post_single_circle', 's_blog_post_single_badge', 's_event_event_picture', 's_event_event_card', 's_event_event_single_card', 's_event_event_single_entry', 's_event_event_single_offset', 's_event_event_single_badge', 's_event_event_single_aside', 's_appointment_type_card', 's_appointment_type_picture', 's_appointment_type_list', 's_newsletter_list', 's_event_upcoming_snippet', 's_event_event_picture', 's_newsletter_subscribe_form', 's_carousel_indicators_hidden', # FIXME those classes have no reason to be here... missing data-snippet? 's_hr', 's_accordion', 's_accordion_highlight', 's_media_list_item', 's_media_list_img_wrapper', 's_media_list_body', 's_media_list_img', 's_website_form_datetime', ] @tagged('post_install', '-at_install') class TestNewPageTemplates(TransactionCase): def test_template_names(self): websites_themes = self.env['website'].get_test_themes_websites() for website in websites_themes: views = self.env['ir.ui.view'].search([ ('key', 'like', f'{website.theme_id.name}.new_page_template%_s_'), ]) if website.theme_id.name != 'theme_default': self.assertGreater(len(views), 10, "Test should have encountered some views in theme %r" % website.name) for view in views: self.assertEqual(view.mode, 'extension', "Theme's new page template customization %r should never be primary" % view.key) name = view.key.split('.')[1] parent_name = view.inherit_id.key.split('.')[1] self.assertEqual(name, parent_name, "Theme's new page template customization %r should use the same name as their parent %r" % (view.key, view.inherit_id.key)) def test_render_templates(self): errors = [] view_ids = set() websites_themes = self.env['website'].get_test_themes_websites() for website in websites_themes: with MockRequest(self.env, website=website): views = self.env['ir.ui.view'].search([ '|', '|', ('key', 'like', f'{website.theme_id.name}.s_'), ('key', 'like', f'{website.theme_id.name}.configurator'), ('key', 'like', f'{website.theme_id.name}.new_page'), ]) view_ids.update(views.ids) for view in views: try: self.env['ir.qweb']._render(view.id) except Exception as e: # noqa: BLE001 errors.append("View %s cannot be rendered (%r)" % (view.key, e)) _logger.info("Tested %s views", len(view_ids)) self.assertGreater(len(view_ids), 1250, "Test should have encountered a lot of views") self.assertFalse(errors, "No error should have been collected") # TODO should handle the fact that grid items can't have padding classes def test_render_applied_templates(self): View = self.env['ir.ui.view'] errors = [] classes_inventory = set() view_count = 0 def check(theme_name, website): with MockRequest(self.env, website=website): views = View.search([ '|', '|', ('key', 'in', [ 'website.snippets', 'website.new_page_template_groups', ]), ('key', 'like', escape_psql('website.configurator_')), ('key', 'like', escape_psql('website.new_page_template_sections_')), ]) for view in views: try: # TODO: Improve the perfs of the next line # Doesn't seem to be a way to avoid one RECURSIVE # SQL Query from `_get_inheriting_views` per view html_text = self.env['ir.qweb']._render(view.id) if not html_text: continue html_tree = html.fromstring(f'{html_text}') blocks_el = html_tree.xpath("//*[@id='o_scroll']") if blocks_el: # Only look at blocks in website.snippets html_tree = blocks_el[0] for el in html_tree.xpath('//*[@class]'): classes = el.attrib['class'].split() classes_inventory.update(classes) if len(classes) != len(set(classes)): errors.append( "Using %r, view %r contains duplicate classes: %r" % (theme_name, view.key, classes) ) for conflicting_classes in CONFLICTUAL_CLASSES: conflict = set(classes).intersection(conflicting_classes) if len(conflict) > 1: errors.append( "Using %r, view %r contains conflicting classes: %r in %r" % (theme_name, view.key, conflict, classes) ) for conflicting_classes_re, white_list in CONFLICTUAL_CLASSES_RE.items(): conflict = set(filter(conflicting_classes_re.findall, set(classes))) conflict.difference_update(white_list) if len(conflict) > 1: errors.append( "Using %r, view %r contains conflicting classes: %r in %r (according to pattern %r)" % (theme_name, view.key, conflict, classes, conflicting_classes_re.pattern) ) # Special handling for snippet classes following # naming convention: if classes match the # 's_snippet_name_*' pattern, they are allowed. non_whitelisted_s_classes = { cl for cl in classes if cl.startswith('s_') and cl not in S_CLASSES_WHITELIST } if non_whitelisted_s_classes: # Check the element classes itself first: if # there is a s_XXX class, s_something_XXX is # automatically accepted as it indicates a # variant of s_XXX (e.g. s_nice_popup being a # variant of s_popup). non_whitelisted_s_classes = { cl for cl in non_whitelisted_s_classes if not any(cl != other_cl and cl.endswith(f'_{other_cl[2:]}') for other_cl in non_whitelisted_s_classes) } # Find all parent elements classes that start # with 's_' (including on the current element). # and only accept classes that are prefixed by # a parent class (+ '_') (e.g. s_table_item # would be accepted inside a s_table (as it is # a sub-element of s_table), and s_table_xs # would be accepted as an option of s_table)). all_parent_s_classes = set() parent_el = el # This also looks for the presence of non- # whitelisted 's_' classes in non-snippets. is_in_snippet = view.key.startswith('website.configurator_') while parent_el is not None: parent_classes = set(parent_el.attrib.get('class', '').split()) all_parent_s_classes.update({cl for cl in parent_classes if cl.startswith('s_')}) if parent_el.attrib.get('data-snippet'): is_in_snippet = True break parent_el = parent_el.getparent() if is_in_snippet: non_whitelisted_s_classes = { cl for cl in non_whitelisted_s_classes if not any(cl.startswith(f'{parent_cls}_') for parent_cls in all_parent_s_classes) } is_snippet_root = el.attrib.get('data-snippet') \ or el.getparent().tag == 'wrap' and view.key.startswith('website.configurator_') if len(non_whitelisted_s_classes) > (1 if is_snippet_root else 0): errors.append( "Using %r, view %r contains 's_' classes that do not respect our conventions: %r in %r" % (theme_name, view.key, non_whitelisted_s_classes, classes) ) else: errors.append( "Using %r, view %r contains 's_' classes (%r) that are not in a snippet" % (theme_name, view.key, non_whitelisted_s_classes) ) for el in html_tree.xpath('//*[@style]'): styles = el.attrib['style'].split(';') non_empty_styles = filter(lambda style: style, styles) property_names = [style.split(':')[0].strip() for style in non_empty_styles] if len(property_names) != len(set(property_names)): errors.append( "Using %r, view %r contains duplicate style properties: %r" % (theme_name, view.key, el.attrib['style']) ) for grid_el in html_tree.xpath("//div[contains(concat(' ', normalize-space(@class), ' '), ' o_grid_mode ')]"): if 'data-row-count' not in grid_el.attrib: errors.append( "Using %r, view %r defines a grid mode row without row count" % (theme_name, view.key) ) continue row_count = int(grid_el.attrib['data-row-count']) max_row = 0 for item_el in grid_el.xpath(".//div[contains(concat(' ', normalize-space(@class), ' '), ' o_grid_item ')]"): classes = item_el.attrib['class'].split() styles = item_el.attrib['style'].split(';') grid_area_style = list(filter(lambda style: style.strip().startswith('grid-area:'), styles)) if not grid_area_style: errors.append( "Using %r, view %r does not specify a grid-area for its grid item" % (theme_name, view.key) ) continue grid_area = grid_area_style[0].split(':')[1].strip() top, left, bottom, right = map(int, grid_area.split('/')) max_row = max(max_row, bottom) height_class = f'g-height-{bottom - top}' if height_class not in classes: errors.append( "Using %r, view %r does not specify %r for grid item %r (%r)" % (theme_name, view.key, height_class, grid_area, classes) ) width_class = f'g-col-lg-{right - left}' if width_class not in classes: errors.append( "Using %r, view %r does not specify %r for grid item %r (%r)" % (theme_name, view.key, width_class, grid_area, classes) ) non_grid_width_class = f'col-lg-{right - left}' if non_grid_width_class not in classes: errors.append( "Using %r, view %r does not specify %r for grid item %r (%r)" % (theme_name, view.key, non_grid_width_class, grid_area, classes) ) padding_classes = list(filter(lambda klass: klass.startswith(('pb', 'pt')), classes)) if padding_classes: errors.append( "Using %r, view %r specifies unnecessary padding classes on grid item %r" % (theme_name, view.key, padding_classes) ) if row_count != max_row - 1: errors.append( "Using %r, view %r defines %r as row count while %r is reached" % (theme_name, view.key, row_count, max_row) ) for el in html_tree.xpath('//*[@data-row-count]'): classes = el.attrib['class'].split() if 'o_grid_mode' not in classes: errors.append( "Using %r, view %r defines a row count on a non-grid mode row" % (theme_name, view.key) ) except Exception as e: # noqa: BLE001 _logger.error("Using %r, view %r cannot be rendered (%r)", theme_name, view.key, e) errors.append("Using %r, view %r cannot be rendered (%r)" % (theme_name, view.key, e)) return len(views) view_count += check('no theme', self.env.ref('website.default_website')) websites_themes = self.env['website'].get_test_themes_websites() for website in websites_themes: view_count += check(website.name, website) _logger.info("Tested %s views", view_count) self.assertGreater(view_count, 2900, "Test should have checked many views") # Use this information to potentially update known possible conflicts. for known_classes in CONFLICTUAL_CLASSES: classes_inventory.difference_update(known_classes) for known_classes in CONFLICTUAL_CLASSES_RE.values(): classes_inventory.difference_update(known_classes) for known_classes_re in CONFLICTUAL_CLASSES_RE: classes_inventory = list(filter(lambda cl: not known_classes_re.findall(cl), classes_inventory)) _logger.info("Unknown classes encountered: %r", sorted(classes_inventory)) self.assertFalse(errors, "No error should have been collected") def test_attribute_separator(self): ATTRIBUTE_SEPARATORS = { 'class': ' ', 'style': ';', 'sizes': ',', 'itemref': ' ', } View = self.env['ir.ui.view'] errors = [] view_count = 0 for module_name in ['website', *(website.theme_id.name for website in self.env['website'].get_test_themes_websites())]: views = View.search([ '|', '|', ('key', 'like', escape_psql(f'{module_name}.s_')), ('key', 'like', escape_psql(f'{module_name}.configurator')), ('key', 'like', escape_psql(f'{module_name}.new_page')), ]) for view in views: try: xml_tree = etree.fromstring(view.arch_db) except etree.LxmlError: _logger.error("Using %r, view %r cannot be parsed: %r", module_name, view.key, view.arch_db) errors.append("Using %r, view %r cannot be parsed: %r" % (module_name, view.key, view.arch_db)) continue for el in xml_tree.xpath('//attribute[@add] | //attribute[@remove]'): attribute_name = el.attrib['name'] if attribute_name in ATTRIBUTE_SEPARATORS: current_separator = el.attrib.get('separator', ',') expected_separator = ATTRIBUTE_SEPARATORS[attribute_name] if current_separator != expected_separator: errors.append( "Using %r, view %r uses separator %r to modify attribute %r" % (module_name, view.key, current_separator, attribute_name) ) view_count += len(views) _logger.info("Tested %s views", view_count) self.assertGreater(view_count, 2500, "Test should have checked many views") self.assertFalse(errors, "No error should have been collected")