net.shibboleth.tool.xmlsectool

Class BaseTest

java.lang.Object

net.shibboleth.tool.xmlsectool.BaseTest

Direct Known Subclasses:

XSTJ51Test, XSTJ59Test

public abstract class BaseTest
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private String	baseClassPath Base path for class-relative test resource references.
private String	basePackagePath Base path for package-relative test resource references.
private net.shibboleth.utilities.java.support.xml.BasicParserPool	parserPool Initialized parser pool used to parser data.
protected Class<?>	testingClass Class being tested.
private Package	testingPackage Package for the class being tested.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTest(Class<?> clazz) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	assertXMLIdentical(Node expected, Node actual) Checks whether two nodes are identical based on Diff.identical().
protected boolean	canTestECC() Is it worth testing Elliptic Curve signatures?
protected File	classRelativeFile(String which) Returns a test resource File with a name related to the class under test.
protected String	classRelativeResource(String which) Makes a resource reference relative to the class being tested.
net.shibboleth.utilities.java.support.xml.ParserPool	getParserPool() Gets an initialized parser pool.
protected File	getSchemaDirectory() Returns the local test directory containing a useful collection of schema files.
protected org.opensaml.security.x509.X509Credential	getSigningCredential(String which) Acquire a class-local signing credential consisting of a certificate and key.
protected org.opensaml.security.x509.X509Credential	getSigningCredential(String which, String algorithm, Class<?> clazz) Acquire a class-local signing credential consisting of a certificate and key.
private String	nameToPath(String name) Converts the "."-separated name of a class or package into an absolute path.
protected File	packageRelativeFile(String which) Returns a test resource File from the package directory.
protected String	packageRelativeResource(String which) Makes a resource reference relative to the package of the class being tested.
Document	readXMLDocument(String path) Reads in an XML file, parses it, and returns the parsed document.
void	setUp() Setup test class.
protected String	simpleClassRelativeName(String which)
protected void	zapSignatureValues(Document doc) Set all SignatureValues elements to have the value "zap".
protected void	zapSignatureValues(Element root, String value) Set all SignatureValue elements to have the given value.

Methods inherited from class java.lang.Object

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

Field Detail

testingClass

protected final Class<?> testingClass

Class being tested.

baseClassPath

private final String baseClassPath

Base path for class-relative test resource references. Will not end in a '/'.

testingPackage

private final Package testingPackage

Package for the class being tested.

basePackagePath

private final String basePackagePath

Base path for package-relative test resource references. Will always end in a '/'.

parserPool

private net.shibboleth.utilities.java.support.xml.BasicParserPool parserPool

Initialized parser pool used to parser data.

Constructor Detail

BaseTest

protected BaseTest(Class<?> clazz)

Constructor

Method Detail

nameToPath

private String nameToPath(String name)

Converts the "."-separated name of a class or package into an absolute path. Names ending with "Test" have that value stripped before use.

Parameters:

name - name to be converted

Returns:

path to resources associated with the name

classRelativeResource

protected String classRelativeResource(String which)

Makes a resource reference relative to the class being tested. The convention adopted is that the class-relative name is something like "foo.pem", and that this is expanded to "/a/b/c/Bar-foo.pem".

Parameters:

which - class-relative resource name

Returns:

absolute resource name

simpleClassRelativeName

protected String simpleClassRelativeName(String which)

classRelativeFile

protected File classRelativeFile(String which)

Returns a test resource File with a name related to the class under test.

Parameters:

which - class-local name of the file

Returns:

the named File, or null

packageRelativeResource

protected String packageRelativeResource(String which)

Makes a resource reference relative to the package of the class being tested. The convention adopted is that the package-relative name is something like "foo.pem", and that this is expanded to "/a/b/c/foo.pem".

Parameters:

which - package-relative resource name

Returns:

absolute resource name

packageRelativeFile

protected File packageRelativeFile(String which)

Returns a test resource File from the package directory.

Parameters:

which - package-local name of the file

Returns:

the named File, or null

getSchemaDirectory

protected File getSchemaDirectory()

Returns the local test directory containing a useful collection of schema files.

Returns:

the schema directory

setUp

public void setUp()
           throws net.shibboleth.utilities.java.support.component.ComponentInitializationException,
                  org.opensaml.core.config.InitializationException

Setup test class. Creates and initializes the parser pool.

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException - if there is a problem initializing the parser pool

org.opensaml.core.config.InitializationException - if OpenSAML initialization fails

getParserPool

public net.shibboleth.utilities.java.support.xml.ParserPool getParserPool()

Gets an initialized parser pool.

Returns:

initialized parser pool, never null

readXMLDocument

public Document readXMLDocument(String path)
                         throws net.shibboleth.utilities.java.support.xml.XMLParserException

Reads in an XML file, parses it, and returns the parsed document. If the given path is relative (i.e., does not start with a '/') it is assumed to be relative to the class, or to /data if the class has not been set.

Parameters:

path - classpath path to the data file, never null

Returns:

the parsed Document, never null

Throws:

net.shibboleth.utilities.java.support.xml.XMLParserException - thrown if the file does not exist or there is a problem parsing it

assertXMLIdentical

public void assertXMLIdentical(Node expected,
                      Node actual)

Checks whether two nodes are identical based on Diff.identical().

Parameters:

expected - the expected node against which the actual node will be tested, never null

actual - the actual node tested against the expected node, never null

zapSignatureValues

protected void zapSignatureValues(@Nonnull
                      Element root,
                      @Nonnull
                      String value)

Set all SignatureValue elements to have the given value. This is useful for nondeterministic signature methods such as DSA.

Parameters:

root - root DOM Element below which values should be replaced

value - new value to place into all SignatureValue elements

zapSignatureValues

protected void zapSignatureValues(@Nonnull
                      Document doc)

Set all SignatureValues elements to have the value "zap". This is useful for nondeterministic signature methods such as DSA.

Parameters:

doc - Document to operate on

canTestECC

protected boolean canTestECC()

Is it worth testing Elliptic Curve signatures?

Returns:

true if we can test Elliptic Curve signatures

getSigningCredential

protected org.opensaml.security.x509.X509Credential getSigningCredential(String which)
                                                                  throws KeyException,
                                                                         CertificateException

Acquire a class-local signing credential consisting of a certificate and key.

Parameters:

which - name of the credential to acquire

Returns:

the credential

Throws:

KeyException - if the key cannot be acquired

CertificateException - if the certificate cannot be acquired

getSigningCredential

protected org.opensaml.security.x509.X509Credential getSigningCredential(String which,
                                                             String algorithm,
                                                             Class<?> clazz)
                                                                  throws KeyException,
                                                                         CertificateException

Acquire a class-local signing credential consisting of a certificate and key. Checks that the returned credential has an appropriate public key algorithm and class.

Parameters:

which - name of the credential to acquire

algorithm - required public key algorithm

clazz - required public key class or interface

Returns:

the credential

Throws:

KeyException - if the key cannot be acquired

CertificateException - if the certificate cannot be acquired