Compare revisions

michael.minelli · michael.minelli · michael.minelli · michael.minelli · michael.minelli · michael.minelli
--- a/config/ClientsSharedConfig.ts
+++ b/config/ClientsSharedConfig.ts
@@ -21,28 +21,28 @@ class ClientsSharedConfig {


    constructor() {
-        this.apiURL = process.env.API_URL || '';
+        this.apiURL = process.env.API_URL ?? '';

        this.assignment = {
-            filename   : process.env.ASSIGNMENT_FILENAME || '',
-            neededFiles: JSON.parse(process.env.EXERCISE_NEEDED_FILES || '[]')
+            filename   : process.env.ASSIGNMENT_FILENAME ?? '',
+            neededFiles: JSON.parse(process.env.EXERCISE_NEEDED_FILES ?? '[]')
        };

        this.gitlab = {
            dojoAccount: {
-                id      : Number(process.env.GITLAB_DOJO_ACCOUNT_ID) || -1,
-                username: process.env.GITLAB_DOJO_ACCOUNT_USERNAME || ''
+                id      : Number(process.env.GITLAB_DOJO_ACCOUNT_ID ?? -1),
+                username: process.env.GITLAB_DOJO_ACCOUNT_USERNAME ?? ''
            }
        };

        this.dockerCompose = {
-            projectName: process.env.DOCKER_COMPOSE_PROJECT_NAME || ''
+            projectName: process.env.DOCKER_COMPOSE_PROJECT_NAME ?? ''
        };

-        this.exerciseResultsFolderMaxSizeInBytes = Number(process.env.EXERCISE_RESULTS_FOLDER_MAX_SIZE_IN_BYTES || 0);
+        this.exerciseResultsFolderMaxSizeInBytes = Number(process.env.EXERCISE_RESULTS_FOLDER_MAX_SIZE_IN_BYTES ?? 0);

        this.filenames = {
-            results: process.env.EXERCISE_RESULTS_FILENAME || ''
+            results: process.env.EXERCISE_RESULTS_FILENAME ?? ''
        };
    }
 }

