编写使用mat-autocomplete的组件的单元测试

时间:2018-05-20 05:17:33

标签: angular unit-testing autocomplete angular-material mat-autocomplete

我是Angular的新手,我正在尝试使用Angular 5构建一个自动完成的文本字段。

我在Angular Material docs中找到了这个例子:

https://stackblitz.com/angular/kopqvokeddbq?file=app%2Fautocomplete-overview-example.ts

我想知道如何编写用于测试自动完成功能的单元测试。我正在为输入元素设置一个值并触发输入'事件并尝试选择mat-option元素,但看到它们都没有创建:

我的组件html的相关部分:

<form>
  <mat-form-field class="input-with-icon">
    <div>
      <i ngClass="jf jf-search jf-lg md-primary icon"></i>
      <input #nameInput matInput class="input-field-with-icon" placeholder="Type name here"
             type="search" [matAutocomplete]="auto" [formControl]="userFormControl" [value]="inputField">
    </div>
  </mat-form-field>
</form>

<mat-autocomplete #auto="matAutocomplete">
  <mat-option *ngFor="let option of filteredOptions | async" [value]="option.name"
              (onSelectionChange)="onNameSelect(option)">
    {{ option.name }}
  </mat-option>
</mat-autocomplete>

规格文件:

it('should filter users based on input', fakeAsync(() => {
    const hostElement = fixture.nativeElement;

    sendInput('john').then(() => {
        fixture.detectChanges();
        expect(fixture.nativeElement.querySelectorAll('mat-option').length).toBe(1);

        expect(hostElement.textContent).toContain('John Rambo');
    });
}));
function sendInput(text: string) {
    let inputElement: HTMLInputElement;

    inputElement = fixture.nativeElement.querySelector('input');
    inputElement.focus();
    inputElement.value = text;
    inputElement.dispatchEvent(new Event('input'));
    fixture.detectChanges();
    return fixture.whenStable();
}

组件html:

userFormControl: FormControl = new FormControl();

ngOnInit() {
    this.filteredOptions = this.userFormControl.valueChanges
        .pipe(
            startWith(''),
            map(val => this.filter(val))
        );
}

filter(val: string): User[] {
    if (val.length >= 3) {
        console.log(' in filter');
        return this.users.filter(user =>
            user.name.toLowerCase().includes(val.toLowerCase()));
    }
}

在此之前,我意识到为了使FormControl对象设置值,我必须首先执行inputElement.focus(),这与使用角度材质的mat输入有关。是否有必要触发打开mat-options窗格?

如何使此测试工作?

4 个答案:

答案 0 :(得分:5)

您需要添加更多活动。我和你一样或多或少都有同样的问题,它只在我触发focusin事件时起作用。

我在我的代码中使用这些事件。不确定是否都需要。

inputElement.dispatchEvent(new Event('focus')); inputElement.dispatchEvent(new Event('focusin')); inputElement.dispatchEvent(new Event('input')); inputElement.dispatchEvent(new Event('keydown'));

您需要将此添加到您的sendInput函数...

答案 1 :(得分:3)

@Adam对先前答案的评论使我想到了mat-autocomplete component's own test,特别是here。您可以在其中看到focusin是打开“选项”的事件。

但是它们实际上是在组件外部的覆盖中打开的,因此在我的测试中fixture.nativeElement.querySelectorAll('mat-option').length0,但是如果我对元素document.querySelectorAll('mat-option')进行查询,则会得到预期的选项数量。

总结:

    fixture.detectChanges();
    const inputElement = fixture.debugElement.query(By.css('input')); // Returns DebugElement
    inputElement.nativeElement.dispatchEvent(new Event('focusin'));
    inputElement.nativeElement.value = text;
    inputElement.nativeElement.dispatchEvent(new Event('input'));

    fixture.detectChanges();
    await fixture.whenStable();
    fixture.detectChanges();

    const matOptions = document.querySelectorAll('mat-option');
    expect(matOptions.length).toBe(3,
      'Expect to have less options after input text and filter');

附加球:并且,如果您想单击一个选项(我已经这样做了),可以这样继续:

    const optionToClick = matOptions[0] as HTMLElement;
    optionToClick.click();
    fixture.detectChanges();

尽管我没有成功点击并把值输入到输入中。 ?好吧,我不是专业的测试人员,但是可能应该在自己的mat-autocomplete测试中(实际上是这样)并依靠它来进行测试?

答案 2 :(得分:0)

我在这里进一步建立@David的答案。

正在测试的提供组件具有@Output() selectedTimezone = new EventEmitter<string>();, 并在组件模板中 <mat-autocomplete #auto="matAutocomplete" (optionSelected)="selectTimezone($event.option.value)">, 捕获发出正确值的适当类型事件的单元测试如下

it('should emit selectedTimezone event on optionSelected', async() => { 
    // Note: 'selectedTimezone' is @Output event type as specified in component's signature
    spyOn(component.selectedTimezone, 'emit'); 

    const inputElement = fixture.debugElement.query(By.css('input'));
    inputElement.nativeElement.dispatchEvent(new Event('focusin'));

    /**
     * Note, mat-options in this case set up to have array of ['Africa/Accra (UTC
     * +01:00)', 'Africa/Addis_Ababa (UTC +01:00)', 'Africa/Algiers (UTC +01:00)',
     * 'Africa/Asmara (UTC +01:00)']. I am setting it up in 'beforeEach'
     */
    inputElement.nativeElement.value = 'Africa'; 
    inputElement.nativeElement.dispatchEvent(new Event('input'));

    await fixture.whenStable();

    const matOptions = document.querySelectorAll('mat-option');
    expect(matOptions.length).toBe(4);

    const optionToClick = matOptions[0] as HTMLElement;
    optionToClick.click();

    // With this expect statement we verify both, proper type of event and value in it being emitted
    expect(component.selectedTimezone.emit).toHaveBeenCalledWith('Africa/Accra');
  });

答案 3 :(得分:0)

感谢@David 的回答,我让一切正常,直到选择了一个选项部分。

为了使选项选择工作,我必须这样做;

...
matOptions[0].dispatchEvent(new Event('click'));
...

而且您不必将 matOptions[0] 的类型转换为 HTMLElement

注意**我使用的是 Angular 8.0.1,新版本中的解决方案可能会有所不同