Programming exercises: Add JavaScript programming language template

docs/user/exercises/programming-exercise-features.inc

@@ -35,6 +35,8 @@ Instructors can still use those templates to generate programming exercises and
   +----------------------+----------+---------+
   | Rust                 | yes      | yes     |
   +----------------------+----------+---------+
+  | JavaScript           | 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.
@@ -67,6 +69,8 @@ Instructors can still use those templates to generate programming exercises and
   +----------------------+----------------------+----------------------+---------------------+--------------+------------------------------------------+------------------------------+----------------------------+------------------------+
   | Rust                 | no                   | no                   | no                  | no           | n/a                                      | no                           | no                         | L: yes, J: no          |
   +----------------------+----------------------+----------------------+---------------------+--------------+------------------------------------------+------------------------------+----------------------------+------------------------+
+  | JavaScript           | no                   | no                   | no                  | 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.

src/main/java/de/tum/in/www1/artemis/domain/enumeration/ProgrammingLanguage.java

@@ -48,7 +48,8 @@ public enum ProgrammingLanguage {
         ASSEMBLER,
         SWIFT,
         OCAML,
-        RUST
+        RUST,
+        JAVASCRIPT
     );
     // @formatter:on
 

src/main/java/de/tum/in/www1/artemis/service/connectors/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 -> "assignment";
-                    case JAVASCRIPT, C_SHARP, C_PLUS_PLUS, SQL, R, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP ->
+                    case JAVA, PYTHON, C, HASKELL, KOTLIN, VHDL, ASSEMBLER, SWIFT, OCAML, EMPTY, RUST, JAVASCRIPT -> "assignment";
+                    case C_SHARP, C_PLUS_PLUS, SQL, R, 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 -> "";
+                    case JAVA, PYTHON, HASKELL, KOTLIN, SWIFT, EMPTY, RUST, JAVASCRIPT -> "";
                     case C, VHDL, ASSEMBLER, OCAML -> "tests";
-                    case JAVASCRIPT, C_SHARP, C_PLUS_PLUS, SQL, R, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP ->
+                    case C_SHARP, C_PLUS_PLUS, SQL, R, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP ->
                         throw new UnsupportedOperationException("Unsupported programming language: " + language);
                 };
             }

src/main/java/de/tum/in/www1/artemis/service/connectors/gitlabci/GitLabCIProgrammingLanguageFeatureService.java

@@ -2,6 +2,7 @@
 
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.EMPTY;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.JAVA;
+import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.JAVASCRIPT;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.RUST;
 import static de.tum.in.www1.artemis.domain.enumeration.ProjectType.MAVEN_MAVEN;
 import static de.tum.in.www1.artemis.domain.enumeration.ProjectType.PLAIN_MAVEN;
@@ -22,5 +23,6 @@ public GitLabCIProgrammingLanguageFeatureService() {
         programmingLanguageFeatures.put(EMPTY, new ProgrammingLanguageFeature(EMPTY, false, false, false, false, false, List.of(), false, false));
         programmingLanguageFeatures.put(JAVA, new ProgrammingLanguageFeature(JAVA, false, false, false, true, false, List.of(PLAIN_MAVEN, MAVEN_MAVEN), false, false));
         programmingLanguageFeatures.put(RUST, new ProgrammingLanguageFeature(RUST, false, false, false, false, false, List.of(), false, false));
+        programmingLanguageFeatures.put(JAVASCRIPT, new ProgrammingLanguageFeature(JAVASCRIPT, false, false, false, false, false, List.of(), false, false));
     }
 }

src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsProgrammingLanguageFeatureService.java

@@ -4,6 +4,7 @@
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.EMPTY;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.HASKELL;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.JAVA;
+import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.JAVASCRIPT;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.KOTLIN;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.PYTHON;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.RUST;
@@ -41,5 +42,6 @@ public JenkinsProgrammingLanguageFeatureService() {
         programmingLanguageFeatures.put(C, new ProgrammingLanguageFeature(C, false, false, true, false, false, List.of(FACT, GCC), false, false));
         programmingLanguageFeatures.put(HASKELL, new ProgrammingLanguageFeature(HASKELL, false, false, false, false, true, List.of(), false, false));
         programmingLanguageFeatures.put(RUST, new ProgrammingLanguageFeature(RUST, false, false, false, false, false, List.of(), false, false));
+        programmingLanguageFeatures.put(JAVASCRIPT, new ProgrammingLanguageFeature(JAVASCRIPT, false, false, false, false, false, List.of(), false, false));
     }
 }

