Skip to content

Latest commit

 

History

History
354 lines (247 loc) · 11.9 KB

使用Quick框架和Nimble来测试ViewControler.md

File metadata and controls

354 lines (247 loc) · 11.9 KB

Testing view controllers with Quick and Nimble

使用Quick框架和Nimble来测试ViewControler


ViewController是iOS应用开发的支柱之一,它们是用户界面和业务逻辑、模型的纽带,即便只是修改了它其中的一点代码也可能会引发严重的问题,因此对ViewController进行测试就变得极为重要。然而,为ViewController写测试代码一直以来都是一个晦涩难懂的话题。这篇文章中,我会尝试使用Quick和Nimble框架来解开这些疑惑。

Quick 和 Nimble

Quick 是一个针对于Swift和Objective-C的行为驱动开发框架. 它的灵感来自于 RSpec, Specta, 和 Ginkgo.

Nimble 是一个同时适用于Swift和Objective-C语言的匹配框架.

换句话说,Quick是一个用于创建BDD测试的框架。配合Nimbl,可以为你创建更符合预期目标的测试。

示例

这个示例是使用Swift 1.2创建的名为Pony的iOS应用。这个应用含有一个底部栏和一个用于在应用启动时弹出应用简介信息的ViewController。Main.storybard看起来如下图所示 :

运行后 :

