Reverting the available_permissionseet_licenses task and assign_permi…

…ssion_set_licenses takes either the developername or permissionsetlicenseKey
SFDO-Tooling · Jun 7, 2024 · 4b4a386 · 4b4a386
1 parent 730deb7
commit 4b4a386
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 10 deletions.
diff --git a/cumulusci/tasks/preflight/licenses.py b/cumulusci/tasks/preflight/licenses.py
@@ -16,9 +16,9 @@ def _run_task(self):
 class GetAvailablePermissionSetLicenses(BaseSalesforceApiTask):
     def _run_task(self):
         self.return_values = [
-            result["DeveloperName"]
+            result["PermissionSetLicenseKey"]
             for result in self.sf.query(
-                "SELECT DeveloperName FROM PermissionSetLicense"
+                "SELECT PermissionSetLicenseKey FROM PermissionSetLicense"
             )["records"]
         ]
         licenses = "\n".join(self.return_values)

diff --git a/cumulusci/tasks/preflight/tests/test_licenses.py b/cumulusci/tasks/preflight/tests/test_licenses.py
@@ -34,8 +34,8 @@ def test_psl_preflight(self):
         task._init_api.return_value.query.return_value = {
             "totalSize": 2,
             "records": [
-                {"DeveloperName": "TEST1"},
-                {"DeveloperName": "TEST2"},
+                {"PermissionSetLicenseKey": "TEST1"},
+                {"PermissionSetLicenseKey": "TEST2"},
             ],
         }
         task()

diff --git a/cumulusci/tasks/salesforce/users/permsets.py b/cumulusci/tasks/salesforce/users/permsets.py
@@ -174,12 +174,34 @@ class AssignPermissionSetLicenses(AssignPermissionSets):
     }
 
     permission_name = "PermissionSetLicense"
-    permission_name_field = "DeveloperName"
+    permission_name_field = ["DeveloperName", "PermissionSetLicenseKey"]
     permission_label = "Permission Set License"
     assignment_name = "PermissionSetLicenseAssign"
     assignment_lookup = "PermissionSetLicenseId"
     assignment_child_relationship = "PermissionSetLicenseAssignments"
 
+    def _get_perm_ids(self):
+        perms_by_ids = {}
+        api_names = "', '".join(self.options["api_names"])
+        missing_perms = {api_name: True for api_name in self.options["api_names"]}
+        for permission_field in self.permission_name_field:
+            perms = self.sf.query(
+                f"SELECT Id,{permission_field} FROM {self.permission_name} WHERE {permission_field} IN ('{api_names}')"
+            )
+            perms_by_ids_subset = {
+                p["Id"]: p[permission_field] for p in perms["records"]
+            }
+            perms_by_ids.update(perms_by_ids_subset)
+            missing_perms.update(
+                {api_name: False for api_name in perms_by_ids.values()}
+            )
+
+        if any(missing_perms.values()):
+            raise CumulusCIException(
+                f"The following {self.permission_label}s were not found: {', '.join(api_names for api_names in missing_perms if missing_perms[api_names])}."
+            )
+        return perms_by_ids
+
 
 class AssignPermissionSetGroups(AssignPermissionSets):
     task_docs = """

diff --git a/cumulusci/tasks/salesforce/users/tests/test_permsets.py b/cumulusci/tasks/salesforce/users/tests/test_permsets.py
@@ -464,6 +464,16 @@ def test_create_permsetlicense(self):
                 ],
             },
         )
+        responses.add(
+            method="GET",
+            url=f"{task.org_config.instance_url}/services/data/v{CURRENT_SF_API_VERSION}/query/?q=SELECT+Id%2CPermissionSetLicenseKey+FROM+PermissionSetLicense+WHERE+PermissionSetLicenseKey+IN+%28%27PermSetLicense1%27%2C+%27PermSetLicense2%27%29",
+            status=200,
+            json={
+                "done": True,
+                "totalSize": 1,
+                "records": [],
+            },
+        )
         responses.add(
             method="POST",
             url=f"{task.org_config.instance_url}/services/data/v{CURRENT_SF_API_VERSION}/composite/sobjects",
@@ -487,7 +497,7 @@ def test_create_permsetlicense(self):
 
         task()
 
-        assert len(responses.calls) == 3
+        assert len(responses.calls) == 4
 
     @responses.activate
     def test_create_permsetlicense__no_assignments(self):
@@ -526,9 +536,21 @@ def test_create_permsetlicense__no_assignments(self):
                         "Id": "0PL000000000000",
                         "DeveloperName": "PermSetLicense1",
                     },
+                ],
+            },
+        )
+
+        responses.add(
+            method="GET",
+            url=f"{task.org_config.instance_url}/services/data/v{CURRENT_SF_API_VERSION}/query/?q=SELECT+Id%2CPermissionSetLicenseKey+FROM+PermissionSetLicense+WHERE+PermissionSetLicenseKey+IN+%28%27PermSetLicense1%27%2C+%27PermSetLicense2%27%29",
+            status=200,
+            json={
+                "done": True,
+                "totalSize": 1,
+                "records": [
                     {
                         "Id": "0PL000000000001",
-                        "DeveloperName": "PermSetLicense2",
+                        "PermissionSetLicenseKey": "PermSetLicense2",
                     },
                 ],
             },
@@ -564,7 +586,7 @@ def test_create_permsetlicense__no_assignments(self):
         )
         task()
 
-        assert len(responses.calls) == 3
+        assert len(responses.calls) == 4
 
     @responses.activate
     def test_create_permsetlicense__alias(self):
@@ -607,13 +629,26 @@ def test_create_permsetlicense__alias(self):
                         "Id": "0PL000000000000",
                         "DeveloperName": "PermSetLicense1",
                     },
+                ],
+            },
+        )
+
+        responses.add(
+            method="GET",
+            url=f"{task.org_config.instance_url}/services/data/v{CURRENT_SF_API_VERSION}/query/?q=SELECT+Id%2CPermissionSetLicenseKey+FROM+PermissionSetLicense+WHERE+PermissionSetLicenseKey+IN+%28%27PermSetLicense1%27%2C+%27PermSetLicense2%27%29",
+            status=200,
+            json={
+                "done": True,
+                "totalSize": 1,
+                "records": [
                     {
                         "Id": "0PL000000000001",
-                        "DeveloperName": "PermSetLicense2",
+                        "PermissionSetLicenseKey": "PermSetLicense2",
                     },
                 ],
             },
         )
+
         responses.add(
             method="POST",
             url=f"{task.org_config.instance_url}/services/data/v{CURRENT_SF_API_VERSION}/sobjects/PermissionSetLicenseAssign/",
@@ -643,7 +678,7 @@ def test_create_permsetlicense__alias(self):
         )
         task()
 
-        assert len(responses.calls) == 3
+        assert len(responses.calls) == 4
 
     @responses.activate
     def test_create_permsetlicense__alias_raises(self):
@@ -715,6 +750,25 @@ def test_create_permsetlicense_raises(self):
                 ],
             },
         )
+        responses.add(
+            method="GET",
+            url=f"{task.org_config.instance_url}/services/data/v{CURRENT_SF_API_VERSION}/query/?q=SELECT+Id%2CPermissionSetLicenseKey+FROM+PermissionSetLicense+WHERE+PermissionSetLicenseKey+IN+%28%27PermSetLicense1%27%2C+%27PermSetLicense2%27%2C+%27PermSetLicense3%27%29",
+            status=200,
+            json={
+                "done": True,
+                "totalSize": 1,
+                "records": [
+                    {
+                        "Id": "0PL000000000000",
+                        "PermissionSetLicenseKey": "PermSetLicense1",
+                    },
+                    {
+                        "Id": "0PL000000000001",
+                        "PermissionSetLicenseKey": "PermSetLicense2",
+                    },
+                ],
+            },
+        )
 
         with pytest.raises(CumulusCIException):
             task()