def test_mails_delete(self, mock_mail):
# Deleting a questionnaire sends an email to the compiler.
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {
'identifier': self.questionnaire_reviewed.code
}
detail_page.open(login=True, user=self.user_secretariat)
detail_page.delete_questionnaire()
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_compiler,
'mail': 'deleted'
},
{
'to': self.user_editor_assigned,
'mail': 'deleted'
},
{
'to': self.user_reviewer_assigned,
'mail': 'deleted'
},
{
'to': self.user_publisher_assigned,
'mail': 'deleted'
},
{
'to': self.user_wocat_mailbox,
'mail': 'deleted'
},
])
def test_mails_review_message(self, mock_mail):
# The message written when reviewing the questionnaire is in the mail.
review_message = 'Message for the publisher'
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {
'identifier': self.questionnaire_submitted.code
}
detail_page.open(login=True, user=self.user_reviewer_group)
detail_page.review_questionnaire(message=review_message)
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_compiler,
'mail': 'reviewed',
'message': review_message
},
{
'to': self.user_editor_assigned,
'mail': 'reviewed',
'message': review_message
},
{
'to': self.user_publisher_assigned,
'mail': 'reviewed',
'message': review_message
},
{
'to': self.user_wocat_mailbox,
'mail': 'reviewed',
'message': review_message
},
])
def test_mails_publish_message(self, mock_mail):
# Publishing a reviewed questionnaire adds the message to the email.
publish_message = 'Success message'
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {
'identifier': self.questionnaire_reviewed.code
}
detail_page.open(login=True, user=self.user_publisher_group)
detail_page.publish_questionnaire(message=publish_message)
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_compiler,
'mail': 'published',
'message': publish_message,
},
{
'to': self.user_editor_assigned,
'mail': 'published',
'message': publish_message,
},
{
'to': self.user_reviewer_assigned,
'mail': 'published',
'message': publish_message,
},
{
'to': self.user_wocat_mailbox,
'mail': 'published',
'message': publish_message,
},
])
def test_mails_compiler_added_keep_as_editor(
self, mock_user_information, mock_search_users, mock_mail):
# Changing the compiler sends a mail to the previous compiler and to the
# new one. If the previous compiler is now an editor, another mail is
# sent (also to the new compiler).
mock_search_users.side_effect = self.get_mock_remote_user_client_search
mock_user_information.side_effect = self.get_mock_remote_user_client_user_information
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': self.questionnaire_draft.code}
detail_page.open(login=True, user=self.user_secretariat)
detail_page.change_compiler(
self.user_bob.firstname, keep_as_editor=True)
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_compiler,
'mail': 'compiler_removed'
},
{
'to': self.user_bob,
'mail': 'compiler_added'
},
{
'to': self.user_compiler,
'mail': 'editor_added'
},
])
def test_mails_review(self, mock_mail):
# Reviewing a submitted questionnaire sends an email to all publishers,
# as well as to the compiler.
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {
'identifier': self.questionnaire_submitted.code
}
detail_page.open(login=True, user=self.user_reviewer_group)
detail_page.review_questionnaire()
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_compiler,
'mail': 'reviewed'
},
{
'to': self.user_editor_assigned,
'mail': 'reviewed'
},
{
'to': self.user_publisher_assigned,
'mail': 'reviewed',
},
{
'to': self.user_wocat_mailbox,
'mail': 'reviewed'
},
])
def test_delete_with_lock(self):
# The editor logs in and starts editing, this creates a lock.
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': self.questionnaire.code}
detail_page.open(login=True, user=self.robin)
detail_page.edit_questionnaire()
edit_page = SampleEditPage(self)
edit_page.click_edit_category('cat_1')
# The compiler logs in and wants to delete the questionnaire
detail_page.open(login=True, user=self.jay)
assert Questionnaire.objects.get(
code=self.questionnaire.code).is_deleted is False
assert detail_page.has_text(self.questionnaire.code)
detail_page.delete_questionnaire(check_success=False)
# He receives an error message, the questionnaire was not deleted.
assert detail_page.has_warning_message(
f'This questionnaire is locked for editing by '
f'{self.robin.get_display_name()}.')
assert detail_page.has_text(self.questionnaire.code)
assert Questionnaire.objects.get(
code=self.questionnaire.code).is_deleted is False
# After a while, the lock expires
Lock.objects.filter(questionnaire_code=self.questionnaire.code).update(
is_finished=True)
# Now the questionnaire can be deleted.
detail_page.delete_questionnaire(check_success=True)
assert Questionnaire.objects.get(
code=self.questionnaire.code).is_deleted is True
def test_mails_rejected_reviewed(self, mock_mail):
# Rejecting a reviewed questionnaire sends an email to the compiler.
reject_message = 'Rejected because it is incomplete.'
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {
'identifier': self.questionnaire_reviewed.code
}
detail_page.open(login=True, user=self.user_publisher_group)
detail_page.reject_questionnaire(reject_message)
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_compiler,
'mail': 'rejected_reviewed',
'message': reject_message,
},
{
'to': self.user_editor_assigned,
'mail': 'rejected_reviewed',
'message': reject_message,
},
{
'to': self.user_reviewer_assigned,
'mail': 'rejected_reviewed',
'message': reject_message,
},
{
'to': self.user_wocat_mailbox,
'mail': 'rejected_reviewed',
'message': reject_message,
},
])
def test_creation_date_does_not_change(self):
# Alice logs in
user = User.objects.get(pk=102)
# She goes to the details of an existing questionnaire and takes
# note of the creation and update dates
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': 'sample_3'}
detail_page.open(login=True, user=user)
creation_date = detail_page.get_el(detail_page.LOC_CREATION_DATE).text
update_date = detail_page.get_el(detail_page.LOC_UPDATE_DATE).text
# She creates a new version
detail_page.create_new_version()
# She notices that the creation date did not change while the
# update date changed.
creation_date_1 = detail_page.get_el(
detail_page.LOC_CREATION_DATE).text
update_date_1 = detail_page.get_el(detail_page.LOC_UPDATE_DATE).text
assert creation_date == creation_date_1
assert update_date != update_date_1
# Alice logs in as a different user
# She also opens a draft version of a questionnaire and takes
# note of the creation and update dates
user = User.objects.get(pk=101)
detail_page.route_kwargs = {'identifier': 'sample_1'}
detail_page.open(login=True, user=user)
creation_date = detail_page.get_el(detail_page.LOC_CREATION_DATE).text
update_date = detail_page.get_el(detail_page.LOC_UPDATE_DATE).text
# She makes an edit
detail_page.edit_questionnaire()
edit_page = SampleEditPage(self)
edit_page.click_edit_category('cat_1')
step_page = SampleStepPage(self)
step_page.enter_text(step_page.LOC_FORM_INPUT_KEY_1, ' (changed)')
# She submits the questionnaire
step_page.submit_step()
# She sees the changes were submitted
assert edit_page.has_text(' (changed)')
# She notices that the creation date did not change while the
# update date changed.
creation_date_1 = edit_page.get_el(edit_page.LOC_CREATION_DATE).text
update_date_1 = edit_page.get_el(edit_page.LOC_UPDATE_DATE).text
assert creation_date == creation_date_1
assert update_date != update_date_1
def test_do_not_show_deleted_links_in_form(self):
user = User.objects.get(pk=101)
samplemulti_link = 'This is key 1a'
sample_link = 'This is the first key.'
# User goes to the SAMPLE questionnaire and sees the link
detail_page_sample = SampleDetailPage(self)
detail_page_sample.route_kwargs = {'identifier': 'sample_1'}
detail_page_sample.open(login=True, user=user)
assert detail_page_sample.has_text(samplemulti_link)
# User starts editing the questionnaire
detail_page_sample.create_new_version()
edit_page = SampleEditPage(self)
assert edit_page.has_text(samplemulti_link)
# User opens the step with the link and sees the link is there
edit_page.click_edit_category('cat_5')
step_page = QuestionnaireStepPage(self)
assert step_page.check_links([samplemulti_link])
# User opens the details page of the SAMPLEMULTI questionnaire
detail_page_multi = SampleMultiDetailPage(self)
detail_page_multi.route_kwargs = {'identifier': 'samplemulti_1'}
detail_page_multi.open()
assert detail_page_multi.has_text(sample_link)
# User deletes the questionnaire
detail_page_multi.delete_questionnaire()
# User opens the detail page of the SAMPLE questionnaire again. The link
# is not there anymore.
detail_page_sample.open()
assert not detail_page_sample.has_text(samplemulti_link)
# The link is not on the edit page either
detail_page_sample.edit_questionnaire()
assert not detail_page_sample.has_text(samplemulti_link)
# Also on the step edit page, no link
edit_page.click_edit_category('cat_5')
assert step_page.check_links([])
# The step can be submitted without an error
step_page.submit_step()
def test_delete_with_lock_by_own_user(self):
# The compiler (!) logs in and starts editing, this creates a lock.
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': self.questionnaire.code}
detail_page.open(login=True, user=self.jay)
detail_page.edit_questionnaire()
edit_page = SampleEditPage(self)
edit_page.click_edit_category('cat_1')
# The compiler opens the detail page (= back without saving) and wants
# to delete the questionnaire while his own lock is still active. This
# works because his own lock is released when deleting the
# questionnaire.
detail_page.open()
detail_page.delete_questionnaire(check_success=True)
assert Questionnaire.objects.get(
code=self.questionnaire.code).is_deleted is True
def test_mails_editor_added(
self, mock_user_information, mock_search_users, mock_mail):
# Inviting an editor sends a mail to this editor.
mock_search_users.side_effect = self.get_mock_remote_user_client_search
mock_user_information.side_effect = self.get_mock_remote_user_client_user_information
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': self.questionnaire_draft.code}
detail_page.open(login=True, user=self.user_compiler)
detail_page.assign_user(self.user_bob.firstname)
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_bob,
'mail': 'editor_added',
}
])
def test_mails_edit(self, mock_mail):
# Notifying about having finished editing a draft questionnaire sends an
# email to the compiler.
self.questionnaire_draft.add_user(self.user_alice, 'editor')
# Reviewer should not receive an email
self.questionnaire_draft.add_user(self.user_bob, 'reviewer')
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': self.questionnaire_draft.code}
detail_page.open(login=True, user=self.user_alice)
detail_page.finish_editing()
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_compiler,
'mail': 'edited'
}
])
def test_mails_submit(self, mock_mail):
# Submitting a draft questionnaire sends an email to all reviewers.
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': self.questionnaire_draft.code}
detail_page.open(login=True, user=self.user_compiler)
detail_page.submit_questionnaire()
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_reviewer_assigned,
'mail': 'submitted'
},
{
'to': self.user_wocat_mailbox,
'mail': 'submitted'
},
])
# In order to always access the same mail, do some ordering first
mock_mail_call_args = [call[1] for call in mock_mail.call_args_list]
mock_alt_mail_call_args = [
call[1] for call
in mock_mail.return_value.attach_alternative.call_args_list]
merged_calls = zip(mock_mail_call_args, mock_alt_mail_call_args)
sorted_calls = sorted(
merged_calls, key=lambda c: (c[0]['to'], c[0]['subject']))
sorted_mock_mail_calls, sorted_mock_alt_mail_calls = zip(
*sorted_calls)
mail_body_plain = sorted_mock_mail_calls[1]['body']
mail_body_html = sorted_mock_alt_mail_calls[1]['content']
for mail_body in [mail_body_plain, mail_body_html]:
assert self.questionnaire_draft.get_absolute_url() in mail_body
assert self.user_wocat_mailbox.get_display_name() in mail_body
assert self.user_compiler.get_display_name() in mail_body
assert str(settings.BASE_URL) in mail_body
assert str(self.user_wocat_mailbox.mailpreferences.get_signed_url()) in \
mail_body
def test_mails_publisher_added(
self, mock_user_information, mock_search_users, mock_mail):
# Inviting a publisher sends a mail to this publisher and to the
# compiler.
mock_search_users.side_effect = self.get_mock_remote_user_client_search
mock_user_information.side_effect = self.get_mock_remote_user_client_user_information
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {
'identifier': self.questionnaire_reviewed.code
}
detail_page.open(login=True, user=self.user_secretariat)
detail_page.assign_user(self.user_bob.firstname)
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_bob,
'mail': 'publisher_added'
},
])
def test_mails_submit_message(self, mock_mail):
# Submitting a draft questionnaire sends an email to all reviewers which
# includes the message entered upon submission
submit_message = 'Message for the reviewer'
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': self.questionnaire_draft.code}
detail_page.open(login=True, user=self.user_compiler)
detail_page.submit_questionnaire(message=submit_message)
call_command('send_notification_mails')
self.check_mails(mock_mail, [
{
'to': self.user_wocat_mailbox,
'mail': 'submitted',
'message': submit_message
},
{
'to': self.user_reviewer_assigned,
'mail': 'submitted',
'message': submit_message
}
])
def test_edit_public(self):
code = 'sample_3'
user = User.objects.get(pk=101)
old_text = 'Faz 3'
new_text = 'asdf'
# User logs in and goes to the detail page of a "public" Questionnaire
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': code}
detail_page.open(login=True, user=user)
assert code in self.browser.current_url
assert detail_page.has_text(old_text)
assert not detail_page.has_text(new_text)
# There is only one version of this questionnaire in the db
assert Questionnaire.objects.filter(code=code).count() == 1
# User uses the direct link to go to the edit page of the questionnaire
# and sees no new version of the questionnaire is created in the DB.
# This prevents the issue when new versions were created upon GET of the
# edit page, which should be fixed now.
edit_page = SampleEditPage(self)
edit_page.route_kwargs = {'identifier': code}
edit_page.open()
assert Questionnaire.objects.filter(code=code).count() == 1
# User edits the Questionnaire (creates a new version) and sees that
# the URL contains the code of the Questionnaire
detail_page.open()
detail_page.create_new_version()
assert code in self.browser.current_url
# User edits a category and sees that the URL still contains the
# code of the Questionnaire
edit_page.click_edit_category('cat_2')
assert code in self.browser.current_url
# User makes some changes and submits the category
step_page = SampleStepPage(self)
step_page.enter_text(step_page.LOC_FORM_INPUT_KEY_5,
new_text,
clear=True)
step_page.submit_step()
# User is back on the overview page and sees that the URL still
# contains the code of the Questionnaire
assert code in self.browser.current_url
assert edit_page.has_text(code)
# She sees that the value of Key 1 was updated
assert not edit_page.has_text(old_text)
assert edit_page.has_text(new_text)
# Also there was an additional version created in the database
assert Questionnaire.objects.count() == 11
# The newly created version has the same code
assert Questionnaire.objects.filter(code=code).count() == 2
# She goes to see her own questionnaire and sees sample_3 appears only
# once
my_page = MyDataPage(self)
my_page.open()
my_page.wait_for_lists()
expected_list = [
{
'description': new_text,
},
{
# Just to check that description is there ...
'description': 'Faz 1'
},
# ... the rest does not really matter
]
assert my_page.count_list_results() == 6
my_page.check_list_results(expected_list, count=False)
# She clicks the first entry and sees that she is taken to the
# details page of the latest (pending) version.
my_page.click_list_entry(index=0)
assert detail_page.has_text(new_text)
def test_show_only_one_linked_version(self):
sample_title = 'This is the first key.'
samplemulti_title = 'This is key 1a'
samplemulti_changed_text = ' (changed)'
samplemulti_title_changed = samplemulti_title + samplemulti_changed_text
# Alice logs in
# She goes to the SAMPLE questionnaire and sees the link
user_1 = User.objects.get(pk=101)
sample_detail_page = SampleDetailPage(self)
sample_detail_page.route_kwargs = {'identifier': 'sample_1'}
sample_detail_page.open(login=True, user=user_1)
sample_detail_page.expand_details()
expected_samplemulti_links = [{
'title': samplemulti_title,
'configuration': 'samplemulti',
}]
sample_detail_page.check_linked_questionnaires(
expected=expected_samplemulti_links)
# She goes to the MULTISAMPLE questionnaire and sees the link
sample_detail_page.click_linked_questionnaire(index=0)
samplemulti_detail_page = SampleMultiDetailPage(self)
samplemulti_detail_page.expand_details()
expected_sample_links = [{
'title': sample_title,
'configuration': 'sample',
}]
samplemulti_detail_page.check_linked_questionnaires(
expected=expected_sample_links)
# She edits the MULTISAMPLE questionnaire and sees only one
# version is linked (still the same)
samplemulti_detail_page.create_new_version()
samplemulti_edit_page = SampleMultiEditPage(self)
samplemulti_edit_page.click_edit_category('mcat_1')
samplemulti_step_page = SampleMultiStepPage(self)
samplemulti_step_page.enter_text(
samplemulti_step_page.LOC_QUESTION_MQG01_MKEY01,
samplemulti_changed_text)
# She submits the step
samplemulti_step_page.submit_step()
# She sees that only one questionnaire is linked
samplemulti_edit_page.expand_details()
samplemulti_edit_page.check_linked_questionnaires(
expected=expected_sample_links)
# She goes to the SAMPLE questionnaire and sees only one version
# is linked (the pending one)
samplemulti_edit_page.click_linked_questionnaire(index=0)
expected_samplemulti_links_changed = [{
'title': samplemulti_title_changed,
'configuration': 'samplemulti',
}]
sample_detail_page.check_linked_questionnaires(
expected=expected_samplemulti_links_changed)
# She even creates a new version and opens the form and sees there is
# only one version
sample_detail_page.create_new_version()
sample_edit_page = SampleEditPage(self)
sample_edit_page.click_edit_category('cat_5')
sample_step_page = SampleStepPage(self)
sample_step_page.check_links([samplemulti_title_changed])
sample_step_page.back_without_saving()
# She logs out and sees only one questionnaire is linked (the
# active one)
sample_detail_page.logout()
sample_detail_page.open()
sample_detail_page.expand_details()
sample_detail_page.check_linked_questionnaires(
expected=expected_samplemulti_links)
# She logs in as a different user and sees only one version is
# linked (the active one)
user_2 = User.objects.get(pk=102)
sample_detail_page.open(login=True, user=user_2)
sample_detail_page.expand_details()
sample_detail_page.check_linked_questionnaires(
expected=expected_samplemulti_links)
def test_edit_public_new_config_edition(self, mock_choices):
mock_choices.return_value = CODE_CHOICES + [
('sample', 'sample'),
]
code = 'sample_3'
old_version = Questionnaire.objects.get(code=code)
# A user logs in and goes to the detail page of a public questionnaire
# where he is the compiler
detail_page = SampleDetailPage(self)
detail_page.route_kwargs = {'identifier': code}
detail_page.open(login=True, user=self.user)
# The user sees a hint about a new edition on the detail page
detail_page.close_edition_modal()
assert detail_page.has_new_edition()
# The user creates a new version
detail_page.create_new_version()
# The new version is in the new edition
new_version = Questionnaire.objects.latest('updated')
assert new_version.configuration.edition == '2018'
# The data of the old version was cleaned up
assert old_version.data['qg_2'][0]['key_2'] is not None
assert new_version.data['qg_2'][0]['key_2'] is None
assert old_version.data['qg_2'][0]['key_3'] \
== new_version.data['qg_2'][0]['key_3']
assert 'qg_5' in old_version.data
assert 'qg_5' not in new_version.data
# The old values are still there
edit_page = SampleEditPage(self)
assert edit_page.has_text('Foo 3')
# New questions are available and can be entered
edit_page.click_edit_category('cat_4')
step_page = SampleStepPage(self)
step_page.enter_text(step_page.LOC_FORM_INPUT_KEY_68,
'New key for edition 2018')
step_page.submit_step()
assert edit_page.has_text('New key for edition 2018')
# The old values are still there
assert edit_page.has_text('Foo 3')
# Questions also have updated labels
edit_page.click_edit_category('cat_1')
assert step_page.has_text('Key 1 (edition 2018):')
step_page.submit_step()
# The old values are still there
assert edit_page.has_text('Foo 3')
# The user submits the version
edit_page.submit_questionnaire()
# The version is reviewed (in DB)
new_version.status = settings.QUESTIONNAIRE_PUBLIC
new_version.save()
# The new public version does not have a hint about new editions
detail_page.open()
assert not detail_page.has_new_edition()
def test_edit_questionnaire(self):
user = self.create_new_user(email='*****@*****.**',
groups=['Reviewers', 'Publishers'])
# Alice logs in
# She enters a Questionnaire
new_page = SampleNewPage(self)
new_page.open(login=True, user=user)
new_page.click_edit_category('cat_1')
step_page = SampleStepPage(self)
step_page.enter_text(step_page.LOC_FORM_INPUT_KEY_1, 'Foo')
step_page.enter_text(step_page.LOC_FORM_INPUT_KEY_3, 'Bar')
step_page.submit_step()
# The questionnaire is already saved as draft
# She submits it for review
edit_page = SampleEditPage(self)
edit_page.submit_questionnaire()
# She reviews it
detail_page = SampleDetailPage(self)
detail_page.review_questionnaire()
# She publishes it
detail_page.publish_questionnaire()
# She sees it is public and visible
assert detail_page.has_text('Foo')
assert detail_page.has_text('Bar')
url = self.browser.current_url
# She creates a new version
detail_page.create_new_version()
# She edits it
edit_page.click_edit_category('cat_1')
# She changes some values
step_page.enter_text(step_page.LOC_FORM_INPUT_KEY_1,
'asdf',
clear=True)
step_page.submit_step()
# The questionnaire is already saved as draft
# She is taken to the overview page where she sees the latest
# (pending) changes of the draft
edit_page.check_status('draft')
assert not edit_page.has_text('Foo')
assert edit_page.has_text('asdf')
assert edit_page.has_text('Bar')
# She sees the edit buttons
assert edit_page.exists_el(
edit_page.format_locator(edit_page.LOC_BUTTON_EDIT_CATEGORY,
keyword='cat_1'))
# She sees the possibility to view the questionnaire
edit_page.view_questionnaire()
self.assertIn(url, self.browser.current_url + '#top')
# All the changes are there
assert not detail_page.has_text('Foo')
assert detail_page.has_text('asdf')
assert detail_page.has_text('Bar')
# There are no buttons to edit the sections anymore
assert not detail_page.exists_el(
detail_page.format_locator(edit_page.LOC_BUTTON_EDIT_CATEGORY,
keyword='cat_1'))
