gg_easy_widget_test 1.1.6

GgEasyWidgetTest eases the tests of the widgets. It easily provides you with the following information about a widget under test.

example/gg_easy_widget_test_example.dart

// @license
// Copyright (c) 2019 - 2021 Dr. Gabriel Gatzsche. All Rights Reserved.
//
// Use of this source code is governed by terms that can be
// found in the LICENSE file in the root of this package.

import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:gg_easy_widget_test/src/gg_easy_widget_test.dart';

const subwidgetFrame = Rect.fromLTWH(10, 20, 30, 40);

// #############################################################################

/// This is the sample widget we will test using GgEasyWidgetTest
class SampleWidget extends StatefulWidget {
  const SampleWidget({required Key key}) : super(key: key);

  @override
  // ignore: library_private_types_in_public_api
  _SampleWidgetState createState() => _SampleWidgetState();
}

// .............................................................................
/// This is the state of the sample widget we will test using GgEasyWidgetTest
class _SampleWidgetState extends State<SampleWidget> {
  @override
  Widget build(BuildContext context) {
    return Container(
      width: subwidgetFrame.width,
      height: subwidgetFrame.height,
    );
  }
}

// #############################################################################
void main() {
  group('GgEasyWidgetTest', () {
    // .........................................................................
    testWidgets('should provide information about an widget under test',
        (WidgetTester tester) async {
      // ......................................
      // Create a widget containing a subwidget
      final sampleWidgetKey = GlobalKey(debugLabel: 'sampleWidgetKey');
      final sampleWidget = SampleWidget(key: sampleWidgetKey);

      final widget = Directionality(
        textDirection: TextDirection.ltr,
        child: Container(
          child: Stack(
            children: [
              Positioned(
                left: subwidgetFrame.left,
                top: subwidgetFrame.top,
                child: sampleWidget,
              ),
            ],
          ),
        ),
      );

      // ......................
      // Instantiate the widget
      await tester.pumpWidget(widget);
      await tester.pumpAndSettle();

      // .................................
      // Create a finder for the subwidget
      final sampleWidgetFinder = find.byKey(sampleWidgetKey);

      // .........................................
      // Create a GgEasyWidgetTest for the subwidget
      final ggEasyWidgetTest = GgEasyWidgetTest(sampleWidgetFinder, tester);

      // ..................................
      // Width and height should be correct
      expect(ggEasyWidgetTest.width, subwidgetFrame.width);
      expect(ggEasyWidgetTest.height, subwidgetFrame.height);

      // ..............................
      // Render box should be delivered
      expect(ggEasyWidgetTest.renderBox, isInstanceOf<RenderBox>());

      // ..............................
      // The element should be delivered
      expect(ggEasyWidgetTest.element, isInstanceOf<Element>());

      // ......................................
      // The absolute frame should be delivered
      expect(ggEasyWidgetTest.absoluteFrame, subwidgetFrame);

      // ..............................
      // The widget should be delivered
      expect(ggEasyWidgetTest.widget, sampleWidget);

      // .............................
      // The state should be delivered
      expect(ggEasyWidgetTest.state, isInstanceOf<_SampleWidgetState>());
    });
  });
}