Merge pull request #23 from reportportal/develop

Release

Author: HardNorth

.github/workflows/ci.yml

@@ -35,11 +35,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Set up JDK 1.8
+      - name: Set up JDK 11
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '8'
+          java-version: '11'
 
       - name: Build with Gradle
         run: ./gradlew build

.github/workflows/release.yml

@@ -47,11 +47,11 @@ jobs:
           version-file: ${{ env.VERSION_FILE }}
           version-file-extraction-pattern: ${{ env.VERSION_EXTRACT_PATTERN }}
 
-      - name: Set up JDK 1.8
+      - name: Set up JDK 11
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '8'
+          java-version: '11'
 
       - name: Setup git credentials
         uses: oleksiyrudenko/gha-git-credentials@v2-latest

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 ## [Unreleased]
+### Changed
+- Client version updated on [5.4.3](https://github.com/reportportal/client-java/releases/tag/5.4.3), by @HardNorth
+- Replace "jsr305" annotations with "jakarta.annotation-api", by @HardNorth
+- Switch on use of `Instant` class instead of `Date` to get more timestamp precision, by @HardNorth
+### Removed
+- Deprecated code, by @HardNorth
 
 ## [5.3.0]
 ### Changed

build.gradle

@@ -29,22 +29,21 @@ project.ext.limits = [
         'class'      : 60
 ]
 
-sourceCompatibility = JavaVersion.VERSION_1_8
-targetCompatibility = JavaVersion.VERSION_1_8
+sourceCompatibility = JavaVersion.VERSION_11
+targetCompatibility = JavaVersion.VERSION_11
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
     compileOnly "com.epam.reportportal:client-java:${client_version}"
-    compileOnly "com.google.code.findbugs:jsr305:${jsr305_version}"
 
     implementation 'org.jsoup:jsoup:1.15.3'
+    implementation 'org.apache.commons:commons-lang3:3.18.0'
 
     testImplementation "com.epam.reportportal:client-java:${client_version}"
-    testImplementation "com.google.code.findbugs:jsr305:${jsr305_version}"
-    testImplementation 'com.epam.reportportal:agent-java-test-utils:0.0.12'
+    testImplementation 'com.epam.reportportal:agent-java-test-utils:0.1.0'
 
     testImplementation("org.junit.platform:junit-platform-runner:${junit5_runner_version}") {
         exclude module: 'junit'

gradle.properties

@@ -1,9 +1,9 @@
-version=5.3.1-SNAPSHOT
+version=5.4.0-SNAPSHOT
 description=Report Portal Java formatting utils for Agents and Loggers
 junit5_version=5.6.3
 junit5_runner_version=1.6.3
 mockito_version=4.5.1
-client_version=5.3.14
+client_version=5.4.3
 jsr305_version=3.0.2
 scripts_url=https://raw.githubusercontent.com/reportportal/gradle-scripts
 scripts_branch=master

src/main/java/com/epam/reportportal/formatting/AbstractHttpFormatter.java

@@ -30,10 +30,14 @@
 import com.epam.reportportal.service.step.StepReporter;
 import com.epam.reportportal.utils.files.ByteSource;
 import com.epam.reportportal.utils.http.ContentType;
-
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import java.util.*;
+import jakarta.annotation.Nonnull;
+import jakarta.annotation.Nullable;
+
+import java.time.Instant;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
 import java.util.function.Function;
 
 import static com.epam.reportportal.formatting.http.Constants.BODY_TYPE_MAP;
@@ -55,18 +59,7 @@ public abstract class AbstractHttpFormatter<SELF extends AbstractHttpFormatter<S
 	protected final Function<String, String> uriConverter;
 
 	private Map<String, Function<String, String>> contentPrettifiers = DEFAULT_PRETTIFIERS;
-
-	/**
-	 * @deprecated Use {@link #getContentPrettifiers()} instead
-	 */
-	@Deprecated
-	protected Map<String, Function<String, String>> contentPrettiers = contentPrettifiers;
-
-	/**
-	 * @deprecated Use {@link #getBodyTypeMap()} instead
-	 */
-	@Deprecated
-	protected Map<String, BodyType> bodyTypeMap = BODY_TYPE_MAP;
+	private Map<String, BodyType> bodyTypeMap = BODY_TYPE_MAP;
 
 	/**
 	 * Create a formatter with the specific log level and converters.
@@ -93,26 +86,26 @@ protected AbstractHttpFormatter(@Nonnull LogLevel defaultLogLevel, @Nullable Fun
 
 	protected void attachAsBinary(@Nullable String message, @Nullable byte[] attachment, @Nonnull String contentType) {
 		if (attachment == null) {
-			ReportPortal.emitLog(message, logLevel, Calendar.getInstance().getTime());
+			ReportPortal.emitLog(message, logLevel, Instant.now());
 		} else {
 			ReportPortal.emitLog(
 					new ReportPortalMessage(ByteSource.wrap(attachment), contentType, message),
 					logLevel,
-					Calendar.getInstance().getTime()
+					Instant.now()
 			);
 		}
 	}
 
 	protected void logMultiPartRequest(@Nonnull HttpRequestFormatter formatter) {
-		Date currentDate = Calendar.getInstance().getTime();
+		Instant currentDate = Instant.now();
 		String headers = formatter.formatHeaders() + formatter.formatCookies();
 		if (!headers.isEmpty()) {
 			ReportPortal.emitLog(headers, logLevel, currentDate);
 		}
 
-		Date myDate = currentDate;
+		Instant myDate = currentDate;
 		for (HttpPartFormatter part : formatter.getMultipartBody()) {
-			myDate = new Date(myDate.getTime() + 1);
+			myDate = myDate.plusMillis(1);
 			HttpPartFormatter.PartType partType = part.getType();
 			switch (partType) {
 				case TEXT:
@@ -128,11 +121,11 @@ protected void emitLog(HttpFormatter formatter) {
 		BodyType type = formatter.getType();
 		switch (type) {
 			case NONE:
-				ReportPortal.emitLog(formatter.formatHead(), logLevel, Calendar.getInstance().getTime());
+				ReportPortal.emitLog(formatter.formatHead(), logLevel, Instant.now());
 				break;
 			case TEXT:
 			case FORM:
-				ReportPortal.emitLog(formatter.formatAsText(), logLevel, Calendar.getInstance().getTime());
+				ReportPortal.emitLog(formatter.formatAsText(), logLevel, Instant.now());
 				break;
 			case BINARY:
 				attachAsBinary(
@@ -149,7 +142,7 @@ protected void emitLog(HttpFormatter formatter) {
 				sr.ifPresent(StepReporter::finishPreviousStep);
 				break;
 			default:
-				ReportPortal.emitLog("Unknown entity type: " + type.name(), LogLevel.ERROR.name(), Calendar.getInstance().getTime());
+				ReportPortal.emitLog("Unknown entity type: " + type.name(), LogLevel.ERROR.name(), Instant.now());
 		}
 	}
 
@@ -165,7 +158,7 @@ protected void emitLog(HttpFormatter formatter) {
 	@SuppressWarnings("unchecked")
 	@Nonnull
 	public SELF setBodyTypeMap(@Nonnull Map<String, BodyType> typeMap) {
-		this.bodyTypeMap = Collections.unmodifiableMap(new HashMap<>(typeMap));
+		this.bodyTypeMap = Map.copyOf(typeMap);
 		return (SELF) this;
 	}
 
@@ -195,26 +188,9 @@ public Map<String, BodyType> getBodyTypeMap() {
 	@Nonnull
 	public SELF setContentPrettifiers(@Nonnull Map<String, Function<String, String>> contentPrettifiers) {
 		this.contentPrettifiers = Collections.unmodifiableMap(new HashMap<>(contentPrettifiers));
-		this.contentPrettiers = this.contentPrettifiers;
 		return (SELF) this;
 	}
 
-	/***
-	 * Set the content prettifiers for the formatter.
-	 * <p>
-	 * Content prettifiers are used to format the content of the request/response before logging it. The prettifiers are applied to the
-	 * content based on the content type.
-	 *
-	 * @param contentPrettifiers a map with the content type as a key and the prettifier function as a value
-	 * @return the formatter instance
-	 * @deprecated Use {@link #setContentPrettifiers(Map)} instead
-	 */
-	@Deprecated
-	@Nonnull
-	public SELF setContentPrettiers(@Nonnull Map<String, Function<String, String>> contentPrettifiers) {
-		return setContentPrettifiers(contentPrettifiers);
-	}
-
 	/**
 	 * Get the content prettifiers for the formatter.
 	 * <p>

src/main/java/com/epam/reportportal/formatting/http/Constants.java

@@ -69,26 +69,20 @@ public class Constants {
 			MULTIPART_TYPES.stream().collect(Collectors.toMap(k -> k, v -> BodyType.MULTIPART))
 	).flatMap(m -> m.entrySet().stream()).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)));
 
-	public static final Map<String, Function<String, String>> DEFAULT_PRETTIFIERS = Collections.unmodifiableMap(new HashMap<String, Function<String, String>>() {{
-		put(ContentType.APPLICATION_XML, XmlPrettifier.INSTANCE);
-		put(ContentType.APPLICATION_SOAP_XML, XmlPrettifier.INSTANCE);
-		put(ContentType.APPLICATION_ATOM_XML, XmlPrettifier.INSTANCE);
-		put(ContentType.APPLICATION_SVG_XML, XmlPrettifier.INSTANCE);
-		put(ContentType.APPLICATION_XHTML_XML, XmlPrettifier.INSTANCE);
-		put(ContentType.TEXT_XML, XmlPrettifier.INSTANCE);
-		put(ContentType.APPLICATION_JSON, JsonPrettifier.INSTANCE);
-		// Can't use ContentType.TEXT_JSON, etc. because client-java dependency marked as compileOnly
-		put("text/json", JsonPrettifier.INSTANCE);
-		put("application/x.reportportal.launch.v2+json", JsonPrettifier.INSTANCE);
-		put("application/x.reportportal.test.v2+json", JsonPrettifier.INSTANCE);
-		put(ContentType.TEXT_HTML, HtmlPrettifier.INSTANCE);
-	}});
-
-	/**
-	 * @deprecated Use {@link #DEFAULT_PRETTIFIERS} instead
-	 */
-	@Deprecated
-	public static final Map<String, Function<String, String>> DEFAULT_PRETTIERS = DEFAULT_PRETTIFIERS;
+	public static final Map<String, Function<String, String>> DEFAULT_PRETTIFIERS = Map.ofEntries(
+			Map.entry(ContentType.APPLICATION_XML, XmlPrettifier.INSTANCE),
+			Map.entry(ContentType.APPLICATION_SOAP_XML, XmlPrettifier.INSTANCE),
+			Map.entry(ContentType.APPLICATION_ATOM_XML, XmlPrettifier.INSTANCE),
+			Map.entry(ContentType.APPLICATION_SVG_XML, XmlPrettifier.INSTANCE),
+			Map.entry(ContentType.APPLICATION_XHTML_XML, XmlPrettifier.INSTANCE),
+			Map.entry(ContentType.TEXT_XML, XmlPrettifier.INSTANCE),
+			Map.entry(ContentType.APPLICATION_JSON, JsonPrettifier.INSTANCE),
+			// Can't use ContentType.TEXT_JSON, etc. because client-java dependency marked as compileOnly
+			Map.entry("text/json", JsonPrettifier.INSTANCE),
+			Map.entry("application/x.reportportal.launch.v2+json", JsonPrettifier.INSTANCE),
+			Map.entry("application/x.reportportal.test.v2+json", JsonPrettifier.INSTANCE),
+			Map.entry(ContentType.TEXT_HTML, HtmlPrettifier.INSTANCE)
+	);
 
 	private Constants() {
 		throw new RuntimeException("No instances should exist for the class!");

src/main/java/com/epam/reportportal/formatting/http/HttpFormatUtils.java

@@ -24,16 +24,18 @@
 import com.epam.reportportal.formatting.http.entities.Header;
 import com.epam.reportportal.formatting.http.entities.Param;
 import com.epam.reportportal.utils.http.ContentType;
+import jakarta.annotation.Nonnull;
+import jakarta.annotation.Nullable;
 import org.apache.commons.lang3.tuple.Pair;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
+import java.time.Instant;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeParseException;
 import java.util.*;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -137,11 +139,7 @@ public static Header toHeader(@Nonnull String nameValuePair) {
 	public static Stream<Pair<String, String>> toKeyValue(@Nonnull String headerValue) {
 		return Arrays.stream(headerValue.split(";\\s*")).map(c -> c.split("=", 2)).map(kv -> {
 			if (kv.length > 1) {
-				try {
-					return Pair.of(kv[0], URLDecoder.decode(kv[1], Charset.defaultCharset().name()));
-				} catch (UnsupportedEncodingException e) {
-					throw new IllegalStateException(e);
-				}
+				return Pair.of(kv[0], URLDecoder.decode(kv[1], Charset.defaultCharset()));
 			}
 			return Pair.of(kv[0], "");
 		});
@@ -150,7 +148,7 @@ public static Stream<Pair<String, String>> toKeyValue(@Nonnull String headerValu
 	@Nonnull
 	public static Cookie toCookie(@Nonnull String name, @Nullable String value, @Nullable String comment, @Nullable String path,
 			@Nullable String domain, @Nullable Long maxAge, @Nullable Boolean secured, @Nullable Boolean httpOnly,
-			@Nullable Date expiryDate, @Nullable Integer version, @Nullable String sameSite) {
+			@Nullable Instant expiryDate, @Nullable Integer version, @Nullable String sameSite) {
 		Cookie cookie = new Cookie(name);
 		cookie.setValue(value);
 		cookie.setComment(comment);
@@ -180,10 +178,12 @@ public static Cookie toCookie(@Nonnull String headerValue) {
 		Boolean httpOnly = cookieMetadata.containsKey("httponly");
 		// Examples: Tue, 06 Sep 2022 09:32:51 GMT
 		//           Wed, 06-Sep-2023 11:22:09 GMT
-		Date expiryDate = ofNullable(cookieMetadata.get("expires")).map(d -> {
+		Instant expiryDate = ofNullable(cookieMetadata.get("expires")).map(d -> {
 			try {
-				return new SimpleDateFormat(DefaultCookieConverter.DEFAULT_COOKIE_DATE_FORMAT).parse(d.replace('-', ' '));
-			} catch (ParseException e) {
+				DateTimeFormatter formatter = DateTimeFormatter.ofPattern(DefaultCookieConverter.DEFAULT_COOKIE_DATE_FORMAT)
+						.withZone(ZoneId.of(DefaultCookieConverter.DEFAULT_COOKIE_TIME_ZONE.getID()));
+				return ZonedDateTime.parse(d.replace('-', ' '), formatter).toInstant();
+			} catch (DateTimeParseException e) {
 				return null;
 			}
 		}).orElse(null);
@@ -228,11 +228,7 @@ public static List<Param> toForm(@Nullable String formParameters, @Nullable Stri
 				.map(param -> param.split("=", 2))
 				.map(Arrays::stream)
 				.map(param -> param.map(p -> {
-					try {
-						return URLDecoder.decode(p, charset.name());
-					} catch (UnsupportedEncodingException e) {
-						throw new IllegalStateException("Missed standard charset", e);
-					}
+					return URLDecoder.decode(p, charset);
 				}).collect(Collectors.toList()))
 				.map(param -> {
 					if (param.isEmpty()) {

src/main/java/com/epam/reportportal/formatting/http/HttpFormatter.java

@@ -17,9 +17,8 @@
 package com.epam.reportportal.formatting.http;
 
 import com.epam.reportportal.formatting.http.entities.BodyType;
-
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import jakarta.annotation.Nonnull;
+import jakarta.annotation.Nullable;
 
 public interface HttpFormatter {