-
Notifications
You must be signed in to change notification settings - Fork 3.3k
[path_provider] added android support for getDownloadsDirectory #4317
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ name: path_provider_android | |
description: Android implementation of the path_provider plugin. | ||
repository: https://github.com/flutter/packages/tree/main/packages/path_provider/path_provider_android | ||
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+path_provider%22 | ||
version: 2.0.27 | ||
version: 2.0.28 | ||
|
||
environment: | ||
sdk: ">=2.18.0 <4.0.0" | ||
|
@@ -23,9 +23,11 @@ dependencies: | |
path_provider_platform_interface: ^2.0.1 | ||
|
||
dev_dependencies: | ||
build_runner: ^2.3.2 | ||
flutter_test: | ||
sdk: flutter | ||
integration_test: | ||
sdk: flutter | ||
mockito: 5.4.1 | ||
pigeon: ^9.2.4 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @stuartmorgan I assume these should be removed before being merged? |
||
test: ^1.16.0 |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,10 +3,13 @@ | |
// found in the LICENSE file. | ||
|
||
import 'package:flutter_test/flutter_test.dart'; | ||
import 'package:mockito/annotations.dart'; | ||
import 'package:mockito/mockito.dart'; | ||
import 'package:path_provider_android/messages.g.dart' as messages; | ||
import 'package:path_provider_android/path_provider_android.dart'; | ||
import 'package:path_provider_platform_interface/path_provider_platform_interface.dart'; | ||
import 'messages_test.g.dart'; | ||
import 'path_provider_android_test.mocks.dart'; | ||
|
||
const String kTemporaryPath = 'temporaryPath'; | ||
const String kApplicationSupportPath = 'applicationSupportPath'; | ||
|
@@ -37,14 +40,17 @@ class _Api implements TestPathProviderApi { | |
String? getTemporaryPath() => kTemporaryPath; | ||
} | ||
|
||
@GenerateMocks(<Type>[TestPathProviderApi]) | ||
void main() { | ||
TestWidgetsFlutterBinding.ensureInitialized(); | ||
|
||
group('PathProviderAndroid', () { | ||
late MockTestPathProviderApi mockApi; | ||
late PathProviderAndroid pathProvider; | ||
|
||
setUp(() async { | ||
pathProvider = PathProviderAndroid(); | ||
mockApi = MockTestPathProviderApi(); | ||
TestPathProviderApi.setup(_Api()); | ||
}); | ||
|
||
|
@@ -89,13 +95,20 @@ void main() { | |
}); | ||
} // end of for-loop | ||
|
||
test('getDownloadsPath fails', () async { | ||
try { | ||
await pathProvider.getDownloadsPath(); | ||
fail('should throw UnsupportedError'); | ||
} catch (e) { | ||
expect(e, isUnsupportedError); | ||
} | ||
test('getDownloadsPath succeeds', () async { | ||
when(mockApi.getExternalStoragePaths(messages.StorageDirectory.downloads)) | ||
.thenReturn(<String?>[kDownloadsPath]); | ||
final List<String?> path = | ||
mockApi.getExternalStoragePaths(messages.StorageDirectory.downloads); | ||
expect(path.first, kDownloadsPath); | ||
}); | ||
|
||
test('getDownloadsPath null', () async { | ||
when(mockApi.getExternalStoragePaths(messages.StorageDirectory.downloads)) | ||
.thenReturn(<String?>[null]); | ||
final List<String?> path = | ||
mockApi.getExternalStoragePaths(messages.StorageDirectory.downloads); | ||
expect(path.first, null); | ||
}); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can check this one if its going in the right direction? I'm trying to add a case for the null externalStoragePaths, but if I override it to empty list then it will affect other tests There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You'll either have to modify There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've updated the null test There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This approach seems okay to me but perhaps you can move this test to a different group and set up the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry, I had an answer to the original question that I didn't realize I'd never actually published, and was still There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've updated the getDownloads test to use mockito, so we can configure values for normal path and null path There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe Stuart was suggesting making There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I was suggesting making the values returned by I'm okay with |
||
}); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
// Mocks generated by Mockito 5.4.1 from annotations | ||
// in path_provider_android/test/path_provider_android_test.dart. | ||
// Do not manually edit this file. | ||
|
||
// @dart=2.19 | ||
|
||
// ignore_for_file: no_leading_underscores_for_library_prefixes | ||
import 'package:mockito/mockito.dart' as _i1; | ||
import 'package:path_provider_android/messages.g.dart' as _i3; | ||
|
||
import 'messages_test.g.dart' as _i2; | ||
|
||
// ignore_for_file: type=lint | ||
// ignore_for_file: avoid_redundant_argument_values | ||
// ignore_for_file: avoid_setters_without_getters | ||
// ignore_for_file: comment_references | ||
// ignore_for_file: implementation_imports | ||
// ignore_for_file: invalid_use_of_visible_for_testing_member | ||
// ignore_for_file: prefer_const_constructors | ||
// ignore_for_file: unnecessary_parenthesis | ||
// ignore_for_file: camel_case_types | ||
// ignore_for_file: subtype_of_sealed_class | ||
|
||
/// A class which mocks [TestPathProviderApi]. | ||
/// | ||
/// See the documentation for Mockito's code generation for more information. | ||
class MockTestPathProviderApi extends _i1.Mock | ||
implements _i2.TestPathProviderApi { | ||
MockTestPathProviderApi() { | ||
_i1.throwOnMissingStub(this); | ||
} | ||
|
||
@override | ||
List<String?> getExternalCachePaths() => (super.noSuchMethod( | ||
Invocation.method( | ||
#getExternalCachePaths, | ||
[], | ||
), | ||
returnValue: <String?>[], | ||
) as List<String?>); | ||
@override | ||
List<String?> getExternalStoragePaths(_i3.StorageDirectory? directory) => | ||
(super.noSuchMethod( | ||
Invocation.method( | ||
#getExternalStoragePaths, | ||
[directory], | ||
), | ||
returnValue: <String?>[], | ||
) as List<String?>); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this one I've updated to catch the stateError scenario when externalStoragePaths returns empty list.