Skip to content

Commit

Permalink
ListComponents modified to SOAP call (#3735)
Browse files Browse the repository at this point in the history 
Modified listing components of non source trackable metadata types using
SOAP call `APILISTMETADATA`

SOAP call takes maximum 3 queries at a time and so used the existing the
soap envelope which takes 1 metadata type at a time.
  • Loading branch information
@lakshmi2506
lakshmi2506 authored Jan 29, 2024
1 parent d4ff1e8 commit 6f0c918
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 169 deletions.
72 changes: 26 additions & 46 deletions cumulusci/tasks/salesforce/nonsourcetracking.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
import os

import requests
import sarge

from cumulusci.core.config import TaskConfig
from cumulusci.core.exceptions import CumulusCIException, SfdxOrgException
from cumulusci.core.sfdx import sfdx
from cumulusci.core.exceptions import CumulusCIException
from cumulusci.core.utils import process_list_arg
from cumulusci.salesforce_api.metadata import ApiListMetadata
from cumulusci.tasks.salesforce import (
BaseRetrieveMetadata,
BaseSalesforceApiTask,
Expand Down Expand Up @@ -83,6 +82,7 @@ def _run_task(self):


class ListComponents(BaseSalesforceApiTask):
api_class = ApiListMetadata
task_options = {
"api_version": {
"description": "Override the API version used to list metadatatypes",
Expand All @@ -99,55 +99,35 @@ def _init_options(self, kwargs):
self.options[
"api_version"
] = self.project_config.project__package__api_version
self.options["metadata_types"] = process_list_arg(
self.options.get("metadata_types", [])
)

def _get_components(self):
task_config = TaskConfig(
{"options": {"api_version": self.options["api_version"]}}
)
if not self.options["metadata_types"]:
metadata_types = ListNonSourceTrackable(
if "metadata_types" not in self.options:
self.options["metadata_types"] = ListNonSourceTrackable(
org_config=self.org_config,
project_config=self.project_config,
task_config=task_config,
task_config=TaskConfig(
{"options": {"api_version": self.options["api_version"]}}
),
)._run_task()
self.options["metadata_types"] = metadata_types
else:
self.options["metadata_types"] = process_list_arg(
self.options.get("metadata_types")
)

def _get_components(self):
list_components = []
for md_type in self.options["metadata_types"]:
p: sarge.Command = sfdx(
"force:mdapi:listmetadata",
access_token=self.org_config.access_token,
log_note="Listing components",
args=[
"-a",
str(self.options["api_version"]),
"-m",
str(md_type),
"--json",
],
env={"SFDX_INSTANCE_URL": self.org_config.instance_url},
api_object = self.api_class(
self, metadata_type=md_type, as_of_version=self.options["api_version"]
)
stdout, stderr = p.stdout_text.read(), p.stderr_text.read()

if p.returncode:
message = f"\nstderr:\n{nl.join(stderr)}"
message += f"\nstdout:\n{nl.join(stdout)}"
raise SfdxOrgException(message)
else:
result = json.loads(stdout)["result"]
if result:
for cmp in result:
change_dict = {
"MemberType": md_type,
"MemberName": cmp["fullName"],
"lastModifiedByName": cmp["lastModifiedByName"],
"lastModifiedDate": cmp["lastModifiedDate"],
}
if change_dict not in list_components:
list_components.append(change_dict)

components = api_object()
for temp in components[md_type]:
cmp = {
"MemberType": md_type,
"MemberName": temp["fullName"],
"lastModifiedByName": temp["lastModifiedByName"],
"lastModifiedDate": temp["lastModifiedDate"],
}
if cmp not in list_components:
list_components.append(cmp)
return list_components

def _run_task(self):
Expand Down
210 changes: 87 additions & 123 deletions cumulusci/tasks/salesforce/tests/test_nonsourcetracking.py
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import io
import datetime
import json
import os
from unittest import mock

import pytest
import responses

from cumulusci.core.exceptions import CumulusCIException, SfdxOrgException
from cumulusci.core.exceptions import CumulusCIException
from cumulusci.tasks.salesforce import DescribeMetadataTypes
from cumulusci.tasks.salesforce.nonsourcetracking import (
ListComponents,
Expand Down Expand Up @@ -85,128 +85,79 @@ def test_run_task_list_metadatatypes(self, create_task_fixture):
assert non_source_trackable == ["Scontrol", "SharingRules"]


@mock.patch("sarge.Command")
class TestListComponents:
@pytest.mark.parametrize(
"return_code, result",
[
(
0,
b"""{
"status": 0,
"result": [],
"warnings": [
"No metadata found for type: SharingRules"
]
}""",
),
(1, b""),
],
)
def test_check_sfdx_output(self, cmd, create_task_fixture, return_code, result):
options = {"api_version": 44.0}
task = create_task_fixture(ListComponents, options)
cmd.return_value = mock.Mock(
stderr=io.BytesIO(b""), stdout=io.BytesIO(result), returncode=return_code
)
task._init_task()
def test_init_task(self, create_task_fixture):
with mock.patch.object(
ListNonSourceTrackable, "_run_task", return_value=["SharingRules"]
ListNonSourceTrackable,
"_run_task",
return_value=["SharingRules", "Scontrol"],
):
if return_code:
with pytest.raises(SfdxOrgException):
task._run_task()
else:
assert task._run_task() == []
task = create_task_fixture(ListComponents, {})
task._init_task()
assert task.options["metadata_types"] == ["SharingRules", "Scontrol"]

@pytest.mark.parametrize(
"options",
[
{"api_version": 44.0, "metadata_types": "FlowDefinition"},
def test_check_api_result(self, create_task_fixture):
options = {"metadata_types": "SharingRules"}
task = create_task_fixture(ListComponents, options)
expected = [
{
"api_version": 44.0,
"MemberType": "SharingRules",
"MemberName": "Order",
"lastModifiedByName": "Automated process",
"lastModifiedDate": datetime.datetime(1970, 1, 1, 0, 0),
},
],
)
def test_check_sfdx_result(self, cmd, create_task_fixture, options):
task = create_task_fixture(ListComponents, options)
result = b"""{
"status": 0,
"result": [
{
"createdById": "0051y00000OdeZBAAZ",
"createdByName": "User User",
"createdDate": "2024-01-02T06:50:03.000Z",
"fileName": "flowDefinitions/alpha.flowDefinition",
"fullName": "alpha",
"id": "3001y000000ERX6AAO",
"lastModifiedById": "0051y00000OdeZBAAZ",
"lastModifiedByName": "User User",
"lastModifiedDate": "2024-01-02T06:50:07.000Z",
"manageableState": "unmanaged",
"namespacePrefix": "myalpha",
"type": "FlowDefinition"
},{
"createdById": "0051y00000OdeZBAAZ",
"createdByName": "User User",
"createdDate": "2024-01-02T06:50:03.000Z",
"fileName": "flowDefinitions/beta.flowDefinition",
"fullName": "beta",
"id": "3001y000000ERX6AAO",
"lastModifiedById": "0051y00000OdeZBAAZ",
"lastModifiedByName": "User User",
"lastModifiedDate": "2024-01-02T06:50:07.000Z",
"manageableState": "unmanaged",
"namespacePrefix": "myalpha",
"type": "FlowDefinition"
}
],
"warnings": []
}"""
cmd.return_value = mock.Mock(
stderr=io.BytesIO(b""), stdout=io.BytesIO(result), returncode=0
{
"MemberType": "SharingRules",
"MemberName": "BusinessBrand",
"lastModifiedByName": "User User",
"lastModifiedDate": datetime.datetime(1970, 1, 1, 0, 0),
},
]
result = mock.Mock(
return_value={
"SharingRules": [
{
"createdById": "0055j000008HpiJAAS",
"createdByName": "Alpha",
"createdDate": datetime.datetime(1970, 1, 1, 0, 0),
"fileName": "sharingRules/Order.sharingRules",
"fullName": "Order",
"id": None,
"lastModifiedById": "0055j000008HpiJAAS",
"lastModifiedByName": "Automated process",
"lastModifiedDate": datetime.datetime(1970, 1, 1, 0, 0),
"manageableState": None,
"namespacePrefix": None,
"type": "SharingRules",
},
{
"createdById": "0055j000008HpiJAAS",
"createdByName": "Beta",
"createdDate": datetime.datetime(1970, 1, 1, 0, 0),
"fileName": "sharingRules/BusinessBrand.sharingRules",
"fullName": "BusinessBrand",
"id": None,
"lastModifiedById": "0055j000008HpiJAAS",
"lastModifiedByName": "User User",
"lastModifiedDate": datetime.datetime(1970, 1, 1, 0, 0),
"manageableState": None,
"namespacePrefix": None,
"type": "SharingRules",
},
]
}
)
messages = []
task._init_task()
task.logger = mock.Mock()
task.logger.info = messages.append
if "metadata_types" in options:
components = task._run_task()
assert cmd.call_count == 1
assert (
"sfdx force:mdapi:listmetadata -a 44.0 -m FlowDefinition --json"
in cmd.call_args[0][0]
)
assert components == [
{
"MemberType": "FlowDefinition",
"MemberName": "alpha",
"lastModifiedByName": "User User",
"lastModifiedDate": "2024-01-02T06:50:07.000Z",
},
{
"MemberType": "FlowDefinition",
"MemberName": "beta",
"lastModifiedByName": "User User",
"lastModifiedDate": "2024-01-02T06:50:07.000Z",
},
]
assert (
"Found 2 non source trackable components in the org for the given types."
in messages
)
else:
with mock.patch.object(
ListNonSourceTrackable,
"_run_task",
return_value=["Index"],
):
task._run_task()
assert cmd.call_count == 1
assert (
"sfdx force:mdapi:listmetadata -a 44.0 -m Index --json"
in cmd.call_args[0][0]
)
task.api_class = mock.Mock(return_value=result)
components = task._run_task()
assert components == expected
assert (
"Found 2 non source trackable components in the org for the given types."
in messages
)


@mock.patch("cumulusci.tasks.salesforce.sourcetracking.sfdx")
Expand All @@ -219,7 +170,9 @@ def test_init_options__sfdx_format(self, sfdx, create_task_fixture):
json.dump(
{"packageDirectories": [{"path": "force-app", "default": True}]}, f
)
task = create_task_fixture(RetrieveComponents, {}, project_config)
task = create_task_fixture(
RetrieveComponents, {"metadata_types": "SharingRules"}, project_config
)
assert not task.md_format
assert task.options["path"] == "force-app"

Expand All @@ -229,29 +182,38 @@ def test_run_task(self, sfdx, create_task_fixture):

with temporary_dir():
task = create_task_fixture(
RetrieveComponents, {"include": "alpha", "namespace_tokenize": "ns"}
RetrieveComponents,
{
"include": "alpha",
"namespace_tokenize": "ns",
"metadata_types": "SharingRules",
},
)
task._init_task()
messages = []
with mock.patch.object(
ListComponents,
"_get_components",
return_value=[
{
"MemberType": "FlowDefinition",
"MemberType": "SharingRules",
"MemberName": "alpha",
"lastModifiedByName": "User User",
"lastModifiedDate": "2024-01-02T06:50:07.000Z",
"lastModifiedByName": "Automated process",
"lastModifiedDate": datetime.datetime(1970, 1, 1, 0, 0),
},
{
"MemberType": "FlowDefinition",
"MemberName": "beta",
"MemberType": "SharingRules",
"MemberName": "BusinessBrand",
"lastModifiedByName": "User User",
"lastModifiedDate": "2024-01-02T06:50:07.000Z",
"lastModifiedDate": datetime.datetime(1970, 1, 1, 0, 0),
},
],
):
task.logger = mock.Mock()
task.logger.info = messages.append
task._run_task()

assert "SharingRules: alpha" in messages
assert "SharingRules: BusinessBrand" not in messages
assert sfdx_calls == [
"force:mdapi:convert",
"force:source:retrieve",
Expand All @@ -261,7 +223,9 @@ def test_run_task(self, sfdx, create_task_fixture):

def test_run_task__no_changes(self, sfdx, create_task_fixture):
with temporary_dir() as path:
task = create_task_fixture(RetrieveComponents, {"path": path})
task = create_task_fixture(
RetrieveComponents, {"path": path, "metadata_types": "SharingRules"}
)
task._init_task()
messages = []
with mock.patch.object(ListComponents, "_get_components", return_value=[]):
Expand Down

0 comments on commit 6f0c918

Please sign in to comment.