Merge pull request #881 from openedx/pwnage101/ENT-11009-1

feat: allow provisioning of multiple subs plans with same opp line item

Author: pwnage101

enterprise_access/apps/api/serializers/provisioning.py

@@ -188,6 +188,7 @@ class SubscriptionPlanResponseSerializer(BaseSerializer):
     is_current = serializers.BooleanField()
     plan_type = serializers.CharField()
     enterprise_catalog_uuid = serializers.UUIDField()
+    product = serializers.IntegerField()
 
 
 class CustomerAgreementResponseSerializer(BaseSerializer):

enterprise_access/apps/api/v1/tests/test_provisioning_views.py

@@ -67,6 +67,7 @@
     "is_current": False,
     "plan_type": "Standard Paid",
     "enterprise_catalog_uuid": str(TEST_CATALOG_UUID),
+    "product": 1,
 }
 
 DEFAULT_AGREEMENT_RECORD = {

enterprise_access/apps/provisioning/api.py

@@ -156,15 +156,23 @@ def get_or_create_customer_agreement(enterprise_customer_uuid, customer_slug, de
 
 
 def get_or_create_subscription_plan(
-    customer_agreement_uuid, existing_subscription_list, plan_title, catalog_uuid, opp_line_item,
-    start_date, expiration_date, desired_num_licenses, product_id, **kwargs
+    customer_agreement_uuid: str,
+    existing_subscription_list: list[dict],
+    plan_title: str,
+    catalog_uuid: str | None,
+    opp_line_item: str,
+    start_date: str,
+    expiration_date: str,
+    desired_num_licenses: int,
+    product_id: int | None,
+    **kwargs
 ):
     """
     Get or create a new subscription plan, provided an existing customer agreement dictionary.
     """
     matching_subscription = next((
         _sub for _sub in existing_subscription_list
-        if _sub.get('salesforce_opportunity_line_item') == opp_line_item
+        if _sub.get('salesforce_opportunity_line_item') == opp_line_item and _sub.get('product') == product_id
     ), None)
     if matching_subscription:
         logger.info(
@@ -186,7 +194,12 @@ def get_or_create_subscription_plan(
         **kwargs,
     )
     logger.info(
-        'Provisioning: created new subscription plan with uuid %s and salesforce_opportunity_line_item %s',
-        created_subscription['uuid'], created_subscription['salesforce_opportunity_line_item'],
+        (
+            'Provisioning: created new subscription plan with '
+            'uuid %s and salesforce_opportunity_line_item %s and product_id %s'
+        ),
+        created_subscription['uuid'],
+        created_subscription['salesforce_opportunity_line_item'],
+        created_subscription['product'],
     )
     return created_subscription

enterprise_access/apps/provisioning/models.py

@@ -391,6 +391,7 @@ class GetCreateSubscriptionPlanStepOutput(BaseInputOutput):
     is_current: bool = field(validator=is_bool)
     plan_type: str = field(validator=is_str)
     enterprise_catalog_uuid: UUID = field(validator=is_uuid)
+    product: int = field(validator=is_int)
 
 
 class GetCreateSubscriptionPlanStep(AbstractWorkflowStep):

enterprise_access/apps/provisioning/tests/factories.py

@@ -88,6 +88,7 @@ def create_complete_workflow(cls, **kwargs):
                 'is_current': True,
                 'plan_type': 'subscription',
                 'enterprise_catalog_uuid': str(uuid.uuid4()),
+                'product': 1,
             },
         }
 

enterprise_access/apps/provisioning/tests/test_api.py

@@ -3,7 +3,9 @@
 """
 from unittest import mock
 
+import ddt
 import requests
+from django.conf import settings
 from django.test import TestCase
 from rest_framework import status
 
@@ -382,6 +384,7 @@ def test_create_new_customer_agreement(self, mock_license_manager_client):
         )
 
 
+@ddt.ddt
 class TestGetOrCreateSubscriptionPlan(TestCase):
     """
     Tests for the get_or_create_subscription_plan() function.
@@ -393,57 +396,99 @@ def test_get_existing_subscription_plan(self, mock_license_manager_client):
                 'uuid': 'sub-uuid',
                 'title': 'Test Plan',
                 'salesforce_opportunity_line_item': 'opp-line-item',
+                'product': 1,
             },
         ]
 
         result = provisioning_api.get_or_create_subscription_plan(
-            customer_agreement_uuid=None,
+            customer_agreement_uuid='customer-agreement-uuid',
             existing_subscription_list=existing_subscriptions,
             plan_title='Test Plan',
             catalog_uuid='catalog-uuid',
             opp_line_item='opp-line-item',
             start_date='2025-05-01',
             expiration_date='2026-05-01',
             desired_num_licenses=100,
-            product_id=None,
+            product_id=1,
         )
 
         self.assertEqual(result, existing_subscriptions[0])
         mock_license_manager_client.assert_not_called()
 
