MixboxUiKit 0.3.46

MixboxUiKit 0.3.46

Vladislav AlekseevAlexey ShpirkoArtyom RazinovTimofey SoloninArtyom Razinov 维护。



  • 来自 Avito 的编码者蜂巢

概览

Version License Build Status

强大的 iOS 端到端 UI 测试框架。

目前它在 Avito 使用,我们拥有 700+ 的端到端 UI 测试,其中约 90% 是通过验证的,这已经帮助我们在过去两年中减少了手动测试。我们在 PR 上运行了约 25%,我们正在朝着在 pull request 上执行 100% 测试的方向努力,部分是通过将黑盒端到端测试转换为灰盒测试。我们在三个平台上运行这些测试,大约需要 40 分钟(测试的总持续时间是 30+ 小时),因为我们使用了 Emcee,这是一个可以在多台机器上运行测试的测试运行器(请注意,Mixbox 不需要 Emcee)。我们也在编写灰盒测试(我们模拟类、网络等),但我们才刚刚开始。

如果您对在您的公司使用它充满热情,请提交一个问题。我们正在努力使其对社区可用,但这并不是我们的主要目标。

功能

  • 动作和检查(很明显)

  • 像素可见性检查

  • 一切均有轮询

  • 完全自动滚动

  • 黑盒和灰盒测试!

    • 黑盒测试在单独的应用程序中运行,并能启动应用程序。您可以使用这种类型的测试测试更多应用程序功能。您可以使用模拟,但需要编写更多的代码(使用启动参数或实现进程间通信)。
    • 灰盒测试在应用程序内部运行(如EarlGrey),但测试与黑盒测试相兼容,因此您可以共享测试模型、页面对象、测试辅助程序等。由于测试是在同一进程内执行的,因此可以轻松地模拟任何内容。不能不使用模拟来测试启动应用程序。

    大多数代码在灰盒和黑盒测试之间共享,因为大多数功能都如此。两种选项都有其自身的好处。使用这两种方法来获得一个良好的测试金字塔

  • 页面对象

    • 可以包含任何代码的功能
    • 页面对象元素可以嵌套元素(但是这需要一些不太美观的样板代码)
    • 一切(动作/检查)都是完全可扩展的。如果您实现了自定义动作或检查,它将自动适用于黑盒和灰盒测试(请参阅SwipeAction,所有内置动作都是真正扩展)。
  • UICollectionView中的每个单元格在测试中都是可见的(包括隐藏的单元格)

  • 可自定义的应用程序与测试之间进程间通信

  • 测试中可见视图的定制值

  • 网络模拟(通过NSURLSessionProtocol)

  • 设置权限(相机/地理位置/通知等)

  • 推送通知模拟(局限:仅限于活动应用程序内!)

  • 从测试中打开url

  • 地理位置模拟

  • 硬件键盘(定义了极少数的按键代码,但它可以轻松实现)

  • 无需分叉存储库即可自定义

  • Swift & Objective-C

  • 经过测试

    • 3种设备配置上的176个黑盒UI测试
    • 3种设备配置上的155个灰盒UI测试
    • 4种设备配置上的100个单元测试
    • SwiftLint +自定义linter
    • 所有测试都会在向Mixbox提交每个拉取请求时执行,通常1个PR等于1个提交。
    • 使用5个版本的Xcode(10.0、10.1、10.2.1、10.3、11.0)测试了2个演示
  • 可配置的报告(例如:Tests项目与具有Web界面的开源报告系统Allure集成,在Avito,我们使用内部解决方案来处理报告;您可以编写自己的实现)

在开发中/尚未开源

  • 页面对象的代码生成
  • 从应用程序获取所有断言失败
  • 与弹簧板工作的界面
  • 在发布和测试构建之间切换访问性值

安装

使用Mixbox有两种方式。

第一种在演示中描述,它是过度简化的,基本上您只需使用pod SomePod

第二种我们在Avito中使用,它是这样的:Tests(在Podfile中查看)。

文档还不够充分,因此您可以尝试简单的将Mixbox链接起来的方法(演示),但请使用Tests中的代码示例。

支持的 iOS/Xcode/Swift 版本

  • Xcode 11
  • Swift 5
  • iOS 10.3、iOS 11.4、iOS 12.1,可能有些中间版本也可以正常工作或不一定能工作,所提的版本已在 CI 上测试过
  • Cocoapods 1.8.4
  • Mac OS 10.14.6

不再支持 Xcode 9/10 及更早版本。如果您计划在不同的环境下使用项目并遇到问题,请告知我们。

已知问题

  • 在 iOS 11.2 上崩溃(在 iOS 11.3、iOS 11.4 上表现良好)
  • 在物理设备上设置权限不起作用(可能还有其他一些,我们在物理设备上没有测试;基本功能是正常的)
  • 未测试设备旋转,我认为我们可能存在与它的 bug
  • 未测试 iPad
  • 报告中的俄语问题(将很快修复)

示例

更多实际示例,请参阅 Tests 项目。这是最新开源示例,展示如何使用,但缺乏真实感(没有展示如何为真实应用编写测试)。

展示基本功能的测试示例

func test() {
    // Setting permissions
    permissions.camera.set(.allowed)
    permissions.photos.set(.notDetermined)

    // Functions are useful in page objects and allows
    // reusing code, for example, for transitions between states of the app
    pageObjects.initial
        .authorize(user: testUser)
        .goToCvScreen()
        
    // Aliases for simple assertions (you can add your own):
    pageObjects.simpleCv.view.assertIsDisplayed()
    pageObjects.simpleCv.title.assertHasText("My CV")
    
    // Fully customizable assertions
    pageObjects.simpleCv.addressField.assertMatches { element in
        element.text != addressFieldInitialText && element.text.isNotEmpty
    }
    
    // Network stubbing.
    networking.stubbing
        .stub(urlPattern: ".*?example.com/api/cv")
        .thenReturn(file: "cv.json")
    // There is also a monitoring feature, including recording+replaying feature that
    // allows to record all network and replay in later, so your tests will not require internet.
    
    // Actions
    pageObjects.simpleCV.occupationField.setText("iOS developer")
    pageObjects.simpleCV.createCVButton.tap()
}

声明页面对象

public final class MapScreen:
    BasePageObjectWithDefaultInitializer,
    ScreenWithNavigationBar // protocol extensions are very useful for sharing code
{
    // Basic locator  
    public var mapView: ViewElement {
        return element("Map view") { element in
            element.id == "GoogleMapView"
        }
    }
    
    // You can use complex checks
    // Note that you can create your own matchers like `element.isFooBar()`
    public func pin(coordinates: Coordinates, deltaInMeters: Double = 10) -> ViewElement {
        return element("Pin with coordinates \(coordinates)") { element in
            element.id == "pin" && element
                .customValues["coordinates", Coordinates.self]
                .isClose(to: coordinates, deltaInMeters: deltaInMeters)
        }
    }
}

声明自定义页面对象元素

public final class RatingStarsElement:
    BaseElementWithDefaultInitializer,
    ElementWithUi
{
    public func assertRatingEqualsTo(
        _ number: Int,
        file: StaticString = #file,
        line: UInt = #line)
    {
        assertMatches(file: file, line: line) { element in
            element.customValues["rating"] == number
        }
    }
}

粘贴的代码

本库包含从其他库中复制的部分代码。有时是一个单独的文件,有时是因为我们需要在源代码中内置条件编译,以防止在发布构建中链接代码。

用于测试

其他文档