Merge pull request #12 from gogovan/test/enhance

Update tests, add "build" build

Author: luiges90

.github/workflows/build.yaml

@@ -0,0 +1,24 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+
+      - name: Install dependencies
+        run: |
+          flutter pub get
+          flutter pub run build_runner build
+
+      - name: Run tests
+        run: flutter test
+

README.md

@@ -1,6 +1,7 @@
 # flutter-force-permission
 
-[![codecov](https://codecov.io/gh/gogovan/flutter-force-permission/branch/main/graph/badge.svg?token=F9DPJUAVAJ)](https://codecov.io/gh/gogovan/flutter-force-permission)
+![Build](https://github.com/github/gogovan/flutter-force-permission/workflows/build.yaml/badge.svg)
+![codecov](https://codecov.io/gh/gogovan/flutter-force-permission/branch/main/graph/badge.svg?token=F9DPJUAVAJ)](https://codecov.io/gh/gogovan/flutter-force-permission)
 
 Show permission disclosure page and allows required permissions and their associated services before
 the user can proceed.

analysis_options.yaml

@@ -183,7 +183,7 @@ dart_code_metrics:
     - lib/main.dart
   rules:
     # Common
-    - avoid-banned-imports # Configure some imports that you want to ban, ref: https://dartcodemetrics.dev/docs/rules/common/avoid-banned-imports
+    # - avoid-banned-imports # Configure some imports that you want to ban, ref: https://dartcodemetrics.dev/docs/rules/common/avoid-banned-imports
     - avoid-collection-methods-with-unrelated-types # Avoid using collection methods with unrelated types, such as accessing a map of integers using a string key.
     - avoid-duplicate-exports # Warns when a file has multiple exports declarations with the same URI.
     #    - avoid-dynamic # Warns when the dynamic type is used as a variable type in a declaration, return type of a function, etc. Using dynamic is considered unsafe since it can easily result in runtime errors.
@@ -203,7 +203,7 @@ dart_code_metrics:
     - avoid-unused-parameters: # Checks for unused parameters inside a function or method body. For overridden methods suggests renaming unused parameters to _, __, etc.
         exclude:
           - lib/**/*bloc.dart
-    - ban-name # Configure some names that you want to ban, ref: https://dartcodemetrics.dev/docs/rules/common/ban-name
+    # - ban-name # Configure some names that you want to ban, ref: https://dartcodemetrics.dev/docs/rules/common/ban-name
     - binary-expression-operand-order # Warns when a literal value is on the left hand side in a binary expressions, inspired by https://palantir.github.io/tslint/rules/binary-expression-operand-order/
     - double-literal-format # Checks that double literals should begin with 0. instead of just ., and should not end with a trailing 0. Helps keep a consistent style of numeric literals and decrease potential typos.
     - format-comment # Prefer format comments like sentences.

lib/flutter_force_permission.dart

@@ -4,7 +4,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_force_permission/flutter_force_permission_config.dart';
 import 'package:flutter_force_permission/permission_service_status.dart';
 import 'package:flutter_force_permission/src/flutter_force_permission_util.dart';
-import 'package:flutter_force_permission/src/permission_service.dart';
+import 'package:flutter_force_permission/src/test_stub.dart';
 import 'package:flutter_force_permission/src/views/disclosure_page.dart';
 import 'package:permission_handler/permission_handler.dart';
 

lib/permission_item_config.dart

@@ -21,10 +21,8 @@ class PermissionItemConfig {
   /// The display item configuration for these permission(s). Refer to [PermissionItemText] for details.
   final PermissionItemText itemText;
 
-  /// If the permission has an associated service (e.g. location) and this permission is required,
-  /// this service will also be checked for availability.
-  /// If service is unavailable and this item is not null, the disclosure page will
-  /// show a disclosure item for this service, before `itemText`.
+  /// If the permission has an associated service (such as location) and this permission is required, this service will also be checked for availability.
+  /// If service is unavailable and this item is not null, the disclosure page will show a disclosure item for this service, before `itemText`.
   /// Users will also be asked to enable the service.
   ///
   /// *Note*: This is used only when `required` is true.

lib/src/permission_service.dart renamed to lib/src/test_stub.dart

@@ -2,10 +2,9 @@ import 'package:app_settings/app_settings.dart';
 import 'package:permission_handler/permission_handler.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
-/// 3rd party libraries relies too many on static methods which are unmockable
-/// and hence untestable. This service wraps permission_handler methods
-/// so that it can be tested.
-/// https://github.com/Baseflow/flutter-permission-handler/issues/262
+/// 3rd party libraries relies on static methods which are unmockable and hence untestable.
+/// This service wraps those methods so that it can be tested.
+/// See https://github.com/Baseflow/flutter-permission-handler/issues/262 for details.
 class TestStub {
   const TestStub();
 

lib/src/views/disclosure_page.dart

@@ -7,7 +7,7 @@ import 'package:flutter_force_permission/permission_item_config.dart';
 import 'package:flutter_force_permission/permission_item_text.dart';
 import 'package:flutter_force_permission/permission_service_status.dart';
 import 'package:flutter_force_permission/src/flutter_force_permission_util.dart';
-import 'package:flutter_force_permission/src/permission_service.dart';
+import 'package:flutter_force_permission/src/test_stub.dart';
 import 'package:permission_handler/permission_handler.dart';
 
 /// Disclosure page.
@@ -316,7 +316,6 @@ class _DisclosurePageState extends State<DisclosurePage>
   }
 
   Future<void> _showPhoneSettings() async {
-    // TODO(peter): find function to open phone settings directly if possible.
     await widget._service.openAppSettings();
   }
 

pubspec.yaml

@@ -21,6 +21,6 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
   flutter_lints: ^2.0.0
-  dart_code_metrics: ^5.0.1
+  dart_code_metrics: ^5.4.0
   mockito: ^5.3.2
   build_runner: ^2.3.2

test/unit_test/flutter_force_permission_test.dart

@@ -4,7 +4,7 @@ import 'package:flutter_force_permission/flutter_force_permission.dart';
 import 'package:flutter_force_permission/flutter_force_permission_config.dart';
 import 'package:flutter_force_permission/permission_item_config.dart';
 import 'package:flutter_force_permission/permission_item_text.dart';
-import 'package:flutter_force_permission/src/permission_service.dart';
+import 'package:flutter_force_permission/src/test_stub.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';

test/widget_test/disclosure_page_test.dart

@@ -7,7 +7,7 @@ import 'package:flutter_force_permission/forced_permission_dialog_config.dart';
 import 'package:flutter_force_permission/permission_item_config.dart';
 import 'package:flutter_force_permission/permission_item_text.dart';
 import 'package:flutter_force_permission/permission_service_status.dart';
-import 'package:flutter_force_permission/src/permission_service.dart';
+import 'package:flutter_force_permission/src/test_stub.dart';
 import 'package:flutter_force_permission/src/views/disclosure_page.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:mockito/annotations.dart';
@@ -23,14 +23,16 @@ void main() {
   when(prefs.getBool('Permission.location_requested')).thenReturn(false);
   when(prefs.setBool('Permission.location_requested', any))
       .thenAnswer((realInvocation) => Future.value(true));
+  when(prefs.setBool('Permission.phone_requested', any))
+      .thenAnswer((realInvocation) => Future.value(true));
 
   testWidgets('Regular permission show dialog', (tester) async {
     final testStub = MockTestStub();
     when(testStub.getSharedPreference())
         .thenAnswer((realInvocation) => Future.value(prefs));
-    when(testStub.request(Permission.location))
+    when(testStub.request(Permission.phone))
         .thenAnswer((realInvocation) => Future.value(PermissionStatus.granted));
-    when(testStub.status(Permission.location))
+    when(testStub.status(Permission.phone))
         .thenAnswer((realInvocation) => Future.value(PermissionStatus.granted));
 
     final config = FlutterForcePermissionConfig(
@@ -39,7 +41,7 @@ void main() {
       permissionItemConfigs: [
         PermissionItemConfig(
           permissions: [
-            Permission.location,
+            Permission.phone,
           ],
           itemText: PermissionItemText(
             header: 'Foreground location',
@@ -49,7 +51,7 @@ void main() {
       ],
     );
     final status = <Permission, PermissionServiceStatus>{
-      Permission.location: PermissionServiceStatus(
+      Permission.phone: PermissionServiceStatus(
         status: PermissionStatus.denied,
         requested: false,
         serviceStatus: ServiceStatus.enabled,
@@ -76,7 +78,8 @@ void main() {
     await tester.tap(find.text('Confirm'));
     await tester.pump();
 
-    verify(prefs.setBool('Permission.location_requested', true));
+    verify(testStub.request(Permission.phone));
+    verify(prefs.setBool('Permission.phone_requested', true));
 
     await resumed.close();
   });
@@ -139,6 +142,7 @@ void main() {
     await tester.tap(find.text('Confirm'));
     await tester.pump();
 
+    verify(testStub.request(Permission.location));
     verify(prefs.setBool('Permission.location_requested', true));
 
     await resumed.close();
@@ -205,6 +209,8 @@ void main() {
     await tester.tap(find.text('Confirm'));
     await tester.pump();
 
+    verify(testStub.request(Permission.location));
+
     expect(find.text('Location required'), findsOneWidget);
     expect(find.text('Location needed for proper operation'), findsOneWidget);
     expect(find.text('Settings'), findsOneWidget);
@@ -481,11 +487,7 @@ void main() {
       await tester.tap(find.text('Confirm'));
       await tester.pump();
 
-      verify(testStub.openAppSettings());
-
-      resumed.add(true);
-      await tester.pump();
-
+      verify(testStub.request(Permission.location));
       when(testStub.status(Permission.location)).thenAnswer(
         (realInvocation) => Future.value(PermissionStatus.granted),
       );