( 如果浏览器不支持视频播放,可以手动拷贝地址到浏览器中观看,地址在 https://d262ilb51hltx0.cloudfront.net/max/1600/1*9HuloDCQQ3Ul2t4KGQGkYg.ogv ).

  1. 加载应用.
  2. 弹出简介信息.

为Pony配置Quick和Nimble

如果你安装了最新版的CocoaPods,你可以将下面的配置代码添加到Podfile中 :

platform :ios, '8.0'
 
source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!
 
target 'PonyTests', :exclusive => true do
  pod 'Nimble', :git => 'https://github.com/Quick/Nimble.git' #, :branch => 'swift-1.1' # if you want to use swift 1.1
  pod 'Quick', :git => 'https://github.com/Quick/Quick.git', # :branch => 'swift-1.1'
end

Quick文件模板(可选)

你可以使用Alcatraz 或者 通过 Rakefile手动创建

注意

在开始之前,确保你的类是public的, 例如:

public class MyPublicClass {
 
  public var myPublicProperty: String?
  public func myPublicFunc () {
    //... 
  }
}

创建一个测试类

如果Quick模板已经安装了,那么你可以选择quick模板、创建一个新的文件,然后import应用模块到文件中,例如 :

import Quick
import Nimble
import MyAppModule // Importing the app module
 
class HelloTest: QuickSpec {
    override func spec() {
      //...
    }
}

如果你导入应用模块有问题,可以参考这篇文章: http://stackoverflow.com/a/24151067/1970675

测试

PonyTabController: UITabBarController

PonyTabController是UITabController的子类,它的职责是在第一次进入应用时展示应用简介(appIntroViewController)。

public class PonyTabController: UITabBarController {
  
  override public func viewDidAppear(animated: Bool) {
    super.viewDidAppear(animated)
    
    let userDefaults = NSUserDefaults.standardUserDefaults()
    
    if !userDefaults.boolForKey("appIntroHasBeenPresented") {
      let storyboard = UIStoryboard(name: "Main", bundle: NSBundle.mainBundle())
      let appIntroViewController = storyboard.instantiateViewControllerWithIdentifier("appIntroViewControllerID") as! AppIntroViewController
        
      appIntroViewController.delegate = self
      
      self.presentViewController(appIntroViewController, animated: true) {
        userDefaults.setBool(true, forKey: "appIntroHasBeenPresented")
      }
    }
  }
}
 
extension PonyTabController: AppIntroDelegate {
    
// MARK: - AppIntroDelegate
    
  public func appIntroDidFinish(appIntro: UIViewController!) {
    // Dismissing app intro
    dismissViewControllerAnimated(true, completion:nil)
  }
}

让我们从viewDidAppear中开始 :

“当应用简介从来没有被dismissed时,它会被当做appIntroDelegate设置给PonyTabController”

import Quick
import Nimble
import Pony
 
class PonyTabBarControllerSpec: QuickSpec {
  override func spec() {
    var tabBarController: PonyTabController!
    
    describe("viewDidAppear"){
      describe("When app intro had never been dismissed"){
        it("should be set as the appIntroDelegate"){
        }
      }
    }
  }
}

现在我们有了期望的描述信息,但是我们还缺少一些东西。我们还没有断言或者用于测试的对象,也没有任何的测试方法会被调用。为了更简介的进行初始化,我们可以将测试代码分为三个部分,例如 :

准备工作:

  • 创建PonyTabController实例;

执行:

  • 触发PonyTabController的生命周期方法;

断言:

  • tabController作为appIntroViewController的delegate;

完成的测试代码 :

import Quick
import Nimble
import Pony
 
class PonyTabBarControllerSpec: QuickSpec {
  override func spec() {
    var tabBarController: PonyTabController!
    
    describe(".viewDidAppear"){
      
      describe("When app intro had never been dismissed"){
      
       var appIntroViewController: AppIntroViewController?
        
        beforeEach{
            // Arrange:
            NSUserDefaults.standardUserDefaults().setBool(false, forKey: "appIntroHasBeenPresented")
            let storyboard = UIStoryboard(name:"Main", bundle: NSBundle.mainBundle())
            tabBarController = storyboard.instantiateInitialViewController() as! PonyTabController
            let window = UIWindow(frame: UIScreen.mainScreen().bounds)
            window.makeKeyAndVisible()
            window.rootViewController = tabBarController
            
            // Act:
            tabBarController.beginAppearanceTransition(true, animated: false) // Triggers viewWillAppear
            tabBarController.endAppearanceTransition() // Triggers viewDidAppear
            appIntroViewController = tabBarController.presentedViewController as! AppIntroViewController!
        }
        
        it("should be set as the appIntroDelegate"){
            // Assert:
            expect(appIntroViewController!.delegate as? PonyTabController).to(equal(tabBarController))
        }
      }
    }
  }
}

通过Arrange-Act-Assert模式组织测试代码是一种非常好的实践,它的优点如下 :

  • 明确区分出初始化与验证步骤中有哪些需要被测试;
  • 关注点集中在测试历史记录和必须的测试步骤上。

现在,做同样的操作 :

当应用简介从来没有被dismissed时,它应该被展示*”*

import Quick
import Nimble
import Pony
 
class PonyTabBarControllerSpec: QuickSpec {
  override func spec() {
    var tabBarController: PonyTabController!
    
    describe(".viewDidAppear"){
      
      context("When app intro had never been dismissed"){
        
        var appIntroViewController: AppIntroViewController?
        
        beforeEach{
            // Arrange:
            NSUserDefaults.standardUserDefaults().setBool(false, forKey: "appIntroHasBeenPresented")
            let storyboard = UIStoryboard(name:"Main", bundle: NSBundle.mainBundle())
            tabBarController = storyboard.instantiateInitialViewController() as! PonyTabController
            let window = UIWindow(frame: UIScreen.mainScreen().bounds)
            window.makeKeyAndVisible()
            window.rootViewController = tabBarController
            
            // Act:
            tabBarController.beginAppearanceTransition(true, animated: false) // Triggers viewWillAppear
            tabBarController.endAppearanceTransition() // Triggers viewDidAppear
            
            appIntroViewController = tabBarController.presentedViewController as! AppIntroViewController!
        }
        
        it("should be set as the appIntroDelegate"){
            // Assert:
            expect(appIntroViewController!.delegate as? PonyTabController).to(equal(tabBarController))
        }
        
        it("should be presented"){
          // Assert:
          expect(tabBarController.presentedViewController).toEventually(beAnInstanceOf(AppIntroViewController))
        }
      }
    }
  }
}

当应用简介从来没有被dismissed且appIntroDidFinish被调用时应该dismiss应用简介"

import Quick
import Nimble
import Pony
 
class PonyTabBarControllerSpec: QuickSpec {
  override func spec() {
    var tabBarController: PonyTabController!
    
    describe(".viewDidAppear"){
      describe("When app intro had not been presented"){
        // ... previous test 
       context("and appIntroDidFinish is called") { // Introducing a context
          
          let userDefaults = NSUserDefaults.standardUserDefaults()
          
          beforeEach {
            // Arrange:
            userDefaults.setBool(false, forKey: "appIntroHasBeenPresented")
            
            // Act:
            // Triggers viewWillAppear and viewDidAppear:animated
            tabBarController.beginAppearanceTransition(true, animated: false)
            tabBarController.endAppearanceTransition()
 
            // - Dismissing app intro.
            tabBarController.appIntroDidFinish(appIntroViewController)
          }
          
          it("should dismiss app intro"){
            // Assert:
            expect(appIntroViewController!.isBeingDismissed()).toEventually(beTrue())
          }
        }
      }
    }
  }
}

“describe” 和 “context”的简单介绍:

Describe: 包装一个功能测试集合;
Context: 在同一状态下包装一个功能测试集合;

你可以在这里查看该项目完整的代码

其他

Nimble含有一个waitUntil方法,你能够在它里面执行闭包代码,当done函数被调用时表明它已经ready,如果done函数没有被调用,那么第二个测试将会失败。如果你需要扩展定时函数来指定一个超时参数来确定你在执行某个函数时多长时间视为失败。例如,当你想等待一个ViewController被展示时你可以这么处理 :

waitUntil{ 
    done in
    tabBarController.presentViewController(viewController,
    			 animated: false){
           done()
   }
}

结论

  • 明确测试目标,你可以使用Quick框架和Nimble来实现更有意义的测试;
  • 你必须要遵守它的生命周期函数 ,例如如果另一个ViewController正在展示或者视图不是你的视图层级的一部分时你不能展示另一个ViewController ;
  • UIKit提供了一些public的函数来帮助你触发view controller 的状态;
  • 测试ViewController有时候是相当蛋疼的,尽量保持这些测试代码的简洁性。

参考资料

特别鸣谢

@eldudi@banaslee