Merge pull request wix#2421 from wix/DeviceOrientation

Fail tests in cases where setting device orientation is not supported
dani-mp · Oct 18, 2020 · 72060b7 · 72060b7
2 parents 1c5f6a2 + 91a2027
commit 72060b7
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/detox/ios/Detox/Actions/UIDevice+DetoxActions.m b/detox/ios/Detox/Actions/UIDevice+DetoxActions.m
@@ -15,6 +15,7 @@ @implementation UIDevice (DetoxActions)
 + (void)dtx_setOrientation:(UIDeviceOrientation)deviceOrientation
 {
 	NSParameterAssert(NSThread.isMainThread);
+	DTXAssert(UIDevice.currentDevice.userInterfaceIdiom == UIUserInterfaceIdiomPhone || [[NSBundle.mainBundle objectForInfoDictionaryKey:@"UIRequiresFullScreen"] boolValue] == YES, @"Setting device orientation is only supported for iPhone devices, or for apps declared as requiring full screen on iPad.");
 	[[UIDevice currentDevice] setOrientation:deviceOrientation animated:YES];
 }
 

diff --git a/detox/test/ios/example.xcodeproj/project.pbxproj b/detox/test/ios/example.xcodeproj/project.pbxproj
@@ -577,6 +577,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = "com.wix.detox-example";
 				PRODUCT_NAME = example;
+				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
 		};
@@ -605,6 +606,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = "com.wix.detox-example";
 				PRODUCT_NAME = example;
+				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;
 		};

diff --git a/detox/test/ios/example/Info.plist b/detox/test/ios/example/Info.plist
@@ -55,11 +55,14 @@
 	<array>
 		<string>armv7</string>
 	</array>
+	<key>UIRequiresFullScreen</key>
+	<true/>
 	<key>UISupportedInterfaceOrientations</key>
 	<array>
 		<string>UIInterfaceOrientationPortrait</string>
 		<string>UIInterfaceOrientationLandscapeLeft</string>
 		<string>UIInterfaceOrientationLandscapeRight</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
 	</array>
 	<key>UIViewControllerBasedStatusBarAppearance</key>
 	<true/>

diff --git a/docs/APIRef.DeviceObjectAPI.md b/docs/APIRef.DeviceObjectAPI.md
@@ -279,9 +279,12 @@ Read more in [Mocking User Activity](APIRef.MockingUserActivity.md) section.
 Check out Detox's [own test suite](../detox/test/e2e/18.user-activities.test.js)
 
 ### `device.setOrientation(orientation)`
+
 Takes `"portrait"` or `"landscape"` and rotates the device to the given orientation.
-Currently only available in the iOS Simulator.
-Check out Detox's [own test suite](../detox/test/e2e/06.device-orientation.test.js)
+
+**Note:** Setting device orientation is only supported for iPhone devices, or for apps declared as requiring full screen on iPad. For all other cases, the current test will be failed.
+
+Check out Detox's [own test suite.](../detox/test/e2e/06.device-orientation.test.js)
 
 ### `device.setLocation(lat, lon)`
 >Note: `setLocation` is dependent on `fbsimctl`. if `fbsimctl` is not installed, the command will fail, asking for it to be installed.