config/SharedConfig.ts

@@ -3,11 +3,19 @@ class SharedConfig {
 
     public readonly logsFolder: string;
 
+    public gitlab: {
+        apiURL: string
+    };
+
 
     constructor() {
         this.production = process.env.NODE_ENV === 'production';
 
         this.logsFolder = process.env.LOGS_FOLDER || '';
+
+        this.gitlab = {
+            apiURL: process.env.GITLAB_API_URL || ''
+        };
     }
 }
 

helpers/Dojo/SharedAssignmentHelper.ts

@@ -2,6 +2,10 @@ import Ajv, { ErrorObject, JTDSchemaType } from 'ajv/dist/jtd';
 import fs                                  from 'fs';
 import JSON5                               from 'json5';
 import AssignmentFile                      from '../../types/Dojo/AssignmentFile';
+import GitlabPipelineStatus                from '../../types/Gitlab/GitlabPipelineStatus';
+import DojoStatusCode                      from '../../types/Dojo/DojoStatusCode';
+import GitlabPipeline                      from '../../types/Gitlab/GitlabPipeline';
+import SharedGitlabManager                 from '../../managers/SharedGitlabManager';
 
 
 class SharedAssignmentHelper {
@@ -16,8 +20,10 @@ class SharedAssignmentHelper {
                 immutable: {
                     elements: {
                         properties        : {
+                            path: { type: 'string' }
+                        },
+                        optionalProperties: {
                             description: { type: 'string' },
-                            path       : { type: 'string' },
                             isDirectory: { type: 'boolean' }
                         }
                     }
@@ -67,6 +73,37 @@ class SharedAssignmentHelper {
                 };
         }
     }
+
+    async isPublishable(repositoryId: number): Promise<{ isPublishable: boolean, lastPipeline: GitlabPipeline | null, status?: { code: DojoStatusCode, message: string } }> {
+        const pipelines = await SharedGitlabManager.getRepositoryPipelines(repositoryId, 'main');
+        if ( pipelines.length > 0 ) {
+            const lastPipeline = pipelines[0];
+            if ( lastPipeline.status != GitlabPipelineStatus.SUCCESS ) {
+                return {
+                    isPublishable: false,
+                    lastPipeline : lastPipeline,
+                    status       : {
+                        code   : DojoStatusCode.ASSIGNMENT_PUBLISH_PIPELINE_FAILED,
+                        message: `Last pipeline status is not "${ GitlabPipelineStatus.SUCCESS }" but "${ lastPipeline.status }".`
+                    }
+                };
+            } else {
+                return {
+                    isPublishable: true,
+                    lastPipeline : lastPipeline
+                };
+            }
+        } else {
+            return {
+                isPublishable: false,
+                lastPipeline : null,
+                status       : {
+                    code   : DojoStatusCode.ASSIGNMENT_PUBLISH_NO_PIPELINE,
+                    message: 'No pipeline found for this assignment.'
+                }
+            };
+        }
+    }
 }
 
 

managers/SharedGitlabManager.ts

+import axios          from 'axios';
+import GitlabPipeline from '../types/Gitlab/GitlabPipeline';
+import GitlabRoute    from '../types/Gitlab/GitlabRoute';
+import SharedConfig   from '../config/SharedConfig';
+
+
+class GitlabManager {
+    private getApiUrl(route: GitlabRoute): string {
+        return `${ SharedConfig.gitlab.apiURL }${ route }`;
+    }
+
+    async getRepositoryPipelines(repoId: number, branch: string = 'main'): Promise<Array<GitlabPipeline>> {
+        const response = await axios.get<Array<GitlabPipeline>>(this.getApiUrl(GitlabRoute.REPOSITORY_PIPELINES).replace('{{id}}', String(repoId)), {
+            params: {
+                ref: branch
+            }
+        });
+
+        return response.data;
+    }
+}
+
+
+export default new GitlabManager();

types/Dojo/AssignmentCheckerError.ts

