BC-5628 cyclic data deletion

ansible/roles/schulcloud-server-core/tasks/main.yml

@@ -37,6 +37,13 @@
       template: onepassword.yml.j2
     when: ONEPASSWORD_OPERATOR is defined and ONEPASSWORD_OPERATOR|bool
 
+  - name: Admin API client secret (from 1Password)
+    kubernetes.core.k8s:
+      kubeconfig: ~/.kube/config
+      namespace: "{{ NAMESPACE }}"
+      template: onepassword-admin-api-client.yml.j2
+    when: ONEPASSWORD_OPERATOR is defined and ONEPASSWORD_OPERATOR|bool
+
   - name: remove old migration Job
     kubernetes.core.k8s:
       kubeconfig: ~/.kube/config
@@ -108,6 +115,12 @@
       namespace: "{{ NAMESPACE }}"
       template: api-delete-s3-files-cronjob.yml.j2
 
+  - name: Data deletion trigger CronJob
+    kubernetes.core.k8s:
+      kubeconfig: ~/.kube/config
+      namespace: "{{ NAMESPACE }}"
+      template: data-deletion-trigger-cronjob.yml.j2
+
   - name: AMQPFileStorageDeployment
     kubernetes.core.k8s:
       kubeconfig: ~/.kube/config

ansible/roles/schulcloud-server-core/templates/data-deletion-trigger-cronjob.yml.j2

@@ -0,0 +1,52 @@
+apiVersion: batch/v1
+kind: CronJob
+metadata:
+  namespace: {{ NAMESPACE }}
+  labels:
+    app: data-deletion-trigger
+    cronjob: data-deletion-trigger
+    app.kubernetes.io/part-of: schulcloud-verbund
+    app.kubernetes.io/version: {{ SCHULCLOUD_SERVER_IMAGE_TAG }}
+    app.kubernetes.io/name: data-deletion-trigger
+    app.kubernetes.io/component: data-deletion
+    app.kubernetes.io/managed-by: ansible
+    git.branch: {{ SCHULCLOUD_SERVER_BRANCH_NAME }}
+    git.repo: {{ SCHULCLOUD_SERVER_REPO_NAME }}
+  name: data-deletion-trigger-cronjob
+spec:
+  concurrencyPolicy: Forbid
+  schedule: "{{ SERVER_DATA_DELETION_TRIGGER_CRONJOB_SCHEDULE|default("@hourly", true) }}"
+  jobTemplate:
+    labels:
+      app: data-deletion-trigger
+      cronjob: data-deletion-trigger
+    spec:
+      template:
+        spec:
+          containers:
+          - name: data-deletion-trigger-cronjob
+            image: {{ SCHULCLOUD_SERVER_IMAGE }}:{{ SCHULCLOUD_SERVER_IMAGE_TAG }}
+            envFrom:
+            - secretRef:
+                name: admin-api-client-secret
+            command: ['/bin/sh', '-c']
+            args: ['npm run nest:start:deletion-console -- execution trigger']
+            resources:
+              limits:
+                cpu: {{ API_CPU_LIMITS|default("2000m", true) }}
+                memory: {{ API_MEMORY_LIMITS|default("2Gi", true) }}
+              requests:
+                cpu: {{ API_CPU_REQUESTS|default("100m", true) }}
+                memory: {{ API_MEMORY_REQUESTS|default("150Mi", true) }}
+          restartPolicy: OnFailure
+        metadata:
+          labels:
+            app: data-deletion-trigger
+            cronjob: data-deletion-trigger
+            app.kubernetes.io/part-of: schulcloud-verbund
+            app.kubernetes.io/version: {{ SCHULCLOUD_SERVER_IMAGE_TAG }}
+            app.kubernetes.io/name: data-deletion-trigger
+            app.kubernetes.io/component: data-deletion
+            app.kubernetes.io/managed-by: ansible
+            git.branch: {{ SCHULCLOUD_SERVER_BRANCH_NAME }}
+            git.repo: {{ SCHULCLOUD_SERVER_REPO_NAME }}

