Add unit tests for IResult

ycanardeau · May 25, 2024 · 9e9eaff · 9e9eaff
1 parent 5ba6f1b
commit 9e9eaff
Show file tree

Hide file tree

Showing 35 changed files with 1,269 additions and 59 deletions.
diff --git a/packages/antiforgery/test/DefaultAntiforgery.test.ts b/packages/antiforgery/test/DefaultAntiforgery.test.ts
@@ -53,7 +53,7 @@ function getServices(): IServiceProvider {
 function getHttpContext(
 	antiforgeryFeature?: IAntiforgeryFeature,
 ): IHttpContext {
-	const httpContext = HttpContext.create();
+	const httpContext = HttpContext.createWithDefaultFeatureCollection();
 	antiforgeryFeature = antiforgeryFeature ?? new AntiforgeryFeature();
 	httpContext.features.set(IAntiforgeryFeature, antiforgeryFeature);
 	httpContext.requestServices = getServices();

diff --git a/packages/authentication.abstractions/src/AuthenticationProperties.ts b/packages/authentication.abstractions/src/AuthenticationProperties.ts
@@ -30,6 +30,16 @@ export class AuthenticationProperties {
 		this.parameters = parameters ?? new Map();
 	}
 
+	static create(): AuthenticationProperties {
+		return new AuthenticationProperties(undefined, undefined);
+	}
+
+	static createWithItems(
+		items: Map<string, string | undefined>,
+	): AuthenticationProperties {
+		return new AuthenticationProperties(items, undefined);
+	}
+
 	protected getString(key: string): string | undefined {
 		const tryGetValueResult = tryGetValue(this.items, key);
 		return tryGetValueResult.ok ? tryGetValueResult.val : undefined;
@@ -64,8 +74,8 @@ export class AuthenticationProperties {
 			? tryGetValueResult.val === 'true'
 				? true
 				: tryGetValueResult.val === 'false'
-				? false
-				: undefined
+					? false
+					: undefined
 			: undefined;
 	}
 

diff --git a/packages/authentication.abstractions/src/AuthenticationTicket.ts b/packages/authentication.abstractions/src/AuthenticationTicket.ts
@@ -11,7 +11,7 @@ export class AuthenticationTicket {
 
 	constructor(
 		readonly principal: ClaimsPrincipal,
-		properties = new AuthenticationProperties(undefined, undefined),
+		properties = AuthenticationProperties.create(),
 		readonly authenticationScheme: string,
 	) {
 		this.properties = properties;

diff --git a/packages/authentication.cookies/src/CookieAuthenticationHandler.ts b/packages/authentication.cookies/src/CookieAuthenticationHandler.ts
@@ -290,10 +290,7 @@ export class CookieAuthenticationHandler extends SignInAuthenticationHandler<Coo
 
 	protected async handleSignIn(
 		user: ClaimsPrincipal,
-		properties: AuthenticationProperties = new AuthenticationProperties(
-			undefined,
-			undefined,
-		),
+		properties: AuthenticationProperties = AuthenticationProperties.create(),
 	): Promise<void> {
 		this.signInCalled = true;
 
@@ -384,8 +381,7 @@ export class CookieAuthenticationHandler extends SignInAuthenticationHandler<Coo
 	protected async handleSignOut(
 		properties: AuthenticationProperties | undefined,
 	): Promise<void> {
-		properties =
-			properties ?? new AuthenticationProperties(undefined, undefined);
+		properties = properties ?? AuthenticationProperties.create();
 
 		this.signOutCalled = true;
 

diff --git a/packages/authentication/src/PropertiesContext.ts b/packages/authentication/src/PropertiesContext.ts
@@ -30,7 +30,6 @@ export abstract class PropertiesContext<
 	) {
 		super(context, scheme, options);
 
-		this.properties =
-			properties ?? new AuthenticationProperties(undefined, undefined);
+		this.properties = properties ?? AuthenticationProperties.create();
 	}
 }
diff --git a/packages/authentication/src/PropertiesSerializer.ts b/packages/authentication/src/PropertiesSerializer.ts
@@ -44,7 +44,7 @@ export class PropertiesSerializer
 			const value = reader.readString();
 			extra.set(key, value);
 		}
-		return new AuthenticationProperties(extra, undefined);
+		return AuthenticationProperties.createWithItems(extra);
 	}
 
 	deserialize(data: Buffer): AuthenticationProperties | undefined {

diff --git a/packages/authentication/src/SignInAuthenticationHandler.ts b/packages/authentication/src/SignInAuthenticationHandler.ts
@@ -48,8 +48,7 @@ export abstract class SignInAuthenticationHandler<
 			? signIn(this.context, target, user, properties)
 			: this.handleSignIn(
 					user,
-					properties ??
-						new AuthenticationProperties(undefined, undefined),
+					properties ?? AuthenticationProperties.create(),
 				);
 	}
 }
diff --git a/packages/authentication/src/SignOutAuthenticationHandler.ts b/packages/authentication/src/SignOutAuthenticationHandler.ts
@@ -37,8 +37,7 @@ export abstract class SignOutAuthenticationHandler<
 		return target !== undefined
 			? signOut(this.context, target, properties)
 			: this.handleSignOut(
-					properties ??
-						new AuthenticationProperties(undefined, undefined),
-			  );
+					properties ?? AuthenticationProperties.create(),
+				);
 	}
 }
