Kristiyan Kostadinov
873229f24b
We currently have two long-standing issues related to how `TestBed` tests are torn down: 1. The dynamically-created test module isn't going to be destroyed, preventing the `ngOnDestroy` hooks on providers from running and keeping the component `style` nodes in the DOM. 2. The test root elements aren't going to be removed from the DOM. Instead, they will be removed whenever another test component is created. By themselves, these issues are easy to resolve, but given how long they've been around, there are a lot of unit tests out there that depend on the broken behavior. These changes address the issues by introducing APIs that allow users to opt into the correct test teardown behavior either at the application level via `TestBed.initTestEnvironment` or the test suite level via `TestBed.configureTestingModule`. At the moment, the new teardown behavior is opt-in, but the idea is that we'll eventually make it opt-out before removing the configuration altogether. Fixes #18831. PR Close #42566
54 lines
1.7 KiB
TypeScript
54 lines
1.7 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
/**
|
|
* Public Test Library for unit testing Angular applications. Assumes that you are running
|
|
* with Jasmine, Mocha, or a similar framework which exports a beforeEach function and
|
|
* allows tests to be asynchronous by either returning a promise or using a 'done' parameter.
|
|
*/
|
|
|
|
import {resetFakeAsyncZone} from './fake_async';
|
|
import {TestBed, TestBedViewEngine as TestBedInternal} from './test_bed';
|
|
|
|
declare var global: any;
|
|
|
|
const _global = <any>(typeof window === 'undefined' ? global : window);
|
|
|
|
// Reset the test providers and the fake async zone before each test.
|
|
if (_global.beforeEach) {
|
|
_global.beforeEach(getCleanupHook(false));
|
|
}
|
|
|
|
// We provide both a `beforeEach` and `afterEach`, because the updated behavior for
|
|
// tearing down the module is supposed to run after the test so that we can associate
|
|
// teardown errors with the correct test.
|
|
if (_global.afterEach) {
|
|
_global.afterEach(getCleanupHook(true));
|
|
}
|
|
|
|
function getCleanupHook(expectedTeardownValue: boolean) {
|
|
return () => {
|
|
if ((TestBed as unknown as TestBedInternal).shouldTearDownTestingModule() ===
|
|
expectedTeardownValue) {
|
|
TestBed.resetTestingModule();
|
|
resetFakeAsyncZone();
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* This API should be removed. But doing so seems to break `google3` and so it requires a bit of
|
|
* investigation.
|
|
*
|
|
* A work around is to mark it as `@codeGenApi` for now and investigate later.
|
|
*
|
|
* @codeGenApi
|
|
*/
|
|
// TODO(iminar): Remove this code in a safe way.
|
|
export const __core_private_testing_placeholder__ = '';
|