com.aventstack.extentreports.ReportAggregatesListener Maven / Gradle / Ivy

package com.aventstack.extentreports;

import java.util.List;

import com.aventstack.extentreports.model.Author;
import com.aventstack.extentreports.model.Category;
import com.aventstack.extentreports.model.Device;
import com.aventstack.extentreports.model.Test;
import com.aventstack.extentreports.model.context.ExceptionTestContextStore;
import com.aventstack.extentreports.model.context.SystemAttributeContext;
import com.aventstack.extentreports.model.context.TestAttributeTestContextStore;

/**
 * Allows sharing of aggregates/collections to be shared with the started
 * reporter. A few examples of these collections include:
 * 
 * 
 * Category context - list of all categories and associated tests
 * Exception context - list of all exceptions and associated tests
 * Complete list of started tests
 * System information
 * 
 */
public interface ReportAggregatesListener {

	/**
	 * Allows sharing the complete list of tests with the reporter
	 * 
	 * @param testList list of all tests created by {@link ExtentReports}
	 */
	void setTestList(List testList);

	/**
	 * Passes the complete list of logs to the reporter
	 * 
	 * @param logs testrunner logs
	 */
	void setTestRunnerLogs(List logs);

	/**
	 * Allows sharing the complete list of category and associated tests with the
	 * reporter
	 * 
	 * @param categoryContext collection containing categories and all associated
	 *                        tests
	 */
	void setCategoryContextInfo(TestAttributeTestContextStore categoryContext);

	/**
	 * Allows sharing the complete list of author and associated tests with the
	 * reporter
	 *
	 * @param authorContext collection containing author and all associated tests
	 */
	void setAuthorContextInfo(TestAttributeTestContextStore authorContext);

	/**
	 * Allows sharing the complete list of device and associated tests with the
	 * reporter
	 *
	 * @param deviceContext collection containing devices and all associated tests
	 */
	void setDeviceContextInfo(TestAttributeTestContextStore deviceContext);

	/**
	 * Allows sharing the complete list of exceptions and associated tests with the
	 * reporter
	 * 
	 * @param exceptionContext collection containing exception and all associated
	 *                         tests
	 */
	void setExceptionContextInfo(ExceptionTestContextStore exceptionContext);

	/**
	 * Passes all system information to the reporter
	 * 
	 * @param systemAttributeContext system information
	 */
	void setSystemAttributeContext(SystemAttributeContext systemAttributeContext);

	/**
	 * Report Status stats of the run session for all possible levels:
	 * 
	 * 
	 * Features/Tests
	 * Scenarios/Logs
	 * Steps
	 * 
	 * 
	 * @param sc {@link ReportStatusStats} represents stats of each hierarchical
	 *           level of test/event
	 */
	void setReportStatusStats(ReportStatusStats sc);

	/**
	 * A distinct list of status assigned to tests
	 * 
	 * @param statusList a distinct list of {@link Status}
	 */
	void setStatusList(List statusList);

}