Skip to content

feat(core): Add TestBed.runInContext to help test functions which use inject #47955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
atscott wants to merge 1 commit into from
Closed

feat(core): Add TestBed.runInContext to help test functions which use inject #47955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions goldens/public-api/core/testing/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ export interface TestBed {
resetTestEnvironment(): void;
// (undocumented)
resetTestingModule(): TestBed;
runInInjectionContext<T>(fn: () => T): T;
}

// @public
Expand Down
16 changes: 15 additions & 1 deletion packages/core/test/test_bed_spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* found in the LICENSE file at https://angular.io/license
*/

import {APP_INITIALIZER, ChangeDetectorRef, Compiler, Component, Directive, ElementRef, ErrorHandler, getNgModuleById, Inject, Injectable, InjectFlags, InjectionToken, InjectOptions, Injector, Input, LOCALE_ID, ModuleWithProviders, NgModule, Optional, Pipe, Type, ViewChild, ɵsetClassMetadata as setClassMetadata, ɵɵdefineComponent as defineComponent, ɵɵdefineInjector as defineInjector, ɵɵdefineNgModule as defineNgModule, ɵɵelementEnd as elementEnd, ɵɵelementStart as elementStart, ɵɵsetNgModuleScope as setNgModuleScope, ɵɵtext as text} from '@angular/core';
import {APP_INITIALIZER, ChangeDetectorRef, Compiler, Component, Directive, ElementRef, ErrorHandler, getNgModuleById, inject, Inject, Injectable, InjectFlags, InjectionToken, InjectOptions, Injector, Input, LOCALE_ID, ModuleWithProviders, NgModule, Optional, Pipe, Type, ViewChild, ɵsetClassMetadata as setClassMetadata, ɵɵdefineComponent as defineComponent, ɵɵdefineInjector as defineInjector, ɵɵdefineNgModule as defineNgModule, ɵɵelementEnd as elementEnd, ɵɵelementStart as elementStart, ɵɵsetNgModuleScope as setNgModuleScope, ɵɵtext as text} from '@angular/core';
import {TestBed, TestBedImpl} from '@angular/core/testing/src/test_bed';
import {By} from '@angular/platform-browser';
import {expect} from '@angular/platform-browser/testing/src/matchers';
Expand Down Expand Up @@ -1893,6 +1893,20 @@ describe('TestBed', () => {
});
});
});

it('should be able to call Testbed.runInInjectionContext in tests', () => {
const expectedValue = 'testValue';
@Injectable({providedIn: 'root'})
class SomeInjectable {
readonly instanceValue = expectedValue;
}

function functionThatUsesInject(): string {
return inject(SomeInjectable).instanceValue;
}

expect(TestBed.runInInjectionContext(functionThatUsesInject)).toEqual(expectedValue);
});
});


Expand Down
21 changes: 21 additions & 0 deletions packages/core/testing/src/test_bed.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import {
Component,
Directive,
EnvironmentInjector,
InjectFlags,
InjectionToken,
InjectOptions,
Expand Down Expand Up @@ -104,6 +105,13 @@ export interface TestBed {
/** @deprecated from v9.0.0 use TestBed.inject */
get(token: any, notFoundValue?: any): any;

/**
* Runs the given function in the `EnvironmentInjector` context of `TestBed`.
*
* @see EnvironmentInjector#runInContext
*/
runInInjectionContext<T>(fn: () => T): T;

execute(tokens: any[], fn: Function, context?: any): any;

overrideModule(ngModule: Type<any>, override: MetadataOverride<NgModule>): TestBed;
Expand Down Expand Up @@ -325,6 +333,15 @@ export class TestBedImpl implements TestBed {
return TestBedImpl.INSTANCE.inject(token, notFoundValue, flags);
}

/**
* Runs the given function in the `EnvironmentInjector` context of `TestBed`.
*
* @see EnvironmentInjector#runInContext
*/
static runInInjectionContext<T>(fn: () => T): T {
return TestBedImpl.INSTANCE.runInInjectionContext(fn);
}

static createComponent<T>(component: Type<T>): ComponentFixture<T> {
return TestBedImpl.INSTANCE.createComponent(component);
}
Expand Down Expand Up @@ -516,6 +533,10 @@ export class TestBedImpl implements TestBed {
return this.inject(token, notFoundValue, flags);
}

runInInjectionContext<T>(fn: () => T): T {
return this.inject(EnvironmentInjector).runInContext(fn);
}

execute(tokens: any[], fn: Function, context?: any): any {
const params = tokens.map(t => this.inject(t));
return fn.apply(context, params);
Expand Down