CITS5501 lab 3 (week 4) – ISP – solutions
Suppose you are asked to write tests for a Java method in the
AgePricing
class, whose Javadoc and signature are as
follows:
/** Returns true if age is eligible for adult ticket price.
*
* @arg age The age of the customer
* @return true if someone of that age is eligible for the adult ticket price,
* false otherwise.
*/
public static boolean isAdult(int age);
Elsewhere in the API documentation, you’re told that any person who is 18 or over is considered an adult.
Suppose also you’re given the following JUnit test for this method. (There’s no need to compile and run it, but you’re welcome to do so if you want.)
import static org.junit.jupiter.api.Assertions.*;
import org.junit.jupiter.api.Test;
class AgePricingTest {
@Test
void adultAgeShouldReturnTrue() {
assertTrue(AgePricing.isAdult(30));
}
}
The above test is the only test currently in place, and we aren’t given access to the implementation.
Is this one test enough to be confident that the method works? If not, come up with additional test cases.1 Think about:
Sample solutions:
This one test is not enough to be confident the method
works. The method implementation ought to be extremely simple – just
return age >= 18
– but if we want have high confidence
that the method is implemented correctly, we should probably check, in
addition to the “30” case:
Once those tests are in place, we still don’t know for sure
that the method is correct in all cases – the only way of knowing that
would be to test every single int
value – but our
confidence in it should be much higher. It’s possible that the
implementer of the method has written it as
public static boolean isAdult(int age) {
if (age == 999)
return false;
else
return age >= 18;
}
But unless the implementer is trying to be deliberately unhelpful, that seems unlikely. More realistically, if there is a mistake, it would be
<=
or >
instead of >=
), or (less likely)Given the sorts of mistake an implementer is likely to make, the four tests above (including the original test) should give us a high confidence the method works.
Beyond that, any additional tests reach a point of diminishing returns – they don’t increase our confidence much, and the extra tests constitute additional code that needs to be maintained. (You might like to think about: why don’t the additional tests increase our confidence? Then read the material in the textbook about Input Space Partitioning and see if that helps you formulate your answer.)
In lectures, we’ve mentioned that Java code can be instrumented so that, after your tests run, a coverage tool can report which lines of implementation code were executed. One such tool is JaCoCo (Java Code Coverage), which integrates with build systems and IDEs to produce coverage reports: https://www.jacoco.org/jacoco/.
Suppose we now are given access to the implementation of the
isAdult(int age)
method (feel free to suggest a plausible
one). We instrument the method, and run the original single-test suite,
then later your improved multi-test suite.
Do you think the reported line coverage will change between the two suites? Why or why not? If the reported coverage doesn’t change, what does that tell you about the limitations of line coverage as a measure of how thoroughly a method has been tested?
Sample solutions:
The line coverage will almost certainly not change – it will likely be exactly the same for both test suites.
As we’ve noted, the implementation is likely to be (assuming it is correctly written):
public static boolean isAdult(int age) {
return age >= 18;
}
So there is only one line in the body – and all possible
execution paths are short and go through the same single statement. Even
with just the first test (age = 30), that line is executed. Adding more
tests (e.g. boundary values) executes the same set of lines — so the
line coverage number doesn’t increase. (It’s possible, though not
likely, that a naive implementer might write the method using an
if ... else
statement – but even then, one “false” and one
“true” test case suffice to exercise all the lines in it.)
What does this tell us about the limitations of line coverage?
Line coverage measures whether a line was executed at least once, not
how thoroughly its behaviour was tested. In our example, we can have
100% line coverage while missing critical behaviours at boundaries
(e.g., age == 18) or in invalid input cases. For a boolean expression
(age >= 18
) with only one variable in it, there will
likely not be too many boundaries (just one in fact) – but hopefully you
can see that more complex expressions would give rise to more complex
boundaries. Good testing needs to explore different conditions and equivalence
classes, not just “touch every line”. In the material from this week
and the following weeks, we’ll look at ways of assessing coverage which
go beyond simple metrics of “number of lines executed”. ISP, graph-based
testing, logic-based testing, and syntax-based testing all do the
following:
Pre-reading for remaining exercises
The remaining exercises in this worksheet assume general familiarity with the steps of Input Space Partitioning, so it’s recommended you complete the recommended reading for week 4 from the textbook before attempting them.
Consider the Javadoc documentation and signature for the following
Java method, which searches inside an array of char
s for a
particular value.
(Adapted from the Android version of the Java standard library.)
/**
* Performs a binary search for @code value in the ascending sorted
* array @code array, in the range specified by fromIndex (inclusive)
* and toIndex (exclusive). Searching in an unsorted array has an
* undefined result. It's also undefined which element is found if there
* are multiple occurrences of the same element.
*
* @param array the sorted array to search.
* @param startIndex the inclusive start index.
* @param endIndex the exclusive start index.
* @param value the element to find.
* @return the non-negative index of the element, or a negative index
* which is <code>-index - 1</code> where the element would be
* inserted.
* @throws IllegalArgumentException if <code>startIndex > endIndex</code>
* @throws ArrayIndexOutOfBoundsException if
* <code>startIndex < 0 || endIndex > array.length</code>
* @since 1.6
*/
public static int binarySearch(char[] array, int startIndex, int endIndex, char value)
Based on the prescribed reading, discuss how you would go about creating tests using Input Space Partitioning.
Once you’ve answered these questions, you might like to try implementing some of your tests in Java using JUnit.
Sample solutions:
a. Steps involved are:
b. input domain
The input domain consists of:
char
s (for
all practical purposes, we can consider this domain as being infinite in
size)int
s (2 parameters of this
sort)char
s (if we assume for
simplicity that only ASCII characters are used,2
there are 256 of them)Technically, the input domain consists of a 4-tuple made up of (arrays-of-chars, ints, ints, chars). (We could, if needed, make the sets here a little more mathematically precise, but it’s not needed for our purposes.)
c. Characteristics and partitions:
Some characteristics we could use for our int
s are:
array.length - 1
)?Some comments on these:
Characteristic (i) is acceptable, but not a particularly useful
characteristic in this case. Ask yourself: is it especially likely that
the sorting routine would treat positive and negative values
differently? If not, then what is the point of dividing an
int
up in this way? Recall that the purpose of partitioning
is to divide a domain up into equivalence classes – values where any one
value is likely to be as good as any other. For a sorting routine,
that’s already true of an int
– there is little
value to be got from splitting it up further (though you might do so for
completeness, once other, more useful characteristics have been
applied).
In fact, this characteristic is something a machine might come up with (interface-based), as opposed to a person thinking about the intended behaviour of the method.
Characteristic (iii) is a characteristic of two parameters combined (which is fine).
For characteristic (iv) - all of these partitions are
sensible, and are worth testing for. When the first parameter is greater
than the second, then the method documentation says an
IllegalArgumentException
should be thrown – so we should
test for that and make sure that it is.
(You might ask: why should we write a test just to make sure some exception is thrown? The answer is that this is part of the “contract” of the method, and is important. In practice, software developers do want to know what exceptions a method can throw, and do rely on methods throwing what they say they will.)
Some characteristics we could use for our array are:
Note that a characteristic like “is the array in ascending sorted order?” is not a useful characteristic here. The array must be in ascending sorted order; that’s a precondition of calling the method, and if it’s not true, the behaviour is undefined, so what “expected behaviour” could we possibly test for?
Some characteristics we could use for our char are:
(These are boundary values for the char
type.)
Suppose we have a Stack class that is intended to implement the stack
abstract data type. The class stores int
s, and provides
methods for observing the state of the stack, and for performing the
“push” and “pop” operations. The method signatures for the class are as
follows:
public IntStack ();
public void push (int i);
public int pop (); /** Throws an exception if empty */
public boolean isEmpty()
Assume the object state consists of an int
array.
push
as a function, what sort of
function would we use? How about pop
?pop
method, and
suggest some characteristics that can be used to partition the input
space.Sample solutions:
a. We would model the push
Java method as a mathematical
function that maps from “the old state” and an integer, to a new
state:
\[ push : ([\mathbb{Z}], \mathbb{Z}) \rightarrow [\mathbb{Z}] \]
(We use \([\mathbb{Z}]\) here to indicate an array of integers.)
If we wanted our mathematical notation to be a little more informative to a reader, we could say:
push
be a function with signature: \(push : (StateOfStack, \mathbb{Z}) \rightarrow
StateOfStack\)Basically, the function is treating the method as if it were
something more like a static
Java method with the signature
static [int] push( int oldState[], int i)
, which takes
in a state, and returns a new state.
For pop
, we would model it as \(pop : [\mathbb{Z}] \rightarrow (\mathbb{Z},
[\mathbb{Z}])\) – a function that takes in the state of the
stack, and returns a result and a new state. That is, it’s as if the
method instead of having signature public int pop ()
had
instead a signature something like
static Pair<int, [int]> pop()
.
(See https://docs.oracle.com/javase/9/docs/api/javafx/util/Pair.html
for the Pair
type.)
b. Pop has effectively one parameter, the object state.
Some possible characteristics:
Note that it doesn’t make sense to have “nullness” as a characteristic. If the array were null, the object would be in an invalid state, and what “expected behaviour” could we possibly test for?
Consider the following questions about ISP and try writing an answer to each. (Questions like this are typical of ones you might be asked in the mid-semester test or final exam.) Once you’ve made an attempt, you might like to drop in on a timetabled lab session to compare your answers with other students’.
There is not necessarily any single correct answer to such questions; students are expected to base their answers on the information covered in class and in previous units, and on reasonable deductions they can make from those.
Suppose we need to test some method (let’s suppose it is a static
method myMethod
that takes one int
for the
sake of argument, and that it’s sensible to partition it into positive,
negative and 0-valued int
s. i.e. the signature is
static myMethod(int i)
).
Suppose you’ve already written three tests for the function; each of your 3 tests uses a test value from one partition.
Your supervisor says three tests is not enough, and you should write more. What do you think? Would more tests be better? Could more tests be worse?
Research suggests that the later in the development life cycle a fault is discovered, the more expensive it is to fix. Why do you think this is so?
a. Number of tests
The idea behind partitioning is that we’ve split the domain up into what are called equivalence classes, where any one value from each partition is “as good as any other” (so far as the behaviour of the method is concerned).
If that really is the case, then once we have three tests for
myMethod
, writing more tests adds nothing of value. In
fact, excessive tests could make things worse: more tests means
regression tests become slower to run, and we have more code to
maintain. Every test you write should “carry its weight” – it should
serve some useful purpose, and add more value than it costs to
maintain.
So – if these really are equivalence classes, then writing more tests adds nothing of value. But in fact, we know that programmers tend to make mistakes around boundaries, so it’s not quite true that every value from each partition is “as good as” any other.
We could add in tests that use -1 and 1 as test values (or maybe even
the maximum and minimum values of an int
), and still have
tests that “carry their weight”.
b. Costs of fixing defects
The main reason is that the component which contains the fault becomes a more and more integral part of the system, and affects more components – the fault has become “built in” to the documentation, larger components, other tests, etc.
This means that fixing the fault is (a) likely to take more effort, because we have to consider all the other components/documentation/tests that it affects, and (b) can have unexpected consequences – our components may interact in complex ways.
As a reminder – when being asked to come up with
test cases, you just need to come up with descriptions of
tests; you’re not being asked to write code (refer to the week
1 lectures) – if an assessment is asking you to write code, it will say
so (e.g. “Write JUnit 5-based tests for your test cases”).
Each test case must specify (i) the inputs to the thing being
tested, and (ii) the expected outputs or results. The “thing being
tested” is sometimes referred to as the subject under test.↩︎
In actuality, Java char
s are 2 bytes in
size and can hold 65,536 distinct values, representing a subset of Unicode code points –
see e.g. the documentation for the Character
class for the version of Java you’re interested in.
In Java, methods that need to take a “character” (in the broad
sense) as an argument can do so in two ways: they can take a
char
, or they can take an int
.
If they take a char
, they’ll be limited to the 65,536
possible values of a char
. If they take an
int
, then they can represent all possible code points
(there are 1,114,112 of them), but also will have to deal with values
outside that range (e.g. by throwing an exception, or having undefined
behaviour). Assuming the int
does represent a possible code
point, it may or may not be assigned to some actual character – in Unicode version
16.0, only 154,998 characters are assigned so far – so again may
need some way of handling invalid values. Different versions of Java
will implement different versions of the Unicode standard, so the exact
number of assigned code points will vary from version to version.
An example of a method taking an int
is the indexOf
method of the java.lang.String
class. That method says what the behaviour of the function will be
if an int
is passed that falls in the U+0000 to U+10FFFF
range (1,114,112 values), but doesn’t say what the behaviour will be if
an int
outside that range is passed; so we must take the
behaviour to be undefined.
When answering questions in tests or exams, you’re welcome to make
simplifying assumptions, if needed; since you probably won’t have access
to the Unicode standard, you can make the simplifying assumption that
we’re only considering ASCII characters. (You should clearly state that
you’re making this assumption, however, and that the actual number of
characters is larger.) Markers are generally more interested in your
reasoning than in whether you can recall exactly the size of a
char
or how many Unicode characters there are, so this sort
of simplifying assumption is fine.↩︎