edx-enterprise-data 10.9.2__py3-none-any.whl → 10.10.0__py3-none-any.whl

{edx_enterprise_data-10.9.2.dist-info → edx_enterprise_data-10.10.0.dist-info}/METADATA

@@ -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.dist-info → edx_enterprise_data-10.10.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-enterprise_data/__init__.py,sha256=43SJnms4n0HahLVcyoeoXg5lGi892WKLrR8LP-MkYto,124
+enterprise_data/__init__.py,sha256=z8VZBN4L4n3dhorf4GlhRP7qPQKCp334pTYxoE7F_As,125
 enterprise_data/apps.py,sha256=aF6hZwDfI2oWj95tUTm_2ikHueQj-jLj-u0GrgzpsQI,414
 enterprise_data/clients.py,sha256=pBuCQOP7NYl264ZbMtZCRPCET1pg0by8w6PVlA-icKA,4995
 enterprise_data/constants.py,sha256=uCKjfpdlMYFZJsAj3n9RMw4Cmg5_6s3NuwocO-fch3s,238
@@ -153,7 +153,8 @@ enterprise_data_roles/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 enterprise_data_roles/tests/factories.py,sha256=VOm0NyOhiKkxl1MRIriRkKSpKypr9-4lG2FrsE2YfKo,1153
 enterprise_data_roles/tests/test_models.py,sha256=wJv7ywk0BSbjlW_U142h0aFxZleAHyT92nIiPy_ECW4,1476
 enterprise_reporting/__init__.py,sha256=yQO9ureIxFnl-1a_34H53elDwuAzXrSmhLlzqqD2SJ0,112
-enterprise_reporting/delivery_method.py,sha256=bG-JCGhrK3nuC3P6D88zBRSwDJCbaDxN35nNlXzvoRM,4813
+enterprise_reporting/constants.py,sha256=k3IKeKl0Rs6PnPqnnwma9SUNcmO6_6Ma4mLXV5mIrH4,208
+enterprise_reporting/delivery_method.py,sha256=JpNEDT3yk4IV27OsqIq0iLv3xcTkW9B285P91YBUrsA,6109
 enterprise_reporting/external_resource_link_report.py,sha256=jQ6RS0yec0IhAz4wErQ3q8Yn206R7aQbgcR2c803BLA,8066
 enterprise_reporting/reporter.py,sha256=3wI46qH-CNCUC5r9-Eme1mQdMjwEsFk9myRb-ajzJkM,13807
 enterprise_reporting/send_enterprise_reports.py,sha256=W9xc7hu3ZP4zmoIndITc3hdXDbd4A3QEWQN0_ZO1E1A,5270
@@ -167,7 +168,7 @@ enterprise_reporting/fixtures/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 enterprise_reporting/fixtures/enterprise_customer_reporting.json,sha256=nS6E9KHW0Iqk7ZHtTyyVyrztIXxjn9OtBvMJkn7owxc,3959
 enterprise_reporting/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 enterprise_reporting/tests/test_clients.py,sha256=h-h7xBJ6wIBKP-QqRxcJJGiQxLfTOLYByCuWfcCeCy0,8474
-enterprise_reporting/tests/test_delivery_method.py,sha256=Zy169SrKz5zWjysI_RhGujuPZWivDR3arm3kxAUBPF8,2598
+enterprise_reporting/tests/test_delivery_method.py,sha256=AU4C6qev9ETr_hQCM1QVN1PKztyJNUGfKXI8XzeIOZ4,4555
 enterprise_reporting/tests/test_enterprise_client.py,sha256=lpWm0muvA3alRjmlRAezE5901C9DU3WiySH4D5-U3qE,1058
 enterprise_reporting/tests/test_external_link_report.py,sha256=zdnVOD1qtAp9c5EbIPnD9jcoLtW4iKs7gSVklgBK328,7029
 enterprise_reporting/tests/test_reporter.py,sha256=PTmkGvPjGEjxiyizL88LAKnaWdvZDgOBjL4QStfOdyw,4057
@@ -175,8 +176,8 @@ enterprise_reporting/tests/test_send_enterprise_reports.py,sha256=zBj7sDvRLJQbRs
 enterprise_reporting/tests/test_utils.py,sha256=y4t6w9aKra-ftqtUeHvPwOhje-1npz7auV5o74ya8fE,9523
 enterprise_reporting/tests/test_vertica_client.py,sha256=-R2yNCGUjRtoXwLMBloVFQkFYrJoo613VCr61gwI3kQ,140
 enterprise_reporting/tests/utils.py,sha256=xms2LM7DV3wczXEfctOK1ddel1EE0J_YSr17UzbCDy4,1401
-edx_enterprise_data-10.9.2.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-edx_enterprise_data-10.9.2.dist-info/METADATA,sha256=POBhGmJwAD5O1bHRURgDSxzF7nJ2iOok3jI4MW6BAM0,1684
-edx_enterprise_data-10.9.2.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-edx_enterprise_data-10.9.2.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
-edx_enterprise_data-10.9.2.dist-info/RECORD,,
+edx_enterprise_data-10.10.0.dist-info/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+edx_enterprise_data-10.10.0.dist-info/METADATA,sha256=BbVKWA5HCJ6IBYrXapHWyfhPWtP1t5gFieZAVoFyuUQ,1685
+edx_enterprise_data-10.10.0.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+edx_enterprise_data-10.10.0.dist-info/top_level.txt,sha256=f5F2kU-dob6MqiHJpgZkFzoCD5VMhsdpkTV5n9Tvq3I,59
+edx_enterprise_data-10.10.0.dist-info/RECORD,,

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"

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']

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={},
+        )

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={},
+            )