Project Icon

Kaspresso

Android UI测试框架,提升Espresso和UI Automator

Kaspresso提供防止测试波动、Jetpack Compose支持和截图测试功能,还能与其他应用和系统元素交互。它使用Kotlin DSL封装提高代码可读性,支持详细日志和报告生成。该框架还支持ADB命令、Robolectric和Allure,并能显著加速UI Automator命令执行。Kaspresso还提供简单的Espresso迁移和灵活的配置选项。

Android Arsenal Android Weekly Android Weekly MavenCentral Build and Deploy Telegram Telegram Discord

Kaspresso

Kaspresso是一个Android UI测试框架。基于EspressoUI Automator,Kaspresso提供了广泛的额外功能,例如:

  • 内置防止不稳定测试的保护
  • Jetpack Compose支持
  • 原生方法的截图测试(支持深色模式)
  • 编写测试的声明式方法
  • 能够与其他应用程序、系统元素和界面交互
  • 通过Kotlin DSL包装UiAutomator和Espresso实现人类可读性
  • 详细的日志和报告(日志、视图层次结构、截图、视频等)
  • ADB支持
  • Allure支持
  • Robolectric支持
  • 从Espresso轻松迁移
  • 灵活的配置选项
  • 测试执行后自动提取产物
  • 显著加快UI Automator命令的执行速度。使用Kaspresso,某些UI Automator命令的运行速度快10倍
  • 开箱即用的页面对象模式

还有更多!

Kaspresso

集成

要将Kaspresso集成到您的项目中:

  1. 如果mavenCentral仓库不存在,请将其包含在您的根build.gradle文件中:
allprojects {
    repositories {
        mavenCentral()
    }
}
  1. build.gradle中添加依赖:
dependencies {
    androidTestImplementation 'com.kaspersky.android-components:kaspresso:<最新版本>'
    // Allure支持
    androidTestImplementation "com.kaspersky.android-components:kaspresso-allure-support:<最新版本>"
    // Jetpack Compose支持
    androidTestImplementation "com.kaspersky.android-components:kaspresso-compose-support:<最新版本>"
}

要在官方发布之前尝试最新的kaspresso更新,请在您的build.gradle中添加快照仓库

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots") }
    }
}

要使用Kaspresso的快照版本,请在最新的Kaspresso版本后添加"-SNAPHOT"后缀,例如

dependencies {
    androidTestImplementation 'com.kaspersky.android-components:kaspresso:<最新版本>-SNAPSHOT'
}

如果您仍在使用旧的Android Support库,我们强烈建议迁移到AndroidX。

使用Android Support库的最后一个版本是:

dependencies {
    androidTestImplementation 'com.kaspersky.android-components:kaspresso:1.5.3'
}

常见问题

请查看我们的网站。 您也可以在Discord上联系我们。

教程

为了更容易学习该框架,我们的网站上提供了一个分步教程我们的网站

Kaspresso的功能

可读性

我们喜欢Kakao用于编写UI测试的语法。这个Espresso的包装器使用Kotlin DSL方法,使代码显著缩短并更易读。看看区别:

Espresso:

@Test
fun testFirstFeature() {
    onView(withId(R.id.toFirstFeature))
        .check(ViewAssertions.matches(
               ViewMatchers.withEffectiveVisibility(
                       ViewMatchers.Visibility.VISIBLE)))
    onView(withId(R.id.toFirstFeature)).perform(click())
}

Kakao:

@Test
fun testFirstFeature() {
    mainScreen {
        toFirstFeatureButton {
            isVisible()
            click()
        }
    }
}

我们使用相同的方法开发了我们自己的UI Automator包装器,我们称之为Kautomator。看看下面的代码:

UI Automator:

val instrumentation: Instrumentation = InstrumentationRegistry.getInstrumentation()
val uiDevice = UiDevice.getInstance(instrumentation)
val uiObject = uiDevice.wait(
    Until.findObject(
        By.res(
            "com.kaspersky.kaspresso.sample_kautomator",
            "editText"
        )
    ),
    2_000
)
uiObject.text = "Kaspresso"
assertEquals(uiObject.text, "Kaspresso")

Kautomator:

MainScreen {
    simpleEditText {
        replaceText("Kaspresso")
        hasText("Kaspresso")
    }
}

由于Kakao和Kautomator提供了几乎相同的API,您不必关心测试底层是Espresso还是UI Automator。使用Kaspresso,您可以以相同的风格为两者编写测试。

