End to End Testing (Java)

jplag.endToEndTesting/pom.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>de.jplag</groupId>
+		<artifactId>aggregator</artifactId>
+		<version>${revision}</version>
+	</parent>
+	<artifactId>jplag.endToEndTesting</artifactId>
+	<dependencies>
+		<dependency>
+			<groupId>de.jplag</groupId>
+			<artifactId>jplag</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-databind</artifactId>
+			<version>2.13.0</version>
+		</dependency>
+	</dependencies>
+</project>

jplag.endToEndTesting/src/main/java/de/jplag/endToEndTesting/constants/Constant.java

@@ -0,0 +1,23 @@
+package de.jplag.endToEndTesting.constants;
+
+import java.nio.file.Path;
+
+public final class Constant {
+
+	private Constant() {
+		// private constructor to prevent instantiation
+	}
+
+	// can be exchanged for a suitable standard path if necessary
+	public static final String EMPTY_STRING = "";
+	public static final String TEMPORARY_DIRECTORY_NAME = "submission";
+	public static final String TEMPORARY_SYSTEM_DIRECTORY = "java.io.tmpdir";
+
+	public static final String TEMPORARY_SUBMISSION_DIRECTORY_NAME = Path.of(System.getProperty(TEMPORARY_SYSTEM_DIRECTORY), TEMPORARY_DIRECTORY_NAME).toString();
+
+	// constant final project strings
+	public static final Path BASE_PATH_TO_JAVA_RESOURCES_SORTALGO = Path.of("src", "test", "resources", "java",
+			"sortAlgo");
+	public static final Path BASE_PATH_TO_JAVA_RESULT_JSON = Path.of("src", "test", "resources", "results",
+			"javaResult.json");
+}

jplag.endToEndTesting/src/main/java/de/jplag/endToEndTesting/helper/JPlagTestSuiteHelper.java

@@ -0,0 +1,127 @@
+package de.jplag.endToEndTesting.helper;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
+
+import java.util.Arrays;
+import java.util.List;
+
+import javax.annotation.processing.FilerException;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import de.jplag.endToEndTesting.constants.Constant;
+import de.jplag.options.LanguageOption;
+import model.ResultJsonModel;
+import model.TestCaseModel;
+
+public class JPlagTestSuiteHelper {
+
+	private static final Logger logger = LoggerFactory.getLogger("EndToEndTesting");
+
+	private String[] resourceNames;
+	private List<ResultJsonModel> resultModel;
+	private LanguageOption languageOption;
+
+	/**
+	 * Helper class for the endToEnd tests. In this class the necessary resources
+	 * are loaded, prepared and copied for the tests based on the passed parameters.
+	 * An instance of this class loads all necessary paths and properties for a test
+	 * run with the specified language
+	 * 
+	 * @param languageOption for loading language-specific resources
+	 * @throws Exception
+	 */
+	public JPlagTestSuiteHelper(LanguageOption languageOption) throws Exception {
+		this.languageOption = languageOption;
+		this.resourceNames = new File(Constant.BASE_PATH_TO_JAVA_RESOURCES_SORTALGO.toString()).list();
+
+		this.resultModel = JsonHelper.getResultModelFromPath();
+		logger.info(String.format("temp path at [%s]", Constant.TEMPORARY_SUBMISSION_DIRECTORY_NAME));
+	}
+
+	/**
+	 * creates all necessary folder paths and objects for a test run. Also searches
+	 * for the stored previous results of the test in order to compare them with the
+	 * current results.
+	 * 
+	 * @param classNames
+	 * @return comparison results saved for the test
+	 * @throws Exception
+	 */
+	public TestCaseModel createNewTestCase(String[] classNames) throws Exception {
+		createNewTestCaseDirectory(classNames);
+		var functionName = StackWalker.getInstance().walk(stream -> stream.skip(1).findFirst().get()).getMethodName();
+		ResultJsonModel resultJsonModel = resultModel.stream()
+				.filter(jsonModel -> functionName.equals(jsonModel.getFunctionName())).findAny().orElse(null);
+		return new TestCaseModel(Constant.TEMPORARY_SUBMISSION_DIRECTORY_NAME, resultJsonModel, languageOption);
+	}
+
+	/**
+	 * The copied data should be deleted after instance closure
+	 * 
+	 * @throws Exception
+	 */
+	public void clear() throws Exception {
+		logger.info("Class instance was cleaned!");
+		deleteCopiedFiles(new File(Constant.TEMPORARY_SUBMISSION_DIRECTORY_NAME));
+	}
+
+	/**
+	 * Copies the passed filenames to a temporary path to use them in the tests
+	 * 
+	 * @throws Exception
+	 */
+	private void createNewTestCaseDirectory(String[] classNames) throws Exception {
+		// before copying files to the test path, check if all files are in the resource
+		// directory
+		for (String className : classNames) {
+			if (!Arrays.asList(resourceNames).contains(className)) {
+				throw new FileNotFoundException(
+						String.format("The specified class could not be found! [%s]", className));
+			}
+		}
+		// Copy the resources data to the temporary path
+		for (int counter = 0; counter < classNames.length; counter++) {
+			Path originalPath = Path.of(Constant.BASE_PATH_TO_JAVA_RESOURCES_SORTALGO.toString(), classNames[counter]);
+			Path copiePath = Path.of(Constant.TEMPORARY_SUBMISSION_DIRECTORY_NAME,
+					Constant.TEMPORARY_DIRECTORY_NAME + (counter + 1), classNames[counter]);
+
+			File directory = new File(copiePath.toString());
+			if (!directory.exists()) {
+				directory.mkdirs();
+			}
+
+			Files.copy(originalPath, copiePath, StandardCopyOption.REPLACE_EXISTING);
+			logger.info(String.format("Copy file from [%s] to [%s]", originalPath, copiePath));
+		}
+	}
+
+	/**
+	 * Delete directory with including files
+	 * 
+	 * @param file
+	 */
+	private void deleteCopiedFiles(File folder) {
+		File[] files = folder.listFiles();
+		if (files != null) { // some JVMs return null for empty dirs
+			for (File f : files) {
+				if (f.isDirectory()) {
+					deleteCopiedFiles(f);
+				} else {
+					logger.info(String.format("Delete file in folder: [%s]", f.toString()));
+					f.delete();
+				}
+			}
+		}
+		logger.info(String.format("Delete folder: [%s]", folder.toString()));
+		folder.delete();
+	}
+
+}

