diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 2561dae05690..08e009547a4a 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -9,7 +9,7 @@ tone_instructions: '' early_access: true enable_free_tier: true reviews: - profile: assertive + profile: chill request_changes_workflow: true high_level_summary: true high_level_summary_placeholder: '@coderabbitai summary' @@ -192,7 +192,7 @@ reviews: - TYPOGRAPHY - CASING enabled_only: false - level: picky + level: default enabled_rules: [] enabled_categories: [] biome: diff --git a/.github/issue-labeler.yml b/.github/issue-labeler.yml new file mode 100644 index 000000000000..b2201cc36358 --- /dev/null +++ b/.github/issue-labeler.yml @@ -0,0 +1,144 @@ +assessment: + - assessment + - bonus + - complaint + - submission + - grading + - grade + - score + - caseSensitive: false + +athena: + - athena + - caseSensitive: false + +atlas: + - atlas + - competency + - competencies + - knowledge area + - learning path + - learner profile + - science event + - adaptive learning + - caseSensitive: false + +buildagent: + - buildagent + - build agent + - buildjob + - build job + - build result + - caseSensitive: false + +communication: + - communication + - conversation + - notification + - agreement + - faq + - post + - reaction + - chat + - message + - caseSensitive: false + +core: + - user-management + - authority + - data export + - migration + - user + - group + - caseSensitive: false + +exam: + - exam + - exercisegroup + - student exam + - suspicious behavior + - suspicious behaviour + - caseSensitive: false + +exercise: + - exercise + - participation + - participant + - difficulty + - lifecycle + - team + - assignment + - caseSensitive: false + +fileupload: + - fileupload + - upload + - caseSensitive: false + +iris: + - iris + - llm + - chatbot + - ai + - caseSensitive: false + +lecture: + - lecture + - attachment + - online + - slide + - video + - text unit + - caseSensitive: false + +lti: + - lti + - online course + - caseSensitive: false + +modeling: + - modeling + - diagram + - uml + - caseSensitive: false + +plagiarism: + - plagiarism + - caseSensitive: false + +programming: + - programming + - build + - build plan + - code hint + - git + - testwise coverage + - ide + - submission policy + - aeolus + - penalty + - auxilary + - commit + - project + - static code analysis + - caseSensitive: false + +quiz: + - quiz + - drag + - drop + - single choice + - multiple choice + - batch + - short answer + - caseSensitive: false + +text: + - text + - block + - caseSensitive: false + +tutorialgroup: + - tutorialgroup + - session + - caseSensitive: false diff --git a/.github/workflows/analysis-of-endpoint-connections.yml b/.github/workflows/analysis-of-endpoint-connections.yml index f5f2dd4edb71..f74dff1b7b95 100644 --- a/.github/workflows/analysis-of-endpoint-connections.yml +++ b/.github/workflows/analysis-of-endpoint-connections.yml @@ -79,12 +79,16 @@ jobs: path: supporting_scripts/analysis-of-endpoint-connections/ - name: Analyze endpoints - run: + run: | ./gradlew :supporting_scripts:analysis-of-endpoint-connections:runEndpointAnalysis + continue-on-error: true + id: endpointAnalysis - name: Analyze rest calls - run: + run: | ./gradlew :supporting_scripts:analysis-of-endpoint-connections:runRestCallAnalysis + continue-on-error: true + id: restCallAnalysis - name: Upload analysis results uses: actions/upload-artifact@v4 @@ -93,3 +97,21 @@ jobs: path: | supporting_scripts/analysis-of-endpoint-connections/endpointAnalysisResult.json supporting_scripts/analysis-of-endpoint-connections/restCallAnalysisResult.json + + - name: Check if any step failed + run: | + if [ "${{ steps.endpointAnalysis.outcome }}" != "success" ] && + [ "${{ steps.restCallAnalysis.outcome }}" != "success" ]; then + echo "Endpoints and REST calls could not be matched." + exit 1 + fi + if [ "${{ steps.endpointAnalysis.outcome }}" == "success" ] && + [ "${{ steps.restCallAnalysis.outcome }}" != "success" ]; then + echo "REST calls could not be matched." + exit 1 + fi + if [ "${{ steps.endpointAnalysis.outcome }}" != "success" ] && + [ "${{ steps.restCallAnalysis.outcome }}" == "success" ]; then + echo "Endpoints could not be matched." + exit 1 + fi diff --git a/.github/workflows/issue-labler.yml b/.github/workflows/issue-labler.yml new file mode 100644 index 000000000000..10908c7bc2ee --- /dev/null +++ b/.github/workflows/issue-labler.yml @@ -0,0 +1,17 @@ +name: "Issue Labeler" +on: + issues: + types: [opened, edited] + +permissions: + issues: write + contents: read + +jobs: + triage: + runs-on: ubuntu-latest + steps: + - uses: MaximilianAnzinger/issue-labeler@1.0.1 + with: + configuration-path: .github/issue-labeler.yml + repo-token: ${{ github.token }} diff --git a/README.md b/README.md index 08742f5d89b5..a982be2c6bba 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,7 @@ Refer to [Using JHipster in production](http://www.jhipster.tech/production) for The following command can automate the deployment to a server. The example shows the deployment to the main Artemis test server (which runs a virtual machine): ```shell -./artemis-server-cli deploy username@artemistest.ase.in.tum.de -w build/libs/Artemis-7.6.0.war +./artemis-server-cli deploy username@artemistest.ase.in.tum.de -w build/libs/Artemis-7.6.1.war ``` ## Architecture diff --git a/build.gradle b/build.gradle index 163b2517748f..c6d5fe742ab3 100644 --- a/build.gradle +++ b/build.gradle @@ -25,7 +25,7 @@ plugins { } group = "de.tum.cit.aet.artemis" -version = "7.6.0" +version = "7.6.1" description = "Interactive Learning with Individual Feedback" java { @@ -243,11 +243,12 @@ dependencies { exclude module: "jaxb-api" } - implementation "org.gitlab4j:gitlab4j-api:6.0.0-rc.5" + implementation "org.gitlab4j:gitlab4j-api:6.0.0-rc.6" implementation "de.jplag:jplag:${jplag_version}" implementation "de.jplag:c:${jplag_version}" + implementation "de.jplag:cpp:${jplag_version}" implementation "de.jplag:java:${jplag_version}" implementation "de.jplag:javascript:${jplag_version}" implementation "de.jplag:kotlin:${jplag_version}" @@ -329,7 +330,7 @@ dependencies { // implementation "org.springdoc:springdoc-openapi-ui:1.8.0" // use the latest version to avoid security vulnerabilities - implementation "org.springframework:spring-webmvc:6.1.13" + implementation "org.springframework:spring-webmvc:6.1.14" implementation "com.vdurmont:semver4j:3.1.0" @@ -345,7 +346,7 @@ dependencies { implementation "tech.jhipster:jhipster-framework:${jhipster_dependencies_version}" implementation "org.springframework.boot:spring-boot-starter-cache:${spring_boot_version}" - implementation "io.micrometer:micrometer-registry-prometheus:1.13.5" + implementation "io.micrometer:micrometer-registry-prometheus:1.13.6" implementation "net.logstash.logback:logstash-logback-encoder:8.0" // Defines low-level streaming API, and includes JSON-specific implementations @@ -397,8 +398,8 @@ dependencies { implementation "org.springframework.boot:spring-boot-starter-oauth2-resource-server:${spring_boot_version}" implementation "org.springframework.boot:spring-boot-starter-oauth2-client:${spring_boot_version}" - implementation "org.springframework.ldap:spring-ldap-core:3.2.6" - implementation "org.springframework.data:spring-data-ldap:3.3.4" + implementation "org.springframework.ldap:spring-ldap-core:3.2.7" + implementation "org.springframework.data:spring-data-ldap:3.3.5" implementation("org.springframework.cloud:spring-cloud-starter-netflix-eureka-client:4.1.3") { // NOTE: these modules contain security vulnerabilities and are not needed @@ -409,8 +410,8 @@ dependencies { implementation "org.springframework.cloud:spring-cloud-commons:4.1.4" implementation "io.netty:netty-all:4.1.114.Final" - implementation "io.projectreactor.netty:reactor-netty:1.1.22" - implementation "org.springframework:spring-messaging:6.1.13" + implementation "io.projectreactor.netty:reactor-netty:1.1.23" + implementation "org.springframework:spring-messaging:6.1.14" implementation "org.springframework.retry:spring-retry:2.0.9" implementation "org.springframework.security:spring-security-config:${spring_security_version}" @@ -440,7 +441,7 @@ dependencies { implementation "org.bouncycastle:bcpkix-jdk18on:1.78.1" implementation "org.bouncycastle:bcprov-jdk18on:1.78.1" - implementation "com.mysql:mysql-connector-j:9.0.0" + implementation "com.mysql:mysql-connector-j:9.1.0" implementation "org.postgresql:postgresql:42.7.4" implementation "org.zalando:problem-spring-web:0.29.1" @@ -448,8 +449,7 @@ dependencies { implementation "com.ibm.icu:icu4j-charset:75.1" implementation "com.github.seancfoley:ipaddress:5.5.1" implementation "org.apache.maven:maven-model:3.9.9" - // NOTE: 3.0.2 is broken for splitting lecture specific PDFs - implementation "org.apache.pdfbox:pdfbox:3.0.1" + implementation "org.apache.pdfbox:pdfbox:3.0.3" implementation "org.apache.commons:commons-csv:1.12.0" implementation "org.commonmark:commonmark:0.23.0" implementation "commons-fileupload:commons-fileupload:1.5" diff --git a/docs/user/exercises/programming-exercise-features.inc b/docs/user/exercises/programming-exercise-features.inc index 660e2bd4bf02..e1ce98df80f1 100644 --- a/docs/user/exercises/programming-exercise-features.inc +++ b/docs/user/exercises/programming-exercise-features.inc @@ -39,6 +39,8 @@ Instructors can still use those templates to generate programming exercises and +----------------------+----------+---------+ | R | yes | yes | +----------------------+----------+---------+ + | C++ | yes | yes | + +----------------------+----------+---------+ - Not all ``templates`` support the same feature set and supported features can also change depending on the continuous integration system setup. Depending on the feature set, some options might not be available during the creation of the programming exercise. @@ -75,6 +77,8 @@ Instructors can still use those templates to generate programming exercises and +----------------------+----------------------+----------------------+---------------------+--------------+------------------------------------------+------------------------------+----------------------------+------------------------+ | R | no | no | yes | no | n/a | no | no | L: yes, J: no | +----------------------+----------------------+----------------------+---------------------+--------------+------------------------------------------+------------------------------+----------------------------+------------------------+ + | C++ | no | no | yes | no | n/a | no | no | L: yes, J: no | + +----------------------+----------------------+----------------------+---------------------+--------------+------------------------------------------+------------------------------+----------------------------+------------------------+ - *Sequential Test Runs*: ``Artemis`` can generate a build plan which first executes structural and then behavioral tests. This feature can help students to better concentrate on the immediate challenge at hand. - *Static Code Analysis*: ``Artemis`` can generate a build plan which additionally executes static code analysis tools. diff --git a/docs/user/exercises/programming-exercise-setup.inc b/docs/user/exercises/programming-exercise-setup.inc index 08d03e9f6290..0d1adbff6297 100644 --- a/docs/user/exercises/programming-exercise-setup.inc +++ b/docs/user/exercises/programming-exercise-setup.inc @@ -351,6 +351,8 @@ Update exercise code in repositories - In case of a |build_failed| result, some configuration is wrong, please check the build errors on the corresponding build plan. - **Hints:** Test cases should only reference code, that is available in the template repository. In case this is **not** possible, please try out the option **Sequential Test Runs** +.. _adapt_build_script: + Adapt the build script ^^^^^^^^^^^^^^^^^^^^^^ @@ -360,8 +362,7 @@ You can activate the option `Customize Build Script` in the programming exercise All changes in the configuration will be considered for all builds (template, solution, student submissions). There are predefined build scripts in bash for all programming languages, project types and configurations (e.g. with or without static code analysis). -Notice that the checkout paths for the test and the assignment (template, solution or student) repo cannot be customized at the moment and are determined -by the chosen programming language. Most programming languages clone the test repos into the root folder and the assignment repo into the `assignment` folder. +Most programming languages clone the test repos into the root folder and the assignment repo into the `assignment` folder. This means that build files in the test repo (e.g. Gradle, Maven) typically refer to the `assignment` folder. You can also use a custom docker image for the build. Make sure to publish the docker image in a publicly available repository (e.g. DockerHub). Ideally build it @@ -372,8 +373,45 @@ The default Java Docker image can be found on https://github.com/ls1intum/artemi Hint: Try out the build of a custom programming exercise locally before you publish a custom docker image and before you upload the code to Artemis, because the development and debugging experience is much better. +Edit Repositories Checkout Paths +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**This option is only available when using** :ref:`integrated code lifecycle` + +This section is optional. In most cases, the preconfigured checkout paths do not need to be changed. +The checkout paths depend on the chosen programming language and project type. The paths are shown in the preview: + +.. figure:: programming/checkout-paths-preview.png + :align: center + +By checkout paths, we mean the paths where the repositories are cloned during the build process. For example, in Java exercises, the assignment repository is cloned into the `assignment` folder, the test repository is cloned into the root folder. All paths are relative to the working directory of the build plan. +If you want to change the checkout paths, you can do so by clicking on the `edit repositories checkout path` button. The following dialog will open: + +.. figure:: programming/checkout-paths-edit.png + :align: center + +You must then change the paths in the build script if necessary. Please refer to the :ref:`adapt_build_script` section on how to do this. + +.. warning:: + - Changing the checkout paths can only be done in the exercise creation process. After the exercise has been created, the checkout paths cannot be changed. + - Depending on the programming language and project type, the checkout paths are predefined and cannot be changed. For example, for Java exercises, only the assignment repository path can be changed. For Ocaml exercises, the assignment, test, and solution repository paths can be changed. + - Changing the checkout paths can lead to build errors if the build script is not adapted accordingly. + - For C programming exercises, if used with the default docker image, changing the checkout paths will lead to build errors. The default docker image is configured to work with the default checkout paths. + .. _configure_static_code_analysis_tools: +Edit Maximum Build Duration +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**This option is only available when using** :ref:`integrated code lifecycle` +This section is optional. In most cases, the preconfigured build script does not need to be changed. + +The maximum build duration is the time limit for the build plan to execute. If the build plan exceeds this time limit, it will be terminated. The default value is 120 seconds. +You can change the maximum build duration by using the slider. + +.. figure:: programming/timeout-slider.png + :align: center + Configure static code analysis ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/user/exercises/programming/checkout-paths-edit.png b/docs/user/exercises/programming/checkout-paths-edit.png new file mode 100644 index 000000000000..ef4e3244cb31 Binary files /dev/null and b/docs/user/exercises/programming/checkout-paths-edit.png differ diff --git a/docs/user/exercises/programming/checkout-paths-preview.png b/docs/user/exercises/programming/checkout-paths-preview.png new file mode 100644 index 000000000000..611892d7d3cc Binary files /dev/null and b/docs/user/exercises/programming/checkout-paths-preview.png differ diff --git a/docs/user/exercises/programming/timeout-slider.png b/docs/user/exercises/programming/timeout-slider.png new file mode 100644 index 000000000000..c502166c9e5e Binary files /dev/null and b/docs/user/exercises/programming/timeout-slider.png differ diff --git a/gradle.properties b/gradle.properties index 07ee79d07d25..02b6e1e550ce 100644 --- a/gradle.properties +++ b/gradle.properties @@ -28,15 +28,15 @@ slf4j_version=2.0.16 sentry_version=7.15.0 liquibase_version=4.29.2 docker_java_version=3.4.0 -logback_version=1.5.10 +logback_version=1.5.11 java_parser_version=3.26.2 -byte_buddy_version=1.15.4 +byte_buddy_version=1.15.5 # testing # make sure both versions are compatible junit_version=5.11.0 junit_platform_version=1.11.2 -mockito_version=5.14.1 +mockito_version=5.14.2 # gradle plugin version diff --git a/package-lock.json b/package-lock.json index 91ee03d72aaf..3d991d2d9079 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,30 +1,30 @@ { "name": "artemis", - "version": "7.6.0", + "version": "7.6.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "artemis", - "version": "7.6.0", + "version": "7.6.1", "hasInstallScript": true, "license": "MIT", "dependencies": { "@angular/animations": "18.2.8", - "@angular/cdk": "18.2.8", + "@angular/cdk": "18.2.9", "@angular/common": "18.2.8", "@angular/compiler": "18.2.8", "@angular/core": "18.2.8", "@angular/forms": "18.2.8", "@angular/localize": "18.2.8", - "@angular/material": "18.2.8", + "@angular/material": "18.2.9", "@angular/platform-browser": "18.2.8", "@angular/platform-browser-dynamic": "18.2.8", "@angular/router": "18.2.8", "@angular/service-worker": "18.2.8", "@ctrl/ngx-emoji-mart": "9.2.0", "@danielmoncada/angular-datetime-picker": "18.1.0", - "@fingerprintjs/fingerprintjs": "4.5.0", + "@fingerprintjs/fingerprintjs": "4.5.1", "@fortawesome/angular-fontawesome": "0.15.0", "@fortawesome/fontawesome-svg-core": "6.6.0", "@fortawesome/free-regular-svg-icons": "6.6.0", @@ -60,17 +60,17 @@ "ngx-webstorage": "18.0.0", "papaparse": "5.4.1", "pdfjs-dist": "4.7.76", - "posthog-js": "1.167.0", + "posthog-js": "1.174.2", "rxjs": "7.8.1", "showdown": "2.1.0", "showdown-highlight": "3.1.0", "showdown-katex": "0.6.0", - "simple-statistics": "7.8.5", + "simple-statistics": "7.8.7", "smoothscroll-polyfill": "0.4.4", "sockjs-client": "1.6.1", "split.js": "1.6.5", "ts-cacheable": "1.0.10", - "tslib": "2.7.0", + "tslib": "2.8.0", "uuid": "10.0.0", "webstomp-client": "1.2.6", "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz", @@ -78,13 +78,13 @@ }, "devDependencies": { "@angular-builders/jest": "18.0.0", - "@angular-devkit/build-angular": "18.2.8", + "@angular-devkit/build-angular": "18.2.9", "@angular-eslint/builder": "18.3.1", "@angular-eslint/eslint-plugin": "18.3.1", "@angular-eslint/eslint-plugin-template": "18.3.1", "@angular-eslint/schematics": "18.3.1", "@angular-eslint/template-parser": "18.3.1", - "@angular/cli": "18.2.8", + "@angular/cli": "18.2.9", "@angular/compiler-cli": "18.2.8", "@angular/language-service": "18.2.8", "@sentry/types": "8.34.0", @@ -93,14 +93,14 @@ "@types/dompurify": "3.0.5", "@types/jest": "29.5.13", "@types/lodash-es": "4.17.12", - "@types/node": "22.7.5", + "@types/node": "22.7.6", "@types/papaparse": "5.3.14", "@types/showdown": "2.0.6", "@types/smoothscroll-polyfill": "0.3.4", "@types/sockjs-client": "1.5.4", "@types/uuid": "10.0.0", - "@typescript-eslint/eslint-plugin": "8.8.1", - "@typescript-eslint/parser": "8.8.1", + "@typescript-eslint/eslint-plugin": "8.10.0", + "@typescript-eslint/parser": "8.10.0", "eslint": "9.12.0", "eslint-config-prettier": "9.1.0", "eslint-plugin-deprecation": "3.0.0", @@ -121,7 +121,7 @@ "ngxtension": "4.0.0", "prettier": "3.3.3", "rimraf": "6.0.1", - "sass": "1.79.5", + "sass": "1.80.2", "ts-jest": "29.2.5", "typescript": "5.5.4", "weak-napi": "2.0.2" @@ -212,13 +212,13 @@ } }, "node_modules/@angular-devkit/architect": { - "version": "0.1802.8", - "resolved": "https://registry.npmjs.org/@angular-devkit/architect/-/architect-0.1802.8.tgz", - "integrity": "sha512-/rtFQEKgS7LlB9oHr4NCBSdKnvP5kr8L5Hbd3Vl8hZOYK9QWjxKPEXnryA2d5+PCE98bBzZswCNXqELZCPTgIQ==", + "version": "0.1802.9", + "resolved": "https://registry.npmjs.org/@angular-devkit/architect/-/architect-0.1802.9.tgz", + "integrity": "sha512-fubJf4WC/t3ITy+tyjI4/CKKwUP4XJTmV+Y0nyPcrkcthVyUcIpZB74NlUOvg6WECiPQuIc+CtoAaA9X5+RQ5Q==", "dev": true, "license": "MIT", "dependencies": { - "@angular-devkit/core": "18.2.8", + "@angular-devkit/core": "18.2.9", "rxjs": "7.8.1" }, "engines": { @@ -228,17 +228,17 @@ } }, "node_modules/@angular-devkit/build-angular": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@angular-devkit/build-angular/-/build-angular-18.2.8.tgz", - "integrity": "sha512-qK/iLk7A8vQp1CyiJV4DpwfLjPKoiOlTtFqoO5vD8Tyxmc+R06FQp6GJTsZ7JtrTLYSiH+QAWiY6NgF/Rj/hHg==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@angular-devkit/build-angular/-/build-angular-18.2.9.tgz", + "integrity": "sha512-d4W6t9vBozFUmOP2VvihMcSg/zgr3AvJY6/b7OPuATlK+W3P6tmsqxGIQ6eKc1TxXeu3lWhi14mV2pPykfrwfA==", "dev": true, "license": "MIT", "dependencies": { "@ampproject/remapping": "2.3.0", - "@angular-devkit/architect": "0.1802.8", - "@angular-devkit/build-webpack": "0.1802.8", - "@angular-devkit/core": "18.2.8", - "@angular/build": "18.2.8", + "@angular-devkit/architect": "0.1802.9", + "@angular-devkit/build-webpack": "0.1802.9", + "@angular-devkit/core": "18.2.9", + "@angular/build": "18.2.9", "@babel/core": "7.25.2", "@babel/generator": "7.25.0", "@babel/helper-annotate-as-pure": "7.24.7", @@ -249,7 +249,7 @@ "@babel/preset-env": "7.25.3", "@babel/runtime": "7.25.0", "@discoveryjs/json-ext": "0.6.1", - "@ngtools/webpack": "18.2.8", + "@ngtools/webpack": "18.2.9", "@vitejs/plugin-basic-ssl": "1.1.0", "ansi-colors": "4.1.3", "autoprefixer": "10.4.20", @@ -382,13 +382,13 @@ "license": "0BSD" }, "node_modules/@angular-devkit/build-webpack": { - "version": "0.1802.8", - "resolved": "https://registry.npmjs.org/@angular-devkit/build-webpack/-/build-webpack-0.1802.8.tgz", - "integrity": "sha512-uPpopkXkO66SSdjtVr7xCyQCPs/x6KUC76xkDc4j0b8EEHifTbi/fNpbkcZ6wBmoAfjKLWXfKvtkh0TqKK5Hkw==", + "version": "0.1802.9", + "resolved": "https://registry.npmjs.org/@angular-devkit/build-webpack/-/build-webpack-0.1802.9.tgz", + "integrity": "sha512-p7xNGo5ZTV/Z0Rk+q2/E68QQLw9VT33kauDh6s010jIeBLrOwMo74JpzXMSFttQo5O4bLKP8IORzIM+0q7Uzjg==", "dev": true, "license": "MIT", "dependencies": { - "@angular-devkit/architect": "0.1802.8", + "@angular-devkit/architect": "0.1802.9", "rxjs": "7.8.1" }, "engines": { @@ -402,9 +402,9 @@ } }, "node_modules/@angular-devkit/core": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@angular-devkit/core/-/core-18.2.8.tgz", - "integrity": "sha512-4o2T6wsmXGE/v53+F8L7kGoN2+qzt03C9rtjLVQpOljzpJVttQ8bhvfWxyYLWwcl04RWqRa+82fpIZtBkOlZJw==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@angular-devkit/core/-/core-18.2.9.tgz", + "integrity": "sha512-bsVt//5E0ua7FZfO0dCF/qGGY6KQD34/bNGyRu5B6HedimpdU2/0PGDptksU5v3yKEc9gNw0xC6mT0UsY/R9pA==", "dev": true, "license": "MIT", "dependencies": { @@ -430,13 +430,13 @@ } }, "node_modules/@angular-devkit/schematics": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@angular-devkit/schematics/-/schematics-18.2.8.tgz", - "integrity": "sha512-i/h2Oji5FhJMC7wDSnIl5XUe/qym+C1ZwScaATJwDyRLCUIynZkj5rLgdG/uK6l+H0PgvxigkF+akWpokkwW6w==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@angular-devkit/schematics/-/schematics-18.2.9.tgz", + "integrity": "sha512-aIY5/IomDOINGCtFYi77uo0acDpdQNNCighfBBUGEBNMQ1eE3oGNGpLAH/qWeuxJndgmxrdKsvws9DdT46kLig==", "dev": true, "license": "MIT", "dependencies": { - "@angular-devkit/core": "18.2.8", + "@angular-devkit/core": "18.2.9", "jsonc-parser": "3.3.1", "magic-string": "0.30.11", "ora": "5.4.1", @@ -564,14 +564,14 @@ } }, "node_modules/@angular/build": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@angular/build/-/build-18.2.8.tgz", - "integrity": "sha512-ufuA4vHJSrL9SQW7bKV61DOoN1mm0t0ILTHaxSoCG3YF70cZJOX7+HNp3cK2uoldRMwbTOKSvCWBw54KKDRd5Q==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@angular/build/-/build-18.2.9.tgz", + "integrity": "sha512-o1hOEM2e6ARy+ck2Pohl0d/RFgbbXTw6/hTLAj3CBKjtqAGStRaVF2UlJjhi+xOxlfsOPuJJc9IpzLBteku+Ag==", "dev": true, "license": "MIT", "dependencies": { "@ampproject/remapping": "2.3.0", - "@angular-devkit/architect": "0.1802.8", + "@angular-devkit/architect": "0.1802.9", "@babel/core": "7.25.2", "@babel/helper-annotate-as-pure": "7.24.7", "@babel/helper-split-export-declaration": "7.24.7", @@ -651,9 +651,9 @@ } }, "node_modules/@angular/cdk": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@angular/cdk/-/cdk-18.2.8.tgz", - "integrity": "sha512-J8A2FkwTBzLleAEWz6EgW73dEoeq87GREBPjTv8+2JV09LX+V3hnbgNk6zWq5k4OXtQNg9WrWP9QyRbUyA597g==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@angular/cdk/-/cdk-18.2.9.tgz", + "integrity": "sha512-hV2dXpvy2TLwCsRtI/ZXkb2EoaJiellRr+kbcnKwO15LFoz3mTAOhKtsvu7yOyURkaPiI605qiIZrPP4zLL1qw==", "license": "MIT", "dependencies": { "tslib": "^2.3.0" @@ -668,18 +668,18 @@ } }, "node_modules/@angular/cli": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@angular/cli/-/cli-18.2.8.tgz", - "integrity": "sha512-GKXG7F7z5rxwZ8/bnW/Bp8/zsfE/BpHmIP/icLfUIOwv2kaY5OD2tfQssWXPEuqZzYq2AYz+wjVSbWjxGoja8A==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@angular/cli/-/cli-18.2.9.tgz", + "integrity": "sha512-ejTIqwvPABwK7MtVmI2qWbEaMhhbHNsq0NPzl1hwLtkrLbjdDrEVv0Wy+gN0xqrT9NyCPl4AmNLz/xuYTzgU5g==", "dev": true, "license": "MIT", "dependencies": { - "@angular-devkit/architect": "0.1802.8", - "@angular-devkit/core": "18.2.8", - "@angular-devkit/schematics": "18.2.8", + "@angular-devkit/architect": "0.1802.9", + "@angular-devkit/core": "18.2.9", + "@angular-devkit/schematics": "18.2.9", "@inquirer/prompts": "5.3.8", "@listr2/prompt-adapter-inquirer": "2.0.15", - "@schematics/angular": "18.2.8", + "@schematics/angular": "18.2.9", "@yarnpkg/lockfile": "1.1.0", "ini": "4.1.3", "jsonc-parser": "3.3.1", @@ -862,16 +862,16 @@ } }, "node_modules/@angular/material": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@angular/material/-/material-18.2.8.tgz", - "integrity": "sha512-wQGMVsfQ9lQfih2VsWAvV4z3S3uBxrxc61owlE+K0T1BxH9u/jo3A/rnRitIdvR/L4NnYlfhCnmrW9K+Pl+WCg==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@angular/material/-/material-18.2.9.tgz", + "integrity": "sha512-M2oCgPPIMMd6BLgEJCD+FvdC7gRDeCjj9yktNn3ctHmkKUWRvpJ3xRBH/WjVXb+9fPCCW1iNwZI7+bN1fHE7cA==", "license": "MIT", "dependencies": { "tslib": "^2.3.0" }, "peerDependencies": { "@angular/animations": "^18.0.0 || ^19.0.0", - "@angular/cdk": "18.2.8", + "@angular/cdk": "18.2.9", "@angular/common": "^18.0.0 || ^19.0.0", "@angular/core": "^18.0.0 || ^19.0.0", "@angular/forms": "^18.0.0 || ^19.0.0", @@ -3584,9 +3584,9 @@ } }, "node_modules/@fingerprintjs/fingerprintjs": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/@fingerprintjs/fingerprintjs/-/fingerprintjs-4.5.0.tgz", - "integrity": "sha512-mFSQoxyt8SGGRp1QUlhcnVtquW2HzCKfHKxAoIurR6soIJpuK3VvZuH0sg8eNaHH2dJhI3mZOEUx4k+P4GqXzw==", + "version": "4.5.1", + "resolved": "https://registry.npmjs.org/@fingerprintjs/fingerprintjs/-/fingerprintjs-4.5.1.tgz", + "integrity": "sha512-hKJaRoLHNeUUPhb+Md3pTlY/Js2YR4aXjroaDHpxrjoM8kGnEFyZVZxXo6l3gRyKnQN52Uoqsycd3M73eCdMzw==", "license": "BUSL-1.1", "dependencies": { "tslib": "^2.4.1" @@ -5376,9 +5376,9 @@ } }, "node_modules/@ngtools/webpack": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@ngtools/webpack/-/webpack-18.2.8.tgz", - "integrity": "sha512-sq0kI8gEen4QlM6X8XqOYy7j4B8iLCYNo+iKxatV36ts4AXH0MuVkP56+oMaoH5oZNoSqd0RlfnotEHfvJAr8A==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@ngtools/webpack/-/webpack-18.2.9.tgz", + "integrity": "sha512-/apDvs4qevjSWoYw3h3/c/mILFrf2EgCJfBy9f3E7PEgi2tjifOIszBRrLQkVpeHAaFgEH8zKS2ol0hAmOl8sw==", "dev": true, "license": "MIT", "engines": { @@ -6570,14 +6570,14 @@ ] }, "node_modules/@schematics/angular": { - "version": "18.2.8", - "resolved": "https://registry.npmjs.org/@schematics/angular/-/angular-18.2.8.tgz", - "integrity": "sha512-62Sr7/j/dlhZorxH4GzQgpJy0s162BVts0Q7knZuEacP4VL+IWOUE1NS9OFkh/cbomoyXBdoewkZ5Zd1dVX78w==", + "version": "18.2.9", + "resolved": "https://registry.npmjs.org/@schematics/angular/-/angular-18.2.9.tgz", + "integrity": "sha512-LlMHZQ6f8zrqSK24OBXi4u2MTNHNu9ZN6JXpbElq0bz/9QkUR2zy+Kk2wLpPxCwXYTZby7/xgHiTzXvG+zTdhw==", "dev": true, "license": "MIT", "dependencies": { - "@angular-devkit/core": "18.2.8", - "@angular-devkit/schematics": "18.2.8", + "@angular-devkit/core": "18.2.9", + "@angular-devkit/schematics": "18.2.9", "jsonc-parser": "3.3.1" }, "engines": { @@ -7360,9 +7360,9 @@ } }, "node_modules/@types/node": { - "version": "22.7.5", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.7.5.tgz", - "integrity": "sha512-jML7s2NAzMWc//QSJ1a3prpk78cOPchGvXJsC3C6R6PSMoooztvRVQEz89gmBTBY1SPMaqo5teB4uNHPdetShQ==", + "version": "22.7.6", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.7.6.tgz", + "integrity": "sha512-/d7Rnj0/ExXDMcioS78/kf1lMzYk4BZV8MZGTBKzTGZ6/406ukkbYlIsZmMPhcR5KlkunDHQLrtAVmSq7r+mSw==", "dev": true, "license": "MIT", "dependencies": { @@ -7566,17 +7566,17 @@ "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.8.1.tgz", - "integrity": "sha512-xfvdgA8AP/vxHgtgU310+WBnLB4uJQ9XdyP17RebG26rLtDrQJV3ZYrcopX91GrHmMoH8bdSwMRh2a//TiJ1jQ==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.10.0.tgz", + "integrity": "sha512-phuB3hoP7FFKbRXxjl+DRlQDuJqhpOnm5MmtROXyWi3uS/Xg2ZXqiQfcG2BJHiN4QKyzdOJi3NEn/qTnjUlkmQ==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.8.1", - "@typescript-eslint/type-utils": "8.8.1", - "@typescript-eslint/utils": "8.8.1", - "@typescript-eslint/visitor-keys": "8.8.1", + "@typescript-eslint/scope-manager": "8.10.0", + "@typescript-eslint/type-utils": "8.10.0", + "@typescript-eslint/utils": "8.10.0", + "@typescript-eslint/visitor-keys": "8.10.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -7600,16 +7600,16 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.8.1.tgz", - "integrity": "sha512-hQUVn2Lij2NAxVFEdvIGxT9gP1tq2yM83m+by3whWFsWC+1y8pxxxHUFE1UqDu2VsGi2i6RLcv4QvouM84U+ow==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.10.0.tgz", + "integrity": "sha512-E24l90SxuJhytWJ0pTQydFT46Nk0Z+bsLKo/L8rtQSL93rQ6byd1V/QbDpHUTdLPOMsBCcYXZweADNCfOCmOAg==", "dev": true, "license": "BSD-2-Clause", "dependencies": { - "@typescript-eslint/scope-manager": "8.8.1", - "@typescript-eslint/types": "8.8.1", - "@typescript-eslint/typescript-estree": "8.8.1", - "@typescript-eslint/visitor-keys": "8.8.1", + "@typescript-eslint/scope-manager": "8.10.0", + "@typescript-eslint/types": "8.10.0", + "@typescript-eslint/typescript-estree": "8.10.0", + "@typescript-eslint/visitor-keys": "8.10.0", "debug": "^4.3.4" }, "engines": { @@ -7629,14 +7629,14 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.8.1.tgz", - "integrity": "sha512-X4JdU+66Mazev/J0gfXlcC/dV6JI37h+93W9BRYXrSn0hrE64IoWgVkO9MSJgEzoWkxONgaQpICWg8vAN74wlA==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.10.0.tgz", + "integrity": "sha512-AgCaEjhfql9MDKjMUxWvH7HjLeBqMCBfIaBbzzIcBbQPZE7CPh1m6FF+L75NUMJFMLYhCywJXIDEMa3//1A0dw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.8.1", - "@typescript-eslint/visitor-keys": "8.8.1" + "@typescript-eslint/types": "8.10.0", + "@typescript-eslint/visitor-keys": "8.10.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -7647,14 +7647,14 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.8.1.tgz", - "integrity": "sha512-qSVnpcbLP8CALORf0za+vjLYj1Wp8HSoiI8zYU5tHxRVj30702Z1Yw4cLwfNKhTPWp5+P+k1pjmD5Zd1nhxiZA==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.10.0.tgz", + "integrity": "sha512-PCpUOpyQSpxBn230yIcK+LeCQaXuxrgCm2Zk1S+PTIRJsEfU6nJ0TtwyH8pIwPK/vJoA+7TZtzyAJSGBz+s/dg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/typescript-estree": "8.8.1", - "@typescript-eslint/utils": "8.8.1", + "@typescript-eslint/typescript-estree": "8.10.0", + "@typescript-eslint/utils": "8.10.0", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" }, @@ -7672,9 +7672,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.8.1.tgz", - "integrity": "sha512-WCcTP4SDXzMd23N27u66zTKMuEevH4uzU8C9jf0RO4E04yVHgQgW+r+TeVTNnO1KIfrL8ebgVVYYMMO3+jC55Q==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.10.0.tgz", + "integrity": "sha512-k/E48uzsfJCRRbGLapdZgrX52csmWJ2rcowwPvOZ8lwPUv3xW6CcFeJAXgx4uJm+Ge4+a4tFOkdYvSpxhRhg1w==", "dev": true, "license": "MIT", "engines": { @@ -7686,14 +7686,14 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.8.1.tgz", - "integrity": "sha512-A5d1R9p+X+1js4JogdNilDuuq+EHZdsH9MjTVxXOdVFfTJXunKJR/v+fNNyO4TnoOn5HqobzfRlc70NC6HTcdg==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.10.0.tgz", + "integrity": "sha512-3OE0nlcOHaMvQ8Xu5gAfME3/tWVDpb/HxtpUZ1WeOAksZ/h/gwrBzCklaGzwZT97/lBbbxJ16dMA98JMEngW4w==", "dev": true, "license": "BSD-2-Clause", "dependencies": { - "@typescript-eslint/types": "8.8.1", - "@typescript-eslint/visitor-keys": "8.8.1", + "@typescript-eslint/types": "8.10.0", + "@typescript-eslint/visitor-keys": "8.10.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -7715,16 +7715,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.8.1.tgz", - "integrity": "sha512-/QkNJDbV0bdL7H7d0/y0qBbV2HTtf0TIyjSDTvvmQEzeVx8jEImEbLuOA4EsvE8gIgqMitns0ifb5uQhMj8d9w==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.10.0.tgz", + "integrity": "sha512-Oq4uZ7JFr9d1ZunE/QKy5egcDRXT/FrS2z/nlxzPua2VHFtmMvFNDvpq1m/hq0ra+T52aUezfcjGRIB7vNJF9w==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.8.1", - "@typescript-eslint/types": "8.8.1", - "@typescript-eslint/typescript-estree": "8.8.1" + "@typescript-eslint/scope-manager": "8.10.0", + "@typescript-eslint/types": "8.10.0", + "@typescript-eslint/typescript-estree": "8.10.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -7738,13 +7738,13 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.8.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.8.1.tgz", - "integrity": "sha512-0/TdC3aeRAsW7MDvYRwEc1Uwm0TIBfzjPFgg60UU2Haj5qsCs9cc3zNgY71edqE3LbWfF/WoZQd3lJoDXFQpag==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.10.0.tgz", + "integrity": "sha512-k8nekgqwr7FadWk548Lfph6V3r9OVqjzAIVskE7orMZR23cGJjAOVazsZSJW+ElyjfTM4wx/1g88Mi70DDtG9A==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.8.1", + "@typescript-eslint/types": "8.10.0", "eslint-visitor-keys": "^3.4.3" }, "engines": { @@ -8337,9 +8337,9 @@ } }, "node_modules/array-flatten": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", - "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-3.0.0.tgz", + "integrity": "sha512-zPMVc3ZYlGLNk4mpK1NzP2wg0ml9t7fUgDsayR5Y5rSzxQilzR9FGu/EH2jQOcKSAeAfWeylyW8juy3OkWRvNA==", "dev": true, "license": "MIT" }, @@ -8803,28 +8803,26 @@ } }, "node_modules/body-parser": { - "version": "1.20.3", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.3.tgz", - "integrity": "sha512-7rAxByjUMqQ3/bHJy7D6OGXvx/MMc4IqBn/X0fcM1QUcAItpZrBEYhWGem+tzXH90c+G01ypMcYJBO9Y30203g==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.0.1.tgz", + "integrity": "sha512-PagxbjvuPH6tv0f/kdVbFGcb79D236SLcDTs6DrQ7GizJ88S1UWP4nMXFEo/I4fdhGRGabvFfFjVGm3M7U8JwA==", "dev": true, "license": "MIT", "dependencies": { "bytes": "3.1.2", "content-type": "~1.0.5", - "debug": "2.6.9", - "depd": "2.0.0", + "debug": "3.1.0", "destroy": "1.2.0", "http-errors": "2.0.0", - "iconv-lite": "0.4.24", + "iconv-lite": "0.5.2", "on-finished": "2.4.1", "qs": "6.13.0", - "raw-body": "2.5.2", + "raw-body": "^3.0.0", "type-is": "~1.6.18", "unpipe": "1.0.0" }, "engines": { - "node": ">= 0.8", - "npm": "1.2.8000 || >= 1.4.16" + "node": ">= 0.10" } }, "node_modules/body-parser/node_modules/bytes": { @@ -8837,6 +8835,43 @@ "node": ">= 0.8" } }, + "node_modules/body-parser/node_modules/iconv-lite": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.5.2.tgz", + "integrity": "sha512-kERHXvpSaB4aU3eANwidg79K8FlrN77m8G9V+0vOR3HYaRifrlwMEpT7ZBJqLSEIHnEgJTHcWK82wwLwwKwtag==", + "dev": true, + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/body-parser/node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/body-parser/node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, "node_modules/bonjour-service": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/bonjour-service/-/bonjour-service-1.2.1.tgz", @@ -9602,9 +9637,9 @@ "optional": true }, "node_modules/content-disposition": { - "version": "0.5.4", - "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", - "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.0.0.tgz", + "integrity": "sha512-Au9nRL8VNUut/XSzbQA38+M78dzP4D+eqg3gfJHMIHHYa3bg067xj1KxMUWj+VULbiZMowKngFFbKczUrNJ1mg==", "dev": true, "license": "MIT", "dependencies": { @@ -9652,21 +9687,24 @@ "license": "MIT" }, "node_modules/cookie": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.1.tgz", - "integrity": "sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-1.0.1.tgz", + "integrity": "sha512-Xd8lFX4LM9QEEwxQpF9J9NTUh8pmdJO0cyRJhFiDoLTk2eH8FXlRv2IFGYVadZpqI3j8fhNrSdKCeYPxiAhLXw==", "dev": true, "license": "MIT", "engines": { - "node": ">= 0.6" + "node": ">=18" } }, "node_modules/cookie-signature": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz", - "integrity": "sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.2.1.tgz", + "integrity": "sha512-78KWk9T26NhzXtuL26cIJ8/qNHANyJ/ZYrmEXFzUmhZdjpBv+DlWlOANRTGBt48YcyslsLrj0bMLFTmXvLRCOw==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=6.6.0" + } }, "node_modules/copy-anything": { "version": "2.0.6", @@ -9870,9 +9908,9 @@ "license": "MIT" }, "node_modules/critters": { - "version": "0.0.24", - "resolved": "https://registry.npmjs.org/critters/-/critters-0.0.24.tgz", - "integrity": "sha512-Oyqew0FGM0wYUSNqR0L6AteO5MpMoUU0rhKRieXeiKs+PmRTxiJMyaunYB2KF6fQ3dzChXKCpbFOEJx3OQ1v/Q==", + "version": "0.0.25", + "resolved": "https://registry.npmjs.org/critters/-/critters-0.0.25.tgz", + "integrity": "sha512-ROF/tjJyyRdM8/6W0VqoN5Ql05xAGnkf5b7f3sTEl1bI5jTQQf8O918RD/V9tEb9pRY/TKcvJekDbJtniHyPtQ==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -11943,46 +11981,94 @@ } }, "node_modules/express": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/express/-/express-4.21.0.tgz", - "integrity": "sha512-VqcNGcj/Id5ZT1LZ/cfihi3ttTn+NJmkli2eZADigjq29qTlWi/hAQ43t/VLPq8+UX06FCEx3ByOYet6ZFblng==", + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/express/-/express-5.0.1.tgz", + "integrity": "sha512-ORF7g6qGnD+YtUG9yx4DFoqCShNMmUKiXuT5oWMHiOvt/4WFbHC6yCwQMTSBMno7AqntNCAzzcnnjowRkTL9eQ==", "dev": true, "license": "MIT", "dependencies": { - "accepts": "~1.3.8", - "array-flatten": "1.1.1", - "body-parser": "1.20.3", - "content-disposition": "0.5.4", + "accepts": "^2.0.0", + "body-parser": "^2.0.1", + "content-disposition": "^1.0.0", "content-type": "~1.0.4", - "cookie": "0.6.0", - "cookie-signature": "1.0.6", - "debug": "2.6.9", + "cookie": "0.7.1", + "cookie-signature": "^1.2.1", + "debug": "4.3.6", "depd": "2.0.0", "encodeurl": "~2.0.0", "escape-html": "~1.0.3", "etag": "~1.8.1", - "finalhandler": "1.3.1", - "fresh": "0.5.2", + "finalhandler": "^2.0.0", + "fresh": "2.0.0", "http-errors": "2.0.0", - "merge-descriptors": "1.0.3", + "merge-descriptors": "^2.0.0", "methods": "~1.1.2", + "mime-types": "^3.0.0", "on-finished": "2.4.1", + "once": "1.4.0", "parseurl": "~1.3.3", - "path-to-regexp": "0.1.10", "proxy-addr": "~2.0.7", "qs": "6.13.0", "range-parser": "~1.2.1", + "router": "^2.0.0", "safe-buffer": "5.2.1", - "send": "0.19.0", - "serve-static": "1.16.2", + "send": "^1.1.0", + "serve-static": "^2.1.0", "setprototypeof": "1.2.0", "statuses": "2.0.1", - "type-is": "~1.6.18", + "type-is": "^2.0.0", "utils-merge": "1.0.1", "vary": "~1.1.2" }, "engines": { - "node": ">= 0.10.0" + "node": ">= 18" + } + }, + "node_modules/express/node_modules/accepts": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-2.0.0.tgz", + "integrity": "sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng==", + "dev": true, + "license": "MIT", + "dependencies": { + "mime-types": "^3.0.0", + "negotiator": "^1.0.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/mime-db": { + "version": "1.53.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.53.0.tgz", + "integrity": "sha512-oHlN/w+3MQ3rba9rqFr6V/ypF10LSkdwUysQL7GkXoTgIWeV+tcXGA852TBxH+gsh8UWoyhR1hKcoMJTuWflpg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/mime-types": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.0.tgz", + "integrity": "sha512-XqoSHeCGjVClAmoGFG3lVFqQFRIrTVw2OH3axRqAcfaw+gHWIfnASS92AV+Rl/mk0MupgZTRHQOjxY6YVnzK5w==", + "dev": true, + "license": "MIT", + "dependencies": { + "mime-db": "^1.53.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/negotiator": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz", + "integrity": "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.6" } }, "node_modules/express/node_modules/safe-buffer": { @@ -12192,14 +12278,14 @@ } }, "node_modules/finalhandler": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.1.tgz", - "integrity": "sha512-6BN9trH7bp3qvnrRyzsBz+g3lZxTNZTbVO2EV1CS0WIcDbawYVdYvGflME/9QP0h0pYlCDBCTjYa9nZzMDpyxQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-2.0.0.tgz", + "integrity": "sha512-MX6Zo2adDViYh+GcxxB1dpO43eypOGUOL12rLCOTMQv/DfIbpSJUy4oQIIZhVZkH9e+bZWKMon0XHFEju16tkQ==", "dev": true, "license": "MIT", "dependencies": { "debug": "2.6.9", - "encodeurl": "~2.0.0", + "encodeurl": "~1.0.2", "escape-html": "~1.0.3", "on-finished": "2.4.1", "parseurl": "~1.3.3", @@ -12210,6 +12296,16 @@ "node": ">= 0.8" } }, + "node_modules/finalhandler/node_modules/encodeurl": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", + "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, "node_modules/find-cache-dir": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-4.0.0.tgz", @@ -12396,13 +12492,13 @@ } }, "node_modules/fresh": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", - "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-2.0.0.tgz", + "integrity": "sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A==", "dev": true, "license": "MIT", "engines": { - "node": ">= 0.6" + "node": ">= 0.8" } }, "node_modules/front-matter": { @@ -13617,6 +13713,13 @@ "dev": true, "license": "MIT" }, + "node_modules/is-promise": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/is-promise/-/is-promise-4.0.0.tgz", + "integrity": "sha512-hvpoI6korhJMnej285dSg6nu1+e6uxs7zG3BYAm5byqDsgJNWwxzM6z6iZiAgQR4TJ30JmBTOwqZUw3WlyH3AQ==", + "dev": true, + "license": "MIT" + }, "node_modules/is-stream": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", @@ -16877,19 +16980,19 @@ "license": "ISC" }, "node_modules/media-typer": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", - "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-1.1.0.tgz", + "integrity": "sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw==", "dev": true, "license": "MIT", "engines": { - "node": ">= 0.6" + "node": ">= 0.8" } }, "node_modules/memfs": { - "version": "4.13.0", - "resolved": "https://registry.npmjs.org/memfs/-/memfs-4.13.0.tgz", - "integrity": "sha512-dIs5KGy24fbdDhIAg0RxXpFqQp3RwL6wgSMRF9OSuphL/Uc9a4u2/SDJKPLj/zUgtOGKuHrRMrj563+IErj4Cg==", + "version": "4.14.0", + "resolved": "https://registry.npmjs.org/memfs/-/memfs-4.14.0.tgz", + "integrity": "sha512-JUeY0F/fQZgIod31Ja1eJgiSxLn7BfQlCnqhwXFBzFHEw63OdLK7VJUJ7bnzNsWgCyoUP5tEp1VRY8rDaYzqOA==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -16907,11 +17010,14 @@ } }, "node_modules/merge-descriptors": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", - "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-2.0.0.tgz", + "integrity": "sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==", "dev": true, "license": "MIT", + "engines": { + "node": ">=18" + }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } @@ -16973,6 +17079,7 @@ "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", "dev": true, "license": "MIT", + "optional": true, "bin": { "mime": "cli.js" }, @@ -18855,11 +18962,14 @@ "license": "ISC" }, "node_modules/path-to-regexp": { - "version": "0.1.10", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.10.tgz", - "integrity": "sha512-7lf7qcQidTku0Gu3YDPc8DJ1q7OOucfa/BSsIwjuh56VU7katFvuM8hULfkwB3Fns/rsVF7PwPKVw1sl5KQS9w==", + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.2.0.tgz", + "integrity": "sha512-TdrF7fW9Rphjq4RjrW0Kp2AW0Ahwu9sRGTkS6bvDi0SCwZlEZYmcfDbEsTz8RVk0EHIS/Vd1bv3JhG+1xZuAyQ==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=16" + } }, "node_modules/path-type": { "version": "5.0.0", @@ -19222,14 +19332,15 @@ "license": "MIT" }, "node_modules/posthog-js": { - "version": "1.167.0", - "resolved": "https://registry.npmjs.org/posthog-js/-/posthog-js-1.167.0.tgz", - "integrity": "sha512-/zXQ6tuJgiF1d4mgg3UsAi/uoyg7UnfFNQtikuALmaE53xFExpcAKbMfHPG/f54QgTvLxSHyGL1kFl/1uspkGg==", + "version": "1.174.2", + "resolved": "https://registry.npmjs.org/posthog-js/-/posthog-js-1.174.2.tgz", + "integrity": "sha512-UgS7eRcDVvVz2XSJ09NMX8zBcdpFnPayfiWDNF3xEbJTsIu1GipkkYNrVlsWlq8U1PIrviNm6i0Dyq8daaxssw==", "license": "MIT", "dependencies": { + "core-js": "^3.38.1", "fflate": "^0.4.8", "preact": "^10.19.3", - "web-vitals": "^4.0.1" + "web-vitals": "^4.2.0" } }, "node_modules/preact": { @@ -19506,15 +19617,15 @@ } }, "node_modules/raw-body": { - "version": "2.5.2", - "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.2.tgz", - "integrity": "sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-3.0.0.tgz", + "integrity": "sha512-RmkhL8CAyCRPXCE28MMH0z2PNWQBNk2Q09ZdxM9IOOXwxwZbN+qbWaatPkdkWIKL2ZVDImrN/pK5HTRz2PcS4g==", "dev": true, "license": "MIT", "dependencies": { "bytes": "3.1.2", "http-errors": "2.0.0", - "iconv-lite": "0.4.24", + "iconv-lite": "0.6.3", "unpipe": "1.0.0" }, "engines": { @@ -19531,6 +19642,19 @@ "node": ">= 0.8" } }, + "node_modules/raw-body/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/react": { "version": "18.2.0", "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz", @@ -20161,6 +20285,25 @@ "dev": true, "license": "MIT" }, + "node_modules/router": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/router/-/router-2.0.0.tgz", + "integrity": "sha512-dIM5zVoG8xhC6rnSN8uoAgFARwTE7BQs8YwHEvK0VCmfxQXMaOuA1uiR1IPwsW7JyK5iTt7Od/TC9StasS2NPQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-flatten": "3.0.0", + "is-promise": "4.0.0", + "methods": "~1.1.2", + "parseurl": "~1.3.3", + "path-to-regexp": "^8.0.0", + "setprototypeof": "1.2.0", + "utils-merge": "1.0.1" + }, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/rrweb-cssom": { "version": "0.7.1", "resolved": "https://registry.npmjs.org/rrweb-cssom/-/rrweb-cssom-0.7.1.tgz", @@ -20227,9 +20370,9 @@ "license": "MIT" }, "node_modules/sass": { - "version": "1.79.5", - "resolved": "https://registry.npmjs.org/sass/-/sass-1.79.5.tgz", - "integrity": "sha512-W1h5kp6bdhqFh2tk3DsI771MoEJjvrSY/2ihJRJS4pjIyfJCw0nTsxqhnrUzaLMOJjFchj8rOvraI/YUVjtx5g==", + "version": "1.80.2", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.80.2.tgz", + "integrity": "sha512-9wXY8cGBlUmoUoT+vwOZOFCiS+naiWVjqlreN9ar9PudXbGwlMTFwCR5K9kB4dFumJ6ib98wZyAObJKsWf1nAA==", "dev": true, "license": "MIT", "dependencies": { @@ -20418,38 +20561,37 @@ } }, "node_modules/send": { - "version": "0.19.0", - "resolved": "https://registry.npmjs.org/send/-/send-0.19.0.tgz", - "integrity": "sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/send/-/send-1.1.0.tgz", + "integrity": "sha512-v67WcEouB5GxbTWL/4NeToqcZiAWEq90N888fczVArY8A79J0L4FD7vj5hm3eUMua5EpoQ59wa/oovY6TLvRUA==", "dev": true, "license": "MIT", "dependencies": { - "debug": "2.6.9", - "depd": "2.0.0", - "destroy": "1.2.0", - "encodeurl": "~1.0.2", - "escape-html": "~1.0.3", - "etag": "~1.8.1", - "fresh": "0.5.2", - "http-errors": "2.0.0", - "mime": "1.6.0", - "ms": "2.1.3", - "on-finished": "2.4.1", - "range-parser": "~1.2.1", - "statuses": "2.0.1" + "debug": "^4.3.5", + "destroy": "^1.2.0", + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "etag": "^1.8.1", + "fresh": "^0.5.2", + "http-errors": "^2.0.0", + "mime-types": "^2.1.35", + "ms": "^2.1.3", + "on-finished": "^2.4.1", + "range-parser": "^1.2.1", + "statuses": "^2.0.1" }, "engines": { - "node": ">= 0.8.0" + "node": ">= 18" } }, - "node_modules/send/node_modules/encodeurl": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", - "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==", + "node_modules/send/node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", "dev": true, "license": "MIT", "engines": { - "node": ">= 0.8" + "node": ">= 0.6" } }, "node_modules/serialize-javascript": { @@ -20532,19 +20674,19 @@ } }, "node_modules/serve-static": { - "version": "1.16.2", - "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.2.tgz", - "integrity": "sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-2.1.0.tgz", + "integrity": "sha512-A3We5UfEjG8Z7VkDv6uItWw6HY2bBSBJT1KtVESn6EOoOr2jAxNhxWCLY3jDE2WcuHXByWju74ck3ZgLwL8xmA==", "dev": true, "license": "MIT", "dependencies": { - "encodeurl": "~2.0.0", - "escape-html": "~1.0.3", - "parseurl": "~1.3.3", - "send": "0.19.0" + "encodeurl": "^2.0.0", + "escape-html": "^1.0.3", + "parseurl": "^1.3.3", + "send": "^1.0.0" }, "engines": { - "node": ">= 0.8.0" + "node": ">= 18" } }, "node_modules/set-blocking": { @@ -20783,9 +20925,9 @@ } }, "node_modules/simple-statistics": { - "version": "7.8.5", - "resolved": "https://registry.npmjs.org/simple-statistics/-/simple-statistics-7.8.5.tgz", - "integrity": "sha512-yw4aOnkvPLbL80zamrEKznAnk5cIIkjEcx/z0aQl+m/YKMmVufrnWgWJWRspqZtwh+ElZXRhJ0MtnUjFUQV5Ow==", + "version": "7.8.7", + "resolved": "https://registry.npmjs.org/simple-statistics/-/simple-statistics-7.8.7.tgz", + "integrity": "sha512-ed5FwTNYvkMTfbCai1U+r3symP+lIPKWCqKdudpN4NFNMn9RtDlFtSyAQhCp4oPH0YBjWu/qnW+5q5ZkPB3uHQ==", "license": "ISC", "engines": { "node": "*" @@ -22058,9 +22200,9 @@ } }, "node_modules/tslib": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz", - "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA==", + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.0.tgz", + "integrity": "sha512-jWVzBLplnCmoaTr13V9dYbiQ99wvZRd0vNWaDRg+aVYRcjDF3nDksxFDE/+fkXnKhpnUUkmx5pK/v8mCtLVqZA==", "license": "0BSD" }, "node_modules/tsutils": { @@ -22138,14 +22280,38 @@ } }, "node_modules/type-is": { - "version": "1.6.18", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", - "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.0.tgz", + "integrity": "sha512-gd0sGezQYCbWSbkZr75mln4YBidWUN60+devscpLF5mtRDUpiaTvKpBNrdaCvel1NdR2k6vclXybU5fBd2i+nw==", "dev": true, "license": "MIT", "dependencies": { - "media-typer": "0.3.0", - "mime-types": "~2.1.24" + "content-type": "^1.0.5", + "media-typer": "^1.1.0", + "mime-types": "^3.0.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-db": { + "version": "1.53.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.53.0.tgz", + "integrity": "sha512-oHlN/w+3MQ3rba9rqFr6V/ypF10LSkdwUysQL7GkXoTgIWeV+tcXGA852TBxH+gsh8UWoyhR1hKcoMJTuWflpg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-types": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.0.tgz", + "integrity": "sha512-XqoSHeCGjVClAmoGFG3lVFqQFRIrTVw2OH3axRqAcfaw+gHWIfnASS92AV+Rl/mk0MupgZTRHQOjxY6YVnzK5w==", + "dev": true, + "license": "MIT", + "dependencies": { + "mime-db": "^1.53.0" }, "engines": { "node": ">= 0.6" @@ -22444,9 +22610,9 @@ } }, "node_modules/vite": { - "version": "5.4.8", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.8.tgz", - "integrity": "sha512-FqrItQ4DT1NC4zCUqMB4c4AZORMKIa0m8/URVCZ77OZ/QSNeJ54bU1vrFADbDsuwfIPcgknRkmqakQcgnL4GiQ==", + "version": "5.4.9", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.9.tgz", + "integrity": "sha512-20OVpJHh0PAM0oSOELa5GaZNWeDjcAvQjGXy2Uyr+Tp+/D2/Hdz6NLgpJLsarPTA2QJ6v8mX2P1ZfbsSKvdMkg==", "dev": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 755adfae3d3e..fb1e38afe1cd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "artemis", - "version": "7.6.0", + "version": "7.6.1", "description": "Interactive Learning with Individual Feedback", "private": true, "license": "MIT", @@ -14,20 +14,20 @@ ], "dependencies": { "@angular/animations": "18.2.8", - "@angular/cdk": "18.2.8", + "@angular/cdk": "18.2.9", "@angular/common": "18.2.8", "@angular/compiler": "18.2.8", "@angular/core": "18.2.8", "@angular/forms": "18.2.8", "@angular/localize": "18.2.8", - "@angular/material": "18.2.8", + "@angular/material": "18.2.9", "@angular/platform-browser": "18.2.8", "@angular/platform-browser-dynamic": "18.2.8", "@angular/router": "18.2.8", "@angular/service-worker": "18.2.8", "@ctrl/ngx-emoji-mart": "9.2.0", "@danielmoncada/angular-datetime-picker": "18.1.0", - "@fingerprintjs/fingerprintjs": "4.5.0", + "@fingerprintjs/fingerprintjs": "4.5.1", "@fortawesome/angular-fontawesome": "0.15.0", "@fortawesome/fontawesome-svg-core": "6.6.0", "@fortawesome/free-regular-svg-icons": "6.6.0", @@ -63,17 +63,17 @@ "ngx-webstorage": "18.0.0", "papaparse": "5.4.1", "pdfjs-dist": "4.7.76", - "posthog-js": "1.167.0", + "posthog-js": "1.174.2", "rxjs": "7.8.1", "showdown": "2.1.0", "showdown-highlight": "3.1.0", "showdown-katex": "0.6.0", - "simple-statistics": "7.8.5", + "simple-statistics": "7.8.7", "smoothscroll-polyfill": "0.4.4", "sockjs-client": "1.6.1", "split.js": "1.6.5", "ts-cacheable": "1.0.10", - "tslib": "2.7.0", + "tslib": "2.8.0", "uuid": "10.0.0", "webstomp-client": "1.2.6", "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz", @@ -91,16 +91,16 @@ "eslint": "^9.12.0" }, "braces": "3.0.3", - "cookie": "0.7.1", - "critters": "0.0.24", + "cookie": "1.0.1", + "critters": "0.0.25", "debug": "4.3.7", "eslint-plugin-deprecation": { "eslint": "^9.12.0" }, "eslint-plugin-jest": { - "@typescript-eslint/eslint-plugin": "^8.8.0" + "@typescript-eslint/eslint-plugin": "^8.10.0" }, - "express": "4.21.0", + "express": "5.0.1", "jsdom": "25.0.1", "katex": "0.16.11", "postcss": "8.4.47", @@ -110,7 +110,7 @@ "showdown": "2.1.0" }, "tough-cookie": "5.0.0", - "vite": "5.4.8", + "vite": "5.4.9", "webpack-dev-middleware": "7.4.2", "webpack-dev-server": "5.1.0", "word-wrap": "1.2.5", @@ -119,13 +119,13 @@ }, "devDependencies": { "@angular-builders/jest": "18.0.0", - "@angular-devkit/build-angular": "18.2.8", + "@angular-devkit/build-angular": "18.2.9", "@angular-eslint/builder": "18.3.1", "@angular-eslint/eslint-plugin": "18.3.1", "@angular-eslint/eslint-plugin-template": "18.3.1", "@angular-eslint/schematics": "18.3.1", "@angular-eslint/template-parser": "18.3.1", - "@angular/cli": "18.2.8", + "@angular/cli": "18.2.9", "@angular/compiler-cli": "18.2.8", "@angular/language-service": "18.2.8", "@sentry/types": "8.34.0", @@ -134,14 +134,14 @@ "@types/dompurify": "3.0.5", "@types/jest": "29.5.13", "@types/lodash-es": "4.17.12", - "@types/node": "22.7.5", + "@types/node": "22.7.6", "@types/papaparse": "5.3.14", "@types/showdown": "2.0.6", "@types/smoothscroll-polyfill": "0.3.4", "@types/sockjs-client": "1.5.4", "@types/uuid": "10.0.0", - "@typescript-eslint/eslint-plugin": "8.8.1", - "@typescript-eslint/parser": "8.8.1", + "@typescript-eslint/eslint-plugin": "8.10.0", + "@typescript-eslint/parser": "8.10.0", "eslint": "9.12.0", "eslint-config-prettier": "9.1.0", "eslint-plugin-deprecation": "3.0.0", @@ -162,7 +162,7 @@ "ng-mocks": "14.13.1", "prettier": "3.3.3", "rimraf": "6.0.1", - "sass": "1.79.5", + "sass": "1.80.2", "ts-jest": "29.2.5", "typescript": "5.5.4", "weak-napi": "2.0.2" diff --git a/src/main/java/de/tum/cit/aet/artemis/atlas/dto/CompetencyGraphNodeDTO.java b/src/main/java/de/tum/cit/aet/artemis/atlas/dto/CompetencyGraphNodeDTO.java index 59feee0edd6b..c56876064668 100644 --- a/src/main/java/de/tum/cit/aet/artemis/atlas/dto/CompetencyGraphNodeDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/atlas/dto/CompetencyGraphNodeDTO.java @@ -12,7 +12,7 @@ public record CompetencyGraphNodeDTO(String id, String label, ZonedDateTime softDueDate, Double value, CompetencyNodeValueType valueType) { public enum CompetencyNodeValueType { - MASTERY_PROGRESS + MASTERY_PROGRESS, AVERAGE_MASTERY_PROGRESS, } public static CompetencyGraphNodeDTO of(@NotNull CourseCompetency competency, Double value, CompetencyNodeValueType valueType) { diff --git a/src/main/java/de/tum/cit/aet/artemis/atlas/dto/LearningPathHealthDTO.java b/src/main/java/de/tum/cit/aet/artemis/atlas/dto/LearningPathHealthDTO.java index 8592378c6a50..05d621746267 100644 --- a/src/main/java/de/tum/cit/aet/artemis/atlas/dto/LearningPathHealthDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/atlas/dto/LearningPathHealthDTO.java @@ -14,6 +14,6 @@ public LearningPathHealthDTO(Set status) { } public enum HealthStatus { - OK, DISABLED, MISSING, NO_COMPETENCIES, NO_RELATIONS + MISSING, NO_COMPETENCIES, NO_RELATIONS } } diff --git a/src/main/java/de/tum/cit/aet/artemis/atlas/repository/CompetencyProgressRepository.java b/src/main/java/de/tum/cit/aet/artemis/atlas/repository/CompetencyProgressRepository.java index 85c627b06408..2e397c06db36 100644 --- a/src/main/java/de/tum/cit/aet/artemis/atlas/repository/CompetencyProgressRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/atlas/repository/CompetencyProgressRepository.java @@ -94,4 +94,16 @@ SELECT COUNT(cp) AND c = :competency """) Set findAllPriorByCompetencyId(@Param("competency") CourseCompetency competency, @Param("user") User userId); + + @Query(""" + SELECT COALESCE(GREATEST(0.0, LEAST(1.0, AVG(cp.progress * cp.confidence / com.masteryThreshold))), 0.0) + FROM CompetencyProgress cp + LEFT JOIN cp.competency com + LEFT JOIN com.course c + LEFT JOIN cp.user u + WHERE com.id = :competencyId + AND cp.progress > 0 + AND c.studentGroupName MEMBER OF u.groups + """) + double findAverageOfAllNonZeroStudentProgressByCompetencyId(@Param("competencyId") long competencyId); } diff --git a/src/main/java/de/tum/cit/aet/artemis/atlas/service/competency/CompetencyJolService.java b/src/main/java/de/tum/cit/aet/artemis/atlas/service/competency/CompetencyJolService.java index 8deffa786626..1011cacaf450 100644 --- a/src/main/java/de/tum/cit/aet/artemis/atlas/service/competency/CompetencyJolService.java +++ b/src/main/java/de/tum/cit/aet/artemis/atlas/service/competency/CompetencyJolService.java @@ -86,9 +86,7 @@ public void setJudgementOfLearning(long competencyId, long userId, short jolValu irisCourseChatSessionService.ifPresent(service -> { // Inform Iris so it can send a message to the user try { - if (userId % 3 > 0) { // HD3-GROUPS: Iris groups are 1 & 2 - service.onJudgementOfLearningSet(jol); - } + service.onJudgementOfLearningSet(jol); } catch (Exception e) { log.warn("Something went wrong while sending the judgement of learning to Iris", e); diff --git a/src/main/java/de/tum/cit/aet/artemis/atlas/service/learningpath/LearningPathService.java b/src/main/java/de/tum/cit/aet/artemis/atlas/service/learningpath/LearningPathService.java index 190565c5c35c..ea2a4bd9ec37 100644 --- a/src/main/java/de/tum/cit/aet/artemis/atlas/service/learningpath/LearningPathService.java +++ b/src/main/java/de/tum/cit/aet/artemis/atlas/service/learningpath/LearningPathService.java @@ -33,6 +33,7 @@ import de.tum.cit.aet.artemis.atlas.repository.CompetencyProgressRepository; import de.tum.cit.aet.artemis.atlas.repository.CompetencyRelationRepository; import de.tum.cit.aet.artemis.atlas.repository.CompetencyRepository; +import de.tum.cit.aet.artemis.atlas.repository.CourseCompetencyRepository; import de.tum.cit.aet.artemis.atlas.repository.LearningPathRepository; import de.tum.cit.aet.artemis.atlas.service.competency.CompetencyProgressService; import de.tum.cit.aet.artemis.core.domain.Course; @@ -89,10 +90,13 @@ public class LearningPathService { private final StudentParticipationRepository studentParticipationRepository; + private final CourseCompetencyRepository courseCompetencyRepository; + public LearningPathService(UserRepository userRepository, LearningPathRepository learningPathRepository, CompetencyProgressRepository competencyProgressRepository, LearningPathNavigationService learningPathNavigationService, CourseRepository courseRepository, CompetencyRepository competencyRepository, CompetencyRelationRepository competencyRelationRepository, LearningPathNgxService learningPathNgxService, - LectureUnitCompletionRepository lectureUnitCompletionRepository, StudentParticipationRepository studentParticipationRepository) { + LectureUnitCompletionRepository lectureUnitCompletionRepository, StudentParticipationRepository studentParticipationRepository, + CourseCompetencyRepository courseCompetencyRepository) { this.userRepository = userRepository; this.learningPathRepository = learningPathRepository; this.competencyProgressRepository = competencyProgressRepository; @@ -103,6 +107,7 @@ public LearningPathService(UserRepository userRepository, LearningPathRepository this.learningPathNgxService = learningPathNgxService; this.lectureUnitCompletionRepository = lectureUnitCompletionRepository; this.studentParticipationRepository = studentParticipationRepository; + this.courseCompetencyRepository = courseCompetencyRepository; } /** @@ -298,20 +303,11 @@ else if (learningPath.isStartedByStudent()) { * @return dto containing the health status and additional information (missing learning paths) if needed */ public LearningPathHealthDTO getHealthStatusForCourse(@NotNull Course course) { - if (!course.getLearningPathsEnabled()) { - return new LearningPathHealthDTO(Set.of(LearningPathHealthDTO.HealthStatus.DISABLED)); - } - Set status = new HashSet<>(); Long numberOfMissingLearningPaths = checkMissingLearningPaths(course, status); checkNoCompetencies(course, status); checkNoRelations(course, status); - // if no issues where found, add OK status - if (status.isEmpty()) { - status.add(LearningPathHealthDTO.HealthStatus.OK); - } - return new LearningPathHealthDTO(status, numberOfMissingLearningPaths); } @@ -366,6 +362,25 @@ public LearningPathCompetencyGraphDTO generateLearningPathCompetencyGraph(@NotNu return new LearningPathCompetencyGraphDTO(progressDTOs, relationDTOs); } + /** + * Generates the graph of competencies with the student's progress for the given learning path. + * + * @param courseId the id of the course for which the graph should be generated + * @return dto containing the competencies and relations of the learning path + */ + public LearningPathCompetencyGraphDTO generateLearningPathCompetencyInstructorGraph(long courseId) { + List competencies = courseCompetencyRepository.findByCourseIdOrderById(courseId); + Set progressDTOs = competencies.stream().map(competency -> { + double averageMasteryProgress = competencyProgressRepository.findAverageOfAllNonZeroStudentProgressByCompetencyId(competency.getId()); + return CompetencyGraphNodeDTO.of(competency, averageMasteryProgress, CompetencyGraphNodeDTO.CompetencyNodeValueType.AVERAGE_MASTERY_PROGRESS); + }).collect(Collectors.toSet()); + + Set relations = competencyRelationRepository.findAllWithHeadAndTailByCourseId(courseId); + Set relationDTOs = relations.stream().map(CompetencyGraphEdgeDTO::of).collect(Collectors.toSet()); + + return new LearningPathCompetencyGraphDTO(progressDTOs, relationDTOs); + } + /** * Generates Ngx graph representation of the learning path graph. * diff --git a/src/main/java/de/tum/cit/aet/artemis/atlas/web/LearningPathResource.java b/src/main/java/de/tum/cit/aet/artemis/atlas/web/LearningPathResource.java index f69dae28f80c..43a8135f27cb 100644 --- a/src/main/java/de/tum/cit/aet/artemis/atlas/web/LearningPathResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/atlas/web/LearningPathResource.java @@ -203,6 +203,21 @@ public ResponseEntity getLearningPathCompetencyG return ResponseEntity.ok(learningPathService.generateLearningPathCompetencyGraph(learningPath, user)); } + /** + * GET courses/{courseId}/learning-path/competency-instructor-graph : Gets the competency instructor graph + * + * @param courseId the id of the course for which the graph should be fetched + * @return the ResponseEntity with status 200 (OK) and with body the graph + */ + @GetMapping("courses/{courseId}/learning-path/competency-instructor-graph") + @FeatureToggle(Feature.LearningPaths) + @EnforceAtLeastInstructorInCourse + public ResponseEntity getLearningPathCompetencyInstructorGraph(@PathVariable long courseId) { + log.debug("REST request to get competency instructor graph for learning path with id: {}", courseId); + + return ResponseEntity.ok(learningPathService.generateLearningPathCompetencyInstructorGraph(courseId)); + } + /** * GET learning-path/:learningPathId/graph : Gets the ngx representation of the learning path as a graph. * diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildAgentInformation.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildAgentInformation.java index 35625765d858..ab24012f51fa 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildAgentInformation.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildAgentInformation.java @@ -11,8 +11,8 @@ // in the future are migrated or cleared. Changes should be communicated in release notes as potentially breaking changes. @JsonIgnoreProperties(ignoreUnknown = true) @JsonInclude(JsonInclude.Include.NON_EMPTY) -public record BuildAgentInformation(String name, int maxNumberOfConcurrentBuildJobs, int numberOfCurrentBuildJobs, List runningBuildJobs, boolean status, - List recentBuildJobs, String publicSshKey) implements Serializable { +public record BuildAgentInformation(String name, int maxNumberOfConcurrentBuildJobs, int numberOfCurrentBuildJobs, List runningBuildJobs, + BuildAgentStatus status, List recentBuildJobs, String publicSshKey) implements Serializable { @Serial private static final long serialVersionUID = 1L; @@ -27,4 +27,8 @@ public BuildAgentInformation(BuildAgentInformation agentInformation, List> runningFutures = new ConcurrentHashMap<>(); + private final Map> runningFuturesWrapper = new ConcurrentHashMap<>(); + /** * A set that contains all build jobs that were cancelled by the user. * This set is unique for each node and contains only the build jobs that were cancelled on this node. @@ -178,9 +180,20 @@ public CompletableFuture executeBuildJob(BuildJobQueueItem buildJob } } }); - futureResult.whenComplete(((result, throwable) -> runningFutures.remove(buildJobItem.id()))); - return futureResult; + runningFuturesWrapper.put(buildJobItem.id(), futureResult); + return futureResult.whenComplete(((result, throwable) -> { + runningFutures.remove(buildJobItem.id()); + runningFuturesWrapper.remove(buildJobItem.id()); + })); + } + + Set getRunningBuildJobIds() { + return Set.copyOf(runningFutures.keySet()); + } + + CompletableFuture getRunningBuildJobFutureWrapper(String buildJobId) { + return runningFuturesWrapper.get(buildJobId); } /** @@ -235,7 +248,7 @@ private void finishBuildJobExceptionally(String buildJobId, String containerName * * @param buildJobId The id of the build job that should be cancelled. */ - private void cancelBuildJob(String buildJobId) { + void cancelBuildJob(String buildJobId) { Future future = runningFutures.get(buildJobId); if (future != null) { try { diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java index 7534de04e3bf..e73f8bac244b 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java @@ -2,6 +2,7 @@ import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_BUILDAGENT; +import java.time.Duration; import java.time.ZonedDateTime; import java.util.ArrayList; import java.util.List; @@ -10,20 +11,28 @@ import java.util.UUID; import java.util.concurrent.CancellationException; import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutorService; import java.util.concurrent.RejectedExecutionException; +import java.util.concurrent.ScheduledFuture; import java.util.concurrent.ThreadPoolExecutor; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.locks.ReentrantLock; import java.util.stream.Collectors; -import jakarta.annotation.PostConstruct; import jakarta.annotation.PreDestroy; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.context.event.ApplicationReadyEvent; import org.springframework.context.annotation.Profile; +import org.springframework.context.event.EventListener; +import org.springframework.scheduling.TaskScheduler; import org.springframework.scheduling.annotation.Scheduled; import org.springframework.stereotype.Service; @@ -32,7 +41,9 @@ import com.hazelcast.collection.ItemEvent; import com.hazelcast.collection.ItemListener; import com.hazelcast.core.HazelcastInstance; +import com.hazelcast.core.HazelcastInstanceNotActiveException; import com.hazelcast.map.IMap; +import com.hazelcast.topic.ITopic; import de.tum.cit.aet.artemis.buildagent.dto.BuildAgentInformation; import de.tum.cit.aet.artemis.buildagent.dto.BuildJobQueueItem; @@ -64,6 +75,8 @@ public class SharedQueueProcessingService { private final BuildAgentSshKeyService buildAgentSSHKeyService; + private final TaskScheduler taskScheduler; + private IQueue queue; private IQueue resultQueue; @@ -80,32 +93,102 @@ public class SharedQueueProcessingService { */ private final ReentrantLock instanceLock = new ReentrantLock(); + /** + * Lock for pausing and resuming the build agent. + */ + private final ReentrantLock pauseResumeLock = new ReentrantLock(); + private UUID listenerId; + /** + * Scheduled future for checking availability and processing next build job. + */ + private ScheduledFuture scheduledFuture; + + /** + * Flag to indicate whether the build agent is paused. + */ + private final AtomicBoolean isPaused = new AtomicBoolean(false); + + /** + * Flag to indicate whether the build agent should process build results. This is necessary to differentiate between when the build agent is paused and grace period is not over + * yet. + */ + private final AtomicBoolean processResults = new AtomicBoolean(true); + + @Value("${artemis.continuous-integration.pause-grace-period-seconds:15}") + private int pauseGracePeriodSeconds; + public SharedQueueProcessingService(@Qualifier("hazelcastInstance") HazelcastInstance hazelcastInstance, ExecutorService localCIBuildExecutorService, - BuildJobManagementService buildJobManagementService, BuildLogsMap buildLogsMap, BuildAgentSshKeyService buildAgentSSHKeyService) { + BuildJobManagementService buildJobManagementService, BuildLogsMap buildLogsMap, BuildAgentSshKeyService buildAgentSSHKeyService, TaskScheduler taskScheduler) { this.hazelcastInstance = hazelcastInstance; this.localCIBuildExecutorService = (ThreadPoolExecutor) localCIBuildExecutorService; this.buildJobManagementService = buildJobManagementService; this.buildLogsMap = buildLogsMap; this.buildAgentSSHKeyService = buildAgentSSHKeyService; + this.taskScheduler = taskScheduler; } /** * Initialize relevant data from hazelcast */ - @PostConstruct + @EventListener(ApplicationReadyEvent.class) public void init() { this.buildAgentInformation = this.hazelcastInstance.getMap("buildAgentInformation"); this.processingJobs = this.hazelcastInstance.getMap("processingJobs"); this.queue = this.hazelcastInstance.getQueue("buildJobQueue"); this.resultQueue = this.hazelcastInstance.getQueue("buildResultQueue"); + // Remove listener if already present + if (this.listenerId != null) { + this.queue.removeItemListener(this.listenerId); + } this.listenerId = this.queue.addItemListener(new QueuedBuildJobItemListener(), true); + + /* + * Check every 10 seconds whether the node has at least one thread available for a new build job. + * If so, process the next build job. + * This is a backup mechanism in case the build queue is not empty, no new build jobs are entering the queue and the + * node otherwise stopped checking for build jobs in the queue. + */ + scheduledFuture = taskScheduler.scheduleAtFixedRate(this::checkAvailabilityAndProcessNextBuild, Duration.ofSeconds(10)); + + ITopic pauseBuildAgentTopic = hazelcastInstance.getTopic("pauseBuildAgentTopic"); + pauseBuildAgentTopic.addMessageListener(message -> { + if (message.getMessageObject().equals(hazelcastInstance.getCluster().getLocalMember().getAddress().toString())) { + pauseBuildAgent(); + } + }); + + ITopic resumeBuildAgentTopic = hazelcastInstance.getTopic("resumeBuildAgentTopic"); + resumeBuildAgentTopic.addMessageListener(message -> { + if (message.getMessageObject().equals(hazelcastInstance.getCluster().getLocalMember().getAddress().toString())) { + resumeBuildAgent(); + } + }); } @PreDestroy - public void removeListener() { - this.queue.removeItemListener(this.listenerId); + public void removeListenerAndCancelScheduledFuture() { + removeListener(); + cancelCheckAvailabilityAndProcessNextBuildScheduledFuture(); + } + + private void removeListener() { + // check if Hazelcast is still active, before invoking this + try { + if (hazelcastInstance != null && hazelcastInstance.getLifecycleService().isRunning()) { + this.queue.removeItemListener(this.listenerId); + } + } + catch (HazelcastInstanceNotActiveException e) { + log.error("Failed to remove listener from SharedQueueProcessingService as Hazelcast instance is not active any more."); + } + } + + private void cancelCheckAvailabilityAndProcessNextBuildScheduledFuture() { + if (scheduledFuture != null && !scheduledFuture.isCancelled()) { + scheduledFuture.cancel(false); + } } /** @@ -127,23 +210,12 @@ public void updateBuildAgentInformation() { } } - /** - * Check every 10 seconds whether the node has at least one thread available for a new build job. - * If so, process the next build job. - * This is a backup mechanism in case the build queue is not empty, no new build jobs are entering the queue and the - * node otherwise stopped checking for build jobs in the queue. - */ - @Scheduled(fixedRate = 10000) - public void checkForBuildJobs() { - checkAvailabilityAndProcessNextBuild(); - } - /** * Checks whether the node has at least one thread available for a new build job. * If so, process the next build job. */ private void checkAvailabilityAndProcessNextBuild() { - if (noDataMemberInClusterAvailable(hazelcastInstance)) { + if (noDataMemberInClusterAvailable(hazelcastInstance) || queue == null) { log.debug("There are only lite member in the cluster. Not processing build jobs."); return; } @@ -158,14 +230,14 @@ private void checkAvailabilityAndProcessNextBuild() { return; } - if (queue.isEmpty()) { + if (queue.isEmpty() || isPaused.get()) { return; } BuildJobQueueItem buildJob = null; instanceLock.lock(); try { // Recheck conditions after acquiring the lock to ensure they are still valid - if (!nodeIsAvailable() || queue.isEmpty()) { + if (!nodeIsAvailable() || queue.isEmpty() || isPaused.get()) { return; } @@ -241,7 +313,9 @@ private BuildAgentInformation getUpdatedLocalBuildAgentInformation(BuildJobQueue List processingJobsOfMember = getProcessingJobsOfNode(memberAddress); int numberOfCurrentBuildJobs = processingJobsOfMember.size(); int maxNumberOfConcurrentBuilds = localCIBuildExecutorService.getMaximumPoolSize(); - boolean active = numberOfCurrentBuildJobs > 0; + boolean hasJobs = numberOfCurrentBuildJobs > 0; + BuildAgentInformation.BuildAgentStatus status = isPaused.get() ? BuildAgentInformation.BuildAgentStatus.PAUSED + : hasJobs ? BuildAgentInformation.BuildAgentStatus.ACTIVE : BuildAgentInformation.BuildAgentStatus.IDLE; BuildAgentInformation agent = buildAgentInformation.get(memberAddress); List recentBuildJobs; if (agent != null) { @@ -260,7 +334,7 @@ private BuildAgentInformation getUpdatedLocalBuildAgentInformation(BuildJobQueue String publicSshKey = buildAgentSSHKeyService.getPublicKeyAsString(); - return new BuildAgentInformation(memberAddress, maxNumberOfConcurrentBuilds, numberOfCurrentBuildJobs, processingJobsOfMember, active, recentBuildJobs, publicSshKey); + return new BuildAgentInformation(memberAddress, maxNumberOfConcurrentBuilds, numberOfCurrentBuildJobs, processingJobsOfMember, status, recentBuildJobs, publicSshKey); } private List getProcessingJobsOfNode(String memberAddress) { @@ -305,7 +379,12 @@ private void processBuild(BuildJobQueueItem buildJob) { buildLogsMap.removeBuildLogs(buildJob.id()); ResultQueueItem resultQueueItem = new ResultQueueItem(buildResult, finishedJob, buildLogs, null); - resultQueue.add(resultQueueItem); + if (processResults.get()) { + resultQueue.add(resultQueueItem); + } + else { + log.info("Build agent is paused. Not adding build result to result queue for build job: {}", buildJob); + } // after processing a build job, remove it from the processing jobs processingJobs.remove(buildJob.id()); @@ -342,7 +421,12 @@ private void processBuild(BuildJobQueueItem buildJob) { failedResult.setBuildLogEntries(buildLogs); ResultQueueItem resultQueueItem = new ResultQueueItem(failedResult, job, buildLogs, ex); - resultQueue.add(resultQueueItem); + if (processResults.get()) { + resultQueue.add(resultQueueItem); + } + else { + log.info("Build agent is paused. Not adding build result to result queue for build job: {}", buildJob); + } processingJobs.remove(buildJob.id()); localProcessingJobs.decrementAndGet(); @@ -353,6 +437,90 @@ private void processBuild(BuildJobQueueItem buildJob) { }); } + private void pauseBuildAgent() { + if (isPaused.get()) { + log.info("Build agent is already paused"); + return; + } + + pauseResumeLock.lock(); + try { + log.info("Pausing build agent with address {}", hazelcastInstance.getCluster().getLocalMember().getAddress().toString()); + + isPaused.set(true); + removeListenerAndCancelScheduledFuture(); + updateLocalBuildAgentInformation(); + + log.info("Gracefully cancelling running build jobs"); + + Set runningBuildJobIds = buildJobManagementService.getRunningBuildJobIds(); + if (runningBuildJobIds.isEmpty()) { + log.info("No running build jobs to cancel"); + } + else { + List> runningFuturesWrapper = runningBuildJobIds.stream().map(buildJobManagementService::getRunningBuildJobFutureWrapper) + .filter(Objects::nonNull).toList(); + + if (!runningFuturesWrapper.isEmpty()) { + CompletableFuture allFuturesWrapper = CompletableFuture.allOf(runningFuturesWrapper.toArray(new CompletableFuture[0])); + + try { + allFuturesWrapper.get(pauseGracePeriodSeconds, TimeUnit.SECONDS); + log.info("All running build jobs finished during grace period"); + } + catch (TimeoutException e) { + handleTimeoutAndCancelRunningJobs(); + } + catch (InterruptedException | ExecutionException e) { + log.error("Error while waiting for running build jobs to finish", e); + } + } + } + } + finally { + pauseResumeLock.unlock(); + } + } + + private void handleTimeoutAndCancelRunningJobs() { + if (!isPaused.get()) { + log.info("Build agent was resumed before the build jobs could be cancelled"); + return; + } + log.info("Grace period exceeded. Cancelling running build jobs."); + + processResults.set(false); + Set runningBuildJobIdsAfterGracePeriod = buildJobManagementService.getRunningBuildJobIds(); + List runningBuildJobsAfterGracePeriod = processingJobs.getAll(runningBuildJobIdsAfterGracePeriod).values().stream().toList(); + runningBuildJobIdsAfterGracePeriod.forEach(buildJobManagementService::cancelBuildJob); + queue.addAll(runningBuildJobsAfterGracePeriod); + log.info("Cancelled running build jobs and added them back to the queue with Ids {}", runningBuildJobIdsAfterGracePeriod); + log.debug("Cancelled running build jobs: {}", runningBuildJobsAfterGracePeriod); + } + + private void resumeBuildAgent() { + if (!isPaused.get()) { + log.info("Build agent is already running"); + return; + } + + pauseResumeLock.lock(); + try { + log.info("Resuming build agent with address {}", hazelcastInstance.getCluster().getLocalMember().getAddress().toString()); + isPaused.set(false); + processResults.set(true); + // We remove the listener and scheduledTask first to avoid having multiple listeners and scheduled tasks running + removeListenerAndCancelScheduledFuture(); + listenerId = queue.addItemListener(new QueuedBuildJobItemListener(), true); + scheduledFuture = taskScheduler.scheduleAtFixedRate(this::checkAvailabilityAndProcessNextBuild, Duration.ofSeconds(10)); + checkAvailabilityAndProcessNextBuild(); + updateLocalBuildAgentInformation(); + } + finally { + pauseResumeLock.unlock(); + } + } + /** * Checks whether the node has at least one thread available for a new build job. */ diff --git a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParser.java b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParser.java index 5e2672e4b426..50c3c5925f97 100644 --- a/src/main/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParser.java +++ b/src/main/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParser.java @@ -33,22 +33,8 @@ public static void processTestResultFile(String testResultFileString, List element - // And parse the inner test suites - TestSuites suites = mapper.readValue(testResultFileString, TestSuites.class); - if (suites.testsuites() == null) { - return; - } - - for (TestSuite suite : suites.testsuites()) { - processTestSuite(suite, failedTests, successfulTests); - } - } + // A toplevel element is parsed like a + processTestSuite(testSuite, failedTests, successfulTests); } private static void processTestSuite(TestSuite testSuite, List failedTests, List successfulTests) { @@ -64,17 +50,19 @@ private static void processTestSuite(TestSuite testSuite, List testsuites) { + for (TestSuite suite : testSuite.testSuites()) { + processTestSuite(suite, failedTests, successfulTests); + } } @JsonIgnoreProperties(ignoreUnknown = true) - record TestSuite(@JacksonXmlElementWrapper(useWrapping = false) @JacksonXmlProperty(localName = "testcase") List testCases) { + record TestSuite(@JacksonXmlElementWrapper(useWrapping = false) @JacksonXmlProperty(localName = "testcase") List testCases, + @JacksonXmlElementWrapper(useWrapping = false) @JacksonXmlProperty(localName = "testsuite") List testSuites) { TestSuite { testCases = Objects.requireNonNullElse(testCases, Collections.emptyList()); + testSuites = Objects.requireNonNullElse(testSuites, Collections.emptyList()); } } diff --git a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java index fddce3b9e6cd..fc6f7e9e1256 100644 --- a/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java +++ b/src/main/java/de/tum/cit/aet/artemis/communication/service/notifications/MailService.java @@ -8,6 +8,8 @@ import java.util.Locale; import java.util.Set; +import org.commonmark.parser.Parser; +import org.commonmark.renderer.html.HtmlRenderer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; @@ -261,6 +263,18 @@ public void sendNotification(Notification notification, User user, Object notifi // posts use a different mechanism for the url context.setVariable(NOTIFICATION_URL, extractNotificationUrl(post, artemisServerUrl.toString())); subject = createAnnouncementText(notificationSubject, locale); + + // Render markdown content of post to html + try { + Parser parser = Parser.builder().build(); + HtmlRenderer renderer = HtmlRenderer.builder().build(); + String postContent = post.getContent(); + String renderedPostContent = renderer.render(parser.parse(postContent)); + post.setContent(renderedPostContent); + } + catch (Exception e) { + // In case something goes wrong, leave content of post as-is + } } else { context.setVariable(NOTIFICATION_URL, extractNotificationUrl(notification, artemisServerUrl.toString())); diff --git a/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java b/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java index e39b8915c94f..e979c66b6183 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/config/PublicResourcesConfiguration.java @@ -54,12 +54,15 @@ public void addResourceHandlers(@NotNull ResourceHandlerRegistry registry) { // Add caching for course icons, user profile pictures, and drag and drop quiz pictures // Add resource handlers for dynamic image paths based on fileUploadPath // TODO: those paths have to be the same as in FilePathService, ideally we reuse the constants and define them only once - registry.addResourceHandler("/images/course/icons/**").addResourceLocations("file:" + fileUploadPath + "/images/course/icons/").setCacheControl(defaultCacheControl); + registry.addResourceHandler("/course/icons/**").addResourceLocations("file:" + fileUploadPath + "/images/course/icons/").setCacheControl(defaultCacheControl); - registry.addResourceHandler("/images/user/profile-pictures/**").addResourceLocations("file:" + fileUploadPath + "/images/user/profile-pictures/") + registry.addResourceHandler("/user/profile-pictures/**").addResourceLocations("file:" + fileUploadPath + "/images/user/profile-pictures/") .setCacheControl(defaultCacheControl); - registry.addResourceHandler("/images/drag-and-drop/**").addResourceLocations("file:" + fileUploadPath + "/images/drag-and-drop/").setCacheControl(defaultCacheControl); + registry.addResourceHandler("/drag-and-drop/**").addResourceLocations("file:" + fileUploadPath + "/images/drag-and-drop/").setCacheControl(defaultCacheControl); + + // e.g. public/videos/course-competencies/create-competencies.gif + addResourceHandlerForPath(registry, "videos", "course-competencies").setCacheControl(defaultCacheControl); } /** diff --git a/src/main/java/de/tum/cit/aet/artemis/core/repository/CourseRepository.java b/src/main/java/de/tum/cit/aet/artemis/core/repository/CourseRepository.java index fa3bba8a4b73..ad4c3ab139f5 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/repository/CourseRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/repository/CourseRepository.java @@ -322,6 +322,14 @@ GROUP BY SUBSTRING(CAST(s.submissionDate AS string), 1, 10), p.student.login """) List findAllNotEndedCoursesByManagementGroupNames(@Param("now") ZonedDateTime now, @Param("userGroups") List userGroups); + @Query(""" + SELECT COUNT(DISTINCT ug.userId) + FROM Course c + JOIN UserGroup ug ON c.studentGroupName = ug.group + WHERE c.id = :courseId + """) + int countCourseStudents(@Param("courseId") long courseId); + /** * Counts the number of members of a course, i.e. users that are a member of the course's student, tutor, editor or instructor group. * Users that are part of multiple groups are NOT counted multiple times. diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/TelemetrySendingService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/TelemetrySendingService.java deleted file mode 100644 index f3d50f64722c..000000000000 --- a/src/main/java/de/tum/cit/aet/artemis/core/service/TelemetrySendingService.java +++ /dev/null @@ -1,89 +0,0 @@ -package de.tum.cit.aet.artemis.core.service; - -import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_SCHEDULING; - -import java.util.Arrays; -import java.util.List; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.context.annotation.Profile; -import org.springframework.core.env.Environment; -import org.springframework.http.HttpEntity; -import org.springframework.http.HttpHeaders; -import org.springframework.http.MediaType; -import org.springframework.scheduling.annotation.Async; -import org.springframework.stereotype.Service; -import org.springframework.web.client.RestTemplate; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.ObjectWriter; - -@Service -@Profile(PROFILE_SCHEDULING) -public class TelemetrySendingService { - - private static final Logger log = LoggerFactory.getLogger(TelemetrySendingService.class); - - @JsonInclude(JsonInclude.Include.NON_EMPTY) - public record TelemetryData(String version, String serverUrl, String operator, String contact, List profiles, String adminName) { - } - - private final Environment env; - - private final RestTemplate restTemplate; - - public TelemetrySendingService(Environment env, RestTemplate restTemplate) { - this.env = env; - this.restTemplate = restTemplate; - } - - @Value("${artemis.version}") - private String version; - - @Value("${server.url}") - private String serverUrl; - - @Value("${info.operatorName}") - private String operator; - - @Value("${info.operatorAdminName}") - private String operatorAdminName; - - @Value("${info.contact}") - private String contact; - - @Value("${artemis.telemetry.sendAdminDetails}") - private boolean sendAdminDetails; - - @Value("${artemis.telemetry.destination}") - private String destination; - - /** - * Assembles the telemetry data, and sends it to the external telemetry server. - * - * @throws Exception if the writing the telemetry data to a json format fails, or the connection to the telemetry server fails - */ - @Async - public void sendTelemetryByPostRequest() throws Exception { - List activeProfiles = Arrays.asList(env.getActiveProfiles()); - TelemetryData telemetryData; - if (sendAdminDetails) { - telemetryData = new TelemetryData(version, serverUrl, operator, contact, activeProfiles, operatorAdminName); - } - else { - telemetryData = new TelemetryData(version, serverUrl, operator, null, activeProfiles, null); - } - - HttpHeaders headers = new HttpHeaders(); - headers.setContentType(MediaType.APPLICATION_JSON); - ObjectWriter objectWriter = new ObjectMapper().writer().withDefaultPrettyPrinter(); - - var telemetryJson = objectWriter.writeValueAsString(telemetryData); - HttpEntity requestEntity = new HttpEntity<>(telemetryJson, headers); - var response = restTemplate.postForEntity(destination + "/api/telemetry", requestEntity, String.class); - log.info("Successfully sent telemetry data. {}", response.getBody()); - } -} diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/telemetry/TelemetrySendingService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/telemetry/TelemetrySendingService.java new file mode 100644 index 000000000000..265b96192ad0 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/core/service/telemetry/TelemetrySendingService.java @@ -0,0 +1,128 @@ +package de.tum.cit.aet.artemis.core.service.telemetry; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_SCHEDULING; + +import java.util.Arrays; +import java.util.List; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Profile; +import org.springframework.core.env.Environment; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.scheduling.annotation.Async; +import org.springframework.stereotype.Service; +import org.springframework.web.client.RestTemplate; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; + +import de.tum.cit.aet.artemis.core.service.ProfileService; + +@Service +@Profile(PROFILE_SCHEDULING) +public class TelemetrySendingService { + + private static final Logger log = LoggerFactory.getLogger(TelemetrySendingService.class); + + @JsonInclude(JsonInclude.Include.NON_EMPTY) + public record TelemetryData(String version, String serverUrl, String operator, List profiles, boolean isProductionInstance, boolean isTestServer, String dataSource, + String contact, String adminName) { + } + + private final Environment env; + + private final RestTemplate restTemplate; + + private final ProfileService profileService; + + public TelemetrySendingService(Environment env, RestTemplate restTemplate, ProfileService profileService) { + this.env = env; + this.restTemplate = restTemplate; + this.profileService = profileService; + } + + @Value("${artemis.version}") + private String version; + + @Value("${server.url}") + private String serverUrl; + + @Value("${info.operatorName}") + private String operator; + + @Value("${info.operatorAdminName}") + private String operatorAdminName; + + @Value("${info.contact}") + private String operatorContact; + + @Value("${artemis.telemetry.destination}") + private String destination; + + @Value("${spring.datasource.url}") + private String datasourceUrl; + + @Value("${info.test-server:false}") + private boolean isTestServer; + + /** + * Sends telemetry data to a specified destination via an HTTP POST request asynchronously. + * The telemetry includes information about the application version, environment, data source, + * and optionally, administrator details. If Eureka is enabled, the number of registered + * instances is also included. + * + *

+ * The method constructs the telemetry data object, converts it to JSON, and sends it to a + * telemetry collection server. The request is sent asynchronously due to the {@code @Async} annotation. + * + * @param sendAdminDetails a flag indicating whether to include administrator details in the + * telemetry data (such as contact information and admin name). + */ + @Async + public void sendTelemetryByPostRequest(boolean sendAdminDetails) { + + try { + String telemetryJson = new ObjectMapper().writer().withDefaultPrettyPrinter().writeValueAsString(buildTelemetryData(sendAdminDetails)); + HttpHeaders headers = new HttpHeaders(); + headers.setContentType(MediaType.APPLICATION_JSON); + HttpEntity requestEntity = new HttpEntity<>(telemetryJson, headers); + + log.info("Sending telemetry to {}", destination); + var response = restTemplate.postForEntity(destination + "/api/telemetry", requestEntity, String.class); + log.info("Successfully sent telemetry data. {}", response.getBody()); + } + catch (JsonProcessingException e) { + log.warn("JsonProcessingException in sendTelemetry.", e); + } + catch (Exception e) { + log.warn("Exception in sendTelemetry, with dst URI: {}", destination, e); + } + } + + /** + * Retrieves telemetry data for the current system configuration, including details + * about the active profiles, data source type, and optionally admin contact details. + * + * @param sendAdminDetails whether to include admin contact information in the telemetry data + * @return an instance of {@link TelemetryData} containing the gathered telemetry information + */ + private TelemetryData buildTelemetryData(boolean sendAdminDetails) { + TelemetryData telemetryData; + var dataSource = datasourceUrl.startsWith("jdbc:mysql") ? "mysql" : "postgresql"; + List activeProfiles = Arrays.asList(env.getActiveProfiles()); + + String contact = null; + String adminName = null; + if (sendAdminDetails) { + contact = operatorContact; + adminName = operatorAdminName; + } + telemetryData = new TelemetryData(version, serverUrl, operator, activeProfiles, profileService.isProductionActive(), isTestServer, dataSource, contact, adminName); + return telemetryData; + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/TelemetryService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/telemetry/TelemetryService.java similarity index 54% rename from src/main/java/de/tum/cit/aet/artemis/core/service/TelemetryService.java rename to src/main/java/de/tum/cit/aet/artemis/core/service/telemetry/TelemetryService.java index 408e6c3dd514..d43f79aae256 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/service/TelemetryService.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/service/telemetry/TelemetryService.java @@ -1,4 +1,4 @@ -package de.tum.cit.aet.artemis.core.service; +package de.tum.cit.aet.artemis.core.service.telemetry; import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_SCHEDULING; @@ -10,7 +10,7 @@ import org.springframework.context.event.EventListener; import org.springframework.stereotype.Service; -import com.fasterxml.jackson.core.JsonProcessingException; +import de.tum.cit.aet.artemis.core.service.ProfileService; @Service @Profile(PROFILE_SCHEDULING) @@ -22,37 +22,30 @@ public class TelemetryService { private final TelemetrySendingService telemetrySendingService; - @Value("${artemis.telemetry.enabled}") - public boolean useTelemetry; + private final boolean useTelemetry; - @Value("${artemis.telemetry.destination}") - private String destination; + private final boolean sendAdminDetails; - public TelemetryService(ProfileService profileService, TelemetrySendingService telemetrySendingService) { + public TelemetryService(ProfileService profileService, TelemetrySendingService telemetrySendingService, @Value("${artemis.telemetry.enabled}") boolean useTelemetry, + @Value("${artemis.telemetry.sendAdminDetails}") boolean sendAdminDetails) { this.profileService = profileService; this.telemetrySendingService = telemetrySendingService; + this.useTelemetry = useTelemetry; + this.sendAdminDetails = sendAdminDetails; } /** - * Sends telemetry to the server specified in artemis.telemetry.destination. - * This function runs once, at the startup of the application. - * If telemetry is disabled in artemis.telemetry.enabled, no data is sent. + * Sends telemetry data to the server after the application is ready. + * This method is triggered automatically when the application context is fully initialized. + *

+ * If telemetry is disabled (as specified by the {@code useTelemetry} flag), the task will not be executed. */ @EventListener(ApplicationReadyEvent.class) public void sendTelemetry() { if (!useTelemetry || profileService.isDevActive()) { return; } - - log.info("Sending telemetry information"); - try { - telemetrySendingService.sendTelemetryByPostRequest(); - } - catch (JsonProcessingException e) { - log.warn("JsonProcessingException in sendTelemetry.", e); - } - catch (Exception e) { - log.warn("Exception in sendTelemetry, with dst URI: {}", destination, e); - } + log.info("Start sending telemetry data asynchronously"); + telemetrySendingService.sendTelemetryByPostRequest(sendAdminDetails); } } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminBuildJobQueueResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminBuildJobQueueResource.java index db71ab34c05a..33e7bd099155 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminBuildJobQueueResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminBuildJobQueueResource.java @@ -15,6 +15,7 @@ import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PutMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @@ -188,4 +189,44 @@ public ResponseEntity getBuildJobStatistics(@RequestPara BuildJobsStatisticsDTO buildJobStatistics = BuildJobsStatisticsDTO.of(buildJobResultCountDtos); return ResponseEntity.ok(buildJobStatistics); } + + /** + * {@code PUT /api/admin/agent/{agentName}/pause} : Pause the specified build agent. + * This endpoint allows administrators to pause a specific build agent by its name. + * Pausing a build agent will prevent it from picking up any new build jobs until it is resumed. + * + *

+ * Authorization: This operation requires admin privileges, enforced by {@code @EnforceAdmin}. + *

+ * + * @param agentName the name of the build agent to be paused (provided as a path variable) + * @return {@link ResponseEntity} with status code 204 (No Content) if the agent was successfully paused + * or an appropriate error response if something went wrong + */ + @PutMapping("agent/{agentName}/pause") + public ResponseEntity pauseBuildAgent(@PathVariable String agentName) { + log.debug("REST request to pause agent {}", agentName); + localCIBuildJobQueueService.pauseBuildAgent(agentName); + return ResponseEntity.noContent().build(); + } + + /** + * {@code PUT /api/admin/agent/{agentName}/resume} : Resume the specified build agent. + * This endpoint allows administrators to resume a specific build agent by its name. + * Resuming a build agent will allow it to pick up new build jobs again. + * + *

+ * Authorization: This operation requires admin privileges, enforced by {@code @EnforceAdmin}. + *

+ * + * @param agentName the name of the build agent to be resumed (provided as a path variable) + * @return {@link ResponseEntity} with status code 204 (No Content) if the agent was successfully resumed + * or an appropriate error response if something went wrong + */ + @PutMapping("agent/{agentName}/resume") + public ResponseEntity resumeBuildAgent(@PathVariable String agentName) { + log.debug("REST request to resume agent {}", agentName); + localCIBuildJobQueueService.resumeBuildAgent(agentName); + return ResponseEntity.noContent().build(); + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/exercise/web/ParticipationTeamWebsocketService.java b/src/main/java/de/tum/cit/aet/artemis/exercise/web/ParticipationTeamWebsocketService.java index ccf10fb60273..ad7d9b0fa16a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/exercise/web/ParticipationTeamWebsocketService.java +++ b/src/main/java/de/tum/cit/aet/artemis/exercise/web/ParticipationTeamWebsocketService.java @@ -10,11 +10,10 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; -import jakarta.annotation.PostConstruct; - import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.context.event.ApplicationReadyEvent; import org.springframework.context.annotation.Profile; import org.springframework.context.event.EventListener; import org.springframework.messaging.handler.annotation.DestinationVariable; @@ -31,6 +30,7 @@ import org.springframework.web.socket.messaging.SessionUnsubscribeEvent; import com.hazelcast.core.HazelcastInstance; +import com.hazelcast.core.HazelcastInstanceNotActiveException; import de.tum.cit.aet.artemis.communication.service.WebsocketMessagingService; import de.tum.cit.aet.artemis.core.domain.User; @@ -96,7 +96,7 @@ public ParticipationTeamWebsocketService(WebsocketMessagingService websocketMess /** * Initialize relevant data from hazelcast */ - @PostConstruct + @EventListener(ApplicationReadyEvent.class) public void init() { // participationId-username -> timestamp this.lastTypingTracker = hazelcastInstance.getMap("lastTypingTracker"); @@ -307,11 +307,19 @@ public void handleDisconnect(SessionDisconnectEvent event) { * @param sessionId id of the sessions which is unsubscribing */ public void unsubscribe(String sessionId) { - Optional.ofNullable(destinationTracker.get(sessionId)).ifPresent(destination -> { - Long participationId = getParticipationIdFromDestination(destination); - sendOnlineTeamStudents(participationId, sessionId); - destinationTracker.remove(sessionId); - }); + // check if Hazelcast is still active, before invoking this + try { + if (hazelcastInstance != null && hazelcastInstance.getLifecycleService().isRunning()) { + Optional.ofNullable(destinationTracker.get(sessionId)).ifPresent(destination -> { + destinationTracker.remove(sessionId); + Long participationId = getParticipationIdFromDestination(destination); + sendOnlineTeamStudents(participationId, sessionId); + }); + } + } + catch (HazelcastInstanceNotActiveException e) { + log.error("Failed to unsubscribe as Hazelcast is no longer active"); + } } /** diff --git a/src/main/java/de/tum/cit/aet/artemis/lecture/web/LectureResource.java b/src/main/java/de/tum/cit/aet/artemis/lecture/web/LectureResource.java index 54ae76bf3bad..6ea319ae365a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/lecture/web/LectureResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/lecture/web/LectureResource.java @@ -1,6 +1,7 @@ package de.tum.cit.aet.artemis.lecture.web; import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_IRIS; import java.net.URI; import java.net.URISyntaxException; @@ -40,6 +41,7 @@ import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastEditor; import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastInstructor; import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastStudent; +import de.tum.cit.aet.artemis.core.security.annotations.enforceRoleInCourse.EnforceAtLeastInstructorInCourse; import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService; import de.tum.cit.aet.artemis.core.util.HeaderUtil; import de.tum.cit.aet.artemis.exercise.domain.Exercise; @@ -261,13 +263,15 @@ public ResponseEntity importLecture(@PathVariable long sourceLectureId, /** * POST /courses/{courseId}/ingest - * This endpooint is for starting the ingestion of all lectures or only one lecture when triggered in Artemis. + * This endpoint is for starting the ingestion of all lectures or only one lecture when triggered in Artemis. * * @param courseId the ID of the course for which all lectures should be ingested in pyris * @param lectureId If this id is present then only ingest this one lecture of the respective course * @return the ResponseEntity with status 200 (OK) and a message success or null if the operation failed */ + @Profile(PROFILE_IRIS) @PostMapping("courses/{courseId}/ingest") + @EnforceAtLeastInstructorInCourse public ResponseEntity ingestLectures(@PathVariable Long courseId, @RequestParam(required = false) Optional lectureId) { log.debug("REST request to ingest lectures of course : {}", courseId); Course course = courseRepository.findByIdWithLecturesAndLectureUnitsElseThrow(courseId); diff --git a/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/ProgrammingPlagiarismDetectionService.java b/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/ProgrammingPlagiarismDetectionService.java index ea6ebfdf3b81..30e568ac85a5 100644 --- a/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/ProgrammingPlagiarismDetectionService.java +++ b/src/main/java/de/tum/cit/aet/artemis/plagiarism/service/ProgrammingPlagiarismDetectionService.java @@ -30,6 +30,7 @@ import de.jplag.Language; import de.jplag.c.CLanguage; import de.jplag.clustering.ClusteringOptions; +import de.jplag.cpp.CPPLanguage; import de.jplag.exceptions.ExitException; import de.jplag.java.JavaLanguage; import de.jplag.javascript.JavaScriptLanguage; @@ -312,6 +313,7 @@ public void deleteTempLocalRepository(Repository repository) { private Language getJPlagProgrammingLanguage(ProgrammingExercise programmingExercise) { return switch (programmingExercise.getProgrammingLanguage()) { case C -> new CLanguage(); + case C_PLUS_PLUS -> new CPPLanguage(); case JAVA -> new JavaLanguage(); case JAVASCRIPT -> new JavaScriptLanguage(); case KOTLIN -> new KotlinLanguage(); @@ -319,9 +321,8 @@ private Language getJPlagProgrammingLanguage(ProgrammingExercise programmingExer case R -> new RLanguage(); case RUST -> new RustLanguage(); case SWIFT -> new SwiftLanguage(); - case EMPTY, PHP, DART, HASKELL, ASSEMBLER, OCAML, C_SHARP, C_PLUS_PLUS, SQL, TYPESCRIPT, GO, MATLAB, BASH, VHDL, RUBY, POWERSHELL, ADA -> - throw new BadRequestAlertException("Programming language " + programmingExercise.getProgrammingLanguage() + " not supported for plagiarism check.", - "ProgrammingExercise", "notSupported"); + case EMPTY, PHP, DART, HASKELL, ASSEMBLER, OCAML, C_SHARP, SQL, TYPESCRIPT, GO, MATLAB, BASH, VHDL, RUBY, POWERSHELL, ADA -> throw new BadRequestAlertException( + "Programming language " + programmingExercise.getProgrammingLanguage() + " not supported for plagiarism check.", "ProgrammingExercise", "notSupported"); }; } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java b/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java index 239ef3674d44..4f00e1bb117f 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/domain/AuthenticationMechanism.java @@ -21,4 +21,8 @@ public enum AuthenticationMechanism { * The user used the artemis client code editor to authenticate to the LocalVC */ CODE_EDITOR, + /** + * The user attempted to authenticate to the LocalVC using either a user token or a participation token + */ + VCS_ACCESS_TOKEN, } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingLanguage.java b/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingLanguage.java index 781ad04f98c6..0fdc216122b9 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingLanguage.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/domain/ProgrammingLanguage.java @@ -40,6 +40,7 @@ public enum ProgrammingLanguage { private static final Set ENABLED_LANGUAGES = Set.of( ASSEMBLER, C, + C_PLUS_PLUS, HASKELL, JAVA, JAVASCRIPT, diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/domain/VcsAccessLog.java b/src/main/java/de/tum/cit/aet/artemis/programming/domain/VcsAccessLog.java index 560ca52a31c1..9d5155d63f14 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/domain/VcsAccessLog.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/domain/VcsAccessLog.java @@ -77,6 +77,10 @@ public void setCommitHash(String commitHash) { this.commitHash = commitHash; } + public void setRepositoryActionType(RepositoryActionType repositoryActionType) { + this.repositoryActionType = repositoryActionType; + } + public User getUser() { return user; } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseStudentParticipationRepository.java b/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseStudentParticipationRepository.java index 3739ed8dff71..cc1f57c533fa 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseStudentParticipationRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/repository/ProgrammingExerciseStudentParticipationRepository.java @@ -82,6 +82,12 @@ default ProgrammingExerciseStudentParticipation findByExerciseIdAndStudentLoginO return getValueElseThrow(findByExerciseIdAndStudentLogin(exerciseId, username)); } + Optional findByRepositoryUri(String repositoryUri); + + default ProgrammingExerciseStudentParticipation findByRepositoryUriElseThrow(String repositoryUri) { + return getValueElseThrow(findByRepositoryUri(repositoryUri)); + } + @EntityGraph(type = LOAD, attributePaths = { "submissions" }) Optional findWithSubmissionsByExerciseIdAndStudentLogin(long exerciseId, String username); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/repository/SolutionProgrammingExerciseParticipationRepository.java b/src/main/java/de/tum/cit/aet/artemis/programming/repository/SolutionProgrammingExerciseParticipationRepository.java index 2949576a13cb..4297b39f9ea9 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/repository/SolutionProgrammingExerciseParticipationRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/repository/SolutionProgrammingExerciseParticipationRepository.java @@ -43,6 +43,12 @@ public interface SolutionProgrammingExerciseParticipationRepository """) Optional findByBuildPlanIdWithResults(@Param("buildPlanId") String buildPlanId); + Optional findByRepositoryUri(String repositoryUri); + + default SolutionProgrammingExerciseParticipation findByRepositoryUriElseThrow(String repositoryUri) { + return getValueElseThrow(findByRepositoryUri(repositoryUri)); + } + @EntityGraph(type = LOAD, attributePaths = { "results", "submissions", "submissions.results" }) Optional findWithEagerResultsAndSubmissionsByProgrammingExerciseId(long exerciseId); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/repository/TemplateProgrammingExerciseParticipationRepository.java b/src/main/java/de/tum/cit/aet/artemis/programming/repository/TemplateProgrammingExerciseParticipationRepository.java index bc609dcd06fa..67795b58ae54 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/repository/TemplateProgrammingExerciseParticipationRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/repository/TemplateProgrammingExerciseParticipationRepository.java @@ -48,6 +48,12 @@ default TemplateProgrammingExerciseParticipation findWithEagerResultsAndSubmissi return getValueElseThrow(findWithEagerResultsAndSubmissionsByProgrammingExerciseId(exerciseId)); } + Optional findByRepositoryUri(String repositoryUri); + + default TemplateProgrammingExerciseParticipation findByRepositoryUriElseThrow(String repositoryUri) { + return getValueElseThrow(findByRepositoryUri(repositoryUri)); + } + @EntityGraph(type = LOAD, attributePaths = { "results", "results.feedbacks", "results.feedbacks.testCase", "submissions" }) Optional findWithEagerResultsAndFeedbacksAndTestCasesAndSubmissionsByProgrammingExerciseId(long exerciseId); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/repository/VcsAccessLogRepository.java b/src/main/java/de/tum/cit/aet/artemis/programming/repository/VcsAccessLogRepository.java index af342179e111..628019f34eaa 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/repository/VcsAccessLogRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/repository/VcsAccessLogRepository.java @@ -33,14 +33,14 @@ public interface VcsAccessLogRepository extends ArtemisJpaRepository findNewestByParticipationIdWhereCommitHashIsNull(@Param("participationId") long participationId); + FROM VcsAccessLog vcsAccessLog + WHERE vcsAccessLog.participation.id = :participationId + ORDER BY vcsAccessLog.timestamp DESC + LIMIT 1 + """) + Optional findNewestByParticipationId(@Param("participationId") long participationId); /** * Retrieves a list of {@link VcsAccessLog} entities associated with the specified participation ID. @@ -62,7 +62,6 @@ public interface VcsAccessLogRepository extends ArtemisJpaRepository getCommitInfos(ProgrammingExerciseParticipation parti } } + /** + * Get the commits information for the given auxiliary repository. + * + * @param auxiliaryRepository the auxiliary repository for which to get the commits. + * @return a list of CommitInfo DTOs containing author, timestamp, commit-hash and commit message. + */ + public List getAuxiliaryRepositoryCommitInfos(AuxiliaryRepository auxiliaryRepository) { + try { + return gitService.getCommitInfos(auxiliaryRepository.getVcsRepositoryUri()); + } + catch (GitAPIException e) { + log.error("Could not get commit infos for auxiliaryRepository {} with repository uri {}", auxiliaryRepository.getId(), auxiliaryRepository.getVcsRepositoryUri()); + return List.of(); + } + } + /** * Get the commits information for the test repository of the given participation's exercise. * diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java index 0cbf73da21ff..d4e7de493f52 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseService.java @@ -1048,4 +1048,15 @@ public ProgrammingExercise loadProgrammingExercise(long exerciseId, boolean with programmingExerciseTaskService.replaceTestIdsWithNames(programmingExercise); return programmingExercise; } + + /** + * Load a programming exercise, only with eager auxiliary repositories + * + * @param exerciseId the ID of the programming exercise to load + * @return the loaded programming exercise entity + */ + public ProgrammingExercise loadProgrammingExerciseWithAuxiliaryRepositories(long exerciseId) { + final Set fetchOptions = Set.of(AuxiliaryRepositories); + return programmingExerciseRepository.findByIdWithDynamicFetchElseThrow(exerciseId, fetchOptions); + } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/TemplateUpgradePolicyService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/TemplateUpgradePolicyService.java index 4c73046b1ab0..cc018ae1eb61 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/TemplateUpgradePolicyService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/TemplateUpgradePolicyService.java @@ -32,8 +32,8 @@ public TemplateUpgradePolicyService(JavaTemplateUpgradeService javaRepositoryUpg public TemplateUpgradeService getUpgradeService(ProgrammingLanguage programmingLanguage) { return switch (programmingLanguage) { case JAVA -> javaRepositoryUpgradeService; - case KOTLIN, PYTHON, C, HASKELL, VHDL, ASSEMBLER, SWIFT, OCAML, EMPTY, RUST, JAVASCRIPT, R -> defaultRepositoryUpgradeService; - case C_SHARP, C_PLUS_PLUS, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> + case KOTLIN, PYTHON, C, HASKELL, VHDL, ASSEMBLER, SWIFT, OCAML, EMPTY, RUST, JAVASCRIPT, R, C_PLUS_PLUS -> defaultRepositoryUpgradeService; + case C_SHARP, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> throw new UnsupportedOperationException("Unsupported programming language: " + programmingLanguage); }; } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/ci/ContinuousIntegrationService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/ci/ContinuousIntegrationService.java index b9050501c67a..f2f53467d261 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/ci/ContinuousIntegrationService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/ci/ContinuousIntegrationService.java @@ -219,8 +219,8 @@ enum RepositoryCheckoutPath implements CustomizableCheckoutPath { @Override public String forProgrammingLanguage(ProgrammingLanguage language) { return switch (language) { - case JAVA, PYTHON, C, HASKELL, KOTLIN, VHDL, ASSEMBLER, SWIFT, OCAML, EMPTY, RUST, JAVASCRIPT, R -> "assignment"; - case C_SHARP, C_PLUS_PLUS, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> + case JAVA, PYTHON, C, HASKELL, KOTLIN, VHDL, ASSEMBLER, SWIFT, OCAML, EMPTY, RUST, JAVASCRIPT, R, C_PLUS_PLUS -> "assignment"; + case C_SHARP, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> throw new UnsupportedOperationException("Unsupported programming language: " + language); }; } @@ -230,9 +230,9 @@ public String forProgrammingLanguage(ProgrammingLanguage language) { @Override public String forProgrammingLanguage(ProgrammingLanguage language) { return switch (language) { - case JAVA, PYTHON, HASKELL, KOTLIN, SWIFT, EMPTY, RUST, JAVASCRIPT, R -> ""; + case JAVA, PYTHON, HASKELL, KOTLIN, SWIFT, EMPTY, RUST, JAVASCRIPT, R, C_PLUS_PLUS -> ""; case C, VHDL, ASSEMBLER, OCAML -> "tests"; - case C_SHARP, C_PLUS_PLUS, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> + case C_SHARP, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> throw new UnsupportedOperationException("Unsupported programming language: " + language); }; } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/JenkinsProgrammingLanguageFeatureService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/JenkinsProgrammingLanguageFeatureService.java index 45a473da9148..8b948e8f0073 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/JenkinsProgrammingLanguageFeatureService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/JenkinsProgrammingLanguageFeatureService.java @@ -1,6 +1,7 @@ package de.tum.cit.aet.artemis.programming.service.jenkins; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.C; +import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.C_PLUS_PLUS; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.EMPTY; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.HASKELL; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.JAVA; @@ -35,6 +36,7 @@ public JenkinsProgrammingLanguageFeatureService() { // Must be extended once a new programming language is added programmingLanguageFeatures.put(EMPTY, new ProgrammingLanguageFeature(EMPTY, false, false, false, false, false, List.of(), false, false)); programmingLanguageFeatures.put(C, new ProgrammingLanguageFeature(C, false, false, true, false, false, List.of(FACT, GCC), false, false)); + programmingLanguageFeatures.put(C_PLUS_PLUS, new ProgrammingLanguageFeature(C_PLUS_PLUS, false, false, true, false, false, List.of(), false, false)); programmingLanguageFeatures.put(HASKELL, new ProgrammingLanguageFeature(HASKELL, false, false, false, false, true, List.of(), false, false)); programmingLanguageFeatures.put(JAVA, new ProgrammingLanguageFeature(JAVA, true, true, true, true, false, List.of(PLAIN_GRADLE, GRADLE_GRADLE, PLAIN_MAVEN, MAVEN_MAVEN, MAVEN_BLACKBOX), true, false)); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/build_plan/JenkinsBuildPlanService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/build_plan/JenkinsBuildPlanService.java index f900cc0f6dd1..dc4ff7a8178a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/build_plan/JenkinsBuildPlanService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/jenkins/build_plan/JenkinsBuildPlanService.java @@ -184,8 +184,8 @@ private JenkinsXmlConfigBuilder builderFor(ProgrammingLanguage programmingLangua throw new UnsupportedOperationException("Xcode templates are not available for Jenkins."); } return switch (programmingLanguage) { - case JAVA, KOTLIN, PYTHON, C, HASKELL, SWIFT, EMPTY, RUST, JAVASCRIPT, R -> jenkinsBuildPlanCreator; - case VHDL, ASSEMBLER, OCAML, C_SHARP, C_PLUS_PLUS, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> + case JAVA, KOTLIN, PYTHON, C, HASKELL, SWIFT, EMPTY, RUST, JAVASCRIPT, R, C_PLUS_PLUS -> jenkinsBuildPlanCreator; + case VHDL, ASSEMBLER, OCAML, C_SHARP, SQL, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP -> throw new UnsupportedOperationException(programmingLanguage + " templates are not available for Jenkins."); }; } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIProgrammingLanguageFeatureService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIProgrammingLanguageFeatureService.java index bc8292d407bb..704755528d3c 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIProgrammingLanguageFeatureService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIProgrammingLanguageFeatureService.java @@ -3,6 +3,7 @@ import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_LOCALCI; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.ASSEMBLER; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.C; +import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.C_PLUS_PLUS; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.EMPTY; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.HASKELL; import static de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage.JAVA; @@ -42,6 +43,7 @@ public LocalCIProgrammingLanguageFeatureService() { programmingLanguageFeatures.put(EMPTY, new ProgrammingLanguageFeature(EMPTY, false, false, false, false, false, List.of(), false, true)); programmingLanguageFeatures.put(ASSEMBLER, new ProgrammingLanguageFeature(ASSEMBLER, false, false, false, false, false, List.of(), false, true)); programmingLanguageFeatures.put(C, new ProgrammingLanguageFeature(C, false, true, true, false, false, List.of(FACT, GCC), false, true)); + programmingLanguageFeatures.put(C_PLUS_PLUS, new ProgrammingLanguageFeature(C_PLUS_PLUS, false, false, true, false, false, List.of(), false, true)); programmingLanguageFeatures.put(HASKELL, new ProgrammingLanguageFeature(HASKELL, true, false, false, false, true, List.of(), false, true)); programmingLanguageFeatures.put(JAVA, new ProgrammingLanguageFeature(JAVA, true, true, true, true, false, List.of(PLAIN_GRADLE, GRADLE_GRADLE, PLAIN_MAVEN, MAVEN_MAVEN), false, true)); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIResultProcessingService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIResultProcessingService.java index 4507f1a4e76d..a450fc545886 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIResultProcessingService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/LocalCIResultProcessingService.java @@ -7,19 +7,21 @@ import java.util.UUID; import java.util.concurrent.CancellationException; -import jakarta.annotation.PostConstruct; import jakarta.annotation.PreDestroy; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.context.event.ApplicationReadyEvent; import org.springframework.context.annotation.Profile; +import org.springframework.context.event.EventListener; import org.springframework.stereotype.Service; import com.hazelcast.collection.IQueue; import com.hazelcast.collection.ItemEvent; import com.hazelcast.collection.ItemListener; import com.hazelcast.core.HazelcastInstance; +import com.hazelcast.core.HazelcastInstanceNotActiveException; import com.hazelcast.map.IMap; import de.tum.cit.aet.artemis.assessment.domain.Result; @@ -90,16 +92,28 @@ public LocalCIResultProcessingService(@Qualifier("hazelcastInstance") HazelcastI /** * Initializes the result queue, build agent information map and the locks. */ - @PostConstruct + @EventListener(ApplicationReadyEvent.class) public void init() { this.resultQueue = this.hazelcastInstance.getQueue("buildResultQueue"); this.buildAgentInformation = this.hazelcastInstance.getMap("buildAgentInformation"); this.listenerId = resultQueue.addItemListener(new ResultQueueListener(), true); } + /** + * Removes the item listener from the Hazelcast result queue if the instance is active. + * Logs an error if Hazelcast is not running. + */ @PreDestroy public void removeListener() { - this.resultQueue.removeItemListener(this.listenerId); + // check if Hazelcast is still active, before invoking this + try { + if (hazelcastInstance != null && hazelcastInstance.getLifecycleService().isRunning()) { + this.resultQueue.removeItemListener(this.listenerId); + } + } + catch (HazelcastInstanceNotActiveException e) { + log.error("Could not remove listener as hazelcast instance is not active."); + } } /** diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java index a99766da005b..9af5fe3b45c1 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localci/SharedQueueManagementService.java @@ -67,6 +67,10 @@ public class SharedQueueManagementService { private ITopic canceledBuildJobsTopic; + private ITopic pauseBuildAgentTopic; + + private ITopic resumeBuildAgentTopic; + public SharedQueueManagementService(BuildJobRepository buildJobRepository, @Qualifier("hazelcastInstance") HazelcastInstance hazelcastInstance, ProfileService profileService) { this.buildJobRepository = buildJobRepository; this.hazelcastInstance = hazelcastInstance; @@ -83,6 +87,8 @@ public void init() { this.queue = this.hazelcastInstance.getQueue("buildJobQueue"); this.canceledBuildJobsTopic = hazelcastInstance.getTopic("canceledBuildJobsTopic"); this.dockerImageCleanupInfo = this.hazelcastInstance.getMap("dockerImageCleanupInfo"); + this.pauseBuildAgentTopic = hazelcastInstance.getTopic("pauseBuildAgentTopic"); + this.resumeBuildAgentTopic = hazelcastInstance.getTopic("resumeBuildAgentTopic"); } /** @@ -135,6 +141,14 @@ public List getBuildAgentInformationWithoutRecentBuildJob agent.numberOfCurrentBuildJobs(), agent.runningBuildJobs(), agent.status(), null, null)).toList(); } + public void pauseBuildAgent(String agent) { + pauseBuildAgentTopic.publish(agent); + } + + public void resumeBuildAgent(String agent) { + resumeBuildAgentTopic.publish(agent); + } + /** * Cancel a build job by removing it from the queue or stopping the build process. * diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ArtemisGitServletService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ArtemisGitServletService.java index b64406840602..0bfbbbe700e0 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ArtemisGitServletService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ArtemisGitServletService.java @@ -6,6 +6,7 @@ import org.eclipse.jgit.http.server.GitServlet; import org.eclipse.jgit.transport.ReceivePack; +import org.eclipse.jgit.transport.UploadPack; import org.springframework.context.annotation.Profile; import org.springframework.stereotype.Service; @@ -31,6 +32,13 @@ public ArtemisGitServletService(LocalVCServletService localVCServletService) { /** * Initialize the ArtemisGitServlet by setting the repository resolver and adding filters for fetch and push requests. + * Sets the pre/post receive/upload hooks. + *

+ * For general information on the different hooks and git packs see the git documentation: + *

+ * https://git-scm.com/docs/git-receive-pack + *

+ * https://git-scm.com/docs/git-upload-pack */ @PostConstruct @Override @@ -55,5 +63,13 @@ public void init() { receivePack.setPostReceiveHook(new LocalVCPostPushHook(localVCServletService)); return receivePack; }); + + this.setUploadPackFactory((request, repository) -> { + UploadPack uploadPack = new UploadPack(repository); + + // Add the custom pre-upload hook, to distinguish between clone and pull operations + uploadPack.setPreUploadHook(new LocalVCFetchPreUploadHook(localVCServletService, request)); + return uploadPack; + }); } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchFilter.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchFilter.java index 504355f1cdf2..e789bf4c5e78 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchFilter.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchFilter.java @@ -10,6 +10,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.security.core.AuthenticationException; import org.springframework.web.filter.OncePerRequestFilter; import de.tum.cit.aet.artemis.core.exception.localvc.LocalVCAuthException; @@ -44,6 +45,11 @@ public void doFilterInternal(HttpServletRequest servletRequest, HttpServletRespo servletResponse.setStatus(localVCServletService.getHttpStatusForException(e, servletRequest.getRequestURI())); return; } + catch (AuthenticationException e) { + // intercept failed authentication to log it in the VCS access log + localVCServletService.createVCSAccessLogForFailedAuthenticationAttempt(servletRequest); + throw e; + } filterChain.doFilter(servletRequest, servletResponse); } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchPreUploadHook.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchPreUploadHook.java new file mode 100644 index 000000000000..97e7523991d7 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchPreUploadHook.java @@ -0,0 +1,34 @@ +package de.tum.cit.aet.artemis.programming.service.localvc; + +import java.util.Collection; + +import jakarta.servlet.http.HttpServletRequest; + +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.transport.PreUploadHook; +import org.eclipse.jgit.transport.UploadPack; + +public class LocalVCFetchPreUploadHook implements PreUploadHook { + + private final LocalVCServletService localVCServletService; + + private final HttpServletRequest request; + + public LocalVCFetchPreUploadHook(LocalVCServletService localVCServletService, HttpServletRequest request) { + this.localVCServletService = localVCServletService; + this.request = request; + } + + @Override + public void onBeginNegotiateRound(UploadPack uploadPack, Collection collection, int clientOffered) { + localVCServletService.updateVCSAccessLogForCloneAndPullHTTPS(request, clientOffered); + } + + @Override + public void onEndNegotiateRound(UploadPack uploadPack, Collection collection, int i, int i1, boolean b) { + } + + @Override + public void onSendPack(UploadPack uploadPack, Collection collection, Collection collection1) { + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchPreUploadHookSSH.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchPreUploadHookSSH.java new file mode 100644 index 000000000000..09f79348c180 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCFetchPreUploadHookSSH.java @@ -0,0 +1,37 @@ +package de.tum.cit.aet.artemis.programming.service.localvc; + +import java.nio.file.Path; +import java.util.Collection; + +import org.apache.sshd.server.session.ServerSession; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.transport.PreUploadHook; +import org.eclipse.jgit.transport.UploadPack; + +public class LocalVCFetchPreUploadHookSSH implements PreUploadHook { + + private final LocalVCServletService localVCServletService; + + private final ServerSession serverSession; + + private final Path rootDir; + + public LocalVCFetchPreUploadHookSSH(LocalVCServletService localVCServletService, ServerSession serverSession, Path rootDir) { + this.localVCServletService = localVCServletService; + this.serverSession = serverSession; + this.rootDir = rootDir; + } + + @Override + public void onBeginNegotiateRound(UploadPack uploadPack, Collection collection, int clientOffered) { + localVCServletService.updateVCSAccessLogForCloneAndPullSSH(serverSession, rootDir, clientOffered); + } + + @Override + public void onEndNegotiateRound(UploadPack uploadPack, Collection collection, int i, int i1, boolean b) { + } + + @Override + public void onSendPack(UploadPack uploadPack, Collection collection, Collection collection1) { + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCPushFilter.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCPushFilter.java index 3d178b998cdd..914205081e60 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCPushFilter.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCPushFilter.java @@ -47,6 +47,7 @@ public void doFilterInternal(HttpServletRequest servletRequest, HttpServletRespo servletResponse.setStatus(localVCServletService.getHttpStatusForException(e, servletRequest.getRequestURI())); return; } + this.localVCServletService.updateVCSAccessLogForPushHTTPS(servletRequest); filterChain.doFilter(servletRequest, servletResponse); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCServletService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCServletService.java index 470b7f815322..f4bcf1ea2e89 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCServletService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/LocalVCServletService.java @@ -16,10 +16,12 @@ import java.util.Map; import java.util.Objects; import java.util.Optional; +import java.util.concurrent.CompletableFuture; import jakarta.servlet.http.HttpServletRequest; import org.apache.commons.lang3.StringUtils; +import org.apache.sshd.server.session.ServerSession; import org.eclipse.jgit.api.Git; import org.eclipse.jgit.api.errors.GitAPIException; import org.eclipse.jgit.errors.RepositoryNotFoundException; @@ -32,6 +34,7 @@ import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Profile; import org.springframework.http.HttpStatus; +import org.springframework.scheduling.annotation.Async; import org.springframework.security.authentication.AuthenticationManager; import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; import org.springframework.security.core.AuthenticationException; @@ -66,6 +69,7 @@ import de.tum.cit.aet.artemis.programming.service.ProgrammingTriggerService; import de.tum.cit.aet.artemis.programming.service.RepositoryAccessService; import de.tum.cit.aet.artemis.programming.service.ci.ContinuousIntegrationTriggerService; +import de.tum.cit.aet.artemis.programming.service.localvc.ssh.SshConstants; import de.tum.cit.aet.artemis.programming.web.repository.RepositoryActionType; /** @@ -127,6 +131,8 @@ public void setLocalVCBaseUrl(URL localVCBaseUrl) { */ public static final String AUTHORIZATION_HEADER = "Authorization"; + public static final String BUILD_USER_NAME = "buildjob_user"; + // Cache the retrieved repositories for quicker access. // The resolveRepository method is called multiple times per request. // Key: repositoryPath --> Value: Repository @@ -207,7 +213,8 @@ public Repository resolveRepository(String repositoryPath) throws RepositoryNotF * @throws LocalVCForbiddenException If the user is not allowed to access the repository, e.g. because offline IDE usage is not allowed or the due date has passed. * @throws LocalVCInternalException If an internal error occurs, e.g. because the LocalVCRepositoryUri could not be created. */ - public void authenticateAndAuthorizeGitRequest(HttpServletRequest request, RepositoryActionType repositoryAction) throws LocalVCAuthException, LocalVCForbiddenException { + public void authenticateAndAuthorizeGitRequest(HttpServletRequest request, RepositoryActionType repositoryAction) + throws LocalVCAuthException, LocalVCForbiddenException, AuthenticationException { long timeNanoStart = System.nanoTime(); @@ -274,7 +281,8 @@ private AuthenticationMechanism resolveAuthenticationMechanism(String authorizat return AuthenticationMechanism.PARTICIPATION_VCS_ACCESS_TOKEN; } - private User authenticateUser(String authorizationHeader, ProgrammingExercise exercise, LocalVCRepositoryUri localVCRepositoryUri) throws LocalVCAuthException { + private User authenticateUser(String authorizationHeader, ProgrammingExercise exercise, LocalVCRepositoryUri localVCRepositoryUri) + throws LocalVCAuthException, AuthenticationException { UsernameAndPassword usernameAndPassword = extractUsernameAndPassword(authorizationHeader); @@ -428,8 +436,7 @@ public void authorizeUser(String repositoryTypeOrUserName, User user, Programmin ProgrammingExerciseParticipation participation; try { - participation = programmingExerciseParticipationService.getParticipationForRepository(exercise, repositoryTypeOrUserName, localVCRepositoryUri.isPracticeRepository(), - false); + participation = programmingExerciseParticipationService.retrieveParticipationForRepository(repositoryTypeOrUserName, localVCRepositoryUri.toString()); } catch (EntityNotFoundException e) { throw new LocalVCInternalException( @@ -442,20 +449,40 @@ public void authorizeUser(String repositoryTypeOrUserName, User user, Programmin catch (AccessForbiddenException e) { throw new LocalVCForbiddenException(e); } - // TODO: retrieving the git commit hash should be done ASYNC together with storing the log in the database to avoid long waiting times during permission check - String commitHash = null; + + // Asynchronously store an VCS access log entry + CompletableFuture.runAsync(() -> storeAccessLogAsync(user, participation, repositoryActionType, authenticationMechanism, ipAddress, localVCRepositoryUri)) + .exceptionally(ex -> { + log.warn("Failed to asynchronously obtain commit hash or store access log for repository {}. Error: {}", localVCRepositoryUri.getRelativeRepositoryPath(), + ex.getMessage()); + return null; + }); + } + + /** + * Asynchronously retrieves the latest commit hash from the specified repository and logs the access to the repository. + * This method runs without blocking the user during repository access checks. + * + * @param user the user accessing the repository + * @param participation the participation associated with the repository + * @param repositoryActionType the action performed on the repository (READ or WRITE) + * @param authenticationMechanism the mechanism used for authentication (e.g., token, basic auth) + * @param ipAddress the IP address of the user accessing the repository + * @param localVCRepositoryUri the URI of the localVC repository + */ + private void storeAccessLogAsync(User user, ProgrammingExerciseParticipation participation, RepositoryActionType repositoryActionType, + AuthenticationMechanism authenticationMechanism, String ipAddress, LocalVCRepositoryUri localVCRepositoryUri) { try { - if (repositoryActionType == RepositoryActionType.READ) { - String relativeRepositoryPath = localVCRepositoryUri.getRelativeRepositoryPath().toString(); - try (Repository repository = resolveRepository(relativeRepositoryPath)) { - commitHash = getLatestCommitHash(repository); - } + String commitHash; + String relativeRepositoryPath = localVCRepositoryUri.getRelativeRepositoryPath().toString(); + try (Repository repository = resolveRepository(relativeRepositoryPath)) { + commitHash = getLatestCommitHash(repository); } - // Write a access log entry to the database - String finalCommitHash = commitHash; - vcsAccessLogService.ifPresent(service -> service.storeAccessLog(user, participation, repositoryActionType, authenticationMechanism, finalCommitHash, ipAddress)); + + RepositoryActionType finalRepositoryActionType = repositoryActionType == RepositoryActionType.READ ? RepositoryActionType.PULL : RepositoryActionType.PUSH; + vcsAccessLogService.ifPresent(service -> service.storeAccessLog(user, participation, finalRepositoryActionType, authenticationMechanism, commitHash, ipAddress)); + } - // NOTE: we intentionally catch all issues here to avoid that the user is blocked from accessing the repository catch (Exception e) { log.warn("Failed to obtain commit hash or store access log for repository {}. Error: {}", localVCRepositoryUri.getRelativeRepositoryPath().toString(), e.getMessage()); } @@ -526,16 +553,9 @@ public void processNewPush(String commitHash, Repository repository) { // Process push to any repository other than the test repository. processNewPushToRepository(participation, commit); - try { - // For push the correct commitHash is only available here, therefore the preliminary null value is overwritten - String finalCommitHash = commitHash; - vcsAccessLogService.ifPresent(service -> service.updateCommitHash(participation, finalCommitHash)); - } - // NOTE: we intentionally catch all issues here to avoid that the user is blocked from accessing the repository - catch (Exception e) { - log.warn("Failed to obtain commit hash or store access log for repository {}. Error: {}", localVCRepositoryUri.getRelativeRepositoryPath().toString(), - e.getMessage()); - } + // For push the correct commitHash is only available here, therefore the preliminary null value is overwritten + String finalCommitHash = commitHash; + vcsAccessLogService.ifPresent(service -> service.updateCommitHash(participation, finalCommitHash)); } catch (GitAPIException | IOException e) { // This catch clause does not catch exceptions that happen during runBuildJob() as that method is called asynchronously. @@ -552,8 +572,8 @@ private ProgrammingExerciseParticipation getProgrammingExerciseParticipation(Loc ProgrammingExercise exercise) { ProgrammingExerciseParticipation participation; try { - participation = programmingExerciseParticipationService.getParticipationForRepository(exercise, repositoryTypeOrUserName, localVCRepositoryUri.isPracticeRepository(), - true); + participation = programmingExerciseParticipationService.retrieveParticipationForRepository(exercise, repositoryTypeOrUserName, + localVCRepositoryUri.isPracticeRepository(), true); } catch (EntityNotFoundException e) { throw new VersionControlException("Could not find participation for repository " + repositoryTypeOrUserName + " of exercise " + exercise, e); @@ -704,6 +724,29 @@ private Commit extractCommitInfo(String commitHash, Repository repository) throw return new Commit(commitHash, author.getName(), revCommit.getFullMessage(), author.getEmailAddress(), branch); } + /** + * Retrieves the participation for a programming exercise based on the repository URI. + * + * @param localVCRepositoryUri the {@link LocalVCRepositoryUri} containing details about the repository. + * @return the {@link ProgrammingExerciseParticipation} corresponding to the repository URI. + */ + private ProgrammingExerciseParticipation retrieveParticipationFromLocalVCRepositoryUri(LocalVCRepositoryUri localVCRepositoryUri) { + String repositoryTypeOrUserName = localVCRepositoryUri.getRepositoryTypeOrUserName(); + var repositoryURL = localVCRepositoryUri.toString().replace("/git-upload-pack", "").replace("/git-receive-pack", ""); + return programmingExerciseParticipationService.retrieveParticipationForRepository(repositoryTypeOrUserName, repositoryURL); + } + + /** + * Retrieves the participation for a programming exercise based on the HTTP request. + * + * @param request the {@link HttpServletRequest} containing the repository URI. + * @return the {@link ProgrammingExerciseParticipation} corresponding to the repository details in the request. + */ + private ProgrammingExerciseParticipation getExerciseParticipationFromRequest(HttpServletRequest request) { + LocalVCRepositoryUri localVCRepositoryUri = parseRepositoryUri(request); + return retrieveParticipationFromLocalVCRepositoryUri(localVCRepositoryUri); + } + /** * Determine the default branch of the given repository. * @@ -715,6 +758,127 @@ public static String getDefaultBranchOfRepository(Repository repository) { return LocalVCService.getDefaultBranchOfRepository(repositoryFolderPath.toString()); } + /** + * Updates the VCS (Version Control System) access log for clone and pull actions using HTTPS. + *

+ * This method logs the access information based on the incoming HTTP request. It checks if the action + * is performed by a build job user and, if not, records the user's repository action (clone or pull). + * The action type is determined based on the number of offers (`clientOffered`). + * + * @param request the {@link HttpServletRequest} containing the HTTP request data, including headers. + * @param clientOffered the number of objects offered by the client in the operation, used to determine + * if the action is a clone (if 0) or a pull (if greater than 0). + */ + @Async + public void updateVCSAccessLogForCloneAndPullHTTPS(HttpServletRequest request, int clientOffered) { + try { + String authorizationHeader = request.getHeader(LocalVCServletService.AUTHORIZATION_HEADER); + UsernameAndPassword usernameAndPassword = extractUsernameAndPassword(authorizationHeader); + String userName = usernameAndPassword.username(); + if (userName.equals(BUILD_USER_NAME)) { + return; + } + RepositoryActionType repositoryActionType = getRepositoryActionReadType(clientOffered); + var participation = getExerciseParticipationFromRequest(request); + + vcsAccessLogService.ifPresent(service -> service.updateRepositoryActionType(participation, repositoryActionType)); + } + catch (Exception ignored) { + } + } + + /** + * Updates the VCS access log for a push action using HTTPS. + *

+ * This method logs the access information if the HTTP request is a POST request and the action + * is not performed by a build job user. The repository action type is set as a push action. + * + * This method is asynchronous. + * + * @param request the {@link HttpServletRequest} containing the HTTP request data, including headers. + */ + @Async + public void updateVCSAccessLogForPushHTTPS(HttpServletRequest request) { + if (!request.getMethod().equals("POST")) { + return; + } + try { + String authorizationHeader = request.getHeader(LocalVCServletService.AUTHORIZATION_HEADER); + UsernameAndPassword usernameAndPassword = extractUsernameAndPassword(authorizationHeader); + String userName = usernameAndPassword.username(); + if (userName.equals(BUILD_USER_NAME)) { + return; + } + RepositoryActionType repositoryActionType = RepositoryActionType.PUSH; + var participation = getExerciseParticipationFromRequest(request); + + vcsAccessLogService.ifPresent(service -> service.updateRepositoryActionType(participation, repositoryActionType)); + } + catch (Exception ignored) { + } + } + + /** + * Updates the VCS access log for clone and pull actions performed over SSH. + *

+ * This method logs access information based on the SSH session and the root directory of the repository. + * It determines the repository action (clone or pull) based on the number of offers (`clientOffered`) and + * fetches participation details from the local VC repository URI. + * + * @param session the {@link ServerSession} representing the SSH session. + * @param rootDir the {@link Path} to the root directory of the repository. + * @param clientOffered the number of objects offered by the client in the operation, used to determine + * if the action is a clone (if 0) or a pull (if greater than 0). + */ + @Async + public void updateVCSAccessLogForCloneAndPullSSH(ServerSession session, Path rootDir, int clientOffered) { + try { + if (session.getAttribute(SshConstants.USER_KEY).getName().equals(BUILD_USER_NAME)) { + return; + } + RepositoryActionType repositoryActionType = getRepositoryActionReadType(clientOffered); + var participation = retrieveParticipationFromLocalVCRepositoryUri(getLocalVCRepositoryUri(rootDir)); + vcsAccessLogService.ifPresent(service -> service.updateRepositoryActionType(participation, repositoryActionType)); + } + catch (Exception ignored) { + } + } + + /** + * Adds a failed VCS access attempt to the log. + *

+ * This method logs a failed clone attempt, associating it with the user and participation retrieved + * from the incoming HTTP request. It assumes that the failed attempt used password authentication. + * + * @param servletRequest the {@link HttpServletRequest} containing the HTTP request data. + */ + public void createVCSAccessLogForFailedAuthenticationAttempt(HttpServletRequest servletRequest) { + try { + String authorizationHeader = servletRequest.getHeader(LocalVCServletService.AUTHORIZATION_HEADER); + UsernameAndPassword usernameAndPassword = extractUsernameAndPassword(authorizationHeader); + User user = userRepository.findOneByLogin(usernameAndPassword.username()).orElseThrow(LocalVCAuthException::new); + AuthenticationMechanism mechanism = usernameAndPassword.password().startsWith("vcpat-") ? AuthenticationMechanism.VCS_ACCESS_TOKEN : AuthenticationMechanism.PASSWORD; + var participation = getExerciseParticipationFromRequest(servletRequest); + var ipAddress = servletRequest.getRemoteAddr(); + vcsAccessLogService.ifPresent(service -> service.storeAccessLog(user, participation, RepositoryActionType.CLONE_FAIL, mechanism, "", ipAddress)); + } + catch (LocalVCAuthException ignored) { + } + } + + /** + * Determines the repository action type for read operations (clone or pull). + *

+ * This method returns a {@link RepositoryActionType} based on the number of objects offered. + * If no objects are offered (0), it is considered a clone; otherwise, it is a pull action. + * + * @param clientOffered the number of objects offered to the client in the operation. + * @return the {@link RepositoryActionType} based on the number of objects offered (clone if 0, pull if greater than 0). + */ + private RepositoryActionType getRepositoryActionReadType(int clientOffered) { + return clientOffered == 0 ? RepositoryActionType.CLONE : RepositoryActionType.PULL; + } + record UsernameAndPassword(String username, String password) { } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/SshGitLocationResolverService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/SshGitLocationResolverService.java index a61712685ef7..d45bfda1c179 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/SshGitLocationResolverService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/SshGitLocationResolverService.java @@ -70,12 +70,12 @@ public Path resolveRootDirectory(String command, String[] args, ServerSession se // git-upload-pack means fetch (read operation), git-receive-pack means push (write operation) final var repositoryAction = gitCommand.equals("git-upload-pack") ? RepositoryActionType.READ : gitCommand.equals("git-receive-pack") ? RepositoryActionType.WRITE : null; + final var user = session.getAttribute(SshConstants.USER_KEY); if (session.getAttribute(SshConstants.IS_BUILD_AGENT_KEY) && repositoryAction == RepositoryActionType.READ) { // We already checked for build agent authenticity } else { - final var user = session.getAttribute(SshConstants.USER_KEY); try { localVCServletService.authorizeUser(repositoryTypeOrUserName, user, exercise, repositoryAction, AuthenticationMechanism.SSH, session.getClientAddress().toString(), localVCRepositoryUri); diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/VcsAccessLogService.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/VcsAccessLogService.java index 57330b4d51e0..af1972ce2e1c 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/VcsAccessLogService.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/VcsAccessLogService.java @@ -7,6 +7,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.annotation.Profile; +import org.springframework.scheduling.annotation.Async; import org.springframework.stereotype.Service; import de.tum.cit.aet.artemis.core.domain.User; @@ -44,7 +45,7 @@ public class VcsAccessLogService { * @param commitHash The latest commit hash * @param ipAddress The ip address of the user accessing the repository */ - // TODO: this should be ASYNC to avoid long waiting times during permission check + @Async public void storeAccessLog(User user, ProgrammingExerciseParticipation participation, RepositoryActionType actionType, AuthenticationMechanism authenticationMechanism, String commitHash, String ipAddress) { log.debug("Storing access operation for user {}", user); @@ -55,19 +56,32 @@ public void storeAccessLog(User user, ProgrammingExerciseParticipation participa } /** - * Updates the commit hash after a successful push + * Updates the commit hash of the newest log entry * * @param participation The participation to which the repository belongs to * @param commitHash The newest commit hash which should get set for the access log entry */ - // TODO: this should be ASYNC to avoid long waiting times during permission check + @Async public void updateCommitHash(ProgrammingExerciseParticipation participation, String commitHash) { - vcsAccessLogRepository.findNewestByParticipationIdWhereCommitHashIsNull(participation.getId()).ifPresent(entry -> { + vcsAccessLogRepository.findNewestByParticipationId(participation.getId()).ifPresent(entry -> { entry.setCommitHash(commitHash); vcsAccessLogRepository.save(entry); }); } + /** + * Updates the repository action type of the newest log entry. This method is not Async, as it should already be called from an @Async context + * + * @param participation The participation to which the repository belongs to + * @param repositoryActionType The repositoryActionType which should get set for the newest access log entry + */ + public void updateRepositoryActionType(ProgrammingExerciseParticipation participation, RepositoryActionType repositoryActionType) { + vcsAccessLogRepository.findNewestByParticipationId(participation.getId()).ifPresent(entry -> { + entry.setRepositoryActionType(repositoryActionType); + vcsAccessLogRepository.save(entry); + }); + } + /** * Stores the log for a push from the code editor. * @@ -81,7 +95,11 @@ public void storeCodeEditorAccessLog(Repository repo, User user, Long participat String lastCommitHash = git.log().setMaxCount(1).call().iterator().next().getName(); var participation = participationRepository.findById(participationId); if (participation.isPresent() && participation.get() instanceof ProgrammingExerciseParticipation programmingParticipation) { - storeAccessLog(user, programmingParticipation, RepositoryActionType.WRITE, AuthenticationMechanism.CODE_EDITOR, lastCommitHash, null); + log.debug("Storing access operation for user {}", user); + + VcsAccessLog accessLogEntry = new VcsAccessLog(user, (Participation) programmingParticipation, user.getName(), user.getEmail(), RepositoryActionType.WRITE, + AuthenticationMechanism.CODE_EDITOR, lastCommitHash, null); + vcsAccessLogRepository.save(accessLogEntry); } } } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ssh/SshGitCommand.java b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ssh/SshGitCommand.java index b0307ec38bb4..7ec968646217 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ssh/SshGitCommand.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/service/localvc/ssh/SshGitCommand.java @@ -21,6 +21,7 @@ import org.eclipse.jgit.util.FS; import de.tum.cit.aet.artemis.core.domain.User; +import de.tum.cit.aet.artemis.programming.service.localvc.LocalVCFetchPreUploadHookSSH; import de.tum.cit.aet.artemis.programming.service.localvc.LocalVCPostPushHook; import de.tum.cit.aet.artemis.programming.service.localvc.LocalVCPrePushHook; import de.tum.cit.aet.artemis.programming.service.localvc.LocalVCServletService; @@ -84,6 +85,7 @@ public void run() { if (GenericUtils.isNotBlank(protocol)) { uploadPack.setExtraParameters(Collections.singleton(protocol)); } + uploadPack.setPreUploadHook(new LocalVCFetchPreUploadHookSSH(localVCServletService, getServerSession(), rootDir)); uploadPack.upload(getInputStream(), getOutputStream(), getErrorStream()); } else if (RemoteConfig.DEFAULT_RECEIVE_PACK.equals(subCommand)) { diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseParticipationResource.java b/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseParticipationResource.java index d06fdf5fb975..be1c99c67be6 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseParticipationResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseParticipationResource.java @@ -49,6 +49,7 @@ import de.tum.cit.aet.artemis.programming.domain.VcsRepositoryUri; import de.tum.cit.aet.artemis.programming.dto.CommitInfoDTO; import de.tum.cit.aet.artemis.programming.dto.VcsAccessLogDTO; +import de.tum.cit.aet.artemis.programming.repository.AuxiliaryRepositoryRepository; import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseRepository; import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseStudentParticipationRepository; import de.tum.cit.aet.artemis.programming.repository.VcsAccessLogRepository; @@ -89,11 +90,13 @@ public class ProgrammingExerciseParticipationResource { private final Optional vcsAccessLogRepository; + private final AuxiliaryRepositoryRepository auxiliaryRepositoryRepository; + public ProgrammingExerciseParticipationResource(ProgrammingExerciseParticipationService programmingExerciseParticipationService, ResultRepository resultRepository, ParticipationRepository participationRepository, ProgrammingExerciseStudentParticipationRepository programmingExerciseStudentParticipationRepository, ProgrammingSubmissionService submissionService, ProgrammingExerciseRepository programmingExerciseRepository, AuthorizationCheckService authCheckService, ResultService resultService, ParticipationAuthorizationCheckService participationAuthCheckService, RepositoryService repositoryService, - StudentExamRepository studentExamRepository, Optional vcsAccessLogRepository) { + StudentExamRepository studentExamRepository, Optional vcsAccessLogRepository, AuxiliaryRepositoryRepository auxiliaryRepositoryRepository) { this.programmingExerciseParticipationService = programmingExerciseParticipationService; this.participationRepository = participationRepository; this.programmingExerciseStudentParticipationRepository = programmingExerciseStudentParticipationRepository; @@ -105,6 +108,7 @@ public ProgrammingExerciseParticipationResource(ProgrammingExerciseParticipation this.participationAuthCheckService = participationAuthCheckService; this.repositoryService = repositoryService; this.studentExamRepository = studentExamRepository; + this.auxiliaryRepositoryRepository = auxiliaryRepositoryRepository; this.vcsAccessLogRepository = vcsAccessLogRepository; } @@ -339,22 +343,25 @@ public ResponseEntity> getVcsAccessLogForParticipationRepo /** * GET /programming-exercise/{exerciseID}/commit-history/{repositoryType} : Get the commit history of a programming exercise repository. The repository type can be TEMPLATE or - * SOLUTION or TESTS. + * SOLUTION, TESTS or AUXILIARY. * Here we check is at least a teaching assistant for the exercise. * * @param exerciseID the id of the exercise for which to retrieve the commit history * @param repositoryType the type of the repository for which to retrieve the commit history + * @param repositoryId the id of the repository * @return the ResponseEntity with status 200 (OK) and with body a list of commitInfo DTOs with the commits information of the repository */ @GetMapping("programming-exercise/{exerciseID}/commit-history/{repositoryType}") @EnforceAtLeastTutor - public ResponseEntity> getCommitHistoryForTemplateSolutionOrTestRepo(@PathVariable long exerciseID, @PathVariable RepositoryType repositoryType) { + public ResponseEntity> getCommitHistoryForTemplateSolutionTestOrAuxRepo(@PathVariable long exerciseID, @PathVariable RepositoryType repositoryType, + @RequestParam Optional repositoryId) { boolean isTemplateRepository = repositoryType.equals(RepositoryType.TEMPLATE); boolean isSolutionRepository = repositoryType.equals(RepositoryType.SOLUTION); boolean isTestRepository = repositoryType.equals(RepositoryType.TESTS); + boolean isAuxiliaryRepository = repositoryType.equals(RepositoryType.AUXILIARY); ProgrammingExerciseParticipation participation; - if (!isTemplateRepository && !isSolutionRepository && !isTestRepository) { + if (!isTemplateRepository && !isSolutionRepository && !isTestRepository && !isAuxiliaryRepository) { throw new BadRequestAlertException("Invalid repository type", ENTITY_NAME, "invalidRepositoryType"); } else if (isTemplateRepository) { @@ -364,6 +371,15 @@ else if (isTemplateRepository) { participation = programmingExerciseParticipationService.findSolutionParticipationByProgrammingExerciseId(exerciseID); } participationAuthCheckService.checkCanAccessParticipationElseThrow(participation); + + if (isAuxiliaryRepository) { + var auxiliaryRepo = auxiliaryRepositoryRepository.findByIdElseThrow(repositoryId.orElseThrow()); + if (!auxiliaryRepo.getExercise().getId().equals(exerciseID)) { + throw new BadRequestAlertException("Invalid repository id", ENTITY_NAME, "invalidRepositoryId"); + } + return ResponseEntity.ok(programmingExerciseParticipationService.getAuxiliaryRepositoryCommitInfos(auxiliaryRepo)); + } + if (isTestRepository) { return ResponseEntity.ok(programmingExerciseParticipationService.getCommitInfosTestRepo(participation)); } diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java b/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java index 2225baa81759..957f7435ce0d 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java @@ -534,6 +534,21 @@ public ResponseEntity getProgrammingExerciseWithTemplateAnd return ResponseEntity.ok(programmingExercise); } + /** + * GET /programming-exercises/:exerciseId/with-auxiliary-repository + * + * @param exerciseId the id of the programmingExercise to retrieve + * @return the ResponseEntity with status 200 (OK) and the programming exercise with template and solution participation, or with status 404 (Not Found) + */ + @GetMapping("programming-exercises/{exerciseId}/with-auxiliary-repository") + @EnforceAtLeastTutorInExercise + public ResponseEntity getProgrammingExerciseWithAuxiliaryRepository(@PathVariable long exerciseId) { + + log.debug("REST request to get programming exercise with auxiliary repositories: {}", exerciseId); + final var programmingExercise = programmingExerciseService.loadProgrammingExerciseWithAuxiliaryRepositories(exerciseId); + return ResponseEntity.ok(programmingExercise); + } + /** * DELETE /programming-exercises/:id : delete the "id" programmingExercise. * diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/web/repository/AuxiliaryRepositoryResource.java b/src/main/java/de/tum/cit/aet/artemis/programming/web/repository/AuxiliaryRepositoryResource.java new file mode 100644 index 000000000000..8c03cf7dae19 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/programming/web/repository/AuxiliaryRepositoryResource.java @@ -0,0 +1,220 @@ +package de.tum.cit.aet.artemis.programming.web.repository; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; + +import java.security.Principal; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import jakarta.servlet.http.HttpServletRequest; + +import org.eclipse.jgit.api.errors.CheckoutConflictException; +import org.eclipse.jgit.api.errors.GitAPIException; +import org.eclipse.jgit.api.errors.WrongRepositoryStateException; +import org.springframework.context.annotation.Profile; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.DeleteMapping; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.PutMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +import de.tum.cit.aet.artemis.core.domain.User; +import de.tum.cit.aet.artemis.core.exception.AccessForbiddenException; +import de.tum.cit.aet.artemis.core.repository.UserRepository; +import de.tum.cit.aet.artemis.core.security.annotations.EnforceAtLeastTutor; +import de.tum.cit.aet.artemis.core.service.AuthorizationCheckService; +import de.tum.cit.aet.artemis.core.service.ProfileService; +import de.tum.cit.aet.artemis.core.service.feature.Feature; +import de.tum.cit.aet.artemis.core.service.feature.FeatureToggle; +import de.tum.cit.aet.artemis.programming.domain.AuxiliaryRepository; +import de.tum.cit.aet.artemis.programming.domain.FileType; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; +import de.tum.cit.aet.artemis.programming.domain.Repository; +import de.tum.cit.aet.artemis.programming.domain.VcsRepositoryUri; +import de.tum.cit.aet.artemis.programming.dto.FileMove; +import de.tum.cit.aet.artemis.programming.dto.RepositoryStatusDTO; +import de.tum.cit.aet.artemis.programming.repository.AuxiliaryRepositoryRepository; +import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseRepository; +import de.tum.cit.aet.artemis.programming.service.GitService; +import de.tum.cit.aet.artemis.programming.service.RepositoryAccessService; +import de.tum.cit.aet.artemis.programming.service.RepositoryService; +import de.tum.cit.aet.artemis.programming.service.localvc.LocalVCServletService; +import de.tum.cit.aet.artemis.programming.service.vcs.VersionControlService; + +/** + * Executes requested actions on the auxiliary repository of a programming exercise. Only available to TAs, Instructors and Admins. + */ +@Profile(PROFILE_CORE) +@RestController +@RequestMapping("api/auxiliary-repository/") +public class AuxiliaryRepositoryResource extends RepositoryResource { + + private final AuxiliaryRepositoryRepository auxiliaryRepositoryRepository; + + public AuxiliaryRepositoryResource(ProfileService profileService, UserRepository userRepository, AuthorizationCheckService authCheckService, GitService gitService, + RepositoryService repositoryService, Optional versionControlService, ProgrammingExerciseRepository programmingExerciseRepository, + RepositoryAccessService repositoryAccessService, Optional localVCServletService, AuxiliaryRepositoryRepository auxiliaryRepositoryRepository) { + super(profileService, userRepository, authCheckService, gitService, repositoryService, versionControlService, programmingExerciseRepository, repositoryAccessService, + localVCServletService); + this.auxiliaryRepositoryRepository = auxiliaryRepositoryRepository; + } + + @Override + Repository getRepository(Long auxiliaryRepositoryId, RepositoryActionType repositoryActionType, boolean pullOnGet) throws GitAPIException { + final var auxiliaryRepository = auxiliaryRepositoryRepository.findByIdElseThrow(auxiliaryRepositoryId); + User user = userRepository.getUserWithGroupsAndAuthorities(); + repositoryAccessService.checkAccessTestOrAuxRepositoryElseThrow(false, auxiliaryRepository.getExercise(), user, "auxiliary"); + final var repoUri = auxiliaryRepository.getVcsRepositoryUri(); + return gitService.getOrCheckoutRepository(repoUri, pullOnGet); + } + + @Override + VcsRepositoryUri getRepositoryUri(Long auxiliaryRepositoryId) { + var auxRepo = auxiliaryRepositoryRepository.findByIdElseThrow(auxiliaryRepositoryId); + return auxRepo.getVcsRepositoryUri(); + } + + @Override + boolean canAccessRepository(Long auxiliaryRepositoryId) { + try { + repositoryAccessService.checkAccessTestOrAuxRepositoryElseThrow(false, auxiliaryRepositoryRepository.findByIdElseThrow(auxiliaryRepositoryId).getExercise(), + userRepository.getUserWithGroupsAndAuthorities(), "auxiliary"); + } + catch (AccessForbiddenException e) { + return false; + } + return true; + } + + @Override + String getOrRetrieveBranchOfDomainObject(Long auxiliaryRepositoryId) { + AuxiliaryRepository auxiliaryRepo = auxiliaryRepositoryRepository.findByIdElseThrow(auxiliaryRepositoryId); + ProgrammingExercise exercise = programmingExerciseRepository.findByIdElseThrow(auxiliaryRepo.getExercise().getId()); + return versionControlService.orElseThrow().getOrRetrieveBranchOfExercise(exercise); + } + + @Override + @GetMapping(value = "{auxiliaryRepositoryId}/files", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + public ResponseEntity> getFiles(@PathVariable Long auxiliaryRepositoryId) { + return super.getFiles(auxiliaryRepositoryId); + } + + @Override + @GetMapping(value = "{auxiliaryRepositoryId}/file", produces = MediaType.APPLICATION_OCTET_STREAM_VALUE) + @EnforceAtLeastTutor + public ResponseEntity getFile(@PathVariable Long auxiliaryRepositoryId, @RequestParam("file") String filename) { + return super.getFile(auxiliaryRepositoryId, filename); + } + + @Override + @PostMapping(value = "{auxiliaryRepositoryId}/file", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + @FeatureToggle(Feature.ProgrammingExercises) + public ResponseEntity createFile(@PathVariable Long auxiliaryRepositoryId, @RequestParam("file") String filePath, HttpServletRequest request) { + return super.createFile(auxiliaryRepositoryId, filePath, request); + } + + @Override + @PostMapping(value = "{auxiliaryRepositoryId}/folder", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + @FeatureToggle(Feature.ProgrammingExercises) + public ResponseEntity createFolder(@PathVariable Long auxiliaryRepositoryId, @RequestParam("folder") String folderPath, HttpServletRequest request) { + return super.createFolder(auxiliaryRepositoryId, folderPath, request); + } + + @Override + @PostMapping(value = "{auxiliaryRepositoryId}/rename-file", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + @FeatureToggle(Feature.ProgrammingExercises) + public ResponseEntity renameFile(@PathVariable Long auxiliaryRepositoryId, @RequestBody FileMove fileMove) { + return super.renameFile(auxiliaryRepositoryId, fileMove); + } + + @Override + @DeleteMapping(value = "{auxiliaryRepositoryId}/file", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + @FeatureToggle(Feature.ProgrammingExercises) + public ResponseEntity deleteFile(@PathVariable Long auxiliaryRepositoryId, @RequestParam("file") String filename) { + return super.deleteFile(auxiliaryRepositoryId, filename); + } + + @Override + @GetMapping(value = "{auxiliaryRepositoryId}/pull", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + public ResponseEntity pullChanges(@PathVariable Long auxiliaryRepositoryId) { + return super.pullChanges(auxiliaryRepositoryId); + } + + @Override + @PostMapping(value = "{auxiliaryRepositoryId}/commit", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + @FeatureToggle(Feature.ProgrammingExercises) + public ResponseEntity commitChanges(@PathVariable Long auxiliaryRepositoryId) { + return super.commitChanges(auxiliaryRepositoryId); + } + + @Override + @PostMapping(value = "{auxiliaryRepositoryId}/reset", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + @FeatureToggle(Feature.ProgrammingExercises) + public ResponseEntity resetToLastCommit(@PathVariable Long auxiliaryRepositoryId) { + return super.resetToLastCommit(auxiliaryRepositoryId); + } + + @Override + @GetMapping(value = "{auxiliaryRepositoryId}", produces = MediaType.APPLICATION_JSON_VALUE) + @EnforceAtLeastTutor + public ResponseEntity getStatus(@PathVariable Long auxiliaryRepositoryId) throws GitAPIException { + return super.getStatus(auxiliaryRepositoryId); + } + + /** + * Update a list of files in an auxiliary repository based on the submission's content. + * + * @param auxiliaryRepositoryId of exercise to which the files belong + * @param submissions information about the file updates + * @param commit whether to commit after updating the files + * @param principal used to check if the user can update the files + * @return {Map} file submissions or the appropriate http error + */ + @PutMapping("{auxiliaryRepositoryId}/files") + @EnforceAtLeastTutor + public ResponseEntity> updateAuxiliaryFiles(@PathVariable("auxiliaryRepositoryId") Long auxiliaryRepositoryId, + @RequestBody List submissions, @RequestParam Boolean commit, Principal principal) { + + if (versionControlService.isEmpty()) { + throw new ResponseStatusException(HttpStatus.SERVICE_UNAVAILABLE, "VCSNotPresent"); + } + AuxiliaryRepository auxiliaryRepository = auxiliaryRepositoryRepository.findByIdElseThrow(auxiliaryRepositoryId); + ProgrammingExercise exercise = auxiliaryRepository.getExercise(); + + Repository repository; + try { + repositoryAccessService.checkAccessTestOrAuxRepositoryElseThrow(true, exercise, userRepository.getUserWithGroupsAndAuthorities(principal.getName()), "test"); + repository = gitService.getOrCheckoutRepository(auxiliaryRepository.getVcsRepositoryUri(), true); + } + catch (AccessForbiddenException e) { + FileSubmissionError error = new FileSubmissionError(auxiliaryRepositoryId, "noPermissions"); + throw new ResponseStatusException(HttpStatus.FORBIDDEN, error.getMessage(), error); + } + catch (CheckoutConflictException | WrongRepositoryStateException ex) { + FileSubmissionError error = new FileSubmissionError(auxiliaryRepositoryId, "checkoutConflict"); + throw new ResponseStatusException(HttpStatus.CONFLICT, error.getMessage(), error); + } + catch (GitAPIException ex) { + FileSubmissionError error = new FileSubmissionError(auxiliaryRepositoryId, "checkoutFailed"); + throw new ResponseStatusException(HttpStatus.SERVICE_UNAVAILABLE, error.getMessage(), error); + } + return saveFilesAndCommitChanges(auxiliaryRepositoryId, submissions, commit, repository); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/web/repository/RepositoryActionType.java b/src/main/java/de/tum/cit/aet/artemis/programming/web/repository/RepositoryActionType.java index f7f62ebb4989..8d803cc66a53 100644 --- a/src/main/java/de/tum/cit/aet/artemis/programming/web/repository/RepositoryActionType.java +++ b/src/main/java/de/tum/cit/aet/artemis/programming/web/repository/RepositoryActionType.java @@ -4,5 +4,5 @@ * Determines if a repository action only reads (e.g. get a file from the repo) or updates (e.g. create a new file in the repo). */ public enum RepositoryActionType { - READ, WRITE, RESET + READ, WRITE, RESET, CLONE, PULL, PUSH, CLONE_FAIL, PULL_FAIL, PUSH_FAIL } diff --git a/src/main/resources/config/application.yml b/src/main/resources/config/application.yml index 3924e2d804f9..6645696acc2e 100644 --- a/src/main/resources/config/application.yml +++ b/src/main/resources/config/application.yml @@ -93,6 +93,8 @@ artemis: default: "ghcr.io/ls1intum/artemis-javascript-docker:v1.0.0" r: default: "ghcr.io/ls1intum/artemis-r-docker:v1.0.0" + c_plus_plus: + default: "ghcr.io/ls1intum/artemis-cpp-docker:v1.0.0" management: endpoints: diff --git a/src/main/resources/public/videos/course-competencies/create-competencies.gif b/src/main/resources/public/videos/course-competencies/create-competencies.gif new file mode 100644 index 000000000000..fcf6de03985b Binary files /dev/null and b/src/main/resources/public/videos/course-competencies/create-competencies.gif differ diff --git a/src/main/resources/public/videos/course-competencies/create-course-competency-relations.gif b/src/main/resources/public/videos/course-competencies/create-course-competency-relations.gif new file mode 100644 index 000000000000..072796051ef7 Binary files /dev/null and b/src/main/resources/public/videos/course-competencies/create-course-competency-relations.gif differ diff --git a/src/main/resources/templates/aeolus/c/fact.yaml b/src/main/resources/templates/aeolus/c/fact.yaml index 9d3527e65503..4278be956fac 100644 --- a/src/main/resources/templates/aeolus/c/fact.yaml +++ b/src/main/resources/templates/aeolus/c/fact.yaml @@ -7,7 +7,7 @@ actions: # Task Description: # Build and run all tests # ------------------------------ - # Updating assignment and test-reports ownership... + # Updating ${studentParentWorkingDirectoryName} and test-reports ownership... sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R || true sudo mkdir test-reports sudo chown artemis_user:artemis_user test-reports/ -R || true @@ -32,4 +32,3 @@ actions: - name: junit_test-reports/tests-results.xml path: test-reports/tests-results.xml type: junit - diff --git a/src/main/resources/templates/aeolus/c/gcc.yaml b/src/main/resources/templates/aeolus/c/gcc.yaml index 29b2e2c635ec..31cafd647000 100644 --- a/src/main/resources/templates/aeolus/c/gcc.yaml +++ b/src/main/resources/templates/aeolus/c/gcc.yaml @@ -9,7 +9,7 @@ actions: # Build and run all tests # ------------------------------ - # Updating assignment and test-reports ownership... + # Updating ${studentParentWorkingDirectoryName} and test-reports ownership... sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R mkdir test-reports chown artemis_user:artemis_user test-reports/ -R diff --git a/src/main/resources/templates/aeolus/c/gcc_static.yaml b/src/main/resources/templates/aeolus/c/gcc_static.yaml index 21c0b506f179..06ad3136f9aa 100644 --- a/src/main/resources/templates/aeolus/c/gcc_static.yaml +++ b/src/main/resources/templates/aeolus/c/gcc_static.yaml @@ -9,7 +9,7 @@ actions: # Build and run all tests # ------------------------------ - # Updating assignment and test-reports ownership... + # Updating ${studentParentWorkingDirectoryName} and test-reports ownership... sudo chown artemis_user:artemis_user ${studentParentWorkingDirectoryName}/ -R mkdir test-reports chown artemis_user:artemis_user test-reports/ -R diff --git a/src/main/resources/templates/aeolus/c_plus_plus/default.sh b/src/main/resources/templates/aeolus/c_plus_plus/default.sh new file mode 100644 index 000000000000..aa91d2f607d0 --- /dev/null +++ b/src/main/resources/templates/aeolus/c_plus_plus/default.sh @@ -0,0 +1,56 @@ +#!/usr/bin/env bash +set -e +export AEOLUS_INITIAL_DIRECTORY=${PWD} +setup_the_build_environment () { + echo '⚙️ executing setup_the_build_environment' + #!/usr/bin/env bash + + # ------------------------------ + # Task Description: + # Setup the build environment + # ------------------------------ + + mkdir test-reports + + # Updating ownership... + chown -R artemis_user:artemis_user . + + REQ_FILE=requirements.txt + if [ -f "$REQ_FILE" ]; then + python3 -m venv /venv + /venv/bin/pip3 install -r "$REQ_FILE" + else + echo "$REQ_FILE does not exist" + fi +} + +build_and_run_all_tests () { + echo '⚙️ executing build_and_run_all_tests' + #!/usr/bin/env bash + + # ------------------------------ + # Task Description: + # Build and run all tests + # ------------------------------ + + if [ -d /venv ]; then + . /venv/bin/activate + fi + + # Run tests as unprivileged user + runuser -u artemis_user python3 Tests.py +} + +main () { + if [[ "${1}" == "aeolus_sourcing" ]]; then + return 0 # just source to use the methods in the subshell, no execution + fi + local _script_name + _script_name=${BASH_SOURCE[0]:-$0} + cd "${AEOLUS_INITIAL_DIRECTORY}" + bash -c "source ${_script_name} aeolus_sourcing; setup_the_build_environment" + cd "${AEOLUS_INITIAL_DIRECTORY}" + bash -c "source ${_script_name} aeolus_sourcing; build_and_run_all_tests" +} + +main "${@}" diff --git a/src/main/resources/templates/aeolus/c_plus_plus/default.yaml b/src/main/resources/templates/aeolus/c_plus_plus/default.yaml new file mode 100644 index 000000000000..ac71eb79779f --- /dev/null +++ b/src/main/resources/templates/aeolus/c_plus_plus/default.yaml @@ -0,0 +1,48 @@ +api: v0.0.1 +metadata: + name: C++ + id: c_plus_plus + description: Test using the GBS Tester +actions: + - name: setup_the_build_environment + script: |- + #!/usr/bin/env bash + + # ------------------------------ + # Task Description: + # Setup the build environment + # ------------------------------ + + mkdir test-reports + + # Updating ownership... + chown -R artemis_user:artemis_user . + + REQ_FILE=requirements.txt + if [ -f "$REQ_FILE" ]; then + python3 -m venv /venv + /venv/bin/pip3 install -r "$REQ_FILE" + else + echo "$REQ_FILE does not exist" + fi + runAlways: false + - name: build_and_run_all_tests + script: |- + #!/usr/bin/env bash + + # ------------------------------ + # Task Description: + # Build and run all tests + # ------------------------------ + + if [ -d /venv ]; then + . /venv/bin/activate + fi + + # Run tests as unprivileged user + runuser -u artemis_user python3 Tests.py + runAlways: false + results: + - name: junit_test-reports/tests-results.xml + path: 'test-reports/*.xml' + type: junit diff --git a/src/main/resources/templates/aeolus/swift/plain.yaml b/src/main/resources/templates/aeolus/swift/plain.yaml index 48211dee715a..a2be5d469e65 100644 --- a/src/main/resources/templates/aeolus/swift/plain.yaml +++ b/src/main/resources/templates/aeolus/swift/plain.yaml @@ -6,7 +6,7 @@ actions: cp -R Tests ${studentParentWorkingDirectoryName} cp Package.swift ${studentParentWorkingDirectoryName} - # In order to get the correct console output we need to execute the command within the assignment directory + # In order to get the correct console output we need to execute the command within the ${studentParentWorkingDirectoryName} directory # swift build cd ${studentParentWorkingDirectoryName} swift build || error=true diff --git a/src/main/resources/templates/aeolus/swift/plain_static.yaml b/src/main/resources/templates/aeolus/swift/plain_static.yaml index 72f683141903..83c76e1a2b61 100644 --- a/src/main/resources/templates/aeolus/swift/plain_static.yaml +++ b/src/main/resources/templates/aeolus/swift/plain_static.yaml @@ -7,7 +7,7 @@ actions: cp -R Tests ${studentParentWorkingDirectoryName} cp Package.swift ${studentParentWorkingDirectoryName} - # In order to get the correct console output we need to execute the command within the assignment directory + # In order to get the correct console output we need to execute the command within the ${studentParentWorkingDirectoryName} directory # swift build cd ${studentParentWorkingDirectoryName} swift build || error=true diff --git a/src/main/resources/templates/c_plus_plus/exercise/.clang-format b/src/main/resources/templates/c_plus_plus/exercise/.clang-format new file mode 100644 index 000000000000..541e6dca6c50 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/exercise/.clang-format @@ -0,0 +1,4 @@ +--- +Language: Cpp +BasedOnStyle: Google +IncludeBlocks: Preserve diff --git a/src/main/resources/templates/c_plus_plus/exercise/.gitattributes b/src/main/resources/templates/c_plus_plus/exercise/.gitattributes new file mode 100644 index 000000000000..0e4a9089ed6e --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/exercise/.gitattributes @@ -0,0 +1,39 @@ +# Source: https://github.com/gitattributes/gitattributes/blob/master/C%2B%2B.gitattributes (01.09.2024) + +# Sources +*.c text diff=cpp +*.cc text diff=cpp +*.cxx text diff=cpp +*.cpp text diff=cpp +*.cpi text diff=cpp +*.c++ text diff=cpp +*.hpp text diff=cpp +*.h text diff=cpp +*.h++ text diff=cpp +*.hh text diff=cpp + +# Compiled Object files +*.slo binary +*.lo binary +*.o binary +*.obj binary + +# Precompiled Headers +*.gch binary +*.pch binary + +# Compiled Dynamic libraries +*.so binary +*.dylib binary +*.dll binary + +# Compiled Static libraries +*.lai binary +*.la binary +*.a binary +*.lib binary + +# Executables +*.exe binary +*.out binary +*.app binary diff --git a/src/main/resources/templates/c_plus_plus/exercise/.gitignore b/src/main/resources/templates/c_plus_plus/exercise/.gitignore new file mode 100644 index 000000000000..62f60adbb914 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/exercise/.gitignore @@ -0,0 +1,4 @@ +cmake-build-*/ + +.vscode/ +.idea/ diff --git a/src/main/resources/templates/c_plus_plus/exercise/CMakeLists.txt b/src/main/resources/templates/c_plus_plus/exercise/CMakeLists.txt new file mode 100644 index 000000000000..1a01a44252aa --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/exercise/CMakeLists.txt @@ -0,0 +1,11 @@ +cmake_minimum_required(VERSION 3.13) +project(ArtemisExercise) + +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +add_library(assignment src/sort.cpp) +target_include_directories(assignment PUBLIC include) + +add_executable(assignment_main src/main.cpp) +target_link_libraries(assignment_main assignment) diff --git a/src/main/resources/templates/c_plus_plus/exercise/include/sort.hpp b/src/main/resources/templates/c_plus_plus/exercise/include/sort.hpp new file mode 100644 index 000000000000..886fc4aeba92 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/exercise/include/sort.hpp @@ -0,0 +1,25 @@ +#pragma once + +#include + +void selection_sort(std::vector::iterator begin, + std::vector::iterator end); + +void insertion_sort(std::vector::iterator begin, + std::vector::iterator end); + +void quicksort(std::vector::iterator begin, + std::vector::iterator end); + +void mergesort(std::vector::iterator begin, + std::vector::iterator end); + +void mergesort_inplace(std::vector::iterator begin, + std::vector::iterator end); + +void heapsort(std::vector::iterator begin, std::vector::iterator end); + +void heapsort_explicit(std::vector::iterator begin, + std::vector::iterator end); + +void bogosort(std::vector::iterator begin, std::vector::iterator end); diff --git a/src/main/resources/templates/c_plus_plus/exercise/src/main.cpp b/src/main/resources/templates/c_plus_plus/exercise/src/main.cpp new file mode 100644 index 000000000000..16b651caade9 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/exercise/src/main.cpp @@ -0,0 +1,5 @@ +#include "sort.hpp" + +int main() { + // Test your implementation here +} diff --git a/src/main/resources/templates/c_plus_plus/exercise/src/sort.cpp b/src/main/resources/templates/c_plus_plus/exercise/src/sort.cpp new file mode 100644 index 000000000000..5966af03e21f --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/exercise/src/sort.cpp @@ -0,0 +1,43 @@ +#include "sort.hpp" + +#include + +void selection_sort(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} + +void insertion_sort(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} + +void quicksort(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} + +void mergesort(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} + +void mergesort_inplace(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} + +void heapsort(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} + +void heapsort_explicit(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} + +void bogosort(std::vector::iterator begin, + std::vector::iterator end) { + throw std::logic_error("not implemented"); +} diff --git a/src/main/resources/templates/c_plus_plus/readme b/src/main/resources/templates/c_plus_plus/readme new file mode 100644 index 000000000000..5aefda9d7606 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/readme @@ -0,0 +1,91 @@ +# Sorting using `` building blocks + +An array `v` is considered _sorted_ if each pair of neighboring elements fulfills `v[i] <= v[i + 1]`. +Sorting an array means rearranging the elements such that it is sorted. This also means that +sorting may not add or remove elements. This is usually achieved by swapping elements. + +1. [task][CMake runs correctly](TestConfigure) +2. [task][Your code compiles](CompileSort) + + +# Sorting Algorithms +[task][All algorithms sort correctly](TestCatch2(sort-test)) +1. [task][Selection Sort](sorting_algorithms/selection_sort,sorting_algorithms/all_elements_equal/selection_sort,sorting_algorithms/reverse-sorted_values/selection_sort,sorting_algorithms/single_values/selection_sort,sorting_algorithms/empty_input/selection_sort,sorting_algorithms/large_input/selection_sort) + Find the correct value for the next position, one position at a time. + + Implement the following function using suitable C++ standard library algorithms. + ```c++ + void selection_sort(std::vector::iterator begin, + std::vector::iterator end) { /* ... */ } + ``` + +2. [task][Insertion Sort](sorting_algorithms/insertion_sort,sorting_algorithms/all_elements_equal/insertion_sort,sorting_algorithms/reverse-sorted_values/insertion_sort,sorting_algorithms/single_values/insertion_sort,sorting_algorithms/empty_input/insertion_sort,sorting_algorithms/large_input/insertion_sort) + Find the correct position in the sorted sequence for the next value, one value at a time. + + Implement the following function using suitable C++ standard library algorithms: + ```c++ + void insertion_sort(std::vector::iterator begin, + std::vector::iterator end) { /* ... */ } + ``` + +3. [task][Quicksort](sorting_algorithms/quicksort,sorting_algorithms/all_elements_equal/quicksort,sorting_algorithms/reverse-sorted_values/quicksort,sorting_algorithms/single_values/quicksort,sorting_algorithms/empty_input/quicksort,sorting_algorithms/large_input/quicksort) + Quicksort chooses a single element (called _pivot_ `p`) from the input and partitions the + remaining elements into $$ \le p $$ and $$ \gt p $$, with the pivot placed between them. + + ```c++ + void quicksort(std::vector::iterator begin, + std::vector::iterator end) { /* .. */ } + ``` + + Don't forget to catch the base case (sorting 0 or 1 elements)! + +4. [task][Mergesort](sorting_algorithms/mergesort,sorting_algorithms/all_elements_equal/mergesort,sorting_algorithms/reverse-sorted_values/mergesort,sorting_algorithms/single_values/mergesort,sorting_algorithms/empty_input/mergesort,sorting_algorithms/large_input/mergesort) + Split the input into 2 equal-sized halves, call `mergesort` on them and then merge/interleave + the two sorted halves using an appropriate algorithm with linear time complexity. + + ```c++ + void mergesort(std::vector::iterator begin, + std::vector::iterator end) { /* ... */ } + ``` + + Don't forget to catch the base case (sorting 0 or 1 elements)! + +5. [task][Mergesort Inplace](sorting_algorithms/mergesort_inplace,sorting_algorithms/all_elements_equal/mergesort_inplace,sorting_algorithms/reverse-sorted_values/mergesort_inplace,sorting_algorithms/single_values/mergesort_inplace,sorting_algorithms/empty_input/mergesort_inplace,sorting_algorithms/large_input/mergesort_inplace) + Split the input into 2 equal-sized halves, call `mergesort_inplace` on them and then merge/interleave + the two sorted halves using an appropriate algorithm without allocating additional memory. + + ```c++ + void mergesort_inplace(std::vector::iterator begin, + std::vector::iterator end) { /* ... */ } + ``` + + Don't forget to catch the base case (sorting 0 or 1 elements)! + +6. [task][Heapsort](sorting_algorithms/heapsort,sorting_algorithms/all_elements_equal/heapsort,sorting_algorithms/reverse-sorted_values/heapsort,sorting_algorithms/single_values/heapsort,sorting_algorithms/empty_input/heapsort,sorting_algorithms/large_input/heapsort) + Construct a heap from the input. Then sort it with an appropriate algorithm. + + ```c++ + void heapsort(std::vector::iterator begin, + std::vector::iterator end) { /* ... */ } + ``` + +7. [task][Explicit Heapsort](sorting_algorithms/heapsort_explicit,sorting_algorithms/all_elements_equal/heapsort_explicit,sorting_algorithms/reverse-sorted_values/heapsort_explicit,sorting_algorithms/single_values/heapsort_explicit,sorting_algorithms/empty_input/heapsort_explicit,sorting_algorithms/large_input/heapsort_explicit) + Implement Heapsort without using `sort_heap`. + You do not need to understand the details of the algorithm. You should only look at the + documentation for heap algorithms. For example, refer to + [cppreference.com: `sort_heap`](https://en.cppreference.com/w/cpp/algorithm/sort_heap) + and figure out which algorithms need to be called. + + ```c++ + void heapsort_explicit(std::vector::iterator begin, + std::vector::iterator end) { /* ... */ } + ``` + +8. [task][Bogosort](bogosort,bogosort/empty_input,bogosort/single_value) + As long as the vector is not sorted, randomly shuffle the entire vector. + Alternatively, you can deterministically try all permutations until the vector is sorted. + + ```c++ + void bogosort(std::vector::iterator begin, + std::vector::iterator end) { /* ... */ } + ``` diff --git a/src/main/resources/templates/c_plus_plus/solution/.clang-format b/src/main/resources/templates/c_plus_plus/solution/.clang-format new file mode 100644 index 000000000000..541e6dca6c50 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/solution/.clang-format @@ -0,0 +1,4 @@ +--- +Language: Cpp +BasedOnStyle: Google +IncludeBlocks: Preserve diff --git a/src/main/resources/templates/c_plus_plus/solution/.gitattributes b/src/main/resources/templates/c_plus_plus/solution/.gitattributes new file mode 100644 index 000000000000..0e4a9089ed6e --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/solution/.gitattributes @@ -0,0 +1,39 @@ +# Source: https://github.com/gitattributes/gitattributes/blob/master/C%2B%2B.gitattributes (01.09.2024) + +# Sources +*.c text diff=cpp +*.cc text diff=cpp +*.cxx text diff=cpp +*.cpp text diff=cpp +*.cpi text diff=cpp +*.c++ text diff=cpp +*.hpp text diff=cpp +*.h text diff=cpp +*.h++ text diff=cpp +*.hh text diff=cpp + +# Compiled Object files +*.slo binary +*.lo binary +*.o binary +*.obj binary + +# Precompiled Headers +*.gch binary +*.pch binary + +# Compiled Dynamic libraries +*.so binary +*.dylib binary +*.dll binary + +# Compiled Static libraries +*.lai binary +*.la binary +*.a binary +*.lib binary + +# Executables +*.exe binary +*.out binary +*.app binary diff --git a/src/main/resources/templates/c_plus_plus/solution/.gitignore b/src/main/resources/templates/c_plus_plus/solution/.gitignore new file mode 100644 index 000000000000..62f60adbb914 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/solution/.gitignore @@ -0,0 +1,4 @@ +cmake-build-*/ + +.vscode/ +.idea/ diff --git a/src/main/resources/templates/c_plus_plus/solution/CMakeLists.txt b/src/main/resources/templates/c_plus_plus/solution/CMakeLists.txt new file mode 100644 index 000000000000..1a01a44252aa --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/solution/CMakeLists.txt @@ -0,0 +1,11 @@ +cmake_minimum_required(VERSION 3.13) +project(ArtemisExercise) + +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +add_library(assignment src/sort.cpp) +target_include_directories(assignment PUBLIC include) + +add_executable(assignment_main src/main.cpp) +target_link_libraries(assignment_main assignment) diff --git a/src/main/resources/templates/c_plus_plus/solution/include/sort.hpp b/src/main/resources/templates/c_plus_plus/solution/include/sort.hpp new file mode 100644 index 000000000000..886fc4aeba92 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/solution/include/sort.hpp @@ -0,0 +1,25 @@ +#pragma once + +#include + +void selection_sort(std::vector::iterator begin, + std::vector::iterator end); + +void insertion_sort(std::vector::iterator begin, + std::vector::iterator end); + +void quicksort(std::vector::iterator begin, + std::vector::iterator end); + +void mergesort(std::vector::iterator begin, + std::vector::iterator end); + +void mergesort_inplace(std::vector::iterator begin, + std::vector::iterator end); + +void heapsort(std::vector::iterator begin, std::vector::iterator end); + +void heapsort_explicit(std::vector::iterator begin, + std::vector::iterator end); + +void bogosort(std::vector::iterator begin, std::vector::iterator end); diff --git a/src/main/resources/templates/c_plus_plus/solution/src/main.cpp b/src/main/resources/templates/c_plus_plus/solution/src/main.cpp new file mode 100644 index 000000000000..16b651caade9 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/solution/src/main.cpp @@ -0,0 +1,5 @@ +#include "sort.hpp" + +int main() { + // Test your implementation here +} diff --git a/src/main/resources/templates/c_plus_plus/solution/src/sort.cpp b/src/main/resources/templates/c_plus_plus/solution/src/sort.cpp new file mode 100644 index 000000000000..2e091fae5c4d --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/solution/src/sort.cpp @@ -0,0 +1,82 @@ +#include "sort.hpp" + +#include +#include +#include + +void selection_sort(std::vector::iterator begin, + std::vector::iterator end) { + for (auto it = begin; it != end; ++it) { + auto min = std::min_element(it, end); + // std::iter_swap(min, it); // unstable + std::rotate(it, min, min + 1); + } +} + +void insertion_sort(std::vector::iterator begin, + std::vector::iterator end) { + for (auto it = begin; it != end; ++it) { + auto insertion_pos = std::upper_bound(begin, it, *it); + std::rotate(insertion_pos, it, it + 1); + } +} + +void quicksort(std::vector::iterator begin, + std::vector::iterator end) { + if (end - begin <= 1) { + return; + } + auto pivot = *begin; + auto middle = + std::partition(begin + 1, end, [pivot](int i) { return i < pivot; }); + auto new_middle = std::rotate(begin, begin + 1, middle); + quicksort(begin, new_middle); + quicksort(new_middle + 1, end); +} + +void mergesort(std::vector::iterator begin, + std::vector::iterator end) { + auto length = end - begin; + if (length <= 1) { + return; + } + std::vector tmp(begin, end); + auto middle = tmp.begin() + length / 2; + mergesort(tmp.begin(), middle); + mergesort(middle, tmp.end()); + std::merge(tmp.begin(), middle, middle, tmp.end(), begin); +} + +void mergesort_inplace(std::vector::iterator begin, + std::vector::iterator end) { + auto length = end - begin; + if (length <= 1) { + return; + } + auto middle = begin + length / 2; + mergesort_inplace(begin, middle); + mergesort_inplace(middle, end); + std::inplace_merge(begin, middle, end); +} + +void heapsort(std::vector::iterator begin, + std::vector::iterator end) { + std::make_heap(begin, end); + std::sort_heap(begin, end); +} + +void heapsort_explicit(std::vector::iterator begin, + std::vector::iterator end) { + std::make_heap(begin, end); + while (end != begin) { + std::pop_heap(begin, end); + --end; + } +} + +void bogosort(std::vector::iterator begin, + std::vector::iterator end) { + while (!std::is_sorted(begin, end)) { + std::next_permutation(begin, end); + } +} diff --git a/src/main/resources/templates/c_plus_plus/test/.clang-format b/src/main/resources/templates/c_plus_plus/test/.clang-format new file mode 100644 index 000000000000..541e6dca6c50 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/.clang-format @@ -0,0 +1,4 @@ +--- +Language: Cpp +BasedOnStyle: Google +IncludeBlocks: Preserve diff --git a/src/main/resources/templates/c_plus_plus/test/.gitattributes b/src/main/resources/templates/c_plus_plus/test/.gitattributes new file mode 100644 index 000000000000..0e4a9089ed6e --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/.gitattributes @@ -0,0 +1,39 @@ +# Source: https://github.com/gitattributes/gitattributes/blob/master/C%2B%2B.gitattributes (01.09.2024) + +# Sources +*.c text diff=cpp +*.cc text diff=cpp +*.cxx text diff=cpp +*.cpp text diff=cpp +*.cpi text diff=cpp +*.c++ text diff=cpp +*.hpp text diff=cpp +*.h text diff=cpp +*.h++ text diff=cpp +*.hh text diff=cpp + +# Compiled Object files +*.slo binary +*.lo binary +*.o binary +*.obj binary + +# Precompiled Headers +*.gch binary +*.pch binary + +# Compiled Dynamic libraries +*.so binary +*.dylib binary +*.dll binary + +# Compiled Static libraries +*.lai binary +*.la binary +*.a binary +*.lib binary + +# Executables +*.exe binary +*.out binary +*.app binary diff --git a/src/main/resources/templates/c_plus_plus/test/.gitignore b/src/main/resources/templates/c_plus_plus/test/.gitignore new file mode 100644 index 000000000000..d779962e6971 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/.gitignore @@ -0,0 +1,10 @@ +/${studentParentWorkingDirectoryName}/ +/test-reports/ +/build/ + +cmake-build-*/ + +.vscode/ +.idea/ + +__pycache__/ diff --git a/src/main/resources/templates/c_plus_plus/test/CMakeLists.txt b/src/main/resources/templates/c_plus_plus/test/CMakeLists.txt new file mode 100644 index 000000000000..fe378768d813 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/CMakeLists.txt @@ -0,0 +1,14 @@ +cmake_minimum_required(VERSION 3.13) +project(ArtemisTest) +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +include(CTest) + +find_package(Catch2 3.0 REQUIRED) + +add_subdirectory("${studentParentWorkingDirectoryName}") + +add_executable(sort-test src/sort-test.cpp) +target_link_libraries(sort-test assignment Catch2::Catch2WithMain) +add_test(NAME sort-test COMMAND sort-test) diff --git a/src/main/resources/templates/c_plus_plus/test/Tests.py b/src/main/resources/templates/c_plus_plus/test/Tests.py new file mode 100755 index 000000000000..1c062fef90fe --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/Tests.py @@ -0,0 +1,32 @@ +#!/usr/bin/env python3 + +from tests.TestCompile import TestCompile +from tests.TestConfigure import TestConfigure +from tests.TestCatch2 import TestCatch2 +from testUtils.Tester import Tester + + +def main() -> None: + # Create a new instance of the tester: + tester: Tester = Tester() + + buildDir = "./build" + + # Register all test cases: + # Configure: + testConfigure: TestConfigure = TestConfigure(".", buildDir, + ["-DCMAKE_BUILD_TYPE=Debug", + "-DCMAKE_CXX_FLAGS=-fsanitize=address", + "-DCMAKE_EXE_LINKER_FLAGS=-fsanitize=address"]) + tester.addTest(testConfigure) + tester.addTest(TestCompile(buildDir, "sort-test", requirements=[testConfigure.name], name="CompileSort")) + tester.addTest(TestCatch2(buildDir, "sort-test", ["CompileSort"])) + + # Run the actual tests: + tester.run() + # Export the results into the JUnit XML format: + tester.exportResult("./test-reports/tests-results.xml") + + +if __name__ == "__main__": + main() diff --git a/src/main/resources/templates/c_plus_plus/test/src/sort-test.cpp b/src/main/resources/templates/c_plus_plus/test/src/sort-test.cpp new file mode 100644 index 000000000000..6216ce9aa745 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/src/sort-test.cpp @@ -0,0 +1,122 @@ +#include "sort.hpp" + +#include +#include +#include +#include + +#include + +void run_all_algorithms(std::vector& values, + const std::vector& expected) { + SECTION("selection_sort") { + selection_sort(values.begin(), values.end()); + REQUIRE(values == expected); + } + SECTION("insertion_sort") { + insertion_sort(values.begin(), values.end()); + REQUIRE(values == expected); + } + SECTION("quicksort") { + quicksort(values.begin(), values.end()); + REQUIRE(values == expected); + } + SECTION("mergesort") { + mergesort(values.begin(), values.end()); + REQUIRE(values == expected); + } + SECTION("mergesort_inplace") { + mergesort_inplace(values.begin(), values.end()); + REQUIRE(values == expected); + } + SECTION("heapsort") { + heapsort(values.begin(), values.end()); + REQUIRE(values == expected); + } + SECTION("heapsort_explicit") { + heapsort_explicit(values.begin(), values.end()); + REQUIRE(values == expected); + } +} + +TEST_CASE("sorting_algorithms") { + std::vector values{6, 2, 4, 2, 1, 7, 0, 2, 3, 4, 8}; + std::vector expected{0, 1, 2, 2, 2, 3, 4, 4, 6, 7, 8}; + + run_all_algorithms(values, expected); +} + +TEST_CASE("sorting_algorithms/all_elements_equal") { + std::vector values(20, 1); + auto expected = values; + + // just to make sure your code doesn't crash on repeated values + run_all_algorithms(values, expected); +} + +TEST_CASE("sorting_algorithms/reverse-sorted_values") { + std::vector values(20, 1); + std::iota(values.begin(), values.end(), 0); + auto expected = values; + std::reverse(values.begin(), values.end()); + + run_all_algorithms(values, expected); +} + +TEST_CASE("sorting_algorithms/single_values") { + std::vector values{4}; + std::vector expected{4}; + + // just to make sure your code doesn't crash on single values + run_all_algorithms(values, expected); +} + +TEST_CASE("sorting_algorithms/empty_input") { + std::vector values; + std::vector expected; + + // just to make sure your code doesn't crash on empty inputs + run_all_algorithms(values, expected); +} + +TEST_CASE("sorting_algorithms/large_input") { + std::vector values; + std::uniform_int_distribution dist{0, 50}; + std::default_random_engine rng; // default seed + for (int i = 0; i < 100; ++i) { + values.push_back(dist(rng)); + } + auto expected = values; + std::sort(expected.begin(), expected.end()); + + run_all_algorithms(values, expected); +} + +TEST_CASE("bogosort") { + // bogosort only works for very small inputs, + // large inputs take forever + std::vector values{6, 2, 4, 2}; + std::vector expected{2, 2, 4, 6}; + + bogosort(values.begin(), values.end()); + + REQUIRE(values == expected); +} + +TEST_CASE("bogosort/empty_input") { + std::vector values{}; + std::vector expected{}; + + bogosort(values.begin(), values.end()); + + REQUIRE(values == expected); +} + +TEST_CASE("bogosort/single_value") { + std::vector values{3}; + std::vector expected{3}; + + bogosort(values.begin(), values.end()); + + REQUIRE(values == expected); +} diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/AbstractProgramTest.py b/src/main/resources/templates/c_plus_plus/test/testUtils/AbstractProgramTest.py new file mode 100644 index 000000000000..5c080913c17c --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/AbstractProgramTest.py @@ -0,0 +1,42 @@ +from typing import List, Optional + +from testUtils.AbstractTest import AbstractTest +from testUtils.Utils import PWrap + + +class AbstractProgramTest(AbstractTest): + """ + A abstract test that every test executing an external program has to inherit from. + How to: + 1. Inherit from AbstractProgramTest + 2. Override the "_run()" method. + 3. Done + """ + + # Our process wrapper instance: + pWrap: Optional[PWrap] + # The location of the executable: + executionDirectory: str + # The name of the executable that should get executed: + executable: str + + def __init__(self, name: str, executionDirectory: str, executable: str, requirements: List[str] = None, timeoutSec: int = -1): + super(AbstractProgramTest, self).__init__(name, requirements, timeoutSec) + self.executionDirectory: str = executionDirectory + self.executable: str = executable + self.pWrap: Optional[PWrap] = None + + def _onTimeout(self): + self._terminateProgramm() + + def _onFailed(self): + self._terminateProgramm() + + def _terminateProgramm(self): + if self.pWrap: + if not self.pWrap.hasTerminated(): + self.pWrap.kill() + self.pWrap.cleanup() + + def _progTerminatedUnexpectedly(self): + self._failWith("Program terminated unexpectedly.") diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/AbstractTest.py b/src/main/resources/templates/c_plus_plus/test/testUtils/AbstractTest.py new file mode 100644 index 000000000000..18040680de98 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/AbstractTest.py @@ -0,0 +1,269 @@ +from abc import ABC, abstractmethod +from contextlib import contextmanager, suppress +from datetime import datetime, timedelta +from os import makedirs, path +from signal import alarm, SIG_IGN, SIGALRM, signal +from traceback import print_exc +from typing import Dict, List, Optional, NoReturn +from xml.etree import ElementTree as Et + +from testUtils.junit.TestCase import Result, TestCase +from testUtils.junit.TestSuite import TestSuite +from testUtils.TestFailedError import TestFailedError +from testUtils.Utils import printTester, PWrap + + +# Timeout handler based on: https://www.jujens.eu/posts/en/2018/Jun/02/python-timeout-function/ +class AbstractTest(ABC): + """ + An abstract test that every test has to inherit from. + How to: + 1. Inherit from AbstractTest + 2. Override the "_run()" method. + 3. Override the "_onTimeout()" method. + 4. Override the "_onFailed()" method. + 5. Done + """ + + name: str + requirements: List[str] + timeoutSec: int + case: Optional[TestCase] + suite: Optional[TestSuite] + additionalSuites: List[Et.Element] + + def __init__(self, name: str, requirements: Optional[List[str]] = None, timeoutSec: int = -1) -> None: + """ + name: str + An unique test case name. + + requirements: List[str] + A list of test cases names that have to finish successfully for this test to run. + Usually an execution test should have the compile test as its requirement. + + timeoutSec: int + The test case timeout in seconds, + """ + + self.name = name + self.timeoutSec = timeoutSec + self.requirements = [] if requirements is None else requirements + + self.case: Optional[TestCase] = None + self.suite: Optional[TestSuite] = None + + def start(self, testResults: Dict[str, Result], suite: TestSuite, additionalSuites: List[TestSuite]) -> None: + """ + Starts the test run. + + --- + + testResults: Dict[str, Result] + All test results up to this point. + + suite: TestSuite + The test suite where this test should get added to. + """ + + self.suite = suite + self.additionalSuites = additionalSuites + self.case = TestCase(self.name) + + # Check if all test requirements (other tests) are fulfilled: + if not self.__checkTestRequirements(testResults): + printTester(f"Skipping test case '{self.name}' not all requirements ({self.requirements!s}) are fulfilled") + self.case.message = f"Test requires other test cases to succeed first ({self.requirements!s})" + self.case.result = Result.SKIPPED + self.case.stdout = "" + self.case.stderr = "" + self.case.time = timedelta() + self.suite.addCase(self.case) + return + + startTime: datetime = datetime.now() + + self._initOutputDirectory() + + if self.timeoutSec > 0: + # Run with timeout: + with self.__timeout(self.timeoutSec): + try: + self._run() + except TestFailedError: + printTester(f"'{self.name}' failed.") + except TimeoutError: + self._timeout() + except Exception as e: + self.__markAsFailed(f"'{self.name}' had an internal error. {e}.\nPlease report this to an instructor!") + print_exc() + self._onFailed() + else: + # Run without timeout: + try: + self._run() + except TestFailedError: + printTester(f"'{self.name}' failed.") + except Exception as e: + self.__markAsFailed(f"'{self.name}' had an internal error. {e}.\nPlease report this to an instructor!") + print_exc() + self._onFailed() + + self.case.time = datetime.now() - startTime + self.suite.addCase(self.case) + + def __checkTestRequirements(self, testResults: Dict[str, Result]) -> bool: + """ + Checks if all requirements (i.e. other test cases were successful) are fulfilled. + """ + + return all(testResults.get(req) == Result.SUCCESS for req in self.requirements) + + @contextmanager + def __timeout(self, timeoutSec: int): + # Register a function to raise a TimeoutError on the signal. + signal(SIGALRM, self.__raiseTimeout) + # Schedule the signal to be sent after ``time``. + alarm(timeoutSec) + + with suppress(TimeoutError): + yield + # Unregister the signal so it won't be triggered + # if the timeout is not reached. + signal(SIGALRM, SIG_IGN) + + def __raiseTimeout(self, _sigNum: int, _frame) -> NoReturn: + self._onTimeout() + raise TimeoutError + + def _failWith(self, msg: str) -> NoReturn: + """ + Marks the current test as failed with the given message. + Stores the complete stderr and stdout output from the run. + """ + + self.__markAsFailed(msg) + self._onFailed() + raise TestFailedError(f"{self.name} failed.") + + def __markAsFailed(self, msg: str) -> None: + """ + Marks the current test case as failed and loads all stdout and stderr. + """ + + self.case.message = msg + self.case.result = Result.FAILURE + self.case.stdout = self._loadFullStdout() + self.case.stderr = self._loadFullStderr() + printTester(f"Test {self.name} failed with: {msg}") + + def _timeout(self, msg: str = "") -> None: + """ + Marks the current test as failed with the given optional message. + Stores the complete stderr and stdout output from the run. + Should be called once a test timeout occurred. + """ + + if msg: + self.__markAsFailed(f"timeout ({msg})") + else: + self.__markAsFailed("timeout") + + def __loadFileContent(self, filePath: str) -> str: + """ + Returns the content of a file specified by filePath as string. + """ + if path.exists(filePath) and path.isfile(filePath): + with open(filePath, "r") as file: + content: str = file.read() + return content + return "" + + def _loadFullStdout(self) -> str: + """ + Returns the stdout output of the executable. + """ + filePath: str = self._getStdoutFilePath() + return self.__loadFileContent(filePath) + + def _loadFullStderr(self) -> str: + """ + Returns the stderr output of the executable. + """ + + filePath: str = self._getStderrFilePath() + return self.__loadFileContent(filePath) + + def _initOutputDirectory(self) -> None: + """ + Prepares the output directory for the stderr and stdout files. + """ + outDir: str = self._getOutputPath() + if path.exists(outDir) and path.isdir(outDir): + return + makedirs(outDir) + + def _getOutputPath(self) -> str: + """ + Returns the output path for temporary stuff like the stderr and stdout files. + """ + + return path.join("/tmp", self.suite.name, self.name) + + def _getStdoutFilePath(self) -> str: + """ + Returns the path of the stdout cache file. + """ + + return path.join(self._getOutputPath(), "stdout.txt") + + def _getStderrFilePath(self) -> str: + """ + Returns the path of the stderr cache file. + """ + + return path.join(self._getOutputPath(), "stderr.txt") + + def _createPWrap(self, cmd: List[str], cwd: Optional[str] = None) -> PWrap: + """ + Creates a new PWrap instance from the given command. + """ + + return PWrap(cmd, self._getStdoutFilePath(), self._getStderrFilePath(), cwd=cwd) + + def _startPWrap(self, pWrap: PWrap) -> None: + """ + Starts the PWrap execution. + Handles FileNotFoundError if, for example, the executable was not found or does not exist. + """ + + try: + pWrap.start() + except FileNotFoundError as fe: + printTester(str(fe)) + self._failWith("File not found for execution. Did compiling fail?") + except NotADirectoryError as de: + printTester(str(de)) + self._failWith(f"Directory '{pWrap.cwd}' does not exist.") + except PermissionError as pe: + printTester(str(pe)) + self._failWith("Missing file execution permission. Make sure it has execute rights (chmod +x ).") + + @abstractmethod + def _run(self): + """ + Implement your test run here. + """ + + @abstractmethod + def _onTimeout(self): + """ + Called once a timeout occurs. + Should cancel all outstanding actions and free all resources. + """ + + @abstractmethod + def _onFailed(self): + """ + Called once the test failed via "_failWith(msg: str)". + Should cancel all outstanding actions and free all allocated resources. + """ diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/TestFailedError.py b/src/main/resources/templates/c_plus_plus/test/testUtils/TestFailedError.py new file mode 100644 index 000000000000..00ac65a80ce8 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/TestFailedError.py @@ -0,0 +1,6 @@ +class TestFailedError(Exception): + """ + Raised when a test failed. + """ + + pass diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/Tester.py b/src/main/resources/templates/c_plus_plus/test/testUtils/Tester.py new file mode 100644 index 000000000000..eae56143c44e --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/Tester.py @@ -0,0 +1,81 @@ +from typing import Dict, List + +from testUtils.AbstractTest import AbstractTest +from testUtils.junit.Junit import Junit +from testUtils.junit.TestCase import Result +from testUtils.junit.TestSuite import TestSuite +from xml.etree import ElementTree as Et +from testUtils.Utils import clearTesterOutputCache, getTesterOutput, printTester, resetStdoutLimit, setStdoutLimitEnabled + + +class Tester: + name: str + suite: TestSuite + additionalSuites: List[Et.Element] + tests: Dict[str, AbstractTest] + + def __init__(self, name: str = "GBS-Tester-1.36") -> None: + self.name = name + self.suite = TestSuite(name) + self.additionalSuites = [] + self.tests = {} + + def run(self) -> None: + """ + Starts the tester and runs all tests added via "addTest(test: AbstractTest)". + """ + + setStdoutLimitEnabled(False) + printTester(f"Running: {self.name}") + + # A dictionary of test results: + # Test name -> result + testResults: Dict[str, Result] = {} + + for name, test in self.tests.items(): + if test.timeoutSec >= 0: + printTester(f"Running test case '{name}' with a {test.timeoutSec} second timeout...") + else: + printTester(f"Running test case '{name}' with no timeout...") + + # Reset the tester output cache: + resetStdoutLimit() + setStdoutLimitEnabled(True) + clearTesterOutputCache() + + test.start(testResults, self.suite, self.additionalSuites) + + setStdoutLimitEnabled(False) + printTester(f"Finished test case '{name}' in {test.case.time.total_seconds()} seconds.") + + # Store the tester output in the test case: + test.case.testerOutput = self.name + "\n" + getTesterOutput() + # Update test results: + testResults[name] = test.case.result + self.__printResult() + + def addTest(self, test: AbstractTest) -> None: + """ + Adds a new test that will be run once "run()" is invoked. + """ + + if test.name in self.tests: + raise ValueError(f"Test '{test.name}' already registered. Test names should be unique!") + self.tests[test.name] = test + + def __printResult(self) -> None: + print("Result".center(50, "=")) + print(f"{self.name} finished {len(self.tests)} test cases in {self.suite.time.total_seconds()} seconds.") + print(f"SUCCESS: {self.suite.successful}") + print(f"FAILED: {self.suite.failures}") + print(f"ERROR: {self.suite.errors}") + print(f"SKIPPED: {self.suite.skipped}") + print("".center(50, "=")) + + def exportResult(self, outputPath: str) -> None: + """ + Exports the test results into a JUnit format and stores it at the given outputPath. + """ + + junit: Junit = Junit(self.suite, self.additionalSuites) + junit.toXml(outputPath) diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/Utils.py b/src/main/resources/templates/c_plus_plus/test/testUtils/Utils.py new file mode 100644 index 000000000000..25c28bb4553e --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/Utils.py @@ -0,0 +1,532 @@ +import os +import select +import signal +from datetime import datetime +from io import TextIOWrapper +from pty import openpty +from pwd import getpwnam, struct_passwd +from subprocess import Popen +from termios import ONLCR, tcgetattr, TCSANOW, tcsetattr +from threading import Thread +from time import sleep +from typing import Any, Dict, List, Optional + + +def studSaveStrComp(ref: str, other: str, strip: bool = True, ignoreCase: bool = True, ignoreNonAlNum=True): + """ + Student save compare between strings. + Converts both to lower, strips them and removes all non alphanumeric chars + before comparison. + """ + # Strip: + if strip: + ref = ref.strip() + other = other.strip() + + # Convert to lower + if ignoreCase: + ref = ref.lower() + other = other.lower() + + # Remove all non alphanumeric chars: + if ignoreNonAlNum: + ref = "".join(c for c in ref if c.isalnum()) + other = "".join(c for c in other if c.isalnum()) + + # print("Ref: {}\nOther:{}".format(ref, other)) + return ref == other + + +def recursive_chmod(path: str, mode: int): + """ + Recursively changes file permissions. + """ + os.chmod(path, mode) + # print("CHMOD: {}".format(path)) + f: str + for f in os.listdir(path): + f = os.path.join(path, f) + if os.path.isdir(f): + recursive_chmod(f, mode) + else: + os.chmod(f, mode) + # print("CHMOD: {}".format(f)) + + +# Limit for stdout in chars. +# Should prevent to much output on artemis if for example there is a loop in a tree. +# By default the stdout limit is disabled: +__stdoutLimitEnabled: bool = False + + +def resetStdoutLimit(limit: int = 15000): + """ + Resets the stout limit to the given limit (default = 15.000 chars). + """ + global stdoutCharsLeft # Required since we want to modify stdoutCharsLeft + stdoutCharsLeft = limit + + +def setStdoutLimitEnabled(enabled: bool): + """ + Enables or disables the stdout limit. + Does not restet the chars left! + """ + global __stdoutLimitEnabled + __stdoutLimitEnabled = enabled + + +def __printStdout(text: str): + """ + Prints the given text to stdout. + Only if there are still enough chars in stdoutCharsLeft left. + Else will not print anything. + """ + global stdoutCharsLeft # Required since we want to modify stdoutCharsLeft + + if not __stdoutLimitEnabled: + print(text) + elif stdoutCharsLeft > 0: + if stdoutCharsLeft >= len(text): + print(text) + else: + print(text[:stdoutCharsLeft] + "...") + stdoutCharsLeft -= len(text) + if stdoutCharsLeft <= 0: + print("[STDOUT LIMIT REACHED]".center(50, "=")) + + +# A cache of all that the tester has been writing to stdout: +testerOutputCache: List[str] = list() + + +def clearTesterOutputCache(): + """ + Clears the testerOutputCache. + """ + testerOutputCache.clear() + + +def getTesterOutput(): + """ + Returns the complete tester output as a single string. + """ + return "\n".join(testerOutputCache) + + +startTime: datetime = datetime.now() + + +def __getCurSeconds(): + """ + Returns the total seconds passed, since the tester started as a string with a precision of two digits. + """ + seconds: float = (datetime.now() - startTime).total_seconds() + return str(round(seconds, 2)) + + +def __getCurDateTimeStr(): + """ + Returns the current date and time string (e.g. 11.10.2019_17:02:33) + """ + return datetime.now().strftime("%d.%m.%Y_%H:%M:%S") + + +def printTester(text: str, addToCache: bool = True): + """ + Prints the given string with the '[T]: ' tag in front. + Should be used instead of print() to make it easier for students + to determine what came from the tester and what from their program. + """ + msg: str = f"[{__getCurSeconds()}][T]: {text}" + __printStdout(msg) + if addToCache: + testerOutputCache.append(msg) + + +def printProg(text: str, addToCache: bool = True): + """ + Prints the given string with the '[P]: ' tag in front. + Should be used instead of print() to make it easier for students + to determine what came from the tester and what from their program. + """ + msg: str = f"[{__getCurSeconds()}][P]: {text.rstrip()}" + __printStdout(msg) + if addToCache: + testerOutputCache.append(msg) + + +def shortenText(text: str, maxNumChars: int): + """ + Shortens the given text to a maximum number of chars. + If there are more chars than specified in maxNumChars, + it will append: "\n[And {} chars more...]". + """ + + if len(text) > maxNumChars: + s: str = f"\n[And {len(text) - maxNumChars} chars more...]" + l: int = maxNumChars - len(s) + if l > 0: + return f"{text[:l]}{s}" + else: + printTester(f"Unable to limit output to {maxNumChars} chars! Not enough space.", False) + return "" + return text + + +class ReadCache(Thread): + """ + Helper class that makes sure we only get one line (separated by '\n') + if we read multiple lines at once. + """ + + __cacheList: List[str] + __cacheFile: TextIOWrapper + + __outFd: int + __outSlaveFd: int + + def __init__(self, filePath: str): + Thread.__init__(self) + self.__cacheList = [] + self.__cacheFile = open(filePath, "w") + + # Emulate a terminal: + self.__outFd, self.__outSlaveFd = openpty() + + self.start() + + def fileno(self): + return self.__outFd + + def join(self, timeout: float = None): + try: + os.close(self.__outFd) + except OSError as e: + printTester(f"Closing stdout FD failed with: {e}") + try: + os.close(self.__outSlaveFd) + except OSError as e: + printTester(f"Closing stdout slave FD failed with: {e}") + Thread.join(self, timeout) + + @staticmethod + def __isFdValid(fd: int): + try: + os.stat(fd) + except OSError: + return False + return True + + @staticmethod + def __decode(data: bytes): + """ + Tries to decode the given string as UTF8. + In case this fails, it will fall back to ASCII encoding. + Returns the decoded result. + + --- + + data: bytes + The data that should be decoded. + """ + try: + return data.decode("utf8", "replace") + except UnicodeDecodeError as e: + printTester(f"Failed to decode line as utf8. Using ascii ecoding - {e}") + return data.decode("ascii", "replace") + + def run(self): + pollObj = select.poll() + pollObj.register(self.__outSlaveFd, select.POLLIN) + while self.__isFdValid(self.__outSlaveFd): + try: + for fd, mask in pollObj.poll(100): + if fd != self.__outSlaveFd: + continue + if mask & (select.POLLHUP | select.POLLERR | select.POLLNVAL): + return + if mask & select.POLLIN: + data: bytes = os.read(self.__outSlaveFd, 4096) + dataStr: str = self.__decode(data) + try: + self.__cacheFile.write(dataStr) + except UnicodeEncodeError: + printTester("Invalid ASCII character read. Skipping line...") + continue + self.__cacheFile.flush() + self.__cache(dataStr) + printProg(dataStr) + except OSError: + break + + def canReadLine(self): + return len(self.__cacheList) > 0 + + def __cache(self, data: str): + self.__cacheList.extend(data.splitlines(True)) + + def readLine(self): + if self.canReadLine(): + return self.__cacheList.pop(0) + return "" + + +class PWrap: + """ + A wrapper for "Popen". + """ + + cmd: List[str] + prog: Optional[Popen] + cwd: str + + __stdinFd: int + __stdinMasterFd: int + + __stdOutLineCache: ReadCache + __stdErrLineCache: ReadCache + + __terminatedTime: Optional[datetime] + + def __init__(self, cmd: List[str], stdoutFilePath: str = "/tmp/stdout.txt", stderrFilePath: str = "/tmp/stderr.txt", cwd: Optional[str] = None): + self.cmd = cmd + self.prog = None + self.cwd: str = os.getcwd() if cwd is None else cwd + self.stdout = open(stdoutFilePath, "wb") + self.stderr = open(stderrFilePath, "wb") + + self.__stdOutLineCache = ReadCache(stdoutFilePath) + self.__stdErrLineCache = ReadCache(stderrFilePath) + + self.__terminatedTime = None + + def __del__(self): + try: + os.close(self.__stdinFd) + except OSError as e: + printTester(f"Closing stdin FD failed with: {e}") + except AttributeError: + pass + try: + os.close(self.__stdinMasterFd) + except OSError as e: + printTester(f"Closing stdin master FD failed with: {e}") + except AttributeError: + pass + + def start(self, userName: Optional[str] = None): + """ + Starts the process and sets all file descriptors to nonblocking. + + --- + + userName: Optional[str] = None + In case the userName is not None, the process will be executed as the given userName. + This requires root privileges and you have to ensure the user has the required rights to access all resources (files). + """ + # Emulate a terminal for stdin: + self.__stdinMasterFd, self.__stdinFd = openpty() + + # Transform "\r\n" to '\n' for data send to stdin: + tsettings: List[Any] = tcgetattr(self.__stdinFd) + tsettings[1] &= ~ONLCR + tcsetattr(self.__stdinFd, TCSANOW, tsettings) + + if userName is not None: + # Check for root privileges: + self.__checkForRootPrivileges() + + # Prepare environment: + pwRecord: struct_passwd = getpwnam(userName) + env: Dict[str, str] = os.environ.copy() + env["HOME"] = pwRecord.pw_dir + env["LOGNAME"] = pwRecord.pw_name + env["USER"] = pwRecord.pw_name + env["PWD"] = self.cwd + printTester(f"Starting process as: {pwRecord.pw_name}") + + # Start the actual process: + self.prog = Popen( + self.cmd, + stdout=self.__stdOutLineCache.fileno(), + stdin=self.__stdinMasterFd, + stderr=self.__stdErrLineCache.fileno(), + universal_newlines=True, + cwd=self.cwd, + env=env, + preexec_fn=self.__demote(pwRecord.pw_uid, pwRecord.pw_gid, pwRecord.pw_name), + ) + else: + # Start the actual process: + self.prog = Popen( + self.cmd, + stdout=self.__stdOutLineCache.fileno(), + stdin=self.__stdinMasterFd, + stderr=self.__stdErrLineCache.fileno(), + universal_newlines=True, + cwd=self.cwd, + preexec_fn=os.setsid, + ) # Make sure we store the process group id + + def __demote(self, userUid: int, userGid: int, userName: str): + """ + Returns a call, demoting the calling process to the given user, UID and GID. + """ + + def result(): + # self.__printIds("Starting demotion...") # Will print inside the new process and reports via the __stdOutLineCache + os.initgroups(userName, userGid) + os.setuid(userUid) + # self.__printIds("Finished demotion.") # Will print inside the new process and reports via the __stdOutLineCache + + return result + + @staticmethod + def __checkForRootPrivileges(): + """ + Checks if the current process has root permissions. + Fails if not. + """ + if os.geteuid() != 0: + raise PermissionError("The tester has to be executed as root to be able to switch users!") + + def __printIds(self, msg: str): + printTester(f"uid, gid = {os.getuid()}, {os.getgid()}; {msg}") + + def __readLine(self, lineCache: ReadCache, blocking: bool): + """ + Reads a single line from the given ReadCache and returns it. + + --- + + blocking: + When set to True will only return if the process terminated or we read a non empty string. + """ + while blocking: + if not lineCache.canReadLine(): + if not self.hasTerminated(): + sleep(0.1) + else: + break + else: + line: str = lineCache.readLine() + return line + return "" + + def readLineStdout(self, blocking: bool = True): + """ + Reads a single line from the processes stdout and returns it. + + --- + + blocking: + When set to True will only return if the process terminated or we read a non empty string. + """ + return self.__readLine(self.__stdOutLineCache, blocking) + + def canReadLineStdout(self): + """ + Returns whether there is a line from the processes stdout that can be read. + """ + return self.__stdOutLineCache.canReadLine() + + def readLineStderr(self, blocking: bool = True): + """ + Reads a single line from the processes stderr and returns it. + + --- + + blocking: + When set to True will only return if the process terminated or we read a non empty string. + """ + return self.__readLine(self.__stdErrLineCache, blocking) + + def canReadLineStderr(self): + """ + Returns whether there is a line from the processes stderr that can be read. + """ + return self.__stdErrLineCache.canReadLine() + + def writeStdin(self, data: str): + """ + Writes the given data string to the processes stdin. + """ + os.write(self.__stdinFd, data.encode()) + printTester(f"Wrote: {data}") + + def hasTerminated(self): + """ + Returns whether the process has terminated. + """ + if self.prog is None: + return True + + # Make sure we wait 1.0 seconds after the process has terminated to + # make sure all the output arrived: + elif self.prog.poll() is not None: + if self.__terminatedTime: + if (datetime.now() - self.__terminatedTime).total_seconds() > 1.0: + return True + else: + self.__terminatedTime = datetime.now() + return False + + def getReturnCode(self): + """ + Returns the returncode of the terminated process else None. + """ + return self.prog.returncode + + def waitUntilTerminationReading(self, secs: float = -1): + """ + Waits until termination of the process and tries to read until either + the process terminated or the timeout occurred. + + Returns True if the process terminated before the timeout occurred, + else False. + + --- + + secs: + The timeout in seconds. Values < 0 result in infinity. + """ + start: datetime = datetime.now() + while True: + if self.hasTerminated(): + return True + elif 0 <= secs <= (datetime.now() - start).total_seconds(): + return False + self.readLineStdout(False) + sleep(0.1) + + def kill(self, signal: int = signal.SIGKILL): + """ + Sends the given signal to the complete process group started by the process. + + Returns True if the process existed and had to be killed. Else False. + + --- + + signal: + The signal that should be sent to the process group started by the process. + """ + # Send a signal to the complete process group: + try: + os.killpg(os.getpgid(self.prog.pid), signal) + return True + except ProcessLookupError: + printTester("No need to kill process. Process does not exist any more.") + return False + + def cleanup(self): + """ + Should be called once the execution has terminated. + Will join the stdout and stderr reader threads. + """ + + self.__stdOutLineCache.join() + self.__stdErrLineCache.join() + + def getPID(self): + return self.prog.pid diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/junit/Junit.py b/src/main/resources/templates/c_plus_plus/test/testUtils/junit/Junit.py new file mode 100644 index 000000000000..12aaa288889b --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/junit/Junit.py @@ -0,0 +1,33 @@ +from os import chmod, makedirs, path +from typing import Tuple, List +from xml.etree import ElementTree as Et + +from testUtils.junit.TestSuite import TestSuite + + +# JUnit format: https://github.com/junit-team/junit5/blob/master/platform-tests/src/test/resources/jenkins-junit.xsd +class Junit: + suite: TestSuite + additionalSuites: List[Et.Element] + + def __init__(self, suite: TestSuite, additionalSuites: List[Et.Element]) -> None: + self.suite = suite + self.additionalSuites = additionalSuites + + def toXml(self, outputPath: str) -> None: + suiteXml: Et.Element = self.suite.toXml() + root: Et.Element = Et.Element("testsuites") + root.append(suiteXml) + root.extend(self.additionalSuites) + tree: Et.ElementTree = Et.ElementTree(root) + self.createOutputPath(outputPath) + tree.write(outputPath, xml_declaration=True) + # Ensure nobody can edit our results: + chmod(outputPath, 0o644) + + @staticmethod + def createOutputPath(outputPath: str) -> None: + paths: Tuple[str, str] = path.split(outputPath) + if paths[0] and not path.exists(paths[0]): + # Prevent others from writing in this folder: + makedirs(paths[0], mode=0o755) diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/junit/TestCase.py b/src/main/resources/templates/c_plus_plus/test/testUtils/junit/TestCase.py new file mode 100644 index 000000000000..8bb7e1392bc7 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/junit/TestCase.py @@ -0,0 +1,75 @@ +from datetime import timedelta +from enum import Enum +from xml.etree import ElementTree as Et + +from testUtils.Utils import shortenText + + +class Result(Enum): + SKIPPED = "skipped" + ERROR = "error" + FAILURE = "failure" + SUCCESS = "success" + + +class TestCase: + stdout: str + stderr: str + testerOutput: str + + name: str + time: timedelta + result: Result + message: str + + def __init__(self, name: str) -> None: + self.name = name + + self.stdout: str = "" + self.stderr: str = "" + self.testerOutput: str = "" + self.time: timedelta = timedelta() + self.result: Result = Result.SUCCESS + self.message: str = "" + + def toXml(self, suite: Et.Element, maxCharsPerOutput: int = 2500) -> None: + case: Et.Element = Et.SubElement(suite, "testcase") + case.set("name", self.name) + case.set("time", str(self.time.total_seconds())) + + if self.result != Result.SUCCESS: + result: Et.Element = Et.SubElement(case, self.result.value) + result.set("message", self.message) + result.text = self.genErrFailureMessage() + + if self.stdout: + stdout: Et.Element = Et.SubElement(case, "system-out") + stdout.text = shortenText(self.stdout, maxCharsPerOutput) + "\n" + if self.stderr: + stderr: Et.Element = Et.SubElement(case, "system-err") + stderr.text = shortenText(self.stderr, maxCharsPerOutput) + "\n" + + def genErrFailureMessage(self, maxChars: int = 5000) -> str: + oneThird: int = maxChars // 3 + + # Limit the stderr output to one third of the available chars: + stderrMsg: str = "\n" + "stderr".center(50, "=") + "\n" + if self.stderr: + stderrMsg += shortenText(self.stderr, oneThird) + "\n" + else: + stderrMsg += "No output on stderr found!\n" + + # Limit the stdout output to one third + the unused chars from the stderr output: + stdoutMsg: str = "\n" + "stdout".center(50, "=") + "\n" + if self.stdout: + stdoutMsg += shortenText(self.stdout, oneThird + (oneThird - len(stderrMsg))) + "\n" + else: + stdoutMsg += "No output on stdout found!\n" + + # Limit the tester output to one third + the left overs from stderr and stdout: + testerMsg: str = "\n" + "Tester".center(50, "=") + "\n" + if self.testerOutput: + testerMsg += shortenText(self.testerOutput, maxChars - len(testerMsg) - len(stderrMsg) - len(stdoutMsg)) + "\n" + else: + testerMsg += "No tester output found!\n" + return self.message + stdoutMsg + stderrMsg + testerMsg diff --git a/src/main/resources/templates/c_plus_plus/test/testUtils/junit/TestSuite.py b/src/main/resources/templates/c_plus_plus/test/testUtils/junit/TestSuite.py new file mode 100644 index 000000000000..0acc513c744b --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/testUtils/junit/TestSuite.py @@ -0,0 +1,55 @@ +from datetime import timedelta +from typing import Dict +from xml.etree import ElementTree as Et + +from testUtils.junit.TestCase import Result, TestCase + + +class TestSuite: + __cases: Dict[str, TestCase] + + name: str + tests: int + failures: int + errors: int + skipped: int + successful: int + time: timedelta + + def __init__(self, name: str): + self.name = name + + self.__cases: Dict[str, TestCase] = dict() + self.tests: int = 0 + self.failures: int = 0 + self.errors: int = 0 + self.skipped: int = 0 + self.successful: int = 0 + self.time: timedelta = timedelta() + + def addCase(self, case: TestCase): + self.__cases[case.name] = case + self.tests += 1 + self.time += case.time + + if case.result == Result.ERROR: + self.errors += 1 + elif case.result == Result.FAILURE: + self.failures += 1 + elif case.result == Result.SKIPPED: + self.skipped += 1 + else: + self.successful += 1 + + def toXml(self): + suite: Et.Element = Et.Element("testsuite") + suite.set("name", self.name) + suite.set("tests", str(self.tests)) + suite.set("failures", str(self.failures)) + suite.set("errors", str(self.errors)) + suite.set("skipped", str(self.skipped)) + suite.set("time", str(self.time.total_seconds())) + + for _name, case in self.__cases.items(): + case.toXml(suite) + return suite diff --git a/src/main/resources/templates/c_plus_plus/test/tests/TestCatch2.py b/src/main/resources/templates/c_plus_plus/test/tests/TestCatch2.py new file mode 100644 index 000000000000..4b2de70d2564 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/tests/TestCatch2.py @@ -0,0 +1,36 @@ +from os.path import join +from typing import List +from xml.etree import ElementTree as Et + +from testUtils.AbstractProgramTest import AbstractProgramTest +from testUtils.Utils import printTester + + +class TestCatch2(AbstractProgramTest): + def __init__(self, location: str, executable: str, requirements: List[str] | None = None, name: str | None = None) -> None: + super().__init__(name or f"TestCatch2({executable})", location, executable, requirements, timeoutSec=10) + + def _run(self) -> None: + # Start the program: + outputFilename = f"result-{self.executable}.xml" + self.pWrap = self._createPWrap([join(".", self.executable), "--success", "--reporter", f"JUnit::out={outputFilename}", "--reporter", "console::out=-::colour-mode=none"], self.executionDirectory) + self._startPWrap(self.pWrap) + self.pWrap.waitUntilTerminationReading() + + retCode: int = self.pWrap.getReturnCode() + # parse XML output and append it to the results + try: + catchXmlRoot: Et = Et.parse(join(self.executionDirectory, outputFilename)) + catchXmlSuite: Et.Element = catchXmlRoot.find("testsuite") + self.additionalSuites.append(catchXmlSuite) + printTester(f"Appended {catchXmlSuite}") + except Exception as e: + printTester(f"Exception {e}") + + if retCode != 0: + self._failWith( + f"Test for {self.executable} failed." + ) + + # Always cleanup to make sure all threads get joined: + self.pWrap.cleanup() diff --git a/src/main/resources/templates/c_plus_plus/test/tests/TestCompile.py b/src/main/resources/templates/c_plus_plus/test/tests/TestCompile.py new file mode 100644 index 000000000000..612380af0872 --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/tests/TestCompile.py @@ -0,0 +1,40 @@ +from typing import List + +from testUtils.AbstractProgramTest import AbstractProgramTest + + +class TestCompile(AbstractProgramTest): + """ + Test case that tries to compile the given program with any compiler optimization disabled. + Most compiler warnings are enabled but aren't treated as errors. + """ + + target: str + + def __init__( + self, + buildDir: str, + target: str = "all", + requirements: List[str] | None = None, + name: str = "TestCompile", + ) -> None: + super().__init__( + name, buildDir, "cmake", requirements, timeoutSec=10 + ) + self.target = target + + def _run(self) -> None: + # Build all targets: + self.pWrap = self._createPWrap([self.executable, "--build", self.executionDirectory, "--target", self.target]) + self._startPWrap(self.pWrap) + + self.pWrap.waitUntilTerminationReading() + + retCode: int = self.pWrap.getReturnCode() + if retCode != 0: + self._failWith( + f"Build for directory {self.executionDirectory} failed. Returncode is {retCode}." + ) + + # Always cleanup to make sure all threads get joined: + self.pWrap.cleanup() diff --git a/src/main/resources/templates/c_plus_plus/test/tests/TestConfigure.py b/src/main/resources/templates/c_plus_plus/test/tests/TestConfigure.py new file mode 100644 index 000000000000..6a74ed566b0b --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/tests/TestConfigure.py @@ -0,0 +1,49 @@ +from typing import List +import shutil +import os.path + +from testUtils.AbstractProgramTest import AbstractProgramTest + + +class TestConfigure(AbstractProgramTest): + """ + Test case that runs CMake to configure the build + """ + + buildDir: str + extraFlags: List[str] + + def __init__( + self, + location: str, + buildDir: str, + extraFlags: List[str] | None = None, + requirements: List[str] | None = None, + name: str = "TestConfigure", + ) -> None: + super().__init__( + name, location, "cmake", requirements, timeoutSec=10 + ) + self.buildDir = buildDir + self.extraFlags = extraFlags or [] + + def _run(self) -> None: + if os.path.exists(self.buildDir): + shutil.rmtree(self.buildDir) + # Call CMake to configure the project: + self.pWrap = self._createPWrap( + [self.executable, "-S", self.executionDirectory, "-B", self.buildDir, + *self.extraFlags] + ) + self._startPWrap(self.pWrap) + + self.pWrap.waitUntilTerminationReading() + + retCode: int = self.pWrap.getReturnCode() + if retCode != 0: + self._failWith( + f"CMake for directory {self.executionDirectory} failed. Returncode is {retCode}." + ) + + # Always cleanup to make sure all threads get joined: + self.pWrap.cleanup() diff --git a/src/main/resources/templates/c_plus_plus/test/tests/TestOutput.py b/src/main/resources/templates/c_plus_plus/test/tests/TestOutput.py new file mode 100644 index 000000000000..dfbc60fe28fa --- /dev/null +++ b/src/main/resources/templates/c_plus_plus/test/tests/TestOutput.py @@ -0,0 +1,39 @@ +from os.path import join +from typing import List + +from testUtils.AbstractProgramTest import AbstractProgramTest +from testUtils.Utils import printTester, studSaveStrComp + + +class TestOutput(AbstractProgramTest): + def __init__(self, makefileLocation: str, requirements: List[str] = None, name: str = "TestOutput", executable: str = "helloWorld.out"): + super(TestOutput, self).__init__(name, makefileLocation, executable, requirements, timeoutSec=10) + + def _run(self): + # Start the program: + self.pWrap = self._createPWrap([join(".", self.executionDirectory, self.executable)]) + self._startPWrap(self.pWrap) + + # Wait for child being ready: + printTester("Waiting for: 'Hello world!'") + expected: str = "Hello world!" + while True: + if self.pWrap.hasTerminated() and not self.pWrap.canReadLineStdout(): + self._progTerminatedUnexpectedly() + # Read a single line form the program output: + line: str = self.pWrap.readLineStdout() + # Perform a "student save" compare: + if studSaveStrComp(expected, line): + break + else: + printTester(f"Expected '{expected}' but received read '{line}'") + + # Wait reading until the program terminates: + printTester("Waiting for the program to terminate...") + if not self.pWrap.waitUntilTerminationReading(3): + printTester("Program did not terminate - killing it!") + self.pWrap.kill() + self._failWith("Program did not terminate at the end.") + + # Always cleanup to make sure all threads get joined: + self.pWrap.cleanup() diff --git a/src/main/resources/templates/jenkins/c_plus_plus/regularRuns/pipeline.groovy b/src/main/resources/templates/jenkins/c_plus_plus/regularRuns/pipeline.groovy new file mode 100644 index 000000000000..d9bc3bbf4a27 --- /dev/null +++ b/src/main/resources/templates/jenkins/c_plus_plus/regularRuns/pipeline.groovy @@ -0,0 +1,81 @@ +/* + * This file configures the actual build steps for the automatic grading. + * + * !!! + * For regular exercises, there is no need to make changes to this file. + * Only this base configuration is actively supported by the Artemis maintainers + * and/or your Artemis instance administrators. + * !!! + */ + +dockerImage = '#dockerImage' +dockerFlags = '#dockerArgs' + +/** + * Main function called by Jenkins. + */ +void testRunner() { + docker.image(dockerImage).inside(dockerFlags) { c -> + runTestSteps() + } +} + +private void runTestSteps() { + test() +} + +/** + * Run unit tests + */ +private void test() { + stage('Setup') { + sh ''' + mkdir test-reports + + # Updating ownership... + chown -R artemis_user:artemis_user . + + REQ_FILE=requirements.txt + if [ -f "$REQ_FILE" ]; then + python3 -m venv /venv + /venv/bin/pip3 install -r "$REQ_FILE" + else + echo "$REQ_FILE does not exist" + fi + ''' + } + + stage('Compile and Test') { + sh ''' + if [ -d /venv ]; then + . /venv/bin/activate + fi + + # Run tests as unprivileged user + runuser -u artemis_user python3 Tests.py + ''' + } +} + +/** + * Script of the post build tasks aggregating all JUnit files in $WORKSPACE/results. + * + * Called by Jenkins. + */ +void postBuildTasks() { + sh ''' + if [ -e test-reports/tests-results.xml ] + then + sed -i 's/[^[:print:]\t]/�/g' test-reports/tests-results.xml + sed -i 's//<\\/error>/g' test-reports/tests-results.xml + sed -i 's/]*>//g ; s/<\\/testsuites>/<\\/testsuite>/g' test-reports/tests-results.xml + fi + rm -rf results + mv test-reports results + ''' +} + +// very important, do not remove +// required so that Jenkins finds the methods defined in this script +return this diff --git a/src/main/webapp/app/admin/metrics/metrics.model.ts b/src/main/webapp/app/admin/metrics/metrics.model.ts index dbed33af6fc7..cc476415b8ad 100644 --- a/src/main/webapp/app/admin/metrics/metrics.model.ts +++ b/src/main/webapp/app/admin/metrics/metrics.model.ts @@ -83,6 +83,7 @@ export interface Services { export enum HttpMethod { Post = 'POST', Get = 'GET', + Put = 'PUT', Delete = 'DELETE', Patch = 'PATCH', } diff --git a/src/main/webapp/app/course/competencies/competency-management/competency-management.component.html b/src/main/webapp/app/course/competencies/competency-management/competency-management.component.html index 889576aa7830..e541845c4ede 100644 --- a/src/main/webapp/app/course/competencies/competency-management/competency-management.component.html +++ b/src/main/webapp/app/course/competencies/competency-management/competency-management.component.html @@ -1,7 +1,12 @@

-

- +
+

+ +
@if (irisCompetencyGenerationEnabled) { diff --git a/src/main/webapp/app/course/competencies/competency-management/competency-management.component.ts b/src/main/webapp/app/course/competencies/competency-management/competency-management.component.ts index ca7ce5bdd1d7..7aad7d529594 100644 --- a/src/main/webapp/app/course/competencies/competency-management/competency-management.component.ts +++ b/src/main/webapp/app/course/competencies/competency-management/competency-management.component.ts @@ -13,7 +13,7 @@ import { } from 'app/entities/competency.model'; import { onError } from 'app/shared/util/global.utils'; import { Subject, Subscription } from 'rxjs'; -import { faFileImport, faPencilAlt, faPlus, faRobot, faTrash } from '@fortawesome/free-solid-svg-icons'; +import { faCircleQuestion, faFileImport, faPencilAlt, faPlus, faRobot, faTrash } from '@fortawesome/free-solid-svg-icons'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { DocumentationType } from 'app/shared/components/documentation-button/documentation-button.component'; import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; @@ -28,6 +28,7 @@ import { ImportAllCourseCompetenciesResult, } from 'app/course/competencies/components/import-all-course-competencies-modal/import-all-course-competencies-modal.component'; import { CourseCompetencyApiService } from 'app/course/competencies/services/course-competency-api.service'; +import { CourseCompetencyExplanationModalComponent } from 'app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component'; @Component({ selector: 'jhi-competency-management', @@ -53,6 +54,7 @@ export class CompetencyManagementComponent implements OnInit, OnDestroy { protected readonly faTrash = faTrash; protected readonly faPencilAlt = faPencilAlt; protected readonly faRobot = faRobot; + protected readonly faCircleQuestion = faCircleQuestion; // other constants readonly getIcon = getIcon; @@ -60,14 +62,14 @@ export class CompetencyManagementComponent implements OnInit, OnDestroy { readonly CourseCompetencyType = CourseCompetencyType; // Injected services - private readonly activatedRoute: ActivatedRoute = inject(ActivatedRoute); - private readonly courseCompetencyApiService: CourseCompetencyApiService = inject(CourseCompetencyApiService); - private readonly alertService: AlertService = inject(AlertService); - private readonly modalService: NgbModal = inject(NgbModal); - private readonly profileService: ProfileService = inject(ProfileService); - private readonly irisSettingsService: IrisSettingsService = inject(IrisSettingsService); - private readonly translateService: TranslateService = inject(TranslateService); - private readonly featureToggleService: FeatureToggleService = inject(FeatureToggleService); + private readonly activatedRoute = inject(ActivatedRoute); + private readonly courseCompetencyApiService = inject(CourseCompetencyApiService); + private readonly alertService = inject(AlertService); + private readonly modalService = inject(NgbModal); + private readonly profileService = inject(ProfileService); + private readonly irisSettingsService = inject(IrisSettingsService); + private readonly translateService = inject(TranslateService); + private readonly featureToggleService = inject(FeatureToggleService); ngOnInit(): void { this.activatedRoute.parent!.params.subscribe(async (params) => { @@ -75,6 +77,11 @@ export class CompetencyManagementComponent implements OnInit, OnDestroy { await this.loadData(); this.loadIrisEnabled(); }); + const lastVisit = sessionStorage.getItem('lastTimeVisitedCourseCompetencyExplanation'); + if (!lastVisit) { + this.openCourseCompetencyExplanation(); + } + sessionStorage.setItem('lastTimeVisitedCourseCompetencyExplanation', Date.now().toString()); this.standardizedCompetencySubscription = this.featureToggleService.getFeatureToggleActive(FeatureToggle.StandardizedCompetencies).subscribe((isActive) => { this.standardizedCompetenciesEnabled = isActive; }); @@ -229,4 +236,12 @@ export class CompetencyManagementComponent implements OnInit, OnDestroy { this.relations = this.relations.filter((relation) => relation.tailCompetency?.id !== competencyId && relation.headCompetency?.id !== competencyId); this.courseCompetencies = this.competencies.concat(this.prerequisites); } + + openCourseCompetencyExplanation(): void { + this.modalService.open(CourseCompetencyExplanationModalComponent, { + size: 'xl', + backdrop: 'static', + windowClass: 'course-competency-explanation-modal', + }); + } } diff --git a/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html b/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html new file mode 100644 index 000000000000..1215b5f095af --- /dev/null +++ b/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.html @@ -0,0 +1,62 @@ +
+
+
+ + +
+
+
+
+
+
+

+

+ +
+

+

+
+
+
+
+

+

+

+

+
+ How to create a course competency +
+

+
+
+
+
+

+ +

+

+

+
+ How to create a course competency +
+
+
+

+

+

+
+
+
+

+

+

+
+
+
+

+

+

+
+
+
+
diff --git a/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.scss b/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.scss new file mode 100644 index 000000000000..91fd4bf8bd19 --- /dev/null +++ b/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.scss @@ -0,0 +1,12 @@ +.explanation-model-gif { + display: block; + max-width: 800px; + margin: 0 auto; // Centers the container horizontally + + img { + width: 100%; // Makes both GIFs responsive + height: auto; // Maintains aspect ratio + display: block; // Centers the image horizontally + margin: 0 auto; + } +} diff --git a/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.ts b/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.ts new file mode 100644 index 000000000000..8cd333d439f3 --- /dev/null +++ b/src/main/webapp/app/course/competencies/components/course-competency-explanation-modal/course-competency-explanation-modal.component.ts @@ -0,0 +1,25 @@ +import { Component, inject } from '@angular/core'; +import { FontAwesomeModule } from '@fortawesome/angular-fontawesome'; +import { faXmark } from '@fortawesome/free-solid-svg-icons'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { CompetencyGraphComponent } from 'app/course/learning-paths/components/competency-graph/competency-graph.component'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; + +@Component({ + selector: 'jhi-course-competency-explanation-modal', + standalone: true, + imports: [CompetencyGraphComponent, TranslateDirective, FontAwesomeModule], + templateUrl: './course-competency-explanation-modal.component.html', + styleUrl: './course-competency-explanation-modal.component.scss', +}) +export class CourseCompetencyExplanationModalComponent { + protected readonly closeIcon = faXmark; + + protected readonly DOCUMENTATION_LINK = 'https://docs.artemis.cit.tum.de/user/adaptive-learning/'; + + private readonly activeModal = inject(NgbActiveModal); + + protected closeModal(): void { + this.activeModal.close(); + } +} diff --git a/src/main/webapp/app/course/learning-paths/components/competency-graph-modal/competency-graph-modal.component.ts b/src/main/webapp/app/course/learning-paths/components/competency-graph-modal/competency-graph-modal.component.ts index 8dfd9971432e..ac7a27af9f09 100644 --- a/src/main/webapp/app/course/learning-paths/components/competency-graph-modal/competency-graph-modal.component.ts +++ b/src/main/webapp/app/course/learning-paths/components/competency-graph-modal/competency-graph-modal.component.ts @@ -1,7 +1,7 @@ import { Component, effect, inject, input, signal } from '@angular/core'; import { FontAwesomeModule, IconDefinition } from '@fortawesome/angular-fontawesome'; import { faXmark } from '@fortawesome/free-solid-svg-icons'; -import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { NgbActiveModal, NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { CompetencyGraphComponent } from 'app/course/learning-paths/components/competency-graph/competency-graph.component'; import { ArtemisSharedModule } from 'app/shared/shared.module'; import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; @@ -46,4 +46,13 @@ export class CompetencyGraphModalComponent { closeModal(): void { this.activeModal.close(); } + + static openCompetencyGraphModal(modalService: NgbModal, learningPathId: number): void { + const modalRef = modalService.open(CompetencyGraphModalComponent, { + size: 'xl', + backdrop: 'static', + windowClass: 'competency-graph-modal', + }); + modalRef.componentInstance.learningPathId = signal(learningPathId); + } } diff --git a/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.html b/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.html index 77bb3e447289..3c546d22b01d 100644 --- a/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.html +++ b/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.html @@ -1,9 +1,11 @@
- - @if (valueType() === CompetencyGraphNodeValueType.MASTERY_PROGRESS) { + @if (valueType() === CompetencyGraphNodeValueType.MASTERY_PROGRESS || valueType() === CompetencyGraphNodeValueType.AVERAGE_MASTERY_PROGRESS) { {{ value() }} % + } @else { + {{ value() }} } diff --git a/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.ts b/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.ts index 2ff110c01954..5365bb22387b 100644 --- a/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.ts +++ b/src/main/webapp/app/course/learning-paths/components/competency-node/competency-node.component.ts @@ -46,6 +46,7 @@ export class CompetencyNodeComponent implements AfterViewInit { isYellow(): boolean { switch (this.valueType()) { case CompetencyGraphNodeValueType.MASTERY_PROGRESS: + case CompetencyGraphNodeValueType.AVERAGE_MASTERY_PROGRESS: return this.value() > 0 && this.value() < 100; default: return false; @@ -55,6 +56,7 @@ export class CompetencyNodeComponent implements AfterViewInit { isGray(): boolean { switch (this.valueType()) { case CompetencyGraphNodeValueType.MASTERY_PROGRESS: + case CompetencyGraphNodeValueType.AVERAGE_MASTERY_PROGRESS: return this.value() === 0; default: return false; diff --git a/src/main/webapp/app/course/learning-paths/components/learning-path-nav-overview/learning-path-nav-overview.component.ts b/src/main/webapp/app/course/learning-paths/components/learning-path-nav-overview/learning-path-nav-overview.component.ts index a63830f98bc7..07722fb3d0e7 100644 --- a/src/main/webapp/app/course/learning-paths/components/learning-path-nav-overview/learning-path-nav-overview.component.ts +++ b/src/main/webapp/app/course/learning-paths/components/learning-path-nav-overview/learning-path-nav-overview.component.ts @@ -61,11 +61,6 @@ export class LearningPathNavOverviewComponent { } openCompetencyGraph(): void { - const modalRef = this.modalService.open(CompetencyGraphModalComponent, { - size: 'xl', - backdrop: 'static', - windowClass: 'competency-graph-modal', - }); - modalRef.componentInstance.learningPathId = this.learningPathId; + CompetencyGraphModalComponent.openCompetencyGraphModal(this.modalService, this.learningPathId()); } } diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.html b/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.html new file mode 100644 index 000000000000..86d03a787e5d --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.html @@ -0,0 +1,27 @@ +
+
+
+
+
+ +
+
+ @if (isLoading()) { +
+ +
+ } @else if (instructorCompetencyGraph()) { + + } +
+
+
+ + +
+ + +
+ diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.scss b/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.scss new file mode 100644 index 000000000000..64570aa984c9 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.scss @@ -0,0 +1,7 @@ +.learning-paths-analytics-container { + height: 500px; + + .learning-paths-analytics-graph-selection-container { + border-right: var(--bs-border-width) solid var(--border-color); + } +} diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.ts b/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.ts new file mode 100644 index 000000000000..41a8261eb206 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component.ts @@ -0,0 +1,44 @@ +import { Component, effect, inject, input, signal } from '@angular/core'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { CompetencyGraphDTO, CompetencyGraphNodeValueType } from 'app/entities/competency/learning-path.model'; +import { AlertService } from 'app/core/util/alert.service'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { CompetencyGraphComponent } from 'app/course/learning-paths/components/competency-graph/competency-graph.component'; +import { onError } from 'app/shared/util/global.utils'; + +@Component({ + selector: 'jhi-learning-paths-analytics', + standalone: true, + imports: [ArtemisSharedCommonModule, CompetencyGraphComponent], + templateUrl: './learning-paths-analytics.component.html', + styleUrl: './learning-paths-analytics.component.scss', +}) +export class LearningPathsAnalyticsComponent { + protected readonly CompetencyGraphNodeValueType = CompetencyGraphNodeValueType; + + private readonly learningPathApiService = inject(LearningPathApiService); + private readonly alertService = inject(AlertService); + + readonly courseId = input.required(); + + readonly isLoading = signal(false); + readonly instructorCompetencyGraph = signal(undefined); + + readonly valueSelection = signal(CompetencyGraphNodeValueType.AVERAGE_MASTERY_PROGRESS); + + constructor() { + effect(() => this.loadInstructionCompetencyGraph(this.courseId()), { allowSignalWrites: true }); + } + + private async loadInstructionCompetencyGraph(courseId: number): Promise { + try { + this.isLoading.set(true); + const instructorCompetencyGraph = await this.learningPathApiService.getLearningPathInstructorCompetencyGraph(courseId); + this.instructorCompetencyGraph.set(instructorCompetencyGraph); + } catch (error) { + onError(this.alertService, error); + } finally { + this.isLoading.set(false); + } + } +} diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component.html b/src/main/webapp/app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component.html new file mode 100644 index 000000000000..3edcb13c956f --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component.html @@ -0,0 +1,41 @@ +
+
+
+ @if (isEditMode()) { + + } @else { + + } +
+
+
+ @if (isConfigLoading()) { +
+ +
+ } @else { + + + + } +
+
diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component.ts b/src/main/webapp/app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component.ts new file mode 100644 index 000000000000..23e5cb8e8612 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component.ts @@ -0,0 +1,78 @@ +import { Component, computed, effect, inject, input, signal } from '@angular/core'; +import { FontAwesomeModule } from '@fortawesome/angular-fontawesome'; +import { faSpinner } from '@fortawesome/free-solid-svg-icons'; +import { LearningPathApiService } from '../../services/learning-path-api.service'; +import { LearningPathsConfigurationDTO } from 'app/entities/competency/learning-path.model'; +import { AlertService } from 'app/core/util/alert.service'; +import { onError } from 'app/shared/util/global.utils'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; + +@Component({ + selector: 'jhi-learning-paths-configuration', + standalone: true, + imports: [FontAwesomeModule, ArtemisSharedCommonModule, ArtemisSharedComponentModule], + templateUrl: './learning-paths-configuration.component.html', + styleUrls: ['../../pages/learning-path-instructor-page/learning-path-instructor-page.component.scss'], +}) +export class LearningPathsConfigurationComponent { + protected readonly faSpinner = faSpinner; + + private readonly learningPathApiService = inject(LearningPathApiService); + private readonly alertService = inject(AlertService); + + readonly courseId = input.required(); + + readonly isEditMode = signal(false); + readonly configHasBeenChanged = signal(false); + + readonly isConfigLoading = signal(false); + readonly isSaving = signal(false); + private readonly learningPathsConfiguration = signal(undefined); + readonly includeAllGradedExercisesEnabled = computed(() => this.learningPathsConfiguration()?.includeAllGradedExercises ?? false); + + constructor() { + effect(() => this.loadLearningPathsConfiguration(this.courseId()), { allowSignalWrites: true }); + } + + private async loadLearningPathsConfiguration(courseId: number): Promise { + try { + this.isConfigLoading.set(true); + const learningPathsConfiguration = await this.learningPathApiService.getLearningPathsConfiguration(courseId); + this.learningPathsConfiguration.set(learningPathsConfiguration); + } catch (error) { + onError(this.alertService, error); + } finally { + this.isConfigLoading.set(false); + } + } + + protected toggleIncludeAllGradedExercises(): void { + this.configHasBeenChanged.set(true); + this.learningPathsConfiguration.set({ + ...this.learningPathsConfiguration(), + includeAllGradedExercises: !this.includeAllGradedExercisesEnabled(), + }); + } + + protected async saveLearningPathsConfiguration(): Promise { + if (this.configHasBeenChanged()) { + try { + this.isSaving.set(true); + await this.learningPathApiService.updateLearningPathsConfiguration(this.courseId(), this.learningPathsConfiguration()!); + this.alertService.success('artemisApp.learningPathManagement.learningPathsConfiguration.saveSuccess'); + this.isEditMode.set(false); + } catch (error) { + onError(this.alertService, error); + } finally { + this.isSaving.set(false); + } + } else { + this.isEditMode.set(false); + } + } + + protected enableEditMode(): void { + this.isEditMode.set(true); + } +} diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.html b/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.html new file mode 100644 index 000000000000..cb2e0fb12c93 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.html @@ -0,0 +1,40 @@ +
+
+
+ +
+
+
+ @if (isLoading()) { +
+ +
+ } @else { + @for (healthState of learningPathHealthState(); let first = $first; track healthState) { +
+ +

+ +
+ } @empty { +
+ +
+ } + } +
+
diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.scss b/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.scss new file mode 100644 index 000000000000..6354cc0912ab --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.scss @@ -0,0 +1,18 @@ +@import 'bootstrap/scss/functions'; +@import 'bootstrap/scss/variables'; + +.learning-paths-state-container { + border-left: 2px solid $info; + + &.danger-state { + border-left-color: $danger; + } + + &.warning-state { + border-left-color: $warning; + } + + &.info-state { + border-left-color: $info; + } +} diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.ts b/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.ts new file mode 100644 index 000000000000..e5fc57092472 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-state/learning-paths-state.component.ts @@ -0,0 +1,85 @@ +import { Component, computed, effect, inject, input, signal } from '@angular/core'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { HealthStatus, LearningPathHealthDTO } from 'app/entities/competency/learning-path-health.model'; +import { AlertService } from 'app/core/util/alert.service'; +import { onError } from 'app/shared/util/global.utils'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { ActivatedRoute, Router } from '@angular/router'; +import { faSpinner } from '@fortawesome/free-solid-svg-icons'; + +@Component({ + selector: 'jhi-learning-paths-state', + standalone: true, + imports: [ArtemisSharedCommonModule], + templateUrl: './learning-paths-state.component.html', + styleUrls: ['./learning-paths-state.component.scss', '../../pages/learning-path-instructor-page/learning-path-instructor-page.component.scss'], +}) +export class LearningPathsStateComponent { + protected readonly faSpinner = faSpinner; + + private readonly baseTranslationKey = 'artemisApp.learningPathManagement.learningPathsState.type'; + readonly translationKeys: Record = { + [HealthStatus.MISSING]: `${this.baseTranslationKey}.missing`, + [HealthStatus.NO_COMPETENCIES]: `${this.baseTranslationKey}.noCompetencies`, + [HealthStatus.NO_RELATIONS]: `${this.baseTranslationKey}.noRelations`, + }; + + readonly stateCssClasses: Record = { + [HealthStatus.MISSING]: 'warning-state', + [HealthStatus.NO_COMPETENCIES]: 'danger-state', + [HealthStatus.NO_RELATIONS]: 'warning-state', + }; + + private readonly learningPathApiService = inject(LearningPathApiService); + private readonly alertService = inject(AlertService); + private readonly router = inject(Router); + private readonly activatedRoute = inject(ActivatedRoute); + + readonly courseId = input.required(); + + readonly isLoading = signal(false); + private readonly learningPathHealth = signal(undefined); + readonly learningPathHealthState = computed(() => this.learningPathHealth()?.status ?? []); + + constructor() { + effect(() => this.loadLearningPathHealthState(this.courseId()), { allowSignalWrites: true }); + } + + protected async loadLearningPathHealthState(courseId: number): Promise { + try { + this.isLoading.set(true); + const learningPathHealthState = await this.learningPathApiService.getLearningPathHealthStatus(courseId); + this.learningPathHealth.set(learningPathHealthState); + } catch (error) { + onError(this.alertService, error); + } finally { + this.isLoading.set(false); + } + } + + protected async handleHealthStateAction(healthState: HealthStatus): Promise { + switch (healthState) { + case HealthStatus.MISSING: + await this.generateMissingLearningPaths(); + break; + case HealthStatus.NO_COMPETENCIES: + case HealthStatus.NO_RELATIONS: + await this.navigateToManageCompetencyPage(); + break; + } + } + + private async navigateToManageCompetencyPage(): Promise { + await this.router.navigate(['../competency-management'], { relativeTo: this.activatedRoute }); + } + + private async generateMissingLearningPaths(): Promise { + try { + await this.learningPathApiService.generateMissingLearningPaths(this.courseId()); + this.alertService.success(`${this.baseTranslationKey}.missing.successAlert`); + await this.loadLearningPathHealthState(this.courseId()); + } catch (error) { + onError(this.alertService, error); + } + } +} diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.html b/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.html new file mode 100644 index 000000000000..4f4b23a690e0 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.html @@ -0,0 +1,66 @@ +
+
+
+
+ @if (isLoading()) { + + } + +
+
+
+
+
+ + + + + + + + + + + @for (learningPath of learningPaths(); track learningPath.id) { + + + + + + + } @empty { + + + + } + +
#
{{ learningPath.id }} + + + + + {{ learningPath.progress }} % +
+ +
+
+ +
+
diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.scss b/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.scss new file mode 100644 index 000000000000..e0a8bf4315b9 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.scss @@ -0,0 +1,18 @@ +.learning-paths-table-container { + height: 185px; + overflow-y: auto; + + table { + thead th { + position: sticky; + top: 0; + z-index: 1; + background: var(--bs-card-bg); + } + } +} + +.pagination { + height: 27px; + overflow-y: hidden; +} diff --git a/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.ts b/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.ts new file mode 100644 index 000000000000..3d5a50483faa --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/components/learning-paths-table/learning-paths-table.component.ts @@ -0,0 +1,94 @@ +import { Component, computed, effect, inject, input, signal, untracked } from '@angular/core'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { AlertService } from 'app/core/util/alert.service'; +import { LearningPathInformationDTO } from 'app/entities/competency/learning-path.model'; +import { SearchResult, SearchTermPageableSearch, SortingOrder } from 'app/shared/table/pageable-table'; +import { onError } from 'app/shared/util/global.utils'; +import { faSpinner } from '@fortawesome/free-solid-svg-icons'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { CompetencyGraphModalComponent } from 'app/course/learning-paths/components/competency-graph-modal/competency-graph-modal.component'; +import { BaseApiHttpService } from 'app/course/learning-paths/services/base-api-http.service'; + +enum TableColumn { + ID = 'ID', + USER_NAME = 'USER_NAME', + USER_LOGIN = 'USER_LOGIN', + PROGRESS = 'PROGRESS', +} + +@Component({ + selector: 'jhi-learning-paths-table', + standalone: true, + imports: [ArtemisSharedCommonModule], + templateUrl: './learning-paths-table.component.html', + styleUrls: ['./learning-paths-table.component.scss', '../../pages/learning-path-instructor-page/learning-path-instructor-page.component.scss'], +}) +export class LearningPathsTableComponent { + protected readonly faSpinner = faSpinner; + + private readonly learningPathApiService = inject(LearningPathApiService); + private readonly alertService = inject(AlertService); + private readonly modalService = inject(NgbModal); + + readonly courseId = input.required(); + + readonly isLoading = signal(false); + private readonly searchResults = signal | undefined>(undefined); + readonly learningPaths = computed(() => this.searchResults()?.resultsOnPage ?? []); + + readonly searchTerm = signal(''); + readonly page = signal(1); + private readonly sortingOrder = signal(SortingOrder.ASCENDING); + private readonly sortedColumn = signal(TableColumn.ID); + readonly pageSize = signal(100).asReadonly(); + readonly collectionSize = computed(() => (this.searchResults()?.numberOfPages ?? 1) * this.pageSize()); + + // Debounce the loadLearningPaths function to prevent multiple requests when the user types quickly + private readonly debounceLoadLearningPaths = BaseApiHttpService.debounce(this.loadLearningPaths.bind(this), 300); + + constructor() { + effect( + () => { + // Load learning paths whenever the courseId changes + const courseId = this.courseId(); + untracked(() => this.loadLearningPaths(courseId)); + }, + { allowSignalWrites: true }, + ); + } + + private async loadLearningPaths(courseId: number): Promise { + try { + this.isLoading.set(true); + const searchState = { + page: this.page(), + pageSize: this.pageSize(), + searchTerm: this.searchTerm(), + sortingOrder: this.sortingOrder(), + sortedColumn: this.sortedColumn(), + }; + const searchResults = await this.learningPathApiService.getLearningPathInformation(courseId, searchState); + this.searchResults.set(searchResults); + } catch (error) { + onError(this.alertService, error); + } finally { + this.isLoading.set(false); + } + } + + search(searchTerm: string): void { + this.searchTerm.set(searchTerm); + this.page.set(1); + this.debounceLoadLearningPaths(this.courseId()); + } + + async setPage(pageNumber: number): Promise { + this.page.set(pageNumber); + await this.loadLearningPaths(this.courseId()); + } + + openCompetencyGraph(learningPathId: number): void { + CompetencyGraphModalComponent.openCompetencyGraphModal(this.modalService, learningPathId); + } +} diff --git a/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.html b/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.html index c8a10304da15..fa2f5b75d63b 100644 --- a/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.html +++ b/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.html @@ -8,21 +8,19 @@ @if (!isLoading && health) {

- @if (health.status?.includes(HealthStatus.DISABLED)) { +
+
- -
- -
+
- } +
@if (health.status?.includes(HealthStatus.MISSING)) { } @@ -32,63 +30,61 @@

@if (health.status?.includes(HealthStatus.NO_RELATIONS)) { } - @if (!health.status?.includes(HealthStatus.DISABLED)) { -
-
- - - @if (searchLoading) { - - } -
- - - - - - - - +
+
+ + + @if (searchLoading) { + + } +
+
- # - - - - - - - - - - -
+ + + + + + + + + + + @for (learningPath of content.resultsOnPage; track trackId($index, learningPath)) { + + + + + + - - - @for (learningPath of content.resultsOnPage; track trackId($index, learningPath)) { - - - - - - - - } - -
+ # + + + + + + + + + + +
+ {{ learningPath.id }} + + + + + + + + +
- {{ learningPath.id }} - - - - - - - - -
-
- -
+ } + + +
+
- } +
} diff --git a/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.ts b/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.ts index e6f2eb495f5c..bff608a8cb93 100644 --- a/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.ts +++ b/src/main/webapp/app/course/learning-paths/learning-path-management/learning-path-management.component.ts @@ -135,10 +135,8 @@ export class LearningPathManagementComponent implements OnInit { .subscribe({ next: (res) => { this.health = res.body!; - if (!this.health.status?.includes(HealthStatus.DISABLED)) { - this.performSearch(this.sort, 0); - this.performSearch(this.search, 300); - } + this.performSearch(this.sort, 0); + this.performSearch(this.search, 300); }, error: (res: HttpErrorResponse) => onError(this.alertService, res), }); diff --git a/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.html b/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.html new file mode 100644 index 000000000000..09ad272a5bbe --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.html @@ -0,0 +1,39 @@ +@if (isLoading()) { +
+ +
+} @else if (learningPathsEnabled()) { +
+
+ + + + +
+ +
+
+ +
+
+
+ +
+
+} @else { +
+
+

+ + +
+
+} diff --git a/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.scss b/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.scss new file mode 100644 index 000000000000..be0c2625f1bd --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.scss @@ -0,0 +1,13 @@ +.enable-learning-paths-container { + max-width: 500px; + text-align: center; +} + +.learning-paths-container { + background: var(--bs-card-bg); +} + +.learning-paths-management-container { + max-height: 220px; + overflow-y: auto; +} diff --git a/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.ts b/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.ts new file mode 100644 index 000000000000..1dab247186e1 --- /dev/null +++ b/src/main/webapp/app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component.ts @@ -0,0 +1,62 @@ +import { Component, computed, effect, inject, signal } from '@angular/core'; +import { toSignal } from '@angular/core/rxjs-interop'; +import { ActivatedRoute } from '@angular/router'; +import { LearningPathsConfigurationComponent } from 'app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component'; +import { lastValueFrom, map } from 'rxjs'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { AlertService } from 'app/core/util/alert.service'; +import { onError } from 'app/shared/util/global.utils'; +import { Course } from 'app/entities/course.model'; +import { ArtemisSharedCommonModule } from 'app/shared/shared-common.module'; +import { LearningPathsStateComponent } from 'app/course/learning-paths/components/learning-paths-state/learning-paths-state.component'; +import { LearningPathsTableComponent } from 'app/course/learning-paths/components/learning-paths-table/learning-paths-table.component'; +import { CourseManagementService } from 'app/course/manage/course-management.service'; +import { LearningPathsAnalyticsComponent } from 'app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component'; + +@Component({ + selector: 'jhi-learning-path-instructor-page', + standalone: true, + imports: [LearningPathsConfigurationComponent, ArtemisSharedCommonModule, LearningPathsStateComponent, LearningPathsTableComponent, LearningPathsAnalyticsComponent], + templateUrl: './learning-path-instructor-page.component.html', + styleUrl: './learning-path-instructor-page.component.scss', +}) +export class LearningPathInstructorPageComponent { + private readonly activatedRoute = inject(ActivatedRoute); + private readonly learningPathApiService = inject(LearningPathApiService); + private readonly alertService = inject(AlertService); + private readonly courseManagementService = inject(CourseManagementService); + + readonly courseId = toSignal(this.activatedRoute.parent!.params.pipe(map((params) => Number(params.courseId))), { requireSync: true }); + private readonly course = signal(undefined); + readonly learningPathsEnabled = computed(() => this.course()?.learningPathsEnabled ?? false); + + readonly isLoading = signal(false); + + constructor() { + effect(() => this.loadCourse(this.courseId()), { allowSignalWrites: true }); + } + + private async loadCourse(courseId: number): Promise { + try { + this.isLoading.set(true); + const courseBody = await lastValueFrom(this.courseManagementService.findOneForDashboard(courseId)); + this.course.set(courseBody.body!); + } catch (error) { + onError(this.alertService, error); + } finally { + this.isLoading.set(false); + } + } + + protected async enableLearningPaths(): Promise { + try { + this.isLoading.set(true); + await this.learningPathApiService.enableLearningPaths(this.courseId()); + this.course.update((course) => ({ ...course!, learningPathsEnabled: true })); + } catch (error) { + onError(this.alertService, error); + } finally { + this.isLoading.set(false); + } + } +} diff --git a/src/main/webapp/app/course/learning-paths/services/base-api-http.service.ts b/src/main/webapp/app/course/learning-paths/services/base-api-http.service.ts index a5b5653ce442..898a2de8d301 100644 --- a/src/main/webapp/app/course/learning-paths/services/base-api-http.service.ts +++ b/src/main/webapp/app/course/learning-paths/services/base-api-http.service.ts @@ -2,6 +2,7 @@ import { HttpMethod } from 'app/admin/metrics/metrics.model'; import { inject } from '@angular/core'; import { HttpClient, HttpErrorResponse, HttpHeaders, HttpParams } from '@angular/common/http'; import { lastValueFrom } from 'rxjs'; +import { SearchTermPageableSearch } from 'app/shared/table/pageable-table'; export abstract class BaseApiHttpService { private readonly httpClient: HttpClient = inject(HttpClient); @@ -67,6 +68,22 @@ export abstract class BaseApiHttpService { } } + /** + * Creates a `HttpParams` object from the given `SearchTermPageableSearch` object. + * @param pageable The pageable object to create the `HttpParams` object from. + * @protected + * + * @return The `HttpParams` object. + */ + protected createHttpSearchParams(pageable: SearchTermPageableSearch): HttpParams { + return new HttpParams() + .set('pageSize', String(pageable.pageSize)) + .set('page', String(pageable.page)) + .set('sortingOrder', pageable.sortingOrder) + .set('searchTerm', pageable.searchTerm) + .set('sortedColumn', pageable.sortedColumn); + } + /** * Constructs a `GET` request that interprets the body as JSON and * returns a Promise of an object of type `T`. @@ -185,4 +202,34 @@ export abstract class BaseApiHttpService { ): Promise { return await this.request(HttpMethod.Patch, url, { body: body, ...options }); } + + /** + * Constructs a `PUT` request that interprets the body as JSON and + * returns a Promise of an object of type `T`. + * + * @param url The endpoint URL excluding the base server url (/api). + * @param body The content to include in the body of the request. + * @param options The HTTP options to send with the request. + * @protected + * + * @return A `Promise` of type `Object` (T), + */ + protected async put( + url: string, + body?: any, + options?: { + headers?: + | HttpHeaders + | { + [header: string]: string | string[]; + }; + params?: + | HttpParams + | { + [param: string]: string | number | boolean | ReadonlyArray; + }; + }, + ): Promise { + return await this.request(HttpMethod.Put, url, { body: body, ...options }); + } } diff --git a/src/main/webapp/app/course/learning-paths/services/learning-path-api.service.ts b/src/main/webapp/app/course/learning-paths/services/learning-path-api.service.ts index 01a43398f1c8..951927be0f8e 100644 --- a/src/main/webapp/app/course/learning-paths/services/learning-path-api.service.ts +++ b/src/main/webapp/app/course/learning-paths/services/learning-path-api.service.ts @@ -4,12 +4,16 @@ import { LearningObjectType, LearningPathCompetencyDTO, LearningPathDTO, + LearningPathInformationDTO, LearningPathNavigationDTO, LearningPathNavigationObjectDTO, LearningPathNavigationOverviewDTO, + LearningPathsConfigurationDTO, } from 'app/entities/competency/learning-path.model'; import { HttpParams } from '@angular/common/http'; import { BaseApiHttpService } from 'app/course/learning-paths/services/base-api-http.service'; +import { LearningPathHealthDTO } from 'app/entities/competency/learning-path-health.model'; +import { SearchResult, SearchTermPageableSearch } from 'app/shared/table/pageable-table'; @Injectable({ providedIn: 'root', @@ -52,6 +56,10 @@ export class LearningPathApiService extends BaseApiHttpService { return await this.get(`learning-path/${learningPathId}/competency-graph`); } + async getLearningPathInstructorCompetencyGraph(courseId: number): Promise { + return await this.get(`courses/${courseId}/learning-path/competency-instructor-graph`); + } + async getLearningPathCompetencies(learningPathId: number): Promise { return await this.get(`learning-path/${learningPathId}/competencies`); } @@ -59,4 +67,29 @@ export class LearningPathApiService extends BaseApiHttpService { async getLearningPathCompetencyLearningObjects(learningPathId: number, competencyId: number): Promise { return await this.get(`learning-path/${learningPathId}/competencies/${competencyId}/learning-objects`); } + + async getLearningPathsConfiguration(courseId: number): Promise { + return await this.get(`courses/${courseId}/learning-paths/configuration`); + } + + async getLearningPathHealthStatus(courseId: number): Promise { + return await this.get(`courses/${courseId}/learning-path-health`); + } + + async updateLearningPathsConfiguration(courseId: number, updatedLearningPathsConfiguration: LearningPathsConfigurationDTO): Promise { + await this.put(`courses/${courseId}/learning-paths/configuration`, updatedLearningPathsConfiguration); + } + + async enableLearningPaths(courseId: number): Promise { + await this.put(`courses/${courseId}/learning-paths/enable`); + } + + async generateMissingLearningPaths(courseId: number): Promise { + await this.put(`courses/${courseId}/learning-paths/generate-missing`); + } + + async getLearningPathInformation(courseId: number, pageable: SearchTermPageableSearch): Promise> { + const params = this.createHttpSearchParams(pageable); + return await this.get>(`courses/${courseId}/learning-paths`, { params }); + } } diff --git a/src/main/webapp/app/course/manage/course-management.route.ts b/src/main/webapp/app/course/manage/course-management.route.ts index ad4507123d1a..c85789f6d74e 100644 --- a/src/main/webapp/app/course/manage/course-management.route.ts +++ b/src/main/webapp/app/course/manage/course-management.route.ts @@ -22,7 +22,6 @@ import { CreateTutorialGroupsConfigurationComponent } from 'app/course/tutorial- import { CourseLtiConfigurationComponent } from 'app/course/manage/course-lti-configuration/course-lti-configuration.component'; import { EditCourseLtiConfigurationComponent } from 'app/course/manage/course-lti-configuration/edit-course-lti-configuration.component'; import { CourseManagementTabBarComponent } from 'app/course/manage/course-management-tab-bar/course-management-tab-bar.component'; -import { LearningPathManagementComponent } from 'app/course/learning-paths/learning-path-management/learning-path-management.component'; import { PendingChangesGuard } from 'app/shared/guard/pending-changes.guard'; import { BuildQueueComponent } from 'app/localci/build-queue/build-queue.component'; import { ImportCompetenciesComponent } from 'app/course/competencies/import/import-competencies.component'; @@ -33,6 +32,7 @@ import { ImportPrerequisitesComponent } from 'app/course/competencies/import/imp import { CreatePrerequisiteComponent } from 'app/course/competencies/create/create-prerequisite.component'; import { EditPrerequisiteComponent } from 'app/course/competencies/edit/edit-prerequisite.component'; import { CourseImportStandardizedPrerequisitesComponent } from 'app/course/competencies/import-standardized-competencies/course-import-standardized-prerequisites.component'; +import { LearningPathInstructorPageComponent } from 'app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component'; import { FaqComponent } from 'app/faq/faq.component'; import { FaqUpdateComponent } from 'app/faq/faq-update.component'; import { FaqResolve } from 'app/faq/faq.routes'; @@ -321,7 +321,7 @@ export const courseManagementState: Routes = [ }, { path: 'learning-path-management', - component: LearningPathManagementComponent, + component: LearningPathInstructorPageComponent, data: { authorities: [Authority.INSTRUCTOR, Authority.ADMIN], pageTitle: 'artemisApp.learningPath.manageLearningPaths.title', diff --git a/src/main/webapp/app/detail-overview-list/components/programming-auxiliary-repository-buttons-detail/programming-auxiliary-repository-buttons-detail.component.html b/src/main/webapp/app/detail-overview-list/components/programming-auxiliary-repository-buttons-detail/programming-auxiliary-repository-buttons-detail.component.html index c22ec3d50039..26cf22829413 100644 --- a/src/main/webapp/app/detail-overview-list/components/programming-auxiliary-repository-buttons-detail/programming-auxiliary-repository-buttons-detail.component.html +++ b/src/main/webapp/app/detail-overview-list/components/programming-auxiliary-repository-buttons-detail/programming-auxiliary-repository-buttons-detail.component.html @@ -1,9 +1,14 @@
    - @for (auxiliaryRepository of detail.data.auxiliaryRepositories; track auxiliaryRepository) { + @for (auxiliaryRepository of detail.data.auxiliaryRepositories; track auxiliaryRepository.id) { @if (auxiliaryRepository.id && auxiliaryRepository.repositoryUri && detail.data.exerciseId) {
  • Repository: {{ auxiliaryRepository.name }} - + {{ section.headline | artemisTranslate }}
    - @for (detail of section.details; track detail) { + @for (detail of section.details; track $index) { @if (!!detail) { @if (detail.title) {
    diff --git a/src/main/webapp/app/entities/competency/learning-path-health.model.ts b/src/main/webapp/app/entities/competency/learning-path-health.model.ts index 1cbcb13ba367..803dabf9eca2 100644 --- a/src/main/webapp/app/entities/competency/learning-path-health.model.ts +++ b/src/main/webapp/app/entities/competency/learning-path-health.model.ts @@ -1,5 +1,5 @@ export class LearningPathHealthDTO { - public status?: HealthStatus[]; + public status: HealthStatus[] = []; public missingLearningPaths?: number; constructor(status: HealthStatus[]) { @@ -8,18 +8,12 @@ export class LearningPathHealthDTO { } export enum HealthStatus { - OK = 'OK', - DISABLED = 'DISABLED', MISSING = 'MISSING', NO_COMPETENCIES = 'NO_COMPETENCIES', NO_RELATIONS = 'NO_RELATIONS', } function getWarningTranslation(status: HealthStatus, element: string) { - if (!status || status === HealthStatus.OK || status === HealthStatus.DISABLED) { - return ''; - } - const translation = { [HealthStatus.MISSING]: 'missing', [HealthStatus.NO_COMPETENCIES]: 'noCompetencies', @@ -29,33 +23,17 @@ function getWarningTranslation(status: HealthStatus, element: string) { } export function getWarningTitle(status: HealthStatus) { - if (!status || status === HealthStatus.OK || status === HealthStatus.DISABLED) { - return ''; - } - return getWarningTranslation(status, 'title'); } export function getWarningBody(status: HealthStatus) { - if (!status || status === HealthStatus.OK || status === HealthStatus.DISABLED) { - return ''; - } - return getWarningTranslation(status, 'body'); } export function getWarningAction(status: HealthStatus) { - if (!status || status === HealthStatus.OK || status === HealthStatus.DISABLED) { - return ''; - } - return getWarningTranslation(status, 'action'); } export function getWarningHint(status: HealthStatus) { - if (!status || status === HealthStatus.OK || status === HealthStatus.DISABLED) { - return ''; - } - return getWarningTranslation(status, 'hint'); } diff --git a/src/main/webapp/app/entities/competency/learning-path.model.ts b/src/main/webapp/app/entities/competency/learning-path.model.ts index 2c55868d0af0..576afd4e75a5 100644 --- a/src/main/webapp/app/entities/competency/learning-path.model.ts +++ b/src/main/webapp/app/entities/competency/learning-path.model.ts @@ -16,9 +16,9 @@ export class LearningPath implements BaseEntity { } export class LearningPathInformationDTO { - public id?: number; - public user?: UserNameAndLoginDTO; - public progress?: number; + public id: number; + public user: UserNameAndLoginDTO; + public progress: number; } export enum LearningObjectType { @@ -58,8 +58,13 @@ export interface LearningPathNavigationOverviewDTO { learningObjects: LearningPathNavigationObjectDTO[]; } +export interface LearningPathsConfigurationDTO { + includeAllGradedExercises: boolean; +} + export enum CompetencyGraphNodeValueType { MASTERY_PROGRESS = 'MASTERY_PROGRESS', + AVERAGE_MASTERY_PROGRESS = 'AVERAGE_MASTERY_PROGRESS', } export interface CompetencyGraphNodeDTO { diff --git a/src/main/webapp/app/entities/programming/build-agent.model.ts b/src/main/webapp/app/entities/programming/build-agent.model.ts index 172a8596b299..86c51ffc8b35 100644 --- a/src/main/webapp/app/entities/programming/build-agent.model.ts +++ b/src/main/webapp/app/entities/programming/build-agent.model.ts @@ -1,12 +1,18 @@ import { BaseEntity } from 'app/shared/model/base-entity'; import { BuildJob } from 'app/entities/programming/build-job.model'; +export enum BuildAgentStatus { + ACTIVE = 'ACTIVE', + PAUSED = 'PAUSED', + IDLE = 'IDLE', +} + export class BuildAgent implements BaseEntity { public id?: number; public name?: string; public maxNumberOfConcurrentBuildJobs?: number; public numberOfCurrentBuildJobs?: number; public runningBuildJobs?: BuildJob[]; - public status?: boolean; + public status?: BuildAgentStatus; public recentBuildJobs?: BuildJob[]; } diff --git a/src/main/webapp/app/entities/programming/programming-exercise.model.ts b/src/main/webapp/app/entities/programming/programming-exercise.model.ts index 8dde59469c03..d1d039f7cd38 100644 --- a/src/main/webapp/app/entities/programming/programming-exercise.model.ts +++ b/src/main/webapp/app/entities/programming/programming-exercise.model.ts @@ -16,6 +16,7 @@ export enum ProgrammingLanguage { EMPTY = 'EMPTY', ASSEMBLER = 'ASSEMBLER', C = 'C', + C_PLUS_PLUS = 'C_PLUS_PLUS', HASKELL = 'HASKELL', JAVA = 'JAVA', JAVASCRIPT = 'JAVASCRIPT', diff --git a/src/main/webapp/app/exercises/programming/manage/programming-exercise-management-routing.module.ts b/src/main/webapp/app/exercises/programming/manage/programming-exercise-management-routing.module.ts index cf949670dcf9..583c85ec8b49 100644 --- a/src/main/webapp/app/exercises/programming/manage/programming-exercise-management-routing.module.ts +++ b/src/main/webapp/app/exercises/programming/manage/programming-exercise-management-routing.module.ts @@ -172,6 +172,18 @@ export const routes: Routes = [ }, canActivate: [UserRouteAccessService, LocalVCGuard], }, + { + path: ':courseId/programming-exercises/:exerciseId/repository/:repositoryType/repo/:repositoryId', + component: RepositoryViewComponent, + data: { + authorities: [Authority.ADMIN, Authority.INSTRUCTOR, Authority.EDITOR, Authority.TA], + pageTitle: 'artemisApp.repository.title', + flushRepositoryCacheAfter: 900000, // 15 min + participationCache: {}, + repositoryCache: {}, + }, + canActivate: [UserRouteAccessService, LocalVCGuard], + }, { path: ':courseId/programming-exercises/:exerciseId/repository/:repositoryType/commit-history', component: CommitHistoryComponent, @@ -184,6 +196,18 @@ export const routes: Routes = [ }, canActivate: [LocalVCGuard], }, + { + path: ':courseId/programming-exercises/:exerciseId/repository/:repositoryType/repo/:repositoryId/commit-history', + component: CommitHistoryComponent, + data: { + authorities: [Authority.ADMIN, Authority.INSTRUCTOR, Authority.EDITOR], + pageTitle: 'artemisApp.repository.title', + flushRepositoryCacheAfter: 900000, // 15 min + participationCache: {}, + repositoryCache: {}, + }, + canActivate: [LocalVCGuard], + }, { path: ':courseId/programming-exercises/:exerciseId/repository/:repositoryType/vcs-access-log', component: VcsRepositoryAccessLogViewComponent, @@ -196,6 +220,18 @@ export const routes: Routes = [ }, canActivate: [LocalVCGuard], }, + { + path: ':courseId/programming-exercises/:exerciseId/repository/:repositoryType/repo/:repositoryId/vcs-access-log', + component: VcsRepositoryAccessLogViewComponent, + data: { + authorities: [Authority.ADMIN, Authority.INSTRUCTOR], + pageTitle: 'artemisApp.repository.title', + flushRepositoryCacheAfter: 900000, // 15 min + participationCache: {}, + repositoryCache: {}, + }, + canActivate: [LocalVCGuard], + }, { path: ':courseId/programming-exercises/:exerciseId/repository/:repositoryType/commit-history/:commitHash', component: CommitDetailsViewComponent, diff --git a/src/main/webapp/app/exercises/programming/manage/services/programming-exercise-participation.service.ts b/src/main/webapp/app/exercises/programming/manage/services/programming-exercise-participation.service.ts index e83414219bb6..b44b87386158 100644 --- a/src/main/webapp/app/exercises/programming/manage/services/programming-exercise-participation.service.ts +++ b/src/main/webapp/app/exercises/programming/manage/services/programming-exercise-participation.service.ts @@ -185,4 +185,16 @@ export class ProgrammingExerciseParticipationService implements IProgrammingExer retrieveCommitHistoryForTemplateSolutionOrTests(exerciseId: number, repositoryType: string): Observable { return this.http.get(`${this.resourceUrl}${exerciseId}/commit-history/${repositoryType}`); } + + /** + * Get the commit history for a specific auxiliary repository + * @param exerciseId the exercise the repository belongs to + * @param repositoryType the repositories type + * @param auxiliaryRepositoryId the id of the repository + */ + retrieveCommitHistoryForAuxiliaryRepository(exerciseId: number, auxiliaryRepositoryId: number): Observable { + const params: { [key: string]: number } = {}; + params['repositoryId'] = auxiliaryRepositoryId; + return this.http.get(`${this.resourceUrl}${exerciseId}/commit-history/AUXILIARY`, { params: params }); + } } diff --git a/src/main/webapp/app/exercises/programming/manage/services/programming-exercise.service.ts b/src/main/webapp/app/exercises/programming/manage/services/programming-exercise.service.ts index 82077ff4ffd6..5b1a793288ff 100644 --- a/src/main/webapp/app/exercises/programming/manage/services/programming-exercise.service.ts +++ b/src/main/webapp/app/exercises/programming/manage/services/programming-exercise.service.ts @@ -283,6 +283,16 @@ export class ProgrammingExerciseService { ); } + /** + * Finds the programming exercise for the given exerciseId with its auxiliary repositories + * @param programmingExerciseId of the programming exercise to retrieve + */ + findWithAuxiliaryRepository(programmingExerciseId: number): Observable { + return this.http.get(`${this.resourceUrl}/${programmingExerciseId}/with-auxiliary-repository`, { + observe: 'response', + }); + } + private setLatestResultForTemplateAndSolution(programmingExercise: ProgrammingExercise) { if (programmingExercise.templateParticipation) { const latestTemplateResult = this.getLatestResult(programmingExercise.templateParticipation); diff --git a/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-difficulty.component.html b/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-difficulty.component.html index 8f66c32f99dd..59cc94f7c1ba 100644 --- a/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-difficulty.component.html +++ b/src/main/webapp/app/exercises/programming/manage/update/update-components/programming-exercise-difficulty.component.html @@ -42,6 +42,8 @@ ngbTooltip="{{ 'artemisApp.programmingExercise.allowOfflineIde.alertNoTheia' | artemisTranslate }}" /> } + } @else { + }
@@ -74,6 +76,8 @@ ngbTooltip="{{ 'artemisApp.programmingExercise.allowOnlineEditor.alertNoTheia' | artemisTranslate }}" /> } + } @else { + }
@@ -99,6 +103,8 @@ [placement]="'top'" ngbTooltip="{{ 'artemisApp.programmingExercise.allowOnlineIde.alert' | artemisTranslate }}" /> + } @else { + }
diff --git a/src/main/webapp/app/exercises/programming/shared/code-editor/model/code-editor.model.ts b/src/main/webapp/app/exercises/programming/shared/code-editor/model/code-editor.model.ts index a3215aa04c48..555b5d0e84d8 100644 --- a/src/main/webapp/app/exercises/programming/shared/code-editor/model/code-editor.model.ts +++ b/src/main/webapp/app/exercises/programming/shared/code-editor/model/code-editor.model.ts @@ -2,6 +2,7 @@ import { StudentParticipation } from 'app/entities/participation/student-partici import { TemplateProgrammingExerciseParticipation } from 'app/entities/participation/template-programming-exercise-participation.model'; import { SolutionProgrammingExerciseParticipation } from 'app/entities/participation/solution-programming-exercise-participation.model'; import { ProgrammingExercise } from 'app/entities/programming/programming-exercise.model'; +import { AuxiliaryRepository } from 'app/entities/programming/programming-exercise-auxiliary-repository-model'; /** * Enumeration defining type of the exported file. @@ -49,6 +50,7 @@ export type FileSubmission = { [fileName: string]: string | undefined }; export enum DomainType { PARTICIPATION = 'PARTICIPATION', TEST_REPOSITORY = 'TEST_REPOSITORY', + AUXILIARY_REPOSITORY = 'AUXILIARY_REPOSITORY', } /** @@ -94,7 +96,8 @@ export enum ResizeType { export type DomainParticipationChange = [DomainType.PARTICIPATION, StudentParticipation | TemplateProgrammingExerciseParticipation | SolutionProgrammingExerciseParticipation]; export type DomainTestRepositoryChange = [DomainType.TEST_REPOSITORY, ProgrammingExercise]; -export type DomainChange = DomainParticipationChange | DomainTestRepositoryChange; +export type DomainAuxiliaryRepositoryChange = [DomainType.AUXILIARY_REPOSITORY, AuxiliaryRepository]; +export type DomainChange = DomainParticipationChange | DomainTestRepositoryChange | DomainAuxiliaryRepositoryChange; /** * Enumeration defining the state of git. diff --git a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-conflict-state.service.ts b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-conflict-state.service.ts index eba9259107c1..a045a3b2b62b 100644 --- a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-conflict-state.service.ts +++ b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-conflict-state.service.ts @@ -66,6 +66,9 @@ export class CodeEditorConflictStateService extends DomainDependentService imple private getDomainKey = () => { const [domainType, domainValue] = this.domain; + if (domainType === DomainType.AUXILIARY_REPOSITORY) { + return `auxiliary-${domainValue.id!.toString()}`; + } return `${domainType === DomainType.PARTICIPATION ? 'participation' : 'test'}-${domainValue.id!.toString()}`; }; } diff --git a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain-dependent-endpoint.service.ts b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain-dependent-endpoint.service.ts index fe6e71ac586a..b124042fec13 100644 --- a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain-dependent-endpoint.service.ts +++ b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain-dependent-endpoint.service.ts @@ -35,6 +35,8 @@ export abstract class DomainDependentEndpointService extends DomainDependentServ return `api/repository/${domainValue.id}`; case DomainType.TEST_REPOSITORY: return `api/test-repository/${domainValue.id}`; + case DomainType.AUXILIARY_REPOSITORY: + return `api/auxiliary-repository/${domainValue.id}`; } } } diff --git a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain.service.ts b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain.service.ts index 84d080b67efb..cebaae778af9 100644 --- a/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain.service.ts +++ b/src/main/webapp/app/exercises/programming/shared/code-editor/service/code-editor-domain.service.ts @@ -1,6 +1,11 @@ import { Injectable } from '@angular/core'; import { BehaviorSubject, Observable } from 'rxjs'; -import { DomainChange, DomainParticipationChange, DomainTestRepositoryChange } from 'app/exercises/programming/shared/code-editor/model/code-editor.model'; +import { + DomainAuxiliaryRepositoryChange, + DomainChange, + DomainParticipationChange, + DomainTestRepositoryChange, +} from 'app/exercises/programming/shared/code-editor/model/code-editor.model'; /** * This service provides subscribing services with the most recently selected domain (participation vs repository). @@ -9,7 +14,7 @@ import { DomainChange, DomainParticipationChange, DomainTestRepositoryChange } f @Injectable({ providedIn: 'root' }) export class DomainService { protected domain: DomainChange; - private subject = new BehaviorSubject(undefined); + private subject = new BehaviorSubject(undefined); constructor() {} diff --git a/src/main/webapp/app/exercises/shared/result/result.component.html b/src/main/webapp/app/exercises/shared/result/result.component.html index 911320c183df..65c4be9ca9de 100644 --- a/src/main/webapp/app/exercises/shared/result/result.component.html +++ b/src/main/webapp/app/exercises/shared/result/result.component.html @@ -61,7 +61,7 @@ } @if (!isInSidebarCard) { - ({{ result!.completionDate | artemisTimeAgo }} ) + ({{ result!.completionDate | artemisTimeAgo }}) } @if (hasBuildArtifact() && participation.type === ParticipationType.PROGRAMMING) { diff --git a/src/main/webapp/app/lecture/lecture-detail.component.ts b/src/main/webapp/app/lecture/lecture-detail.component.ts index a36705a78930..ef9e7344b4eb 100644 --- a/src/main/webapp/app/lecture/lecture-detail.component.ts +++ b/src/main/webapp/app/lecture/lecture-detail.component.ts @@ -89,7 +89,7 @@ export class LectureDetailComponent implements OnInit, OnDestroy { } } /** - * Trigger the Ingeston of this Lecture in Iris. + * Trigger the ingestion of this lecture in Iris. */ ingestLectureInPyris() { this.lectureService.ingestLecturesInPyris(this.lecture.course!.id!, this.lecture.id).subscribe({ diff --git a/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.html b/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.html index ea1b2da0f1d2..1a88dba6a6d8 100644 --- a/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.html +++ b/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.html @@ -1,10 +1,25 @@
@if (buildAgent) { -
-
-

- : -

{{ buildAgent.name }}

+
+
+
+

+ : +

{{ buildAgent.name }}

+
+
+ @if (buildAgent.status === 'PAUSED') { + + } @else { + + } +
@@ -28,10 +43,16 @@

{{ buildAgent.nam - @if (value) { - - } @else { - + @switch (value) { + @case ('ACTIVE') { + + } + @case ('IDLE') { + + } + @case ('PAUSED') { + + } } diff --git a/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.ts b/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.ts index 074c1e704695..de19544b01ad 100644 --- a/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.ts +++ b/src/main/webapp/app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component.ts @@ -2,12 +2,13 @@ import { Component, OnDestroy, OnInit } from '@angular/core'; import { BuildAgent } from 'app/entities/programming/build-agent.model'; import { BuildAgentsService } from 'app/localci/build-agents/build-agents.service'; import { Subscription } from 'rxjs'; -import { faCircleCheck, faExclamationCircle, faExclamationTriangle, faTimes } from '@fortawesome/free-solid-svg-icons'; +import { faCircleCheck, faExclamationCircle, faExclamationTriangle, faPause, faPlay, faTimes } from '@fortawesome/free-solid-svg-icons'; import dayjs from 'dayjs/esm'; import { TriggeredByPushTo } from 'app/entities/programming/repository-info.model'; import { ActivatedRoute } from '@angular/router'; import { JhiWebsocketService } from 'app/core/websocket/websocket.service'; import { BuildQueueService } from 'app/localci/build-queue/build-queue.service'; +import { AlertService, AlertType } from 'app/core/util/alert.service'; @Component({ selector: 'jhi-build-agent-details', @@ -28,12 +29,15 @@ export class BuildAgentDetailsComponent implements OnInit, OnDestroy { faExclamationCircle = faExclamationCircle; faExclamationTriangle = faExclamationTriangle; faTimes = faTimes; + readonly faPause = faPause; + readonly faPlay = faPlay; constructor( private websocketService: JhiWebsocketService, private buildAgentsService: BuildAgentsService, private route: ActivatedRoute, private buildQueueService: BuildQueueService, + private alertService: AlertService, ) {} ngOnInit() { @@ -105,4 +109,52 @@ export class BuildAgentDetailsComponent implements OnInit, OnDestroy { const url = `/api/build-log/${resultId}`; window.open(url, '_blank'); } + + pauseBuildAgent(): void { + if (this.buildAgent.name) { + this.buildAgentsService.pauseBuildAgent(this.buildAgent.name).subscribe({ + next: () => { + this.alertService.addAlert({ + type: AlertType.SUCCESS, + message: 'artemisApp.buildAgents.alerts.buildAgentPaused', + }); + }, + error: () => { + this.alertService.addAlert({ + type: AlertType.DANGER, + message: 'artemisApp.buildAgents.alerts.buildAgentPauseFailed', + }); + }, + }); + } else { + this.alertService.addAlert({ + type: AlertType.WARNING, + message: 'artemisApp.buildAgents.alerts.buildAgentWithoutName', + }); + } + } + + resumeBuildAgent(): void { + if (this.buildAgent.name) { + this.buildAgentsService.resumeBuildAgent(this.buildAgent.name).subscribe({ + next: () => { + this.alertService.addAlert({ + type: AlertType.SUCCESS, + message: 'artemisApp.buildAgents.alerts.buildAgentResumed', + }); + }, + error: () => { + this.alertService.addAlert({ + type: AlertType.DANGER, + message: 'artemisApp.buildAgents.alerts.buildAgentResumeFailed', + }); + }, + }); + } else { + this.alertService.addAlert({ + type: AlertType.WARNING, + message: 'artemisApp.buildAgents.alerts.buildAgentWithoutName', + }); + } + } } diff --git a/src/main/webapp/app/localci/build-agents/build-agent-summary/build-agent-summary.component.html b/src/main/webapp/app/localci/build-agents/build-agent-summary/build-agent-summary.component.html index a9b878d14d33..0982463d75a9 100644 --- a/src/main/webapp/app/localci/build-agents/build-agent-summary/build-agent-summary.component.html +++ b/src/main/webapp/app/localci/build-agents/build-agent-summary/build-agent-summary.component.html @@ -41,10 +41,16 @@

- @if (value) { - - } @else { - + @switch (value) { + @case ('ACTIVE') { + + } + @case ('IDLE') { + + } + @case ('PAUSED') { + + } } diff --git a/src/main/webapp/app/localci/build-agents/build-agents.service.ts b/src/main/webapp/app/localci/build-agents/build-agents.service.ts index 99905ad80c51..b701b85fe5d0 100644 --- a/src/main/webapp/app/localci/build-agents/build-agents.service.ts +++ b/src/main/webapp/app/localci/build-agents/build-agents.service.ts @@ -27,4 +27,28 @@ export class BuildAgentsService { }), ); } + + /** + * Pause Build Agent + */ + pauseBuildAgent(agentName: string): Observable { + const encodedAgentName = encodeURIComponent(agentName); + return this.http.put(`${this.adminResourceUrl}/agent/${encodedAgentName}/pause`, null).pipe( + catchError((err) => { + return throwError(() => new Error(`Failed to pause build agent ${agentName}\n${err.message}`)); + }), + ); + } + + /** + * Resume Build Agent + */ + resumeBuildAgent(agentName: string): Observable { + const encodedAgentName = encodeURIComponent(agentName); + return this.http.put(`${this.adminResourceUrl}/agent/${encodedAgentName}/resume`, null).pipe( + catchError((err) => { + return throwError(() => new Error(`Failed to resume build agent ${agentName}\n${err.message}`)); + }), + ); + } } diff --git a/src/main/webapp/app/localvc/commit-history/commit-history.component.ts b/src/main/webapp/app/localvc/commit-history/commit-history.component.ts index fe98dd02cb53..f734f9f2eec3 100644 --- a/src/main/webapp/app/localvc/commit-history/commit-history.component.ts +++ b/src/main/webapp/app/localvc/commit-history/commit-history.component.ts @@ -24,6 +24,7 @@ export class CommitHistoryComponent implements OnInit, OnDestroy { participationId: number; exerciseId: number; repositoryType: string; + repositoryId?: number; paramSub: Subscription; commits: CommitInfo[]; commitsInfoSubscription: Subscription; @@ -53,6 +54,7 @@ export class CommitHistoryComponent implements OnInit, OnDestroy { this.participationId = Number(params['participationId']); this.exerciseId = Number(params['exerciseId']); this.repositoryType = params['repositoryType']; + this.repositoryId = Number(params['repositoryId']); if (this.repositoryType) { this.loadDifferentParticipation(); } else { @@ -88,6 +90,8 @@ export class CommitHistoryComponent implements OnInit, OnDestroy { } else if (this.repositoryType === 'TESTS') { this.isTestRepository = true; this.participation = this.exercise.templateParticipation!; + } else if (this.repositoryType === 'AUXILIARY') { + this.participation = this.exercise.templateParticipation!; } }), ) @@ -121,26 +125,59 @@ export class CommitHistoryComponent implements OnInit, OnDestroy { } /** - * Retrieves the commit history for the participation and filters out the commits that have no submission. + * Retrieves the commit history and handles it depending on repository type * The last commit is always the template commit and is added to the list of commits. * @private */ private handleCommits() { - if (this.repositoryType) { - this.commitsInfoSubscription = this.programmingExerciseParticipationService - .retrieveCommitHistoryForTemplateSolutionOrTests(this.exerciseId, this.repositoryType) - .subscribe((commits) => { - this.commits = this.sortCommitsByTimestampDesc(commits); - if (!this.isTestRepository) { - this.setCommitResults(); - } - }); + if (!this.repositoryType) { + this.handleParticipationCommits(); + } else if (this.repositoryType === 'AUXILIARY') { + this.handleAuxiliaryRepositoryCommits(); } else { - this.commitsInfoSubscription = this.programmingExerciseParticipationService.retrieveCommitHistoryForParticipation(this.participation.id!).subscribe((commits) => { + this.handleTemplateSolutionTestRepositoryCommits(); + } + } + + /** + * Retrieves the commit history and filters out the commits that have no submission. + * The last commit is always the template commit and is added to the list of commits. + * @private + */ + private handleParticipationCommits() { + this.commitsInfoSubscription = this.programmingExerciseParticipationService.retrieveCommitHistoryForParticipation(this.participation.id!).subscribe((commits) => { + this.commits = this.sortCommitsByTimestampDesc(commits); + this.setCommitResults(); + }); + } + + /** + * Retrieves the commit history for an auxiliary repository + * The last commit is always the template commit and is added to the list of commits. + * @private + */ + private handleAuxiliaryRepositoryCommits() { + this.commitsInfoSubscription = this.programmingExerciseParticipationService + .retrieveCommitHistoryForAuxiliaryRepository(this.exerciseId, this.repositoryId!) + .subscribe((commits) => { this.commits = this.sortCommitsByTimestampDesc(commits); - this.setCommitResults(); }); - } + } + + /** + * Retrieves the commit history for template/solution/test repositories. + * The last commit is always the template commit and is added to the list of commits. + * @private + */ + private handleTemplateSolutionTestRepositoryCommits() { + this.commitsInfoSubscription = this.programmingExerciseParticipationService + .retrieveCommitHistoryForTemplateSolutionOrTests(this.exerciseId, this.repositoryType) + .subscribe((commits) => { + this.commits = this.sortCommitsByTimestampDesc(commits); + if (!this.isTestRepository) { + this.setCommitResults(); + } + }); } /** diff --git a/src/main/webapp/app/localvc/repository-view/repository-view.component.ts b/src/main/webapp/app/localvc/repository-view/repository-view.component.ts index 72e9bbdfc3ad..8e0b537d7abd 100644 --- a/src/main/webapp/app/localvc/repository-view/repository-view.component.ts +++ b/src/main/webapp/app/localvc/repository-view/repository-view.component.ts @@ -91,11 +91,14 @@ export class RepositoryViewComponent implements OnInit, OnDestroy { this.participationCouldNotBeFetched = false; const exerciseId = Number(params['exerciseId']); const participationId = Number(params['participationId']); + const repositoryId = Number(params['repositoryId']); this.repositoryType = participationId ? 'USER' : params['repositoryType']; this.vcsAccessLogRoute = this.router.url + '/vcs-access-log'; this.enableVcsAccessLog = this.router.url.includes('course-management') && params['repositoryType'] !== 'TESTS'; if (this.repositoryType === 'USER') { this.loadStudentParticipation(participationId); + } else if (this.repositoryType === 'AUXILIARY') { + this.loadAuxiliaryRepository(exerciseId, repositoryId); } else { this.loadDifferentParticipation(this.repositoryType, exerciseId); } @@ -190,4 +193,27 @@ export class RepositoryViewComponent implements OnInit, OnDestroy { }), ); } + + private loadAuxiliaryRepository(exerciseId: number, auxiliaryRepositoryId: number) { + this.programmingExerciseService + .findWithAuxiliaryRepository(exerciseId) + .pipe( + tap((exerciseResponse) => { + this.exercise = exerciseResponse.body!; + const auxiliaryRepo = this.exercise.auxiliaryRepositories?.find((repo) => repo.id === auxiliaryRepositoryId); + if (auxiliaryRepo) { + this.domainService.setDomain([DomainType.AUXILIARY_REPOSITORY, auxiliaryRepo]); + this.repositoryUri = auxiliaryRepo.repositoryUri!; + } + }), + ) + .subscribe({ + next: () => { + this.loadingParticipation = false; + }, + error: () => { + this.participationCouldNotBeFetched = true; + }, + }); + } } diff --git a/src/main/webapp/app/overview/course-conversations/course-conversations.component.html b/src/main/webapp/app/overview/course-conversations/course-conversations.component.html index 90b2559fa81a..e4cd32cdbecb 100644 --- a/src/main/webapp/app/overview/course-conversations/course-conversations.component.html +++ b/src/main/webapp/app/overview/course-conversations/course-conversations.component.html @@ -29,10 +29,14 @@ [itemSelected]="conversationSelected" [courseId]="course.id" [sidebarData]="sidebarData" - (onPlusPressed)="onAccordionPlusButtonPressed($event)" + (onCreateChannelPressed)="openCreateChannelDialog()" + (onBrowsePressed)="openChannelOverviewDialog()" + (onDirectChatPressed)="openCreateOneToOneChatDialog()" + (onGroupChatPressed)="openCreateGroupChatDialog()" [showAddOption]="CHANNEL_TYPE_SHOW_ADD_OPTION" [channelTypeIcon]="CHANNEL_TYPE_ICON" [collapseState]="DEFAULT_COLLAPSE_STATE" + [inCommunication]="true" />
@if (course && !activeConversation && isCodeOfConductPresented) { diff --git a/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts b/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts index 2d56484f8a46..da7dd332f047 100644 --- a/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts +++ b/src/main/webapp/app/overview/course-conversations/course-conversations.component.ts @@ -1,12 +1,12 @@ -import { Component, ElementRef, HostListener, OnDestroy, OnInit, ViewChild, ViewEncapsulation } from '@angular/core'; +import { Component, ElementRef, EventEmitter, HostListener, OnDestroy, OnInit, ViewChild, ViewEncapsulation } from '@angular/core'; import { ConversationDTO } from 'app/entities/metis/conversation/conversation.model'; import { Post } from 'app/entities/metis/post.model'; import { ActivatedRoute, Router } from '@angular/router'; import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; -import { EMPTY, Subject, Subscription, from, take, takeUntil } from 'rxjs'; -import { catchError } from 'rxjs/operators'; +import { EMPTY, Observable, Subject, Subscription, from, take, takeUntil } from 'rxjs'; +import { catchError, debounceTime, distinctUntilChanged } from 'rxjs/operators'; import { MetisConversationService } from 'app/shared/metis/metis-conversation.service'; -import { ChannelSubType, getAsChannelDTO } from 'app/entities/metis/conversation/channel.model'; +import { ChannelDTO, ChannelSubType, getAsChannelDTO } from 'app/entities/metis/conversation/channel.model'; import { MetisService } from 'app/shared/metis/metis.service'; import { Course, isMessagingEnabled } from 'app/entities/course.model'; import { PageType, SortDirection } from 'app/shared/metis/metis.util'; @@ -16,11 +16,12 @@ import { CourseWideSearchComponent, CourseWideSearchConfig } from 'app/overview/ import { AccordionGroups, ChannelAccordionShowAdd, ChannelTypeIcons, CollapseState, SidebarCardElement, SidebarData } from 'app/types/sidebar'; import { CourseOverviewService } from 'app/overview/course-overview.service'; import { GroupChatCreateDialogComponent } from 'app/overview/course-conversations/dialogs/group-chat-create-dialog/group-chat-create-dialog.component'; -import { defaultFirstLayerDialogOptions } from 'app/overview/course-conversations/other/conversation.util'; +import { defaultFirstLayerDialogOptions, defaultSecondLayerDialogOptions } from 'app/overview/course-conversations/other/conversation.util'; import { UserPublicInfoDTO } from 'app/core/user/user.model'; import { OneToOneChatCreateDialogComponent } from 'app/overview/course-conversations/dialogs/one-to-one-chat-create-dialog/one-to-one-chat-create-dialog.component'; -import { ChannelsOverviewDialogComponent } from 'app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component'; +import { ChannelAction, ChannelsOverviewDialogComponent } from 'app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component'; import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; +import { ChannelsCreateDialogComponent } from 'app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component'; const DEFAULT_CHANNEL_GROUPS: AccordionGroups = { favoriteChannels: { entityData: [] }, @@ -114,7 +115,9 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { faFilter = faFilter; faSearch = faSearch; - // MetisConversationService is created in course overview, so we can use it here + createChannelFn?: (channel: ChannelDTO) => Observable; + channelActions$ = new EventEmitter(); + constructor( private router: Router, private activatedRoute: ActivatedRoute, @@ -162,6 +165,16 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { this.isServiceSetUp = true; this.isLoading = false; } + this.channelActions$ + .pipe( + debounceTime(500), + distinctUntilChanged((prev, curr) => prev.action === curr.action && prev.channel.id === curr.channel.id), + takeUntil(this.ngUnsubscribe), + ) + .subscribe((channelAction) => { + this.performChannelAction(channelAction); + }); + this.createChannelFn = (channel: ChannelDTO) => this.metisConversationService.createChannel(channel); }); this.profileSubscription = this.profileService.getProfileInfo()?.subscribe((profileInfo) => { @@ -170,6 +183,21 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { }); } + performChannelAction(channelAction: ChannelAction) { + if (this.createChannelFn) { + this.createChannelFn(channelAction.channel) + .pipe(takeUntil(this.ngUnsubscribe)) + .subscribe({ + complete: () => { + this.prepareSidebarData(); + }, + error: (error) => { + console.error('Error creating channel:', error); + }, + }); + } + } + subscribeToQueryParameter() { this.activatedRoute.queryParams.pipe(take(1), takeUntil(this.ngUnsubscribe)).subscribe((queryParams) => { if (queryParams.conversationId) { @@ -270,8 +298,8 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { storageId: 'conversation', groupedData: this.accordionConversationGroups, ungroupedData: this.sidebarConversations, - showAccordionAddOption: true, showAccordionLeadingIcon: true, + messagingEnabled: isMessagingEnabled(this.course), }; } @@ -284,16 +312,6 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { this.courseOverviewService.setSidebarCollapseState('conversation', this.isCollapsed); } - onAccordionPlusButtonPressed(chatType: string) { - if (chatType === 'groupChats') { - this.openCreateGroupChatDialog(); - } else if (chatType === 'directMessages') { - this.openCreateOneToOneChatDialog(); - } else { - this.openChannelOverviewDialog(chatType); - } - } - openCreateGroupChatDialog() { const modalRef: NgbModalRef = this.modalService.open(GroupChatCreateDialogComponent, defaultFirstLayerDialogOptions); modalRef.componentInstance.course = this.course; @@ -332,8 +350,22 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { }); } - openChannelOverviewDialog(groupKey: string) { - const subType = this.getChannelSubType(groupKey); + openCreateChannelDialog() { + const modalRef: NgbModalRef = this.modalService.open(ChannelsCreateDialogComponent, defaultSecondLayerDialogOptions); + modalRef.componentInstance.course = this.course; + modalRef.componentInstance.initialize(); + from(modalRef.result) + .pipe( + catchError(() => EMPTY), + takeUntil(this.ngUnsubscribe), + ) + .subscribe((channel: ChannelDTO) => { + this.channelActions$.emit({ action: 'create', channel }); + }); + } + + openChannelOverviewDialog() { + const subType = null; const modalRef: NgbModalRef = this.modalService.open(ChannelsOverviewDialogComponent, defaultFirstLayerDialogOptions); modalRef.componentInstance.course = this.course; modalRef.componentInstance.createChannelFn = subType === ChannelSubType.GENERAL ? this.metisConversationService.createChannel : undefined; @@ -363,22 +395,6 @@ export class CourseConversationsComponent implements OnInit, OnDestroy { }); } - getChannelSubType(groupKey: string) { - if (groupKey === 'exerciseChannels') { - return ChannelSubType.EXERCISE; - } - if (groupKey === 'generalChannels') { - return ChannelSubType.GENERAL; - } - if (groupKey === 'lectureChannels') { - return ChannelSubType.LECTURE; - } - if (groupKey === 'examChannels') { - return ChannelSubType.EXAM; - } - return ChannelSubType.GENERAL; - } - toggleChannelSearch() { this.channelSearchCollapsed = !this.channelSearchCollapsed; } diff --git a/src/main/webapp/app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component.html b/src/main/webapp/app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component.html index cd5b295812a3..e7c6413b8b22 100644 --- a/src/main/webapp/app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component.html +++ b/src/main/webapp/app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component.html @@ -1,5 +1,5 @@ @if (isInitialized) { -
+

- {{ 'artemisApp.dialogs.channelOverview.title.' + channelSubType | artemisTranslate: { courseTitle: course.title } }} + {{ 'artemisApp.dialogs.channelOverview.title' | artemisTranslate: { courseTitle: course.title } }}

@if (channels && channels.length > 0) { -
+
    @for (channel of channels; track channels.indexOf(channel)) { @@ -22,36 +22,6 @@

} - @if (otherChannels && otherChannels.length > 0) { -
-
- - -
-
-
-
    - @for (channel of otherChannels; track otherChannels.indexOf(channel)) { -
  • - -
    • - } -
-
-
-
- } -
-
- @if (createChannelFn && canCreateChannel(course)) { - - }
} diff --git a/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.scss b/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.scss index f4e1f58d30ed..e5be0b4fb1d2 100644 --- a/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.scss +++ b/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.scss @@ -11,6 +11,7 @@ .list-group-item { overflow: hidden; + padding: 0; } .other-channels { diff --git a/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.ts b/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.ts index 046f49428f99..deb055e00a5e 100644 --- a/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.ts +++ b/src/main/webapp/app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.ts @@ -1,19 +1,15 @@ import { Component, Input, OnDestroy, OnInit } from '@angular/core'; -import { EMPTY, Observable, Subject, debounceTime, distinctUntilChanged, finalize, from, map, takeUntil } from 'rxjs'; +import { Observable, Subject, debounceTime, distinctUntilChanged, finalize, map, takeUntil } from 'rxjs'; import { faChevronRight } from '@fortawesome/free-solid-svg-icons'; - import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; import { onError } from 'app/shared/util/global.utils'; import { AlertService } from 'app/core/util/alert.service'; -import { NgbActiveModal, NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { ChannelService } from 'app/shared/metis/conversations/channel.service'; import { ChannelDTO, ChannelSubType } from 'app/entities/metis/conversation/channel.model'; import { Course } from 'app/entities/course.model'; -import { ChannelsCreateDialogComponent } from 'app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component'; import { canCreateChannel } from 'app/shared/metis/conversations/conversation-permissions.utils'; import { AbstractDialogComponent } from 'app/overview/course-conversations/dialogs/abstract-dialog.component'; -import { defaultSecondLayerDialogOptions } from 'app/overview/course-conversations/other/conversation.util'; -import { catchError } from 'rxjs/operators'; export type ChannelActionType = 'register' | 'deregister' | 'view' | 'create'; export type ChannelAction = { @@ -44,12 +40,10 @@ export class ChannelsOverviewDialogComponent extends AbstractDialogComponent imp channelModificationPerformed = false; isLoading = false; channels: ChannelDTO[] = []; - otherChannels: ChannelDTO[] = []; isInitialized = false; faChevronRight = faChevronRight; - otherChannelsAreCollapsed = true; initialize() { super.initialize(['course', 'channelSubType']); @@ -61,7 +55,6 @@ export class ChannelsOverviewDialogComponent extends AbstractDialogComponent imp constructor( private channelService: ChannelService, private alertService: AlertService, - private modalService: NgbModal, activeModal: NgbActiveModal, ) { @@ -114,18 +107,6 @@ export class ChannelsOverviewDialogComponent extends AbstractDialogComponent imp case 'view': this.close([channelAction.channel, this.channelModificationPerformed]); break; - case 'create': - if (this.createChannelFn) { - this.createChannelFn(channelAction.channel) - .pipe(takeUntil(this.ngUnsubscribe)) - .subscribe({ - complete: () => { - this.loadChannelsOfCourse(); - this.channelModificationPerformed = true; - }, - }); - } - break; } } @@ -142,8 +123,7 @@ export class ChannelsOverviewDialogComponent extends AbstractDialogComponent imp ) .subscribe({ next: (channels: ChannelDTO[]) => { - this.channels = channels?.filter((channel) => channel.subType === this.channelSubType) ?? []; - this.otherChannels = channels?.filter((channel) => channel.subType !== this.channelSubType) ?? []; + this.channels = channels; this.noOfChannels = this.channels.length; }, error: (errorResponse: HttpErrorResponse) => { @@ -151,19 +131,4 @@ export class ChannelsOverviewDialogComponent extends AbstractDialogComponent imp }, }); } - - openCreateChannelDialog(event: MouseEvent) { - event.stopPropagation(); - const modalRef: NgbModalRef = this.modalService.open(ChannelsCreateDialogComponent, defaultSecondLayerDialogOptions); - modalRef.componentInstance.course = this.course; - modalRef.componentInstance.initialize(); - from(modalRef.result) - .pipe( - catchError(() => EMPTY), - takeUntil(this.ngUnsubscribe), - ) - .subscribe((channel: ChannelDTO) => { - this.channelActions$.next({ action: 'create', channel }); - }); - } } diff --git a/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.html b/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.html index 752c1e385261..f7f5d5aa0f5a 100644 --- a/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.html +++ b/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.html @@ -46,7 +46,7 @@ (delete)="deleteChannel()" [dialogError]="dialogError$" > - +

} diff --git a/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.ts b/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.ts index 64cb3410ae78..9a9b9b56bb6e 100644 --- a/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.ts +++ b/src/main/webapp/app/overview/course-conversations/dialogs/conversation-detail-dialog/tabs/conversation-settings/conversation-settings.component.ts @@ -9,7 +9,7 @@ import { onError } from 'app/shared/util/global.utils'; import { EMPTY, Subject, from, takeUntil } from 'rxjs'; import { HttpErrorResponse } from '@angular/common/http'; import { AlertService } from 'app/core/util/alert.service'; -import { faTimes } from '@fortawesome/free-solid-svg-icons'; +import { faTrash } from '@fortawesome/free-solid-svg-icons'; import { canChangeChannelArchivalState, canDeleteChannel, canLeaveConversation } from 'app/shared/metis/conversations/conversation-permissions.utils'; import { GroupChatService } from 'app/shared/metis/conversations/group-chat.service'; import { isGroupChatDTO } from 'app/entities/metis/conversation/group-chat.model'; @@ -42,7 +42,7 @@ export class ConversationSettingsComponent implements OnInit, OnDestroy { private dialogErrorSource = new Subject(); dialogError$ = this.dialogErrorSource.asObservable(); - faTimes = faTimes; + readonly faTrash = faTrash; conversationAsChannel: ChannelDTO | undefined; canLeaveConversation: boolean; diff --git a/src/main/webapp/app/overview/course-conversations/dialogs/group-chat-create-dialog/group-chat-create-dialog.component.html b/src/main/webapp/app/overview/course-conversations/dialogs/group-chat-create-dialog/group-chat-create-dialog.component.html index d8e0e8a5aa1a..b84a700f6e35 100644 --- a/src/main/webapp/app/overview/course-conversations/dialogs/group-chat-create-dialog/group-chat-create-dialog.component.html +++ b/src/main/webapp/app/overview/course-conversations/dialogs/group-chat-create-dialog/group-chat-create-dialog.component.html @@ -1,5 +1,5 @@ @if (isInitialized) { -
+

diff --git a/src/main/webapp/app/overview/course-conversations/dialogs/one-to-one-chat-create-dialog/one-to-one-chat-create-dialog.component.html b/src/main/webapp/app/overview/course-conversations/dialogs/one-to-one-chat-create-dialog/one-to-one-chat-create-dialog.component.html index cbe9bcfbf6bb..6e0626903103 100644 --- a/src/main/webapp/app/overview/course-conversations/dialogs/one-to-one-chat-create-dialog/one-to-one-chat-create-dialog.component.html +++ b/src/main/webapp/app/overview/course-conversations/dialogs/one-to-one-chat-create-dialog/one-to-one-chat-create-dialog.component.html @@ -1,5 +1,5 @@ @if (isInitialized) { -
+

diff --git a/src/main/webapp/app/overview/course-dashboard/course-dashboard.component.ts b/src/main/webapp/app/overview/course-dashboard/course-dashboard.component.ts index 18bda85f7731..a027b4afae8b 100644 --- a/src/main/webapp/app/overview/course-dashboard/course-dashboard.component.ts +++ b/src/main/webapp/app/overview/course-dashboard/course-dashboard.component.ts @@ -67,16 +67,13 @@ export class CourseDashboardComponent implements OnInit, OnDestroy { this.paramSubscription = this.route.parent?.parent?.params.subscribe((params) => { this.courseId = parseInt(params['courseId'], 10); - // HD3-GROUPS: Experiment groups for IRIS are 1 & 2. Disable for group 0 - if (this.accountService.userIdentity && this.accountService.userIdentity!.id! % 3 > 0) { - this.profileService.getProfileInfo().subscribe((profileInfo) => { - if (profileInfo?.activeProfiles.includes(PROFILE_IRIS)) { - this.irisSettingsService.getCombinedCourseSettings(this.courseId).subscribe((settings) => { - this.irisEnabled = !!settings?.irisChatSettings?.enabled; - }); - } - }); - } + this.profileService.getProfileInfo().subscribe((profileInfo) => { + if (profileInfo?.activeProfiles.includes(PROFILE_IRIS)) { + this.irisSettingsService.getCombinedCourseSettings(this.courseId).subscribe((settings) => { + this.irisEnabled = !!settings?.irisChatSettings?.enabled; + }); + } + }); }); this.setCourse(this.courseStorageService.getCourse(this.courseId)); diff --git a/src/main/webapp/app/overview/course-faq/course-faq.component.html b/src/main/webapp/app/overview/course-faq/course-faq.component.html index 115efb80cc1c..67cc28d2f00f 100644 --- a/src/main/webapp/app/overview/course-faq/course-faq.component.html +++ b/src/main/webapp/app/overview/course-faq/course-faq.component.html @@ -27,9 +27,15 @@

+ @if (faqs?.length === 0) { +

+ }
@for (faq of this.filteredFaqs; track faq) { }
+ @if (filteredFaqs?.length === 0 && faqs.length > 0) { +

+ }
diff --git a/src/main/webapp/app/overview/course-faq/course-faq.component.ts b/src/main/webapp/app/overview/course-faq/course-faq.component.ts index 03fd207fda21..db5a91e2c3d7 100644 --- a/src/main/webapp/app/overview/course-faq/course-faq.component.ts +++ b/src/main/webapp/app/overview/course-faq/course-faq.component.ts @@ -16,6 +16,7 @@ import { loadCourseFaqCategories } from 'app/faq/faq.utils'; import { CustomExerciseCategoryBadgeComponent } from 'app/shared/exercise-categories/custom-exercise-category-badge/custom-exercise-category-badge.component'; import { onError } from 'app/shared/util/global.utils'; import { SearchFilterComponent } from 'app/shared/search-filter/search-filter.component'; +import { ArtemisMarkdownModule } from 'app/shared/markdown.module'; @Component({ selector: 'jhi-course-faq', @@ -23,7 +24,7 @@ import { SearchFilterComponent } from 'app/shared/search-filter/search-filter.co styleUrls: ['../course-overview.scss', 'course-faq.component.scss'], encapsulation: ViewEncapsulation.None, standalone: true, - imports: [ArtemisSharedComponentModule, ArtemisSharedModule, CourseFaqAccordionComponent, CustomExerciseCategoryBadgeComponent, SearchFilterComponent], + imports: [ArtemisSharedComponentModule, ArtemisSharedModule, CourseFaqAccordionComponent, CustomExerciseCategoryBadgeComponent, SearchFilterComponent, ArtemisMarkdownModule], }) export class CourseFaqComponent implements OnInit, OnDestroy { private ngUnsubscribe = new Subject(); diff --git a/src/main/webapp/app/overview/course-overview.component.html b/src/main/webapp/app/overview/course-overview.component.html index 958137c657b6..e0b62084f8b6 100644 --- a/src/main/webapp/app/overview/course-overview.component.html +++ b/src/main/webapp/app/overview/course-overview.component.html @@ -13,7 +13,7 @@ @@ -274,7 +274,7 @@ routerLinkActive="active" [jhiFeatureToggleHide]="sidebarItem.featureToggle" [title]="sidebarItem.title" - (click)="itemsDrop.close()" + (click)="itemsDrop?.close()" > diff --git a/src/main/webapp/app/overview/exercise-details/request-feedback-button/request-feedback-button.component.html b/src/main/webapp/app/overview/exercise-details/request-feedback-button/request-feedback-button.component.html index 6d6addcc2b84..69310708cac3 100644 --- a/src/main/webapp/app/overview/exercise-details/request-feedback-button/request-feedback-button.component.html +++ b/src/main/webapp/app/overview/exercise-details/request-feedback-button/request-feedback-button.component.html @@ -1,4 +1,4 @@ -@if (!isExamExercise) { +@if (!isExamExercise && requestFeedbackEnabled) { @if (athenaEnabled) { @if (exercise().type === ExerciseType.TEXT) { diff --git a/src/main/webapp/app/shared/sidebar/accordion-add-options/accordion-add-options.component.scss b/src/main/webapp/app/shared/sidebar/accordion-add-options/accordion-add-options.component.scss deleted file mode 100644 index a9acacbbb52e..000000000000 --- a/src/main/webapp/app/shared/sidebar/accordion-add-options/accordion-add-options.component.scss +++ /dev/null @@ -1,12 +0,0 @@ -.dropdown-toggle::after { - display: none; -} - -.sidebar-button { - border: 0; - - &:hover { - background-color: var(--transparent); - color: var(--link-item-color); - } -} diff --git a/src/main/webapp/app/shared/sidebar/accordion-add-options/accordion-add-options.component.ts b/src/main/webapp/app/shared/sidebar/accordion-add-options/accordion-add-options.component.ts deleted file mode 100644 index f8001221c8b6..000000000000 --- a/src/main/webapp/app/shared/sidebar/accordion-add-options/accordion-add-options.component.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { Component, Input } from '@angular/core'; -import { faPlus } from '@fortawesome/free-solid-svg-icons'; -import { SidebarEventService } from 'app/shared/sidebar/sidebar-event.service'; - -@Component({ - selector: 'jhi-accordion-add-options', - templateUrl: './accordion-add-options.component.html', - styleUrl: './accordion-add-options.component.scss', -}) -export class AccordionAddOptionsComponent { - @Input() groupKey: string; - faPlus = faPlus; - - constructor(private sidebarEventService: SidebarEventService) {} - - onPlusPressed(event: MouseEvent) { - event.stopPropagation(); - this.sidebarEventService.emitSidebarAccordionPlusClickedEvent(this.groupKey); - } -} diff --git a/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.html b/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.html index 39d52538a222..69bc271744d1 100644 --- a/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.html +++ b/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.html @@ -1,9 +1,9 @@
-
-
diff --git a/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.ts b/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.ts index 048a12a59fc4..b096a691be7d 100644 --- a/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.ts +++ b/src/main/webapp/app/shared/sidebar/conversation-options/conversation-options.component.ts @@ -79,11 +79,35 @@ export class ConversationOptionsComponent implements OnInit, OnDestroy { onHiddenClicked(event: MouseEvent) { event.stopPropagation(); + if (!this.course.id || !this.conversation.id) { + return; + } + + if (!this.conversation.isHidden && this.conversation.isFavorite) { + this.conversationService.updateIsFavorite(this.course.id, this.conversation.id, false).subscribe({ + next: () => { + this.conversation.isFavorite = false; + }, + error: (errorResponse: HttpErrorResponse) => onError(this.alertService, errorResponse), + }); + } this.hide$.next(!this.conversation.isHidden); } onFavoriteClicked($event: MouseEvent) { $event.stopPropagation(); + if (!this.course.id || !this.conversation.id) { + return; + } + + if (this.conversation.isHidden && !this.conversation.isFavorite) { + this.conversationService.updateIsHidden(this.course.id, this.conversation.id, false).subscribe({ + next: () => { + this.conversation.isHidden = false; + }, + error: (errorResponse: HttpErrorResponse) => onError(this.alertService, errorResponse), + }); + } this.favorite$.next(!this.conversation.isFavorite); } diff --git a/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html b/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html index bb8af797054e..16eb4bc62671 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html +++ b/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.html @@ -1,46 +1,44 @@ @for (groupKey of Object.keys(groupedData); track groupKey; let i = $index) { -
-
-
- @if (showLeadingIcon) { - - } - {{ 'artemisApp.courseOverview.sidebar.' + groupKey | artemisTranslate | titlecase }} - ({{ (groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue)?.length }}) -
-
- - + @if ((groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue)?.length) { +
+
+
+ @if (showLeadingIcon) { + + } + {{ 'artemisApp.courseOverview.sidebar.' + groupKey | artemisTranslate | titlecase }} + ({{ (groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue)?.length }}) +
+
+ +
-
- @if ((groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue)?.length) { -
-
- @for (sidebarItem of groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue; let last = $last; track sidebarItem) { -
- -
-
- } -
- @if (!collapseState[groupKey]) { + @if ((groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue)?.length) {
+
+ @for (sidebarItem of groupedData[groupKey].entityData | searchFilter: ['title', 'type'] : searchValue; let last = $last; track sidebarItem) { +
+ +
+
+ } +
+ @if (!collapseState[groupKey]) { +
+ } } - } -
+
+ } } diff --git a/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.ts b/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.ts index 5cd59c0d3b8e..9f185af2da2d 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar-accordion/sidebar-accordion.component.ts @@ -1,6 +1,6 @@ import { Component, EventEmitter, Input, OnChanges, OnInit, Output } from '@angular/core'; import { faChevronRight, faFile } from '@fortawesome/free-solid-svg-icons'; -import { AccordionGroups, ChannelAccordionShowAdd, ChannelGroupCategory, ChannelTypeIcons, CollapseState, SidebarCardElement, SidebarTypes } from 'app/types/sidebar'; +import { AccordionGroups, ChannelTypeIcons, CollapseState, SidebarCardElement, SidebarTypes } from 'app/types/sidebar'; import { Params } from '@angular/router'; @Component({ @@ -20,8 +20,6 @@ export class SidebarAccordionComponent implements OnChanges, OnInit { @Input() courseId?: number; @Input() itemSelected?: boolean; @Input() showLeadingIcon = false; - @Input() showAddOptions = false; - @Input() showAddOption?: ChannelAccordionShowAdd; @Input() channelTypeIcon?: ChannelTypeIcons; @Input() collapseState: CollapseState; @Input() isFilterActive: boolean = false; @@ -72,11 +70,4 @@ export class SidebarAccordionComponent implements OnChanges, OnInit { this.collapseState[groupCategoryKey] = !this.collapseState[groupCategoryKey]; sessionStorage.setItem('sidebar.accordion.collapseState.' + this.storageId + '.byCourse.' + this.courseId, JSON.stringify(this.collapseState)); } - - getGroupKey(groupKey: string): boolean { - if (!this.showAddOption) { - return false; - } - return this.showAddOption[groupKey as ChannelGroupCategory]; - } } diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.html b/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.html index ce2055d4c657..15f1ecdd6e90 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.html +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.html @@ -1,6 +1,6 @@ @if (sidebarItem) { -
+
@if (sidebarType === 'exam') {
@@ -46,8 +46,14 @@
} @else { -
- +
+ @if (sidebarItem.icon) { } @@ -58,8 +64,11 @@ } + @if (unreadCount() > 0) { + {{ formattedUnreadCount }} + }
-
+
{{ sidebarItem.subtitleLeft }} diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.scss b/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.scss index 6c43e309b90b..64f4e5a920c0 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.scss +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.scss @@ -5,3 +5,17 @@ .muted { color: var(--metis-conversation-sidebar-muted); } + +.unread-count { + background-color: var(--bs-primary); + color: var(--bs-white); + border-radius: 50%; + font-size: 0.6rem; + width: 1.1rem; + height: 1.1rem; + display: flex; + justify-content: center; + align-items: center; + overflow: hidden; + white-space: nowrap; +} diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.ts b/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.ts index 0db256223fe5..4c294f485fa7 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-item/sidebar-card-item.component.ts @@ -1,4 +1,4 @@ -import { Component, Input } from '@angular/core'; +import { Component, Input, OnChanges, OnInit, SimpleChanges, input } from '@angular/core'; import { SidebarCardElement, SidebarTypes } from 'app/types/sidebar'; @Component({ @@ -6,7 +6,28 @@ import { SidebarCardElement, SidebarTypes } from 'app/types/sidebar'; templateUrl: './sidebar-card-item.component.html', styleUrls: ['./sidebar-card-item.component.scss', '../sidebar.component.scss'], }) -export class SidebarCardItemComponent { +export class SidebarCardItemComponent implements OnInit, OnChanges { @Input() sidebarItem: SidebarCardElement; @Input() sidebarType?: SidebarTypes; + @Input() groupKey?: string; + unreadCount = input(0); + + formattedUnreadCount: string = ''; + + ngOnInit(): void { + this.formattedUnreadCount = this.getFormattedUnreadCount(); + } + + ngOnChanges(changes: SimpleChanges): void { + if (changes['unreadCount']) { + this.formattedUnreadCount = this.getFormattedUnreadCount(); + } + } + + private getFormattedUnreadCount(): string { + if (this.unreadCount() > 99) { + return '99+'; + } + return this.unreadCount().toString() || ''; + } } diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.html b/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.html index 6f5f92481893..264f9815cfa4 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.html +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.html @@ -5,5 +5,6 @@ (click)="emitStoreAndRefresh(sidebarItem.id)" [routerLinkActive]="'bg-selected border-selected'" > - + +
diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.ts b/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.ts index 40afd9615c37..1422a0ad4efc 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-large/sidebar-card-large.component.ts @@ -13,6 +13,8 @@ export class SidebarCardLargeComponent { @Input({ required: true }) sidebarItem: SidebarCardElement; @Input() sidebarType?: SidebarTypes; @Input() itemSelected?: boolean; + /** Key used for grouping or categorizing sidebar items */ + @Input() groupKey?: string; constructor( private sidebarEventService: SidebarEventService, private router: Router, diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.html b/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.html index adfa1da77f82..4bb0e62c10bb 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.html +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.html @@ -5,12 +5,12 @@ [ngClass]="{ 'bg-selected border-selected': itemSelected }" (click)="emitPageChangeForExam()" > - +
} @else {
- +
} diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.ts b/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.ts index facce881ecdc..05596e471937 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-medium/sidebar-card-medium.component.ts @@ -16,6 +16,8 @@ export class SidebarCardMediumComponent { @Input() sidebarType?: SidebarTypes; @Input() itemSelected?: boolean; @Output() pageChange = new EventEmitter(); + /** Key used for grouping or categorizing sidebar items */ + @Input() groupKey?: string; constructor( private sidebarEventService: SidebarEventService, diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.html b/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.html index 4ba959ab59fc..ae134a4dfd8d 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.html +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.html @@ -9,8 +9,13 @@ (click)="emitStoreAndRefresh(sidebarItem.id)" [routerLinkActive]="'bg-selected border-selected'" > -
- +
+
@if (sidebarItem.conversation) {
diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.ts b/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.ts index 68dc7bbb75f5..319763c19970 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar-card-small/sidebar-card-small.component.ts @@ -16,6 +16,8 @@ export class SidebarCardSmallComponent { @Input({ required: true }) sidebarItem: SidebarCardElement; @Input() sidebarType?: SidebarTypes; @Input() itemSelected?: boolean; + /** Key used for grouping or categorizing sidebar items */ + @Input() groupKey?: string; constructor( private sidebarEventService: SidebarEventService, diff --git a/src/main/webapp/app/shared/sidebar/sidebar-card.directive.ts b/src/main/webapp/app/shared/sidebar/sidebar-card.directive.ts index d197f711bc6b..dc248d99d527 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-card.directive.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar-card.directive.ts @@ -13,6 +13,7 @@ export class SidebarCardDirective implements OnInit, OnDestroy { @Input() sidebarItem: SidebarCardElement; @Input() sidebarType?: SidebarTypes; @Input() itemSelected?: boolean; + @Input() groupKey?: string; @Output() onUpdateSidebar = new EventEmitter(); @@ -42,12 +43,32 @@ export class SidebarCardDirective implements OnInit, OnDestroy { private assignAttributes() { if (this.componentRef) { + if (this.groupKey !== undefined) { + this.componentRef.instance.groupKey = this.groupKey; + } + this.componentRef.instance.itemSelected = this.itemSelected; this.componentRef.instance.sidebarType = this.sidebarType; this.componentRef.instance.sidebarItem = this.sidebarItem; + this.componentRef.instance.sidebarItem.title = this.removeChannelPrefix(this.sidebarItem.title); + if (this.size == 'S') { this.componentRef.instance.onUpdateSidebar = this.onUpdateSidebar; } } } + + removeChannelPrefix(name: string): string { + const prefixes = ['exercise-', 'lecture-', 'exam-']; + const channelTypes = ['exerciseChannels', 'lectureChannels', 'examChannels']; + + if (channelTypes.includes(this.groupKey)) { + prefixes.forEach((prefix) => { + if (name?.startsWith(prefix)) { + name = name.substring(prefix.length); + } + }); + } + return name; + } } diff --git a/src/main/webapp/app/shared/sidebar/sidebar-event.service.ts b/src/main/webapp/app/shared/sidebar/sidebar-event.service.ts index b383a1847516..2db0f5fabfc4 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar-event.service.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar-event.service.ts @@ -4,7 +4,6 @@ import { BehaviorSubject } from 'rxjs'; @Injectable({ providedIn: 'root' }) export class SidebarEventService { private sidebarCardClickedEvent = new BehaviorSubject(null); - private sidebarAccordionPlusClickedEvent = new BehaviorSubject(null); emitSidebarCardEvent(itemId: string | number) { this.sidebarCardClickedEvent.next(itemId); @@ -17,13 +16,4 @@ export class SidebarEventService { sidebarCardEventListener() { return this.sidebarCardClickedEvent.asObservable(); } - - emitSidebarAccordionPlusClickedEvent(groupkey: string) { - this.sidebarAccordionPlusClickedEvent.next(groupkey); - this.sidebarAccordionPlusClickedEvent.next(null); - } - - sidebarAccordionPlusClickedEventListener() { - return this.sidebarAccordionPlusClickedEvent.asObservable(); - } } diff --git a/src/main/webapp/app/shared/sidebar/sidebar.component.html b/src/main/webapp/app/shared/sidebar/sidebar.component.html index a70e2a9e604f..d972ad363a29 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar.component.html +++ b/src/main/webapp/app/shared/sidebar/sidebar.component.html @@ -3,8 +3,8 @@
@if (searchFieldEnabled) { -
- +
+ @if (showFilter) {
@@ -17,8 +17,38 @@
} + + @if (inCommunication()) { +
+ + +
+ @if (sidebarData?.messagingEnabled) { + + + } + + +
+
+ }
} + @if (!sidebarData?.ungroupedData || !(sidebarData?.ungroupedData | searchFilter: ['title', 'type'] : searchValue)?.length) {
(); @Output() onUpdateSidebar = new EventEmitter(); - @Output() onPlusPressed = new EventEmitter(); + onDirectChatPressed = output(); + onGroupChatPressed = output(); + onBrowsePressed = output(); + onCreateChannelPressed = output(); @Input() searchFieldEnabled: boolean = true; @Input() sidebarData: SidebarData; @Input() courseId?: number; @@ -33,7 +36,7 @@ export class SidebarComponent implements OnDestroy, OnChanges, OnInit { @Input() channelTypeIcon?: ChannelTypeIcons; @Input() collapseState: CollapseState; @Input() showFilter: boolean = false; - + inCommunication = input(false); searchValue = ''; isCollapsed: boolean = false; @@ -42,7 +45,6 @@ export class SidebarComponent implements OnDestroy, OnChanges, OnInit { paramSubscription?: Subscription; profileSubscription?: Subscription; sidebarEventSubscription?: Subscription; - sidebarAccordionEventSubscription?: Subscription; routeParams: Params; isProduction = true; @@ -52,6 +54,11 @@ export class SidebarComponent implements OnDestroy, OnChanges, OnInit { readonly faFilter = faFilter; readonly faFilterCurrentlyApplied = faFilterCircleXmark; + readonly faUser = faUser; + readonly faUsers = faUsers; + readonly faPlusCircle = faPlusCircle; + readonly faSearch = faSearch; + readonly faHashtag = faHashtag; sidebarDataBeforeFiltering: SidebarData; @@ -65,6 +72,22 @@ export class SidebarComponent implements OnDestroy, OnChanges, OnInit { private modalService: NgbModal, ) {} + createNewChannel() { + this.onCreateChannelPressed.emit(); + } + + browseChannels() { + this.onBrowsePressed.emit(); + } + + createDirectChat() { + this.onDirectChatPressed.emit(); + } + + createGroupChat() { + this.onGroupChatPressed.emit(); + } + ngOnInit(): void { this.profileSubscription = this.profileService.getProfileInfo()?.subscribe((profileInfo) => { this.isProduction = profileInfo?.inProduction; @@ -84,17 +107,6 @@ export class SidebarComponent implements OnDestroy, OnChanges, OnInit { } } }); - - this.sidebarAccordionEventSubscription = this.sidebarEventService - .sidebarAccordionPlusClickedEventListener() - .pipe( - distinctUntilChanged(), // This ensures the function is only called when the actual value changes - ) - .subscribe((groupKey) => { - if (groupKey) { - this.onPlusPressed.emit(groupKey); - } - }); } ngOnChanges() { diff --git a/src/main/webapp/app/shared/sidebar/sidebar.module.ts b/src/main/webapp/app/shared/sidebar/sidebar.module.ts index fdb5efb40bff..5a6ca727a8b5 100644 --- a/src/main/webapp/app/shared/sidebar/sidebar.module.ts +++ b/src/main/webapp/app/shared/sidebar/sidebar.module.ts @@ -14,7 +14,6 @@ import { ArtemisSharedCommonModule } from '../shared-common.module'; import { SubmissionResultStatusModule } from 'app/overview/submission-result-status.module'; import { SidebarCardDirective } from 'app/shared/sidebar/sidebar-card.directive'; import { ConversationOptionsComponent } from 'app/shared/sidebar/conversation-options/conversation-options.component'; -import { AccordionAddOptionsComponent } from 'app/shared/sidebar/accordion-add-options/accordion-add-options.component'; import { ArtemisExamSharedModule } from 'app/exam/shared/exam-shared.module'; import { SearchFilterComponent } from 'app/shared/search-filter/search-filter.component'; @@ -39,8 +38,7 @@ import { SearchFilterComponent } from 'app/shared/search-filter/search-filter.co SidebarCardItemComponent, SidebarComponent, ConversationOptionsComponent, - AccordionAddOptionsComponent, ], - exports: [SidebarComponent, SidebarCardSmallComponent, SidebarCardMediumComponent, SidebarCardLargeComponent, ConversationOptionsComponent, AccordionAddOptionsComponent], + exports: [SidebarComponent, SidebarCardSmallComponent, SidebarCardMediumComponent, SidebarCardLargeComponent, ConversationOptionsComponent], }) export class ArtemisSidebarModule {} diff --git a/src/main/webapp/app/types/sidebar.ts b/src/main/webapp/app/types/sidebar.ts index cdaae8d3b99f..11575cf18592 100644 --- a/src/main/webapp/app/types/sidebar.ts +++ b/src/main/webapp/app/types/sidebar.ts @@ -32,8 +32,8 @@ export interface SidebarData { groupedData?: AccordionGroups; ungroupedData?: SidebarCardElement[]; storageId?: string; - showAccordionAddOption?: boolean; showAccordionLeadingIcon?: boolean; + messagingEnabled?: boolean; } export interface SidebarCardElement { diff --git a/src/main/webapp/i18n/de/buildAgents.json b/src/main/webapp/i18n/de/buildAgents.json index cabe778eee21..2cd4ca72def3 100644 --- a/src/main/webapp/i18n/de/buildAgents.json +++ b/src/main/webapp/i18n/de/buildAgents.json @@ -12,9 +12,19 @@ "recentBuildJobs": "Letzte Build Jobs", "running": "Laufend", "idle": "Inaktiv", + "paused": "Angehalten", "onlineAgents": "online Agent(en)", "of": "von", - "buildJobsRunning": "Build Jobs laufen" + "buildJobsRunning": "Build Jobs laufen", + "alerts": { + "buildAgentPaused": "Anfrage zum Anhalten des Build-Agenten erfolgreich gesendet. Der Agent akzeptiert keine neuen BuildJobs und wird die aktuellen BuildJobs entweder ordnungsgemäß beenden oder nach einer konfigurierbaren Anzahl von Sekunden abbrechen.", + "buildAgentResumed": "Anfrage zum Fortsetzen des BuildJobs erfolgreich gesendet. Der Agent wird wieder neue BuildJobs annehmen.", + "buildAgentPauseFailed": "Anhalten des Build-Agenten fehlgeschlagen.", + "buildAgentResumeFailed": "Fortsetzen des Build-Agenten fehlgeschlagen.", + "buildAgentWithoutName": "Der Name des Build-Agenten ist erforderlich." + }, + "pause": "Anhalten", + "resume": "Fortsetzen" } } } diff --git a/src/main/webapp/i18n/de/competency.json b/src/main/webapp/i18n/de/competency.json index 40c540dad5cb..cb07c639df52 100644 --- a/src/main/webapp/i18n/de/competency.json +++ b/src/main/webapp/i18n/de/competency.json @@ -172,6 +172,7 @@ "softDueDate": "Empfohlen bis", "masteryThreshold": "Schwellwert zum Erreichen der Kompetenz", "manage": { + "helpButton": "Hilfe", "importAllButton": "Alles eines Kurses importieren" }, "importSettings": { @@ -225,6 +226,7 @@ "titleUniqueValidationError": "Es gibt bereits eine Kompetenz/Voraussetzung mit diesem Titel in dem Kurs", "suggestedTaxonomy": "Vorschlag", "averageMastery": "Durchschnittliche Kompetenzbeherrschung der Studierenden", + "averageStudentScore": "Durchschnittliche Bewertung der Studierenden", "selectLecture": "Wähle eine Vorlesung aus", "noLectures": "Dieser Kurs hat keine Vorlesungen", "dropdown": "{{lectureTitle}} ({{ noOfConnectedUnits }} Vorlesungseinheiten verbunden)", @@ -239,6 +241,42 @@ "noOfParticipants": "Anzahl der Teilnehmenden", "participationRate": "Teilnahmerate" } + }, + "featureExplanation": { + "title": "Einführung in Kurskompetenzen", + "adaptiveLearning": { + "title1": "Was bedeutet adaptives Lernen?", + "paragraph1": "Adaptives Lernen schneidet die Lerninhalte auf die individuellen Bedürfnisse jedes einzelnen Studierenden zu und passt sie in Echtzeit an seine Leistungen an. Durch personalisierte Unterstützung und Herausforderungen hilft es den Studierenden, effizienter zu lernen, sich zu engagieren und den Lernstoff in ihrem eigenen Tempo zu bewältigen.", + "paragraph2": "Im Artemis bilden Kompetenzen die Grundlage für Adaptives Lernen. Sie sind übergreifende Lernziele, die durch die Interaktion mit verschiedenen Vorlesungen und Übungen erreicht werden können. Basierend auf diesen Kompetenzmodellen kann Artemis den Studierenden personalisierte Lernpfade anbieten, die ihren individuellen Bedürfnissen entsprechen.", + "title2": "Warum?", + "paragraph3": "Der kompetenzbasierte Unterricht ermöglicht es den Studierenden, sich die Fähigkeiten in ihrem eigenen Tempo anzueignen, was echte Fortschritte und Selbstvertrauen gewährleistet. Sie schafft eine personalisierte, ansprechende Lernerfahrung, die zu besseren Ergebnissen und langfristigem Erfolg führt. Auch ohne Lernpfade profitieren die Studierenden von der Möglichkeit, ihre Fortschritte zu verfolgen.", + "paragraph4": "Durch Lernpfade erhalten die Studierenden Empfehlungen zur Unterstützung ihrer Lernanstrengungen. So wird es für sie einfacher, alle erforderlichen Kompetenzen eines Kurses zu beherrschen." + }, + "courseCompetencyCreation": { + "title": "Wie erstellt man eine Kurskompetenz?", + "paragraph1": "Im Allgemeinen unterscheiden wir zwischen einer Kompetenz und einer Voraussetzung.", + "paragraph2": "Um eine Kompetenz zu erstellen, klicke auf die Schaltfläche „Kompetenz erstellen“ am oberen Rand der Kompetenzseite. Auf der Erstellungsseite kann eindeutiger Name und eine passende Beschreibung für die Kompetenz angeben werden. Außerdem gibt es die Möglichkeit, ein empfohlenes Abschlussdatum festzulegen, das den Lernenden anzeigt, bis wann sie die verbundenen Lernobjekte beherrschen sollten.", + "paragraph3": "Im Kompetenzbereich kann auch eine Taxonomie hinzugefügt werden, um den Studierenden einen besseren Einblick in den Zweck des Kompetenzbereichs zu geben. Wenn bestimmte Lernobjekte innerhalb dieses Kompetenzbereichs optional sind, kann eine Schwelle festgelegt werden, ab der der Kompetenzbereich als beherrscht gilt. Es gibt auch die Möglichkeit, den gesamten Kompetenzbereich als optional zu kennzeichnen.", + "paragraph4": "Außerdem können Vorlesungseinheiten direkt mit dem Kompetenzbereich verknüpft werden. Es können zwar auch Übungen mit einem Kompetenzbereich verknüpft werden, dies muss jedoch in der Ansicht zur Bearbeitung/Erstellung von Übungen geschehen.", + "paragraph5": "Neben der Möglichkeit, Kompetenzen oder Voraussetzungen selbst zu erstellen, besteht auch die Möglichkeit, diese aus anderen Kursen zu importieren oder standardisierte Kompetenzen zu verwenden. Weitere Informationen zu diesem Prozess enthält das Benutzerhandbuch für Artemis." + }, + "courseCompetencyRelations": { + "title": "Was sind Relationen zwischen Kurskompetenzen?", + "paragraph1": "Lernkompetenzen können aufeinander aufbauen oder voneinander abhängig sein, weshalb Sie verschiedene Arten von Beziehungen zwischen ihnen herstellen können. Die Kompetenzen können sich entweder \"Stimmt überein mit\", \"Erweitert\" oder \"Setzt voraus\". Im Folgenden werden diese Beziehungen ausführlich beschrieben.", + "paragraph2": "Zusammenfassend:", + "paragraph3": "Bei \"Stimmt überein mit\" geht es um die Gleichwertigkeit zweier Fähigkeiten.
\"Erweitert\" bedeutet, dass man auf einer vorhandenen Fähigkeit aufbaut.
\"Setzt voraus\" bedeutet, dass eine Fähigkeit Voraussetzung für eine andere ist.", + "paragraph4": "Um diese Beziehungen zu erstellen, öffne das Modal „Beziehungen bearbeiten“. In diesem Modal kann man die verbundenen Kompetenzen auswählen oder nacheinander auf jede einzelne klicken. Danach kann der gewünschte Beziehungstyp gewählt und die Beziehung erstellt werden. Um eine Beziehung zu aktualisieren oder zu löschen, klicke einfach auf die betreffende Beziehung und aktualisiere entweder den Beziehungstyp im Formular oder lösche ihn.", + "relationTitle1": "1. Stimmt überein mit", + "relationParagraph1": "Diese Beziehung impliziert, dass zwei Kompetenzen auf demselben Niveau sind und dieselben Fähigkeiten und Anforderungen abdecken. Wenn man die eine hat, hat man auch schon die andere, und sie können als austauschbar betrachtet werden.", + "exampleLabel": "Beispiel:", + "relationParagraph2": "Kompetenz A: Balancieren auf einem stationären Fahrrad. Kompetenz B: Auf einem Bein stehen (balancieren, ohne sich zu bewegen). Hier könnte das Balancieren auf einem stationären Fahrrad „stimmt überein mit“ mit dem Balancieren auf einem Bein sein, da beide die gleiche grundlegende Fähigkeit des Gleichgewichts erfordern. Wenn du das eine kannst, kannst du höchstwahrscheinlich auch das andere, da die Kernkompetenz (Gleichgewicht) in beiden Szenarien dieselbe ist.", + "relationTitle2": "2. Erweitert", + "relationParagraph3": "Diese Beziehung bedeutet, dass eine Kompetenz auf einer anderen aufbaut, indem sie komplexer oder umfangreicher wird. Mit anderen Worten: Wenn du eine Kompetenz beherrschst, kannst du zur Beherrschung der erweiterten Kompetenz übergehen, die diese Fähigkeit weiter ausbaut.", + "relationParagraph4": "Kompetenz A: Mit dem Fahrrad in einer geraden Linie fahren. Kompetenz B: Mit dem Fahrrad um Kurven und Abbiegungen fahren. Das Fahren in einer geraden Linie ist die grundlegende Fähigkeit, die sich auf das Fahren in Kurven und beim Abbiegen ausweitet. Kompetenz B erweitert Kompetenz A um die Notwendigkeit, Richtungsänderungen zu bewältigen und dabei das Gleichgewicht und die Kontrolle zu behalten. Sobald du in einer geraden Linie fahren kannst, bist du bereit, diese Fähigkeit auf komplexere Fahrszenarien auszuweiten.", + "relationTitle3": "3. Setzt voraus", + "relationParagraph5": "Diese Beziehung impliziert, dass eine Kompetenz davon abhängt, dass eine andere bereits beherrscht wird. Um die fortgeschrittenere Kompetenz ausüben zu können, muss der Lernende zunächst die zugrunde liegende Fähigkeit oder das Wissen besitzen.", + "relationParagraph6": "Kompetenz A: Sicheres Fahren mit dem Fahrrad in flachem Gelände. Kompetenz B: Mit dem Fahrrad bergauf fahren. Das Fahren mit dem Fahrrad bergauf setzt voraus, dass der Lernende bereits das Fahren auf ebenem Gelände beherrscht. Die Beherrschung des Fahrens in der Ebene ist eine Voraussetzung, da das Fahren bergauf einen größeren Widerstand darstellt und zusätzliche Kraft und Technik erfordert. Ohne die Beherrschung der grundlegenden Fähigkeiten des Fahrens in der Ebene ist der Lernende nicht in der Lage, das Fahren bergauf in Angriff zu nehmen." + } } }, "prerequisite": { @@ -281,6 +319,11 @@ "edit": { "title": "Bearbeite eine Voraussetzung" }, + "importAll": { + "title": "Alle Kompetenzen eines Kurses importieren", + "success": "{{ noOfCompetencies }} Kompetenzen aus dem Kurs \"{{ courseTitle }}\" importiert.", + "warning": "Es wurden keine Kompetenzen für den Kurs \"{{ courseTitle }}\" gefunden." + }, "competencyCard": { "delete": { "question": "Willst du wirklich die Voraussetzung {{ title }} löschen? Du kannst diese Aktion nicht rückgängig machen!", diff --git a/src/main/webapp/i18n/de/conversation.json b/src/main/webapp/i18n/de/conversation.json index 7a07b66d408b..1e35654026e4 100644 --- a/src/main/webapp/i18n/de/conversation.json +++ b/src/main/webapp/i18n/de/conversation.json @@ -192,12 +192,7 @@ } }, "channelOverview": { - "title": { - "general": "Alle allgemeinen Kanäle im Kurs {{ courseTitle }}", - "exercise": "Alle Aufgabenkanäle im Kurs {{ courseTitle }}", - "lecture": "Alle Vorlesungskanäle im Kurs {{ courseTitle }}", - "exam": "Alle Klausurkanäle im Kurs {{ courseTitle }}" - }, + "title": "Alle Kanäle im Kurs {{ courseTitle }}", "otherChannels": "Andere Kanäle", "createChannelButton": "Erstelle einen neuen Kanal", "channelItem": { diff --git a/src/main/webapp/i18n/de/dragAndDropSubmittedAnswer.json b/src/main/webapp/i18n/de/dragAndDropSubmittedAnswer.json index 21bb95afa9a7..d7165bae8e1c 100644 --- a/src/main/webapp/i18n/de/dragAndDropSubmittedAnswer.json +++ b/src/main/webapp/i18n/de/dragAndDropSubmittedAnswer.json @@ -14,7 +14,8 @@ "detail": { "title": "Drag-and-Drop eingereichte Antwort" }, - "mappings": "Zuordnungen" + "mappings": "Zuordnungen", + "assignments": "Anweisungen" } } } diff --git a/src/main/webapp/i18n/de/editor.json b/src/main/webapp/i18n/de/editor.json index 1c1db6d76147..abd74a5c2b5f 100644 --- a/src/main/webapp/i18n/de/editor.json +++ b/src/main/webapp/i18n/de/editor.json @@ -64,6 +64,7 @@ "deleteFolderTitle": "Verzeichnis löschen", "deleteFileConfirm": "Bist Du sicher, dass Du die Datei {{filename}} löschen willst?", "deleteFolderConfirm": "Bist Du sicher, dass Du das Verzeichnis {{filename}} und alle enthaltenen Dateien löschen willst?", + "delete": "Löschen bestätigen", "unsavedChanges": "Datei enthält ungespeicherte Änderungen", "createFolderRoot": "Verzeichnis auf Root Level erstellen", "createFileRoot": "Datei auf Root Level erstellen", diff --git a/src/main/webapp/i18n/de/exam.json b/src/main/webapp/i18n/de/exam.json index 18a4ad5d81d3..48db3f680269 100644 --- a/src/main/webapp/i18n/de/exam.json +++ b/src/main/webapp/i18n/de/exam.json @@ -213,6 +213,7 @@ "examScores": { "xAxes": "Ergebnis in %", "xAxesSuffix": " + {Notenname}", + "xAxesSuffixNoBonus": " + {Notenname}", "xAxesSuffixBonus": " + {Bonuspunkte}", "yAxes": "Anzahl Teilnehmende", "highlightPassedMedian": "Hebe Median aller bestandenen Klausuren im Diagramm hervor: {{ median }}%", @@ -319,6 +320,7 @@ "notSynced": "Aufgabe nicht gespeichert", "notStarted": "Aufgabe nicht gestartet", "submitted": "Du hast eine Lösung für die Aufgabe eingereicht. Du kannst die Aufgabe weiter bearbeiten und erneut abgeben.", + "submittedSubmissionLimitReached": "Du hast eine Lösung für die Aufgabe eingereicht. Du kannst keine Lösungen mehr einreichen, weil du das Limit erreicht hast.", "notSubmitted": "Aufgabe nicht eingereicht", "notSavedOrSubmitted": "Du hast Änderungen, die nicht abgesendet sind.", "saveSubmissionError": "Die Änderungen konnten nicht gespeichert werden! Bitte stelle sicher, dass du online bist und speichere nochmal.", diff --git a/src/main/webapp/i18n/de/exercise-actions.json b/src/main/webapp/i18n/de/exercise-actions.json index b4f2ce5c25d4..f2050c3aef59 100644 --- a/src/main/webapp/i18n/de/exercise-actions.json +++ b/src/main/webapp/i18n/de/exercise-actions.json @@ -19,6 +19,7 @@ "openCodeEditor": "Programmiereditor öffnen", "openPracticeCodeEditor": "Programmiereditor zum Üben öffnen", "openGradedCodeEditor": "Programmiereditor öffnen", + "choseGradedMode": "Bewertete Teilnahme gewählt", "openModelingEditor": "Modellierungseditor öffnen", "importIntoIDE": "In deiner IDE öffnen", "openOnlineIDE": "Online IDE öffnen", diff --git a/src/main/webapp/i18n/de/exerciseAssessmentDashboard.json b/src/main/webapp/i18n/de/exerciseAssessmentDashboard.json index 532f09c8c8d2..768f8a2d863f 100644 --- a/src/main/webapp/i18n/de/exerciseAssessmentDashboard.json +++ b/src/main/webapp/i18n/de/exerciseAssessmentDashboard.json @@ -40,6 +40,7 @@ "toRead": "zum Lesen", "toReview": "zur Überprüfung", "totalExamples": "Es gibt {{total}} Beispielabgaben: {{toRead}} zum Lesen und {{toAssess}} zur Bewertung.", + "totalExampleSubmissions": "Es gibt {{total}} Beispielabgaben: {{toRead}} zum Lesen and {{toAssess}} zur Bewertung.", "readSubmissions": "Überprüfung von Beispielabgaben", "start": "", "continue": "", diff --git a/src/main/webapp/i18n/de/faq.json b/src/main/webapp/i18n/de/faq.json index 0cb07d298310..987b093de2c7 100644 --- a/src/main/webapp/i18n/de/faq.json +++ b/src/main/webapp/i18n/de/faq.json @@ -20,7 +20,9 @@ "questionAnswer": "Antwort auf die Frage", "categories": "Kategorien" }, - "course": "Kurs" + "course": "Kurs", + "noExisting": "Momentan existiert für diesen Kurs noch kein FAQ.", + "noMatching": "Es gibt kein FAQ, das die Kombination aus Filter- und Suchkriterien erfüllt." } } } diff --git a/src/main/webapp/i18n/de/global.json b/src/main/webapp/i18n/de/global.json index b809dec61943..3b8195fea41d 100644 --- a/src/main/webapp/i18n/de/global.json +++ b/src/main/webapp/i18n/de/global.json @@ -35,6 +35,7 @@ "quizExercise": "Quiz Aufgabe", "lecture": "Vorlesung", "competency": "Kompetenz", + "ltiOutcomeUrl": "LTI-Outcome-URL", "submittedAnswer": "Eingereichte Antwort", "quizQuestion": "Frage", "multipleChoiceQuestion": "Multiple-Choice Frage", @@ -207,6 +208,7 @@ "confirm": "Bestätigen", "download": "Herunterladen", "dashboard": "Dashboard", + "exportRepos": "Repositories herunterladen", "units": "Einheiten", "edit": "Bearbeiten", "connect": "Verknüpfen", diff --git a/src/main/webapp/i18n/de/learningPathManagement.json b/src/main/webapp/i18n/de/learningPathManagement.json new file mode 100644 index 000000000000..b21ec355fbd3 --- /dev/null +++ b/src/main/webapp/i18n/de/learningPathManagement.json @@ -0,0 +1,60 @@ +{ + "artemisApp": { + "learningPathManagement": { + "learningPathsDisabled": { + "title": "Willkommen bei der Lernpfadverwaltung!", + "description": "Die Lernpfadfunktion ist derzeit für diesen Kurs deaktiviert. Mit dieser Funktion können Kursteilnehmer einen personalisierten Lernpfad verfolgen, der auf den definierten Kompetenzen basiert. Jeder Lernpfad wird auf der Grundlage des individuellen Fortschritts des Teilnehmers, der Beziehungen zwischen den Kompetenzen und der festgelegten Fälligkeitsdaten erstellt. Mit dem folgenden Button kann die Lernpfadfunktion aktiviert werden.", + "buttonLabel": "Lernpfade aktivieren" + }, + "learningPathsState": { + "title": "Status", + "emptyState": "Alles ist eingerichtet und bereit!", + "refreshButtonLabel": "Aktualisieren", + "type": { + "missing": { + "title": "Fehlende Lernpfade", + "description": "Einige Studierende haben ihre Lernpfade noch nicht generiert. Ihre Lernpfade werden erst erstellt, wenn sie ihren Lernpfad zum ersten Mal anfordern.", + "actionButton": "Lernpfad generieren", + "successAlert": "Lernpfade wurden erfolgreich generiert." + }, + "noCompetencies": { + "title": "Keine Kompetenzen", + "description": "Es existieren noch keine Kompetenzen für diesen Kurs. Bitte erstelle Kompetenzen für diesen Kurs.", + "actionButton": "Kompetenzen zuweisen" + }, + "noRelations": { + "title": "Keine Kompetenzbeziehungen", + "description": "Einigen Kompetenzen wurden noch keine Beziehungen zugewiesen. Bitte weise diesen Kompetenzen Beziehungen zu.", + "actionButton": "Beziehungen zuweisen" + } + } + }, + "learningPathsConfiguration": { + "title": "Konfiguration", + "saveButtonLabel": "Speichern", + "editButtonLabel": "Bearbeiten", + "configuration": { + "includeAllGradedExercises": "Alle bewerteten Aufgaben einbeziehen", + "includeAllGradedExercisesToolTip": "Die Lernpfade werden alle Aufgaben enthalten, die in die Kursbewertung einfließen. Dadurch können Studierende keine wichtigen Aufgaben im Lernpfad übersehen." + }, + "saveSuccess": "Die Konfiguration wurde erfolgreich gespeichert." + }, + "learningPathsTable": { + "title": "Individuelle Lernpfade", + "searchPlaceholder": "Suchen", + "columnLabel": { + "name": "Name", + "login": "Login", + "progress": "Fortschritt" + }, + "noResults": "Keine Lernpfade gefunden!" + }, + "learningPathsAnalytics": { + "title": "Analyse", + "graphSelection": { + "AVERAGE_MASTERY_PROGRESS": "Ø Beherrschungsfortschritt" + } + } + } + } +} diff --git a/src/main/webapp/i18n/de/lectureUnit.json b/src/main/webapp/i18n/de/lectureUnit.json index 41fe6c3255fd..2ed9397e04ff 100644 --- a/src/main/webapp/i18n/de/lectureUnit.json +++ b/src/main/webapp/i18n/de/lectureUnit.json @@ -15,6 +15,7 @@ }, "releaseDate": "Veröffentlichungsdatum", "details": { + "title": "Eigenschaften", "releaseDateNotSet": "Kein Veröffentlichungsdatum gesetzt!", "releaseDateSet": "Veröffentlichungsdatum: ", "attachmentVersion": "Dateiversion: " @@ -86,7 +87,7 @@ "description": "Beschreibung", "notReleasedTooltip": "Onlineeinheit nur sichtbar für Tutor:innen und Lehrende. Veröffentlichungsdatum:", "doOpen": "Link öffnen", - "createVideoUnit": { + "createOnlineUnit": { "title": "Erstelle Onlineeinheit", "name": "Name", "namePlaceHolder": "Gib der Onlineeinheit einen Namen", diff --git a/src/main/webapp/i18n/de/metrics.json b/src/main/webapp/i18n/de/metrics.json index 4c6034248943..c564bdb825aa 100644 --- a/src/main/webapp/i18n/de/metrics.json +++ b/src/main/webapp/i18n/de/metrics.json @@ -80,7 +80,15 @@ "cachename": "Cache Name", "hits": "Treffer", "misses": "Keine Treffer", - "evictions": "Anzahl entfernter Objekte" + "gets": "Cache Gets", + "puts": "Cache Hinzufügungen", + "removals": "Cache Entfernungen", + "evictions": "Anzahl entfernter Objekte", + "hitPercent": "Cache Hit %", + "missPercent": "Cache Miss %", + "averageGetTime": "Durchschnitt get Zeit (µs)", + "averagePutTime": "Durchschnitt put Zeit (µs)", + "averageRemoveTime": "Durchschnitt remove Zeit (µs)" }, "datasource": { "usage": "Usage", diff --git a/src/main/webapp/i18n/de/notification.json b/src/main/webapp/i18n/de/notification.json index bc479b170f0b..5c8f606c432c 100644 --- a/src/main/webapp/i18n/de/notification.json +++ b/src/main/webapp/i18n/de/notification.json @@ -14,8 +14,10 @@ "showAllSavedNotifications": "Zeige alle gespeicherten Benachrichtigungen", "hideAllCurrentlyDisplayedNotifications": "Verstecke alle aktuell dargestellten Benachrichtigungen", "target": { + "newAnswer": "Antwort ansehen", "newAnswerPost": "Antwort ansehen", "newPost": "Beitrag ansehen", + "newQuestion": "Frage ansehen", "exerciseCreated": "Übung ansehen", "exerciseUpdated": "Übung ansehen", "attachmentUpdated": "Vorlesung ansehen" diff --git a/src/main/webapp/i18n/de/organizationManagement.json b/src/main/webapp/i18n/de/organizationManagement.json index a838d55db96d..c6b917d4d238 100644 --- a/src/main/webapp/i18n/de/organizationManagement.json +++ b/src/main/webapp/i18n/de/organizationManagement.json @@ -7,7 +7,7 @@ "url": "URL", "description": "Beschreibung", "logoUrl": "Logo URL", - "Nutzer:innens": "Nutzer:innen", + "users": "Nutzer:innen", "courses": "Kurse", "emailPattern": "E-Mail-Muster", "delete": { diff --git a/src/main/webapp/i18n/de/programmingExercise.json b/src/main/webapp/i18n/de/programmingExercise.json index d1bf21030478..e3a86ea5c71d 100644 --- a/src/main/webapp/i18n/de/programmingExercise.json +++ b/src/main/webapp/i18n/de/programmingExercise.json @@ -56,6 +56,7 @@ "steps": { "generalInfoStepTitle": "Informationen", "difficultyStepTitle": "Modus", + "buildPlansTitle": "Build-Pläne", "languageStepTitle": "Sprache", "gradingStepTitle": "Benotung", "problemStepTitle": "Problem", @@ -65,6 +66,7 @@ "generalInfoStepTitle": "Allgemein", "generalInfoStepMessage": "Eingabe von Informationen, die die Grundlage für die Programmieraufgabe bilden", "difficultyStepTitle": "Modus", + "buildPlansTitle": "Build-Pläne", "difficultyStepMessage": "Konfiguration der Einstellungen bezüglich der Bearbeitung und Kollaboration der Aufgabe", "languageStepTitle": "Sprache", "languageStepMessage": "Wähle die gewünschte Programmiersprache aus und konfiguriere zusätzliche Funktionen bezüglich der Build Umgebung", @@ -135,18 +137,21 @@ "workdir": "Verzeichnis", "allowOnlineEditor": { "title": "Online-Editor erlauben", + "description": "Ein Online-Texteditor mit Datei-Explorer und Code-Hervorhebungsfunktionen, jedoch ohne die Möglichkeit, Code zu kompilieren oder auszuführen.", "alert": "Es muss mindestens eine Option (Offline-IDE, Online-Editor oder Online-IDE) ausgewählt sein", "alertNoTheia": "Es muss mindestens eine Option (Offline-IDE oder Online-Editor) ausgewählt sein" }, "onlineEditor": "Online", "allowOfflineIde": { "title": "Offline-IDE erlauben", + "description": "Erlaubt Studierenden die Übung mit Git herunterzuladen und diese lokal mit der bevorzugten IDE zu bearbeiten.", "alert": "Es muss mindestens eine Option (Offline-IDE, Online-Editor oder Online-IDE) ausgewählt sein", "alertNoTheia": "Es muss mindestens eine Option (Offline-IDE oder Online-Editor) ausgewählt sein" }, "offlineIde": "IDE", "allowOnlineIde": { "title": "Online-IDE erlauben", + "description": "Eine auf Visual Studio Code basierende Online-Entwicklungsumgebung mit Code-Hervorhebungs- und Formatierungsfunktionen. Vorkonfiguriert für die Sprache der Übung und mit der Möglichkeit, Code online zu kompilieren oder auszuführen.", "alert": "Es muss mindestens eine Option (Offline-IDE, Online-Editor oder Online-IDE) ausgewählt sein.", "alertNoTheia": "Es muss mindestens eine Option (Offline-IDE oder Online-Editor) ausgewählt sein" }, @@ -518,10 +523,12 @@ "repositoryName": "Name des Repositorys", "checkoutDirectory": "Checkout-Verzeichnis", "description": "Beschreibung", + "invalidRepositoryName": "Es existiert bereits ein Repository mit diesem Namen in der Aufgabe.", "duplicateRepositoryNames": "Verschiedene Hilfs-Repositories dürfen nicht den gleichen Namen haben.", "duplicateDirectoryNames": "Verschiedene Hilfs-Repositories dürfen nicht das gleiche Checkout-Verzeichnis haben.", "warning": "Hilfs-Repositories können hinzugefügt, editiert und gelöscht werden. Editierungen wirken sich allerdings nicht auf das VCS und CIS aus und müssen dort manuell durchgeführt werden.", "editedWarning": "Du hast die Hilfs-Repositories verändert. Diese Änderungen wirken sich allerdings nicht auf das VCS und CIS aus und müssen dort manuell durchgeführt werden.", + "editedWarningLocalCI": "Du hast die Hilfs-Repositories verändert. Diese Änderungen wirken sich allerdings nicht auf das VCS und CIS aus und müssen dort manuell durchgeführt werden.", "repositoryNameRequired": { "pattern": "Der Name eines Hilfs-Repositories darf nicht 'exercise', 'solution', 'tests', oder 'auxiliary' sein. Außerdem darf der Name nur Wörter und die Sonderzeichen '-' und '_' enthalten." }, diff --git a/src/main/webapp/i18n/de/quizExercise.json b/src/main/webapp/i18n/de/quizExercise.json index aa444778ac1c..d04f13e11078 100644 --- a/src/main/webapp/i18n/de/quizExercise.json +++ b/src/main/webapp/i18n/de/quizExercise.json @@ -308,12 +308,6 @@ "join": "Bearbeiten", "joinFailed": "Dem Quiz konnte nicht beigetreten werden.", "submitSuccess": "Deine Antworten wurden erfolgreich abgegeben.

Die Ergebnisse sind verfügbar, nachdem das Quiz beendet ist." - }, - "quizLiveModal": { - "title": "Go-Live einer neuen Quiz-Übung", - "body": "Das Quiz {{quizName}} für den Kurs {{courseName}} ist nun aktiv! Klick auf den 'Weiter zum Quiz' Button, um zum Quiz zu gelangen.", - "cancelButton": "Abbrechen", - "goToButton": "Weiter zum Quiz" } } } diff --git a/src/main/webapp/i18n/de/student-dashboard.json b/src/main/webapp/i18n/de/student-dashboard.json index 5906220b4d8a..a14592b067dc 100644 --- a/src/main/webapp/i18n/de/student-dashboard.json +++ b/src/main/webapp/i18n/de/student-dashboard.json @@ -70,6 +70,8 @@ "examChannels": "Klausuren", "createChannel": "Kanal erstellen", "browseChannels": "Kanäle durchsuchen", + "createGroupChat": "Gruppenchat erstellen", + "createDirectChat": "Direkt-Chat erstellen", "groupChats": "Gruppenchats", "directMessages": "Direktnachrichten", "filterConversationPlaceholder": "Konversationen filtern" @@ -104,6 +106,7 @@ "achievablePoints": "Erreichbare Punktzahl", "applyFilter": "Filter anwenden", "resetFilter": "Filter zurücksetzen", + "clearFilter": "Filter entfernen", "noFilterAvailable": "Für die bisherigen Aufgaben gibt es keine unterscheidenden Filteroptionen", "noMoreOptions": "Keine weiteren Auswahlmöglichkeiten" }, @@ -136,6 +139,7 @@ "notReleased": "Nicht freigegeben", "live": "Live", "shortDueDate": "Bis", + "userNotAssignedToTeam": "Du wurdest noch keinem Team zugeteilt.", "userNotStartedExercise": "Du hast mit der Aufgabe noch nicht angefangen.", "exerciseSubmitted": "Bereits abgegeben, Änderungen sind noch möglich.", "exerciseSubmittedWaitingForGrading": "Bereits abgegeben, noch keine Bewertung.", @@ -148,6 +152,7 @@ "userParticipating": "Du nimmst gerade an diesem Quiz teil.", "userSubmitted": "Du hast bereits abgegeben.", "userNotStartedExerciseShort": "Nicht angefangen", + "userNotAssignedToTeamShort": "Noch kein Team", "exerciseNotSubmittedShort": "Nicht abgegeben", "exerciseMissedDueDateShort": "Frist abgelaufen", "quizNotStartedShort": "Nicht begonnen", diff --git a/src/main/webapp/i18n/de/userSettings.json b/src/main/webapp/i18n/de/userSettings.json index 6a2ebecc1763..0771455d4e2a 100644 --- a/src/main/webapp/i18n/de/userSettings.json +++ b/src/main/webapp/i18n/de/userSettings.json @@ -118,7 +118,7 @@ }, "settingDescriptions": { "basicWeeklySummaryDescription": "Erhalte jeden Freitag um 17:00 Uhr eine einfache wöchentliche Zusammenfassung (bsp. welche neuen Aufgaben diese Woche veröffentlicht wurden und noch bearbeitbar sind)", - "exerciseCreatedOrStartedDescription": "Erhalte eine Mitteilung, wenn eine neue Aufgabe veröffentlicht wurde", + "exerciseReleasedDescription": "Erhalte eine Mitteilung, wenn eine Aufgabe veröffentlicht wurde", "exerciseOpenForPracticeDescription": "Erhalte eine Mitteilung, wenn eine Aufgabe zum Üben freigeschaltet wurde (z.B. ein Quiz)", "exerciseSubmissionAssessedDescription": "Erhalte eine Mitteilung, wenn deine eingereichten Aufgaben bewertet wurden", "newExercisePostDescription": "Erhalte eine Mitteilung, wenn eine neue Nachricht zu einer Aufgabe erstellt wurde", diff --git a/src/main/webapp/i18n/en/buildAgents.json b/src/main/webapp/i18n/en/buildAgents.json index 195a549cda0f..e1401d97e272 100644 --- a/src/main/webapp/i18n/en/buildAgents.json +++ b/src/main/webapp/i18n/en/buildAgents.json @@ -12,9 +12,19 @@ "recentBuildJobs": "Recent build jobs", "running": "Running", "idle": "Idle", + "paused": "Paused", "onlineAgents": "online agent(s)", "of": "of", - "buildJobsRunning": "build jobs running" + "buildJobsRunning": "build jobs running", + "alerts": { + "buildAgentPaused": "Build agent pause request sent successfully. The agent will not accept new build jobs and will gracefully finish the current build jobs or will cancel them after a configurable seconds.", + "buildAgentResumed": "Build agent resume request sent successfully. The agent will start accepting new build jobs.", + "buildAgentPauseFailed": "Failed to pause the build agent.", + "buildAgentResumeFailed": "Failed to resume the build agent.", + "buildAgentWithoutName": "Build agent name is required." + }, + "pause": "Pause", + "resume": "Resume" } } } diff --git a/src/main/webapp/i18n/en/competency.json b/src/main/webapp/i18n/en/competency.json index 9baf2d9d4975..c056c0d50d94 100644 --- a/src/main/webapp/i18n/en/competency.json +++ b/src/main/webapp/i18n/en/competency.json @@ -172,6 +172,7 @@ "softDueDate": "Recommended until", "masteryThreshold": "Mastery threshold", "manage": { + "helpButton": "Help", "importAllButton": "Import all of a course" }, "importSettings": { @@ -207,6 +208,7 @@ "create": { "titleUniqueValidationError": "There already exists a competency/prerequisite with this title in the course", "suggestedTaxonomy": "Suggested", + "averageMastery": "Average competency mastery of students", "averageStudentScore": "Average student mastery", "selectLecture": "Select a Lecture", "noLectures": "This course has no lectures", @@ -239,6 +241,42 @@ "ANALYZE": "differentiate, examine, experiment, question, relate, test, break down, contrast, distinguish", "EVALUATE": "appraise, argue, choose, defend, judge, select, support, value, critique", "CREATE": "design, formulate, hypothesize, invent, plan, propose, write, assemble, construct, develop" + }, + "featureExplanation": { + "title": "Introduction to course competencies", + "adaptiveLearning": { + "title1": "What is Adaptive Learning?", + "paragraph1": "Adaptive learning tailors educational content to each student's unique needs, adjusting in real-time based on their performance. By providing personalized support and challenges, it helps students learn more efficiently, stay engaged, and achieve mastery at their own pace.", + "paragraph2": "In Artemis course competencies are the foundation for Adaptive Learning. They are overarching learning objectives that can be obtained by interacting with different lectures and exercises. Based on these competency models Artemis can offer students personalized learning paths that fit their individual needs.", + "title2": "Why?", + "paragraph3": "Competency-based education empowers students to master skills at their own pace, ensuring real progress and confidence. It creates a personalized, engaging learning experience that leads to better outcomes and long-term success. So, even without enabling learning paths, students benefit from being able to track their progress.", + "paragraph4": "With learning paths, students receive recommendations to support their learning efforts. Making it easier for them to master all the required competencies of a course." + }, + "courseCompetencyCreation": { + "title": "How to create a course competency?", + "paragraph1": "In general we distinguish between a competency and a prerequisite.", + "paragraph2": "To create a competency, click the 'Create Competency' button at the top of the competency page. On the creation page, you can specify a unique name and an appropriate description for the competency. Additionally, you have the option to set a recommended completion date, which indicates to students by when they should master the connected learning objects.", + "paragraph3": "You can also add taxonomy to the competency, providing students with greater insight into its purpose. If certain learning objects within this competency are optional, you can establish a threshold for when the competency will be considered mastered. You also have the option to mark the entire competency as optional.", + "paragraph4": "Finally, you can directly link lecture units to the competency. While you can also connect exercises to a competency, this must be done in the exercise edit/creation view.", + "paragraph5": "In addition to creating competencies or prerequisites yourself, you can also import them from other courses or utilize standardized competencies. For more information on this process, please refer to the user manual for Artemis." + }, + "courseCompetencyRelations": { + "title": "What are course competency relations?", + "paragraph1": "Course competencies can build upon or depend on one another, which is why you can establish different types of relationships between them. Competencies can either MATCH, EXTEND, or ASSUME each other. Detailed descriptions of these relationships are provided below.", + "paragraph2": "In summary:", + "paragraph3": "MATCH is about equivalency between two skills.
EXTEND is about building on an existing skill.
ASSUME means one skill is a prerequisite for another.", + "paragraph4": "To create these relationships, open the 'Edit Relations' modal. In this modal, you can either select the related competencies or click on each one consecutively. After that, choose the desired relation type and create the relationship. To update or delete a relation, simply click on the specific relation and either update the relation type in the form or delete it.", + "relationTitle1": "1. MATCH", + "relationParagraph1": "This relationship implies that two competencies are at the same level, covering the same skills and requirements. If you have one, you already have the other, and they can be considered interchangeable.", + "exampleLabel": "Example:", + "relationParagraph2": "Competency A: Balancing on a stationary bike. Competency B: Standing on one leg (balancing without moving). Here, balancing on a stationary bike might \"MATCH\" balancing on one leg because both involve the same fundamental skill of balance. If you can do one, you're very likely able to do the other, as the core competency (balance) is the same in both scenarios.", + "relationTitle2": "2. EXTEND", + "relationParagraph3": "This relationship means one competency builds upon another by adding more complexity or breadth. In other words, once you have mastered one competency, you can move on to mastering the extended one, which takes that skill further.", + "relationParagraph4": "Competency A: Riding a bike in a straight line. Competency B: Riding a bike around curves and turns. Riding in a straight line is the foundational skill that \"EXTENDS\" into riding around curves and turns. Competency B extends Competency A by adding the need to navigate changes in direction while maintaining balance and control. Once you can ride in a straight line, you're ready to extend that ability to more complex riding scenarios.", + "relationTitle3": "3. ASSUME", + "relationParagraph5": "This relationship implies that one competency relies on another being already mastered. To perform the more advanced competency, the learner must first have the underlying skill or knowledge.", + "relationParagraph6": "Competency A: Riding a bike with confidence on flat terrain. Competency B: Riding a bike uphill. Riding a bike uphill ASSUMES that the learner has already mastered riding on flat terrain. The skill of riding on flat ground is a prerequisite because uphill riding adds more resistance and requires additional strength and technique. Without mastering the basic competency of flat-ground riding, the learner wouldn't be ready to tackle riding uphill." + } } }, "prerequisite": { diff --git a/src/main/webapp/i18n/en/complaint.json b/src/main/webapp/i18n/en/complaint.json index 2d879e4213de..83d4d2cb4324 100644 --- a/src/main/webapp/i18n/en/complaint.json +++ b/src/main/webapp/i18n/en/complaint.json @@ -69,6 +69,7 @@ "info": "Submitting a feedback request does not affect your number of allowed complaints, but your score will remain unchanged.", "review": "Review More Feedback Request", "alreadyHandled": "The request has been resolved", + "alreadySubmitted": "You already requested more feedback", "alreadySubmittedSubmissionAuthor": "You have already requested more feedback", "alreadySubmittedNotSubmissionAuthor": "The student has already requested more feedback", "acceptedLong": "Request was answered", diff --git a/src/main/webapp/i18n/en/conversation.json b/src/main/webapp/i18n/en/conversation.json index 40cb47bb8f98..93c350bf4c55 100644 --- a/src/main/webapp/i18n/en/conversation.json +++ b/src/main/webapp/i18n/en/conversation.json @@ -164,6 +164,7 @@ "maxError": "You can only add {{ max }} users", "addUserLabel": "Search for users in the course", "maxUsersNote": "Note: You can add {{ max }} users to this conversation", + "maxU": "Note: You can only add {{ max }} users to this conversation", "addIndividualUsers": "Add individual users", "addWholeGroups": "Add whole groups", "addAllStudents": "Add all students", @@ -191,12 +192,7 @@ } }, "channelOverview": { - "title": { - "general": "All General Channels in course {{ courseTitle }}", - "exercise": "All Exercise Channels in course {{ courseTitle }}", - "lecture": "All Lecture Channels in course {{ courseTitle }}", - "exam": "All Exam Channels in course {{ courseTitle }}" - }, + "title": "All Channels in course {{ courseTitle }}", "otherChannels": "Other Channels", "createChannelButton": "Create a new channel", "channelItem": { diff --git a/src/main/webapp/i18n/en/dragAndDropSubmittedAnswer.json b/src/main/webapp/i18n/en/dragAndDropSubmittedAnswer.json index 497a35543bba..25dc947b1a90 100644 --- a/src/main/webapp/i18n/en/dragAndDropSubmittedAnswer.json +++ b/src/main/webapp/i18n/en/dragAndDropSubmittedAnswer.json @@ -14,6 +14,7 @@ "detail": { "title": "Drag And Drop Submitted Answer" }, + "mappings": "Mappings", "assignments": "Assignments" } } diff --git a/src/main/webapp/i18n/en/editor.json b/src/main/webapp/i18n/en/editor.json index 266ce0333d74..18442db3ca14 100644 --- a/src/main/webapp/i18n/en/editor.json +++ b/src/main/webapp/i18n/en/editor.json @@ -33,6 +33,7 @@ "building": "Building and testing...", "buildFailed": "Build failed", "noBuildOutput": "No build results available", + "generatingFeedback": "Generating feedback...", "selectFile": "Select a file to get started!", "binaryFileSelected": "This is a binary file that cannot be displayed.", "downloadBuildResult": "Download Build Result", diff --git a/src/main/webapp/i18n/en/exam.json b/src/main/webapp/i18n/en/exam.json index 9792a7145dd0..f4f6df4f2fbe 100644 --- a/src/main/webapp/i18n/en/exam.json +++ b/src/main/webapp/i18n/en/exam.json @@ -212,6 +212,7 @@ }, "examScores": { "xAxes": "Score in %", + "xAxesSuffix": " + {Grade Name}", "xAxesSuffixNoBonus": " + {Grade Name}", "xAxesSuffixBonus": " + {Bonus Points}", "yAxes": "Number of Participants", @@ -468,6 +469,7 @@ "examStudentReviewStart": "Begin of Student Review", "examStudentReviewEnd": "End of Student Review", "exampleSolutionPublicationDateTooltip": "Students can see the example solutions for all exercises in the exam from this time onwards if they participated in the exam. Leave blank to disable.", + "studentReviewEnabled": "Student review enabled", "maxPoints": { "title": "Maximum number of points for exam", "warning": "Updating this field will update the grading scale for the exam if such exists, such that the points values for the grade steps still match the percentages, adjusted for the new maximum points value. This also affects all students' grades in the exam!" diff --git a/src/main/webapp/i18n/en/exampleSubmission.json b/src/main/webapp/i18n/en/exampleSubmission.json index d63e75979fd0..63cf358ffd47 100644 --- a/src/main/webapp/i18n/en/exampleSubmission.json +++ b/src/main/webapp/i18n/en/exampleSubmission.json @@ -31,6 +31,7 @@ "readSuccessfully": "You have successfully read and understood this example submission", "createNew": "Create new", "pageHeader": "Example Text Submission for Exercise", + "usedForTutorial": "Use in Tutorial", "assessmentTraining": "Assessment Training", "selectModel": "Select Assessment Training Mode:", "selectModelExplanation": "You can select the assessment training mode here. The assessment training mode defines how the tutor has to confirm that the example was understood.", diff --git a/src/main/webapp/i18n/en/exerciseAssessmentDashboard.json b/src/main/webapp/i18n/en/exerciseAssessmentDashboard.json index cf2d3b1c574e..84d5206f2ae9 100644 --- a/src/main/webapp/i18n/en/exerciseAssessmentDashboard.json +++ b/src/main/webapp/i18n/en/exerciseAssessmentDashboard.json @@ -39,6 +39,7 @@ "readAndUnderstood": "I have read and understood the instructions", "toRead": "to read", "toReview": "to review", + "totalExamples": "There are {{total}} example submissions: {{toRead}} to read and {{toAssess}} to assess.", "totalExampleSubmissions": "There are {{total}} example submissions: {{toRead}} to read and {{toAssess}} to assess.", "readSubmissions": "Read submissions", "start": "Start", diff --git a/src/main/webapp/i18n/en/faq.json b/src/main/webapp/i18n/en/faq.json index 1a158eb52c40..3fd403409d2b 100644 --- a/src/main/webapp/i18n/en/faq.json +++ b/src/main/webapp/i18n/en/faq.json @@ -20,7 +20,9 @@ "questionAnswer": "Question answer", "categories": "Categories" }, - "course": "Course" + "course": "Course", + "noExisting": "Currently, there is no FAQ available for this course.", + "noMatching": "There is no FAQ that matches the combination of filter and search criteria." } } } diff --git a/src/main/webapp/i18n/en/learningPathManagement.json b/src/main/webapp/i18n/en/learningPathManagement.json new file mode 100644 index 000000000000..0817497e0f23 --- /dev/null +++ b/src/main/webapp/i18n/en/learningPathManagement.json @@ -0,0 +1,60 @@ +{ + "artemisApp": { + "learningPathManagement": { + "learningPathsDisabled": { + "title": "Welcome to the learning path management!", + "description": "The learning path feature is currently disabled for this course. This feature enables students to follow a personalized learning path based on the competencies you have defined. Each learning path is generated based on the student's individual progress, the relationships between competencies, and the specified soft due dates. You can enable the learning path feature by clicking the button below.", + "buttonLabel": "Enable learning paths" + }, + "learningPathsState": { + "title": "State", + "emptyState": "Everything is set up and ready to go!", + "refreshButtonLabel": "Refresh", + "type": { + "missing": { + "title": "Missing learning paths", + "description": "Some students have not generated their learning paths yet. Their learning paths will be created once they request their learning path for the first time.", + "actionButton": "Generate learning paths", + "successAlert": "Learning paths have been generated successfully." + }, + "noCompetencies": { + "title": "No competencies", + "description": "Some students have not been assigned any competencies yet. Please assign competencies to these students.", + "actionButton": "Assign competencies" + }, + "noRelations": { + "title": "No relations", + "description": "Some competencies have not been assigned any relations yet. Please assign relations to these competencies.", + "actionButton": "Assign relations" + } + } + }, + "learningPathsConfiguration": { + "title": "Configuration", + "saveButtonLabel": "Save", + "editButtonLabel": "Edit", + "configuration": { + "includeAllGradedExercises": "Include all graded exercises", + "includeAllGradedExercisesToolTip": "The learning paths will include all exercises that are included in the course score. This way, students cannot miss important exercises in the learning path." + }, + "saveSuccess": "The configuration has been saved successfully." + }, + "learningPathsTable": { + "title": "Individual learning paths", + "searchPlaceholder": "Search", + "columnLabel": { + "name": "Name", + "login": "Login", + "progress": "Progress" + }, + "noResults": "No learning paths found!" + }, + "learningPathsAnalytics": { + "title": "Analytics", + "graphSelection": { + "AVERAGE_MASTERY_PROGRESS": "Ø Mastery progress" + } + } + } + } +} diff --git a/src/main/webapp/i18n/en/lectureUnit.json b/src/main/webapp/i18n/en/lectureUnit.json index d83040554b23..d54a06f188b1 100644 --- a/src/main/webapp/i18n/en/lectureUnit.json +++ b/src/main/webapp/i18n/en/lectureUnit.json @@ -149,6 +149,7 @@ "endPage": "End page must be less or equal to {{ max }}." }, "split": { + "empty": "", "unit": "Lecture Units", "unitName": "Unit Name", "releaseDate": "Release Date", diff --git a/src/main/webapp/i18n/en/modelingAssessment.json b/src/main/webapp/i18n/en/modelingAssessment.json index 1fe1b53bee3f..1040ce467a3a 100644 --- a/src/main/webapp/i18n/en/modelingAssessment.json +++ b/src/main/webapp/i18n/en/modelingAssessment.json @@ -2,6 +2,7 @@ "artemisApp": { "modelingAssessment": { "points": "Points", + "conflicts": "Conflicts", "assessor": "Assessor: {{firstName}} {{lastName}}", "noModel": "No model found to display", "invalidAssessments": "Your assessments are not valid!", diff --git a/src/main/webapp/i18n/en/multipleChoiceQuestion.json b/src/main/webapp/i18n/en/multipleChoiceQuestion.json index 2426e8563c8e..f342c31a56bc 100644 --- a/src/main/webapp/i18n/en/multipleChoiceQuestion.json +++ b/src/main/webapp/i18n/en/multipleChoiceQuestion.json @@ -37,6 +37,7 @@ "headingOne": "Heading One", "headingTwo": "Heading Two", "headingThree": "Heading Three", + "heading": "Heading", "quote": "Quote", "link": "Link", "orderedList": "Ordered List", diff --git a/src/main/webapp/i18n/en/notification.json b/src/main/webapp/i18n/en/notification.json index a027df9ace12..6c1e49a8bad0 100644 --- a/src/main/webapp/i18n/en/notification.json +++ b/src/main/webapp/i18n/en/notification.json @@ -15,6 +15,8 @@ "hideAllCurrentlyDisplayedNotifications": "Hide all currently displayed notifications", "target": { "newAnswer": "View reply", + "newAnswerPost": "View reply", + "newPost": "View post", "newQuestion": "View post", "exerciseCreated": "View exercise", "exerciseUpdated": "View exercise", diff --git a/src/main/webapp/i18n/en/programmingExercise.json b/src/main/webapp/i18n/en/programmingExercise.json index 9e88733b77e6..6929f51511f7 100644 --- a/src/main/webapp/i18n/en/programmingExercise.json +++ b/src/main/webapp/i18n/en/programmingExercise.json @@ -147,18 +147,21 @@ }, "allowOnlineEditor": { "title": "Allow Online Editor", + "description": "An online text editor featuring a file explorer, coding window, and code highlighting features but without the ability to compile or run code.", "alert": "At least one option (Offline IDE, Online Editor, or Online IDE) must be selected", "alertNoTheia": "At least one option (Offline IDE or Online Editor) must be selected" }, "onlineEditor": "Online", "allowOfflineIde": { "title": "Allow Offline IDE", + "description": "Enables students to download the exercise via Git and to work on it locally using their preferred IDE.", "alert": "At least one option (Offline IDE, Online Editor, or Online IDE) must be selected", "alertNoTheia": "At least one option (Offline IDE or Online Editor) must be selected" }, "offlineIde": "IDE", "allowOnlineIde": { "title": "Allow Online IDE", + "description": "An online coding environment based on Visual Studio Code featuring code highlighting and formatting features. Pre-configured to your exercise's language and with the ability to compile or run code online.", "alert": "At least one option (Offline IDE, Online Editor, or Online IDE) must be selected.", "alertNoTheia": "At least one option (Offline IDE or Online Editor) must be selected" }, @@ -465,6 +468,8 @@ "allowFeedbackRequestsTooltip": "Students can request feedback before the due date. The requests will be processed by Athena, or, if Athena cannot be reached, students can send manual feedback requests.", "manualFeedbackRequests": "Manual feedback requests", "manualFeedbackRequestsTooltip": "Students can request manual feedback before the due date to receive feedback.", + "feedbackRequestsEnabled": "Feedback requests are enabled.", + "feedbackRequestsDisabled": "Feedback requests are disabled.", "complaintOnAutomaticAssessment": "Complaint on Automatic Assessment", "complaintOnAutomaticAssessmentTooltip": "Students can complain after receiving an automatic assessment. Which will be evaluated by a tutor afterwards.", "exampleSolutionPublicationDateTooltip": "The date when the Solution Repository becomes available to download for students. Leave blank to disable.", diff --git a/src/main/webapp/i18n/en/quizExercise.json b/src/main/webapp/i18n/en/quizExercise.json index 6b9d14db482f..649092bb9f56 100644 --- a/src/main/webapp/i18n/en/quizExercise.json +++ b/src/main/webapp/i18n/en/quizExercise.json @@ -273,12 +273,6 @@ "explanationAnswered": "You have answered this question", "explanationNotAnswered": "You have not answered this question", "submissionWarning": "Are you sure you want to submit? You have not answered all questions and you still have some time left!", - "quizLiveModal": { - "title": "Go-Live of a new Quiz Exercise", - "body": "The Quiz {{quizName}} for Course {{courseName}} is now live! Click on the 'Go to Quiz' button in order to access the quiz.", - "cancelButton": "Cancel", - "goToButton": "Go to quiz" - }, "placeholder": { "title": "Short Quiz Title", "questionTitle": "Question Title", diff --git a/src/main/webapp/i18n/en/student-dashboard.json b/src/main/webapp/i18n/en/student-dashboard.json index b9eddb4ecfa3..58b2effd112c 100644 --- a/src/main/webapp/i18n/en/student-dashboard.json +++ b/src/main/webapp/i18n/en/student-dashboard.json @@ -70,6 +70,8 @@ "examChannels": "Exams", "createChannel": "Create channel", "browseChannels": "Browse channels", + "createGroupChat": "Create group chat", + "createDirectChat": "Create direct chat", "groupChats": "Group Chats", "directMessages": "Direct Messages", "filterConversationPlaceholder": "Filter conversations" @@ -103,6 +105,7 @@ "achievedScore": "Achieved Score", "achievablePoints": "Achievable Points", "applyFilter": "Apply filter", + "resetFilter": "Reset filter", "clearFilter": "Clear filter", "noFilterAvailable": "There are no distinguishing filter options for the existing exercises", "noMoreOptions": "No more options" diff --git a/src/test/java/de/tum/cit/aet/artemis/atlas/learningpath/LearningPathIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/atlas/learningpath/LearningPathIntegrationTest.java index 9c55add49a9d..b217564b469f 100644 --- a/src/test/java/de/tum/cit/aet/artemis/atlas/learningpath/LearningPathIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/atlas/learningpath/LearningPathIntegrationTest.java @@ -72,6 +72,8 @@ class LearningPathIntegrationTest extends AbstractAtlasIntegrationTest { private static final String STUDENT2_OF_COURSE = TEST_PREFIX + "student2"; + private static final String SECOND_STUDENT_OF_COURSE = TEST_PREFIX + "student2"; + private static final String TUTOR_OF_COURSE = TEST_PREFIX + "tutor1"; private static final String EDITOR_OF_COURSE = TEST_PREFIX + "editor1"; @@ -131,6 +133,7 @@ private void testAllPreAuthorize() throws Exception { final var search = pageableSearchUtilService.configureSearch(""); request.getSearchResult("/api/courses/" + course.getId() + "/learning-paths", HttpStatus.FORBIDDEN, LearningPath.class, pageableSearchUtilService.searchMapping(search)); request.get("/api/courses/" + course.getId() + "/learning-path-health", HttpStatus.FORBIDDEN, LearningPathHealthDTO.class); + request.get("/api/courses/" + course.getId() + "/learning-path/competency-instructor-graph", HttpStatus.FORBIDDEN, NgxLearningPathDTO.class); } private void enableLearningPathsRESTCall(Course course) throws Exception { @@ -397,7 +400,7 @@ void testGetLearningPathWithOwner() throws Exception { @WithMockUser(username = STUDENT1_OF_COURSE, roles = "USER") void testGetLearningPathOfOtherUser() throws Exception { course = learningPathUtilService.enableAndGenerateLearningPathsForCourse(course); - final var otherStudent = userTestRepository.findOneByLogin(TEST_PREFIX + "student2").orElseThrow(); + final var otherStudent = userTestRepository.findOneByLogin(SECOND_STUDENT_OF_COURSE).orElseThrow(); final var learningPath = learningPathRepository.findByCourseIdAndUserIdElseThrow(course.getId(), otherStudent.getId()); request.get("/api/learning-path/" + learningPath.getId(), HttpStatus.FORBIDDEN, NgxLearningPathDTO.class); } @@ -406,7 +409,7 @@ void testGetLearningPathOfOtherUser() throws Exception { @WithMockUser(username = STUDENT1_OF_COURSE, roles = "USER") void testGetLearningPathCompetencyGraphOfOtherUser() throws Exception { course = learningPathUtilService.enableAndGenerateLearningPathsForCourse(course); - final var otherStudent = userTestRepository.findOneByLogin(TEST_PREFIX + "student2").orElseThrow(); + final var otherStudent = userTestRepository.findOneByLogin(SECOND_STUDENT_OF_COURSE).orElseThrow(); final var learningPath = learningPathRepository.findByCourseIdAndUserIdElseThrow(course.getId(), otherStudent.getId()); request.get("/api/learning-path/" + learningPath.getId() + "/competency-graph", HttpStatus.FORBIDDEN, LearningPathCompetencyGraphDTO.class); } @@ -453,7 +456,7 @@ void testGetLearningPathNgxForLearningPathsDisabled(LearningPathResource.NgxRequ @ParameterizedTest(name = "{displayName} [{index}] {argumentsWithNames}") @EnumSource(LearningPathResource.NgxRequestType.class) - @WithMockUser(username = TEST_PREFIX + "student2", roles = "USER") + @WithMockUser(username = SECOND_STUDENT_OF_COURSE, roles = "USER") void testGetLearningPathNgxForOtherStudent(LearningPathResource.NgxRequestType type) throws Exception { course = learningPathUtilService.enableAndGenerateLearningPathsForCourse(course); final var student = userTestRepository.findOneByLogin(STUDENT1_OF_COURSE).orElseThrow(); @@ -617,7 +620,7 @@ void shouldStartLearningPath() throws Exception { } @Test - @WithMockUser(username = TEST_PREFIX + "student2", roles = "USER") + @WithMockUser(username = SECOND_STUDENT_OF_COURSE, roles = "USER") void testGetCompetencyProgressForLearningPathByOtherStudent() throws Exception { course = learningPathUtilService.enableAndGenerateLearningPathsForCourse(course); final var student = userTestRepository.findOneByLogin(STUDENT1_OF_COURSE).orElseThrow(); diff --git a/src/test/java/de/tum/cit/aet/artemis/atlas/service/LearningPathServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/atlas/service/LearningPathServiceTest.java index 65143ebdf769..471d3752c728 100644 --- a/src/test/java/de/tum/cit/aet/artemis/atlas/service/LearningPathServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/atlas/service/LearningPathServiceTest.java @@ -110,24 +110,6 @@ void setup() { course = courseRepository.save(course); } - @Test - void testHealthStatusDisabled() { - var healthStatus = learningPathService.getHealthStatusForCourse(course); - assertThat(healthStatus.status()).containsExactly(LearningPathHealthDTO.HealthStatus.DISABLED); - assertThat(healthStatus.missingLearningPaths()).isNull(); - } - - @Test - void testHealthStatusOK() { - final var competency1 = competencyUtilService.createCompetency(course); - final var competency2 = competencyUtilService.createCompetency(course); - competencyUtilService.addRelation(competency1, RelationType.MATCHES, competency2); - course = learningPathUtilService.enableAndGenerateLearningPathsForCourse(course); - var healthStatus = learningPathService.getHealthStatusForCourse(course); - assertThat(healthStatus.status()).containsExactly(LearningPathHealthDTO.HealthStatus.OK); - assertThat(healthStatus.missingLearningPaths()).isNull(); - } - @Test void testHealthStatusMissing() { final var competency1 = competencyUtilService.createCompetency(course); diff --git a/src/test/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParserTest.java b/src/test/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParserTest.java index 3af5e6b64a69..f228d0223f9d 100644 --- a/src/test/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParserTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/buildagent/service/TestResultXmlParserTest.java @@ -208,4 +208,42 @@ void testEmptyTestMessage() throws IOException { assertThat(test.getName()).isEqualTo("mwe-name"); assertThat(test.getTestMessages()).hasSize(1).contains(""); } + + @Test + void testNestedTestsuite() throws IOException { + String input = """ + + + + + + + + + + + + + + + + + + + + + + + + + + """; + + TestResultXmlParser.processTestResultFile(input, failedTests, successfulTests); + assertThat(successfulTests).hasSize(12).extracting(BuildResult.LocalCITestJobDTO::getName).containsExactlyInAnyOrder("Testing filtering in A", "Testing mapping in A", + "Testing filtering in B", "Testing mapping in B", "Testing filtering in C", "Testing mapping in C", "Testing A against sample solution", + "Testing B against sample solution", "Testing C against sample solution", "Testing selectAndReflectA (0,0) []", "Testing selectAndReflectB (0,1) [(0,0)]", + "Testing selectAndReflectC (0,1) [(-1,-1)]"); + assertThat(failedTests).isEmpty(); + } } diff --git a/src/test/java/de/tum/cit/aet/artemis/core/service/TelemetryServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/core/service/TelemetryServiceTest.java index c820f3fb0bb0..1938c719ffa1 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/service/TelemetryServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/service/TelemetryServiceTest.java @@ -1,6 +1,7 @@ package de.tum.cit.aet.artemis.core.service; import static java.util.concurrent.TimeUnit.SECONDS; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; import static org.mockito.Mockito.spy; import static org.springframework.test.web.client.match.MockRestRequestMatchers.method; import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; @@ -25,6 +26,8 @@ import com.fasterxml.jackson.databind.ObjectMapper; +import de.tum.cit.aet.artemis.core.service.telemetry.TelemetrySendingService; +import de.tum.cit.aet.artemis.core.service.telemetry.TelemetryService; import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationIndependentTest; @ExtendWith(MockitoExtension.class) @@ -34,7 +37,10 @@ class TelemetryServiceTest extends AbstractSpringIntegrationIndependentTest { private RestTemplate restTemplate; @Autowired - private TelemetryService telemetryService; + private TelemetrySendingService telemetrySendingService; + + @Autowired + private ProfileService profileService; private MockRestServiceServer mockServer; @@ -46,34 +52,54 @@ class TelemetryServiceTest extends AbstractSpringIntegrationIndependentTest { private String destination; @BeforeEach - void init() { - telemetryServiceSpy = spy(telemetryService); - mockServer = MockRestServiceServer.createServer(restTemplate); - telemetryServiceSpy.useTelemetry = true; + void setUp() { + mockServer = MockRestServiceServer.bindTo(restTemplate).ignoreExpectOrder(true).build(); } @Test void testSendTelemetry_TelemetryEnabled() throws Exception { + TelemetryService telemetryService = new TelemetryService(profileService, telemetrySendingService, true, true); + telemetryServiceSpy = spy(telemetryService); + mockServer.expect(ExpectedCount.once(), requestTo(new URI(destination + "/api/telemetry"))).andExpect(method(HttpMethod.POST)) + .andExpect(request -> assertThat(request.getBody().toString()).contains("adminName")) + .andRespond(withStatus(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON).body(mapper.writeValueAsString("Success!"))); + telemetryServiceSpy.sendTelemetry(); + + await().atMost(2, SECONDS).untilAsserted(() -> mockServer.verify()); + } + + @Test + void testSendTelemetry_TelemetryEnabledWithoutPersonalData() throws Exception { + TelemetryService telemetryService = new TelemetryService(profileService, telemetrySendingService, true, false); + telemetryServiceSpy = spy(telemetryService); mockServer.expect(ExpectedCount.once(), requestTo(new URI(destination + "/api/telemetry"))).andExpect(method(HttpMethod.POST)) + .andExpect(request -> assertThat(request.getBody().toString()).doesNotContain("adminName")) .andRespond(withStatus(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON).body(mapper.writeValueAsString("Success!"))); telemetryServiceSpy.sendTelemetry(); - await().atMost(1, SECONDS).untilAsserted(() -> mockServer.verify()); + + await().atMost(2, SECONDS).untilAsserted(() -> mockServer.verify()); } @Test void testSendTelemetry_TelemetryDisabled() throws Exception { + TelemetryService telemetryService = new TelemetryService(profileService, telemetrySendingService, false, true); + telemetryServiceSpy = spy(telemetryService); + mockServer.expect(ExpectedCount.never(), requestTo(new URI(destination + "/api/telemetry"))).andExpect(method(HttpMethod.POST)) .andRespond(withStatus(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON).body(mapper.writeValueAsString("Success!"))); - telemetryServiceSpy.useTelemetry = false; telemetryServiceSpy.sendTelemetry(); - await().atMost(1, SECONDS).untilAsserted(() -> mockServer.verify()); + await().atMost(2, SECONDS).untilAsserted(() -> mockServer.verify()); } @Test void testSendTelemetry_ExceptionHandling() throws Exception { + TelemetryService telemetryService = new TelemetryService(profileService, telemetrySendingService, true, true); + telemetryServiceSpy = spy(telemetryService); + mockServer.expect(ExpectedCount.once(), requestTo(new URI(destination + "/api/telemetry"))).andExpect(method(HttpMethod.POST)) .andRespond(withServerError().body(mapper.writeValueAsString("Failure!"))); + telemetryServiceSpy.sendTelemetry(); - await().atMost(1, SECONDS).untilAsserted(() -> mockServer.verify()); + await().atMost(2, SECONDS).untilAsserted(() -> mockServer.verify()); } } diff --git a/src/test/java/de/tum/cit/aet/artemis/exercise/participation/util/ParticipationUtilService.java b/src/test/java/de/tum/cit/aet/artemis/exercise/participation/util/ParticipationUtilService.java index ff3ab5f260e6..1d0f5953f3e9 100644 --- a/src/test/java/de/tum/cit/aet/artemis/exercise/participation/util/ParticipationUtilService.java +++ b/src/test/java/de/tum/cit/aet/artemis/exercise/participation/util/ParticipationUtilService.java @@ -132,6 +132,9 @@ public class ParticipationUtilService { @Value("${artemis.version-control.default-branch:main}") protected String defaultBranch; + @Value("${artemis.version-control.url}") + protected String artemisVersionControlUrl; + /** * Creates and saves a Result for a ProgrammingExerciseStudentParticipation associated with the given ProgrammingExercise and login. If no corresponding * ProgrammingExerciseStudentParticipation exists, it will be created and saved as well. @@ -153,7 +156,7 @@ public Result addProgrammingParticipationWithResultForExercise(ProgrammingExerci participation.setBuildPlanId(buildPlanId); participation.setProgrammingExercise(exercise); participation.setInitializationState(InitializationState.INITIALIZED); - participation.setRepositoryUri(String.format("http://some.test.url/%s/%s.git", exercise.getProjectKey(), repoName)); + participation.setRepositoryUri(String.format("%s/git/%s/%s.git", artemisVersionControlUrl, exercise.getProjectKey(), repoName)); programmingExerciseStudentParticipationRepo.save(participation); storedParticipation = programmingExerciseStudentParticipationRepo.findByExerciseIdAndStudentLogin(exercise.getId(), login); assertThat(storedParticipation).isPresent(); @@ -315,7 +318,7 @@ public ProgrammingExerciseStudentParticipation addStudentParticipationForProgram ProgrammingExerciseStudentParticipation participation = ParticipationFactory.generateIndividualProgrammingExerciseStudentParticipation(exercise, userUtilService.getUserByLogin(login)); final var repoName = (exercise.getProjectKey() + "-" + login).toLowerCase(); - participation.setRepositoryUri(String.format("http://some.test.url/scm/%s/%s.git", exercise.getProjectKey(), repoName)); + participation.setRepositoryUri(String.format("%s/git/%s/%s.git", artemisVersionControlUrl, exercise.getProjectKey(), repoName)); participation = programmingExerciseStudentParticipationRepo.save(participation); participationVCSAccessTokenService.createParticipationVCSAccessToken(userUtilService.getUserByLogin(login), participation); return (ProgrammingExerciseStudentParticipation) studentParticipationRepo.findWithEagerLegalSubmissionsAndResultsAssessorsById(participation.getId()).orElseThrow(); @@ -337,7 +340,7 @@ public ProgrammingExerciseStudentParticipation addTeamParticipationForProgrammin } ProgrammingExerciseStudentParticipation participation = ParticipationFactory.generateTeamProgrammingExerciseStudentParticipation(exercise, team); final var repoName = (exercise.getProjectKey() + "-" + team.getShortName()).toLowerCase(); - participation.setRepositoryUri(String.format("http://some.test.url/scm/%s/%s.git", exercise.getProjectKey(), repoName)); + participation.setRepositoryUri(String.format("%s/git/%s/%s.git", artemisVersionControlUrl, exercise.getProjectKey(), repoName)); participation = programmingExerciseStudentParticipationRepo.save(participation); return (ProgrammingExerciseStudentParticipation) studentParticipationRepo.findWithEagerLegalSubmissionsAndResultsAssessorsById(participation.getId()).orElseThrow(); diff --git a/src/test/java/de/tum/cit/aet/artemis/exercise/programming/AuxiliaryRepositoryResourceIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/exercise/programming/AuxiliaryRepositoryResourceIntegrationTest.java new file mode 100644 index 000000000000..e8f6ae3c38ec --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/exercise/programming/AuxiliaryRepositoryResourceIntegrationTest.java @@ -0,0 +1,552 @@ +package de.tum.cit.aet.artemis.exercise.programming; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.any; +import static org.mockito.Mockito.argThat; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.reset; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Path; +import java.time.ZonedDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import org.apache.commons.io.FileUtils; +import org.eclipse.jgit.api.ListBranchCommand; +import org.eclipse.jgit.api.MergeResult; +import org.eclipse.jgit.api.errors.TransportException; +import org.eclipse.jgit.api.errors.WrongRepositoryStateException; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.merge.MergeStrategy; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.security.test.context.support.WithMockUser; +import org.springframework.util.LinkedMultiValueMap; + +import de.tum.cit.aet.artemis.core.domain.Course; +import de.tum.cit.aet.artemis.programming.domain.AuxiliaryRepository; +import de.tum.cit.aet.artemis.programming.domain.File; +import de.tum.cit.aet.artemis.programming.domain.FileType; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; +import de.tum.cit.aet.artemis.programming.domain.Repository; +import de.tum.cit.aet.artemis.programming.dto.FileMove; +import de.tum.cit.aet.artemis.programming.dto.RepositoryStatusDTO; +import de.tum.cit.aet.artemis.programming.repository.AuxiliaryRepositoryRepository; +import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseBuildConfigRepository; +import de.tum.cit.aet.artemis.programming.service.GitService; +import de.tum.cit.aet.artemis.programming.test_repository.ProgrammingExerciseTestRepository; +import de.tum.cit.aet.artemis.programming.util.GitUtilService; +import de.tum.cit.aet.artemis.programming.util.LocalRepository; +import de.tum.cit.aet.artemis.programming.util.ProgrammingExerciseFactory; +import de.tum.cit.aet.artemis.programming.web.repository.FileSubmission; +import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationJenkinsGitlabTest; + +class AuxiliaryRepositoryResourceIntegrationTest extends AbstractSpringIntegrationJenkinsGitlabTest { + + private static final String TEST_PREFIX = "auxiliaryrepositoryresourceint"; + + @Autowired + private ProgrammingExerciseTestRepository programmingExerciseRepository; + + @Autowired + private ProgrammingExerciseBuildConfigRepository programmingExerciseBuildConfigRepository; + + @Autowired + private AuxiliaryRepositoryRepository auxiliaryRepositoryRepository; + + private final String testRepoBaseUrl = "/api/auxiliary-repository/"; + + private ProgrammingExercise programmingExercise; + + private AuxiliaryRepository auxiliaryRepository; + + private final String currentLocalFileName = "currentFileName"; + + private final String currentLocalFileContent = "testContent"; + + private final String currentLocalFolderName = "currentFolderName"; + + private final LocalRepository localAuxiliaryRepo = new LocalRepository(defaultBranch); + + private GitUtilService.MockFileRepositoryUri auxRepoUri; + + @BeforeEach + void setup() throws Exception { + userUtilService.addUsers(TEST_PREFIX, 1, 1, 0, 1); + Course course = courseUtilService.addEmptyCourse(); + programmingExercise = ProgrammingExerciseFactory.generateProgrammingExercise(ZonedDateTime.now().minusDays(1), ZonedDateTime.now().plusDays(7), course); + programmingExercise.setBuildConfig(programmingExerciseBuildConfigRepository.save(programmingExercise.getBuildConfig())); + + // Instantiate the remote repository as non-bare so its files can be manipulated + localAuxiliaryRepo.configureRepos("auxLocalRepo", "auxOriginRepo", false); + + // add file to the repository folder + Path filePath = Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName); + var file = Files.createFile(filePath).toFile(); + // write content to the created file + FileUtils.write(file, currentLocalFileContent, Charset.defaultCharset()); + + // add folder to the repository folder + filePath = Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFolderName); + Files.createDirectory(filePath); + + // add the auxiliary repository + auxiliaryRepositoryRepository.deleteAll(); + auxRepoUri = new GitUtilService.MockFileRepositoryUri(localAuxiliaryRepo.localRepoFile); + programmingExercise.setTestRepositoryUri(auxRepoUri.toString()); + var newAuxiliaryRepo = new AuxiliaryRepository(); + newAuxiliaryRepo.setName("AuxiliaryRepo"); + newAuxiliaryRepo.setRepositoryUri(auxRepoUri.toString()); + newAuxiliaryRepo.setCheckoutDirectory(localAuxiliaryRepo.localRepoFile.toPath().toString()); + newAuxiliaryRepo.setExercise(programmingExercise); + programmingExercise.setAuxiliaryRepositories(List.of(newAuxiliaryRepo)); + programmingExercise = programmingExerciseRepository.save(programmingExercise); + auxiliaryRepository = programmingExercise.getAuxiliaryRepositories().getFirst(); + + doReturn(gitService.getExistingCheckedOutRepositoryByLocalPath(localAuxiliaryRepo.localRepoFile.toPath(), null)).when(gitService).getOrCheckoutRepository(auxRepoUri, true); + doReturn(gitService.getExistingCheckedOutRepositoryByLocalPath(localAuxiliaryRepo.localRepoFile.toPath(), null)).when(gitService).getOrCheckoutRepository(auxRepoUri, + false); + + doReturn(gitService.getExistingCheckedOutRepositoryByLocalPath(localAuxiliaryRepo.localRepoFile.toPath(), null)).when(gitService).getOrCheckoutRepository(eq(auxRepoUri), + eq(true), any()); + doReturn(gitService.getExistingCheckedOutRepositoryByLocalPath(localAuxiliaryRepo.localRepoFile.toPath(), null)).when(gitService).getOrCheckoutRepository(eq(auxRepoUri), + eq(false), any()); + + doReturn(defaultBranch).when(versionControlService).getOrRetrieveBranchOfExercise(programmingExercise); + } + + @AfterEach + void tearDown() throws IOException { + reset(gitService); + localAuxiliaryRepo.resetLocalRepo(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testGetFiles() throws Exception { + programmingExerciseRepository.save(programmingExercise); + var files = request.getMap(testRepoBaseUrl + auxiliaryRepository.getId() + "/files", HttpStatus.OK, String.class, FileType.class); + assertThat(files).isNotEmpty(); + + // Check if all files exist + for (String key : files.keySet()) { + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + key)).exists(); + } + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "STUDENT") + void testGetFilesAsStudent_accessForbidden() throws Exception { + programmingExerciseRepository.save(programmingExercise); + request.getMap(testRepoBaseUrl + auxiliaryRepository.getId() + "/files", HttpStatus.FORBIDDEN, String.class, FileType.class); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testGetFilesAsInstructor_checkoutConflict() throws Exception { + programmingExerciseRepository.save(programmingExercise); + doThrow(new WrongRepositoryStateException("conflict")).when(gitService).getOrCheckoutRepository(auxRepoUri, true); + + request.getMap(testRepoBaseUrl + auxiliaryRepository.getId() + "/files", HttpStatus.CONFLICT, String.class, FileType.class); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testGetFile() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + params.add("file", currentLocalFileName); + var file = request.get(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.OK, byte[].class, params); + assertThat(file).isNotEmpty(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + assertThat(new String(file)).isEqualTo(currentLocalFileContent); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCreateFile() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/newFile")).doesNotExist(); + params.add("file", "newFile"); + request.postWithoutResponseBody(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.OK, params); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/newFile")).isRegularFile(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCreateFile_alreadyExists() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat((Path.of(localAuxiliaryRepo.localRepoFile + "/newFile"))).doesNotExist(); + params.add("file", "newFile"); + + doReturn(Optional.of(true)).when(gitService).getFileByName(any(), any()); + request.postWithoutResponseBody(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.BAD_REQUEST, params); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCreateFile_invalidRepository() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat((Path.of(localAuxiliaryRepo.localRepoFile + "/newFile"))).doesNotExist(); + params.add("file", "newFile"); + + Repository mockRepository = mock(Repository.class); + doReturn(mockRepository).when(gitService).getOrCheckoutRepository(any(), eq(true)); + doReturn(localAuxiliaryRepo.localRepoFile.toPath()).when(mockRepository).getLocalPath(); + doReturn(false).when(mockRepository).isValidFile(any()); + request.postWithoutResponseBody(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.BAD_REQUEST, params); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCreateFolder() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/newFolder")).doesNotExist(); + params.add("folder", "newFolder"); + request.postWithoutResponseBody(testRepoBaseUrl + auxiliaryRepository.getId() + "/folder", HttpStatus.OK, params); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/newFolder")).isDirectory(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testRenameFile() throws Exception { + programmingExerciseRepository.save(programmingExercise); + assertThat((Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName))).exists(); + String newLocalFileName = "newFileName"; + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + newLocalFileName)).doesNotExist(); + FileMove fileMove = new FileMove(currentLocalFileName, newLocalFileName); + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/rename-file", fileMove, HttpStatus.OK, null); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).doesNotExist(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + newLocalFileName)).exists(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testRenameFile_alreadyExists() throws Exception { + programmingExerciseRepository.save(programmingExercise); + FileMove fileMove = createRenameFileMove(); + + doReturn(Optional.empty()).when(gitService).getFileByName(any(), any()); + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/rename-file", fileMove, HttpStatus.NOT_FOUND, null); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testRenameFile_invalidExistingFile() throws Exception { + programmingExerciseRepository.save(programmingExercise); + FileMove fileMove = createRenameFileMove(); + + doReturn(Optional.of(localAuxiliaryRepo.localRepoFile)).when(gitService).getFileByName(any(), eq(fileMove.currentFilePath())); + + Repository mockRepository = mock(Repository.class); + doReturn(mockRepository).when(gitService).getOrCheckoutRepository(any(), eq(true)); + doReturn(localAuxiliaryRepo.localRepoFile.toPath()).when(mockRepository).getLocalPath(); + doReturn(false).when(mockRepository).isValidFile(argThat(file -> file.getName().contains(currentLocalFileName))); + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/rename-file", fileMove, HttpStatus.BAD_REQUEST, null); + } + + private FileMove createRenameFileMove() { + String newLocalFileName = "newFileName"; + + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + newLocalFileName)).doesNotExist(); + + return new FileMove(currentLocalFileName, newLocalFileName); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testRenameFolder() throws Exception { + programmingExerciseRepository.save(programmingExercise); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFolderName)).exists(); + String newLocalFolderName = "newFolderName"; + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + newLocalFolderName)).doesNotExist(); + FileMove fileMove = new FileMove(currentLocalFolderName, newLocalFolderName); + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/rename-file", fileMove, HttpStatus.OK, null); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFolderName)).doesNotExist(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + newLocalFolderName)).exists(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testDeleteFile() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + params.add("file", currentLocalFileName); + request.delete(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.OK, params); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).doesNotExist(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testDeleteFile_notFound() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + params.add("file", currentLocalFileName); + + doReturn(Optional.empty()).when(gitService).getFileByName(any(), any()); + + request.delete(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.NOT_FOUND, params); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testDeleteFile_invalidFile() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + params.add("file", currentLocalFileName); + + doReturn(Optional.of(localAuxiliaryRepo.localRepoFile)).when(gitService).getFileByName(any(), eq(currentLocalFileName)); + + Repository mockRepository = mock(Repository.class); + doReturn(mockRepository).when(gitService).getOrCheckoutRepository(any(), eq(true)); + doReturn(localAuxiliaryRepo.localRepoFile.toPath()).when(mockRepository).getLocalPath(); + doReturn(false).when(mockRepository).isValidFile(argThat(file -> file.getName().contains(currentLocalFileName))); + + request.delete(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.BAD_REQUEST, params); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testDeleteFile_validFile() throws Exception { + programmingExerciseRepository.save(programmingExercise); + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + params.add("file", currentLocalFileName); + + File mockFile = mock(File.class); + doReturn(Optional.of(mockFile)).when(gitService).getFileByName(any(), eq(currentLocalFileName)); + doReturn(currentLocalFileName).when(mockFile).getName(); + doReturn(false).when(mockFile).isFile(); + + Repository mockRepository = mock(Repository.class); + doReturn(mockRepository).when(gitService).getOrCheckoutRepository(any(), eq(true)); + doReturn(localAuxiliaryRepo.localRepoFile.toPath()).when(mockRepository).getLocalPath(); + doReturn(true).when(mockRepository).isValidFile(argThat(file -> file.getName().contains(currentLocalFileName))); + + request.delete(testRepoBaseUrl + auxiliaryRepository.getId() + "/file", HttpStatus.OK, params); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testCommitChanges() throws Exception { + programmingExerciseRepository.save(programmingExercise); + var receivedStatusBeforeCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusBeforeCommit.repositoryStatus()).hasToString("UNCOMMITTED_CHANGES"); + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/commit", null, HttpStatus.OK, null); + var receivedStatusAfterCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusAfterCommit.repositoryStatus()).hasToString("CLEAN"); + var testRepoCommits = localAuxiliaryRepo.getAllLocalCommits(); + assertThat(testRepoCommits).hasSize(1); + assertThat(userUtilService.getUserByLogin(TEST_PREFIX + "instructor1").getName()).isEqualTo(testRepoCommits.getFirst().getAuthorIdent().getName()); + } + + private List getFileSubmissions() { + List fileSubmissions = new ArrayList<>(); + FileSubmission fileSubmission = new FileSubmission(); + fileSubmission.setFileName(currentLocalFileName); + fileSubmission.setFileContent("updatedFileContent"); + fileSubmissions.add(fileSubmission); + return fileSubmissions; + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testSaveFiles() throws Exception { + programmingExerciseRepository.save(programmingExercise); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + request.put(testRepoBaseUrl + auxiliaryRepository.getId() + "/files?commit=false", getFileSubmissions(), HttpStatus.OK); + + Path filePath = Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName); + assertThat(filePath).hasContent("updatedFileContent"); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testSaveFilesAndCommit() throws Exception { + programmingExerciseRepository.save(programmingExercise); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName)).exists(); + + var receivedStatusBeforeCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusBeforeCommit.repositoryStatus()).hasToString("UNCOMMITTED_CHANGES"); + + request.put(testRepoBaseUrl + auxiliaryRepository.getId() + "/files?commit=true", getFileSubmissions(), HttpStatus.OK); + + var receivedStatusAfterCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusAfterCommit.repositoryStatus()).hasToString("CLEAN"); + + Path filePath = Path.of(localAuxiliaryRepo.localRepoFile + "/" + currentLocalFileName); + assertThat(filePath).hasContent("updatedFileContent"); + + var testRepoCommits = localAuxiliaryRepo.getAllLocalCommits(); + assertThat(testRepoCommits).hasSize(1); + assertThat(userUtilService.getUserByLogin(TEST_PREFIX + "instructor1").getName()).isEqualTo(testRepoCommits.getFirst().getAuthorIdent().getName()); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "INSTRUCTOR") + void testSaveFiles_accessForbidden() throws Exception { + programmingExerciseRepository.save(programmingExercise); + // student1 should not have access to instructor1's tests repository even if they assume an INSTRUCTOR role. + request.put(testRepoBaseUrl + auxiliaryRepository.getId() + "/files?commit=true", List.of(), HttpStatus.FORBIDDEN); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testSaveFiles_conflict() throws Exception { + programmingExerciseRepository.save(programmingExercise); + doThrow(new WrongRepositoryStateException("conflict")).when(gitService).getOrCheckoutRepository(auxRepoUri, true); + + request.put(testRepoBaseUrl + auxiliaryRepository.getId() + "/files?commit=true", List.of(), HttpStatus.CONFLICT); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testSaveFiles_serviceUnavailable() throws Exception { + programmingExerciseRepository.save(programmingExercise); + doThrow(new TransportException("unavailable")).when(gitService).getOrCheckoutRepository(auxRepoUri, true); + + request.put(testRepoBaseUrl + auxiliaryRepository.getId() + "/files?commit=true", List.of(), HttpStatus.SERVICE_UNAVAILABLE); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testPullChanges() throws Exception { + programmingExerciseRepository.save(programmingExercise); + String fileName = "remoteFile"; + + // Create a commit for the local and the remote repository + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/commit", null, HttpStatus.OK, null); + try (var remoteRepository = gitService.getExistingCheckedOutRepositoryByLocalPath(localAuxiliaryRepo.originRepoFile.toPath(), null)) { + + // Create file in the remote repository + Path filePath = Path.of(localAuxiliaryRepo.originRepoFile + "/" + fileName); + Files.createFile(filePath); + + // Check if the file exists in the remote repository and that it doesn't yet exist in the local repository + assertThat(Path.of(localAuxiliaryRepo.originRepoFile + "/" + fileName)).exists(); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + fileName)).doesNotExist(); + + // Stage all changes and make a second commit in the remote repository + gitService.stageAllChanges(remoteRepository); + GitService.commit(localAuxiliaryRepo.originGit).setMessage("TestCommit").setAllowEmpty(true).setCommitter("testname", "test@email").call(); + + // Checks if the current commit is not equal on the local and the remote repository + assertThat(localAuxiliaryRepo.getAllLocalCommits().getFirst()).isNotEqualTo(localAuxiliaryRepo.getAllOriginCommits().getFirst()); + + // Execute the Rest call + request.get(testRepoBaseUrl + auxiliaryRepository.getId() + "/pull", HttpStatus.OK, Void.class); + + // Check if the current commit is the same on the local and the remote repository and if the file exists on the local repository + assertThat(localAuxiliaryRepo.getAllLocalCommits().getFirst()).isEqualTo(localAuxiliaryRepo.getAllOriginCommits().getFirst()); + assertThat(Path.of(localAuxiliaryRepo.localRepoFile + "/" + fileName)).exists(); + } + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testResetToLastCommit() throws Exception { + programmingExerciseRepository.save(programmingExercise); + String fileName = "testFile"; + try (var localRepo = gitService.getExistingCheckedOutRepositoryByLocalPath(localAuxiliaryRepo.localRepoFile.toPath(), null); + var remoteRepo = gitService.getExistingCheckedOutRepositoryByLocalPath(localAuxiliaryRepo.originRepoFile.toPath(), null)) { + + // Check status of git before the commit + var receivedStatusBeforeCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusBeforeCommit.repositoryStatus()).hasToString("UNCOMMITTED_CHANGES"); + + // Create a commit for the local and the remote repository + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/commit", null, HttpStatus.OK, null); + + // Check status of git after the commit + var receivedStatusAfterCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusAfterCommit.repositoryStatus()).hasToString("CLEAN"); + + // Create file in the local repository and commit it + Path localFilePath = Path.of(localAuxiliaryRepo.localRepoFile + "/" + fileName); + var localFile = Files.createFile(localFilePath).toFile(); + // write content to the created file + FileUtils.write(localFile, "local", Charset.defaultCharset()); + gitService.stageAllChanges(localRepo); + GitService.commit(localAuxiliaryRepo.localGit).setMessage("local").call(); + + // Create file in the remote repository and commit it + Path remoteFilePath = Path.of(localAuxiliaryRepo.originRepoFile + "/" + fileName); + var remoteFile = Files.createFile(remoteFilePath).toFile(); + // write content to the created file + FileUtils.write(remoteFile, "remote", Charset.defaultCharset()); + gitService.stageAllChanges(remoteRepo); + GitService.commit(localAuxiliaryRepo.originGit).setMessage("remote").call(); + + // Merge the two and a conflict will occur + localAuxiliaryRepo.localGit.fetch().setRemote("origin").call(); + List refs = localAuxiliaryRepo.localGit.branchList().setListMode(ListBranchCommand.ListMode.REMOTE).call(); + var result = localAuxiliaryRepo.localGit.merge().include(refs.getFirst().getObjectId()).setStrategy(MergeStrategy.RESOLVE).call(); + var status = localAuxiliaryRepo.localGit.status().call(); + assertThat(status.getConflicting()).isNotEmpty(); + assertThat(result.getMergeStatus()).isEqualTo(MergeResult.MergeStatus.CONFLICTING); + + // Execute the reset Rest call + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/reset", null, HttpStatus.OK, null); + + // Check the git status after the reset + status = localAuxiliaryRepo.localGit.status().call(); + assertThat(status.getConflicting()).isEmpty(); + assertThat(localAuxiliaryRepo.getAllLocalCommits().getFirst()).isEqualTo(localAuxiliaryRepo.getAllOriginCommits().getFirst()); + var receivedStatusAfterReset = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusAfterReset.repositoryStatus()).hasToString("CLEAN"); + } + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testGetStatus() throws Exception { + programmingExerciseRepository.save(programmingExercise); + var receivedStatusBeforeCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + + // The current status is "uncommited changes", since we added files and folders, but we didn't commit yet + assertThat(receivedStatusBeforeCommit.repositoryStatus()).hasToString("UNCOMMITTED_CHANGES"); + + // Perform a commit to check if the status changes + request.postWithoutLocation(testRepoBaseUrl + auxiliaryRepository.getId() + "/commit", null, HttpStatus.OK, null); + + // Check if the status of git is "clean" after the commit + var receivedStatusAfterCommit = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, RepositoryStatusDTO.class); + assertThat(receivedStatusAfterCommit.repositoryStatus()).hasToString("CLEAN"); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "INSTRUCTOR") + void testGetStatus_cannotAccessRepository() throws Exception { + programmingExerciseRepository.save(programmingExercise); + // student1 should not have access to instructor1's tests repository even if they assume the role of an INSTRUCTOR. + request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.FORBIDDEN, RepositoryStatusDTO.class); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void testIsClean() throws Exception { + programmingExerciseRepository.save(programmingExercise); + doReturn(true).when(gitService).isRepositoryCached(any()); + var status = request.get(testRepoBaseUrl + auxiliaryRepository.getId(), HttpStatus.OK, Map.class); + assertThat(status).isNotEmpty(); + } +} diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseIntegrationTestService.java b/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseIntegrationTestService.java index 7bfbb4253069..49696af61d96 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseIntegrationTestService.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseIntegrationTestService.java @@ -2188,6 +2188,14 @@ private AuxiliaryRepository addAuxiliaryRepositoryToExercise() { return repository; } + public void addAuxiliaryRepositoryToExercise(ProgrammingExercise exercise) { + AuxiliaryRepository repository = AuxiliaryRepositoryBuilder.defaults().get(); + auxiliaryRepositoryRepository.save(repository); + exercise.setAuxiliaryRepositories(new ArrayList<>()); + exercise.addAuxiliaryRepository(repository); + programmingExerciseRepository.save(exercise); + } + private String defaultAuxiliaryRepositoryEndpoint() { return "/api/programming-exercises/setup"; } diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseParticipationIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseParticipationIntegrationTest.java index fb6d19002d15..1e47b62e649b 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseParticipationIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/ProgrammingExerciseParticipationIntegrationTest.java @@ -1,9 +1,13 @@ package de.tum.cit.aet.artemis.programming; import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doNothing; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.doThrow; +import java.io.IOException; +import java.net.URISyntaxException; import java.time.ZoneId; import java.time.ZonedDateTime; import java.util.HashMap; @@ -11,8 +15,10 @@ import java.util.Map; import java.util.stream.Stream; +import org.eclipse.jgit.api.errors.GitAPIException; import org.eclipse.jgit.api.errors.NoHeadException; import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; @@ -35,11 +41,15 @@ import de.tum.cit.aet.artemis.exercise.test_repository.ParticipationTestRepository; import de.tum.cit.aet.artemis.exercise.test_repository.StudentParticipationTestRepository; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise; +import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseParticipation; import de.tum.cit.aet.artemis.programming.domain.ProgrammingExerciseStudentParticipation; import de.tum.cit.aet.artemis.programming.domain.ProgrammingSubmission; +import de.tum.cit.aet.artemis.programming.domain.Repository; import de.tum.cit.aet.artemis.programming.domain.SolutionProgrammingExerciseParticipation; import de.tum.cit.aet.artemis.programming.domain.TemplateProgrammingExerciseParticipation; +import de.tum.cit.aet.artemis.programming.domain.VcsRepositoryUri; import de.tum.cit.aet.artemis.programming.dto.CommitInfoDTO; +import de.tum.cit.aet.artemis.programming.repository.AuxiliaryRepositoryRepository; import de.tum.cit.aet.artemis.programming.test_repository.ProgrammingExerciseStudentParticipationTestRepository; import de.tum.cit.aet.artemis.programming.test_repository.ProgrammingExerciseTestRepository; import de.tum.cit.aet.artemis.programming.util.ProgrammingExerciseUtilService; @@ -71,6 +81,13 @@ class ProgrammingExerciseParticipationIntegrationTest extends AbstractSpringInte @Autowired private ParticipationUtilService participationUtilService; + @Autowired + private AuxiliaryRepositoryRepository auxiliaryRepositoryRepository; + + // TODO remove again after refactoring and cleanup + @Autowired + private ProgrammingExerciseIntegrationTestService programmingExerciseIntegrationTestService; + private ProgrammingExercise programmingExercise; private Participation programmingExerciseParticipation; @@ -81,6 +98,7 @@ void initTestCase() { var course = programmingExerciseUtilService.addCourseWithOneProgrammingExerciseAndTestCases(); programmingExercise = exerciseUtilService.getFirstExerciseWithType(course, ProgrammingExercise.class); programmingExercise = programmingExerciseRepository.findWithEagerStudentParticipationsById(programmingExercise.getId()).orElseThrow(); + programmingExerciseIntegrationTestService.addAuxiliaryRepositoryToExercise(programmingExercise); } private static Stream argumentsForGetParticipationResults() { @@ -704,6 +722,144 @@ void checkResetRepository_exam_badRequest() throws Exception { request.put("/api/programming-exercise-participations/" + programmingExerciseParticipation.getId() + "/reset-repository", null, HttpStatus.BAD_REQUEST); } + /** + * TODO move the following test into a different test file, as they do not use the programming-exercise-participations/.. endpoint, but programming-exercise/.. + * move the endpoint itself too + *

+ * Test for GET - programming-exercise/{exerciseID}/commit-history/{repositoryType} + */ + @Nested + class GetCommitHistoryForTemplateSolutionTestOrAuxRepo { + + String PATH_PREFIX; + + ProgrammingExercise programmingExerciseWithAuxRepo; + + @BeforeEach + void setup() throws GitAPIException { + userUtilService.addUsers(TEST_PREFIX, 4, 2, 0, 2); + var course = programmingExerciseUtilService.addCourseWithOneProgrammingExerciseAndTestCases(); + programmingExerciseWithAuxRepo = exerciseUtilService.getFirstExerciseWithType(course, ProgrammingExercise.class); + programmingExerciseWithAuxRepo = programmingExerciseRepository.findWithEagerStudentParticipationsById(programmingExerciseWithAuxRepo.getId()).orElseThrow(); + programmingExerciseIntegrationTestService.addAuxiliaryRepositoryToExercise(programmingExerciseWithAuxRepo); + + doThrow(new NoHeadException("error")).when(gitService).getCommitInfos(any()); + PATH_PREFIX = "/api/programming-exercise/" + programmingExerciseWithAuxRepo.getId() + "/commit-history/"; + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldReturnBadRequestForInvalidRepositoryType() throws Exception { + request.getList(PATH_PREFIX + "INVALIDTYPE", HttpStatus.BAD_REQUEST, CommitInfoDTO.class); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldGetListForTemplateRepository() throws Exception { + assertThat(request.getList(PATH_PREFIX + "TEMPLATE", HttpStatus.OK, CommitInfoDTO.class)).isEmpty(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldGetListForSolutionRepository() throws Exception { + assertThat(request.getList(PATH_PREFIX + "SOLUTION", HttpStatus.OK, CommitInfoDTO.class)).isEmpty(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldGetListForTestsRepository() throws Exception { + assertThat(request.getList(PATH_PREFIX + "TESTS", HttpStatus.OK, CommitInfoDTO.class)).isEmpty(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldGetListForAuxiliaryRepository() throws Exception { + assertThat(request.getList(PATH_PREFIX + "AUXILIARY?repositoryId=" + programmingExerciseWithAuxRepo.getAuxiliaryRepositories().getFirst().getId(), HttpStatus.OK, + CommitInfoDTO.class)).isEmpty(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldThrowWithInvalidAuxiliaryRepositoryId() throws Exception { + request.getList(PATH_PREFIX + "AUXILIARY?repositoryId=" + 128, HttpStatus.NOT_FOUND, CommitInfoDTO.class); + } + } + + /** + * Tests for programming-exercise-participations/{participationId}/files-content/{commitId} + */ + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void getParticipationRepositoryFilesInstructorSuccess() throws Exception { + var commitHash = "commitHash"; + var participation = participationUtilService.addStudentParticipationForProgrammingExercise(programmingExercise, TEST_PREFIX + "student1"); + var commitInfo = new CommitInfoDTO("hash", "msg1", ZonedDateTime.of(2020, 1, 1, 0, 0, 0, 0, ZoneId.of("UTC")), "author", "authorEmail"); + var commitInfo2 = new CommitInfoDTO("hash2", "msg2", ZonedDateTime.of(2020, 1, 2, 0, 0, 0, 0, ZoneId.of("UTC")), "author2", "authorEmail2"); + doReturn(List.of(commitInfo, commitInfo2)).when(gitService).getCommitInfos(participation.getVcsRepositoryUri()); + doReturn(new Repository("ab", new VcsRepositoryUri("uri"))).when(gitService).checkoutRepositoryAtCommit(participation.getVcsRepositoryUri(), commitHash, true); + doReturn(Map.of()).when(gitService).listFilesAndFolders(any()); + doNothing().when(gitService).switchBackToDefaultBranchHead(any()); + + request.getMap("/api/programming-exercise-participations/" + participation.getId() + "/files-content/" + commitHash, HttpStatus.OK, String.class, String.class); + } + + /** + * TODO refactor endpoint to contain participation -> programming-exercise-participations + * tests GET - programming-exercise/{exerciseId}/files-content-commit-details/{commitId} + */ + @Nested + class GetParticipationRepositoryFilesForCommitsDetailsView { + + String PATH_PREFIX; + + String COMMIT_HASH; + + ProgrammingExerciseParticipation participation; + + @BeforeEach + void setup() throws GitAPIException, URISyntaxException, IOException { + userUtilService.addUsers(TEST_PREFIX, 4, 2, 0, 2); + participation = participationUtilService.addStudentParticipationForProgrammingExercise(programmingExercise, TEST_PREFIX + "student1"); + var course = programmingExerciseUtilService.addCourseWithOneProgrammingExerciseAndTestCases(); + programmingExercise = exerciseUtilService.getFirstExerciseWithType(course, ProgrammingExercise.class); + programmingExercise = programmingExerciseRepository.findWithEagerStudentParticipationsById(programmingExercise.getId()).orElseThrow(); + programmingExerciseIntegrationTestService.addAuxiliaryRepositoryToExercise(programmingExercise); + COMMIT_HASH = "commitHash"; + + doReturn(Map.of()).when(gitService).listFilesAndFolders(any()); + doNothing().when(gitService).switchBackToDefaultBranchHead(any()); + doReturn(new Repository("ab", new VcsRepositoryUri("uri"))).when(gitService).checkoutRepositoryAtCommit(any(VcsRepositoryUri.class), any(String.class), + any(Boolean.class)); + doThrow(new NoHeadException("error")).when(gitService).getCommitInfos(any()); + PATH_PREFIX = "/api/programming-exercise/" + participation.getProgrammingExercise().getId() + "/files-content-commit-details/" + COMMIT_HASH; + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldReturnBadRequestWithoutAnyProvidedParameters() throws Exception { + request.getMap(PATH_PREFIX, HttpStatus.BAD_REQUEST, String.class, String.class); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldReturnForParticipation() throws Exception { + assertThat(request.getMap(PATH_PREFIX + "?participationId=" + participation.getId(), HttpStatus.OK, String.class, String.class)).isEmpty(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldReturnFilesForTemplateRepository() throws Exception { + assertThat(request.getMap(PATH_PREFIX + "?repositoryType=TEMPLATE", HttpStatus.OK, String.class, String.class)).isEmpty(); + } + + @Test + @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") + void shouldReturnFilesForSolutionRepository() throws Exception { + assertThat(request.getMap(PATH_PREFIX + "?repositoryType=SOLUTION", HttpStatus.OK, String.class, String.class)).isEmpty(); + } + + } + @Test @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") void retrieveCommitInfoInstructorSuccess() throws Exception { diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java index 7d17a712b4ec..4563d7c9f95c 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIIntegrationTest.java @@ -41,6 +41,7 @@ import org.mockito.ArgumentMatcher; import org.mockito.Mockito; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.io.FileSystemResource; import org.springframework.http.HttpStatus; @@ -51,8 +52,12 @@ import com.github.dockerjava.api.command.ExecStartCmd; import com.github.dockerjava.api.exception.NotFoundException; import com.github.dockerjava.api.model.Frame; +import com.hazelcast.collection.IQueue; +import com.hazelcast.core.HazelcastInstance; +import com.hazelcast.map.IMap; import de.tum.cit.aet.artemis.assessment.domain.Result; +import de.tum.cit.aet.artemis.buildagent.dto.BuildJobQueueItem; import de.tum.cit.aet.artemis.buildagent.dto.ResultBuildJob; import de.tum.cit.aet.artemis.core.exception.VersionControlException; import de.tum.cit.aet.artemis.exercise.domain.ExerciseMode; @@ -95,6 +100,10 @@ class LocalCIIntegrationTest extends AbstractLocalCILocalVCIntegrationTest { @Autowired private BuildLogEntryService buildLogEntryService; + @Autowired + @Qualifier("hazelcastInstance") + private HazelcastInstance hazelcastInstance; + @Value("${artemis.user-management.internal-admin.username}") private String localVCUsername; @@ -502,4 +511,25 @@ void testCustomCheckoutPaths() { localVCServletService.processNewPush(commitHash, studentAssignmentRepository.originGit.getRepository()); localVCLocalCITestService.testLatestSubmission(participation.getId(), commitHash, 1, false); } + + @Test + @WithMockUser(username = TEST_PREFIX + "student1", roles = "USER") + void testPauseAndResumeBuildAgent() { + String memberAddress = hazelcastInstance.getCluster().getLocalMember().getAddress().toString(); + hazelcastInstance.getTopic("pauseBuildAgentTopic").publish(memberAddress); + + ProgrammingExerciseStudentParticipation studentParticipation = localVCLocalCITestService.createParticipation(programmingExercise, student1Login); + + localVCServletService.processNewPush(commitHash, studentAssignmentRepository.originGit.getRepository()); + await().until(() -> { + IQueue buildQueue = hazelcastInstance.getQueue("buildJobQueue"); + IMap buildJobMap = hazelcastInstance.getMap("processingJobs"); + BuildJobQueueItem buildJobQueueItem = buildQueue.peek(); + + return buildJobQueueItem != null && buildJobQueueItem.buildConfig().commitHashToBuild().equals(commitHash) && !buildJobMap.containsKey(buildJobQueueItem.id()); + }); + + hazelcastInstance.getTopic("resumeBuildAgentTopic").publish(memberAddress); + localVCLocalCITestService.testLatestSubmission(studentParticipation.getId(), commitHash, 1, false); + } } diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java index 3b7ced720320..e05b87776154 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIResourceIntegrationTest.java @@ -1,7 +1,10 @@ package de.tum.cit.aet.artemis.programming.icl; import static org.assertj.core.api.Assertions.assertThat; +import static org.awaitility.Awaitility.await; +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; import java.time.ZonedDateTime; @@ -85,7 +88,7 @@ protected String getTestPrefix() { @BeforeEach void createJobs() { // temporarily remove listener to avoid triggering build job processing - sharedQueueProcessingService.removeListener(); + sharedQueueProcessingService.removeListenerAndCancelScheduledFuture(); JobTimingInfo jobTimingInfo1 = new JobTimingInfo(ZonedDateTime.now().plusMinutes(1), ZonedDateTime.now().plusMinutes(2), ZonedDateTime.now().plusMinutes(3)); JobTimingInfo jobTimingInfo2 = new JobTimingInfo(ZonedDateTime.now(), ZonedDateTime.now().plusMinutes(1), ZonedDateTime.now().plusMinutes(2)); @@ -97,7 +100,7 @@ void createJobs() { job1 = new BuildJobQueueItem("1", "job1", "address1", 1, course.getId(), 1, 1, 1, BuildStatus.SUCCESSFUL, repositoryInfo, jobTimingInfo1, buildConfig, null); job2 = new BuildJobQueueItem("2", "job2", "address1", 2, course.getId(), 1, 1, 1, BuildStatus.SUCCESSFUL, repositoryInfo, jobTimingInfo2, buildConfig, null); String memberAddress = hazelcastInstance.getCluster().getLocalMember().getAddress().toString(); - agent1 = new BuildAgentInformation(memberAddress, 1, 0, new ArrayList<>(List.of(job1)), false, new ArrayList<>(List.of(job2)), null); + agent1 = new BuildAgentInformation(memberAddress, 1, 0, new ArrayList<>(List.of(job1)), BuildAgentInformation.BuildAgentStatus.IDLE, new ArrayList<>(List.of(job2)), null); BuildJobQueueItem finishedJobQueueItem1 = new BuildJobQueueItem("3", "job3", "address1", 3, course.getId(), 1, 1, 1, BuildStatus.SUCCESSFUL, repositoryInfo, jobTimingInfo1, buildConfig, null); BuildJobQueueItem finishedJobQueueItem2 = new BuildJobQueueItem("4", "job4", "address1", 4, course.getId() + 1, 1, 1, 1, BuildStatus.FAILED, repositoryInfo, jobTimingInfo2, @@ -360,4 +363,14 @@ void testGetBuildJobStatistics() throws Exception { assertThat(response.failedBuilds()).isEqualTo(1); assertThat(response.cancelledBuilds()).isEqualTo(0); } + + @Test + @WithMockUser(username = TEST_PREFIX + "admin", roles = "ADMIN") + void testPauseBuildAgent() throws Exception { + request.put("/api/admin/agent/" + URLEncoder.encode(agent1.name(), StandardCharsets.UTF_8) + "/pause", null, HttpStatus.NO_CONTENT); + await().until(() -> buildAgentInformation.get(agent1.name()).status() == BuildAgentInformation.BuildAgentStatus.PAUSED); + + request.put("/api/admin/agent/" + URLEncoder.encode(agent1.name(), StandardCharsets.UTF_8) + "/resume", null, HttpStatus.NO_CONTENT); + await().until(() -> buildAgentInformation.get(agent1.name()).status() == BuildAgentInformation.BuildAgentStatus.IDLE); + } } diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java index 040aef91d87e..b935eb8d2d67 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalCIServiceTest.java @@ -80,7 +80,7 @@ void setUp() { processingJobs = hazelcastInstance.getMap("processingJobs"); // remove listener to avoid triggering build job processing - sharedQueueProcessingService.removeListener(); + sharedQueueProcessingService.removeListenerAndCancelScheduledFuture(); } @AfterEach diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalVCLocalCIIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalVCLocalCIIntegrationTest.java index 877ccd6493e0..17ca800422e9 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalVCLocalCIIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/icl/LocalVCLocalCIIntegrationTest.java @@ -111,6 +111,9 @@ class LocalVCLocalCIIntegrationTest extends AbstractLocalCILocalVCIntegrationTes @Value("${artemis.user-management.internal-admin.password}") private String localVCPassword; + @Value("${artemis.version-control.url}") + protected String artemisVersionControlUrl; + // ---- Repository handles ---- private LocalRepository templateRepository; @@ -911,6 +914,9 @@ void testFetchPush_teachingAssistantPracticeRepository() throws Exception { // Create practice participation. ProgrammingExerciseStudentParticipation practiceParticipation = participationUtilService.addStudentParticipationForProgrammingExercise(programmingExercise, tutor1Login); practiceParticipation.setPracticeMode(true); + practiceParticipation.setRepositoryUri(localVCLocalCITestService.constructLocalVCUrl("", "", projectKey1, practiceRepositorySlug)); + + // practiceParticipation.setRepositoryUri(String.format("%s/git/%s/%s.git", artemisVersionControlUrl, programmingExercise.getProjectKey(), practiceRepositorySlug)); programmingExerciseStudentParticipationRepository.save(practiceParticipation); // Students should not be able to access, teaching assistants should be able to fetch and push and editors and higher should be able to fetch and push. @@ -950,6 +956,8 @@ void testFetchPush_instructorPracticeRepository() throws Exception { ProgrammingExerciseStudentParticipation practiceParticipation = participationUtilService.addStudentParticipationForProgrammingExercise(programmingExercise, instructor1Login); practiceParticipation.setPracticeMode(true); + practiceParticipation.setRepositoryUri(localVCLocalCITestService.constructLocalVCUrl("", "", projectKey1, practiceRepositorySlug)); + programmingExerciseStudentParticipationRepository.save(practiceParticipation); // Students should not be able to access, teaching assistants should be able to fetch, and editors and higher should be able to fetch and push. @@ -973,11 +981,6 @@ void testFetchPush_instructorPracticeRepository() throws Exception { @Nested class BuildJobPriorityTest { - @BeforeEach - void setUp() { - sharedQueueProcessingService.removeListener(); - } - @AfterEach void tearDown() { queuedJobs.clear(); @@ -1031,6 +1034,9 @@ void testPriorityRunningExam() throws Exception { } private void testPriority(String login, int expectedPriority) throws Exception { + queuedJobs.clear(); + sharedQueueProcessingService.removeListenerAndCancelScheduledFuture(); + log.info("Creating participation"); ProgrammingExerciseStudentParticipation studentParticipation = localVCLocalCITestService.createParticipation(programmingExercise, student1Login); diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseFactory.java b/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseFactory.java index e01c45a01b9e..e4dca9d8be57 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseFactory.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseFactory.java @@ -9,6 +9,8 @@ import java.util.List; import java.util.Set; +import org.springframework.beans.factory.annotation.Value; + import de.tum.cit.aet.artemis.assessment.domain.AssessmentType; import de.tum.cit.aet.artemis.assessment.domain.CategoryState; import de.tum.cit.aet.artemis.assessment.domain.Feedback; @@ -43,6 +45,9 @@ public class ProgrammingExerciseFactory { public static final String DEFAULT_BRANCH = "main"; + @Value("${artemis.version-control.url}") + protected static String artemisVersionControlUrl; + /** * Generates a programming exercise with the given release and due date. This exercise is added to the provided course. * @@ -137,7 +142,7 @@ else if (programmingLanguage == ProgrammingLanguage.SWIFT) { } programmingExercise.setPackageName(programmingLanguage == ProgrammingLanguage.SWIFT ? "swiftTest" : "de.test"); final var repoName = programmingExercise.generateRepositoryName(RepositoryType.TESTS); - String testRepoUri = String.format("http://some.test.url/scm/%s/%s.git", programmingExercise.getProjectKey(), repoName); + String testRepoUri = String.format("%s/git/%s/%s.git", artemisVersionControlUrl, programmingExercise.getProjectKey(), repoName); programmingExercise.setTestRepositoryUri(testRepoUri); programmingExercise.getBuildConfig().setBranch(DEFAULT_BRANCH); } diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseUtilService.java b/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseUtilService.java index 984ca2f5ae26..e1571792335a 100644 --- a/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseUtilService.java +++ b/src/test/java/de/tum/cit/aet/artemis/programming/util/ProgrammingExerciseUtilService.java @@ -93,6 +93,9 @@ public class ProgrammingExerciseUtilService { @Value("${artemis.version-control.default-branch:main}") protected String defaultBranch; + @Value("${artemis.version-control.url}") + protected String artemisVersionControlUrl; + @Autowired private TemplateProgrammingExerciseParticipationRepository templateProgrammingExerciseParticipationRepo; @@ -197,7 +200,7 @@ public ProgrammingExercise addTemplateParticipationForProgrammingExercise(Progra TemplateProgrammingExerciseParticipation participation = new TemplateProgrammingExerciseParticipation(); participation.setProgrammingExercise(exercise); participation.setBuildPlanId(exercise.generateBuildPlanId(BuildPlanType.TEMPLATE)); - participation.setRepositoryUri(String.format("http://some.test.url/scm/%s/%s.git", exercise.getProjectKey(), repoName)); + participation.setRepositoryUri(String.format("%s/git/%s/%s.git", artemisVersionControlUrl, exercise.getProjectKey(), repoName)); participation.setInitializationState(InitializationState.INITIALIZED); templateProgrammingExerciseParticipationRepo.save(participation); exercise.setTemplateParticipation(participation); @@ -215,7 +218,7 @@ public ProgrammingExercise addSolutionParticipationForProgrammingExercise(Progra SolutionProgrammingExerciseParticipation participation = new SolutionProgrammingExerciseParticipation(); participation.setProgrammingExercise(exercise); participation.setBuildPlanId(exercise.generateBuildPlanId(BuildPlanType.SOLUTION)); - participation.setRepositoryUri(String.format("http://some.test.url/scm/%s/%s.git", exercise.getProjectKey(), repoName)); + participation.setRepositoryUri(String.format("%s/git/%s/%s.git", artemisVersionControlUrl, exercise.getProjectKey(), repoName)); participation.setInitializationState(InitializationState.INITIALIZED); solutionProgrammingExerciseParticipationRepo.save(participation); exercise.setSolutionParticipation(participation); diff --git a/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/AbstractTutorialGroupIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/AbstractTutorialGroupIntegrationTest.java index e18ea9081084..0f9928400e38 100644 --- a/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/AbstractTutorialGroupIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/AbstractTutorialGroupIntegrationTest.java @@ -25,6 +25,8 @@ import de.tum.cit.aet.artemis.communication.domain.conversation.Channel; import de.tum.cit.aet.artemis.communication.repository.conversation.ChannelRepository; import de.tum.cit.aet.artemis.communication.test_repository.ConversationParticipantTestRepository; +import de.tum.cit.aet.artemis.communication.test_repository.PostTestRepository; +import de.tum.cit.aet.artemis.communication.util.ConversationUtilService; import de.tum.cit.aet.artemis.core.domain.Language; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.test_repository.CourseTestRepository; @@ -32,7 +34,7 @@ import de.tum.cit.aet.artemis.core.user.util.UserUtilService; import de.tum.cit.aet.artemis.core.util.CourseTestService; import de.tum.cit.aet.artemis.core.util.CourseUtilService; -import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationLocalCILocalVCTest; +import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationIndependentTest; import de.tum.cit.aet.artemis.tutorialgroup.domain.TutorialGroup; import de.tum.cit.aet.artemis.tutorialgroup.domain.TutorialGroupRegistration; import de.tum.cit.aet.artemis.tutorialgroup.domain.TutorialGroupSchedule; @@ -49,58 +51,67 @@ import de.tum.cit.aet.artemis.tutorialgroup.test_repository.TutorialGroupTestRepository; import de.tum.cit.aet.artemis.tutorialgroup.util.TutorialGroupUtilService; -/** - * Contains useful methods for testing the tutorial groups feature. - */ -abstract class AbstractTutorialGroupIntegrationTest extends AbstractSpringIntegrationLocalCILocalVCTest { +public abstract class AbstractTutorialGroupIntegrationTest extends AbstractSpringIntegrationIndependentTest { + // Repositories @Autowired - CourseTestService courseTestService; + protected TutorialGroupTestRepository tutorialGroupTestRepository; @Autowired - UserTestRepository userRepository; + protected TutorialGroupSessionRepository tutorialGroupSessionRepository; @Autowired - CourseTestRepository courseRepository; + protected TutorialGroupScheduleTestRepository tutorialGroupScheduleTestRepository; @Autowired - TutorialGroupTestRepository tutorialGroupTestRepository; + protected TutorialGroupFreePeriodRepository tutorialGroupFreePeriodRepository; @Autowired - TutorialGroupSessionRepository tutorialGroupSessionRepository; + protected TutorialGroupsConfigurationRepository tutorialGroupsConfigurationRepository; @Autowired - TutorialGroupScheduleTestRepository tutorialGroupScheduleTestRepository; + protected TutorialGroupRegistrationTestRepository tutorialGroupRegistrationTestRepository; + // External Repositories @Autowired - TutorialGroupFreePeriodRepository tutorialGroupFreePeriodRepository; + protected UserTestRepository userRepository; @Autowired - TutorialGroupsConfigurationRepository tutorialGroupsConfigurationRepository; + protected CourseTestRepository courseRepository; @Autowired - TutorialGroupRegistrationTestRepository tutorialGroupRegistrationTestRepository; + protected ChannelRepository channelRepository; @Autowired - TutorialGroupService tutorialGroupService; + protected ConversationParticipantTestRepository conversationParticipantRepository; @Autowired - ChannelRepository channelRepository; + protected PostTestRepository postRepository; + // Services @Autowired - ConversationParticipantTestRepository conversationParticipantRepository; + protected TutorialGroupService tutorialGroupService; @Autowired - TutorialGroupChannelManagementService tutorialGroupChannelManagementService; + protected TutorialGroupChannelManagementService tutorialGroupChannelManagementService; + // Util Services @Autowired - TutorialGroupUtilService tutorialGroupUtilService; + protected TutorialGroupUtilService tutorialGroupUtilService; + // External Util Services @Autowired - CourseUtilService courseUtilService; + protected CourseUtilService courseUtilService; @Autowired - UserUtilService userUtilService; + protected UserUtilService userUtilService; + + @Autowired + protected ConversationUtilService conversationUtilService; + + // Misc + @Autowired + protected CourseTestService courseTestService; Long exampleCourseId; diff --git a/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/TutorialGroupIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/TutorialGroupIntegrationTest.java index 00e2cf588148..a30463011469 100644 --- a/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/TutorialGroupIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/TutorialGroupIntegrationTest.java @@ -22,7 +22,6 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.security.test.context.support.WithMockUser; import org.springframework.util.LinkedMultiValueMap; @@ -32,8 +31,6 @@ import de.tum.cit.aet.artemis.communication.domain.DisplayPriority; import de.tum.cit.aet.artemis.communication.domain.Post; -import de.tum.cit.aet.artemis.communication.test_repository.PostTestRepository; -import de.tum.cit.aet.artemis.communication.util.ConversationUtilService; import de.tum.cit.aet.artemis.core.domain.Language; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.dto.StudentDTO; @@ -49,12 +46,6 @@ class TutorialGroupIntegrationTest extends AbstractTutorialGroupIntegrationTest private static final String TEST_PREFIX = "tutorialgroup"; - @Autowired - private ConversationUtilService conversationUtilService; - - @Autowired - private PostTestRepository postRepository; - private User instructor1; private User tutor1; diff --git a/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/architecture/TutorialGroupTestArchitectureTest.java b/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/architecture/TutorialGroupTestArchitectureTest.java new file mode 100644 index 000000000000..cd7ad9b0ad12 --- /dev/null +++ b/src/test/java/de/tum/cit/aet/artemis/tutorialgroup/architecture/TutorialGroupTestArchitectureTest.java @@ -0,0 +1,17 @@ +package de.tum.cit.aet.artemis.tutorialgroup.architecture; + +import de.tum.cit.aet.artemis.shared.architecture.module.AbstractModuleTestArchitectureTest; +import de.tum.cit.aet.artemis.tutorialgroup.AbstractTutorialGroupIntegrationTest; + +class TutorialGroupTestArchitectureTest extends AbstractModuleTestArchitectureTest { + + @Override + public String getModulePackage() { + return ARTEMIS_PACKAGE + ".tutorialgroup"; + } + + @Override + protected Class getAbstractModuleIntegrationTestClass() { + return AbstractTutorialGroupIntegrationTest.class; + } +} diff --git a/src/test/javascript/spec/component/learning-paths/components/learning-paths-analytics.component.spec.ts b/src/test/javascript/spec/component/learning-paths/components/learning-paths-analytics.component.spec.ts new file mode 100644 index 000000000000..fe54e94bb83d --- /dev/null +++ b/src/test/javascript/spec/component/learning-paths/components/learning-paths-analytics.component.spec.ts @@ -0,0 +1,95 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { LearningPathsAnalyticsComponent } from 'app/course/learning-paths/components/learning-paths-analytics/learning-paths-analytics.component'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { AlertService } from 'app/core/util/alert.service'; +import { MockAlertService } from '../../../helpers/mocks/service/mock-alert.service'; +import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; +import { TranslateService } from '@ngx-translate/core'; +import { provideHttpClient } from '@angular/common/http'; +import { provideHttpClientTesting } from '@angular/common/http/testing'; +import { CompetencyGraphDTO, CompetencyGraphEdgeDTO, CompetencyGraphNodeDTO, CompetencyGraphNodeValueType } from 'app/entities/competency/learning-path.model'; + +describe('LearningPathsAnalyticsComponent', () => { + let component: LearningPathsAnalyticsComponent; + let fixture: ComponentFixture; + let learningPathApiService: LearningPathApiService; + let alertService: AlertService; + let getInstructorCompetencyGraphSpy: jest.SpyInstance; + + const courseId = 1; + + const competencyGraph = { + nodes: [ + { + id: '1', + label: 'Node 1', + valueType: CompetencyGraphNodeValueType.AVERAGE_MASTERY_PROGRESS, + value: 12, + } as CompetencyGraphNodeDTO, + { + id: '2', + label: 'Node 2', + valueType: CompetencyGraphNodeValueType.AVERAGE_MASTERY_PROGRESS, + value: 0, + } as CompetencyGraphNodeDTO, + ], + edges: [ + { + source: '1', + target: '2', + } as CompetencyGraphEdgeDTO, + ], + }; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [LearningPathsAnalyticsComponent], + providers: [ + provideHttpClient(), + provideHttpClientTesting(), + { + provide: TranslateService, + useClass: MockTranslateService, + }, + { provide: AlertService, useClass: MockAlertService }, + ], + }).compileComponents(); + + learningPathApiService = TestBed.inject(LearningPathApiService); + alertService = TestBed.inject(AlertService); + + getInstructorCompetencyGraphSpy = jest.spyOn(learningPathApiService, 'getLearningPathInstructorCompetencyGraph').mockResolvedValue(competencyGraph); + + fixture = TestBed.createComponent(LearningPathsAnalyticsComponent); + component = fixture.componentInstance; + fixture.componentRef.setInput('courseId', courseId); + }); + + it('should load instructor competency graph', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + + expect(getInstructorCompetencyGraphSpy).toHaveBeenCalledExactlyOnceWith(courseId); + expect(component.instructorCompetencyGraph()).toEqual(competencyGraph); + }); + + it('should set isLoading correctly', async () => { + const isLoadingSpy = jest.spyOn(component.isLoading, 'set'); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(isLoadingSpy).toHaveBeenNthCalledWith(1, true); + expect(isLoadingSpy).toHaveBeenNthCalledWith(2, false); + }); + + it('should show error on load instructor competency graph', async () => { + const alertServiceErrorSpy = jest.spyOn(alertService, 'addAlert'); + getInstructorCompetencyGraphSpy.mockRejectedValue(new Error('Error')); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(alertServiceErrorSpy).toHaveBeenCalledOnce(); + }); +}); diff --git a/src/test/javascript/spec/component/learning-paths/components/learning-paths-configuration.component.spec.ts b/src/test/javascript/spec/component/learning-paths/components/learning-paths-configuration.component.spec.ts new file mode 100644 index 000000000000..220681f972f8 --- /dev/null +++ b/src/test/javascript/spec/component/learning-paths/components/learning-paths-configuration.component.spec.ts @@ -0,0 +1,147 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { LearningPathsConfigurationComponent } from 'app/course/learning-paths/components/learning-paths-configuration/learning-paths-configuration.component'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { AlertService } from 'app/core/util/alert.service'; +import { provideHttpClient } from '@angular/common/http'; +import { provideHttpClientTesting } from '@angular/common/http/testing'; +import { TranslateService } from '@ngx-translate/core'; +import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; +import { MockAlertService } from '../../../helpers/mocks/service/mock-alert.service'; +import { LearningPathsConfigurationDTO } from 'app/entities/competency/learning-path.model'; + +describe('LearningPathsConfigurationComponent', () => { + let component: LearningPathsConfigurationComponent; + let fixture: ComponentFixture; + let learningPathApiService: LearningPathApiService; + let alertService: AlertService; + let getLearningPathsConfigurationSpy: jest.SpyInstance; + + const courseId = 1; + + const learningPathsConfiguration = { + includeAllGradedExercises: true, + }; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [LearningPathsConfigurationComponent], + providers: [ + provideHttpClient(), + provideHttpClientTesting(), + { + provide: TranslateService, + useClass: MockTranslateService, + }, + { provide: AlertService, useClass: MockAlertService }, + ], + }).compileComponents(); + + learningPathApiService = TestBed.inject(LearningPathApiService); + alertService = TestBed.inject(AlertService); + + getLearningPathsConfigurationSpy = jest.spyOn(learningPathApiService, 'getLearningPathsConfiguration').mockResolvedValue(learningPathsConfiguration); + + fixture = TestBed.createComponent(LearningPathsConfigurationComponent); + component = fixture.componentInstance; + fixture.componentRef.setInput('courseId', courseId); + }); + + it('should load learning paths configuration', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + + const includeAllExercisesCheckBox = fixture.nativeElement.querySelector('#include-all-graded-exercises-checkbox'); + + fixture.detectChanges(); + + expect(includeAllExercisesCheckBox.checked).toEqual(learningPathsConfiguration.includeAllGradedExercises); + expect(component.includeAllGradedExercisesEnabled()).toEqual(learningPathsConfiguration.includeAllGradedExercises); + expect(getLearningPathsConfigurationSpy).toHaveBeenCalledExactlyOnceWith(courseId); + }); + + it('should show error on load learning paths configuration', async () => { + const alertServiceErrorSpy = jest.spyOn(alertService, 'addAlert'); + getLearningPathsConfigurationSpy.mockRejectedValue(new Error('Error')); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(alertServiceErrorSpy).toHaveBeenCalledOnce(); + }); + + it('should set isLoading correctly', async () => { + const isLoadingSpy = jest.spyOn(component.isConfigLoading, 'set'); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(isLoadingSpy).toHaveBeenNthCalledWith(1, true); + expect(isLoadingSpy).toHaveBeenNthCalledWith(2, false); + }); + + it('should enable edit mode', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + + const includeAllExercisesCheckBox = fixture.nativeElement.querySelector('#include-all-graded-exercises-checkbox'); + expect(includeAllExercisesCheckBox.disabled).toBeTrue(); + + await enableEditMode(); + + expect(includeAllExercisesCheckBox.disabled).toBeFalse(); + + const saveButton = fixture.nativeElement.querySelector('#save-learning-paths-configuration-button'); + expect(saveButton).not.toBeNull(); + expect(component.isEditMode()).toBeTrue(); + }); + + it('should toggle include all graded exercises', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + + await enableEditMode(); + + const includeAllExercisesCheckBox = fixture.nativeElement.querySelector('#include-all-graded-exercises-checkbox'); + includeAllExercisesCheckBox.click(); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(includeAllExercisesCheckBox.checked).toBe(!learningPathsConfiguration.includeAllGradedExercises); + expect(component.includeAllGradedExercisesEnabled()).toBe(!learningPathsConfiguration.includeAllGradedExercises); + }); + + it('should save learning paths configuration', async () => { + const updateLearningPathsConfigurationSpy = jest.spyOn(learningPathApiService, 'updateLearningPathsConfiguration').mockResolvedValue(); + const alertServiceSuccessSpy = jest.spyOn(alertService, 'success'); + + fixture.detectChanges(); + await fixture.whenStable(); + + await enableEditMode(); + + const includeAllExercisesCheckBox = fixture.nativeElement.querySelector('#include-all-graded-exercises-checkbox'); + includeAllExercisesCheckBox.click(); + + const saveButton = fixture.nativeElement.querySelector('#save-learning-paths-configuration-button'); + saveButton.click(); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(updateLearningPathsConfigurationSpy).toHaveBeenCalledExactlyOnceWith(courseId, { + ...learningPathsConfiguration, + includeAllGradedExercises: !learningPathsConfiguration.includeAllGradedExercises, + }); + expect(alertServiceSuccessSpy).toHaveBeenCalledOnce(); + expect(component.isEditMode()).toBeFalse(); + }); + + async function enableEditMode(): Promise { + const editButton = fixture.nativeElement.querySelector('#edit-learning-paths-configuration-button'); + editButton.click(); + + fixture.detectChanges(); + await fixture.whenStable(); + } +}); diff --git a/src/test/javascript/spec/component/learning-paths/components/learning-paths-state.component.spec.ts b/src/test/javascript/spec/component/learning-paths/components/learning-paths-state.component.spec.ts new file mode 100644 index 000000000000..0193ae9a129f --- /dev/null +++ b/src/test/javascript/spec/component/learning-paths/components/learning-paths-state.component.spec.ts @@ -0,0 +1,145 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { LearningPathsStateComponent } from 'app/course/learning-paths/components/learning-paths-state/learning-paths-state.component'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { AlertService } from 'app/core/util/alert.service'; +import { MockAlertService } from '../../../helpers/mocks/service/mock-alert.service'; +import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; +import { provideHttpClient } from '@angular/common/http'; +import { TranslateService } from '@ngx-translate/core'; +import { provideHttpClientTesting } from '@angular/common/http/testing'; +import { ActivatedRoute, Router } from '@angular/router'; +import { of } from 'rxjs'; +import { HealthStatus, LearningPathHealthDTO } from 'app/entities/competency/learning-path-health.model'; +import { MockRouter } from '../../../helpers/mocks/mock-router'; + +describe('LearningPathsStateComponent', () => { + let component: LearningPathsStateComponent; + let fixture: ComponentFixture; + let learningPathApiService: LearningPathApiService; + let alertService: AlertService; + let router: Router; + let getLearningPathHealthStatusSpy: jest.SpyInstance; + + const courseId = 1; + + const learningPathHealth = { + missingLearningPaths: 1, + status: [HealthStatus.MISSING, HealthStatus.NO_COMPETENCIES, HealthStatus.NO_RELATIONS], + }; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [LearningPathsStateComponent], + providers: [ + provideHttpClient(), + provideHttpClientTesting(), + { + provide: TranslateService, + useClass: MockTranslateService, + }, + { provide: AlertService, useClass: MockAlertService }, + { + provide: ActivatedRoute, + useValue: { + parent: { + parent: { + params: of({ + courseId: courseId, + }), + }, + }, + }, + }, + { + provide: Router, + useClass: MockRouter, + }, + ], + }).compileComponents(); + + learningPathApiService = TestBed.inject(LearningPathApiService); + alertService = TestBed.inject(AlertService); + router = TestBed.inject(Router); + + getLearningPathHealthStatusSpy = jest.spyOn(learningPathApiService, 'getLearningPathHealthStatus').mockResolvedValue(learningPathHealth); + + fixture = TestBed.createComponent(LearningPathsStateComponent); + component = fixture.componentInstance; + fixture.componentRef.setInput('courseId', courseId); + }); + + it('should load learning path health status', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + fixture.detectChanges(); + + const learningPathsStateContainer = fixture.nativeElement.querySelectorAll('.learning-paths-state-container'); + + expect(learningPathsStateContainer).toHaveLength(learningPathHealth.status.length); + expect(getLearningPathHealthStatusSpy).toHaveBeenCalledExactlyOnceWith(courseId); + expect(component.learningPathHealthState()).toEqual(learningPathHealth.status); + }); + + it('should set isLoading correctly', async () => { + const isLoadingSpy = jest.spyOn(component.isLoading, 'set'); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(isLoadingSpy).toHaveBeenNthCalledWith(1, true); + expect(isLoadingSpy).toHaveBeenNthCalledWith(2, false); + }); + + it('should show error when loading fails', async () => { + jest.spyOn(learningPathApiService, 'getLearningPathHealthStatus').mockRejectedValue(new Error('Error loading learning path health status')); + const onErrorSpy = jest.spyOn(alertService, 'addAlert'); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(onErrorSpy).toHaveBeenCalledOnce(); + }); + + it.each([HealthStatus.NO_COMPETENCIES, HealthStatus.NO_RELATIONS])('should navigate to competencies page on %s status', async (status) => { + const navigateSpy = jest.spyOn(router, 'navigate'); + getLearningPathHealthStatusSpy.mockResolvedValue({ ...learningPathHealth, status: [status] }); + + await clickHealthStateButton(`#health-state-button-${status}`); + + expect(navigateSpy).toHaveBeenCalledExactlyOnceWith(['../competency-management'], { relativeTo: TestBed.inject(ActivatedRoute) }); + }); + + it('should generate missing learning paths', async () => { + const generateMissingLearningPathsSpy = jest.spyOn(learningPathApiService, 'generateMissingLearningPaths').mockResolvedValue(); + const successSpy = jest.spyOn(alertService, 'success'); + getLearningPathHealthStatusSpy.mockResolvedValue({ ...learningPathHealth, status: [HealthStatus.MISSING] }); + + await clickHealthStateButton(`#health-state-button-${HealthStatus.MISSING}`); + + expect(generateMissingLearningPathsSpy).toHaveBeenCalledExactlyOnceWith(courseId); + expect(successSpy).toHaveBeenCalledOnce(); + expect(getLearningPathHealthStatusSpy).toHaveBeenNthCalledWith(2, courseId); + }); + + it('should show error when generating missing learning paths fails', async () => { + jest.spyOn(learningPathApiService, 'generateMissingLearningPaths').mockRejectedValue(new Error('Error generating missing learning paths')); + const onErrorSpy = jest.spyOn(alertService, 'addAlert'); + getLearningPathHealthStatusSpy.mockResolvedValue({ ...learningPathHealth, status: [HealthStatus.MISSING] }); + + await clickHealthStateButton(`#health-state-button-${HealthStatus.MISSING}`); + + expect(onErrorSpy).toHaveBeenCalledOnce(); + }); + + async function clickHealthStateButton(selector: string) { + fixture.detectChanges(); + await fixture.whenStable(); + fixture.detectChanges(); + + const healthStateButton = fixture.nativeElement.querySelector(selector); + healthStateButton.click(); + + fixture.detectChanges(); + await fixture.whenStable(); + } +}); diff --git a/src/test/javascript/spec/component/learning-paths/components/learning-paths-table.component.spec.ts b/src/test/javascript/spec/component/learning-paths/components/learning-paths-table.component.spec.ts new file mode 100644 index 000000000000..66485d809779 --- /dev/null +++ b/src/test/javascript/spec/component/learning-paths/components/learning-paths-table.component.spec.ts @@ -0,0 +1,147 @@ +import '@angular/localize/init'; +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { LearningPathsTableComponent } from 'app/course/learning-paths/components/learning-paths-table/learning-paths-table.component'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; +import { AlertService } from 'app/core/util/alert.service'; +import { MockAlertService } from '../../../helpers/mocks/service/mock-alert.service'; +import { TranslateService } from '@ngx-translate/core'; +import { provideHttpClient } from '@angular/common/http'; +import { provideHttpClientTesting } from '@angular/common/http/testing'; +import { LearningPathInformationDTO } from 'app/entities/competency/learning-path.model'; +import { SearchResult, SearchTermPageableSearch } from 'app/shared/table/pageable-table'; +import { By } from '@angular/platform-browser'; + +describe('LearningPathsTableComponent', () => { + let component: LearningPathsTableComponent; + let fixture: ComponentFixture; + let learningPathApiService: LearningPathApiService; + let alertService: AlertService; + let getLearningPathInformationSpy: jest.SpyInstance; + + const courseId = 1; + + const searchResults = >{ + numberOfPages: 2, + resultsOnPage: generateResults(0, 100), + }; + + const pageable = { + page: 1, + pageSize: 100, + searchTerm: '', + sortingOrder: 'ASCENDING', + sortedColumn: 'ID', + }; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [LearningPathsTableComponent], + providers: [ + provideHttpClient(), + provideHttpClientTesting(), + { + provide: TranslateService, + useClass: MockTranslateService, + }, + { provide: AlertService, useClass: MockAlertService }, + ], + }).compileComponents(); + + learningPathApiService = TestBed.inject(LearningPathApiService); + alertService = TestBed.inject(AlertService); + + getLearningPathInformationSpy = jest.spyOn(learningPathApiService, 'getLearningPathInformation').mockResolvedValue(searchResults); + + fixture = TestBed.createComponent(LearningPathsTableComponent); + component = fixture.componentInstance; + fixture.componentRef.setInput('courseId', courseId); + }); + + afterEach(() => { + jest.restoreAllMocks(); + }); + + it('should load learning paths', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + fixture.detectChanges(); + + const learningPathRows = fixture.nativeElement.querySelectorAll('tr'); + + expect(getLearningPathInformationSpy).toHaveBeenCalledExactlyOnceWith(courseId, pageable); + + expect(component.learningPaths()).toEqual(searchResults.resultsOnPage); + expect(learningPathRows).toHaveLength(searchResults.resultsOnPage.length + 1); + expect(component.collectionSize()).toBe(searchResults.resultsOnPage.length * searchResults.numberOfPages); + }); + + it('should open competency graph modal', async () => { + const learningPathId = 1; + const openCompetencyGraphSpy = jest.spyOn(component, 'openCompetencyGraph'); + + fixture.detectChanges(); + await fixture.whenStable(); + fixture.detectChanges(); + + const learningPathIdButton = fixture.debugElement.query(By.css(`#open-competency-graph-button-${learningPathId}`)); + learningPathIdButton.nativeElement.click(); + expect(openCompetencyGraphSpy).toHaveBeenCalledExactlyOnceWith(1); + }); + + it('should change page', async () => { + const onPageChangeSpy = jest.spyOn(component, 'setPage'); + + fixture.detectChanges(); + await fixture.whenStable(); + + await component.setPage(2); + + expect(onPageChangeSpy).toHaveBeenLastCalledWith(2); + expect(getLearningPathInformationSpy).toHaveBeenLastCalledWith(courseId, { ...pageable, page: 2 }); + }); + + it('should search for learning paths when the search term changes', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + fixture.detectChanges(); + + const searchField = fixture.debugElement.query(By.css('#learning-path-search')); + const searchPageable = { ...pageable, searchTerm: 'Search Term' }; + searchField.nativeElement.value = 'Search Term'; + searchField.nativeElement.dispatchEvent(new Event('input')); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(getLearningPathInformationSpy).toHaveBeenLastCalledWith(courseId, searchPageable); + }); + + it('should show error message when loading learning paths fails', async () => { + getLearningPathInformationSpy.mockRejectedValue(new Error('Error loading learning paths')); + const alertServiceErrorSpy = jest.spyOn(alertService, 'addAlert'); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(alertServiceErrorSpy).toHaveBeenCalledOnce(); + }); + + it('should set isLoading correctly', async () => { + const isLoadingSpy = jest.spyOn(component.isLoading, 'set'); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(isLoadingSpy).toHaveBeenNthCalledWith(1, true); + expect(isLoadingSpy).toHaveBeenNthCalledWith(2, false); + }); + + function generateResults(start: number, end: number): LearningPathInformationDTO[] { + return Array.from({ length: end - start }, (_, i) => ({ + id: i + start, + user: { name: `User ${i + start}`, login: `user${i + start}` }, + progress: i + start, + })); + } +}); diff --git a/src/test/javascript/spec/component/learning-paths/management/learning-path-management.component.spec.ts b/src/test/javascript/spec/component/learning-paths/management/learning-path-management.component.spec.ts index d432116e8ae0..884544d93695 100644 --- a/src/test/javascript/spec/component/learning-paths/management/learning-path-management.component.spec.ts +++ b/src/test/javascript/spec/component/learning-paths/management/learning-path-management.component.spec.ts @@ -3,7 +3,7 @@ import { LearningPathManagementComponent, TableColumn } from 'app/course/learnin import { LearningPathPagingService } from 'app/course/learning-paths/learning-path-paging.service'; import { SortService } from 'app/shared/service/sort.service'; import { SearchResult, SearchTermPageableSearch, SortingOrder } from 'app/shared/table/pageable-table'; -import { LearningPath } from 'app/entities/competency/learning-path.model'; +import { LearningPath, LearningPathInformationDTO } from 'app/entities/competency/learning-path.model'; import { ArtemisTestModule } from '../../../test.module'; import { MockComponent, MockDirective, MockPipe } from 'ng-mocks'; import { ButtonComponent } from 'app/shared/components/button.component'; @@ -97,7 +97,7 @@ describe('LearningPathManagementComponent', () => { searchStub.mockReturnValue(of(searchResult)); enableLearningPathsStub.mockReturnValue(of(new HttpResponse())); generateMissingLearningPathsForCourseStub.mockReturnValue(of(new HttpResponse())); - health = new LearningPathHealthDTO([HealthStatus.OK]); + health = new LearningPathHealthDTO([]); getHealthStatusForCourseStub.mockReturnValue(of(new HttpResponse({ body: health }))); }); @@ -128,19 +128,6 @@ describe('LearningPathManagementComponent', () => { expect(alertServiceStub).toHaveBeenCalledOnce(); })); - it('should enable learning paths and load data', fakeAsync(() => { - const healthDisabled = new LearningPathHealthDTO([HealthStatus.DISABLED]); - getHealthStatusForCourseStub.mockReturnValueOnce(of(new HttpResponse({ body: healthDisabled }))).mockReturnValueOnce(of(new HttpResponse({ body: health }))); - fixture.detectChanges(); - comp.ngOnInit(); - expect(comp.health).toEqual(healthDisabled); - comp.enableLearningPaths(); - expect(enableLearningPathsStub).toHaveBeenCalledOnce(); - expect(enableLearningPathsStub).toHaveBeenCalledWith(courseId); - expect(getHealthStatusForCourseStub).toHaveBeenCalledTimes(3); - expect(comp.health).toEqual(health); - })); - it('should alert error if enable learning paths fails', fakeAsync(() => { const error = { status: 404 }; enableLearningPathsStub.mockReturnValue(throwError(() => new HttpErrorResponse(error))); @@ -218,6 +205,6 @@ describe('LearningPathManagementComponent', () => { })); it('should return learning path id', () => { - expect(comp.trackId(0, learningPath)).toEqual(learningPath.id); + expect(comp.trackId(0, { id: 2 })).toEqual(learningPath.id); }); }); diff --git a/src/test/javascript/spec/component/learning-paths/pages/learning-path-instructor-page.component.spec.ts b/src/test/javascript/spec/component/learning-paths/pages/learning-path-instructor-page.component.spec.ts new file mode 100644 index 000000000000..500d5db33716 --- /dev/null +++ b/src/test/javascript/spec/component/learning-paths/pages/learning-path-instructor-page.component.spec.ts @@ -0,0 +1,145 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { LearningPathInstructorPageComponent } from 'app/course/learning-paths/pages/learning-path-instructor-page/learning-path-instructor-page.component'; +import { LearningPathApiService } from 'app/course/learning-paths/services/learning-path-api.service'; +import { AlertService } from 'app/core/util/alert.service'; +import { MockAlertService } from '../../../helpers/mocks/service/mock-alert.service'; +import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; +import { HttpErrorResponse, HttpResponse, provideHttpClient } from '@angular/common/http'; +import { provideHttpClientTesting } from '@angular/common/http/testing'; +import { TranslateService } from '@ngx-translate/core'; +import { ActivatedRoute } from '@angular/router'; +import { of } from 'rxjs'; +import { CourseManagementService } from 'app/course/manage/course-management.service'; +import { ArtemisTestModule } from '../../../test.module'; +import { Course } from 'app/entities/course.model'; + +describe('LearningPathInstructorPageComponent', () => { + let component: LearningPathInstructorPageComponent; + let fixture: ComponentFixture; + let learningPathApiService: LearningPathApiService; + let alertService: AlertService; + let courseManagementService: CourseManagementService; + let getCourseSpy: jest.SpyInstance; + + const courseId = 1; + + const course = { + id: 1, + learningPathsEnabled: false, + }; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [ArtemisTestModule, LearningPathInstructorPageComponent], + providers: [ + provideHttpClient(), + provideHttpClientTesting(), + { + provide: ActivatedRoute, + useValue: { + parent: { + params: of({ + courseId: courseId, + }), + }, + }, + }, + { + provide: TranslateService, + useClass: MockTranslateService, + }, + { provide: AlertService, useClass: MockAlertService }, + ], + }).compileComponents(); + + learningPathApiService = TestBed.inject(LearningPathApiService); + alertService = TestBed.inject(AlertService); + courseManagementService = TestBed.inject(CourseManagementService); + + getCourseSpy = jest.spyOn(courseManagementService, 'findOneForDashboard').mockReturnValue( + of( + new HttpResponse({ + body: course, + }), + ), + ); + + fixture = TestBed.createComponent(LearningPathInstructorPageComponent); + component = fixture.componentInstance; + }); + + it('should load course', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + + expect(getCourseSpy).toHaveBeenCalledExactlyOnceWith(courseId); + expect(component.learningPathsEnabled()).toBe(course.learningPathsEnabled); + }); + + it('should show error on load course', async () => { + const alertServiceErrorSpy = jest.spyOn(alertService, 'addAlert'); + getCourseSpy.mockRejectedValue(new HttpErrorResponse({ error: 'Error' })); + + fixture.detectChanges(); + await fixture.whenStable(); + fixture.detectChanges(); + + expect(alertServiceErrorSpy).toHaveBeenCalledOnce(); + }); + + it('should set isLoading correctly on course loading', async () => { + const isLoadingSpy = jest.spyOn(component.isLoading, 'set'); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(isLoadingSpy).toHaveBeenNthCalledWith(1, true); + expect(isLoadingSpy).toHaveBeenNthCalledWith(2, false); + }); + + it('should show enable learning paths button if not enabled', async () => { + fixture.detectChanges(); + await fixture.whenStable(); + + const enableLearningPathsButton = fixture.nativeElement.querySelector('#enable-learning-paths-button'); + expect(enableLearningPathsButton).toBeDefined(); + }); + + it('should enable learning paths', async () => { + const enableLearningPathsSpy = jest.spyOn(learningPathApiService, 'enableLearningPaths').mockResolvedValue(); + + await clickEnableLearningPathsButton(); + + expect(enableLearningPathsSpy).toHaveBeenCalledExactlyOnceWith(courseId); + expect(component.learningPathsEnabled()).toBeTrue(); + }); + + it('should show error on enable learning paths', async () => { + const alertServiceErrorSpy = jest.spyOn(alertService, 'addAlert'); + jest.spyOn(learningPathApiService, 'enableLearningPaths').mockRejectedValue(new Error('Error')); + + await clickEnableLearningPathsButton(); + + expect(alertServiceErrorSpy).toHaveBeenCalledOnce(); + }); + + it('should set isLoading correctly on enable learning paths', async () => { + const isLoadingSpy = jest.spyOn(component.isLoading, 'set'); + + await clickEnableLearningPathsButton(); + + expect(isLoadingSpy).toHaveBeenNthCalledWith(1, true); + expect(isLoadingSpy).toHaveBeenNthCalledWith(2, false); + }); + + async function clickEnableLearningPathsButton(): Promise { + fixture.detectChanges(); + await fixture.whenStable(); + + const enableLearningPathsButton = fixture.nativeElement.querySelector('#enable-learning-paths-button'); + enableLearningPathsButton.click(); + + fixture.detectChanges(); + await fixture.whenStable(); + } +}); diff --git a/src/test/javascript/spec/component/learning-paths/pages/learning-path-student-page.component.spec.ts b/src/test/javascript/spec/component/learning-paths/pages/learning-path-student-page.component.spec.ts index 15f0dc14b768..2bebd4f5df76 100644 --- a/src/test/javascript/spec/component/learning-paths/pages/learning-path-student-page.component.spec.ts +++ b/src/test/javascript/spec/component/learning-paths/pages/learning-path-student-page.component.spec.ts @@ -78,18 +78,13 @@ describe('LearningPathStudentPageComponent', () => { jest.restoreAllMocks(); }); - it('should initialize', () => { - expect(component).toBeTruthy(); - expect(component.courseId()).toBe(courseId); - }); - it('should get learning path', async () => { const getLearningPathIdSpy = jest.spyOn(learningPathApiService, 'getLearningPathForCurrentUser').mockResolvedValue(learningPath); fixture.detectChanges(); await fixture.whenStable(); - expect(getLearningPathIdSpy).toHaveBeenCalledWith(courseId); + expect(getLearningPathIdSpy).toHaveBeenCalledExactlyOnceWith(courseId); expect(component.learningPath()).toEqual(learningPath); }); @@ -116,7 +111,7 @@ describe('LearningPathStudentPageComponent', () => { fixture.detectChanges(); await fixture.whenStable(); - expect(getLearningPathIdSpy).toHaveBeenCalledWith(courseId); + expect(getLearningPathIdSpy).toHaveBeenCalledExactlyOnceWith(courseId); expect(alertServiceErrorSpy).toHaveBeenCalledOnce(); }); diff --git a/src/test/javascript/spec/component/link-preview/link-preview-container.component.spec.ts b/src/test/javascript/spec/component/link-preview/link-preview-container.component.spec.ts index 6f17eeba735a..534aaad61e6f 100644 --- a/src/test/javascript/spec/component/link-preview/link-preview-container.component.spec.ts +++ b/src/test/javascript/spec/component/link-preview/link-preview-container.component.spec.ts @@ -37,7 +37,7 @@ describe('LinkPreviewContainerComponent', () => { }); it('should fetch link previews and update linkPreviews array', () => { - component.data = 'Check out these links: https://example.com/link1 and https://example.com/link2'; + fixture.componentRef.setInput('data', 'Check out these links: https://example.com/link1 and https://example.com/link2'); const links: Link[] = [ { type: '', value: '', href: 'https://example.com/link1' }, { type: '', value: '', href: 'https://example.com/link2' }, @@ -52,18 +52,18 @@ describe('LinkPreviewContainerComponent', () => { component.ngOnInit(); - expect(linkifyServiceSpy).toHaveBeenCalledWith(component.data); + expect(linkifyServiceSpy).toHaveBeenCalledWith(component.data()); expect(linkPreviewServiceSpy).toHaveBeenCalledTimes(2); expect(linkPreviewServiceSpy).toHaveBeenCalledWith('https://example.com/link1'); expect(linkPreviewServiceSpy).toHaveBeenCalledWith('https://example.com/link2'); - expect(component.linkPreviews).toEqual(mockLinkPreviews); - expect(component.hasError).toBeFalse(); - expect(component.loaded).toBeTrue(); - expect(component.showLoadingsProgress).toBeFalse(); + expect(component.linkPreviews()).toEqual(mockLinkPreviews); + expect(component.hasError()).toBeFalse(); + expect(component.loaded()).toBeTrue(); + expect(component.showLoadingsProgress()).toBeFalse(); }); it('should update existing link preview if it already exists', () => { - component.data = 'Check out these links: https://example.com/link1'; + fixture.componentRef.setInput('data', 'Check out these links: https://example.com/link1'); const links: Link[] = [{ type: '', value: '', href: 'https://example.com/link1' }]; const existingLinkPreview: LinkPreview = { url: 'https://example.com/link1', @@ -77,14 +77,14 @@ describe('LinkPreviewContainerComponent', () => { const linkifyServiceSpy = jest.spyOn(linkifyService, 'find').mockReturnValue(links); const linkPreviewServiceSpy = jest.spyOn(linkPreviewService, 'fetchLink').mockReturnValueOnce(of(newLinkPreview)); - component.linkPreviews.push(existingLinkPreview); + component.linkPreviews().push(existingLinkPreview); component.ngOnInit(); - expect(linkifyServiceSpy).toHaveBeenCalledWith(component.data); + expect(linkifyServiceSpy).toHaveBeenCalledWith(component.data()); expect(linkPreviewServiceSpy).toHaveBeenCalledOnce(); expect(linkPreviewServiceSpy).toHaveBeenCalledWith('https://example.com/link1'); - expect(component.linkPreviews).toHaveLength(1); - expect(component.linkPreviews[0]).toEqual(newLinkPreview); + expect(component.linkPreviews()).toHaveLength(1); + expect(component.linkPreviews()[0]).toEqual(newLinkPreview); }); }); diff --git a/src/test/javascript/spec/component/localci/build-agents/build-agent-details.component.spec.ts b/src/test/javascript/spec/component/localci/build-agents/build-agent-details.component.spec.ts index 9c4ddded2d45..2db5c31ac80b 100644 --- a/src/test/javascript/spec/component/localci/build-agents/build-agent-details.component.spec.ts +++ b/src/test/javascript/spec/component/localci/build-agents/build-agent-details.component.spec.ts @@ -1,21 +1,22 @@ import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing'; import { JhiWebsocketService } from 'app/core/websocket/websocket.service'; import { BuildAgentsService } from 'app/localci/build-agents/build-agents.service'; -import { of } from 'rxjs'; +import { of, throwError } from 'rxjs'; import { BuildJob } from 'app/entities/programming/build-job.model'; import dayjs from 'dayjs/esm'; import { ArtemisTestModule } from '../../../test.module'; import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; import { DataTableComponent } from 'app/shared/data-table/data-table.component'; -import { MockComponent, MockPipe } from 'ng-mocks'; +import { MockComponent, MockPipe, MockProvider } from 'ng-mocks'; import { NgxDatatableModule } from '@siemens/ngx-datatable'; -import { BuildAgent } from 'app/entities/programming/build-agent.model'; +import { BuildAgent, BuildAgentStatus } from 'app/entities/programming/build-agent.model'; import { RepositoryInfo, TriggeredByPushTo } from 'app/entities/programming/repository-info.model'; import { JobTimingInfo } from 'app/entities/job-timing-info.model'; import { BuildConfig } from 'app/entities/programming/build-config.model'; import { BuildAgentDetailsComponent } from 'app/localci/build-agents/build-agent-details/build-agent-details/build-agent-details.component'; import { MockActivatedRoute } from '../../../helpers/mocks/activated-route/mock-activated-route'; import { ActivatedRoute } from '@angular/router'; +import { AlertService, AlertType } from 'app/core/util/alert.service'; describe('BuildAgentDetailsComponent', () => { let component: BuildAgentDetailsComponent; @@ -30,6 +31,8 @@ describe('BuildAgentDetailsComponent', () => { const mockBuildAgentsService = { getBuildAgentDetails: jest.fn().mockReturnValue(of([])), + pauseBuildAgent: jest.fn().mockReturnValue(of({})), + resumeBuildAgent: jest.fn().mockReturnValue(of({})), }; const repositoryInfo: RepositoryInfo = { @@ -114,9 +117,12 @@ describe('BuildAgentDetailsComponent', () => { numberOfCurrentBuildJobs: 2, runningBuildJobs: mockRunningJobs1, recentBuildJobs: mockRecentBuildJobs1, - status: true, + status: BuildAgentStatus.ACTIVE, }; + let alertService: AlertService; + let alertServiceAddAlertStub: jest.SpyInstance; + beforeEach(waitForAsync(() => { TestBed.configureTestingModule({ imports: [ArtemisTestModule, NgxDatatableModule], @@ -126,6 +132,7 @@ describe('BuildAgentDetailsComponent', () => { { provide: ActivatedRoute, useValue: new MockActivatedRoute({ key: 'ABC123' }) }, { provide: BuildAgentsService, useValue: mockBuildAgentsService }, { provide: DataTableComponent, useClass: DataTableComponent }, + MockProvider(AlertService), ], }).compileComponents(); @@ -133,6 +140,8 @@ describe('BuildAgentDetailsComponent', () => { component = fixture.componentInstance; activatedRoute = fixture.debugElement.injector.get(ActivatedRoute) as MockActivatedRoute; activatedRoute.setParameters({ agentName: mockBuildAgent.name }); + alertService = TestBed.inject(AlertService); + alertServiceAddAlertStub = jest.spyOn(alertService, 'addAlert'); })); beforeEach(() => { @@ -202,4 +211,66 @@ describe('BuildAgentDetailsComponent', () => { expect(spy).toHaveBeenCalledOnce(); }); + + it('should show an alert when pausing build agent without a name', () => { + component.buildAgent = { ...mockBuildAgent, name: '' }; + component.pauseBuildAgent(); + + expect(alertServiceAddAlertStub).toHaveBeenCalledWith({ + type: AlertType.WARNING, + message: 'artemisApp.buildAgents.alerts.buildAgentWithoutName', + }); + }); + + it('should show an alert when resuming build agent without a name', () => { + component.buildAgent = { ...mockBuildAgent, name: '' }; + component.resumeBuildAgent(); + + expect(alertServiceAddAlertStub).toHaveBeenCalledWith({ + type: AlertType.WARNING, + message: 'artemisApp.buildAgents.alerts.buildAgentWithoutName', + }); + }); + + it('should show success alert when pausing build agent', () => { + component.buildAgent = mockBuildAgent; + + component.pauseBuildAgent(); + expect(alertServiceAddAlertStub).toHaveBeenCalledWith({ + type: AlertType.SUCCESS, + message: 'artemisApp.buildAgents.alerts.buildAgentPaused', + }); + }); + + it('should show error alert when pausing build agent fails', () => { + mockBuildAgentsService.pauseBuildAgent.mockReturnValue(throwError(() => new Error())); + component.buildAgent = mockBuildAgent; + + component.pauseBuildAgent(); + expect(alertServiceAddAlertStub).toHaveBeenCalledWith({ + type: AlertType.DANGER, + message: 'artemisApp.buildAgents.alerts.buildAgentPauseFailed', + }); + }); + + it('should show success alert when resuming build agent', () => { + component.buildAgent = mockBuildAgent; + + component.resumeBuildAgent(); + expect(alertServiceAddAlertStub).toHaveBeenCalledWith({ + type: AlertType.SUCCESS, + message: 'artemisApp.buildAgents.alerts.buildAgentResumed', + }); + }); + + it('should show error alert when resuming build agent fails', () => { + mockBuildAgentsService.resumeBuildAgent.mockReturnValue(throwError(() => new Error())); + component.buildAgent = mockBuildAgent; + + component.resumeBuildAgent(); + expect(alertServiceAddAlertStub).toHaveBeenCalledWith({ + type: AlertType.DANGER, + message: 'artemisApp.buildAgents.alerts.buildAgentResumeFailed', + }); + }); }); diff --git a/src/test/javascript/spec/component/localci/build-agents/build-agent-summary.component.spec.ts b/src/test/javascript/spec/component/localci/build-agents/build-agent-summary.component.spec.ts index 7c18ab22e946..9a4e94b1cb7e 100644 --- a/src/test/javascript/spec/component/localci/build-agents/build-agent-summary.component.spec.ts +++ b/src/test/javascript/spec/component/localci/build-agents/build-agent-summary.component.spec.ts @@ -10,7 +10,7 @@ import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; import { DataTableComponent } from 'app/shared/data-table/data-table.component'; import { MockComponent, MockPipe } from 'ng-mocks'; import { NgxDatatableModule } from '@siemens/ngx-datatable'; -import { BuildAgent } from 'app/entities/programming/build-agent.model'; +import { BuildAgent, BuildAgentStatus } from 'app/entities/programming/build-agent.model'; import { RepositoryInfo, TriggeredByPushTo } from 'app/entities/programming/repository-info.model'; import { JobTimingInfo } from 'app/entities/job-timing-info.model'; import { BuildConfig } from 'app/entities/programming/build-config.model'; @@ -124,7 +124,7 @@ describe('BuildAgentSummaryComponent', () => { maxNumberOfConcurrentBuildJobs: 2, numberOfCurrentBuildJobs: 2, runningBuildJobs: mockRunningJobs1, - status: true, + status: BuildAgentStatus.ACTIVE, }, { id: 2, @@ -132,7 +132,7 @@ describe('BuildAgentSummaryComponent', () => { maxNumberOfConcurrentBuildJobs: 2, numberOfCurrentBuildJobs: 2, runningBuildJobs: mockRunningJobs2, - status: true, + status: BuildAgentStatus.ACTIVE, }, ]; diff --git a/src/test/javascript/spec/component/localci/build-agents/build-agents.service.spec.ts b/src/test/javascript/spec/component/localci/build-agents/build-agents.service.spec.ts index 421b868c03fe..c73f5d49ee15 100644 --- a/src/test/javascript/spec/component/localci/build-agents/build-agents.service.spec.ts +++ b/src/test/javascript/spec/component/localci/build-agents/build-agents.service.spec.ts @@ -1,16 +1,17 @@ import { TestBed } from '@angular/core/testing'; +import { provideHttpClient } from '@angular/common/http'; import { HttpTestingController, provideHttpClientTesting } from '@angular/common/http/testing'; import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; import { TranslateService } from '@ngx-translate/core'; import { BuildJob } from 'app/entities/programming/build-job.model'; import dayjs from 'dayjs/esm'; +import { lastValueFrom } from 'rxjs'; import { BuildAgentsService } from 'app/localci/build-agents/build-agents.service'; import { BuildAgent } from 'app/entities/programming/build-agent.model'; import { RepositoryInfo, TriggeredByPushTo } from 'app/entities/programming/repository-info.model'; import { JobTimingInfo } from 'app/entities/job-timing-info.model'; import { BuildConfig } from 'app/entities/programming/build-config.model'; -import { provideHttpClient } from '@angular/common/http'; describe('BuildAgentsService', () => { let service: BuildAgentsService; @@ -113,6 +114,74 @@ describe('BuildAgentsService', () => { req.flush(expectedResponse); }); + it('should handle get build agent details error', async () => { + const errorMessage = 'Failed to fetch build agent details buildAgent1'; + + const observable = lastValueFrom(service.getBuildAgentDetails('buildAgent1')); + + const req = httpMock.expectOne(`${service.adminResourceUrl}/build-agent?agentName=buildAgent1`); + expect(req.request.method).toBe('GET'); + req.flush({ message: errorMessage }, { status: 500, statusText: 'Internal Server Error' }); + + try { + await observable; + throw new Error('expected an error, but got a success'); + } catch (error) { + expect(error.message).toContain(errorMessage); + } + }); + + it('should pause build agent', () => { + service.pauseBuildAgent('buildAgent1').subscribe(); + + const req = httpMock.expectOne(`${service.adminResourceUrl}/agent/buildAgent1/pause`); + expect(req.request.method).toBe('PUT'); + req.flush({}); + }); + + it('should resume build agent', () => { + service.resumeBuildAgent('buildAgent1').subscribe(); + + const req = httpMock.expectOne(`${service.adminResourceUrl}/agent/buildAgent1/resume`); + expect(req.request.method).toBe('PUT'); + req.flush({}); + }); + + it('should handle pause build agent error', async () => { + const errorMessage = 'Failed to pause build agent buildAgent1'; + + const observable = lastValueFrom(service.pauseBuildAgent('buildAgent1')); + + const req = httpMock.expectOne(`${service.adminResourceUrl}/agent/buildAgent1/pause`); + expect(req.request.method).toBe('PUT'); + req.flush({ message: errorMessage }, { status: 500, statusText: 'Internal Server Error' }); + + try { + await observable; + throw new Error('expected an error, but got a success'); + } catch (error) { + expect(error.message).toContain(errorMessage); + } + }); + + it('should handle resume build agent error', async () => { + const errorMessage = 'Failed to resume build agent buildAgent1'; + + const observable = lastValueFrom(service.resumeBuildAgent('buildAgent1')); + + // Set up the expected HTTP request and flush the response with an error. + const req = httpMock.expectOne(`${service.adminResourceUrl}/agent/buildAgent1/resume`); + expect(req.request.method).toBe('PUT'); + req.flush({ message: errorMessage }, { status: 500, statusText: 'Internal Server Error' }); + + try { + await observable; + throw new Error('expected an error, but got a success'); + } catch (error) { + expect(error.message).toContain(errorMessage); + } + }); + afterEach(() => { httpMock.verify(); // Verify that there are no outstanding requests. }); diff --git a/src/test/javascript/spec/component/localvc/commit-history.component.spec.ts b/src/test/javascript/spec/component/localvc/commit-history.component.spec.ts index 8c3a628980a6..672cfc49982f 100644 --- a/src/test/javascript/spec/component/localvc/commit-history.component.spec.ts +++ b/src/test/javascript/spec/component/localvc/commit-history.component.spec.ts @@ -272,4 +272,25 @@ describe('CommitHistoryComponent', () => { expect(component.paramSub?.closed).toBeTrue(); expect(component.participationSub?.closed).toBeTrue(); }); + + it('should load auxiliary repository commits', () => { + setupComponent(); + activatedRoute.setParameters({ repositoryType: 'AUXILIARY', repositoryId: 5 }); + jest.spyOn(programmingExerciseParticipationService, 'retrieveCommitHistoryForAuxiliaryRepository').mockReturnValue(of(mockTestCommits)); + + // Trigger ngOnInit + component.ngOnInit(); + + // Expectations + expect(component.commits).toEqual(mockTestCommits); // Updated to reflect the correct order + expect(component.commits[0].result).toBeUndefined(); + expect(component.commits[1].result).toBeUndefined(); + + // Trigger ngOnDestroy + component.ngOnDestroy(); + + // Expect subscription to be unsubscribed + expect(component.paramSub?.closed).toBeTrue(); + expect(component.participationSub?.closed).toBeTrue(); + }); }); diff --git a/src/test/javascript/spec/component/localvc/repository-view.component.spec.ts b/src/test/javascript/spec/component/localvc/repository-view.component.spec.ts index ff004d03c91b..512e1abae71a 100644 --- a/src/test/javascript/spec/component/localvc/repository-view.component.spec.ts +++ b/src/test/javascript/spec/component/localvc/repository-view.component.spec.ts @@ -18,6 +18,7 @@ import { DueDateStat } from 'app/course/dashboards/due-date-stat.model'; import { ProgrammingExerciseStudentParticipation } from 'app/entities/participation/programming-exercise-student-participation.model'; import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; import { MockProfileService } from '../../helpers/mocks/service/mock-profile.service'; +import { AuxiliaryRepository } from 'app/entities/programming/programming-exercise-auxiliary-repository-model'; describe('RepositoryViewComponent', () => { let component: RepositoryViewComponent; @@ -170,6 +171,44 @@ describe('RepositoryViewComponent', () => { expect(component.paramSub?.closed).toBeTrue(); }); + it('should load AUXILIARY repository type', () => { + // Mock exercise and participation data + const mockAuxiliaryRepository: AuxiliaryRepository = { id: 5, repositoryUri: 'repositoryUri', checkoutDirectory: 'dir', name: 'AuxRepo', description: 'description' }; + const mockExercise: ProgrammingExercise = { + id: 1, + numberOfAssessmentsOfCorrectionRounds: [new DueDateStat()], + auxiliaryRepositories: [mockAuxiliaryRepository], + studentAssignedTeamIdComputed: true, + secondCorrectionEnabled: true, + }; + const mockExerciseResponse: HttpResponse = new HttpResponse({ body: mockExercise }); + const exerciseId = 1; + const auxiliaryRepositoryId = 5; + + activatedRoute.setParameters({ exerciseId: exerciseId, repositoryType: 'AUXILIARY', repositoryId: auxiliaryRepositoryId }); + jest.spyOn(programmingExerciseService, 'findWithAuxiliaryRepository').mockReturnValue(of(mockExerciseResponse)); + + // Trigger ngOnInit + component.ngOnInit(); + + // Expect loadingParticipation to be false after loading + expect(component.loadingParticipation).toBeFalse(); + + // Expect exercise and participation to be set correctly + expect(component.exercise).toEqual(mockExercise); + expect(component.participation).toBeUndefined(); + + // Expect domainService method to be called with the correct arguments + expect(component.domainService.setDomain).toHaveBeenCalledWith([DomainType.AUXILIARY_REPOSITORY, mockAuxiliaryRepository]); + + // Trigger ngOnDestroy + component.ngOnDestroy(); + + // Expect subscription to be unsubscribed + expect(component.differentParticipationSub?.closed).toBeTrue(); + expect(component.paramSub?.closed).toBeTrue(); + }); + it('should handle unknown repository type', () => { // Mock exercise and participation data const mockExercise: ProgrammingExercise = { diff --git a/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts b/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts index c67649159a60..71a9eaef676c 100644 --- a/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts +++ b/src/test/javascript/spec/component/overview/course-conversations/course-conversations.component.spec.ts @@ -1,6 +1,5 @@ import { CourseConversationsComponent } from 'app/overview/course-conversations/course-conversations.component'; import { ComponentFixture, TestBed, fakeAsync, tick, waitForAsync } from '@angular/core/testing'; -import { Type } from '@angular/core'; import { ConversationDTO } from 'app/entities/metis/conversation/conversation.model'; import { generateExampleChannelDTO, generateExampleGroupChatDTO, generateOneToOneChatDTO } from './helpers/conversationExampleModels'; import { MockComponent, MockPipe, MockProvider } from 'ng-mocks'; @@ -29,20 +28,17 @@ import { DocumentationButtonComponent } from 'app/shared/components/documentatio import { getElement } from '../../../helpers/utils/general.utils'; import { SidebarComponent } from 'app/shared/sidebar/sidebar.component'; import { CourseOverviewService } from 'app/overview/course-overview.service'; -import { ChannelSubType } from 'app/entities/metis/conversation/channel.model'; -import { UserPublicInfoDTO } from 'app/core/user/user.model'; import { GroupChatCreateDialogComponent } from 'app/overview/course-conversations/dialogs/group-chat-create-dialog/group-chat-create-dialog.component'; -import { AbstractDialogComponent } from 'app/overview/course-conversations/dialogs/abstract-dialog.component'; -import { defaultFirstLayerDialogOptions } from 'app/overview/course-conversations/other/conversation.util'; import { NgbCollapseMocksModule } from '../../../helpers/mocks/directive/ngbCollapseMocks.module'; import { NgbTooltipMocksModule } from '../../../helpers/mocks/directive/ngbTooltipMocks.module'; import { SidebarEventService } from 'app/shared/sidebar/sidebar-event.service'; -import { AccordionAddOptionsComponent } from 'app/shared/sidebar/accordion-add-options/accordion-add-options.component'; import { SidebarAccordionComponent } from 'app/shared/sidebar/sidebar-accordion/sidebar-accordion.component'; import { GroupChatDTO } from 'app/entities/metis/conversation/group-chat.model'; import { OneToOneChatCreateDialogComponent } from 'app/overview/course-conversations/dialogs/one-to-one-chat-create-dialog/one-to-one-chat-create-dialog.component'; -import { ChannelsOverviewDialogComponent } from 'app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component'; +import { ChannelAction, ChannelsOverviewDialogComponent } from 'app/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component'; import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; +import { ChannelsCreateDialogComponent } from 'app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component'; +import { ChannelDTO } from 'app/entities/metis/conversation/channel.model'; const examples: (ConversationDTO | undefined)[] = [undefined, generateOneToOneChatDTO({}), generateExampleGroupChatDTO({}), generateExampleChannelDTO({})]; @@ -56,8 +52,8 @@ examples.forEach((activeConversation) => { let postsSubject: BehaviorSubject; let acceptCodeOfConductSpy: jest.SpyInstance; let setActiveConversationSpy: jest.SpyInstance; - let sidebarEventService: SidebarEventService; let metisConversationService: MetisConversationService; + let modalService: NgbModal; beforeEach(waitForAsync(() => { queryParamsSubject = new BehaviorSubject(convertToParamMap({})); @@ -73,7 +69,6 @@ examples.forEach((activeConversation) => { MockComponent(ButtonComponent), MockComponent(SidebarComponent), MockComponent(CourseWideSearchComponent), - MockComponent(AccordionAddOptionsComponent), MockComponent(SidebarAccordionComponent), MockPipe(ArtemisTranslatePipe), MockPipe(HtmlForMarkdownPipe), @@ -112,7 +107,6 @@ examples.forEach((activeConversation) => { }, }); - sidebarEventService = TestBed.inject(SidebarEventService); metisConversationService = TestBed.inject(MetisConversationService); Object.defineProperty(metisConversationService, 'isServiceSetup$', { get: () => new BehaviorSubject(true).asObservable() }); @@ -135,12 +129,10 @@ examples.forEach((activeConversation) => { postsSubject = new BehaviorSubject([]); jest.spyOn(metisConversationService, 'course', 'get').mockReturnValue(course); jest.spyOn(metisConversationService, 'activeConversation$', 'get').mockReturnValue(new BehaviorSubject(activeConversation).asObservable()); - jest.spyOn(sidebarEventService, 'emitSidebarAccordionPlusClickedEvent').mockImplementation((groupKey: string) => { - component.onAccordionPlusButtonPressed(groupKey); - }); setActiveConversationSpy = jest.spyOn(metisConversationService, 'setActiveConversation'); acceptCodeOfConductSpy = jest.spyOn(metisConversationService, 'acceptCodeOfConduct'); jest.spyOn(metisService, 'posts', 'get').mockReturnValue(postsSubject.asObservable()); + modalService = TestBed.inject(NgbModal); })); afterEach(() => { @@ -155,6 +147,57 @@ examples.forEach((activeConversation) => { expect(component.activeConversation).toEqual(activeConversation); }); + describe('Dialog Opening', () => { + const expectedResults = [undefined, true]; + const mockModalRef: Partial = { + componentInstance: { + course: {}, + initialize: jest.fn(), + }, + }; + + beforeEach(() => { + // Set a mock course with id 1 + component.course = { id: 1 } as Course; + }); + + it('should open the group chat creation dialog', fakeAsync(() => { + mockModalRef.result = Promise.resolve(undefined); + const spy = jest.spyOn(modalService, 'open').mockReturnValue(mockModalRef as NgbModalRef); + component.openCreateGroupChatDialog(); + tick(); + expect(spy).toHaveBeenCalledExactlyOnceWith(GroupChatCreateDialogComponent, expect.anything()); + })); + + it('should open the one-to-one chat creation dialog', fakeAsync(() => { + const spy = jest.spyOn(modalService, 'open').mockReturnValue(mockModalRef as NgbModalRef); + component.openCreateOneToOneChatDialog(); + tick(); + expect(spy).toHaveBeenCalledExactlyOnceWith(OneToOneChatCreateDialogComponent, expect.anything()); + })); + + it('should open the channel overview dialog', fakeAsync(() => { + mockModalRef.result = Promise.resolve(expectedResults); + const spy = jest.spyOn(modalService, 'open').mockReturnValue(mockModalRef as NgbModalRef); + component.openChannelOverviewDialog(); + tick(); + expect(spy).toHaveBeenCalledExactlyOnceWith(ChannelsOverviewDialogComponent, expect.anything()); + expect(mockModalRef.componentInstance.initialize).toHaveBeenCalled(); + })); + + it('should open the create channel dialog when onCreateChannelPressed is called', fakeAsync(() => { + mockModalRef.result = Promise.resolve(expectedResults); + const spy = jest.spyOn(modalService, 'open').mockReturnValue(mockModalRef as NgbModalRef); + + component.openCreateChannelDialog(); + tick(); + + expect(spy).toHaveBeenCalledExactlyOnceWith(ChannelsCreateDialogComponent, expect.anything()); + expect(mockModalRef.componentInstance.course).toEqual(course); + expect(mockModalRef.componentInstance.initialize).toHaveBeenCalled(); + })); + }); + it('should update thread in post', fakeAsync(() => { fixture.detectChanges(); component.postInThread = { id: 1, content: 'loremIpsum' } as Post; @@ -245,101 +288,70 @@ examples.forEach((activeConversation) => { expect(setActiveConversationSpy).toHaveBeenCalled(); }); - it('getChannelSubType method should return correct SubType', () => { - expect(component.getChannelSubType('exerciseChannels')).toEqual(ChannelSubType.EXERCISE); - expect(component.getChannelSubType('examChannels')).toEqual(ChannelSubType.EXAM); - expect(component.getChannelSubType('generalChannels')).toEqual(ChannelSubType.GENERAL); - expect(component.getChannelSubType('lectureChannels')).toEqual(ChannelSubType.LECTURE); - }); + describe('performChannelAction', () => { + let channelAction: ChannelAction; + let channel: ChannelDTO; - it('onAccordionPlusButtonPressed method should call openCreateGroupChatDialog when groupKey is groupChats', () => { - const createGroupChatSpy = jest.spyOn(component, 'openCreateGroupChatDialog').mockImplementation(); - component.onAccordionPlusButtonPressed('groupChats'); - expect(createGroupChatSpy).toHaveBeenCalled(); - }); + beforeEach(() => { + channel = new ChannelDTO(); + channel.id = 123; + channel.name = 'Test Channel'; - it('onAccordionPlusButtonPressed method should call openCreateOneToOneChatDialog when groupKey is directMessages', () => { - const createDirectMessageSpy = jest.spyOn(component, 'openCreateOneToOneChatDialog').mockImplementation(); - component.onAccordionPlusButtonPressed('directMessages'); - expect(createDirectMessageSpy).toHaveBeenCalled(); - }); + channelAction = { + action: 'create', + channel, + }; - it('onAccordionPlusButtonPressed method should call openChannelOverviewDialog when groupKey is any channelType', () => { - const openChannelOverviewDialogSpy = jest.spyOn(component, 'openChannelOverviewDialog').mockImplementation(); - component.onAccordionPlusButtonPressed('generalChannels'); - expect(openChannelOverviewDialogSpy).toHaveBeenCalledWith('generalChannels'); - component.onAccordionPlusButtonPressed('examChannels'); - expect(openChannelOverviewDialogSpy).toHaveBeenCalledWith('examChannels'); - component.onAccordionPlusButtonPressed('lectureChannels'); - expect(openChannelOverviewDialogSpy).toHaveBeenCalledWith('lectureChannels'); - component.onAccordionPlusButtonPressed('exerciseChannels'); - expect(openChannelOverviewDialogSpy).toHaveBeenCalledWith('exerciseChannels'); - component.onAccordionPlusButtonPressed('randomInputShouldAddedToGeneralChannels'); - expect(openChannelOverviewDialogSpy).toHaveBeenCalledWith('generalChannels'); - }); + component.createChannelFn = undefined; + component.ngOnInit(); - it('should open create group chat dialog when button is pressed', fakeAsync(() => { - const createGroupChatSpy = jest.spyOn(metisConversationService, 'createGroupChat').mockReturnValue(EMPTY); - createConversationDialogTest([new UserPublicInfoDTO()], GroupChatCreateDialogComponent, 'groupChats'); - fixture.whenStable().then(() => { - expect(createGroupChatSpy).toHaveBeenCalledOnce(); + component.createChannelFn = jest.fn().mockReturnValue(EMPTY); + jest.spyOn(component, 'prepareSidebarData').mockImplementation(); }); - })); - it('should open one to one chat dialog when button is pressed', fakeAsync(() => { - const createOneToOneChatSpy = jest.spyOn(metisConversationService, 'createOneToOneChat').mockReturnValue(EMPTY); - const chatPartner = new UserPublicInfoDTO(); - chatPartner.login = 'test'; - createConversationDialogTest(chatPartner, OneToOneChatCreateDialogComponent, 'directMessages'); - fixture.whenStable().then(() => { - expect(createOneToOneChatSpy).toHaveBeenCalledOnce(); + it('should call createChannelFn with the provided channel', () => { + component.performChannelAction(channelAction); + expect(component.createChannelFn).toHaveBeenCalledWith(channel); }); - })); - it('should open channel overview dialog when button is pressed', fakeAsync(() => { - fixture.detectChanges(); - tick(301); - const modalService = TestBed.inject(NgbModal); - const mockModalRef = { - componentInstance: { - course: undefined, - createChannelFn: undefined, - initialize: () => {}, - }, - result: Promise.resolve([new GroupChatDTO(), true]), - }; - const openDialogSpy = jest.spyOn(modalService, 'open').mockReturnValue(mockModalRef as unknown as NgbModalRef); - component.onAccordionPlusButtonPressed('generalChannels'); + it('should call prepareSidebarData on successful completion', () => { + component.createChannelFn = jest.fn().mockReturnValue({ + pipe: () => ({ + subscribe: ({ complete }: any) => { + complete(); + }, + }), + }); - tick(301); - fixture.whenStable().then(() => { - expect(openDialogSpy).toHaveBeenCalledOnce(); - expect(openDialogSpy).toHaveBeenCalledWith(ChannelsOverviewDialogComponent, defaultFirstLayerDialogOptions); - expect(mockModalRef.componentInstance.course).toEqual(course); + component.performChannelAction(channelAction); + expect(component.prepareSidebarData).toHaveBeenCalled(); }); - })); - function createConversationDialogTest(modalReturnValue: any, dialog: Type, channelType: string) { - fixture.detectChanges(); - tick(301); - const modalService = TestBed.inject(NgbModal); - const mockModalRef = { - componentInstance: { - course: undefined, - initialize: () => {}, - }, - result: Promise.resolve(modalReturnValue), - }; - const openDialogSpy = jest.spyOn(modalService, 'open').mockReturnValue(mockModalRef as unknown as NgbModalRef); - fixture.detectChanges(); + it('should log an error if createChannelFn throws an error', () => { + const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(); - sidebarEventService.emitSidebarAccordionPlusClickedEvent(channelType); - tick(301); - fixture.whenStable().then(() => { - expect(openDialogSpy).toHaveBeenCalledOnce(); - expect(openDialogSpy).toHaveBeenCalledWith(dialog, defaultFirstLayerDialogOptions); - expect(mockModalRef.componentInstance.course).toEqual(course); + component.createChannelFn = jest.fn().mockReturnValue({ + pipe: () => ({ + subscribe: ({ error }: any) => { + error('Test Error'); + }, + }), + }); + + component.performChannelAction(channelAction); + expect(consoleErrorSpy).toHaveBeenCalledWith('Error creating channel:', 'Test Error'); + + consoleErrorSpy.mockRestore(); + }); + + it('should not call createChannelFn or prepareSidebarData if createChannelFn is undefined', () => { + component.createChannelFn = undefined; + const prepareSidebarDataSpy = jest.spyOn(component, 'prepareSidebarData'); + component.performChannelAction(channelAction); + expect(component.createChannelFn).toBeUndefined(); + // Since createChannelFn is undefined, prepareSidebarData should not be called + expect(prepareSidebarDataSpy).not.toHaveBeenCalled(); }); - } + }); }); }); diff --git a/src/test/javascript/spec/component/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.spec.ts b/src/test/javascript/spec/component/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.spec.ts index ac930363fa6a..3cc001fce612 100644 --- a/src/test/javascript/spec/component/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.spec.ts +++ b/src/test/javascript/spec/component/overview/course-conversations/dialogs/channels-overview-dialog/channels-overview-dialog.component.spec.ts @@ -12,11 +12,9 @@ import { generateExampleChannelDTO } from '../../helpers/conversationExampleMode import { ChannelService } from 'app/shared/metis/conversations/channel.service'; import { ConversationService } from 'app/shared/metis/conversations/conversation.service'; import { AlertService } from 'app/core/util/alert.service'; -import { NgbActiveModal, NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; +import { NgbActiveModal, NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { HttpResponse } from '@angular/common/http'; import { By } from '@angular/platform-browser'; -import { ChannelsCreateDialogComponent } from 'app/overview/course-conversations/dialogs/channels-create-dialog/channels-create-dialog.component'; -import { defaultSecondLayerDialogOptions } from 'app/overview/course-conversations/other/conversation.util'; import { FaIconComponent } from '@fortawesome/angular-fontawesome'; import { NgbCollapseMocksModule } from '../../../../../helpers/mocks/directive/ngbCollapseMocks.module'; @@ -107,8 +105,7 @@ examples.forEach((exampleChannel) => { expect(component).toBeTruthy(); expect(getChannelsOfCourseSpy).toHaveBeenCalledWith(course.id); expect(getChannelsOfCourseSpy).toHaveBeenCalledOnce(); - expect(component.noOfChannels).toBe(3); - expect(component.otherChannels).toHaveLength(3); + expect(component.noOfChannels).toBe(6); expect(fixture.nativeElement.querySelectorAll('jhi-channel-item')).toHaveLength(6); expect(channelItems).toHaveLength(6); expect(channelItems[0].channel).toEqual(channelOne); @@ -156,46 +153,5 @@ examples.forEach((exampleChannel) => { expect(component.channelModificationPerformed).toBeTrue(); })); } - - it('should not show create channel button if user is missing the permission', fakeAsync(() => { - canCreateChannel.mockReturnValue(false); - fixture.detectChanges(); - expect(fixture.debugElement.nativeElement.querySelector('#createChannel')).toBeFalsy(); - })); - - if (allowChannelCreation) { - it('should open create channel dialog when button is pressed', fakeAsync(() => { - const modalService = TestBed.inject(NgbModal); - const mockModalRef = { - componentInstance: { course: undefined, initialize: () => {} }, - result: Promise.resolve(new ChannelDTO()), - }; - const openDialogSpy = jest.spyOn(modalService, 'open').mockReturnValue(mockModalRef as unknown as NgbModalRef); - fixture.detectChanges(); - - const createChannelButton = fixture.debugElement.nativeElement.querySelector('#createChannel'); - createChannelButton.click(); - tick(501); - fixture.whenStable().then(() => { - expect(openDialogSpy).toHaveBeenCalledOnce(); - expect(openDialogSpy).toHaveBeenCalledWith(ChannelsCreateDialogComponent, defaultSecondLayerDialogOptions); - expect(mockModalRef.componentInstance.course).toEqual(course); - }); - })); - } else { - it('should hide create channel button if creation is not allowed', () => { - const createChannelButton = fixture.debugElement.nativeElement.querySelector('#createChannel'); - expect(createChannelButton).toBeNull(); - }); - } - - it('should toggle other channels on click', () => { - expect(component.otherChannelsAreCollapsed).toBeTrue(); - - const otherChannels = fixture.debugElement.nativeElement.querySelector('.other-channels'); - otherChannels.click(); - - expect(component.otherChannelsAreCollapsed).toBeFalse(); - }); }); }); diff --git a/src/test/javascript/spec/component/overview/exercise-details/request-feedback-button/request-feedback-button.component.spec.ts b/src/test/javascript/spec/component/overview/exercise-details/request-feedback-button/request-feedback-button.component.spec.ts index 94219fdd2420..d5741fd57069 100644 --- a/src/test/javascript/spec/component/overview/exercise-details/request-feedback-button/request-feedback-button.component.spec.ts +++ b/src/test/javascript/spec/component/overview/exercise-details/request-feedback-button/request-feedback-button.component.spec.ts @@ -56,7 +56,7 @@ describe('RequestFeedbackButtonComponent', () => { submissions: [{ id: 1, submitted: true }], testRun: false, } as StudentParticipation; - const exercise = { id: 1, type: ExerciseType.TEXT, course: undefined, studentParticipations: [participation] } as Exercise; + const exercise = { id: 1, type: ExerciseType.TEXT, course: undefined, studentParticipations: [participation], allowFeedbackRequests: true } as Exercise; fixture.componentRef.setInput('exercise', exercise); mockExerciseDetails(exercise); @@ -75,7 +75,7 @@ describe('RequestFeedbackButtonComponent', () => { it('should display the button when Athena is enabled and it is not an exam exercise', fakeAsync(() => { setAthenaEnabled(true); - const exercise = { id: 1, type: ExerciseType.TEXT, course: {} } as Exercise; // course undefined means exam exercise + const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, allowFeedbackRequests: true } as Exercise; // course undefined means exam exercise fixture.componentRef.setInput('exercise', exercise); mockExerciseDetails(exercise); @@ -104,7 +104,7 @@ describe('RequestFeedbackButtonComponent', () => { it('should disable the button when participation is missing', fakeAsync(() => { setAthenaEnabled(true); - const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, studentParticipations: undefined } as Exercise; + const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, studentParticipations: undefined, allowFeedbackRequests: true } as Exercise; fixture.componentRef.setInput('exercise', exercise); mockExerciseDetails(exercise); @@ -123,7 +123,7 @@ describe('RequestFeedbackButtonComponent', () => { id: 1, submissions: [{ id: 1, submitted: true }], } as StudentParticipation; - const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, studentParticipations: [participation] } as Exercise; + const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, studentParticipations: [participation], allowFeedbackRequests: true } as Exercise; fixture.componentRef.setInput('exercise', exercise); component.isExamExercise = false; mockExerciseDetails(exercise); @@ -146,7 +146,7 @@ describe('RequestFeedbackButtonComponent', () => { submissions: [{ id: 1, submitted: false }], testRun: false, } as StudentParticipation; - const exercise = { id: 1, type: ExerciseType.PROGRAMMING, studentParticipations: [participation], course: {} } as Exercise; + const exercise = { id: 1, type: ExerciseType.PROGRAMMING, studentParticipations: [participation], course: {}, allowFeedbackRequests: true } as Exercise; fixture.componentRef.setInput('exercise', exercise); mockExerciseDetails(exercise); @@ -173,7 +173,7 @@ describe('RequestFeedbackButtonComponent', () => { it('should show an alert when requestFeedback() is called and conditions are not satisfied', fakeAsync(() => { setAthenaEnabled(true); - const exercise = { id: 1, type: ExerciseType.TEXT, course: {} } as Exercise; + const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, allowFeedbackRequests: true } as Exercise; fixture.componentRef.setInput('exercise', exercise); jest.spyOn(component, 'hasAthenaResultForLatestSubmission').mockReturnValue(true); @@ -191,7 +191,7 @@ describe('RequestFeedbackButtonComponent', () => { submissions: [{ id: 1, submitted: false }], testRun: false, } as StudentParticipation; - const exercise = { id: 1, type: ExerciseType.TEXT, studentParticipations: [participation], course: {} } as Exercise; + const exercise = { id: 1, type: ExerciseType.TEXT, studentParticipations: [participation], course: {}, allowFeedbackRequests: true } as Exercise; fixture.componentRef.setInput('exercise', exercise); fixture.componentRef.setInput('isGeneratingFeedback', false); mockExerciseDetails(exercise); @@ -212,7 +212,7 @@ describe('RequestFeedbackButtonComponent', () => { submissions: [{ id: 1, submitted: true }], testRun: false, } as StudentParticipation; - const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, studentParticipations: [participation] } as Exercise; + const exercise = { id: 1, type: ExerciseType.TEXT, course: {}, studentParticipations: [participation], allowFeedbackRequests: true } as Exercise; fixture.componentRef.setInput('exercise', exercise); fixture.componentRef.setInput('isGeneratingFeedback', false); mockExerciseDetails(exercise); diff --git a/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-difficulty.component.spec.ts b/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-difficulty.component.spec.ts index 70c70a17dd5b..0750ffcdca6a 100644 --- a/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-difficulty.component.spec.ts +++ b/src/test/javascript/spec/component/programming-exercise/update-components/programming-exercise-difficulty.component.spec.ts @@ -14,6 +14,7 @@ import { ProfileInfo } from 'app/shared/layouts/profiles/profile-info.model'; import { ProfileService } from 'app/shared/layouts/profiles/profile.service'; import { PROFILE_THEIA } from 'app/app.constants'; import { ArtemisTestModule } from '../../../test.module'; +import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; describe('ProgrammingExerciseDifficultyComponent', () => { let fixture: ComponentFixture; @@ -24,7 +25,7 @@ describe('ProgrammingExerciseDifficultyComponent', () => { beforeEach(() => { TestBed.configureTestingModule({ - imports: [ArtemisTestModule], + imports: [ArtemisTestModule, ArtemisSharedComponentModule], declarations: [ CheckboxControlValueAccessor, DefaultValueAccessor, diff --git a/src/test/javascript/spec/component/shared/monaco-editor/monaco-editor-communication-action.integration.spec.ts b/src/test/javascript/spec/component/shared/monaco-editor/monaco-editor-communication-action.integration.spec.ts index 862de1bdc8a7..fd1179a35c4b 100644 --- a/src/test/javascript/spec/component/shared/monaco-editor/monaco-editor-communication-action.integration.spec.ts +++ b/src/test/javascript/spec/component/shared/monaco-editor/monaco-editor-communication-action.integration.spec.ts @@ -26,6 +26,8 @@ import { Lecture } from 'app/entities/lecture.model'; import { LectureAttachmentReferenceAction } from 'app/shared/monaco-editor/model/actions/communication/lecture-attachment-reference.action'; import { LectureUnitType } from 'app/entities/lecture-unit/lectureUnit.model'; import { ReferenceType } from 'app/shared/metis/metis.util'; +import { Attachment } from 'app/entities/attachment.model'; +import dayjs from 'dayjs/esm'; describe('MonacoEditorCommunicationActionIntegration', () => { let comp: MonacoEditorComponent; @@ -276,6 +278,64 @@ describe('MonacoEditorCommunicationActionIntegration', () => { expect(comp.getText()).toBe(`[lecture]${lecture.title}(${metisService.getLinkForLecture(lecture.id.toString())})[/lecture]`); }); + it('should reference an attachment without brackets', () => { + fixture.detectChanges(); + + const attachmentNameWithBrackets = 'Test (File) With [Brackets] And (More) [Bracket(s)]'; + const attachmentNameWithoutBrackets = 'Test File With Brackets And More Brackets'; + + const newAttachment = { + id: 53, + name: attachmentNameWithBrackets, + link: '/api/files/attachments/lecture/4/Mein_Test_PDF3.pdf', + version: 1, + uploadDate: dayjs('2019-05-07T08:49:59+02:00'), + attachmentType: 'FILE', + } as Attachment; + + comp.registerAction(lectureAttachmentReferenceAction); + const lecture = lectureAttachmentReferenceAction.lecturesWithDetails[0]; + const shortLink = newAttachment.link?.split('attachments/')[1]; + lectureAttachmentReferenceAction.executeInCurrentEditor({ reference: ReferenceType.ATTACHMENT, lecture: lecture, attachment: newAttachment }); + expect(comp.getText()).toBe(`[attachment]${attachmentNameWithoutBrackets}(${shortLink})[/attachment]`); + }); + + it('should reference a lecture without brackets', () => { + fixture.detectChanges(); + + const lectureNameWithBrackets = 'Test (Lecture) With [Brackets] And (More) [Bracket(s)]'; + const lectureNameWithoutBrackets = 'Test Lecture With Brackets And More Brackets'; + + comp.registerAction(lectureAttachmentReferenceAction); + const lecture = lectureAttachmentReferenceAction.lecturesWithDetails[0]; + const previousTitle = lecture.title; + lecture.title = lectureNameWithBrackets; + lectureAttachmentReferenceAction.executeInCurrentEditor({ reference: ReferenceType.LECTURE, lecture }); + lecture.title = previousTitle; + expect(comp.getText()).toBe(`[lecture]${lectureNameWithoutBrackets}(${metisService.getLinkForLecture(lecture.id.toString())})[/lecture]`); + }); + + it('should reference an attachment unit without brackets', () => { + fixture.detectChanges(); + + const attachmentUnitNameWithBrackets = 'Test (AttachmentUnit) With [Brackets] And (More) [Bracket(s)]'; + const attachmentUnitNameWithoutBrackets = 'Test AttachmentUnit With Brackets And More Brackets'; + + comp.registerAction(lectureAttachmentReferenceAction); + const lecture = lectureAttachmentReferenceAction.lecturesWithDetails[2]; + const attachmentUnit = lecture.attachmentUnits![0]; + const previousName = attachmentUnit.name; + attachmentUnit.name = attachmentUnitNameWithBrackets; + const attachmentUnitFileName = 'Metis-Attachment.pdf'; + lectureAttachmentReferenceAction.executeInCurrentEditor({ + reference: ReferenceType.ATTACHMENT_UNITS, + lecture, + attachmentUnit, + }); + attachmentUnit.name = previousName; + expect(comp.getText()).toBe(`[lecture-unit]${attachmentUnitNameWithoutBrackets}(${attachmentUnitFileName})[/lecture-unit]`); + }); + it('should reference an attachment', () => { fixture.detectChanges(); comp.registerAction(lectureAttachmentReferenceAction); diff --git a/src/test/javascript/spec/component/shared/sidebar/accordion-add-options.component.spec.ts b/src/test/javascript/spec/component/shared/sidebar/accordion-add-options.component.spec.ts deleted file mode 100644 index 3bd63df2e611..000000000000 --- a/src/test/javascript/spec/component/shared/sidebar/accordion-add-options.component.spec.ts +++ /dev/null @@ -1,45 +0,0 @@ -import { ComponentFixture, TestBed, fakeAsync, tick } from '@angular/core/testing'; -import { AccordionAddOptionsComponent } from 'app/shared/sidebar/accordion-add-options/accordion-add-options.component'; -import { MockComponent, MockProvider } from 'ng-mocks'; -import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; -import { FaIconComponent } from '@fortawesome/angular-fontawesome'; -import { NgbCollapseMocksModule } from '../../../helpers/mocks/directive/ngbCollapseMocks.module'; -import { NgbTooltipMocksModule } from '../../../helpers/mocks/directive/ngbTooltipMocks.module'; -import { SidebarEventService } from 'app/shared/sidebar/sidebar-event.service'; - -describe('AccordionAddOptionsComponent', () => { - let component: AccordionAddOptionsComponent; - let fixture: ComponentFixture; - let sidebarEventService: SidebarEventService; - - beforeEach(async () => { - await TestBed.configureTestingModule({ - imports: [NgbCollapseMocksModule, NgbTooltipMocksModule], - declarations: [AccordionAddOptionsComponent, MockComponent(FaIconComponent)], - providers: [MockProvider(NgbModal), MockProvider(SidebarEventService)], - }).compileComponents(); - - sidebarEventService = TestBed.inject(SidebarEventService); - fixture = TestBed.createComponent(AccordionAddOptionsComponent); - component = fixture.componentInstance; - - jest.spyOn(sidebarEventService, 'emitSidebarAccordionPlusClickedEvent').mockImplementation(() => {}); - fixture.detectChanges(); - }); - - it('should create', () => { - expect(component).toBeTruthy(); - }); - - it('should call emitSidebarAccordionPlusClickedEvent when button is pressed', fakeAsync(() => { - component.groupKey = 'test'; - fixture.detectChanges(); - const emitSidebarAccordionPlusClickedEventSpy = jest.spyOn(sidebarEventService, 'emitSidebarAccordionPlusClickedEvent'); - - const dialogOpenButton = fixture.debugElement.nativeElement.querySelector('#plusButton-test'); - dialogOpenButton.click(); - tick(301); - - expect(emitSidebarAccordionPlusClickedEventSpy).toHaveBeenCalledWith('test'); - })); -}); diff --git a/src/test/javascript/spec/component/shared/sidebar/conversation-options.component.spec.ts b/src/test/javascript/spec/component/shared/sidebar/conversation-options.component.spec.ts index 0fc2fad98e4c..e36a883298a8 100644 --- a/src/test/javascript/spec/component/shared/sidebar/conversation-options.component.spec.ts +++ b/src/test/javascript/spec/component/shared/sidebar/conversation-options.component.spec.ts @@ -85,6 +85,43 @@ examples.forEach((conversation) => { expect(component).toBeTruthy(); }); + it('should remove conversation from favorites when hidden', fakeAsync(() => { + component.conversation.isFavorite = true; + component.conversation.isHidden = false; + + const hideButton = fixture.debugElement.nativeElement.querySelector('.hide'); + hideButton.click(); + tick(501); + + expect(updateIsFavoriteSpy).toHaveBeenCalledOnce(); + expect(updateIsFavoriteSpy).toHaveBeenCalledWith(course.id, component.conversation.id, false); + + expect(updateIsHiddenSpy).toHaveBeenCalledOnce(); + expect(updateIsHiddenSpy).toHaveBeenCalledWith(course.id, component.conversation.id, true); + + expect(component.conversation.isFavorite).toBeFalse(); + expect(component.conversation.isHidden).toBeTrue(); + })); + + it('should remove conversation from hidden when favorited', fakeAsync(() => { + component.conversation.isFavorite = false; + component.conversation.isHidden = true; + fixture.detectChanges(); + + const favoriteButton = fixture.debugElement.nativeElement.querySelector('.favorite'); + favoriteButton.click(); + tick(501); + + expect(updateIsHiddenSpy).toHaveBeenCalledOnce(); + expect(updateIsHiddenSpy).toHaveBeenCalledWith(course.id, component.conversation.id, false); + + expect(updateIsFavoriteSpy).toHaveBeenCalledOnce(); + expect(updateIsFavoriteSpy).toHaveBeenCalledWith(course.id, component.conversation.id, true); + + expect(component.conversation.isHidden).toBeFalse(); + expect(component.conversation.isFavorite).toBeTrue(); + })); + it('should call updateIsFavorite when button is clicked', fakeAsync(() => { const button = fixture.debugElement.nativeElement.querySelector('.favorite'); button.click(); diff --git a/src/test/javascript/spec/component/shared/sidebar/sidebar-accordion.component.spec.ts b/src/test/javascript/spec/component/shared/sidebar/sidebar-accordion.component.spec.ts index 68eddc94218d..39d8e23eb473 100644 --- a/src/test/javascript/spec/component/shared/sidebar/sidebar-accordion.component.spec.ts +++ b/src/test/javascript/spec/component/shared/sidebar/sidebar-accordion.component.spec.ts @@ -8,16 +8,14 @@ import { SearchFilterPipe } from 'app/shared/pipes/search-filter.pipe'; import { SearchFilterComponent } from 'app/shared/search-filter/search-filter.component'; import { ArtemisTranslatePipe } from 'app/shared/pipes/artemis-translate.pipe'; import { MockComponent, MockModule, MockPipe } from 'ng-mocks'; -import { DebugElement } from '@angular/core'; -import { By } from '@angular/platform-browser'; import { NgbCollapseModule, NgbTooltipModule } from '@ng-bootstrap/ng-bootstrap'; import { RouterModule } from '@angular/router'; -import { AccordionAddOptionsComponent } from 'app/shared/sidebar/accordion-add-options/accordion-add-options.component'; +import { DebugElement } from '@angular/core'; +import { By } from '@angular/platform-browser'; describe('SidebarAccordionComponent', () => { let component: SidebarAccordionComponent; let fixture: ComponentFixture; - let debugElement: DebugElement; beforeEach(() => { TestBed.configureTestingModule({ @@ -25,7 +23,6 @@ describe('SidebarAccordionComponent', () => { declarations: [ SidebarAccordionComponent, SidebarCardMediumComponent, - MockComponent(AccordionAddOptionsComponent), SidebarCardItemComponent, SidebarCardDirective, SearchFilterPipe, @@ -39,7 +36,6 @@ describe('SidebarAccordionComponent', () => { beforeEach(() => { fixture = TestBed.createComponent(SidebarAccordionComponent); component = fixture.componentInstance; - debugElement = fixture.debugElement; component.groupedData = { current: { @@ -73,11 +69,19 @@ describe('SidebarAccordionComponent', () => { }); it('should toggle collapse state when group header is clicked', () => { - const groupHeader = debugElement.query(By.css('#test-accordion-item-header-current')); - groupHeader.triggerEventHandler('click', null); + const groupKey = 'current'; + const initialCollapseState = component.collapseState[groupKey]; + + component.searchValue = ''; fixture.detectChanges(); - expect(component.collapseState['current']).toBeTrue(); + const headerElement: DebugElement = fixture.debugElement.query(By.css('#test-accordion-item-header-' + groupKey)); + expect(headerElement).toBeTruthy(); + + headerElement.triggerEventHandler('click', null); + fixture.detectChanges(); + + expect(component.collapseState[groupKey]).toBe(!initialCollapseState); }); it('should call expandAll when searchValue changes to a non-empty string', () => { @@ -122,18 +126,17 @@ describe('SidebarAccordionComponent', () => { component.ngOnChanges(); fixture.detectChanges(); - const expectedDisplayedDiv = 2; - const expectedHiddenDiv = 0; - const elementIdDisplayedDiv = `#test-accordion-item-container-${expectedDisplayedDiv}`; - const elementIdHiddenDiv = `#test-accordion-item-container-${expectedHiddenDiv}`; + const displayedDivIndex = 2; + const elementIdDisplayedDiv = `#test-accordion-item-container-${displayedDivIndex}`; const itemDisplayedDiv: HTMLElement = fixture.nativeElement.querySelector(elementIdDisplayedDiv); - const itemHiddeniv: HTMLElement = fixture.nativeElement.querySelector(elementIdHiddenDiv); - // Check if the div exists and has the 'd-none' class - expect(itemDisplayedDiv).toBeTruthy(); // Ensure the element is found + expect(itemDisplayedDiv).toBeTruthy(); expect(itemDisplayedDiv.classList.contains('d-none')).toBeFalse(); - expect(itemHiddeniv).toBeTruthy(); // Ensure the element is found - expect(itemHiddeniv.classList.contains('d-none')).toBeTrue(); + + const elementIdHiddenDiv = `#test-accordion-item-container-0`; + const itemHiddenDiv: HTMLElement = fixture.nativeElement.querySelector(elementIdHiddenDiv); + + expect(itemHiddenDiv).toBeNull(); }); it('should expand the group containing the selected item', () => { diff --git a/src/test/javascript/spec/component/shared/sidebar/sidebar-card-item.component.spec.ts b/src/test/javascript/spec/component/shared/sidebar/sidebar-card-item.component.spec.ts index e77a8ca29e17..b82e9af01815 100644 --- a/src/test/javascript/spec/component/shared/sidebar/sidebar-card-item.component.spec.ts +++ b/src/test/javascript/spec/component/shared/sidebar/sidebar-card-item.component.spec.ts @@ -3,6 +3,7 @@ import { SidebarCardItemComponent } from 'app/shared/sidebar/sidebar-card-item/s import { SidebarCardSize } from 'app/types/sidebar'; import { ArtemisTestModule } from '../../../test.module'; import { DifficultyLevel } from 'app/entities/exercise.model'; +import { input, runInInjectionContext } from '@angular/core'; describe('SidebarCardItemComponent', () => { let component: SidebarCardItemComponent; @@ -37,4 +38,20 @@ describe('SidebarCardItemComponent', () => { const compiled = fixture.debugElement.nativeElement; expect(compiled.querySelector('#test-sidebar-card-title').textContent).toContain(testItem.title); }); + + it('should format unreadCount correctly when count is less than 99', () => { + runInInjectionContext(fixture.debugElement.injector, () => { + component.unreadCount = input(45); + component.ngOnInit(); + expect(component.formattedUnreadCount).toBe('45'); + }); + }); + + it('should format unreadCount as "99+" when count exceeds 99', () => { + runInInjectionContext(fixture.debugElement.injector, () => { + component.unreadCount = input(120); + component.ngOnInit(); + expect(component.formattedUnreadCount).toBe('99+'); + }); + }); }); diff --git a/src/test/javascript/spec/component/shared/sidebar/sidebar.component.spec.ts b/src/test/javascript/spec/component/shared/sidebar/sidebar.component.spec.ts index 55ad12ae7776..77008de55231 100644 --- a/src/test/javascript/spec/component/shared/sidebar/sidebar.component.spec.ts +++ b/src/test/javascript/spec/component/shared/sidebar/sidebar.component.spec.ts @@ -173,6 +173,44 @@ describe('SidebarComponent', () => { }); }); + describe('Chat and Channel Creation Methods', () => { + beforeEach(() => { + fixture.detectChanges(); + }); + + it('should emit onDirectChatPressed and set showChatDropdown to false when createDirectChat is called', () => { + jest.spyOn(component.onDirectChatPressed, 'emit'); + + component.createDirectChat(); + + expect(component.onDirectChatPressed.emit).toHaveBeenCalledOnce(); + }); + + it('should emit onGroupChatPressed and set showChatDropdown to false when createGroupChat is called', () => { + jest.spyOn(component.onGroupChatPressed, 'emit'); + + component.createGroupChat(); + + expect(component.onGroupChatPressed.emit).toHaveBeenCalledOnce(); + }); + + it('should emit onBrowsePressed and set showChannelDropdown to false when browseChannels is called', () => { + jest.spyOn(component.onBrowsePressed, 'emit'); + + component.browseChannels(); + + expect(component.onBrowsePressed.emit).toHaveBeenCalledOnce(); + }); + + it('should emit onCreateChannelPressed and set showChannelDropdown to false when createNewChannel is called', () => { + jest.spyOn(component.onCreateChannelPressed, 'emit'); + + component.createNewChannel(); + + expect(component.onCreateChannelPressed.emit).toHaveBeenCalledOnce(); + }); + }); + describe('openFilterExercisesDialog', () => { it('should subscribe to filterApplied from modal', () => { const filterAppliedEmitter = new EventEmitter(); diff --git a/src/test/javascript/spec/directive/sidebar-card.directive.spec.ts b/src/test/javascript/spec/directive/sidebar-card.directive.spec.ts index d23d8c1f7f5a..6c47b36f7b9a 100644 --- a/src/test/javascript/spec/directive/sidebar-card.directive.spec.ts +++ b/src/test/javascript/spec/directive/sidebar-card.directive.spec.ts @@ -72,6 +72,9 @@ describe('SidebarCardDirective', () => { it('should create SidebarCardSmallComponent when size is "S"', () => { const createComponentSpy = jest.spyOn(component.directive.viewContainerRef, 'createComponent'); component.size = 'S'; + component.directive.sidebarItem = { title: 'exercise-TestTitle', id: '1', size: 'S' }; + component.directive.groupKey = 'exerciseChannels'; + fixture.detectChanges(); component.directive.ngOnInit(); @@ -81,6 +84,8 @@ describe('SidebarCardDirective', () => { it('should create SidebarCardSmallComponent when size is "M"', () => { const createComponentSpy = jest.spyOn(component.directive.viewContainerRef, 'createComponent'); component.size = 'M'; + component.directive.sidebarItem = { title: 'exercise-TestTitle', id: '1', size: 'M' }; + component.directive.groupKey = 'exerciseChannels'; fixture.detectChanges(); component.directive.ngOnInit(); @@ -90,9 +95,67 @@ describe('SidebarCardDirective', () => { it('should create SidebarCardSmallComponent when size is "L"', () => { const createComponentSpy = jest.spyOn(component.directive.viewContainerRef, 'createComponent'); component.size = 'L'; + component.directive.sidebarItem = { title: 'exercise-TestTitle', id: '1', size: 'L' }; + component.directive.groupKey = 'exerciseChannels'; fixture.detectChanges(); component.directive.ngOnInit(); expect(createComponentSpy).toHaveBeenCalledWith(SidebarCardLargeComponent); }); + + it('should remove the correct prefix from the name when groupKey is in channelTypes', () => { + const prefixes = ['exercise-', 'lecture-', 'exam-']; + const channelTypes = ['exerciseChannels', 'lectureChannels', 'examChannels']; + + for (let i = 0; i < prefixes.length; i++) { + const prefix = prefixes[i]; + const groupKey = channelTypes[i]; + const nameWithPrefix = prefix + 'TestName'; + + component.directive.groupKey = groupKey; + const result = component.directive.removeChannelPrefix(nameWithPrefix); + + expect(result).toBe('TestName'); + } + }); + + it('should not remove the prefix if groupKey is not in channelTypes', () => { + const nameWithPrefix = 'exercise-TestName'; + component.directive.groupKey = 'otherGroup'; + const result = component.directive.removeChannelPrefix(nameWithPrefix); + + expect(result).toBe(nameWithPrefix); + }); + + it('should not remove the prefix if name does not start with any of the prefixes', () => { + const nameWithoutPrefix = 'TestName'; + component.directive.groupKey = 'exerciseChannels'; + const result = component.directive.removeChannelPrefix(nameWithoutPrefix); + + expect(result).toBe(nameWithoutPrefix); + }); + + it('should handle empty name input', () => { + const emptyName = ''; + component.directive.groupKey = 'exerciseChannels'; + const result = component.directive.removeChannelPrefix(emptyName); + + expect(result).toBe(''); + }); + + it('should handle undefined name input', () => { + const undefinedName = undefined as unknown as string; + component.directive.groupKey = 'exerciseChannels'; + const result = component.directive.removeChannelPrefix(undefinedName); + + expect(result).toBe(undefinedName); + }); + + it('should handle null name input', () => { + const nullName = null as unknown as string; + component.directive.groupKey = 'exerciseChannels'; + const result = component.directive.removeChannelPrefix(nullName); + + expect(result).toBe(nullName); + }); }); diff --git a/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise-participation.service.ts b/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise-participation.service.ts index 472de3e839b5..3bca2029aa5c 100644 --- a/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise-participation.service.ts +++ b/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise-participation.service.ts @@ -11,6 +11,7 @@ export class MockProgrammingExerciseParticipationService implements IProgramming getStudentParticipationWithAllResults = (participationId: number) => of({} as ProgrammingExerciseStudentParticipation); retrieveCommitHistoryForParticipation = (participationId: number) => of([] as CommitInfo[]); retrieveCommitHistoryForTemplateSolutionOrTests = (participationId: number, repositoryType: string) => of([] as CommitInfo[]); + retrieveCommitHistoryForAuxiliaryRepository = (exerciseId: number, repositoryId: number) => of([] as CommitInfo[]); getParticipationRepositoryFilesWithContentAtCommitForCommitDetailsView = (exerciseId: number, participationId: number, commitId: string, repositoryType: string) => of(new Map()); checkIfParticipationHasResult = (participationId: number) => of(true); diff --git a/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise.service.ts b/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise.service.ts index b164cc8e700c..27c111ba7665 100644 --- a/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise.service.ts +++ b/src/test/javascript/spec/helpers/mocks/service/mock-programming-exercise.service.ts @@ -2,12 +2,14 @@ import { of } from 'rxjs'; import { ProgrammingExerciseInstructorRepositoryType } from 'app/exercises/programming/manage/services/programming-exercise.service'; import { Participation } from 'app/entities/participation/participation.model'; import { ProgrammingLanguage } from 'app/entities/programming/programming-exercise.model'; +import { ProgrammingExerciseStudentParticipation } from 'app/entities/participation/programming-exercise-student-participation.model'; export class MockProgrammingExerciseService { updateProblemStatement = (exerciseId: number, problemStatement: string) => of(); findWithTemplateAndSolutionParticipation = (exerciseId: number) => of(); findWithTemplateAndSolutionParticipationAndResults = (exerciseId: number) => of(); findWithTemplateAndSolutionParticipationAndLatestResults = (exerciseId: number) => of(); + findWithAuxiliaryRepository = (programmingExerciseId: number) => of(); find = (exerciseId: number) => of({ body: { id: 4 } }); getProgrammingExerciseTestCaseState = (exerciseId: number) => of({ body: { released: true, hasStudentResult: true, testCasesChanged: false } }); exportInstructorExercise = (exerciseId: number) => of({ body: undefined }); diff --git a/src/test/javascript/spec/service/learning-path/learning-path-api.service.spec.ts b/src/test/javascript/spec/service/learning-path/learning-path-api.service.spec.ts index d7f34259716e..265870ceae6d 100644 --- a/src/test/javascript/spec/service/learning-path/learning-path-api.service.spec.ts +++ b/src/test/javascript/spec/service/learning-path/learning-path-api.service.spec.ts @@ -3,6 +3,7 @@ import { TestBed } from '@angular/core/testing'; import { HttpTestingController, provideHttpClientTesting } from '@angular/common/http/testing'; import { LearningObjectType } from 'app/entities/competency/learning-path.model'; import { provideHttpClient } from '@angular/common/http'; +import { SearchTermPageableSearch, SortingOrder } from 'app/shared/table/pageable-table'; describe('LearningPathApiService', () => { let httpClient: HttpTestingController; @@ -83,6 +84,13 @@ describe('LearningPathApiService', () => { await methodCall; }); + it('should get learning path instructor competency graph', async () => { + const methodCall = learningPathApiService.getLearningPathInstructorCompetencyGraph(courseId); + const response = httpClient.expectOne({ method: 'GET', url: `${baseUrl}/courses/${courseId}/learning-path/competency-instructor-graph` }); + response.flush({}); + await methodCall; + }); + it('should get learning path competencies', async () => { const methodCall = learningPathApiService.getLearningPathCompetencies(learningPathId); const response = httpClient.expectOne({ method: 'GET', url: `${baseUrl}/learning-path/${learningPathId}/competencies` }); @@ -100,4 +108,49 @@ describe('LearningPathApiService', () => { response.flush([]); await methodCall; }); + + it('should get learning paths configuration', async () => { + const methodCall = learningPathApiService.getLearningPathsConfiguration(courseId); + const response = httpClient.expectOne({ method: 'GET', url: `${baseUrl}/courses/${courseId}/learning-paths/configuration` }); + response.flush({}); + await methodCall; + }); + + it('should get learning path health status', async () => { + const methodCall = learningPathApiService.getLearningPathHealthStatus(courseId); + const response = httpClient.expectOne({ method: 'GET', url: `${baseUrl}/courses/${courseId}/learning-path-health` }); + response.flush({}); + await methodCall; + }); + + it('should put enable learning paths', async () => { + const methodCall = learningPathApiService.enableLearningPaths(courseId); + const response = httpClient.expectOne({ method: 'PUT', url: `${baseUrl}/courses/${courseId}/learning-paths/enable` }); + response.flush({}); + await methodCall; + }); + + it('should generate missing learning paths', async () => { + const methodCall = learningPathApiService.generateMissingLearningPaths(courseId); + const response = httpClient.expectOne({ method: 'PUT', url: `${baseUrl}/courses/${courseId}/learning-paths/generate-missing` }); + response.flush({}); + await methodCall; + }); + + it('should get learning path information', async () => { + const pageable = { + pageSize: 10, + page: 1, + searchTerm: 'search', + sortingOrder: SortingOrder.DESCENDING, + sortedColumn: 'column', + }; + const methodCall = learningPathApiService.getLearningPathInformation(courseId, pageable); + const response = httpClient.expectOne({ + method: 'GET', + url: `${baseUrl}/courses/${courseId}/learning-paths?pageSize=${pageable.pageSize}&page=${pageable.page}&sortingOrder=${pageable.sortingOrder}&searchTerm=${pageable.searchTerm}&sortedColumn=${pageable.sortedColumn}`, + }); + response.flush({}); + await methodCall; + }); }); diff --git a/src/test/javascript/spec/service/programming-exercise.service.spec.ts b/src/test/javascript/spec/service/programming-exercise.service.spec.ts index 9d450bbf7f8f..bcc07eeecb3a 100644 --- a/src/test/javascript/spec/service/programming-exercise.service.spec.ts +++ b/src/test/javascript/spec/service/programming-exercise.service.spec.ts @@ -20,6 +20,7 @@ import { SolutionProgrammingExerciseParticipation } from 'app/entities/participa import { Submission } from 'app/entities/submission.model'; import { ProgrammingExerciseGitDiffReport } from 'app/entities/hestia/programming-exercise-git-diff-report.model'; import { ProgrammingExerciseGitDiffEntry } from 'app/entities/hestia/programming-exercise-git-diff-entry.model'; +import { AuxiliaryRepository } from 'app/entities/programming/programming-exercise-auxiliary-repository-model'; import { provideHttpClient } from '@angular/common/http'; describe('ProgrammingExercise Service', () => { @@ -89,6 +90,27 @@ describe('ProgrammingExercise Service', () => { tick(); })); + it('should find with auxiliary repositories', fakeAsync(() => { + const auxiliaryRepository: AuxiliaryRepository = { id: 5 }; + const returnedFromService = { + ...defaultProgrammingExercise, + auxiliaryRepositories: [auxiliaryRepository], + releaseDate: undefined, + dueDate: undefined, + assessmentDueDate: undefined, + buildAndTestStudentSubmissionsAfterDueDate: undefined, + studentParticipations: [], + }; + const expected = { ...returnedFromService }; + service + .findWithAuxiliaryRepository(returnedFromService.id!) + .pipe(take(1)) + .subscribe((resp) => expect(resp.body).toEqual(expected)); + const req = httpMock.expectOne({ method: 'GET' }); + req.flush(returnedFromService); + tick(); + })); + it('should create a ProgrammingExercise', fakeAsync(() => { const returnedFromService = { ...defaultProgrammingExercise, diff --git a/src/test/playwright/e2e/exam/ExamResults.spec.ts b/src/test/playwright/e2e/exam/ExamResults.spec.ts index 141a6fd6bc02..85f3b99f9b4c 100644 --- a/src/test/playwright/e2e/exam/ExamResults.spec.ts +++ b/src/test/playwright/e2e/exam/ExamResults.spec.ts @@ -82,7 +82,7 @@ test.describe('Exam Results', () => { } exercise = await examExerciseGroupCreation.addGroupWithExercise(exam, testCase.exerciseType, additionalData); await examAPIRequests.registerStudentForExam(exam, studentOne); - const studentExams = await examAPIRequests.generateMissingIndividualExams(exam); + const studentExams = await examAPIRequests.getAllStudentExams(exam); studentExam = studentExams[0]; }); diff --git a/src/test/playwright/support/requests/ExamAPIRequests.ts b/src/test/playwright/support/requests/ExamAPIRequests.ts index 26b8d4d98a9b..ff4e6a8cdb12 100644 --- a/src/test/playwright/support/requests/ExamAPIRequests.ts +++ b/src/test/playwright/support/requests/ExamAPIRequests.ts @@ -165,6 +165,15 @@ export class ExamAPIRequests { return await response.json(); } + /** + * Get all student-exams of an exam + * @param exam the exam for which the student-exams are fetched + */ + async getAllStudentExams(exam: Exam) { + const response = await this.page.request.get(`${COURSE_BASE}/${exam.course!.id}/exams/${exam.id}/student-exams`); + return await response.json(); + } + /** * Gets the exam scores * @param exam the exam to get the scores for diff --git a/src/test/resources/config/application-artemis.yml b/src/test/resources/config/application-artemis.yml index d06190330e15..c43ee1c7f401 100644 --- a/src/test/resources/config/application-artemis.yml +++ b/src/test/resources/config/application-artemis.yml @@ -48,6 +48,8 @@ artemis: password: fake-password token: fake-token url: https://continuous-integration.fake.fake + concurrent-build-size: 1 + secret-push-token: fake-token-hash vcs-credentials: fake-key artemis-authentication-token-key: fake-key artemis-authentication-token-value: fake-token diff --git a/src/test/resources/config/application.yml b/src/test/resources/config/application.yml index ee94c5be7573..16c56a619dd9 100644 --- a/src/test/resources/config/application.yml +++ b/src/test/resources/config/application.yml @@ -72,11 +72,14 @@ artemis: default: "~~invalid~~" r: default: "~~invalid~~" + c_plus_plus: + default: "~~invalid~~" spring: application: name: Artemis datasource: + url: jdbc:mysql://artemis-mysql:3306/ type: com.zaxxer.hikari.HikariDataSource name: username: @@ -290,3 +293,10 @@ jhipster: aeolus: url: http://mock-aeolus-url:8090 + +# Eureka configuration +eureka: + client: + enabled: false + service-url: + defaultZone: http://admin:admin@localhost:8761/eureka/ diff --git a/supporting_scripts/analysis-of-endpoint-connections/analysisOfEndpointConnections.config.yml b/supporting_scripts/analysis-of-endpoint-connections/analysisOfEndpointConnections.config.yml new file mode 100644 index 000000000000..e251a96541e7 --- /dev/null +++ b/supporting_scripts/analysis-of-endpoint-connections/analysisOfEndpointConnections.config.yml @@ -0,0 +1,305 @@ +# This file is the configuration file for the GitHub action Analysis Of Endpoint Connections. It allows to exclude certain endpoints +# (either by URI or by file name) from the analysis, and to define the output file paths. + +# These are the paths to the files that contain the parsing results and the analysis results and to the client directory. +# Adjust the paths as necessary. +endpointParsingResultPath: 'endpoints.json' +restCallParsingResultPath: 'restCalls.json' +endpointAnalysisResultPath: 'endpointAnalysisResult.json' +restCallAnalysisResultPath: 'restCallAnalysisResult.json' +clientDirPath: 'src/main/webapp/app' + +# This sections holds a list of files that should be excluded from the parsing and the analysis. Adjust the list as necessary. +excludedEndpointFiles: + # These files only contain endpoints that are not used by the WebApp + - 'de/tum/in/www1/artemis/web/rest/open/PublicBuildPlanResource.java' + - 'src/main/java/de/tum/in/www1/artemis/web/rest/AppleAppSiteAssociationResource.java' + +excludedEndpoints: + # Some of these Endpoints are not used by the Artemis WebApp, others cannot automatically be assigned to one or more REST + # calls because the REST call is not yet parsed correctly. + - '/api/push_notification/register' + - '.well-known/apple-app-site-association' + - 'api/courses/{courseId}/programming-exercises' + - 'api/programming-exercises/with-sca' + - 'api/programming-exercises/{exerciseId}/auxiliary-repository' + - 'api/programming-exercises/{exerciseId}/tasks' + - 'api/file-upload-exercises/{exerciseId}' + - 'api/courses/{courseId}/file-upload-exercises' + - 'api/file-upload-exercises/{exerciseId}/export-submissions' + - 'api/courses/{courseId}/grading-scale/grade-steps/{gradeStepId}' + - 'api/courses/{courseId}/exams/{examId}/grading-scale/grade-steps/{gradeStepId}' + - 'api/push_notification/register' + - 'api/push_notification/unregister' + - 'api/management/statistics/data-for-content' + - 'api/management/statistics/course-statistics' + - 'api/management/statistics/exercise-statistics' + - 'api/participations/{participationId}/results/{resultId}' + - 'api/participations/{participationId}/results/{resultId}/details' + - 'api/participations/{participationId}/results/{resultId}' + - 'api/apollon-diagrams/{diagramId}/title' + - 'api/courses/{courseId}/answer-messages' + - 'api/courses/{courseId}/answer-messages/{answerMessageId}' + - 'api/courses/{courseId}/messages' + - 'api/courses/{courseId}/messages/{messageId}' + - 'api/courses/{courseId}/messages/similarity-check' + - 'api/modeling-exercises' + - 'api/courses/{courseId}/modeling-exercises' + - 'api/modeling-exercises/{exerciseId}/export-submissions' + - 'api/courses/{courseId}/exams/{examId}/bonus/calculate-raw' + - 'api/courses/{courseId}/learning-path/me' + - 'api/learning-path/{learningPathId}/start' + - 'api/learning-path/{learningPathId}/competency-graph' + - 'api/courses/{courseId}/learning-path/competency-instructor-graph' + - 'api/learning-path/{learningPathId}/relative-navigation' + - 'api/learning-path/{learningPathId}/navigation' + - 'api/learning-path/{learningPathId}/competencies' + - 'api/learning-path/{learningPathId}/competencies/{competencyId}/learning-objects' + - 'api/files/markdown/{filename}' + - 'api/files/templates/{language}/{projectType}' + - 'api/files/templates/{language}' + - 'api/files/drag-and-drop/backgrounds/{questionId}/*' + - 'api/files/drag-and-drop/drag-items/{dragItemId}/*' + - 'api/files/file-upload-exercises/{exerciseId}/submissions/{submissionId}/*' + - 'api/files/course/icons/{courseId}/*' + - 'api/files/exam-user/signatures/{examUserId}/*' + - 'api/files/exam-user/{examUserId}/*' + - 'api/files/attachments/lecture/{lectureId}/{filename}' + - 'api/files/attachments/attachment-unit/{attachmentUnitId}/*' + - 'api/files/attachments/attachment-unit/{attachmentUnitId}/slide/{slideNumber}' + - 'api/tutorial-groups/{tutorialGroupId}/title' + - 'api/courses/{courseId}/text-exercises' + - 'api/text-exercises/{exerciseId}/export-submissions' + - 'api/admin/audits/{id:.+}' + - 'api/admin/logs' + - 'api/admin/management/statistics/data' + - 'api/admin/imprint-for-update' + - 'api/admin/imprint' + - 'api/admin/event-insights/text-assessment/events/{courseId}' + - 'api/admin/organizations/{organizationId}/courses/{courseId}' + - 'api/admin/organizations/{organizationId}/count' + - 'api/admin/organizations/{organizationId}/title' + - 'api/iris/exercise-chat/{exerciseId}/sessions/current' + - 'api/iris/exercise-chat/{exerciseId}/sessions' + - 'api/iris/text-exercise-chat/{exerciseId}/sessions/current' + - 'api/iris/text-exercise-chat/{exerciseId}/sessions' + - 'api/iris/sessions/{sessionId}/messages/{messageId}/helpful' + - 'api/iris/course-chat/{courseId}/sessions/current' + - 'api/iris/course-chat/{courseId}/sessions' + - 'api/repository/{participationId}/files-plagiarism-view' + - 'api/repository-files-content/{commitId}' + - 'api/repository/{participationId}/files-change' + - 'api/repository/{participationId}/file-plagiarism-view' + - 'api/repository/{participationId}/files-content' + - 'api/repository/{participationId}/file-names' + - 'api/repository/{participationId}/files' + - 'api/repository/{participationId}/reset' + - 'api/test-repository/{exerciseId}/files' + - 'api/test-repository/{exerciseId}/reset' + - 'api/test-repository/{exerciseId}/file' + - 'api/test-repository/{exerciseId}/folder' + - 'api/test-repository/{exerciseId}/rename-file' + - 'api/test-repository/{exerciseId}/pull' + - 'api/test-repository/{exerciseId}/commit' + - 'api/test-repository/{exerciseId}' + - 'api/courses' + - 'api/courses/{courseId}/download-archive' + - 'api/public/pyris/pipelines/competency-extraction/runs/{runId}/status' + - 'api/public/pyris/pipelines/text-exercise-chat/runs/{runId}/status' + - 'api/exercises/{exerciseId}/feedback-details' + - 'api/files/user/profile-pictures/{userId}/*' + - 'api/account' + - 'api/account/change-password' + - 'api/account/ssh-public-key' + - 'api/account/user-vcs-access-token' + - 'api/account/participation-vcs-access-token' + - 'api/public/register' + - 'api/public/activate' + - 'api/public/account/reset-password/init' + - 'api/public/account/reset-password/finish' + - 'api/public/account' + - 'api/public/account/change-language' + - 'api/public/saml2' + - 'api/public/logout' + + # Issue: #9372 and #9371 + - 'api/courses/{courseId}/students' + - 'api/courses/{courseId}/tutors' + - 'api/courses/{courseId}/editors' + - 'api/courses/{courseId}/instructors' + - 'api/courses/{courseId}/title' + - 'api/courses/{courseId}/students/{studentLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/tutors/{tutorLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/editors/{editorLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/instructors/{instructorLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/students/{studentLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/tutors/{tutorLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/editors/{editorLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/instructors/{instructorLogin: + Constants.LOGIN_REGEX + }' + - 'api/courses/{courseId}/exams/{examId}/students/{studentLogin: + Constants.LOGIN_REGEX + }/attendance-check' + - 'api/programming-exercises/{exerciseId} + /static-code-analysis-categories/import' + + # Issue: #9371 + - 'api/athena/text-exercises/{exerciseId}/submissions/{submissionId}/feedback-suggestions' + - 'api/athena/programming-exercises/{exerciseId}/submissions/{submissionId}/feedback-suggestions' + - 'api/athena/modeling-exercises/{exerciseId}/submissions/{submissionId}/feedback-suggestions' + - 'api/athena/courses/{courseId}/text-exercises/available-modules' + - 'api/athena/courses/{courseId}/programming-exercises/available-modules' + - 'api/athena/courses/{courseId}/modeling-exercises/available-modules' + - 'api/quiz-exercises/{quizExerciseId}/{action}' + + + - 'api/public/athena/programming-exercises/{exerciseId}/submissions/{submissionId}/repository' + - 'api/public/athena/programming-exercises/{exerciseId}/repository/template' + - 'api/public/athena/programming-exercises/{exerciseId}/repository/solution' + - 'api/public/athena/programming-exercises/{exerciseId}/repository/tests' + - 'api/programming-exercises/{exerciseId}/build-plan/for-editor' + - 'api/programming-exercises/{exerciseId}/build-plan' + - 'api/build-log/{buildJobId}' + - 'api/exercises/{exerciseId}/submissions-for-import' + - 'api/courses/{courseId}/answer-posts' + - 'api/courses/{courseId}/answer-posts/{answerPostId}' + - 'api/courses/{courseId}/posts' + - 'api/courses/{courseId}/posts/{postId}' + - 'api/lectures/{lectureId}/attachment-units/{attachmentUnitId}' + + # Issue: 9393 + - 'api/course-competencies/{competencyId}/title' + - 'api/courses/{courseId}/course-competencies/import-all' + - 'api/courses/{courseId}/competencies' + - 'api/courses/{courseId}/competencies/{competencyId}' + - 'api/courses/{courseId}/competencies' + - 'api/courses/{courseId}/competencies/bulk' + - 'api/courses/{courseId}/competencies/import' + - 'api/courses/{courseId}/competencies/import-all' + - 'api/courses/{courseId}/competencies/import/bulk' + - 'api/courses/{courseId}/competencies/import-all/{sourceCourseId}' + - 'api/courses/{courseId}/competencies/import-standardized' + - 'api/courses/{courseId}/prerequisites' + - 'api/courses/{courseId}/prerequisites/{prerequisiteId}' + - 'api/courses/{courseId}/prerequisites' + - 'api/courses/{courseId}/prerequisites/bulk' + - 'api/courses/{courseId}/prerequisites/import' + - 'api/courses/{courseId}/prerequisites/import/bulk' + - 'api/courses/{courseId}/prerequisites/import-all' + - 'api/courses/{courseId}/prerequisites/import-all/{sourceCourseId}' + - 'api/courses/{courseId}/prerequisites/import-standardized' + + - 'api/courses/{courseId}/exams/{examId}/exam-users' + - 'api/programming-exercises/{exerciseId}/exercise-hints/{exerciseHintId}/title' + - 'api/programming-exercises/{exerciseId}/solution-entries/{solutionEntryId}' + - 'api/programming-exercises/{exerciseId}/code-hints/{codeHintId}/solution-entries' + - 'api/programming-exercises/{exerciseId}/test-cases/{testCaseId}/solution-entries' + - 'api/programming-exercises/{exerciseId}/code-hints' + - 'api/programming-exercises/{exerciseId}/tasks-with-unassigned-test-cases' + - 'api/programming-exercises/{exerciseId}/testwise-coverage-report' + - '.well-known/assetlinks.json' + - 'api/exercises/{exerciseId}/title' + - 'api/participations/{participationId}/with-latest-result' + - 'api/aeolus/templates/{language}/{projectType}' + - 'api/aeolus/template-scripts/{language}/{projectType}' + - 'api/lectures/{lectureId}/title' + - 'api/exams/active' + - 'api/exams' + - 'api/exams/{examId}/title' + - 'api/courses/{courseId}/exams/{examId}/exam-for-assessment-dashboard' + - 'api/courses/{courseId}/exams/{examId}/exam-for-test-run-assessment-dashboard' + - 'api/courses/{courseId}/exams/{examId}/download-archive' + - '.well-known/jwks.json' + - 'api/public/authenticate' + - 'api/public/pyris/pipelines/tutor-chat/runs/{runId}/status' + - 'api/public/pyris/pipelines/course-chat/runs/{runId}/status' + - 'api/public/pyris/webhooks/ingestion/runs/{runId}/status' + - 'api/public/programming-submissions/{participationId}' + - 'api/public/programming-exercises/test-cases-changed/{exerciseId}' + - 'api/public/programming-exercises/{exerciseId}/build-plan' + - 'api/public/time' + - 'api/public/programming-exercises/new-result' + - 'api/public/imprint' + - 'api/programming-exercises/{exerciseId}/submission-policy' + - 'api/data-exports/{dataExportId}' + + # Issue #9377 + - 'LTI13_LOGIN_REDIRECT_PROXY_PATH' + - 'LTI13_DEEPLINK_REDIRECT_PATH' + +excludedRestCallFiles: + # Files that only contain REST calls that are not yet parsed correctly + - 'src/main/webapp/app/assessment/athena.service.ts' + - 'src/main/webapp/app/shared/statistics-graph/statistics.service.ts' + - 'src/main/webapp/app/shared/server-date.service.ts' + - 'src/main/webapp/app/shared/image/cacheable-image.service.ts' + - 'src/main/webapp/app/shared/http/file.service.ts' + - 'src/main/webapp/app/lecture/lecture-paging.service.ts' + - 'src/main/webapp/app/exercises/shared/manage/exercise-paging.service.ts' + - 'src/main/webapp/app/exercises/shared/example-submission/example-submission-import/example-submission-import-paging.service.ts' + - 'src/main/webapp/app/exercises/programming/manage/services/build-plan.service.ts' + - 'src/main/webapp/app/exam/manage/exams/exam-import/exam-import-paging.service.ts' + +excludedRestCalls: + # The Endpoints matching the following REST calls are provided by SpringBootActuator and spring, + # see src/main/resources/config/application.yml management.endpoints.web.exposure.include + - 'management/configprops' + - 'management/env' + - '/management/inf' + - 'management/info' + - 'management/health' + - 'management/loggers' + - 'management/loggers/${name}' + - 'management/jhimetrics' + - 'management/threaddump' + + # The following Endpoints are all from this file: course-management.service.ts + # The Endpoint on the server looks like this: 'api/courses/{courseId}/instructors' + # or this: api/courses/{courseId}/tutors etc. + # Issue: #9372 and #9371 + - 'api/courses/${courseId}/${courseGroup}' + - 'api/courses/${courseId}/${courseGroup}/${login}' + - 'api/courses/${courseId}/course-competencies/import-all/${sourceCourseId}' + - 'api/courses/${courseId}/learning-path-id' + + # The following Endpoints are all from this file: quiz-exercise.service.ts + # The Endpoint on the server looks like this: 'api/quiz-exercises/{quizExerciseId}/{action}' + - 'api/quiz-exercises/${quizExerciseId}/open-for-practice' + - 'api/quiz-exercises/${quizExerciseId}/start-now' + - 'api/quiz-exercises/${quizExerciseId}/end-now' + - 'api/quiz-exercises/${quizExerciseId}/set-visible' + + # These 3 files are part of the file: iris-chat-http.service.ts + - 'api/iris/sessions/${sessionId}/messages/${messageId}/helpful/${helpful}' + - 'api/iris/${identifier}/sessions/current' + - 'api/iris/${identifier}/sessions' + + # This REST call is not yet parsed correctly. + # Issues #9393 and #9372 + - '${this.resourceUrl}' + + # The following Endpoints are all from this file: course-exercise.service.ts + # Issue: #9393 + - '${this.resourceUrl}/${courseId}/file-upload-exercises' + - '${this.resourceUrl}/${courseId}/text-exercises' + - '${this.resourceUrl}/${courseId}/modeling-exercises' + - '${this.resourceUrl}/${courseId}/programming-exercises' + + # Issue: #9372 + - 'api/programming-exercises/${targetExerciseId}/static-code-analysis-categories/import' + + # Edge case in exam-management.service.ts + - '${url}' + + # Edge cases with multiple possible values in athena.service.ts + # Issue: #9371 + - 'api/athena/${exercise.type}-exercises/${exercise.id}/submissions/${submissionId}/feedback-suggestions' + - 'api/athena/courses/${courseId}/${exercise.type}-exercises/available-modules' + + # POSSIBLY UNUSED REST CALLS + # Issue: #9386 + - 'api/programming-exercises/${exerciseId}/code-hints/${codeHintId}/generate-description' + - 'api/courses/${courseId}/posts/similarity-check' + - 'public/content/${filename}' + - 'api/courses/${courseId}/results' + - 'api/exercises' + - 'api/results/${resultId}' + - 'api/attachments' + - 'api/repository/${participationId}/file' + - 'api/public/lti13/auth-login' diff --git a/supporting_scripts/analysis-of-endpoint-connections/build.gradle b/supporting_scripts/analysis-of-endpoint-connections/build.gradle index 706ba847be1c..ebdd2e7acd36 100644 --- a/supporting_scripts/analysis-of-endpoint-connections/build.gradle +++ b/supporting_scripts/analysis-of-endpoint-connections/build.gradle @@ -17,6 +17,7 @@ dependencies { implementation "com.github.javaparser:javaparser-core:${project.java_parser_version}" implementation "com.github.javaparser:javaparser-core-serialization:${project.java_parser_version}" implementation "com.fasterxml.jackson.core:jackson-databind:${project.fasterxml_version}" + implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:${project.fasterxml_version}' implementation rootProject.ext.springBootStarterWeb implementation "org.slf4j:slf4j-api:${project.slf4j_version}" implementation "ch.qos.logback:logback-classic:${project.logback_version}" diff --git a/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/Config.java b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/Config.java new file mode 100644 index 000000000000..f0b93902ffae --- /dev/null +++ b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/Config.java @@ -0,0 +1,8 @@ +package de.tum.cit.endpointanalysis; + +import java.util.List; + +public record Config(List excludedEndpointFiles, List excludedEndpoints, List excludedRestCallFiles, + List excludedRestCalls, String endpointParsingResultPath, String restCallParsingResultPath, String endpointAnalysisResultPath, String restCallAnalysisResultPath, + String clientDirPath) { +} diff --git a/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointAnalyzer.java b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointAnalyzer.java index b096ba1201c6..cac9492695e3 100644 --- a/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointAnalyzer.java +++ b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointAnalyzer.java @@ -1,5 +1,7 @@ package de.tum.cit.endpointanalysis; +import static de.tum.cit.endpointanalysis.EndpointParser.readConfig; + import java.io.File; import java.io.IOException; import java.util.ArrayList; @@ -15,7 +17,7 @@ public class EndpointAnalyzer { - private static String ENDPOINT_ANALYSIS_RESULT_PATH = "endpointAnalysisResult.json"; + private static final Config CONFIG = readConfig(); private static final Logger log = LoggerFactory.getLogger(EndpointAnalyzer.class); @@ -36,12 +38,12 @@ private static void analyzeEndpoints() { ObjectMapper mapper = new ObjectMapper(); try { - List endpointClasses = mapper.readValue(new File(EndpointParser.ENDPOINT_PARSING_RESULT_PATH), - new TypeReference>() { - }); - List restCallFiles = mapper.readValue(new File(EndpointParser.REST_CALL_PARSING_RESULT_PATH), - new TypeReference>() { - }); + List endpointClasses = mapper.readValue(new File(CONFIG.endpointParsingResultPath()), new TypeReference>() { + }); + List restCallFiles = mapper.readValue(new File(CONFIG.restCallParsingResultPath()), new TypeReference>() { + }); + + excludeExcludedEndpoints(endpointClasses); List endpointsAndMatchingRestCalls = new ArrayList<>(); List unusedEndpoints = new ArrayList<>(); @@ -78,7 +80,7 @@ private static void analyzeEndpoints() { } EndpointAnalysis endpointAnalysis = new EndpointAnalysis(endpointsAndMatchingRestCalls, unusedEndpoints); - mapper.writeValue(new File(ENDPOINT_ANALYSIS_RESULT_PATH), endpointAnalysis); + mapper.writeValue(new File(CONFIG.endpointAnalysisResultPath()), endpointAnalysis); } catch (IOException e) { log.error("Failed to analyze endpoints", e); @@ -110,6 +112,25 @@ private static void checkForWildcardEndpoints(EndpointInformation endpoint, List } } + /** + * Excludes endpoints that are specified in the configuration from the provided EndpointClassInformation list. + * + * This method performs two main tasks: + * 1. Removes entire files that are excluded from the analysis based on the file paths specified in the configuration. + * 2. Removes individual endpoints that are excluded from the analysis based on the endpoint URIs specified in the configuration. + * + * @param endpoints The list of {@link de.tum.cit.endpointanalysis.EndpointClassInformation} objects to be filtered. + */ + private static void excludeExcludedEndpoints(List endpoints) { + CONFIG.excludedEndpointFiles().forEach(excludedEndpointFile -> { + endpoints.removeIf(endpointFile -> CONFIG.excludedEndpointFiles().contains(endpointFile.filePath())); + }); + + for (EndpointClassInformation endpointFile : endpoints) { + endpointFile.endpoints().removeIf(endpoint -> CONFIG.excludedEndpoints().contains(endpoint.buildCompleteEndpointURI())); + } + } + /** * Prints the endpoint analysis result. * @@ -122,7 +143,7 @@ private static void printEndpointAnalysisResult() { ObjectMapper mapper = new ObjectMapper(); EndpointAnalysis endpointsAndMatchingRestCalls = null; try { - endpointsAndMatchingRestCalls = mapper.readValue(new File(ENDPOINT_ANALYSIS_RESULT_PATH), new TypeReference() { + endpointsAndMatchingRestCalls = mapper.readValue(new File(CONFIG.endpointAnalysisResultPath()), new TypeReference() { }); } catch (IOException e) { @@ -143,5 +164,9 @@ private static void printEndpointAnalysisResult() { }); log.info("Number of endpoints without matching REST calls: {}", endpointsAndMatchingRestCalls.unusedEndpoints().size()); + + if (!endpointsAndMatchingRestCalls.unusedEndpoints().isEmpty()) { + System.exit(1); + } } } diff --git a/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointParser.java b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointParser.java index 9fb5a05b72da..dc546523f7ad 100644 --- a/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointParser.java +++ b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/EndpointParser.java @@ -20,6 +20,7 @@ import org.springframework.web.bind.annotation.RequestMapping; import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; import com.github.javaparser.ParserConfiguration; import com.github.javaparser.StaticJavaParser; import com.github.javaparser.ast.CompilationUnit; @@ -32,12 +33,10 @@ public class EndpointParser { - static final String ENDPOINT_PARSING_RESULT_PATH = "endpoints.json"; - - static final String REST_CALL_PARSING_RESULT_PATH = "restCalls.json"; - private static final Logger log = LoggerFactory.getLogger(EndpointParser.class); + private static final Config CONFIG = readConfig(); + public static void main(String[] args) { final Path absoluteDirectoryPath = Path.of("../../src/main/java").toAbsolutePath().normalize(); @@ -45,7 +44,8 @@ public static void main(String[] args) { String[] filesToParse = {}; try (Stream paths = Files.walk(absoluteDirectoryPath)) { - filesToParse = paths.filter(Files::isRegularFile).filter(path -> path.toString().endsWith(".java")).map(Path::toString).toArray(String[]::new); + filesToParse = paths.filter(path -> Files.isRegularFile(path) && path.toString().endsWith(".java") && !CONFIG.excludedEndpointFiles().contains(path)).map(Path::toString) + .toArray(String[]::new); } catch (IOException e) { log.error("Error reading files from directory: {}", absoluteDirectoryPath, e); @@ -54,6 +54,17 @@ public static void main(String[] args) { parseServerEndpoints(filesToParse); } + static Config readConfig() { + ObjectMapper mapper = new ObjectMapper(new YAMLFactory()); + try { + return mapper.readValue(new File("analysisOfEndpointConnections.config.yml"), Config.class); + } + catch (IOException e) { + log.error("Failed to read config file: {}", e.getMessage(), e); + return null; + } + } + /** * Parses server endpoints from the given file paths. * @@ -208,7 +219,7 @@ private static void printFilesFailedToParse(List filesFailedToParse) { */ private static void writeEndpointsToFile(List endpointClasses) { try { - new ObjectMapper().writeValue(new File(ENDPOINT_PARSING_RESULT_PATH), endpointClasses); + new ObjectMapper().writeValue(new File(CONFIG.endpointParsingResultPath()), endpointClasses); } catch (IOException e) { log.error("Failed to write endpoint information to file", e); diff --git a/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/RestCallAnalyzer.java b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/RestCallAnalyzer.java index 19f8cbc6c56f..0ed35913f5cc 100644 --- a/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/RestCallAnalyzer.java +++ b/supporting_scripts/analysis-of-endpoint-connections/src/main/java/de/tum/cit/endpointanalysis/RestCallAnalyzer.java @@ -1,5 +1,7 @@ package de.tum.cit.endpointanalysis; +import static de.tum.cit.endpointanalysis.EndpointParser.readConfig; + import java.io.File; import java.io.IOException; import java.util.ArrayList; @@ -15,7 +17,7 @@ public class RestCallAnalyzer { - private static final String REST_CALL_ANALYSIS_RESULT_PATH = "restCallAnalysisResult.json"; + private static final Config CONFIG = readConfig(); private static final Logger log = LoggerFactory.getLogger(RestCallAnalyzer.class); @@ -36,12 +38,13 @@ private static void analyzeRestCalls() { ObjectMapper mapper = new ObjectMapper(); try { - List endpointClasses = mapper.readValue(new File(EndpointParser.ENDPOINT_PARSING_RESULT_PATH), - new TypeReference>() { - }); - List restCalls = mapper.readValue(new File(EndpointParser.REST_CALL_PARSING_RESULT_PATH), new TypeReference>() { + List endpointClasses = mapper.readValue(new File(CONFIG.endpointParsingResultPath()), new TypeReference>() { + }); + List restCalls = mapper.readValue(new File(CONFIG.restCallParsingResultPath()), new TypeReference>() { }); + excludeExcludedRestCalls(restCalls); + List restCallsWithMatchingEndpoint = new ArrayList<>(); List restCallsWithoutMatchingEndpoint = new ArrayList<>(); @@ -77,7 +80,7 @@ private static void analyzeRestCalls() { } RestCallAnalysis restCallAnalysis = new RestCallAnalysis(restCallsWithMatchingEndpoint, restCallsWithoutMatchingEndpoint); - mapper.writeValue(new File(REST_CALL_ANALYSIS_RESULT_PATH), restCallAnalysis); + mapper.writeValue(new File(CONFIG.restCallAnalysisResultPath()), restCallAnalysis); } catch (IOException e) { log.error("Failed to analyze REST calls", e); @@ -109,6 +112,25 @@ private static void checkForWildcardMatches(RestCallInformation restCall, List restCalls) { + CONFIG.excludedRestCallFiles().forEach(excludedFile -> { + restCalls.removeIf(restCallFile -> restCallFile.filePath().equals(excludedFile)); + }); + + for (RestCallFileInformation restCallFile : restCalls) { + restCallFile.restCalls().removeIf(restCall -> CONFIG.excludedRestCalls().contains(restCall.buildCompleteRestCallURI())); + } + } + /** * Prints the endpoint analysis result. * @@ -123,7 +145,7 @@ private static void printRestCallAnalysisResult() { RestCallAnalysis restCallsAndMatchingEndpoints = null; try { - restCallsAndMatchingEndpoints = mapper.readValue(new File(REST_CALL_ANALYSIS_RESULT_PATH), new TypeReference() { + restCallsAndMatchingEndpoints = mapper.readValue(new File(CONFIG.restCallAnalysisResultPath()), new TypeReference() { }); } catch (IOException e) { @@ -144,5 +166,9 @@ private static void printRestCallAnalysisResult() { }); log.info("Number of REST calls without matching endpoints: {}", restCallsAndMatchingEndpoints.restCallsWithoutMatchingEndpoints().size()); + + if (!restCallsAndMatchingEndpoints.restCallsWithoutMatchingEndpoints().isEmpty()) { + System.exit(1); + } } } diff --git a/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/AnalysisOfEndpointConnectionsClient.ts b/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/AnalysisOfEndpointConnectionsClient.ts index ad4f19a9322e..87bbcb41325f 100644 --- a/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/AnalysisOfEndpointConnectionsClient.ts +++ b/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/AnalysisOfEndpointConnectionsClient.ts @@ -1,9 +1,22 @@ -import { readdirSync, readFileSync } from 'node:fs'; +import { readdirSync, readFileSync, writeFileSync } from 'node:fs'; import { join, resolve } from 'node:path'; import { Preprocessor } from './Preprocessor'; import { Postprocessor } from './Postprocessor'; -import { writeFileSync } from 'node:fs'; import { parse, TSESTree } from '@typescript-eslint/typescript-estree'; +import { load } from 'js-yaml'; + +interface Config { + excludedEndpointFiles: string[]; + excludedEndpoints: string[]; + excludedRestCallFiles: string[]; + excludedRestCalls: string[]; + + endpointParsingResultPath: string; + restCallParsingResultPath: string; + endpointAnalysisResultPath: string; + restCallAnalysisResultPath: string; + clientDirPath: string; +} /** * Recursively collects all TypeScript files in a directory. @@ -16,12 +29,10 @@ function collectTypeScriptFiles(dir: string, files: string[] = []) : string[] { const entries = readdirSync(dir, { withFileTypes: true }); for (const entry of entries) { const fullPath = join(dir, entry.name); - - const filePathFromSrcFolder = fullPath.substring(fullPath.indexOf('src/main/webapp/app')); if (entry.isDirectory()) { collectTypeScriptFiles(fullPath, files); } else if (entry.isFile() && entry.name.endsWith('.ts')) { - files.push(filePathFromSrcFolder); + files.push(fullPath); } } return files; @@ -50,9 +61,25 @@ function parseTypeScriptFile(filePath: string): TSESTree.Program | null { } } -const clientDirPath = resolve('src/main/webapp/app'); +function readConfigFile(filePath: string): Config | undefined { + try { + const fileContent = readFileSync(filePath, 'utf8'); + return load(fileContent) as Config; + } catch (error) { + console.error('Failed to read config file:', error); + return undefined; + } +} + +const configFilePath = 'supporting_scripts/analysis-of-endpoint-connections/analysisOfEndpointConnections.config.yml'; + +const config = readConfigFile(configFilePath); +if (!config) { + process.exit(1); +} + -const tsFiles = collectTypeScriptFiles(clientDirPath); +const tsFiles = collectTypeScriptFiles(config.clientDirPath); // create and store Syntax Tree for each file const astMap = new Map; @@ -82,7 +109,8 @@ Array.from(astMap.keys()).forEach((filePath) => { }); try { - writeFileSync('supporting_scripts/analysis-of-endpoint-connections/restCalls.json', JSON.stringify(Postprocessor.filesWithRestCalls, null, 2)); + + writeFileSync(`supporting_scripts/analysis-of-endpoint-connections/${config.restCallParsingResultPath}`, JSON.stringify(Postprocessor.filesWithRestCalls, null, 2)); } catch (error) { console.error('Failed to write REST calls to file:', error); } diff --git a/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package-lock.json b/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package-lock.json index 3d697912c662..8c30e1b1a681 100644 --- a/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package-lock.json +++ b/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package-lock.json @@ -11,6 +11,7 @@ "devDependencies": { "@eslint/js": "9.9.0", "@types/eslint__js": "8.42.3", + "@types/js-yaml": "4.0.9", "@types/node": "22.4.2", "eslint": "9.9", "typescript": "5.5.4", @@ -235,6 +236,12 @@ "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", "dev": true }, + "node_modules/@types/js-yaml": { + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-4.0.9.tgz", + "integrity": "sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==", + "dev": true + }, "node_modules/@types/json-schema": { "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", diff --git a/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package.json b/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package.json index aa79b4aa50ae..ef72dbac3680 100644 --- a/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package.json +++ b/supporting_scripts/analysis-of-endpoint-connections/src/main/typeScript/package.json @@ -12,6 +12,7 @@ "devDependencies": { "@eslint/js": "9.9.0", "@types/eslint__js": "8.42.3", + "@types/js-yaml": "4.0.9", "@types/node": "22.4.2", "eslint": "9.9", "typescript": "5.5.4", diff --git a/supporting_scripts/analyze_module_complexity.py b/supporting_scripts/analyze_module_complexity.py index aabce698f0ea..927cf5adf9e5 100644 --- a/supporting_scripts/analyze_module_complexity.py +++ b/supporting_scripts/analyze_module_complexity.py @@ -21,6 +21,68 @@ def run_cloc(directory): print(f"Error running cloc: {e}") return None +# Function to count REST Controllers, services, DTOs, and entity classes +def analyze_java_file(file_path): + rest_controller_count = 0 + service_count = 0 + entity_count = 0 + repository_count = 0 + record_dto_count = 0 + class_dto_count = 0 + http_methods = { + 'GET': 0, + 'PUT': 0, + 'POST': 0, + 'PATCH': 0, + 'DELETE': 0 + } + queries = { + '@Query': 0, + '@EntityGraph': 0 + } + + with open(file_path, 'r') as f: + for line in f: + line = line.strip() + if '@RestController' in line: + rest_controller_count += 1 + if '@Service' in line: + service_count += 1 + if '@Entity' in line: + entity_count += 1 + if '@Repository' in line: + repository_count += 1 + if 'class ' in line and 'DTO' in line: + class_dto_count += 1 + if 'record ' in line and 'DTO' in line: + record_dto_count += 1 + if '@GetMapping' in line or 'RequestMethod.GET' in line: + http_methods['GET'] += 1 + if '@PutMapping' in line or 'RequestMethod.PUT' in line: + http_methods['PUT'] += 1 + if '@PostMapping' in line or 'RequestMethod.POST' in line: + http_methods['POST'] += 1 + if '@PatchMapping' in line or 'RequestMethod.PATCH' in line: + http_methods['PATCH'] += 1 + if '@DeleteMapping' in line or 'RequestMethod.DELETE' in line: + http_methods['DELETE'] += 1 + if '@Query' in line: + queries['@Query'] += 1 + if '@EntityGraph' in line: + queries['@EntityGraph'] += 1 + + return { + 'rest_controller_count': rest_controller_count, + 'service_count': service_count, + 'repository_count': repository_count, + 'dto_count': class_dto_count + record_dto_count, + 'record_dto_count': record_dto_count, + 'class_dto_count': class_dto_count, + 'entity_count': entity_count, + 'http_methods': http_methods, + 'queries': queries + } + # Function to count the number of classes and methods in a Java file def count_classes_methods(file_path): class_count = 0 @@ -40,6 +102,24 @@ def analyze_module(module_path): total_files = 0 total_classes = 0 total_methods = 0 + total_services = 0 + total_repositories = 0 + total_dtos = 0 + total_record_dtos = 0 + total_class_dtos = 0 + total_entities = 0 + total_rest_controllers = 0 + http_methods = { + 'GET': 0, + 'PUT': 0, + 'POST': 0, + 'PATCH': 0, + 'DELETE': 0 + } + queries = { + '@Query': 0, + '@EntityGraph': 0 + } for root, dirs, files in os.walk(module_path): java_files = [f for f in files if f.endswith('.java')] @@ -51,14 +131,38 @@ def analyze_module(module_path): total_classes += classes total_methods += methods - # Run cloc for lines of code and sum them up + analysis = analyze_java_file(file_path) + total_rest_controllers += analysis['rest_controller_count'] + total_services += analysis['service_count'] + total_repositories += analysis['repository_count'] + total_entities += analysis['entity_count'] + total_dtos += analysis['dto_count'] + total_record_dtos += analysis['record_dto_count'] + total_class_dtos += analysis['class_dto_count'] + + for method in http_methods: + http_methods[method] += analysis['http_methods'][method] + + for query in queries: + queries[query] += analysis['queries'][query] + + # Run cloc for lines of code total_loc = run_cloc(module_path) return { 'total_files': total_files, 'total_classes': total_classes, 'total_methods': total_methods, - 'total_loc': total_loc + 'total_loc': total_loc, + 'total_rest_controllers': total_rest_controllers, + 'total_services': total_services, + 'total_repositories': total_repositories, + 'total_entities': total_entities, + 'total_dtos': total_dtos, + 'record_dtos': total_record_dtos, + 'class_dtos': total_class_dtos, + 'http_methods': http_methods, + 'queries': queries } # Function to dynamically detect all subfolders (modules) in the base directory @@ -70,17 +174,111 @@ def detect_modules(base_directory): modules.append(item) return sorted(modules) # Sort the modules alphabetically -# Function to analyze all detected modules +# Function to calculate cyclomatic complexity +def calculate_cyclomatic_complexity(file_path): + complexity = 1 # Start at 1 for the method itself + decision_points = ['if', 'for', 'while', 'case', '&&', '||', 'catch', 'switch'] + + with open(file_path, 'r') as f: + for line in f: + line = line.strip() + # Check for decision points to increment complexity + if any(dp in line for dp in decision_points): + complexity += 1 + return complexity + +# Function to count methods in a Java file +def count_methods(file_path): + method_count = 0 + with open(file_path, 'r') as f: + for line in f: + line = line.strip() + # Count lines that define methods + if '(' in line and ')' in line and ('{' in line or ';' in line): + method_count += 1 + return method_count + +# Updated function to analyze services and entities +def analyze_services_entities(module_path): + service_complexities = [] + entity_complexities = [] + + for root, dirs, files in os.walk(module_path): + java_files = [f for f in files if f.endswith('.java')] + + for file in java_files: + file_path = os.path.join(root, file) + + # Read file content to look for annotations + with open(file_path, 'r') as f: + file_content = f.read() + + # Check if it's a service or an entity by looking for the annotation inside the file + if '@Service' in file_content: + complexity = calculate_cyclomatic_complexity(file_path) + method_count = count_methods(file_path) + loc = run_cloc(file_path) # Optional, if you want to include lines of code + service_complexities.append({ + 'file': file, + 'complexity': complexity, + 'methods': method_count, + 'loc': loc + }) + + elif '@Entity' in file_content: + complexity = calculate_cyclomatic_complexity(file_path) + method_count = count_methods(file_path) + loc = run_cloc(file_path) # Optional, if you want to include lines of code + entity_complexities.append({ + 'file': file, + 'complexity': complexity, + 'methods': method_count, + 'loc': loc + }) + + return service_complexities, entity_complexities + +# Function to calculate the average of multiple values (complexity, methods, loc) and round them +def calculate_average_metrics(items): + if not items: + return 0, 0, 0 + total_complexity = sum(item['complexity'] for item in items) + total_methods = sum(item['methods'] for item in items) + total_loc = sum(item['loc'] for item in items) + count = len(items) + + # Round the averages to one decimal place + return round(total_complexity / count, 1), round(total_methods / count, 1), round(total_loc / count, 1) + +# Updated function to analyze individual module and include complexity +def analyze_module_with_complexity(module_path): + module_metrics = analyze_module(module_path) + + avg_service_complexity, avg_entity_complexity = analyze_services_entities(module_path) + + module_metrics['avg_service_complexity'] = avg_service_complexity + module_metrics['avg_entity_complexity'] = avg_entity_complexity + + return module_metrics + +# Function to analyze all modules def analyze_all_modules(base_directory): modules = detect_modules(base_directory) results = {} + for module in modules: module_path = os.path.join(base_directory, module) if os.path.exists(module_path): print(f"Analyzing module: {module}") results[module] = analyze_module(module_path) + service_complexities, entity_complexities = analyze_services_entities(module_path) + results[module].update({ + 'service_complexities': service_complexities, + 'entity_complexities': entity_complexities, + }) else: print(f"Module path does not exist: {module_path}") + return results # Specify the base directory of your codebase @@ -96,3 +294,28 @@ def analyze_all_modules(base_directory): print(f"Classes: {metrics['total_classes']} (includes enums, interfaces, records)") print(f"Methods: {metrics['total_methods']}") print(f"Lines of Code: {metrics['total_loc']}") + print(f"REST Controllers: {metrics['total_rest_controllers']}") + + # Calculate averages for services + avg_service_complexity, avg_service_methods, avg_service_loc = calculate_average_metrics(metrics['service_complexities']) + # Calculate averages for entities + avg_entity_complexity, avg_entity_methods, avg_entity_loc = calculate_average_metrics(metrics['entity_complexities']) + print(f"Services: {metrics['total_services']}") + # Print the average metrics for services + print(f"Average Service Complexity: cyclic: {avg_service_complexity}, methods: {avg_service_methods}, loc: {avg_service_loc}") + + print(f"Repositories: {metrics['total_repositories']}") + print(f"Database Queries: {metrics['queries']}") + + print(f"Entities: {metrics['total_entities']}") + # Print the average metrics for entities + print(f"Average Entity Complexity: cyclic: {avg_entity_complexity}, methods: {avg_entity_methods}, loc: {avg_entity_loc}") + + print(f"DTOs: {metrics['total_dtos']} (Records: {metrics['record_dtos']}, Classes: {metrics['class_dtos']})") + print(f"HTTP Methods: {metrics['http_methods']}") + # print("Services:") + # for service in metrics['service_complexities']: + # print(f" Service: {service['file']}, Complexity: {service['complexity']}, Methods: {service['methods']}, LOC: {service['loc']}") + # print("Entities:") + # for entity in metrics['entity_complexities']: + # print(f" Entity: {entity['file']}, Complexity: {entity['complexity']}, Methods: {entity['methods']}, LOC: {entity['loc']}")