src/main/java/de/tum/in/www1/artemis/service/connectors/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 -> jenkinsBuildPlanCreator;
-            case VHDL, ASSEMBLER, OCAML, JAVASCRIPT, C_SHARP, C_PLUS_PLUS, SQL, R, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP ->
+            case JAVA, KOTLIN, PYTHON, C, HASKELL, SWIFT, EMPTY, RUST, JAVASCRIPT -> jenkinsBuildPlanCreator;
+            case VHDL, ASSEMBLER, OCAML, C_SHARP, C_PLUS_PLUS, SQL, R, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP ->
                 throw new UnsupportedOperationException(programmingLanguage + " templates are not available for Jenkins.");
         };
     }

src/main/java/de/tum/in/www1/artemis/service/connectors/localci/LocalCIProgrammingLanguageFeatureService.java

@@ -5,6 +5,7 @@
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.C;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.HASKELL;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.JAVA;
+import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.JAVASCRIPT;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.KOTLIN;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.OCAML;
 import static de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage.PYTHON;
@@ -48,5 +49,6 @@ public LocalCIProgrammingLanguageFeatureService() {
         programmingLanguageFeatures.put(OCAML, new ProgrammingLanguageFeature(OCAML, false, false, false, false, true, List.of(), false, true));
         programmingLanguageFeatures.put(SWIFT, new ProgrammingLanguageFeature(SWIFT, false, false, true, true, false, List.of(PLAIN), false, true));
         programmingLanguageFeatures.put(RUST, new ProgrammingLanguageFeature(RUST, false, false, false, false, false, List.of(), false, true));
+        programmingLanguageFeatures.put(JAVASCRIPT, new ProgrammingLanguageFeature(JAVASCRIPT, false, false, false, false, false, List.of(), false, true));
     }
 }

src/main/java/de/tum/in/www1/artemis/service/programming/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 -> defaultRepositoryUpgradeService;
-            case JAVASCRIPT, C_SHARP, C_PLUS_PLUS, SQL, R, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP ->
+            case KOTLIN, PYTHON, C, HASKELL, VHDL, ASSEMBLER, SWIFT, OCAML, EMPTY, RUST, JAVASCRIPT -> defaultRepositoryUpgradeService;
+            case C_SHARP, C_PLUS_PLUS, SQL, R, TYPESCRIPT, GO, MATLAB, BASH, RUBY, POWERSHELL, ADA, DART, PHP ->
                 throw new UnsupportedOperationException("Unsupported programming language: " + programmingLanguage);
         };
     }

src/main/resources/config/application.yml

@@ -89,6 +89,8 @@ artemis:
                     default: "ls1tum/artemis-ocaml-docker:v1"
                 rust:
                     default: "ghcr.io/ls1intum/artemis-rust-docker:v0.9.70"
+                javascript:
+                    default: "ghcr.io/ls1intum/artemis-javascript-docker:v1.0.0"
 
 management:
     endpoints:

src/main/resources/templates/aeolus/javascript/default.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+set -e
+export AEOLUS_INITIAL_DIRECTORY=${PWD}
+install_dependencies () {
+  echo '⚙️ executing install_dependencies'
+  npm ci --prefer-offline --no-audit
+}
+
+test () {
+  echo '⚙️ executing test'
+  npm run test:ci
+}
+
+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; install_dependencies"
+  cd "${AEOLUS_INITIAL_DIRECTORY}"
+  bash -c "source ${_script_name} aeolus_sourcing; test"
+}
+
+main "${@}"

src/main/resources/templates/aeolus/javascript/default.yaml

@@ -0,0 +1,14 @@
+api: v0.0.1
+metadata:
+  name: JavaScript
+  description: Run tests using Jest
+actions:
+  - name: install_dependencies
+    script: 'npm ci --prefer-offline --no-audit'
+  - name: test
+    script: 'npm run test:ci'
+    runAlways: false
+    results:
+      - name: junit
+        path: 'junit.xml'
+        type: junit

src/main/resources/templates/gitlabci/javascript/regularRuns/.gitlab-ci.yml

