class documentation

class KeyGenTests(TestCase): (source)

View In Hierarchy

Tests for various functions used to implement the ckeygen script.

Method setUp Patch sys.stdout so tests can make assertions about what's printed.
Method test_changePassphrase changePassPhrase allows a user to change the passphrase of a private key interactively.
Method test_changePassphraseBadKey changePassPhrase exits if the file specified points to an invalid key.
Method test_changePassphraseCreateError changePassPhrase doesn't modify the key file if an unexpected error happens when trying to create the key with the new passphrase.
Method test_changePassphraseEmptyGetPass changePassPhrase exits if no passphrase is specified for the getpass call and the key is encrypted.
Method test_changePassphraseEmptyStringError changePassPhrase doesn't modify the key file if toString returns an empty string.
Method test_changePassphrasePublicKey changePassPhrase exits when trying to change the passphrase on a public key, and doesn't change the file.
Method test_changePassphraseSubtypeV1 changePassPhrase can be told to write the new private key file in OpenSSH v1 format.
Method test_changePassphraseWithBoth changePassPhrase allows a user to change the passphrase of a private key by providing both old and new passphrases without prompting.
Method test_changePassphraseWithOld changePassPhrase allows a user to change the passphrase of a private key, providing the old passphrase and prompting for new one.
Method test_changePassphraseWrongPassphrase changePassPhrase exits if passed an invalid old passphrase when trying to change the passphrase of a private key.
Method test_displayPublicKey displayPublicKey prints out the public key associated with a given private key.
Method test_displayPublicKeyEncrypted displayPublicKey prints out the public key associated with a given private key using the given passphrase when it's encrypted.
Method test_displayPublicKeyEncryptedPassphrasePrompt displayPublicKey prints out the public key associated with a given private key, asking for the passphrase when it's encrypted.
Method test_displayPublicKeyWrongPassphrase displayPublicKey fails with a BadKeyError when trying to decrypt an encrypted key with the wrong password.
Method test_enumrepresentation enumrepresentation takes a dictionary as input and returns a dictionary with its attributes changed to enum representation.
Method test_enumrepresentationBadFormat Test for unsupported fingerprint format
Method test_enumrepresentationsha256 No summary
Method test_keygeneration Undocumented
Method test_printFingerprint printFingerprint writes a line to standard out giving the number of bits of the key, its fingerprint, and the basename of the file from it was read.
Method test_printFingerprintBadFingerPrintFormat printFigerprint raises keys.BadFingerprintFormat when unsupported formats are requested.
Method test_printFingerprintsha256 No summary
Method test_runBadKeytype Undocumented
Method test_saveKey _saveKey writes the private and public parts of a key to two different files and writes a report of this to standard out.
Method test_saveKeyBadFingerPrintformat _saveKey raises keys.BadFingerprintFormat when unsupported formats are requested.
Method test_saveKeyECDSA _saveKey writes the private and public parts of a key to two different files and writes a report of this to standard out. Test with ECDSA key.
Method test_saveKeyECDSAEmptyPassphrase _saveKey will choose an empty string for the passphrase if no-passphrase is True.
Method test_saveKeyEd25519 _saveKey writes the private and public parts of a key to two different files and writes a report of this to standard out. Test with Ed25519 key.
Method test_saveKeyEd25519EmptyPassphrase _saveKey will choose an empty string for the passphrase if no-passphrase is True.
Method test_saveKeyEmptyPassphrase _saveKey will choose an empty string for the passphrase if no-passphrase is True.
Method test_saveKeyNoFilename When no path is specified, it will ask for the path used to store the key.
Method test_saveKeysha256 No summary
Method test_saveKeySubtypeV1 _saveKey can be told to write the new private key file in OpenSSH v1 format.
Instance Variable stdout Undocumented
Method _testrun Undocumented

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 setUp(self): (source)

Patch sys.stdout so tests can make assertions about what's printed.

def test_changePassphrase(self): (source)

changePassPhrase allows a user to change the passphrase of a private key interactively.

