o !d@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl mZddlmZmZddlmZddlmZddlmZddlmZdd lmZdd lmZddlZdd lmZddl Z!dd l"m#Z#dd l m$Z$ddl!m%Z%ddlZej&rej'j(ej'_)ej*+Z,e-dZ.da/ddZ0ddZ1ddZ2ddZ3ddZ4e j5ddZ6dSddZ7ddZ8dTd"d#Z9Gd$d%d%ej'Z:Gd&d'd'e:Z;Gd(d)d)e<Z=Gd*d+d+e<Z>e j5d,d-Z?e j5dUd/d0Z@Gd1d2d2ej'ZAGd3d4d4eAZBGd5d6d6ej'ZCGd7d8d8e<ZDGd9d:d:eEZFGd;d<dZH  dVdAdBZIdCdDZJdEdFZKdGdHZLGdIdJdJej'ZMGdKdLdLeZNGdMdNdNe<ZOGdOdPdPeEZPGdQdRdRe<ZQdS)Wa^Test utilities for the AWS CLI. This module includes various classes/functions that help in writing CLI unit/integration tests. This module should not be imported by any module **except** for test code. This is included in the CLI package so that code that is not part of the CLI can still take advantage of all the testing utilities we provide. N)pformat)PopenPIPE)mock)StringIO)six)Session) ClientError) WaiterError) AWSResponse) load_plugins) CLIDriver)EnvironmentVariableszawscli.tests.integrationcsfdd}|S)zDecorator to skip tests that should not be run on windows. Example usage: @skip_if_windows("Not valid") def test_some_non_windows_stuff(self): self.assertEqual(...) csttdv|S)N)DarwinLinux)unittestZskipIfplatformsystem)funcreason4usr/lib/python3.10/site-packages/awscli/testutils.py decoratorPs  z"skip_if_windows..decoratorr)rrrrrskip_if_windowsFs rcCsFtj}|j}|dtj}|sg}tj || dt|S)N data_pathZ data_loader) awscliZ clidrivercreate_clidriversessionZget_config_variablesplitospathsep_LOADERZ search_pathsextendZregister_component)driverrrrrrrVs   rcCsbddl}tdur/tjtj|j}tj|dd}tj|s-t d}|dur-t d|atS)NrbinawszCould not find "aws" executable. Either make sure it is on your PATH, or you can explicitly set this value using "set_aws_cmd()") rAWS_CMDr pathdirnameabspath__file__joinisfile_search_path_for_cmd ValueError)rZ repo_rootaws_cmdrrr get_aws_cmdas r1cCsBtjddtjD]}tj||}tj|r|Sq dS)NPATH)r environgetrr!r(r,r-)cmd_namer(Z full_cmd_pathrrrr.ss  r.cCs|adSN)r')r0rrr set_aws_cmd{sr8c cst}dttd}tj||}t|dz(t|| }|VWdn1s/wYWt |dSWt |dSt |w)afThis is a cross platform temporary file creation. tempfile.NamedTemporary file on windows creates a secure temp file that can't be read by other processes and can't be opened a second time. For tests, we generally *want* them to be read multiple times. The test fixture writes the temp file contents, the test reads the temp file. z tmpfile-%swN) tempfilemkdtempstr random_charsr r(r,opencloseshutilrmtree)modeZtemporary_directorybasenameZ full_filenamefrrrtemporary_files  rFc Cs|sd}|jd|d}|r|}nt}d|i}|dkr!d|i|d<z |jd i|W|StyK}z|jdd d kr?nWYd }~|Sd }~ww) zG Creates a bucket :returns: the name of the bucket created us-west-2s3Z region_nameBucket us-east-1ZLocationConstraintZCreateBucketConfigurationErrorCodeZBucketAlreadyOwnedByYouNr) create_clientrandom_bucket_name create_bucketr responser5)rnameregionclient bucket_nameparamserrrrPs(   rPcCsttt|ddS)zZReturns random hex characters. Useful for creating resources with random names. ascii)binasciihexlifyr urandomintdecode)Z num_charsrrrr>sr>awscli-s3integ-cCs |t|S)aGenerate a random S3 bucket name. :param prefix: A prefix to use in the bucket name. Useful for tracking resources. This default value makes it easy to see which buckets were created from CLI integ tests. :param num_random: Number of random chars to include in the bucket name. :returns: The name of a randomly generated bucket name as a string. )r>)prefixZ num_randomrrrrOs rOc@s eZdZdZddZddZdS)BaseCLIDriverTestzBase unittest that use clidriver. This will load all the default plugins as well so it will simulate the behavior the user will see. cCsHtjdddddd|_td|j|_|jt|_|jj|_dS)N AWS_DATA_PATHrK access_key secret_keyr3rcAWS_DEFAULT_REGIONAWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEYAWS_CONFIG_FILE os.environ) r r4rpatch environ_patchstartrr$rselfrrrsetUps zBaseCLIDriverTest.setUpcCs|jdSr7)rmstoprorrrtearDownzBaseCLIDriverTest.tearDownN)__name__ __module__ __qualname____doc__rqrsrrrrrbs rbcsHeZdZfddZfddZddZddZd d Zd d ZZ S) BaseAWSHelpOutputTestcs<tt|td|_|j|_t|_ |j |j_ dS)Nzawscli.help.get_renderer) superryrqrrlrenderer_patchrnZ renderer_mockCapturedRendererrenderer return_valuero __class__rrrqs   zBaseAWSHelpOutputTest.setUpcstt||jdSr7)rzryrsr{rrrorrrrsszBaseAWSHelpOutputTest.tearDowncCs*||jjvr|d||jjfdSdS)NzFThe expected contents: %s were not in the actual rendered contents: %sr}rendered_contentsfail)rpcontainsrrrassert_contains  z%BaseAWSHelpOutputTest.assert_containscCs8|jj|}||kr|d|||jj|fdSdS)NzkThe expected contents: %s , with the count: %d were not in the actual rendered contents: %s with count: %d)r}rcountr)rprrZr_countrrrassert_contains_with_counts  z0BaseAWSHelpOutputTest.assert_contains_with_countcCs*||jjvr|d||jjfdSdS)NzKThe contents: %s were not suppose to be in the actual rendered contents: %srrpcontentsrrrassert_not_containsrz)BaseAWSHelpOutputTest.assert_not_containscs|d}t|}|jj|||fdd|D}|d}t|dddD])\}}|dkrB|d||f||krV|d||||df|}q/dS) N starting_fromcsg|]}|qSr)find).0argrZ start_indexrr sz;BaseAWSHelpOutputTest.assert_text_order..rz/The string %r was not found in the contents: %szBThe string %r came before %r, but was suppose to come after it. %s)poplistr}rassertInr enumerater)rpargskwargsrZ arg_indicespreviousiindexrrrassert_text_orders$    z'BaseAWSHelpOutputTest.assert_text_order) rurvrwrqrsrrrr __classcell__rrrrrys  ryc@seZdZddZddZdS)r|cCs d|_dS)Nr3)rrorrr__init__s zCapturedRenderer.__init__cCs|d|_dS)Nutf-8)r^rrrrrrenderszCapturedRenderer.renderN)rurvrwrrrrrrr|s r|c@eZdZddZdS)CapturedOutputcCs||_||_dSr7)stdoutstderr)rprrrrrrs zCapturedOutput.__init__N)rurvrwrrrrrr rc cst}t}td|-td|t||VWdn1s'wYWddSWddS1s?wYdS)Nz sys.stderrz sys.stdout)rrrrlr)rrrrrcapture_output"s"rccs^t|}tjrt}||_n|}td| |VWddS1s(wYdS)Nz sys.stdin)rBytesIOPY3rMockbufferrl)Z input_bytes input_dataZ mock_objectrrr capture_input+s "rc@sXeZdZdZddZddZddZdd Zd d Z dd dZ ddZ dddZ dS)BaseAWSCommandParamsTestNcCsi|_d|_tjddddddd|_td|j|_|jtddid|_ i|_ td |_ d |_ g|_ d|_t|_dS) NrcrKrdrer3)rcrgrhrirjZAWS_SHARED_CREDENTIALS_FILErkz'botocore.endpoint.Endpoint.make_requestF) last_params last_kwargsr r4rrlrmrnr http_responseparsed_responsemake_request_patchmake_request_is_patchedoperations_calledparsed_responsesrr$rorrrrq;s$   zBaseAWSCommandParamsTest.setUpcC(|j|jr|jd|_dSdSNF)rmrrrrrorrrrsUs   z!BaseAWSCommandParamsTest.tearDowncKs||dSr7) _store_params)rprVrrrr before_call\rtz$BaseAWSCommandParamsTest.before_callcCs||_|d|_dS)Nbody)Zlast_request_dictr)rprVrrrr_sz&BaseAWSCommandParamsTest._store_paramscsRjr jd_j}jdurfdd|_njjf|_d_dS)NFcsjjdfSNr)rrr)rrrorrmsz=BaseAWSCommandParamsTest.patch_make_request..T) rrrrrnr side_effectrrr~)rprrrorpatch_make_requestcs    z+BaseAWSCommandParamsTest.patch_make_requestrc Cs|||\}}}|dur||||durEt|j} |dur4|D]} z| | =Wq#ty3Yq#w|| krE|dt|t| f|||fS)NzGActual params did not match expected params. Expected: %s Actual: %s )run_cmdrcopyrKeyErrorrr) rpcmdrV expected_rcZstderr_containsZ ignore_paramsrrrcrkeyrrrassert_params_for_cmdss$      z.BaseAWSCommandParamsTest.assert_params_for_cmdcKs||_|j||fdSr7)rrappendr)rprVmodelrrrrbefore_parameter_buildsz/BaseAWSCommandParamsTest.before_parameter_buildc Cstd|||jjd}|d|j|d|j t |t s)| }n|}t &}z|j|}WntyL}z |j}WYd}~nd}~wwWdn1sWwY|j}|j} |||d|||| |f| ||fS)NzCalling cmd: %s event_emitterz before-callzbefore-parameter-build.*.*MUnexpected rc (expected: %s, actual: %s) for command: %s stdout: %sstderr: %s)loggingdebugrr$r get_componentregisterrZregister_firstr isinstancerrrmain SystemExitcodergetvaluer assertEqual) rprrrcmdlistcapturedrrWrrrrrrs:      z BaseAWSCommandParamsTest.run_cmd)NrNNr) rurvrwZmaxDiffrqrsrrrrrrrrrrr8s rcs(eZdZfddZfddZZS)BaseAWSPreviewCommandParamsTestcs(td|_|jtt|dS)Nz-awscli.customizations.preview.mark_as_preview)rrl preview_patchrnrzrrqrorrrrqs  z%BaseAWSPreviewCommandParamsTest.setUpcs|jtt|dSr7)rrrrzrrsrorrrrs z(BaseAWSPreviewCommandParamsTest.tearDown)rurvrwrqrsrrrrrrs rc@s6eZdZddZddZdidfddZd d d Zd S)BaseCLIWireResponseTestcCsPtjdddddd|_td|j|_|jtd|_d |_t|_ dS) NrcrKrdrer3rfrkz botocore.endpoint.Endpoint._sendF) r r4rrlrmrn send_patchsend_is_patchedrr$rorrrrqs   zBaseCLIWireResponseTest.setUpcCrr)rmrrrrrorrrrss   z BaseCLIWireResponseTest.tearDownrrcCs<|jr |jd|_|j}tj|||d|_d|_dS)NF) status_codeheaderscontentT)rrrrrnrrr~)rprrrrrrr patch_sends   z"BaseCLIWireResponseTest.patch_sendrc Cst|ts |}n|}t&}z|j|}Wnty-}z |j}WYd}~nd}~wwWdn1s8wY|j }|j }| ||d|||||f|||fS)Nr) rrrrr$rrrrrrr) rprrrrrrWrrrrrrs,      zBaseCLIWireResponseTest.run_cmdNr)rurvrwrqrsrrrrrrrs  rc@s6eZdZddZddZd ddZd d Zd d ZdS) FileCreatorcCst|_dSr7)r;r<rootdirrorrrrrtzFileCreator.__init__cCs"tj|jrt|jdSdSr7)r r(existsrrArBrorrr remove_allszFileCreator.remove_allNr:cCstj|j|}tjtj|sttj|t|| }||Wdn1s0wYtj |}t |||df|durQt |||f|S)aCreates a file in a tmpdir ``filename`` should be a relative path, e.g. "foo/bar/baz.txt" It will be translated into a full path in a tmp dir. If the ``mtime`` argument is provided, then the file's mtime will be set to the provided value (must be an epoch time). Otherwise the mtime is left untouched. ``mode`` is the mode the file should be opened either as ``w`` or `wb``. Returns the full path to the file. Ni) r r(r,risdirr)makedirsr?writegetmtimeutime)rpfilenamermtimerC full_pathrEZ current_timerrr create_files   zFileCreator.create_filecCsptj|j|}tjtj|sttj|t|d}||Wd|S1s1wY|S)zAppend contents to a file ``filename`` should be a relative path, e.g. "foo/bar/baz.txt" It will be translated into a full path in a tmp dir. Returns the full path to the file. aN) r r(r,rrr)rr?r)rprrrrErrr append_files   zFileCreator.append_filecCstj|j|S)zzTranslate relative path to full path in temp dir. f.full_path('foo/bar.txt') -> /tmp/asdfasd/foo/bar.txt )r r(r,r)rprrrrr szFileCreator.full_path)Nr:)rurvrwrrrrrrrrrrs   rc@ eZdZdS)ProcessTerminatedErrorNrurvrwrrrrr(rc@s"eZdZdddZeddZdS)ResultNcCsL||_||_||_td|td|td||dur!g}||_dS)Nzrc: %sz stdout: %sz stderr: %s)rrr INTEG_LOGr memory_usage)rprrrrrrrr-s    zResult.__init__cCs t|jSr7)jsonloadsrrorrrr8s z Result.jsonr7)rurvrwrpropertyrrrrrr,s  rcCs|dd}|dd}|S)N"z\"')replace)commandrrr_escape_quotes=s  rFTcCstdkr t|}dtjvrtjd}ndt}d||f}t}t|tj r1tj s1| |}t d|tj} d| vrDd| d<|durJ|} |durPt}t|tt|d | d } |s^| Sd} |sui} |rjd |i} | jd i| \} }nt| \} }} t| j| |||| S) a]Run an aws command. This help function abstracts the differences of running the "aws" command on different platforms. If collect_memory is ``True`` the the Result object will have a list of memory usage taken at 2 second intervals. The memory usage will be in bytes. If env_vars is None, this will set the environment variables to be used by the aws process. If wait_for_finish is False, then the Process object is returned to the caller. It is then the caller's responsibility to ensure proper cleanup. This can be useful if you want to test timeout's or how the CLI responds to various signals. :type input_data: string :param input_data: This string will be communicated to the process through the stdin of the process. It essentially allows the user to avoid having to use a file handle to pass information to the process. Note that this string is not passed on creation of the process, but rather communicated to the process. :type input_file: a file handle :param input_file: This is a file handle that will act as the the stdin of the process immediately on creation. Essentially any data written to the file will be read from stdin of the process. This is needed if you plan to stream data into stdin while collecting memory. WindowsZAWS_TEST_COMMANDz python %sz%s %szRunning command: %srgrKNT)rrstdinshellenvinputr)rrrr r4r1get_stdout_encodingrrZ text_typerencoderrrrr communicate_wait_and_collect_memr returncoder^)rZcollect_memoryZenv_varsZwait_for_finishrZ input_fileZ aws_commandZ full_commandZstdout_encodingrprocessmemoryrrrrrrr&GsD !        r&cCsttjdd}|dur d}|S)Nencodingr)getattrsys __stdout__)rrrrr sr cCstdkr t}ntdkrt}ntdtg}|dur>z||j}Wn ty2Yn w|||dus"|\}}|||fS)Nrrz0Can't collect memory for process on platform %s.) rr_get_memory_with_psr/pollpidrrr )rZ get_memoryrcurrentrrrrrr s(       r cCs`d}|t|t|td}|d}|jdks"tt|t| dddS)Nzps u -p)rrri) rrr=rrr r rr] splitlines)rZ command_listprrrrrs    rc@seZdZdZgdZddZddZddZd d Zd d Z d dZ ddZ d8ddZ d9ddZ d:ddZddZddZddZd;d!d"Zd#d$Zd;d%d&Zd;d'd(Zd)d*Zd+d,Zd-d.Z  dBaseS3CLICommandzBase class for aws s3 command. This contains convenience functions to make writing these tests easier and more streamlined. )ZSSECustomerAlgorithmZSSECustomerKeyZSSECustomerKeyMD5Z RequestPayercCs@t|_tj|_i|_d|_|jjd|jd|_| dS)NrGrHrI) rfilesbotocorerZ get_sessionregionsrSrNrT extra_setuprorrrrqs   zBaseS3CLICommand.setUpcCdSr7rrorrrrzBaseS3CLICommand.extra_setupcCs|j|dSr7)rrextra_teardownrorrrrss  zBaseS3CLICommand.tearDowncCr r7rrorrrr"r!zBaseS3CLICommand.extra_teardowncKs |jd}|jdi|dS)NZresponse_parser_factoryr)rrZset_parser_defaults)rprfactoryrrroverride_parsers z BaseS3CLICommand.override_parsercCs$|j||j}|jjd|d}|S)NrHrI)rr5rSrrN)rprUrSrTrrrcreate_client_for_bucketsz)BaseS3CLICommand.create_client_for_bucketcCsh|||t|tjr|d}|||}|t|t|||kr2| d||fdSdS)Nrz?Contents for %s/%s do not match (but they have the same length)) wait_until_key_existsrrrrr^get_key_contentsrlenr)rpbucketrZexpected_contentsZactual_contentsrrrassert_key_contents_equals    z*BaseS3CLICommand.assert_key_contents_equalNcCs>|s|j}t|j||}||j|<||j||||Sr7)rSrPrr addCleanup delete_bucketwait_bucket_exists)rprRrSrUrrrrPs  zBaseS3CLICommand.create_bucketr3c s~|}|||d}|dur|||jdi|}j||i}|r5tfdd|D}j|||d|S)N)rJKeyBodyc3s&|]\}}|jvr||fVqdSr7)_PUT_HEAD_SHARED_EXTRAS)rkvrorr s z.BaseS3CLICommand.put_object..) extra_paramsr)r%update put_objectr+ delete_keydictitemsr&) rprUkey_namer extra_argsrTZ call_argsrQZextra_head_paramsrrorr6s&   zBaseS3CLICommand.put_objectrcCs||||}|} |d8}z|j|dWn|jjy5||r)Yn|dkr.t|Ynwq |j |ddS)NTrrJr) remove_all_objectsr%r, exceptionsZ NoSuchBucketbucket_not_existstimesleeprr)rprUattemptsdelayrTZattempts_remainingrrrr,s"     zBaseS3CLICommand.delete_bucketcCsb||}|d}|j|d}g}|D]}|dd|dgD7}q|D]}|||q&dS)NZ list_objectsr<cSsg|]}|dqS)r.r)robjrrrr0sz7BaseS3CLICommand.remove_all_objects..ZContents)r%Z get_paginatorZpaginater5r7)rprUrTZ paginatorZpagesZ key_namesZpager:rrrr=*s   z#BaseS3CLICommand.remove_all_objectscCs||}|j||d}dSNrJr.)r%Z delete_objectrprUr:rTrQrrrr74rzBaseS3CLICommand.delete_keycCs6|||||}|j||d}|ddS)NrFr/r)r&r%Z get_objectreadr^rGrrrr'8s  z!BaseS3CLICommand.get_key_contentscs8|}|dt|dd}|fdddS)NZ bucket_existsT) min_successesdelay_initial_pollcsjdduS)Nr<)waitrrUwaiterrrrDsz5BaseS3CLICommand.wait_bucket_exists..)r% get_waiterConsistencyWaiterrL)rprUrJrTZconsistency_waiterrrMrr->s   z#BaseS3CLICommand.wait_bucket_existsc CsV||}z |j|dWdSty*}z|jddkr%WYd}~dSd}~ww)Nr<TrMZ404F)r%Z head_bucketr rQr5)rprUrTerrorrrrr?Gs  z"BaseS3CLICommand.bucket_not_existsc C0z |j|||dWdSttfyYdSwN)rJTF)r&r r rprUr:rJrrr key_existsQzBaseS3CLICommand.key_existsc CrRrS)wait_until_key_not_existsr r rTrrrkey_not_existsYrVzBaseS3CLICommand.key_not_existscCs|j}|dS)NZBuckets)rT list_buckets)rprQrrrrYas zBaseS3CLICommand.list_bucketscCs|||}|dS)N ContentType) head_object)rprUr:parsedrrrcontent_type_for_keyes z%BaseS3CLICommand.content_type_for_keycCs||}|j||d}|SrE)r%r[rGrrrr[is zBaseS3CLICommand.head_objectcC|j||||dddS)NTr _wait_for_keyrprUr:r4rJrrrr&n  z&BaseS3CLICommand.wait_until_key_existscCr^)NFr_r`rbrrrrWsrcz*BaseS3CLICommand.wait_until_key_not_existsTc Csb||}|r |d}n|d}||d}|dur ||t|D] } |jdi|q$dS)NZ object_existsZobject_not_existsrFr)r%rOr5rangerL) rprUr:r4rJrrTrNrV_rrrraxs      zBaseS3CLICommand._wait_for_keycCs^||jdd|j|j|jf|d|j|d|j|d|j|d|jdS)NrzNon zero rc (%s) received: %szError:zfailed:z client errorz server error)rrrrZ assertNotIn)rprrrrassert_no_errorssz!BaseS3CLICommand.assert_no_errorsNN)r3N)rr)rI)NrI)NrIT)rurvrwrxr0rqrrsr"r$r%r*rPr6r,r=r7r'r-r?rUrXrYr]r[r&rWrarfrrrrrsB       rc@r)StringIOWithFileNocCsdSrrrorrrfilenoszStringIOWithFileNo.filenoN)rurvrwrirrrrrhrrhc@s*eZdZdddZeddZddZdS) TestEventHandlerNcCs||_d|_d|_dSr)_handler_calledZ__test__)rphandlerrrrrs zTestEventHandler.__init__cCs|jSr7)rlrorrrcalledszTestEventHandler.calledcKs(d|_|jdur|jdi|dSdS)NTr)rlrk)rprrrrrms zTestEventHandler.handlerr7)rurvrwrrrnrmrrrrrjs    rjc@r)ConsistencyWaiterExceptionNrrrrrrorroc@s.eZdZdZ  d ddZdd Zd d Zd S)rPa A waiter class for some check to reach a consistent state. :type min_successes: int :param min_successes: The minimum number of successful check calls to treat the check as stable. Default of 1 success. :type max_attempts: int :param min_successes: The maximum number of times to attempt calling the check. Default of 20 attempts. :type delay: int :param delay: The number of seconds to delay the next API call after a failed check call. Default of 5 seconds. rrFcCs||_||_||_||_dSr7)rJ max_attemptsrCrK)rprJrqrCrKrrrrs zConsistencyWaiter.__init__cOs|d}d}|jr t|j||jkr4|d7}||i|r)|d7}||jkr(dSnt|j||jks|||}t|)a Wait until the check succeeds the configured number of times :type check: callable :param check: A callable that returns True or False to indicate if the check succeeded or failed. :type args: list :param args: Any ordered arguments to be passed to the check. :type kwargs: dict :param kwargs: Any keyword arguments to be passed to the check. rrN)rKr@rArCrqrJ _fail_messagero)rpcheckrrrB successesfail_msgrrrrLs     zConsistencyWaiter.waitcCs||f}d|S)Nz/Failed after %s attempts, only had %s successesr)rprBrtZ format_argsrrrrrszConsistencyWaiter._fail_messageN)rrprF)rurvrwrxrrLrrrrrrrPs  rPrg)r_r`)r)FNTNN)Rrxr rrrAr@rrr;r contextlibstringrZpprintr subprocessrrrrZ awscli.compatrrZbotocore.sessionrZbotocore.exceptionsr r Zbotocore.loadersrZbotocore.awsrequestr Zawscli.clidriverrZ awscli.pluginr r rZPY2ZTestCaseZassertItemsEqualZassertCountEqualloadersLoaderr" getLoggerrr'rrr1r.r8contextmanagerrFrPr>rOrbryobjectr|rrrrrrr Exceptionrrrr&r r rrrhrjrorPrrrrs                    3   t 5;  EV