twisted.conch.test.test_knownhosts.KnownHostsDatabaseTests

class documentation

class KnownHostsDatabaseTests(TestCase): (source)

View In Hierarchy

Tests for KnownHostsFile.

Method loadSampleHostsFile Return a sample hosts file, with keys for www.twistedmatrix.com and divmod.com present.
Method pathWithContent Return a FilePath with the given initial content.
Method test_addHostKey KnownHostsFile.addHostKey adds a new HashedEntry to the host file, and returns it.
Method test_defaultInitializerClobbersExisting After using the default initializer for KnownHostsFile, the first use of KnownHostsFile.save overwrites any existing contents in the save path.
Method test_defaultInitializerIgnoresExisting The default initializer for KnownHostsFile disregards any existing contents in the save path.
Method test_getHostKeyAlgorithms For a given host, get the host key algorithms for that host in the known_hosts file.
Method test_hasLaterAddedKey KnownHostsFile.hasHostKey returns True when a key for the given hostname is present in the file, even if it is only added to the file after the KnownHostsFile instance is initialized.
Method test_hasPresentKey KnownHostsFile.hasHostKey returns True when a key for the given hostname is present and matches the expected key.
Method test_iterentriesUnsaved If the save path for a KnownHostsFile does not exist, KnownHostsFile.iterentries still returns added but unsaved entries.
Method test_loadFromPath Loading a KnownHostsFile from a path with six entries in it will result in a KnownHostsFile object with six IKnownHostEntry providers in it.
Method test_loadNonExistent Loading a KnownHostsFile from a path that does not exist should result in an empty KnownHostsFile that will save back to that path.
Method test_loadNonExistentParent Loading a KnownHostsFile from a path whose parent directory does not exist should result in an empty KnownHostsFile that will save back to that path, creating its parent directory(ies) in the process.
Method test_notPresentKey KnownHostsFile.hasHostKey returns False when a key for the given hostname is not present.
Method test_randomSalts KnownHostsFile.addHostKey generates a random salt for each new key, so subsequent salts will be different.
Method test_readOnlySavePath KnownHostsFile.savePath is read-only; if an assignment is made to it, AttributeError is raised and the value is unchanged.
Method test_savedEntryAfterAddHasKeyMismatch Even after a new entry has been added in memory but not yet saved, the HostKeyChanged exception raised by KnownHostsFile.hasHostKey has a lineno attribute which indicates the 1-based line number of the offending entry in the underlying file when the given host key does not match the expected host key.
Method test_savedEntryHasKeyMismatch KnownHostsFile.hasHostKey raises HostKeyChanged if the host key is present in the underlying file, but different from the expected one. The resulting exception should have an offendingEntry indicating the given entry.
Method test_saveResetsClobberState After KnownHostsFile.save is used once with an instance initialized by the default initializer, contents of the save path are respected and preserved.
Method test_savingAddsEntry KnownHostsFile.save will write out a new file with any entries that have been added.
Method test_savingAvoidsDuplication KnownHostsFile.save only writes new entries to the save path, not entries which were added and already written by a previous call to save.
Method test_savingsPreservesExisting KnownHostsFile.save will not overwrite existing entries in its save path, even if they were only added after the KnownHostsFile instance was initialized.
Method test_unsavedEntryHasKeyMismatch KnownHostsFile.hasHostKey raises HostKeyChanged if the host key is present in memory (but not yet saved), but different from the expected one. The resulting exception has a offendingEntry indicating the given entry, but no filename or line number information (reflecting the fact that the entry exists only in memory).
Method test_verifyHashedEntry Loading a KnownHostsFile from a path containing a single valid HashedEntry entry will result in a KnownHostsFile object with one IKnownHostEntry provider.
Method test_verifyHostIPMismatch Verifying a key where the host is present (and correct), but the IP is present and different, should result the deferred firing in a HostKeyChanged failure.
Method test_verifyInvalidKey Verifying an invalid key should return a Deferred which fires with a HostKeyChanged failure.
Method test_verifyKeyForHostAndIP Verifying a key where the hostname is present but the IP is not should result in the key being added for the IP and the user being warned about the change.
Method test_verifyNonPresentECKey Set up a test to verify an ECDSA key that isn't present. Return a 3-tuple of the UI, a list set up to collect the result of the verifyHostKey call, and the sample KnownHostsFile being used.
Method test_verifyNonPresentKey_No Verifying a key where neither the hostname nor the IP are present should result in the UI being prompted with a message explaining as much. If the UI says no, the Deferred should fail with UserRejectedKey.
Method test_verifyNonPresentKey_Yes Verifying a key where neither the hostname nor the IP are present should result in the UI being prompted with a message explaining as much. If the UI says yes, the Deferred should fire with True.
Method test_verifyPlainEntry Loading a KnownHostsFile from a path containing a single valid PlainEntry entry will result in a KnownHostsFile object with one IKnownHostEntry provider.
Method test_verifyUnparsableEncryptionMarker Loading a KnownHostsFile from a path containing an unparseable line that starts with an encryption marker will be represented as an UnparsedEntry instance.
Method test_verifyUnparsableLine Loading a KnownHostsFile from a path that contains an unparseable line will be represented as an UnparsedEntry instance.
Method test_verifyUnparsedComment Loading a KnownHostsFile from a path that contains a comment will result in a KnownHostsFile object containing a UnparsedEntry object.
Method test_verifyUnparsedEntry No summary
Method test_verifyValidKey Verifying a valid key should return a Deferred which fires with True.
Method verifyNonPresentKey Set up a test to verify a key that isn't present. Return a 3-tuple of the UI, a list set up to collect the result of the verifyHostKey call, and the sample KnownHostsFile being used.

