com.mark59.core.interfaces.JmeterFunctions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mark59-core Show documentation
Common core components of the mark59 framework.
There is a newer version: 6.2
/*
 *  Copyright 2019 Insurance Australia Group Limited
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License"); 
 *  you may not use this file except in compliance with the License. 
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *      
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mark59.core.interfaces;

import org.apache.jmeter.samplers.SampleResult;

import com.mark59.core.utils.Mark59Constants.JMeterFileDatatypes;

/**
 * Defines methods that can be called throughout the lifecycle of the test in order to handle behaviour around recording timings and other metrics.
 * 
 * @author Philip Webb    
 * @author Michael Cohen
 * Written: Australian Winter 2019  
 */
public interface JmeterFunctions {

	/**
	 * Start monitoring the transaction / Begin the timer
	 * Adds a transaction with the supplied label name and commences the timer. 
	 * Should be paired with a call to this.endTransaction(String).
	 * @param transactionID label for the transaction
	 */
	void startTransaction(String transactionID);

	
	/**
	 * Stop monitoring the transaction / End the timer
	 * Ends an existing transaction with the supplied label name, stopping the timer
	 * Should be paired with a call to this.startTransaction(String).
	 * 
	 * @param transactionID label for the transaction
	 * @return SampleResult
	 */
	SampleResult endTransaction(String transactionID);

	
	/**
	 * Set a transactions for a given time.
	 * 
	 * This is independent of starting or stopping transactions, setting a specific value for the transaction duration.
	 * 
	 * @param transactionLabel label for the transaction
	 * @param transactionTime time taken for the transaction
	 * @return SampleResult 
	 */
	SampleResult setTransaction(String transactionLabel, long transactionTime);
	
	
	/**
	 * Set a transactions for a given time (in milliseconds).  The transaction status of success (or fail) is passed. 
	 * This is independent of starting or stopping transactions, setting a specific value for the transaction duration.
	 * Allows for setting whether the transaction was a success or failure
	 * 
	 * @param transactionLabel label for the transaction
	 * @param transactionTime time taken for the transaction
	 * @param success success state of the transaction
	 * @return SampleResult
	 */
	SampleResult setTransaction(String transactionLabel, long transactionTime, boolean success);
	
	
	/**
	 * Set a transactions for a given time (in milliseconds).  The transaction status of success (or fail) is passed. 
	 * This is independent of starting or stopping transactions, setting a specific value for the transaction duration.
	 * Allows for setting whether the transaction was a success or failure
	 * Allows for a response message (which is printed in a JMeter report for error transactions)
	 * 
	 * @param transactionLabel label for the transaction
	 * @param transactionTime time taken for the transaction
	 * @param success success state of the transaction
	 * @param responseCode response message (useful for error transactions)
	 * @return SampleResult
	 */
	SampleResult setTransaction(String transactionLabel, long transactionTime, boolean success, String responseCode);
	
	
	/**
	 * Add a single datapoint.
	 * A datapoint reflects an arbitrary discrete value, other than time to complete a transaction.
	 * 
	 * @param dataPointName label for the datapoint
	 * @param dataPointValue value for the datapoint
	 * @return SampleResult
	 */
	SampleResult userDataPoint(String dataPointName, long dataPointValue);
	
	
	/**
	 * Add a single result of a given datatype.
	 * 
	 * @param dataPointName label for the datapoint
	 * @param dataPointValue value for the datapoint
	 * @param jmeterFileDatatypes see data value as they appear on the JMeter results file
	 * @return SampleResult
	 * @see JMeterFileDatatypes
	 */
	SampleResult userDatatypeEntry(String dataPointName, long dataPointValue,  JMeterFileDatatypes jmeterFileDatatypes);

	
	/**
	 * Behaviours to execute at the end of test, such as terminating transations that were started but not ended.
	 * Specific behaviours vary based on the particular implementation of Tester.
	 */
	void tearDown();
	
	
	/**
	 * Marks the test as failed.
	 */
	void failTest();
	
	
	/**
	 * Return results from running the test
	 * @return org.apache.jmeter.samplers.SampleResult
	 */	
	SampleResult getMainResult();
}