com.eviware.soapui.security

Class SecurityTest

java.lang.Object

com.eviware.soapui.model.support.AbstractModelItem

com.eviware.soapui.impl.wsdl.AbstractWsdlModelItem<T>

com.eviware.soapui.impl.wsdl.AbstractTestPropertyHolderWsdlModelItem<SecurityTestConfig>

com.eviware.soapui.security.SecurityTest

All Implemented Interfaces:

MutableTestPropertyHolder, ModelItem, Releasable, AnimatableItem, TestModelItem, TestPropertyHolder, TestRunnable, PropertyChangeNotifier

public class SecurityTest
extends AbstractTestPropertyHolderWsdlModelItem<SecurityTestConfig>
implements TestModelItem, TestRunnable

This class is used to connect a TestCase with a set of security scans

Author:

SoapUI team

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAIL_ON_ERROR_PROPERTY
static String	FAIL_ON_SCANS_ERRORS_PROPERTY
static String	ICON_NAME
static String	SKIP_DATASOURCE_LOOP_PROPERTY
static String	STARTUP_SCRIPT_PROPERTY
static String	TEARDOWN_SCRIPT_PROPERTY

Fields inherited from interface com.eviware.soapui.model.ModelItem

DESCRIPTION_PROPERTY, ICON_PROPERTY, LABEL_PROPERTY, NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SecurityTest(WsdlTestCase testCase, SecurityTestConfig config)

Method Summary

Modifier and Type	Method and Description
SecurityScan	addNewSecurityScan(TestStep testStep, String securityScanName) Adds new securityScan for the specific TestStep by Security Scan Type
SecurityScan	addSecurityScan(TestStep testStep, SecurityScanFactory factory, SecurityScanConfig newScanConfig) Adds a securityScan for the specific TestStep
void	addSecurityTestListener(SecurityTestListener listener)
void	addSecurityTestRunListener(SecurityTestRunListener listener)
void	addTestStepRunListener(TestStep testStep, SecurityTestRunListener listener)
boolean	canAddSecurityScan(TestStep testStep, String securityScanName) Checks if we can add new SecurityScan for the specific TestStep (only one type of SecurityScan for TestStep is allowed)
void	clearSecurityTestStepResultMap()
String	findTestStepScanUniqueName(String testStepId, String type)
String[]	getAvailableSecurityScanNames(TestStep testStep, String[] securityScanNames) Creates array of all available security scan names (those that have not been added to test step).
List<? extends ModelItem>	getChildren()
boolean	getFailOnError()
boolean	getFailSecurityTestOnScanErrors()
int	getSecurityScanCount()
HashMap<String,List<SecurityScan>>	getSecurityScansMap() Returns a map of testids to security scans
SecurityTestRunListener[]	getSecurityTestRunListeners()
Map<TestStep,SecurityTestStepResult>	getSecurityTestStepResultMap()
boolean	getSkipDataSourceLoops()
String	getStartupScript()
int	getStepSecurityApplicableScansCount(TestStepResult tsr)
String	getTearDownScript()
WsdlTestCase	getTestCase()
SecurityTestRunListener[]	getTestStepRunListeners(TestStep testStep)
SecurityScan	getTestStepSecurityScanAt(String testStepId, int index)
SecurityScan	getTestStepSecurityScanByName(String testStepId, String securityScanName)
<T extends SecurityScan> List<T>	getTestStepSecurityScanByType(String testStepId, Class<T> securityScanType)
List<SecurityScan>	getTestStepSecurityScans(String testStepId)
int	getTestStepSecurityScansCount(String testStepId)
boolean	importSecurityScan(TestStep targetTestStep, SecurityScan securityScanToClone, boolean overwrite)
boolean	isRunning()
SecurityScan	moveTestStepSecurityScan(TestStep testStep, SecurityScan securityScan, int index, int offset) Moves specified SecurityScan of a TestStep in a list
void	putSecurityTestStepResult(TestStep testStep, SecurityTestStepResult securityTestStepResult) Puts result of a SecurityTest on a TestStep level to a map, if map previously contained value for specified TestStep it is being replaced with the new result value
void	release()
void	removeSecurityScan(TestStep testStep, SecurityScan securityScan) Remove securityScan for the specific TestStep
void	removeSecurityScanWhenRemoveTestStep(TestStep testStep, SecurityScan securityScan)
void	removeSecurityTestListener(SecurityTestListener listener)
void	removeSecurityTestRunListener(SecurityTestRunListener listener)
void	removeTestStepRunListener(TestStep testStep, SecurityTestRunListener listener)
void	resetAllScansSkipFurtherRunning()
void	resetConfigOnMove(SecurityTestConfig securityTestConfig)
SecurityTestRunner	run(StringToObjectMap context, boolean async)
Object	runStartupScript(SecurityTestRunContext runContext, SecurityTestRunner runner) Executes the startup Script
Object	runTearDownScript(SecurityTestRunContext runContext, SecurityTestRunner runner) Executes the teardown Script
void	setFailOnError(boolean failOnError)
void	setFailSecurityTestOnScanErrors(boolean failSecurityTestOnErrors)
void	setSkipDataSourceLoops(boolean skipDataSourceLoops)
void	setStartupScript(String script) Sets the script to be used on startup
void	setTearDownScript(String script) Sets the script to be used on teardown
protected boolean	skipTest(TestStep testStep)

