diff --git a/build.gradle b/build.gradle index e1f70b00ac68..ec1e1fdc73ab 100644 --- a/build.gradle +++ b/build.gradle @@ -170,7 +170,28 @@ dependencies { implementation "com.offbytwo.jenkins:jenkins-client:0.3.8" implementation "org.gitlab4j:gitlab4j-api:5.0.1" - implementation "de.jplag:jplag:3.0.0" + implementation "de.jplag:jplag:${jplag_version}" + implementation "de.jplag:java:${jplag_version}" + implementation "de.jplag:kotlin:${jplag_version}" + implementation "de.jplag:cpp:${jplag_version}" + implementation "de.jplag:swift:${jplag_version}" + implementation "de.jplag:java:${jplag_version}" + implementation "de.jplag:python-3:${jplag_version}" + implementation "de.jplag:text:${jplag_version}" + + + implementation "org.slf4j:jcl-over-slf4j:${slf4j_version}" + implementation "org.slf4j:jul-to-slf4j:${slf4j_version}" + implementation ("org.slf4j:slf4j-api") { + version { + strictly "${slf4j_version}" + } + } + implementation "org.apache.logging.log4j:log4j-to-slf4j:2.17.2" +// implementation "org.apache.logging.log4j:log4j-to-slf4j:2.19.0" +// implementation "ch.qos.logback:logback-classic:1.4.1" + + // https://search.maven.org/artifact/org.eclipse.jgit/org.eclipse.jgit diff --git a/docs/user/exercises/programming-exercise-setup.inc b/docs/user/exercises/programming-exercise-setup.inc index 8d878e9aee42..9014f81761ce 100644 --- a/docs/user/exercises/programming-exercise-setup.inc +++ b/docs/user/exercises/programming-exercise-setup.inc @@ -47,17 +47,17 @@ Instructors can still use those templates to generate programming exercises and +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ | C | no | yes | yes | no | no | no | no | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ - | C (FACT framework) | no | no | no | no | no | no | no | + | C (FACT framework) | no | no | yes | no | no | no | no | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ | Haskell | yes | no | no | no | no | yes | no | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ - | Kotlin | yes | no | no | yes | no | no | yes | + | Kotlin | yes | no | yes | yes | no | no | yes | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ | VHDL | no | no | no | no | no | no | no | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ | Assembler | no | no | no | no | no | no | no | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ - | Swift | no | no | no | no | no | no | no | + | Swift | no | no | yes | no | no | no | no | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ | OCaml | no | no | no | no | no | yes | no | +----------------------+----------------------+----------------------+------------------+--------------+--------------+------------------------------+--------------------------------------------+ diff --git a/gradle.properties b/gradle.properties index 97c76323599e..94b9a219c377 100644 --- a/gradle.properties +++ b/gradle.properties @@ -17,6 +17,8 @@ mockito_version=4.8.0 fasterxml_version=2.13.4 jgit_version=6.3.0.202209071007-r checkstyle_version=10.3.3 +jplag_version=4.0.0 +slf4j_version=1.7.36 # gradle plugin version jib_plugin_version=2.0.0 diff --git a/src/main/java/de/tum/in/www1/artemis/domain/BonusStrategy.java b/src/main/java/de/tum/in/www1/artemis/domain/BonusStrategy.java index 471812a87841..85e4d902b2d1 100644 --- a/src/main/java/de/tum/in/www1/artemis/domain/BonusStrategy.java +++ b/src/main/java/de/tum/in/www1/artemis/domain/BonusStrategy.java @@ -3,7 +3,7 @@ import static de.tum.in.www1.artemis.service.util.RoundingUtil.roundScoreSpecifiedByCourseSettings; -import org.apache.commons.lang.NotImplementedException; +import org.apache.commons.lang3.NotImplementedException; import de.tum.in.www1.artemis.repository.GradingScaleRepository; import de.tum.in.www1.artemis.web.rest.dto.BonusExampleDTO; diff --git a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismComparison.java b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismComparison.java index c14342c84de2..739dcb4aba15 100644 --- a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismComparison.java +++ b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismComparison.java @@ -1,5 +1,6 @@ package de.tum.in.www1.artemis.domain.plagiarism; +import java.io.File; import java.util.Objects; import java.util.Set; import java.util.stream.Collectors; @@ -14,6 +15,7 @@ import de.jplag.JPlagComparison; import de.tum.in.www1.artemis.domain.DomainObject; +import de.tum.in.www1.artemis.domain.Exercise; import de.tum.in.www1.artemis.domain.plagiarism.text.TextSubmissionElement; /** @@ -63,7 +65,7 @@ public class PlagiarismComparison extends protected Set matches; /** - * Similarity of the compared submissions (between 0 and 1). + * Similarity of the compared submissions in percentage (between 0 and 100). */ @Column(name = "similarity") private double similarity; @@ -79,14 +81,17 @@ public class PlagiarismComparison extends * * @param jplagComparison JPlag comparison to map to the new PlagiarismComparison instance * @return a new instance with the content of the JPlagComparison + * @param exercise the exercise to which the comparison belongs, either Text or Programming + * @param submissionDirectory the directory to which all student submissions have been downloaded / stored */ - public static PlagiarismComparison fromJPlagComparison(JPlagComparison jplagComparison) { + public static PlagiarismComparison fromJPlagComparison(JPlagComparison jplagComparison, Exercise exercise, File submissionDirectory) { PlagiarismComparison comparison = new PlagiarismComparison<>(); - comparison.setSubmissionA(PlagiarismSubmission.fromJPlagSubmission(jplagComparison.getFirstSubmission())); - comparison.setSubmissionB(PlagiarismSubmission.fromJPlagSubmission(jplagComparison.getSecondSubmission())); - comparison.setMatches(jplagComparison.getMatches().stream().map(PlagiarismMatch::fromJPlagMatch).collect(Collectors.toSet())); - comparison.setSimilarity(jplagComparison.similarity()); + comparison.setSubmissionA(PlagiarismSubmission.fromJPlagSubmission(jplagComparison.firstSubmission(), exercise, submissionDirectory)); + comparison.setSubmissionB(PlagiarismSubmission.fromJPlagSubmission(jplagComparison.secondSubmission(), exercise, submissionDirectory)); + comparison.setMatches(jplagComparison.matches().stream().map(PlagiarismMatch::fromJPlagMatch).collect(Collectors.toSet())); + // Note: JPlag returns a value between 0 and 1, we assume and store a value between 0 and 100 (percentage) in the database + comparison.setSimilarity(jplagComparison.similarity() * 100); comparison.setStatus(PlagiarismStatus.NONE); return comparison; diff --git a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismMatch.java b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismMatch.java index 539d46fed04b..ba034ebedc5a 100644 --- a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismMatch.java +++ b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismMatch.java @@ -36,9 +36,9 @@ public class PlagiarismMatch { */ public static PlagiarismMatch fromJPlagMatch(Match jplagMatch) { PlagiarismMatch match = new PlagiarismMatch(); - match.setStartA(jplagMatch.getStartOfFirst()); - match.setStartB(jplagMatch.getStartOfSecond()); - match.setLength(jplagMatch.getLength()); + match.setStartA(jplagMatch.startOfFirst()); + match.setStartB(jplagMatch.startOfSecond()); + match.setLength(jplagMatch.length()); return match; } diff --git a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismSubmission.java b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismSubmission.java index 98c7faa7e154..d0be3cfe22ff 100644 --- a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismSubmission.java +++ b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/PlagiarismSubmission.java @@ -1,10 +1,10 @@ package de.tum.in.www1.artemis.domain.plagiarism; +import java.io.File; import java.util.ArrayList; import java.util.List; import java.util.Objects; import java.util.stream.Collectors; -import java.util.stream.StreamSupport; import javax.persistence.*; @@ -15,6 +15,7 @@ import de.jplag.Submission; import de.tum.in.www1.artemis.domain.DomainObject; +import de.tum.in.www1.artemis.domain.Exercise; import de.tum.in.www1.artemis.domain.modeling.ModelingSubmission; import de.tum.in.www1.artemis.domain.participation.StudentParticipation; import de.tum.in.www1.artemis.domain.plagiarism.modeling.ModelingSubmissionElement; @@ -84,9 +85,11 @@ public class PlagiarismSubmission extends * Create a new PlagiarismSubmission instance from an existing JPlag Submission * * @param jplagSubmission the JPlag Submission to create the PlagiarismSubmission from + * @param exercise the exercise to which the comparison belongs, either Text or Programming + * @param submissionDirectory the directory to which all student submissions have been downloaded / stored * @return a new PlagiarismSubmission instance */ - public static PlagiarismSubmission fromJPlagSubmission(Submission jplagSubmission) { + public static PlagiarismSubmission fromJPlagSubmission(Submission jplagSubmission, Exercise exercise, File submissionDirectory) { PlagiarismSubmission submission = new PlagiarismSubmission<>(); String[] submissionIdAndStudentLogin = jplagSubmission.getName().split("[-.]"); @@ -106,8 +109,8 @@ public static PlagiarismSubmission fromJPlagSubmission(Su } submission.setStudentLogin(studentLogin); - submission.setElements(StreamSupport.stream(jplagSubmission.getTokenList().allTokens().spliterator(), false).filter(Objects::nonNull) - .map(token -> TextSubmissionElement.fromJPlagToken(token, submission)).collect(Collectors.toCollection(ArrayList::new))); + submission.setElements(jplagSubmission.getTokenList().stream().filter(Objects::nonNull) + .map(token -> TextSubmissionElement.fromJPlagToken(token, submission, exercise, submissionDirectory)).collect(Collectors.toCollection(ArrayList::new))); submission.setSubmissionId(submissionId); submission.setSize(jplagSubmission.getNumberOfTokens()); submission.setScore(null); // TODO diff --git a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/text/TextPlagiarismResult.java b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/text/TextPlagiarismResult.java index 505bccd0e6d0..bcebb824ae60 100644 --- a/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/text/TextPlagiarismResult.java +++ b/src/main/java/de/tum/in/www1/artemis/domain/plagiarism/text/TextPlagiarismResult.java @@ -1,11 +1,11 @@ package de.tum.in.www1.artemis.domain.plagiarism.text; -import java.util.Comparator; - import javax.persistence.Entity; -import de.jplag.JPlagComparison; +import org.apache.commons.lang3.ArrayUtils; + import de.jplag.JPlagResult; +import de.tum.in.www1.artemis.domain.Exercise; import de.tum.in.www1.artemis.domain.plagiarism.PlagiarismComparison; import de.tum.in.www1.artemis.domain.plagiarism.PlagiarismResult; @@ -18,17 +18,23 @@ public class TextPlagiarismResult extends PlagiarismResult plagiarismSubmission) { + public static TextSubmissionElement fromJPlagToken(Token token, PlagiarismSubmission plagiarismSubmission, Exercise exercise, File submissionDirectory) { TextSubmissionElement textSubmissionElement = new TextSubmissionElement(); textSubmissionElement.setColumn(token.getColumn()); textSubmissionElement.setLine(token.getLine()); - textSubmissionElement.setFile(token.file); - textSubmissionElement.setType(token.type); + if (exercise instanceof ProgrammingExercise) { + // Note: for text submissions 'file' must be null + // Note: we want to get the relative path within the repository and not the absolute path + var submissionDirectoryAbsoluteFile = submissionDirectory.getAbsoluteFile(); + var tokenAbsoluteFile = token.getFile().getAbsoluteFile(); + var filePath = submissionDirectoryAbsoluteFile.toPath().relativize(tokenAbsoluteFile.toPath()); + // remove the first element, because it is the parent folder in which the whole repo was saved + var fileStringWithinRepository = filePath.toString(); + if (filePath.getNameCount() > 1) { + fileStringWithinRepository = filePath.subpath(1, filePath.getNameCount()).toString(); + } + textSubmissionElement.setFile(fileStringWithinRepository); + } textSubmissionElement.setLength(token.getLength()); textSubmissionElement.setPlagiarismSubmission(plagiarismSubmission); diff --git a/src/main/java/de/tum/in/www1/artemis/service/QuizBatchService.java b/src/main/java/de/tum/in/www1/artemis/service/QuizBatchService.java index 90af185bc85e..889a128c2183 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/QuizBatchService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/QuizBatchService.java @@ -6,7 +6,7 @@ import javax.annotation.Nullable; -import org.apache.commons.lang.RandomStringUtils; +import org.apache.commons.lang3.RandomStringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Service; diff --git a/src/main/java/de/tum/in/www1/artemis/service/ResourceLoaderService.java b/src/main/java/de/tum/in/www1/artemis/service/ResourceLoaderService.java index 735384ba8e11..a5ed4df9f948 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/ResourceLoaderService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/ResourceLoaderService.java @@ -7,7 +7,7 @@ import java.util.List; import java.util.Optional; -import org.apache.commons.lang.StringUtils; +import org.apache.commons.lang3.StringUtils; import org.springframework.beans.factory.annotation.Value; import org.springframework.core.io.Resource; import org.springframework.core.io.ResourceLoader; diff --git a/src/main/java/de/tum/in/www1/artemis/service/SubmissionExportService.java b/src/main/java/de/tum/in/www1/artemis/service/SubmissionExportService.java index 797c6a2e294a..f139e6b9b091 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/SubmissionExportService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/SubmissionExportService.java @@ -10,7 +10,7 @@ import javax.annotation.Nullable; -import org.apache.commons.lang.mutable.MutableInt; +import org.apache.commons.lang3.mutable.MutableInt; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; diff --git a/src/main/java/de/tum/in/www1/artemis/service/SubmissionPolicyService.java b/src/main/java/de/tum/in/www1/artemis/service/SubmissionPolicyService.java index c2c0fb9eccc4..11669d7f3965 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/SubmissionPolicyService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/SubmissionPolicyService.java @@ -1,6 +1,6 @@ package de.tum.in.www1.artemis.service; -import org.apache.commons.lang.NotImplementedException; +import org.apache.commons.lang3.NotImplementedException; import org.springframework.stereotype.Service; import de.tum.in.www1.artemis.domain.*; diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/GitService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/GitService.java index 81b61fa4fd3f..428537d5a1df 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/GitService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/GitService.java @@ -26,7 +26,7 @@ import org.apache.commons.io.FileUtils; import org.apache.commons.io.filefilter.HiddenFileFilter; -import org.apache.commons.lang.StringUtils; +import org.apache.commons.lang3.StringUtils; import org.eclipse.jgit.api.*; import org.eclipse.jgit.api.errors.CanceledException; import org.eclipse.jgit.api.errors.GitAPIException; diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooProgrammingLanguageFeatureService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooProgrammingLanguageFeatureService.java index 8983d12c9623..f8f0d857b653 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooProgrammingLanguageFeatureService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooProgrammingLanguageFeatureService.java @@ -22,10 +22,10 @@ public BambooProgrammingLanguageFeatureService() { programmingLanguageFeatures.put(PYTHON, new ProgrammingLanguageFeature(PYTHON, true, false, true, false, false, List.of())); programmingLanguageFeatures.put(C, new ProgrammingLanguageFeature(C, false, true, true, false, false, List.of(FACT, GCC))); programmingLanguageFeatures.put(HASKELL, new ProgrammingLanguageFeature(HASKELL, true, false, false, false, true, List.of())); - programmingLanguageFeatures.put(KOTLIN, new ProgrammingLanguageFeature(KOTLIN, true, false, false, true, false, List.of())); + programmingLanguageFeatures.put(KOTLIN, new ProgrammingLanguageFeature(KOTLIN, true, false, true, true, false, List.of())); programmingLanguageFeatures.put(VHDL, new ProgrammingLanguageFeature(VHDL, false, false, false, false, false, List.of())); programmingLanguageFeatures.put(ASSEMBLER, new ProgrammingLanguageFeature(ASSEMBLER, false, false, false, false, false, List.of())); - programmingLanguageFeatures.put(SWIFT, new ProgrammingLanguageFeature(SWIFT, false, true, false, true, false, List.of(PLAIN, XCODE))); + programmingLanguageFeatures.put(SWIFT, new ProgrammingLanguageFeature(SWIFT, false, true, true, true, false, List.of(PLAIN, XCODE))); programmingLanguageFeatures.put(OCAML, new ProgrammingLanguageFeature(OCAML, false, false, false, false, true, List.of())); } } diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/dto/BambooBuildResultNotificationDTO.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/dto/BambooBuildResultNotificationDTO.java index 2f426e13cc80..b5322fe7bf30 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/dto/BambooBuildResultNotificationDTO.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/dto/BambooBuildResultNotificationDTO.java @@ -7,7 +7,7 @@ import java.util.List; import java.util.Optional; -import org.apache.commons.lang.StringEscapeUtils; +import org.apache.commons.text.StringEscapeUtils; import com.fasterxml.jackson.annotation.*; @@ -104,7 +104,7 @@ public List extractBuildLogs(ProgrammingLanguage programmingLangu for (var job : getBuild().jobs()) { for (var bambooLog : job.logs()) { // We have to unescape the HTML as otherwise symbols like '<' are not displayed correctly - buildLogEntries.add(new BuildLogEntry(bambooLog.date(), StringEscapeUtils.unescapeHtml(bambooLog.log()))); + buildLogEntries.add(new BuildLogEntry(bambooLog.date(), StringEscapeUtils.unescapeHtml4(bambooLog.log()))); } } diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsBuildLogParseUtils.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsBuildLogParseUtils.java index 3b51118d3032..8102ba998e35 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsBuildLogParseUtils.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsBuildLogParseUtils.java @@ -7,7 +7,7 @@ import java.util.LinkedList; import java.util.List; -import org.apache.commons.lang.StringUtils; +import org.apache.commons.lang3.StringUtils; import org.jsoup.nodes.Element; import org.jsoup.nodes.Node; import org.jsoup.nodes.TextNode; diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsProgrammingLanguageFeatureService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsProgrammingLanguageFeatureService.java index 4d2c3c2638c5..bdbfa0749a1a 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsProgrammingLanguageFeatureService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsProgrammingLanguageFeatureService.java @@ -19,10 +19,10 @@ 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())); programmingLanguageFeatures.put(JAVA, new ProgrammingLanguageFeature(JAVA, true, true, true, true, false, List.of(PLAIN_GRADLE, GRADLE_GRADLE, PLAIN_MAVEN, MAVEN_MAVEN))); - programmingLanguageFeatures.put(KOTLIN, new ProgrammingLanguageFeature(KOTLIN, true, false, false, true, false, List.of())); + programmingLanguageFeatures.put(KOTLIN, new ProgrammingLanguageFeature(KOTLIN, true, false, true, true, false, List.of())); programmingLanguageFeatures.put(PYTHON, new ProgrammingLanguageFeature(PYTHON, false, false, true, false, false, List.of())); // Jenkins is not supporting XCODE at the moment - programmingLanguageFeatures.put(SWIFT, new ProgrammingLanguageFeature(SWIFT, false, true, false, true, false, List.of(PLAIN))); + programmingLanguageFeatures.put(SWIFT, new ProgrammingLanguageFeature(SWIFT, false, true, true, true, false, List.of(PLAIN))); programmingLanguageFeatures.put(C, new ProgrammingLanguageFeature(C, false, false, true, false, false, List.of(FACT, GCC))); programmingLanguageFeatures.put(HASKELL, new ProgrammingLanguageFeature(HASKELL, false, false, false, false, false, List.of())); } diff --git a/src/main/java/de/tum/in/www1/artemis/service/plagiarism/ProgrammingPlagiarismDetectionService.java b/src/main/java/de/tum/in/www1/artemis/service/plagiarism/ProgrammingPlagiarismDetectionService.java index 442b49342118..bd716b9c6a5b 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/plagiarism/ProgrammingPlagiarismDetectionService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/plagiarism/ProgrammingPlagiarismDetectionService.java @@ -6,10 +6,13 @@ import java.nio.file.Path; import java.util.ArrayList; import java.util.List; +import java.util.Set; import java.util.concurrent.Executors; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; +import javax.validation.constraints.NotNull; + import org.eclipse.jgit.api.errors.GitAPIException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -18,11 +21,11 @@ import de.jplag.JPlag; import de.jplag.JPlagResult; -import de.jplag.exceptions.BasecodeException; +import de.jplag.Language; +import de.jplag.clustering.ClusteringOptions; import de.jplag.exceptions.ExitException; import de.jplag.options.JPlagOptions; -import de.jplag.options.LanguageOption; -import de.jplag.reporting.Report; +import de.jplag.reporting.reportobject.ReportObjectFactory; import de.tum.in.www1.artemis.domain.PlagiarismCheckState; import de.tum.in.www1.artemis.domain.ProgrammingExercise; import de.tum.in.www1.artemis.domain.Repository; @@ -35,7 +38,6 @@ import de.tum.in.www1.artemis.repository.plagiarism.PlagiarismResultRepository; import de.tum.in.www1.artemis.service.FileService; import de.tum.in.www1.artemis.service.UrlService; -import de.tum.in.www1.artemis.service.ZipFileService; import de.tum.in.www1.artemis.service.connectors.GitService; import de.tum.in.www1.artemis.service.plagiarism.cache.PlagiarismCacheService; import de.tum.in.www1.artemis.service.programming.ProgrammingExerciseExportService; @@ -54,8 +56,6 @@ public class ProgrammingPlagiarismDetectionService { private final ProgrammingExerciseRepository programmingExerciseRepository; - private final ZipFileService zipFileService; - private final GitService gitService; private final StudentParticipationRepository studentParticipationRepository; @@ -72,13 +72,12 @@ public class ProgrammingPlagiarismDetectionService { private final UrlService urlService; - public ProgrammingPlagiarismDetectionService(ProgrammingExerciseRepository programmingExerciseRepository, FileService fileService, ZipFileService zipFileService, - GitService gitService, StudentParticipationRepository studentParticipationRepository, PlagiarismResultRepository plagiarismResultRepository, + public ProgrammingPlagiarismDetectionService(ProgrammingExerciseRepository programmingExerciseRepository, FileService fileService, GitService gitService, + StudentParticipationRepository studentParticipationRepository, PlagiarismResultRepository plagiarismResultRepository, ProgrammingExerciseExportService programmingExerciseExportService, PlagiarismWebsocketService plagiarismWebsocketService, PlagiarismCacheService plagiarismCacheService, UrlService urlService) { this.programmingExerciseRepository = programmingExerciseRepository; this.fileService = fileService; - this.zipFileService = zipFileService; this.gitService = gitService; this.studentParticipationRepository = studentParticipationRepository; this.programmingExerciseExportService = programmingExerciseExportService; @@ -92,7 +91,7 @@ public ProgrammingPlagiarismDetectionService(ProgrammingExerciseRepository progr * downloads all repos of the exercise and runs JPlag * * @param programmingExerciseId the id of the programming exercises which should be checked - * @param similarityThreshold ignore comparisons whose similarity is below this threshold (%) + * @param similarityThreshold ignore comparisons whose similarity is below this threshold (in % between 0 and 100) * @param minimumScore consider only submissions whose score is greater or equal to this value * @return the text plagiarism result container with up to 500 comparisons with the highest similarity values * @throws ExitException is thrown if JPlag exits unexpectedly @@ -113,8 +112,8 @@ public TextPlagiarismResult checkPlagiarism(long programmingExerciseId, float si } plagiarismCacheService.setActivePlagiarismCheck(courseId); - JPlagResult result = getJPlagResult(programmingExercise, similarityThreshold, minimumScore); - if (result == null) { + JPlagResult jPlagResult = computeJPlagResult(programmingExercise, similarityThreshold, minimumScore); + if (jPlagResult == null) { log.info("Insufficient amount of submissions for plagiarism detection. Return empty result."); TextPlagiarismResult textPlagiarismResult = new TextPlagiarismResult(); textPlagiarismResult.setExercise(programmingExercise); @@ -127,10 +126,9 @@ public TextPlagiarismResult checkPlagiarism(long programmingExerciseId, float si return textPlagiarismResult; } - log.info("JPlag programming comparison finished with {} comparisons for programming exercise {}", result.getComparisons().size(), programmingExerciseId); + log.info("JPlag programming comparison finished with {} comparisons for programming exercise {}", jPlagResult.getAllComparisons().size(), programmingExerciseId); TextPlagiarismResult textPlagiarismResult = new TextPlagiarismResult(); - textPlagiarismResult.convertJPlagResult(result); - textPlagiarismResult.setExercise(programmingExercise); + textPlagiarismResult.convertJPlagResult(jPlagResult, programmingExercise); log.info("JPlag programming comparison done in {}", TimeLogUtil.formatDurationFrom(start)); plagiarismWebsocketService.notifyInstructorAboutPlagiarismState(topic, PlagiarismCheckState.COMPLETED, List.of()); @@ -146,22 +144,17 @@ public TextPlagiarismResult checkPlagiarism(long programmingExerciseId, float si * downloads all repos of the exercise and runs JPlag * * @param programmingExerciseId the id of the programming exercises which should be checked - * @param similarityThreshold ignore comparisons whose similarity is below this threshold (%) + * @param similarityThreshold ignore comparisons whose similarity is below this threshold (in % between 0 and 100) * @param minimumScore consider only submissions whose score is greater or equal to this value * @return a zip file that can be returned to the client - * @throws ExitException is thrown if JPlag exits unexpectedly - * @throws IOException is created the zip failed */ - public File checkPlagiarismWithJPlagReport(long programmingExerciseId, float similarityThreshold, int minimumScore) throws ExitException, IOException { + public File checkPlagiarismWithJPlagReport(long programmingExerciseId, float similarityThreshold, int minimumScore) { long start = System.nanoTime(); final var programmingExercise = programmingExerciseRepository.findWithAllParticipationsById(programmingExerciseId).get(); - JPlagResult result = getJPlagResult(programmingExercise, similarityThreshold, minimumScore); - if (result == null) { - return null; - } + JPlagResult result = computeJPlagResult(programmingExercise, similarityThreshold, minimumScore); - log.info("JPlag programming comparison finished with {} comparisons in {}", result.getComparisons().size(), TimeLogUtil.formatDurationFrom(start)); + log.info("JPlag programming comparison finished with {} comparisons in {}", result.getAllComparisons().size(), TimeLogUtil.formatDurationFrom(start)); return generateJPlagReportZip(result, programmingExercise); } @@ -169,12 +162,12 @@ public File checkPlagiarismWithJPlagReport(long programmingExerciseId, float sim * Checks for plagiarism and returns a JPlag result * * @param programmingExercise the programming exercise to check - * @param similarityThreshold the similarity threshold + * @param similarityThreshold the similarity threshold (in % between 0 and 100) * @param minimumScore the minimum score * @return the JPlag result or null if there are not enough participations - * @throws ExitException in case JPlag fails */ - private JPlagResult getJPlagResult(ProgrammingExercise programmingExercise, float similarityThreshold, int minimumScore) throws ExitException { + @NotNull + private JPlagResult computeJPlagResult(ProgrammingExercise programmingExercise, float similarityThreshold, int minimumScore) { long programmingExerciseId = programmingExercise.getId(); final var numberOfParticipations = programmingExercise.getStudentParticipations().size(); @@ -184,41 +177,48 @@ private JPlagResult getJPlagResult(ProgrammingExercise programmingExercise, floa List participations = filterStudentParticipationsForComparison(programmingExercise, minimumScore); if (participations.size() < 2) { - return null; + throw new BadRequestAlertException("Insufficient amount of valid and long enough submissions available for comparison", "Plagiarism Check", "notEnoughSubmissions"); } List repositories = downloadRepositories(programmingExercise, participations, targetPath); log.info("Downloading repositories done for programming exercise {}", programmingExerciseId); final var projectKey = programmingExercise.getProjectKey(); - final var repoFolder = Path.of(targetPath, projectKey).toString(); - final LanguageOption programmingLanguage = getJPlagProgrammingLanguage(programmingExercise); - + final var repoFolder = Path.of(targetPath, projectKey).toFile(); + final var programmingLanguage = getJPlagProgrammingLanguage(programmingExercise); final var templateRepoName = urlService.getRepositorySlugFromRepositoryUrl(programmingExercise.getTemplateParticipation().getVcsRepositoryUrl()); - JPlagOptions options = new JPlagOptions(repoFolder, programmingLanguage); + JPlagOptions options = new JPlagOptions(programmingLanguage, Set.of(repoFolder), Set.of()) + // JPlag expects a value between 0.0 and 1.0 + .withSimilarityThreshold(similarityThreshold / 100.0).withClusteringOptions(new ClusteringOptions().withEnabled(false)); if (templateRepoName != null) { - options.setBaseCodeSubmissionName(templateRepoName); + var templateFolder = Path.of(targetPath, projectKey, templateRepoName).toFile(); + options = options.withBaseCodeSubmissionDirectory(templateFolder); } - options.setSimilarityThreshold(similarityThreshold); - log.info("Start JPlag programming comparison for programming exercise {}", programmingExerciseId); String topic = plagiarismWebsocketService.getProgrammingExercisePlagiarismCheckTopic(programmingExerciseId); plagiarismWebsocketService.notifyInstructorAboutPlagiarismState(topic, PlagiarismCheckState.RUNNING, List.of("Running JPlag...")); JPlag jplag = new JPlag(options); - JPlagResult result = null; + JPlagResult result; try { result = jplag.run(); } - catch (BasecodeException e) { + catch (Exception e) { // Handling small or invalid base codes log.error(e.getMessage(), e); - log.info("Retrying JPlag Plagiarism Check without BaseCode"); - options.setBaseCodeSubmissionName(null); - jplag = new JPlag(options); - result = jplag.run(); + log.warn("Retrying JPlag Plagiarism Check without BaseCode"); + try { + options = options.withBaseCodeSubmissionDirectory(null); + jplag = new JPlag(options); + result = jplag.run(); + } + catch (Exception ex) { + log.info("FAILED: Retrying JPlag Plagiarism Check without BaseCode"); + log.error(ex.getMessage(), ex); + throw new BadRequestAlertException(ex.getMessage(), "Plagiarism Check", "jplagException"); + } } cleanupResourcesAsync(programmingExercise, repositories, targetPath); @@ -244,52 +244,30 @@ private void limitAndSavePlagiarismResult(TextPlagiarismResult textPlagiarismRes * @param jPlagResult The JPlag result * @param programmingExercise the programming exercise * @return the zip file - * @throws ExitException if JPlag fails - * @throws IOException if the zip file cannot be created */ - public File generateJPlagReportZip(JPlagResult jPlagResult, ProgrammingExercise programmingExercise) throws ExitException, IOException { + public File generateJPlagReportZip(JPlagResult jPlagResult, ProgrammingExercise programmingExercise) { final var targetPath = fileService.getUniquePathString(repoDownloadClonePath); - final var outputFolder = Path.of(targetPath, programmingExercise.getProjectKey() + "-output").toString(); - final var outputFolderFile = new File(outputFolder); + final var reportFolder = Path.of(targetPath, programmingExercise.getProjectKey() + " JPlag Report").toString(); + final var reportFolderFile = new File(reportFolder); // Create directories. - if (!outputFolderFile.mkdirs()) { - log.error("Cannot generate JPlag report because directories couldn't be created: {}", outputFolder); + if (!reportFolderFile.mkdirs()) { + log.error("Cannot generate JPlag report because directories couldn't be created: {}", reportFolder); return null; } // Write JPlag report result to the file. - log.info("Write JPlag report to file system"); - Report jplagReport = new Report(outputFolderFile, jPlagResult.getOptions()); - jplagReport.writeResult(jPlagResult); - - // Zip the file - var zipFile = zipJPlagReport(programmingExercise, targetPath, Path.of(outputFolder)); + log.info("Write JPlag report to file system and zip it"); + ReportObjectFactory reportObjectFactory = new ReportObjectFactory(); + reportObjectFactory.createAndSaveReport(jPlagResult, reportFolder); + // JPlag automatically zips the report + var zipFile = new File(reportFolder + ".zip"); + fileService.scheduleForDeletion(zipFile.getAbsoluteFile().toPath(), 1); fileService.scheduleForDirectoryDeletion(Path.of(targetPath), 2); return zipFile; } - /** - * Zips a JPlag report. - * - * @param programmingExercise the programming exercise - * @param targetPath the path where the zip file will be created - * @param outputFolderPath the path of the Jplag report - * @return the zip file - * @throws IOException if the zip file cannot be created - */ - private File zipJPlagReport(ProgrammingExercise programmingExercise, String targetPath, Path outputFolderPath) throws IOException { - log.info("JPlag report zipping to {}", targetPath); - final var courseShortName = programmingExercise.getCourseViaExerciseGroupOrCourseMember().getShortName(); - final var filename = courseShortName + "-" + programmingExercise.getShortName() + "-" + System.currentTimeMillis() + "-Jplag-Analysis-Output.zip"; - final var zipFilePath = Path.of(targetPath, filename); - zipFileService.createZipFileWithFolderContent(zipFilePath, outputFolderPath, null); - log.info("JPlag report zipped. Schedule deletion of zip file in 1 minute"); - fileService.scheduleForDeletion(zipFilePath, 1); - return new File(zipFilePath.toString()); - } - private void cleanupResourcesAsync(final ProgrammingExercise programmingExercise, final List repositories, final String targetPath) { executor.schedule(() -> { log.info("Will delete local repositories for programming exercise {}", programmingExercise.getId()); @@ -330,11 +308,13 @@ public void deleteTempLocalRepository(Repository repository) { } } - private LanguageOption getJPlagProgrammingLanguage(ProgrammingExercise programmingExercise) { + private Language getJPlagProgrammingLanguage(ProgrammingExercise programmingExercise) { return switch (programmingExercise.getProgrammingLanguage()) { - case JAVA -> LanguageOption.JAVA; - case C -> LanguageOption.C_CPP; - case PYTHON -> LanguageOption.PYTHON_3; + case JAVA -> new de.jplag.java.Language(); + case C -> new de.jplag.cpp.Language(); + case PYTHON -> new de.jplag.python3.Language(); + case SWIFT -> new de.jplag.swift.Language(); + case KOTLIN -> new de.jplag.kotlin.Language(); default -> throw new BadRequestAlertException("Programming language " + programmingExercise.getProgrammingLanguage() + " not supported for plagiarism check.", "ProgrammingExercise", "notSupported"); }; @@ -370,7 +350,7 @@ private List downloadRepositories(ProgrammingExercise programmingExe var topic = plagiarismWebsocketService.getProgrammingExercisePlagiarismCheckTopic(programmingExercise.getId()); List downloadedRepositories = new ArrayList<>(); - participations.forEach(participation -> { + participations.parallelStream().forEach(participation -> { try { var progressMessage = "Downloading repositories: " + (downloadedRepositories.size() + 1) + "/" + participations.size(); plagiarismWebsocketService.notifyInstructorAboutPlagiarismState(topic, PlagiarismCheckState.RUNNING, List.of(progressMessage)); diff --git a/src/main/java/de/tum/in/www1/artemis/service/plagiarism/TextPlagiarismDetectionService.java b/src/main/java/de/tum/in/www1/artemis/service/plagiarism/TextPlagiarismDetectionService.java index fe1a63d81caa..8b8e56241f68 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/plagiarism/TextPlagiarismDetectionService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/plagiarism/TextPlagiarismDetectionService.java @@ -5,6 +5,7 @@ import java.util.ArrayList; import java.util.List; import java.util.Optional; +import java.util.Set; import java.util.concurrent.atomic.AtomicInteger; import org.slf4j.Logger; @@ -14,9 +15,10 @@ import de.jplag.JPlag; import de.jplag.JPlagResult; +import de.jplag.Language; +import de.jplag.clustering.ClusteringOptions; import de.jplag.exceptions.ExitException; import de.jplag.options.JPlagOptions; -import de.jplag.options.LanguageOption; import de.tum.in.www1.artemis.domain.PlagiarismCheckState; import de.tum.in.www1.artemis.domain.TextExercise; import de.tum.in.www1.artemis.domain.TextSubmission; @@ -71,7 +73,7 @@ public List textSubmissionsForComparison(TextExercise exerciseWi * Download all submissions of the exercise, run JPlag, and return the result * * @param textExercise to detect plagiarism for - * @param similarityThreshold ignore comparisons whose similarity is below this threshold (%) + * @param similarityThreshold ignore comparisons whose similarity is below this threshold (in % between 0 and 100) * @param minimumScore consider only submissions whose score is greater or equal to this value * @param minimumSize consider only submissions whose size is greater or equal to this value * @return a zip file that can be returned to the client @@ -100,12 +102,8 @@ public TextPlagiarismResult checkPlagiarism(TextExercise textExercise, float sim log.info("Save text submissions for JPlag text comparison with {} submissions", submissionsSize); if (textSubmissions.size() < 2) { - log.info("Insufficient amount of submissions for plagiarism detection. Return empty result."); - TextPlagiarismResult textPlagiarismResult = new TextPlagiarismResult(); - textPlagiarismResult.setExercise(textExercise); - textPlagiarismResult.setSimilarityDistribution(new int[0]); - - return textPlagiarismResult; + log.info("Insufficient amount of submissions for plagiarism detection. Inform the client with a bad request response."); + throw new BadRequestAlertException("Insufficient amount of valid and long enough submissions available for comparison", "Plagiarism Check", "notEnoughSubmissions"); } AtomicInteger processedSubmissionCount = new AtomicInteger(1); @@ -135,17 +133,17 @@ public TextPlagiarismResult checkPlagiarism(TextExercise textExercise, float sim log.info("Saving text submissions done"); - JPlagOptions options = new JPlagOptions(submissionsFolderName, LanguageOption.TEXT); - options.setMinimumTokenMatch(minimumSize); - // Important: for large courses with more than 1000 students, we might get more than one million results and 10 million files in the file system due to many 0% results, // therefore we limit the results to at least 50% or 0.5 similarity, the passed threshold is between 0 and 100% - options.setSimilarityThreshold(similarityThreshold); + Language language = new de.jplag.text.Language(); + JPlagOptions options = new JPlagOptions(language, Set.of(submissionFolderFile), Set.of()) + // JPlag expects a value between 0.0 and 1.0 + .withSimilarityThreshold(similarityThreshold / 100.0).withClusteringOptions(new ClusteringOptions().withEnabled(false)); log.info("Start JPlag Text comparison"); JPlag jplag = new JPlag(options); JPlagResult jPlagResult = jplag.run(); - log.info("JPlag Text comparison finished with {} comparisons. Will limit the number of comparisons to 500", jPlagResult.getComparisons().size()); + log.info("JPlag Text comparison finished with {} comparisons. Will limit the number of comparisons to 500", jPlagResult.getAllComparisons().size()); log.info("Delete submission folder"); if (submissionFolderFile.exists()) { @@ -153,13 +151,16 @@ public TextPlagiarismResult checkPlagiarism(TextExercise textExercise, float sim } TextPlagiarismResult textPlagiarismResult = new TextPlagiarismResult(); - textPlagiarismResult.convertJPlagResult(jPlagResult); - textPlagiarismResult.setExercise(textExercise); + textPlagiarismResult.convertJPlagResult(jPlagResult, textExercise); log.info("JPlag text comparison for {} submissions done in {}", submissionsSize, TimeLogUtil.formatDurationFrom(start)); plagiarismWebsocketService.notifyInstructorAboutPlagiarismState(topic, PlagiarismCheckState.COMPLETED, List.of()); return textPlagiarismResult; } + catch (Exception ex) { + log.warn("Text plagiarism detection NOT successful", ex); + throw new BadRequestAlertException(ex.getMessage(), "Plagiarism Check", "jplagException"); + } finally { plagiarismCacheService.setInactivePlagiarismCheck(courseId); } diff --git a/src/main/java/de/tum/in/www1/artemis/web/rest/FileResource.java b/src/main/java/de/tum/in/www1/artemis/web/rest/FileResource.java index b914bd529671..6e2fb5dc167f 100644 --- a/src/main/java/de/tum/in/www1/artemis/web/rest/FileResource.java +++ b/src/main/java/de/tum/in/www1/artemis/web/rest/FileResource.java @@ -12,7 +12,7 @@ import javax.activation.MimetypesFileTypeMap; import org.apache.commons.io.IOUtils; -import org.apache.commons.lang.StringUtils; +import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.core.io.Resource; diff --git a/src/main/java/de/tum/in/www1/artemis/web/rest/ModelingExerciseResource.java b/src/main/java/de/tum/in/www1/artemis/web/rest/ModelingExerciseResource.java index c05ed93ab0a4..17548feeb9e7 100644 --- a/src/main/java/de/tum/in/www1/artemis/web/rest/ModelingExerciseResource.java +++ b/src/main/java/de/tum/in/www1/artemis/web/rest/ModelingExerciseResource.java @@ -418,7 +418,7 @@ public ResponseEntity getPlagiarismResult(@PathVariabl * Start the automated plagiarism detection for the given exercise and return its result. * * @param exerciseId for which all submission should be checked - * @param similarityThreshold ignore comparisons whose similarity is below this threshold (%) + * @param similarityThreshold ignore comparisons whose similarity is below this threshold (in % between 0 and 100) * @param minimumScore consider only submissions whose score is greater or equal to this * value * @param minimumSize consider only submissions whose size is greater or equal to this diff --git a/src/main/java/de/tum/in/www1/artemis/web/rest/ProgrammingExercisePlagiarismResource.java b/src/main/java/de/tum/in/www1/artemis/web/rest/ProgrammingExercisePlagiarismResource.java index c94f94eb40c0..a5b6ce3f880e 100644 --- a/src/main/java/de/tum/in/www1/artemis/web/rest/ProgrammingExercisePlagiarismResource.java +++ b/src/main/java/de/tum/in/www1/artemis/web/rest/ProgrammingExercisePlagiarismResource.java @@ -31,7 +31,7 @@ import de.tum.in.www1.artemis.service.programming.ProgrammingLanguageFeature; import de.tum.in.www1.artemis.service.programming.ProgrammingLanguageFeatureService; import de.tum.in.www1.artemis.service.util.TimeLogUtil; -import de.tum.in.www1.artemis.web.rest.util.HeaderUtil; +import de.tum.in.www1.artemis.web.rest.errors.BadRequestAlertException; /** * REST controller for managing ProgrammingExercise. @@ -89,7 +89,7 @@ public ResponseEntity getPlagiarismResult(@PathVariable lo * GET /programming-exercises/{exerciseId}/check-plagiarism : Start the automated plagiarism detection for the given exercise and return its result. * * @param exerciseId The ID of the programming exercise for which the plagiarism check should be executed - * @param similarityThreshold ignore comparisons whose similarity is below this threshold (%) + * @param similarityThreshold ignore comparisons whose similarity is below this threshold (in % between 0 and 100) * @param minimumScore consider only submissions whose score is greater or equal to this value * @return the ResponseEntity with status 200 (OK) and the list of at most 500 pair-wise submissions with a similarity above the given threshold (e.g. 50%). * @throws ExitException is thrown if JPlag exits unexpectedly @@ -106,8 +106,8 @@ public ResponseEntity checkPlagiarism(@PathVariable long e ProgrammingLanguageFeature programmingLanguageFeature = programmingLanguageFeatureService.get().getProgrammingLanguageFeatures(language); if (!programmingLanguageFeature.isPlagiarismCheckSupported()) { - return ResponseEntity.badRequest().headers(HeaderUtil.createFailureAlert(applicationName, true, ENTITY_NAME, "programmingLanguageNotSupported", - "Artemis does not support plagiarism checks for the programming language " + language)).body(null); + throw new BadRequestAlertException("Artemis does not support plagiarism checks for the programming language " + programmingExercise.getProgrammingLanguage(), + ENTITY_NAME, "programmingLanguageNotSupported"); } long start = System.nanoTime(); @@ -123,32 +123,28 @@ public ResponseEntity checkPlagiarism(@PathVariable long e * GET /programming-exercises/{exerciseId}/plagiarism-check : Uses JPlag to check for plagiarism and returns the generated output as zip file * * @param exerciseId The ID of the programming exercise for which the plagiarism check should be executed - * @param similarityThreshold ignore comparisons whose similarity is below this threshold (%) + * @param similarityThreshold ignore comparisons whose similarity is below this threshold (in % between 0 and 100) * @param minimumScore consider only submissions whose score is greater or equal to this value * @return The ResponseEntity with status 201 (Created) or with status 400 (Bad Request) if the parameters are invalid - * @throws ExitException is thrown if JPlag exits unexpectedly * @throws IOException is thrown for file handling errors */ - @GetMapping(value = CHECK_PLAGIARISM_JPLAG_REPORT, produces = MediaType.TEXT_PLAIN_VALUE) + @GetMapping(value = CHECK_PLAGIARISM_JPLAG_REPORT) @PreAuthorize("hasRole('EDITOR')") @FeatureToggle(Feature.ProgrammingExercises) public ResponseEntity checkPlagiarismWithJPlagReport(@PathVariable long exerciseId, @RequestParam float similarityThreshold, @RequestParam int minimumScore) - throws ExitException, IOException { + throws IOException { log.debug("REST request to check plagiarism for ProgrammingExercise with id: {}", exerciseId); ProgrammingExercise programmingExercise = programmingExerciseRepository.findByIdElseThrow(exerciseId); authCheckService.checkHasAtLeastRoleForExerciseElseThrow(Role.EDITOR, programmingExercise, null); - ProgrammingLanguageFeature programmingLanguageFeature = programmingLanguageFeatureService.get() - .getProgrammingLanguageFeatures(programmingExercise.getProgrammingLanguage()); + var programmingLanguageFeature = programmingLanguageFeatureService.get().getProgrammingLanguageFeatures(programmingExercise.getProgrammingLanguage()); if (!programmingLanguageFeature.isPlagiarismCheckSupported()) { - return ResponseEntity.badRequest().headers(HeaderUtil.createFailureAlert(applicationName, true, ENTITY_NAME, "programmingLanguageNotSupported", - "Artemis does not support plagiarism checks for the programming language " + programmingExercise.getProgrammingLanguage())).body(null); + throw new BadRequestAlertException("Artemis does not support plagiarism checks for the programming language " + programmingExercise.getProgrammingLanguage(), + "Plagiarism Check", "programmingLanguageNotSupported"); } File zipFile = programmingPlagiarismDetectionService.checkPlagiarismWithJPlagReport(exerciseId, similarityThreshold, minimumScore); if (zipFile == null) { - return ResponseEntity.badRequest().headers( - HeaderUtil.createFailureAlert(applicationName, true, ENTITY_NAME, "internalServerError", "Insufficient amount of comparisons available for comparison.")) - .body(null); + throw new BadRequestAlertException("Insufficient amount of valid and long enough submissions available for comparison.", "Plagiarism Check", "notEnoughSubmissions"); } InputStreamResource resource = new InputStreamResource(new FileInputStream(zipFile)); diff --git a/src/main/java/de/tum/in/www1/artemis/web/rest/TextExerciseResource.java b/src/main/java/de/tum/in/www1/artemis/web/rest/TextExerciseResource.java index 54f771616d04..73efa2a422eb 100644 --- a/src/main/java/de/tum/in/www1/artemis/web/rest/TextExerciseResource.java +++ b/src/main/java/de/tum/in/www1/artemis/web/rest/TextExerciseResource.java @@ -474,7 +474,7 @@ public ResponseEntity getPlagiarismResult(@PathVariable lo * Start the automated plagiarism detection for the given exercise and return its result. * * @param exerciseId ID of the exercise for which to detect plagiarism - * @param similarityThreshold ignore comparisons whose similarity is below this threshold (%) + * @param similarityThreshold ignore comparisons whose similarity is below this threshold (in % between 0 and 100) * @param minimumScore consider only submissions whose score is greater or equal to this value * @param minimumSize consider only submissions whose size is greater or equal to this value * @return the ResponseEntity with status 200 (OK) and the list of at most 500 pair-wise submissions with a similarity above the given threshold (e.g. 50%). diff --git a/src/main/java/de/tum/in/www1/artemis/web/rest/util/StringUtil.java b/src/main/java/de/tum/in/www1/artemis/web/rest/util/StringUtil.java index 69c0592b7d8c..9679153e1be9 100644 --- a/src/main/java/de/tum/in/www1/artemis/web/rest/util/StringUtil.java +++ b/src/main/java/de/tum/in/www1/artemis/web/rest/util/StringUtil.java @@ -1,6 +1,6 @@ package de.tum.in.www1.artemis.web.rest.util; -import org.apache.commons.lang.StringUtils; +import org.apache.commons.lang3.StringUtils; /** * Utility class for String manipulation diff --git a/src/main/webapp/app/exercises/programming/manage/programming-exercise-detail.component.html b/src/main/webapp/app/exercises/programming/manage/programming-exercise-detail.component.html index 78b9df4a2aaa..7dfc2fd3fd07 100644 --- a/src/main/webapp/app/exercises/programming/manage/programming-exercise-detail.component.html +++ b/src/main/webapp/app/exercises/programming/manage/programming-exercise-detail.component.html @@ -75,7 +75,7 @@

Programming Exercise Dashboard (); dialogError$ = this.dialogErrorSource.asObservable(); @@ -116,6 +119,7 @@ export class ProgrammingExerciseDetailComponent implements OnInit, OnDestroy { private programmingExerciseGradingService: ProgrammingExerciseGradingService, private codeHintService: CodeHintService, private router: Router, + private programmingLanguageFeatureService: ProgrammingLanguageFeatureService, ) {} ngOnInit() { @@ -197,6 +201,10 @@ export class ProgrammingExerciseDetailComponent implements OnInit, OnDestroy { }); this.setLatestCoveredLineRatio(); + + this.plagiarismCheckSupported = this.programmingLanguageFeatureService.getProgrammingLanguageFeature( + programmingExercise.programmingLanguage, + ).plagiarismCheckSupported; }); this.statisticsService.getExerciseStatistics(exerciseId!).subscribe((statistics: ExerciseManagementStatisticsDto) => { @@ -296,7 +304,7 @@ export class ProgrammingExerciseDetailComponent implements OnInit, OnDestroy { }); } - public deleteProgrammingExercise(event: { [key: string]: boolean }) { + deleteProgrammingExercise(event: { [key: string]: boolean }) { this.programmingExerciseService.delete(this.programmingExercise.id!, event.deleteStudentReposBuildPlans, event.deleteBaseReposBuildPlans).subscribe({ next: () => { this.eventManager.broadcast({ @@ -330,7 +338,7 @@ export class ProgrammingExerciseDetailComponent implements OnInit, OnDestroy { /** * Unlocks all repositories that belong to the exercise */ - private unlockAllRepositories() { + unlockAllRepositories() { this.lockingOrUnlockingRepositories = true; this.programmingExerciseService.unlockAllRepositories(this.programmingExercise.id!).subscribe({ next: (res) => { diff --git a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.html b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.html index 3dcd049b25e7..7627511f62a8 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.html +++ b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.html @@ -88,7 +88,7 @@

-
+
diff --git a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.ts b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.ts index bb759c54df21..47505af1cced 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.component.ts @@ -1,6 +1,6 @@ import { Component, OnInit } from '@angular/core'; import { ActivatedRoute, Router } from '@angular/router'; -import { HttpResponse } from '@angular/common/http'; +import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; import { ModelingExerciseService } from 'app/exercises/modeling/manage/modeling-exercise.service'; import { Exercise, ExerciseType } from 'app/entities/exercise.model'; import { TextExerciseService } from 'app/exercises/text/manage/text-exercise/text-exercise.service'; @@ -23,6 +23,7 @@ import { Range } from 'app/shared/util/utils'; import { PlagiarismInspectorService } from 'app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.service'; import { PlagiarismCasesService } from 'app/course/plagiarism-cases/shared/plagiarism-cases.service'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { AlertService, AlertType } from 'app/core/util/alert.service'; export type PlagiarismCheckState = { state: 'COMPLETED' | 'RUNNING'; @@ -112,6 +113,7 @@ export class PlagiarismInspectorComponent implements OnInit { deleteAllPlagiarismComparisons = false; readonly FeatureToggle = FeatureToggle; + readonly PROGRAMMING = ExerciseType.PROGRAMMING; // Icons faQuestionCircle = faQuestionCircle; @@ -129,6 +131,7 @@ export class PlagiarismInspectorComponent implements OnInit { private inspectorService: PlagiarismInspectorService, private plagiarismCasesService: PlagiarismCasesService, private modalService: NgbModal, + private alertService: AlertService, ) {} ngOnInit() { @@ -142,7 +145,7 @@ export class PlagiarismInspectorComponent implements OnInit { /** * Registers to the websocket topic of the plagiarism check - * to get feedback abount the progress + * to get feedback about the progress */ registerToPlagarismDetectionTopic() { const topic = this.getPlagarismDetectionTopic(); @@ -199,21 +202,21 @@ export class PlagiarismInspectorComponent implements OnInit { case ExerciseType.MODELING: { this.modelingExerciseService.getLatestPlagiarismResult(this.exercise.id!).subscribe({ next: (result) => this.handlePlagiarismResult(result), - error: () => (this.detectionInProgress = false), + error: () => this.handleError(), }); return; } case ExerciseType.PROGRAMMING: { this.programmingExerciseService.getLatestPlagiarismResult(this.exercise.id!).subscribe({ next: (result) => this.handlePlagiarismResult(result), - error: () => (this.detectionInProgress = false), + error: () => this.handleError(), }); return; } case ExerciseType.TEXT: { this.textExerciseService.getLatestPlagiarismResult(this.exercise.id!).subscribe({ next: (result) => this.handlePlagiarismResult(result), - error: () => (this.detectionInProgress = false), + error: () => this.handleError(), }); return; } @@ -254,8 +257,17 @@ export class PlagiarismInspectorComponent implements OnInit { this.detectionInProgress = false; downloadZipFileFromResponse(response); }, - error: () => { - this.detectionInProgress = false; + error: (error: HttpErrorResponse) => { + // Note: for some reason the alert is not shown, we do it manually with a workaround, because the message (part of the body) is not accessible in the error + const errorMessage = error.headers.get('x-artemisapp-error'); + if (errorMessage === 'error.notEnoughSubmissions') { + this.alertService.addAlert({ + type: AlertType.DANGER, + message: 'Insufficient amount of valid and long enough submissions available for comparison', + disableTranslation: true, + }); + } + this.handleError(); }, }); } @@ -273,16 +285,20 @@ export class PlagiarismInspectorComponent implements OnInit { if (this.exercise.type === ExerciseType.TEXT) { this.textExerciseService.checkPlagiarism(this.exercise.id!, options).subscribe({ next: (result) => this.handlePlagiarismResult(result), - error: () => (this.detectionInProgress = false), + error: () => this.handleError(), }); } else { this.programmingExerciseService.checkPlagiarism(this.exercise.id!, options).subscribe({ next: (result) => this.handlePlagiarismResult(result), - error: () => (this.detectionInProgress = false), + error: () => this.handleError(), }); } } + handleError() { + this.detectionInProgress = false; + } + /** * Trigger the server-side plagiarism detection and fetch its result. */ @@ -291,7 +307,7 @@ export class PlagiarismInspectorComponent implements OnInit { this.modelingExerciseService.checkPlagiarism(this.exercise.id!, options).subscribe({ next: (result: ModelingPlagiarismResult) => this.handlePlagiarismResult(result), - error: () => (this.detectionInProgress = false), + error: () => this.handleError(), }); } diff --git a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.service.ts b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.service.ts index 3f217af2c39f..c2a5ba2bfe7c 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.service.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-inspector/plagiarism-inspector.service.ts @@ -6,6 +6,7 @@ import { Range } from 'app/shared/util/utils'; export class PlagiarismInspectorService { /** * Filters the given comparisons and returns only those that have a similarity within the range [minimumSimilarity, maximumSimilarity) + * Note: similarities are defined as doubles between 0 and 100 * @param range the similarity range the comparisons should be filtered against * @param comparisons the comparisons that should be filtered */ diff --git a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-sidebar/plagiarism-sidebar.component.ts b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-sidebar/plagiarism-sidebar.component.ts index 47a04ce528f8..6b731dc16126 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-sidebar/plagiarism-sidebar.component.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-sidebar/plagiarism-sidebar.component.ts @@ -56,7 +56,11 @@ export class PlagiarismSidebarComponent implements OnChanges { const comparisons: PlagiarismComparison[] = changes.comparisons.currentValue; this.currentPage = 0; - this.numberOfPages = this.computeNumberOfPages(comparisons.length); + if (!comparisons) { + this.numberOfPages = 0; + } else { + this.numberOfPages = this.computeNumberOfPages(comparisons.length); + } this.pagedComparisons = this.getPagedComparisons(); } } @@ -71,7 +75,6 @@ export class PlagiarismSidebarComponent implements OnChanges { getPagedComparisons() { const startIndex = this.currentPage * this.pageSize; - return this.comparisons?.slice(startIndex, startIndex + this.pageSize); } diff --git a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/plagiarism-split-view.component.ts b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/plagiarism-split-view.component.ts index 2406cb397eda..4aba5d3a8e1e 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/plagiarism-split-view.component.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/plagiarism-split-view.component.ts @@ -3,16 +3,17 @@ import { AfterViewInit, Component, Directive, ElementRef, Input, OnChanges, OnIn import Split from 'split.js'; import { Subject } from 'rxjs'; import { PlagiarismComparison } from 'app/exercises/shared/plagiarism/types/PlagiarismComparison'; -import { TextSubmissionElement } from 'app/exercises/shared/plagiarism/types/text/TextSubmissionElement'; +import { FromToElement, TextSubmissionElement } from 'app/exercises/shared/plagiarism/types/text/TextSubmissionElement'; import { ModelingSubmissionElement } from 'app/exercises/shared/plagiarism/types/modeling/ModelingSubmissionElement'; import { Exercise, ExerciseType, getCourseId } from 'app/entities/exercise.model'; import { PlagiarismSubmission } from 'app/exercises/shared/plagiarism/types/PlagiarismSubmission'; import { PlagiarismCasesService } from 'app/course/plagiarism-cases/shared/plagiarism-cases.service'; import { HttpResponse } from '@angular/common/http'; +import { SimpleMatch } from 'app/exercises/shared/plagiarism/types/PlagiarismMatch'; @Directive({ selector: '[jhiPane]' }) export class SplitPaneDirective { - constructor(public el: ElementRef) {} + constructor(public elementRef: ElementRef) {} } @Component({ @@ -35,8 +36,8 @@ export class PlagiarismSplitViewComponent implements AfterViewInit, OnChanges, O public isModelingExercise: boolean; public isProgrammingOrTextExercise: boolean; - public matchesA: Map; - public matchesB: Map; + public matchesA: Map; + public matchesB: Map; constructor(private plagiarismCasesService: PlagiarismCasesService) {} @@ -44,7 +45,7 @@ export class PlagiarismSplitViewComponent implements AfterViewInit, OnChanges, O * Initialize third party libs inside this lifecycle hook. */ ngAfterViewInit(): void { - const paneElements = this.panes.map((pane: SplitPaneDirective) => pane.el.nativeElement); + const paneElements = this.panes.map((pane: SplitPaneDirective) => pane.elementRef.nativeElement); this.split = Split(paneElements, { minSize: 100, @@ -91,30 +92,27 @@ export class PlagiarismSplitViewComponent implements AfterViewInit, OnChanges, O plagiarismComparison.submissionA = plagiarismComparison.submissionB; plagiarismComparison.submissionB = temp; - plagiarismComparison.matches.forEach((match) => { - const tempStart = match.startA; - match.startA = match.startB; - match.startB = tempStart; - }); + if (plagiarismComparison.matches) { + plagiarismComparison.matches.forEach((match) => { + const tempStart = match.startA; + match.startA = match.startB; + match.startB = tempStart; + }); + } } - parseTextMatches({ submissionA, submissionB, matches }: PlagiarismComparison) { - const matchesA = matches - .map((match) => ({ - start: match.startA, - length: match.length, - })) - .sort((a, b) => a.start - b.start); - - const matchesB = matches - .map((match) => ({ - start: match.startB, - length: match.length, - })) - .sort((a, b) => a.start - b.start); - - this.matchesA = this.mapMatchesToElements(matchesA, submissionA); - this.matchesB = this.mapMatchesToElements(matchesB, submissionB); + parseTextMatches(plagComparison: PlagiarismComparison) { + if (plagComparison.matches) { + const matchesA = plagComparison.matches.map((match) => new SimpleMatch(match.startA, match.length)).sort((m1, m2) => m1.start - m2.start); + const matchesB = plagComparison.matches.map((match) => new SimpleMatch(match.startB, match.length)).sort((m1, m2) => m1.start - m2.start); + + this.matchesA = this.mapMatchesToElements(matchesA, plagComparison.submissionA); + this.matchesB = this.mapMatchesToElements(matchesB, plagComparison.submissionB); + } else { + // empty map in case no matches are available + this.matchesA = new Map(); + this.matchesB = new Map(); + } } /** @@ -122,15 +120,15 @@ export class PlagiarismSplitViewComponent implements AfterViewInit, OnChanges, O * @param matches list of objects containing the index and length of matched elements * @param submission the submission to map the elements of */ - mapMatchesToElements(matches: { start: number; length: number }[], submission: PlagiarismSubmission) { - const filesToMatchedElements = new Map(); + mapMatchesToElements(matches: SimpleMatch[], submission: PlagiarismSubmission) { + const filesToMatchedElements = new Map(); - matches.forEach(({ start, length }) => { + matches.forEach((match) => { // skip empty jplag (whitespace) matches - if (length === 0) { + if (match.length === 0) { return; } - const file = submission.elements![start]?.file || 'none'; + const file = submission.elements![match.start]?.file || 'none'; if (!filesToMatchedElements.has(file)) { filesToMatchedElements.set(file, []); @@ -138,10 +136,7 @@ export class PlagiarismSplitViewComponent implements AfterViewInit, OnChanges, O const fileMatches = filesToMatchedElements.get(file)!; - fileMatches.push({ - from: submission.elements![start], - to: submission.elements![start + length - 1], - }); + fileMatches.push(new FromToElement(submission.elements![match.start], submission.elements![match.start + match.length - 1])); }); return filesToMatchedElements; diff --git a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts index a9ee456698dc..b2c0d671430a 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.ts @@ -2,7 +2,7 @@ import { Component, Input, OnChanges, SimpleChanges, ViewEncapsulation } from '@ import { TextSubmissionService } from 'app/exercises/text/participate/text-submission.service'; import { PlagiarismSubmission } from 'app/exercises/shared/plagiarism/types/PlagiarismSubmission'; import { TextSubmission } from 'app/entities/text-submission.model'; -import { TextSubmissionElement } from 'app/exercises/shared/plagiarism/types/text/TextSubmissionElement'; +import { FromToElement, TextSubmissionElement } from 'app/exercises/shared/plagiarism/types/text/TextSubmissionElement'; import { TextExercise } from 'app/entities/text-exercise.model'; import { ProgrammingExercise } from 'app/entities/programming-exercise.model'; import { ExerciseType } from 'app/entities/exercise.model'; @@ -21,7 +21,7 @@ type FilesWithType = { [p: string]: FileType }; }) export class TextSubmissionViewerComponent implements OnChanges { @Input() exercise: ProgrammingExercise | TextExercise; - @Input() matches: Map; + @Input() matches: Map; @Input() plagiarismSubmission: PlagiarismSubmission; /** @@ -201,6 +201,10 @@ export class TextSubmissionViewerComponent implements OnChanges { } insertToken(text: string, token: string, position: number) { + // prevent negative values because slice does not handle them as we would wish + if (position < 0) { + position = 0; + } return [text.slice(0, position), token, text.slice(position)].join(''); } @@ -209,27 +213,27 @@ export class TextSubmissionViewerComponent implements OnChanges { const matches = this.getMatchesForCurrentFile(); const offsets = new Array(rows.length).fill(0); - matches.forEach(({ from, to }) => { - if (!from) { + matches.forEach((match) => { + if (!match.from) { captureException(new Error('"from" is not defined in insertMatchTokens')); return; } - if (!to) { + if (!match.to) { captureException(new Error('"to" is not defined in insertMatchTokens')); return; } - const idxLineFrom = from.line - 1; - const idxLineTo = to.line - 1; + const idxLineFrom = match.from.line - 1; + const idxLineTo = match.to.line - 1; - const idxColumnFrom = from.column - 1 + offsets[idxLineFrom]; + const idxColumnFrom = match.from.column - 1 + offsets[idxLineFrom]; if (rows[idxLineFrom]) { rows[idxLineFrom] = this.insertToken(rows[idxLineFrom], this.tokenStart, idxColumnFrom); offsets[idxLineFrom] += this.tokenStart.length; } - const idxColumnTo = to.column + to.length - 1 + offsets[idxLineTo]; + const idxColumnTo = match.to.column + match.to.length - 1 + offsets[idxLineTo]; if (rows[idxLineTo]) { rows[idxLineTo] = this.insertToken(rows[idxLineTo], this.tokenEnd, idxColumnTo); diff --git a/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismComparison.ts b/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismComparison.ts index a2860131735f..5840d330eb72 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismComparison.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismComparison.ts @@ -31,10 +31,10 @@ export class PlagiarismComparison { /** * List of matches between both submissions involved in this comparison. */ - matches: PlagiarismMatch[]; + matches?: PlagiarismMatch[]; /** - * Similarity of the compared submissions (between 0 and 1). + * Similarity of the compared submissions in percentage (between 0 and 100). */ similarity: number; diff --git a/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismMatch.ts b/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismMatch.ts index b747a29faaad..832d0a630f3f 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismMatch.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/types/PlagiarismMatch.ts @@ -1,3 +1,13 @@ +export class SimpleMatch { + start: number; + length: number; + + constructor(start: number, length: number) { + this.start = start; + this.length = length; + } +} + /** * A `PlagiarismMatch` is a sequence of identical elements of both submissions. */ diff --git a/src/main/webapp/app/exercises/shared/plagiarism/types/text/TextSubmissionElement.ts b/src/main/webapp/app/exercises/shared/plagiarism/types/text/TextSubmissionElement.ts index a96f8c136068..562537d65408 100644 --- a/src/main/webapp/app/exercises/shared/plagiarism/types/text/TextSubmissionElement.ts +++ b/src/main/webapp/app/exercises/shared/plagiarism/types/text/TextSubmissionElement.ts @@ -1,5 +1,14 @@ import { PlagiarismSubmissionElement } from '../PlagiarismSubmissionElement'; +export class FromToElement { + from: TextSubmissionElement; + to: TextSubmissionElement; + constructor(from: TextSubmissionElement, to: TextSubmissionElement) { + this.from = from; + this.to = to; + } +} + export class TextSubmissionElement extends PlagiarismSubmissionElement { column: number; line: number; diff --git a/src/test/java/de/tum/in/www1/artemis/TextExerciseIntegrationTest.java b/src/test/java/de/tum/in/www1/artemis/TextExerciseIntegrationTest.java index 8af1644a39ef..ce834c44001f 100644 --- a/src/test/java/de/tum/in/www1/artemis/TextExerciseIntegrationTest.java +++ b/src/test/java/de/tum/in/www1/artemis/TextExerciseIntegrationTest.java @@ -990,8 +990,7 @@ void testCheckPlagiarismIdenticalShortTexts() throws Exception { database.createSubmissionForTextExercise(textExercise, database.getUserByLogin("student2"), shortText); var path = "/api/text-exercises/" + textExercise.getId() + "/check-plagiarism"; - var result = request.get(path, HttpStatus.OK, TextPlagiarismResult.class, database.getPlagiarismOptions(50D, 0, 5)); - assertThat(result.getComparisons()).isEmpty(); + request.get(path, HttpStatus.BAD_REQUEST, TextPlagiarismResult.class, database.getPlagiarismOptions(50D, 0, 5)); } @Test @@ -1001,8 +1000,7 @@ void testCheckPlagiarismNoSubmissions() throws Exception { TextExercise textExercise = textExerciseRepository.findByCourseIdWithCategories(course.getId()).get(0); var path = "/api/text-exercises/" + textExercise.getId() + "/check-plagiarism"; - var result = request.get(path, HttpStatus.OK, TextPlagiarismResult.class, database.getDefaultPlagiarismOptions()); - assertThat(result.getComparisons()).isEmpty(); + request.get(path, HttpStatus.BAD_REQUEST, TextPlagiarismResult.class, database.getDefaultPlagiarismOptions()); } @Test diff --git a/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationBambooBitbucketJiraTest.java b/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationBambooBitbucketJiraTest.java index a2dba8f6f1bb..fabf9ecf0c04 100644 --- a/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationBambooBitbucketJiraTest.java +++ b/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationBambooBitbucketJiraTest.java @@ -10,6 +10,7 @@ import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.RepeatedTest; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.condition.DisabledOnOs; import org.junit.jupiter.api.condition.OS; @@ -773,7 +774,7 @@ void testCheckPlagiarism() throws Exception { programmingExerciseIntegrationTestService.testCheckPlagiarism(); } - @Test + @RepeatedTest(10) @WithMockUser(username = "instructor1", roles = "INSTRUCTOR") void testCheckPlagiarismJplagReport() throws Exception { programmingExerciseIntegrationTestService.testCheckPlagiarismJplagReport(); diff --git a/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationTestService.java b/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationTestService.java index e950aa5979cb..16027dfb79bd 100644 --- a/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationTestService.java +++ b/src/test/java/de/tum/in/www1/artemis/programmingexercise/ProgrammingExerciseIntegrationTestService.java @@ -5,6 +5,7 @@ import static de.tum.in.www1.artemis.web.rest.ProgrammingExerciseResourceEndpoints.*; import static de.tum.in.www1.artemis.web.rest.ProgrammingExerciseResourceErrorKeys.*; import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.Mockito.*; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -1571,11 +1572,18 @@ void testCheckPlagiarismJplagReport() throws Exception { assertThat(jplagZipArchive).isNotNull(); assertThat(jplagZipArchive).exists(); try (ZipFile zipFile = new ZipFile(jplagZipArchive)) { - assertThat(zipFile.getEntry("index.html")).isNotNull(); - assertThat(zipFile.getEntry("match0.html")).isNotNull(); - assertThat(zipFile.getEntry("matches_avg.csv")).isNotNull(); - // only one match exists - assertThat(zipFile.getEntry("match1.html")).isNull(); + // var entries = zipFile.entries(); + // while(entries.hasMoreElements()) { + // System.out.println(entries.nextElement().getName()); + // } + assertThat(zipFile.getEntry("overview.json")).isNotNull(); + assertThat(zipFile.getEntry("submissions/Submission-1.java/Submission-1.java")).isNotNull(); + assertThat(zipFile.getEntry("submissions/Submission-2.java/Submission-2.java")).isNotNull(); + + // it is random which of the following two exists, but one of them must be part of the zip file + var json1 = zipFile.getEntry("Submission-2.java-Submission-1.java.json"); + var json2 = zipFile.getEntry("Submission-1.java-Submission-2.java.json"); + assertTrue(json1 != null || json2 != null); } } diff --git a/src/test/javascript/spec/component/plagiarism/plagiarism-split-view.component.spec.ts b/src/test/javascript/spec/component/plagiarism/plagiarism-split-view.component.spec.ts index 19284520789e..d28fb80097c8 100644 --- a/src/test/javascript/spec/component/plagiarism/plagiarism-split-view.component.spec.ts +++ b/src/test/javascript/spec/component/plagiarism/plagiarism-split-view.component.spec.ts @@ -9,8 +9,8 @@ import { ExerciseType } from 'app/entities/exercise.model'; import { ModelingExercise } from 'app/entities/modeling-exercise.model'; import { TextExercise } from 'app/entities/text-exercise.model'; import { PlagiarismSubmission } from 'app/exercises/shared/plagiarism/types/PlagiarismSubmission'; -import { TextSubmissionElement } from 'app/exercises/shared/plagiarism/types/text/TextSubmissionElement'; -import { PlagiarismMatch } from 'app/exercises/shared/plagiarism/types/PlagiarismMatch'; +import { FromToElement, TextSubmissionElement } from 'app/exercises/shared/plagiarism/types/text/TextSubmissionElement'; +import { PlagiarismMatch, SimpleMatch } from 'app/exercises/shared/plagiarism/types/PlagiarismMatch'; import { ArtemisDatePipe } from 'app/shared/pipes/artemis-date.pipe'; import { MockComponent, MockPipe } from 'ng-mocks'; import { ModelingSubmissionViewerComponent } from 'app/exercises/shared/plagiarism/plagiarism-split-view/modeling-submission-viewer/modeling-submission-viewer.component'; @@ -203,7 +203,7 @@ describe('Plagiarism Split View Component', () => { { start: 0, length: 2 }, { start: 0, length: 0 }, { start: 3, length: 3 }, - ]; + ] as SimpleMatch[]; submissionA.elements = [ { file: '', column: 1, line: 1 }, { file: '', column: 2, line: 2 }, @@ -218,8 +218,8 @@ describe('Plagiarism Split View Component', () => { ] as TextSubmissionElement[]; const mappedElements = new Map(); mappedElements.set('none', [ - { from: { file: '', column: 1, line: 1 }, to: { file: '', column: 2, line: 2 } }, - { from: { file: '', column: 4, line: 4 }, to: { file: '', column: 6, line: 6 } }, + new FromToElement({ file: '', column: 1, line: 1 } as TextSubmissionElement, { file: '', column: 2, line: 2 } as TextSubmissionElement), + new FromToElement({ file: '', column: 4, line: 4 } as TextSubmissionElement, { file: '', column: 6, line: 6 } as TextSubmissionElement), ]); const result = comp.mapMatchesToElements(matches, submissionA); @@ -245,12 +245,12 @@ describe('Plagiarism Split View Component', () => { { start: 0, length: 0 }, { start: submissionA.elements.length + 1, length: 3 }, // Faulty data { start: 3, length: 3 }, - ]; + ] as SimpleMatch[]; const mappedElements = new Map(); mappedElements.set('none', [ - { from: { file: '', column: 1, line: 1 }, to: { file: '', column: 2, line: 2 } }, - { from: undefined, to: undefined }, // Faulty but better than crashing. - { from: { file: '', column: 4, line: 4 }, to: { file: '', column: 6, line: 6 } }, + new FromToElement({ file: '', column: 1, line: 1 } as TextSubmissionElement, { file: '', column: 2, line: 2 } as TextSubmissionElement), + new FromToElement(undefined as unknown as TextSubmissionElement, undefined as unknown as TextSubmissionElement), + new FromToElement({ file: '', column: 4, line: 4 } as TextSubmissionElement, { file: '', column: 6, line: 6 } as TextSubmissionElement), ]); const result = comp.mapMatchesToElements(matches, submissionA); @@ -314,8 +314,8 @@ describe('Plagiarism Split View Component', () => { expect(plagComp.submissionA).toEqual(originalPlagComp.submissionB); expect(plagComp.submissionB).toEqual(originalPlagComp.submissionA); - expect(plagComp.matches.map((match) => match.startA)).toEqual(originalPlagComp.matches.map((match) => match.startB)); - expect(plagComp.matches.map((match) => match.startB)).toEqual(originalPlagComp.matches.map((match) => match.startA)); - expect(plagComp.matches.map((match) => match.length)).toEqual(originalPlagComp.matches.map((match) => match.length)); + expect(plagComp.matches?.map((match) => match.startA)).toEqual(originalPlagComp.matches?.map((match) => match.startB)); + expect(plagComp.matches?.map((match) => match.startB)).toEqual(originalPlagComp.matches?.map((match) => match.startA)); + expect(plagComp.matches?.map((match) => match.length)).toEqual(originalPlagComp.matches?.map((match) => match.length)); }); });