@@ -0,0 +1,49 @@
+stages:
+    - test
+    - upload
+
+
+test-job:
+    image: ${ARTEMIS_BUILD_DOCKER_IMAGE}
+    stage: test
+    only:
+        variables:
+            - $CI_COMMIT_BRANCH == $ARTEMIS_SUBMISSION_GIT_BRANCH
+    allow_failure: true
+    variables:
+        GIT_STRATEGY: none
+    script:
+        - git clone --branch ${ARTEMIS_TEST_GIT_BRANCH} ${CI_SERVER_PROTOCOL}://${ARTEMIS_TEST_GIT_USER}:${ARTEMIS_TEST_GIT_TOKEN}@${CI_SERVER_HOST}:${CI_SERVER_PORT}/${CI_PROJECT_NAMESPACE}/${ARTEMIS_TEST_GIT_REPOSITORY_SLUG} .
+        - git clone --branch ${ARTEMIS_SUBMISSION_GIT_BRANCH} ${CI_SERVER_PROTOCOL}://${ARTEMIS_TEST_GIT_USER}:${ARTEMIS_TEST_GIT_TOKEN}@${CI_SERVER_HOST}:${CI_SERVER_PORT}/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME} assignment
+        - export ARTEMIS_NOTIFICATION_SECRET=[hidden] # Workaround for overwriting the secret
+        - export ARTEMIS_TEST_GIT_TOKEN=[hidden]
+        - npm ci --prefer-offline --no-audit | tee -a "${ARTEMIS_BUILD_LOGS_FILE}"
+        - npm run test:ci | tee -a "${ARTEMIS_BUILD_LOGS_FILE}" && echo "ARTEMIS_BUILD_STATUS=success" > .env || echo "ARTEMIS_BUILD_STATUS=failed" > .env
+        - test -e junit.xml && sed -i 's/<testsuites[^>]*>/<testsuite>/g ; s/<\/testsuites>/<\/testsuite>/g' junit.xml  # <testsuites> not supported by notification plugin
+        - test -e junit.xml && mkdir test-reports && cp junit.xml test-reports/junit.xml
+    after_script:
+        - echo "ARTEMIS_TEST_GIT_HASH=$(git rev-parse HEAD)" >> .env
+        - echo "ARTEMIS_SUBMISSION_GIT_HASH=${CI_COMMIT_SHA}" >> .env
+        - echo "ARTEMIS_SUBMISSION_GIT_REPOSITORY_SLUG=${CI_PROJECT_NAME}" >> .env
+    artifacts:
+        paths:
+          - ${ARTEMIS_BUILD_LOGS_FILE}
+          - test-reports/junit.xml
+        reports:
+            dotenv: .env
+
+
+upload-job:
+    image: ${ARTEMIS_NOTIFICATION_PLUGIN_DOCKER_IMAGE}
+    stage: upload
+    dependencies:
+        - test-job
+    only:
+        variables:
+            - $CI_COMMIT_BRANCH == $ARTEMIS_SUBMISSION_GIT_BRANCH
+    variables:
+        GIT_STRATEGY: none
+    script:
+        - cp -r /notification-plugin/* .
+        - export ARTEMIS_TEST_RESULTS_DIR="test-reports"  # override project variable
+        - gradle run

src/main/resources/templates/javascript/exercise/.gitignore

@@ -0,0 +1 @@
+node_modules/

src/main/resources/templates/javascript/exercise/package.json

@@ -0,0 +1,11 @@
+{
+    "name": "artemis-exercise",
+    "private": true,
+    "scripts": {
+        "start": "node ./src/client.js"
+    },
+    "exports": {
+        "./*.js": "./src/*.js"
+    },
+    "type": "module"
+}

src/main/resources/templates/javascript/exercise/src/bubblesort.js

@@ -0,0 +1,3 @@
+export default class BubbleSort {
+    // TODO: implement in performSort(Date[])
+}

src/main/resources/templates/javascript/exercise/src/client.js

@@ -0,0 +1,66 @@
+const ITERATIONS = 10;
+const DATES_LENGTH_MIN = 5;
+const DATES_LENGTH_MAX = 15;
+
+/**
+ * Main function.
+ * Add code to demonstrate your implementation here.
+ */
+function main() {
+    // TODO: Init Context and Policy
+
+    // Run multiple times to simulate different sorting strategies
+    for (let i = 0; i < ITERATIONS; i++) {
+        const dates = createRandomDates();
+
+        // TODO: Configure context
+
+        console.log('Unsorted Array of dates:');
+        console.log(dates);
+
+        // TODO: Sort dates
+
+        console.log('Sorted Array of dates:');
+        console.log(dates);
+    }
+}
+
+/**
+ * Generates an Array of random Date objects with random Array length between
+ * {@link DATES_LENGTH_MIN} and {@link DATES_LENGTH_MAX}.
+ *
+ * @return an Array of random Date objects
+ */
+function createRandomDates() {
+    const length = randomIntegerWithin(DATES_LENGTH_MIN, DATES_LENGTH_MAX);
+
+    const lowestDate = new Date('2024-09-15');
+    const highestDate = new Date('2025-01-15');
+
+    return Array.from(Array(length), () => randomDateWithin(lowestDate, highestDate));
+}
+
+/**
+ * Creates a random Date within the given range.
+ *
+ * @param low {Date} the lower bound
+ * @param high {Date} the upper bound
+ * @return {Date} random Date within the given range
+ */
+function randomDateWithin(low, high) {
+    const randomTimestamp = randomIntegerWithin(low.valueOf(), high.valueOf());
+    return new Date(randomTimestamp);
+}
+
+/**
+ * Creates a random int within the given range.
+ *
+ * @param low {number} the lower bound
+ * @param high {number} the upper bound
+ * @returns {number} random int within the given range
+ */
+function randomIntegerWithin(low, high) {
+    return Math.floor(Math.random() * (high - low + 1)) + low;
+}
+
+main();

