ConsoleCaptor

Install library with:

Install with maven

<dependency>
    <groupId>io.github.hakky54</groupId>
    <artifactId>consolecaptor</artifactId>
    <version>1.0.3</version>
    <scope>test</scope>
</dependency>

Install with Gradle

testImplementation 'io.github.hakky54:consolecaptor:1.0.3'

Install with Scala SBT

libraryDependencies += "io.github.hakky54" % "consolecaptor" % "1.0.3" % Test

Install with Apache Ivy

<dependency org="io.github.hakky54" name="consolecaptor" rev="1.0.3" />

Introduction
- Advantages
- Tested Java versions
Usage
- Capture Console Output
- Reuse ConsoleCaptor for multiple tests
Contributing
License

Introduction

Hey, hello there 👋 Welcome. I hope you will like this library ❤️

ConsoleCaptor is a library which will enable you to easily capture the output of the console for unit testing purposes.

Do you want to capture logs? Please have a look at LogCaptor.

Advantages

No mocking required
No custom JUnit extension required
Plug & play
Zero transitive dependencies

Tested Java versions

Java 8
Java 11+

See the unit test ConsoleCaptorShould for all the scenario's.

Usage

Capture console output

public class FooService {

    public void sayHello() {
        System.out.println("Keyboard not responding. Press any key to continue...");
        System.err.println("Congratulations, you are pregnant!");
    }

}

Unit test:

import static org.assertj.core.api.Assertions.assertThat;

import nl.altindag.console.ConsoleCaptor;
import org.junit.jupiter.api.Test;

public class FooServiceShould {

    @Test
    public void captureStandardAndErrorOutput() {
        ConsoleCaptor consoleCaptor = new ConsoleCaptor();

        FooService fooService = new FooService();
        fooService.sayHello();

        assertThat(consoleCaptor.getStandardOutput()).contains("Keyboard not responding. Press any key to continue...");
        assertThat(consoleCaptor.getErrorOutput()).contains("Congratulations, you are pregnant!");
        
        consoleCaptor.close();
    }
}

Initialize ConsoleCaptor once and reuse it during multiple tests with clearOutput() method within the afterEach method:

import nl.altindag.console.ConsoleCaptor;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;

public class FooServiceShould {

    private static ConsoleCaptor consoleCaptor;
    
    @BeforeAll
    public static void setupConsoleCaptor() {
        consoleCaptor = new ConsoleCaptor();
    }

    @AfterEach
    public void clearOutput() {
        consoleCaptor.clearOutput();
    }
    
    @AfterAll
    public static void tearDown() {
        consoleCaptor.close();
    }

    @Test
    public void captureStandardOutput() {
        FooService service = new FooService();
        service.sayHello();

        assertThat(consoleCaptor.getStandardOutput()).contains("Keyboard not responding. Press any key to continue...");
    }

    @Test
    public void captureErrorOutput() {
        FooService service = new FooService();
        service.sayHello();

        assertThat(consoleCaptor.getErrorOutput()).contains("Congratulations, you are pregnant!");
    }

}

Contributing

There are plenty of ways to contribute to this project:

Give it a star
Join the Gitter room and leave a feedback or help with answering users questions
Submit a PR

License

getStandardOutput() not returning anything

Hello,

I am trying to use ConsoleCaptor to get logs from the console. I tried using LogCaptor, but it doesn't seem to work with my Maven repositories, so I resorted to ConsoleCaptor since it seems quick and easy to set up!

Background
I have a class that uses SL4J logging binded to a Log4J2 configuration. I have set up my log4j2.xml file with a Console Appender that logs error messages to the console. I know this works, because when I run the unit tests, I can see the log message printed in the console. I think the issue I am experiencing is ConsoleCaptor not picking up the log message from the console, because when I do a System.out.println(consoleCaptor.getStandardOutput()), nothing is returned.

My pom.xml file has the following dependencies:

<dependencies>
        <dependency>
            <groupId>io.github.hakky54</groupId>
            <artifactId>consolecaptor</artifactId>
            <version>1.0.2</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j18-impl</artifactId>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>2.0.0-alpha7</version>
        </dependency>

In my test file, I have set up ConsoleCaptor as follows:

@BeforeAll
    public static void setupConsoleCaptor() {
        consoleCaptor = new ConsoleCaptor();
    }

    @AfterEach
    public void clearOutput() {
        consoleCaptor.clearOutput();
    }

    @AfterAll
    public static void tearDown() {
        consoleCaptor.close();
    }

Do you have any idea what I might be missing or doing wrong?

hakky54 / console-captor Goto Github PK

console-captor's Introduction

ConsoleCaptor

Install library with:

Install with maven

Install with Gradle

Install with Scala SBT

Install with Apache Ivy

Table of contents

Introduction

Advantages

Tested Java versions

Usage

Capture console output

Unit test:

Initialize ConsoleCaptor once and reuse it during multiple tests with clearOutput() method within the afterEach method:

Contributing

License

console-captor's People

Contributors

Stargazers

Watchers

Forkers

console-captor's Issues

Recommend Projects

Recommend Topics

Recommend Org