Mh$dZddlZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlmZddlmZmZddlmZddlmZmZddlmZdd lmZdd lmZdd lmZdd lm Z m!Z!dd l"m#Z#ddl$Z$ddl$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,ddl-m.Z.e$j/r#e%e+e(e0e+e0e+e.fZ1eZ2 d.de3de4de%e j e5ffdZ6de7fdZ8Gdde j9Z:Gdde:Z;Gdde;Ze$j=d#e'de*ed ffde'd!fd$Z> d/d#e+e'de*ed ffde+e7de*e'd!e'e'de*ed ffge'd!fffd%Z>de>_?Gd&d'ej@ZAd(e j9d)e&de&fd*ZBd+e&ddfd,ZCeDd-kr eCdSdS)0aSupport classes for automated testing. * `AsyncTestCase` and `AsyncHTTPTestCase`: Subclasses of unittest.TestCase with additional support for testing asynchronous (`.IOLoop`-based) code. * `ExpectLog`: Make test logs less spammy. * `main()`: A simple test runner (wrapper around unittest.main()) with support for the tornado.autoreload module to rerun the tests when code changes. N) Generator)gen)AsyncHTTPClient HTTPResponse) HTTPServer)IOLoop TimeoutError)netutil)AsyncIOMainLoop) Subprocess)app_log)raise_exc_infobasestring_type) Application)TupleAnyCallableTypeDictUnionOptional Coroutine) TracebackTypeF 127.0.0.1 reuse_portaddressreturnctjd|tj|d}|d}||fS)aIBinds a server socket to an available port on localhost. Returns a tuple (socket, port). .. versionchanged:: 4.4 Always binds to ``127.0.0.1`` without resolving the name ``localhost``. .. versionchanged:: 6.2 Added optional ``address`` argument to override the default "127.0.0.1". r)familyr)r bind_socketssocketAF_INET getsockname)rrsockports O/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/tornado/testing.pybind_unused_portr(1sP   76>j    D     a D :ctjd}| t|S#t$rYnwxYwdS)z}Get the global timeout setting for async tests. Returns a float, the timeout in seconds. .. versionadded:: 3.1 ASYNC_TEST_TIMEOUTN)osenvirongetfloat ValueError)envs r'get_async_test_timeoutr3GsS *..- . .C  ::     D  1s 2 ??c*eZdZdZddeddffd Zdfd Zdfd Zdefd Z d e e d e d e de fd ZddZ ddeejdeejffd ZdeddfdZddededdfdZ ddeede fdeedefdZxZS) AsyncTestCasea/`~unittest.TestCase` subclass for testing `.IOLoop`-based asynchronous code. The unittest framework is synchronous, so the test must be complete by the time the test method returns. This means that asynchronous code cannot be used in quite the same way as usual and must be adapted to fit. To write your tests with coroutines, decorate your test methods with `tornado.testing.gen_test` instead of `tornado.gen.coroutine`. This class also provides the (deprecated) `stop()` and `wait()` methods for a more manual style of testing. The test method itself must call ``self.wait()``, and asynchronous callbacks should call ``self.stop()`` to signal completion. By default, a new `.IOLoop` is constructed for each test and is available as ``self.io_loop``. If the code being tested requires a reused global `.IOLoop`, subclasses should override `get_new_ioloop` to return it, although this is deprecated as of Tornado 6.3. The `.IOLoop`'s ``start`` and ``stop`` methods should not be called directly. Instead, use `self.stop ` and `self.wait `. Arguments passed to ``self.stop`` are returned from ``self.wait``. It is possible to have multiple ``wait``/``stop`` cycles in the same test. Example:: # This test uses coroutine style. class MyTestCase(AsyncTestCase): @tornado.testing.gen_test def test_http_fetch(self): client = AsyncHTTPClient() response = yield client.fetch("http://www.tornadoweb.org") # Test contents of response self.assertIn("FriendFeed", response.body) # This test uses argument passing between self.stop and self.wait. class MyTestCase2(AsyncTestCase): def test_http_fetch(self): client = AsyncHTTPClient() client.fetch("http://www.tornadoweb.org/", self.stop) response = self.wait() # Test contents of response self.assertIn("FriendFeed", response.body) runTest methodNamerNct|d|_d|_d|_d|_d|_d|_dS)NF)super__init___AsyncTestCase__stopped_AsyncTestCase__running_AsyncTestCase__failure_AsyncTestCase__stop_args_AsyncTestCase__timeout_test_generator)selfr7 __class__s r'r:zAsyncTestCase.__init__sO $$$ $r)ctj}d|cxkrdksnd|cxkrdkrAnn>t|tjtjddt dtt|j tj urtj d t | |_ tj|j jdS) N) r)rDrE )rD r)rDrGr ignorezThere is no current event loopz tornado\..*)messagecategorymodulezget_new_ioloop is deprecated)sys version_infosetup_with_context_managerwarningscatch_warningsfilterwarningsDeprecationWarningr9setUptypeget_new_ioloopr5warnio_loopasyncioset_event_loop asyncio_loop)rApy_verrBs r'rSzAsyncTestCase.setUps! & - - - -: - - - -:3U3U3U3U:3U3U3U3U3U 'tX-D-F-F G G G  #8+%        :: $M,H H H M8:L M M M**,, t|899999r)c^|jj}tj|dDD]}|rS|jfd\}}|rJ|D],} |#tj$rY)wxYwtj tj dt|jts|j dt|dS)Nc:g|]}||S)done).0ts r' z*AsyncTestCase.tearDown..s%222q2222r)c,tjSN)rXwait)taskssr'z(AsyncTestCase.tearDown..s',u:M:Mr)T)all_fds)rWrZrX all_taskscancelrun_syncresultCancelledErrorr uninitializerY isinstance_NON_OWNED_IOLOOPScloser9tearDown_AsyncTestCase__rethrow)rArZrar_pendingfrfrBs @r'rrzAsyncTestCase.tearDownsR |0 !,//32E222  A HHJJJJ   L112M2M2M2MNNMD'     HHJJJJ-D !!!t$$$$,(:;; - L  t  , , ,  s3BBBc"tdS)aReturns the `.IOLoop` to use for this test. By default, a new `.IOLoop` is created for each test. Subclasses may override this method to return `.IOLoop.current()` if it is not appropriate to use a new `.IOLoop` in each tests (for example, if there are global singletons using the default `.IOLoop`) or if a per-test event loop is being provided by another system (such as ``pytest-asyncio``). .. deprecated:: 6.3 This method will be removed in Tornado 7.0. F) make_current)rrAs r'rUzAsyncTestCase.get_new_ioloops5))))r)typvaluetbc|j |||f|_ntjd|||f|dS)Nz%multiple unhandled exceptions in test)exc_infoT)r=r errorstoprAryrzr{s r'_handle_exceptionzAsyncTestCase._handle_exceptionsU > !!5"-DNN M73rBR     tr)cR|j|j}d|_t|dSdSrd)r=r)rAfailures r' __rethrowzAsyncTestCase.__rethrows4 > %nG!DN 7 # # # # # & %r)rlcrt|}||Srd)r9runrs)rArlretrBs r'rzAsyncTestCase.runs1ggkk&!!  r)methodc|}t|tstj|rt d|t d|zdS)axRun the given test method, raising an error if it returns non-None. Failure to decorate asynchronous test methods with ``@gen_test`` can lead to tests incorrectly passing. Remove this override when Python 3.10 support is dropped. This check (in the form of a DeprecationWarning) became a part of the standard library in 3.11. Note that ``_callTestMethod`` is not documented as a public interface. However, it is present in all supported versions of Python (3.8+), and if it goes away in the future that's OK because we can just remove this override as noted above. zVGenerator and coroutine test methods should be decorated with tornado.testing.gen_testNz)Return value from test method ignored: %r)rorinspect iscoroutine TypeErrorr1)rArrls r'_callTestMethodzAsyncTestCase._callTestMethodsp fi ( ( SG,?,G,G S;  H6QRR R r)_argkwargsc ||rJ|p||_|jr |jd|_d|_dS)aIStops the `.IOLoop`, causing one pending (or future) call to `wait()` to return. Keyword arguments or a single positional argument passed to `stop()` are saved and will be returned by `wait()`. .. deprecated:: 5.1 `stop` and `wait` are deprecated; use ``@gen_test`` instead. NFT)r>r<rWrr;)rArrs r'rzAsyncTestCase.stopsM|6|||!>T > # L     "DNr) condition.timeoutctjsrAdfd }jjz|_ d_jj | |rn5j&j jd_jsJd_ j }d_ |S)aRuns the `.IOLoop` until stop is called or timeout has passed. In the event of a timeout, an exception will be thrown. The default timeout is 5 seconds; it may be overridden with a ``timeout`` keyword argument or globally with the ``ASYNC_TEST_TIMEOUT`` environment variable. If ``condition`` is not ``None``, the `.IOLoop` will be restarted after `stop()` until ``condition()`` returns ``True``. .. versionchanged:: 3.1 Added the ``ASYNC_TEST_TIMEOUT`` environment variable. .. deprecated:: 5.1 `stop` and `wait` are deprecated; use ``@gen_test`` instead. Nrc dz#t$rtj_YnwxYwdS)Nz*Async operation timed out after %s seconds)failureException ExceptionrLr}r=r)rArsr' timeout_funcz(AsyncTestCase.wait..timeout_funcCsg8"33H7R%888),8IIKKKKKs"AATFrN) r3r;rW add_timeouttimer?r<startr=remove_timeoutrsr>)rArrrrls` ` r'rezAsyncTestCase.wait's!, ?,..G~ &        "&!9!9L%%'''1<"" !% ""$$$>-1Biikk1B   ~) ++DN;;;!%~ ! r))r6rrdNN)__name__ __module__ __qualname____doc__strr:rSrrrrUrrrboolrrsrunittest TestResultrrrrrr0re __classcell__rBs@r'r5r5Ws--^ $ $3 $t $ $ $ $ $ $::::::$******X*****  ? +4 :G      $$$$7;  x23  (% &      ShS4SSSS0st(48#'55HS$Y/05%5 55555555r)r5c eZdZdZdfd ZdefdZdefdZde fdZ dd e d e d e defd Zdee e ffd ZdefdZde fdZd e de fdZdfd ZxZS)AsyncHTTPTestCasearA test case that starts up an HTTP server. Subclasses must override `get_app()`, which returns the `tornado.web.Application` (or other `.HTTPServer` callback) to be tested. Tests will typically use the provided ``self.http_client`` to fetch URLs from this server. Example, assuming the "Hello, world" example from the user guide is in ``hello.py``:: import hello class TestHelloApp(AsyncHTTPTestCase): def get_app(self): return hello.make_app() def test_homepage(self): response = self.fetch('/') self.assertEqual(response.code, 200) self.assertEqual(response.body, 'Hello, world') That call to ``self.fetch()`` is equivalent to :: self.http_client.fetch(self.get_url('/'), self.stop) response = self.wait() which illustrates how AsyncTestCase can turn an asynchronous operation, like ``http_client.fetch()``, into a synchronous operation. If you need to do other asynchronous operations in tests, you'll probably need to use ``stop()`` and ``wait()`` yourself. rNcDtt\}}||_||_||_||_ |j |gdSrd) r9rSr(_AsyncHTTPTestCase__portget_http_client http_clientget_app_appget_http_server http_server add_sockets)rAr%r&rBs r'rSzAsyncHTTPTestCase.setUps  %'' d //11LLNN //11 $$dV,,,,,r)ctSrd)rrxs r'rz!AsyncHTTPTestCase.get_http_clients   r)cJt|jfi|Srd)rrget_httpserver_optionsrxs r'rz!AsyncHTTPTestCase.get_http_servers&$)EEt'B'B'D'DEEEr)ct)zzShould be overridden by subclasses to return a `tornado.web.Application` or other `.HTTPServer` callback. )NotImplementedErrorrxs r'rzAsyncHTTPTestCase.get_apps"###r)Fpath raise_errorrc |dr|n|jfdt S)aEConvenience method to synchronously fetch a URL. The given path will be appended to the local server's host and port. Any additional keyword arguments will be passed directly to `.AsyncHTTPClient.fetch` (and so could be used to pass ``method="POST"``, ``body="..."``, etc). If the path begins with http:// or https://, it will be treated as a full URL and will be fetched as-is. If ``raise_error`` is ``True``, a `tornado.httpclient.HTTPError` will be raised if the response code is not 200. This is the same behavior as the ``raise_error`` argument to `.AsyncHTTPClient.fetch`, but the default is ``False`` here (it's ``True`` in `.AsyncHTTPClient`) because tests often need to deal with non-200 response codes. .. versionchanged:: 5.0 Added support for absolute URLs. .. versionchanged:: 5.1 Added the ``raise_error`` argument. .. deprecated:: 5.1 This method currently turns any exception into an `.HTTPResponse` with status code 599. In Tornado 6.0, errors other than `tornado.httpclient.HTTPError` will be passed through, and ``raise_error=False`` will only suppress errors that would be raised due to non-200 response codes. )zhttp://zhttps://c.jjfdiS)Nr)rfetch)rrrAurlsr'rgz)AsyncHTTPTestCase.fetch..s%*D$*3RRKR6RRr)r)lower startswithget_urlrWrkr3)rArrrrs` ``@r'rzAsyncHTTPTestCase.fetchs}H ::<< " "#: ; ; %CC,,t$$C|$$ R R R R R R R*,,%   r)ciS)zgMay be overridden by subclasses to return additional keyword arguments for the server. r^rxs r'rz(AsyncHTTPTestCase.get_httpserver_optionss  r)c|jS)zZReturns the port used by the server. A new port is chosen for each test. )rrxs r' get_http_portzAsyncHTTPTestCase.get_http_ports {r)cdS)Nhttpr^rxs r' get_protocolzAsyncHTTPTestCase.get_protocolsvr)c\|d||S)z>Returns an absolute url for the given path on the test server.z ://127.0.0.1:)rr)rArs r'rzAsyncHTTPTestCase.get_urls3##%%PPD4F4F4H4HP$PPPr)c|j|j|jjt |j|`|`t dS)Nr) rrrWrkclose_all_connectionsr3rrqrr9rr)rArBs r'rrzAsyncHTTPTestCase.tearDowns     2A+ + + + + ZS#X scQCQCQQQQr)rceZdZdZdefdZdeeeffdZ deeeffdZ e deeeffdZ defdZ dS) AsyncHTTPSTestCasezjA test case that starts an HTTPS server. Interface is generally the same as `AsyncHTTPTestCase`. rc@tdtdS)NTF) validate_cert)force_instancedefaults)rdictrxs r'rz"AsyncHTTPSTestCase.get_http_clients!dTPU=V=V=VWWWWr)cFt|S)N) ssl_options)rget_ssl_optionsrxs r'rz)AsyncHTTPSTestCase.get_httpserver_optionss 4 4 6 67777r)c4tS)zMay be overridden by subclasses to select SSL options. By default includes a self-signed testing certificate. )rdefault_ssl_optionsrxs r'rz"AsyncHTTPSTestCase.get_ssl_optionss "55777r)ctjt}t tj|ddtj|ddS)Ntestztest.crtztest.key)certfilekeyfile)r-rdirname__file__rjoin) module_dirs r'rz&AsyncHTTPSTestCase.default_ssl_optionssXW__X.. W\\*fjAAGLLVZ@@    r)cdS)Nhttpsr^rxs r'rzAsyncHTTPSTestCase.get_protocolswr)N)rrrrrrrrrrr staticmethodrrr^r)r'rrs XXXXX8S#X88888c3h8888  c3h    \  cr)rrr.r.NcdSrdr^rs r'gen_testrs  Dr)funccdSrdr^)rs r'rr sDr)ctdtdttdffdtdffd }| ||S|S)a1Testing equivalent of ``@gen.coroutine``, to be applied to test methods. ``@gen.coroutine`` cannot be used on tests because the `.IOLoop` is not already running. ``@gen_test`` should be applied to test methods on subclasses of `AsyncTestCase`. Example:: class MyTest(AsyncHTTPTestCase): @gen_test def test_something(self): response = yield self.http_client.fetch(self.get_url('/')) By default, ``@gen_test`` times out after 5 seconds. The timeout may be overridden globally with the ``ASYNC_TEST_TIMEOUT`` environment variable, or for each test with the ``timeout`` keyword argument:: class MyTest(AsyncHTTPTestCase): @gen_test(timeout=10) def test_something_slow(self): response = yield self.http_client.fetch(self.get_url('/')) Note that ``@gen_test`` is incompatible with `AsyncTestCase.stop`, `AsyncTestCase.wait`, and `AsyncHTTPTestCase.fetch`. Use ``yield self.http_client.fetch(self.get_url())`` as shown above instead. .. versionadded:: 3.1 The ``timeout`` argument and ``ASYNC_TEST_TIMEOUT`` environment variable. .. versionchanged:: 4.0 The wrapper now passes along ``*args, **kwargs`` so it can be used on functions with arguments. Nru.rrrctjfd}tjr|nt j|tjfd}|S)Nc|g|Ri|}t|tstj|r||_nd|_|Srd)rorrrr@)rAargsrrlrus r' pre_coroutinez-gen_test..wrap..pre_coroutineHs`Qt-d---f--F&),, ,0CF0K0K ,'-$$'+$Mr)c |jtj|g|Ri|S#t$r=}|j0t |jddr|j|d}~wwxYw)Nr cr_runningT)rWrk functoolspartialr r@getattrthrow)rArrecorors r'post_coroutinez.gen_test..wrap..post_coroutineXs |,,%dDB4BBB6BBG-    '3(,993(..q111  s/3 A:8A55A:)rwrapsriscoroutinefunctionr coroutine)rurrrrs` @r'wrapzgen_test..wrap?s            &q ) ) 0 DD=//D           .r))r3rrr)rrrs ` r'rrs{T(**1eI{$:;;<1)AT111111f  tDzz r)c eZdZdZ ddeejefdede de e ddf d Z d ej de fd Zdd Zd dde ede eddfdZdS) ExpectLogaContext manager to capture and suppress expected log output. Useful to make tests of error conditions less noisy, while still leaving unexpected log entries visible. *Not thread safe.* The attribute ``logged_stack`` is set to ``True`` if any exception stack trace was logged. Usage:: with ExpectLog('tornado.application', "Uncaught exception"): error_response = self.fetch("/some_page") .. versionchanged:: 4.3 Added the ``logged_stack`` attribute. TNloggerregexrequiredlevelrct|trtj|}||_t j||_||_d|_ d|_ d|_ ||_ d|_ dS)aConstructs an ExpectLog context manager. :param logger: Logger object (or name of logger) to watch. Pass an empty string to watch the root logger. :param regex: Regular expression to match. Any log entries on the specified logger that match this regex will be suppressed. :param required: If true, an exception will be raised if the end of the ``with`` statement is reached without matching any log entries. :param level: A constant from the ``logging`` module indicating the expected log level. If this parameter is provided, only log messages at this level will be considered to match. Additionally, the supplied ``logger`` will have its level adjusted if necessary (for the duration of the ``ExpectLog`` to enable the expected message. .. versionchanged:: 6.1 Added the ``level`` parameter. .. deprecated:: 6.3 In Tornado 7.0, only ``WARNING`` and higher logging levels will be matched by default. To match ``INFO`` and lower levels, the ``level`` argument must be used. This is changing to minimize differences between ``tornado.testing.main`` (which enables ``INFO`` logs by default) and most other test runners (including those in IDEs) which have ``INFO`` logs disabled by default. rFN)rorlogging getLoggerrrecompilerrmatcheddeprecated_level_matched logged_stackr orig_level)rArrrrs r'r:zExpectLog.__init__so@ fo . . /&v..F Z&&    ()%! r)recordc |jrd|_|}|j|r|j%|jtjkr|xj dz c_ |jL|j|jkr?? ?   .$,>> MK"          ?>r))TN)rr)rrrrrrLoggerrrrrrr: LogRecordrr BaseExceptionrrr^r)r'rrs*# **gno56** * } *  ****XW.4, , & ] #   r)rtestcasecmch|}||jddd|S)a[Use a context manager to setUp a test case. Example:: def setUp(self): setup_with_context_manager(self, warnings.catch_warnings()) warnings.filterwarnings("ignore", category=DeprecationWarning) # The catch_warnings context manager will be deactivated # automatically in tearDown. N)r addCleanupr)rr vals r'rNrNs2 ,,..C  T4666 Jr)rc 4ddlm}m}m}|dtdd|dt|d t|d t|d t|d tt jdg|t jz}|js)tjtj tj |j d|d<|j d|d<|j d|d <|jd|d<|jd|d <t dkrBt#|dkr/t%dt jt jdt#|dkrt+jdd |d|d St+jdd|d|d S)aA simple test runner. This test runner is essentially equivalent to `unittest.main` from the standard library, but adds support for Tornado-style option parsing and log formatting. It is *not* necessary to use this `main` function to run tests using `AsyncTestCase`; these tests are self-contained and can run with any test runner. The easiest way to run a test is via the command line:: python -m tornado.testing tornado.test.web_test See the standard library ``unittest`` module for ways in which tests can be specified. Projects with many tests may wish to define a test script like ``tornado/test/runtests.py``. This script should define a method ``all()`` which returns a test suite and then call `tornado.testing.main()`. Note that even when a test script is used, the ``all()`` test suite may be overridden by naming a single test on the command line:: # Runs all tests python -m tornado.test.runtests # Runs one test python -m tornado.test.runtests tornado.test.web_test Additional keyword arguments passed through to ``unittest.main()``. For example, use ``tornado.testing.main(verbosity=2)`` to show many test details as they are run. See http://docs.python.org/library/unittest.html#unittest.main for full argument list. .. versionchanged:: 5.0 This function produces no output of its own; only that produced by the `unittest` module (previously it would add a PASS or FAIL log message). r)defineoptionsparse_command_lineexception_on_interruptTzIf true (default), ctrl-c raises a KeyboardInterrupt exception. This prints a stack trace but cannot interrupt certain operations. If false, the process is more reliably killed, but does not print a stack trace.)rTdefaulthelpverbose)rTquietfailfastcatchbufferN verbosity catchbreak__main__r zNo tests specified)file)rKargvall) defaultTestr5r^)tornado.optionsr%r&r'rrLr5r(signalSIGINTSIG_DFLr+r,r-r.r/rlenprintstderrexitrmain)rr%r&r'r5s r'r@r@sPDCCCCCCCCC F  8     F94     F7 F:D!!!! F7 F8$ HQK=--ch77 7D  )5 fmV^444"{} {#!z} #|~!x:#d))q.. "4444   4yy1}} 7T7777777 =%d==f=====r)r3)Frr)ErrXcollections.abcrrrrr-rr9r"rLrrOtornadortornado.httpclientrrtornado.httpserverrtornado.iolooprr r tornado.platform.asyncior tornado.processr tornado.logr tornado.utilrr tornado.webrtypingrrrrrrrrtypesr TYPE_CHECKINGr _ExcInfoTuplerprrrr(r0r3TestCaser5rroverloadr__test__FilterrrNr@rr^r)r'rSs  %%%%%% <<<<<<<<))))))////////444444&&&&&&88888888###### OOOOOOOOOOOOOOOOOOOO m$%x '>@WWM %.9'* 6=# ,       EEEEEH%EEEP@@@@@ @@@F!!!!!*!!!H"&     xU9k#9::;QQR     8Cy+'=!>>? HYDW    DH#hh 8Cy+'=!>>? @h e_h  Y hsE)["899: ;Xi=P PQShhhhZnnnnnnnnd):"Y>3Y>4Y>Y>Y>Y>x zDFFFFFr)