Skip to content

testing.md

Latest commit

 

History

History
149 lines (104 loc) · 6.31 KB

testing.md

File metadata and controls

149 lines (104 loc) · 6.31 KB

测试

运行 APP 测试

以下各个小节分别说明如何运行各个平台的调试 APP (支持断点) 。最推荐的方式是运行 PC APP，支持热重载。

注意，调试版本的性能远低于发布版本，很多动画都会变迟钝和不流畅，如需测试性能，请使用发布版本。

什么是 Run Configuration (运行配置)

项目自带一些运行配置，方便你运行测试版 APP，可以在 Android Studio 顶部找到：

app.android 就是一个运行配置，使用它即可运行 Android APP (下面有说明)。

Warning

如何编辑一个运行配置

一般来说你不需要修改配置。如果你需要，必须先复制一份再修改：

打开后，将配置复制一份，然后修改复制的配置。因为默认配置是由 Git 管理的，除非有很强的理由， 否则不要修改默认配置。

如何运行 PC APP

PC 版本有三种启动方式：

  • 热重载（推荐）的调试版本：选择配置 Run Desktop (Hot Reload) 点击按钮运行或调试即可。热重载版本会自动检测 IDE 里的代码更新，自动编译并热加载到 APP 中。无需重启即可调试。
  • 普通运行调试版本：选择配置 Run Desktop (Normal) 点击按钮运行或调试即可。此版本没有热重载功能，修改代码后需要手动重启 APP。
  • 运行发布版本：双击 Control，输入 ./gradlew runReleaseDistributable 可运行发布版本。发布版本有激进的优化，运行很快，但会无法调试。

Tip

将 PC 版本窗口调小到手机大小，可以模拟手机的效果。

如何运行调试版本 Android APP

在 Android Studio 或 IntelliJ IDEA 中，选择运行配置 app.android，点击按钮运行或调试即可。

Tip

Android 调试版本 (Debug) 的性能远低于发布版本 (Release)

由于调试版本禁用了一切优化，而且包含 Compose 额外的调试信息，性能会比发布版本低很多。 所有手机都会非常卡。如果你要测试性能，请切换到发布版本。

如何运行 iOS APP

只有 macOS 才能运行 iOS APP。

先在 local.properties 中加入：

ani.enable.ios=true
ani.build.framework=true
  1. 在 App Store 安装 Xcode
  2. 在 Xcode 中打开项目 app/ios/Animeko
  3. 在 Xcode 内运行

在 Android Studio 中，也可以选择运行配置 Run iOS Debug，点击按钮运行即可。

单元测试

Animeko 拥有多平台测试。启用 iOS 目标后，在 macOS 上会运行 11,000+ 测试。其他平台上会略少一些。 我们建议你为所有新功能编写测试，不仅是为了验证功能的正确性，也是为了防止未来出现回溯问题。

测试源集结构

基于多平台架构，Ani 也拥有多平台测试。测试源集结构如下：

  • commonTest
    • jvmTest
      • desktopTest
      • androidDeviceTest
    • nativeTest
      • appleTest
        • iosTest
          • iosSimulatorArm64Test
    • skikoTest (由 desktopTest 和 iosTest 共享)
  • androidHostTest (独立于其他所有测试)

提示：

  • 绝大部分测试可写在 commonTest 里，它们会被所有平台共享，也就是所有平台都会执行这些测试；
  • 对于桌面端专用的测试，应当放置在 jvmTest 或 desktopTest。
  • 对于 iOS 专用的测试，应当放置在 nativeTest 或 appleTest 或 iosTest。对于不依赖 Apple API 的部分，建议放置于 nativeTest；对于依赖 macOS 和 iOS 都存在的 Apple API 的部分，建议放置于 appleTest；对于只能在 iOS 运行的部分，放置于 iosTest。
  • 如果是桌面端和安卓都可以使用的测试，则放置在 jvmTest 中。

Android Instrumented Test

项目拥有 Android Instrumented Test。安卓平台测试有以下两种：

  • androidHostTest：使用本地 JDK 运行的单元测试，无法调用 Android SDK API
  • androidDeviceTest：连接到安卓模拟器或真机运行

Tip

为什么要有两种测试?

因为安卓 SDK 和 JDK 有些许区别。例如:

  • 安卓的 Regex 需要比 JDK 更多的转义。当不成对时，\] 在 JDK 可以去除前面的 \，而在安卓不可以。 IDE 会提示去除 \，导致在安卓真机运行时才能发现问题 (而现在开发者更倾向于方便地用 PC 缩小窗口大小来"模拟"安卓，很可能会漏掉 bug)
  • 部分 API 在安卓上没有，但在 jvmMain 内可以访问，导致运行时 NoSuchMethodError。例如 List.removeFirst()

如何在本地运行 instrumented test

  1. 在 local.properties 增加 android.min.sdk=30

    因为 SDK 30 才支持函数名写空格 (我们已经有一万个 case 了，没办法回头改每个 case 的名字了)。

  2. ADB 连接手机或者启动模拟器
  3. ./gradlew connectedCheck

说明：

  • ./gradlew check 不会执行 androidDeviceTest (但会执行 androidHostTest 和其他)。需要使用 ./gradlew connectedCheck 才能执行 instrumented test。默认会连接到 ADB 连接的一个设备， 也就是需要提前插上手机或启动模拟器；
  • IDE 内不支持从一个函数运行，只能用 ./gradlew connectedCheck 运行全部；
  • 这可能需要 5-10 分钟。

我需要在日常提交代码前运行 instrumented test 吗？

不需要。绝大部分情况下不会有代码通过了 commonTest (即所有平台的 unit 测试)，但不能在安卓真机上运行。 PR 的 CI 总是会运行 instrumented test，如果 CI 报错才需要本地运行 debug。

简单来说，日常仍然只需要测试 ./gradlew check 通过后，即可 push commit 和提交 PR。

UI 单元测试

在 commonTest 中可以编写 UI 测试。UI 测试使用 Compose Multiplatform 的测试框架，可以在所有平台运行。API 非常类似 Jetpack Compose 的测试框架。

示例：me.him188.ani.app.ui.foundation.layout.CarouselAutoAdvanceEffectTest