Source code for notifications.tests.common_functions

from post_office.models import Email

from tests.test_manager import CobaltTestManagerIntegration




def check_email_sent(
    manager: CobaltTestManagerIntegration,
    test_name: str,
    test_description: str,
    email_to: str = None,
    subject_search: str = None,
    body_search: str = None,
    email_count: int = 10,
    debug: bool = False,
):
    """Check if an email has been sent. This isn't the greatest test going around. Email addresses get changed
        by the playpen checks and you can also find older emails that match by accident. Emails really need to
        be manually tested as you need to look at the presentation as well as the content, but this is better
        than nothing.

    Args:
        manager: standard manager object
        test_name: Name for this test to appear in report
        test_description: Description for this test
        subject_search: string to search for in the email subject
        body_search: string to search for in the email body
        email_to: first name of person sent the email. Assumes using normal templates for this.
        email_count: how many recent emails to look through
        debug: print diagnostics
    """

    try:
        last_email = Email.objects.order_by("-pk")[0].pk
    except (AttributeError, IndexError):
        if debug:
            print("Email Check: No emails found at all - emails are empty")
        manager.save_results(
            status=False,
            output="Looked for last email but found no emails at all",
            test_name=test_name,
            test_description=test_description,
        )
        return

    # We can't use the ORM to filter emails, we need to call Django Post Office functions
    emails = Email.objects.filter(id__gt=last_email - email_count)

    ok, output = _check_email_sent_tests(
        email_count,
        email_to,
        emails,
        subject_search,
        body_search,
        # debug,
    )

    output += f"Result was {ok}"

    manager.save_results(
        status=ok,
        output=output,
        test_name=test_name,
        test_description=test_description,
    )



def _check_email_sent_tests(
    email_count, email_to, emails, subject_search, body_search, debug=False
):
    """Sub step of check_email_sent. Does the actual checking."""

    if debug:
        mail_count = Email.objects.count()
        print(
            f"----> Inside _check_email_sent_tests. There are {mail_count} emails. Email list is:"
        )
        for email in emails:
            print(f"To: {email.context['name']}   Subject: {email.context['title']}")

    if not emails:
        return False, "No emails found at all. Could not search."

    ok = False
    output = f"Looked through last {email_count} emails for an email with "

    if email_to:
        output += f"to={email_to} "
        for email in emails:
            try:
                if email.context["name"] == email_to:
                    ok = True
                    if debug:
                        print(f"Email Check: Matched email in email_to check - {email}")
                else:
                    emails.exclude(pk=email.id)
            except TypeError:
                if debug:
                    print(
                        "Email Check: TypeError exception in checking email_to. email.context['name'] not found."
                    )
                emails.exclude(pk=email.id)
        if not ok:
            output += "Failed on email_to. "
            if debug:
                print("Email Check: Failed to match any emails in email_to check")
            return ok, output

    if subject_search:
        ok = False
        output += f"subject has '{subject_search}' "
        for email in emails:
            try:
                if email.context["subject"].find(subject_search) >= 0:
                    ok = True
                    if debug:
                        print(
                            f"Email Check: Matched email in subject_search check - {email}"
                        )
                else:
                    emails.exclude(pk=email.id)
            except TypeError:
                if debug:
                    print(
                        "Email Check: TypeError exception in checking subject_search. email.context['name'] not found."
                    )
                emails.exclude(pk=email.id)
        if not ok:
            output += "Failed on subject_search. "
            if debug:
                print("Email Check: Failed to match any emails in subject_search check")
            return ok, output

    if body_search:
        ok = False
        output += f"body contains '{body_search}' "
        for email in emails:
            try:
                if email.context["email_body"].find(body_search) >= 0:
                    ok = True
                    if debug:
                        print(
                            f"Email Check: Matched email in body_search check: {email}"
                        )
            except TypeError:
                if debug:
                    print(
                        "Email Check: TypeError exception in checking body_search. email.context['name'] not found."
                    )
                emails.exclude(pk=email.id)
        if not ok:
            output += "Failed on body_search. "
            if debug:
                print("Email Check: Failed to match any emails in body_search check")
            return ok, output

    return ok, output