test(core): Move unit tests closer to testable components (no-changelog) (#10287)

packages/cli/src/sso/saml/__tests__/saml.service.ee.test.ts

@@ -0,0 +1,53 @@
+import { mock } from 'jest-mock-extended';
+import type express from 'express';
+import { SamlService } from '@/sso/saml/saml.service.ee';
+import { mockInstance } from '@test/mocking';
+import { UrlService } from '@/services/url.service';
+import { Logger } from '@/Logger';
+import type { IdentityProviderInstance, ServiceProviderInstance } from 'samlify';
+import * as samlHelpers from '@/sso/saml/samlHelpers';
+
+describe('SamlService', () => {
+	const logger = mockInstance(Logger);
+	const urlService = mockInstance(UrlService);
+	const samlService = new SamlService(logger, urlService);
+
+	describe('getAttributesFromLoginResponse', () => {
+		test('throws when any attribute is missing', async () => {
+			//
+			// ARRANGE
+			//
+			jest
+				.spyOn(samlService, 'getIdentityProviderInstance')
+				.mockReturnValue(mock<IdentityProviderInstance>());
+
+			const serviceProviderInstance = mock<ServiceProviderInstance>();
+			serviceProviderInstance.parseLoginResponse.mockResolvedValue({
+				samlContent: '',
+				extract: {},
+			});
+			jest
+				.spyOn(samlService, 'getServiceProviderInstance')
+				.mockReturnValue(serviceProviderInstance);
+
+			jest.spyOn(samlHelpers, 'getMappedSamlAttributesFromFlowResult').mockReturnValue({
+				attributes: {} as never,
+				missingAttributes: [
+					'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress',
+					'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/firstname',
+					'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/lastname',
+					'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn',
+				],
+			});
+
+			//
+			// ACT & ASSERT
+			//
+			await expect(
+				samlService.getAttributesFromLoginResponse(mock<express.Request>(), 'post'),
+			).rejects.toThrowError(
+				'SAML Authentication failed. Invalid SAML response (missing attributes: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress, http://schemas.xmlsoap.org/ws/2005/05/identity/claims/firstname, http://schemas.xmlsoap.org/ws/2005/05/identity/claims/lastname, http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn).',
+			);
+		});
+	});
+});

packages/cli/src/sso/saml/__tests__/samlHelpers.test.ts

@@ -0,0 +1,55 @@
+import { User } from '@/databases/entities/User';
+import { generateNanoId } from '@/databases/utils/generators';
+import * as helpers from '@/sso/saml/samlHelpers';
+import type { SamlUserAttributes } from '@/sso/saml/types/samlUserAttributes';
+import { mockInstance } from '@test/mocking';
+import { UserRepository } from '@/databases/repositories/user.repository';
+import type { AuthIdentity } from '@/databases/entities/AuthIdentity';
+import { AuthIdentityRepository } from '@/databases/repositories/authIdentity.repository';
+
+const userRepository = mockInstance(UserRepository);
+mockInstance(AuthIdentityRepository);
+
+describe('sso/saml/samlHelpers', () => {
+	describe('updateUserFromSamlAttributes', () => {
+		// We need to use `save` so that that the subscriber in
+		// packages/cli/src/databases/entities/Project.ts receives the full user.
+		// With `update` it would only receive the updated fields, e.g. the `id`
+		// would be missing.
+		test('does not user `Repository.update`, but `Repository.save` instead', async () => {
+			//
+			// ARRANGE
+			//
+			const user = Object.assign(new User(), {
+				id: generateNanoId(),
+				authIdentities: [] as AuthIdentity[],
+			} as User);
+			const samlUserAttributes: SamlUserAttributes = {
+				firstName: 'Nathan',
+				lastName: 'Nathaniel',
+				email: 'n@8.n',
+				userPrincipalName: 'Huh?',
+			};
+
+			userRepository.save.mockImplementationOnce(async (user) => user as User);
+
+			//
+			// ACT
+			//
+			await helpers.updateUserFromSamlAttributes(user, samlUserAttributes);
+
+			//
+			// ASSERT
+			//
+			expect(userRepository.save).toHaveBeenCalledWith(
+				{
+					...user,
+					firstName: samlUserAttributes.firstName,
+					lastName: samlUserAttributes.lastName,
+				},
+				{ transaction: false },
+			);
+			expect(userRepository.update).not.toHaveBeenCalled();
+		});
+	});
+});