From b467e6cd50517532165daa132908e079768503d3 Mon Sep 17 00:00:00 2001 From: Nikolas Rimikis Date: Tue, 29 Aug 2023 17:13:34 +0200 Subject: [PATCH] test(neon): unit test AppStorage.formatKey Signed-off-by: Nikolas Rimikis --- .../neon/lib/src/settings/models/storage.dart | 23 ++-- packages/neon/neon/test/storage_test.dart | 113 +++++++++++++++++- 2 files changed, 126 insertions(+), 10 deletions(-) diff --git a/packages/neon/neon/lib/src/settings/models/storage.dart b/packages/neon/neon/lib/src/settings/models/storage.dart index 74a52862..ebdd58ee 100644 --- a/packages/neon/neon/lib/src/settings/models/storage.dart +++ b/packages/neon/neon/lib/src/settings/models/storage.dart @@ -44,6 +44,10 @@ final class NeonStorage { /// Make sure it has been initialized wiht [init] before. static SharedPreferences? _sharedPreferences; + @visibleForTesting + // ignore: use_setters_to_change_properties + static void mock(final SharedPreferences mock) => _sharedPreferences = mock; + /// Sets up the [SharedPreferences] instance. /// /// Required to be called before accessing [database]. @@ -104,7 +108,8 @@ final class AppStorage implements SettingsStorage { final String? suffix; - String _formatKey(final String key) { + @visibleForTesting + String formatKey(final String key) { if (suffix != null) { return '${this.key.value}-$suffix-$key'; } @@ -112,25 +117,25 @@ final class AppStorage implements SettingsStorage { return '${this.key.value}-$key'; } - bool containsKey(final String key) => NeonStorage.database.containsKey(_formatKey(key)); + bool containsKey(final String key) => NeonStorage.database.containsKey(formatKey(key)); @override - Future remove(final String key) => NeonStorage.database.remove(_formatKey(key)); + Future remove(final String key) => NeonStorage.database.remove(formatKey(key)); @override - String? getString(final String key) => NeonStorage.database.getString(_formatKey(key)); + String? getString(final String key) => NeonStorage.database.getString(formatKey(key)); @override - Future setString(final String key, final String value) => NeonStorage.database.setString(_formatKey(key), value); + Future setString(final String key, final String value) => NeonStorage.database.setString(formatKey(key), value); @override - bool? getBool(final String key) => NeonStorage.database.getBool(_formatKey(key)); + bool? getBool(final String key) => NeonStorage.database.getBool(formatKey(key)); @override - Future setBool(final String key, final bool value) => NeonStorage.database.setBool(_formatKey(key), value); + Future setBool(final String key, final bool value) => NeonStorage.database.setBool(formatKey(key), value); - List? getStringList(final String key) => NeonStorage.database.getStringList(_formatKey(key)); + List? getStringList(final String key) => NeonStorage.database.getStringList(formatKey(key)); Future setStringList(final String key, final List value) => - NeonStorage.database.setStringList(_formatKey(key), value); + NeonStorage.database.setStringList(formatKey(key), value); } diff --git a/packages/neon/neon/test/storage_test.dart b/packages/neon/neon/test/storage_test.dart index d88f8aea..022b3063 100644 --- a/packages/neon/neon/test/storage_test.dart +++ b/packages/neon/neon/test/storage_test.dart @@ -1,9 +1,12 @@ +import 'package:mocktail/mocktail.dart'; import 'package:neon/src/settings/models/storage.dart'; import 'package:shared_preferences/shared_preferences.dart'; import 'package:test/test.dart'; +class SharedPreferencesMock extends Mock implements SharedPreferences {} + void main() { - test('AppStorage', () async { + test('NeonStorage', () async { expect(() => NeonStorage.database, throwsA(isA())); SharedPreferences.setMockInitialValues({}); @@ -11,4 +14,112 @@ void main() { expect(NeonStorage.database, isA()); }); + + group('AppStorage', () { + test('formatKey', () async { + var appStorage = const AppStorage(StorageKeys.accounts); + var key = appStorage.formatKey('test-key'); + expect(key, 'accounts-test-key'); + + appStorage = const AppStorage(StorageKeys.accounts, 'test-suffix'); + key = appStorage.formatKey('test-key'); + expect(key, 'accounts-test-suffix-test-key'); + }); + + test('interface', () async { + final sharedPreferences = SharedPreferencesMock(); + NeonStorage.mock(sharedPreferences); + const appStorage = AppStorage(StorageKeys.accounts); + const key = 'key'; + final formatedKey = appStorage.formatKey(key); + + when(() => sharedPreferences.containsKey(formatedKey)).thenReturn(true); + dynamic result = appStorage.containsKey(key); + expect(result, equals(true)); + verify(() => sharedPreferences.containsKey(formatedKey)).called(1); + + when(() => sharedPreferences.remove(formatedKey)).thenAnswer((final _) => Future.value(false)); + result = await appStorage.remove(key); + expect(result, equals(false)); + verify(() => sharedPreferences.remove(formatedKey)).called(1); + + when(() => sharedPreferences.getString(formatedKey)).thenReturn(null); + result = appStorage.getString(key); + expect(result, isNull); + verify(() => sharedPreferences.getString(formatedKey)).called(1); + + when(() => sharedPreferences.setString(formatedKey, 'value')).thenAnswer((final _) => Future.value(false)); + result = await appStorage.setString(key, 'value'); + expect(result, false); + verify(() => sharedPreferences.setString(formatedKey, 'value')).called(1); + + when(() => sharedPreferences.getBool(formatedKey)).thenReturn(true); + result = appStorage.getBool(key); + expect(result, equals(true)); + verify(() => sharedPreferences.getBool(formatedKey)).called(1); + + when(() => sharedPreferences.setBool(formatedKey, true)).thenAnswer((final _) => Future.value(true)); + result = await appStorage.setBool(key, true); + expect(result, true); + verify(() => sharedPreferences.setBool(formatedKey, true)).called(1); + + when(() => sharedPreferences.getStringList(formatedKey)).thenReturn(['hi there']); + result = appStorage.getStringList(key); + expect(result, equals(['hi there'])); + verify(() => sharedPreferences.getStringList(formatedKey)).called(1); + + when(() => sharedPreferences.setStringList(formatedKey, ['hi there'])) + .thenAnswer((final _) => Future.value(false)); + result = await appStorage.setStringList(key, ['hi there']); + expect(result, false); + verify(() => sharedPreferences.setStringList(formatedKey, ['hi there'])).called(1); + }); + }); + + test('SingleValueStorage', () async { + final sharedPreferences = SharedPreferencesMock(); + NeonStorage.mock(sharedPreferences); + const storage = SingleValueStorage(StorageKeys.global); + final key = StorageKeys.global.value; + + when(() => sharedPreferences.containsKey(key)).thenReturn(true); + dynamic result = storage.hasValue(); + expect(result, equals(true)); + verify(() => sharedPreferences.containsKey(key)).called(1); + + when(() => sharedPreferences.remove(key)).thenAnswer((final _) => Future.value(false)); + result = await storage.remove(); + expect(result, equals(false)); + verify(() => sharedPreferences.remove(key)).called(1); + + when(() => sharedPreferences.getString(key)).thenReturn(null); + result = storage.getString(); + expect(result, isNull); + verify(() => sharedPreferences.getString(key)).called(1); + + when(() => sharedPreferences.setString(key, 'value')).thenAnswer((final _) => Future.value(false)); + result = await storage.setString('value'); + expect(result, false); + verify(() => sharedPreferences.setString(key, 'value')).called(1); + + when(() => sharedPreferences.getBool(key)).thenReturn(true); + result = storage.getBool(); + expect(result, equals(true)); + verify(() => sharedPreferences.getBool(key)).called(1); + + when(() => sharedPreferences.setBool(key, true)).thenAnswer((final _) => Future.value(true)); + result = await storage.setBool(true); + expect(result, true); + verify(() => sharedPreferences.setBool(key, true)).called(1); + + when(() => sharedPreferences.getStringList(key)).thenReturn(['hi there']); + result = storage.getStringList(); + expect(result, equals(['hi there'])); + verify(() => sharedPreferences.getStringList(key)).called(1); + + when(() => sharedPreferences.setStringList(key, ['hi there'])).thenAnswer((final _) => Future.value(false)); + result = await storage.setStringList(['hi there']); + expect(result, false); + verify(() => sharedPreferences.setStringList(key, ['hi there'])).called(1); + }); }