ansible/roles/schulcloud-server-core/templates/onepassword-admin-api-client.yml.j2

@@ -0,0 +1,7 @@
+apiVersion: onepassword.com/v1
+kind: OnePasswordItem
+metadata:
+  name: admin-api-client-secret
+  namespace: {{ NAMESPACE }}
+spec:
+  itemPath: "vaults/{{ ONEPASSWORD_OPERATOR_VAULT }}/items/admin-api-client"

apps/server/src/modules/deletion/client/deletion.client.spec.ts

@@ -151,4 +151,42 @@ describe(DeletionClient.name, () => {
 			});
 		});
 	});
+
+	describe('executeDeletions', () => {
+		describe('when received valid response with expected HTTP status code', () => {
+			const setup = () => {
+				const limit = 10;
+
+				const response: AxiosResponse<DeletionRequestOutput> = axiosResponseFactory.build({
+					status: 204,
+				});
+
+				httpService.post.mockReturnValueOnce(of(response));
+
+				return { limit };
+			};
+
+			it('should return proper output', async () => {
+				const { limit } = setup();
+
+				await expect(client.executeDeletions(limit)).resolves.not.toThrow();
+			});
+		});
+
+		describe('when received invalid HTTP status code in a response', () => {
+			const setup = () => {
+				const response: AxiosResponse<DeletionRequestOutput> = axiosResponseFactory.build({
+					status: 200,
+				});
+
+				httpService.post.mockReturnValueOnce(of(response));
+			};
+
+			it('should throw an exception', async () => {
+				setup();
+
+				await expect(client.executeDeletions()).rejects.toThrow(Error);
+			});
+		});
+	});
 });

apps/server/src/modules/deletion/client/deletion.client.ts

