test: add more test coverage (#1075)

Author: fadi-george

.gitignore

@@ -12,8 +12,13 @@ android/.idea
 flutter_export_environment.sh
 example/ios/Flutter/ephemeral/
 
+# Coverage
+coverage/
+test/dlcov_references_test.dart
+dlcov.log
+
 # IntelliJ related
 *.iml
 *.ipr
 *.iws
-.idea/
+.idea/

lib/src/inappmessage.dart

@@ -16,8 +16,8 @@ class OSInAppMessageClickEvent extends JSONStringRepresentable {
 
   String jsonRepresentation() {
     return convertToJsonString({
-      'message': this.message,
-      'result': this.result,
+      'message': this.message.jsonRepresentation(),
+      'result': this.result.jsonRepresentation(),
     });
   }
 }

lib/src/inappmessages.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+
 import 'package:flutter/services.dart';
 import 'package:onesignal_flutter/onesignal_flutter.dart';
 import 'package:onesignal_flutter/src/inappmessage.dart';
@@ -20,7 +21,7 @@ class OneSignalInAppMessages {
 
   // constructor method
   OneSignalInAppMessages() {
-    this._channel.setMethodCallHandler(_handleMethod);
+    this._channel.setMethodCallHandler(handleMethod);
   }
 
   List<OnClickInAppMessageListener> _clickListeners =
@@ -78,7 +79,8 @@ class OneSignalInAppMessages {
   }
 
   // Private function that gets called by ObjC/Java
-  Future<Null> _handleMethod(MethodCall call) async {
+  // Exposed as public for testing purposes
+  Future<Null> handleMethod(MethodCall call) async {
     if (call.method == 'OneSignal#onClickInAppMessage') {
       for (var listener in _clickListeners) {
         listener(

pubspec.yaml

@@ -3,6 +3,9 @@ description: OneSignal is a free push notification service for mobile apps. This
 version: 5.3.4
 homepage: https://github.com/OneSignal/OneSignal-Flutter-SDK
 
+scripts:
+  test: dlcov -c 80 --lcov-gen="flutter test --coverage" --include-untested-files=true
+
 flutter:
   plugin:
     platforms:
@@ -20,7 +23,9 @@ dev_dependencies:
   test: ^1.5.1
   flutter_test:
     sdk: flutter
+  dlcov: ^4.2.1
+  rps: ^0.9.1
 
 environment:
-  sdk: '>=2.12.0 <3.0.0'
-  flutter: '>=1.10.0'
+  sdk: ">=2.12.0 <3.0.0"
+  flutter: ">=1.10.0"

test/debug_test.dart

@@ -0,0 +1,37 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:onesignal_flutter/onesignal_flutter.dart';
+
+import 'mock_channel.dart';
+
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  OneSignalMockChannelController channelController =
+      OneSignalMockChannelController();
+
+  setUp(() {
+    channelController.resetState();
+  });
+
+  group('OneSignalDebug', () {
+    group('setLogLevel', () {
+      for (final logLevel in OSLogLevel.values) {
+        test('sets log level to ${logLevel.toString().split('.').last}',
+            () async {
+          await OneSignal.Debug.setLogLevel(logLevel);
+          expect(channelController.state.logLevel, logLevel);
+        });
+      }
+    });
+
+    group('setAlertLevel', () {
+      for (final logLevel in OSLogLevel.values) {
+        test('sets alert level to ${logLevel.toString().split('.').last}',
+            () async {
+          await OneSignal.Debug.setAlertLevel(logLevel);
+          expect(channelController.state.visualLevel, logLevel);
+        });
+      }
+    });
+  });
+}

test/inappmessage_test.dart

@@ -0,0 +1,178 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:onesignal_flutter/src/inappmessage.dart';
+import 'package:onesignal_flutter/src/utils.dart';
+
+const validMessageJson = {
+  'message_id': 'test-message-id-123',
+};
+
+const validClickResultJson = {
+  'action_id': 'action-123',
+  'url': 'https://example.com',
+  'closing_message': true,
+};
+
+void _testMessageEvent<T extends JSONStringRepresentable>(
+  String eventName,
+  T Function(Map<String, dynamic>) constructor,
+) {
+  group(eventName, () {
+    test('creates from valid JSON with message', () {
+      final json = {'message': validMessageJson};
+      final event = constructor(json);
+      expect(event, isNotNull);
+    });
+
+    test('creates from JSON with null message_id', () {
+      final json = {'message': <String, dynamic>{}};
+      final event = constructor(json);
+      expect(event, isNotNull);
+    });
+
+    test('jsonRepresentation returns correct JSON string', () {
+      final json = {'message': validMessageJson};
+      final event = constructor(json);
+      final jsonString = event.jsonRepresentation();
+      expect(jsonString, contains('"message"'));
+    });
+  });
+}
+
+void main() {
+  group('OSInAppMessage', () {
+    test('creates from valid JSON with message_id', () {
+      final message = OSInAppMessage(validMessageJson);
+
+      expect(message.messageId, validMessageJson['message_id']);
+    });
+
+    test('creates from JSON with null message_id', () {
+      final json = <String, dynamic>{};
+      final message = OSInAppMessage(json);
+
+      expect(message.messageId, isNull);
+    });
+
+    test('jsonRepresentation returns correct JSON string', () {
+      // Test with valid message_id
+      final message1 = OSInAppMessage(validMessageJson);
+      final jsonString1 = message1.jsonRepresentation();
+      expect(jsonString1, contains('"message_id": "test-message-id-123"'));
+
+      // Test with null message_id
+      final json = <String, dynamic>{};
+      final message2 = OSInAppMessage(json);
+      final jsonString2 = message2.jsonRepresentation();
+      expect(jsonString2, contains('"message_id"'));
+      expect(jsonString2, contains('null'));
+    });
+  });
+
+  group('OSInAppMessageClickResult', () {
+    test('creates from valid JSON with all fields', () {
+      final result = OSInAppMessageClickResult(validClickResultJson);
+
+      expect(result.actionId, 'action-123');
+      expect(result.url, 'https://example.com');
+      expect(result.closingMessage, true);
+    });
+
+    test('creates from minimal JSON', () {
+      final json = <String, dynamic>{
+        'closing_message': false,
+      };
+      final result = OSInAppMessageClickResult(json);
+
+      expect(result.actionId, isNull);
+      expect(result.url, isNull);
+      expect(result.closingMessage, false);
+    });
+
+    test('jsonRepresentation returns correct JSON string', () {
+      final result = OSInAppMessageClickResult(validClickResultJson);
+      final jsonString = result.jsonRepresentation();
+
+      expect(jsonString, contains('"action_id": "action-123"'));
+      expect(jsonString, contains('"url": "https://example.com"'));
+      expect(jsonString, contains('"closing_message": true'));
+    });
+
+    test('jsonRepresentation handles null optional fields', () {
+      final json = <String, dynamic>{
+        'closing_message': false,
+      };
+      final result = OSInAppMessageClickResult(json);
+      final jsonString = result.jsonRepresentation();
+
+      expect(jsonString, contains('"action_id": null'));
+      expect(jsonString, contains('"url": null'));
+      expect(jsonString, contains('"closing_message": false'));
+    });
+  });
+
+  group('OSInAppMessageClickEvent', () {
+    test('creates from valid JSON with message and result', () {
+      final json = {
+        'message': validMessageJson,
+        'result': validClickResultJson,
+        'closing_message': false,
+      };
+      final event = OSInAppMessageClickEvent(json);
+
+      expect(event.message.messageId, 'test-message-id-123');
+      expect(event.result.actionId, 'action-123');
+      expect(event.result.url, 'https://example.com');
+      expect(event.result.closingMessage, true);
+    });
+
+    test('creates from JSON with minimal fields', () {
+      final json = {
+        'message': validMessageJson,
+        'result': {
+          'closing_message': false,
+        },
+      };
+      final event = OSInAppMessageClickEvent(json);
+
+      expect(event.message.messageId, 'test-message-id-123');
+      expect(event.result.actionId, isNull);
+      expect(event.result.url, isNull);
+      expect(event.result.closingMessage, false);
+    });
+
+    test('jsonRepresentation returns correct JSON string', () {
+      final json = {
+        'message': {
+          'message_id': 'test-message-id-123',
+        },
+        'result': {
+          'action_id': 'action-123',
+          'url': 'https://example.com',
+          'closing_message': true,
+        },
+      };
+      final event = OSInAppMessageClickEvent(json);
+      final jsonString = event.jsonRepresentation();
+
+      expect(jsonString, contains('"message"'));
+      expect(jsonString, contains('"result"'));
+    });
+  });
+
+  _testMessageEvent(
+    'OSInAppMessageWillDisplayEvent',
+    (json) => OSInAppMessageWillDisplayEvent(json),
+  );
+  _testMessageEvent(
+    'OSInAppMessageDidDisplayEvent',
+    (json) => OSInAppMessageDidDisplayEvent(json),
+  );
+  _testMessageEvent(
+    'OSInAppMessageWillDismissEvent',
+    (json) => OSInAppMessageWillDismissEvent(json),
+  );
+  _testMessageEvent(
+    'OSInAppMessageDidDismissEvent',
+    (json) => OSInAppMessageDidDismissEvent(json),
+  );
+}