Merge branch 'master' into dependabot/gradle/org.testng-testng-7.3.0

Author: pashidlos

src/main/java/io/visual_regression_tracker/sdk_java/VisualRegressionTracker.java

@@ -38,10 +38,12 @@ public VisualRegressionTracker(VisualRegressionTrackerConfig trackerConfig) {
     public void start() throws IOException {
         String projectName = configuration.getProject();
         String branch = configuration.getBranchName();
+        String ciBuildId = configuration.getCiBuildId();
 
         BuildRequest newBuild = BuildRequest.builder()
                                             .branchName(branch)
                                             .project(projectName)
+                                            .ciBuildId(ciBuildId)
                                             .build();
 
         RequestBody body = RequestBody.create(JSON, gson.toJson(newBuild));
@@ -61,8 +63,8 @@ public void start() throws IOException {
         buildId = buildResponse.getId();
         projectId = buildResponse.getProjectId();
 
-        log.info("Visual Regression Tracker is started for project <{}>: buildId <{}>, projectId <{}>",
-                 projectName, projectId, buildId);
+        log.info("Visual Regression Tracker is started for project <{}>: buildId: <{}>, projectId: <{}>, ciBuildId: <{}>",
+                 projectName, projectId, buildId, buildResponse.getCiBuildId());
     }
 
     public void stop() throws IOException {

src/main/java/io/visual_regression_tracker/sdk_java/VisualRegressionTrackerConfig.java

@@ -1,14 +1,27 @@
 package io.visual_regression_tracker.sdk_java;
 
 import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Data;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
 
 @Data
+@Builder
+@RequiredArgsConstructor
 @AllArgsConstructor
 public class VisualRegressionTrackerConfig {
-    private String apiUrl;
-    private String project;
-    private String apiKey;
-    private String branchName;
-    private Boolean enableSoftAssert;
+
+    @NonNull
+    private final String apiUrl;
+    @NonNull
+    private final String project;
+    @NonNull
+    private final String apiKey;
+    @NonNull
+    private final String branchName;
+    @Builder.Default
+    private Boolean enableSoftAssert = false;
+    @Builder.Default
+    private String ciBuildId = null;
 }

src/main/java/io/visual_regression_tracker/sdk_java/request/BuildRequest.java

@@ -8,4 +8,5 @@
 public class BuildRequest {
     private final String project;
     private final String branchName;
+    private final String ciBuildId;
 }

src/main/java/io/visual_regression_tracker/sdk_java/response/BuildResponse.java

@@ -8,4 +8,5 @@
 public class BuildResponse {
     private final String id;
     private final String projectId;
+    private final String ciBuildId;
 }

src/test/java/io/visual_regression_tracker/sdk_java/VisualRegressionTrackerTest.java

@@ -43,18 +43,13 @@ public class VisualRegressionTrackerTest {
 
     private final static String BUILD_ID = "123123";
     private final static String PROJECT_ID = "projectId";
+    private final static String CI_BUILD_ID = "123456789";
     private final static String NAME = "Test name";
     private final static String IMAGE_BASE_64 = "image";
 
     private final Gson gson = new Gson();
-    private final VisualRegressionTrackerConfig config = new VisualRegressionTrackerConfig(
-            "http://localhost",
-            "733c148e-ef70-4e6d-9ae5-ab22263697cc",
-            "XHGDZDFD3GMJDNM87JKEMP0JS1G5",
-            "develop",
-            false
-    );
 
+    private VisualRegressionTrackerConfig config;
     private MockWebServer server;
     private VisualRegressionTracker vrt;
     private VisualRegressionTracker vrtMocked;
@@ -66,7 +61,13 @@ public void setup() {
         server.start();
 
         // target to mock server
-        this.config.setApiUrl(server.url("/").toString());
+        config = new VisualRegressionTrackerConfig(
+                server.url("/").toString(),
+                "733c148e-ef70-4e6d-9ae5-ab22263697cc",
+                "XHGDZDFD3GMJDNM87JKEMP0JS1G5",
+                "develop",
+                false,
+                CI_BUILD_ID);
         vrt = new VisualRegressionTracker(config);
         vrtMocked = mock(VisualRegressionTracker.class);
         vrtMocked.paths = new PathProvider("baseApiUrl");
@@ -84,10 +85,12 @@ public void shouldStartBuild() throws IOException, InterruptedException {
         BuildRequest buildRequest = BuildRequest.builder()
                                                 .branchName(this.config.getBranchName())
                                                 .project(this.config.getProject())
+                                                .ciBuildId(this.config.getCiBuildId())
                                                 .build();
         BuildResponse buildResponse = BuildResponse.builder()
                                                    .id(BUILD_ID)
                                                    .projectId(PROJECT_ID)
+                                                   .ciBuildId(CI_BUILD_ID)
                                                    .build();
         server.enqueue(new MockResponse()
                                .setResponseCode(200)
@@ -209,7 +212,15 @@ public Object[][] trackErrorCases() {
             expectedExceptions = TestRunException.class,
             expectedExceptionsMessageRegExp = "^(Difference found: https://someurl.com/test/123123|No baseline: https://someurl.com/test/123123)$")
     public void trackShouldThrowException(TestRunResponse testRunResponse, String expectedExceptionMessage) throws IOException {
-        vrtMocked.configuration = new VisualRegressionTrackerConfig("", "", "", "", false);
+        vrtMocked.configuration = VisualRegressionTrackerConfig.builder()
+                                                               .apiUrl("")
+                                                               .project("")
+                                                               .apiKey("")
+                                                               .branchName("")
+                                                               .enableSoftAssert(false)
+                                                               .ciBuildId("")
+                                                               .build();
+
         when(vrtMocked.submitTestRun(anyString(), anyString(), any())).thenReturn(testRunResponse);
 
         doCallRealMethod().when(vrtMocked).track(anyString(), anyString(), any());
@@ -224,7 +235,14 @@ public void trackShouldLogSevere(TestRunResponse testRunResponse, String expecte
         listAppender.start();
         // add the appender to the logger
         loggerMock.addAppender(listAppender);
-        vrtMocked.configuration = new VisualRegressionTrackerConfig("", "", "", "", true);
+        vrtMocked.configuration = VisualRegressionTrackerConfig.builder()
+                                                               .apiUrl("")
+                                                               .project("")
+                                                               .apiKey("")
+                                                               .branchName("")
+                                                               .enableSoftAssert(true)
+                                                               .ciBuildId("")
+                                                               .build();
         when(vrtMocked.submitTestRun(anyString(), anyString(), any())).thenReturn(testRunResponse);
 
         doCallRealMethod().when(vrtMocked).track(anyString(), anyString(), any());