testRobot<R extends Robot<RobotScenario>> function

@isTest void testRobot<R extends Robot<RobotScenario>>(String description, Future<void> body(R), { RobotScenario? scenario, List<RobotDevice> devices = const [], bool? skip, Timeout? timeout, bool semanticsEnabled = true, TestVariant<Object?> variant = const DefaultTestVariant(), dynamic tags, int? retry, })

A test helper that makes it easy to write widget tests with robots.

The testRobot function is used to write widget tests that use robots to interact with the UI. It requires setting up the robot first using setupRobot.

Example usage:

void main() {
  // Setup the robot builder
  setupRobot(
    (tester) => MyRobot(tester: tester),
  );

  // Write tests using testRobot
  testRobot<MyRobot>(
    'should show sunny icon and toggle to cloudy',
    (robot) async {
      await robot.assertPageSunnyGolden();
      await robot.sunIcon.tap();
      await robot.assertPageCloudyGolden();
    },
    scenario: MyScenario(), // Optional scenario configuration
  );

  // Test on multiple device sizes
  testRobot<MyRobot>(
    'should display correctly on different devices',
    (robot) async {
      await robot.assertPageLayout();
    },
    devices: [
      RobotDevice.large(),
      RobotDevice.small(),
      RobotDevice.medium(),
    ],
    scenario: MyScenario(),
  );
}

Parameters:

• description: Test description
• body: Test body that receives the robot instance
• scenario: Optional scenario configuration
• devices: List of device configurations for multi-device testing
• skip: Whether to skip this test
• timeout: Custom timeout duration
• semanticsEnabled: Whether semantics are enabled
• variant: Test variants configuration
• tags: Test tags
• retry: Number of retry attempts
• experimentalLeakTesting: Leak testing configuration

Implementation

@isTest
void testRobot<R extends Robot>(
  String description,
  Future<void> Function(R) body, {
  RobotScenario? scenario,
  List<RobotDevice> devices = const [],
  bool? skip,
  test_package.Timeout? timeout,
  bool semanticsEnabled = true,
  TestVariant<Object?> variant = const DefaultTestVariant(),
  dynamic tags,
  int? retry,
}) {
  testWidgets(
    description,
    (tester) async {
      if (devices.isEmpty) {
        final robot = _blocBuilder[R.toString()]!(tester) as R;
        await robot.setup(scenario: scenario);
        await body(robot);
        return;
      }
      await MultiDeviceRobot<R>(
        robot: _blocBuilder[R.toString()]!(tester) as R,
        devices: devices,
        test: (robot, device) async {
          await robot.setup(scenario: scenario);
          await body(robot);
        },
      ).run();
    },
    skip: skip,
    timeout: timeout,
    semanticsEnabled: semanticsEnabled,
    variant: variant,
    tags: tags,
    retry: retry,
  );
}