Merge pull request #2 from Visual-Regression-Tracker/53-tests

tests are added

Author: pashidlos

.github/workflows/gradle.yml

@@ -24,6 +24,3 @@ jobs:
       run: chmod +x gradlew
     - name: Build with Gradle
       run: ./gradlew build
-    - name: Codecov
-      uses: codecov/[email protected]
-

build.gradle

@@ -28,8 +28,10 @@ dependencies {
     implementation 'com.google.code.gson:gson:2.8.6'
     testImplementation group: 'org.testng', name: 'testng', version: '7.1.0'
     testImplementation 'commons-io:commons-io:2.6'
+    testImplementation 'org.mockito:mockito-core:3.3.3'
+    testImplementation "com.squareup.okhttp3:mockwebserver:4.7.2"
 }
 
-test{
+test {
     useTestNG()
 }

lombok.config

@@ -1,2 +1,3 @@
 # This file is generated by the 'io.freefair.lombok' Gradle plugin
 config.stopBubbling = true
+lombok.addLombokGeneratedAnnotation = true

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

@@ -0,0 +1,20 @@
+package io.visual_regression_tracker.sdk_java;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public enum TestRunStatus {
+    @SerializedName("ok")
+    OK,
+    @SerializedName("approved")
+    APPROVED,
+    @SerializedName("failed")
+    FAILED,
+    @SerializedName("new")
+    NEW,
+    @SerializedName("unresolved")
+    UNRESOLVED
+}

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

@@ -1,14 +1,18 @@
 package io.visual_regression_tracker.sdk_java;
 
 import com.google.gson.Gson;
+import io.visual_regression_tracker.sdk_java.request.BuildRequest;
+import io.visual_regression_tracker.sdk_java.request.TestRunRequest;
+import io.visual_regression_tracker.sdk_java.response.BuildResponse;
+import io.visual_regression_tracker.sdk_java.response.TestRunResponse;
 import okhttp3.*;
 
 import java.io.IOException;
-import java.util.HashMap;
-import java.util.Map;
 
 public class VisualRegressionTracker {
     static final MediaType JSON = MediaType.get("application/json; charset=utf-8");
+    String apiKeyHeaderName = "apiKey";
+    Gson gson = new Gson();
     VisualRegressionTrackerConfig visualRegressionTrackerConfig;
     String buildId;
     OkHttpClient client;
@@ -21,61 +25,62 @@ public VisualRegressionTracker(VisualRegressionTrackerConfig visualRegressionTra
 
     void startBuild() throws IOException {
         if (this.buildId == null) {
-            Map<String, String> data = new HashMap<>();
-            data.put("projectId", this.visualRegressionTrackerConfig.projectId);
-            data.put("branchName", this.visualRegressionTrackerConfig.branchName);
+            BuildRequest newBuild = BuildRequest.builder()
+                    .branchName(this.visualRegressionTrackerConfig.branchName)
+                    .projectId(this.visualRegressionTrackerConfig.projectId)
+                    .build();
 
-            RequestBody body = RequestBody.create(new Gson().toJson(data), JSON);
+            RequestBody body = RequestBody.create(gson.toJson(newBuild), JSON);
 
             Request request = new Request.Builder()
                     .url(this.visualRegressionTrackerConfig.apiUrl.concat("/builds"))
-                    .addHeader("apiKey", this.visualRegressionTrackerConfig.apiKey)
+                    .addHeader(apiKeyHeaderName, this.visualRegressionTrackerConfig.apiKey)
                     .post(body)
                     .build();
 
             try (ResponseBody responseBody = client.newCall(request).execute().body()) {
-                BuildDTO buildDTO = new Gson().fromJson(responseBody.string(), BuildDTO.class);
+                BuildResponse buildDTO = new Gson().fromJson(responseBody.string(), BuildResponse.class);
                 this.buildId = buildDTO.getId();
             }
         }
     }
 
-    TestResultDTO submitTestRun(String name, String imageBase64, TestRunOptions testRunOptions) throws IOException {
-        Map<String, Object> data = new HashMap<>();
-        data.put("projectId", this.visualRegressionTrackerConfig.projectId);
-        data.put("buildId", this.buildId);
-        data.put("name", name);
-        data.put("imageBase64", imageBase64);
-        data.put("os", testRunOptions.getOs());
-        data.put("browser", testRunOptions.getBrowser());
-        data.put("viewport", testRunOptions.getViewport());
-        data.put("device", testRunOptions.getDevice());
-        data.put("diffTollerancePercent", testRunOptions.getDiffTollerancePercent());
+    TestRunResponse submitTestRun(String name, String imageBase64, TestRunOptions testRunOptions) throws IOException {
+        TestRunRequest newTestRun = TestRunRequest.builder()
+                .projectId(this.visualRegressionTrackerConfig.projectId)
+                .buildId(this.buildId)
+                .name(name)
+                .imageBase64(imageBase64)
+                .os(testRunOptions.getOs())
+                .browser(testRunOptions.getBrowser())
+                .viewport(testRunOptions.getViewport())
+                .device(testRunOptions.getDevice())
+                .diffTollerancePercent(testRunOptions.getDiffTollerancePercent())
+                .build();
 
-        RequestBody body = RequestBody.create(new Gson().toJson(data), JSON);
+        RequestBody body = RequestBody.create(gson.toJson(newTestRun), JSON);
 
         Request request = new Request.Builder()
                 .url(this.visualRegressionTrackerConfig.apiUrl.concat("/test"))
-                .addHeader("apiKey", this.visualRegressionTrackerConfig.apiKey)
+                .addHeader(apiKeyHeaderName, this.visualRegressionTrackerConfig.apiKey)
                 .post(body)
                 .build();
 
-
         try (ResponseBody responseBody = client.newCall(request).execute().body()) {
-            return new Gson().fromJson(responseBody.string(), TestResultDTO.class);
+            return gson.fromJson(responseBody.string(), TestRunResponse.class);
         }
     }
 
     public void track(String name, String imageBase64, TestRunOptions testRunOptions) throws IOException {
         this.startBuild();
 
-        TestResultDTO testResultDTO = this.submitTestRun(name, imageBase64, testRunOptions);
+        TestRunResponse testResultDTO = this.submitTestRun(name, imageBase64, testRunOptions);
 
-        if (testResultDTO.getStatus().equals("new")) {
+        if (testResultDTO.getStatus().equals(TestRunStatus.NEW)) {
             throw new TestRunException("No baseline: ".concat(testResultDTO.getUrl()));
         }
 
-        if (testResultDTO.getStatus().equals("unresolved")) {
+        if (testResultDTO.getStatus().equals(TestRunStatus.UNRESOLVED)) {
             throw new TestRunException("Difference found: ".concat(testResultDTO.getUrl()));
         }
     }

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

@@ -0,0 +1,9 @@
+package io.visual_regression_tracker.sdk_java.request;
+
+import lombok.Builder;
+
+@Builder
+public class BuildRequest {
+    String projectId;
+    String branchName;
+}

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

@@ -0,0 +1,16 @@
+package io.visual_regression_tracker.sdk_java.request;
+
+import lombok.Builder;
+
+@Builder
+public class TestRunRequest {
+    String projectId;
+    String buildId;
+    String name;
+    String imageBase64;
+    String os;
+    String browser;
+    String viewport;
+    String device;
+    Integer diffTollerancePercent;
+}

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

@@ -0,0 +1,10 @@
+package io.visual_regression_tracker.sdk_java.response;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Builder
+@Getter
+public class BuildResponse {
+    String id;
+}