Add extra student files to packaging configuration

Author: nygrenh

tmc-langs-framework/src/main/java/fi/helsinki/cs/tmc/langs/AbstractLanguagePlugin.java

@@ -13,6 +13,8 @@
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
 import java.util.Stack;
 
@@ -147,9 +149,17 @@ private ImmutableList<Path> searchForExercises(
     }
 
     @Override
-    public ExercisePackagingConfiguration getExercisePackagingConfiguration() {
-        return new ExercisePackagingConfiguration(
-                ImmutableList.of("src"), ImmutableList.of("test"));
+    public ExercisePackagingConfiguration getExercisePackagingConfiguration(Path path) {
+        Configuration configuration = getConfiguration(path);
+        List<Path> extraStudentFiles = configuration.getExtraStudentFiles();
+        List<String> extraStudentStrings = new ArrayList<>();
+        for (Path p : extraStudentFiles) {
+            extraStudentStrings.add(p.toString());
+        }
+        ImmutableList<String> studentFiles =
+                ImmutableList.<String>builder().add("src").addAll(extraStudentStrings).build();
+        ImmutableList<String> src = ImmutableList.of("src");
+        return new ExercisePackagingConfiguration(studentFiles, ImmutableList.of("test"));
     }
 
     @Override

tmc-langs-framework/src/main/java/fi/helsinki/cs/tmc/langs/LanguagePlugin.java

@@ -164,7 +164,7 @@ ValidationResult checkCodeStyle(Path path, Locale messageLocale)
      * Returns configuration which is used to package submission on tmc-server.
      */
     @Beta
-    public ExercisePackagingConfiguration getExercisePackagingConfiguration();
+    public ExercisePackagingConfiguration getExercisePackagingConfiguration(Path path);
 
     /**
      * Runs clean command e.g {@code make clean} for make or {@code mvn clean} for maven.

tmc-langs-framework/src/main/java/fi/helsinki/cs/tmc/langs/domain/Configuration.java

@@ -2,24 +2,33 @@
 
 import fi.helsinki.cs.tmc.langs.utils.TmcProjectYmlParser;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.Maps;
 
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 public final class Configuration {
 
+    private final TmcProjectYmlParser tmcProjectYmlParser;
+    private final Path path;
     private Map<String, ValueObject> options;
     public static final Path TMC_PROJECT_YML = Paths.get(".tmcproject.yml");
 
+    @VisibleForTesting
     public Configuration() {
+        tmcProjectYmlParser = new TmcProjectYmlParser();
         options = new HashMap<>();
+        path = null;
     }
 
     public Configuration(Path path) {
+        this.path = path;
+        tmcProjectYmlParser = new TmcProjectYmlParser();
         parseOptions(path);
     }
 
@@ -40,19 +49,23 @@ public ValueObject get(String key) {
         return null;
     }
 
+    public List<Path> getExtraStudentFiles() {
+        return tmcProjectYmlParser.parseExtraStudentFiles(path.resolve(TMC_PROJECT_YML));
+    }
+
     /**
      * Parse options from the path.
      *
      * @param path Absolute path to configuration, e.g. .tmcproject.yml -file.
      */
-    public void parseOptions(Path path) {
+    void parseOptions(Path path) {
         this.options = parseTmcProjectYmlOptions(path);
     }
 
     private Map<String, ValueObject> parseTmcProjectYmlOptions(Path path) {
         Path configFile = path.resolve(TMC_PROJECT_YML);
         if (Files.exists(path)) {
-            return new TmcProjectYmlParser().parseOptions(configFile);
+            return tmcProjectYmlParser.parseOptions(configFile);
         }
         return Maps.newHashMap();
     }

tmc-langs-framework/src/main/java/fi/helsinki/cs/tmc/langs/io/ConfigurableStudentFilePolicy.java

@@ -78,7 +78,7 @@ private boolean isExtraStudentFile(Path path) {
         }
 
         for (Path extraStudentFile : extraStudentFiles) {
-            if (extraStudentFile.toAbsolutePath().equals(path.toAbsolutePath())) {
+            if (rootPath.resolve(extraStudentFile).toAbsolutePath().equals(path.toAbsolutePath())) {
                 return true;
             }
         }
@@ -96,7 +96,7 @@ private void loadExtraStudentFileList() {
 
         if (Files.exists(configFile)) {
             TmcProjectYmlParser parser = new TmcProjectYmlParser();
-            extraStudentFiles = parser.parseExtraStudentFiles(configFile, rootPath);
+            extraStudentFiles = parser.parseExtraStudentFiles(configFile);
         }
     }
 

tmc-langs-framework/src/main/java/fi/helsinki/cs/tmc/langs/utils/TmcProjectYmlParser.java

@@ -12,6 +12,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -20,18 +21,15 @@
 public final class TmcProjectYmlParser implements ConfigurationParser {
 
     private static final Logger log = LoggerFactory.getLogger(TmcProjectYmlParser.class);
-
-    private Path rootPath;
     private List<Path> extraStudentFiles;
 
     /**
      * Parses a list of extra student files from a <tt>.tmcproject.yml</tt> file.
      */
-    public List<Path> parseExtraStudentFiles(Path configFilePath, Path projectRootPath) {
+    public List<Path> parseExtraStudentFiles(Path configFilePath) {
 
         log.debug("Parsing extra student files from {}", configFilePath);
 
-        rootPath = projectRootPath;
         extraStudentFiles = new ArrayList<>();
 
         Object yamlSpecifications = getYamlSpecs(configFilePath.toAbsolutePath());
@@ -109,7 +107,7 @@ private void addAllIfList(Object files) {
 
     private void addIfString(Object value) {
         if (value instanceof String) {
-            Path path = this.rootPath.resolve((String) value);
+            Path path = Paths.get((String) value);
             extraStudentFiles.add(path);
             log.trace("Added {} as extra student file", path);
         }

tmc-langs-java/src/main/java/fi/helsinki/cs/tmc/langs/java/maven/MavenPlugin.java

@@ -109,8 +109,9 @@ protected TestRunFileAndLogs createRunResultFile(Path path)
                 result.getStdErr());
     }
 
+    // TODO: ADD extra student file support to here too
     @Override
-    public ExercisePackagingConfiguration getExercisePackagingConfiguration() {
+    public ExercisePackagingConfiguration getExercisePackagingConfiguration(Path path) {
         return new ExercisePackagingConfiguration(
                 ImmutableList.of("src/main"), ImmutableList.of("src/test"));
     }

tmc-langs-python3/src/main/java/fi/helsinki/cs/tmc/langs/python3/Python3Plugin.java

@@ -148,8 +148,9 @@ public void clean(Path path) {
         // no op
     }
 
+    // TODO: Add extra student files to here too
     @Override
-    public ExercisePackagingConfiguration getExercisePackagingConfiguration() {
+    public ExercisePackagingConfiguration getExercisePackagingConfiguration(Path path) {
         return new ExercisePackagingConfiguration(
                 ImmutableList.of("src"), ImmutableList.of("test", "tmc"));
     }

tmc-langs-util/src/main/java/fi/helsinki/cs/tmc/langs/util/TaskExecutorImpl.java

@@ -115,7 +115,7 @@ public byte[] compressProject(Path path) throws NoLanguagePluginFoundException,
     @Override
     public ExercisePackagingConfiguration getExercisePackagingConfiguration(Path path)
             throws NoLanguagePluginFoundException {
-        return getLanguagePlugin(path).getExercisePackagingConfiguration();
+        return getLanguagePlugin(path).getExercisePackagingConfiguration(path);
     }
 
     @Override