feat: created mock_apps for ci testing

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         python-version: ['3.11']
-        toxenv: [quality, docs, pii_check, django42]
+        toxenv: [quality, pii_check, django42]
 
     steps:
     - uses: actions/checkout@v3

.gitignore

@@ -63,3 +63,7 @@ docs/channel_integrations.*.rst
 # Private requirements
 requirements/private.in
 requirements/private.txt
+
+# Code editor settings
+.idea/
+.vscode/

CHANGELOG.rst

@@ -16,10 +16,13 @@ Unreleased
 
 *
 
-0.1.0 – 2024-10-30
+0.1.0 – 2025-01-16
 **********************************************
 
 Added
 =====
 
+* Created ``mock_apps`` for testing purposes.
+* Updated requirements in ``base.in`` and run ``make requirements``.
+* Migrated ``integrated_channel`` app from edx-enterprise.
 * First release on PyPI.

channel_integrations/catalog_service_utils.py

@@ -1,5 +1,5 @@
 """
-A utility collection for calls from integrated_channels to Catalog service
+A utility collection for calls from integrated_channels to Catalog service.
 """
 from enterprise.api_client.discovery import get_course_catalog_api_service_client
 

channel_integrations/integrated_channel/exporters/content_metadata.py

@@ -13,7 +13,6 @@
 from django.conf import settings
 from django.db.models import Q
 from django.utils import timezone
-
 from enterprise.api_client.enterprise_catalog import EnterpriseCatalogApiClient
 from enterprise.constants import (
     EXEC_ED_CONTENT_DESCRIPTION_TAG,
@@ -23,6 +22,7 @@
     TRANSMISSION_MARK_CREATE,
 )
 from enterprise.utils import get_content_metadata_item_id
+
 from channel_integrations.integrated_channel.exporters import Exporter
 from channel_integrations.utils import generate_formatted_log, truncate_item_dicts
 

channel_integrations/integrated_channel/exporters/learner_data.py

@@ -9,23 +9,22 @@
 from datetime import datetime
 from logging import getLogger
 
-from opaque_keys import InvalidKeyError
-from requests.exceptions import HTTPError
-
+from consent.models import DataSharingConsent
 from django.apps import apps
 from django.contrib import auth
 from django.utils import timezone
 from django.utils.dateparse import parse_datetime
+from enterprise.api_client.lms import GradesApiClient
+from enterprise.models import EnterpriseCourseEnrollment
+from opaque_keys import InvalidKeyError
+from requests.exceptions import HTTPError
 
 from channel_integrations.integrated_channel.channel_settings import ChannelSettingsMixin
 
 try:
     from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
 except ImportError:
     CourseOverview = None
