com.mark59.scripting.KeepBrowserOpen Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2019 Mark59.com
 *  
 *  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.scripting;

/**
 * To indicate when the browser should be left open or closed when testing a UI script.
 *  
 * Note the option has no effect when running in headless mode (the browser and all associated objects will always close).  
 * 
 *  Options are :
 *  

 *  	NEVER     - the browser will always close at test end (default except when testing via the runSeleniumTest() method). 
 *  
 	ONFAILURE - if the script errors (exception or assertion error caught), the browser will stay open, otherwise it will close. Set as the default behaviour when testing.	    
 *	
	ALWAYS    - the browser will be left open at the end of the test.	
 *  
 *  
 * @see com.mark59.scripting.selenium.SeleniumAbstractJavaSamplerClient#runUiTest(KeepBrowserOpen)
 * @see com.mark59.scripting.playwright.PlaywrightAbstractJavaSamplerClient#runUiTest(KeepBrowserOpen)
 * 
 * @author Philip Webb
 * Written: Australian Winter 2019    
 */
public enum KeepBrowserOpen {
	/** NEVER - always close the browser  */
	NEVER,
	/** ONFAILURE - keep open on failure if running headed  */
	ONFAILURE,
	/** ALWAYS - always keep open if running headed  */
	ALWAYS
}