Fix bug screenshot not attached with email and update tests (#113)

* Fix bug screenshot not attached with email and update tests

* remove report path from email env and automatically fetch it

Author: reach2jeyan

README.md

@@ -155,7 +155,6 @@ Create an emailenv file in your project folder that has the following
 ```commandline
 sender_email=you@example.com
 recipient_email=team@example.com
-report_path=report.html
 subject=Your Test Report
 smtp_server=smtp.sendgrid.net
 smtp_port=587

pytest_reporter_plus/plugin.py

@@ -132,7 +132,7 @@ def pytest_sessionfinish(session, exitstatus):
        print("📬 --send-email enabled. Sending report...")
        try:
            config = load_email_env()
-           config["report_path"] = f"{html_output}/report.html"
+           config["report_path"] = f"{html_output}"
            send_email_from_env(config)
        except Exception as e:
            raise RuntimeError(f"Failed to send email: {e}") from e

pytest_reporter_plus/send_email_report.py

@@ -3,6 +3,12 @@
 from email.message import EmailMessage
 from email.utils import make_msgid
 
+import shutil
+
+def zip_report_folder(folder_path: str, output_zip: str):
+    shutil.make_archive(output_zip.replace(".zip", ""), 'zip', folder_path)
+    return output_zip
+
 def load_email_env(filepath="emailenv"):
     if not os.path.exists(filepath):
         raise FileNotFoundError("emailenv file not found!")
@@ -25,17 +31,19 @@ def send_email_from_env(config: dict):
     password = config["email_password"]
     use_tls = True
 
+    zip_path = zip_report_folder(report_path, f"{report_path}_zipped" + ".zip")
+
     msg = EmailMessage()
     msg["Subject"] = subject
     msg["From"] = sender
     msg["To"] = recipient
 
     msg.set_content("Your test report is attached as an HTML file.")
 
-    filename = os.path.basename(report_path)
-    with open(report_path, "rb") as f:
+    filename = os.path.basename(zip_path)
+    with open(zip_path, "rb") as f:
         report_data = f.read()
-    msg.add_attachment(report_data, maintype="text", subtype="html", filename=filename)
+    msg.add_attachment(report_data, maintype="application", subtype="zip", filename=filename)
 
     try:
         if "sendgrid" in smtp_server.lower():

tests/e2e/test_email.py

@@ -1,27 +1,25 @@
-from unittest import mock
-from unittest.mock import patch, MagicMock
-
 import pytest
 
 from pytest_reporter_plus.send_email_report import send_email_from_env, load_email_env
-
+from unittest.mock import patch, MagicMock
 
 @patch("smtplib.SMTP")
-def test_send_email_success(mock_smtp):
-    # Prepare mock environment
+def test_send_email_success(mock_smtp, tmp_path):
+    report_dir = tmp_path / "report_output"
+    report_dir.mkdir()
+    report_file = report_dir / "report.html"
+    report_file.write_text("<h1>Test Report</h1>")
+
     config = {
         "sender_email": "sender@example.com",
         "recipient_email": "recipient@example.com",
-        "report_path": "sample_report.html",
+        "report_path": str(report_dir),
         "subject": "Test Subject",
         "smtp_server": "smtp.sendgrid.net",
         "smtp_port": "587",
         "email_password": "SG.fakekeyforunittesting"
     }
 
-    with open(config["report_path"], "w") as f:
-        f.write("<h1>Test Report</h1>")
-
     mock_server = MagicMock()
     mock_smtp.return_value.__enter__.return_value = mock_server
 
@@ -34,25 +32,25 @@ def test_send_email_success(mock_smtp):
 
 
 @patch("smtplib.SMTP")
-def test_invalid_sendgrid_key_warning(mock_smtp, capsys):
+def test_invalid_sendgrid_key_warning(mock_smtp, capsys, tmp_path):
+    report_dir = tmp_path / "report_output"
+    report_dir.mkdir()
+    (report_dir / "report.html").write_text("test")
+
     config = {
         "sender_email": "sender@example.com",
         "recipient_email": "recipient@example.com",
-        "report_path": "sample_report.html",
+        "report_path": str(report_dir),
         "subject": "Invalid Key Test",
         "smtp_server": "smtp.sendgrid.net",
         "smtp_port": "587",
         "email_password": "not_sendgrid_key"
     }
 
-    with open(config["report_path"], "w") as f:
-        f.write("test")
-
     mock_server = MagicMock()
     mock_smtp.return_value.__enter__.return_value = mock_server
 
     send_email_from_env(config)
-
     captured = capsys.readouterr()
     assert "SendGrid API key looks invalid" in captured.out
 
@@ -62,17 +60,17 @@ def test_load_email_env_file_not_found():
         load_email_env("non_existent_file.env")
 
 
-import pytest
 from unittest import mock
 
 def test_send_email_handles_exception(tmp_path):
-    report_path = tmp_path / "report.html"
-    report_path.write_text("<html><body>Fake report</body></html>")
+    report_dir = tmp_path / "report_output"
+    report_dir.mkdir()
+    (report_dir / "report.html").write_text("<html><body>Fake report</body></html>")
 
     config = {
         "sender_email": "test@example.com",
         "recipient_email": "recipient@example.com",
-        "report_path": str(report_path),
+        "report_path": str(report_dir),
         "subject": "Test Report",
         "smtp_server": "smtp.sendgrid.net",
         "smtp_port": "587",
@@ -84,17 +82,15 @@ def test_send_email_handles_exception(tmp_path):
             send_email_from_env(config)
 
 
-
-import pytest
-
 def test_warns_on_invalid_sendgrid_key(tmp_path):
-    report_path = tmp_path / "report.html"
-    report_path.write_text("<html><body>Hi</body></html>")
+    report_dir = tmp_path / "report_output"
+    report_dir.mkdir()
+    (report_dir / "report.html").write_text("<html><body>Hi</body></html>")
 
     config = {
         "sender_email": "me@example.com",
         "recipient_email": "you@example.com",
-        "report_path": str(report_path),
+        "report_path": str(report_dir),
         "subject": "Fake Subject",
         "smtp_server": "smtp.sendgrid.net",
         "smtp_port": "587",
@@ -105,6 +101,7 @@ def test_warns_on_invalid_sendgrid_key(tmp_path):
         with pytest.raises(RuntimeError, match="Failed to send email: SMTP failed"):
             send_email_from_env(config)
 
+
 def test_load_email_env_parses_file_correctly(tmp_path):
     env_file = tmp_path / "emailenv"
     env_file.write_text("sender_email=me@example.com\nrecipient_email=you@example.com\n")