diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index effe15df..4e4a31b3 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -202,6 +202,111 @@ jobs: working-directory: flutter_secure_storage_web run: flutter test --platform chrome + unit_tests_windows: + name: Windows Unit Tests + needs: formatting + runs-on: windows-latest + timeout-minutes: 30 + + steps: + - name: Checkout Repository + uses: actions/checkout@v6 + + - name: Set Up Flutter + uses: subosito/flutter-action@v2 + with: + channel: stable + cache: true + + - name: Install Dependencies + working-directory: flutter_secure_storage_windows + run: flutter pub get + + - name: Run Windows Unit Tests with Coverage + working-directory: flutter_secure_storage_windows + run: flutter test --coverage + + - name: Upload Windows Coverage to Codecov + uses: codecov/codecov-action@v6 + with: + token: ${{ secrets.CODECOV_TOKEN }} + files: flutter_secure_storage_windows/coverage/lcov.info + flags: windows + name: codecov-windows + fail_ci_if_error: true + + native_tests_windows: + name: Windows Native Tests + needs: formatting + runs-on: windows-latest + timeout-minutes: 30 + + steps: + - name: Checkout Repository + uses: actions/checkout@v6 + + - name: Set Up Flutter + uses: subosito/flutter-action@v2 + with: + channel: stable + cache: true + + - name: Install Dependencies + working-directory: flutter_secure_storage/example + run: flutter pub get + + - name: Build Windows Example (generates CMake project) + working-directory: flutter_secure_storage/example + run: flutter build windows --debug + + - name: Reconfigure CMake with BUILD_TESTING + working-directory: flutter_secure_storage/example + shell: pwsh + run: | + cmake -DBUILD_TESTING=ON ` + -S windows ` + -B build/windows/x64 + + - name: Build Native Test Binary + working-directory: flutter_secure_storage/example + shell: pwsh + run: | + cmake --build build/windows/x64 ` + --target flutter_secure_storage_windows_test ` + --config Debug + + - name: Run Native Windows Tests + working-directory: flutter_secure_storage/example + shell: pwsh + run: | + ctest --test-dir build/windows/x64/plugins/flutter_secure_storage_windows ` + --output-on-failure ` + -C Debug + + integration_tests_windows: + name: Windows Integration Tests + needs: [unit_tests, unit_tests_windows] + runs-on: windows-latest + timeout-minutes: 20 + + steps: + - name: Checkout Repository + uses: actions/checkout@v6 + + - name: Set Up Flutter + uses: subosito/flutter-action@v2 + with: + channel: stable + cache: true + + - name: Install Dependencies + working-directory: flutter_secure_storage/example + run: flutter pub get + + - name: Run Windows Integration Tests + working-directory: flutter_secure_storage/example + run: flutter test integration_test/windows_test.dart -d windows + integration_tests_android: name: Android Tests needs: [unit_tests, unit_tests_android] diff --git a/flutter_secure_storage/example/integration_test/windows_test.dart b/flutter_secure_storage/example/integration_test/windows_test.dart new file mode 100644 index 00000000..b7cd291d --- /dev/null +++ b/flutter_secure_storage/example/integration_test/windows_test.dart @@ -0,0 +1,541 @@ +import 'dart:io'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_secure_storage/flutter_secure_storage.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:integration_test/integration_test.dart'; + +/// Windows-specific integration tests, ported from the Windows example app. +/// +/// Covers: +/// - Basic CRUD +/// - Backward-compatibility migration (new DPAPI storage + legacy Credential +/// Store coexistence) +/// - Special-character keys and values +/// +/// Run with: +/// flutter test integration_test/windows_test.dart -d windows + +// --------------------------------------------------------------------------- +// Legacy Credential Store helpers +// --------------------------------------------------------------------------- +// The C++ plugin still registers itself on the +// "plugins.it_nomads.com/flutter_secure_storage" channel and handles the +// Windows Credential Store. Calling it directly lets us seed legacy data +// without going through the new FFI layer. + +const _legacyChannel = + MethodChannel('plugins.it_nomads.com/flutter_secure_storage'); + +Future _legacyWrite(String key, String value) => + _legacyChannel.invokeMethod('write', { + 'key': key, + 'value': value, + 'options': {}, + }); + +Future> _legacyReadAll() async { + final raw = await _legacyChannel.invokeMethod>( + 'readAll', + {'options': {}}, + ); + return raw?.cast() ?? {}; +} + +Future _legacyDeleteAll() => + _legacyChannel.invokeMethod('deleteAll', { + 'options': {}, + }); + +// --------------------------------------------------------------------------- +// Shared storage instances +// --------------------------------------------------------------------------- + +const _storage = FlutterSecureStorage( + wOptions: WindowsOptions(useBackwardCompatibility: true), +); + +const _storageNoCompat = FlutterSecureStorage(); + +// --------------------------------------------------------------------------- +// Helpers +// --------------------------------------------------------------------------- + +/// Verifies that the legacy Credential Store is empty, confirming that +/// migration has completed. +Future _checkMigration() async { + final legacy = await _legacyReadAll(); + expect( + legacy, + isEmpty, + reason: 'Legacy Credential Store should be empty after migration', + ); +} + +/// Runs a complete CRUD cycle (write → read → containsKey → readAll → delete +/// → deleteAll) against `storage`, using [key1] and optionally [key2]. +Future _doTestSuite({ + required String key1, + String? key2, + String value1 = 'value-for-key1', + String? value2, + bool useBackwardCompatibility = true, +}) async { + final s = useBackwardCompatibility ? _storage : _storageNoCompat; + final v2 = value2 ?? (key2 != null ? 'value-for-key2' : null); + + // Write + await s.write(key: key1, value: value1); + if (key2 != null) await s.write(key: key2, value: v2); + + // Read + expect(await s.read(key: key1), value1); + if (key2 != null) expect(await s.read(key: key2), v2); + + // ContainsKey + expect(await s.containsKey(key: key1), isTrue); + if (key2 != null) expect(await s.containsKey(key: key2), isTrue); + + // ReadAll + final all = await s.readAll(); + expect(all, containsPair(key1, value1)); + if (key2 != null) expect(all, containsPair(key2, v2)); + + // Delete key1 + await s.delete(key: key1); + expect(await s.read(key: key1), isNull); + expect(await s.containsKey(key: key1), isFalse); + + final afterDelete = await s.readAll(); + expect(afterDelete, isNot(contains(key1))); + if (key2 != null) expect(afterDelete, containsPair(key2, v2)); + + // Re-write key1 so deleteAll has something to clear when there is no key2. + if (key2 == null) await s.write(key: key1, value: value1); + + // DeleteAll + await s.deleteAll(); + expect(await s.read(key: key2 ?? key1), isNull); + expect(await s.containsKey(key: key2 ?? key1), isFalse); + expect(await s.readAll(), isEmpty); +} + +// --------------------------------------------------------------------------- +// Test entry point +// --------------------------------------------------------------------------- + +void main() { + IntegrationTestWidgetsFlutterBinding.ensureInitialized(); + + setUp(() async { + await _storage.deleteAll(); // cleans DPAPI store + // (and legacy when compat=true) + await _legacyDeleteAll(); // belt-and-suspenders: clean Credential Store + }); + + tearDown(() async { + await _storage.deleteAll(); + await _legacyDeleteAll(); + }); + + // ------------------------------------------------------------------------- + // Basic test + // ------------------------------------------------------------------------- + + group( + 'Basic test', + () { + testWidgets('Smoke test', (_) async { + await _doTestSuite(key1: 'key1', key2: 'key2'); + }); + }, + skip: kIsWeb || !Platform.isWindows ? 'Windows only' : null, + ); + + // ------------------------------------------------------------------------- + // Backward compatibility cases + // ------------------------------------------------------------------------- + + group( + 'Backwards compatibility cases', + () { + // readAll --------------------------------------------------------------- + + testWidgets('readAll - empty, empty', (_) async { + final all = await _storage.readAll(); + expect(all, isEmpty); + await _checkMigration(); + }); + + testWidgets('readAll - 1 entry (new), 1 entry (legacy), different keys', + (_) async { + const key1 = 'key1'; + const key2 = 'key2'; + const v1 = 'dpapi-v1'; + const v2 = 'legacy-v2'; + + await _storage.write(key: key1, value: v1); + await _legacyWrite(key2, v2); + + final all = await _storage.readAll(); + expect(all, containsPair(key1, v1)); + expect(all, containsPair(key2, v2)); + await _checkMigration(); + }); + + testWidgets('readAll - 1 entry (new), 1 entry (legacy), same key', + (_) async { + const key = 'key'; + const dpapiValue = 'dpapi-value'; + const legacyValue = 'legacy-value'; + + await _storage.write(key: key, value: dpapiValue); + await _legacyWrite(key, legacyValue); + + // DPAPI takes precedence when both stores have the same key. + final all = await _storage.readAll(); + expect(all, containsPair(key, dpapiValue)); + expect(all.length, 1); + await _checkMigration(); + }); + + testWidgets('readAll - empty (new), 1 entry (legacy)', (_) async { + const key = 'key'; + const v = 'legacy-value'; + + await _legacyWrite(key, v); + + final all = await _storage.readAll(); + expect(all, containsPair(key, v)); + await _checkMigration(); + }); + + testWidgets('readAll - 1 entry (new), empty (legacy)', (_) async { + const key = 'key'; + const v = 'dpapi-value'; + + await _storage.write(key: key, value: v); + + final all = await _storage.readAll(); + expect(all, containsPair(key, v)); + await _checkMigration(); + }); + + testWidgets( + 'readAll - 2 entries (new), 2 entries (legacy), overlapping keys', + (_) async { + const key1 = 'key1'; + const key2 = 'key2'; + const key3 = 'key3'; + const dpapiV1 = 'dpapi-v1'; + const dpapiV2 = 'dpapi-v2'; + const legacyV3 = 'legacy-v3'; + const legacyV1 = 'legacy-v1-different'; // same key as key1 + + await _storage.write(key: key1, value: dpapiV1); + await _storage.write(key: key2, value: dpapiV2); + await _legacyWrite(key3, legacyV3); + await _legacyWrite(key1, legacyV1); // DPAPI should win + + final all = await _storage.readAll(); + // DPAPI value wins for key1 + expect(all, containsPair(key1, dpapiV1)); + expect(all, containsPair(key2, dpapiV2)); + expect(all, containsPair(key3, legacyV3)); + expect(all.length, 3); + await _checkMigration(); + }); + + // read ------------------------------------------------------------------ + + testWidgets('read - exists in new, exists in legacy (same key)', + (_) async { + const key = 'key'; + const dpapiValue = 'dpapi-value'; + + await _storage.write(key: key, value: dpapiValue); + await _legacyWrite(key, 'legacy-value'); + + // DPAPI takes precedence. + expect(await _storage.read(key: key), dpapiValue); + await _checkMigration(); + }); + + testWidgets('read - not in new, exists in legacy', (_) async { + const key = 'key'; + const v = 'legacy-value'; + + await _legacyWrite(key, v); + + expect(await _storage.read(key: key), v); + await _checkMigration(); + }); + + testWidgets('read - exists in new, not in legacy', (_) async { + const key = 'key'; + const v = 'dpapi-value'; + + await _storage.write(key: key, value: v); + + expect(await _storage.read(key: key), v); + await _checkMigration(); + }); + + testWidgets('read - not in new, not in legacy', (_) async { + expect(await _storage.read(key: 'key'), isNull); + await _checkMigration(); + }); + + // containsKey ----------------------------------------------------------- + // Note: containsKey does NOT trigger auto-migration. + + testWidgets('containsKey - exists in new, exists in legacy', (_) async { + const key = 'key'; + + await _storage.write(key: key, value: 'dpapi-value'); + await _legacyWrite(key, 'legacy-value'); + + expect(await _storage.containsKey(key: key), isTrue); + // No migration expected — containsKey does not migrate. + }); + + testWidgets('containsKey - not in new, exists in legacy', (_) async { + const key = 'key'; + + await _legacyWrite(key, 'legacy-value'); + + expect(await _storage.containsKey(key: key), isTrue); + // No migration expected. + }); + + testWidgets('containsKey - exists in new, not in legacy', (_) async { + const key = 'key'; + + await _storage.write(key: key, value: 'dpapi-value'); + + expect(await _storage.containsKey(key: key), isTrue); + }); + + testWidgets('containsKey - not in new, not in legacy', (_) async { + expect(await _storage.containsKey(key: 'key'), isFalse); + }); + + // write ----------------------------------------------------------------- + + testWidgets('write - new key', (_) async { + const key = 'key'; + const v = 'written-value'; + + await _storage.write(key: key, value: v); + await _checkMigration(); + + expect(await _storage.read(key: key), v); + }); + + testWidgets('write - overwrite existing key', (_) async { + const key = 'key'; + + await _storage.write(key: key, value: 'first'); + await _checkMigration(); + + await _storage.write(key: key, value: 'second'); + await _checkMigration(); + + expect(await _storage.read(key: key), 'second'); + }); + + testWidgets('write - legacy value exists for same key', (_) async { + const key = 'key'; + const legacyValue = 'legacy-value'; + const newValue = 'new-dpapi-value'; + + await _legacyWrite(key, legacyValue); + + await _storage.write(key: key, value: newValue); + await _checkMigration(); + + expect(await _storage.read(key: key), newValue); + }); + + // delete ---------------------------------------------------------------- + + testWidgets('delete - exists in new, exists in legacy', (_) async { + const key = 'key'; + + await _storage.write(key: key, value: 'dpapi-value'); + await _legacyWrite(key, 'legacy-value'); + + await _storage.delete(key: key); + await _checkMigration(); + + expect(await _storage.containsKey(key: key), isFalse); + }); + + testWidgets('delete - exists in new, not in legacy', (_) async { + const key = 'key'; + + await _storage.write(key: key, value: 'dpapi-value'); + + await _storage.delete(key: key); + await _checkMigration(); + + expect(await _storage.containsKey(key: key), isFalse); + }); + + testWidgets('delete - not in new, exists in legacy', (_) async { + const key = 'key'; + + await _legacyWrite(key, 'legacy-value'); + + await _storage.delete(key: key); + await _checkMigration(); + + expect(await _storage.containsKey(key: key), isFalse); + }); + + testWidgets('delete - not in new, not in legacy', (_) async { + await _storage.delete(key: 'key'); + await _checkMigration(); + + expect(await _storage.containsKey(key: 'key'), isFalse); + }); + + // deleteAll ------------------------------------------------------------- + + testWidgets('deleteAll - empty, empty', (_) async { + await _storage.deleteAll(); + await _checkMigration(); + + expect(await _storage.readAll(), isEmpty); + }); + + testWidgets('deleteAll - 1 entry (new), 1 entry (legacy), different keys', + (_) async { + await _storage.write(key: 'key1', value: 'dpapi-v1'); + await _legacyWrite('key2', 'legacy-v2'); + + await _storage.deleteAll(); + await _checkMigration(); + + expect(await _storage.readAll(), isEmpty); + }); + + testWidgets('deleteAll - 1 entry (new), 1 entry (legacy), same key', + (_) async { + const key = 'key'; + + await _storage.write(key: key, value: 'dpapi-value'); + await _legacyWrite(key, 'legacy-value'); + + await _storage.deleteAll(); + await _checkMigration(); + + expect(await _storage.readAll(), isEmpty); + }); + + testWidgets('deleteAll - empty (new), 1 entry (legacy)', (_) async { + await _legacyWrite('key', 'legacy-value'); + + await _storage.deleteAll(); + await _checkMigration(); + + expect(await _storage.readAll(), isEmpty); + }); + + testWidgets('deleteAll - 1 entry (new), empty (legacy)', (_) async { + await _storage.write(key: 'key', value: 'dpapi-value'); + + await _storage.deleteAll(); + await _checkMigration(); + + expect(await _storage.readAll(), isEmpty); + }); + + testWidgets( + 'deleteAll - 2 entries (new), 2 entries (legacy), overlapping keys', + (_) async { + await _storage.write(key: 'key1', value: 'dpapi-v1'); + await _storage.write(key: 'key2', value: 'dpapi-v2'); + await _legacyWrite('key3', 'legacy-v3'); + await _legacyWrite('key1', 'legacy-v1-different'); + + await _storage.deleteAll(); + await _checkMigration(); + + expect(await _storage.readAll(), isEmpty); + }); + }, + skip: kIsWeb || !Platform.isWindows ? 'Windows only' : null, + ); + + // ------------------------------------------------------------------------- + // Special character handling + // ------------------------------------------------------------------------- + + group( + 'Special characters handling', + () { + testWidgets('URL key', (_) async { + await _doTestSuite( + key1: 'http://example.com', + useBackwardCompatibility: false, + ); + }); + + testWidgets('Double dot key', (_) async { + await _doTestSuite(key1: '/../a'); + }); + + testWidgets('Long key (256 chars)', (_) async { + await _doTestSuite( + key1: String.fromCharCodes(Iterable.generate(256, (_) => 65)), + useBackwardCompatibility: false, + ); + }); + + testWidgets('Empty key and value', (_) async { + await _doTestSuite(key1: '', value1: ''); + }); + + for (final entry in { + 'ASCII space (U+0020)': 0x20, + 'Non-breaking space (U+00A0)': 0xA0, + 'Full-width space (U+3000)': 0x3000, + }.entries) { + testWidgets('Space key and value - ${entry.key}', (_) async { + await _doTestSuite( + key1: String.fromCharCode(entry.value), + value1: String.fromCharCode(entry.value), + ); + }); + } + + testWidgets('Horizontal tab key and value (U+0009)', (_) async { + await _doTestSuite( + key1: String.fromCharCode(0x09), + value1: String.fromCharCode(0x09), + useBackwardCompatibility: false, + ); + }); + + for (final entry in { + 'Latin-1 / French': 'cl\u00E9', + 'CJK / Japanese': '\u30AD\u30FC', + 'Surrogate pair / Emoji': '\uD83D\uDD11', + }.entries) { + testWidgets('Non-ASCII key and value - ${entry.key}', (_) async { + await _doTestSuite( + key1: entry.value, + value1: entry.value, + ); + }); + } + + testWidgets('Case-sensitive keys (key vs KEY)', (_) async { + await _doTestSuite(key1: 'key', key2: 'KEY'); + }); + }, + skip: kIsWeb || !Platform.isWindows ? 'Windows only' : null, + ); +} diff --git a/flutter_secure_storage_windows/.metadata b/flutter_secure_storage_windows/.metadata index fd19ae02..7847a320 100644 --- a/flutter_secure_storage_windows/.metadata +++ b/flutter_secure_storage_windows/.metadata @@ -1,11 +1,11 @@ # This file tracks properties of this Flutter project. # Used by Flutter tool to assess capabilities and perform upgrades etc. # -# This file should be version controlled. +# This file should be version controlled and should not be manually edited. version: - revision: 2ad6cd72c040113b47ee9055e722606a490ef0da - channel: stable + revision: "db50e20168db8fee486b9abf32fc912de3bc5b6a" + channel: "stable" project_type: plugin @@ -13,11 +13,11 @@ project_type: plugin migration: platforms: - platform: root - create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da - base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a - platform: windows - create_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da - base_revision: 2ad6cd72c040113b47ee9055e722606a490ef0da + create_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a + base_revision: db50e20168db8fee486b9abf32fc912de3bc5b6a # User provided section diff --git a/flutter_secure_storage_windows/example/.gitignore b/flutter_secure_storage_windows/example/.gitignore deleted file mode 100644 index 24476c5d..00000000 --- a/flutter_secure_storage_windows/example/.gitignore +++ /dev/null @@ -1,44 +0,0 @@ -# Miscellaneous -*.class -*.log -*.pyc -*.swp -.DS_Store -.atom/ -.buildlog/ -.history -.svn/ -migrate_working_dir/ - -# IntelliJ related -*.iml -*.ipr -*.iws -.idea/ - -# The .vscode folder contains launch configuration and tasks you configure in -# VS Code which you may wish to be included in version control, so this line -# is commented out by default. -#.vscode/ - -# Flutter/Dart/Pub related -**/doc/api/ -**/ios/Flutter/.last_build_id -.dart_tool/ -.flutter-plugins -.flutter-plugins-dependencies -.packages -.pub-cache/ -.pub/ -/build/ - -# Symbolication related -app.*.symbols - -# Obfuscation related -app.*.map.json - -# Android Studio will place build artifacts here -/android/app/debug -/android/app/profile -/android/app/release diff --git a/flutter_secure_storage_windows/example/README.md b/flutter_secure_storage_windows/example/README.md deleted file mode 100644 index b37f4c62..00000000 --- a/flutter_secure_storage_windows/example/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# flutter_secure_storage_windows_example - -Demonstrates how to use the flutter_secure_storage_windows plugin. - -## Getting Started - -This project is a starting point for a Flutter application. - -A few resources to get you started if this is your first Flutter project: - -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) - -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. diff --git a/flutter_secure_storage_windows/example/analysis_options.yaml b/flutter_secure_storage_windows/example/analysis_options.yaml deleted file mode 100644 index 61b6c4de..00000000 --- a/flutter_secure_storage_windows/example/analysis_options.yaml +++ /dev/null @@ -1,29 +0,0 @@ -# This file configures the analyzer, which statically analyzes Dart code to -# check for errors, warnings, and lints. -# -# The issues identified by the analyzer are surfaced in the UI of Dart-enabled -# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be -# invoked from the command line by running `flutter analyze`. - -# The following line activates a set of recommended lints for Flutter apps, -# packages, and plugins designed to encourage good coding practices. -include: package:flutter_lints/flutter.yaml - -linter: - # The lint rules applied to this project can be customized in the - # section below to disable rules from the `package:flutter_lints/flutter.yaml` - # included above or to enable additional rules. A list of all available lints - # and their documentation is published at - # https://dart-lang.github.io/linter/lints/index.html. - # - # Instead of disabling a lint rule for the entire project in the - # section below, it can also be suppressed for a single line of code - # or a specific dart file by using the `// ignore: name_of_lint` and - # `// ignore_for_file: name_of_lint` syntax on the line or in the file - # producing the lint. - rules: - # avoid_print: false # Uncomment to disable the `avoid_print` rule - # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule - -# Additional information about this file can be found at -# https://dart.dev/guides/language/analysis-options diff --git a/flutter_secure_storage_windows/example/integration_test/app_test.dart b/flutter_secure_storage_windows/example/integration_test/app_test.dart deleted file mode 100644 index 6e961389..00000000 --- a/flutter_secure_storage_windows/example/integration_test/app_test.dart +++ /dev/null @@ -1,1117 +0,0 @@ -import 'dart:io'; - -import 'package:flutter/foundation.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:integration_test/integration_test.dart'; - -import 'package:flutter_secure_storage_windows_example/main.dart' as app; -import 'package:path/path.dart' as path; -import 'package:path_provider/path_provider.dart'; - -// For legacy behavior investigation, change bellow line. -// Note that "Special charactors handling" cases can cause app crash -// or file creation outside of app support directory. - -const useMethodChannelOnly = false; - -void main() { - IntegrationTestWidgetsFlutterBinding.ensureInitialized(); - - Future cleanUpFiles() async { - // Clean up current & legacy files. - final directory = await getApplicationSupportDirectory(); - if (directory.existsSync()) { - directory - .listSync(recursive: false, followLinks: false) - .whereType() - .where((f) => - path.basename(f.path) == 'flutter_secure_storage.dat' || - f.path.endsWith('.secure')) - .forEach((f) => f.deleteSync()); - } - - // Check parent directory, too. - if (directory.parent.existsSync()) { - directory.parent - .listSync(recursive: false, followLinks: false) - .whereType() - .where((f) => f.path.endsWith('.secure')) - .forEach((f) => f.deleteSync()); - } - } - - setUpAll(() async { - await cleanUpFiles(); - }); - - tearDown(() async { - await cleanUpFiles(); - }); - - app.MyAppState getState( - WidgetTester tester, { - required bool useBackwardCompatibility, - }) { - final state = tester.state(find.byType(app.MyApp)); - - state.useBackwardCompatibilityKey.currentState!.value = - useBackwardCompatibility; - state.useMethodChannelOnlyKey.currentState!.value = useMethodChannelOnly; - - return state; - } - - Future checkSuccess( - WidgetTester tester, - app.MyAppState state, { - String? expectedDetail, - }) async { - printOnFailure('checkSuccess'); - await tester.pumpAndSettle(); - - expect( - state.resultSummaryFieldController.text, - 'SUCCESS', - reason: 'Failed: ${state.resultDetailFieldController}', - ); - - if (expectedDetail != null) { - expect(state.resultDetailFieldController.text, expectedDetail); - } - - return state.resultDetailFieldController.text; - } - - Future doTestSuite( - WidgetTester tester, { - required String key1, - String? key2, - String? writingValue1, - String? writingValue2, - bool useBackwardCompatibility = true, - }) async { - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: useBackwardCompatibility, - ); - - // write 1 - state.keyFieldController.text = key1; - state.valueFieldController.text = writingValue1 ?? ''; - - await tester.tap(find.text('Write')); - final value1 = await checkSuccess(tester, state); - - late final String value2; - if (key2 != null) { - // write 2 - state.keyFieldController.text = key2; - state.valueFieldController.text = writingValue2 ?? ''; - await tester.tap(find.text('Write')); - value2 = await checkSuccess(tester, state); - } - - state.valueFieldController.text = ''; - - // read for write 1 - state.keyFieldController.text = key1; - await tester.tap(find.text('Read')); - await checkSuccess(tester, state, expectedDetail: value1); - - if (key2 != null) { - // read for write 2 - state.keyFieldController.text = key2; - await tester.tap(find.text('Read')); - await checkSuccess(tester, state, expectedDetail: value2); - } - - // containsKey for write 1 - state.keyFieldController.text = key1; - await tester.tap(find.text('ContainsKey')); - await checkSuccess(tester, state, expectedDetail: 'true'); - - if (key2 != null) { - // containsKey for write 2 - state.keyFieldController.text = key2; - await tester.tap(find.text('ContainsKey')); - await checkSuccess(tester, state, expectedDetail: 'true'); - } - - // readAll - await tester.tap(find.text('ReadAll')); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: - (key2 != null ? {key1: value1, key2: value2} : {key1: value1}) - .toString(), - ); - - // delete for write 1 - state.keyFieldController.text = key1; - await tester.tap(find.text('Delete')); - await checkSuccess(tester, state); - - // read for delete - await tester.tap(find.text('Read')); - await checkSuccess(tester, state, expectedDetail: ''); - - // containsKey for delete - await tester.tap(find.text('ContainsKey')); - await checkSuccess(tester, state, expectedDetail: 'false'); - - // readAll for delete - await tester.tap(find.text('ReadAll')); - await checkSuccess( - tester, state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: (key2 == null ? {} : {key2: value2}).toString(), - ); - - if (key2 == null) { - // re-write for deleteAll - state.keyFieldController.text = key1; - state.valueFieldController.text = writingValue1 ?? ''; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - // clear - state.valueFieldController.text = ''; - } - - // deleteAll - await tester.tap(find.text('DeleteAll')); - await checkSuccess(tester, state); - - // read for delete 2 - state.keyFieldController.text = key2 ?? key1; - await tester.tap(find.text('Read')); - await checkSuccess(tester, state, expectedDetail: ''); - - // containsKey for delete 2 - await tester.tap(find.text('ContainsKey')); - await checkSuccess(tester, state, expectedDetail: 'false'); - - // readAll for delete - await tester.tap(find.text('ReadAll')); - await checkSuccess( - tester, state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - } - - group( - 'Basic test', - () { - testWidgets('Smoke test', (tester) async { - await doTestSuite(tester, key1: 'key1', key2: 'key2'); - }); - }, - skip: kIsWeb || !Platform.isWindows - ? 'These tests only work on Windows' - : null, - ); - - group( - 'Backwards compatibilty cases', - () { - Future checkMigration( - WidgetTester tester, - app.MyAppState state, - ) async { - printOnFailure('checkMigration'); - await tester.tap(find.text('LegacyReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - } - - testWidgets('readAll - empty, empty', (tester) async { - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - await checkMigration(tester, state); - }); - - testWidgets('readAll - 1 entry, 1 entry, different keys', (tester) async { - const key1 = 'key1'; - const key2 = 'key2'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key1; - await tester.tap(find.text('Write')); - final value1 = await checkSuccess(tester, state); - - state.keyFieldController.text = key2; - await tester.tap(find.text('LegacyWrite')); - final value2 = await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {key1: value1, key2: value2}.toString(), - ); - await checkMigration(tester, state); - }); - - testWidgets('readAll - 1 entry, 1 entry, same keys', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - final value = await checkSuccess(tester, state); - - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {key: value}.toString(), - ); - await checkMigration(tester, state); - }); - - testWidgets('readAll - empty, 1entry', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('LegacyWrite')); - final value = await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {key: value}.toString(), - ); - await checkMigration(tester, state); - }); - - testWidgets('readAll - 1entry, empty', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - final value = await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {key: value}.toString(), - ); - await checkMigration(tester, state); - }); - - testWidgets('readAll - 2 entries, 2 entries, same keys and diffrent keys', - (tester) async { - const key1 = 'key1'; - const key2 = 'key2'; - const key3 = 'key3'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key1; - await tester.tap(find.text('Write')); - final value1 = await checkSuccess(tester, state); - - state.keyFieldController.text = key2; - await tester.tap(find.text('Write')); - final value2 = await checkSuccess(tester, state); - - state.keyFieldController.text = key3; - await tester.tap(find.text('LegacyWrite')); - final value3 = await checkSuccess(tester, state); - - state.keyFieldController.text = key1; - await tester.tap(find.text('LegacyWrite')); - final value4 = await checkSuccess(tester, state); - - assert(value1 != value4); - - // Do test - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {key1: value1, key2: value2, key3: value3}.toString(), - ); - await checkMigration(tester, state); - }); - - testWidgets('read - exists, exists', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - final value = await checkSuccess(tester, state); - - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('Read')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: value); - await checkMigration(tester, state); - }); - - testWidgets('read - does not exist, exists', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('LegacyWrite')); - final value = await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('Read')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: value); - await checkMigration(tester, state); - }); - - testWidgets('read - exists, does not exist', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - final value = await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('Read')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: value); - await checkMigration(tester, state); - }); - - testWidgets('read - does not exist, does not exist', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Do test - state.keyFieldController.text = key; - await tester.tap(find.text('Read')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: ''); - await checkMigration(tester, state); - }); - - testWidgets('containsKey - exists, exists', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'true'); - // containsKey does not execute auto-migration - }); - - testWidgets('containsKey - does not exist, exists', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'true'); - // containsKey does not execute auto-migration - }); - - testWidgets('containsKey - exists, does not exist', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'true'); - // containsKey does not execute auto-migration - }); - - testWidgets('containsKey - does not exist, does not exist', - (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Do test - state.keyFieldController.text = key; - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'false'); - // containsKey does not execute auto-migration - }); - - testWidgets('write - new', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Do test - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await tester.pumpAndSettle(); - final writtenValue = await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('Read')); - await tester.pumpAndSettle(); - final readValue = await checkSuccess(tester, state); - expect(readValue, writtenValue); - }); - - testWidgets('write - overwrite', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Do test - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await tester.pumpAndSettle(); - final writtenValue1 = await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('Write')); - await tester.pumpAndSettle(); - final writtenValue2 = await checkSuccess(tester, state); - await checkMigration(tester, state); - - assert(writtenValue1 != writtenValue2); - - await tester.tap(find.text('Read')); - await tester.pumpAndSettle(); - final readValue = await checkSuccess(tester, state); - expect(readValue, writtenValue2); - }); - - testWidgets('write - legacy value exists', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('LegacyWrite')); - await tester.pumpAndSettle(); - final legacyValue = await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('Write')); - await tester.pumpAndSettle(); - final writtenValue = await checkSuccess(tester, state); - await checkMigration(tester, state); - - assert(writtenValue != legacyValue); - - await tester.tap(find.text('Read')); - await tester.pumpAndSettle(); - final readValue = await checkSuccess(tester, state); - expect(readValue, writtenValue); - }); - - testWidgets('delete - exists, exists', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - await tester.tap(find.text('LegacyWrite')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('Delete')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'false'); - }); - - testWidgets('delete - exists, does not exist', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('Delete')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'false'); - }); - - testWidgets('delete - does not exist, exists', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('LegacyWrite')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('Delete')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'false'); - }); - - testWidgets('delete - does not exist, does not exist', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Do test - state.keyFieldController.text = key; - await tester.tap(find.text('Delete')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ContainsKey')); - await tester.pumpAndSettle(); - await checkSuccess(tester, state, expectedDetail: 'false'); - }); - - testWidgets('deleteAll - empty, empty', (tester) async { - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - await tester.tap(find.text('DeleteAll')); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - }); - - testWidgets('deleteAll - 1 entry, 1 entry, different keys', - (tester) async { - const key1 = 'key1'; - const key2 = 'key2'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key1; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - - state.keyFieldController.text = key2; - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('DeleteAll')); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - }); - - testWidgets('deleteAll - 1 entry, 1 entry, same keys', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('DeleteAll')); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - }); - - testWidgets('deleteAll - empty, 1entry', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('DeleteAll')); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - }); - - testWidgets('deleteAll - 1entry, empty', (tester) async { - const key = 'key'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('DeleteAll')); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - }); - - testWidgets( - 'deleteAll - 2 entries, 2 entries, same keys and diffrent keys', - (tester) async { - const key1 = 'key1'; - const key2 = 'key2'; - const key3 = 'key3'; - - app.main(); - await tester.pumpAndSettle(); - - final state = getState( - tester, - useBackwardCompatibility: true, - ); - - // Prepare - state.keyFieldController.text = key1; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - - state.keyFieldController.text = key2; - await tester.tap(find.text('Write')); - await checkSuccess(tester, state); - - state.keyFieldController.text = key3; - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - state.keyFieldController.text = key1; - await tester.tap(find.text('LegacyWrite')); - await checkSuccess(tester, state); - - // Do test - await tester.tap(find.text('DeleteAll')); - await checkSuccess(tester, state); - await checkMigration(tester, state); - - await tester.tap(find.text('ReadAll')); - await tester.pumpAndSettle(); - await checkSuccess( - tester, - state, - // Standard map's order and toString() result should be stable - // even if there are no guarantee nand backward compatibility. - expectedDetail: {}.toString(), - ); - }); - }, - skip: kIsWeb || !Platform.isWindows - ? 'These tests only work on Windows' - : null, - ); - - group( - 'Special charactors handling', - () { - testWidgets('URL', (tester) async { - await doTestSuite( - tester, - key1: 'http://example.com', - useBackwardCompatibility: false, - ); - }); - - testWidgets('Double dot', (tester) async { - await doTestSuite( - tester, - key1: '/../a', - ); - }); - - testWidgets('Long key', (tester) async { - await doTestSuite( - tester, - key1: - String.fromCharCodes(Iterable.generate(256, (_) => 65 /* 'A' */)), - useBackwardCompatibility: false, - ); - }); - - testWidgets('Empty key & value', (tester) async { - await doTestSuite( - tester, - key1: '', - writingValue1: '', - ); - }); - - for (final char in { - 'ASCII whitespace': 0x20, - 'Nbsp': 0xA0, - 'Full-width space': 0x3000, - }.entries) { - testWidgets( - 'Space key & value - ${char.key} (U+${char.value.toRadixString(16).padLeft(4, '0')})', - (tester) async { - await doTestSuite( - tester, - key1: String.fromCharCode(char.value), - writingValue1: String.fromCharCode(char.value), - ); - }); - } - - for (final char in { - 'Horizontal tab': 0x09, - }.entries) { - testWidgets( - 'Space key & value - ${char.key} (U+${char.value.toRadixString(16).padLeft(4, '0')})', - (tester) async { - await doTestSuite( - tester, - key1: String.fromCharCode(char.value), - writingValue1: String.fromCharCode(char.value), - useBackwardCompatibility: false, - ); - }); - } - - for (final char in { - 'Latin-1 (French)': 'cl\u00E9', - 'CJK (Japanese)': '\u30AD\u30FC', - 'Surrogate Pair (Emoji)': '\uD83D\uDD11', - }.entries) { - testWidgets('Non ASCII key & value - ${char.key}', (tester) async { - await doTestSuite( - tester, - key1: char.value, - writingValue1: char.value, - ); - }); - } - - testWidgets('Only casing is differ', (tester) async { - await doTestSuite( - tester, - key1: 'key', - key2: 'KEY', - ); - }); - }, - skip: kIsWeb || !Platform.isWindows - ? 'These tests only work on Windows' - : null, - ); -} diff --git a/flutter_secure_storage_windows/example/lib/main.dart b/flutter_secure_storage_windows/example/lib/main.dart deleted file mode 100644 index 9424a018..00000000 --- a/flutter_secure_storage_windows/example/lib/main.dart +++ /dev/null @@ -1,383 +0,0 @@ -import 'package:flutter/material.dart'; -import 'dart:async'; - -import 'package:flutter_secure_storage_platform_interface/flutter_secure_storage_platform_interface.dart'; -import 'package:flutter_secure_storage_windows/flutter_secure_storage_windows.dart'; - -// testing application. -void main() { - runApp(const MyApp()); -} - -class MyApp extends StatefulWidget { - const MyApp({Key? key}) : super(key: key); - - @override - State createState() => MyAppState(); -} - -class MyAppState extends State { - final TextEditingController keyFieldController = TextEditingController(); - final TextEditingController valueFieldController = TextEditingController(); - final TextEditingController resultSummaryFieldController = - TextEditingController(); - final TextEditingController resultDetailFieldController = - TextEditingController(); - final GlobalKey useMethodChannelOnlyKey = GlobalKey(); - final GlobalKey useBackwardCompatibilityKey = - GlobalKey(); - - Future? _future; - - FlutterSecureStoragePlatform _flutterSecureStorageWindowsPlugin = - FlutterSecureStorageWindows(); - final Map _options = {'useBackwardCompatibility': 'false'}; - - @override - void initState() { - super.initState(); - } - - @override - Widget build(BuildContext context) { - return MaterialApp( - home: Scaffold( - appBar: AppBar( - title: const Text('Plugin example app'), - ), - body: Padding( - padding: const EdgeInsets.all(8), - child: Column(children: [ - TextField( - controller: keyFieldController, - decoration: const InputDecoration(label: Text('Key')), - ), - TextField( - controller: valueFieldController, - decoration: const InputDecoration(label: Text('Value')), - ), - LabeledCheckbox( - key: useMethodChannelOnlyKey, - initialValue: false, - label: 'UseMethodChannelOnly', - onChanged: (useMethodChannelOnly) { - setState(() { - _flutterSecureStorageWindowsPlugin = useMethodChannelOnly - ? MethodChannelFlutterSecureStorage() - : FlutterSecureStorageWindows(); - }); - }, - ), - LabeledCheckbox( - key: useBackwardCompatibilityKey, - initialValue: false, - label: 'UseBackwardCompatibility', - onChanged: (useBackwardCompatibility) { - setState(() { - _options['useBackwardCompatibility'] = - useBackwardCompatibility.toString(); - }); - }, - ), - Row( - children: [ - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doRead, - child: const Text('Read'), - ), - ), - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doReadAll, - child: const Text('ReadAll'), - ), - ), - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doContainsKey, - child: const Text('ContainsKey'), - ), - ), - ], - ), - Row( - children: [ - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doWrite, - child: const Text('Write'), - ), - ), - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doDelete, - child: const Text('Delete'), - ), - ), - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doDeleteAll, - child: const Text('DeleteAll'), - ), - ), - ], - ), - Row( - children: [ - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doLegacyWrite, - child: const Text('LegacyWrite'), - ), - ), - Padding( - padding: const EdgeInsets.all(4), - child: ElevatedButton( - onPressed: doLegacyReadAll, - child: const Text('LegacyReadAll'), - ), - ), - ], - ), - if (_future != null) - FutureBuilder( - builder: (context, snapshot) { - if (!snapshot.hasData && !snapshot.hasError) { - return const CircularProgressIndicator(); - } - - resultSummaryFieldController.text = - (snapshot.data?.success ?? false) ? 'SUCCESS' : 'FAIL'; - - return TextField( - controller: resultSummaryFieldController, - decoration: const InputDecoration(label: Text('Result')), - ); - }, - future: _future, - ), - - if (_future != null) - FutureBuilder( - builder: (context, snapshot) { - if (!snapshot.hasData && !snapshot.hasError) { - return const CircularProgressIndicator(); - } - - resultDetailFieldController.text = - snapshot.error?.toString() ?? - snapshot.data!.detail ?? - ''; - - return Column( - children: [ - TextField( - controller: resultSummaryFieldController, - decoration: - const InputDecoration(label: Text('Result')), - ), - TextField( - controller: resultDetailFieldController, - decoration: - const InputDecoration(label: Text('Detail')), - ), - ], - ); - }, - future: _future, - ), - // const Expanded(child: SizedBox()), - ]), - ), - ), - ); - } - - Future doTestCore(FutureOr Function() test) async { - late final TestResult result; - try { - result = await test(); - } catch (e, s) { - debugPrint(e.toString()); - debugPrintStack(stackTrace: s); - result = TestResult(success: false, detail: e.toString()); - } - - return result; - } - - void doTest(FutureOr Function() test) { - setState(() { - _future = doTestCore(test); - }); - } - - void doRead() => doTest(() async { - final key = keyFieldController.text; - return TestResult( - success: true, - detail: await _flutterSecureStorageWindowsPlugin.read( - key: key, - options: _options, - ), - ); - }); - - void doReadAll() => doTest(() async { - return TestResult( - success: true, - detail: (await _flutterSecureStorageWindowsPlugin.readAll( - options: _options, - )) - .toString(), - ); - }); - - void doContainsKey() => doTest(() async { - final key = keyFieldController.text; - return TestResult( - success: true, - detail: (await _flutterSecureStorageWindowsPlugin.containsKey( - key: key, - options: _options, - )) - .toString(), - ); - }); - - void doWrite() => doTest(() async { - final key = keyFieldController.text; - final value = valueFieldController.text.isNotEmpty - ? valueFieldController.text - : DateTime.now().toIso8601String(); - await _flutterSecureStorageWindowsPlugin.write( - key: key, - value: value, - options: _options, - ); - return TestResult(success: true, detail: value); - }); - - void doDelete() => doTest(() async { - final key = keyFieldController.text; - await _flutterSecureStorageWindowsPlugin.delete( - key: key, - options: _options, - ); - return TestResult( - success: true, - detail: null, - ); - }); - - void doDeleteAll() => doTest(() async { - await _flutterSecureStorageWindowsPlugin.deleteAll( - options: _options, - ); - return TestResult( - success: true, - detail: null, - ); - }); - - void doLegacyWrite() => doTest(() async { - final key = keyFieldController.text; - final value = valueFieldController.text.isNotEmpty - ? valueFieldController.text - : DateTime.now().toIso8601String(); - // call MethodChannelFlutterSecureStorage directly - final legacyStorage = MethodChannelFlutterSecureStorage(); - await legacyStorage.write( - key: key, - value: value, - options: _options, - ); - return TestResult(success: true, detail: value); - }); - - void doLegacyReadAll() => doTest(() async { - // call MethodChannelFlutterSecureStorage directly - final legacyStorage = MethodChannelFlutterSecureStorage(); - return TestResult( - success: true, - detail: (await legacyStorage.readAll( - options: _options, - )) - .toString()); - }); -} - -class TestResult { - final bool success; - final String? detail; - TestResult({ - required this.success, - required this.detail, - }); -} - -class LabeledCheckbox extends StatefulWidget { - final String label; - final EdgeInsetsGeometry padding; - final bool initialValue; - final ValueChanged? onChanged; - const LabeledCheckbox({ - Key? key, - required this.label, - this.padding = const EdgeInsets.all(4), - this.initialValue = false, - this.onChanged, - }) : super(key: key); - - @override - State createState() => LabeledCheckboxState._(); -} - -class LabeledCheckboxState extends State { - late bool _value; - - bool get value => _value; - set value(bool v) { - setState(() { - _value = v; - }); - - widget.onChanged?.call(v); - } - - LabeledCheckboxState._(); - - @override - void initState() { - super.initState(); - _value = widget.initialValue; - } - - @override - Widget build(BuildContext context) => InkWell( - onTap: () { - value = !value; - }, - child: Padding( - padding: widget.padding, - child: Row(children: [ - Expanded(child: Text(widget.label)), - Checkbox( - value: value, - onChanged: (newValue) { - if (newValue != null) { - value = newValue; - } - }) - ]), - ), - ); -} diff --git a/flutter_secure_storage_windows/example/pubspec.yaml b/flutter_secure_storage_windows/example/pubspec.yaml deleted file mode 100644 index 541e71be..00000000 --- a/flutter_secure_storage_windows/example/pubspec.yaml +++ /dev/null @@ -1,30 +0,0 @@ -name: flutter_secure_storage_windows_example -description: Demonstrates how to use the flutter_secure_storage_windows plugin. -publish_to: 'none' - -environment: - sdk: '>=3.4.0 <4.0.0' - flutter: '>=3.22.0' - -dependencies: - flutter: - sdk: flutter - flutter_secure_storage_platform_interface: - flutter_secure_storage_windows: - path: ../ - path: ^1.8.0 - path_provider: ^2.0.0 - -dev_dependencies: - flutter_lints: ^2.0.0 - flutter_test: - sdk: flutter - integration_test: - sdk: flutter - -dependency_overrides: - flutter_secure_storage_platform_interface: - path: ../../flutter_secure_storage_platform_interface - -flutter: - uses-material-design: true diff --git a/flutter_secure_storage_windows/example/windows/.gitignore b/flutter_secure_storage_windows/example/windows/.gitignore deleted file mode 100644 index d492d0d9..00000000 --- a/flutter_secure_storage_windows/example/windows/.gitignore +++ /dev/null @@ -1,17 +0,0 @@ -flutter/ephemeral/ - -# Visual Studio user-specific files. -*.suo -*.user -*.userosscache -*.sln.docstates - -# Visual Studio build-related files. -x64/ -x86/ - -# Visual Studio cache files -# files ending in .cache can be ignored -*.[Cc]ache -# but keep track of directories ending in .cache -!*.[Cc]ache/ diff --git a/flutter_secure_storage_windows/example/windows/CMakeLists.txt b/flutter_secure_storage_windows/example/windows/CMakeLists.txt deleted file mode 100644 index 6ff7ad0e..00000000 --- a/flutter_secure_storage_windows/example/windows/CMakeLists.txt +++ /dev/null @@ -1,101 +0,0 @@ -# Project-level configuration. -cmake_minimum_required(VERSION 3.14) -project(flutter_secure_storage_windows_example LANGUAGES CXX) - -# The name of the executable created for the application. Change this to change -# the on-disk name of your application. -set(BINARY_NAME "flutter_secure_storage_windows_example") - -# Explicitly opt in to modern CMake behaviors to avoid warnings with recent -# versions of CMake. -cmake_policy(SET CMP0063 NEW) - -# Define build configuration option. -get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) -if(IS_MULTICONFIG) - set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" - CACHE STRING "" FORCE) -else() - if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) - set(CMAKE_BUILD_TYPE "Debug" CACHE - STRING "Flutter build mode" FORCE) - set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS - "Debug" "Profile" "Release") - endif() -endif() -# Define settings for the Profile build mode. -set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") -set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") -set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") -set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") - -# Use Unicode for all projects. -add_definitions(-DUNICODE -D_UNICODE) - -# Compilation settings that should be applied to most targets. -# -# Be cautious about adding new options here, as plugins use this function by -# default. In most cases, you should add new options to specific targets instead -# of modifying this function. -function(APPLY_STANDARD_SETTINGS TARGET) - target_compile_features(${TARGET} PUBLIC cxx_std_17) - target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") - target_compile_options(${TARGET} PRIVATE /EHsc) - target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") - target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") -endfunction() - -# Flutter library and tool build rules. -set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") -add_subdirectory(${FLUTTER_MANAGED_DIR}) - -# Application build; see runner/CMakeLists.txt. -add_subdirectory("runner") - -# Generated plugin build rules, which manage building the plugins and adding -# them to the application. -include(flutter/generated_plugins.cmake) - - -# === Installation === -# Support files are copied into place next to the executable, so that it can -# run in place. This is done instead of making a separate bundle (as on Linux) -# so that building and running from within Visual Studio will work. -set(BUILD_BUNDLE_DIR "$") -# Make the "install" step default, as it's required to run. -set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) -if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) - set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) -endif() - -set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") -set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") - -install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" - COMPONENT Runtime) - -install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" - COMPONENT Runtime) - -install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" - COMPONENT Runtime) - -if(PLUGIN_BUNDLED_LIBRARIES) - install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" - DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" - COMPONENT Runtime) -endif() - -# Fully re-copy the assets directory on each build to avoid having stale files -# from a previous install. -set(FLUTTER_ASSET_DIR_NAME "flutter_assets") -install(CODE " - file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") - " COMPONENT Runtime) -install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" - DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) - -# Install the AOT library on non-Debug builds only. -install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" - CONFIGURATIONS Profile;Release - COMPONENT Runtime) diff --git a/flutter_secure_storage_windows/example/windows/flutter/CMakeLists.txt b/flutter_secure_storage_windows/example/windows/flutter/CMakeLists.txt deleted file mode 100644 index 903f4899..00000000 --- a/flutter_secure_storage_windows/example/windows/flutter/CMakeLists.txt +++ /dev/null @@ -1,109 +0,0 @@ -# This file controls Flutter-level build steps. It should not be edited. -cmake_minimum_required(VERSION 3.14) - -set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") - -# Configuration provided via flutter tool. -include(${EPHEMERAL_DIR}/generated_config.cmake) - -# TODO: Move the rest of this into files in ephemeral. See -# https://github.com/flutter/flutter/issues/57146. -set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") - -# Set fallback configurations for older versions of the flutter tool. -if (NOT DEFINED FLUTTER_TARGET_PLATFORM) - set(FLUTTER_TARGET_PLATFORM "windows-x64") -endif() - -# === Flutter Library === -set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") - -# Published to parent scope for install step. -set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) -set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) -set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) -set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) - -list(APPEND FLUTTER_LIBRARY_HEADERS - "flutter_export.h" - "flutter_windows.h" - "flutter_messenger.h" - "flutter_plugin_registrar.h" - "flutter_texture_registrar.h" -) -list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") -add_library(flutter INTERFACE) -target_include_directories(flutter INTERFACE - "${EPHEMERAL_DIR}" -) -target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") -add_dependencies(flutter flutter_assemble) - -# === Wrapper === -list(APPEND CPP_WRAPPER_SOURCES_CORE - "core_implementations.cc" - "standard_codec.cc" -) -list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") -list(APPEND CPP_WRAPPER_SOURCES_PLUGIN - "plugin_registrar.cc" -) -list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") -list(APPEND CPP_WRAPPER_SOURCES_APP - "flutter_engine.cc" - "flutter_view_controller.cc" -) -list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") - -# Wrapper sources needed for a plugin. -add_library(flutter_wrapper_plugin STATIC - ${CPP_WRAPPER_SOURCES_CORE} - ${CPP_WRAPPER_SOURCES_PLUGIN} -) -apply_standard_settings(flutter_wrapper_plugin) -set_target_properties(flutter_wrapper_plugin PROPERTIES - POSITION_INDEPENDENT_CODE ON) -set_target_properties(flutter_wrapper_plugin PROPERTIES - CXX_VISIBILITY_PRESET hidden) -target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) -target_include_directories(flutter_wrapper_plugin PUBLIC - "${WRAPPER_ROOT}/include" -) -add_dependencies(flutter_wrapper_plugin flutter_assemble) - -# Wrapper sources needed for the runner. -add_library(flutter_wrapper_app STATIC - ${CPP_WRAPPER_SOURCES_CORE} - ${CPP_WRAPPER_SOURCES_APP} -) -apply_standard_settings(flutter_wrapper_app) -target_link_libraries(flutter_wrapper_app PUBLIC flutter) -target_include_directories(flutter_wrapper_app PUBLIC - "${WRAPPER_ROOT}/include" -) -add_dependencies(flutter_wrapper_app flutter_assemble) - -# === Flutter tool backend === -# _phony_ is a non-existent file to force this command to run every time, -# since currently there's no way to get a full input/output list from the -# flutter tool. -set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") -set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) -add_custom_command( - OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} - ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} - ${CPP_WRAPPER_SOURCES_APP} - ${PHONY_OUTPUT} - COMMAND ${CMAKE_COMMAND} -E env - ${FLUTTER_TOOL_ENVIRONMENT} - "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" - ${FLUTTER_TARGET_PLATFORM} $ - VERBATIM -) -add_custom_target(flutter_assemble DEPENDS - "${FLUTTER_LIBRARY}" - ${FLUTTER_LIBRARY_HEADERS} - ${CPP_WRAPPER_SOURCES_CORE} - ${CPP_WRAPPER_SOURCES_PLUGIN} - ${CPP_WRAPPER_SOURCES_APP} -) diff --git a/flutter_secure_storage_windows/example/windows/flutter/generated_plugin_registrant.cc b/flutter_secure_storage_windows/example/windows/flutter/generated_plugin_registrant.cc deleted file mode 100644 index 0c507538..00000000 --- a/flutter_secure_storage_windows/example/windows/flutter/generated_plugin_registrant.cc +++ /dev/null @@ -1,14 +0,0 @@ -// -// Generated file. Do not edit. -// - -// clang-format off - -#include "generated_plugin_registrant.h" - -#include - -void RegisterPlugins(flutter::PluginRegistry* registry) { - FlutterSecureStorageWindowsPluginRegisterWithRegistrar( - registry->GetRegistrarForPlugin("FlutterSecureStorageWindowsPlugin")); -} diff --git a/flutter_secure_storage_windows/example/windows/flutter/generated_plugin_registrant.h b/flutter_secure_storage_windows/example/windows/flutter/generated_plugin_registrant.h deleted file mode 100644 index dc139d85..00000000 --- a/flutter_secure_storage_windows/example/windows/flutter/generated_plugin_registrant.h +++ /dev/null @@ -1,15 +0,0 @@ -// -// Generated file. Do not edit. -// - -// clang-format off - -#ifndef GENERATED_PLUGIN_REGISTRANT_ -#define GENERATED_PLUGIN_REGISTRANT_ - -#include - -// Registers Flutter plugins. -void RegisterPlugins(flutter::PluginRegistry* registry); - -#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/flutter_secure_storage_windows/example/windows/flutter/generated_plugins.cmake b/flutter_secure_storage_windows/example/windows/flutter/generated_plugins.cmake deleted file mode 100644 index 4fc759c4..00000000 --- a/flutter_secure_storage_windows/example/windows/flutter/generated_plugins.cmake +++ /dev/null @@ -1,24 +0,0 @@ -# -# Generated file, do not edit. -# - -list(APPEND FLUTTER_PLUGIN_LIST - flutter_secure_storage_windows -) - -list(APPEND FLUTTER_FFI_PLUGIN_LIST -) - -set(PLUGIN_BUNDLED_LIBRARIES) - -foreach(plugin ${FLUTTER_PLUGIN_LIST}) - add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) - target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) - list(APPEND PLUGIN_BUNDLED_LIBRARIES $) - list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) -endforeach(plugin) - -foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) - add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) - list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) -endforeach(ffi_plugin) diff --git a/flutter_secure_storage_windows/example/windows/runner/CMakeLists.txt b/flutter_secure_storage_windows/example/windows/runner/CMakeLists.txt deleted file mode 100644 index 394917c0..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/CMakeLists.txt +++ /dev/null @@ -1,40 +0,0 @@ -cmake_minimum_required(VERSION 3.14) -project(runner LANGUAGES CXX) - -# Define the application target. To change its name, change BINARY_NAME in the -# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer -# work. -# -# Any new source files that you add to the application should be added here. -add_executable(${BINARY_NAME} WIN32 - "flutter_window.cpp" - "main.cpp" - "utils.cpp" - "win32_window.cpp" - "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" - "Runner.rc" - "runner.exe.manifest" -) - -# Apply the standard set of build settings. This can be removed for applications -# that need different build settings. -apply_standard_settings(${BINARY_NAME}) - -# Add preprocessor definitions for the build version. -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") -target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") - -# Disable Windows macros that collide with C++ standard library functions. -target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") - -# Add dependency libraries and include directories. Add any application-specific -# dependencies here. -target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) -target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") -target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") - -# Run the Flutter tool portions of the build. This must not be removed. -add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/flutter_secure_storage_windows/example/windows/runner/Runner.rc b/flutter_secure_storage_windows/example/windows/runner/Runner.rc deleted file mode 100644 index 4a244a5a..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/Runner.rc +++ /dev/null @@ -1,121 +0,0 @@ -// Microsoft Visual C++ generated resource script. -// -#pragma code_page(65001) -#include "resource.h" - -#define APSTUDIO_READONLY_SYMBOLS -///////////////////////////////////////////////////////////////////////////// -// -// Generated from the TEXTINCLUDE 2 resource. -// -#include "winres.h" - -///////////////////////////////////////////////////////////////////////////// -#undef APSTUDIO_READONLY_SYMBOLS - -///////////////////////////////////////////////////////////////////////////// -// English (United States) resources - -#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) -LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US - -#ifdef APSTUDIO_INVOKED -///////////////////////////////////////////////////////////////////////////// -// -// TEXTINCLUDE -// - -1 TEXTINCLUDE -BEGIN - "resource.h\0" -END - -2 TEXTINCLUDE -BEGIN - "#include ""winres.h""\r\n" - "\0" -END - -3 TEXTINCLUDE -BEGIN - "\r\n" - "\0" -END - -#endif // APSTUDIO_INVOKED - - -///////////////////////////////////////////////////////////////////////////// -// -// Icon -// - -// Icon with lowest ID value placed first to ensure application icon -// remains consistent on all systems. -IDI_APP_ICON ICON "resources\\app_icon.ico" - - -///////////////////////////////////////////////////////////////////////////// -// -// Version -// - -#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) -#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD -#else -#define VERSION_AS_NUMBER 1,0,0,0 -#endif - -#if defined(FLUTTER_VERSION) -#define VERSION_AS_STRING FLUTTER_VERSION -#else -#define VERSION_AS_STRING "1.0.0" -#endif - -VS_VERSION_INFO VERSIONINFO - FILEVERSION VERSION_AS_NUMBER - PRODUCTVERSION VERSION_AS_NUMBER - FILEFLAGSMASK VS_FFI_FILEFLAGSMASK -#ifdef _DEBUG - FILEFLAGS VS_FF_DEBUG -#else - FILEFLAGS 0x0L -#endif - FILEOS VOS__WINDOWS32 - FILETYPE VFT_APP - FILESUBTYPE 0x0L -BEGIN - BLOCK "StringFileInfo" - BEGIN - BLOCK "040904e4" - BEGIN - VALUE "CompanyName", "com.example" "\0" - VALUE "FileDescription", "flutter_secure_storage_windows_example" "\0" - VALUE "FileVersion", VERSION_AS_STRING "\0" - VALUE "InternalName", "flutter_secure_storage_windows_example" "\0" - VALUE "LegalCopyright", "Copyright (C) 2023 com.example. All rights reserved." "\0" - VALUE "OriginalFilename", "flutter_secure_storage_windows_example.exe" "\0" - VALUE "ProductName", "flutter_secure_storage_windows_example" "\0" - VALUE "ProductVersion", VERSION_AS_STRING "\0" - END - END - BLOCK "VarFileInfo" - BEGIN - VALUE "Translation", 0x409, 1252 - END -END - -#endif // English (United States) resources -///////////////////////////////////////////////////////////////////////////// - - - -#ifndef APSTUDIO_INVOKED -///////////////////////////////////////////////////////////////////////////// -// -// Generated from the TEXTINCLUDE 3 resource. -// - - -///////////////////////////////////////////////////////////////////////////// -#endif // not APSTUDIO_INVOKED diff --git a/flutter_secure_storage_windows/example/windows/runner/flutter_window.cpp b/flutter_secure_storage_windows/example/windows/runner/flutter_window.cpp deleted file mode 100644 index 955ee303..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/flutter_window.cpp +++ /dev/null @@ -1,71 +0,0 @@ -#include "flutter_window.h" - -#include - -#include "flutter/generated_plugin_registrant.h" - -FlutterWindow::FlutterWindow(const flutter::DartProject& project) - : project_(project) {} - -FlutterWindow::~FlutterWindow() {} - -bool FlutterWindow::OnCreate() { - if (!Win32Window::OnCreate()) { - return false; - } - - RECT frame = GetClientArea(); - - // The size here must match the window dimensions to avoid unnecessary surface - // creation / destruction in the startup path. - flutter_controller_ = std::make_unique( - frame.right - frame.left, frame.bottom - frame.top, project_); - // Ensure that basic setup of the controller was successful. - if (!flutter_controller_->engine() || !flutter_controller_->view()) { - return false; - } - RegisterPlugins(flutter_controller_->engine()); - SetChildContent(flutter_controller_->view()->GetNativeWindow()); - - flutter_controller_->engine()->SetNextFrameCallback([&]() { - this->Show(); - }); - - // Flutter can complete the first frame before the "show window" callback is - // registered. The following call ensures a frame is pending to ensure the - // window is shown. It is a no-op if the first frame hasn't completed yet. - flutter_controller_->ForceRedraw(); - - return true; -} - -void FlutterWindow::OnDestroy() { - if (flutter_controller_) { - flutter_controller_ = nullptr; - } - - Win32Window::OnDestroy(); -} - -LRESULT -FlutterWindow::MessageHandler(HWND hwnd, UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept { - // Give Flutter, including plugins, an opportunity to handle window messages. - if (flutter_controller_) { - std::optional result = - flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, - lparam); - if (result) { - return *result; - } - } - - switch (message) { - case WM_FONTCHANGE: - flutter_controller_->engine()->ReloadSystemFonts(); - break; - } - - return Win32Window::MessageHandler(hwnd, message, wparam, lparam); -} diff --git a/flutter_secure_storage_windows/example/windows/runner/flutter_window.h b/flutter_secure_storage_windows/example/windows/runner/flutter_window.h deleted file mode 100644 index 6da0652f..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/flutter_window.h +++ /dev/null @@ -1,33 +0,0 @@ -#ifndef RUNNER_FLUTTER_WINDOW_H_ -#define RUNNER_FLUTTER_WINDOW_H_ - -#include -#include - -#include - -#include "win32_window.h" - -// A window that does nothing but host a Flutter view. -class FlutterWindow : public Win32Window { - public: - // Creates a new FlutterWindow hosting a Flutter view running |project|. - explicit FlutterWindow(const flutter::DartProject& project); - virtual ~FlutterWindow(); - - protected: - // Win32Window: - bool OnCreate() override; - void OnDestroy() override; - LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, - LPARAM const lparam) noexcept override; - - private: - // The project to run. - flutter::DartProject project_; - - // The Flutter instance hosted by this window. - std::unique_ptr flutter_controller_; -}; - -#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/flutter_secure_storage_windows/example/windows/runner/main.cpp b/flutter_secure_storage_windows/example/windows/runner/main.cpp deleted file mode 100644 index 6e0f99d4..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/main.cpp +++ /dev/null @@ -1,43 +0,0 @@ -#include -#include -#include - -#include "flutter_window.h" -#include "utils.h" - -int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, - _In_ wchar_t *command_line, _In_ int show_command) { - // Attach to console when present (e.g., 'flutter run') or create a - // new console when running with a debugger. - if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { - CreateAndAttachConsole(); - } - - // Initialize COM, so that it is available for use in the library and/or - // plugins. - ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); - - flutter::DartProject project(L"data"); - - std::vector command_line_arguments = - GetCommandLineArguments(); - - project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); - - FlutterWindow window(project); - Win32Window::Point origin(10, 10); - Win32Window::Size size(1280, 720); - if (!window.Create(L"flutter_secure_storage_windows_example", origin, size)) { - return EXIT_FAILURE; - } - window.SetQuitOnClose(true); - - ::MSG msg; - while (::GetMessage(&msg, nullptr, 0, 0)) { - ::TranslateMessage(&msg); - ::DispatchMessage(&msg); - } - - ::CoUninitialize(); - return EXIT_SUCCESS; -} diff --git a/flutter_secure_storage_windows/example/windows/runner/resource.h b/flutter_secure_storage_windows/example/windows/runner/resource.h deleted file mode 100644 index 66a65d1e..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/resource.h +++ /dev/null @@ -1,16 +0,0 @@ -//{{NO_DEPENDENCIES}} -// Microsoft Visual C++ generated include file. -// Used by Runner.rc -// -#define IDI_APP_ICON 101 - -// Next default values for new objects -// -#ifdef APSTUDIO_INVOKED -#ifndef APSTUDIO_READONLY_SYMBOLS -#define _APS_NEXT_RESOURCE_VALUE 102 -#define _APS_NEXT_COMMAND_VALUE 40001 -#define _APS_NEXT_CONTROL_VALUE 1001 -#define _APS_NEXT_SYMED_VALUE 101 -#endif -#endif diff --git a/flutter_secure_storage_windows/example/windows/runner/resources/app_icon.ico b/flutter_secure_storage_windows/example/windows/runner/resources/app_icon.ico deleted file mode 100644 index c04e20ca..00000000 Binary files a/flutter_secure_storage_windows/example/windows/runner/resources/app_icon.ico and /dev/null differ diff --git a/flutter_secure_storage_windows/example/windows/runner/runner.exe.manifest b/flutter_secure_storage_windows/example/windows/runner/runner.exe.manifest deleted file mode 100644 index a42ea768..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/runner.exe.manifest +++ /dev/null @@ -1,20 +0,0 @@ - - - - - PerMonitorV2 - - - - - - - - - - - - - - - diff --git a/flutter_secure_storage_windows/example/windows/runner/utils.cpp b/flutter_secure_storage_windows/example/windows/runner/utils.cpp deleted file mode 100644 index f5bf9fa0..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/utils.cpp +++ /dev/null @@ -1,64 +0,0 @@ -#include "utils.h" - -#include -#include -#include -#include - -#include - -void CreateAndAttachConsole() { - if (::AllocConsole()) { - FILE *unused; - if (freopen_s(&unused, "CONOUT$", "w", stdout)) { - _dup2(_fileno(stdout), 1); - } - if (freopen_s(&unused, "CONOUT$", "w", stderr)) { - _dup2(_fileno(stdout), 2); - } - std::ios::sync_with_stdio(); - FlutterDesktopResyncOutputStreams(); - } -} - -std::vector GetCommandLineArguments() { - // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. - int argc; - wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); - if (argv == nullptr) { - return std::vector(); - } - - std::vector command_line_arguments; - - // Skip the first argument as it's the binary name. - for (int i = 1; i < argc; i++) { - command_line_arguments.push_back(Utf8FromUtf16(argv[i])); - } - - ::LocalFree(argv); - - return command_line_arguments; -} - -std::string Utf8FromUtf16(const wchar_t* utf16_string) { - if (utf16_string == nullptr) { - return std::string(); - } - int target_length = ::WideCharToMultiByte( - CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, - -1, nullptr, 0, nullptr, nullptr); - std::string utf8_string; - if (target_length == 0 || target_length > utf8_string.max_size()) { - return utf8_string; - } - utf8_string.resize(target_length); - int converted_length = ::WideCharToMultiByte( - CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, - -1, utf8_string.data(), - target_length, nullptr, nullptr); - if (converted_length == 0) { - return std::string(); - } - return utf8_string; -} diff --git a/flutter_secure_storage_windows/example/windows/runner/utils.h b/flutter_secure_storage_windows/example/windows/runner/utils.h deleted file mode 100644 index 3879d547..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/utils.h +++ /dev/null @@ -1,19 +0,0 @@ -#ifndef RUNNER_UTILS_H_ -#define RUNNER_UTILS_H_ - -#include -#include - -// Creates a console for the process, and redirects stdout and stderr to -// it for both the runner and the Flutter library. -void CreateAndAttachConsole(); - -// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string -// encoded in UTF-8. Returns an empty std::string on failure. -std::string Utf8FromUtf16(const wchar_t* utf16_string); - -// Gets the command line arguments passed in as a std::vector, -// encoded in UTF-8. Returns an empty std::vector on failure. -std::vector GetCommandLineArguments(); - -#endif // RUNNER_UTILS_H_ diff --git a/flutter_secure_storage_windows/example/windows/runner/win32_window.cpp b/flutter_secure_storage_windows/example/windows/runner/win32_window.cpp deleted file mode 100644 index 041a3855..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/win32_window.cpp +++ /dev/null @@ -1,288 +0,0 @@ -#include "win32_window.h" - -#include -#include - -#include "resource.h" - -namespace { - -/// Window attribute that enables dark mode window decorations. -/// -/// Redefined in case the developer's machine has a Windows SDK older than -/// version 10.0.22000.0. -/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute -#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE -#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 -#endif - -constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; - -/// Registry key for app theme preference. -/// -/// A value of 0 indicates apps should use dark mode. A non-zero or missing -/// value indicates apps should use light mode. -constexpr const wchar_t kGetPreferredBrightnessRegKey[] = - L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; -constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; - -// The number of Win32Window objects that currently exist. -static int g_active_window_count = 0; - -using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); - -// Scale helper to convert logical scaler values to physical using passed in -// scale factor -int Scale(int source, double scale_factor) { - return static_cast(source * scale_factor); -} - -// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. -// This API is only needed for PerMonitor V1 awareness mode. -void EnableFullDpiSupportIfAvailable(HWND hwnd) { - HMODULE user32_module = LoadLibraryA("User32.dll"); - if (!user32_module) { - return; - } - auto enable_non_client_dpi_scaling = - reinterpret_cast( - GetProcAddress(user32_module, "EnableNonClientDpiScaling")); - if (enable_non_client_dpi_scaling != nullptr) { - enable_non_client_dpi_scaling(hwnd); - } - FreeLibrary(user32_module); -} - -} // namespace - -// Manages the Win32Window's window class registration. -class WindowClassRegistrar { - public: - ~WindowClassRegistrar() = default; - - // Returns the singleton registar instance. - static WindowClassRegistrar* GetInstance() { - if (!instance_) { - instance_ = new WindowClassRegistrar(); - } - return instance_; - } - - // Returns the name of the window class, registering the class if it hasn't - // previously been registered. - const wchar_t* GetWindowClass(); - - // Unregisters the window class. Should only be called if there are no - // instances of the window. - void UnregisterWindowClass(); - - private: - WindowClassRegistrar() = default; - - static WindowClassRegistrar* instance_; - - bool class_registered_ = false; -}; - -WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; - -const wchar_t* WindowClassRegistrar::GetWindowClass() { - if (!class_registered_) { - WNDCLASS window_class{}; - window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); - window_class.lpszClassName = kWindowClassName; - window_class.style = CS_HREDRAW | CS_VREDRAW; - window_class.cbClsExtra = 0; - window_class.cbWndExtra = 0; - window_class.hInstance = GetModuleHandle(nullptr); - window_class.hIcon = - LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); - window_class.hbrBackground = 0; - window_class.lpszMenuName = nullptr; - window_class.lpfnWndProc = Win32Window::WndProc; - RegisterClass(&window_class); - class_registered_ = true; - } - return kWindowClassName; -} - -void WindowClassRegistrar::UnregisterWindowClass() { - UnregisterClass(kWindowClassName, nullptr); - class_registered_ = false; -} - -Win32Window::Win32Window() { - ++g_active_window_count; -} - -Win32Window::~Win32Window() { - --g_active_window_count; - Destroy(); -} - -bool Win32Window::Create(const std::wstring& title, - const Point& origin, - const Size& size) { - Destroy(); - - const wchar_t* window_class = - WindowClassRegistrar::GetInstance()->GetWindowClass(); - - const POINT target_point = {static_cast(origin.x), - static_cast(origin.y)}; - HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); - UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); - double scale_factor = dpi / 96.0; - - HWND window = CreateWindow( - window_class, title.c_str(), WS_OVERLAPPEDWINDOW, - Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), - Scale(size.width, scale_factor), Scale(size.height, scale_factor), - nullptr, nullptr, GetModuleHandle(nullptr), this); - - if (!window) { - return false; - } - - UpdateTheme(window); - - return OnCreate(); -} - -bool Win32Window::Show() { - return ShowWindow(window_handle_, SW_SHOWNORMAL); -} - -// static -LRESULT CALLBACK Win32Window::WndProc(HWND const window, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept { - if (message == WM_NCCREATE) { - auto window_struct = reinterpret_cast(lparam); - SetWindowLongPtr(window, GWLP_USERDATA, - reinterpret_cast(window_struct->lpCreateParams)); - - auto that = static_cast(window_struct->lpCreateParams); - EnableFullDpiSupportIfAvailable(window); - that->window_handle_ = window; - } else if (Win32Window* that = GetThisFromHandle(window)) { - return that->MessageHandler(window, message, wparam, lparam); - } - - return DefWindowProc(window, message, wparam, lparam); -} - -LRESULT -Win32Window::MessageHandler(HWND hwnd, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept { - switch (message) { - case WM_DESTROY: - window_handle_ = nullptr; - Destroy(); - if (quit_on_close_) { - PostQuitMessage(0); - } - return 0; - - case WM_DPICHANGED: { - auto newRectSize = reinterpret_cast(lparam); - LONG newWidth = newRectSize->right - newRectSize->left; - LONG newHeight = newRectSize->bottom - newRectSize->top; - - SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, - newHeight, SWP_NOZORDER | SWP_NOACTIVATE); - - return 0; - } - case WM_SIZE: { - RECT rect = GetClientArea(); - if (child_content_ != nullptr) { - // Size and position the child window. - MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, - rect.bottom - rect.top, TRUE); - } - return 0; - } - - case WM_ACTIVATE: - if (child_content_ != nullptr) { - SetFocus(child_content_); - } - return 0; - - case WM_DWMCOLORIZATIONCOLORCHANGED: - UpdateTheme(hwnd); - return 0; - } - - return DefWindowProc(window_handle_, message, wparam, lparam); -} - -void Win32Window::Destroy() { - OnDestroy(); - - if (window_handle_) { - DestroyWindow(window_handle_); - window_handle_ = nullptr; - } - if (g_active_window_count == 0) { - WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); - } -} - -Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { - return reinterpret_cast( - GetWindowLongPtr(window, GWLP_USERDATA)); -} - -void Win32Window::SetChildContent(HWND content) { - child_content_ = content; - SetParent(content, window_handle_); - RECT frame = GetClientArea(); - - MoveWindow(content, frame.left, frame.top, frame.right - frame.left, - frame.bottom - frame.top, true); - - SetFocus(child_content_); -} - -RECT Win32Window::GetClientArea() { - RECT frame; - GetClientRect(window_handle_, &frame); - return frame; -} - -HWND Win32Window::GetHandle() { - return window_handle_; -} - -void Win32Window::SetQuitOnClose(bool quit_on_close) { - quit_on_close_ = quit_on_close; -} - -bool Win32Window::OnCreate() { - // No-op; provided for subclasses. - return true; -} - -void Win32Window::OnDestroy() { - // No-op; provided for subclasses. -} - -void Win32Window::UpdateTheme(HWND const window) { - DWORD light_mode; - DWORD light_mode_size = sizeof(light_mode); - LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, - kGetPreferredBrightnessRegValue, - RRF_RT_REG_DWORD, nullptr, &light_mode, - &light_mode_size); - - if (result == ERROR_SUCCESS) { - BOOL enable_dark_mode = light_mode == 0; - DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, - &enable_dark_mode, sizeof(enable_dark_mode)); - } -} diff --git a/flutter_secure_storage_windows/example/windows/runner/win32_window.h b/flutter_secure_storage_windows/example/windows/runner/win32_window.h deleted file mode 100644 index c86632d8..00000000 --- a/flutter_secure_storage_windows/example/windows/runner/win32_window.h +++ /dev/null @@ -1,102 +0,0 @@ -#ifndef RUNNER_WIN32_WINDOW_H_ -#define RUNNER_WIN32_WINDOW_H_ - -#include - -#include -#include -#include - -// A class abstraction for a high DPI-aware Win32 Window. Intended to be -// inherited from by classes that wish to specialize with custom -// rendering and input handling -class Win32Window { - public: - struct Point { - unsigned int x; - unsigned int y; - Point(unsigned int x, unsigned int y) : x(x), y(y) {} - }; - - struct Size { - unsigned int width; - unsigned int height; - Size(unsigned int width, unsigned int height) - : width(width), height(height) {} - }; - - Win32Window(); - virtual ~Win32Window(); - - // Creates a win32 window with |title| that is positioned and sized using - // |origin| and |size|. New windows are created on the default monitor. Window - // sizes are specified to the OS in physical pixels, hence to ensure a - // consistent size this function will scale the inputted width and height as - // as appropriate for the default monitor. The window is invisible until - // |Show| is called. Returns true if the window was created successfully. - bool Create(const std::wstring& title, const Point& origin, const Size& size); - - // Show the current window. Returns true if the window was successfully shown. - bool Show(); - - // Release OS resources associated with window. - void Destroy(); - - // Inserts |content| into the window tree. - void SetChildContent(HWND content); - - // Returns the backing Window handle to enable clients to set icon and other - // window properties. Returns nullptr if the window has been destroyed. - HWND GetHandle(); - - // If true, closing this window will quit the application. - void SetQuitOnClose(bool quit_on_close); - - // Return a RECT representing the bounds of the current client area. - RECT GetClientArea(); - - protected: - // Processes and route salient window messages for mouse handling, - // size change and DPI. Delegates handling of these to member overloads that - // inheriting classes can handle. - virtual LRESULT MessageHandler(HWND window, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept; - - // Called when CreateAndShow is called, allowing subclass window-related - // setup. Subclasses should return false if setup fails. - virtual bool OnCreate(); - - // Called when Destroy is called. - virtual void OnDestroy(); - - private: - friend class WindowClassRegistrar; - - // OS callback called by message pump. Handles the WM_NCCREATE message which - // is passed when the non-client area is being created and enables automatic - // non-client DPI scaling so that the non-client area automatically - // responsponds to changes in DPI. All other messages are handled by - // MessageHandler. - static LRESULT CALLBACK WndProc(HWND const window, - UINT const message, - WPARAM const wparam, - LPARAM const lparam) noexcept; - - // Retrieves a class instance pointer for |window| - static Win32Window* GetThisFromHandle(HWND const window) noexcept; - - // Update the window frame's theme to match the system theme. - static void UpdateTheme(HWND const window); - - bool quit_on_close_ = false; - - // window handle for top level window. - HWND window_handle_ = nullptr; - - // window handle for hosted content. - HWND child_content_ = nullptr; -}; - -#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/flutter_secure_storage_windows/windows/CMakeLists.txt b/flutter_secure_storage_windows/windows/CMakeLists.txt index 61bd19da..d5564d9e 100644 --- a/flutter_secure_storage_windows/windows/CMakeLists.txt +++ b/flutter_secure_storage_windows/windows/CMakeLists.txt @@ -26,4 +26,8 @@ if(NOT DEFINED STORAGE_PREFIX) add_compile_definitions(SECURE_STORAGE_KEY_PREFIX="${BINARY_NAME}_VGhpcyBpcyB0aGUgcHJlZml4IGZv_") else() add_compile_definitions(SECURE_STORAGE_KEY_PREFIX="${STORAGE_PREFIX}_VGhpcyBpcyB0aGUgcHJlZml4IGZv_") +endif() + +if(BUILD_TESTING) + add_subdirectory(test) endif() \ No newline at end of file diff --git a/flutter_secure_storage_windows/windows/flutter_secure_storage_windows_plugin.cpp b/flutter_secure_storage_windows/windows/flutter_secure_storage_windows_plugin.cpp index 4656daa7..375f9957 100644 --- a/flutter_secure_storage_windows/windows/flutter_secure_storage_windows_plugin.cpp +++ b/flutter_secure_storage_windows/windows/flutter_secure_storage_windows_plugin.cpp @@ -1,4 +1,4 @@ -#include "include/flutter_secure_storage_windows/flutter_secure_storage_windows_plugin.h" +#include "flutter_secure_storage_windows_plugin.h" // This must be included before many other Windows headers. #include @@ -28,67 +28,9 @@ #pragma comment(lib, "version.lib") #pragma comment(lib, "bcrypt.lib") -namespace +namespace flutter_secure_storage_windows { - class FlutterSecureStorageWindowsPlugin : public flutter::Plugin - { - public: - static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); - - FlutterSecureStorageWindowsPlugin(); - - virtual ~FlutterSecureStorageWindowsPlugin(); - - private: - // Called when a method is called on this plugin's channel from Dart. - void HandleMethodCall( - const flutter::MethodCall &method_call, - std::unique_ptr> result); - - // Retrieves the value passed to the given param. - std::optional GetStringArg( - const std::string ¶m, - const flutter::EncodableMap *args); - - // Derive the key for a value given a method argument map. - std::optional FlutterSecureStorageWindowsPlugin::GetValueKey(const flutter::EncodableMap *args); - - // Removes prefix of the given storage key. - // - // The prefix (defined by ELEMENT_PREFERENCES_KEY_PREFIX) is added automatically when writing to storage, - // to distinguish values that are written by this plugin from values that are not. - std::string RemoveKeyPrefix(const std::string &key); - - // Gets the string name for the given int error code - std::string GetErrorString(const DWORD &error_code); - // Get string name of ntstatus - std::string NtStatusToString(const CHAR* operation, NTSTATUS status); - - DWORD GetApplicationSupportPath(std::wstring& path); - - std::wstring SanitizeDirString(std::wstring string); - - bool PathExists(const std::wstring& path); - - bool MakePath(const std::wstring& path); - - PBYTE GetEncryptionKey(); - - // Stores the given value under the given key. - void Write(const std::string &key, const std::string &val); - - std::optional Read(const std::string &key); - - flutter::EncodableMap ReadAll(); - - void Delete(const std::string &key); - - void DeleteAll(); - - bool ContainsKey(const std::string &key); - }; - const std::string ELEMENT_PREFERENCES_KEY_PREFIX = SECURE_STORAGE_KEY_PREFIX; const int ELEMENT_PREFERENCES_KEY_PREFIX_LENGTH = (sizeof SECURE_STORAGE_KEY_PREFIX) - 1; @@ -892,12 +834,13 @@ namespace } return true; } -} // namespace +} // namespace flutter_secure_storage_windows void FlutterSecureStorageWindowsPluginRegisterWithRegistrar( FlutterDesktopPluginRegistrarRef registrar) { - FlutterSecureStorageWindowsPlugin::RegisterWithRegistrar( - flutter::PluginRegistrarManager::GetInstance() - ->GetRegistrar(registrar)); + flutter_secure_storage_windows::FlutterSecureStorageWindowsPlugin:: + RegisterWithRegistrar( + flutter::PluginRegistrarManager::GetInstance() + ->GetRegistrar(registrar)); } diff --git a/flutter_secure_storage_windows/windows/flutter_secure_storage_windows_plugin.h b/flutter_secure_storage_windows/windows/flutter_secure_storage_windows_plugin.h new file mode 100644 index 00000000..135231e6 --- /dev/null +++ b/flutter_secure_storage_windows/windows/flutter_secure_storage_windows_plugin.h @@ -0,0 +1,56 @@ +#ifndef FLUTTER_PLUGIN_FLUTTER_SECURE_STORAGE_WINDOWS_PLUGIN_H_ +#define FLUTTER_PLUGIN_FLUTTER_SECURE_STORAGE_WINDOWS_PLUGIN_H_ + +#include + +#include +#include + +#include +#include +#include + +namespace flutter_secure_storage_windows { + +class FlutterSecureStorageWindowsPlugin : public flutter::Plugin { + public: + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows *registrar); + + FlutterSecureStorageWindowsPlugin(); + virtual ~FlutterSecureStorageWindowsPlugin(); + + // Disallow copy and assign. + FlutterSecureStorageWindowsPlugin(const FlutterSecureStorageWindowsPlugin&) = + delete; + FlutterSecureStorageWindowsPlugin& operator=( + const FlutterSecureStorageWindowsPlugin&) = delete; + + // Called when a method is called on this plugin's channel from Dart. + // Public so that it can be exercised directly in native unit tests. + void HandleMethodCall( + const flutter::MethodCall& method_call, + std::unique_ptr> result); + + private: + std::optional GetStringArg(const std::string& param, + const flutter::EncodableMap* args); + std::optional GetValueKey(const flutter::EncodableMap* args); + std::string RemoveKeyPrefix(const std::string& key); + std::string GetErrorString(const DWORD& error_code); + std::string NtStatusToString(const CHAR* operation, NTSTATUS status); + DWORD GetApplicationSupportPath(std::wstring& path); + std::wstring SanitizeDirString(std::wstring string); + bool PathExists(const std::wstring& path); + bool MakePath(const std::wstring& path); + PBYTE GetEncryptionKey(); + void Write(const std::string& key, const std::string& val); + std::optional Read(const std::string& key); + flutter::EncodableMap ReadAll(); + void Delete(const std::string& key); + void DeleteAll(); + bool ContainsKey(const std::string& key); +}; + +} // namespace flutter_secure_storage_windows + +#endif // FLUTTER_PLUGIN_FLUTTER_SECURE_STORAGE_WINDOWS_PLUGIN_H_ diff --git a/flutter_secure_storage_windows/windows/test/CMakeLists.txt b/flutter_secure_storage_windows/windows/test/CMakeLists.txt new file mode 100644 index 00000000..8661dd62 --- /dev/null +++ b/flutter_secure_storage_windows/windows/test/CMakeLists.txt @@ -0,0 +1,39 @@ +cmake_minimum_required(VERSION 3.15) +project(flutter_secure_storage_windows_test LANGUAGES CXX) + +include(FetchContent) +FetchContent_Declare( + googletest + URL https://github.com/google/googletest/archive/b514bdc898e2951020cbdca1304b75f5950d1f59.zip + DOWNLOAD_EXTRACT_TIMESTAMP TRUE +) +# Prevent overriding the parent project's compiler/linker settings on Windows. +set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) +FetchContent_MakeAvailable(googletest) + +enable_testing() + +add_executable(flutter_secure_storage_windows_test + flutter_secure_storage_windows_plugin_test.cpp +) + +# The test binary shares the same SECURE_STORAGE_KEY_PREFIX as the plugin so +# that keys written through HandleMethodCall use the same namespace. A +# dedicated test prefix is used to avoid touching real application data. +target_compile_definitions(flutter_secure_storage_windows_test PRIVATE + SECURE_STORAGE_KEY_PREFIX="fss_native_test_" +) + +target_include_directories(flutter_secure_storage_windows_test PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/.. +) + +target_link_libraries(flutter_secure_storage_windows_test PRIVATE + ${PLUGIN_NAME} + GTest::gtest_main +) + +target_compile_features(flutter_secure_storage_windows_test PRIVATE cxx_std_17) + +include(GoogleTest) +gtest_discover_tests(flutter_secure_storage_windows_test) diff --git a/flutter_secure_storage_windows/windows/test/flutter_secure_storage_windows_plugin_test.cpp b/flutter_secure_storage_windows/windows/test/flutter_secure_storage_windows_plugin_test.cpp new file mode 100644 index 00000000..d2916261 --- /dev/null +++ b/flutter_secure_storage_windows/windows/test/flutter_secure_storage_windows_plugin_test.cpp @@ -0,0 +1,148 @@ +#include +#include +#include +#include + +#include +#include +#include + +#include "flutter_secure_storage_windows_plugin.h" + +namespace flutter_secure_storage_windows { +namespace test { + +using flutter::EncodableMap; +using flutter::EncodableValue; +using flutter::MethodCall; +using flutter::MethodResultFunctions; + +// --------------------------------------------------------------------------- +// Helpers +// --------------------------------------------------------------------------- + +// Invoke HandleMethodCall and return true on success, false on error / not- +// implemented. Optionally captures the success value via |out|. +static bool Invoke( + FlutterSecureStorageWindowsPlugin& plugin, + const std::string& method, + EncodableMap args, + EncodableValue* out = nullptr) { + bool succeeded = false; + plugin.HandleMethodCall( + MethodCall(method, std::make_unique(std::move(args))), + std::make_unique>( + [&succeeded, out](const EncodableValue* result) { + succeeded = true; + if (out && result) *out = *result; + }, + /*on_error=*/nullptr, + /*on_not_implemented=*/nullptr)); + return succeeded; +} + +static bool Write(FlutterSecureStorageWindowsPlugin& plugin, + const std::string& key, const std::string& value) { + return Invoke(plugin, "write", + {{EncodableValue("key"), EncodableValue(key)}, + {EncodableValue("value"), EncodableValue(value)}}); +} + +static std::optional Read(FlutterSecureStorageWindowsPlugin& plugin, + const std::string& key) { + EncodableValue out; + if (!Invoke(plugin, "read", {{EncodableValue("key"), EncodableValue(key)}}, + &out)) + return std::nullopt; + if (std::holds_alternative(out)) + return std::get(out); + return std::nullopt; // null result == key not present +} + +static bool ContainsKey(FlutterSecureStorageWindowsPlugin& plugin, + const std::string& key) { + EncodableValue out; + Invoke(plugin, "containsKey", + {{EncodableValue("key"), EncodableValue(key)}}, &out); + return std::holds_alternative(out) && std::get(out); +} + +static bool Delete(FlutterSecureStorageWindowsPlugin& plugin, + const std::string& key) { + return Invoke(plugin, "delete", + {{EncodableValue("key"), EncodableValue(key)}}); +} + +static bool DeleteAll(FlutterSecureStorageWindowsPlugin& plugin) { + return Invoke(plugin, "deleteAll", {}); +} + +// --------------------------------------------------------------------------- +// Tests +// --------------------------------------------------------------------------- + +class FlutterSecureStorageWindowsPluginTest : public ::testing::Test { + protected: + void SetUp() override { DeleteAll(plugin_); } + void TearDown() override { DeleteAll(plugin_); } + + FlutterSecureStorageWindowsPlugin plugin_; +}; + +TEST_F(FlutterSecureStorageWindowsPluginTest, WriteAndReadRoundTrip) { + ASSERT_TRUE(Write(plugin_, "key1", "value1")); + EXPECT_EQ(Read(plugin_, "key1"), "value1"); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, ReadMissingKeyReturnsNullopt) { + EXPECT_EQ(Read(plugin_, "nonexistent"), std::nullopt); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, OverwriteReturnsNewValue) { + Write(plugin_, "k", "first"); + Write(plugin_, "k", "second"); + EXPECT_EQ(Read(plugin_, "k"), "second"); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, ContainsKeyTrueAfterWrite) { + Write(plugin_, "k", "v"); + EXPECT_TRUE(ContainsKey(plugin_, "k")); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, ContainsKeyFalseForMissing) { + EXPECT_FALSE(ContainsKey(plugin_, "nonexistent")); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, DeleteRemovesKey) { + Write(plugin_, "k", "v"); + ASSERT_TRUE(ContainsKey(plugin_, "k")); + Delete(plugin_, "k"); + EXPECT_FALSE(ContainsKey(plugin_, "k")); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, DeleteNonexistentIsNoOp) { + EXPECT_TRUE(Delete(plugin_, "never_written")); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, DeleteAllClearsAllKeys) { + Write(plugin_, "a", "1"); + Write(plugin_, "b", "2"); + DeleteAll(plugin_); + EXPECT_FALSE(ContainsKey(plugin_, "a")); + EXPECT_FALSE(ContainsKey(plugin_, "b")); +} + +TEST_F(FlutterSecureStorageWindowsPluginTest, UnknownMethodReturnsNotImplemented) { + bool not_implemented_called = false; + plugin_.HandleMethodCall( + MethodCall("unknownMethod", + std::make_unique(EncodableMap{})), + std::make_unique>( + /*on_success=*/nullptr, + /*on_error=*/nullptr, + [¬_implemented_called]() { not_implemented_called = true; })); + EXPECT_TRUE(not_implemented_called); +} + +} // namespace test +} // namespace flutter_secure_storage_windows diff --git a/melos.yaml b/melos.yaml index d3530370..318265df 100644 --- a/melos.yaml +++ b/melos.yaml @@ -9,7 +9,6 @@ packages: - flutter_secure_storage_platform_interface - flutter_secure_storage_web - flutter_secure_storage_windows - - flutter_secure_storage_windows/example command: version: