[shared_preferences_web] Migrate tests to integration_test (flutter#4185)

Author: ditman

packages/shared_preferences/shared_preferences_web/CHANGELOG.md

@@ -1,3 +1,7 @@
+## NEXT
+
+* Move tests to `example` directory, so they run as integration_tests with `flutter drive`.
+
 ## 2.0.0
 
 * Migrate to null-safety.

packages/shared_preferences/shared_preferences_web/example/README.md

@@ -0,0 +1,9 @@
+# Testing
+
+This package uses `package:integration_test` to run its tests in a web browser.
+
+See [Plugin Tests > Web Tests](https://github.com/flutter/flutter/wiki/Plugin-Tests#web-tests)
+in the Flutter wiki for instructions to setup and run the tests in this package.
+
+Check [flutter.dev > Integration testing](https://flutter.dev/docs/testing/integration-tests)
+for more info.

…eb/test/shared_preferences_web_test.dart …on_test/shared_preferences_web_test.dartpackages/shared_preferences/shared_preferences_web/test/shared_preferences_web_test.dart renamed to packages/shared_preferences/shared_preferences_web/example/integration_test/shared_preferences_web_test.dart packages/shared_preferences/shared_preferences_web/test/shared_preferences_web_test.dart renamed to packages/shared_preferences/shared_preferences_web/example/integration_test/shared_preferences_web_test.dart

@@ -2,11 +2,11 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-@TestOn('chrome')
 import 'dart:convert' show json;
 import 'dart:html' as html;
 
 import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
 import 'package:shared_preferences_platform_interface/method_channel_shared_preferences.dart';
 import 'package:shared_preferences_platform_interface/shared_preferences_platform_interface.dart';
 import 'package:shared_preferences_web/shared_preferences_web.dart';
@@ -20,12 +20,14 @@ const Map<String, dynamic> kTestValues = <String, dynamic>{
 };
 
 void main() {
+  IntegrationTestWidgetsFlutterBinding.ensureInitialized();
+
   group('SharedPreferencesPlugin', () {
     setUp(() {
       html.window.localStorage.clear();
     });
 
-    test('registers itself', () {
+    testWidgets('registers itself', (WidgetTester tester) async {
       SharedPreferencesStorePlatform.instance =
           MethodChannelSharedPreferencesStore();
       expect(SharedPreferencesStorePlatform.instance,
@@ -35,7 +37,7 @@ void main() {
           isA<SharedPreferencesPlugin>());
     });
 
-    test('getAll', () async {
+    testWidgets('getAll', (WidgetTester tester) async {
       final SharedPreferencesPlugin store = SharedPreferencesPlugin();
       expect(await store.getAll(), isEmpty);
 
@@ -46,7 +48,7 @@ void main() {
       expect(allData['flutter.testKey'], 'test value');
     });
 
-    test('remove', () async {
+    testWidgets('remove', (WidgetTester tester) async {
       final SharedPreferencesPlugin store = SharedPreferencesPlugin();
       html.window.localStorage['flutter.testKey'] = '"test value"';
       expect(html.window.localStorage['flutter.testKey'], isNotNull);
@@ -58,7 +60,7 @@ void main() {
       );
     });
 
-    test('setValue', () async {
+    testWidgets('setValue', (WidgetTester tester) async {
       final SharedPreferencesPlugin store = SharedPreferencesPlugin();
       for (String key in kTestValues.keys) {
         final dynamic value = kTestValues[key];
@@ -79,7 +81,7 @@ void main() {
       );
     });
 
-    test('clear', () async {
+    testWidgets('clear', (WidgetTester tester) async {
       final SharedPreferencesPlugin store = SharedPreferencesPlugin();
       html.window.localStorage['flutter.testKey1'] = '"test value"';
       html.window.localStorage['flutter.testKey2'] = '42';

packages/shared_preferences/shared_preferences_web/example/lib/main.dart

@@ -0,0 +1,25 @@
+// Copyright 2013 The Flutter 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 'package:flutter/material.dart';
+
+void main() {
+  runApp(MyApp());
+}
+
+/// App for testing
+class MyApp extends StatefulWidget {
+  @override
+  _MyAppState createState() => _MyAppState();
+}
+
+class _MyAppState extends State<MyApp> {
+  @override
+  Widget build(BuildContext context) {
+    return Directionality(
+      textDirection: TextDirection.ltr,
+      child: Text('Testing... Look at the console output for results!'),
+    );
+  }
+}

packages/shared_preferences/shared_preferences_web/example/pubspec.yaml

@@ -0,0 +1,21 @@
+name: shared_preferences_web_integration_tests
+publish_to: none
+
+environment:
+  sdk: ">=2.12.0 <3.0.0"
+  flutter: ">=2.2.0"
+
+dependencies:
+  shared_preferences_web:
+    path: ../
+  flutter:
+    sdk: flutter
+
+dev_dependencies:
+  js: ^0.6.3
+  flutter_test:
+    sdk: flutter
+  flutter_driver:
+    sdk: flutter
+  integration_test:
+    sdk: flutter

packages/shared_preferences/shared_preferences_web/example/run_test.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/bash
+# Copyright 2013 The Flutter Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+if pgrep -lf chromedriver > /dev/null; then
+  echo "chromedriver is running."
+
+  if [ $# -eq 0 ]; then
+    echo "No target specified, running all tests..."
+    find integration_test/ -iname *_test.dart | xargs -n1 -i -t flutter drive -d web-server --web-port=7357 --browser-name=chrome --driver=test_driver/integration_test.dart --target='{}'
+  else
+    echo "Running test target: $1..."
+    set -x
+    flutter drive -d web-server --web-port=7357 --browser-name=chrome --driver=test_driver/integration_test.dart --target=$1
+  fi
+
+  else
+    echo "chromedriver is not running."
+    echo "Please, check the README.md for instructions on how to use run_test.sh"
+fi
+

packages/shared_preferences/shared_preferences_web/example/test_driver/integration_test.dart

@@ -0,0 +1,7 @@
+// Copyright 2013 The Flutter 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 'package:integration_test/integration_test_driver.dart';
+
+Future<void> main() => integrationDriver();

packages/shared_preferences/shared_preferences_web/example/web/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<!-- Copyright 2013 The Flutter Authors. All rights reserved.
+Use of this source code is governed by a BSD-style license that can be
+found in the LICENSE file. -->
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>example</title>
+</head>
+<body>
+  <script src="main.dart.js" type="application/javascript"></script>
+</body>
+</html>

packages/shared_preferences/shared_preferences_web/test/README.md

@@ -0,0 +1,5 @@
+## test
+
+This package uses integration tests for testing.
+
+See `example/README.md` for more info.

packages/shared_preferences/shared_preferences_web/test/tests_exist_elsewhere_test.dart

@@ -0,0 +1,14 @@
+// Copyright 2013 The Flutter 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 'package:flutter_test/flutter_test.dart';
+
+void main() {
+  test('Tell the user where to find the real tests', () {
+    print('---');
+    print('This package uses integration_test for its tests.');
+    print('See `example/README.md` for more info.');
+    print('---');
+  });
+}