This repository was archived by the owner on Feb 22, 2023. It is now read-only.

[image_picker] Set up XCUITests #3254

Merged

cyanglaz merged 7 commits into flutter:master from cyanglaz:image_picker_uitests

Nov 9, 2020

Contributor

cyanglaz commented Nov 6, 2020 •

edited

Loading

Description

Set up the XCUITests harness for image picker plugin

Related Issues

Help with flutter/flutter#65995 (This is not a fix, this only sets up tests so it is easier to write tests when fixing the issue)

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
No, this is not a breaking change.

Chris Yang added 2 commits

November 6, 2020 13:33


          setup xcuitests

b2bf3c8


          unskip image picker

480e86c

google-cla bot added the cla: yes label

cyanglaz requested review from jmagman and amirh

November 6, 2020 21:39


          format

f0ab4d5

amirh reviewed

View reviewed changes

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* aImage = self.app.scrollViews.firstMatch.images.firstMatch;
+                XCUIElement* allPhotosCell = [self.app.cells
+                    elementMatchingPredicate:[NSPredicate predicateWithFormat:@"label == %@", @"All Photos"]];
+                XCUIElement* firstExist = [RunnerUITestUtils waitForFirstExistence:@[ aImage, allPhotosCell ]

Contributor

amirh Nov 6, 2020

The waitForFirstExistence function worries me a little bit as it is non deterministic, and performing a busy-wait.
What do you think about checking for the OS version here, and use it to determine if we need to wait for the allPhotosCell?

Contributor Author

cyanglaz Nov 9, 2020

done

jmagman approved these changes

View reviewed changes

Member

jmagman left a comment

LGTM with nits

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* aImage = self.app.scrollViews.firstMatch.images.firstMatch;
+                XCUIElement* allPhotosCell = [self.app.cells
+                    elementMatchingPredicate:[NSPredicate predicateWithFormat:@"label == %@", @"All Photos"]];
+                XCUIElement* firstExist = [RunnerUITestUtils waitForFirstExistence:@[ aImage, allPhotosCell ]

Member

jmagman Nov 6, 2020

This feels heavy (and the check should probably be scheduled on a runloop instead of the while). Can you instead check if (@available(iOS 14.0, *)) directly?

Member

jmagman Nov 6, 2020

Ha, ditto what @amirh said, didn't see his comment until I submitted.

Contributor Author

cyanglaz Nov 9, 2020

done

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCTAssertTrue(pickButton.exists);
+                [pickButton tap];
+                // Find an image and tap on it. (IOS 14 UI, images are showing direclty)

Member

jmagman Nov 6, 2020

directly

Contributor Author

cyanglaz Nov 9, 2020

done

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* pickButton = [self.app.buttons elementMatchingPredicate:predicateToFindPickButton];
+                if (![pickButton waitForExistenceWithTimeout:30]) {
+                  NSLog(@"%@", self.app.debugDescription);
+                  XCTFail(@"Failed due to not able to find pick button with %@ seconds", @(30));

Member

jmagman Nov 6, 2020

If you're going to hard code it anyway, can do @"Failed due to not able to find pick button with 30 seconds". Or format as an int. Don't need the NSNumber here but if you do use it, number literals don't need the parentheses, @30.

Contributor Author

cyanglaz Nov 9, 2020

done

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* imageFromGalleryButton =
+                    [self.app.otherElements elementMatchingPredicate:predicateToFindImageFromGalleryButton];
+                if (![imageFromGalleryButton waitForExistenceWithTimeout:30]) {
+                  NSLog(@"%@", self.app.debugDescription);

Member

jmagman Nov 6, 2020

NSLog is soft deprecated, should prefer os_log.

Contributor Author

cyanglaz Nov 9, 2020

done

Chris Yang added 3 commits

November 9, 2020 08:56


          reviews

6dfc471


          format

ca96ae1


          remove deleted file from xcodeproj

616911b

cyanglaz commented

View reviewed changes

Contributor Author

cyanglaz left a comment

@amirh @jmagman Thanks for the quick review! Updated per comments. PTAL

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* imageFromGalleryButton =
+                    [self.app.otherElements elementMatchingPredicate:predicateToFindImageFromGalleryButton];
+                if (![imageFromGalleryButton waitForExistenceWithTimeout:30]) {
+                  NSLog(@"%@", self.app.debugDescription);

Contributor Author

cyanglaz Nov 9, 2020

done

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* pickButton = [self.app.buttons elementMatchingPredicate:predicateToFindPickButton];
+                if (![pickButton waitForExistenceWithTimeout:30]) {
+                  NSLog(@"%@", self.app.debugDescription);
+                  XCTFail(@"Failed due to not able to find pick button with %@ seconds", @(30));

Contributor Author

cyanglaz Nov 9, 2020

done

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCTAssertTrue(pickButton.exists);
+                [pickButton tap];
+                // Find an image and tap on it. (IOS 14 UI, images are showing direclty)

Contributor Author

cyanglaz Nov 9, 2020

done

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* aImage = self.app.scrollViews.firstMatch.images.firstMatch;
+                XCUIElement* allPhotosCell = [self.app.cells
+                    elementMatchingPredicate:[NSPredicate predicateWithFormat:@"label == %@", @"All Photos"]];
+                XCUIElement* firstExist = [RunnerUITestUtils waitForFirstExistence:@[ aImage, allPhotosCell ]

Contributor Author

cyanglaz Nov 9, 2020

done

packages/image_picker/image_picker/example/ios/RunnerUITests/ImagePickerFromGalleryUITests.m Outdated

+                XCUIElement* aImage = self.app.scrollViews.firstMatch.images.firstMatch;
+                XCUIElement* allPhotosCell = [self.app.cells
+                    elementMatchingPredicate:[NSPredicate predicateWithFormat:@"label == %@", @"All Photos"]];
+                XCUIElement* firstExist = [RunnerUITestUtils waitForFirstExistence:@[ aImage, allPhotosCell ]

Contributor Author

cyanglaz Nov 9, 2020

done


          remove unused imports

1342b54

cyanglaz mentioned this pull request

[google_maps_flutter] My location button and my location fixes #1809

Closed

13 tasks

jmagman approved these changes

View reviewed changes

Member

jmagman left a comment

LGTM

amirh approved these changes

View reviewed changes

Contributor

amirh left a comment

LGTM

cyanglaz merged commit 4e8f8ed into flutter:master

cyanglaz deleted the image_picker_uitests branch

November 9, 2020 21:01

jmagman reviewed

View reviewed changes

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -13,6 +13,7 @@ @@
               		680049272280D79A006DD6AB /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FD1CF9000F007C117D /* Assets.xcassets */; };
               		680049382280F2B9006DD6AB /* pngImage.png in Resources */ = {isa = PBXBuildFile; fileRef = 680049352280F2B8006DD6AB /* pngImage.png */; };
               		680049392280F2B9006DD6AB /* jpgImage.jpg in Resources */ = {isa = PBXBuildFile; fileRef = 680049362280F2B8006DD6AB /* jpgImage.jpg */; };
+C8392555D726009DAF8D /* ImagePickerFromGalleryUITests.m in Sources */ = {isa = PBXBuildFile; fileRef = 6801C8382555D726009DAF8D /* ImagePickerFromGalleryUITests.m */; };

Member

jmagman Nov 9, 2020

@amirh This is the new test file that Chris added. If Xcode doesn't know about it, then xcodebuild test won't run it.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -34,6 +35,13 @@ @@
               			remoteGlobalIDString = 97C146ED1CF9000F007C117D;
               			remoteInfo = Runner;
               		};
+C83B2555D726009DAF8D /* PBXContainerItemProxy */ = {

Member

jmagman Nov 9, 2020

This is the new test target. This grouping tells Xcode what kind of tests they are (UI tests in this case) so it knows how to run them.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -60,6 +68,9 @@ @@
               		680049352280F2B8006DD6AB /* pngImage.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = pngImage.png; sourceTree = "<group>"; };
               		680049362280F2B8006DD6AB /* jpgImage.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = jpgImage.jpg; sourceTree = "<group>"; };
               		6801632E632668F4349764C9 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = "<group>"; };
+C8362555D726009DAF8D /* RunnerUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };

Member

jmagman Nov 9, 2020

This is the location the test xctest product bundle will be built, so the binaries where the tests are compiled into.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -60,6 +68,9 @@ @@
               		680049352280F2B8006DD6AB /* pngImage.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = pngImage.png; sourceTree = "<group>"; };
               		680049362280F2B8006DD6AB /* jpgImage.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = jpgImage.jpg; sourceTree = "<group>"; };
               		6801632E632668F4349764C9 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = "<group>"; };
+C8362555D726009DAF8D /* RunnerUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
+C8382555D726009DAF8D /* ImagePickerFromGalleryUITests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ImagePickerFromGalleryUITests.m; sourceTree = "<group>"; };

Member

jmagman Nov 9, 2020

This is the new test file that was explicitly added.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -60,6 +68,9 @@ @@
               		680049352280F2B8006DD6AB /* pngImage.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = pngImage.png; sourceTree = "<group>"; };
               		680049362280F2B8006DD6AB /* jpgImage.jpg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = jpgImage.jpg; sourceTree = "<group>"; };
               		6801632E632668F4349764C9 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = "<group>"; };
+C8362555D726009DAF8D /* RunnerUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
+C8382555D726009DAF8D /* ImagePickerFromGalleryUITests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ImagePickerFromGalleryUITests.m; sourceTree = "<group>"; };
+C83A2555D726009DAF8D /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };

Member

jmagman Nov 9, 2020

This is the Info.plist file that was also explicitly added. It contains metadata about the bundle, and is required for most bundle types (apps, frameworks, extensions etc)

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -389,6 +449,14 @@ @@
               			);
               			runOnlyForDeploymentPostprocessing = 0;
               		};
+C8322555D726009DAF8D /* Sources */ = {

Member

jmagman Nov 9, 2020

This is the Sources build phase that says which files should be compiled into the xctest bundle. So ImagePickerFromGalleryUITests in this case.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -407,6 +475,11 @@ @@
               			target = 97C146ED1CF9000F007C117D /* Runner */;
               			targetProxy = 6800491C2280D368006DD6AB /* PBXContainerItemProxy */;
               		};
+C83C2555D726009DAF8D /* PBXTargetDependency */ = {

Member

jmagman Nov 9, 2020

This says that the test target depends on the Runner (app) target, so Runner needs to be built first.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -480,9 +553,55 @@ @@
               			};
               			name = Release;
               		};
+C83D2555D726009DAF8D /* Debug */ = {

Member

jmagman Nov 9, 2020

These are the Debug build configuration build settings, and it looks like it's all the defaults Xcode uses for new targets. The CLANG_ GCC_C_ and MTL_ ones can be removed since they would be inherited from the overall project settings. But most people just let Xcode set the overrides it wants and don't touch it.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

+              			};
+              			name = Debug;
+              		};
+C83E2555D726009DAF8D /* Release */ = {

Member

jmagman Nov 9, 2020

Ditto but for the Release build configuration build settings.

packages/image_picker/image_picker/example/ios/Runner.xcodeproj/project.pbxproj

@@ @@ -644,6 +762,15 @@ @@
               			defaultConfigurationIsVisible = 0;
               			defaultConfigurationName = Release;
               		};
+C83F2555D726009DAF8D /* Build configuration list for PBXNativeTarget "RunnerUITests" */ = {

Member

jmagman Nov 9, 2020

This the hook for setting build configuration settings for the new test target (like a base xcconfig file)

cyanglaz mentioned this pull request

[image_picker] optionally disable PHAsset & iOS permission request #3090

Closed

13 tasks

fesp pushed a commit to fesp/plugins that referenced this pull request


          [image_picker] Set up XCUITests (flutter#3254)

2c58077

FlutterSu pushed a commit to FlutterSu/flutter-plugins that referenced this pull request


          [image_picker] Set up XCUITests (flutter#3254)

1b63b5f

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels