Skip to content

Move cloud-logging from JUnit4 to JUnit5 #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion cf-java-logging-support-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,23 @@
<version>${logback.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest</artifactId>
<version>${hamcrest.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.12.0</version>
<version>${commons-lang3.version}</version>
</dependency>
</dependencies>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
package com.sap.hcp.cf.logging.common;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import org.junit.Test;

import com.sap.hcp.cf.logging.common.helper.Environment;

import org.junit.jupiter.api.Test;

public class LogOptionalFieldsSettingsTest {

@Test
Expand All @@ -21,10 +21,10 @@ public void testLogOptionalFieldsSettingsTrue() {

LogOptionalFieldsSettings settings = new LogOptionalFieldsSettings(mockEnvironment, "NameOfInvokingClass");

assertTrue("Wrapping LOG_SENSITIVE_CONNECTION_DATA failed", settings.isLogSensitiveConnectionData());
assertTrue("Wrapping LOG_REMOTE_USER failed", settings.isLogRemoteUserField());
assertTrue("Wrapping LOG_REFERER failed", settings.isLogRefererField());
assertTrue("Wrapping LOG_SSL_HEADERS failed", settings.isLogSslHeaders());
assertTrue(settings.isLogSensitiveConnectionData(), "Wrapping LOG_SENSITIVE_CONNECTION_DATA failed");
assertTrue(settings.isLogRemoteUserField(), "Wrapping LOG_REMOTE_USER failed");
assertTrue(settings.isLogRefererField(), "Wrapping LOG_REFERER failed");
assertTrue(settings.isLogSslHeaders(), "Wrapping LOG_SSL_HEADERS failed");
}

@Test
Expand All @@ -37,10 +37,10 @@ public void testLogOptionalFieldsSettingsFalse() {

LogOptionalFieldsSettings settings = new LogOptionalFieldsSettings(mockEnvironment, "NameOfInvokingClass");

assertFalse("Wrapping LOG_SENSITIVE_CONNECTION_DATA failed", settings.isLogSensitiveConnectionData());
assertFalse("Wrapping LOG_REMOTE_USER failed", settings.isLogRemoteUserField());
assertFalse("Wrapping LOG_REFERER failed", settings.isLogRefererField());
assertFalse("Wrapping LOG_SSL_HEADERS failed", settings.isLogSslHeaders());
assertFalse(settings.isLogSensitiveConnectionData(), "Wrapping LOG_SENSITIVE_CONNECTION_DATA failed");
assertFalse(settings.isLogRemoteUserField(), "Wrapping LOG_REMOTE_USER failed");
assertFalse(settings.isLogRefererField(), "Wrapping LOG_REFERER failed");
assertFalse(settings.isLogSslHeaders(), "Wrapping LOG_SSL_HEADERS failed");
}

@Test
Expand All @@ -52,10 +52,10 @@ public void testLogOptionalFieldsSettingsInvalidEnvVariable() {
when(mockEnvironment.getVariable(Environment.LOG_SSL_HEADERS)).thenReturn("someInvalidString");

LogOptionalFieldsSettings settings = new LogOptionalFieldsSettings(mockEnvironment, "NameOfInvokingClass");
assertFalse("Wrapping LOG_SENSITIVE_CONNECTION_DATA failed", settings.isLogSensitiveConnectionData());
assertFalse("Wrapping LOG_REMOTE_USER failed", settings.isLogRemoteUserField());
assertFalse("Wrapping LOG_REFERER failed", settings.isLogRefererField());
assertFalse("Wrapping LOG_SSL_HEADERS failed", settings.isLogSslHeaders());
assertFalse(settings.isLogSensitiveConnectionData(), "Wrapping LOG_SENSITIVE_CONNECTION_DATA failed");
assertFalse(settings.isLogRemoteUserField(), "Wrapping LOG_REMOTE_USER failed");
assertFalse(settings.isLogRefererField(), "Wrapping LOG_REFERER failed");
assertFalse(settings.isLogSslHeaders(), "Wrapping LOG_SSL_HEADERS failed");
}

@Test
Expand All @@ -67,10 +67,10 @@ public void testLogOptionalFieldsSettingsEmptyString() {
when(mockEnvironment.getVariable(Environment.LOG_SSL_HEADERS)).thenReturn("");

LogOptionalFieldsSettings settings = new LogOptionalFieldsSettings(mockEnvironment, "NameOfInvokingClass");
assertFalse("Wrapping LOG_SENSITIVE_CONNECTION_DATA failed", settings.isLogSensitiveConnectionData());
assertFalse("Wrapping LOG_REMOTE_USER failed", settings.isLogRemoteUserField());
assertFalse("Wrapping LOG_REFERER failed", settings.isLogRefererField());
assertFalse("Wrapping LOG_SSL_HEADERS failed", settings.isLogSslHeaders());
assertFalse(settings.isLogSensitiveConnectionData(), "Wrapping LOG_SENSITIVE_CONNECTION_DATA failed");
assertFalse(settings.isLogRemoteUserField(), "Wrapping LOG_REMOTE_USER failed");
assertFalse(settings.isLogRefererField(), "Wrapping LOG_REFERER failed");
assertFalse(settings.isLogSslHeaders(), "Wrapping LOG_SSL_HEADERS failed");
}

@Test
Expand All @@ -83,10 +83,10 @@ public void testLogOptionalFieldsSettingsEmptyEnvVariable() {

LogOptionalFieldsSettings settings = new LogOptionalFieldsSettings(mockEnvironment, "NameOfInvokingClass");

assertFalse("Wrapping LOG_SENSITIVE_CONNECTION_DATA failed", settings.isLogSensitiveConnectionData());
assertFalse("Wrapping LOG_REMOTE_USER failed", settings.isLogRemoteUserField());
assertFalse("Wrapping LOG_REFERER failed", settings.isLogRefererField());
assertFalse("Wrapping LOG_SSL_HEADERS failed", settings.isLogSslHeaders());
assertFalse(settings.isLogSensitiveConnectionData(), "Wrapping LOG_SENSITIVE_CONNECTION_DATA failed");
assertFalse(settings.isLogRemoteUserField(), "Wrapping LOG_REMOTE_USER failed");
assertFalse(settings.isLogRefererField(), "Wrapping LOG_REFERER failed");
assertFalse(settings.isLogSslHeaders(), "Wrapping LOG_SSL_HEADERS failed");
}

@Test
Expand All @@ -99,10 +99,10 @@ public void testLogOptionalFieldsWithMixedSettings() {

LogOptionalFieldsSettings settings = new LogOptionalFieldsSettings(mockEnvironment, "NameOfInvokingClass");

assertFalse("Wrapping LOG_SENSITIVE_CONNECTION_DATA failed", settings.isLogSensitiveConnectionData());
assertTrue("Wrapping LOG_REMOTE_USER failed", settings.isLogRemoteUserField());
assertTrue("Wrapping LOG_REFERER failed", settings.isLogRefererField());
assertFalse("Wrapping LOG_SSL_HEADERS failed", settings.isLogSslHeaders());
assertFalse(settings.isLogSensitiveConnectionData(), "Wrapping LOG_SENSITIVE_CONNECTION_DATA failed");
assertTrue(settings.isLogRemoteUserField(), "Wrapping LOG_REMOTE_USER failed");
assertTrue(settings.isLogRefererField(), "Wrapping LOG_REFERER failed");
assertFalse(settings.isLogSslHeaders(), "Wrapping LOG_SSL_HEADERS failed");
}

}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package com.sap.hcp.cf.logging.common;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;
import static org.junit.Assert.assertThat;

import org.junit.Test;
import org.junit.jupiter.api.Test;

public class TestDoubleValue {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package com.sap.hcp.cf.logging.common;

import static org.junit.Assert.assertTrue;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;

import org.junit.Test;
import org.junit.jupiter.api.Test;

public class TestVcapEnvReader {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
package com.sap.hcp.cf.logging.common.converter;

import static org.hamcrest.Matchers.contains;
import static org.junit.Assert.assertThat;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.contains;
import static org.junit.jupiter.api.Assertions.assertThrows;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;
import org.junit.Test;
import java.util.List;

import org.junit.jupiter.api.Test;

public class LineWriterTest {

@Test
Expand All @@ -29,11 +30,13 @@ public void fillLinesWithIgnoredOffsetAndLength() throws IOException {
assertThat(lines.getLines(), contains("first line", "second line"));
}

@Test(expected = IndexOutOfBoundsException.class)
public void readNonexistentEntry() throws IOException {
LineWriter lines = new LineWriter();
lines.close();
lines.getLines().get(10);
@Test
public void readNonexistentEntry() {
assertThrows(IndexOutOfBoundsException.class, () -> {
LineWriter lines = new LineWriter();
lines.close();
lines.getLines().get(10);
});
}

@Test
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
package com.sap.hcp.cf.logging.common.converter;

import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.lessThan;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.junit.Test;

import java.util.List;
import java.util.concurrent.TimeUnit;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;

public class StacktraceLinesTest {

final List<String> lines = new ArrayList<String>(Arrays.asList("this is the first line", "this is the second line",
Expand Down Expand Up @@ -46,9 +48,10 @@ public void testStacktraceLinesGetFirstLinesUnderestimatingSizeOfFirstLine() {
StacktraceLines stackTraceLines = new StacktraceLines(lines);
List<String> extractedLines = stackTraceLines.getFirstLines(maxSizeOfFirstPart);
assertThat(extractedLines.size(), equalTo(0));
}

@Test(timeout = 1000)
}

@Test
@Timeout(value = 1000, unit = TimeUnit.MILLISECONDS)
public void testStacktraceLinesGetFirstLinesOverEstimatingTotalSizeOfLines() {
int maxSizeOfFirstPart = 2500;
StacktraceLines stackTraceLines = new StacktraceLines(lines);
Expand Down Expand Up @@ -76,9 +79,10 @@ public void testStacktraceLinesGetLastLinesUnderestimatingSizeOfLastLine() {
StacktraceLines stackTraceLines = new StacktraceLines(lines);
List<String> extractedLines = stackTraceLines.getLastLines(maxSizeOfLastPart);
assertThat(extractedLines.size(), equalTo(0));
}

@Test(timeout = 1000)
}

@Test
@Timeout(value = 1000, unit = TimeUnit.MILLISECONDS)
public void testStacktraceLinesGetLastLinesOverEstimatingTotalSizeOfLines() {
int maxSizeOfFirstPart = 2500;
StacktraceLines stackTraceLines = new StacktraceLines(lines);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.nullValue;

import org.junit.Before;
import org.junit.Test;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import com.sap.hcp.cf.logging.common.Defaults;
import com.sap.hcp.cf.logging.common.Fields;
import com.sap.hcp.cf.logging.common.LogContext;

public class HttpHeadersTest {

@Before
@BeforeEach
public void resetLogContext() {
LogContext.resetContextFields();
HttpHeaders.propagated().stream().map(HttpHeader::getField).forEach(LogContext::remove);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
package com.sap.hcp.cf.logging.common.request;

import static com.sap.hcp.cf.logging.common.request.RequestRecordBuilder.requestRecord;
import static org.junit.Assert.assertEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;

import java.io.IOException;

import org.junit.Test;

import com.fasterxml.jackson.jr.ob.JSON;
import com.fasterxml.jackson.jr.ob.JSONObjectException;
import org.junit.jupiter.api.Test;

import com.sap.hcp.cf.logging.common.Defaults;

public class RequestRecordBuilderTest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
import java.time.Instant;
import java.time.ZoneOffset;

import org.junit.Before;
import org.junit.Test;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.slf4j.MDC;

import com.fasterxml.jackson.jr.ob.JSON;
Expand All @@ -31,7 +31,7 @@ public class RequestRecordTest {

private RequestRecord rrec;

@Before
@BeforeEach
public void resetRequestRecordClock() {
setRequestRecordClock(FIXED_CLOCK_EPOCH);
}
Expand Down
16 changes: 11 additions & 5 deletions cf-java-logging-support-jersey/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

<properties>
<jersey.version>2.22.1</jersey.version>
<jaxb.version>2.3.0</jaxb.version>
<javax.activation.version>1.1.1</javax.activation.version>
</properties>

<dependencies>
Expand Down Expand Up @@ -48,30 +50,34 @@
<version>${jersey.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.glassfish.jersey.test-framework.providers</groupId>
<artifactId>jersey-test-framework-provider-grizzly2</artifactId>
<version>${jersey.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest</artifactId>
<version>${hamcrest.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>javax.xml.bind</groupId>
<artifactId>jaxb-api</artifactId>
<version>2.3.0</version>
<version>${jaxb.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.glassfish.jaxb</groupId>
<artifactId>jaxb-runtime</artifactId>
<version>2.3.0</version>
<version>${jaxb.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>javax.activation</groupId>
<artifactId>activation</artifactId>
<version>1.1.1</version>
<version>${javax.activation.version}</version>
<scope>test</scope>
</dependency>
<!-- we need our log4j2 implementation for testing! -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import org.glassfish.jersey.test.JerseyTest;
import org.junit.After;
import org.junit.Before;

import com.fasterxml.jackson.jr.ob.JSON;

public abstract class AbstractFilterTest extends JerseyTest {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package com.sap.hcp.cf.logging.jersey.filter;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.greaterThan;
import static org.hamcrest.core.Is.is;
import static org.hamcrest.core.IsNot.not;
import static org.hamcrest.core.IsNull.nullValue;
import static org.junit.Assert.assertThat;

import javax.ws.rs.core.Application;
import javax.ws.rs.core.Response;
Expand Down
Loading