Files
edx-platform/cms/djangoapps/contentstore/features/html-editor.py
2018-08-16 16:30:29 -04:00

307 lines
9.8 KiB
Python

# disable missing docstring
# pylint: disable=missing-docstring
# pylint: disable=no-member
from collections import OrderedDict
from lettuce import step, world
from common import get_codemirror_value, type_in_codemirror
from openedx.core.lib.tests.tools import assert_equal, assert_in # pylint: disable=no-name-in-module
CODEMIRROR_SELECTOR_PREFIX = "$('iframe').contents().find"
@step('I have created a Blank HTML Page$')
def i_created_blank_html_page(step):
step.given('I am in Studio editing a new unit')
world.create_component_instance(
step=step,
category='html',
component_type='Text'
)
@step('I have created a raw HTML component')
def i_created_raw_html(step):
step.given('I am in Studio editing a new unit')
world.create_component_instance(
step=step,
category='html',
component_type='Raw HTML'
)
@step('I see the HTML component settings$')
def i_see_only_the_html_display_name(_step):
world.verify_all_setting_entries(
[
['Display Name', "Text", False],
['Editor', "Visual", False]
]
)
@step('I have created an E-text Written in LaTeX$')
def i_created_etext_in_latex(step):
step.given('I am in Studio editing a new unit')
step.given('I have enabled latex compiler')
world.create_component_instance(
step=step,
category='html',
component_type='E-text Written in LaTeX'
)
@step('I edit the page$')
def i_click_on_edit_icon(_step):
world.edit_component()
@step('I add a link with static link "(.*)" via the Link Plugin Icon$')
def i_click_on_link_plugin_icon(_step, path):
def fill_in_link_fields():
world.css_fill('.mce-textbox', path, 0)
world.css_fill('.mce-textbox', 'picture', 1)
use_plugin('.mce-i-link', fill_in_link_fields)
@step('the link is shown as "(.*)" in the Link Plugin$')
def check_link_in_link_plugin(_step, path):
# Ensure caret position is within the link just created.
script = """
var editor = tinyMCE.activeEditor;
editor.selection.select(editor.dom.select('a')[0]);"""
world.browser.driver.execute_script(script)
world.wait_for_ajax_complete()
use_plugin(
'.mce-i-link',
lambda: assert_equal(path, world.css_find('.mce-textbox')[0].value)
)
@step('type "(.*)" in the code editor and press OK$')
def type_in_codemirror_plugin(_step, text):
# Verify that raw code editor is not visible.
assert world.css_has_class('.CodeMirror', 'is-inactive')
# Verify that TinyMCE editor is present
assert world.is_css_present('.tiny-mce')
use_code_editor(
lambda: type_in_codemirror(0, text, CODEMIRROR_SELECTOR_PREFIX)
)
@step('and the code editor displays "(.*)"$')
def verify_code_editor_text(_step, text):
use_code_editor(
lambda: assert_equal(text, get_codemirror_value(0, CODEMIRROR_SELECTOR_PREFIX))
)
@step('I save the page$')
def i_click_on_save(_step):
world.save_component()
@step('the page text contains:')
def check_page_text(step):
assert_in(step.multiline, world.css_find('.xmodule_HtmlModule').html)
@step('the Raw Editor contains exactly:')
def check_raw_editor_text(step):
assert_equal(step.multiline, get_codemirror_value(0))
@step('the src link is rewritten to the asset link "(.*)"$')
def image_static_link_is_rewritten(_step, path):
# Find the TinyMCE iframe within the main window
with world.browser.get_iframe('mce_0_ifr') as tinymce:
image = tinymce.find_by_tag('img').first
assert_in(unicode(world.scenario_dict['COURSE'].id.make_asset_key('asset', path)), image['src'])
@step('the href link is rewritten to the asset link "(.*)"$')
def link_static_link_is_rewritten(_step, path):
# Find the TinyMCE iframe within the main window
with world.browser.get_iframe('mce_0_ifr') as tinymce:
link = tinymce.find_by_tag('a').first
assert_in(unicode(world.scenario_dict['COURSE'].id.make_asset_key('asset', path)), link['href'])
@step('the expected toolbar buttons are displayed$')
def check_toolbar_buttons(_step):
dropdowns = world.css_find('.mce-listbox')
assert_equal(2, len(dropdowns))
# Format dropdown
assert_equal('Paragraph', dropdowns[0].text)
# Font dropdown
assert_equal('Font Family', dropdowns[1].text)
buttons = world.css_find('.mce-ico')
# Note that the code editor icon is not present because we are now showing text instead of an icon.
# However, other test points user the code editor, so we have already verified its presence.
expected_buttons = [
'bold',
'italic',
'underline',
'forecolor',
# This is our custom "code style" button, which uses an image instead of a class.
'none',
'alignleft',
'aligncenter',
'alignright',
'alignjustify',
'bullist',
'numlist',
'outdent',
'indent',
'blockquote',
'link',
'unlink',
'image'
]
assert_equal(len(expected_buttons), len(buttons))
for index, button in enumerate(expected_buttons):
class_names = buttons[index]._element.get_attribute('class') # pylint: disable=protected-access
assert_equal("mce-ico mce-i-" + button, class_names)
@step('I set the text to "(.*)" and I select the text$')
def set_text_and_select(_step, text):
script = """
var editor = tinyMCE.activeEditor;
editor.setContent(arguments[0]);
editor.selection.select(editor.dom.select('p')[0]);"""
world.browser.driver.execute_script(script, str(text))
world.wait_for_ajax_complete()
@step('I select the code toolbar button$')
def select_code_button(_step):
# This is our custom "code style" button. It uses an image instead of a class.
world.css_click(".mce-i-none")
@step('type "(.*)" into the Raw Editor$')
def type_in_raw_editor(_step, text):
# Verify that CodeMirror editor is not hidden
assert not world.css_has_class('.CodeMirror', 'is-inactive')
# Verify that TinyMCE Editor is not present
assert world.is_css_not_present('.tiny-mce')
type_in_codemirror(0, text)
@step('I edit the component and select the (Raw|Visual) Editor$')
def select_editor(_step, editor):
world.edit_component_and_select_settings()
world.browser.select('Editor', editor)
@step('I click font selection dropdown')
def click_font_dropdown(_step):
dropdowns = [drop for drop in world.css_find('.mce-listbox') if drop.text == 'Font Family']
assert_equal(len(dropdowns), 1)
dropdowns[0].click()
@step('I should see a list of available fonts')
def font_selector_dropdown_is_shown(_step):
font_panel = get_fonts_list_panel(world)
expected_fonts = list(CUSTOM_FONTS.keys()) + list(TINYMCE_FONTS.keys())
actual_fonts = [font.strip() for font in font_panel.text.split('\n')]
assert_equal(actual_fonts, expected_fonts)
@step('"Default" option sets the expected font family')
def default_options_sets_expected_font_family(step): # pylint: disable=unused-argument, redefined-outer-name
fonts = get_available_fonts(get_fonts_list_panel(world))
fonts_found = fonts.get("Default", None)
expected_font_family = CUSTOM_FONTS.get('Default')
for expected_font in expected_font_family:
assert_in(expected_font, fonts_found)
@step('all standard tinyMCE fonts should be available')
def check_standard_tinyMCE_fonts(_step):
fonts = get_available_fonts(get_fonts_list_panel(world))
for label, expected_fonts in TINYMCE_FONTS.items():
for expected_font in expected_fonts:
assert_in(expected_font, fonts.get(label, None))
TINYMCE_FONTS = OrderedDict([
("Andale Mono", ['andale mono', 'times']),
("Arial", ['arial', 'helvetica', 'sans-serif']),
("Arial Black", ['arial black', 'avant garde']),
("Book Antiqua", ['book antiqua', 'palatino']),
("Comic Sans MS", ['comic sans ms', 'sans-serif']),
("Courier New", ['courier new', 'courier']),
("Georgia", ['georgia', 'palatino']),
("Helvetica", ['helvetica']),
("Impact", ['impact', 'chicago']),
("Symbol", ['symbol']),
("Tahoma", ['tahoma', 'arial', 'helvetica', 'sans-serif']),
("Terminal", ['terminal', 'monaco']),
("Times New Roman", ['times new roman', 'times']),
("Trebuchet MS", ['trebuchet ms', 'geneva']),
("Verdana", ['verdana', 'geneva']),
# tinyMCE does not set font-family on dropdown span for these two fonts
("Webdings", [""]), # webdings
("Wingdings", [""]), # wingdings, 'zapf dingbats'
])
CUSTOM_FONTS = OrderedDict([
('Default', ['Open Sans', 'Verdana', 'Arial', 'Helvetica', 'sans-serif']),
])
def use_plugin(button_class, action):
# Click on plugin button
world.css_click(button_class)
perform_action_in_plugin(action)
def use_code_editor(action):
# Click on plugin button
buttons = world.css_find('div.mce-widget>button')
code_editor = [button for button in buttons if button.text == 'HTML']
assert_equal(1, len(code_editor))
code_editor[0].click()
perform_action_in_plugin(action)
def perform_action_in_plugin(action):
# Wait for the plugin window to open.
world.wait_for_visible('.mce-window')
# Trigger the action
action()
# Click OK
world.css_click('.mce-primary')
def get_fonts_list_panel(world):
menus = world.css_find('.mce-menu')
return menus[0]
def get_available_fonts(font_panel):
font_spans = font_panel.find_by_css('.mce-text')
return {font_span.text: get_font_family(font_span) for font_span in font_spans}
def get_font_family(font_span):
# get_attribute('style').replace('font-family: ', '').replace(';', '') is equivalent to
# value_of_css_property('font-family'). However, for reason unknown value_of_css_property fails tests in CI
# while works as expected in local development environment
return font_span._element.get_attribute('style').replace('font-family: ', '').replace(';', '') # pylint: disable=protected-access