org.eclipse.jgit.transport.ssh

Class SshTestHarness

java.lang.Object

org.eclipse.jgit.junit.LocalDiskRepositoryTestCase

org.eclipse.jgit.junit.RepositoryTestCase

org.eclipse.jgit.transport.ssh.SshTestHarness

Direct Known Subclasses:

SshTestBase

public abstract class SshTestHarness
extends RepositoryTestCase

Root class for ssh tests. Sets up the ssh test server. A set of pre-computed keys for testing is provided in the bundle and can be used in test cases via copyTestResource(String, File). These test key files names have four components, separated by a single underscore: "id", the algorithm, the bits (if variable), and the password if the private key is encrypted. For instance "id_ecdsa_384_testpass" is an encrypted ECDSA-384 key. The passphrase to decrypt is "testpass". The key "id_ecdsa_384" is the same but unencrypted. All keys were generated and encrypted via ssh-keygen. Note that DSA and ec25519 have no "bits" component. Available keys are listed in SshTestBase.KEY_RESOURCES.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SshTestHarness.LogEntry
protected static class	SshTestHarness.TestCredentialsProvider

Field Summary

Fields

Modifier and Type	Field and Description
private SshSessionFactory	factory
private java.io.File	homeDir
protected java.io.File	knownHosts
protected java.io.File	privateKey1
protected java.io.File	privateKey2
protected java.io.File	publicKey1
protected SshTestGitServer	server
protected java.io.File	sshDir
protected static java.lang.String	TEST_USER
protected int	testPort

Fields inherited from class org.eclipse.jgit.junit.RepositoryTestCase

db, trash

Fields inherited from class org.eclipse.jgit.junit.LocalDiskRepositoryTestCase

ASSUME_UNCHANGED, author, committer, CONTENT, CONTENT_ID, LENGTH, mockSystemReader, MOD_TIME, SMUDGE

Constructor Summary

Constructors

Constructor and Description
SshTestHarness()

Method Summary

Modifier and Type	Method and Description
protected java.io.File	cloneWith(java.lang.String uri, java.io.File to, CredentialsProvider provider, java.lang.String... config)
protected void	copyTestResource(java.lang.Class<?> loader, java.lang.String resourceName, java.io.File to) Copies a test data file contained in the test bundle to the given file, using Class.getResourceAsStream(String) to get the test resource.
protected void	copyTestResource(java.lang.String resourceName, java.io.File to) Copies a test data file contained in the test bundle to the given file.
private static byte[]	createHostKey(java.io.OutputStream publicKey)
private static java.io.File	createKeyPair(java.io.File privateKeyFile)
protected static java.lang.String	createKnownHostsFile(java.io.File file, java.lang.String host, int port, java.io.File publicKey) Creates a new known_hosts file with one entry for the given host and port taken from the given public key file.
protected abstract SshSessionFactory	createSessionFactory()
protected SshSessionFactory	getSessionFactory()
protected boolean	hasHostKey(java.lang.String host, int port, java.lang.String keyPart, java.util.List<java.lang.String> lines) Checks whether there is a line for the given host and port that also matches the given key part in the list of lines.
protected abstract void	installConfig(java.lang.String... config)
protected void	pushTo(CredentialsProvider provider, java.io.File localClone)
protected void	pushTo(java.io.File localClone)
void	setUp() Setup test
void	shutdownServer()

Methods inherited from class org.eclipse.jgit.junit.RepositoryTestCase

assertEqualsFile, check, checkFile, checkoutBranch, commitFile, copyFile, createBranch, createEntry, createEntry, createEntry, deleteTrashFile, fsTick, indexState, lookup, read, resetIndex, slashify, writeLink, writeTrashFile, writeTrashFile, writeTrashFiles

Methods inherited from class org.eclipse.jgit.junit.LocalDiskRepositoryTestCase

addRepoToClose, createBareRepository, createRepository, createRepository, createTempDirectory, createTempFile, createUniqueTestGitDir, createWorkRepository, getCeilings, getTemporaryDirectory, indexState, read, recursiveDelete, runHook, tearDown, tick, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEST_USER

protected static final java.lang.String TEST_USER

See Also:

Constant Field Values

sshDir

protected java.io.File sshDir

privateKey1

protected java.io.File privateKey1

privateKey2

protected java.io.File privateKey2

publicKey1

protected java.io.File publicKey1

server

protected SshTestGitServer server

factory

private SshSessionFactory factory

testPort

protected int testPort

knownHosts

protected java.io.File knownHosts

homeDir

private java.io.File homeDir

Constructor Detail

SshTestHarness

public SshTestHarness()

Method Detail

setUp

public void setUp()
           throws java.lang.Exception

Description copied from class: RepositoryTestCase

Setup test

Overrides:

setUp in class RepositoryTestCase

Throws:

java.lang.Exception

createKeyPair

private static java.io.File createKeyPair(java.io.File privateKeyFile)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

createHostKey

private static byte[] createHostKey(java.io.OutputStream publicKey)
                             throws java.lang.Exception

Throws:

java.lang.Exception

createKnownHostsFile

protected static java.lang.String createKnownHostsFile(java.io.File file,
                                                       java.lang.String host,
                                                       int port,
                                                       java.io.File publicKey)
                                                throws java.io.IOException

Creates a new known_hosts file with one entry for the given host and port taken from the given public key file.

Parameters:

file - to write the known_hosts file to

host - for the entry

port - for the entry

publicKey - to use

Returns:

the public-key part of the line

Throws:

java.io.IOException

hasHostKey

protected boolean hasHostKey(java.lang.String host,
                             int port,
                             java.lang.String keyPart,
                             java.util.List<java.lang.String> lines)

Checks whether there is a line for the given host and port that also matches the given key part in the list of lines.

Parameters:

host - to look for

port - to look for

keyPart - to look for

lines - to look in

Returns:

true if found, false otherwise

shutdownServer

public void shutdownServer()
                    throws java.lang.Exception

Throws:

java.lang.Exception

createSessionFactory

protected abstract SshSessionFactory createSessionFactory()

getSessionFactory

protected SshSessionFactory getSessionFactory()

installConfig

protected abstract void installConfig(java.lang.String... config)

copyTestResource

protected void copyTestResource(java.lang.String resourceName,
                                java.io.File to)
                         throws java.io.IOException

Copies a test data file contained in the test bundle to the given file. Equivalent to copyTestResource(Class, String, File) with SshTestHarness.class as first parameter.

Parameters:

resourceName - of the test resource to copy

to - file to copy the resource to

Throws:

java.io.IOException - if the resource cannot be copied

copyTestResource

protected void copyTestResource(java.lang.Class<?> loader,
                                java.lang.String resourceName,
                                java.io.File to)
                         throws java.io.IOException

Copies a test data file contained in the test bundle to the given file, using Class.getResourceAsStream(String) to get the test resource.

Parameters:

loader - Class to use to load the resource

resourceName - of the test resource to copy

to - file to copy the resource to

Throws:

java.io.IOException - if the resource cannot be copied

cloneWith

protected java.io.File cloneWith(java.lang.String uri,
                                 java.io.File to,
                                 CredentialsProvider provider,
                                 java.lang.String... config)
                          throws java.lang.Exception

Throws:

java.lang.Exception

pushTo

protected void pushTo(java.io.File localClone)
               throws java.lang.Exception

Throws:

java.lang.Exception

pushTo

protected void pushTo(CredentialsProvider provider,
                      java.io.File localClone)
               throws java.lang.Exception

Throws:

java.lang.Exception