io.spine.testing

Class Tests

java.lang.Object

io.spine.testing.Tests

public final class Tests
extends java.lang.Object

Utilities for testing.

Method Summary

Modifier and Type	Method and Description
static void	assertHasPrivateParameterlessCtor(java.lang.Class<?> targetClass) Asserts that if the passed class has private parameter-less constructor and invokes it using Reflection.
static void	assertInDelta(long expectedValue, long actualValue, long delta) Asserts that the difference between expected value and actual value is not bigger than the set delta.
static void	assertMatchesMask(com.google.protobuf.Message message, com.google.protobuf.FieldMask fieldMask) Asserts that the passed message has a field that matches the passed field mask.
static void	halt() Reports that a calling method should never be called by throwing AssertionError.
static <T> T	nullRef() Returns null.
static void	repeat(int count, java.lang.Runnable action) Repeats the passed action the count number of times.

Methods inherited from class java.lang.Object

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

Method Detail

assertHasPrivateParameterlessCtor

public static void assertHasPrivateParameterlessCtor(java.lang.Class<?> targetClass)

Asserts that if the passed class has private parameter-less constructor and invokes it using Reflection.

Typically this method is used to add a constructor of a utility class into the covered code.

Example:

 public class MyUtilityShould
     ...
      @Test
     public void have_private_utility_ctor() {
         assertHasPrivateParameterlessCtor(MyUtility.class));
     }
 

nullRef

public static <T> T nullRef()

Returns null.

Use it when it is needed to pass null to a method in tests so that no warnings suppression is needed.

API Note:

The method doesn't take Class<T> to keep the test API small and convenient

assertMatchesMask

public static void assertMatchesMask(com.google.protobuf.Message message,
                                     com.google.protobuf.FieldMask fieldMask)

Asserts that the passed message has a field that matches the passed field mask.

If the passed mask contains repeated message fields, asserts whether that field repeats at least once, e.g. for a mask of

 
     mask {
         paths: friends
     }
 
 

and messages

 
     message Animal {
         string kind = 1;
     }

     message User {
         string name = 1;
         repeated User friends = 2;
         repeated Animal animals = 3;
     }
 
 

the mask matches if a user has at least one friend.

However, a mask

 
     mask {
         paths: animals.kind
     }
 
 

will never match against a user, since if a repeated field is a part of the mask, it should always be the last part of its path.

Parameters:

message - the message to assert

fieldMask - which is matched against the message field

Throws:

java.lang.AssertionError - if the check fails

assertInDelta

public static void assertInDelta(long expectedValue,
                                 long actualValue,
                                 long delta)

Asserts that the difference between expected value and actual value is not bigger than the set delta.

The assertion will be passed if the actual delta equals to the set one.

Parameters:

expectedValue - expected value

actualValue - actual value

delta - the maximum expected difference between the values

repeat

public static void repeat(int count,
                          java.lang.Runnable action)

Repeats the passed action the count number of times.

halt

public static void halt()
                 throws java.lang.AssertionError

Reports that a calling method should never be called by throwing AssertionError.

Throws:

java.lang.AssertionError - always