Fixed the signature in the email sent when the review request is closed by admin

Review Request #12029 — Created Feb. 3, 2022 and updated

Information

Review Board
release-4.0.x

Reviewers

Currently, when users with admin rights close the review request,
the email template shows the wrong name in the signature at the
bottom of the e-mail content.

This change involves replacing the review_request.submitter
with user to display the name of the admin / user that
closed the review request instead of the owner of the
review request.

Added unit test to test_sending_email.py

I have also included the screenshots that show the changes:

  1. This screenshot shows the TXT e-mail that is created when
    I re-opened the review request and published it. My name is
    in the signature of the e-email.

  2. This screenshot shows the TXT e-mail that is created when
    a user with admin rights closed the review request (discarded).
    The name of the user with admin rights (superUser Admin) is
    in the signature of the e-mail.

Summary ID Author
Fixed the signature in the email sent when the review request is closed by admin
f9a5d2799004930b7c5220acd404165e69f34170 sng06
Changed the review_request.submitter variable to user
737990f499cd7d73fab539744ea94a8479dedce2 sng06
Reverted changes in html file and changed the signature variable to user
73d71b7666cebc7c00c42c4a69375b12ccad5457 sng06
Reverted changes in html template as we want to preserve the author in the By field
e7e5225b43aa7d152b71b585fc8dc934320ff620 sng06
Added unit test to test changes of close email after fixing the signature
515b361b5fe1ddbae29ce5a991e0a889d199707f sng06
Made changes to codes according to code review feedback received
9c3ba0baa111c96e7361337fdfee191a2145475f sng06

Description From Last Updated

I know some of the other things in here say "Tests", but all test docstrings should start with "Testing"

daviddavid

May be a minor thing, but you can shorten this, by including publish=True inside the self.create_review_request function.

gdehalgdehal

These can be self.assertIn('...', message.as_string()), which I think will give us better debug output if they fail.

daviddavid
sheenaNg
sheenaNg
sheenaNg
sheenaNg
sheenaNg
sheenaNg
gdehal
  1. 
      
  2. Show all issues

    May be a minor thing, but you can shorten this, by including publish=True inside the self.create_review_request function.

  3. 
      
david
  1. 
      
  2. Show all issues

    I know some of the other things in here say "Tests", but all test docstrings should start with "Testing"

  3. Show all issues

    These can be self.assertIn('...', message.as_string()), which I think will give us better debug output if they fail.

  4. 
      
sheenaNg
Review request changed
Change Summary:

Made changes to codes based on code review feedback

Commits:
Summary ID Author
Fixed the signature in the email sent when the review request is closed by admin
62e9427cc4bd71357e8aac03bad7aa1e4bd866c9 sng06
Changed the review_request.submitter variable to user
87cc93be33759e98125ddd9e17be290f9acf87f3 sng06
Reverted changes in html file and changed the signature variable to user
90c8a70195d1536172ff9c6cdd7b5cf34c1e97be sng06
Reverted changes in html template as we want to preserve the author in the By field
d14924e1acb54edafefcb5f579de1f9bb7bc6565 sng06
Added unit test to test changes of close email after fixing the signature
0263c2d9973b9306f31200a8c26ce41c865b17fd sng06
Fixed the signature in the email sent when the review request is closed by admin
f9a5d2799004930b7c5220acd404165e69f34170 sng06
Changed the review_request.submitter variable to user
737990f499cd7d73fab539744ea94a8479dedce2 sng06
Reverted changes in html file and changed the signature variable to user
73d71b7666cebc7c00c42c4a69375b12ccad5457 sng06
Reverted changes in html template as we want to preserve the author in the By field
e7e5225b43aa7d152b71b585fc8dc934320ff620 sng06
Added unit test to test changes of close email after fixing the signature
515b361b5fe1ddbae29ce5a991e0a889d199707f sng06
Made changes to codes according to code review feedback received
9c3ba0baa111c96e7361337fdfee191a2145475f sng06

Checks run (2 succeeded)

flake8 passed.
JSHint passed.