pagure/tests/test_pagure_lib_notify.py

# -*- coding: utf-8 -*-

"""
 (c) 2016 - Copyright Red Hat Inc

 Authors:
   Pierre-Yves Chibon <pingou@pingoured.fr>

"""

from __future__ import unicode_literals, absolute_import

import unittest
import shutil
import sys
import os

from mock import patch, MagicMock

sys.path.insert(
    0, os.path.join(os.path.dirname(os.path.abspath(__file__)), "..")
)

import pagure.lib.model
import pagure.lib.notify
import pagure.lib.query
import tests
import munch


class PagureLibNotifytests(tests.Modeltests):
    """ Tests for pagure.lib.notify """

    maxDiff = None

    def test_get_emails_for_obj_issue(self):
        """ Test the _get_emails_for_obj method from pagure.lib.notify. """

        # Create the project ns/test
        item = pagure.lib.model.Project(
            user_id=1,  # pingou
            name="test3",
            namespace="ns",
            description="test project #1",
            hook_token="aaabbbcccdd",
        )
        item.close_status = ["Invalid", "Insufficient data", "Fixed"]
        self.session.add(item)
        self.session.commit()

        # Create the ticket
        iss = pagure.lib.query.new_issue(
            issue_id=4,
            session=self.session,
            repo=item,
            title="test issue",
            content="content test issue",
            user="pingou",
        )
        self.session.commit()
        self.assertEqual(iss.id, 4)
        self.assertEqual(iss.title, "test issue")

        exp = set(["bar@pingou.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

        # Comment on the ticket
        out = pagure.lib.query.add_issue_comment(
            self.session,
            issue=iss,
            comment="This is a comment",
            user="foo",
            notify=False,
        )
        self.assertEqual(out, "Comment added")

        exp = set(["bar@pingou.com", "foo@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

        # Create user `bar`
        item = pagure.lib.model.User(
            user="bar",
            fullname="bar name",
            password="bar",
            default_email="bar@bar.com",
        )
        self.session.add(item)
        item = pagure.lib.model.UserEmail(user_id=3, email="bar@bar.com")
        self.session.add(item)
        self.session.commit()

        # Watch the ticket
        out = pagure.lib.query.set_watch_obj(self.session, "bar", iss, True)
        self.assertEqual(out, "You are now watching this issue")

        exp = set(["bar@pingou.com", "foo@bar.com", "bar@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

    def test_get_emails_for_obj_issue_watching_project(self):
        """ Test the _get_emails_for_obj method from pagure.lib.notify. """

        # Create the project ns/test
        item = pagure.lib.model.Project(
            user_id=1,  # pingou
            name="test3",
            namespace="ns",
            description="test project #1",
            hook_token="aaabbbcccdd",
        )
        item.close_status = ["Invalid", "Insufficient data", "Fixed"]
        self.session.add(item)
        self.session.commit()

        # Create the ticket
        iss = pagure.lib.query.new_issue(
            issue_id=4,
            session=self.session,
            repo=item,
            title="test issue",
            content="content test issue",
            user="pingou",
        )
        self.session.commit()
        self.assertEqual(iss.id, 4)
        self.assertEqual(iss.title, "test issue")

        exp = set(["bar@pingou.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

        # Comment on the ticket
        out = pagure.lib.query.add_issue_comment(
            self.session,
            issue=iss,
            comment="This is a comment",
            user="foo",
            notify=False,
        )
        self.assertEqual(out, "Comment added")

        exp = set(["bar@pingou.com", "foo@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

        # Create user `bar`
        item = pagure.lib.model.User(
            user="bar",
            fullname="bar name",
            password="bar",
            default_email="bar@bar.com",
        )
        self.session.add(item)
        item = pagure.lib.model.UserEmail(user_id=3, email="bar@bar.com")
        self.session.add(item)
        self.session.commit()

        # Watch the project
        repo = pagure.lib.query.get_authorized_project(
            self.session, "test3", namespace="ns"
        )
        out = pagure.lib.query.update_watch_status(
            self.session, repo, "bar", "1"
        )
        self.assertEqual(
            out, "You are now watching issues and PRs on this project"
        )

        exp = set(["bar@pingou.com", "foo@bar.com", "bar@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

    @patch("pagure.lib.notify.smtplib.SMTP")
    def test_get_emails_for_obj_pr(self, mock_smtp):
        """ Test the _get_emails_for_obj method from pagure.lib.notify. """
        mock_smtp.return_value = MagicMock()

        tests.create_projects(self.session)

        # Create the project ns/test
        item = pagure.lib.model.Project(
            user_id=1,  # pingou
            name="test3",
            namespace="ns",
            description="test project #1",
            hook_token="aaabbbcccdd",
        )
        item.close_status = ["Invalid", "Insufficient data", "Fixed"]
        self.session.add(item)
        self.session.commit()

        # Create the PR
        repo = pagure.lib.query._get_project(self.session, "test")
        req = pagure.lib.query.new_pull_request(
            session=self.session,
            repo_from=repo,
            branch_from="master",
            repo_to=repo,
            branch_to="master",
            title="test pull-request",
            user="pingou",
        )
        self.session.commit()
        self.assertEqual(req.id, 1)
        self.assertEqual(req.title, "test pull-request")
        self.assertEqual(repo.open_requests, 1)

        exp = set(["bar@pingou.com"])
        out = pagure.lib.notify._get_emails_for_obj(req)
        self.assertEqual(out, exp)

        # Comment on the ticket
        out = pagure.lib.query.add_pull_request_comment(
            self.session,
            request=req,
            commit=None,
            tree_id=None,
            filename=None,
            row=None,
            comment="This is a comment",
            user="foo",
            notify=False,
        )
        self.assertEqual(out, "Comment added")

        exp = set(["bar@pingou.com", "foo@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(req)
        self.assertEqual(out, exp)

        # Create user `bar`
        item = pagure.lib.model.User(
            user="bar",
            fullname="bar name",
            password="bar",
            default_email="bar@bar.com",
        )
        self.session.add(item)
        item = pagure.lib.model.UserEmail(user_id=3, email="bar@bar.com")
        self.session.add(item)
        self.session.commit()

        # Watch the pull-request
        out = pagure.lib.query.set_watch_obj(self.session, "bar", req, True)
        self.assertEqual(out, "You are now watching this pull-request")

        exp = set(["bar@pingou.com", "foo@bar.com", "bar@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(req)
        self.assertEqual(out, exp)

    @patch("pagure.lib.notify.smtplib.SMTP")
    def test_get_emails_for_obj_pr_watching_project(self, mock_smtp):
        """ Test the _get_emails_for_obj method from pagure.lib.notify. """
        mock_smtp.return_value = MagicMock()

        tests.create_projects(self.session)

        # Create the project ns/test
        item = pagure.lib.model.Project(
            user_id=1,  # pingou
            name="test3",
            namespace="ns",
            description="test project #1",
            hook_token="aaabbbcccdd",
        )
        item.close_status = ["Invalid", "Insufficient data", "Fixed"]
        self.session.add(item)
        self.session.commit()

        # Create the PR
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        req = pagure.lib.query.new_pull_request(
            session=self.session,
            repo_from=repo,
            branch_from="master",
            repo_to=repo,
            branch_to="master",
            title="test pull-request",
            user="pingou",
        )
        self.session.commit()
        self.assertEqual(req.id, 1)
        self.assertEqual(req.title, "test pull-request")
        self.assertEqual(repo.open_requests, 1)

        exp = set(["bar@pingou.com"])
        out = pagure.lib.notify._get_emails_for_obj(req)
        self.assertEqual(out, exp)

        # Comment on the ticket
        out = pagure.lib.query.add_pull_request_comment(
            self.session,
            request=req,
            commit=None,
            tree_id=None,
            filename=None,
            row=None,
            comment="This is a comment",
            user="foo",
            notify=False,
        )
        self.assertEqual(out, "Comment added")

        exp = set(["bar@pingou.com", "foo@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(req)
        self.assertEqual(out, exp)

        # Create user `bar`
        item = pagure.lib.model.User(
            user="bar",
            fullname="bar name",
            password="bar",
            default_email="bar@bar.com",
        )
        self.session.add(item)
        item = pagure.lib.model.UserEmail(user_id=3, email="bar@bar.com")
        self.session.add(item)
        self.session.commit()

        # Watch the project
        repo = pagure.lib.query.get_authorized_project(self.session, "test")
        out = pagure.lib.query.update_watch_status(
            self.session, repo, "bar", "1"
        )
        self.assertEqual(
            out, "You are now watching issues and PRs on this project"
        )

        exp = set(["bar@pingou.com", "foo@bar.com", "bar@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(req)
        self.assertEqual(out, exp)

    def test_get_emails_for_obj_private_issue(self):
        """ Test the _get_emails_for_obj method from pagure.lib.notify. """

        # Create the project ns/test
        item = pagure.lib.model.Project(
            user_id=1,  # pingou
            name="test3",
            namespace="ns",
            description="test project #1",
            hook_token="aaabbbcccdd",
        )
        item.close_status = ["Invalid", "Insufficient data", "Fixed"]
        self.session.add(item)
        self.session.commit()

        # Create the private ticket
        iss = pagure.lib.query.new_issue(
            issue_id=4,
            session=self.session,
            repo=item,
            title="test issue",
            content="content test issue",
            user="pingou",
            private=True,
        )
        self.session.commit()
        self.assertEqual(iss.id, 4)
        self.assertEqual(iss.title, "test issue")

        exp = set(["bar@pingou.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

        # Comment on the ticket
        out = pagure.lib.query.add_issue_comment(
            self.session,
            issue=iss,
            comment="This is a comment",
            user="foo",
            notify=False,
        )
        self.assertEqual(out, "Comment added")

        exp = set(["bar@pingou.com", "foo@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

        # Create user `bar`
        item = pagure.lib.model.User(
            user="bar",
            fullname="bar name",
            password="bar",
            default_email="bar@bar.com",
        )
        self.session.add(item)
        item = pagure.lib.model.UserEmail(user_id=3, email="bar@bar.com")
        self.session.add(item)
        self.session.commit()

        # Add bar on the project with ticket acl
        project = pagure.lib.query._get_project(
            self.session, "test3", namespace="ns"
        )
        msg = pagure.lib.query.add_user_to_project(
            session=self.session,
            project=project,
            new_user="bar",
            user="pingou",
            access="ticket",
        )
        self.session.commit()
        self.assertEqual(msg, "User added")

        exp = set(["bar@pingou.com", "foo@bar.com"])
        out = pagure.lib.notify._get_emails_for_obj(iss)
        self.assertEqual(out, exp)

    @patch.dict(
        "pagure.config.config", {"EVENTSOURCE_SOURCE": "localhost.localdomain"}
    )
    @patch("pagure.lib.notify.smtplib.SMTP")
    def test_send_email(self, mock_smtp):
        """ Test the send_email method from pagure.lib.notify. """
        mock_smtp.return_value = MagicMock()

        email = pagure.lib.notify.send_email(
            "Email content",
            "Email “Subject“",
            "foo@bar.com,zöé@foo.net",
            mail_id="test-pull-request-2edbf96ebe644f4bb31b94605e-1",
            in_reply_to="test-pull-request-2edbf96ebe644f4bb31b94605e",
            project_name="namespace/project",
            user_from="Zöé",
        )
        # Due to differences in the way Python2 and Python3 encode non-ascii
        # email headers, we compare the From and To headers separately from the
        # rest of the message.
        self.assertEqual(
            email["From"],
            "=?utf-8?b?WsO2w6k=?= <pagure@localhost.localdomain>",
        )
        self.assertEqual(email["To"], "zöé@foo.net")
        del email["From"]
        del email["To"]
        exp = """Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: base64
Subject: =?utf-8?b?W25hbWVzcGFjZS9wcm9qZWN0XSBFbWFpbCDigJxTdWJqZWN04oCc?=
mail-id: test-pull-request-2edbf96ebe644f4bb31b94605e-1@localhost.localdomain
Message-Id: <test-pull-request-2edbf96ebe644f4bb31b94605e-1@localhost.localdomain>
In-Reply-To: <test-pull-request-2edbf96ebe644f4bb31b94605e@localhost.localdomain>
X-Auto-Response-Suppress: All
X-pagure: http://localhost.localdomain/
X-pagure-project: namespace/project
List-ID: namespace/project
List-Archive: http://localhost.localdomain/namespace/project
Reply-To: reply+ddd73d6bcace71598118ece5808b9c1b8e68c73e1acc4302538257a0951bb920ea0765d3f262ddb3725e9369519b086a7873cb65fbfceb1a2a25897f8e2a54fa@localhost.localdomain
Mail-Followup-To: reply+ddd73d6bcace71598118ece5808b9c1b8e68c73e1acc4302538257a0951bb920ea0765d3f262ddb3725e9369519b086a7873cb65fbfceb1a2a25897f8e2a54fa@localhost.localdomain

RW1haWwgY29udGVudA==
"""
        self.assertEqual(email.as_string(), exp)

        email = pagure.lib.notify.send_email(
            "Email content",
            "Email “Subject“",
            "foo@bar.com,zöé@foo.net",
            mail_id="test-pull-request-2edbf96ebe644f4bb31b94605e-1",
            in_reply_to="test-pull-request-2edbf96ebe644f4bb31b94605e",
            project_name="namespace/project",
            user_from="Zöé",
        )
        self.assertEqual(
            email["From"],
            "=?utf-8?b?WsO2w6k=?= <pagure@localhost.localdomain>",
        )
        self.assertEqual(email["To"], "zöé@foo.net")
        del email["From"]
        del email["To"]
        self.assertEqual(email.as_string(), exp)
        exp = """Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: base64
Subject: =?utf-8?b?W25hbWVzcGFjZS9wcm9qZWN0XSBFbWFpbCDigJxTdWJqZWN04oCc?=
In-Reply-To: <test-pull-request-2edbf96ebe644f4bb31b94605e@localhost.localdomain>
X-Auto-Response-Suppress: All
X-pagure: http://localhost.localdomain/
X-pagure-project: namespace/project
List-ID: namespace/project
List-Archive: http://localhost.localdomain/namespace/project

RW1haWwgY29udGVudA==
"""
        email = pagure.lib.notify.send_email(
            "Email content",
            "Email “Subject“",
            "foo@bar.com,zöé@foo.net",
            mail_id=None,
            in_reply_to="test-pull-request-2edbf96ebe644f4bb31b94605e",
            project_name="namespace/project",
            user_from="Zöé",
        )
        del email["From"]
        del email["To"]
        self.assertEqual(email.as_string(), exp)

    @patch.dict("pagure.config.config", {"EVENTSOURCE_SOURCE": None})
    @patch("pagure.lib.notify.smtplib.SMTP")
    def test_send_email_no_reply_to(self, mock_smtp):
        """ Test the send_email method from pagure.lib.notify when there
        should not be a Reply-To header even if mail_id is defined. """
        mock_smtp.return_value = MagicMock()

        email = pagure.lib.notify.send_email(
            "Email content",
            "Email “Subject“",
            "foo@bar.com,zöé@foo.net",
            mail_id="test-pull-request-2edbf96ebe644f4bb31b94605e-1",
            in_reply_to="test-pull-request-2edbf96ebe644f4bb31b94605e",
            project_name="namespace/project",
            reporter="reporter",
            assignee="assignee",
            user_from="Zöé",
        )
        # Due to differences in the way Python2 and Python3 encode non-ascii
        # email headers, we compare the From and To headers separately from the
        # rest of the message.
        self.assertEqual(
            email["From"],
            "=?utf-8?b?WsO2w6k=?= <pagure@localhost.localdomain>",
        )
        self.assertEqual(email["To"], "zöé@foo.net")
        del email["From"]
        del email["To"]
        exp = """Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: base64
Subject: =?utf-8?b?W25hbWVzcGFjZS9wcm9qZWN0XSBFbWFpbCDigJxTdWJqZWN04oCc?=
mail-id: test-pull-request-2edbf96ebe644f4bb31b94605e-1@localhost.localdomain
Message-Id: <test-pull-request-2edbf96ebe644f4bb31b94605e-1@localhost.localdomain>
In-Reply-To: <test-pull-request-2edbf96ebe644f4bb31b94605e@localhost.localdomain>
X-Auto-Response-Suppress: All
X-pagure: http://localhost.localdomain/
X-pagure-project: namespace/project
List-ID: namespace/project
List-Archive: http://localhost.localdomain/namespace/project
X-pagure-reporter: reporter
X-pagure-assignee: assignee

RW1haWwgY29udGVudA==
"""
        self.assertEqual(email.as_string(), exp)

    def test_notification_mention(self):
        g = munch.Munch()
        g.session = self.session
        with patch("flask.g", g):

            def _check_mention(comment, exp):
                emails = set([])
                emails = pagure.lib.notify._add_mentioned_users(
                    emails, comment
                )

                self.assertEqual(emails, exp)

            exp = set(["bar@pingou.com"])
            comment = "I think we should ask @pingou how to pronounce pagure"
            _check_mention(comment, exp)

            exp = set([])
            comment = """Let me quote him:
~~~~
 @pingou> Pagure is pronounced 'pa-gure', not 'pagu-re'
~~~~
"""
            _check_mention(comment, exp)


if __name__ == "__main__":
    unittest.main(verbosity=2)