Methods inherited from class com.eviware.soapui.impl.wsdl.AbstractTestPropertyHolderWsdlModelItem

addPropertiesFromFile, addProperty, addTestPropertyListener, getModelItem, getProperties, getPropertiesLabel, getProperty, getPropertyAt, getPropertyCount, getPropertyHolderSupport, getPropertyList, getPropertyNames, getPropertyValue, hasProperty, moveProperty, removeProperty, removeTestPropertyListener, renameProperty, setPropertiesConfig, setPropertyValue

Methods inherited from class com.eviware.soapui.impl.wsdl.AbstractWsdlModelItem

addExternalDependencies, afterLoad, beforeSave, dependsOn, getConfig, getDescription, getExternalDependencies, getIcon, getId, getName, getParent, getSettings, getWsdlModelItemById, getWsdlModelItemByName, resolve, setConfig, setDescription, setIcon, setName, setSettings

Methods inherited from class com.eviware.soapui.model.support.AbstractModelItem

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, getProject, notifyPropertyChanged, notifyPropertyChanged, notifyPropertyChanged, notifyPropertyChanged, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.eviware.soapui.model.TestPropertyHolder

addTestPropertyListener, getModelItem, getProperties, getPropertiesLabel, getProperty, getPropertyAt, getPropertyCount, getPropertyList, getPropertyNames, getPropertyValue, hasProperty, removeTestPropertyListener, setPropertyValue

Methods inherited from interface com.eviware.soapui.model.ModelItem

getDescription, getIcon, getId, getName, getParent, getProject, getSettings

Methods inherited from interface com.eviware.soapui.support.PropertyChangeNotifier

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Field Detail

STARTUP_SCRIPT_PROPERTY

public static final String STARTUP_SCRIPT_PROPERTY

TEARDOWN_SCRIPT_PROPERTY

public static final String TEARDOWN_SCRIPT_PROPERTY

FAIL_ON_SCANS_ERRORS_PROPERTY

public static final String FAIL_ON_SCANS_ERRORS_PROPERTY

FAIL_ON_ERROR_PROPERTY

public static final String FAIL_ON_ERROR_PROPERTY

SKIP_DATASOURCE_LOOP_PROPERTY

public static final String SKIP_DATASOURCE_LOOP_PROPERTY

ICON_NAME

public static final String ICON_NAME

See Also:

Constant Field Values

Constructor Detail

SecurityTest

public SecurityTest(WsdlTestCase testCase,
                    SecurityTestConfig config)

Method Detail

release

public void release()

Specified by:

release in interface Releasable

Overrides:

release in class AbstractWsdlModelItem<SecurityTestConfig>

addNewSecurityScan

public SecurityScan addNewSecurityScan(TestStep testStep,
                                       String securityScanName)

Adds new securityScan for the specific TestStep by Security Scan Type

Parameters:

testStep -

securityScanName -

Returns:

SecurityScan

addSecurityScan

public SecurityScan addSecurityScan(TestStep testStep,
                                    SecurityScanFactory factory,
                                    SecurityScanConfig newScanConfig)

Adds a securityScan for the specific TestStep

Parameters:

testStep -

factory -

newScanConfig -

Returns:

removeSecurityScan

public void removeSecurityScan(TestStep testStep,
                               SecurityScan securityScan)

Remove securityScan for the specific TestStep

Parameters:

testStep -

securityScan -

removeSecurityScanWhenRemoveTestStep

public void removeSecurityScanWhenRemoveTestStep(TestStep testStep,
                                                 SecurityScan securityScan)

getSecurityScansMap

public HashMap<String,List<SecurityScan>> getSecurityScansMap()

Returns a map of testids to security scans

Returns:

A map of TestStepIds to their relevant security scans

getSecurityScanCount

public int getSecurityScanCount()

getStepSecurityApplicableScansCount

public int getStepSecurityApplicableScansCount(TestStepResult tsr)

getSecurityTestStepResultMap

public Map<TestStep,SecurityTestStepResult> getSecurityTestStepResultMap()

clearSecurityTestStepResultMap

public void clearSecurityTestStepResultMap()

putSecurityTestStepResult

public void putSecurityTestStepResult(TestStep testStep,
                                      SecurityTestStepResult securityTestStepResult)

Puts result of a SecurityTest on a TestStep level to a map, if map previously contained value for specified TestStep it is being replaced with the new result value

Parameters:

testStep -

securityTestStepResult -

getTestCase

public WsdlTestCase getTestCase()

Returns:

the current testcase

run

public SecurityTestRunner run(StringToObjectMap context,
                              boolean async)

Specified by:

run in interface TestRunnable

setStartupScript

public void setStartupScript(String script)

Sets the script to be used on startup

Parameters:

script -

getStartupScript

public String getStartupScript()

Returns:

The current startup script

runStartupScript

public Object runStartupScript(SecurityTestRunContext runContext,
                               SecurityTestRunner runner)
                        throws Exception

Executes the startup Script

Parameters:

runContext -

runner -

Returns:

Throws:

Exception

setTearDownScript

public void setTearDownScript(String script)

Sets the script to be used on teardown

Parameters:

script -

getTearDownScript

public String getTearDownScript()

Returns:

The current teardown script

runTearDownScript

public Object runTearDownScript(SecurityTestRunContext runContext,
                                SecurityTestRunner runner)
                         throws Exception

Executes the teardown Script

Parameters:

runContext -

runner -

Returns:

Throws:

Exception

getTestStepSecurityScans

public List<SecurityScan> getTestStepSecurityScans(String testStepId)

getTestStepSecurityScanByName

public SecurityScan getTestStepSecurityScanByName(String testStepId,
                                                  String securityScanName)

getTestStepSecurityScanByType

public <T extends SecurityScan> List<T> getTestStepSecurityScanByType(String testStepId,
                                                                      Class<T> securityScanType)

getTestStepSecurityScanAt

public SecurityScan getTestStepSecurityScanAt(String testStepId,
                                              int index)

getTestStepSecurityScansCount

public int getTestStepSecurityScansCount(String testStepId)

moveTestStepSecurityScan

public SecurityScan moveTestStepSecurityScan(TestStep testStep,
                                             SecurityScan securityScan,
                                             int index,
                                             int offset)

Moves specified SecurityScan of a TestStep in a list

Parameters:

testStep -

securityScan -

index -

offset - specifies position to move to , negative value means moving up while positive value means moving down

Returns:

new AbstractSecurityScan

findTestStepScanUniqueName

public String findTestStepScanUniqueName(String testStepId,
                                         String type)

addSecurityTestRunListener

public void addSecurityTestRunListener(SecurityTestRunListener listener)

removeSecurityTestRunListener

public void removeSecurityTestRunListener(SecurityTestRunListener listener)

getSecurityTestRunListeners

public SecurityTestRunListener[] getSecurityTestRunListeners()

getFailSecurityTestOnScanErrors

public boolean getFailSecurityTestOnScanErrors()

setFailSecurityTestOnScanErrors

public void setFailSecurityTestOnScanErrors(boolean failSecurityTestOnErrors)

getFailOnError

public boolean getFailOnError()

setFailOnError

public void setFailOnError(boolean failOnError)

getSkipDataSourceLoops

public boolean getSkipDataSourceLoops()

setSkipDataSourceLoops

public void setSkipDataSourceLoops(boolean skipDataSourceLoops)

addTestStepRunListener

public void addTestStepRunListener(TestStep testStep,
                                   SecurityTestRunListener listener)

removeTestStepRunListener

public void removeTestStepRunListener(TestStep testStep,
                                      SecurityTestRunListener listener)

getTestStepRunListeners

public SecurityTestRunListener[] getTestStepRunListeners(TestStep testStep)

getChildren

public List<? extends ModelItem> getChildren()

Specified by:

getChildren in interface ModelItem

Overrides:

getChildren in class AbstractModelItem

resetConfigOnMove

public void resetConfigOnMove(SecurityTestConfig securityTestConfig)

canAddSecurityScan

public boolean canAddSecurityScan(TestStep testStep,
                                  String securityScanName)

Checks if we can add new SecurityScan for the specific TestStep (only one type of SecurityScan for TestStep is allowed)

Parameters:

testStep -

Returns:

boolean

getAvailableSecurityScanNames

public String[] getAvailableSecurityScanNames(TestStep testStep,
                                              String[] securityScanNames)

Creates array of all available security scan names (those that have not been added to test step).

Parameters:

testStep -

Returns:

boolean

importSecurityScan

public boolean importSecurityScan(TestStep targetTestStep,
                                  SecurityScan securityScanToClone,
                                  boolean overwrite)

addSecurityTestListener

public void addSecurityTestListener(SecurityTestListener listener)

removeSecurityTestListener

public void removeSecurityTestListener(SecurityTestListener listener)

isRunning

public boolean isRunning()

skipTest

protected boolean skipTest(TestStep testStep)

resetAllScansSkipFurtherRunning

public void resetAllScansSkipFurtherRunning()