--- a/helpers/Dojo/AssignmentValidator.ts
+++ b/helpers/Dojo/AssignmentValidator.ts
--- a/helpers/Dojo/ClientsSharedAssignmentHelper.ts
+++ b/helpers/Dojo/ClientsSharedAssignmentHelper.ts
@@ -6,7 +6,8 @@ import AssignmentValidator from './AssignmentValidator';

 class ClientsSharedAssignmentHelper {
    displayExecutionResults(validator: AssignmentValidator, successMessage: string, Style: { INFO: chalk.Chalk, SUCCESS: chalk.Chalk, FAILURE: chalk.Chalk }) {
-        const finalLogGlobalResult = `${ Style.INFO('Global result') } : ${ validator.success ? Style.SUCCESS(`${ Icon.SUCCESS } Success`) : Style.FAILURE(`${ Icon.FAILURE } Failure`) }`;
+        const globalResult = validator.success ? Style.SUCCESS(`${ Icon.SUCCESS } Success`) : Style.FAILURE(`${ Icon.FAILURE } Failure`);
+        const finalLogGlobalResult = `${ Style.INFO('Global result') } : ${ globalResult }`;

        const finalLogSuccessMessage = validator.success ? `${ successMessage }` : '';
        const finalLogErrorMessage = !validator.success ? `${ Style.INFO('Error message') } :\n${ Style.FAILURE(validator.fatalErrorMessage) }` : '';

--- a/helpers/Dojo/ClientsSharedExerciseHelper.ts
+++ b/helpers/Dojo/ClientsSharedExerciseHelper.ts
@@ -5,27 +5,31 @@ import Icon                from '../../../shared/types/Icon';


 class ClientsSharedExerciseHelper {
-    displayExecutionResults(exerciseResults: ExerciseResultsFile, containerExitCode: number, Style: { INFO: chalk.Chalk, SUCCESS: chalk.Chalk, FAILURE: chalk.Chalk }, additionalText: string = '') {
-        const finalLogGlobalResult = `${ Style.INFO('Global result: ') }${ exerciseResults.success ? Style.SUCCESS(`${ Icon.SUCCESS } Success`) : Style.FAILURE(`${ Icon.FAILURE } Failure`) }`;

-        const finalLogExecutionExitCode = `${ Style.INFO('Execution exit code: ') }${ (containerExitCode == 0 ? Style.SUCCESS : Style.FAILURE)(containerExitCode) }`;
+    private getOtherInformations(exerciseResults: ExerciseResultsFile, Style: { INFO: chalk.Chalk, SUCCESS: chalk.Chalk, FAILURE: chalk.Chalk }) {
+        return exerciseResults.otherInformations ? [ '', ...exerciseResults.otherInformations.map(information => {
+            const informationTitle = Style.INFO(`${ information.icon && information.icon !== '' ? Icon[information.icon] + ' ' : '' }${ information.name }: `);
+            const informationItems = typeof information.itemsOrInformations == 'string' ? information.itemsOrInformations : information.itemsOrInformations.map(item => `- ${ item }`).join('\n');

-        const finalLogResultNumbers = exerciseResults.successfulTests || exerciseResults.failedTests ? `\n\n${ Style.INFO(Style.SUCCESS('Tests passed: ')) }${ exerciseResults.successfulTests ?? '--' }\n${ Style.INFO(Style.FAILURE('Tests failed: ')) }${ exerciseResults.failedTests ?? '--' }` : '';
+            return `${ informationTitle }\n${ informationItems }`;
+        }) ].join('\n\n') : '';
+    }

-        const finalLogSuccessResultDetails = (exerciseResults.successfulTestsList ?? []).map(testName => `- ${ Icon.SUCCESS } ${ testName }`).join('\n');
-        const finalLogFailedResultDetails = (exerciseResults.failedTestsList ?? []).map(testName => `- ${ Icon.FAILURE } ${ testName }`).join('\n');
-        const finalLogResultDetails = exerciseResults.successfulTestsList || exerciseResults.failedTestsList ? `\n\n${ Style.INFO('Tests: ') }${ finalLogSuccessResultDetails != '' ? '\n' + finalLogSuccessResultDetails : '' }${ finalLogFailedResultDetails != '' ? '\n' + finalLogFailedResultDetails : '' }` : '';
+    displayExecutionResults(exerciseResults: ExerciseResultsFile, containerExitCode: number, Style: { INFO: chalk.Chalk, SUCCESS: chalk.Chalk, FAILURE: chalk.Chalk }, additionalText: string = '') {
+        const globalResult = exerciseResults.success ? Style.SUCCESS(`${ Icon.SUCCESS } Success`) : Style.FAILURE(`${ Icon.FAILURE } Failure`);
+        const finalLogGlobalResult = `${ Style.INFO('Global result: ') }${ globalResult }`;
+
+        const finalLogExecutionExitCode = `${ Style.INFO('Execution exit code: ') }${ (containerExitCode === 0 ? Style.SUCCESS : Style.FAILURE)(containerExitCode) }`;

-        let finalLogInformations = '';
-        if ( exerciseResults.otherInformations ) {
-            finalLogInformations = [ '', ...exerciseResults.otherInformations.map(information => {
-                const informationTitle = Style.INFO(`${ information.icon && information.icon != '' ? Icon[information.icon] + ' ' : '' }${ information.name }: `);
-                const informationItems = typeof information.itemsOrInformations == 'string' ? information.itemsOrInformations : information.itemsOrInformations.map(item => `- ${ item }`).join('\n');
+        const finalLogResultNumbers = exerciseResults.successfulTests || exerciseResults.failedTests ? `\n\n${ Style.INFO(Style.SUCCESS('Tests passed: ')) }${ exerciseResults.successfulTests ?? '--' }\n${ Style.INFO(Style.FAILURE('Tests failed: ')) }${ exerciseResults.failedTests ?? '--' }` : '';

-                return `${ informationTitle }\n${ informationItems }`;
-            }) ].join('\n\n');
-        }
+        let finalLogSuccessResultDetails = (exerciseResults.successfulTestsList ?? []).map(testName => `- ${ Icon.SUCCESS } ${ testName }`).join('\n');
+        finalLogSuccessResultDetails = finalLogSuccessResultDetails !== '' ? '\n' + finalLogSuccessResultDetails : '';
+        let finalLogFailedResultDetails = (exerciseResults.failedTestsList ?? []).map(testName => `- ${ Icon.FAILURE } ${ testName }`).join('\n');
+        finalLogFailedResultDetails = finalLogFailedResultDetails !== '' ? '\n' + finalLogFailedResultDetails : '';
+        const finalLogResultDetails = exerciseResults.successfulTestsList || exerciseResults.failedTestsList ? `\n\n${ Style.INFO('Tests: ') }${ finalLogSuccessResultDetails }${ finalLogFailedResultDetails }` : '';

+        const finalLogInformations = this.getOtherInformations(exerciseResults, Style);

        console.log(boxen(`${ finalLogGlobalResult }\n\n${ finalLogExecutionExitCode }${ finalLogResultNumbers }${ finalLogResultDetails }${ finalLogInformations }${ additionalText }`, {
            title         : 'Results',

--- a/helpers/Dojo/DojoBackendHelper.ts
+++ b/helpers/Dojo/DojoBackendHelper.ts
+import ApiRoute            from '../../types/Dojo/ApiRoute';
+import ClientsSharedConfig from '../../config/ClientsSharedConfig';
+
+
+class DojoBackendHelper {
+    public getApiUrl(route: ApiRoute, options?: Partial<{ assignmentNameOrUrl: string, exerciseIdOrUrl: string, gitlabProjectId: string }>): string {
+        const url = `${ ClientsSharedConfig.apiURL }${ route }`;
+
+        if ( options ) {
+            if ( options.assignmentNameOrUrl ) {
+                return url.replace('{{assignmentNameOrUrl}}', encodeURIComponent(options.assignmentNameOrUrl));
+            }
+
+            if ( options.exerciseIdOrUrl ) {
+                return url.replace('{{exerciseIdOrUrl}}', encodeURIComponent(options.exerciseIdOrUrl));
+            }
+
+            if ( options.gitlabProjectId ) {
+                return url.replace('{{gitlabProjectId}}', encodeURIComponent(options.gitlabProjectId));
+            }
+        }
+
+        return url;
+    }
+}
+
+
+export default new DojoBackendHelper();
\ No newline at end of file
--- a/helpers/Dojo/ExerciseDockerCompose.ts
+++ b/helpers/Dojo/ExerciseDockerCompose.ts
@@ -18,7 +18,17 @@ class ExerciseDockerCompose {

    private currentStep: string = 'NOT_RUNNING';

-    constructor(private projectName: string, private assignmentFile: AssignmentFile, private executionFolder: string, private composeFileOverride: Array<string> = []) {
+    private readonly projectName: string;
+    private readonly assignmentFile: AssignmentFile;
+    private readonly executionFolder: string;
+    private readonly composeFileOverride: Array<string> = [];
+
+    constructor(projectName: string, assignmentFile: AssignmentFile, executionFolder: string, composeFileOverride: Array<string> = []) {
+        this.projectName = projectName;
+        this.assignmentFile = assignmentFile;
+        this.executionFolder = executionFolder;
+        this.composeFileOverride = composeFileOverride;
+
        this.events.on('logs', (log: string, _error: boolean, displayable: boolean) => {
            this.allLogs += log;
            this.displayableLogs += displayable ? log : '';
@@ -49,15 +59,15 @@ class ExerciseDockerCompose {
    }

    private registerChildProcess(childProcess: ChildProcessWithoutNullStreams, resolve: (value: (number | PromiseLike<number>)) => void, reject: (reason?: unknown) => void, displayable: boolean, rejectIfCodeIsNotZero: boolean) {
-        childProcess.stdout.on('data', (data) => {
+        childProcess.stdout.on('data', data => {
            this.log(data.toString(), false, displayable);
        });

-        childProcess.stderr.on('data', (data) => {
+        childProcess.stderr.on('data', data => {
            this.log(data.toString(), true, displayable);
        });

-        childProcess.on('exit', (code) => {
+        childProcess.on('exit', code => {
            code === null || (rejectIfCodeIsNotZero && code !== 0) ? reject(code) : resolve(code);
        });
    }
@@ -66,7 +76,8 @@ class ExerciseDockerCompose {
        (async () => {
            let containerExitCode: number = -1;

-            const dockerComposeCommand = `docker compose --project-name ${ this.projectName } --progress plain --file docker-compose.yml ${ this.composeFileOverride.map((file) => `--file "${ file }"`).join(' ') }`;
+            const filesOverrideArguments = this.composeFileOverride.map(file => `--file "${ file }"`).join(' ');
+            const dockerComposeCommand = `docker compose --project-name ${ this.projectName } --progress plain --file docker-compose.yml ${ filesOverrideArguments }`;

            // Run the service
            {

--- a/helpers/Dojo/ExerciseResultsSanitizerAndValidator.ts
+++ b/helpers/Dojo/ExerciseResultsSanitizerAndValidator.ts
@@ -17,7 +17,15 @@ class ExerciseResultsSanitizerAndValidator {

    private resultsFilePath: string = '';

-    constructor(private folderResultsDojo: string, private folderResultsExercise: string, private containerExitCode: number) { }
+    private readonly folderResultsDojo: string;
+    private readonly folderResultsExercise: string;
+    private readonly containerExitCode: number;
+
+    constructor(folderResultsDojo: string, folderResultsExercise: string, containerExitCode: number) {
+        this.folderResultsDojo = folderResultsDojo;
+        this.folderResultsExercise = folderResultsExercise;
+        this.containerExitCode = containerExitCode;
+    }

    private async resultsFileSanitization() {
        this.events.emit('step', 'RESULTS_FILE_SANITIZATION', 'Sanitizing results file');
@@ -33,11 +41,11 @@ class ExerciseResultsSanitizerAndValidator {
        this.events.emit('endStep', 'RESULTS_FILE_SANITIZATION', 'Results file sanitized', false);
    }

-    private async resultsFileProvided(path: string): Promise<boolean> {
+    private async resultsFileProvided(resultFilePath: string): Promise<boolean> {
        // Results file schema validation
        {
            this.events.emit('step', 'VALIDATE_RESULTS_FILE', 'Validating results file schema');
-            const validationResults = Json5FileValidator.validateFile(ExerciseResultsFile, path);
+            const validationResults = Json5FileValidator.validateFile(ExerciseResultsFile, resultFilePath);
            if ( !validationResults.isValid ) {
                this.events.emit('endStep', 'VALIDATE_RESULTS_FILE', `Results file is not valid. Here are the errors :\n${ validationResults.error }`, true);
                this.events.emit('finished', false, ExerciseCheckerError.EXERCISE_RESULTS_FILE_SCHEMA_NOT_VALID);

--- a/models/Assignment.ts
+++ b/models/Assignment.ts
@@ -14,6 +14,8 @@ interface Assignment {

    staff: Array<User>;
    exercises: Array<Exercise>;
+
+    corrections: Array<Exercise>;
 }



--- a/models/Exercise.ts
+++ b/models/Exercise.ts
 import GitlabRepository from '../../shared/types/Gitlab/GitlabRepository';
+import * as Gitlab      from '@gitbeaker/rest';
+import User             from './User';
+import Assignment       from './Assignment';


 interface Exercise {
@@ -10,6 +13,12 @@ interface Exercise {
    gitlabCreationInfo: GitlabRepository;
    gitlabLastInfo: GitlabRepository;
    gitlabLastInfoDate: string;
+
+    members: Array<User> | undefined;
+    assignment: Assignment | undefined;
+
+    isCorrection: boolean;
+    correctionCommit: Gitlab.CommitSchema | undefined;
 }



--- a/types/Dojo/ApiRoute.ts
+++ b/types/Dojo/ApiRoute.ts
@@ -2,14 +2,16 @@ enum ApiRoute {
    LOGIN                        = '/login',
    REFRESH_TOKENS               = '/refresh_tokens',
    TEST_SESSION                 = '/test_session',
-    GITLAB_CHECK_TEMPLATE_ACCESS = '/gitlab/project/{{id}}/checkTemplateAccess',
-    ASSIGNMENT_GET               = '/assignments/{{nameOrUrl}}',
+    GITLAB_CHECK_TEMPLATE_ACCESS = '/gitlab/project/{{gitlabProjectId}}/checkTemplateAccess',
+    ASSIGNMENT_GET               = '/assignments/{{assignmentNameOrUrl}}',
    ASSIGNMENT_CREATE            = '/assignments',
-    ASSIGNMENT_PUBLISH           = '/assignments/{{nameOrUrl}}/publish',
-    ASSIGNMENT_UNPUBLISH         = '/assignments/{{nameOrUrl}}/unpublish',
-    EXERCISE_CREATE              = '/assignments/{{nameOrUrl}}/exercises',
-    EXERCISE_ASSIGNMENT          = '/exercises/{{id}}/assignment',
-    EXERCISE_RESULTS             = '/exercises/{{id}}/results'
+    ASSIGNMENT_PUBLISH           = '/assignments/{{assignmentNameOrUrl}}/publish',
+    ASSIGNMENT_UNPUBLISH         = '/assignments/{{assignmentNameOrUrl}}/unpublish',
+    ASSIGNMENT_CORRECTION_LINK   = '/assignments/{{assignmentNameOrUrl}}/corrections',
+    ASSIGNMENT_CORRECTION_UPDATE = '/assignments/{{assignmentNameOrUrl}}/corrections/{{exerciseIdOrUrl}}',
+    EXERCISE_CREATE              = '/assignments/{{assignmentNameOrUrl}}/exercises',
+    EXERCISE_ASSIGNMENT          = '/exercises/{{exerciseIdOrUrl}}/assignment',
+    EXERCISE_RESULTS             = '/exercises/{{exerciseIdOrUrl}}/results'
 }
No results found