b0e4559459
This commit contains: - FlutterDriver API for e2e tests usable in conjunction with package:test - FlutterDriverExtension to be enabled by the application in order to allow an external agent to connect to it and drive user interactions and probe into the element tree - initial implementations of tap, findByValueKey and getText commands (to be expanded in future PRs)
76 lines
2.4 KiB
Dart
76 lines
2.4 KiB
Dart
// Copyright 2016 The Chromium Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
import 'error.dart';
|
|
|
|
/// A piece of data travelling between Flutter Driver and a Flutter application.
|
|
abstract class Message {
|
|
/// Serializes this message to a JSON map.
|
|
Map<String, dynamic> toJson();
|
|
}
|
|
|
|
/// A message that travels from the Flutter Driver to a Flutter application to
|
|
/// instruct the application to perform a task.
|
|
abstract class Command extends Message {
|
|
/// Identifies the type of the command object and of the handler.
|
|
String get kind;
|
|
}
|
|
|
|
/// A message sent from a Flutter application back to the Flutter Driver in
|
|
/// response to a command.
|
|
abstract class Result extends Message { }
|
|
|
|
/// A serializable reference to an object that lives in the application isolate.
|
|
class ObjectRef extends Result {
|
|
ObjectRef(this.objectReferenceKey);
|
|
|
|
ObjectRef.notFound() : this(null);
|
|
|
|
static ObjectRef fromJson(Map<String, dynamic> json) {
|
|
return json['objectReferenceKey'] != null
|
|
? new ObjectRef(json['objectReferenceKey'])
|
|
: null;
|
|
}
|
|
|
|
/// Identifier used to dereference an object.
|
|
///
|
|
/// This value is generated by the application-side isolate. Flutter driver
|
|
/// tests should not generate these keys.
|
|
final String objectReferenceKey;
|
|
|
|
Map<String, dynamic> toJson() => {
|
|
'objectReferenceKey': objectReferenceKey,
|
|
};
|
|
}
|
|
|
|
/// A command aimed at an object represented by [targetRef].
|
|
///
|
|
/// Implementations must provide a concrete [kind]. If additional data is
|
|
/// required beyond the [targetRef] the implementation may override [toJson]
|
|
/// and add more keys to the returned map.
|
|
abstract class CommandWithTarget extends Command {
|
|
CommandWithTarget(ObjectRef ref) : this.targetRef = ref?.objectReferenceKey {
|
|
if (ref == null)
|
|
throw new DriverError('${this.runtimeType} target cannot be null');
|
|
|
|
if (ref.objectReferenceKey == null)
|
|
throw new DriverError('${this.runtimeType} target reference cannot be null');
|
|
}
|
|
|
|
/// Refers to the object targeted by this command.
|
|
final String targetRef;
|
|
|
|
/// This method is meant to be overridden if data in addition to [targetRef]
|
|
/// is serialized to JSON.
|
|
///
|
|
/// Example:
|
|
///
|
|
/// Map<String, dynamic> toJson() => super.toJson()..addAll({
|
|
/// 'foo': this.foo,
|
|
/// });
|
|
Map<String, dynamic> toJson() => {
|
|
'targetRef': targetRef,
|
|
};
|
|
}
|