+enum ExerciseCheckerError {
+    DOCKER_DAEMON_NOT_RUNNING       = 200,
+    REQUIRED_FILES_MISSING          = 201,
+    ASSIGNMENT_FILE_SCHEMA_ERROR    = 202,
+    IMMUTABLE_PATH_NOT_FOUND        = 203,
+    IMMUTABLE_PATH_IS_DIRECTORY     = 204,
+    IMMUTABLE_PATH_IS_NOT_DIRECTORY = 205,
+    COMPOSE_FILE_YAML_ERROR         = 206,
+    COMPOSE_FILE_SCHEMA_ERROR       = 207,
+    COMPOSE_FILE_CONTAINER_MISSING  = 208,
+    COMPOSE_FILE_VOLUME_MISSING     = 209,
+    DOCKERFILE_NOT_FOUND            = 210,
+    COMPOSE_RUN_SUCCESSFULLY        = 211, // Yes, this is an error
+}
+
+
+/**
+ * Codes that are unusable for historic reasons:
+ * None
+ */
+
+
+export default ExerciseCheckerError;
\ No newline at end of file

types/Dojo/DojoStatusCode.ts

 enum DojoStatusCode {
     CLIENT_NOT_SUPPORTED               = 100,
-    CLIENT_VERSION_NOT_SUPPORTED = 110
+    CLIENT_VERSION_NOT_SUPPORTED       = 110,
+    ASSIGNMENT_PUBLISH_NO_PIPELINE     = 200,
+    ASSIGNMENT_PUBLISH_PIPELINE_FAILED = 201
 }
 
 

types/Dojo/ImmutableFileDescriptor.ts

 interface ImmutableFileDescriptor {
-    description: string,
+    description?: string,
     path: string,
-    isDirectory: boolean,
+    isDirectory?: boolean,
 }
 
 

types/Gitlab/GitlabPipeline.ts

+import GitlabPipelineStatus from './GitlabPipelineStatus';
+import GitlabPipelineSource from './GitlabPipelineSource';
+import GitlabUser           from './GitlabUser';
+
+
+interface GitlabPipeline {
+    id: number,
+    iid: number,
+    project_id: number,
+    status: GitlabPipelineStatus,
+    source: GitlabPipelineSource,
+    ref: string,
+    sha: string,
+    before_sha: string,
+    tag: boolean,
+    name: string,
+    yaml_errors: string | null,
+    user: GitlabUser,
+    web_url: string,
+    created_at: string,
+    updated_at: string,
+    started_at: string | null,
+    finished_at: string | null,
+    committed_at: string | null,
+    duration: number | null,
+    queued_duration: number | null,
+    coverage: string | null,
+}
+
+
+export default GitlabPipeline;
\ No newline at end of file

types/Gitlab/GitlabPipelineSource.ts

+enum GitlabPipelineSource {
+    PUSH                      = 'push',
+    WEB                       = 'web',
+    TRIGGER                   = 'trigger',
+    SCHEDULE                  = 'schedule',
+    API                       = 'api',
+    EXTERNAL                  = 'external',
+    PIPELINE                  = 'pipeline',
+    CHAT                      = 'chat',
+    WEBIDE                    = 'webide',
+    MERGE_REQUEST             = 'merge_request_event',
+    EXTERNAL_PULL_REQUEST     = 'external_pull_request_event',
+    PARENT_PIPELINE           = 'parent_pipeline',
+    ON_DEMAND_DAST_SCAN       = 'ondemand_dast_scan',
+    ON_DEMAND_DAST_VALIDATION = 'ondemand_dast_validation',
+}
+
+
+export default GitlabPipelineSource;

types/Gitlab/GitlabPipelineStatus.ts

+enum GitlabPipelineStatus {
+    CREATED              = 'created',
+    WAITING_FOR_RESOURCE = 'waiting_for_resource',
+    PREPARING            = 'preparing',
+    PENDING              = 'pending',
+    RUNNING              = 'running',
+    SUCCESS              = 'success',
+    FAILED               = 'failed',
+    CANCELED             = 'canceled',
+    SKIPPED              = 'skipped',
+    MANUAL               = 'manual',
+    SCHEDULED            = 'scheduled'
+}
+
+
+export default GitlabPipelineStatus;

types/Gitlab/GitlabRoute.ts

@@ -12,6 +12,7 @@ enum GitlabRoute {
     REPOSITORY_BRANCHES_PROTECT = '/projects/{{id}}/protected_branches',
     REPOSITORY_TREE             = '/projects/{{id}}/repository/tree',
     REPOSITORY_FILE             = '/projects/{{id}}/repository/files/{{filePath}}',
+    REPOSITORY_PIPELINES        = '/projects/{{id}}/pipelines',
 }