initial commit

.gitignore

@@ -0,0 +1,25 @@
+/target/
+!.mvn/wrapper/maven-wrapper.jar
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/build/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/

.travis.yml

@@ -0,0 +1,19 @@
+language: java
+env:
+  global:
+    # OSSRH_JIRA_USERNAME
+    -  secure: TPbdHAtQGq73vosBm57yROH+uNIJawNQxPmznne+Djq9NMo+q/iWx2l0Yj9VxJqhVlW4UTzRdqXyzY+kgsECAF1XSICDRvkkzIViBVwoIzz0k9DdwM2Ues5FPNz93cH+Tb1zFM6/+irSa5DzGh9abgVgFC3AW01oJ18CzIWytW+M+lHOfWsuqvlg17ttW0SUX9na2cirk0NPOQTQmkGLxUFwWL56J0tymPSc6+Brg7X3wzGqpvE8wIKm+Wt4deimCfQomWUuyfpi6gnwgPktRgcZE9OWZttPYuKMgfuFOwk5UfkVigorpvWnBQtKCvISJc9wmgiH66xBgH2dzfoFwwk6JTQUhNNqIP5L2AJmjyWEHRY93Pu9L7MKBVSzBjQ5kGhJbF6cDUW2HjSDJkGCQrqFYC4IpWPOhO6HLuFjqqejRuR0rNTp76+KU2L+2ThOF7YQoKazgj1KdQJnQGMKBapYgDq0TOpp3MlFwkJbKhkV7oo9DQmo5hL+V5MvH+u/pEpk9+xCNzxnaOJCBZVIwx7hbhjrK6mnSc2jsq2bnAjDXhgKD01l8JGhzn8LfJ56ay/4EKC5jGp4D20rshm3omscMH/dDyJjRsn7mCtHiVmnz6dC/EByIGcUB5gNjN3exYS5PUDoI7Na/UHuaDX4CFDtCBJatQKuh4g6AbRYzoU=
+    # OSSRH_JIRA_PASSWORD
+    - secure: rKnHA4ozbQD8M/mpkKOrzwp6QiDazorI0NxvaedsZel52HGpIURUlJjgErUOzW5b55cAbZrgEYwdBgtprXR4wO9W/K8H6qjEiGbR35HMrn2DTWkSeqwEewB6U2XhxlxBOeBTmLSFLQiVnj06SC0+G12AHdlCECpJoAipEqJ1d8FvHh1Pq9CFbNvPLetl05i/UIZQ10KBfx1y8aznajjkjWhWM7IS636Dj0LJyDKWXFOoAhYtntn6BKo2lPUG1j5f4c/p0ietXIlTkLR+FVVpU7/1KD9GWWWHbu9S4bqT9yQdw5BHUVjxjagWNk9NgspCuDP4Sf1RBCzyVEcavuGQW7isUBi7zMzOGyHzvoyDFGe4uAqtX+EBZaEg4HgrLDPx9GS2FfI6wLThDNf0e7vkniYUhI7hHeYQ0MxMbU+2t38ghBkw5KrCu16PmB+McJzCgoFpk/GquweDUp2XTPu0dQagWB2V15bu9uxrjO4A6h3pWZstjwPjG+825YZX7XjJ5p7v3UkZQNOuZeDVcssGzJSV0L535kUski6xpKd4oi+HXymBCFb3P4vCEViieJKdWHOhgT4n/lKW2sYIP/WOqlC/F/cJ0VOrJ1cApaoEkss/IHADh9DxlAx/7eX15ECNwPEoSwGyjO81ypo+6/aWC9UqJ0jjdoVMmEej7WzZdYA=
+    # GPG_KEY_NAME
+    - secure: ZZpaJVSGWZ4fsqSFlBv/UpRkNBBQv098yLtSBdYz2lCuv3sQtCvxBMG11Yj3cU+bHBpAg+Su6qxHD6yurlrqVanWqHRNRJVxw7/9mFRh5oSACyRwy66d8u1n+grosjxSJNQqHFeFAzhHkXTBULd5tGLhpZrmSd3fYN3MJtBSr9qgLjbKgZKymsqMy+syuoL/ZmjcTEIKZ5t/tYsT9DdAHxhGfr8bYsfEJUpi5ZmYtm/5JsY06pZZNyRkjKtswB8FjcRkn4k75qilSVU4wbwHwCeBvZ0QqkF0h3DIiW7dOEYbSO6Zn2vZbOl6SiAFbV95qSHp7V+gyQCZelwBcUeg4fU5CmVa2R9dyyWYVX/f40xs14vYx1O2nJCfh71dsCw0dCv1lIJeGlLdQ90CW/C22Ioh3C47VAvov5J4T6F28Zb13lTZOxwvzSDRYpXDEF1su9jHZTGrqXCwtczPEY1h6d/DReb5l82MiMkL0Li0uLAHOKYYXNl+9W5d3aQSOOB6kWNB1pxo8veUGz0fii+gBtWff1CIhh8X2/Eii694bwFArFVnPWm5bQJzomOgEbjc5YMki9eUaYmwx2+Y96amzpcmju573LxRqqlWT4GPMxNvmwxGH9pxMu2i0PT36wBg66h+TKdOEcdBEiAn2usrVCoCv7MCKqt2FSDc8t83tos=
+    # GPG_KEY_PASSPHRASE
+    - secure: TtYwboYkbGyeYWDF5+HiBg0N/vFdD/7fHMXGi8Q95S8NrlL7IcB2jqqWLKOvbxTPBC2+FsQwfURctu891c3D/NuI2TR4BWnWCPprdlaCpK4x1gOLZiOGHXlf4pGRzp7X5NmNCqCt9W+Z4SUchXVpudAmKbJSvLhU5UFHBG4IY3VtYPu7lip858oYkRm/Iq8EeTFGs2nJ1002CoVq3DvTNNjIm0Y8JFPpFBF4Y06ivr2B0aVhfDsMtqCfFPe/6eVlE2w2CgS7cQjAKtpZPBNOAdRwS4soAEWbiAZw0JI5PfhAoVLhxaC4IX6aaMHfRnyWYsnSCu8R6i6TccN/MKW+QM3a8ajtdJeEMZcrHAcJOo7ktwFvu/O25YuaENB6ZdR/SV+vmB6MlHkzPuhR6oxtmH5WgwqXknWYBglfiI6tnsoOfwxTxJ4A5M320+7DINDt5dLKCsaElFSe+nhi4IKBzV3ARFFimpdTqGfO0y2X6uqYwVbfi0VgCjFx402blb/ZSTDHoNfBrB8p7iWrqqQZKz/mr9Vhl5nuMdqqJW447AhjVFjjvV9U3jBHfxCoBdXzywCn4lsaIomc+kjaMtCbAGd4+a6gsY3TEsguaVM48neA/w3oTDnT7FGy0NCzYDkJI3tfdnD+KCKQQPTmzn1PT/vNVpIR90OULvptaJ2FXeA=
+jdk: openjdk11
+install: mvn install -P !build-extras -DskipTests=true -Dmaven.javadoc.skip=true -B
+  -V
+script: mvn verify -P !build-extras -B
+cache:
+  directories:
+  - "~/.m2/repository"
+after_success: ".travis/deploy_to_maven_central.sh"

.travis/deploy_to_maven_central.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+if [ "$TRAVIS_BRANCH" = 'master' ] && [ "$TRAVIS_PULL_REQUEST" == 'false' ] || [ ! -z "$TRAVIS_TAG" ]; then
+    openssl aes-256-cbc -K $encrypted_419f3502ba64_key -iv $encrypted_419f3502ba64_iv -in .travis/codesigning.asc.enc -out .travis/codesigning.asc -d
+    gpg --fast-import .travis/codesigning.asc
+
+    if [ ! -z "$TRAVIS_TAG" ]
+    then
+        echo "on a tag -> set pom.xml <version> to $TRAVIS_TAG"
+        mvn --settings .travis/mvnsettings.xml org.codehaus.mojo:versions-maven-plugin:2.1:set -DnewVersion=$TRAVIS_TAG 1>/dev/null 2>/dev/null
+    else
+        echo "not on a tag -> keep snapshot version in pom.xml"
+    fi
+
+    mvn deploy -P sign,build-extras --settings .travis/mvnsettings.xml -DskipTests=true -B -U
+fi

.travis/mvnsettings.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+    <servers>
+        <server>
+            <id>ossrh</id>
+            <username>${env.OSSRH_JIRA_USERNAME}</username>
+            <password>${env.OSSRH_JIRA_PASSWORD}</password>
+        </server>
+    </servers>
+
+    <profiles>
+        <profile>
+            <id>ossrh</id>
+            <activation>
+                <activeByDefault>true</activeByDefault>
+            </activation>
+            <properties>
+                <gpg.executable>gpg</gpg.executable>
+                <gpg.keyname>${env.GPG_KEY_NAME}</gpg.keyname>
+                <gpg.passphrase>${env.GPG_PASSPHRASE}</gpg.passphrase>
+            </properties>
+
+        </profile>
+    </profiles>
+</settings>

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2019 dmTECH GmbH, https://www.dmtech.de
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MAINTAINERS.md

@@ -0,0 +1,2 @@
+Daniel Flassak <[email protected]> (https://github.com/waschmittel)  
+

README.md

@@ -0,0 +1,224 @@
+# log-capture
+
+[<img src="https://opensourcelogos.aws.dmtech.cloud/dmTECH_opensource_logo.svg" height="20" width="130">](https://dmtech.de/)
+[![Build Status](https://travis-ci.org/dm-drogeriemarkt/log-capture.svg?branch=master)](https://travis-ci.org/dm-drogeriemarkt/log-capture)
+
+Helper for Unit/Integration tests with JUnit 4 to test if something has been logged.
+
+Because this is a library, Checkstyle is used to make sure all public classes/methods have appropriate Javadoc.
+
+## Table of Contents
+
+* [Usage:](#Usage)
+  * [Examples:](#Examples)
+    * [Unit Test Example:](#Unit-Test-Example)
+    * [Integration Test Example:](#Integration-Test-Example)
+    * [Example with MDC](#Example-with-MDC)
+* [Usage with non-JUnit Runner](#Usage-with-non-JUnit-Runner)
+  * [Cucumber example](#Cucumber-example)
+    * [Cucumber feature file](#Cucumber-feature-file)
+    * [Cucumber stepdefs](#Cucumber-stepdefs)
+    * [Cucumber DTOs](#Cucumber-DTOs)
+
+## Usage:
+
+### Examples:
+
+#### Unit Test Example:
+
+```java
+package my.company.application;
+
+...
+
+public class MyUnitTest {
+
+    Logger logger = LoggerFactory.getLogger(MyUnitTest.class);
+
+    // captures logs from any packages, but only if the log event's call stack 
+    // indicates that it has been caused by the test
+    @Rule
+    public LogCapture logCapture = LogCapture.forUnitTest();
+
+    @Test
+    public void twoLogMessagesInOrder() {
+        log.info("something interesting"); 
+        log.error("something terrible");
+
+        logCapture
+                .assertLogged(Level.INFO, "^something interesting$") //second parameter is a regular expression
+                .thenLogged(Level.ERROR, "terrible");
+    }
+}
+```
+
+#### Integration Test Example:
+
+```Java
+package my.company.application;
+
+import utility.that.logs.Tool;
+import irrelevant.utility.Irrelevant;
+...
+
+public class MyIntegrationTest {
+
+    Logger logger = LoggerFactory.getLogger(MyIntegrationTest.class);
+
+    // captures only logs from my.company and utility.that.logs and sub-packages
+    @Rule
+    public LogCapture logCapture = LogCapture.forIntegrationTest("my.company", "utility.that.logs");
+
+    @Test
+    public void twoLogMessagesInOrder() {
+        Irrelevant.doSomething();
+        Tool.doSomething();
+
+        log.info("something interesting");
+        log.error("something terrible");
+
+        logCapture
+                .assertLogged(Level.INFO, "^something interesting")
+                .assertLogged(Level.INFO, "^info from utility.that.logs")
+                .thenLogged(Level.ERROR, "terrible");
+    }
+}
+```
+
+#### Example with MDC
+
+```Java
+package my.company.application;
+
+...
+
+import static de.dm.prom.logcapture.ExpectedMdcEntry.withMdc;
+
+...
+
+public class MyUnitTest {
+    Logger logger = LoggerFactory.getLogger(MyUnitTest.class);
+
+    @Rule
+    public LogCapture logCapture = LogCapture.forUnitTest();
+
+    @Test
+    public void logMessageWithMdcInformation() {
+        MDC.put("my_mdc_key", "this is the MDC value");
+        MDC.put("other_mdc_key", "this is the other MDC value");
+        log.info("this message has some MDC information attached");
+
+        logCapture
+            .assertLogged(Level.INFO, "information attached", 
+                withMdc("my_mdc_key", "^this is the MDC value$"),
+                withMdc("other_mdc_key", "^this is the other MDC value$")
+            );
+    }
+}
+```
+
+If assertLogged fails because the message is correct, but the MDC value is wrong, the assertion error will contain the actual MDC values of the last captured log event where the log message and level matched.
+
+This can be useful for debugging purposes. For example, this test code:
+
+```java
+    MDC.put("my_mdc_key", "this is the wrong MDC value");
+    MDC.put("other_mdc_key", "this is the other MDC value");
+    log.info("this message has some MDC information attached");
+
+    logCapture
+        .assertLogged(Level.INFO, "information attached", 
+            withMdc("my_mdc_key", "^something expected that never occurs$"),
+            withMdc("other_mdc_key", "^this is the other MDC value$")
+        );
+```
+
+will output:
+
+```text
+java.lang.AssertionError: Expected log message has occurred, but never with the expected MDC value: Level: INFO, Regex: "information attached"
+  Captured message: "this message has some MDC information attached"
+  Captured MDC values:
+    my_mdc_key: "this is the wrong MDC value"
+    other_mdc_key: "this is the other MDC value"
+```
+
+
+## Usage with non-JUnit Runner
+
+If you intend to use LogCapture outside of a JUnit test, you cannot rely on JUnit's `@Rule` annotation and must call LocCapture's `addAppender()` and `removeAppender()` methods manually.
+
+Be aware that this will still cause JUnit to be a dependency.
+
+### Cucumber example
+
+Here's an Example that shows how to use LogCapture with Cucumber 4:
+
+#### Cucumber feature file
+
+```cucumber
+And with MDC logging context
+  | contextId      | contentRegex                    |
+  | verkaufsbon_vo | ^MDC_JSON_VALUE:.*2401219817317 |
+* the following messages where logged
+  | level | messageRegex   |
+  | INFO  | ^Received bon$ |
+```
+
+#### Cucumber stepdefs
+
+You can create these stepdefs in your project to use log-capture in feature files.
+
+```java
+public class LoggingStepdefs {
+    private ExpectedMdcEntry[] expectedMdcEntries;
+
+    public LogCapture logCapture = LogCapture.forIntegrationTest("my.company.app");
+
+    @Before
+    public void setupLogCapture() {
+        logCapture.addAppender();
+    }
+
+    @And("with MDC logging context")
+    public void withMdcLoggingContext(List<LogContext> logContexts) {
+        List<ExpectedMdcEntry> expectedMdcEntries = new LinkedList<>();
+        logContexts.forEach(logContext -> expectedMdcEntries.add(ExpectedMdcEntry.withMdc(logContext.getContextId(), logContext.getContentRegex())));
+        this.expectedMdcEntries = expectedMdcEntries.toArray(new ExpectedMdcEntry[0]);
+    }
+
+    @And("the following messages where logged")
+    public void followingMessagedLogged(List<LogEntry> logEntries) {
+        LogEntry firstEntry = logEntries.get(0);
+        logEntries.remove(0);
+        LogCapture.LastCapturedLogEvent lastCapturedLogEvent = logCapture.assertLogged(Level.toLevel(firstEntry.getLevel()), firstEntry.getMessageRegex(), expectedMdcEntries);
+        for (LogEntry logEntry : logEntries) {
+            lastCapturedLogEvent = lastCapturedLogEvent.thenLogged(Level.toLevel(logEntry.getLevel()), logEntry.getMessageRegex(), expectedMdcEntries);
+        }
+    }
+}
+```
+
+#### Cucumber DTOs
+
+You need to register these DTOs with Cucumber's [TypeRegistryConfigurer](https://cucumber.io/docs/cucumber/configuration/#type-registry):
+
+```java
+import lombok.Data;
+
+@Data
+public class LogContext {
+    private String contextId;
+    private String contentRegex;
+}
+```
+
+```java
+import lombok.Data;
+
+@Data
+public class LogEntry {
+    private String level;
+    private String messageRegex;
+}
+```