cQdZddlmZddlmZddlmZddlZddlmZddl m Z ddl m Z dd l m Z dd l mZddlZej j#Dcgc]}ej%|c}ZGd d e j(ZGd deZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGdd eZGd!d"ej@ejBZ"Gd#d$e#Z$Gd%d&e#Z%Gd'd(e%Z&ycc}w))z4Utility for retrieving and parsing the Resource Map.)absolute_import)division)unicode_literalsN)base) exceptions)yaml)yaml_validator)filesceZdZdZy)ResourceMapErrorzGeneral Purpose Exception.N)__name__ __module__ __qualname____doc__8lib/googlecloudsdk/command_lib/util/resource_map/base.pyr r #s"rr c"eZdZdZfdZxZS)ResourceMapInitializationErrorzGException for when an error occurs while initializing the resource map.cJtt| dj|y)Nz+Error while initializing resource map: [{}])superr__init__format)self init_error __class__s rrz'ResourceMapInitializationError.__init__*s& ( ;;A6*;MOrr rrrr __classcell__rs@rrr'sOOOrrc"eZdZdZfdZxZS)PrivateAttributeNotFoundErrorzFException for when a private attribute that doesn't exist is accessed.cLtt| dj||y)Nz*[{}] does not have private attribute [{}].)rr!rr)r data_wrapperattribute_namers rrz&PrivateAttributeNotFoundError.__init__3s) ' ELLN,-rrrs@rr!r!0sN--rr!c"eZdZdZfdZxZS)ApiNotFoundErrorz@rrrs@rr=r=bsO@@rr=c"eZdZdZfdZxZS)MetadataAlreadyExistsErrorr7cLtt| dj||y)Nz.[{}] metadata already exists in [{}] Resource.)rrBrrr9s rrz#MetadataAlreadyExistsError.__init__os& $d48?? M +,rrrs@rrBrBlr;rrBc"eZdZdZfdZxZS)UnwrappedDataExceptionz6Exception for when unwrapped data is added to the map.cLtt| dj||y)NzhThe following data must be wrapped in a(n) {}Data wrapper prior to being added to the resource map: [{}])rrErr)r field_typedatars rrzUnwrappedDataException.__init__xs$ $0 0  D !#rrrs@rrErEus>##rrEceZdZdZdZdZdZdZdZe jdZ dZ dd Z d Zd Zd ZdZdZdZdZddZy )ResourceMapBaseaBase data wrapper class for Resource Map metadata yaml files. This object loads the relevant resource map file upon instantiation and sets the parsed dictionary as the internal attribute _resource_map_data. Underlying dictionary data is never interacted with directly, and is instead is set/retrieved/interacted with via an ApiData wrapper object. Attributes: _resource_map_data: Dict containing metadata for each resource in each api. cnd|_d|_|ji|_|j yN)_map_file_path_schema_file_path_register_paths_resource_map_data_load_resource_maprs rrzResourceMapBase.__init__s2D!D Drc^|jdr td||j|S)z5Returns underlying API data when accessing attribute._ ResourceMap) startswithr!get_apirr)s r __getattr__zResourceMapBase.__getattr__s,3 )- BB << !!rc||jvS)z;Returns True if api_name exists in self._resource_map_data.rPrXs r __contains__zResourceMapBase.__contains__s t.. ..rc#vKtj|jD]\}}t||yw)zBYields ApiData wrapper objects for each API in _resource_map_data.N)six iteritemsrPApiDatarr)api_datas r__iter__zResourceMapBase.__iter__s2!mmD,C,CD( Hh ''Es79cD|j|jk(SrLto_dictrothers r__eq__zResourceMapBase.__eq__ <<>U]]_ ,,rcy)zMust be overridden by child classes to register map and schema paths. Must explicitly set self._map_file_path and self._schema_file_path to appropriate filepaths in the overridden method of the child class. NrrRs rrOzResourceMapBase._register_pathss rc tj|j5}tj||_ddd|j si|_yy#1swYxYw#tj $r}t|d}~wwxYw)z@Loads the ~/resource_map.yaml file into self._resource_map_data.N)r FileReaderrMrloadrPMissingFileErrorr)rferrs rrQz"ResourceMapBase._load_resource_mapss0   D// 0A"&))A, 1  $ $"$% 1 0  ! !0 *3 //0s-A%AA%A"A%%B8 BBNcL |r|j|r|jtj|xs |j5}t j |j|dddy#1swYyxYw#tj$r}t|d}~wwxYw)zBPrunes and exports self._resource_map_data to ~/resource_map.yaml.)streamN) prune_validate_resource_mapr FileWriterrMrdumprPror)r file_pathrtvalidaterprqs r_export_resource_mapz$ResourceMapBase._export_resource_maps}0   ##%   I<)<)< = $))!4 > = =  ! !0 *3 //0s6AB "A4+B4A=9B=BB# BB#cttj|jj|jy)z:Validates resource map against ~/resource_map_schema.yaml.N)r ValidatorrNValidaterPrRs rruz&ResourceMapBase._validate_resource_maps*T334== !rc|jSrLr[rRs rrfzResourceMapBase.to_dicts  " ""rcDt|D]}|jy)aPrunes the resource map, removing redundant metadata values in the map. Calls prune() on each ApiData wrapper object, which in turn calls prune() on each underlying resource. Pruning each resource will remove any instances of a track-specific metadata field being set to the same value as the parent resource metadata field, eliminating any redundancies and keeping the map as clean as possible. Niterrtrrbs rrtzResourceMapBase.prunesJnnrcf||jvr t|t||j|S)z2Returns the api data wrapped in an ApiData object.)rPr&r`rXs rrWzResourceMapBase.get_apis3t... X && 8T44X> ??rct|ts td||j|jvrt |j|jj |jy)aHAdds an api to the resource map. Args: api_data: Data for api being added. Must be wrapped in an ApiData object. Raises: ApiAlreadyExistsError: API already exists in resource map. UnwrappedDataException: API data attempting to be added without being wrapped in an ApiData wrapper object. ApiN) isinstancer`rE get_api_namerPr+updaterfrs radd_apizResourceMapBase.add_apisc h ( "5( 33    D$;$; ; !("7"7"9 :: $$X%5%5%78rct|ts td||j|jvrt |j|jj |jy)a`Updates an API's data with the provided api data. Args: api_data: API Data to update the api with. Must be provided as an ApiData object. Raises: ApiNotFoundError: Api to be updated does not exist. UnwrappedDataException: API data attempting to be added without being wrapped in an ApiData wrapper object. rN)rr`rErrPr&rrfrs r update_apizResourceMapBase.update_apisc h ( "5( 33d&=&== X224 55 $$X%5%5%78rcP||jvr t||j|=y)z%Removes an API from the resource map.N)rPr&rXs r remove_apizResourceMapBase.remove_apis)t... X && )rc&|j|y)z-Public method to export resource map to file.N)rz)rrxs rexportzResourceMapBase.export si(r)NFTrL)r rrrrrYr\rcriabcabstractmethodrOrQrzrurfrtrWrrrrrrrrJrJsm " /( -  0 0! # @ 9$9&* )rrJcfeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZddZdZy)r`zData wrapper for an API object in the Resource Map metadata file. Attributes: _api_name: Name of the API. _api_data: Dict of resources and associated metadata constituting the api. c ||_||_yrL) _api_name _api_dataras rrzApiData.__init__sDNDNrc|jdr td|t||j|j|S)zGReturns the specified resource's data wrapped in a ResourceData object.rTr`)rVr! ResourceDatarrrr1s rrYzApiData.__getattr__s>$ ))] CC  t~~}5 77rc||jvSrL)rrs rr\zApiData.__contains__!s DNN **rc#K|jjD]\}}t||j| yw)zGYields ResourceData wrapper objects for each API in _resource_map_data.N)ritemsrr)rr1 resource_datas rrczApiData.__iter__$s5(,(<(<(>$ }  FF)?s=?c,t|jSrL)reprrrRs r__repr__zApiData.__repr__)s  rcD|j|jk(SrLrergs rrizApiData.__eq__,rjrcHtj|jSrL)r^ text_typerfrRs rto_strzApiData.to_str/s == ((rc:|j|jiSrL)rrrRs rrfzApiData.to_dict2s     00rc@tj|jSrL)r^rrrRs rrzApiData.get_api_name5s == ((rc|||jvr t|t||j|j|S)zEReturns the data for the specified resource in a ResourceData object.)rr/rrrs r get_resourcezApiData.get_resource8s:DNN* !- 00  t~~}5 77rct|ts td||j|jvrt |j|jj |jyNResource)rrrEget_resource_namerr3rrfrrs r add_resourcezApiData.add_resource?s] m\ 2 ":} ==  ( ( *dnn < &}'F'F'H II nnM1134rct|ts td||j|jvrt |j|jj |jyr)rrrErrr/rrfrs rupdate_resourcezApiData.update_resourceGs] m\ 2 ":} ==  ( ( *$.. @ !-"A"A"C DD nnM1134rcT|r||jvr t||j|=yrL)rr/)rr1 must_exists rremove_resourcezApiData.remove_resourceOs'm4>>9 !- 00 }%rcDt|D]}|jyrLrrs rrtz ApiData.pruneTsd $rN)T)r rrrrrYr\rcrrirrfrrrrrrtrrrr`r`sN7+G  -)1)755& rr`c|eZdZdZdZdZfdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZxZS)rzData wrapper for a Resource object in the ResourceMap metadata file. Attributes: _resource_name: Name of the resource. _api_name: Name of the parent api. _resource_data: Metadata for the resource. c.||_||_||_yrL)_resource_namer_resource_data)rr1r)rs rrzResourceData.__init__bs'DDN'Drc|tvr|j|S|jdr td||j |S)aIReturns metadata value or TrackLevelResourceData object. Attribute being accessed will be either a metadata field for the resource, or the release track (GA, BETA, or ALPHA). If the attribute is a metadata field the appropriate value will be returned from self._resource_data. If the atatribute is a release track, a TrackLevelResourceData object will be returned. This enables both of the following usecases: `value = map.api.resource.metadata_field` OR 'value = map.api.resource.ALPHA.metadata_field` Args: metadata_field: Field or release track being accessed Returns: Metadata field value OR TrackLevelResourceData object. Raises: MetadataNotFoundError: Metadata field does not exist. PrivateAttributeNotFoundError: Private attribute doesn't exist in object. rTr)_RELEASE_TRACKSget_release_track_datarVr! get_metadatarr:s rrYzResourceData.__getattr__gsI.(  ( ( 88  " "3 ' ).. II   ~ ..rc|jdrtt|||y||jvr|j ||y|j ||y)aSets the specified metadata field to the provided value. If the object is not yet instantiated, then standard __setattr__ behavior is observed, allowing for proper object instantiation. After initialization, the specified metadata field within self._resource_data is set to the provided value Args: metadata_field: Metadata field to set the value for. value: Value to set the specified metadata field to. Returns: True rTN)rVrr __setattr__r add_metadataupdate_metadatarr:valuers rrzResourceData.__setattr__sR   % L$+NEB t22 2 . >51rcD|j|jk(SrLrergs rrizResourceData.__eq__rjrc$|j|SrL)has_metadata_fieldrs rr\zResourceData.__contains__s  " "> 22rctD]v}||jvs|j|}t|jD]*}||jvs|j|||k(s(||=,|rj|j|=xy)zDRemoves any redundant metadata specifications between track and top.N)rrlistkeys)rtracktrack_resource_datakeys rrtzResourceData.prunes  $%% %"11%8+0023C D'' 'D,?,?-)#.-/#C(4 #!!%(!rc:|j|jiSrL)rrrRs rrfzResourceData.to_dicts  " " $d&9&9 ::rc||jvSrL)rrs rrzResourceData.has_metadata_fields T00 00rc|jSrL)rrRs rrzResourceData.get_resource_names   rc|jSrL)rrRs rrzResourceData.get_api_names >>rc^dj|j|jS)Nz{}.{})rrrrRs rget_full_collection_namez%ResourceData.get_full_collection_names% >>$++-t/E/E/G HHrch||jvrt|j||j|SrLrr6rrs rrzResourceData.get_metadatas4T000 !$"5"5~ FF   ~ ..rc\t|j|j|j|S)Nr)TrackLevelResourceDatarrrr release_tracks rrz#ResourceData.get_release_track_datas+ !     rcj||jvrt|j|||j|<yrL)rrBrrr:rs rrzResourceData.add_metadatas3,,, &t':':N KK,1d.)rcj||jvrt|j|||j|<yrLrrs rrzResourceData.update_metadatas3T000 !$"5"5~ FF,1d.)rcf||jvrt|j||j|=yrLrrs rremove_metadatazResourceData.remove_metadatas1T000 !$"5"5~ FF   n -r)r rrrrrYrrir\rtrfrrrrrrrrrrrs@rrrYsY( /<2.-3 );1I/ 2 2 .rrc\eZdZdZfdZdZfdZdZdZdZ dZ d Z d Z d Z xZS) ra-Data wrapper for track-specific resource metadata. This data wrapper represents the metadata for a specific release track of a resource. Retrieval of metadata will first check for a track level specification of the metadata, and if not found will then retrieve the top level metadata value. Attributes: _resource_name: Name of the resource. _api_name: Name of the parent api. _resource_data: Metadata for the resource. _track: Release track for the resource. _track_resource_data: Track specific metadata for the resource. c||_|j|ji|_tt||||yrL)_trackget_track_resource_datarrr)rr1r)rrrs rrzTrackLevelResourceData.__init__s;DK - 1 1$++r BD $01>@rc^|jdr td||j|S)aRRetrieves the track-specific metadata value for the resource. If the specified release track does not have a specified value, the parent metadata field value for the resource will be returned. Args: metadata_field: Metadata field value to retrieve Returns: Metadata field value for the specified release track-specific or the parent metadata field. Raises: MetadataNotFoundError: Metadata field value wasn't found for the specific track or for the parent. PrivateAttributeNotFoundError: Private attribute doesn't exist in object. rTr)rVr!rrs rrYz"TrackLevelResourceData.__getattr__s8$  % )*B*8 ::  ~ ..rc|jdrtt|||y||jvr|j ||S|j ||S)aSets the specified metadata field to the provided value. If the object is not yet instantiated, then standard __setattr__ behavior is observed, allowing for proper object intitialization. After initialization, the specified metadata field for the release track is set to the provided value. Args: metadata_field: Metadata field to set the value for. value: Value to set the specified metadata field to. Returns: True rTN)rVrrrrrrrs rrz"TrackLevelResourceData.__setattr__ sY   % "D5neL 444 4##NE::  77rc2|j|jiSrL)rrrRs rrfzTrackLevelResourceData.to_dict$s   !4!4 55rc||jvr|j|S||jvr|j|St|j|rL)rrr6rrs rrz#TrackLevelResourceData.get_metadata'sS222  & &~ 66 4.. .   00 !$"5"5~ FFrcj||jvrt|j|||j|<yrL)rrBrrs rrz#TrackLevelResourceData.add_metadata/s3222 &t':':N KK27d/rcj||jvrt|j|||j|<yrLrr6rrs rrz&TrackLevelResourceData.update_metadata5s3T666 !$"5"5~ FF27d/rcf||jvrt|j||j|=yrLrrs rrz&TrackLevelResourceData.remove_metadata;s1T666 !$"5"5~ FF  # #N 3rc|jSrL)rrRs rget_release_trackz(TrackLevelResourceData.get_release_trackAs ;;rc.t||jrL)r=rrs rrz-TrackLevelResourceData.get_release_track_dataDs -mT[[ IIr)r rrrrrYrrfrrrrrrrrs@rrrs= @ /0806G8 8 4 Jrr)'r __future__rrrrgooglecloudsdk.callioper calliope_basegooglecloudsdk.corerrr googlecloudsdk.core.utilr r^ ReleaseTrack AllValuesrrErrorr rr!r&r+r/r3r6r=rBrEwith_metaclassABCMetarJobjectr`rrrs0rrsQ;&' 9*$.* '4&@&@&J&J&L&LUCMM%&L #z''#O%5O-$4-P'PD,DI,ID!1D,,,@*:@,!1,#-#L)(c((5L)^HfHVB.6B.JgJ\gJAsD<