+ <%= gettext('This configuration is currently used in content experiments. If you make changes to the groups, you may need to edit those experiments.') %>
+
+
+ <% } %>
diff --git a/common/lib/xmodule/xmodule/split_test_module.py b/common/lib/xmodule/xmodule/split_test_module.py
index f5cec8c6d0..9bc5acffb9 100644
--- a/common/lib/xmodule/xmodule/split_test_module.py
+++ b/common/lib/xmodule/xmodule/split_test_module.py
@@ -607,3 +607,19 @@ class SplitTestDescriptor(SplitTestFields, SequenceDescriptor, StudioEditableDes
)
self.children.append(dest_usage_key) # pylint: disable=no-member
self.group_id_to_child[unicode(group.id)] = dest_usage_key
+
+ @property
+ def general_validation_message(self):
+ """
+ Message for either error or warning validation message/s.
+
+ Returns message and type. Priority given to error type message.
+ """
+ validation_messages = self.validation_messages()
+ if validation_messages:
+ has_error = any(message.message_type == ValidationMessageType.error for message in validation_messages)
+ return {
+ 'message': _(u"This content experiment has issues that affect content visibility."),
+ 'type': ValidationMessageType.error if has_error else ValidationMessageType.warning,
+ }
+ return None
diff --git a/common/lib/xmodule/xmodule/tests/test_split_test_module.py b/common/lib/xmodule/xmodule/tests/test_split_test_module.py
index d144357cab..a7484d902e 100644
--- a/common/lib/xmodule/xmodule/tests/test_split_test_module.py
+++ b/common/lib/xmodule/xmodule/tests/test_split_test_module.py
@@ -344,6 +344,13 @@ class SplitTestModuleStudioTest(SplitTestModuleTest):
self.assertEqual(message.action_class, expected_action_class)
self.assertEqual(message.action_label, expected_action_label)
+ def verify_general_validation_message(general_validation, expected_message, expected_message_type):
+ """
+ Verify that the general validation message has the expected validation message and type.
+ """
+ self.assertEqual(unicode(general_validation['message']), expected_message)
+ self.assertEqual(general_validation['type'], expected_message_type)
+
# Verify the messages for an unconfigured user partition
split_test_module.user_partition_id = -1
messages = split_test_module.validation_messages()
@@ -355,6 +362,11 @@ class SplitTestModuleStudioTest(SplitTestModuleTest):
'edit-button',
u"Select a Group Configuration",
)
+ verify_general_validation_message(
+ split_test_module.general_validation_message,
+ u"This content experiment has issues that affect content visibility.",
+ ValidationMessageType.warning
+ )
# Verify the messages for a correctly configured split_test
split_test_module.user_partition_id = 0
@@ -363,6 +375,7 @@ class SplitTestModuleStudioTest(SplitTestModuleTest):
]
messages = split_test_module.validation_messages()
self.assertEqual(len(messages), 0)
+ self.assertIsNone(split_test_module.general_validation_message, None)
# Verify the messages for a split test with too few groups
split_test_module.user_partitions = [
@@ -378,7 +391,11 @@ class SplitTestModuleStudioTest(SplitTestModuleTest):
'add-missing-groups-button',
u"Add Missing Groups"
)
-
+ verify_general_validation_message(
+ split_test_module.general_validation_message,
+ u"This content experiment has issues that affect content visibility.",
+ ValidationMessageType.error
+ )
# Verify the messages for a split test with children that are not associated with any group
split_test_module.user_partitions = [
UserPartition(0, 'first_partition', 'First Partition',
@@ -391,7 +408,11 @@ class SplitTestModuleStudioTest(SplitTestModuleTest):
u"The experiment has an inactive group. Move content into active groups, then delete the inactive group.",
ValidationMessageType.warning
)
-
+ verify_general_validation_message(
+ split_test_module.general_validation_message,
+ u"This content experiment has issues that affect content visibility.",
+ ValidationMessageType.warning
+ )
# Verify the messages for a split test with both missing and inactive children
split_test_module.user_partitions = [
UserPartition(0, 'first_partition', 'First Partition',
@@ -411,6 +432,12 @@ class SplitTestModuleStudioTest(SplitTestModuleTest):
u"The experiment has an inactive group. Move content into active groups, then delete the inactive group.",
ValidationMessageType.warning
)
+ # With two messages of type error and warning priority given to error.
+ verify_general_validation_message(
+ split_test_module.general_validation_message,
+ u"This content experiment has issues that affect content visibility.",
+ ValidationMessageType.error
+ )
# Verify the messages for a split test referring to a non-existent user partition
split_test_module.user_partition_id = 2
@@ -422,3 +449,8 @@ class SplitTestModuleStudioTest(SplitTestModuleTest):
u"Select a valid group configuration or delete this experiment.",
ValidationMessageType.error
)
+ verify_general_validation_message(
+ split_test_module.general_validation_message,
+ u"This content experiment has issues that affect content visibility.",
+ ValidationMessageType.error
+ )
diff --git a/common/test/acceptance/pages/studio/settings_group_configurations.py b/common/test/acceptance/pages/studio/settings_group_configurations.py
index 500f24f043..6cb380f1c1 100644
--- a/common/test/acceptance/pages/studio/settings_group_configurations.py
+++ b/common/test/acceptance/pages/studio/settings_group_configurations.py
@@ -30,6 +30,14 @@ class GroupConfigurationsPage(CoursePage):
"""
self.q(css=".new-button").first.click()
+ @property
+ def no_group_configuration_message_is_present(self):
+ return self.q(css='.wrapper-content .no-group-configurations-content').present
+
+ @property
+ def no_group_configuration_message_text(self):
+ return self.q(css='.wrapper-content .no-group-configurations-content').text[0]
+
class GroupConfiguration(object):
"""
@@ -198,6 +206,34 @@ class GroupConfiguration(object):
"""
return self.find_css('.wrapper-delete-button').first.attrs('data-tooltip')[0]
+ @property
+ def details_error_icon_is_present(self):
+ return self.find_css('.wrapper-group-configuration-usages .icon-exclamation-sign').present
+
+ @property
+ def details_warning_icon_is_present(self):
+ return self.find_css('.wrapper-group-configuration-usages .icon-warning-sign').present
+
+ @property
+ def details_message_is_present(self):
+ return self.find_css('.wrapper-group-configuration-usages .group-configuration-validation-message').present
+
+ @property
+ def details_message_text(self):
+ return self.find_css('.wrapper-group-configuration-usages .group-configuration-validation-message').text[0]
+
+ @property
+ def edit_warning_icon_is_present(self):
+ return self.find_css('.wrapper-group-configuration-validation .icon-warning-sign').present
+
+ @property
+ def edit_warning_message_is_present(self):
+ return self.find_css('.wrapper-group-configuration-validation .group-configuration-validation-text').present
+
+ @property
+ def edit_warning_message_text(self):
+ return self.find_css('.wrapper-group-configuration-validation .group-configuration-validation-text').text[0]
+
def __repr__(self):
return "<{}:{}>".format(self.__class__.__name__, self.name)
diff --git a/common/test/acceptance/tests/test_studio_split_test.py b/common/test/acceptance/tests/test_studio_split_test.py
index d8c37d087a..7dc15371c5 100644
--- a/common/test/acceptance/tests/test_studio_split_test.py
+++ b/common/test/acceptance/tests/test_studio_split_test.py
@@ -301,6 +301,33 @@ class GroupConfigurationsTest(ContainerBase, SplitTestMixin):
)
)
+ def create_group_configuration_experiment(self, groups, associate_experiment):
+ """
+ Creates a Group Configuration containing a list of groups.
+ Optionally creates a Content Experiment and associates it with previous Group Configuration.
+ """
+ # Create a new group configurations
+ self.course_fixture._update_xblock(self.course_fixture._course_location, {
+ "metadata": {
+ u"user_partitions": [
+ UserPartition(0, "Name", "Description.", groups).to_json(),
+ ],
+ },
+ })
+
+ if associate_experiment:
+ # Assign newly created group configuration to experiment
+ vertical = self.course_fixture.get_nested_xblocks(category="vertical")[0]
+ self.course_fixture.create_xblock(
+ vertical.locator,
+ XBlockFixtureDesc('split_test', 'Test Content Experiment', metadata={'user_partition_id': 0})
+ )
+
+ # Go to the Group Configuration Page
+ self.page.visit()
+ config = self.page.group_configurations[0]
+ return config
+
def test_no_group_configurations_added(self):
"""
Scenario: Ensure that message telling me to create a new group configuration is
@@ -311,11 +338,10 @@ class GroupConfigurationsTest(ContainerBase, SplitTestMixin):
And "Create new Group Configuration" button is available
"""
self.page.visit()
- css = ".wrapper-content .no-group-configurations-content"
- self.assertTrue(self.page.q(css=css).present)
+ self.assertTrue(self.page.no_group_configuration_message_is_present)
self.assertIn(
"You haven't created any group configurations yet.",
- self.page.q(css=css).text[0]
+ self.page.no_group_configuration_message_text
)
def test_group_configurations_have_correct_data(self):
@@ -784,3 +810,115 @@ class GroupConfigurationsTest(ContainerBase, SplitTestMixin):
group_configuration_link_name,
self.page.group_configurations[1].name
)
+
+ def test_details_error_validation_message(self):
+ """
+ Scenario: When a Content Experiment uses a Group Configuration, ensure
+ that an error validation message appears if necessary.
+
+ Given I have a course with a Group Configuration containing two Groups
+ And a Content Experiment is assigned to that Group Configuration
+ When I go to the Group Configuration Page
+ Then I do not see a error icon and message in the Group Configuration details view.
+ When I add a Group
+ Then I see an error icon and message in the Group Configuration details view
+ """
+
+ # Create group configuration and associated experiment
+ config = self.create_group_configuration_experiment([Group("0", "Group A"), Group("1", "Group B")], True)
+
+ # Display details view
+ config.toggle()
+ # Check that error icon and message are not present
+ self.assertFalse(config.details_error_icon_is_present)
+ self.assertFalse(config.details_message_is_present)
+
+ # Add a group
+ config.toggle()
+ config.edit()
+ config.add_group()
+ config.save()
+
+ # Display details view
+ config.toggle()
+ # Check that error icon and message are present
+ self.assertTrue(config.details_error_icon_is_present)
+ self.assertTrue(config.details_message_is_present)
+ self.assertIn(
+ "This content experiment has issues that affect content visibility.",
+ config.details_message_text
+ )
+
+ def test_details_warning_validation_message(self):
+ """
+ Scenario: When a Content Experiment uses a Group Configuration, ensure
+ that a warning validation message appears if necessary.
+
+ Given I have a course with a Group Configuration containing three Groups
+ And a Content Experiment is assigned to that Group Configuration
+ When I go to the Group Configuration Page
+ Then I do not see a warning icon and message in the Group Configuration details view.
+ When I remove a Group
+ Then I see a warning icon and message in the Group Configuration details view
+ """
+
+ # Create group configuration and associated experiment
+ config = self.create_group_configuration_experiment([Group("0", "Group A"), Group("1", "Group B"), Group("2", "Group C")], True)
+
+ # Display details view
+ config.toggle()
+ # Check that warning icon and message are not present
+ self.assertFalse(config.details_warning_icon_is_present)
+ self.assertFalse(config.details_message_is_present)
+
+ # Remove a group
+ config.toggle()
+ config.edit()
+ config.groups[2].remove()
+ config.save()
+
+ # Display details view
+ config.toggle()
+ # Check that warning icon and message are present
+ self.assertTrue(config.details_warning_icon_is_present)
+ self.assertTrue(config.details_message_is_present)
+ self.assertIn(
+ "This content experiment has issues that affect content visibility.",
+ config.details_message_text
+ )
+
+ def test_edit_warning_message_empty_usage(self):
+ """
+ Scenario: When a Group Configuration is not used, ensure that there are no warning icon and message.
+
+ Given I have a course with a Group Configuration containing two Groups
+ When I edit the Group Configuration
+ Then I do not see a warning icon and message
+ """
+
+ # Create a group configuration with no associated experiment and display edit view
+ config = self.create_group_configuration_experiment([Group("0", "Group A"), Group("1", "Group B")], False)
+ config.edit()
+ # Check that warning icon and message are not present
+ self.assertFalse(config.edit_warning_icon_is_present)
+ self.assertFalse(config.edit_warning_message_is_present)
+
+ def test_edit_warning_message_non_empty_usage(self):
+ """
+ Scenario: When a Group Configuration is used, ensure that there are a warning icon and message.
+
+ Given I have a course with a Group Configuration containing two Groups
+ When I edit the Group Configuration
+ Then I see a warning icon and message
+ """
+
+ # Create a group configuration with an associated experiment and display edit view
+ config = self.create_group_configuration_experiment([Group("0", "Group A"), Group("1", "Group B")], True)
+ config.edit()
+ # Check that warning icon and message are present
+ self.assertTrue(config.edit_warning_icon_is_present)
+ self.assertTrue(config.edit_warning_message_is_present)
+ self.assertIn(
+ "This configuration is currently used in content experiments. If you make changes to the groups, you may need to edit those experiments.",
+ config.edit_warning_message_text
+ )
diff --git a/lms/templates/split_test_author_view.html b/lms/templates/split_test_author_view.html
index 0e0e9e5fe9..49477874a5 100644
--- a/lms/templates/split_test_author_view.html
+++ b/lms/templates/split_test_author_view.html
@@ -27,22 +27,20 @@ show_link = settings.FEATURES.get('ENABLE_GROUP_CONFIGURATIONS') and group_confi
% endif
% if len(messages) > 0:
<%
+ general_validation = split_test.descriptor.general_validation_message
def get_validation_icon(validation_type):
- if validation_type == 'error':
+ if validation_type == ValidationMessageType.error:
return 'icon-exclamation-sign'
- elif validation_type == 'warning':
+ elif validation_type == ValidationMessageType.warning:
return 'icon-warning-sign'
return None
- error_messages = (message for message in messages if message.message_type==ValidationMessageType.error)
- has_errors = next(error_messages, False)
- aggregate_validation_class = 'has-errors' if has_errors else 'has-warnings'
- aggregate_validation_type = 'error' if has_errors else 'warning'
+ aggregate_validation_class = 'has-errors' if general_validation['type']==ValidationMessageType.error else ' has-warnings'
%>
% if is_configured:
-
- ${_("This content experiment has issues that affect content visibility.")}
+