edx-enterprise-data 10.9.2__tar.gz → 10.10.0__tar.gz

{edx_enterprise_data-10.9.2 → edx_enterprise_data-10.10.0}/CHANGELOG.rst

@@ -15,6 +15,9 @@ Unreleased
 ----------
 
 =========================
+[10.10.0] - 2025-02-24
+---------------------
+  * feat: Added separate handling for of SFTP transmission failures.
 
 [10.9.2] - 2025-03-11
 ---------------------

{edx_enterprise_data-10.9.2/edx_enterprise_data.egg-info → edx_enterprise_data-10.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: edx-enterprise-data
-Version: 10.9.2
+Version: 10.10.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-10.9.2 → edx_enterprise_data-10.10.0/edx_enterprise_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: edx-enterprise-data
-Version: 10.9.2
+Version: 10.10.0
 Summary: Enterprise Reporting
 Home-page: https://github.com/openedx/edx-enterprise-data
 Author: edX

{edx_enterprise_data-10.9.2 → edx_enterprise_data-10.10.0}/edx_enterprise_data.egg-info/SOURCES.txt

@@ -164,6 +164,7 @@ enterprise_data_roles/tests/__init__.py
 enterprise_data_roles/tests/factories.py
 enterprise_data_roles/tests/test_models.py
 enterprise_reporting/__init__.py
+enterprise_reporting/constants.py
 enterprise_reporting/delivery_method.py
 enterprise_reporting/external_resource_link_report.py
 enterprise_reporting/reporter.py

{edx_enterprise_data-10.9.2 → edx_enterprise_data-10.10.0}/enterprise_data/__init__.py

@@ -2,4 +2,4 @@
 Enterprise data api application. This Django app exposes API endpoints used by enterprises.
 """
 
-__version__ = "10.9.2"
+__version__ = "10.10.0"

edx_enterprise_data-10.10.0/enterprise_reporting/constants.py

@@ -0,0 +1,7 @@
+"""
+Constants for enterprise_reporting.
+"""
+
+
+SFTP_OPS_GENIE_EMAIL_ALERT_FROM_EMAIL = "enterprise-analytics@edx.org"
+SFTP_OPS_GENIE_EMAIL_ALERT_EMAILS = ['enterprise-reporting-sftp@2u-internal.opsgenie.net']

{edx_enterprise_data-10.9.2 → edx_enterprise_data-10.10.0}/enterprise_reporting/delivery_method.py

@@ -2,15 +2,19 @@
 Classes that handle sending reports for enterprise customers with specific delivery methods.
 """
 
-
-
 import logging
 import os
 from smtplib import SMTPException
 
 import paramiko
 
-from enterprise_reporting.utils import compress_and_encrypt, decrypt_string, send_email_with_attachment
+from enterprise_reporting.constants import SFTP_OPS_GENIE_EMAIL_ALERT_EMAILS, SFTP_OPS_GENIE_EMAIL_ALERT_FROM_EMAIL
+from enterprise_reporting.utils import (
+    compress_and_encrypt,
+    decrypt_string,
+    retry_on_exception,
+    send_email_with_attachment,
+)
 
 LOGGER = logging.getLogger(__name__)
 
@@ -97,6 +101,8 @@ class SFTPDeliveryMethod(DeliveryMethod):
     """
     Class that handles sending an enterprise report file via SFTP.
     """
+    sender_email = SFTP_OPS_GENIE_EMAIL_ALERT_FROM_EMAIL
+    receiver_emails = SFTP_OPS_GENIE_EMAIL_ALERT_EMAILS
 
     def __init__(self, reporting_config, password):
         """Initialize the SFTP Delivery Method."""
@@ -106,9 +112,11 @@ class SFTPDeliveryMethod(DeliveryMethod):
         self.username = reporting_config['sftp_username']
         self.file_path = reporting_config['sftp_file_path']
 
-    def send(self, files):
-        """Send the given files through SFTP."""
-        data_reports = super().send(files)
+    @retry_on_exception(max_retries=3, delay=2, backoff=2)
+    def send_over_sftp(self, data_reports):
+        """
+        Send the reports via SFTP, retry on exception.
+        """
         LOGGER.info('Connecting via SFTP to remote host {} for {}'.format(
             self.hostname,
             self.enterprise_customer_name
@@ -129,4 +137,25 @@ class SFTPDeliveryMethod(DeliveryMethod):
             )
         sftp.close()
         ssh.close()
-        LOGGER.info(f'Successfully sent report via sftp for {self.enterprise_customer_name}')
+
+    def send(self, files):
+        """Send the given files through SFTP."""
+        try:
+            data_reports = super().send(files)
+            self.send_over_sftp(data_reports)
+        except Exception:  # pylint: disable=broad-except
+            email_subject = f'SFTP transmission failed for {self.enterprise_customer_name}'
+            email_body = f'Failed to send {self.data_type} report for {self.enterprise_customer_name}'
+            LOGGER.exception(f'SFTP transmission failed for {self.enterprise_customer_name}')
+        else:
+            LOGGER.info(f'Successfully sent report via sftp for {self.enterprise_customer_name}')
+            email_subject = f'SFTP transmission successful for {self.enterprise_customer_name}'
+            email_body = f'SFTP transmission successful for {self.enterprise_customer_name}'
+
+        send_email_with_attachment(
+            subject=email_subject,
+            body=email_body,
+            from_email=self.sender_email,
+            to_email=self.receiver_emails,
+            attachment_data={},
+        )

{edx_enterprise_data-10.9.2 → edx_enterprise_data-10.10.0}/enterprise_reporting/tests/test_delivery_method.py

@@ -2,13 +2,12 @@
 Test delivery methods.
 """
 
-import sys
 import unittest
 
 import ddt
-import pytest
 
-from enterprise_reporting.delivery_method import DeliveryMethod, SFTPDeliveryMethod, SMTPDeliveryMethod
+from mock import patch, MagicMock
+from enterprise_reporting.delivery_method import SFTPDeliveryMethod, SMTPDeliveryMethod
 from enterprise_reporting.utils import encrypt_string
 
 from .utils import create_files, verify_compressed
@@ -73,3 +72,47 @@ class TestDeliveryMethod(unittest.TestCase):
         else:
             assert len(delivery_files) == len(delivery_files)
             assert delivery_files == [file['file'].name for file in files]
+
+    @patch('enterprise_reporting.delivery_method.send_email_with_attachment')
+    def test_verify_sftp_exception_handling(self, mock_send_email_with_attachment):
+        """
+        Verify that SFTP transmission related exceptions are being handled correctly.
+        """
+        file_data = [
+            {
+                'name': 'A History of Magic.txt',
+                'size': 1000
+            },
+            {
+                'name': 'Quidditch Through the Ages.txt',
+                'size': 500
+            },
+            {
+                'name': 'Quidditch Through the Ages.txt',
+                'size': 500
+            },
+        ]
+        files, total_original_size = create_files(file_data)
+        sftp_delivery_method = SFTPDeliveryMethod(self.reporting_config, self.password)
+
+        # Verify failed SFTP transmission.
+        with patch('paramiko.SSHClient.connect', side_effect=Exception('SFTP transmission failed')):
+            sftp_delivery_method.send([file['file'] for file in files])
+            mock_send_email_with_attachment.assert_called_with(
+                subject='SFTP transmission failed for bleh-bleh',
+                body='Failed to send progress report for bleh-bleh',
+                from_email='enterprise-analytics@edx.org',
+                to_email=['enterprise-reporting-sftp@2u-internal.opsgenie.net'],
+                attachment_data={},
+            )
+
+        # Verify successful SFTP transmission.
+        with patch('paramiko.SSHClient', MagicMock()):
+            sftp_delivery_method.send([file['file'] for file in files])
+            mock_send_email_with_attachment.assert_called_with(
+                subject='SFTP transmission successful for bleh-bleh',
+                body='SFTP transmission successful for bleh-bleh',
+                from_email='enterprise-analytics@edx.org',
+                to_email=['enterprise-reporting-sftp@2u-internal.opsgenie.net'],
+                attachment_data={},
+            )