EW-1019: TSP Testing

.gitignore

@@ -88,3 +88,6 @@ build
 /.idea/
 /apps/server/src/modules/board/loadtest/**/*.html
 /apps/server/src/modules/board/loadtest/artilleryreport.json
+
+# Docker
+docker-compose.yml

apps/server/src/infra/sync/sync.module.ts

@@ -18,6 +18,7 @@ import { TspSyncService } from './tsp/tsp-sync.service';
 import { TspSyncStrategy } from './tsp/tsp-sync.strategy';
 import { SyncUc } from './uc/sync.uc';
 import { TspFetchService } from './tsp/tsp-fetch.service';
+import { TspSyncMigrationService } from './tsp/tsp-sync-migration.service';
 
 @Module({
 	imports: [
@@ -41,7 +42,14 @@ import { TspFetchService } from './tsp/tsp-fetch.service';
 		SyncUc,
 		SyncService,
 		...((Configuration.get('FEATURE_TSP_SYNC_ENABLED') as boolean)
-			? [TspSyncStrategy, TspSyncService, TspOauthDataMapper, TspFetchService, TspLegacyMigrationService]
+			? [
+					TspSyncStrategy,
+					TspSyncService,
+					TspOauthDataMapper,
+					TspFetchService,
+					TspLegacyMigrationService,
+					TspSyncMigrationService,
+			  ]
 			: []),
 	],
 	exports: [SyncConsole],

apps/server/src/infra/sync/tsp/loggable/tsp-legacy-migration-start.loggable.ts

@@ -1,7 +1,7 @@
 import { Loggable, LogMessage } from '@src/core/logger';
 
 export class TspLegacyMigrationStartLoggable implements Loggable {
-	getLogMessage(): LogMessage {
+	public getLogMessage(): LogMessage {
 		const message: LogMessage = {
 			message: 'Running migration of legacy tsp data.',
 		};

apps/server/src/infra/sync/tsp/loggable/tsp-legacy-migration-system-missing.loggable.ts

@@ -1,7 +1,7 @@
 import { Loggable, LogMessage } from '@src/core/logger';
 
 export class TspLegacyMigrationSystemMissingLoggable implements Loggable {
-	getLogMessage(): LogMessage {
+	public getLogMessage(): LogMessage {
 		const message: LogMessage = {
 			message: 'No legacy system found',
 		};

apps/server/src/infra/sync/tsp/loggable/tsp-legacy-school-migration-count.loggable.ts

@@ -3,7 +3,7 @@ import { Loggable, LogMessage } from '@src/core/logger';
 export class TspLegacySchoolMigrationCountLoggable implements Loggable {
 	constructor(private readonly total: number) {}
 
-	getLogMessage(): LogMessage {
+	public getLogMessage(): LogMessage {
 		const message: LogMessage = {
 			message: `Found ${this.total} legacy tsp schools to migrate`,
 			data: {

apps/server/src/infra/sync/tsp/loggable/tsp-legacy-school-migration-success.loggable.ts

@@ -3,7 +3,7 @@ import { Loggable, LogMessage } from '@src/core/logger';
 export class TspLegacySchoolMigrationSuccessLoggable implements Loggable {
 	constructor(private readonly total: number, private readonly migrated: number) {}
 
-	getLogMessage(): LogMessage {
+	public getLogMessage(): LogMessage {
 		const message: LogMessage = {
 			message: `Legacy tsp data migration finished. Total schools: ${this.total}, migrated schools: ${this.migrated}`,
 			data: {

apps/server/src/infra/sync/tsp/loggable/tsp-migration-batch-summary.loggable.spec.ts

@@ -0,0 +1,30 @@
+import { TspMigrationBatchSummaryLoggable } from './tsp-migration-batch-summary.loggable';
+
+describe(TspMigrationBatchSummaryLoggable.name, () => {
+	let loggable: TspMigrationBatchSummaryLoggable;
+
+	beforeAll(() => {
+		loggable = new TspMigrationBatchSummaryLoggable(1, 2, 3, 4, 5);
+	});
+
+	describe('when loggable is initialized', () => {
+		it('should be defined', () => {
+			expect(loggable).toBeDefined();
+		});
+	});
+
+	describe('getLogMessage', () => {
+		it('should return a log message', () => {
+			expect(loggable.getLogMessage()).toEqual({
+				message: `Migrated 2 users and 3 accounts in batch of size 1 (total done: 4, total migrations: 5)`,
+				data: {
+					batchSize: 1,
+					usersUpdated: 2,
+					accountsUpdated: 3,
+					totalDone: 4,
+					totalMigrations: 5,
+				},
+			});
+		});
+	});
+});

apps/server/src/infra/sync/tsp/loggable/tsp-migration-batch-summary.loggable.ts

@@ -0,0 +1,26 @@
+import { Loggable, LogMessage } from '@src/core/logger';
+
+export class TspMigrationBatchSummaryLoggable implements Loggable {
+	constructor(
+		private readonly batchSize: number,
+		private readonly usersUpdated: number,
+		private readonly accountsUpdated: number,
+		private readonly totalDone: number,
+		private readonly totalMigrations: number
+	) {}
+
+	public getLogMessage(): LogMessage {
+		const message: LogMessage = {
+			message: `Migrated ${this.usersUpdated} users and ${this.accountsUpdated} accounts in batch of size ${this.batchSize} (total done: ${this.totalDone}, total migrations: ${this.totalMigrations})`,
+			data: {
+				batchSize: this.batchSize,
+				usersUpdated: this.usersUpdated,
+				accountsUpdated: this.accountsUpdated,
+				totalDone: this.totalDone,
+				totalMigrations: this.totalMigrations,
+			},
+		};
+
+		return message;
+	}
+}

apps/server/src/infra/sync/tsp/loggable/tsp-students-fetched.loggable.spec.ts → apps/server/src/infra/sync/tsp/loggable/tsp-migrations-fetched.loggable.spec.ts

@@ -1,10 +1,10 @@
-import { TspStudentsFetchedLoggable } from './tsp-students-fetched.loggable';
+import { TspMigrationsFetchedLoggable } from './tsp-migrations-fetched.loggable';
 
-describe(TspStudentsFetchedLoggable.name, () => {
-	let loggable: TspStudentsFetchedLoggable;
+describe(TspMigrationsFetchedLoggable.name, () => {
+	let loggable: TspMigrationsFetchedLoggable;
 
 	beforeAll(() => {
-		loggable = new TspStudentsFetchedLoggable(10);
+		loggable = new TspMigrationsFetchedLoggable(10);
 	});
 
 	describe('when loggable is initialized', () => {
@@ -16,9 +16,9 @@ describe(TspStudentsFetchedLoggable.name, () => {
 	describe('getLogMessage', () => {
 		it('should return a log message', () => {
 			expect(loggable.getLogMessage()).toEqual({
-				message: `Fetched 10 students for migration from TSP`,
+				message: `Fetched 10 users for migration from TSP`,
 				data: {
-					tspStudentCount: 10,
+					tspUserMigrationCount: 10,
 				},
 			});
 		});

apps/server/src/infra/sync/tsp/loggable/tsp-migrations-fetched.loggable.ts

@@ -0,0 +1,16 @@
+import { Loggable, LogMessage } from '@src/core/logger';
+
+export class TspMigrationsFetchedLoggable implements Loggable {
+	constructor(private readonly tspUserMigrationCount: number) {}
+
+	public getLogMessage(): LogMessage {
+		const message: LogMessage = {
+			message: `Fetched ${this.tspUserMigrationCount} users for migration from TSP`,
+			data: {
+				tspUserMigrationCount: this.tspUserMigrationCount,
+			},
+		};
+
+		return message;
+	}
+}

apps/server/src/infra/sync/tsp/loggable/tsp-users-migrated.loggable.spec.ts

@@ -4,7 +4,7 @@ describe(TspUsersMigratedLoggable.name, () => {
 	let loggable: TspUsersMigratedLoggable;
 
 	beforeAll(() => {
-		loggable = new TspUsersMigratedLoggable(10);
+		loggable = new TspUsersMigratedLoggable(10, 5, 4);
 	});
 
 	describe('when loggable is initialized', () => {
@@ -16,9 +16,11 @@ describe(TspUsersMigratedLoggable.name, () => {
 	describe('getLogMessage', () => {
 		it('should return a log message', () => {
 			expect(loggable.getLogMessage()).toEqual({
-				message: `Migrated users: 10 users migrated`,
+				message: `Migrated 5 users and 4 accounts. Total amount of migrations requested: 10`,
 				data: {
-					migratedUsers: 10,
+					totalMigrations: 10,
+					migratedUsers: 5,
+					migratedAccounts: 4,
 				},
 			});
 		});

apps/server/src/infra/sync/tsp/loggable/tsp-users-migrated.loggable.ts

@@ -1,13 +1,19 @@
 import { Loggable, LogMessage } from '@src/core/logger';
 
 export class TspUsersMigratedLoggable implements Loggable {
-	constructor(private readonly migratedUsers: number) {}
+	constructor(
+		private readonly totalMigrations: number,
+		private readonly migratedUsers: number,
+		private readonly migratedAccounts: number
+	) {}
 
 	public getLogMessage(): LogMessage {
 		const message: LogMessage = {
-			message: `Migrated users: ${this.migratedUsers} users migrated`,
+			message: `Migrated ${this.migratedUsers} users and ${this.migratedAccounts} accounts. Total amount of migrations requested: ${this.totalMigrations}`,
 			data: {
+				totalMigrations: this.totalMigrations,
 				migratedUsers: this.migratedUsers,
+				migratedAccounts: this.migratedAccounts,
 			},
 		};