@@ -13,6 +13,8 @@ export class DeletionClient {
 
 	private readonly postDeletionRequestsEndpoint: string;
 
+	private readonly postDeletionExecutionsEndpoint: string;
+
 	constructor(
 		private readonly httpService: HttpService,
 		private readonly configService: ConfigService<DeletionClientConfig, true>
@@ -22,6 +24,7 @@ export class DeletionClient {
 
 		// Prepare the POST /deletionRequests endpoint beforehand to not do it on every client call.
 		this.postDeletionRequestsEndpoint = new URL('/admin/api/v1/deletionRequests', this.baseUrl).toString();
+		this.postDeletionExecutionsEndpoint = new URL('/admin/api/v1/deletionExecutions', this.baseUrl).toString();
 	}
 
 	async queueDeletionRequest(input: DeletionRequestInput): Promise<DeletionRequestOutput> {
@@ -54,6 +57,32 @@ export class DeletionClient {
 			});
 	}
 
+	async executeDeletions(limit?: number): Promise<void> {
+		let requestConfig = {};
+
+		if (limit && limit > 0) {
+			requestConfig = { ...this.defaultHeaders(), params: { limit } };
+		} else {
+			requestConfig = { ...this.defaultHeaders() };
+		}
+
+		const request = this.httpService.post(this.postDeletionExecutionsEndpoint, null, requestConfig);
+
+		return firstValueFrom(request)
+			.then((resp: AxiosResponse) => {
+				// Throw an error if any other status code (other than expected "204 No Content" is returned).
+				if (resp.status !== 204) {
+					throw new Error(`invalid HTTP status code in a response from the server - ${resp.status} instead of 204`);
+				}
+
+				return undefined;
+			})
+			.catch((err: Error) => {
+				// Throw an error if sending/processing deletion executions request by the client failed in any way.
+				throw new Error(`failed to send/process a deletion request: ${err.toString()}`);
+			});
+	}
+
 	private apiKeyHeader() {
 		return { 'X-Api-Key': this.apiKey };
 	}

apps/server/src/modules/deletion/console/builder/index.ts

@@ -1 +1,2 @@
 export * from './push-delete-requests-options.builder';
+export * from './trigger-deletion-execution-options.builder';

apps/server/src/modules/deletion/console/builder/trigger-deletion-execution-options.builder.spec.ts

@@ -0,0 +1,24 @@
+import { TriggerDeletionExecutionOptions } from '../interface';
+import { TriggerDeletionExecutionOptionsBuilder } from './trigger-deletion-execution-options.builder';
+
+describe(TriggerDeletionExecutionOptionsBuilder.name, () => {
+	describe(TriggerDeletionExecutionOptionsBuilder.build.name, () => {
+		describe('when called with proper arguments', () => {
+			const setup = () => {
+				const limit = 1000;
+
+				const expectedOutput: TriggerDeletionExecutionOptions = { limit };
+
+				return { limit, expectedOutput };
+			};
+
+			it('should return valid object with expected values', () => {
+				const { limit, expectedOutput } = setup();
+
+				const output = TriggerDeletionExecutionOptionsBuilder.build(limit);
+
+				expect(output).toStrictEqual(expectedOutput);
+			});
+		});
+	});
+});

apps/server/src/modules/deletion/console/builder/trigger-deletion-execution-options.builder.ts

@@ -0,0 +1,7 @@
+import { TriggerDeletionExecutionOptions } from '../interface';
+
+export class TriggerDeletionExecutionOptionsBuilder {
+	static build(limit: number): TriggerDeletionExecutionOptions {
+		return { limit };
+	}
+}

apps/server/src/modules/deletion/console/deletion-console.module.ts

@@ -7,8 +7,9 @@ import { createConfigModuleOptions } from '@src/config';
 import { DeletionClient } from '../client';
 import { getDeletionClientConfig } from '../client/deletion-client.config';
 import { BatchDeletionService } from '../services';
-import { BatchDeletionUc } from '../uc';
+import { BatchDeletionUc, DeletionExecutionUc } from '../uc';
 import { DeletionQueueConsole } from './deletion-queue.console';
+import { DeletionExecutionConsole } from './deletion-execution.console';
 
 @Module({
 	imports: [
@@ -17,6 +18,13 @@ import { DeletionQueueConsole } from './deletion-queue.console';
 		HttpModule,
 		ConfigModule.forRoot(createConfigModuleOptions(getDeletionClientConfig)),
 	],
-	providers: [DeletionClient, BatchDeletionService, BatchDeletionUc, DeletionQueueConsole],
+	providers: [
+		DeletionClient,
+		BatchDeletionService,
+		BatchDeletionUc,
+		DeletionExecutionUc,
+		DeletionQueueConsole,
+		DeletionExecutionConsole,
+	],
 })
 export class DeletionConsoleModule {}

apps/server/src/modules/deletion/console/deletion-execution.console.spec.ts

@@ -0,0 +1,65 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { createMock } from '@golevelup/ts-jest';
+import { ConsoleWriterService } from '@infra/console';
+import { DeletionExecutionUc } from '../uc';
+import { DeletionExecutionConsole } from './deletion-execution.console';
+import { TriggerDeletionExecutionOptionsBuilder } from './builder';
+
+describe(DeletionExecutionConsole.name, () => {
+	let module: TestingModule;
+	let console: DeletionExecutionConsole;
+	let deletionExecutionUc: DeletionExecutionUc;
+
+	beforeAll(async () => {
+		module = await Test.createTestingModule({
+			providers: [
+				DeletionExecutionConsole,
+				{
+					provide: ConsoleWriterService,
+					useValue: createMock<ConsoleWriterService>(),
+				},
+				{
+					provide: DeletionExecutionUc,
+					useValue: createMock<DeletionExecutionUc>(),
+				},
+			],
+		}).compile();
+
+		console = module.get(DeletionExecutionConsole);
+		deletionExecutionUc = module.get(DeletionExecutionUc);
+	});
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+	});
+
+	afterAll(async () => {
+		await module.close();
+	});
+
+	it('console should be defined', () => {
+		expect(console).toBeDefined();
+	});
+
+	describe('triggerDeletionExecution', () => {
+		describe('when called with valid options', () => {
+			const setup = () => {
+				const limit = 1000;
+
+				const options = TriggerDeletionExecutionOptionsBuilder.build(1000);
+
+				return { limit, options };
+			};
+
+			it(`should call ${DeletionExecutionUc.name} with proper arguments`, async () => {
+				const { limit, options } = setup();
+
+				const spy = jest.spyOn(deletionExecutionUc, 'triggerDeletionExecution');
+
+				await console.triggerDeletionExecution(options);
+
+				expect(spy).toBeCalledWith(limit);
+			});
+		});
+	});
+});

