Skip to content

Email notification when user's role is changed/removed. #3306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
330 changes: 318 additions & 12 deletions tests/unit/manage/test_views.py

Large diffs are not rendered by default.

268 changes: 268 additions & 0 deletions tests/unit/test_email.py
Original file line number Diff line number Diff line change
Expand Up @@ -507,3 +507,271 @@ def test_added_as_collaborator_email(
recipients=[stub_user.email],
),
]


class TestRemovedAsCollaboratorEmail:

def test_removed_as_collaborator_email(
self, pyramid_request, pyramid_config, monkeypatch):

stub_user = pretend.stub(
email='email',
username='username',
)
stub_submitter_user = pretend.stub(
email='submiteremail',
username='submitterusername'
)
stub_role = pretend.stub(
role_name="Owner",
user=stub_user,
project=pretend.stub(
name="test_project"
),
)
pyramid_request.user = stub_submitter_user

subject_renderer = pyramid_config.testing_add_renderer(
'email/removed-as-collaborator.subject.txt'
)
subject_renderer.string_response = 'Email Subject'
body_renderer = pyramid_config.testing_add_renderer(
'email/removed-as-collaborator.body.txt'
)
body_renderer.string_response = 'Email Body'

send_email = pretend.stub(
delay=pretend.call_recorder(lambda *args, **kwargs: None)
)
pyramid_request.task = pretend.call_recorder(
lambda *args, **kwargs: send_email
)
monkeypatch.setattr(email, 'send_email', send_email)

result = email.send_removed_from_role_email(
pyramid_request,
role=stub_role,
)

assert result == {
'project': 'test_project',
'role': 'Owner',
'submitter': stub_submitter_user.username
}
subject_renderer.assert_()
body_renderer.assert_(submitter=stub_submitter_user.username)
body_renderer.assert_(project='test_project')
body_renderer.assert_(role='Owner')

assert pyramid_request.task.calls == [
pretend.call(send_email),
]
assert send_email.delay.calls == [
pretend.call(
'Email Body',
'Email Subject',
recipients=[stub_user.email],
),
]


class TestUserRoleChangedEmail:

def test_user_role_changed_email(
self, pyramid_request, pyramid_config, monkeypatch):

stub_user = pretend.stub(
email='email',
username='username',
)
stub_submitter_user = pretend.stub(
email='submiteremail',
username='submitterusername'
)
stub_role = pretend.stub(
role_name="Owner",
user=stub_user,
project=pretend.stub(
name="test_project"
),
)
pyramid_request.user = stub_submitter_user

subject_renderer = pyramid_config.testing_add_renderer(
'email/role-removed-from-user.subject.txt'
)
subject_renderer.string_response = 'Email Subject'
body_renderer = pyramid_config.testing_add_renderer(
'email/role-removed-from-user.body.txt'
)
body_renderer.string_response = 'Email Body'

send_email = pretend.stub(
delay=pretend.call_recorder(lambda *args, **kwargs: None)
)
pyramid_request.task = pretend.call_recorder(
lambda *args, **kwargs: send_email
)
monkeypatch.setattr(email, 'send_email', send_email)

result = email.send_role_removed_from_user_email(
pyramid_request,
role=stub_role,
email_recipients=[stub_user.email, stub_submitter_user.email]
)

assert result == {
'project': 'test_project',
'role': 'Owner',
'submitter': stub_submitter_user.username,
'username': stub_user.username,
}
subject_renderer.assert_()
body_renderer.assert_(submitter=stub_submitter_user.username)
body_renderer.assert_(project='test_project')
body_renderer.assert_(role='Owner')

assert pyramid_request.task.calls == [
pretend.call(send_email),
]
assert send_email.delay.calls == [
pretend.call(
'Email Body',
'Email Subject',
bcc=[stub_user.email, stub_submitter_user.email],
),
]


class TestUserRoleChangedEmailEmail:

def test_user_role_changed_email(
self, pyramid_request, pyramid_config, monkeypatch):

stub_user = pretend.stub(
email='email',
username='username',
)
stub_submitter_user = pretend.stub(
email='submiteremail',
username='submitterusername'
)
stub_role = pretend.stub(
role_name="Owner",
user=stub_user,
project=pretend.stub(
name="test_project"
),
)
pyramid_request.user = stub_submitter_user

subject_renderer = pyramid_config.testing_add_renderer(
'email/user-role-changed.subject.txt'
)
subject_renderer.string_response = 'Email Subject'
body_renderer = pyramid_config.testing_add_renderer(
'email/user-role-changed.body.txt'
)
body_renderer.string_response = 'Email Body'

