com.teamscale.client.ClusteredTestDetails Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamscale-client Show documentation

A tiny service client that only supports Teamscale's the external upload interface and impacted-tests service.

There is a newer version: 34.0.2

package com.teamscale.client;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * {@link TestDetails} with additional information about which cluster of tests the test case belongs to during
 * prioritization.
 */
public class ClusteredTestDetails extends TestDetails {

	/**
	 * A unique identifier for the cluster this test should be prioritized within. If null the test gets assigned its
	 * own unique cluster.
	 */
	public String clusterId;

	/**
	 * The partition for the cluster this test should be prioritized within and the result will be uploaded to.
	 */
	public String partition;

	@JsonCreator
	public ClusteredTestDetails(@JsonProperty("uniformPath") String uniformPath,
								@JsonProperty("sourcePath") String sourcePath, @JsonProperty("content") String content,
								@JsonProperty("clusterId") String clusterId,
								@JsonProperty("partition") String partition) {
		super(uniformPath, sourcePath, content);
		this.clusterId = clusterId;
		this.partition = partition;
	}

	/**
	 * Creates clustered test details with the given additional {@link TestData}.
	 * 
	 * Use this to easily mark additional files or data as belonging to that test case. Whenever the given
	 * {@link TestData} changes, this test will be selected to be run by the TIA.
	 * 
	 * Example: For a test that reads test data from an XML file, you should pass the contents of that XML file as its
	 * test data. Then, whenever the XML is modified, the corresponding test will be run by the TIA.
	 */
	public static ClusteredTestDetails createWithTestData(String uniformPath, String sourcePath, TestData testData,
														  String clusterId, String partition) {
		return new ClusteredTestDetails(uniformPath, sourcePath, testData.hash, clusterId, partition);
	}

}