automated_testing_framework_models library

Classes

AbortTestCommand
Command to abort a currently running test.
AnnounceDeviceCommand
Command to announce a device to a command and control server.
AnnounceDriverCommand
Command to announce a test driver to a command and control server.
AsyncTestLoader
Loader that loads the test from an async callback.
BaseSize
CancelToken
Token can can be used to cancel test steps.
ChallengeCommand
Command issued to solicit a challenge response for authentication / authorization purposes.
ChallengeResponseCommand
Command to respond to a challenge with an authorization signature for authentication / authorization.
CommandAck
Acknowlegement command sent in response to acknowledge a remote command. This will include the id of the command being ack'd in the commandId.
CommandResponse
Base class for the command responses associated to the CommandAck.
ConnectedDevice
DeviceCommand
A command class intended to be extended to provide comamnds and controls events between the backend server, the device drivers, and the devices themselves.
DriverSignatureHelper
Helper class to generate signatures for use by test drivers as well as driven devices.
GoldenTestImages
GoodbyeCommand
Command to tell the remote connection that the socket is about to be disconnected by the sender. If the complete attribute is true then the session is also being terminated. Otherwise, if the receiver initiates a reconnection then the session will be resumed.
JsonLogRecord
ListDevicesCommand
Command to list the devices currently online for testing. Use the availableOnly flag to filter between devices that are online, but actively in use, vs ones that are both online and available to run tests.
ListDevicesResponse
Response associated with a ListDevicesCommand that provides the list of connected devices.
LogResponse
Response associated with a StartLogStreamCommand that provides the log entry information.
MemoryTestLoader
Loader that loads the test from an in-memory object.
PendingTest
Describes a pending test. The pending test should describe the name, number of steps, version, and provide a loader to load the full test details.
PingCommand
Command sent to let the other side know the connection is still ongoing and that the sender is still actively processing commands. Devices may optionally provide information about the device and the device's test state as part of these periodic check ins.
ReleaseDeviceCommand
Command sent by a test driver to release a device from the driver to put it back into the available device pool.
RequestScreenshotCommand
Command sent by a test driver to request a single screenshot from a device.
ReserveDeviceCommand
Command sent by a test driver to reserve a test device. If this is ack'd with a successful response, the device will now accept commands from the test driver.
RunTestCommand
Command to initiate a test run on a device. The device will send progress via the CommandAck command using this command's id.
ScreenshotResponse
Response containing a screenshot image. This may come from a RunTestCommand's ScreenshotStep or from a StartScreenshotStreamCommand.
StartLogStreamCommand
Command to start a log stream from the device to the test driver. When accepted the device will send a CommandAck with this command's id and the log information in the response.
StartScreenshotStreamCommand
Command instructing the device to send a screenshot periodically to the driver. The default implementation will only send screenshots that have changed since the previous one rather than constantly sending the same screenshot over and over.
StopLogStreamCommand
Command to instruct a device to stop streaming logs to the test driver.
StopScreenshotStreamCommand
Command to stop the stream of screenshots from a device to a test driver.
Test
PODO for a test that can be executed.
TestableGestureAction
Built-in actions that are available to be set either by-default or by-widget on Testable widgets.
TestableGestures
Set of gestures that Testable widgets will respond to when the TestRunner is enabled. Applications can (should) set the gestures based on their typical usage patterns such that the gestures have a minimal amount of conflict with application based gestures.
TestAppSettings
Provides settings for the test app that apply globaly. Any settings set here will globally override values from other parts of the framework.
TestControllerState
TestDeviceCommunicator
Interface that plugins may implement to provide their own solution for communicating with external sources.
TestDeviceInfo
Container class for the device information for the device the test is being executed on.
TestDeviceStatus
TestImage
Represents an image from a test.
TestLoader
Interface for loading tests.
TestReport
Represents a report from a test run.
TestReportMetadata
TestReportStep
The result for an executed test step. It's important to note that times in the report are relative to each run and should not be thought of in absolute terms. Too many variables such as animations, built in delays, etc. can cause an individual test step to take 1-2 seconds despite a perceived expectation that something should be sub-second. When comparing the times, do so only across tests and look for trends. Avoid the temptation to look at the times as absolutes.
TestStatusResponse
Response that gets sent periodically from a RunTestCommand.
TestStep
Describes a single step in a test. A test step is required to have an id which is the human-readable key for the test step. It has an optional image that is a capture of the widget for reference. Finally, it has an optional set of values that configure the step.
TestStepDelays
Defines the various delays and timeouts involved when executing tests.
TestSuiteReport
A summary of all the results from all the runs in a single test suite.
TestSuiteResult
Represents a the summarized results from a single test run within a larger test suite.

Typedefs

ConnectionChangedCallback = Future<void> Function(TestDeviceCommunicator communicator, bool connected)
DeviceCommandHandler = Future<CommandAck> Function(DeviceCommand command)