org.testobject.integrations.LogentriesResultReporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of testobject-java-api Show documentation
java wrapper for testobject's java apis
There is a newer version: 0.3.1
package org.testobject.integrations;

import org.junit.internal.AssumptionViolatedException;
import org.junit.rules.TestWatcher;
import org.junit.runner.Description;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
import java.util.HashMap;
import java.util.Map;

public class LogentriesResultReporter extends TestWatcher {
	private static final String LOGENTRIES_URL = "http://webhook.logentries.com/noformat/logs/";
	private static final String LOGENTRIES_TOKEN_ENV_NAME = "LOGENTRIES_TOKEN";
	private static final String TEST_IDENTIFIER_ENV_NAME = "TEST_IDENTIFIER";
	private static final String JENKINS_JOB_NAME_ENV_NAME = "JOB_NAME";
	private static final String JENKINS_BUILD_URL_ENV_NAME = "BUILD_URL";

	private static final String JSON_TEST_IDENTIFIER_FIELD = "testIdentifier";
	private static final String JSON_TEST_NAME_FIELD = "testName";
	private static final String JSON_DURATION_FIELD = "duration";
	private static final String JSON_RESULT_FIELD = "result";
	private static final String JSON_JENKINS_JOB_NAME_FIELD = "jenkinsJobName";
	private static final String JSON_JENKINS_BUILD_URL_FIELD = "jenkinsBuildUrl";

	private final Client client;
	private final WebTarget webTarget;
	private final String testIdentifier;
	private final String jenkinsJobName;
	private final String jenkinsBuildUrl;

	// Junit doesn't say if the methods are only invoked once by a test. Therefor, I'm keeping them in a map just to be safe (uu)
	private final Map testsMap = new HashMap<>();

	protected LogentriesResultReporter(Client client, String logentriesToken) {
		if (logentriesToken == null) {
			throw new NullPointerException("logentriesToken can't be null");
		}
		this.client = client;
		this.webTarget = client.target(LOGENTRIES_URL).path(logentriesToken);
		this.testIdentifier = System.getenv(TEST_IDENTIFIER_ENV_NAME);
		this.jenkinsJobName = System.getenv(JENKINS_JOB_NAME_ENV_NAME);
		this.jenkinsBuildUrl = System.getenv(JENKINS_BUILD_URL_ENV_NAME);
	}

	public LogentriesResultReporter(String logentriesToken) {
		this(ClientBuilder.newBuilder().build(), logentriesToken);
	}

	public LogentriesResultReporter() {
		this(ClientBuilder.newBuilder().build(), System.getenv(LOGENTRIES_TOKEN_ENV_NAME));
	}

	@Override
	protected void starting(Description description) {
		if (description.isEmpty()) {
			return;
		}
		testsMap.put(description, new Test(description.getDisplayName(), System.currentTimeMillis()));
	}

	@Override
	protected void succeeded(Description description) {
		if (description.isEmpty()) {
			return;
		}
		Test test = testsMap.get(description);
		if (test != null) {
			test.setState(Test.State.SUCCESS);
		}
	}

	@Override
	protected void failed(Throwable e, Description description) {
		if (description.isEmpty()) {
			return;
		}
		Test test = testsMap.get(description);
		if (test != null) {
			test.setState(Test.State.FAILED);
		}
	}

	@Override
	protected void skipped(AssumptionViolatedException e, Description description) {
		if (description.isEmpty()) {
			return;
		}
		Test test = testsMap.get(description);
		if (test != null) {
			test.setState(Test.State.SKIPPED);
		}
	}

	@Override
	protected void finished(Description description) {
		if (description.isEmpty()) {
			return;
		}
		Test test = testsMap.get(description);
		if (test != null) {
			test.setFinishTime(System.currentTimeMillis());
			sendResult(test);
		}
		client.close();
	}

	private void sendResult(Test test) {
		long testDuration = test.getFinishTime() - test.getStartTime();
		Map json = new HashMap<>();
		json.put(JSON_TEST_NAME_FIELD, test.getName());
		json.put(JSON_DURATION_FIELD, testDuration);
		json.put(JSON_RESULT_FIELD, test.getState().name());
		addOptionalVariables(json);
		Response response = webTarget.request().post(Entity.json(json));
		if (response.getStatus() != 204) {
			throw new RuntimeException("Didn't receive the expected result from logentries. Result: " + response.toString());
		}
	}

	private void addOptionalVariables(Map json) {
		if (testIdentifier != null) {
			json.put(JSON_TEST_IDENTIFIER_FIELD, testIdentifier);
		}
		if (jenkinsJobName != null) {
			json.put(JSON_JENKINS_JOB_NAME_FIELD, jenkinsJobName);
		}
		if (jenkinsBuildUrl != null) {
			json.put(JSON_JENKINS_BUILD_URL_FIELD, jenkinsBuildUrl);
		}
	}
}