然而,Kakao和Kautomator本身并不能帮助您看到测试与相应测试用例之间的关系。此外,长测试通常会变成一大段无法拆分成更小部分的代码。 这就是为什么我们创建了一个额外的Kotlin DSL,让您更容易阅读您的测试。

请看下面的示例:

@Test
fun shouldPassOnNoInternetScanTest() =
    beforeTest {
        activityTestRule.launchActivity(null)
        // 一些状态相关的操作
    }.afterTest {
        // 一些状态相关的操作
    }.run {
        step("打开简单界面") {
            MainScreen {
                nextButton {
                    isVisible()
                    click()
                }
            }
        }
        step("点击按钮1并检查按钮2") {
            SimpleScreen {
                button1 {
                    click()
                }
                button2 {
                    isVisible()
                }
            }
        }
        step("点击按钮2并检查编辑框") {
            SimpleScreen {
                button2 {
                    click()
                }
                edit {
                    flakySafely(timeoutMs = 7000) { isVisible() }
                    hasText(R.string.text_edit_text)
                }
            }
        }
        step("检查编辑框的所有可能性") {
            scenario(
                CheckEditScenario()
            )
        }
    }

稳定性

有时你的UI测试可能连续通过十次,但在第十一次尝试时却因某些神秘原因失败。这被称为不稳定性

导致不稳定性最常见的原因是UI测试库(如Espresso和UI Automator)本身的不稳定性。为了消除这种不稳定性,Kaspresso使用了DSL封装和拦截器

UI测试库加速

让我们观看一个简短的视频,展示了原始UI Automator(右侧)与加速后的版本(左侧)之间的差异。

这里有一个简短的解释,说明了为什么这是可能的。

拦截器

我们在Kakao/Kautomator拦截器的基础上开发了Kaspresso行为拦截器来捕获失败。

借助拦截器,你可以做很多有用的事情,比如:

  • 为每个框架操作添加自定义动作,如写日志或截图;
  • 通过重新运行失败的操作、滚动父布局或关闭Android系统对话框来克服不稳定的操作;

以及更多(参见手册)。

编写可读性强的日志

Kaspresso会编写自己的日志,详细且易读:

能够执行ADB命令

Espresso和UI Automator不允许从测试内部调用ADB命令。为了解决这个问题,我们开发了AdbServer(参见wiki)。

能够操作Android系统

你可以使用Kaspresso类来操作Android系统。

例如,使用Device类,你可以:

  • 推送/拉取文件,
  • 启用/禁用网络,
  • 像用户一样授予权限,
  • 模拟电话呼叫,
  • 截屏,
  • 启用/禁用GPS,
  • 设置地理位置,
  • 启用/禁用无障碍功能,
  • 更改应用语言,
  • 收集和解析logcat输出。

(更多信息请参见Device类)。

功能截图

如果你开发的应用在全球范围内可用,你必须将其本地化为不同的语言。当UI被本地化时,译者看到单词或短语的上下文(即特定屏幕)很重要。

使用Kaspresso,译者可以自动截取任何屏幕的截图。这非常快速,即使对于旧屏幕也是如此,而且你不需要重构或模拟任何东西(参见手册)。

可配置性

你可以调整Kaspresso的任何部分(阅读更多信息)。

Robolectric支持

你可以在JVM环境中运行你的UI测试。此外,几乎所有改善稳定性、可读性等的拦截器都将发挥作用。 阅读更多信息

Allure支持

Kaspresso可以为每个测试生成非常详细的Allure报告: 更多信息可在此处获得。

Jetpack Compose支持

现在,你可以为Jetpack Compose屏幕编写Kaspresso测试了!DSL和所有原则都是相同的。 因此,你不会看到View屏幕测试和Compose屏幕测试之间的任何差异。 更多信息可在此处获得。

示例

所有示例都可以在samples文件夹中找到。

大多数示例都需要AdbServer。要启动AdbServer,你应该执行以下步骤:

  1. 进入Kaspresso文件夹
cd ~/Workspace/Kaspresso
  1. 启动adbserver-desktop.jar
java -jar artifacts/adbserver-desktop.jar

现有问题

Kaspresso中的所有现有问题都可以在这里找到。

重大变更

重大变更可以在这里找到

贡献

Kaspresso是一个开源项目,所以欢迎你贡献(参见贡献指南)。

许可证

Kaspresso基于Apache License, Version 2.0提供。

运行器

如果你正在寻找一个执行UI测试的运行器,我们强烈推荐使用MarathonMarathon是一个快速、跨平台的测试运行器,专注于性能和稳定性。它为Android和iOS提供了易于使用的平台实现,以及用于自定义硬件设备组和更多技术栈的API。 Marathon

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号