使用带静态方法的实用程序类对组件进行单元测试

时间:2018-05-24 20:39:13

标签: angular typescript jasmine angular-test

我有使用类LocaleService的组件和此服务instant()的静态方法。 LocaleService未注入组件。在测试组件时,我对LocaleService内部不感兴趣,我不想测试它。因此在beforeEach我添加了一个间谍

const localeServiceInstantSpy = spyOn(LocaleService, 'instant');
localeServiceInstantSpy.and.callFake(msg => msg);

这项工作做得很好。现在我需要将这个间谍(和其他人)移动到LocaleService的存根并在此测试中使用它并使用LocaleService测试其他组件 - 其中有很多。实现这一目标的最正确方法是什么?如何创建可重用的LocaleServiceStub?

\app\utils\locale.service.ts

export class LocaleService {

    public static lang: string;

    private static messages = {
        'user.add': {
            en: 'Add Local User Account',
            de: 'Add Local User Account DE'
        },
        'user.edit': {
            en: 'Edit Local User Account',
            de: 'Edit Local User Account DE'
        }
    };

    public static instant(key: string) {
        return this.messages[key][this.lang];
    }

}

在测试类\app\settings\users\user-form.component.ts

中的用法
import { LocaleService } from 'app/utils/locale.service';
...
getDialogHeader() {
    return this.isNewUser ? LocaleService.instant('user.add') : LocaleService.instant('user.edit');
}
...

1 个答案:

答案 0 :(得分:1)

仅静态类在JavaScript中具有代码味道。如果一个类从未实例化,那就没必要了。

这是Angular DI应该解决的案例之一。它应该重构为服务而不是直接使用的类。

class LocaleService {
    public lang: string;

    private messages = {...};

    public instant(key: string) {
        return this.messages[key][this.lang];
    }
}

...
providers: [LocaleService, ...]
...

然后可以通过DI嘲笑它。为了重用,可以将模拟定义为提供者:

const LOCALE_SERVICE_MOCK = {
  provide: LocaleService,
  useFactory: () => ({
    instant: jasmine.createSpy('instant').and.callFake(msg => msg)
  })
};

并在试验台中说明:

beforeEach(() => {
  TestBed.configureTestingModule({ providers: [LOCALE_SERVICE_MOCK]});
});

或者用模块包裹:

beforeEach(() => {
  TestBed.configureTestingModule({ imports: [LocaleServiceMockModule]});
});

在当前状态下,可以通过将可重用代码移动到函数来使代码变为DRYer:

function mockLocaleService() {
  const localeServiceInstantSpy = spyOn(LocaleService, 'instant');
  localeServiceInstantSpy.and.callFake(msg => msg);
}

在需要的地方使用它:

beforeEach(mockLocaleService);