Merge pull request #24 from Baseflow/implementing_tests

mvanbeusekom · web-flow · commit be2f25204538 · 2021-03-18T12:07:15.000+01:00
Implementing tests
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 3.0.1
+
+* Added unit-tests to guard API against breaking changes.
+
 ## 3.0.0
 
 * Stable null safety release.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Flutter Google Api Availability Plugin  
 
-[![pub package](https://img.shields.io/pub/v/google_api_availability.svg)](https://pub.dartlang.org/packages/google_api_availability) ![Build status](https://github.com/Baseflow/flutter-google-api-availability/workflows/google_api_availability/badge.svg?branch=master)
+[![pub package](https://img.shields.io/pub/v/google_api_availability.svg)](https://pub.dartlang.org/packages/google_api_availability) ![Build status](https://github.com/Baseflow/flutter-google-api-availability/workflows/google_api_availability/badge.svg?branch=master) [![codecov](https://codecov.io/gh/Baseflow/flutter-google-api-availability/branch/master/graph/badge.svg)](https://codecov.io/gh/Baseflow/flutter-google-api-availability)
 
 A Flutter plugin to check the availability of Google Play services on the current device. 
 
@@ -14,7 +14,7 @@ To use this plugin, add `google_api_availability` as a [dependency in your pubsp
 
 ```yaml
 dependencies:
-  google_api_availability: ^3.0.0
+  google_api_availability: ^3.0.1
 ```
 
 > **NOTE:** There's a known issue with integrating plugins that use Swift into a Flutter project created with the Objective-C template. See issue [Flutter#16049](https://github.com/flutter/flutter/issues/16049) for help on integration.
diff --git a/lib/src/google_api_availability.dart b/lib/src/google_api_availability.dart
@@ -1,6 +1,7 @@
 import 'dart:async';
-import 'dart:io';
 
+import 'package:flutter/foundation.dart';
+import 'package:meta/meta.dart';
 import 'package:flutter/services.dart';
 import 'package:google_api_availability/src/models/google_play_services_availability.dart';
 
@@ -11,6 +12,9 @@ import 'models/google_play_services_availability.dart';
 class GoogleApiAvailability {
   const GoogleApiAvailability._();
 
+  @visibleForTesting
+  const GoogleApiAvailability.private();
+
   /// Acquires an instance of the [GoogleApiAvailability] class.
   static const GoogleApiAvailability instance = GoogleApiAvailability._();
 
@@ -22,7 +26,7 @@ class GoogleApiAvailability {
   /// [GooglePlayServicesAvailability.notAvailableOnPlatform].
   Future<GooglePlayServicesAvailability> checkGooglePlayServicesAvailability(
       [bool showDialogIfNecessary = false]) async {
-    if (!Platform.isAndroid) {
+    if (defaultTargetPlatform != TargetPlatform.android) {
       return GooglePlayServicesAvailability.notAvailableOnPlatform;
     }
 
diff --git a/lib/src/models/google_play_services_availability.dart b/lib/src/models/google_play_services_availability.dart
@@ -1,6 +1,12 @@
+import 'package:meta/meta.dart';
+
 /// Indicates possible states of the Google Api Services availability.
 class GooglePlayServicesAvailability {
   const GooglePlayServicesAvailability._(this.value);
+  factory GooglePlayServicesAvailability.byValue(int value) => values[value];
+
+  @visibleForTesting
+  const GooglePlayServicesAvailability.private(this.value);
 
   /// Represents the integer value of the Google Api Services availability
   /// state.
diff --git a/pubspec.lock b/pubspec.lock
@@ -1,20 +1,6 @@
 # Generated by pub
 # See https://dart.dev/tools/pub/glossary#lockfile
 packages:
-  archive:
-    dependency: transitive
-    description:
-      name: archive
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.0.13"
-  args:
-    dependency: transitive
-    description:
-      name: args
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "1.6.0"
   async:
     dependency: transitive
     description:
@@ -57,58 +43,20 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.15.0"
-  convert:
-    dependency: transitive
-    description:
-      name: convert
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.1.1"
-  crypto:
-    dependency: transitive
-    description:
-      name: crypto
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.1.5"
-  e2e:
-    dependency: "direct dev"
-    description:
-      name: e2e
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.4.3+1"
   fake_async:
     dependency: transitive
     description:
       name: fake_async
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.2.0"
-  file:
-    dependency: transitive
-    description:
-      name: file
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "6.0.0"
   flutter:
     dependency: "direct main"
     description: flutter
     source: sdk
     version: "0.0.0"
-  flutter_driver:
-    dependency: transitive
-    description: flutter
-    source: sdk
-    version: "0.0.0"
   flutter_test:
-    dependency: transitive
-    description: flutter
-    source: sdk
-    version: "0.0.0"
-  fuchsia_remote_debug_protocol:
-    dependency: transitive
+    dependency: "direct dev"
     description: flutter
     source: sdk
     version: "0.0.0"
@@ -140,20 +88,6 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.10.0"
-  platform:
-    dependency: transitive
-    description:
-      name: platform
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "3.0.0"
-  process:
-    dependency: transitive
-    description:
-      name: process
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "4.0.0"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -187,13 +121,6 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.1.0"
-  sync_http:
-    dependency: transitive
-    description:
-      name: sync_http
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.2.0"
   term_glyph:
     dependency: transitive
     description:
@@ -222,20 +149,6 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "2.1.0"
-  vm_service:
-    dependency: transitive
-    description:
-      name: vm_service
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "5.5.0"
-  webdriver:
-    dependency: transitive
-    description:
-      name: webdriver
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.1.2"
 sdks:
   dart: ">=2.12.0-259.9.beta <3.0.0"
   flutter: ">=1.12.13+hotfix.6"
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: google_api_availability
 description: A Flutter plugin to check the availability of Google Play Services on an Android device.
-version: 3.0.0
+version: 3.0.1
 homepage: https://github.com/baseflowit/flutter-google-api-availability
 
 environment:
@@ -12,8 +12,9 @@ dependencies:
     sdk: flutter
 
 dev_dependencies:
+  flutter_test:
+    sdk: flutter
   pedantic: ^1.10.0
-  e2e: ^0.4.0
 
 flutter:
   plugin:
diff --git a/test/google_api_availability_test.dart b/test/google_api_availability_test.dart
@@ -0,0 +1,55 @@
+import 'package:flutter/foundation.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:google_api_availability/google_api_availability.dart';
+
+import 'method_channel_mock.dart';
+
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  test('Should receive notAvailableOnPlatform is not Android', () async {
+    debugDefaultTargetPlatformOverride = TargetPlatform.iOS;
+
+    final googlePlayServiceAvailability = await GoogleApiAvailability.private()
+        .checkGooglePlayServicesAvailability();
+
+    expect(googlePlayServiceAvailability,
+        GooglePlayServicesAvailability.notAvailableOnPlatform);
+
+    debugDefaultTargetPlatformOverride = null;
+  });
+
+  test('Should receive the corresponding GooglePlayServiceAvailability',
+      () async {
+    final availability = GooglePlayServicesAvailability.serviceDisabled;
+
+    MethodChannelMock(
+      channelName: 'flutter.baseflow.com/google_api_availability/methods',
+      method: 'checkPlayServicesAvailability',
+      result: availability.value,
+    );
+
+    final googlePlayServiceAvailability = await GoogleApiAvailability.private()
+        .checkGooglePlayServicesAvailability();
+
+    expect(googlePlayServiceAvailability, availability);
+  });
+
+  test(
+      'Should receive GooglePlayServiceAvailability.unknown when availability is null',
+      () async {
+    final availability = null;
+
+    MethodChannelMock(
+      channelName: 'flutter.baseflow.com/google_api_availability/methods',
+      method: 'checkPlayServicesAvailability',
+      result: availability,
+    );
+
+    final googlePlayServiceAvailability = await GoogleApiAvailability.private()
+        .checkGooglePlayServicesAvailability();
+
+    expect(
+        googlePlayServiceAvailability, GooglePlayServicesAvailability.unknown);
+  });
+}
diff --git a/test/google_play_services_availability_test.dart b/test/google_play_services_availability_test.dart
@@ -0,0 +1,28 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:google_api_availability/google_api_availability.dart';
+
+void main() {
+  test(
+      'GooglePlayServicesAvailability has the right amount of availability states',
+      () {
+    final values = GooglePlayServicesAvailability.values;
+
+    expect(values.length, 8);
+  });
+
+  test('check if corresponding status gets received when calling constructor',
+      () {
+    final values = GooglePlayServicesAvailability.values;
+
+    for (var i = 0; i < values.length; i++) {
+      expect(values[i], GooglePlayServicesAvailability.byValue(i));
+    }
+  });
+
+  test('check if toString method returns the corresponding name', () {
+    var playServicesAvailability = GooglePlayServicesAvailability.private(0);
+
+    expect(playServicesAvailability.toString(),
+        'GooglePlayServicesAvailability.success');
+  });
+}
diff --git a/test/method_channel_mock.dart b/test/method_channel_mock.dart
@@ -0,0 +1,32 @@
+import 'package:flutter/services.dart';
+
+class MethodChannelMock {
+  final MethodChannel methodChannel;
+  final String method;
+  final dynamic result;
+  final Duration delay;
+
+  MethodChannelMock({
+    required String channelName,
+    required this.method,
+    this.result,
+    this.delay = Duration.zero,
+  }) : methodChannel = MethodChannel(channelName) {
+    methodChannel.setMockMethodCallHandler(_handler);
+  }
+
+  Future _handler(MethodCall methodCall) async {
+    if (methodCall.method != method) {
+      throw MissingPluginException('No implementation found for method '
+          '$method on channel ${methodChannel.name}');
+    }
+
+    return Future.delayed(delay, () {
+      if (result is Exception) {
+        throw result;
+      }
+
+      return Future.value(result);
+    });
+  }
+}
