Angular + Rxjs 单元测试

最近进入到新的项目,前端采用Angular开发,恶补了一阵子关于Angular的知识,跟Angular相关的Rxjs和Ngrx也不能少。经过几个小的功能模块的开发后,也开始适应了Angular+Rxjs+Ngrx的开发模式。

但是,写UT的时候,却又是【一!脸!懵!逼!】

使用TestBed解决注入问题

首先面临的问题是:Angular一般会使用依赖注入(DI)来创建服务, 当某个服务依赖另一个服务时,DI 就会找到或创建那个被依赖的服务。 如果那个被依赖的服务还有它自己的依赖,DI 也同样会找到或创建它们。但是在编写单元测试的时候,谁来帮忙做注入?

下面是一个例子:

// file: Master.service.ts

@Injectable()
export class MasterService {
  constructor(private subService: SubService) { }
  getValue() { return this.subService.getValue(); }
}

MasterService 依赖于SubService, 通过构造函数注入,SubService的定义如下:

// file: Sub.service.ts

@Injectable()
export class SubService {
  constructor() { }
  getValue() { return "value"; }
}

如果要为MasterService写UT,就需要解决依赖问题。

方法一:

比较“笨”的一个解决办法就是自己在单元测试中主动创建要注入的实例,然后作为构造函数传递,如下:

// file: master.service.spec.ts

describe('MasterService without Angular testing support', () => {
  let masterService: MasterService;
 
  it('#getValue should return real value from the real service', () => {
    //new一个SubService的实例,然后通过MasterService的构造函数传入 
    masterService = new MasterService(new SubService());
    expect(masterService.getValue()).toBe('real value');
  });
 
  it('#getValue should return faked value from a fakeService', () => {
    //new一个假的SubService实例,但是它实现了Subservice的方法,然后通过MasterService的构造函数传入
    masterService = new MasterService(new FakeSubService());
    expect(masterService.getValue()).toBe('faked service value');
  });
 
  it('#getValue should return stubbed value from a spy', () => {
    // 通过jasmin创建一个spy对象,把spy对象通过MasterService的构造函数传入
    const subServiceSpy =
      jasmine.createSpyObj('SubService', ['getValue']);
 
    const stubValue = 'stub value';
    subServiceSpy.getValue.and.returnValue(stubValue);
 
    masterService = new MasterService(subServiceSpy);
 
    expect(masterService.getValue())
      .toBe(stubValue, 'service returned stub value');
    expect(subServiceSpy.getValue.calls.count())
      .toBe(1, 'spy method was called once');
    expect(subServiceSpy.getValue.calls.mostRecent().returnValue)
      .toBe(stubValue);
  });
});

缺陷在于:当要注入的对象比较复杂的时候,这种方法就会力不从心。

方法二(推荐):

其实,Angular官方也考虑到了这个问题,提供了TestBed(来自@angular/core/testing)。TestBed 会动态创建一个用来模拟 @NgModule 的 Angular 测试模块。

具体如下:

// file: master.service.spec.ts

describe('MasterService without Angular testing support', () => {
  let masterService: MasterService;
  
  beforeEach(() => {
    TestBed.configureTestingModule({
      providers: [
        MasterService,
        SubService
      ]
    });
    
    //从TestBed获取一个masterService的实例,不必关心SubService,Angular会自动注入
    masterService = TestBed.get(MasterService);
  });
 
  it('#getValue should return real value from the real service', () => {
    expect(masterService.getValue()).toBe('real value');
  });

});

TestBed.congigureTestingModule方法接受一个配置对象,其属性与@NgModule类似(imports,providers,declarations)等,具体参见https://angular.cn/api/core/testing/TestModuleMetadata),模拟出一个@NgModule

在这个例子中,在provider中声明了MasterServiceSubService,此时TestBed会管理他们的生命周期,在使用TestBed.get(MasterService)时,TestBed会帮助实例话具体的对象和构建依赖对象。

同样的,在使用TestBed时,我们也可以使用spy对象,如下:

// file: master.service.spec.ts

describe('MasterService without Angular testing support', () => {
  let masterService: MasterService;

  
  beforeEach(() => {
    //创建一个spy,名字是SubService,并且提供getValue方法
    const spy = jasmine.createSpyObj('SubService', ['getValue']);
    TestBed.configureTestingModule({
      providers: [
        MasterService,
        { provide: SubService, useValue: spy }//使用spy的SubService
      ]
    });
    
    //在masterService实例话的时候,会取到spy的SubService对象
    masterService = TestBed.get(MasterService);
  });

});

弹珠测试

其次就是针对Rxjs的Observable的单元测试,模拟Observable的数据流和异步是很困难的一件事情。

传统的做法是spy observable的值,并且在subscribe中使用done。

it('async with observable', (done: DoneFn) => {

  // the spy's most recent call returns the observable
  asyncMethod.calls.mostRecent().returnValue.subscribe(() => {
    // check the result here;
    done();
  });
});

但是不足之处在于无法模拟Observable的数据流,Rxjs提供的弹珠测试的方式,很好的解决了这个问题。它们可以使我们以同步且可靠的方式来测试异步操作。

下面用一个例子简单介绍弹珠测试,更多详细信息可以参考官方说明:https://cn.rx.js.org/manual/usage.html#h12

import { cold, hot } from 'jasmine-marbles';

const input = hot('-a--b--c--', { a: 1, b: 2, c: 3 });
const expected = cold('-x--y--z--', { x: 10, y: 20, z: 30 });

expect(input.pipe(map(i => 10 * i ))).toBeObservable(expected);

首先,从jasmine-marbles中导入coldhot函数. coldhot都接受一个满足弹珠语法的字符串,和一个可选的对象,分别返回TestHotObservableTestColdObservable对象(都继承自Observable)。 区别在于hot方法返回的是一个表示已经被订阅且在运行中的Observablecold返回的是暂未被订阅的Observable

在这个例子中,'-a--b--c—'的每一个字符都表示一帧,-表示一个空白帧,a,b,c分别表示在该帧的数据,他们的值是hot第二个参数对象里面对应key所对应的值,所以例子中的hot会产生一个,在第二帧发出1,第5帧发出2,第8帧发出3的Observable。同理,可以明白变量expected的意思。

最后,我们可以通过使用expecttoBeObservable来判断经过处理的input这个Observable的值是否与expected的值相等。

参考文档

TestBed和MarbleTest可以极大的提高Angular中UT编写的简便性,这里只是抛砖引玉举了两个简答的例子,更多的高级功能,还是有待大家一起发掘。下面是一些重要的参考链接:

https://angular.cn/guide/testing

https://github.com/ReactiveX/rxjs/blob/master/docs_app/content/guide/testing/marble-testing.md

https://cn.rx.js.org/manual/usage.html

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352

推荐阅读更多精彩内容