edx-enterprise-data 8.7.0__py3-none-any.whl → 8.8.1__py3-none-any.whl

enterprise_data/tests/admin_analytics/test_analytics_enrollments.py

@@ -8,10 +8,10 @@ from rest_framework import status
 from rest_framework.reverse import reverse
 from rest_framework.test import APITransactionTestCase
 
-from enterprise_data.admin_analytics.constants import ENROLLMENT_CSV
-from enterprise_data.api.v1.serializers import AdvanceAnalyticsEnrollmentSerializer as EnrollmentSerializer
+from enterprise_data.admin_analytics.constants import EnrollmentChart, ResponseType
 from enterprise_data.api.v1.serializers import AdvanceAnalyticsEnrollmentStatsSerializer as EnrollmentStatsSerializer
-from enterprise_data.tests.admin_analytics.mock_enrollments import (
+from enterprise_data.api.v1.serializers import AdvanceAnalyticsQueryParamSerializer
+from enterprise_data.tests.admin_analytics.mock_analytics_data import (
     ENROLLMENT_STATS_CSVS,
     ENROLLMENTS,
     enrollments_csv_content,
@@ -23,13 +23,13 @@ from enterprise_data_roles.constants import ENTERPRISE_DATA_ADMIN_ROLE
 from enterprise_data_roles.models import EnterpriseDataFeatureRole, EnterpriseDataRoleAssignment
 
 INVALID_CALCULATION_ERROR = (
-    f"Calculation must be one of {EnrollmentSerializer.CALCULATION_CHOICES}"
+    f"Calculation must be one of {AdvanceAnalyticsQueryParamSerializer.CALCULATION_CHOICES}"
 )
 INVALID_GRANULARITY_ERROR = (
-    f"Granularity must be one of {EnrollmentSerializer.GRANULARITY_CHOICES}"
+    f"Granularity must be one of {AdvanceAnalyticsQueryParamSerializer.GRANULARITY_CHOICES}"
 )
-INVALID_CSV_ERROR1 = f"csv_type must be one of {EnrollmentSerializer.CSV_TYPES}"
-INVALID_CSV_ERROR2 = f"csv_type must be one of {EnrollmentStatsSerializer.CSV_TYPES}"
+INVALID_RESPONSE_TYPE_ERROR = f"response_type must be one of {AdvanceAnalyticsQueryParamSerializer.RESPONSE_TYPES}"
+INVALID_CHART_TYPE_ERROR = f"chart_type must be one of {EnrollmentStatsSerializer.CHART_TYPES}"
 
 
 @ddt.ddt
@@ -59,7 +59,7 @@ class TestIndividualEnrollmentsAPI(JWTTestMixin, APITransactionTestCase):
         )
 
         fetch_max_enrollment_datetime_patcher = patch(
-            'enterprise_data.api.v1.views.analytics_enrollments.fetch_max_enrollment_datetime',
+            'enterprise_data.api.v1.views.analytics_enrollments.fetch_enrollments_cache_expiry_timestamp',
             return_value=datetime.now()
         )
 
@@ -100,6 +100,7 @@ class TestIndividualEnrollmentsAPI(JWTTestMixin, APITransactionTestCase):
 
         response = self.client.get(self.url, {"page_size": 2})
         assert response.status_code == status.HTTP_200_OK
+        assert response["Content-Type"] == "application/json"
         data = response.json()
         assert data["next"] == f"http://testserver{self.url}?page=2&page_size=2"
         assert data["previous"] is None
@@ -110,6 +111,7 @@ class TestIndividualEnrollmentsAPI(JWTTestMixin, APITransactionTestCase):
 
         response = self.client.get(self.url, {"page_size": 2, "page": 2})
         assert response.status_code == status.HTTP_200_OK
+        assert response["Content-Type"] == "application/json"
         data = response.json()
         assert data["next"] == f"http://testserver{self.url}?page=3&page_size=2"
         assert data["previous"] == f"http://testserver{self.url}?page_size=2"
@@ -120,6 +122,7 @@ class TestIndividualEnrollmentsAPI(JWTTestMixin, APITransactionTestCase):
 
         response = self.client.get(self.url, {"page_size": 2, "page": 3})
         assert response.status_code == status.HTTP_200_OK
+        assert response["Content-Type"] == "application/json"
         data = response.json()
         assert data["next"] is None
         assert data["previous"] == f"http://testserver{self.url}?page=2&page_size=2"
@@ -130,6 +133,7 @@ class TestIndividualEnrollmentsAPI(JWTTestMixin, APITransactionTestCase):
 
         response = self.client.get(self.url, {"page_size": 5})
         assert response.status_code == status.HTTP_200_OK
+        assert response["Content-Type"] == "application/json"
         data = response.json()
         assert data["next"] is None
         assert data["previous"] is None
@@ -146,15 +150,11 @@ class TestIndividualEnrollmentsAPI(JWTTestMixin, APITransactionTestCase):
         Test the GET method for the AdvanceAnalyticsIndividualEnrollmentsView return correct CSV data.
         """
         mock_fetch_and_cache_enrollments_data.return_value = enrollments_dataframe()
-        response = self.client.get(self.url, {"csv_type": ENROLLMENT_CSV.INDIVIDUAL_ENROLLMENTS.value})
+        response = self.client.get(self.url, {"response_type": ResponseType.CSV.value})
         assert response.status_code == status.HTTP_200_OK
 
         # verify the response headers
         assert response["Content-Type"] == "text/csv"
-        assert (
-            response["Content-Disposition"]
-            == 'attachment; filename="individual_enrollments.csv"'
-        )
 
         # verify the response content
         content = b"".join(response.streaming_content)
@@ -193,7 +193,7 @@ class TestIndividualEnrollmentsAPI(JWTTestMixin, APITransactionTestCase):
             "params": {"granularity": "invalid"},
             "error": {"granularity": [INVALID_GRANULARITY_ERROR]},
         },
-        {"params": {"csv_type": "invalid"}, "error": {"csv_type": [INVALID_CSV_ERROR1]}},
+        {"params": {"response_type": "invalid"}, "error": {"response_type": [INVALID_RESPONSE_TYPE_ERROR]}},
     )
     @ddt.unpack
     def test_get_invalid_query_params(self, params, error):
@@ -232,7 +232,7 @@ class TestEnrollmentStatsAPI(JWTTestMixin, APITransactionTestCase):
         )
 
         fetch_max_enrollment_datetime_patcher = patch(
-            'enterprise_data.api.v1.views.analytics_enrollments.fetch_max_enrollment_datetime',
+            'enterprise_data.api.v1.views.analytics_enrollments.fetch_enrollments_cache_expiry_timestamp',
             return_value=datetime.now()
         )
 
@@ -271,6 +271,7 @@ class TestEnrollmentStatsAPI(JWTTestMixin, APITransactionTestCase):
 
         response = self.client.get(self.url)
         assert response.status_code == status.HTTP_200_OK
+        assert response["Content-Type"] == "application/json"
         data = response.json()
         assert data == {
             "enrollments_over_time": [
@@ -332,21 +333,21 @@ class TestEnrollmentStatsAPI(JWTTestMixin, APITransactionTestCase):
 
     @patch("enterprise_data.api.v1.views.analytics_enrollments.fetch_and_cache_enrollments_data")
     @ddt.data(
-        ENROLLMENT_CSV.ENROLLMENTS_OVER_TIME.value,
-        ENROLLMENT_CSV.TOP_COURSES_BY_ENROLLMENTS.value,
-        ENROLLMENT_CSV.TOP_SUBJECTS_BY_ENROLLMENTS.value,
+        EnrollmentChart.ENROLLMENTS_OVER_TIME.value,
+        EnrollmentChart.TOP_COURSES_BY_ENROLLMENTS.value,
+        EnrollmentChart.TOP_SUBJECTS_BY_ENROLLMENTS.value,
     )
-    def test_get_csv(self, csv_type, mock_fetch_and_cache_enrollments_data):
+    def test_get_csv(self, chart_type, mock_fetch_and_cache_enrollments_data):
         """
         Test that AdvanceAnalyticsEnrollmentStatsView return correct CSV data.
         """
         mock_fetch_and_cache_enrollments_data.return_value = enrollments_dataframe()
 
-        response = self.client.get(self.url, {"csv_type": csv_type})
+        response = self.client.get(self.url, {"response_type": ResponseType.CSV.value, "chart_type": chart_type})
         assert response.status_code == status.HTTP_200_OK
         assert response["Content-Type"] == "text/csv"
         # verify the response content
-        assert response.content == ENROLLMENT_STATS_CSVS[csv_type]
+        assert response.content == ENROLLMENT_STATS_CSVS[chart_type]
 
     @ddt.data(
         {
@@ -381,7 +382,7 @@ class TestEnrollmentStatsAPI(JWTTestMixin, APITransactionTestCase):
             "params": {"granularity": "invalid"},
             "error": {"granularity": [INVALID_GRANULARITY_ERROR]},
         },
-        {"params": {"csv_type": "invalid"}, "error": {"csv_type": [INVALID_CSV_ERROR2]}},
+        {"params": {"chart_type": "invalid"}, "error": {"chart_type": [INVALID_CHART_TYPE_ERROR]}},
     )
     @ddt.unpack
     def test_get_invalid_query_params(self, params, error):

enterprise_data/tests/admin_analytics/test_analytics_leaderboard.py

@@ -0,0 +1,163 @@
+"""Unittests for analytics_enrollments.py"""
+
+from datetime import datetime
+
+import ddt
+from mock import patch
+from rest_framework import status
+from rest_framework.reverse import reverse
+from rest_framework.test import APITransactionTestCase
+
+from enterprise_data.admin_analytics.constants import ResponseType
+from enterprise_data.tests.admin_analytics.mock_analytics_data import (
+    ENROLLMENTS,
+    LEADERBOARD_RESPONSE,
+    engagements_dataframe,
+    enrollments_dataframe,
+    leaderboard_csv_content,
+)
+from enterprise_data.tests.mixins import JWTTestMixin
+from enterprise_data.tests.test_utils import UserFactory
+from enterprise_data_roles.constants import ENTERPRISE_DATA_ADMIN_ROLE
+from enterprise_data_roles.models import EnterpriseDataFeatureRole, EnterpriseDataRoleAssignment
+
+
+@ddt.ddt
+class TestLeaderboardAPI(JWTTestMixin, APITransactionTestCase):
+    """Tests for AdvanceAnalyticsLeaderboardView."""
+
+    def setUp(self):
+        """
+        Setup method.
+        """
+        super().setUp()
+        self.user = UserFactory(is_staff=True)
+        role, __ = EnterpriseDataFeatureRole.objects.get_or_create(
+            name=ENTERPRISE_DATA_ADMIN_ROLE
+        )
+        self.role_assignment = EnterpriseDataRoleAssignment.objects.create(
+            role=role, user=self.user
+        )
+        self.client.force_authenticate(user=self.user)
+
+        self.enterprise_uuid = "ee5e6b3a-069a-4947-bb8d-d2dbc323396c"
+        self.set_jwt_cookie()
+
+        self.url = reverse(
+            "v1:enterprise-admin-analytics-leaderboard",
+            kwargs={"enterprise_uuid": self.enterprise_uuid},
+        )
+
+        fetch_max_enrollment_datetime_patcher = patch(
+            'enterprise_data.api.v1.views.analytics_leaderboard.fetch_enrollments_cache_expiry_timestamp',
+            return_value=datetime.now()
+        )
+
+        fetch_max_enrollment_datetime_patcher.start()
+        self.addCleanup(fetch_max_enrollment_datetime_patcher.stop)
+
+        fetch_max_engagement_datetime_patcher = patch(
+            'enterprise_data.api.v1.views.analytics_leaderboard.fetch_engagements_cache_expiry_timestamp',
+            return_value=datetime.now()
+        )
+
+        fetch_max_engagement_datetime_patcher.start()
+        self.addCleanup(fetch_max_engagement_datetime_patcher.stop)
+
+    def verify_enrollment_data(self, results, results_count):
+        """Verify the received enrollment data."""
+        attrs = [
+            "email",
+            "course_title",
+            "course_subject",
+            "enroll_type",
+            "enterprise_enrollment_date",
+        ]
+
+        assert len(results) == results_count
+
+        filtered_data = []
+        for enrollment in ENROLLMENTS:
+            for result in results:
+                if enrollment["email"] == result["email"]:
+                    filtered_data.append({attr: enrollment[attr] for attr in attrs})
+                    break
+
+        received_data = sorted(results, key=lambda x: x["email"])
+        expected_data = sorted(filtered_data, key=lambda x: x["email"])
+        assert received_data == expected_data
+
+    @patch(
+        "enterprise_data.api.v1.views.analytics_leaderboard.fetch_and_cache_enrollments_data"
+    )
+    @patch(
+        "enterprise_data.api.v1.views.analytics_leaderboard.fetch_and_cache_engagements_data"
+    )
+    def test_get(self, mock_fetch_and_cache_engagements_data, mock_fetch_and_cache_enrollments_data):
+        """
+        Test the GET method for the AdvanceAnalyticsLeaderboardView works.
+        """
+        mock_fetch_and_cache_enrollments_data.return_value = enrollments_dataframe()
+        mock_fetch_and_cache_engagements_data.return_value = engagements_dataframe()
+
+        response = self.client.get(self.url, {"page_size": 2})
+        assert response.status_code == status.HTTP_200_OK
+        assert response["Content-Type"] == "application/json"
+        data = response.json()
+        assert data["next"] == f'http://testserver{self.url}?page=2&page_size=2'
+        assert data["previous"] is None
+        assert data["current_page"] == 1
+        assert data["num_pages"] == 6
+        assert data["count"] == 12
+        assert data["results"] == [
+            {
+                "email": "paul77@example.org",
+                "daily_sessions": 1,
+                "learning_time_seconds": 15753,
+                "learning_time_hours": 4.4,
+                "average_session_length": 4.4,
+                "course_completions": None,
+            },
+            {
+                "email": "seth57@example.org",
+                "daily_sessions": 1,
+                "learning_time_seconds": 9898,
+                "learning_time_hours": 2.7,
+                "average_session_length": 2.7,
+                "course_completions": None,
+            },
+        ]
+
+        # fetch all records
+        response = self.client.get(self.url, {"page_size": 20})
+        assert response.status_code == status.HTTP_200_OK
+        data = response.json()
+        assert data["next"] is None
+        assert data["previous"] is None
+        assert data["current_page"] == 1
+        assert data["num_pages"] == 1
+        assert data["count"] == 12
+        assert data["results"] == LEADERBOARD_RESPONSE
+
+    @patch(
+        "enterprise_data.api.v1.views.analytics_leaderboard.fetch_and_cache_enrollments_data"
+    )
+    @patch(
+        "enterprise_data.api.v1.views.analytics_leaderboard.fetch_and_cache_engagements_data"
+    )
+    def test_get_csv(self, mock_fetch_and_cache_engagements_data, mock_fetch_and_cache_enrollments_data):
+        """
+        Test the GET method for the AdvanceAnalyticsIndividualEnrollmentsView return correct CSV data.
+        """
+        mock_fetch_and_cache_enrollments_data.return_value = enrollments_dataframe()
+        mock_fetch_and_cache_engagements_data.return_value = engagements_dataframe()
+
+        response = self.client.get(self.url, {"response_type": ResponseType.CSV.value})
+        assert response.status_code == status.HTTP_200_OK
+
+        # verify the response headers
+        assert response["Content-Type"] == "text/csv"
+
+        # verify the response content
+        content = b"".join(response.streaming_content)
+        assert content == leaderboard_csv_content()

enterprise_data/tests/admin_analytics/test_enterprise_completions.py

@@ -8,7 +8,7 @@ from rest_framework.reverse import reverse
 from rest_framework.test import APITransactionTestCase
 
 from enterprise_data.admin_analytics.utils import ChartType
-from enterprise_data.tests.admin_analytics.mock_enrollments import (
+from enterprise_data.tests.admin_analytics.mock_analytics_data import (
     COMPLETIONS_STATS_CSVS,
     ENROLLMENTS,
     enrollments_dataframe,

enterprise_data/utils.py

@@ -4,6 +4,7 @@ Utility functions for Enterprise Data app.
 import hashlib
 import random
 import time
+from contextlib import contextmanager
 from datetime import timedelta
 from functools import wraps
 from logging import getLogger
@@ -68,6 +69,21 @@ def timeit(func):
     return wrapper
 
 
+@contextmanager
+def timer(prefix):
+    """
+    Context manager to measure the time taken by a block of code.
+
+    Arguments:
+        prefix (str): The prefix to print in the log.
+    """
+    start = time.time()
+    yield
+    end = time.time()
+    difference = end - start
+    print(f"TIMER:: {prefix} took {difference:.20f} seconds")
+
+
 def date_filter(start, end, data_frame, date_column):
     """
     Filter a pandas DataFrame by date range.