org.dataone.client

Class V1ClientArchitectureConformityIT

java.lang.Object

org.dataone.client.V1ClientArchitectureConformityIT

public class V1ClientArchitectureConformityIT
extends Object

This test case parses the MethodCrossReference.xls found on the dataONE architecture site to get information about methods expected to be implemented, and then uses introspection on the client package to get method information on the actual implementations. It also calls out to an echo service which returns information on the message body sent by the implementation, to compare the behavior of the implementations versus what's expected. For example, testing whether method parameters get properly placed in file-parts, param-parts, the URL path, or the URL query string.

Current weaknesses:

• Similarly, HEAD requests don't return message bodies, so "describe" will fail miserably, too.
• the parameter key for the implementation is deduced from the parameter type, which for the most part works, but not always. After a couple times, it's easy to spot the real failures from the fake, but eventually, the tests should account for these parameter naming exceptions.
• Our current implementation of the echo service has been specially configured to handle http PUT methods, so the following is just for awareness. However, by default a django echo server doesn't return message body information from http PUTs. In this case, methods using PUT would return more errors than they should. In that case, manual inspection of the code is needed for validating the method. To help the tester, there's a static property "ignorePUTexceptions" that can be set to true after doing those manual checks.
• Overridden methods may not be properly mapped.

These tests run using a Parameterized JUnit runner, and I haven't figured out how to have eclipse run just one method, so you'll probably have to run it at the class level. Each parameterized test tests one aspect of "conformity" for a given method, and the set of tests is run multiple times, basically once for each method of the api. Note however that if the signatures don't match between documented and implementation, separate iterations will exist for both.

Author:

rnahf

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ECHO_MMP
org.junit.rules.ErrorCollector	errorCollector Tests should use the error collector to handle JUnit assertions and keep going.
protected static String	EXCEPTION_SERVICE
protected static org.apache.commons.logging.Log	log
protected static String	pathInfoBase
protected static String	TEST_SERVICE_BASE

Constructor Summary

Constructors

Constructor and Description
V1ClientArchitectureConformityIT(String methodKey)

Method Summary

Modifier and Type	Method and Description
void	checkEquals(String host, String message, int s1, int s2)
void	checkEquals(String host, String message, String s1, String s2)
void	checkTrue(String host, String message, boolean b)
void	handleFail(String host, String message)
static void	setUp()
static Collection<Object[]>	setUpTestParameters()
void	testEscapedPattern() want to test a particularly confusing bit of logic for the path matching test Note, (String).matches() method will only return true if the pattern includes the entire String under test.
void	testHarness()
void	testHttpVerb() Tests that the documented http verb is the one returned by the echo service.
void	testMethodExceptionHandling() Check the method against all D1 exceptions.
void	testMethodIsDocumented()
void	testMethodIsImplemented()
void	testMethodParameterAgreement()
void	testMethodParameters()
void	testMethodReturnTypeAgreement()
void	testPath()

Methods inherited from class java.lang.Object

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

Field Detail

TEST_SERVICE_BASE

protected static final String TEST_SERVICE_BASE

See Also:

Constant Field Values

ECHO_MMP

protected static final String ECHO_MMP

See Also:

Constant Field Values

EXCEPTION_SERVICE

protected static final String EXCEPTION_SERVICE

See Also:

Constant Field Values

pathInfoBase

protected static String pathInfoBase

log

protected static org.apache.commons.logging.Log log

errorCollector

public org.junit.rules.ErrorCollector errorCollector

Tests should use the error collector to handle JUnit assertions and keep going. The check methods in this class use this errorCollector the check methods

Constructor Detail

V1ClientArchitectureConformityIT

public V1ClientArchitectureConformityIT(String methodKey)

Method Detail

setUp

public static void setUp()
                  throws IOException,
                         org.dataone.client.exception.ClientSideException

Throws:

IOException

org.dataone.client.exception.ClientSideException

setUpTestParameters

public static Collection<Object[]> setUpTestParameters()
                                                throws IOException

Throws:

IOException

testHarness

public void testHarness()

testEscapedPattern

public void testEscapedPattern()

want to test a particularly confusing bit of logic for the path matching test Note, (String).matches() method will only return true if the pattern includes the entire String under test.

testMethodIsDocumented

public void testMethodIsDocumented()

testMethodIsImplemented

public void testMethodIsImplemented()

testMethodParameterAgreement

public void testMethodParameterAgreement()

testMethodReturnTypeAgreement

public void testMethodReturnTypeAgreement()

testHttpVerb

public void testHttpVerb()

Tests that the documented http verb is the one returned by the echo service. Expect HEAD requests to return null (because they can't take message bodies);

testPath

public void testPath()

testMethodParameters

public void testMethodParameters()

testMethodExceptionHandling

public void testMethodExceptionHandling()

Check the method against all D1 exceptions. If it's supposed to be thrown according to the documentation,

checkEquals

public void checkEquals(String host,
                        String message,
                        String s1,
                        String s2)

checkEquals

public void checkEquals(String host,
                        String message,
                        int s1,
                        int s2)

checkTrue

public void checkTrue(String host,
                      String message,
                      boolean b)

handleFail

public void handleFail(String host,
                       String message)