o
gZd @ s d Z ddlmZmZ ddlmZ ddlmZmZm Z m
Z
m Z m Z m
Z
mZ ddlmZ ddlmZ ddlZddlmZ dd lmZmZmZ d
d lm Z m Z d
d l m Z m Z m!Z!m"Z" dd
l#m$Z$m%Z% G dd dZ&G dd dZ'dS ), Class to work with Salesforce Metadata API ) b64encode b64decode)Path)AnyDictIOListMappingOptionalTupleUnion) ElementTree)ElementN) ServiceProxy)
AnySimpleType ComplexType
CompoundValue )Headerscall_salesforce)
DEPLOY_MSGCHECK_DEPLOY_STATUS_MSGCHECK_RETRIEVE_STATUS_MSG RETRIEVE_MSG)ClientSettingsc @ s e Zd ZdZdededeeef de fddZ
e de e
d d
fd d Zd
e
de
d e
fddZde e
d d
fddZde e d ee e
e
f fddZde e
d d
fddZde e
d d
fddZde eee
f d d
fdd Zd ed ed d
fd d Zd e
fd!d"Zd
S )# MetadataTypez"
Salesforce Metadata Type
nameservice zeep_typesession_headerc C s || _ || _|| _|| _dS )a}
Initialize metadata type
:param name: Name of metadata type
:type name: str
:param service: Zeep service
:type service: zeep.proxy.ServiceProxy
:param zeep_type: Zeep type object
:type zeep_type: zeep.xsd.ComplexType or zeep.xsd.AnySimpleType
:param session_header: Session Id header for Metadata API calls
N)_name_service
_zeep_type_session_header)selfr r r r! r' S/home/ubuntu/webapp/venv/lib/python3.10/site-packages/simple_salesforce/metadata.py__init__ s
zMetadataType.__init__responsereturnNc C s\ d}| D ]!}|j s%|d|j d7 }|jD ]}|d|j d|j d7 }qq|r,t|dS )ah
Parses SaveResult and DeleteResult objects to identify if there was
an error, and raises exception accordingly
:param response: List of zeep.objects.SaveResult or
zeep.objects.DeleteResult objects
:type response: list
:raises Exception: If any Result object contains one or more error
messages
z: (z, z), N)successfullNameerrors
statusCodemessage Exception)r*
err_stringresulterrorr' r' r( _handle_api_response- s
z!MetadataType._handle_api_responseargskwargsc O s | j |i |S )z
Creates a new object of this metadata type
:param args: Parameters to pass to zeep.xsd.AnySimpleType
:param kwargs: Parameters to pass to zeep.xsd.ComplexType
:returns: An object of type self._name
)r$ )r& r9 r: r' r' r( __call__C s zMetadataType.__call__metadatac C " | j j|| jgd}| | dS )a
Performs a createMetadata call
:param metadata: Array of one or more metadata components.
Limit: 10. (For CustomMetadata and CustomApplication
only, the limit is 200.)
You must submit arrays of only one type of
component. For example, you can submit an
array of 10 custom objects or 10 profiles, but not a
mix of both types.
:type metadata: list
_soapheadersN)r# createMetadatar% r8 r& r< r* r' r' r( createM s
zMetadataType.create
full_namesc C s0 | j j| j|| jgd}t|dkr|d S |S )aj
Performs a readMetadata call
:param full_names: Array of full names of the components to read.
Limit: 10. (For CustomMetadata and
CustomApplication only, the limit is 200.)
You must submit arrays of only one type of
component. For example, you can submit an array
of 10 custom objects or 10 profiles, but not a mix
of both types.
:type full_names: list
:returns: A list of metadata components
:rtype: list
r> r r )r# readMetadatar" r% lenr& rC r* r' r' r( read^ s zMetadataType.readc C r= )aR
Performs an updateMetadata call. All required fields must be passed
for each component
:param metadata: Array of one or more metadata components.
Limit: 10. (For CustomMetadata and CustomApplication
only, the limit is 200.)
You must submit arrays of only one type of
component. For example, you can submit an
array of 10 custom objects or 10 profiles, but not a
mix of both types.
:type metadata: list
r> N)r# updateMetadatar% r8 rA r' r' r( updatet zMetadataType.updatec C r= )aR
Performs an upsertMetadata call. All required fields must be passed
for each component
:param metadata: Array of one or more metadata components.
Limit: 10. (For CustomMetadata and CustomApplication
only, the limit is 200.)
You must submit arrays of only one type of
component. For example, you can submit an
array of 10 custom objects or 10 profiles, but not a
mix of both types.
:type metadata: list
r> N)r# upsertMetadatar% r8 rA r' r' r( upsert rJ zMetadataType.upsertc C s& | j j| j|| jgd}| | dS )a)
Performs a deleteMetadata call
:param full_names: Array of full names of the components to delete.
Limit: 10. (For CustomMetadata and
CustomApplication only, the limit is 200.)
You must submit arrays of only one type of
component. For example, you can submit an array
of 10 custom objects or 10 profiles, but not a mix
of both types.
:type full_names: list
r> N)r# deleteMetadatar" r% r8 rF r' r' r( delete s
zMetadataType.delete
old_full_name
new_full_namec C s* | j j| j||| jgd}| |g dS )z
Performs a renameMetadata call
:param old_full_name: The current component full name.
:type old_full_name: str
:param new_full_name: The new component full name.
:type new_full_name: str
r> N)r# renameMetadatar" r% r8 )r& rO rP r6 r' r' r( rename s zMetadataType.renamec C s | j jd| j | jgdS )z^
Performs a describeValueType call
:returns: DescribeValueTypeResult
z){http://soap.sforce.com/2006/04/metadata}r> )r# describeValueTyper" r% r& r' r' r( describe s
zMetadataType.describe)__name__
__module__ __qualname____doc__strr r
r r r r) staticmethodr r r8 r; rB rG rI rL r rN rR rU r' r' r' r( r s*
" r c
@ s e Zd ZdZdZdddZdejdeded ed
e d e
e f d d
Z dede fddZ
defddZdee dee fddZdeeee f dededee
e e
e f fddZedeeee f defd d Zd ededefd d Zed!ede fd"d#Z d ededee
e e
e e
e eef e
e eef f fd$d%Z d edd&fd'd(Z d ededee
e e
e f fd)d*Z!d ed+ededefd,d-Z"d ededee
e e
e ee#eef ef fd.d/Z$d ededee
e e
e ee#ee
e f f fd0d1Z%d&S )2SfdcMetadataApir z/services/Soap/m/{version}z)http://schemas.xmlsoap.org/soap/envelope/z'http://soap.sforce.com/2006/04/metadata)soapenvmtsession
session_idinstance metadata_urlheaders api_versionc C s || _ || _|| _|| _|| _|| _d| _ttj d }t
| t
dddd| _| jd| j| _| jd| jd | _dS )
z Initialize and check session Nz
metadata.wsdlFT)strictxsd_ignore_sequence_order)settingsz8{http://soap.sforce.com/2006/04/metadata}MetadataBindingzns0:SessionHeader) sessionId)r_ _session_id _instancerb rc _api_version _deploy_zipr __file__parentr absoluteas_urir _clientcreate_servicer# get_elementr% )r& r_ r` ra rb rc rd wsdl_pathr' r' r( r) s0
zSfdcMetadataApi.__init__itemr+ c C s t || j| jd| | jS )Nzns0:)r r# rq get_typer% )r& ru r' r' r( __getattr__ s zSfdcMetadataApi.__getattr__c C s | j j| j| jgdS )zv
Performs a describeMetadata call
:returns: An object of zeep.objects.DescribeMetadataResult
r> )r# describeMetadatark r% rT r' r' r( describe_metadata s
z!SfdcMetadataApi.describe_metadataqueriesc C s | j j|| j| jgdS )a=
Performs a listMetadata call
:param queries: A list of zeep.objects.ListMetadataQuery that specify
which components you are interested in.
Limit: 3
:type queries: list
:returns: List of zeep.objects.FileProperties objects
:rtype: list
r> )r# listMetadatark r% )r& rz r' r' r(
list_metadata s
z SfdcMetadataApi.list_metadatazipfilesandboxr: c K s~ | dd}| dd}| d}| d}| dd}| dd} | d d}
| d
d} | d d} | d d}
d
}||| j| ||||| |
| | |
|d
}|sZd|d< d
|d < |rfd| d}||d< d}|rt| dkr|D ]
}|d| d7 }qt||d< tjd i |}ddd}t| jd d| j | j
||d}t |j
dd | jpd }t |j
d d | jpd }||fS ) z Kicks off async deployment, returns deployment id
:param zipfile:
:type zipfile:
:param kwargs:
:type kwargs:
:return:
:rtype:
client simple_salesforce_metahelper checkOnlyF testLeveltestsignoreWarningsallowMissingFilesautoUpdatePackageperformRetrieve
purgeOnDeleterollbackOnErrorT)
r r rh ZipFiler r r r r r r r
singlePackagezzr, runspecifiedtestszz
text/xmldeploy)z Content-Type
SOAPAction
deployRequestPOSTurlmethodr_ rc additional_headersdataz.soapenv:Body/mt:deployResponse/mt:result/mt:idNz1soapenv:Body/mt:deployResponse/mt:result/mt:stater' )getri _read_deploy_ziprZ lowerr formatr rb r_ rc ET
fromstringtextfindtext_XML_NAMESPACES)r& r} r~ r: r r r r r r r r r r r
attributes
test_level tests_tagtestrequestrc r6 async_process_idstater' r' r( r sz
zSfdcMetadataApi.deployc C s@ t | drt | dr| d | }nt| }t| S )zY
:param zipfile:
:type zipfile:
:return:
:rtype:
rG seekr )hasattrr rG r
read_bytesr decode)r} rawr' r' r( r \ s
z SfdcMetadataApi._read_deploy_zipr c
K s | dd}|| j|dd}tjdi |}ddd}t| jd | d | j| j||d
}t |j
}| d | j } | d u rEt
d
|j
| S )z Retrieves status for specified deployment id
:param async_process_id:
:type async_process_id:
:param kwargs:
:type kwargs:
:return:
:rtype:
r r true)r rh asyncProcessIdincludeDetailsr checkDeployStatusz Content-typer deployRequest/r r z3soapenv:Body/mt:checkDeployStatusResponse/mt:resultN Result node could not be found: r' )r ri r r r rb r_ rc r r r findr r4 )
r& r r: r r
mt_requestrc resrootr6 r' r' r( _retrieve_deploy_resultm s2 z'SfdcMetadataApi._retrieve_deploy_resultvaluec C s zt | W S ty Y dS w )zGet component error countsr )int
ValueError)r r' r' r( get_component_error_count s
z)SfdcMetadataApi.get_component_error_countc
K s | j |fi |}|dd| jpd}|dd| jp d}g }g }| |dd| j}|dks4|dkr|d| j} | D ],}
||
d d| jpJd|
d
d| jpSd|
d d| jp\d|
d d| jpedd
q=|d| j} | D ],}
||
dd| jpd|
dd| jpd|
dd| jpd|
dd| jpdd qs|dd| jpd|dd| jpd|dd| jpd|d} |dd| jpd|dd| jpd|dd| jpd|d} ||| | fS )z
Checks whether deployment succeeded
:param async_process_id:
:type async_process_id:
:param kwargs:
:type kwargs:
:return:
:rtype:
mt:statusNzmt:stateDetailzmt:numberComponentErrorsr, Failedr z mt:details/mt:componentFailureszmt:componentType mt:fileNamezmt:problemType
mt:problem)typefilestatusr3 z'mt:details/mt:runTestResult/mt:failureszmt:namez
mt:methodNamez
mt:messagez
mt:stackTrace)classr r3 stack_tracezmt:numberComponentsTotalzmt:numberComponentsDeployed) total_count failed_countdeployed_countr1 zmt:numberTestsTotalzmt:numberTestErrorszmt:numberTestsCompleted)r r completed_countr1 )r r r r findallappend)
r& r r: r6 r state_detailunit_test_errorsdeployment_errorsr failuresfailuredeployment_detailunit_test_detailr' r' r( check_deploy_status s
z#SfdcMetadataApi.check_deploy_statusNc C s$ | |}tdtj|ddd dS )zQ Downloads Apex logs for unit tests executed during specified
deployment z response:zus-asciixml)encodingr N)r printr tostring)r& r r6 r' r' r( download_unit_test_logs s
z'SfdcMetadataApi.download_unit_test_logsc K s4 | dd}| dd}t|tstdd}| drR| di D ]/}t| dtrN| di | }|d7 }|D ]
}|d | d
7 }q:|d | d 7 }q"td
|| j| j||d} tjdi | }
ddd} t | j
d | d| j | j | |
d} t
| jdd| jpd}
t
| jdd| jpd}|
|fS )z Submits retrieve request r r single_packageTzsingle_package must be boolr,
unpackagedzz z
zzz(unpackaged metadata types must be a dict)r rh
apiVersionr r r retriever r r r z0soapenv:Body/mt:retrieveResponse/mt:result/mt:idNz3soapenv:Body/mt:retrieveResponse/mt:result/mt:stater' )r
isinstancebool TypeErrordictri rk r r r rb r_ rc r r r r r )r& r r: r r r
metadata_typemembersmemberr r rc r async_process_id_r r' r' r( r sZ
zSfdcMetadataApi.retrieve include_zipc K s | dd}|| j||d}tjd
i |}ddd}t| jd | d| j| j||d }t |j
} | d
| j }
|
d u rEt
d |j
|
S )z- Retrieves status for specified retrieval id r r )r rh r
includeZipr checkRetrieveStatusr r r r z5soapenv:Body/mt:checkRetrieveStatusResponse/mt:resultNr r' )r ri r r r rb r_ rc r r r r r r4 ) r& r r r: r r r rc r r r6 r' r' r( retrieve_retrieve_result6 s2 z(SfdcMetadataApi.retrieve_retrieve_resultc K s | j |dfi |}|dd| jpd}|dd| j}g }|d| j}|D ]}||dd| jp4d|dd| jp=dd q'|d d| jpKd} t| }
||||
fS )
z Retrieves ZIP file r r Nmt:errorMessagemt:details/mt:messagesr r r r3 z
mt:zipFile)r r r r r r ) r& r r: r6 r
error_messagemessages message_listr3 zipfile_base64r} r' r' r( retrieve_zipX s:
z SfdcMetadataApi.retrieve_zipc K s | j |dfi |}|dd| jpd}|dd| j}g }|d| j}|D ]}||dd| jp4d|dd| jp=dd q'|||fS ) z$ Checks whether retrieval succeeded falser Nr r r r r )r r r r r ) r& r r: r6 r r r r r3 r' r' r( check_retrieve_statusx s.
z%SfdcMetadataApi.check_retrieve_status)&rV rW rX rY _METADATA_API_BASE_URIr requestsSessionrZ r r r) r rw r ry r r| r
r bytesr r r r[ r r r r r r
r r r r r r r r' r' r' r( r\ s
M
*
W
9
""
$r\ )(rY base64r r pathlibr typingr r r r r
r r r
xml.etreer r xml.etree.ElementTreer r
zeep.proxyr zeep.xsdr r r utilr r r r r r r zeepr r r r\ r' r' r' r( s ( 2