Merge pull request #5046 from petevdp/submission-preferences-confirma…

…tion-flash

Added confirmation flash when submission preferences are saved.

securedrop/journalist_app/admin.py

@@ -59,6 +59,7 @@ def update_submission_preferences():
         form = SubmissionPreferencesForm()
         if form.validate_on_submit():
             # The UI prompt ("prevent") is the opposite of the setting ("allow"):
+            flash(gettext("Preferences saved."), "submission-preferences-success")
             value = not bool(request.form.get('prevent_document_uploads'))
             InstanceConfig.set('allow_document_uploads', value)
             return redirect(url_for('admin.manage_config'))

securedrop/journalist_templates/config.html

@@ -54,6 +54,7 @@ <h2>{{ gettext('Submission Preferences') }}</h2>
   <button type="submit" id="submit-submission-preferences">
     <i class="fas fa-pencil-alt"></i> {{ gettext('UPDATE SUBMISSION PREFERENCES') }}
   </button>
+  {% include 'submission_preferences_saved_flash.html' %}
 </form>
 
 {% endblock %}

securedrop/journalist_templates/logo_upload_flashed.html

@@ -1,4 +1,4 @@
-{# these are flashed messages for the logo upload file verifiaction #}
+{# these are flashed messages for the logo upload file verification #}
 {% with messages = get_flashed_messages(with_categories=True, category_filter=["logo-success", "logo-error"]) %}
   {% for category, message in messages %}
     {% set category_status = category[5:] %}

securedrop/journalist_templates/submission_preferences_saved_flash.html

@@ -0,0 +1,11 @@
+{% with messages = get_flashed_messages(with_categories=True, category_filter=["submission-preferences-success"]) %}
+  {% for category, message in messages %}
+{#  Get the end of the of the category message which
+    contains the category status.(success/error)#}
+    {% set category_status = category[23:] %}
+      <div class="flash {{ category_status }}">
+        <img src="{{ url_for('static', filename='i/success_checkmark.png') }}" height="17" width="20">
+        {{ message }}
+      </div>
+  {% endfor %}
+{% endwith %}

securedrop/tests/functional/journalist_navigation_steps.py

@@ -287,11 +287,21 @@ def _admin_disallows_document_uploads(self):
             self.safe_click_by_id("prevent_document_uploads")
             self.safe_click_by_id("submit-submission-preferences")
 
+        def preferences_saved():
+            flash_msg = self.driver.find_element_by_css_selector(".flash")
+            assert "Preferences saved." in flash_msg.text
+        self.wait_for(preferences_saved, timeout=self.timeout * 6)
+
     def _admin_allows_document_uploads(self):
         if self.driver.find_element_by_id("prevent_document_uploads").is_selected():
             self.safe_click_by_id("prevent_document_uploads")
             self.safe_click_by_id("submit-submission-preferences")
 
+        def preferences_saved():
+            flash_msg = self.driver.find_element_by_css_selector(".flash")
+            assert "Preferences saved." in flash_msg.text
+        self.wait_for(preferences_saved, timeout=self.timeout * 6)
+
     def _add_user(self, username, first_name="", last_name="", is_admin=False, hotp=None):
         self.safe_send_keys_by_css_selector('input[name="username"]', username)
 

securedrop/tests/test_journalist.py

@@ -1297,6 +1297,11 @@ def test_prevent_document_uploads(journalist_app, test_admin):
                  data=form.data,
                  follow_redirects=True)
         assert InstanceConfig.get_current().allow_document_uploads is False
+        with InstrumentedApp(journalist_app) as ins:
+            app.post(url_for('admin.update_submission_preferences'),
+                     data=form.data,
+                     follow_redirects=True)
+            ins.assert_message_flashed('Preferences saved.', 'submission-preferences-success')
 
 
 def test_no_prevent_document_uploads(journalist_app, test_admin):
@@ -1306,6 +1311,10 @@ def test_no_prevent_document_uploads(journalist_app, test_admin):
         app.post(url_for('admin.update_submission_preferences'),
                  follow_redirects=True)
         assert InstanceConfig.get_current().allow_document_uploads is True
+        with InstrumentedApp(journalist_app) as ins:
+            app.post(url_for('admin.update_submission_preferences'),
+                     follow_redirects=True)
+            ins.assert_message_flashed('Preferences saved.', 'submission-preferences-success')
 
 
 def test_logo_upload_with_valid_image_succeeds(journalist_app, test_admin):