https://github.com/lachlanmckee/timber-junit-rule

A highly configurable JUnit Rule that outputs Timber logs to standard output
https://github.com/lachlanmckee/timber-junit-rule

android java junit junit-test logging testing timber timber-junit-rule timber-logs timber-tree

Last synced: about 8 hours ago
JSON representation

A highly configurable JUnit Rule that outputs Timber logs to standard output

• Host: GitHub
• URL: https://github.com/lachlanmckee/timber-junit-rule
• Owner: LachlanMcKee
• License: mit
• Created: 2017-11-19T17:06:56.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-16T23:53:08.000Z (over 3 years ago)
• Last Synced: 2024-10-31T14:45:43.102Z (7 days ago)
• Topics: android, java, junit, junit-test, logging, testing, timber, timber-junit-rule, timber-logs, timber-tree
• Language: Java
• Homepage:
• Size: 87.9 KB
• Stars: 44
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Timber JUnit-Rule

This library provides a JUnit TestRule that plants a temporary Timber tree that pipes any logs sent via Timber to the standard System.out. Once a unit test has completed, the Timber tree is removed to avoid logging unintended test cases.

The rule is extremely useful for Android JUnit tests, as the Timber logs do not show without planting a tree.

## Usage

Using the library is very straight forward. An example is as follows:

```java

public class TestExample {

    @Rule

    public TimberTestRule timberTestRule = TimberTestRule.builder()

            .minPriority(Log.ERROR)

            .showThread(true)

            .showTimestamp(false)

            .onlyLogWhenTestFails(true)

            .build();

}

```

There are also several factory methods which cover many common cases. These are:

```java

public class TestExample {

    @Rule

    public TimberTestRule logAllAlwaysRule = TimberTestRule.logAllAlways();

    @Rule

    public TimberTestRule logAllOnFailuresRule = TimberTestRule.logAllWhenTestFails();

    @Rule

    public TimberTestRule logErrorsAlwaysRule = TimberTestRule.logErrorsAlways();

    @Rule

    public TimberTestRule logErrorsOnFailuresRule = TimberTestRule.logErrorsWhenTestFails();

}

```

### Configuration

As seen in the example above, there are many ways to modify the output using the following behaviours:

- The minimum log level to output.

- Whether thread ids are shown.

- Whether timestamps are shown.

- Whether to always log, or only log when a unit test fails.

## Download

This library is available on Maven, you can add it to your project using the following gradle dependencies:

```gradle

testCompile 'net.lachlanmckee:timber-junit-rule:1.0.1'

```