def test_authorable_blocks_empty_model(self): """ Tests authorable_xblocks returns an empty list if XBlockStudioConfiguration table is empty, regardless of whether or not XBlockStudioConfigurationFlag is enabled. """ XBlockStudioConfiguration.objects.all().delete() self.assertFalse(XBlockStudioConfigurationFlag.is_enabled()) self.assertEqual(0, len(authorable_xblocks(allow_unsupported=True))) XBlockStudioConfigurationFlag(enabled=True).save() self.assertEqual(0, len(authorable_xblocks(allow_unsupported=True)))
def _advanced_component_types(show_unsupported): """ Return advanced component types which can be created. Args: show_unsupported: if True, unsupported XBlocks may be included in the return value Returns: A dict of authorable XBlock types and their support levels (see XBlockStudioConfiguration). For example: { "done": "us", # unsupported "discussion: "fs" # fully supported } Note that the support level will be "True" for all XBlocks if XBlockStudioConfigurationFlag is not enabled. """ enabled_block_types = _filter_disabled_blocks(ADVANCED_COMPONENT_TYPES) if XBlockStudioConfigurationFlag.is_enabled(): authorable_blocks = authorable_xblocks( allow_unsupported=show_unsupported) filtered_blocks = {} for block in authorable_blocks: if block.name in enabled_block_types: filtered_blocks[block.name] = block.support_level return filtered_blocks else: all_blocks = {} for block_name in enabled_block_types: all_blocks[block_name] = True return all_blocks
def _advanced_component_types(show_unsupported): """ Return advanced component types which can be created. Args: show_unsupported: if True, unsupported XBlocks may be included in the return value Returns: A dict of authorable XBlock types and their support levels (see XBlockStudioConfiguration). For example: { "done": "us", # unsupported "discussion: "fs" # fully supported } Note that the support level will be "True" for all XBlocks if XBlockStudioConfigurationFlag is not enabled. """ enabled_block_types = _filter_disabled_blocks(ADVANCED_COMPONENT_TYPES) if XBlockStudioConfigurationFlag.is_enabled(): authorable_blocks = authorable_xblocks(allow_unsupported=show_unsupported) filtered_blocks = {} for block in authorable_blocks: if block.name in enabled_block_types: filtered_blocks[block.name] = block.support_level return filtered_blocks else: all_blocks = {} for block_name in enabled_block_types: all_blocks[block_name] = True return all_blocks
def test_authorable_blocks_by_name(self): """ Tests authorable_xblocks when configuration flag is enabled and name is specified. """ def verify_xblock_fields(name, template, support_level, block): """ Verifies the returned xblock state. """ self.assertEqual(name, block.name) self.assertEqual(template, block.template) self.assertEqual(support_level, block.support_level) XBlockStudioConfigurationFlag(enabled=True).save() # There are no xblocks with name video. authorable_blocks = authorable_xblocks(name="video") self.assertEqual(0, len(authorable_blocks)) # There is only a single html xblock. authorable_blocks = authorable_xblocks(name="html") self.assertEqual(1, len(authorable_blocks)) verify_xblock_fields("html", "zoom", XBlockStudioConfiguration.PROVISIONAL_SUPPORT, authorable_blocks[0]) authorable_blocks = authorable_xblocks(name="problem", allow_unsupported=True) self.assertEqual(3, len(authorable_blocks)) no_template = None circuit = None multiple_choice = None for block in authorable_blocks: if block.template == '': no_template = block elif block.template == 'circuit_schematic_builder': circuit = block elif block.template == 'multiple_choice': multiple_choice = block verify_xblock_fields("problem", "", XBlockStudioConfiguration.FULL_SUPPORT, no_template) verify_xblock_fields("problem", "circuit_schematic_builder", XBlockStudioConfiguration.UNSUPPORTED, circuit) verify_xblock_fields("problem", "multiple_choice", XBlockStudioConfiguration.FULL_SUPPORT, multiple_choice)
def test_authorable_blocks_empty_model(self): """ Tests authorable_xblocks returns an empty list if the configuration flag is enabled but the XBlockStudioConfiguration table is empty. """ XBlockStudioConfigurationFlag(enabled=True).save() XBlockStudioConfiguration.objects.all().delete() self.assertEqual(0, len(authorable_xblocks(allow_unsupported=True)))
def test_authorable_blocks(self): """ Tests authorable_xblocks when name is not specified. """ authorable_xblock_names = [block.name for block in authorable_xblocks()] self.assertItemsEqual(["done", "problem", "problem", "html"], authorable_xblock_names) # Note that "survey" is disabled in XBlockConfiguration, but it is still returned by # authorable_xblocks because it is marked as enabled and unsupported in XBlockStudioConfiguration. # Since XBlockConfiguration is a blacklist and relates to xblock type, while XBlockStudioConfiguration # is a whitelist and uses a combination of xblock type and template (and in addition has a global feature flag), # it is expected that Studio code will need to filter by both disabled_xblocks and authorable_xblocks. authorable_xblock_names = [block.name for block in authorable_xblocks(allow_unsupported=True)] self.assertItemsEqual( ["survey", "done", "problem", "problem", "problem", "html", "split_module"], authorable_xblock_names )
def get_component_templates(courselike, library=False): """ Returns the applicable component templates that can be used by the specified course or library. """ def create_template_dict(name, category, support_level, boilerplate_name=None, tab="common", hinted=False): """ Creates a component template dict. Parameters display_name: the user-visible name of the component category: the type of component (problem, html, etc.) support_level: the support level of this component boilerplate_name: name of boilerplate for filling in default values. May be None. hinted: True if hinted problem else False tab: common(default)/advanced, which tab it goes in """ return { "display_name": name, "category": category, "boilerplate_name": boilerplate_name, "hinted": hinted, "tab": tab, "support_level": support_level } def component_support_level(editable_types, name, template=None): """ Returns the support level for the given xblock name/template combination. Args: editable_types: a QuerySet of xblocks with their support levels name: the name of the xblock template: optional template for the xblock Returns: If XBlockStudioConfigurationFlag is enabled, returns the support level (see XBlockStudioConfiguration) or False if this xblock name/template combination has no Studio support at all. If XBlockStudioConfigurationFlag is disabled, simply returns True. """ # If the Studio support feature is disabled, return True for all. if not XBlockStudioConfigurationFlag.is_enabled(): return True if template is None: template = "" extension_index = template.rfind(".yaml") if extension_index >= 0: template = template[0:extension_index] for block in editable_types: if block.name == name and block.template == template: return block.support_level return False def create_support_legend_dict(): """ Returns a dict of settings information for the display of the support level legend. """ return { "show_legend": XBlockStudioConfigurationFlag.is_enabled(), "allow_unsupported_xblocks": allow_unsupported, "documentation_label": _(u"{platform_name} Support Levels:").format( platform_name=settings.PLATFORM_NAME) } component_display_names = { 'discussion': _("Discussion"), 'html': _("HTML"), 'problem': _("Problem"), 'video': _("Video") } component_templates = [] categories = set() # The component_templates array is in the order of "advanced" (if present), followed # by the components in the order listed in COMPONENT_TYPES. component_types = COMPONENT_TYPES[:] # Libraries do not support discussions if library: component_types = [ component for component in component_types if component != 'discussion' ] component_types = _filter_disabled_blocks(component_types) # Content Libraries currently don't allow opting in to unsupported xblocks/problem types. allow_unsupported = getattr(courselike, "allow_unsupported_xblocks", False) for category in component_types: authorable_variations = authorable_xblocks( allow_unsupported=allow_unsupported, name=category) support_level_without_template = component_support_level( authorable_variations, category) templates_for_category = [] component_class = _load_mixed_class(category) if support_level_without_template: # add the default template with localized display name # TODO: Once mixins are defined per-application, rather than per-runtime, # this should use a cms mixed-in class. (cpennington) display_name = xblock_type_display_name( category, _('Blank')) # this is the Blank Advanced problem templates_for_category.append( create_template_dict(display_name, category, support_level_without_template, None, 'advanced')) categories.add(category) # add boilerplates if hasattr(component_class, 'templates'): for template in component_class.templates(): filter_templates = getattr(component_class, 'filter_templates', None) if not filter_templates or filter_templates( template, courselike): template_id = template.get('template_id') support_level_with_template = component_support_level( authorable_variations, category, template_id) if support_level_with_template: # Tab can be 'common' 'advanced' # Default setting is common/advanced depending on the presence of markdown tab = 'common' if template['metadata'].get('markdown') is None: tab = 'advanced' hinted = template.get('hinted', False) templates_for_category.append( create_template_dict( _(template['metadata'].get('display_name')), category, support_level_with_template, template_id, tab, hinted, )) # Add any advanced problem types. Note that these are different xblocks being stored as Advanced Problems, # currently not supported in libraries . if category == 'problem' and not library: disabled_block_names = [block.name for block in disabled_xblocks()] advanced_problem_types = [ advanced_problem_type for advanced_problem_type in ADVANCED_PROBLEM_TYPES if advanced_problem_type['component'] not in disabled_block_names ] for advanced_problem_type in advanced_problem_types: component = advanced_problem_type['component'] boilerplate_name = advanced_problem_type['boilerplate_name'] authorable_advanced_component_variations = authorable_xblocks( allow_unsupported=allow_unsupported, name=component) advanced_component_support_level = component_support_level( authorable_advanced_component_variations, component, boilerplate_name) if advanced_component_support_level: try: component_display_name = xblock_type_display_name( component) except PluginMissingError: log.warning( u'Unable to load xblock type %s to read display_name', component, exc_info=True) else: templates_for_category.append( create_template_dict( component_display_name, component, advanced_component_support_level, boilerplate_name, 'advanced')) categories.add(component) component_templates.append({ "type": category, "templates": templates_for_category, "display_name": component_display_names[category], "support_legend": create_support_legend_dict() }) # Libraries do not support advanced components at this time. if library: return component_templates # Check if there are any advanced modules specified in the course policy. # These modules should be specified as a list of strings, where the strings # are the names of the modules in ADVANCED_COMPONENT_TYPES that should be # enabled for the course. course_advanced_keys = courselike.advanced_modules advanced_component_templates = { "type": "advanced", "templates": [], "display_name": _("Advanced"), "support_legend": create_support_legend_dict() } advanced_component_types = _advanced_component_types(allow_unsupported) # Set component types according to course policy file if isinstance(course_advanced_keys, list): for category in course_advanced_keys: if category in advanced_component_types.keys( ) and category not in categories: # boilerplates not supported for advanced components try: component_display_name = xblock_type_display_name( category, default_display_name=category) advanced_component_templates['templates'].append( create_template_dict( component_display_name, category, advanced_component_types[category])) categories.add(category) except PluginMissingError: # dhm: I got this once but it can happen any time the # course author configures an advanced component which does # not exist on the server. This code here merely # prevents any authors from trying to instantiate the # non-existent component type by not showing it in the menu log.warning( u"Advanced component %s does not exist. It will not be added to the Studio new component menu.", category) else: log.error(u"Improper format for course advanced keys! %s", course_advanced_keys) if len(advanced_component_templates['templates']) > 0: component_templates.insert(0, advanced_component_templates) return component_templates
def get_component_templates(courselike, library=False): """ Returns the applicable component templates that can be used by the specified course or library. """ def create_template_dict(name, category, support_level, boilerplate_name=None, tab="common", hinted=False): """ Creates a component template dict. Parameters display_name: the user-visible name of the component category: the type of component (problem, html, etc.) support_level: the support level of this component boilerplate_name: name of boilerplate for filling in default values. May be None. hinted: True if hinted problem else False tab: common(default)/advanced, which tab it goes in """ return { "display_name": name, "category": category, "boilerplate_name": boilerplate_name, "hinted": hinted, "tab": tab, "support_level": support_level } def component_support_level(editable_types, name, template=None): """ Returns the support level for the given xblock name/template combination. Args: editable_types: a QuerySet of xblocks with their support levels name: the name of the xblock template: optional template for the xblock Returns: If XBlockStudioConfigurationFlag is enabled, returns the support level (see XBlockStudioConfiguration) or False if this xblock name/template combination has no Studio support at all. If XBlockStudioConfigurationFlag is disabled, simply returns True. """ # If the Studio support feature is disabled, return True for all. if not XBlockStudioConfigurationFlag.is_enabled(): return True if template is None: template = "" extension_index = template.rfind(".yaml") if extension_index >= 0: template = template[0:extension_index] for block in editable_types: if block.name == name and block.template == template: return block.support_level return False def create_support_legend_dict(): """ Returns a dict of settings information for the display of the support level legend. """ return { "show_legend": XBlockStudioConfigurationFlag.is_enabled(), "allow_unsupported_xblocks": allow_unsupported, "documentation_label": _("{platform_name} Support Levels:").format(platform_name=settings.PLATFORM_NAME) } component_display_names = { 'discussion': _("Discussion"), 'html': _("HTML"), 'problem': _("Problem"), 'video': _("Video") } component_templates = [] categories = set() # The component_templates array is in the order of "advanced" (if present), followed # by the components in the order listed in COMPONENT_TYPES. component_types = COMPONENT_TYPES[:] # Libraries do not support discussions if library: component_types = [component for component in component_types if component != 'discussion'] component_types = _filter_disabled_blocks(component_types) # Content Libraries currently don't allow opting in to unsupported xblocks/problem types. allow_unsupported = getattr(courselike, "allow_unsupported_xblocks", False) for category in component_types: authorable_variations = authorable_xblocks(allow_unsupported=allow_unsupported, name=category) support_level_without_template = component_support_level(authorable_variations, category) templates_for_category = [] component_class = _load_mixed_class(category) if support_level_without_template: # add the default template with localized display name # TODO: Once mixins are defined per-application, rather than per-runtime, # this should use a cms mixed-in class. (cpennington) display_name = xblock_type_display_name(category, _('Blank')) # this is the Blank Advanced problem templates_for_category.append( create_template_dict(display_name, category, support_level_without_template, None, 'advanced') ) categories.add(category) # add boilerplates if hasattr(component_class, 'templates'): for template in component_class.templates(): filter_templates = getattr(component_class, 'filter_templates', None) if not filter_templates or filter_templates(template, courselike): template_id = template.get('template_id') support_level_with_template = component_support_level( authorable_variations, category, template_id ) if support_level_with_template: # Tab can be 'common' 'advanced' # Default setting is common/advanced depending on the presence of markdown tab = 'common' if template['metadata'].get('markdown') is None: tab = 'advanced' hinted = template.get('hinted', False) templates_for_category.append( create_template_dict( _(template['metadata'].get('display_name')), # pylint: disable=translation-of-non-string category, support_level_with_template, template_id, tab, hinted, ) ) # Add any advanced problem types. Note that these are different xblocks being stored as Advanced Problems, # currently not supported in libraries . if category == 'problem' and not library: disabled_block_names = [block.name for block in disabled_xblocks()] advanced_problem_types = [advanced_problem_type for advanced_problem_type in ADVANCED_PROBLEM_TYPES if advanced_problem_type['component'] not in disabled_block_names] for advanced_problem_type in advanced_problem_types: component = advanced_problem_type['component'] boilerplate_name = advanced_problem_type['boilerplate_name'] authorable_advanced_component_variations = authorable_xblocks( allow_unsupported=allow_unsupported, name=component ) advanced_component_support_level = component_support_level( authorable_advanced_component_variations, component, boilerplate_name ) if advanced_component_support_level: try: component_display_name = xblock_type_display_name(component) except PluginMissingError: log.warning('Unable to load xblock type %s to read display_name', component, exc_info=True) else: templates_for_category.append( create_template_dict( component_display_name, component, advanced_component_support_level, boilerplate_name, 'advanced' ) ) categories.add(component) component_templates.append({ "type": category, "templates": templates_for_category, "display_name": component_display_names[category], "support_legend": create_support_legend_dict() }) # Libraries do not support advanced components at this time. if library: return component_templates # Check if there are any advanced modules specified in the course policy. # These modules should be specified as a list of strings, where the strings # are the names of the modules in ADVANCED_COMPONENT_TYPES that should be # enabled for the course. course_advanced_keys = courselike.advanced_modules advanced_component_templates = { "type": "advanced", "templates": [], "display_name": _("Advanced"), "support_legend": create_support_legend_dict() } advanced_component_types = _advanced_component_types(allow_unsupported) # Set component types according to course policy file if isinstance(course_advanced_keys, list): for category in course_advanced_keys: if category in advanced_component_types.keys() and category not in categories: # boilerplates not supported for advanced components try: component_display_name = xblock_type_display_name(category, default_display_name=category) advanced_component_templates['templates'].append( create_template_dict( component_display_name, category, advanced_component_types[category] ) ) categories.add(category) except PluginMissingError: # dhm: I got this once but it can happen any time the # course author configures an advanced component which does # not exist on the server. This code here merely # prevents any authors from trying to instantiate the # non-existent component type by not showing it in the menu log.warning( "Advanced component %s does not exist. It will not be added to the Studio new component menu.", category ) else: log.error( "Improper format for course advanced keys! %s", course_advanced_keys ) if len(advanced_component_templates['templates']) > 0: component_templates.insert(0, advanced_component_templates) return component_templates
def test_authorable_blocks_flag_disabled(self): """ Tests authorable_xblocks returns None if the configuration flag is not enabled. """ self.assertFalse(XBlockStudioConfigurationFlag.is_enabled()) self.assertIsNone(authorable_xblocks())