Adriaan Jacquet](https://github.com/WhisperinCheetah) | Backend Lead | +| [
Francisco Gabriel Van Langenhove](https://github.com/Gabriellvl) | Team Lead | +| [
Gerald Schmittinger](https://github.com/geraldschmittinger) | Database Administrator | +| [
Joyelle Ndagijimana](https://github.com/joyelle436) | Frontend Lead | +| [
Laure Jablonski](https://github.com/laurejablonski) | Documentatie- en Test Lead | +| [
Tibo De Peuter](https://github.com/tdpeuter) | Technische Lead | +| [
Timo De Meyst](https://github.com/kloep1) | System Administrator | + +En in de toekomst misschien jij ook? diff --git a/assets/img/keycloak.png b/assets/img/keycloak.png new file mode 100644 index 00000000..6a79a7a2 Binary files /dev/null and b/assets/img/keycloak.png differ diff --git a/backend/.env.development.example b/backend/.env.development.example index 247ff054..466e1b7b 100644 --- a/backend/.env.development.example +++ b/backend/.env.development.example @@ -1,10 +1,16 @@ -DWENGO_PORT=3000 +# +# Basic configuration +# + +DWENGO_PORT=3000 # The port the backend will listen on DWENGO_DB_HOST=localhost DWENGO_DB_PORT=5431 DWENGO_DB_USERNAME=postgres DWENGO_DB_PASSWORD=postgres DWENGO_DB_UPDATE=true +# Auth + DWENGO_AUTH_STUDENT_URL=http://localhost:7080/realms/student DWENGO_AUTH_STUDENT_CLIENT_ID=dwengo DWENGO_AUTH_STUDENT_JWKS_ENDPOINT=http://localhost:7080/realms/student/protocol/openid-connect/certs @@ -14,3 +20,9 @@ DWENGO_AUTH_TEACHER_JWKS_ENDPOINT=http://localhost:7080/realms/teacher/protocol/ # Allow Vite dev-server to access the backend (for testing purposes). Don't forget to remove this in production! DWENGO_CORS_ALLOWED_ORIGINS=http://localhost:5173 + +# +# Advanced configuration +# + +# LOKI_HOST=http://localhost:9001 # The address of the Loki instance, used for logging diff --git a/backend/.env.example b/backend/.env.example index fd193c89..68cef35d 100644 --- a/backend/.env.example +++ b/backend/.env.example @@ -2,10 +2,9 @@ # Basic configuration # -# The port the backend will listen on -DWENGO_PORT=3000 +DWENGO_PORT=3000 # The port the backend will listen on DWENGO_DB_HOST=domain-or-ip-of-database -DWENGO_DB_PORT=5432 +DWENGO_DB_PORT=5431 # Change this to the actual credentials of the user Dwengo should use in the backend DWENGO_DB_USERNAME=postgres @@ -24,9 +23,5 @@ DWENGO_AUTH_TEACHER_URL=http://localhost:7080/realms/teacher DWENGO_AUTH_TEACHER_CLIENT_ID=dwengo DWENGO_AUTH_TEACHER_JWKS_ENDPOINT=http://localhost:7080/realms/teacher/protocol/openid-connect/certs -# -# Advanced configuration -# - # The address of the Lokiinstance, used for logging # LOKI_HOST=http://localhost:3102 diff --git a/backend/.env.production.example b/backend/.env.production.example new file mode 100644 index 00000000..390409d1 --- /dev/null +++ b/backend/.env.production.example @@ -0,0 +1,28 @@ +DWENGO_PORT=3000 # The port the backend will listen on +DWENGO_DB_HOST=db # Name of the database container +DWENGO_DB_PORT=5431 + +# Change this to the actual credentials of the user Dwengo should use in the backend +DWENGO_DB_NAME=postgres +DWENGO_DB_USERNAME=postgres +DWENGO_DB_PASSWORD=postgres + +# Set this to true when the database scheme needs to be updated. In that case, take a backup first. +DWENGO_DB_UPDATE=false + +# Data for the identity provider via which the students authenticate. +DWENGO_AUTH_STUDENT_URL=https://sel2-1.ugent.be/idp/realms/student +DWENGO_AUTH_STUDENT_CLIENT_ID=dwengo +DWENGO_AUTH_STUDENT_JWKS_ENDPOINT=http://idp:7080/idp/realms/student/protocol/openid-connect/certs # Name of the idp container +# Data for the identity provider via which the teachers authenticate. +DWENGO_AUTH_TEACHER_URL=https://sel2-1.ugent.be/idp/realms/teacher +DWENGO_AUTH_TEACHER_CLIENT_ID=dwengo +DWENGO_AUTH_TEACHER_JWKS_ENDPOINT=http://idp:7080/idp/realms/teacher/protocol/openid-connect/certs # Name of the idp container + +# +# Advanced configuration +# + +# Logging and monitoring + +# LOKI_HOST=http://logging:3102 # The address of the Loki instance, used for logging diff --git a/backend/.env.test b/backend/.env.test.example similarity index 100% rename from backend/.env.test rename to backend/.env.test.example diff --git a/backend/Dockerfile b/backend/Dockerfile new file mode 100644 index 00000000..5f26847c --- /dev/null +++ b/backend/Dockerfile @@ -0,0 +1,35 @@ +FROM node:22 AS build-stage + +WORKDIR /app + +# Install dependencies + +COPY package*.json ./ +COPY backend/package.json ./backend/ + +RUN npm install --silent + +# Build the backend + +# Root tsconfig.json +COPY tsconfig.json ./ + +WORKDIR /app/backend + +COPY backend ./ + +RUN npm run build + +FROM node:22 AS production-stage + +WORKDIR /app + +COPY package-lock.json backend/package.json ./ + +RUN npm install --silent --only=production + +COPY --from=build-stage /app/backend/dist ./dist/ + +EXPOSE 3000 + +CMD ["node", "--env-file=.env", "dist/app.js"] diff --git a/backend/README.md b/backend/README.md index 76bc8eae..442cea82 100644 --- a/backend/README.md +++ b/backend/README.md @@ -20,3 +20,18 @@ npm run dev npm run build npm run start ``` + +### Tests + +Voer volgend commando uit om de unit tests uit te voeren: + +``` +npm run test:unit +``` + +## Keycloak configuratie + +Tijdens development is het voldoende om gebruik te maken van de keycloak configuratie die automatisch ingeladen wordt. + +Voor productie is het ten sterkste aangeraden om keycloak manueel te configureren. +Voor meer informatie, zie de [administrator-handleiding](https://github.com/SELab-2/Dwengo-1/wiki/Administrator:-Productie-omgeving#installatie-en-server-configuratie). diff --git a/backend/config.ts b/backend/config.ts deleted file mode 100644 index 8fd8ec3f..00000000 --- a/backend/config.ts +++ /dev/null @@ -1,10 +0,0 @@ -// Can be placed in dotenv but found it redundant - -// Import dotenv from "dotenv"; - -// Load .env file -// Dotenv.config(); - -export const DWENGO_API_BASE = 'https://dwengo.org/backend/api'; - -export const FALLBACK_LANG = 'nl'; diff --git a/backend/eslint.config.ts b/backend/eslint.config.ts index f5f225b2..6b696021 100644 --- a/backend/eslint.config.ts +++ b/backend/eslint.config.ts @@ -8,4 +8,14 @@ export default [ globals: globals.node, }, }, + + { + files: ['tests/**/*.ts'], + languageOptions: { + globals: globals.node, + }, + rules: { + 'no-console': 'off', + }, + }, ]; diff --git a/backend/package.json b/backend/package.json index fafb24f4..9d7e886a 100644 --- a/backend/package.json +++ b/backend/package.json @@ -5,27 +5,34 @@ "private": true, "type": "module", "scripts": { - "build": "NODE_ENV=production tsc --project tsconfig.json", - "dev": "NODE_ENV=development tsx watch --env-file=.env.development.local src/app.ts", - "start": "NODE_ENV=production node --env-file=.env dist/app.js", + "build": "cross-env NODE_ENV=production tsc --project tsconfig.json", + "dev": "cross-env NODE_ENV=development tsx watch --env-file=.env.development.local src/app.ts", + "start": "cross-env NODE_ENV=production node --env-file=.env dist/app.js", "format": "prettier --write src/", "format-check": "prettier --check src/", "lint": "eslint . --fix", "test:unit": "vitest" }, "dependencies": { - "@mikro-orm/core": "6.4.6", - "@mikro-orm/postgresql": "6.4.6", - "@mikro-orm/reflection": "6.4.6", - "@mikro-orm/sqlite": "6.4.6", - "axios": "^1.8.1", + "@mikro-orm/core": "6.4.9", + "@mikro-orm/knex": "6.4.9", + "@mikro-orm/postgresql": "6.4.9", + "@mikro-orm/reflection": "6.4.9", + "@mikro-orm/sqlite": "6.4.9", + "axios": "^1.8.2", + "cors": "^2.8.5", + "cross": "^1.0.0", + "cross-env": "^7.0.3", "dotenv": "^16.4.7", "express": "^5.0.1", "express-jwt": "^8.5.1", - "jwks-rsa": "^3.1.0", + "gift-pegjs": "^1.0.2", + "isomorphic-dompurify": "^2.22.0", "js-yaml": "^4.1.0", - "cors": "^2.8.5", + "jsonpath-plus": "^10.3.0", + "jwks-rsa": "^3.1.0", "loki-logger-ts": "^1.0.2", + "marked": "^15.0.7", "response-time": "^2.3.3", "swagger-ui-express": "^5.0.1", "uuid": "^11.1.0", @@ -33,13 +40,13 @@ "winston-loki": "^6.1.3" }, "devDependencies": { - "@types/js-yaml": "^4.0.9", - "@mikro-orm/cli": "^6.4.6", + "@mikro-orm/cli": "6.4.9", + "@types/cors": "^2.8.17", "@types/express": "^5.0.0", + "@types/js-yaml": "^4.0.9", "@types/node": "^22.13.4", "@types/response-time": "^2.3.8", "@types/swagger-ui-express": "^4.1.8", - "@types/cors": "^2.8.17", "globals": "^15.15.0", "ts-node": "^10.9.2", "tsx": "^4.19.3", diff --git a/backend/src/app.ts b/backend/src/app.ts index a80980d2..1f518a4a 100644 --- a/backend/src/app.ts +++ b/backend/src/app.ts @@ -1,25 +1,12 @@ -import express, { Express, Response } from 'express'; +import express, { Express } from 'express'; import { initORM } from './orm.js'; - -import themeRoutes from './routes/themes.js'; -import learningPathRoutes from './routes/learningPaths.js'; -import learningObjectRoutes from './routes/learningObjects.js'; - -import studentRouter from './routes/student.js'; -import groupRouter from './routes/group.js'; -import assignmentRouter from './routes/assignment.js'; -import submissionRouter from './routes/submission.js'; -import classRouter from './routes/class.js'; -import questionRouter from './routes/question.js'; -import authRouter from './routes/auth.js'; import { authenticateUser } from './middleware/auth/auth.js'; import cors from './middleware/cors.js'; import { getLogger, Logger } from './logging/initalize.js'; import { responseTimeLogger } from './logging/responseTimeLogger.js'; import responseTime from 'response-time'; import { EnvVars, getNumericEnvVar } from './util/envvars.js'; -import swaggerMiddleware from './swagger'; -import swaggerUi from 'swagger-ui-express'; +import apiRouter from './routes/router.js'; const logger: Logger = getLogger(); @@ -32,41 +19,13 @@ app.use(authenticateUser); // Add response time logging app.use(responseTime(responseTimeLogger)); -// TODO Replace with Express routes -app.get('/', (_, res: Response) => { - logger.debug('GET /'); - res.json({ - message: 'Hello Dwengo!🚀', - }); -}); - -// Routes -app.use('/student', studentRouter /* #swagger.tags = ['Student'] */); -app.use('/group', groupRouter /* #swagger.tags = ['Group'] */); -app.use('/assignment', assignmentRouter /* #swagger.tags = ['Assignment'] */); -app.use('/submission', submissionRouter /* #swagger.tags = ['Submission'] */); -app.use('/class', classRouter /* #swagger.tags = ['Class'] */); -app.use('/question', questionRouter /* #swagger.tags = ['Question'] */); -app.use('/auth', authRouter /* #swagger.tags = ['Auth'] */); -app.use('/theme', themeRoutes /* #swagger.tags = ['Theme'] */); - -app.use( - '/learningPath', - learningPathRoutes /* #swagger.tags = ['Learning Path'] */ -); -app.use( - '/learningObject', - learningObjectRoutes /* #swagger.tags = ['Learning Object'] */ -); - -// Swagger UI for API documentation -app.use('/api-docs', swaggerUi.serve, swaggerMiddleware); +app.get('/api', apiRouter); async function startServer() { await initORM(); app.listen(port, () => { - logger.info(`Server is running at http://localhost:${port}`); + logger.info(`Server is running at http://localhost:${port}/api`); }); } diff --git a/backend/src/config.ts b/backend/src/config.ts index b972a1bd..6cf388cc 100644 --- a/backend/src/config.ts +++ b/backend/src/config.ts @@ -1,12 +1,9 @@ -export const FALLBACK_LANG: string = 'nl'; +import { EnvVars, getEnvVar } from './util/envvars.js'; // API - -export const DWENGO_API_BASE: string = 'https://dwengo.org/backend/api'; +export const DWENGO_API_BASE = getEnvVar(EnvVars.LearningContentRepoApiBaseUrl); +export const FALLBACK_LANG = getEnvVar(EnvVars.FallbackLanguage); // Logging - -export const LOG_LEVEL: string = - 'development' === process.env.NODE_ENV ? 'debug' : 'info'; -export const LOKI_HOST: string = - process.env.LOKI_HOST || 'http://localhost:3102'; +export const LOG_LEVEL: string = 'development' === process.env.NODE_ENV ? 'debug' : 'info'; +export const LOKI_HOST: string = process.env.LOKI_HOST || 'http://localhost:3102'; diff --git a/backend/src/controllers/learning-objects.ts b/backend/src/controllers/learning-objects.ts new file mode 100644 index 00000000..455a4006 --- /dev/null +++ b/backend/src/controllers/learning-objects.ts @@ -0,0 +1,69 @@ +import { Request, Response } from 'express'; +import { FALLBACK_LANG } from '../config.js'; +import { FilteredLearningObject, LearningObjectIdentifier, LearningPathIdentifier } from '../interfaces/learning-content.js'; +import learningObjectService from '../services/learning-objects/learning-object-service.js'; +import { EnvVars, getEnvVar } from '../util/envvars.js'; +import { Language } from '../entities/content/language.js'; +import { BadRequestException } from '../exceptions.js'; +import attachmentService from '../services/learning-objects/attachment-service.js'; +import { NotFoundError } from '@mikro-orm/core'; + +function getLearningObjectIdentifierFromRequest(req: Request): LearningObjectIdentifier { + if (!req.params.hruid) { + throw new BadRequestException('HRUID is required.'); + } + return { + hruid: req.params.hruid as string, + language: (req.query.language || getEnvVar(EnvVars.FallbackLanguage)) as Language, + version: parseInt(req.query.version as string), + }; +} + +function getLearningPathIdentifierFromRequest(req: Request): LearningPathIdentifier { + if (!req.query.hruid) { + throw new BadRequestException('HRUID is required.'); + } + return { + hruid: req.params.hruid as string, + language: (req.query.language as Language) || FALLBACK_LANG, + }; +} + +export async function getAllLearningObjects(req: Request, res: Response): Promise
+
+
`,
+ { ADD_TAGS: ['iframe'], ADD_ATTR: ['allow', 'allowfullscreen', 'frameborder', 'scrolling'] }
+ );
+ }
+}
+
+export default ExternProcessor;
diff --git a/backend/src/services/learning-objects/processing/gift/gift-processor.ts b/backend/src/services/learning-objects/processing/gift/gift-processor.ts
new file mode 100644
index 00000000..5396236a
--- /dev/null
+++ b/backend/src/services/learning-objects/processing/gift/gift-processor.ts
@@ -0,0 +1,61 @@
+/**
+ * Based on https://github.com/dwengovzw/Learning-Object-Repository/blob/main/app/processors/gift/gift_processor.js
+ */
+
+import DOMPurify from 'isomorphic-dompurify';
+import { GIFTQuestion, parse } from 'gift-pegjs';
+import { DwengoContentType } from '../content-type.js';
+import { GIFTQuestionRenderer } from './question-renderers/gift-question-renderer.js';
+import { MultipleChoiceQuestionRenderer } from './question-renderers/multiple-choice-question-renderer.js';
+import { CategoryQuestionRenderer } from './question-renderers/category-question-renderer.js';
+import { DescriptionQuestionRenderer } from './question-renderers/description-question-renderer.js';
+import { EssayQuestionRenderer } from './question-renderers/essay-question-renderer.js';
+import { MatchingQuestionRenderer } from './question-renderers/matching-question-renderer.js';
+import { NumericalQuestionRenderer } from './question-renderers/numerical-question-renderer.js';
+import { ShortQuestionRenderer } from './question-renderers/short-question-renderer.js';
+import { TrueFalseQuestionRenderer } from './question-renderers/true-false-question-renderer.js';
+import { StringProcessor } from '../string-processor.js';
+
+class GiftProcessor extends StringProcessor {
+ private renderers: RendererMap = {
+ Category: new CategoryQuestionRenderer(),
+ Description: new DescriptionQuestionRenderer(),
+ Essay: new EssayQuestionRenderer(),
+ Matching: new MatchingQuestionRenderer(),
+ Numerical: new NumericalQuestionRenderer(),
+ Short: new ShortQuestionRenderer(),
+ TF: new TrueFalseQuestionRenderer(),
+ MC: new MultipleChoiceQuestionRenderer(),
+ };
+
+ constructor() {
+ super(DwengoContentType.GIFT);
+ }
+
+ override renderFn(giftString: string) {
+ const quizQuestions: GIFTQuestion[] = parse(giftString);
+
+ let html = "\n";
+ let i = 1;
+ for (const question of quizQuestions) {
+ html += `
\n';
+
+ return DOMPurify.sanitize(html);
+ }
+
+ private renderQuestion\n`;
+ html += ' ' + this.renderQuestion(question, i).replaceAll(/\n(.+)/g, '\n $1'); // Replace for indentation.
+ html += `
\n`;
+ i++;
+ }
+ html += '${question.title}
\n`; + } + if (question.stem) { + renderedHtml += `${question.stem.text}
\n`; + } + renderedHtml += `\n`; + return renderedHtml; + } +} diff --git a/backend/src/services/learning-objects/processing/gift/question-renderers/gift-question-renderer.ts b/backend/src/services/learning-objects/processing/gift/question-renderers/gift-question-renderer.ts new file mode 100644 index 00000000..41ab5ba2 --- /dev/null +++ b/backend/src/services/learning-objects/processing/gift/question-renderers/gift-question-renderer.ts @@ -0,0 +1,14 @@ +import { GIFTQuestion } from 'gift-pegjs'; + +/** + * Subclasses of this class are renderers which can render a specific type of GIFT questions to HTML. + */ +export abstract class GIFTQuestionRenderer${question.title}
\n`; + } + if (question.stem) { + renderedHtml += `${question.stem.text}
\n`; + } + let i = 0; + for (const choice of question.choices) { + renderedHtml += `\n`;
+ renderedHtml += ` \n`;
+ renderedHtml += ` \n`;
+ renderedHtml += `
\n`;
+ i++;
+ }
+ return renderedHtml;
+ }
+}
diff --git a/backend/src/services/learning-objects/processing/gift/question-renderers/numerical-question-renderer.ts b/backend/src/services/learning-objects/processing/gift/question-renderers/numerical-question-renderer.ts
new file mode 100644
index 00000000..32fdb06e
--- /dev/null
+++ b/backend/src/services/learning-objects/processing/gift/question-renderers/numerical-question-renderer.ts
@@ -0,0 +1,9 @@
+import { GIFTQuestionRenderer } from './gift-question-renderer.js';
+import { Numerical } from 'gift-pegjs';
+import { ProcessingError } from '../../processing-error.js';
+
+export class NumericalQuestionRenderer extends GIFTQuestionRenderer${inlineHtml}
`);
+ }
+}
+
+export default BlockImageProcessor;
diff --git a/backend/src/services/learning-objects/processing/image/inline-image-processor.ts b/backend/src/services/learning-objects/processing/image/inline-image-processor.ts
new file mode 100644
index 00000000..478ce326
--- /dev/null
+++ b/backend/src/services/learning-objects/processing/image/inline-image-processor.ts
@@ -0,0 +1,24 @@
+/**
+ * Based on https://github.com/dwengovzw/Learning-Object-Repository/blob/main/app/processors/image/inline_image_processor.js
+ */
+
+import DOMPurify from 'isomorphic-dompurify';
+import { DwengoContentType } from '../content-type.js';
+import { ProcessingError } from '../processing-error.js';
+import { isValidHttpUrl } from '../../../../util/links.js';
+import { StringProcessor } from '../string-processor.js';
+
+class InlineImageProcessor extends StringProcessor {
+ constructor(contentType: DwengoContentType = DwengoContentType.IMAGE_INLINE) {
+ super(contentType);
+ }
+
+ override renderFn(imageUrl: string) {
+ if (!isValidHttpUrl(imageUrl)) {
+ throw new ProcessingError(`Image URL is invalid: ${imageUrl}`);
+ }
+ return DOMPurify.sanitize(`
+ return `${text}`;
+ },
+
+ // When the syntax for an image is used => 
+ // Render a learning object, pdf, audio or video if a prefix is used.
+ image(img: Image): string {
+ const href = img.href;
+ if (href.startsWith(prefixes.learningObject)) {
+ // Embedded learning-object
+ const learningObjectId = extractLearningObjectIdFromHref(href);
+ return `
+ + + + + Werken met notebooks +
+Het lesmateriaal van 'Python in wiskunde en STEM' wordt aangeboden in de vorm van interactieve notebooks. Notebooks zijn digitale documenten die zowel uitvoerbare code bevatten als tekst, afbeeldingen, video, hyperlinks ...
+Nieuwe begrippen worden aangebracht via tekstuele uitleg, video en afbeeldingen.
+Er zijn uitgewerkte voorbeelden met daarnaast ook kleine en grote opdrachten. In deze opdrachten zal je aangereikte code kunnen uitvoeren, maar ook zelf code opstellen.
+De code die in de notebooks gebruikt wordt, is Python versie 3. We kozen voor Python omdat dit een heel toegankelijke programmeertaal is, die vaak ook intuC/tief is. +Python is bovendien bezig aan een opmars en wordt gebruikt door bedrijven, zoals Google, NASA, Netflix, Uber, AstraZeneca, Barco, Instagram en YouTube.
+We kozen voor notebooks omdat daar enkele belangrijke voordelen aan verbonden zijn: leerkrachten moeten geen geavanceerde installaties doen om de notebooks te gebruiken, leerkrachten kunnen verschillende soorten van lesinhouden aanbieden via C)C)n platform, de notebooks zijn interactief, leerlingen bouwen de oplossing van een probleem stap voor stap op in de notebook waardoor dat proces zichtbaar is voor de leerkracht (Jeroen Van der Hooft, 2023).
++
Klik je op onderstaande knop 'Open notebooks', dan word je doorgestuurd naar een andere website waar jouw persoonlijke notebooks ingeladen worden. (Dit kan even duren.)
+Links op het scherm vind je er twee bestanden met extensie .ipynb. +Dit zijn de twee notebooks waarin je resp. een overzicht krijgt van de opbouw en mogelijkheden en hoe je er mee aan de slag kan. Dubbelklik op de bestandsnaam om een notebook te openen.
+Je ziet er ook een map images met de afbeeldingen die in de notebooks getoond worden.
+In deze eerste twee notebooks leer je hoe de notebooks zijn opgevat en hoe je ermee aan de slag kan. +Na het doorlopen van beide notebooks heb je een goed idee van hoe onze Python notebooks zijn opgevat.
+
+
diff --git a/backend/tests/test-assets/learning-objects/test-essay/test-essay-example.ts b/backend/tests/test-assets/learning-objects/test-essay/test-essay-example.ts
new file mode 100644
index 00000000..d57c7a33
--- /dev/null
+++ b/backend/tests/test-assets/learning-objects/test-essay/test-essay-example.ts
@@ -0,0 +1,28 @@
+import { LearningObjectExample } from '../learning-object-example';
+import { LearningObject } from '../../../../src/entities/content/learning-object.entity';
+import { loadTestAsset } from '../../../test-utils/load-test-asset';
+import { EnvVars, getEnvVar } from '../../../../src/util/envvars';
+import { Language } from '../../../../src/entities/content/language';
+import { DwengoContentType } from '../../../../src/services/learning-objects/processing/content-type';
+
+const example: LearningObjectExample = {
+ createLearningObject: () => {
+ const learningObject = new LearningObject();
+ learningObject.hruid = `${getEnvVar(EnvVars.UserContentPrefix)}test_essay`;
+ learningObject.language = Language.English;
+ learningObject.version = 1;
+ learningObject.title = 'Essay question for testing';
+ learningObject.description = 'This essay question was only created for testing purposes.';
+ learningObject.contentType = DwengoContentType.GIFT;
+ learningObject.returnValue = {
+ callbackUrl: `/learningObject/${learningObject.hruid}/submissions`,
+ callbackSchema: '["antwoord vraag 1"]',
+ };
+ learningObject.content = loadTestAsset('learning-objects/test-essay/content.txt');
+ return learningObject;
+ },
+ createAttachment: {},
+ getHTMLRendering: () => loadTestAsset('learning-objects/test-essay/rendering.txt').toString(),
+};
+
+export default example;
diff --git a/backend/tests/test-assets/learning-objects/test-multiple-choice/content.txt b/backend/tests/test-assets/learning-objects/test-multiple-choice/content.txt
new file mode 100644
index 00000000..7dd5527d
--- /dev/null
+++ b/backend/tests/test-assets/learning-objects/test-multiple-choice/content.txt
@@ -0,0 +1,5 @@
+::MC basic::
+Are you following along well with the class? {
+ ~No, it's very difficult to follow along.
+ =Yes, no problem!
+}
diff --git a/backend/tests/test-assets/learning-objects/test-multiple-choice/rendering.txt b/backend/tests/test-assets/learning-objects/test-multiple-choice/rendering.txt
new file mode 100644
index 00000000..c1829f24
--- /dev/null
+++ b/backend/tests/test-assets/learning-objects/test-multiple-choice/rendering.txt
@@ -0,0 +1,14 @@
+
+
+MC basic
+How are you?
+ +
+
diff --git a/backend/tests/test-assets/learning-objects/test-multiple-choice/test-multiple-choice-example.ts b/backend/tests/test-assets/learning-objects/test-multiple-choice/test-multiple-choice-example.ts
new file mode 100644
index 00000000..a634878a
--- /dev/null
+++ b/backend/tests/test-assets/learning-objects/test-multiple-choice/test-multiple-choice-example.ts
@@ -0,0 +1,28 @@
+import { LearningObjectExample } from '../learning-object-example';
+import { LearningObject } from '../../../../src/entities/content/learning-object.entity';
+import { loadTestAsset } from '../../../test-utils/load-test-asset';
+import { EnvVars, getEnvVar } from '../../../../src/util/envvars';
+import { Language } from '../../../../src/entities/content/language';
+import { DwengoContentType } from '../../../../src/services/learning-objects/processing/content-type';
+
+const example: LearningObjectExample = {
+ createLearningObject: () => {
+ const learningObject = new LearningObject();
+ learningObject.hruid = `${getEnvVar(EnvVars.UserContentPrefix)}test_multiple_choice`;
+ learningObject.language = Language.English;
+ learningObject.version = 1;
+ learningObject.title = 'Multiple choice question for testing';
+ learningObject.description = 'This multiple choice question was only created for testing purposes.';
+ learningObject.contentType = DwengoContentType.GIFT;
+ learningObject.returnValue = {
+ callbackUrl: `/learningObject/${learningObject.hruid}/submissions`,
+ callbackSchema: '["antwoord vraag 1"]',
+ };
+ learningObject.content = loadTestAsset('learning-objects/test-multiple-choice/content.txt');
+ return learningObject;
+ },
+ createAttachment: {},
+ getHTMLRendering: () => loadTestAsset('learning-objects/test-multiple-choice/rendering.txt').toString(),
+};
+
+export default example;
diff --git a/backend/tests/test-assets/learning-paths/learning-path-example.d.ts b/backend/tests/test-assets/learning-paths/learning-path-example.d.ts
new file mode 100644
index 00000000..9df3ba48
--- /dev/null
+++ b/backend/tests/test-assets/learning-paths/learning-path-example.d.ts
@@ -0,0 +1,3 @@
+type LearningPathExample = {
+ createLearningPath: () => LearningPath;
+};
diff --git a/backend/tests/test-assets/learning-paths/learning-path-utils.ts b/backend/tests/test-assets/learning-paths/learning-path-utils.ts
new file mode 100644
index 00000000..c567de66
--- /dev/null
+++ b/backend/tests/test-assets/learning-paths/learning-path-utils.ts
@@ -0,0 +1,31 @@
+import { Language } from '../../../src/entities/content/language';
+import { LearningPathTransition } from '../../../src/entities/content/learning-path-transition.entity';
+import { LearningPathNode } from '../../../src/entities/content/learning-path-node.entity';
+import { LearningPath } from '../../../src/entities/content/learning-path.entity';
+
+export function createLearningPathTransition(node: LearningPathNode, transitionNumber: number, condition: string | null, to: LearningPathNode) {
+ const trans = new LearningPathTransition();
+ trans.node = node;
+ trans.transitionNumber = transitionNumber;
+ trans.condition = condition || 'true';
+ trans.next = to;
+ return trans;
+}
+
+export function createLearningPathNode(
+ learningPath: LearningPath,
+ nodeNumber: number,
+ learningObjectHruid: string,
+ version: number,
+ language: Language,
+ startNode: boolean
+) {
+ const node = new LearningPathNode();
+ node.learningPath = learningPath;
+ node.nodeNumber = nodeNumber;
+ node.learningObjectHruid = learningObjectHruid;
+ node.version = version;
+ node.language = language;
+ node.startNode = startNode;
+ return node;
+}
diff --git a/backend/tests/test-assets/learning-paths/pn-werking-example.ts b/backend/tests/test-assets/learning-paths/pn-werking-example.ts
new file mode 100644
index 00000000..810b4da5
--- /dev/null
+++ b/backend/tests/test-assets/learning-paths/pn-werking-example.ts
@@ -0,0 +1,30 @@
+import { LearningPath } from '../../../src/entities/content/learning-path.entity';
+import { Language } from '../../../src/entities/content/language';
+import { EnvVars, getEnvVar } from '../../../src/util/envvars';
+import { createLearningPathNode, createLearningPathTransition } from './learning-path-utils';
+import { LearningPathNode } from '../../../src/entities/content/learning-path-node.entity';
+
+function createNodes(learningPath: LearningPath): LearningPathNode[] {
+ const nodes = [
+ createLearningPathNode(learningPath, 0, 'u_pn_werkingnotebooks', 3, Language.Dutch, true),
+ createLearningPathNode(learningPath, 1, 'pn_werkingnotebooks2', 3, Language.Dutch, false),
+ createLearningPathNode(learningPath, 2, 'pn_werkingnotebooks3', 3, Language.Dutch, false),
+ ];
+ nodes[0].transitions.push(createLearningPathTransition(nodes[0], 0, 'true', nodes[1]));
+ nodes[1].transitions.push(createLearningPathTransition(nodes[1], 0, 'true', nodes[2]));
+ return nodes;
+}
+
+const example: LearningPathExample = {
+ createLearningPath: () => {
+ const path = new LearningPath();
+ path.language = Language.Dutch;
+ path.hruid = `${getEnvVar(EnvVars.UserContentPrefix)}pn_werking`;
+ path.title = 'Werken met notebooks';
+ path.description = 'Een korte inleiding tot Python notebooks. Hoe ga je gemakkelijk en efficiënt met de notebooks aan de slag?';
+ path.nodes = createNodes(path);
+ return path;
+ },
+};
+
+export default example;
diff --git a/backend/tests/test-assets/learning-paths/test-conditions-example.ts b/backend/tests/test-assets/learning-paths/test-conditions-example.ts
new file mode 100644
index 00000000..07857235
--- /dev/null
+++ b/backend/tests/test-assets/learning-paths/test-conditions-example.ts
@@ -0,0 +1,84 @@
+import { LearningPath } from '../../../src/entities/content/learning-path.entity';
+import { Language } from '../../../src/entities/content/language';
+import testMultipleChoiceExample from '../learning-objects/test-multiple-choice/test-multiple-choice-example';
+import { dummyLearningObject } from '../learning-objects/dummy/dummy-learning-object-example';
+import { createLearningPathNode, createLearningPathTransition } from './learning-path-utils';
+import { LearningObject } from '../../../src/entities/content/learning-object.entity';
+import { EnvVars, getEnvVar } from '../../../src/util/envvars';
+
+export type ConditionTestLearningPathAndLearningObjects = {
+ branchingObject: LearningObject;
+ extraExerciseObject: LearningObject;
+ finalObject: LearningObject;
+ learningPath: LearningPath;
+};
+
+export function createConditionTestLearningPathAndLearningObjects() {
+ const learningPath = new LearningPath();
+ learningPath.hruid = `${getEnvVar(EnvVars.UserContentPrefix)}test_conditions`;
+ learningPath.language = Language.English;
+ learningPath.title = 'Example learning path with conditional transitions';
+ learningPath.description = 'This learning path was made for the purpose of testing conditional transitions';
+
+ const branchingLearningObject = testMultipleChoiceExample.createLearningObject();
+ const extraExerciseLearningObject = dummyLearningObject(
+ 'test_extra_exercise',
+ Language.English,
+ 'Extra exercise (for students with difficulties)'
+ ).createLearningObject();
+ const finalLearningObject = dummyLearningObject(
+ 'test_final_learning_object',
+ Language.English,
+ 'Final exercise (for everyone)'
+ ).createLearningObject();
+
+ const branchingNode = createLearningPathNode(
+ learningPath,
+ 0,
+ branchingLearningObject.hruid,
+ branchingLearningObject.version,
+ branchingLearningObject.language,
+ true
+ );
+ const extraExerciseNode = createLearningPathNode(
+ learningPath,
+ 1,
+ extraExerciseLearningObject.hruid,
+ extraExerciseLearningObject.version,
+ extraExerciseLearningObject.language,
+ false
+ );
+ const finalNode = createLearningPathNode(
+ learningPath,
+ 2,
+ finalLearningObject.hruid,
+ finalLearningObject.version,
+ finalLearningObject.language,
+ false
+ );
+
+ const transitionToExtraExercise = createLearningPathTransition(
+ branchingNode,
+ 0,
+ '$[?(@[0] == 0)]', // The answer to the first question was the first one, which says that it is difficult for the student to follow along.
+ extraExerciseNode
+ );
+ const directTransitionToFinal = createLearningPathTransition(branchingNode, 1, '$[?(@[0] == 1)]', finalNode);
+ const transitionExtraExerciseToFinal = createLearningPathTransition(extraExerciseNode, 0, 'true', finalNode);
+
+ branchingNode.transitions = [transitionToExtraExercise, directTransitionToFinal];
+ extraExerciseNode.transitions = [transitionExtraExerciseToFinal];
+
+ learningPath.nodes = [branchingNode, extraExerciseNode, finalNode];
+
+ return {
+ branchingObject: branchingLearningObject,
+ finalObject: finalLearningObject,
+ extraExerciseObject: extraExerciseLearningObject,
+ learningPath: learningPath,
+ };
+}
+
+const example: LearningPathExample = {
+ createLearningPath: () => createConditionTestLearningPathAndLearningObjects().learningPath,
+};
diff --git a/backend/tests/test-utils/expectations.ts b/backend/tests/test-utils/expectations.ts
new file mode 100644
index 00000000..0fe63811
--- /dev/null
+++ b/backend/tests/test-utils/expectations.ts
@@ -0,0 +1,150 @@
+import { AssertionError } from 'node:assert';
+import { LearningObject } from '../../src/entities/content/learning-object.entity';
+import { FilteredLearningObject, LearningPath } from '../../src/interfaces/learning-content';
+import { LearningPath as LearningPathEntity } from '../../src/entities/content/learning-path.entity';
+import { expect } from 'vitest';
+
+// Ignored properties because they belang for example to the class, not to the entity itself.
+const IGNORE_PROPERTIES = ['parent'];
+
+/**
+ * Checks if the actual entity from the database conforms to the entity that was added previously.
+ * @param actual The actual entity retrieved from the database
+ * @param expected The (previously added) entity we would expect to retrieve
+ */
+export function expectToBeCorrectEntity
+
+MC basic
+Are you following along well with the class?
+
+
+
+
+
+
+
+
+ - {{ role }} + {{ t(`${role}`) }}
@@ -55,22 +59,22 @@ :to="`/${role}/${userId}/assignment`" class="menu_item" > - assignments + {{ t("assignments") }}