Inherited from TestCase:

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method assertFailure Fail if deferred does not errback with one of expectedFailures. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
Method deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
Instance Variable timeout A real number of seconds. If set, the test will raise an error if it takes longer than timeout seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
Method _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
Method _deprecateReactor Deprecate iterate, crash and stop on reactor. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
Method _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
Method _runFixturesAndTest Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
Method _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via TestCase):

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
Method callDeprecated Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
Method runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method shortDescription Undocumented
Instance Variable failureException An exception class, defaulting to FailTest. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable skip None or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the TestResult supports skipping).
Instance Variable suppress None or a list of tuples of (args, kwargs) to be passed to warnings.filterwarnings. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also util.suppress.
Instance Variable todo None, a string or a tuple of (errors, reason) where errors is either an exception class or an iterable of exception classes, and reason is a string. See Todo or makeTodo for more information.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

Method assertAlmostEqual Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertApproximates Fail if first - second > tolerance
Method assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
Method assertIs Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertNotAlmostEqual Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
Method assertRaises Fail the test unless calling the function f with the given args and kwargs raises exception. The failure will report the traceback and call stack of the unexpected exception.
Method assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
Method assertWarns Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def loadSampleHostsFile(self, content=(sampleHashedLine+otherSamplePlaintextLine)+b'\n# That was a blank line.\nThis is just unparseable.\n|1|This also unparseable.\n'): (source)

Return a sample hosts file, with keys for www.twistedmatrix.com and divmod.com present.

def pathWithContent(self, content): (source)

Return a FilePath with the given initial content.

def test_addHostKey(self): (source)

KnownHostsFile.addHostKey adds a new HashedEntry to the host file, and returns it.

def test_defaultInitializerClobbersExisting(self): (source)

After using the default initializer for KnownHostsFile, the first use of KnownHostsFile.save overwrites any existing contents in the save path.

def test_defaultInitializerIgnoresExisting(self): (source)

The default initializer for KnownHostsFile disregards any existing contents in the save path.

def test_getHostKeyAlgorithms(self): (source)

For a given host, get the host key algorithms for that host in the known_hosts file.

def test_hasLaterAddedKey(self): (source)

KnownHostsFile.hasHostKey returns True when a key for the given hostname is present in the file, even if it is only added to the file after the KnownHostsFile instance is initialized.

def test_hasPresentKey(self): (source)

KnownHostsFile.hasHostKey returns True when a key for the given hostname is present and matches the expected key.

def test_iterentriesUnsaved(self): (source)

If the save path for a KnownHostsFile does not exist, KnownHostsFile.iterentries still returns added but unsaved entries.

def test_loadFromPath(self): (source)

Loading a KnownHostsFile from a path with six entries in it will result in a KnownHostsFile object with six IKnownHostEntry providers in it.

def test_loadNonExistent(self): (source)

Loading a KnownHostsFile from a path that does not exist should result in an empty KnownHostsFile that will save back to that path.

def test_loadNonExistentParent(self): (source)

Loading a KnownHostsFile from a path whose parent directory does not exist should result in an empty KnownHostsFile that will save back to that path, creating its parent directory(ies) in the process.

