o eR]GP@sdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddlZ e jjdggggdZiZiZe jjdddZedd Ze jrdGd d d eZne jjZd,d d Zd,ddZ ddZ!ddZ"Gddde#Z$GdddedgdZ%Gddde j&Z'ddZ(ddZ)dd Z*d!d"Z+d-d$d%Z,d&d'Z-d(d)Z.d*d+Z/e,Z0e-Z1e+Z2dS).aD Helper functions for testing. Our **stylistic_issues**, **pyflakes_issues**, and **type_check_issues** respect a 'exclude_paths' in our test config, excluding any absolute paths matching those regexes. Issue strings can start or end with an asterisk to match just against the prefix or suffix. For instance... :: exclude_paths .*/stem/test/data/.* .. versionadded:: 1.2.0 :: TimedTestRunner - test runner that tracks test runtimes test_runtimes - provides runtime of tests excuted through TimedTestRunners clean_orphaned_pyc - delete *.pyc files without corresponding *.py is_pyflakes_available - checks if pyflakes is available is_pycodestyle_available - checks if pycodestyle is available pyflakes_issues - static checks for problems via pyflakes stylistic_issues - checks for PEP8 and other stylistic issues Ntest) pep8.ignorepycodestyle.ignorepyflakes.ignore exclude_pathsPENDINGRUNNINGFINISHED AsyncResultztype msgc@eZdZdZdS)SkipTestz Notes that the test was skipped.N__name__ __module__ __qualname____doc__rr6/usr/lib/python3/dist-packages/stem/util/test_tools.pyr ?r cCs*||krt|durd||f|dS)z Function form of a TestCase's assertEqual. .. versionadded:: 1.6.0 :param object expected: expected value :param object actual: actual value :param str msg: message if assertion fails :raises: **AssertionError** if values aren't equal NzExpected '%s' but was '%s'AssertionErrorexpectedactualmsgrrr assert_equalE rcCs*||vrt|durd||f|dS)a Asserts that a given value is within this content. .. versionadded:: 1.6.0 :param object expected: expected value :param object actual: actual value :param str msg: message if assertion fails :raises: **AssertionError** if the expected value isn't in the actual NzExpected '%s' to be within '%s'rrrrr assert_inVrrcCst|)z Function form of a TestCase's skipTest. .. versionadded:: 1.6.0 :param str msg: reason test is being skipped :raises: **unittest.case.SkipTest** for this reason )r )rrrrskipgs rcCstjj|}|t|j<|jSN)stemutilZ test_tools AsyncTest ASYNC_TESTSnamemethod)funcrrrr asynchronousus r'c@s:eZdZdZdddZddZdd Zd d Zd d ZdS)r"a Test that's run asychronously. These are functions (no self reference) performed like the following... :: class MyTest(unittest.TestCase): @staticmethod def run_tests(): MyTest.test_addition = stem.util.test_tools.AsyncTest(MyTest.test_addition).method @staticmethod def test_addition(): if 1 + 1 != 2: raise AssertionError('tisk, tisk') MyTest.run() .. versionadded:: 1.6.0 NFcsZd|j|jf_|_|_|_fdd_d_d_t _ d_ t j_dS)Nz%s.%scs |Srresult)rselfrrs z$AsyncTest.__init__..)rrr$_runner _runner_args _threadedr%_process _process_pipe threadingRLock _process_lock_result AsyncStatusr_status)r+runnerargsthreadedrr*r__init__s  zAsyncTest.__init__cOstjrdSdd}|j]|jtjkrc|r||_d|vr#|d|_t \|_ }|jrEt j |||j|jfd|jd|_|jdn t j|||j|jfd|_|jtj|_WddSWddS1snwYdS)Nc Sstdztz|r ||n||tddWnKty5}z|tdt|WYd}~n;d}~wtyP}z|tdt|WYd}~n'd}~w|tdtYW| dSW| dSW| dSW| dS| w)N Zsuccessfailureskippederror) osnicesendr rstrr traceback format_excclose)Zconnr8r9excrrr_wrappers(      zAsyncTest.run.._wrapperr:zBackground test of %s)targetr9r$T)rIr9)r prereq _is_python_26r4r7r6rr.r/multiprocessingZPiper1r2ZThreadr-r$r0Z setDaemonZProcessstartr)r+Z runner_argskwargsrHZ child_piperrrruns.      "z AsyncTest.runcCsB|j|jr|js|jjndWdS1swYdSr)r4r0r/pidr*rrrrPs$z AsyncTest.pidcCs|ddSrr(r*rrrjoinszAsyncTest.joincCstjrdS|jw|jtjkr||jtjkr*|j |_ |j tj|_|r:|j jdkr:||j jn'|rJ|j jdkrJ||j jn'|ri|j jdkry||j jWddSWddSWddSWddSWddS1swYdS)Nr=r?r>)r rJrKr4r7r6rrOrr1Zrecvr5r0rQr typefailrskipTest)r+rrrrr)s0         "zAsyncTest.result)NF) rrrrr;rOrPrQr)rrrrr"{s + r"c@r )Issuez Issue encountered by pyflakes or pycodestyle. :var int line_number: line number the issue occured on :var str message: description of the issue :var str line: content of the line the issue is about Nr rrrrrUrrU) line_numbermessagelinecs eZdZdZfddZZS)TimedTestRunnerz Test runner that tracks the runtime of individual tests. When tests are run with this their runtimes are made available through :func:`stem.util.test_tools.test_runtimes`. .. versionadded:: 1.6.0 cs>|jD]}t|Gfddd}||_qtt||S)NcsheZdZdfdd ZfddZfddZdd Zfd d Zfd d ZfddZ Z S)z)TimedTestRunner.run.._TestWrapperNcs4t}tt|||}t|t|<|Sr)timesuperrRrO TEST_RUNTIMESid)r+r)Z start_time __class__rrrOsz-TimedTestRunner.run.._TestWrapper.runcstjs t||SdSr)r rJrKr[rT)r+rWr_ original_typerrrT s z2TimedTestRunner.run.._TestWrapper.skipTestcs4tjr|t|t|dSt|||Sr)r rJrKZ assertEqualsetr[assertItemsEqual)r+rrr`rrrcs z:TimedTestRunner.run.._TestWrapper.assertItemsEqualc_s&|j|dt||g|Ri|S)a Asserts the given invokation raises the expected excepiton. This is similar to unittest's assertRaises and assertRaisesRegexp, but checks for an exact match. This method is **not** being vended to external users and may be changed without notice. If you want this method to be part of our vended API then please let us know. z^%s$)assertRaisesRegexpreescape)r+exc_typeexc_msgr&r9rNrrrassertRaisesWiths& z:TimedTestRunner.run.._TestWrapper.assertRaisesWithc stjr7z||i||d|WdS|y6}z|t|t|tjWYd}~dSd}~wwt |j |||g|Ri|S)Nz*Expected a %s to be raised but nothing was) r rJrKrSZ assertTrueresearchrC MULTILINEr[rd)r+rgrhr&r9rNrGr`rrrd"s ("z._TestWrapper.assertRaisesRegexpcsdjj|jfS)Nz%s.%s.%s)rr_testMethodNamer*rarrr],z,TimedTestRunner.run.._TestWrapper.idcsd|jjjfS)Nz %s (%s.%s))rlrrr*rmrr__str__/rnz1TimedTestRunner.run.._TestWrapper.__str__r) rrrrOrTrcrirdr]ro __classcell__rrmr^r _TestWrappers  rq)Z_testsrRr_r[rYrO)r+rtrqr^rmrrOs 3zTimedTestRunner.run)rrrrrOrprrr^rrYsrYcCsttS)z Provides the runtimes of tests executed through TimedTestRunners. :returns: **dict** of fully qualified test names to floats for the runtime in seconds .. versionadded:: 1.6.0 )dictr\rrrr test_runtimes7s rtcCsg}|D]M}tjj|dD]B}|dd}dtjjtjjf}||vr@||d\}}|ds2qtj ||ddd}tj |sP| |t |qq|S) as Deletes any file with a \*.pyc extention without a corresponding \*.py. This helps to address a common gotcha when deleting python files... * You delete module 'foo.py' and run the tests to ensure that you haven't broken anything. They pass, however there *are* still some 'import foo' statements that still work because the bytecode (foo.pyc) is still around. * You push your change. * Another developer clones our repository and is confused because we have a bunch of ImportErrors. :param list paths: paths to search for orphaned pyc files :returns: list of absolute paths that were deleted z.pycNz%s__pycache__%s.r.py) r r!systemfiles_with_suffixr@pathsepsplitendswithrQexistsappendremove)pathsZ orphaned_pycr{Zpyc_pathZpy_pathpycacheZ directorypycache_filenamerrrclean_orphaned_pycDs      rcCstdotdS)zk Checks if pyflakes is availalbe. :returns: **True** if we can use pyflakes and **False** otherwise z pyflakes.apizpyflakes.reporter)_module_existsrrrris_pyflakes_availableqsrcCs2tdr ddl}n tdrddl}ndSt|dS)zq Checks if pycodestyle is availalbe. :returns: **True** if we can use pycodestyle and **False** otherwise pycodestylerNpep8F BaseReport)rrrhasattr)rrrris_pycodestyle_available{s    rFc sig}ggtdtdD]<}d|vrG|dd\}}d|vr9|dd\}}|||fq|dkrF|q||qfddtrtd r`d d l} nd d l} Gfd d d | j| j |d} | t t |S)a Checks for stylistic issues that are an issue according to the parts of PEP8 we conform to. You can suppress pycodestyle issues by making a 'test' configuration that sets 'pycodestyle.ignore'. For example, with a 'test/settings.cfg' of... :: # pycodestyle compliance issues that we're ignoreing... # # * E111 and E121 four space indentations # * E501 line is over 79 characters pycodestyle.ignore E111 pycodestyle.ignore E121 pycodestyle.ignore E501 pycodestyle.ignore run_tests.py => E402: import stem.util.enum ... you can then run tests with... :: import stem.util.conf test_config = stem.util.conf.get_config('test') test_config.load('test/settings.cfg') issues = stylistic_issues('my_project') .. versionchanged:: 1.3.0 Renamed from get_stylistic_issues() to stylistic_issues(). The old name still works as an alias, but will be dropped in Stem version 2.0.0. .. versionchanged:: 1.4.0 Changing tuples in return value to be namedtuple instances, and adding the line that had the issue. .. versionchanged:: 1.4.0 Added the prefer_single_quotes option. .. versionchanged:: 1.6.0 Changed 'pycodestyle.ignore' code snippets to only need to match against the prefix. :param list paths: paths to search for stylistic issues :param bool check_newlines: check that we have standard newlines (\n), not windows (\r\n) nor classic mac (\r) :param bool check_exception_keyword: checks that we're using 'as' for exceptions rather than a comma :param bool prefer_single_quotes: standardize on using single rather than double quotes for strings, when reasonable :returns: dict of paths list of :class:`stem.util.test_tools.Issue` instances rr=>rv:*csTD]\}}}||r||kr||rdSqD] }||r'dSqdS)NTF)r~strip startswith)r{rulecode ignored_pathZ ignored_ruleZ ignored_code)ignore_all_for_filesignore_for_filerr is_ignoreds  z$stylistic_issues..is_ignoredrrNcs:eZdZfddZfddZZS)z%stylistic_issues..StyleReportc s*t|||||sssdSd}D] }||r!dSqt|D]l\}}|ddd} rId|vrI|gt|dd|| sLq&d| vrS| }rn| drn| d rn|gt|dd |r|sd | vrd | vrd| vr| d s|gt|dd|q&dS)NF#rvr zcontains a windows newlinez"""exceptz, exc:z(except clause should use 'as', not comma"'\z$use single rather than double quotes) r[ init_filer~ enumerater}r setdefaultrrUr) r+filenamelinesrZ line_offsetZis_block_commentrindexrXZcontent) StyleReportr_check_exception_keywordcheck_newlinesrissuesprefer_single_quotesrrrs.    "z/stylistic_issues..StyleReport.init_filecs^t|||||}|r+t|j|}|j||s-|jgt|||dSdSdSr)r[r? linecachegetlinerrrrU)r+rVoffsettextcheckrrX)rr_rrrrr?s z+stylistic_issues..StyleReport.error)rrrrr?rpr)rrrrrrrr^rrs0r)ignorereporter) CONFIGr}rrrrrrrZ StyleGuideZ check_fileslist _python_files) rrrrZ ignore_rulesrr{Z rule_entryrrZ style_checkerr)rrrrrrrrrstylistic_issuess.:    ":rcsXitr*ddl}ddl}Gfddd|jj}|}t|D] }|j||q S)aP Performs static checks via pyflakes. False positives can be ignored via 'pyflakes.ignore' entries in our 'test' config. For instance... :: pyflakes.ignore stem/util/test_tools.py => 'pyflakes' imported but unused pyflakes.ignore stem/util/test_tools.py => 'pycodestyle' imported but unused .. versionchanged:: 1.3.0 Renamed from get_pyflakes_issues() to pyflakes_issues(). The old name still works as an alias, but will be dropped in Stem version 2.0.0. .. versionchanged:: 1.4.0 Changing tuples in return value to be namedtuple instances, and adding the line that had the issue. .. versionchanged:: 1.5.0 Support matching against prefix or suffix issue strings. :param list paths: paths to search for problems :returns: dict of paths list of :class:`stem.util.test_tools.Issue` instances rNcs@eZdZddZddZddZddZd d Zfd d Zd S)z!pyflakes_issues..ReportercSsBi|_tdD]}|d\}}|j|g|qdS)Nrr)_ignored_issuesrr}rrr)r+rXr{issuerrrr;Js  z*pyflakes_issues..Reporter.__init__cSs||d|ddSr_register_issue)r+rrrrrunexpectedErrorQrnz1pyflakes_issues..Reporter.unexpectedErrorcSs|||||dSrr)r+rrlinenorrrrr syntaxErrorTrnz-pyflakes_issues..Reporter.syntaxErrorcSs ||j|j|j|jddSr)rrrrWZ message_args)r+rrrrflakeWs z'pyflakes_issues..Reporter.flakecSs||jD]6\}}||r;||vrdSdd|DD] }||r'dSqdd|DD] }||r:dSq/qdS)NTcS"g|] }|dr|ddqS)rNrv)r~.0irrr c"zApyflakes_issues..Reporter._is_ignored..cSr)rrvN)rrrrrrgrF)ritemsr~r)r+r{rrZignored_issuesprefixsuffixrrr _is_ignoredZs   z-pyflakes_issues..Reporter._is_ignoredcsJ|||s#|r|r|st||}|gt|||dSdSr)rrrrrrrU)r+r{rVrrXrrrrms  z1pyflakes_issues..Reporter._register_issueN) rrrr;rrrrrrrrrReporterIsr)rZ pyflakes.apiZpyflakes.reporterrrrZapiZ checkPath)rZpyflakesrrr{rrrpyflakes_issues)s+ rcCs$zt|WdStyYdSw)z Checks if a module exists. :param str module_name: module to check existance of :returns: **True** if module exists and **False** otherwise TF) __import__ ImportError)Z module_namerrrr|s   rccsV|D]%}tjj|dD]}d}tdD] }t||r!d}nq|s'|Vq qdS)NrxFrT)r r!ryrzrrematch)rr{Z file_pathrZ exclude_pathrrrrs  rr)FFF)3r collectionsrrLr@rer2rZrDZunittestZ stem.prereqr Zstem.util.confZstem.util.enumZstem.util.systemr!confZ config_dictrr\r#enumZ UppercaseEnumr6 namedtupler rJrK Exceptionr caserrrr'objectr"rUZTextTestRunnerrYrtrrrrrrrZget_stylistic_issuesZget_pyflakes_issuesZis_pep8_availablerrrrs\     m E - S