o b@sdZddlZddlZddlmZddlmZddlmZm Z GdddZ Gdd d e e Z Gd d d e e Z Gd d d e e Z Gddde e ZdS)z- Tests for L{twisted.names} example scripts. N)StringIO)FilePath)SkipTestTestCasec@s8eZdZdZddZddZddZdd Zd d Zd S) ExampleTestBasea This is a mixin which adds an example to the path, tests it, and then removes it from the path and unimports the modules which the test loaded. Test cases which test example code and documentation listings should use this. This is done this way so that examples can live in isolated path entries, next to the documentation, replete with their own plugin packages and whatever other metadata they need. Also, example code is a rare instance of it being valid to have multiple versions of the same code in the repository at once, rather than relying on version control, because documentation will often show the progression of a single piece of code as features are added to it, and we want to test each one. cCstjdd|_tj|_t|_|td|jt|_ |td|j z t t j d d}Wn ty=tdw|jdD]}| |}|sXtd|jd qD||_tj|jj|jd d }t||_dS) zn Add our example directory to the path and record which modules are currently loaded. Nstderrstdout TOX_INI_DIRdocsz5Examples not found ($TOX_INI_DIR unset) - cannot test/z Examples (z) not found - cannot test.r)syspath originalPathmodulescopyoriginalModulesrfakeErrpatchfakeOutrosenvironchildKeyErrorrexampleRelativePathsplitexists examplePathappendparentbasename __import__example)selfhere childName moduleNamer'B/usr/lib/python3/dist-packages/twisted/names/test/test_examples.pysetUp!s,   zExampleTestBase.setUpcCs,tjtj|j|jtjdd<dS)z Remove the example directory from the path and remove all modules loaded by the test from sys.modules. N)r rclearupdaterrr)r#r'r'r(tearDownEs zExampleTestBase.tearDowncCsD|j}||dWddS1swYdS)zK The example scripts start with the standard shebang line. s#!/usr/bin/env pythonN)ropen assertEqualreadlinerstrip)r#fr'r'r( test_shebangNs "zExampleTestBase.test_shebangcCsF|t|jjdd|j}||ddd|dfdS)z The example script prints a usage message to stdout if it is passed a --help option and then exits. The first line should contain a USAGE summary, explaining the accepted command arguments. Nz--helprUsage:?Usage message first line should start with "Usage:". Actual: %r) assertRaises SystemExitr"mainrgetvalue splitlines assertTrue startswith)r#outr'r'r(test_usageConsistencyUs  z%ExampleTestBase.test_usageConsistencycCsf|t|jjdd|j}||ddd|df||ddd|dfdS) a` The example script prints a usage message to stderr if it is passed unrecognized command line arguments. The first line should contain a USAGE summary, explaining the accepted command arguments. The last line should contain an ERROR summary, explaining that incorrect arguments were supplied. Nz--unexpected_argumentrr3r4zERROR:z=Usage message last line should start with "ERROR:" Actual: %r) r5r6r"r7rr8r9r:r;)r#errr'r'r(test_usageConsistencyOnErrorhs   z,ExampleTestBase.test_usageConsistencyOnErrorN) __name__ __module__ __qualname____doc__r)r,r2r=r@r'r'r'r(rs$  rc@eZdZdZdZdS) TestDnsTestsz- Test the testdns.py example script. znames/examples/testdns.pyNrArBrCrDrr'r'r'r(rFrFc@rE)GetHostByNameTestsz3 Test the gethostbyname.py example script. znames/examples/gethostbyname.pyNrGr'r'r'r(rIrHrIc@rE)DnsServiceTestsz1 Test the dns-service.py example script. znames/examples/dns-service.pyNrGr'r'r'r(rJrHrJc@rE)MultiReverseLookupTestsz: Test the multi_reverse_lookup.py example script. z&names/examples/multi_reverse_lookup.pyNrGr'r'r'r(rKrHrK)rDrr iortwisted.python.filepathrtwisted.trial.unittestrrrrFrIrJrKr'r'r'r(s  s