def test_notPresentKey(self): (source)

KnownHostsFile.hasHostKey returns False when a key for the given hostname is not present.

def test_randomSalts(self): (source)

KnownHostsFile.addHostKey generates a random salt for each new key, so subsequent salts will be different.

def test_readOnlySavePath(self): (source)

KnownHostsFile.savePath is read-only; if an assignment is made to it, AttributeError is raised and the value is unchanged.

def test_savedEntryAfterAddHasKeyMismatch(self): (source)

Even after a new entry has been added in memory but not yet saved, the HostKeyChanged exception raised by KnownHostsFile.hasHostKey has a lineno attribute which indicates the 1-based line number of the offending entry in the underlying file when the given host key does not match the expected host key.

def test_savedEntryHasKeyMismatch(self): (source)

KnownHostsFile.hasHostKey raises HostKeyChanged if the host key is present in the underlying file, but different from the expected one. The resulting exception should have an offendingEntry indicating the given entry.

def test_saveResetsClobberState(self): (source)

After KnownHostsFile.save is used once with an instance initialized by the default initializer, contents of the save path are respected and preserved.

def test_savingAddsEntry(self): (source)

KnownHostsFile.save will write out a new file with any entries that have been added.

def test_savingAvoidsDuplication(self): (source)

KnownHostsFile.save only writes new entries to the save path, not entries which were added and already written by a previous call to save.

def test_savingsPreservesExisting(self): (source)

KnownHostsFile.save will not overwrite existing entries in its save path, even if they were only added after the KnownHostsFile instance was initialized.

def test_unsavedEntryHasKeyMismatch(self): (source)

KnownHostsFile.hasHostKey raises HostKeyChanged if the host key is present in memory (but not yet saved), but different from the expected one. The resulting exception has a offendingEntry indicating the given entry, but no filename or line number information (reflecting the fact that the entry exists only in memory).

def test_verifyHashedEntry(self): (source)

Loading a KnownHostsFile from a path containing a single valid HashedEntry entry will result in a KnownHostsFile object with one IKnownHostEntry provider.

def test_verifyHostIPMismatch(self): (source)

Verifying a key where the host is present (and correct), but the IP is present and different, should result the deferred firing in a HostKeyChanged failure.

def test_verifyInvalidKey(self): (source)

Verifying an invalid key should return a Deferred which fires with a HostKeyChanged failure.

def test_verifyKeyForHostAndIP(self): (source)

Verifying a key where the hostname is present but the IP is not should result in the key being added for the IP and the user being warned about the change.

def test_verifyNonPresentECKey(self): (source)

Set up a test to verify an ECDSA key that isn't present. Return a 3-tuple of the UI, a list set up to collect the result of the verifyHostKey call, and the sample KnownHostsFile being used.

def test_verifyNonPresentKey_No(self): (source)

Verifying a key where neither the hostname nor the IP are present should result in the UI being prompted with a message explaining as much. If the UI says no, the Deferred should fail with UserRejectedKey.

def test_verifyNonPresentKey_Yes(self): (source)

Verifying a key where neither the hostname nor the IP are present should result in the UI being prompted with a message explaining as much. If the UI says yes, the Deferred should fire with True.

def test_verifyPlainEntry(self): (source)

Loading a KnownHostsFile from a path containing a single valid PlainEntry entry will result in a KnownHostsFile object with one IKnownHostEntry provider.

def test_verifyUnparsableEncryptionMarker(self): (source)

Loading a KnownHostsFile from a path containing an unparseable line that starts with an encryption marker will be represented as an UnparsedEntry instance.

def test_verifyUnparsableLine(self): (source)

Loading a KnownHostsFile from a path that contains an unparseable line will be represented as an UnparsedEntry instance.

def test_verifyUnparsedComment(self): (source)

Loading a KnownHostsFile from a path that contains a comment will result in a KnownHostsFile object containing a UnparsedEntry object.

def test_verifyUnparsedEntry(self): (source)
def test_verifyValidKey(self): (source)

Verifying a valid key should return a Deferred which fires with True.

def verifyNonPresentKey(self): (source)

Set up a test to verify a key that isn't present. Return a 3-tuple of the UI, a list set up to collect the result of the verifyHostKey call, and the sample KnownHostsFile being used.

This utility method avoids returning a Deferred, and records results in the returned list instead, because the events which get generated here are pre-recorded in the 'ui' object. If the Deferred in question does not fire, the it will fail quickly with an empty list.