jplag.endToEndTesting/src/main/java/de/jplag/endToEndTesting/helper/JsonHelper.java

@@ -0,0 +1,35 @@
+package de.jplag.endToEndTesting.helper;
+
+import java.nio.file.Paths;
+
+import java.util.Arrays;
+import java.util.List;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import de.jplag.endToEndTesting.constants.Constant;
+import model.ResultJsonModel;
+
+public final class JsonHelper {
+
+	private JsonHelper() {
+		// private constructor to prevent instantiation
+	}
+
+	/**
+	 * Parsing the old results in the json file as a list from ResultJsonModel.
+	 * 
+	 * @param pathToJsonFile
+	 * @return list of saved results for the test cases
+	 * @throws JsonMappingException
+	 * @throws JsonProcessingException
+	 * @throws Exception
+	 */
+	public static List<ResultJsonModel> getResultModelFromPath()
+			throws JsonMappingException, JsonProcessingException, Exception {
+		return Arrays.asList(
+				new ObjectMapper().readValue(Constant.BASE_PATH_TO_JAVA_RESULT_JSON.toFile(), ResultJsonModel[].class));
+	}
+}

jplag.endToEndTesting/src/main/java/model/ResultJsonModel.java

@@ -0,0 +1,31 @@
+package model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class ResultJsonModel {
+
+	@JsonProperty("function_name")
+	private String functionName;
+	@JsonProperty("result_similarity")
+	private String resultSimilarity;
+
+	public ResultJsonModel(String functionName, String resultSimilarity)
+	{
+		this.functionName = functionName;
+		this.resultSimilarity = resultSimilarity;
+	}
+
+	public ResultJsonModel()
+	{
+	}
+
+	public float similarity()
+	{
+		return Float.parseFloat(resultSimilarity);
+	}
+
+	public String getFunctionName()
+	{
+		return functionName;
+	}
+}

jplag.endToEndTesting/src/main/java/model/TestCaseModel.java

@@ -0,0 +1,44 @@
+package model;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import de.jplag.JPlagComparison;
+import de.jplag.JPlagResult;
+import de.jplag.options.JPlagOptions;
+import de.jplag.options.LanguageOption;
+
+public class TestCaseModel {
+	private static final Logger logger = LoggerFactory.getLogger("EndToEndTesting");
+
+	private ResultJsonModel resultJsonModel;
+	private LanguageOption languageOption;
+	private String submissionFolderPath;
+
+	public TestCaseModel(String submissionFolderPath, ResultJsonModel resultJsonModel, LanguageOption languageOption) {
+		this.submissionFolderPath = submissionFolderPath;
+		this.resultJsonModel = resultJsonModel;
+		this.languageOption = languageOption;
+	}
+
+	/**
+	 * returns the, for the test, current result model that has been persisted in the saved list. 
+	 * @return ResultJsonModel loaded for the test
+	 */
+	public ResultJsonModel getCurrentResultJsonModel()
+	{
+		return resultJsonModel;
+	}
+
+	/**
+	 * creates the JPlag options for the test run from the values passed in the constructor.
+	 * @return current JPlag options for the created object
+	 */
+	public JPlagOptions getJPlagOptionsFromCurrentModel() {
+		return new JPlagOptions(new ArrayList<>(Arrays.asList(submissionFolderPath)), new ArrayList<String>(),
+				languageOption);
+	}
+}