com.fsryan.tools.logging.test

Class FSLoggingAssertions

com.fsryan.tools.logging.test.FSLoggingAssertions

public class FSLoggingAssertions

A means of making assertions that an event was logged.

Field Detail

INSTANCE

public static FSLoggingAssertions INSTANCE

A means of making assertions that an event was logged.

Method Detail

ensureEnvironment

@JvmStatic
public static void ensureEnvironment()

Check whether the test logger has been added. Note that this DOES NOT force you to make logging synchronous in your tests because, ostensibly, you could have a good reason for multi-threading your tests.

resetTestFSEventLogger

@JvmStatic
 @Nullable
public static kotlin.Unit resetTestFSEventLogger()

Wipe out the data stored in the test event logger. You should do this between each test invocation or apply the class FSLoggingTestExtension extension.

See Also:

class FSLoggingTestExtension

assertTimesIncrementedCountableAttr

@JvmStatic
public static void assertTimesIncrementedCountableAttr(@NotNull
                                                                  java.lang.String attrName,
                                                                  int expected,
                                                                  @Nullable
                                                                  java.lang.String errorMessage)

assertAllStoredAttrs

@JvmStatic
 @Deprecated
public static void assertAllStoredAttrs(@NotNull
                                                                java.util.Map<java.lang.String,java.lang.String> expected,
                                                                @Nullable
                                                                java.lang.String errorMessage)

Deprecated.

Assert the stored attributes (added with FSEventLog.addAttr or FSEventLog.addAttrs). All of the expected attrs must be present.

See Also:

expected

assertAllAttrsStored

@JvmStatic
public static void assertAllAttrsStored(@NotNull
                                                   java.util.Map<java.lang.String,java.lang.String> expectedAttrs,
                                                   boolean allowUnexpectedAttrNames,
                                                   @Nullable
                                                   java.lang.String errorMessage)

assertAttrStored

@JvmStatic
public static void assertAttrStored(@NotNull
                                               java.lang.String attrName,
                                               @NotNull
                                               java.lang.String expectedValue,
                                               @Nullable
                                               java.lang.String errorMessage)

assertAnalyticSequence

@JvmStatic
public static void assertAnalyticSequence(@NotNull
                                                     java.lang.String eventName,
                                                     @NotNull
                                                     java.util.List<? extends java.util.Map<java.lang.String,java.lang.String>> expectedSequence)

assertNoAnalyticsSentWithName

@JvmStatic
public static void assertNoAnalyticsSentWithName(@NotNull
                                                            java.lang.String eventName)

Asserts that no analytics were sent matching an event name

assertAnalyticSent

@JvmStatic
 @JvmOverloads
public static void assertAnalyticSent(@NotNull
                                                                java.lang.String eventName,
                                                                @NotNull
                                                                java.util.Map<java.lang.String,java.lang.String> expectedAttributes,
                                                                @Nullable
                                                                java.lang.String errorMessage,
                                                                boolean allowUnexpectedAttrNames)

assertAnalyticSent

@JvmStatic
 @JvmOverloads
public static void assertAnalyticSent(@NotNull
                                                                java.lang.String eventName,
                                                                @NotNull
                                                                java.util.Map<java.lang.String,java.lang.String> expectedAttributes,
                                                                @Nullable
                                                                java.lang.String errorMessage)

assertAnalyticSent

@JvmStatic
 @JvmOverloads
public static void assertAnalyticSent(@NotNull
                                                                java.lang.String eventName,
                                                                @NotNull
                                                                java.util.Map<java.lang.String,java.lang.String> expectedAttributes)

timesIncrementedCountOfAttr

@JvmStatic
public static int timesIncrementedCountOfAttr(@NotNull
                                                         java.lang.String attrName)

storedAttrs

@JvmStatic
 @NotNull
public static java.util.Map<java.lang.String,java.lang.String> storedAttrs()

sentEvents

@JvmStatic
 @NotNull
public static java.util.List<java.util.Map> sentEvents(@NotNull
                                                                            java.lang.String eventName)