a f!᳤@sPddlZddlZddlZddlZddlZddlmZddlmZddlm Z ddlm Z ddlm Z ddl m Zdd l mZd d lmZd d lmZd d lmZeeZdddddddddddddd ZdZdZdZdjedZdjedZdZd d!jeed"!Z"e j#de d#d$d%Z$e j#d&e d#d'd(Z%e j#d)e d*d+d,Z&d-d.Z'd/d0Z(d1d2Z)d3d4Z*d5d6Z+d7d8Z,d9d:Z-d;d<Z.d=d>Z/d?d@Z0dAdBZ1dCdDZ2dEdFZ3dGdHZ4dIdJZ5dKdLZ6dMdNZ7dOdPZ8dQdRZ9dSdTZ:dUdVZ;dWdXZd]d^Z?d_d`Z@dadbZAdcddZBdedfZCdgdhZDdidjZEdkdlZFdS)mN) split_port)Draft4Validator) FormatChecker) RefResolver)ValidationError)COMPOSEFILE_V1)NANOCPUS_SCALEConfigurationError)VERSION_EXPLANATION)"get_service_name_from_network_modeZ cpu_sharesZ extra_hostsZdeviceslinksZ memswap_limitportsZ privilegedvolumesZ working_dir) Z cpu_shareZadd_hostZhostsZ extra_hostZdevicelinkZ memory_swapportZ privilegeZ priviligedZ priviligeZvolumeZworkdirz[a-zA-Z0-9\._\-]z^\d+(\-\d+)?(\/[a-zA-Z]+)?$z!(\d{1,2}|1\d{2}|2[0-4]\d|25[0-5])z({IPV4_SEG}\.){{3}}{IPV4_SEG})ZIPV4_SEGz!^{IPV4_ADDR}/(\d|[1-2]\d|3[0-2])$) IPV4_ADDRz[0-9a-fA-F]{1,4}a9 ^ ( (({IPV6_SEG}:){{7}}{IPV6_SEG})| (({IPV6_SEG}:){{1,7}}:)| (({IPV6_SEG}:){{1,6}}(:{IPV6_SEG}){{1,1}})| (({IPV6_SEG}:){{1,5}}(:{IPV6_SEG}){{1,2}})| (({IPV6_SEG}:){{1,4}}(:{IPV6_SEG}){{1,3}})| (({IPV6_SEG}:){{1,3}}(:{IPV6_SEG}){{1,4}})| (({IPV6_SEG}:){{1,2}}(:{IPV6_SEG}){{1,5}})| (({IPV6_SEG}:){{1,1}}(:{IPV6_SEG}){{1,6}})| (:((:{IPV6_SEG}){{1,7}}|:))| (fe80:(:{IPV6_SEG}){{0,4}}%[0-9a-zA-Z]{{1,}})| (::(ffff(:0{{1,4}}){{0,1}}:){{0,1}}{IPV4_ADDR})| (({IPV6_SEG}:){{1,4}}:{IPV4_ADDR}) ) /(\d|[1-9]\d|1[0-1]\d|12[0-8]) $ )ZIPV6_SEGr)formatraisesc CsBz t|Wn0ty<}ztt|WYd}~n d}~00dS)NT)r ValueErrorrstr)instanceer=/usr/lib/python3.9/site-packages/compose/config/validation.py format_portsEs  "rexposecCs"t|trtt|stddS)Nz)should be of the format 'PORT[/PROTOCOL]'T) isinstancerrematchVALID_EXPOSE_FORMATrrrrr format_exposeNs   r%subnet_ip_address)rcCs.t|tr*tt|s*tt|s*tddS)Nzshould use the CIDR formatT)r rr!r"VALID_REGEX_IPV4_CIDRVALID_REGEX_IPV6_CIDRrr$rrrformat_subnet_ip_addressXs    r)cCsD|dg}|D].}|jr|j|vrtd||dqdS)Nrz^Named volume "{}" is used in service "{}" but no declaration was found in the volumes section.name)getZis_named_volumeZexternalr rrepr)Z service_dictZproject_volumesZservice_volumesZ volume_specrrrmatch_named_volumesbs r-c Cs(t|j}ddddddddd||S)NmappingZarrayZnumberZbooleanstring)dictlistintfloatboolZunicoderbytes)type__name__r+)type_ type_namerrrpython_type_to_yaml_typens  r:c Cst|ts&tdj||tt|d|D]V\}}t|tsTtdj|||dt|ttdfs.tdj|||tt|dq.dS)zValidate the structure of a configuration section. This must be done before interpolation so it's separate from schema validation. z>In file '{filename}', {section} must be a mapping, not {type}.)filenamesectionr6zWIn file '{filename}', the {section} name {name} must be a quoted string, i.e. '{name}'.)r;r<r*NzFIn file '{filename}', {section} '{name}' must be a mapping not {type}.)r;r<r*r6) r r0r ranglicize_json_typer:itemsrr6)r;configr<keyvaluerrrvalidate_config_section|s4    rBcCs(t|jts$td|jt|jdS)Nz8Top level object in '{}' needs to be an object not '{}'.)r r?r0r rr;r6) config_filerrrvalidate_top_level_objects rDcCsP|jdi}|D]4\}}t|tr|d|dkstdj||dqdS)NZulimitsZsoftZhardzdService '{s.name}' has invalid ulimit '{ulimit}'. 'soft' value can not be greater than 'hard' value )sZulimit)r?r+r>r r0r r)service_configZ ulimit_configZ limit_nameZsoft_hard_valuesrrrvalidate_ulimitss rGcCs(d|}d|vr$|dur$td|dS)zo The service to be extended must either be defined in the config key 'file', or within 'filename'. z'Invalid 'extends' configuration for %s:fileNz;%s you need to specify a 'file', e.g. 'file: something.yml'r ) service_nameZextends_optionsr;Z error_prefixrrrvalidate_extends_file_paths rJcCsT|jd}|sdSd|jvr&tdt|}|s6dS||vrPtdj||ddS)N network_modeZnetworksz0'network_mode' and 'networks' cannot be combinedzPService '{s.name}' uses the network stack of service '{dep}' which is undefined.rEZdep)r?r+r rr)rF service_namesrK dependencyrrrvalidate_network_modes  rOcCsB|jd}|sdSt|}|s$dS||vr>tdj||ddS)NpidzPService '{s.name}' uses the PID namespace of service '{dep}' which is undefined.rLr?r+rr r)rFrMZpid_moderNrrrvalidate_pid_modes rRcCsB|jd}|sdSt|}|s$dS||vr>tdj||ddS)NZipczPService '{s.name}' uses the IPC namespace of service '{dep}' which is undefined.rLrQ)rFrMZipc_moderNrrrvalidate_ipc_modes rScCs<|jdgD](}|dd|vrtdj||dqdS)Nr:rzEService '{s.name}' has a link to service '{link}' which is undefined.)rEr)r?r+splitr r)rFrMrrrrvalidate_linkssrVcCs:|jdi}|D]}||vrtdj||dqdS)NZ depends_onzAService '{s.name}' depends on service '{dep}' which is undefined.rL)r?r+keysr r)rFrMZdepsrNrrrvalidate_depends_ons rXcCs8|jd}|sdSd|vr4d|vr4tdj|ddS)Ncredential_specregistryrHzQService '{s.name}' is missing 'credential_spec.file' or credential_spec.registry')rE)r?r+r r)rFrYrrrvalidate_credential_specs r[cCs.dt||}|tvr*|dt|7}|S)Nz&Unsupported config option for {}: '{}'z (did you mean '{}'?))r path_stringDOCKER_CONFIG_HINTS)pathZ error_keymsgrrrget_unsupported_config_msg sr`cCs|drd|Sd|S)N)ariouzan za ) startswith)Z json_typerrrr=s r=cCs|dvS)N)zconfig_schema_v1.jsonz#/properties/servicesr) schema_idrrris_service_dict_schemasrgcCs|jd}t|r<|jdkr"z..)anyfilter).0rbrrr !sz3handle_error_for_schema_with_id..rz#/definitions/serviceZconfig_schema_zInvalid top-level property "{key}". Valid top-level sections for this Compose file are: {properties}, and extensions starting with "x-". {explanation}, properties)r@rtZ explanationz{} {})schemarg validatorrr1rrkparse_key_from_error_msgr`rejoinrWr r^message)errorr^rfinvalid_config_keyrrrhandle_error_for_schema_with_ids*    r|cCsd}|j}|jdkr4d}t|\}}|r||n|jdkrNd}t|j}n|jdkrjd|j}d}nh|jdkrt|jd }d |j|}d }||d ||}n |j rt |j }d }n |j rd }|r|j t ||dS|jS)NoneOfz {path} {msg}r6z3{path} contains an invalid type, it should be {msg}requiredrsz%{path} is invalid, {msg} is required.Z dependenciesr,z{path} is invalid: {msg}z,when defining '{}' you must set '{}' as wellz{path} value {msg})r^r_)ryrv_parse_oneof_validatorappend!_parse_valid_types_from_validatorvalidator_valuerxr1rWrcauserr^r\)rzr^Z msg_format error_msgZ config_key required_keysrrrhandle_generic_error:s<          rcCsJz|jddWStyD|jdddddYS0dS)N'r ( r)ryrU IndexErrorstrip)rzrrrrwcs rwcCsddd|DS)N.css|]}t|tr|VqdSrj)r r)rqrlrrr krnzpath_string..)rx)r^rrrr\jsr\cCsZt|tst|St|dkr*t|dSddt|dg|ddt|dS)zA validator value can be either an array of valid types or a string of a valid type. Parse the valid types and prefix with the correct article. r rz {}, or {}rs)r r1r=lenrrx)rvrrrrns    rcCsg}|jD]}|jdkr6t|\}}t|j|fS|jdkrNd|jfS|jdkrrt|}dd|fS|jdkr|jrt|jndd|jfS|jrt|jdt |jt |j fS|jd kr | |j q t |}dd |fS) aoneOf has multiple schemas, so we need to reason about which schema, sub schema or constraint the validation is failing on. Inspecting the context value of a ValidationError gives us information about which sub schema failed and which kind of error it is. r}r~Nriz!contains unsupported option: '{}'Z uniqueItemsz;contains non-unique items, please remove duplicates from {}z6contains {}, which is an invalid type, it should be {}r6z)contains an invalid type, it should be {})contextrvrr\r^ryrwrrjsondumpsrrr)rztypesr_rr{Z valid_typesrrrr}s6        rcCsf|tkrDd|jvr&d|jvr&d|Sd|jvrDd|jvrDd|Sd|jvrbd|jvrbd|SdS)NZimageZbuildzService {} has both an image and build path specified. A service can either be built to image or use an existing image, not both.Z dockerfilezService {} has both an image and alternate Dockerfile. A service can either be built to image or use an existing image, not both.z]Service {} has neither an image nor a build context specified. At least one must be provided.)V1rr)rzrIversionrrr!process_service_constraint_errorss rcCs0t|j}d|jvr&t||}|r&|St||S)Nrh)r1r^rur|r)rzr^rrrrprocess_config_schema_errorss    rcCs@i}|D].\}}||t|<t|tr t||t|<q |S)zH Non-string keys may break validator with patterned fields. )r>rr r0 keys_to_str)rCdkvrrrrs   rcCsLt|}t|j}tgd}t|tt||d}t||t |j dS)N)rrr&)Zresolverformat_checker) load_jsonschemarr?rrrget_resolver_path handle_errors iter_errorsrr;)rCrrur?rrvrrrvalidate_against_config_schemas   rcsBfdd}tj}t|ddd}t|||ddS)Ncst|jSrj)rr)errorsrCrIrrhandlersz-validate_service_constraints..handlerZ definitions constraintsZservice)rrrrr)r?rIrCrrurvrrrvalidate_service_constraintss rcCs:|jd}|sdS|t}t|tr6|s6tddS)Ncpusz6cpus must have nine or less digits after decimal point)r?r+r r r3 is_integerr )rFrZ nano_cpusrrr validate_cpus rcCstjtjtSrj)osr^dirnameabspath__file__rrrrget_schema_pathsrcCsxd}|tkrd}tjtd|}tj|sBtd|tt |}t |WdS1sj0YdS)NZ compose_specZconfig_schema_v1z{}.jsonz"Version in "{}" is unsupported. {}) rrr^rxrrexistsr r openrload)rr*r;Zfhrrrrs  rcCs2t}tjdkr"d}|dd}nd}d||S)Nwin32z///\/z//z file:{}{}/)rsysplatformreplacer)Z schema_pathschemerrrr s  rcsPt|td}|sdSdfdd|D}tdj|r@d|nd|d dS) zjsonschema returns an error tree full of information to explain what has gone wrong. Process each error and pull out relevant information and re-write helpful error messages that are relevant. )r@N c3s|]}|VqdSrjr)rqrzformat_error_funcrrrrnz handle_errors..z:The Compose file{file_msg} is invalid because: {error_msg}z '{}'r)Zfile_msgr)sortedrrxr r)rrr;rrrrrs rcCs|jdi}d|vrt|dtrt|ddkrFtd|jnN|dddkrtt|dkrttd|jn |dddvrtd |jdS) N healthchecktestrzDService "{}" defines an invalid healthcheck: "test" is an empty listNONEr zbService "{}" defines an invalid healthcheck: "disable: true" cannot be combined with other options)rZCMDz CMD-SHELLzwService "{}" defines an invalid healthcheck: when "test" is a list the first item must be either NONE, CMD or CMD-SHELL)r?r+r r1rr rr*)rFrrrrvalidate_healthcheck$s(r)GrZloggingrr!rZdocker.utils.portsrZ jsonschemarrrrconstrrr rr r Z sort_servicesrZ getLoggerr7logr]rkr#ZVALID_IPV4_SEGrZVALID_IPV4_ADDRr'ZVALID_IPV6_SEGrxrUr(Z cls_checksrr%r)r-r:rBrDrGrJrOrRrSrVrXr[r`r=rgr|rrwr\rrrrrrrrrrrrrrrrrs                        ))