send_email = pretend.stub(
delay=pretend.call_recorder(lambda *args, **kwargs: None)
)
pyramid_request.task = pretend.call_recorder(
lambda *args, **kwargs: send_email
)
monkeypatch.setattr(email, 'send_email', send_email)

result = email.send_user_role_changed_email(
pyramid_request,
role=stub_role,
)

assert result == {
'project': 'test_project',
'role': 'Owner',
'submitter': stub_submitter_user.username
}
subject_renderer.assert_()
body_renderer.assert_(submitter=stub_submitter_user.username)
body_renderer.assert_(project='test_project')
body_renderer.assert_(role='Owner')

assert pyramid_request.task.calls == [
pretend.call(send_email),
]
assert send_email.delay.calls == [
pretend.call(
'Email Body',
'Email Subject',
recipients=[stub_user.email],
),
]


class TestRoleChangedForUserEmail:

def test_role_changed_for_user_email(
self, pyramid_request, pyramid_config, monkeypatch):

stub_user = pretend.stub(
email='email',
username='username',
)
stub_submitter_user = pretend.stub(
email='submiteremail',
username='submitterusername'
)
stub_role = pretend.stub(
role_name="Owner",
user=stub_user,
project=pretend.stub(
name="test_project"
),
)
pyramid_request.user = stub_submitter_user

subject_renderer = pyramid_config.testing_add_renderer(
'email/role-changed-for-user.subject.txt'
)
subject_renderer.string_response = 'Email Subject'
body_renderer = pyramid_config.testing_add_renderer(
'email/role-changed-for-user.body.txt'
)
body_renderer.string_response = 'Email Body'

send_email = pretend.stub(
delay=pretend.call_recorder(lambda *args, **kwargs: None)
)
pyramid_request.task = pretend.call_recorder(
lambda *args, **kwargs: send_email
)
monkeypatch.setattr(email, 'send_email', send_email)

result = email.send_role_changed_for_user_email(
pyramid_request,
role=stub_role,
email_recipients=[stub_user.email, stub_submitter_user.email]
)

assert result == {
'project': 'test_project',
'role': 'Owner',
'submitter': stub_submitter_user.username,
'username': stub_user.username,
}
subject_renderer.assert_()
body_renderer.assert_(submitter=stub_submitter_user.username)
body_renderer.assert_(project='test_project')
body_renderer.assert_(role='Owner')

assert pyramid_request.task.calls == [
pretend.call(send_email),
]
assert send_email.delay.calls == [
pretend.call(
'Email Body',
'Email Subject',
bcc=[stub_user.email, stub_submitter_user.email],
),
]
81 changes: 81 additions & 0 deletions warehouse/email.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,3 +189,84 @@ def send_added_as_collaborator_email(request, submitter, project_name, role,
request.task(send_email).delay(body, subject, recipients=[user_email])

return fields


def send_removed_from_role_email(request, role):
fields = {
'project': role.project.name,
'submitter': request.user.username,
'role': role.role_name
}

subject = render(
'email/removed-as-collaborator.subject.txt', fields, request=request
)

body = render(
'email/removed-as-collaborator.body.txt', fields, request=request
)

request.task(send_email).delay(body, subject, recipients=[role.user.email])

return fields


def send_role_removed_from_user_email(request, role, email_recipients):
fields = {
'project': role.project.name,
'submitter': request.user.username,
'role': role.role_name,
'username': role.user.username,
}

subject = render(
'email/role-removed-from-user.subject.txt', fields, request=request
)

body = render(
'email/role-removed-from-user.body.txt', fields, request=request
)

request.task(send_email).delay(body, subject, bcc=email_recipients)
return fields


def send_user_role_changed_email(request, role):
fields = {
'project': role.project.name,
'submitter': request.user.username,
'role': role.role_name
}

subject = render(
'email/user-role-changed.subject.txt', fields, request=request
)

body = render(
'email/user-role-changed.body.txt', fields, request=request
)

request.task(send_email).delay(body, subject, recipients=[role.user.email])

return fields


def send_role_changed_for_user_email(request, role, email_recipients):
fields = {
'project': role.project.name,
'submitter': request.user.username,
'role': role.role_name,
'username': role.user.username,
}

subject = render(
'email/role-changed-for-user.subject.txt', fields, request=request
)

body = render(
'email/role-changed-for-user.body.txt', fields, request=request
)

request.task(send_email).delay(body, subject, bcc=email_recipients)

return fields
Loading