com.deque.worldspace

Class A11yAssert

java.lang.Object

junit.framework.Assert

com.deque.worldspace.A11yAssert

public class A11yAssert
extends junit.framework.Assert

Custom assertion library wrapping Deque accessibility tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	A11yAssert.NodeInfoPrinter Interface for printing Accessibility Node Infos to a string.

Method Summary

Modifier and Type	Method and Description
A11yAssert	assertOnFailure(boolean doAssert) Change whether or not failures are asserted or just logged to logcat.
A11yAssert	ignore(java.lang.Class<? extends Rule> clazz) Remove a single rule from the test.
A11yAssert	ignore(java.lang.Class<? extends Rule> clazz, A11yNodeInfo.Matcher matcher) Specify the content description of a failure that you wish to ignore for this test.
A11yAssert	ignoreBeneath(Impact impact) Ignore violations below the given impact level.
void	isAccessible() All assertions should end with isAccessible().
A11yAssert	rule(java.lang.Class<? extends Rule> clazz) Add a rule to the test.
A11yAssert	rules(java.util.Collection<java.lang.Class<? extends Rule>> classes) Add a collection of rules to the test.
A11yAssert	ruleSet(Rule.RuleSet ruleSet) Set rules from a pre built list of rules.
static void	setNodeInfoPrinter(A11yAssert.NodeInfoPrinter nodeInfoPrinter) Change the way Nodes print when reporting results.
static A11yAssert	thatA11yNode(android.content.Context ctx, A11yNodeInfo nodeInfo) Test the given accessibility node.
static A11yAssert	thatInstrumentation(android.app.Instrumentation instrumentation) Test the entire screen content of an Android Instrumentation object.
static A11yAssert	thatRoboActivity(android.app.Activity activity) Test the entire screen content of a robolectric activity.
A11yAssert	verboseOutput() Include passing nodes and the complete accessibility hierarchy in output.

Methods inherited from class junit.framework.Assert

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail, failNotEquals, failNotSame, failSame, format

Methods inherited from class java.lang.Object

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

Method Detail

thatRoboActivity

public static A11yAssert thatRoboActivity(android.app.Activity activity)

Test the entire screen content of a robolectric activity.

Parameters:

activity - The activity containing the root node under test.

Returns:

A new accessibility assertion builder.

thatInstrumentation

public static A11yAssert thatInstrumentation(android.app.Instrumentation instrumentation)

Test the entire screen content of an Android Instrumentation object.

Parameters:

instrumentation - The instrumentation to test

Returns:

A new accessibility assertion builder.

thatA11yNode

public static A11yAssert thatA11yNode(android.content.Context ctx,
                                      A11yNodeInfo nodeInfo)

Test the given accessibility node. This is valid in all situations though it is likely easier and more stable to use one of the other variants.

Parameters:

ctx - The context which contains the node info that is being tested.

nodeInfo - The node info to be tested.

Returns:

A new accessibility assertion builder.

assertOnFailure

public A11yAssert assertOnFailure(boolean doAssert)

Change whether or not failures are asserted or just logged to logcat.

Parameters:

doAssert - If true, a test failure results in an assertion.

Returns:

ignore

public A11yAssert ignore(java.lang.Class<? extends Rule> clazz,
                         A11yNodeInfo.Matcher matcher)

Specify the content description of a failure that you wish to ignore for this test.

Parameters:

clazz - The rule to ignore.

matcher - A matcher object to compare against the node.

Returns:

this

ignoreBeneath

public A11yAssert ignoreBeneath(Impact impact)

Ignore violations below the given impact level. If set to Critical for example, only the most critical violations would count as failures for this test.

Parameters:

impact - The lowest failure impact level.

Returns:

this

isAccessible

public void isAccessible()

All assertions should end with isAccessible(). This is the basic execute method of the assertion builder. Any built assertion should be discarded.

rule

public A11yAssert rule(java.lang.Class<? extends Rule> clazz)

Add a rule to the test. If all rules are being tested, clear the list of rules first.

Parameters:

clazz - A class extending DQA11yRule to be tested.

Returns:

this

rules

public A11yAssert rules(java.util.Collection<java.lang.Class<? extends Rule>> classes)

Add a collection of rules to the test. If all rules are being tested the list of rules will be cleared first.

Parameters:

classes - A list of classes extending DQA11yRule that will be tested.

Returns:

this

ruleSet

public A11yAssert ruleSet(Rule.RuleSet ruleSet)

Set rules from a pre built list of rules.

Parameters:

ruleSet - The rule set to use.

Returns:

this

ignore

public A11yAssert ignore(java.lang.Class<? extends Rule> clazz)

Remove a single rule from the test.

Parameters:

clazz - A class extending DQA11yRule to be removed.

Returns:

this

setNodeInfoPrinter

public static void setNodeInfoPrinter(A11yAssert.NodeInfoPrinter nodeInfoPrinter)

Change the way Nodes print when reporting results.

Parameters:

nodeInfoPrinter -

verboseOutput

public A11yAssert verboseOutput()

Include passing nodes and the complete accessibility hierarchy in output.

Returns:

this