使用BDD(Cucumber)+Jetpack Compose做UI测试时遇初始化错误

问题根源 #

Cucumber的Android测试运行器与JUnit4的@Rule机制不兼容，直接在步骤类中声明ComposeTestRule无法被Cucumber正确初始化，导致Compose测试环境未就绪，触发Test not setup properly错误。

解决方案 #

1. 调整测试运行器配置 #

将原步骤类的@RunWith(AndroidJUnit4::class)替换为Cucumber专属运行器，并配置测试参数：

@RunWith(Cucumber::class)
@CucumberOptions(
    features = ["features/login.feature"], // 指向你的feature文件路径
    glue = ["uk.co.topcashback.topcashback.qa.steps.login"], // 步骤类所在包
    plugin = ["pretty"]
)
class LoginCucumberTest {
    // 此处无需声明Rule，步骤逻辑单独放在LoginSteps类中
}

2. 在步骤类中通过Cucumber钩子初始化ComposeTestRule #

修改步骤类，使用Cucumber的@Before钩子手动初始化Compose测试规则，替代JUnit的@Rule注解：

class LoginSteps {
    private lateinit var composeTestRule: AndroidComposeTestRule<MainActivity>

    @Before
    fun setUp() {
        composeTestRule = createAndroidComposeRule<MainActivity>()
        // 若需要直接加载Compose界面，可在此处调用setContent
        // composeTestRule.setContent { YourLoginScreen() }
    }

    @Given("^I am on the signup page$")
    fun I_am_on_the_signup_page() {
        composeTestRule.waitForIdle() // 等待界面完全加载
        composeTestRule.onNodeWithTag("logo").assertIsDisplayed()
    }

    @When("^I click the login button$")
    fun when_I_click_login() {
        composeTestRule.onNodeWithTag("loginBtn").assertIsDisplayed().performClick()
    }

    @Then("^I should see the login page$")
    fun See_the_Sign_in_page() {
        composeTestRule.onNodeWithTag("LoginWelcomemsg").assertIsDisplayed()
    }
}

3. 验证Gradle依赖与配置 #

确保app模块的build.gradle.kts（或build.gradle）包含以下必要配置：

android {
    defaultConfig {
        testInstrumentationRunner "com.yourpackage.CucumberAndroidJUnitRunner"
    }

    sourceSets {
        androidTest {
            assets.srcDirs += files("src/androidTest/assets/features") // 确保feature文件被识别
        }
    }
}

dependencies {
    // Cucumber Android依赖
    androidTestImplementation "io.cucumber:cucumber-android:7.14.0"
    androidTestImplementation "io.cucumber:cucumber-junit:7.14.0"

    // Jetpack Compose测试依赖
    androidTestImplementation "androidx.compose.ui:ui-test-junit4:1.5.4"
    debugImplementation "androidx.compose.ui:ui-test-manifest:1.5.4"
}

4. 自定义Cucumber测试运行器（可选） #

若上述配置仍有问题，可自定义测试运行器确保JUnit规则兼容：

class CucumberAndroidJUnitRunner : AndroidJUnitRunner() {
    override fun newApplication(
        cl: ClassLoader?,
        className: String?,
        context: Context?
    ): Application {
        return super.newApplication(cl, "androidx.test.core.app.ApplicationProvider", context)
    }
}

关键注意事项 #

• 不要在步骤类中同时混用Cucumber和JUnit4的@RunWith注解，两者生命周期不兼容
• 必须通过Cucumber的@Before钩子初始化ComposeTestRule，而非JUnit的@get:Rule
• 执行断言前调用composeTestRule.waitForIdle()，确保Compose界面完全渲染完成

内容的提问来源于stack exchange，提问作者sri Natarajan