Development: Improve XML parsing

build.gradle

@@ -336,6 +336,8 @@ dependencies {
     implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:${fasterxml_version}"
     // Support JSON serialization and deserialization of Hibernate (https://hibernate.org) specific data types and properties; especially lazy-loading aspects
     implementation "com.fasterxml.jackson.datatype:jackson-datatype-hibernate6:${fasterxml_version}"
+    // Support XML serialization and deserialization
+    implementation "com.fasterxml.jackson.dataformat:jackson-dataformat-xml:${fasterxml_version}"
 
     implementation "com.hazelcast:hazelcast:${hazelcast_version}"
     implementation "com.hazelcast:hazelcast-spring:${hazelcast_version}"

src/main/java/de/tum/in/www1/artemis/config/localvcci/LocalCIConfiguration.java

@@ -11,8 +11,6 @@
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
 
-import javax.xml.stream.XMLInputFactory;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
@@ -143,17 +141,6 @@ public ExecutorService localCIBuildExecutorService() {
         return new ThreadPoolExecutor(threadPoolSize, threadPoolSize, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(1), customThreadFactory, customRejectedExecutionHandler);
     }
 
-    /**
-     * Creates an XMLInputFactory that is used to parse the test results during execution of the local CI build jobs.
-     *
-     * @return The XMLInputFactory bean.
-     */
-    @Bean
-    public XMLInputFactory localCIXMLInputFactory() {
-        return XMLInputFactory.newInstance();
-    }
-
-    // TODO: the Artemis server should start even if docker is not running. Also, pulling the image should be done after the start has finished or only on demand
     /**
      * Creates a Docker client that is used to communicate with the Docker daemon.
      *

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

@@ -1,12 +1,9 @@
 package de.tum.in.www1.artemis.domain.enumeration;
 
 import java.util.ArrayList;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.Set;
-import java.util.StringJoiner;
 
 /**
  * Enumeration for supported static code analysis tools
@@ -37,23 +34,6 @@ public String getFilePattern() {
         return this.filePattern;
     }
 
-    public String getArtifactLabel() {
-        return this.name().toLowerCase();
-    }
-
-    /**
-     * Returns the artifact labels of all static code analysis tools.
-     *
-     * @return Set of static code analysis tool artifact labels
-     */
-    public static Set<String> getAllArtifactLabels() {
-        Set<String> artifactLabels = new HashSet<>();
-        for (var tool : StaticCodeAnalysisTool.values()) {
-            artifactLabels.add(tool.getArtifactLabel());
-        }
-        return artifactLabels;
-    }
-
     /**
      * Returns all static code analysis tools supporting the given programming language.
      *
@@ -85,19 +65,4 @@ public static Optional<StaticCodeAnalysisTool> getToolByFilePattern(String fileN
         return Optional.empty();
     }
 
-    /**
-     * Creates the build plan task command for static code analysis tools of a specific language.
-     *
-     * @param language Programming language for which the static code analysis command should be created
-     * @return the command used to run static code analysis for a specific language
-     */
-    public static String createBuildPlanCommandForProgrammingLanguage(ProgrammingLanguage language) {
-        StringJoiner commandBuilder = new StringJoiner(" ");
-        for (var tool : StaticCodeAnalysisTool.values()) {
-            if (tool.language == language) {
-                commandBuilder.add(tool.command);
-            }
-        }
-        return commandBuilder.toString();
-    }
 }

src/main/java/de/tum/in/www1/artemis/repository/StaticCodeAnalysisCategoryRepository.java

@@ -2,32 +2,13 @@
 
 import static de.tum.in.www1.artemis.config.Constants.PROFILE_CORE;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Optional;
 import java.util.Set;
-import java.util.stream.Collectors;
 
-import org.apache.commons.lang3.tuple.ImmutablePair;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.context.annotation.Profile;
 import org.springframework.data.jpa.repository.JpaRepository;
-import org.springframework.data.jpa.repository.Query;
-import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.ObjectMapper;
-
-import de.tum.in.www1.artemis.config.StaticCodeAnalysisConfigurer;
-import de.tum.in.www1.artemis.domain.Feedback;
-import de.tum.in.www1.artemis.domain.ProgrammingExercise;
-import de.tum.in.www1.artemis.domain.Result;
 import de.tum.in.www1.artemis.domain.StaticCodeAnalysisCategory;
-import de.tum.in.www1.artemis.domain.StaticCodeAnalysisDefaultCategory;
-import de.tum.in.www1.artemis.domain.enumeration.CategoryState;
-import de.tum.in.www1.artemis.service.dto.StaticCodeAnalysisReportDTO;
 
 /**
  * Spring Data repository for the StaticCodeAnalysisCategory entity.
@@ -36,101 +17,5 @@
 @Repository
 public interface StaticCodeAnalysisCategoryRepository extends JpaRepository<StaticCodeAnalysisCategory, Long> {
 
-    Logger log = LoggerFactory.getLogger(StaticCodeAnalysisCategoryRepository.class);
-
     Set<StaticCodeAnalysisCategory> findByExerciseId(long exerciseId);
-
-    @Query("""
-            SELECT s
-            FROM StaticCodeAnalysisCategory s
-                LEFT JOIN FETCH s.exercise
-            WHERE s.exercise.id = :exerciseId
-            """)
-    Set<StaticCodeAnalysisCategory> findWithExerciseByExerciseId(@Param("exerciseId") long exerciseId);
-
-    /**
-     * Links the categories of an exercise with the default category mappings.
-     *
-     * @param programmingExercise The programming exercise
-     * @return A list of pairs of categories and their mappings.
-     */
-    default List<ImmutablePair<StaticCodeAnalysisCategory, List<StaticCodeAnalysisDefaultCategory.CategoryMapping>>> getCategoriesWithMappingForExercise(
-            ProgrammingExercise programmingExercise) {
-        var categories = findByExerciseId(programmingExercise.getId());
-        var defaultCategories = StaticCodeAnalysisConfigurer.staticCodeAnalysisConfiguration().get(programmingExercise.getProgrammingLanguage());
-
-        List<ImmutablePair<StaticCodeAnalysisCategory, List<StaticCodeAnalysisDefaultCategory.CategoryMapping>>> categoryPairsWithMapping = new ArrayList<>();
-
-        for (var category : categories) {
-            var defaultCategoryMatch = defaultCategories.stream().filter(defaultCategory -> defaultCategory.name().equals(category.getName())).findFirst();
-            if (defaultCategoryMatch.isPresent()) {
-                var categoryMappings = defaultCategoryMatch.get().categoryMappings();
-                categoryPairsWithMapping.add(new ImmutablePair<>(category, categoryMappings));
-            }
-        }
-
-        return categoryPairsWithMapping;
-    }
-
-    /**
-     * Sets the category for each feedback and removes feedback with no category or an inactive one.
-     * The feedback is removed permanently, which has the advantage that the server or client doesn't have to filter out
-     * invisible feedback every time it is requested. The drawback is that the re-evaluate functionality can't take
-     * the removed feedback into account.
-     *
-     * @param result                     of the build run
-     * @param staticCodeAnalysisFeedback List of static code analysis feedback objects
-     * @param programmingExercise        The current exercise
-     * @return The filtered list of feedback objects
-     */
-    default List<Feedback> categorizeScaFeedback(Result result, List<Feedback> staticCodeAnalysisFeedback, ProgrammingExercise programmingExercise) {
-        var categoryPairs = getCategoriesWithMappingForExercise(programmingExercise);
-
-        return staticCodeAnalysisFeedback.stream().filter(feedback -> {
-            // ObjectMapper to extract the static code analysis issue from the feedback
-            ObjectMapper mapper = new ObjectMapper();
-            // the category for this feedback
-            Optional<StaticCodeAnalysisCategory> category = Optional.empty();
-            try {
-                // extract the sca issue
-                var issue = mapper.readValue(feedback.getDetailText(), StaticCodeAnalysisReportDTO.StaticCodeAnalysisIssue.class);
-
-                // find the category for this issue
-                for (var categoryPair : categoryPairs) {
-                    var categoryMappings = categoryPair.right;
-                    if (categoryMappings.stream().anyMatch(mapping -> mapping.tool().name().equals(feedback.getReference()) && mapping.category().equals(issue.getCategory()))) {
-                        category = Optional.of(categoryPair.left);
-                        break;
-                    }
-                }
-
-                if (category.isPresent()) {
-                    if (category.get().getState() == CategoryState.GRADED) {
-                        // update the penalty of the issue
-                        issue.setPenalty(category.get().getPenalty());
-                    }
-                    else if (issue.getPenalty() != null) {
-                        // remove the penalty of the issue
-                        issue.setPenalty(null);
-                    }
-                    // the feedback is already pre-truncated to fit, it should not be shortened further
-                    feedback.setDetailTextTruncated(mapper.writeValueAsString(issue));
-                }
-            }
-            catch (JsonProcessingException exception) {
-                log.debug("Error occurred parsing feedback {} to static code analysis issue: {}", feedback, exception.getMessage());
-            }
-
-            if (category.isEmpty() || category.get().getState().equals(CategoryState.INACTIVE)) {
-                // remove feedback in no category or an inactive one
-                result.removeFeedback(feedback);
-                return false; // filter this feedback
-            }
-            else {
-                // add the category name to the feedback text
-                feedback.setText(Feedback.STATIC_CODE_ANALYSIS_FEEDBACK_IDENTIFIER + category.get().getName());
-                return true; // keep this feedback
-            }
-        }).collect(Collectors.toCollection(ArrayList::new));
-    }
 }

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

@@ -1003,6 +1003,7 @@ public void switchBackToDefaultBranchHead(Repository repository) throws GitAPIEx
      * @return the latestHash of the given repo.
      * @throws EntityNotFoundException if retrieving the latestHash from the git repo failed.
      */
+    @Nullable
     public ObjectId getLastCommitHash(VcsRepositoryUri repoUri) throws EntityNotFoundException {
         if (repoUri == null || repoUri.getURI() == null) {
             return null;

src/main/java/de/tum/in/www1/artemis/service/util/XmlFileUtils.java → src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsXmlFileUtils.java

@@ -1,4 +1,4 @@
-package de.tum.in.www1.artemis.service.util;
+package de.tum.in.www1.artemis.service.connectors.jenkins;
 
 import java.io.IOException;
 import java.io.StringReader;
@@ -26,9 +26,9 @@
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
-public class XmlFileUtils {
+public class JenkinsXmlFileUtils {
 
-    private static final Logger log = LoggerFactory.getLogger(XmlFileUtils.class);
+    private static final Logger log = LoggerFactory.getLogger(JenkinsXmlFileUtils.class);
 
     public static Document readFromString(String xmlString) {
         return parseDocument(xmlString);

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

@@ -24,7 +24,7 @@
 import de.tum.in.www1.artemis.service.ResourceLoaderService;
 import de.tum.in.www1.artemis.service.connectors.ci.ContinuousIntegrationService;
 import de.tum.in.www1.artemis.service.connectors.jenkins.JenkinsXmlConfigBuilder;
-import de.tum.in.www1.artemis.service.util.XmlFileUtils;
+import de.tum.in.www1.artemis.service.connectors.jenkins.JenkinsXmlFileUtils;
 
 @Profile("jenkins")
 @Component
@@ -99,7 +99,7 @@ public Document buildBasicConfig(final ProgrammingLanguage programmingLanguage,
         final Path configFilePath = Path.of("templates", "jenkins", "config.xml");
         final var configFileReplacements = Map.of(REPLACE_PIPELINE_SCRIPT, jenkinsfile, REPLACE_PUSH_TOKEN, pushToken);
         final var xmlResource = resourceLoaderService.getResource(configFilePath);
-        return XmlFileUtils.readXmlFile(xmlResource, configFileReplacements);
+        return JenkinsXmlFileUtils.readXmlFile(xmlResource, configFileReplacements);
     }
 
     private String getJenkinsfile(final InternalVcsRepositoryURLs internalVcsRepositoryURLs, final ProgrammingLanguage programmingLanguage, final boolean checkoutSolution,

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

@@ -57,9 +57,9 @@
 import de.tum.in.www1.artemis.service.connectors.jenkins.JenkinsEndpoints;
 import de.tum.in.www1.artemis.service.connectors.jenkins.JenkinsInternalUrlService;
 import de.tum.in.www1.artemis.service.connectors.jenkins.JenkinsXmlConfigBuilder;
+import de.tum.in.www1.artemis.service.connectors.jenkins.JenkinsXmlFileUtils;
 import de.tum.in.www1.artemis.service.connectors.jenkins.jobs.JenkinsJobPermissionsService;
 import de.tum.in.www1.artemis.service.connectors.jenkins.jobs.JenkinsJobService;
-import de.tum.in.www1.artemis.service.util.XmlFileUtils;
 
 @Service
 @Profile("jenkins")
@@ -263,7 +263,7 @@ private void postBuildPlanConfigChange(String buildPlanKey, String buildProjectK
             final var headers = new HttpHeaders();
             headers.setContentType(MediaType.APPLICATION_XML);
 
-            String jobXmlString = XmlFileUtils.writeToString(jobConfig);
+            String jobXmlString = JenkinsXmlFileUtils.writeToString(jobConfig);
             final var entity = new HttpEntity<>(jobXmlString, headers);
 
             restTemplate.exchange(uri, HttpMethod.POST, entity, String.class);

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

@@ -17,7 +17,7 @@
 import com.offbytwo.jenkins.model.JobWithDetails;
 
 import de.tum.in.www1.artemis.exception.JenkinsException;
-import de.tum.in.www1.artemis.service.util.XmlFileUtils;
+import de.tum.in.www1.artemis.service.connectors.jenkins.JenkinsXmlFileUtils;
 
 @Service
 @Profile("jenkins")
@@ -101,7 +101,7 @@ public Document getJobConfigForJobInFolder(String folderName, String jobName) {
             xmlString = xmlString.replace("*/master", "**");
             xmlString = xmlString.replace("*/main", "**");
 
-            return XmlFileUtils.readFromString(xmlString);
+            return JenkinsXmlFileUtils.readFromString(xmlString);
         }
         catch (IOException e) {
             log.error(e.getMessage(), e);
@@ -122,7 +122,7 @@ public Document getFolderConfig(String folderName) throws IOException {
         }
 
         String folderXml = jenkinsServer.getJobXml(folderName);
-        return XmlFileUtils.readFromString(folderXml);
+        return JenkinsXmlFileUtils.readFromString(folderXml);
     }
 
     /**
@@ -145,7 +145,7 @@ public void createJobInFolder(Document jobConfig, String folderName, String jobN
                 return;
             }
 
-            String configString = XmlFileUtils.writeToString(jobConfig);
+            String configString = JenkinsXmlFileUtils.writeToString(jobConfig);
             jenkinsServer.createJob(folder, jobName, configString, useCrumb);
         }
         catch (IOException | TransformerException e) {
@@ -171,7 +171,7 @@ public Document getJobConfig(String folderName, String jobName) throws IOExcepti
         var folder = jenkinsServer.getFolderJob(job);
 
         String jobXml = jenkinsServer.getJobXml(folder.orElse(null), jobName);
-        return XmlFileUtils.readFromString(jobXml);
+        return JenkinsXmlFileUtils.readFromString(jobXml);
     }
 
     /**
@@ -184,7 +184,7 @@ public Document getJobConfig(String folderName, String jobName) throws IOExcepti
      */
     public void updateJob(String folderName, String jobName, Document jobConfig) throws IOException {
         try {
-            String configString = XmlFileUtils.writeToString(jobConfig);
+            String configString = JenkinsXmlFileUtils.writeToString(jobConfig);
 
             if (folderName != null && !folderName.isEmpty()) {
                 var job = jenkinsServer.getJob(folderName);
@@ -209,7 +209,7 @@ public void updateJob(String folderName, String jobName, Document jobConfig) thr
      */
     public void updateFolderJob(String folderName, Document folderConfig) throws IOException {
         try {
-            String configString = XmlFileUtils.writeToString(folderConfig);
+            String configString = JenkinsXmlFileUtils.writeToString(folderConfig);
             jenkinsServer.updateJob(folderName, configString, useCrumb);
         }
         catch (TransformerException e) {