+    @ddt.data(
+        # Same prodcut_id, different opp_line_item.
+        {
+            'existing_opp_line_item': 'opp-line-item-1',
+            'existing_product_id': 1,
+            'requesting_opp_line_item': 'opp-line-item-2',
+            'requesting_product_id': 1,
+        },
+        # Same opp_line_item, different prodcut_id.
+        {
+            'existing_opp_line_item': 'opp-line-item-1',
+            'existing_product_id': 1,
+            'requesting_opp_line_item': 'opp-line-item-1',
+            'requesting_product_id': 2,
+        },
+        # Make sure requesting product_id=None falls back to a default which does not conflict.
+        {
+            'existing_opp_line_item': 'opp-line-item-1',
+            'existing_product_id': settings.PROVISIONING_DEFAULTS['subscription']['product_id'] + 1,
+            'requesting_opp_line_item': 'opp-line-item-1',
+            'requesting_product_id': None,  # fallback to settings.PROVISIONING_DEFAULTS['subscription']['product_id']
+        },
+    )
+    @ddt.unpack
     @mock.patch.object(provisioning_api, 'LicenseManagerApiClient', autospec=True)
-    def test_create_new_subscription_plan(self, mock_license_manager_client):
+    def test_create_new_subscription_plan(
+        self,
+        mock_license_manager_client,
+        existing_opp_line_item,
+        existing_product_id,
+        requesting_opp_line_item,
+        requesting_product_id,
+    ):
+        existing_subscriptions = [
+            {
+                'uuid': 'sub-uuid',
+                'title': 'Test Plan',
+                'salesforce_opportunity_line_item': existing_opp_line_item,
+                'product': existing_product_id,
+            },
+        ]
         created_subscription = {
             'uuid': 'new-sub-uuid',
-            'salesforce_opportunity_line_item': 'opp-line-item',
+            'salesforce_opportunity_line_item': requesting_opp_line_item,
             'title': 'New Plan',
+            # Simulate the fallback logic within LicenseManagerApiClient.create_subscription_plan().
+            'product': requesting_product_id or settings.PROVISIONING_DEFAULTS['subscription']['product_id'],
         }
         mock_client = mock_license_manager_client.return_value
         mock_client.create_subscription_plan.return_value = created_subscription
 
         result = provisioning_api.get_or_create_subscription_plan(
             customer_agreement_uuid='agreement-uuid',
-            existing_subscription_list=[],
+            existing_subscription_list=existing_subscriptions,
             plan_title='New Plan',
             catalog_uuid='catalog-uuid',
-            opp_line_item='opp-line-item',
+            opp_line_item=requesting_opp_line_item,
             start_date='2025-05-01',
             expiration_date='2026-05-01',
             desired_num_licenses=50,
             extra_field='extra-value',
-            product_id='the-product',
+            product_id=requesting_product_id,
         )
 
         self.assertEqual(result, created_subscription)
         mock_client.create_subscription_plan.assert_called_once_with(
             customer_agreement_uuid='agreement-uuid',
             enterprise_catalog_uuid='catalog-uuid',
             title='New Plan',
-            salesforce_opportunity_line_item='opp-line-item',
+            salesforce_opportunity_line_item=requesting_opp_line_item,
             start_date='2025-05-01',
             expiration_date='2026-05-01',
             desired_num_licenses=50,
-            product_id='the-product',
+            product_id=requesting_product_id,
             extra_field='extra-value'
         )