Release

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## [Unreleased]
+### Changed
+- Client version updated on [5.3.14](https://github.com/reportportal/client-java/releases/tag/5.3.14), by @HardNorth
 
 ## [5.2.3]
 ### Changed

README.md

@@ -39,7 +39,7 @@ testImplementation 'com.epam.reportportal:logger-java-logback:5.2.3'
 
 ## Configuration
 
-Add a report portal appender into `logback.xml` configuration file.
+Add a report portal appender into `logback.xml` (usually located in `src/main/resources` or `src/test/resources`) configuration file.
 
 ```XML
 <?xml version="1.0" encoding="UTF-8"?>

build.gradle

@@ -42,7 +42,7 @@ dependencies {
 
     testImplementation "com.epam.reportportal:client-java:${client_version}"
     testImplementation "ch.qos.logback:logback-classic:${logback_version}"
-    testImplementation 'com.epam.reportportal:agent-java-test-utils:0.0.2'
+    testImplementation 'com.epam.reportportal:agent-java-test-utils:0.0.12'
     testImplementation('org.awaitility:awaitility:4.0.2') {
         exclude group: 'org.hamcrest'
     }

gradle.properties

@@ -1,8 +1,8 @@
-version=5.2.4-SNAPSHOT
+version=5.3.0-SNAPSHOT
 description=EPAM Report portal. Logback Integration
 scripts_url=https://github.com/reportportal/gradle-scripts
 scripts_branch=master
-client_version=5.2.25
+client_version=5.3.14
 logback_version=1.3.15
 junit_version=5.6.3
 junit_runner_version=1.6.3

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.4-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/test/java/com/epam/reportportal/logback/appender/ReportPortalAppenderTest.java

@@ -4,31 +4,36 @@
 import ch.qos.logback.classic.Logger;
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
+import com.epam.reportportal.listeners.ItemType;
+import com.epam.reportportal.listeners.ListenerParameters;
 import com.epam.reportportal.service.Launch;
-import com.epam.reportportal.service.LoggingContext;
+import com.epam.reportportal.service.ReportPortal;
 import com.epam.reportportal.service.ReportPortalClient;
 import com.epam.reportportal.service.logs.LoggingSubscriber;
 import com.epam.reportportal.util.test.CommonUtils;
-import com.epam.ta.reportportal.ws.model.BatchSaveOperatingRS;
+import com.epam.ta.reportportal.ws.model.*;
+import com.epam.ta.reportportal.ws.model.item.ItemCreatedRS;
+import com.epam.ta.reportportal.ws.model.launch.StartLaunchRQ;
+import com.epam.ta.reportportal.ws.model.launch.StartLaunchRS;
 import io.reactivex.Maybe;
-import io.reactivex.Scheduler;
-import io.reactivex.schedulers.Schedulers;
 import okhttp3.MediaType;
 import okhttp3.MultipartBody;
 import okhttp3.RequestBody;
 import org.apache.commons.io.IOUtils;
 import org.hamcrest.Matchers;
 import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentCaptor;
-import org.mockito.Mock;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Base64;
+import java.util.Calendar;
 import java.util.List;
 import java.util.concurrent.ExecutorService;
 
+import static com.epam.reportportal.util.test.CommonUtils.generateUniqueId;
 import static java.util.Optional.ofNullable;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.*;
@@ -37,91 +42,121 @@
 
 public class ReportPortalAppenderTest {
 
-    @Mock
-    private ReportPortalClient client;
-
-    private final ExecutorService executor = CommonUtils.testExecutor();
-    private final Scheduler scheduler = Schedulers.from(executor);
-
-    private static Logger createLoggerFor(Class<?> clazz) {
-        LoggerContext lc = new LoggerContext();
-        PatternLayoutEncoder ple = new PatternLayoutEncoder();
-
-        ple.setPattern("%date %level [%thread] %logger{10} [%file:%line] %msg%n");
-        ple.setContext(lc);
-        ple.start();
-        ReportPortalAppender appender = new ReportPortalAppender();
-        appender.setEncoder(ple);
-        appender.setContext(lc);
-        appender.start();
-
-        Logger logger = lc.getLogger(clazz);
-        logger.addAppender(appender);
-        logger.setLevel(Level.DEBUG);
-        logger.setAdditive(false);
-        return logger;
-    }
-
-    @SuppressWarnings("unchecked")
-    private static void mockBatchLogging(ReportPortalClient client) {
-        when(client.log(any(List.class))).thenReturn(Maybe.just(new BatchSaveOperatingRS()));
-    }
-
-    @AfterEach
-    public void tearDown() {
-        CommonUtils.shutdownExecutorService(executor);
-    }
-
-    @Test
-    @SuppressWarnings({"unchecked", "ReactiveStreamsUnusedPublisher"})
-    public void test_logger_append() {
-        mockBatchLogging(client);
-        LoggingContext.init(Maybe.just("launch_uuid"), Maybe.just("item_uuid"), client, scheduler);
-        Logger logger = createLoggerFor(Launch.class);
-        logger.info("test message");
-        LoggingContext.complete();
-        verify(client).log(any(List.class));
-    }
-
-    @Test
-    @SuppressWarnings({"unchecked", "ReactiveStreamsUnusedPublisher"})
-    public void test_logger_skip() {
-        LoggingContext.init(Maybe.just("launch_uuid"), Maybe.just("item_uuid"), client, scheduler);
-        Logger logger = createLoggerFor(LoggingSubscriber.class);
-        logger.info("test message");
-        LoggingContext.complete();
-        verify(client, timeout(100).times(0)).log(any(List.class));
-    }
-
-    @Test
-    @SuppressWarnings({"unchecked", "ReactiveStreamsUnusedPublisher"})
-    public void test_binary_file_message_encoding() throws IOException {
-        mockBatchLogging(client);
-        LoggingContext.init(Maybe.just("launch_uuid"), Maybe.just("item_uuid"), client, scheduler);
-        String message = "test message";
-        Logger logger = createLoggerFor(this.getClass());
-        byte[] content;
-        try (InputStream is = ofNullable(Thread.currentThread().getContextClassLoader().getResourceAsStream("pug/unlucky.jpg"))
-                .orElseThrow(() -> new IllegalStateException("Unable to find test image file"))) {
-            content = IOUtils.toByteArray(is);
-        }
-        logger.info("RP_MESSAGE#BASE64#{}#{}", Base64.getEncoder().encodeToString(content), message);
-        LoggingContext.complete();
-        ArgumentCaptor<List<MultipartBody.Part>> captor = ArgumentCaptor.forClass(List.class);
-        verify(client).log(captor.capture());
-
-        List<MultipartBody.Part> request = captor.getValue();
-        assertThat(request, hasSize(2));
-
-        RequestBody jsonPart = request.get(0).body();
-        MediaType jsonPartType = jsonPart.contentType();
-        assertThat(jsonPartType, notNullValue());
-        assertThat(jsonPartType.toString(), Matchers.startsWith("application/json"));
-
-        RequestBody binaryPart = request.get(1).body();
-        MediaType binaryPartType = binaryPart.contentType();
-        assertThat(binaryPartType, notNullValue());
-        assertThat(binaryPartType.toString(), equalTo("image/jpeg"));
-        assertThat(binaryPart.contentLength(), equalTo((long) content.length));
-    }
+	private final ReportPortalClient client = mock(ReportPortalClient.class);
+	private final ExecutorService executor = CommonUtils.testExecutor();
+	private final ReportPortal rp = ReportPortal.create(client, standardParameters(), executor);
+	private Launch launch;
+	private Maybe<String> id;
+
+	public static ListenerParameters standardParameters() {
+		ListenerParameters result = new ListenerParameters();
+		result.setClientJoin(false);
+		result.setBatchLogsSize(1);
+		result.setLaunchName("My-test-launch" + generateUniqueId());
+		result.setProjectName("test-project");
+		result.setEnable(true);
+		result.setBaseUrl("http://localhost:8080");
+		return result;
+	}
+
+	private static Logger createLoggerFor(Class<?> clazz) {
+		LoggerContext lc = new LoggerContext();
+		PatternLayoutEncoder ple = new PatternLayoutEncoder();
+
+		ple.setPattern("%date %level [%thread] %logger{10} [%file:%line] %msg%n");
+		ple.setContext(lc);
+		ple.start();
+		ReportPortalAppender appender = new ReportPortalAppender();
+		appender.setEncoder(ple);
+		appender.setContext(lc);
+		appender.start();
+
+		Logger logger = lc.getLogger(clazz);
+		logger.addAppender(appender);
+		logger.setLevel(Level.DEBUG);
+		logger.setAdditive(false);
+		return logger;
+	}
+
+	@SuppressWarnings("unchecked")
+	private static void mockBatchLogging(ReportPortalClient client) {
+		when(client.log(any(List.class))).thenReturn(Maybe.just(new BatchSaveOperatingRS()));
+	}
+
+	@SuppressWarnings("ResultOfMethodCallIgnored")
+	@BeforeEach
+	public void setUp() {
+		when(client.startLaunch(any(StartLaunchRQ.class))).thenReturn(Maybe.just(new StartLaunchRS("launch_uuid", 1L)));
+		when(client.startTestItem(any(StartTestItemRQ.class))).thenReturn(Maybe.just(new ItemCreatedRS("item_uuid", "unique_item_uuid")));
+		when(client.finishTestItem(any(), any(FinishTestItemRQ.class))).thenReturn(Maybe.just(new OperationCompletionRS()));
+		when(client.finishLaunch(any(), any(FinishExecutionRQ.class))).thenReturn(Maybe.just(new OperationCompletionRS()));
+		StartLaunchRQ launchRQ = new StartLaunchRQ();
+		launchRQ.setStartTime(Calendar.getInstance().getTime());
+		launchRQ.setName("My-test-launch");
+		launch = rp.newLaunch(launchRQ);
+		launch.start().blockingGet();
+		StartTestItemRQ rq = new StartTestItemRQ();
+		rq.setName("My-test-item");
+		rq.setStartTime(Calendar.getInstance().getTime());
+		rq.setType(ItemType.STEP.name());
+		id = launch.startTestItem(rq);
+	}
+
+	@AfterEach
+	public void tearDown() {
+		CommonUtils.shutdownExecutorService(executor);
+	}
+
+	@Test
+	@SuppressWarnings({ "unchecked", "ReactiveStreamsUnusedPublisher" })
+	public void test_logger_append() {
+		mockBatchLogging(client);
+		Logger logger = createLoggerFor(Launch.class);
+		logger.info("test message");
+		launch.finishTestItem(id, new FinishTestItemRQ());
+		launch.finish(new FinishExecutionRQ());
+		verify(client).log(any(List.class));
+	}
+
+	@Test
+	@SuppressWarnings({ "unchecked", "unused", "ReactiveStreamsUnusedPublisher" })
+	public void test_logger_skip() {
+		Logger logger = createLoggerFor(LoggingSubscriber.class);
+		launch.finishTestItem(id, new FinishTestItemRQ());
+		launch.finish(new FinishExecutionRQ());
+		verify(client, timeout(100).times(0)).log(any(List.class));
+	}
+
+	@Test
+	@SuppressWarnings({ "unchecked", "ReactiveStreamsUnusedPublisher" })
+	public void test_binary_file_message_encoding() throws IOException {
+		mockBatchLogging(client);
+		String message = "test message";
+		Logger logger = createLoggerFor(this.getClass());
+		byte[] content;
+		try (InputStream is = ofNullable(Thread.currentThread().getContextClassLoader().getResourceAsStream("pug/unlucky.jpg")).orElseThrow(
+				() -> new IllegalStateException("Unable to find test image file"))) {
+			content = IOUtils.toByteArray(is);
+		}
+		logger.info("RP_MESSAGE#BASE64#{}#{}", Base64.getEncoder().encodeToString(content), message);
+		launch.finishTestItem(id, new FinishTestItemRQ());
+		launch.finish(new FinishExecutionRQ());
+
+		ArgumentCaptor<List<MultipartBody.Part>> captor = ArgumentCaptor.forClass(List.class);
+		verify(client).log(captor.capture());
+
+		List<MultipartBody.Part> request = captor.getValue();
+		assertThat(request, hasSize(2));
+
+		RequestBody jsonPart = request.get(0).body();
+		MediaType jsonPartType = jsonPart.contentType();
+		assertThat(jsonPartType, notNullValue());
+		assertThat(jsonPartType.toString(), Matchers.startsWith("application/json"));
+
+		RequestBody binaryPart = request.get(1).body();
+		MediaType binaryPartType = binaryPart.contentType();
+		assertThat(binaryPartType, notNullValue());
+		assertThat(binaryPartType.toString(), equalTo("image/jpeg"));
+		assertThat(binaryPart.contentLength(), equalTo((long) content.length));
+	}
 }