diff --git a/packages/authentication/test/TicketSerializer.test.ts b/packages/authentication/test/TicketSerializer.test.ts
@@ -17,7 +17,7 @@ import { expect, test } from 'vitest';
 // https://github.com/dotnet/aspnetcore/blob/00d0038f937f0059a847fde504649fe33ec935e0/src/Security/Authentication/test/TicketSerializerTests.cs#L12
 test('CanRoundTripEmptyPrincipal', () => {
 	const serializer = new TicketSerializer();
-	const properties = new AuthenticationProperties(undefined, undefined);
+	const properties = AuthenticationProperties.create();
 	properties.redirectUri = 'bye';
 	const ticket = new AuthenticationTicket(
 		new ClaimsPrincipal(),
@@ -42,7 +42,7 @@ test('CanRoundTripEmptyPrincipal', () => {
 // https://github.com/dotnet/aspnetcore/blob/00d0038f937f0059a847fde504649fe33ec935e0/src/Security/Authentication/test/TicketSerializerTests.cs#L33
 test('CanRoundTripBootstrapContext', () => {
 	const serializer = new TicketSerializer();
-	const properties = new AuthenticationProperties(undefined, undefined);
+	const properties = AuthenticationProperties.create();
 
 	const ticket = new AuthenticationTicket(
 		new ClaimsPrincipal(),
@@ -84,7 +84,7 @@ test('CanRoundTripBootstrapContext', () => {
 // https://github.com/dotnet/aspnetcore/blob/00d0038f937f0059a847fde504649fe33ec935e0/src/Security/Authentication/test/TicketSerializerTests.cs#L55
 test('CanRoundTripActorIdentity', () => {
 	const serializer = new TicketSerializer();
-	const properties = new AuthenticationProperties(undefined, undefined);
+	const properties = AuthenticationProperties.create();
 
 	const actor = new ClaimsIdentity(
 		undefined,
@@ -135,7 +135,7 @@ test('CanRoundTripActorIdentity', () => {
 // https://github.com/dotnet/aspnetcore/blob/00d0038f937f0059a847fde504649fe33ec935e0/src/Security/Authentication/test/TicketSerializerTests.cs#L84
 test('CanRoundTripClaimProperties', () => {
 	const serializer = new TicketSerializer();
-	const properties = new AuthenticationProperties(undefined, undefined);
+	const properties = AuthenticationProperties.create();
 
 	const claim = new Claim(
 		'type',

diff --git a/packages/extensions.logging.abstractions/src/index.ts b/packages/extensions.logging.abstractions/src/index.ts
@@ -4,4 +4,5 @@ export * from './ILoggerT';
 export * from './LoggerExtensions';
 export * from './LoggerT';
 export * from './LogLevel';
+export * from './NullLogger';
 export * from './NullLoggerFactory';
diff --git a/packages/hosting/test/HostingApp.test.ts b/packages/hosting/test/HostingApp.test.ts
@@ -66,7 +66,7 @@ function createApp(
 // https://github.com/dotnet/aspnetcore/blob/e0aed17a16f5f6e5540925ef849bf87358fa10b3/src/Hosting/Hosting/test/HostingApplicationTests.cs#L22C17-L22C85
 test('DisposeContextDoesNotClearHttpContextIfDefaultHttpContextFactoryUsed', () => {
 	const hostingApp = createApp();
-	const httpContext = HttpContext.create();
+	const httpContext = HttpContext.createWithDefaultFeatureCollection();
 
 	const context = hostingApp.createContext(httpContext.features);
 	expect(context.httpContext).not.toBeUndefined();
@@ -91,9 +91,9 @@ test('DisposeContextDoesNotClearHttpContextIfDefaultHttpContextFactoryUsed', ()
 test('CreateContextReinitializesPreviouslyStoredDefaultHttpContext', () => {
 	const hostingApp = createApp();
 	const features = new FeaturesWithContext<HostingAppContext>(
-		HttpContext.create().features,
+		HttpContext.createWithDefaultFeatureCollection().features,
 	);
-	const previousContext = HttpContext.create();
+	const previousContext = HttpContext.createWithDefaultFeatureCollection();
 	features.hostContext = new HostingAppContext();
 	features.hostContext.httpContext = previousContext;
 
@@ -115,9 +115,9 @@ test('CreateContextCreatesNewContextIfNotUsingDefaultHttpContextFactory', () =>
 
 	const hostingApp = createApp(factory);
 	const features = new FeaturesWithContext<HostingAppContext>(
-		HttpContext.create().features,
+		HttpContext.createWithDefaultFeatureCollection().features,
 	);
-	const previousContext = HttpContext.create();
+	const previousContext = HttpContext.createWithDefaultFeatureCollection();
 	// Pretend like we had previous HttpContext
 	features.hostContext = new HostingAppContext();
 	features.hostContext.httpContext = previousContext;
@@ -137,7 +137,7 @@ class TestHttpActivityFeature implements IHttpActivityFeature {
 // https://github.com/dotnet/aspnetcore/blob/e0aed17a16f5f6e5540925ef849bf87358fa10b3/src/Hosting/Hosting/test/HostingApplicationTests.cs#L165C17-L165C67
 test('IHttpActivityFeatureIsNotPopulatedWithoutAListener', () => {
 	const hostingApp = createApp();
-	const httpContext = HttpContext.create();
+	const httpContext = HttpContext.createWithDefaultFeatureCollection();
 	httpContext.features.set<IHttpActivityFeature>(
 		IHttpActivityFeature,
 		new TestHttpActivityFeature(),

diff --git a/packages/http/src/HttpContext.ts b/packages/http/src/HttpContext.ts
@@ -66,7 +66,7 @@ export class HttpContext implements IHttpContext {
 		this.response = new HttpResponse(this);
 	}
 
-	static create(): HttpContext {
+	static createWithDefaultFeatureCollection(): HttpContext {
 		const httpContext = new HttpContext(new FeatureCollection());
 		httpContext.features.set<IHttpRequestFeature>(
 			IHttpRequestFeature,

diff --git a/packages/http/test/HttpContext.test.ts b/packages/http/test/HttpContext.test.ts
@@ -193,7 +193,7 @@ test('RequestServicesAreNotOverwrittenIfAlreadySet', () => {
 		IServiceScopeFactory,
 	);
 
-	const context = HttpContext.create();
+	const context = HttpContext.createWithDefaultFeatureCollection();
 	context.serviceScopeFactory = scopeFactory;
 	context.requestServices = serviceProvider;
 
@@ -247,7 +247,7 @@ test('RequestServicesAreDisposedOnCompleted', async () => {
 	);
 	let instance: DisposableThing | undefined = undefined;
 
-	const context = HttpContext.create();
+	const context = HttpContext.createWithDefaultFeatureCollection();
 	context.serviceScopeFactory = scopeFactory;
 	const responseFeature = new TestHttpResponseFeature();
 	context.features.set<IHttpResponseFeature>(
@@ -336,7 +336,7 @@ test('RequestServicesAreDisposedAsyncOnCompleted', async () => {
 	);
 	let instance: DisposableThing | undefined = undefined;
 
-	const context = HttpContext.create();
+	const context = HttpContext.createWithDefaultFeatureCollection();
 	context.serviceScopeFactory = scopeFactory;
 	const responseFeature = new TestHttpResponseFeature();
 	context.features.set<IHttpResponseFeature>(
@@ -365,7 +365,7 @@ test('RequestServicesAreDisposedAsyncOnCompleted', async () => {
 
 // https://github.com/dotnet/aspnetcore/blob/95b1de9ccf67adbc57919132464dac44c20e92b8/src/Http/Http/test/DefaultHttpContextTests.cs#L261C17-L261C48
 test('InternalActiveFlagIsSetAndUnset', () => {
-	const context = HttpContext.create();
+	const context = HttpContext.createWithDefaultFeatureCollection();
 
 	expect(context.active).toBe(false);
 

diff --git a/packages/main.ts b/packages/main.ts
@@ -110,10 +110,7 @@ export async function main(): Promise<void> {
 			undefined,
 		);
 
-		const authProperties = new AuthenticationProperties(
-			undefined,
-			undefined,
-		);
+		const authProperties = AuthenticationProperties.create();
 
 		await signIn(
 			context,
@@ -126,10 +123,7 @@ export async function main(): Promise<void> {
 	});
 
 	mapGet(app, '/signOut', async (context) => {
-		const authProperties = new AuthenticationProperties(
-			undefined,
-			undefined,
-		);
+		const authProperties = AuthenticationProperties.create();
 
 		await signOut(
 			context,

diff --git a/packages/mvc.core/src/HttpActionResult.ts b/packages/mvc.core/src/HttpActionResult.ts
@@ -0,0 +1,27 @@
+import { ActionContext, IResult } from '@yohira/mvc.abstractions';
+
+import { ActionResult } from './ActionResult';
+
+// https://source.dot.net/#Microsoft.AspNetCore.Mvc.Core/HttpActionResult.cs,da90aa64087eee48,references
+/**
+ * An {@link ActionResult} that when executed will produce a response based on the {@link IResult} provided.
+ */
+export class HttpActionResult extends ActionResult {
+	/**
+	 * Initializes a new instance of the <see cref="HttpActionResult"/> class with the
+	 * {@link IResult} provided.
+	 * @param result The {@link IResult} instance to be used during the {@link executeResult} invocation.
+	 */
+	constructor(
+		/**
+		 * Gets the instance of the current {@link IResult}.
+		 */
+		readonly result: IResult,
+	) {
+		super();
+	}
+
+	executeResult(context: ActionContext): Promise<void> {
+		return this.result.execute(context.httpContext);
+	}
+}
diff --git a/packages/mvc.core/src/index.ts b/packages/mvc.core/src/index.ts
@@ -1,4 +1,6 @@
 export * from './dependency-injection/MvcCoreServiceCollectionExtensions';
+export * from './infrastructure/ContentResultExecutor';
+export * from './infrastructure/RedirectResultExecutor';
 export * from './ActionResult';
 export * from './BadRequestResult';
 export * from './ChallengeResult';
@@ -9,6 +11,8 @@ export * from './FileContentResult';
 export * from './FileResult';
 export * from './FileStreamResult';
 export * from './ForbidResult';
+export * from './HttpActionResult';
+export * from './IStatusCodeActionResult';
 export * from './JsonResult';
 export * from './NoContentResult';
 export * from './NotFoundResult';

diff --git a/packages/mvc.core/test/BadRequestResult.test.ts b/packages/mvc.core/test/BadRequestResult.test.ts
@@ -0,0 +1,10 @@
+import { StatusCodes } from '@yohira/http.abstractions';
+import { BadRequestResult } from '@yohira/mvc.core';
+import { expect, test } from 'vitest';
+
+// https://github.com/dotnet/aspnetcore/blob/49c1c68bf1ac4f1f28db5c1b33ec5b7bab35546b/src/Mvc/Mvc.Core/test/BadRequestResultTests.cs#L11
+test('BadRequestResult_InitializesStatusCode', () => {
+	const badRequest = new BadRequestResult();
+
+	expect(badRequest.statusCode).toBe(StatusCodes.Status400BadRequest);
+});