apps/server/src/modules/deletion/console/deletion-execution.console.ts

@@ -0,0 +1,28 @@
+import { Command, Console } from 'nestjs-console';
+import { ConsoleWriterService } from '@infra/console';
+import { DeletionExecutionUc } from '../uc';
+import { TriggerDeletionExecutionOptions } from './interface';
+
+@Console({ command: 'execution', description: 'Console providing an access to the deletion execution(s).' })
+export class DeletionExecutionConsole {
+	constructor(private consoleWriter: ConsoleWriterService, private deletionExecutionUc: DeletionExecutionUc) {}
+
+	@Command({
+		command: 'trigger',
+		description: 'Trigger execution of deletion requests.',
+		options: [
+			{
+				flags: '-l, --limit <value>',
+				description: 'Limit of the requested deletion executions that should be performed.',
+				required: false,
+			},
+		],
+	})
+	async triggerDeletionExecution(options: TriggerDeletionExecutionOptions): Promise<void> {
+		const result = await this.deletionExecutionUc.triggerDeletionExecution(
+			options.limit ? Number(options.limit) : undefined
+		);
+
+		this.consoleWriter.info(JSON.stringify(result));
+	}
+}

apps/server/src/modules/deletion/console/interface/index.ts

@@ -1 +1,2 @@
 export * from './push-delete-requests-options.interface';
+export * from './trigger-deletion-execution-options.interface';

apps/server/src/modules/deletion/console/interface/trigger-deletion-execution-options.interface.ts

@@ -0,0 +1,3 @@
+export interface TriggerDeletionExecutionOptions {
+	limit: number;
+}

apps/server/src/modules/deletion/uc/builder/deletion-execution-trigger-result.builder.spec.ts

@@ -0,0 +1,45 @@
+import { DeletionExecutionTriggerResult, DeletionExecutionTriggerStatus } from '../interface';
+import { DeletionExecutionTriggerResultBuilder } from './deletion-execution-trigger-result.builder';
+
+describe(DeletionExecutionTriggerResultBuilder.name, () => {
+	describe(DeletionExecutionTriggerResultBuilder.buildSuccess.name, () => {
+		describe('when called', () => {
+			const setup = () => {
+				const expectedOutput: DeletionExecutionTriggerResult = { status: DeletionExecutionTriggerStatus.SUCCESS };
+
+				return { expectedOutput };
+			};
+
+			it('should return valid object indicating success', () => {
+				const { expectedOutput } = setup();
+
+				const output = DeletionExecutionTriggerResultBuilder.buildSuccess();
+
+				expect(output).toStrictEqual(expectedOutput);
+			});
+		});
+	});
+
+	describe(DeletionExecutionTriggerResultBuilder.buildFailure.name, () => {
+		describe('when called with proper arguments', () => {
+			const setup = () => {
+				const error = new Error('test error message');
+
+				const expectedOutput: DeletionExecutionTriggerResult = {
+					status: DeletionExecutionTriggerStatus.FAILURE,
+					error: error.toString(),
+				};
+
+				return { error, expectedOutput };
+			};
+
+			it('should return valid object with expected values', () => {
+				const { error, expectedOutput } = setup();
+
+				const output = DeletionExecutionTriggerResultBuilder.buildFailure(error);
+
+				expect(output).toStrictEqual(expectedOutput);
+			});
+		});
+	});
+});