-from consent.models import DataSharingConsent
-from enterprise.api_client.lms import GradesApiClient
-from enterprise.models import EnterpriseCourseEnrollment
 from channel_integrations.catalog_service_utils import get_course_id_for_enrollment
 from channel_integrations.integrated_channel.exporters import Exporter
 from channel_integrations.lms_utils import (

channel_integrations/integrated_channel/management/commands/__init__.py

@@ -6,8 +6,8 @@
 
 from django.core.management.base import CommandError
 from django.utils.translation import gettext as _
-
 from enterprise.models import EnterpriseCustomer
+
 from channel_integrations.blackboard.models import BlackboardEnterpriseCustomerConfiguration
 from channel_integrations.canvas.models import CanvasEnterpriseCustomerConfiguration
 from channel_integrations.cornerstone.models import CornerstoneEnterpriseCustomerConfiguration

channel_integrations/integrated_channel/management/commands/assign_skills_to_degreed_courses.py

@@ -3,12 +3,11 @@
 """
 from logging import getLogger
 
-from requests.exceptions import ConnectionError, RequestException, Timeout  # pylint: disable=redefined-builtin
-
 from django.contrib import auth
 from django.core.management.base import BaseCommand, CommandError
-
 from enterprise.api_client.enterprise_catalog import EnterpriseCatalogApiClient
+from requests.exceptions import ConnectionError, RequestException, Timeout  # pylint: disable=redefined-builtin
+
 from channel_integrations.degreed2.client import Degreed2APIClient
 from channel_integrations.exceptions import ClientError
 from channel_integrations.integrated_channel.management.commands import IntegratedChannelCommandMixin

channel_integrations/integrated_channel/models.py

@@ -5,21 +5,19 @@
 import json
 import logging
 
-from jsonfield.fields import JSONField
-
 from django.contrib import auth
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models import Q
 from django.db.models.query import QuerySet
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
-
-from model_utils.models import TimeStampedModel
-
 from enterprise.constants import TRANSMISSION_MARK_CREATE, TRANSMISSION_MARK_DELETE, TRANSMISSION_MARK_UPDATE
 from enterprise.models import EnterpriseCustomer, EnterpriseCustomerCatalog
 from enterprise.utils import localized_utcnow
+from jsonfield.fields import JSONField
+from model_utils.models import TimeStampedModel
+
 from channel_integrations.integrated_channel.exporters.content_metadata import ContentMetadataExporter
 from channel_integrations.integrated_channel.exporters.learner_data import LearnerExporter
 from channel_integrations.integrated_channel.transmitters.content_metadata import ContentMetadataTransmitter

channel_integrations/integrated_channel/tasks.py

@@ -7,14 +7,13 @@
 
 from celery import shared_task
 from celery.utils.log import get_task_logger
-from edx_django_utils.monitoring import set_code_owner_attribute
-
 from django.conf import settings
 from django.contrib import auth
 from django.core.cache import cache
 from django.utils import timezone
-
+from edx_django_utils.monitoring import set_code_owner_attribute
 from enterprise.utils import get_enterprise_uuids_for_user_and_course
+
 from channel_integrations.integrated_channel.constants import TASK_LOCK_EXPIRY_SECONDS
 from channel_integrations.integrated_channel.management.commands import (
     INTEGRATED_CHANNEL_CHOICES,

channel_integrations/integrated_channel/transmitters/content_metadata.py

@@ -8,11 +8,10 @@
 from itertools import islice
 
 import requests
-
 from django.apps import apps
 from django.conf import settings
-
 from enterprise.utils import localized_utcnow, truncate_string
+
 from channel_integrations.exceptions import ClientError
 from channel_integrations.integrated_channel.client import IntegratedChannelApiClient
 from channel_integrations.integrated_channel.transmitters import Transmitter
@@ -130,7 +129,7 @@
         """
         return response
 
-    def _transmit_action(self, content_metadata_item_map, client_method, action_name):  # pylint: disable=too-many-statements
+    def _transmit_action(self, content_metadata_item_map, client_method, action_name):  # pylint: disable=R0915
         """
         Do the work of calling the appropriate client method, saving the results, and updating
         the appropriate timestamps

channel_integrations/integrated_channel/transmitters/learner_data.py

@@ -6,8 +6,8 @@
 from http import HTTPStatus
 
 from django.apps import apps
-
 from enterprise.utils import localized_utcnow
+
 from channel_integrations.exceptions import ClientError
 from channel_integrations.integrated_channel.channel_settings import ChannelSettingsMixin
 from channel_integrations.integrated_channel.client import IntegratedChannelApiClient

channel_integrations/utils.py

@@ -15,14 +15,13 @@
 
 import pytz
 import requests
-
 from django.apps import apps
 from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import Q
 from django.utils import timezone
 from django.utils.html import strip_tags
-
 from enterprise.utils import parse_datetime_handle_invalid, parse_lms_api_datetime
+
 from channel_integrations.catalog_service_utils import get_course_run_for_enrollment
 
 UNIX_EPOCH = datetime(1970, 1, 1, tzinfo=timezone.utc)
@@ -503,8 +502,9 @@
     """
     Get the appropriate enterprise client based on channel code
     """
+    # TODO: Suppress pylint warning for E0401 and E0611 until we migrate canvas
     # TODO: Other configs
-    from channel_integrations.canvas.client import CanvasAPIClient  # pylint: disable=C0415
+    from channel_integrations.canvas.client import CanvasAPIClient  # pylint: disable=C0415, E0401, E0611
     _enterprise_client_model_by_channel_code = {
         'canvas': CanvasAPIClient,
     }

manage.py

@@ -10,6 +10,7 @@
 
 if __name__ == '__main__':
     os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'test_settings')
+    sys.path.append('./mock_apps')
     sys.path.append(PWD)
     try:
         from django.core.management import execute_from_command_line

mock_apps/consent/errors.py

@@ -0,0 +1,7 @@
+"""
+Errors thrown by the APIs in the Consent application.
+"""
+
+
+class InvalidProxyConsent(Exception):
+    """A proxy consent object with the given details could not be created."""

mock_apps/consent/mixins.py

@@ -0,0 +1,9 @@
+"""
+Mixins for edX Enterprise's Consent application.
+"""
+
+
+class ConsentModelMixin:
+    """
+    A mixin for Data Sharing Consent classes that require common, reusable functionality.
+    """

mock_apps/consent/models.py

@@ -0,0 +1,11 @@
+class DataSharingConsent:
+    """
+    An abstract representation of Data Sharing Consent granted to an Enterprise for a course by a User.
+
+    The model is used to store a persistent, historical consent state for users granting, not granting, or revoking
+    data sharing consent to an Enterprise for a course.
+
+    .. pii: The username field inherited from Consent contains PII.
+    .. pii_types: username
+    .. pii_retirement: consumer_api
+    """

mock_apps/enterprise/api_client/discovery.py

@@ -0,0 +1,7 @@
+"""
+Utilities to get details from the course catalog API.
+"""
+
+
+def get_course_catalog_api_service_client(site=None):
+    return []

mock_apps/enterprise/api_client/enterprise_catalog.py

@@ -0,0 +1,15 @@
+"""
+Mock Client for communicating with the Enterprise API.
+"""
+
+
+class EnterpriseCatalogApiClient:
+    """
+    The API client to make calls to the Enterprise Catalog API.
+    """
+
+    def get_catalog_diff(self, enterprise_customer_catalog, content_keys, should_raise_exception=True):
+        return [], [], []
+
+    def get_content_metadata(self, enterprise_customer, enterprise_catalogs=None, content_keys_filter=None):
+        return []

mock_apps/enterprise/api_client/lms.py

@@ -0,0 +1,14 @@
+"""
+Utilities to get details from the course catalog API.
+"""
+
+
+class GradesApiClient:
+    """
+    The API client to make calls to the LMS Grades API.
+
+    Note that this API client requires a JWT token, and so it keeps its token alive.
+    """
+
+    def get_course_assessment_grades(self, course_id, username):
+        return []

mock_apps/enterprise/constants.py

@@ -0,0 +1,20 @@
+"""
+Enterprise Django application constants.
+"""
+
+TRANSMISSION_MARK_CREATE = 'create'
+TRANSMISSION_MARK_UPDATE = 'update'
+TRANSMISSION_MARK_DELETE = 'delete'
+
+# ContentFilter field types for validation.
+CONTENT_FILTER_FIELD_TYPES = {
+    'key': {'type': list, 'subtype': str},
+    'first_enrollable_paid_seat_price__lte': {'type': str}
+}
+
+MAX_ALLOWED_TEXT_LENGTH = 16_000_000
+EXEC_ED_COURSE_TYPE = "executive-education-2u"
+IC_CREATE_ACTION = 'create'
+IC_UPDATE_ACTION = 'update'
+EXEC_ED_CONTENT_DESCRIPTION_TAG = ("This instructor-led Executive Education course is "
+                                   "presented by GetSmarter, an edX partner. ")

mock_apps/enterprise/models.py

@@ -0,0 +1,23 @@
+"""
+Database models for enterprise.
+"""
+from django.db import models
+
+
+class EnterpriseCustomerCatalog:
+    """
+    Store catalog information from course discovery specifically for Enterprises.
+    """
+
+
+class EnterpriseCourseEnrollment:
+    """
+    Store information about the enrollment of a user in a course.
+    """
+
+
+class EnterpriseCustomer:
+    enterprise_customer_catalogs = models.ManyToManyField(
+    EnterpriseCustomerCatalog,
+    verbose_name="Enterprise Customer Catalogs",
+    )