/assertlog

Unit-tests for your logging

Primary LanguageJavaMIT LicenseMIT

assertlog

Unit-tests for your logging

https://github.com/codeborne/assertlog

Build Status Maven Central MIT License Free

What is AssertLog?

AssertLog is a library for unit-testing logging in your application.

Sometimes logging is very important, especially if it contains sensitive information, security incidents, money transfers etc.

Here is how you can use AssertLog:

import org.assertlog.junit4.log4j.MockLogging;
import org.junit.Rule;
import org.junit.Test;

public class PetClinicTest {
  @Rule
  public MockLogging mockLogging = new MockLogging();

  @Test
  public void payment() {
      // make a payment
      mockLogging.assertLogged("INFO", "Buying 2 Cows for 99.66 eur");
  }
  
  @After
  public void tearDown() {
    mockLogging.assertNoMoreLogs();
  }
}

What logging frameworks are supported?

We plan to support all major Java logging frameworks. Currently only Log4j 1 and JUnit 4 are supported.

Dependency

You need to add this dependency to you pom.xml:

<dependency>
  <groupId>com.codeborne.assertlog</groupId>
  <artifactId>assertlog-log4j-junit4</artifactId>
  <version>0.1</version>
  <scope>test</scope>
</dependency>

or build.gradle:

testImplementation('com.codeborne.assertlog:assertlog-log4j-junit4:0.1')

License

AssertLog is open-source project, and distributed under the MIT license.