feat: add LmsApiClient.create_enterprise_admin_user() method

Author: iloveagent57

enterprise_access/apps/api_client/lms_client.py

@@ -50,6 +50,7 @@ class LmsApiClient(BaseOAuthClient):
     enterprise_customer_endpoint = enterprise_api_base_url + 'enterprise-customer/'
     pending_enterprise_learner_endpoint = enterprise_api_base_url + 'pending-enterprise-learner/'
     enterprise_group_membership_endpoint = enterprise_api_base_url + 'enterprise-group/'
+    pending_enterprise_admin_endpoint = enterprise_api_base_url + 'pending-enterprise-admin/'
 
     def enterprise_customer_url(self, enterprise_customer_uuid):
         return os.path.join(
@@ -194,6 +195,40 @@ def get_enterprise_admin_users(self, enterprise_customer_uuid):
 
         return results
 
+    def create_enterprise_admin_user(self, enterprise_customer_uuid, user_email):
+        """
+        Creates a new enterprise pending admin record.
+
+        Arguments:
+            enterprise_customer_uuid (UUID): UUID of the enterprise customer.
+            user_email (string): The email address of the admin.
+        Returns:
+            dictionary describing the created pending admin record.
+        """
+        payload = {
+            'enterprise_customer': enterprise_customer_uuid,
+            'user_email': user_email,
+        }
+        try:
+            response = self.client.post(
+                self.pending_enterprise_admin_endpoint,
+                json=payload,
+                timeout=settings.LMS_CLIENT_TIMEOUT,
+            )
+            response.raise_for_status()
+            logger.info(
+                'Successfully created pending admin record for customer %s, email %s',
+                enterprise_customer_uuid, user_email,
+            )
+            payload = response.json()
+            return payload
+        except requests.exceptions.HTTPError:
+            logger.exception(
+                'Failed to create pending admin record for customer %s, email %s',
+                enterprise_customer_uuid, user_email,
+            )
+            raise
+
     def unlink_users_from_enterprise(self, enterprise_customer_uuid, user_emails, is_relinkable=True):
         """
         Unlink users with the given emails from the enterprise.

enterprise_access/apps/api_client/tests/test_lms_client.py

@@ -201,6 +201,7 @@ def test_create_enterprise_customer_data(self, mock_oauth_client, mock_json):
         mock_post.return_value.status_code = 201
 
         client = LmsApiClient()
+
         response_payload = client.create_enterprise_customer(**customer_input)
 
         self.assertEqual(response_payload, mock_created_customer_payload)
@@ -215,6 +216,43 @@ def test_create_enterprise_customer_data(self, mock_oauth_client, mock_json):
             timeout=settings.LMS_CLIENT_TIMEOUT,
         )
 
+    @mock.patch('requests.Response.json')
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_create_enterprise_admin_user(self, mock_oauth_client, mock_json):
+        """
+        Test that we can use the LmsApiClient to create a new customer admin.
+        """
+        customer_uuid = str(uuid4())
+
+        mock_created_admin_payload = {
+            'id': 1,
+            'enterprise_customer': customer_uuid,
+            'user_email': '[email protected]',
+        }
+        mock_json.return_value = mock_created_admin_payload
+
+        mock_post = mock_oauth_client.return_value.post
+
+        mock_post.return_value = requests.Response()
+        mock_post.return_value.status_code = 201
+
+        client = LmsApiClient()
+        response_payload = client.create_enterprise_admin_user(
+            customer_uuid, '[email protected]',
+        )
+
+        self.assertEqual(response_payload, mock_created_admin_payload)
+        expected_url = 'http://edx-platform.example.com/enterprise/api/v1/pending-enterprise-admin/'
+        expected_input = {
+            'enterprise_customer': customer_uuid,
+            'user_email': '[email protected]',
+        }
+        mock_post.assert_called_once_with(
+            expected_url,
+            json=expected_input,
+            timeout=settings.LMS_CLIENT_TIMEOUT,
+        )
+
     @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
     def test_create_enterprise_customer_error(self, mock_oauth_client):
         """
@@ -249,6 +287,35 @@ def test_create_enterprise_customer_error(self, mock_oauth_client):
             timeout=settings.LMS_CLIENT_TIMEOUT,
         )
 
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_create_enterprise_admin_error(self, mock_oauth_client):
+        """
+        Tests that we raise an exception appropriately when creating a
+        new customer admin record with the LmsApiClient().
+        """
+        customer_uuid = str(uuid4())
+        mock_post = mock_oauth_client.return_value.post
+
+        mock_post.side_effect = requests.exceptions.HTTPError('whoopsie')
+        mock_post.return_value.status_code = 400
+
+        client = LmsApiClient()
+        with self.assertRaises(requests.exceptions.HTTPError):
+            client.create_enterprise_admin_user(
+                customer_uuid, '[email protected]',
+            )
+
+        expected_url = 'http://edx-platform.example.com/enterprise/api/v1/pending-enterprise-admin/'
+        expected_input = {
+            'enterprise_customer': customer_uuid,
+            'user_email': '[email protected]',
+        }
+        mock_post.assert_called_once_with(
+            expected_url,
+            json=expected_input,
+            timeout=settings.LMS_CLIENT_TIMEOUT,
+        )
+
     @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
     def test_unlink_users_from_enterprise(self, mock_oauth_client):
         """