\n The annotation syntax is perfect for simple tests where the device remains in the same state for the entire test. The annotations help keep the test code readable and expressive while enabling you to target specific postures and foldable device states.\n<\/p>\n
\n Test Kit annotations work on any foldable device that supports Jetpack Window Manager, including Surface Duo.\n<\/p>\n
\n ![\"Example](\"https:\/\/devblogs.microsoft.com\/surface-duo\/wp-content\/uploads\/sites\/53\/2022\/08\/text-description-automatically-generated.png\")
\n<\/p>\n
Figure 1: Android Studio screenshot showing simple tests that detect the correct text label is showing based on the device orientation set via an annotation <\/em>\n<\/p>\n \n If you need to test complex app flows including changing the device state during the test<\/em>, you should simulate a folding feature or use swipe gestures<\/a> in code, which is also covered in our Test Kit documentation<\/a>.\n<\/p>\n \n The Test Kit components are available on Maven Central. To write tests with the annotations feature, include the dependencies that match your layout preferences (Views or Jetpack Compose) to your app\u2019s build.gradle<\/strong> file:\n<\/p>\n Views<\/strong>\n<\/p>\n Jetpack Compose<\/strong>\n<\/p>\n \n The core for these annotations is two utility classes: \n \n \n This section shows which annotations can be used for different test cases.\n<\/p>\n \n If you want to run tests in single-screen or dual-screen mode, you should use the \n You can use these annotations either at the test class level or test method level, but not both at the same time. You can find more about these annotations here: @SingleScreenTest\/@DualScreenTest<\/a>\n<\/p>\n \n If you want to run tests on specific target devices, you must use \n In this sample, all the methods from TestSample class will run only on Surface Duo devices. You can use this annotation also at the test method level, but not in both places at the same time.\n<\/p>\n \n If you want to ignore some devices, you can use it like this:\n<\/p>\n \n You can find more about this annotation here: @TargetDevices<\/a>\n<\/p>\n \n You can run tests in a specific device orientation with the @DeviceOrientation annotation, or if you want also to run it on a single-screen or dual-screen posture, you can use \n If you want to run tests with a simulated folding feature, you should use \n To make it easier to understand how to use Test Kit annotations, we added a new SDK sample<\/a> to our Views library. We’ve also updated our Compose samples<\/a> to use the new annotations in UI tests.\n <\/p>\n \n To see examples of how to use each specific annotation, check out the links below:\n<\/p>\nHow to add Test Kit to your project <\/h2>\n
androidTestImplementation \"com.microsoft.device.dualscreen.testing:testing-kotlin:1.0.0-alpha4\"\r\n androidTestImplementation \"androidx.test.uiautomator:uiautomator:2.2.0\"\r\n androidTestImplementation \"androidx.test.espresso:espresso-core:3.4.0\"\r\n androidTestImplementation \"androidx.test:runner:1.4.0\"\r\n androidTestImplementation \"androidx.test:rules:1.4.0\"<\/pre>\n
androidTestImplementation \"com.microsoft.device.dualscreen.testing:testing-compose:1.0.0-alpha04\"\r\n androidTestImplementation \"androidx.test.uiautomator:uiautomator:2.2.0\"\r\n androidTestImplementation \"androidx.compose.ui:ui-test-junit4:1.1.1\"<\/pre>\n
How it works<\/h3>\n<\/p>\n
FoldableTestRule<\/code> and FoldableJunit4ClassRunner<\/code>.\n<\/p>\nFoldableTestRule<\/code> is a custom TestRule that must be used together with Test Kit annotations (@SingleScreenTest<\/code>, @DualScreenTest<\/code>, @MockFoldingFeature<\/code> and @DeviceOrientation<\/code>). Without this rule, the annotations have no effect.\n<\/p>\nFoldableJUnit4ClassRunner<\/code> is a custom AndroidJunit4ClassRunner that validates the parameters for Test Kit annotations, and it is recommended to always use it to make the tests run as intended.\n<\/p>\nUsage scenarios<\/h2>\n
Test in single- or dual-screen mode<\/h3>\n
@SingleScreenTest<\/code> or @DualScreenTest<\/code> annotation together with FoldableTestRule and FoldableJUnit4ClassRunner as shown in the following example:\n<\/p>\n @RunWith(FoldableJUnit4ClassRunner::class)\r\n class TestSample {\r\n private val activityScenarioRule = activityScenarioRule<MainActivity>()\r\n private val foldableTestRule = FoldableTestRule()\r\n \r\n @get:Rule\r\n val testRule: TestRule = foldableRuleChain(activityScenarioRule, foldableTestRule)\r\n \r\n @Test\r\n @DualScreenTest\r\n fun sampleTestMethod() {\r\n }\r\n }<\/pre>\nTest on a specific device<\/h2>\n
@TargetDevices<\/code> annotation with the desired devices provided by the devices<\/code> parameter. You can also skip some devices with this annotation using the ignoreDevices<\/code> parameter, like in the following example:\n<\/p>\n @RunWith(FoldableJUnit4ClassRunner::class)\r\n @TargetDevices(devices = [DeviceModel.SurfaceDuo])\r\n class TestSample {\r\n private val activityScenarioRule = activityScenarioRule<MainActivity>()\r\n private val foldableTestRule = FoldableTestRule()\r\n \r\n @get:Rule\r\n val testRule: TestRule = foldableRuleChain(activityScenarioRule, foldableTestRule)\r\n \r\n @Test\r\n fun sampleTestMethod() { \/\/ test will ONLY run on Surface Duo devices\r\n }\r\n }<\/pre>\n @RunWith(FoldableJUnit4ClassRunner::class)\r\n @TargetDevices(ignoreDevices = [DeviceModel.SurfaceDuo])\r\n class TestSample {\r\n private val activityScenarioRule = activityScenarioRule<MainActivity>()\r\n private val foldableTestRule = FoldableTestRule()\r\n \r\n @get:Rule\r\n val testRule: TestRule = foldableRuleChain(activityScenarioRule, foldableTestRule)\r\n \r\n @Test\r\n fun sampleTestMethod() { \/\/ test will NOT run on Surface Duo devices\r\n }\r\n }<\/pre>\nTest a specific orientation<\/h3>\n
@SingleScreenTest<\/code> or @DualScreenTest<\/code> with the deviceOrientation<\/code> parameter, like this:\n<\/p>\n @RunWith(FoldableJUnit4ClassRunner::class)\r\n @DeviceOrientation(orientation = UiAutomation.ROTATION_FREEZE_180)\r\n class TestSample {\r\n private val activityScenarioRule = activityScenarioRule<MainActivity>()\r\n private val foldableTestRule = FoldableTestRule()\r\n \r\n @get:Rule\r\n val testRule: TestRule = foldableRuleChain(activityScenarioRule, foldableTestRule)\r\n \r\n @Test\r\n fun sampleTestMethod() { \/\/ test is run at 180 degree rotation\r\n }\r\n }<\/pre>\n<\/p>\n @RunWith(FoldableJUnit4ClassRunner::class)\r\n @SingleScreenTest(orientation = UiAutomation.ROTATION_FREEZE_180)\r\n class TestSample {\r\n private val activityScenarioRule = activityScenarioRule<MainActivity>()\r\n private val foldableTestRule = FoldableTestRule()\r\n \r\n @get:Rule\r\n val testRule: TestRule = foldableRuleChain(activityScenarioRule, foldableTestRule)\r\n \r\n @Test\r\n fun sampleTestMethod() { \/\/ test is run at 180 degree rotation\r\n }\r\n }<\/pre>\nTest with a simulated folding feature<\/h3>\n
@MockFoldingFeature<\/code> and provide the windowBounds, center, size, state, or orientation parameter. None of these parameters is required because they have default values, but you can find more info about them here: @MockFoldingFeature<\/a>\n<\/p>\n @RunWith(FoldableJUnit4ClassRunner::class)\r\n @MockFoldingFeature(\r\n size = 2, \r\n state = FoldingFeatureState.FLAT, \r\n orientation = FoldingFeatureOrientation.HORIZONTAL\r\n )\r\n class TestSample {\r\n private val activityScenarioRule = activityScenarioRule<MainActivity>()\r\n private val foldableTestRule = FoldableTestRule()\r\n \r\n @get:Rule\r\n val testRule: TestRule = foldableRuleChain(activityScenarioRule, foldableTestRule)\r\n \r\n @Test\r\n fun sampleTestMethod() { \/\/ test is run with custom folding feature configuration\r\n }\r\n }<\/pre>\n\n Samples\n<\/h2>\n