org.openqa.grid.internal

Class TestSlot

java.lang.Object

org.openqa.grid.internal.TestSlot

public class TestSlot
extends java.lang.Object

The entity on a proxy that can host a test session. A test slot has only 1 desired capabilities ( firefox or chrome for instance, but if a remoteproxy needs to support both, the remoteproxy will need 2 TestSlots ) A TestSlot can host 1 TestSession max at a time.

The listener (TestSessionListener attached to the test session of this test slot is thread safe. If 2 threads are trying to execute the before / after session, only 1 will be executed.The other one will be discarded. This class sees multiple threads but is currently sort-of protected by the lock in Registry. Unfortunately the CleanUpThread also messes around in here, so it should be thread safe on its own.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	beingReleased
private java.util.Map<java.lang.String,java.lang.Object>	capabilities
private TestSession	currentSession
private long	lastSessionStart
private java.util.concurrent.locks.Lock	lock
private static java.util.logging.Logger	log
private CapabilityMatcher	matcher
private java.lang.String	path
private SeleniumProtocol	protocol
private RemoteProxy	proxy
private boolean	showWarning

Constructor Summary

Constructors

Constructor and Description
TestSlot(RemoteProxy proxy, SeleniumProtocol protocol, java.util.Map<java.lang.String,java.lang.Object> capabilities) Create a new test slot
TestSlot(RemoteProxy proxy, SeleniumProtocol protocol, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> capabilities) Create a new test slot specifying a custom protocol path

Method Summary

Modifier and Type	Method and Description
void	doFinishRelease() Finish releasing all resources so the slot can be reused.
(package private) void	finishReleaseProcess() releasing all the resources.
java.util.Map<java.lang.String,java.lang.Object>	getCapabilities()
(package private) java.lang.String	getInternalKey()
long	getLastSessionStart()
TestSession	getNewSession(java.util.Map<java.lang.String,java.lang.Object> desiredCapabilities) Try to get a new session for the test slot for the desired capability.
java.lang.String	getPath() the path the server is using to handle the request.
SeleniumProtocol	getProtocol() the type of protocol for the TestSlot.Ideally should always be webdriver, but can also be selenium1 protocol for backward compatibility purposes.
RemoteProxy	getProxy()
java.net.URL	getRemoteURL() get the full URL the underlying server is listening on for selenium / webdriver commands.
TestSession	getSession() get the test session currently executed on this test slot.
boolean	matches(java.util.Map<java.lang.String,java.lang.Object> desiredCapabilities)
(package private) boolean	performAfterSessionEvent()
(package private) boolean	startReleaseProcess() Starts the release process for the TestSlot.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final java.util.logging.Logger log

capabilities

private final java.util.Map<java.lang.String,java.lang.Object> capabilities

proxy

private final RemoteProxy proxy

protocol

private final SeleniumProtocol protocol

path

private final java.lang.String path

matcher

private final CapabilityMatcher matcher

lock

private final java.util.concurrent.locks.Lock lock

currentSession

private volatile TestSession currentSession

beingReleased

volatile boolean beingReleased

showWarning

private boolean showWarning

lastSessionStart

private long lastSessionStart

Constructor Detail

TestSlot

public TestSlot(RemoteProxy proxy,
                SeleniumProtocol protocol,
                java.lang.String path,
                java.util.Map<java.lang.String,java.lang.Object> capabilities)

Create a new test slot specifying a custom protocol path

Parameters:

proxy - the RemoteProxy which includes this test slot

protocol - the SeleniumProtocol this test slot conforms to

path - the protocol path this test slot uses

capabilities - capabilities of this test slot

TestSlot

public TestSlot(RemoteProxy proxy,
                SeleniumProtocol protocol,
                java.util.Map<java.lang.String,java.lang.Object> capabilities)

Create a new test slot

Parameters:

proxy - the RemoteProxy which includes this test slot

protocol - the SeleniumProtocol this test slot conforms to

capabilities - capabilities of this test slot

Method Detail

getCapabilities

public java.util.Map<java.lang.String,java.lang.Object> getCapabilities()

Returns:

the capabilities of this test slot

getProxy

public RemoteProxy getProxy()

Returns:

the RemoteProxy that hosts this slot.

getNewSession

public TestSession getNewSession(java.util.Map<java.lang.String,java.lang.Object> desiredCapabilities)

Try to get a new session for the test slot for the desired capability. To define if the test slot can host the desired capabilities, CapabilityMatcher.matches(Map, Map) is invoked.

Use GridHubConfiguration.capabilityMatcher on the proxy hosting the test slot to modify the definition of match

Parameters:

desiredCapabilities - capabilities for the new session

Returns:

a new session linked to that testSlot if possible, null otherwise.

getProtocol

public SeleniumProtocol getProtocol()

the type of protocol for the TestSlot.Ideally should always be webdriver, but can also be selenium1 protocol for backward compatibility purposes.

Returns:

the protocol for this TestSlot

getPath

public java.lang.String getPath()

the path the server is using to handle the request. Typically /wd/hub for a webdriver based protocol and /selenium-server/driver/ for a selenium1 based protocol

Returns:

the path the server is using for the requests of this slot.

matches

public boolean matches(java.util.Map<java.lang.String,java.lang.Object> desiredCapabilities)

Parameters:

desiredCapabilities - capabilities for the new session

Returns:

true if the desired capabilities matches for the RemoteProxy.getCapabilityHelper()

getSession

public TestSession getSession()

get the test session currently executed on this test slot.

Returns:

the session. Null if the slot is not used at the moment.

startReleaseProcess

boolean startReleaseProcess()

Starts the release process for the TestSlot. Once the release process has started, the clients can't access the test slot any more, but the slot can't be reserved for another test until finishReleaseProcess is called.

That gives time to run exactly once the cleanup operation needed using @see TestSessionListener.afterSession(TestSession)

Returns:

true if that's the first thread trying to release this test slot, false otherwise.

See Also:

finishReleaseProcess()

finishReleaseProcess

void finishReleaseProcess()

releasing all the resources. The slot can now be reused.

doFinishRelease

public void doFinishRelease()

Finish releasing all resources so the slot can be reused.

getInternalKey

java.lang.String getInternalKey()

Returns:

the test session internal key

performAfterSessionEvent

boolean performAfterSessionEvent()

Returns:

invokes after session TestSessionListener events on this test slot

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRemoteURL

public java.net.URL getRemoteURL()

get the full URL the underlying server is listening on for selenium / webdriver commands.

Returns:

the url

getLastSessionStart

public long getLastSessionStart()

Returns:

System.currentTimeMillis() of when the session was started, otherwise -1