src/main/resources/templates/javascript/exercise/src/context.js

@@ -0,0 +1,3 @@
+export default class Context {
+    // TODO: Create and implement a Context class according to the UML class diagram
+}

src/main/resources/templates/javascript/exercise/src/mergesort.js

@@ -0,0 +1,3 @@
+export default class MergeSort {
+    // TODO: implement in performSort(Date[])
+}

src/main/resources/templates/javascript/exercise/src/policy.js

@@ -0,0 +1,3 @@
+export default class Policy {
+    // TODO: Create and implement a Policy class as described in the problem statement
+}

src/main/resources/templates/javascript/readme

@@ -0,0 +1,82 @@
+# Sorting with the Strategy Pattern
+
+In this exercise, we want to implement sorting algorithms and choose them based on runtime specific variables.
+
+### Part 1: Sorting
+
+First, we need to implement two sorting algorithms, in this case `MergeSort` and `BubbleSort`.
+
+**You have the following tasks:**
+
+1. [task][Implement Bubble Sort](structural_BubbleSort_has_method,behavior_BubbleSort_should_sort_correctly)
+Implement the method `performSort(Date[])` in the class `BubbleSort`. Make sure to follow the Bubble Sort algorithm exactly.
+
+2. [task][Implement Merge Sort](structural_MergeSort_has_method,behavior_MergeSort_should_sort_correctly)
+Implement the method `performSort(Date[])` in the class `MergeSort`. Make sure to follow the Merge Sort algorithm exactly.
+
+### Part 2: Strategy Pattern
+
+We want the application to apply different algorithms for sorting an Array of `Date` objects.
+Use the strategy pattern to select the right sorting algorithm at runtime.
+
+**You have the following tasks:**
+
+1. [task][Context Class](structural_Context_has_properties,structural_Context_has_methods)
+Create and implement a `Context` class following the below class diagram.
+Add `get` and `set` accessors for the attribute.
+
+2. [task][Context Policy](structural_Policy_has_properties,structural_Policy_has_methods)
+Create and implement a `Policy` class following the below class diagram.
+Add `get` and `set` accessors for the attribute.
+`Policy` should implement a simple configuration mechanism:
+
+    1. [task][Select MergeSort](behavior_Policy_uses_MergeSort_for_big_list)
+    Select `MergeSort` when the List has more than 10 dates.
+
+    2. [task][Select BubbleSort](behavior_Policy_uses_BubbleSort_for_small_list)
+    Select `BubbleSort` when the List has less or equal 10 dates.
+
+3. Complete the `main()` function which demonstrates switching between two strategies at runtime.
+
+@startuml
+
+class Policy {
+  +Policy(Context) <<constructor>>
+  <color:testsColor(structural_Policy_has_methods)>+configure()</color>
+}
+
+class Context {
+  <color:testsColor(structural_Context_has_properties)>-dates: Date[]</color>
+  <color:testsColor(structural_Context_has_methods)>+sort()</color>
+}
+
+interface SortStrategy {
+  +performSort(Date[])
+}
+
+class BubbleSort {
+  <color:testsColor(behavior_BubbleSort_should_sort_correctly)>+performSort(Date[])</color>
+}
+
+class MergeSort {
+  <color:testsColor(behavior_MergeSort_should_sort_correctly)>+performSort(Date[])</color>
+}
+
+MergeSort -up-|> SortStrategy #testsColor(structural_MergeSort_has_method)
+BubbleSort -up-|> SortStrategy #testsColor(structural_BubbleSort_has_method)
+Policy -right-> Context #testsColor(structural_Policy_has_properties): context
+Context -right-> SortStrategy #testsColor(structural_Context_has_properties): sortAlgorithm
+
+hide empty fields
+hide empty methods
+
+@enduml
+
+
+### Part 3: Optional Challenges
+
+(These are not tested)
+
+1. Create a new class `QuickSort` that implements `SortStrategy` and implement the Quick Sort algorithm.
+
+2. Think about a useful decision in `Policy` when to use the new `QuickSort` algorithm.