144 lines
4.0 KiB
TypeScript
144 lines
4.0 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. 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
|
|
*/
|
|
|
|
import {Location, LocationStrategy} from '@angular/common';
|
|
import {MockLocationStrategy, SpyLocation} from '@angular/common/testing';
|
|
import {Compiler, Injectable, Injector, ModuleWithProviders, NgModule, NgModuleFactory, NgModuleFactoryLoader, Optional} from '@angular/core';
|
|
import {NoPreloading, PreloadingStrategy, Route, Router, RouterModule, RouterOutletMap, Routes, UrlHandlingStrategy, UrlSerializer, provideRoutes} from '@angular/router';
|
|
|
|
import {ROUTER_PROVIDERS, ROUTES, flatten} from './private_import_router';
|
|
|
|
|
|
|
|
/**
|
|
* @whatItDoes Allows to simulate the loading of ng modules in tests.
|
|
*
|
|
* @howToUse
|
|
*
|
|
* ```
|
|
* const loader = TestBed.get(NgModuleFactoryLoader);
|
|
*
|
|
* @Component({template: 'lazy-loaded'})
|
|
* class LazyLoadedComponent {}
|
|
* @NgModule({
|
|
* declarations: [LazyLoadedComponent],
|
|
* imports: [RouterModule.forChild([{path: 'loaded', component: LazyLoadedComponent}])]
|
|
* })
|
|
*
|
|
* class LoadedModule {}
|
|
*
|
|
* // sets up stubbedModules
|
|
* loader.stubbedModules = {lazyModule: LoadedModule};
|
|
*
|
|
* router.resetConfig([
|
|
* {path: 'lazy', loadChildren: 'lazyModule'},
|
|
* ]);
|
|
*
|
|
* router.navigateByUrl('/lazy/loaded');
|
|
* ```
|
|
*
|
|
* @stable
|
|
*/
|
|
@Injectable()
|
|
export class SpyNgModuleFactoryLoader implements NgModuleFactoryLoader {
|
|
/**
|
|
* @docsNotRequired
|
|
*/
|
|
private _stubbedModules: {[path: string]: Promise<NgModuleFactory<any>>} = {};
|
|
|
|
/**
|
|
* @docsNotRequired
|
|
*/
|
|
set stubbedModules(modules: {[path: string]: any}) {
|
|
const res: {[path: string]: any} = {};
|
|
for (const t of Object.keys(modules)) {
|
|
res[t] = this.compiler.compileModuleAsync(modules[t]);
|
|
}
|
|
this._stubbedModules = res;
|
|
}
|
|
|
|
/**
|
|
* @docsNotRequired
|
|
*/
|
|
get stubbedModules(): {[path: string]: any} { return this._stubbedModules; }
|
|
|
|
constructor(private compiler: Compiler) {}
|
|
|
|
load(path: string): Promise<NgModuleFactory<any>> {
|
|
if (this._stubbedModules[path]) {
|
|
return this._stubbedModules[path];
|
|
} else {
|
|
return <any>Promise.reject(new Error(`Cannot find module ${path}`));
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Router setup factory function used for testing.
|
|
*
|
|
* @stable
|
|
*/
|
|
export function setupTestingRouter(
|
|
urlSerializer: UrlSerializer, outletMap: RouterOutletMap, location: Location,
|
|
loader: NgModuleFactoryLoader, compiler: Compiler, injector: Injector, routes: Route[][],
|
|
urlHandlingStrategy?: UrlHandlingStrategy) {
|
|
const router = new Router(
|
|
null, urlSerializer, outletMap, location, injector, loader, compiler, flatten(routes));
|
|
if (urlHandlingStrategy) {
|
|
router.urlHandlingStrategy = urlHandlingStrategy;
|
|
}
|
|
return router;
|
|
}
|
|
|
|
/**
|
|
* @whatItDoes Sets up the router to be used for testing.
|
|
*
|
|
* @howToUse
|
|
*
|
|
* ```
|
|
* beforeEach(() => {
|
|
* TestBed.configureTestModule({
|
|
* imports: [
|
|
* RouterTestingModule.withRoutes(
|
|
* [{path: '', component: BlankCmp}, {path: 'simple', component: SimpleCmp}])]
|
|
* )
|
|
* ]
|
|
* });
|
|
* });
|
|
* ```
|
|
*
|
|
* @description
|
|
*
|
|
* The modules sets up the router to be used for testing.
|
|
* It provides spy implementations of {@link Location}, {@link LocationStrategy}, and {@link
|
|
* NgModuleFactoryLoader}.
|
|
*
|
|
* @stable
|
|
*/
|
|
@NgModule({
|
|
exports: [RouterModule],
|
|
providers: [
|
|
ROUTER_PROVIDERS, {provide: Location, useClass: SpyLocation},
|
|
{provide: LocationStrategy, useClass: MockLocationStrategy},
|
|
{provide: NgModuleFactoryLoader, useClass: SpyNgModuleFactoryLoader}, {
|
|
provide: Router,
|
|
useFactory: setupTestingRouter,
|
|
deps: [
|
|
UrlSerializer, RouterOutletMap, Location, NgModuleFactoryLoader, Compiler, Injector, ROUTES,
|
|
[UrlHandlingStrategy, new Optional()]
|
|
]
|
|
},
|
|
{provide: PreloadingStrategy, useExisting: NoPreloading}, provideRoutes([])
|
|
]
|
|
})
|
|
export class RouterTestingModule {
|
|
static withRoutes(routes: Routes): ModuleWithProviders {
|
|
return {ngModule: RouterTestingModule, providers: [provideRoutes(routes)]};
|
|
}
|
|
}
|