def test_changePassphraseBadKey(self): (source)

changePassPhrase exits if the file specified points to an invalid key.

def test_changePassphraseCreateError(self): (source)

changePassPhrase doesn't modify the key file if an unexpected error happens when trying to create the key with the new passphrase.

def test_changePassphraseEmptyGetPass(self): (source)

changePassPhrase exits if no passphrase is specified for the getpass call and the key is encrypted.

def test_changePassphraseEmptyStringError(self): (source)

changePassPhrase doesn't modify the key file if toString returns an empty string.

def test_changePassphrasePublicKey(self): (source)

changePassPhrase exits when trying to change the passphrase on a public key, and doesn't change the file.

def test_changePassphraseSubtypeV1(self): (source)

changePassPhrase can be told to write the new private key file in OpenSSH v1 format.

def test_changePassphraseWithBoth(self): (source)

changePassPhrase allows a user to change the passphrase of a private key by providing both old and new passphrases without prompting.

def test_changePassphraseWithOld(self): (source)

changePassPhrase allows a user to change the passphrase of a private key, providing the old passphrase and prompting for new one.

def test_changePassphraseWrongPassphrase(self): (source)

changePassPhrase exits if passed an invalid old passphrase when trying to change the passphrase of a private key.

def test_displayPublicKey(self): (source)

displayPublicKey prints out the public key associated with a given private key.

def test_displayPublicKeyEncrypted(self): (source)

displayPublicKey prints out the public key associated with a given private key using the given passphrase when it's encrypted.

def test_displayPublicKeyEncryptedPassphrasePrompt(self): (source)

displayPublicKey prints out the public key associated with a given private key, asking for the passphrase when it's encrypted.

def test_displayPublicKeyWrongPassphrase(self): (source)

displayPublicKey fails with a BadKeyError when trying to decrypt an encrypted key with the wrong password.

def test_enumrepresentation(self): (source)

enumrepresentation takes a dictionary as input and returns a dictionary with its attributes changed to enum representation.

def test_enumrepresentationBadFormat(self): (source)

Test for unsupported fingerprint format

def test_enumrepresentationsha256(self): (source)
def test_keygeneration(self): (source)

Undocumented

def test_printFingerprint(self): (source)

printFingerprint writes a line to standard out giving the number of bits of the key, its fingerprint, and the basename of the file from it was read.

def test_printFingerprintBadFingerPrintFormat(self): (source)

printFigerprint raises keys.BadFingerprintFormat when unsupported formats are requested.

def test_printFingerprintsha256(self): (source)
def test_runBadKeytype(self): (source)

Undocumented

def test_saveKey(self): (source)

_saveKey writes the private and public parts of a key to two different files and writes a report of this to standard out.

def test_saveKeyBadFingerPrintformat(self): (source)

_saveKey raises keys.BadFingerprintFormat when unsupported formats are requested.

def test_saveKeyECDSA(self): (source)

_saveKey writes the private and public parts of a key to two different files and writes a report of this to standard out. Test with ECDSA key.

def test_saveKeyECDSAEmptyPassphrase(self): (source)

_saveKey will choose an empty string for the passphrase if no-passphrase is True.

def test_saveKeyEd25519(self): (source)

_saveKey writes the private and public parts of a key to two different files and writes a report of this to standard out. Test with Ed25519 key.

def test_saveKeyEd25519EmptyPassphrase(self): (source)

_saveKey will choose an empty string for the passphrase if no-passphrase is True.

def test_saveKeyEmptyPassphrase(self): (source)

_saveKey will choose an empty string for the passphrase if no-passphrase is True.

def test_saveKeyNoFilename(self): (source)

When no path is specified, it will ask for the path used to store the key.

def test_saveKeysha256(self): (source)
def test_saveKeySubtypeV1(self): (source)

_saveKey can be told to write the new private key file in OpenSSH v1 format.

Undocumented

def _testrun(self, keyType, keySize=None, privateKeySubtype=None): (source)

Undocumented