README added

Author: pashidlos

README.md

@@ -0,0 +1,88 @@
+# Java implementation for [Visual Knight](https://github.com/visual-knight/platform-community-edition) API 
+Port from JavaScript implementation [link](https://github.com/visual-knight/libraries/tree/master/packages/core)
+
+## Gradle
+```
+repositories {
+ maven { url 'https://jitpack.io' }
+}
+```
+```
+dependencies {
+ implementation 'com.github.pashidlos:visualknight_agent_java_core:${VERSION}'
+}
+```
+## Maven
+```
+<repositories>
+ <repository>
+ <id>jitpack.io</id>
+ <url>https://jitpack.io</url>
+ </repository>
+</repositories>
+```
+```
+<dependency>
+ <groupId>com.github.pashidlos</groupId>
+ <artifactId>visualknight_agent_java_core</artifactId>
+ <version>${VERSION}</version>
+</dependency>
+```
+[Available versions](https://github.com/pashidlos/visualknight_agent_java_core/releases)
+
+More info about https://jitpack.io/
+
+## Usage
+* Setup options object
+```
+VisualKnightOptions visualKnightOptions = VisualKnightOptions.builder()
+ // URL to Visual Knight backend
+ // Required
+ .apiEndpoint("http://localhost:3333/graphql")
+
+ // Your Visual Knight API key
+ // Required
+ .apiKey("API_KEY") 
+
+ // Your project name or ID
+ // Required
+ .project("PROJECT_KEY_OR_NAME")
+
+ // The mismatch tolerance for the comparison, 0.01 is 1%
+ // Optional
+ // Default: 0.01
+ .misMatchTolerance(0.01)
+
+ // Accept first testsession for a variation as baseline
+ // Optional
+ // Default: false
+ .autoBaseline(false)
+ .build();
+```
+* Create instance of `VisualKnightCore`
+```
+VisualKnightCore visualKnightCore = new VisualKnightCore(visualKnightOptions);
+```
+* Take a screenshot as String in Base64 format
+```
+// Selenium example
+String screenshotBase64 = ((TakesScreenshot) driver).getScreenshotAs(OutputType.BASE64);
+```
+* Create instance of `VisualKnightCapabilities`
+```
+VisualKnightCapabilities visualKnightCapabilities = VisualKnightCapabilities.builder()
+ // Available: 'Windows', 'Mac OS', `Puppeteer`
+ .os("Windows")
+
+ // Available: 'Internet Explorer', 'Firefox', 'Safari', 'Chrome', 'Opera'
+ .browserName("Chrome")
+ .build()
+```
+* Process image
+```
+visualKnightCore.processScreenshot(
+ "Name for test",
+ screenshotBase64,
+ visualKnightCapabilities
+);
+```

build.gradle

@@ -30,4 +30,5 @@ sourceCompatibility = 1.8
 dependencies {
  implementation 'io.aexp.nodes.graphql:nodes:0.5.0'
  testImplementation group: 'junit', name: 'junit', version: '4.12'
+ testImplementation 'commons-io:commons-io:2.6'
 }

src/main/java/agent_java_core/VisualKnightCore.java

@@ -32,7 +32,7 @@ public void processScreenshot(String testName, String base64Image, VisualKnightC
  }
 
  private void processTestSessionResult(UploadScreenshotMutation uploadResult) {
- if (uploadResult.misMatchPercentage == null && uploadResult.isSameDimensions != false) {
+ if (uploadResult.misMatchPercentage == null) {
  throw new Error("For this image is no baseline defined! -> " + uploadResult.link);
  }
 

src/main/java/agent_java_core/VisualKnightOptions.java

@@ -7,7 +7,6 @@ public class VisualKnightOptions {
  String apiEndpoint;
  String apiKey;
  String project;
- Boolean liveResult;
  @Builder.Default
  Double misMatchTolerance = 0.01;
  @Builder.Default

src/test/java/Example.java

@@ -1,9 +1,13 @@
 import agent_java_core.VisualKnightCapabilities;
 import agent_java_core.VisualKnightOptions;
 import agent_java_core.VisualKnightCore;
+import org.apache.commons.io.FileUtils;
 import org.junit.Test;
 
+import java.io.File;
+import java.io.IOException;
 import java.net.MalformedURLException;
+import java.util.Base64;
 
 public class Example {
 
@@ -25,7 +29,7 @@ public void asd() throws MalformedURLException {
  }
 
  @Test
- public void uploadScreenshot() throws MalformedURLException {
+ public void uploadScreenshot() throws IOException {
  VisualKnightCapabilities visualKnightCapabilities = VisualKnightCapabilities.builder().browserName("Chrome").os("Windows").build();
  VisualKnightOptions visualKnightOptions = VisualKnightOptions.builder()
  .apiEndpoint("http://localhost:3333/graphql")
@@ -36,7 +40,8 @@ public void uploadScreenshot() throws MalformedURLException {
 
  VisualKnightCore core = new VisualKnightCore(visualKnightOptions);
 
-// core.uploadScreenshot("ck8spt0hc00001cn12rjlu2vl", "aasd");
+ byte[] fileContent = FileUtils.readFileToByteArray(new File(getClass().getResource("large.png").getFile()));
+// core.uploadScreenshot("ck8t908ie000111pjg8z2x58o", Base64.getEncoder().encodeToString(fileContent));
 
  System.out.println("END");
  }