Try to simplify the Workdir code.

Author: Aleksi Salmela

src/main/java/fi/helsinki/cs/tmc/cli/command/InfoCommand.java

@@ -95,11 +95,11 @@ private void printLocalInfo(String[] stringArgs) {
 
         if (useWorkingDirectory) {
             // if in exercise directory, print info for that exercise.
-            String exerciseName = getCurrentExercise(workDir);
-            if (exerciseName == null) {
+            Exercise exercise = getCurrentExercise(workDir);
+            if (exercise == null) {
                 printCourse(info.getCourse());
             } else {
-                printExercise(info.getExercise(exerciseName));
+                printExercise(exercise);
             }
         } else {
             if (stringArgs.length != 1) {
@@ -212,8 +212,8 @@ private int getCompletedExerciseCount(Course course) {
         return completed;
     }
 
-    private String getCurrentExercise(WorkDir workDir) {
-        List<String> exercises = workDir.getExerciseNames(false, false);
+    private Exercise getCurrentExercise(WorkDir workDir) {
+        List<Exercise> exercises = workDir.getExercises(false, false);
         if (exercises.size() == 1) {
             return exercises.get(0);
         }

src/main/java/fi/helsinki/cs/tmc/cli/command/ListExercisesCommand.java

@@ -82,8 +82,6 @@ private String getCourseNameFromCurrentDirectory() {
     }
 
     private CourseInfo getCourseInfoFromCurrentDirectory() {
-        WorkDir workDir = ctx.getWorkDir();
-        workDir.addPath();
         return ctx.getCourseInfo();
     }
 

src/main/java/fi/helsinki/cs/tmc/cli/command/PasteCommand.java

@@ -57,8 +57,8 @@ public void run(CliContext context, CommandLine args) {
             return;
         }
 
-        List<String> exerciseNames = workdir.getExerciseNames();
-        if (exerciseNames.size() != 1) {
+        List<Exercise> exercises = workdir.getExercises();
+        if (exercises.size() != 1) {
             io.errorln("Error: Matched too many exercises.");
             printUsage(context);
             return;
@@ -76,7 +76,7 @@ public void run(CliContext context, CommandLine args) {
                         true);
             }
         }
-        sendPaste(message, exerciseNames.get(0));
+        sendPaste(message, exercises.get(0));
     }
 
     private boolean parseArgs(CommandLine args) {
@@ -103,24 +103,19 @@ private boolean parseArgs(CommandLine args) {
                 io.errorln("The path '" + stringArgs[0] + "' is not valid exercise.");
                 return false;
             }
-        } else {
-            //TODO replace the following call with workdir.getCurrentExercise()
-            if (!workdir.addPath()) {
-                io.errorln("You are not in exercise directory.");
-                return false;
-            }
+        }
+        if (workdir.getExercises().size() != 1) {
+            io.errorln("You are not in exercise directory.");
+            return false;
         }
         return true;
     }
 
-    private void sendPaste(String message, String exerciseName) {
+    private void sendPaste(String message, Exercise exercise) {
         if (message == null) {
             message = "";
         }
 
-        CourseInfo info = ctx.getCourseInfo();
-        Exercise exercise = info.getExercise(exerciseName);
-
         URI uri = TmcUtil.sendPaste(ctx, exercise, message);
         if (uri == null && exercise.hasDeadlinePassed()) {
             io.errorln("Unable to send the paste."

src/main/java/fi/helsinki/cs/tmc/cli/command/RunTestsCommand.java

@@ -61,9 +61,9 @@ public void run(CliContext context, CommandLine args) {
             }
         }
 
-        List<String> exerciseNames = workDir.getExerciseNames();
-        if (exerciseNames.isEmpty()) {
-            io.errorln("You have to be in a course directory to run tests.");
+        List<Exercise> exercises = workDir.getExercises();
+        if (exercises.isEmpty()) {
+            io.errorln("No exercises specified.");
             return;
         }
 
@@ -74,11 +74,10 @@ public void run(CliContext context, CommandLine args) {
         ResultPrinter resultPrinter = new ResultPrinter(io, showDetails, showPassed,
                 passedColor, failedColor);
 
-        boolean isOnlyExercise = (exerciseNames.size() == 1);
+        boolean isOnlyExercise = (exercises.size() == 1);
 
-        for (String name : exerciseNames) {
-            io.println(ColorUtil.colorString("Testing: " + name, Color.YELLOW));
-            Exercise exercise = info.getExercise(name);
+        for (Exercise exercise : exercises) {
+            io.println(ColorUtil.colorString("Testing: " + exercise.getName(), Color.YELLOW));
 
             RunResult runResult = TmcUtil.runLocalTests(ctx, exercise);
             if (runResult == null) {

src/main/java/fi/helsinki/cs/tmc/cli/command/SubmitCommand.java

@@ -70,15 +70,15 @@ public void run(CliContext context, CommandLine args) {
             }
         }
 
-        List<String> exerciseNames;
+        List<Exercise> exercises;
         if (filterUncompleted) {
             workDir.addPath(workDir.getCourseDirectory());
-            exerciseNames = workDir.getExerciseNames(true, true);
+            exercises = workDir.getExercises(true, true);
         } else {
-            exerciseNames = workDir.getExerciseNames();
+            exercises = workDir.getExercises();
         }
 
-        if (exerciseNames.isEmpty()) {
+        if (exercises.isEmpty()) {
             if (filterUncompleted && workDir.getCourseDirectory() != null) {
                 io.println("No locally tested exercises.");
                 return;
@@ -98,8 +98,8 @@ public void run(CliContext context, CommandLine args) {
         ResultPrinter resultPrinter = new ResultPrinter(io, this.showDetails, this.showAll,
                 color1, color2);
 
-        boolean isOnlyExercise = exerciseNames.size() == 1;
-        List<Exercise> submitExercises = info.getExercises(exerciseNames);
+        boolean isOnlyExercise = (exercises.size() == 1);
+        List<Exercise> submitExercises = exercises;
         List<List<FeedbackQuestion>> feedbackLists
                 = new ArrayList<>();
         List<String> exercisesWithFeedback = new ArrayList<>();

src/main/java/fi/helsinki/cs/tmc/cli/io/WorkDir.java

@@ -67,8 +67,8 @@ public Path getConfigFile() {
         }
     }
 
-    public List<String> getExerciseNames() {
-        return getExerciseNames(true, false);
+    public List<Exercise> getExercises() {
+        return getExercises(true, false);
     }
 
     /**
@@ -77,55 +77,43 @@ public List<String> getExerciseNames() {
      * @param onlyTested Return only exercises that are already tested
      * @return: return names of exercises as List
      */
-    public List<String> getExerciseNames(
-            boolean exists, boolean onlyTested) {
+    public List<Exercise> getExercises(boolean exists, boolean onlyTested) {
         if (this.directories.isEmpty() && getConfigFile() == null) {
             return new ArrayList<>();
         }
+        if (this.directories.isEmpty()) {
+            addPath(workdir);
+        }
         /*TODO somehow use the ctx.getCourseInfo */
         CourseInfo courseinfo = CourseInfoIo.load(getConfigFile());
         if (courseinfo == null) {
             return new ArrayList<>();
         }
-        List<Exercise> allExercises = courseinfo.getExercises();
-        List<Exercise> exercises = new ArrayList<>();
-        List<String> filteredExerciseNames = new ArrayList<>();
-        List<String> locallyTested = courseinfo.getLocalCompletedExercises();
-
-        // Conditions for adding all exercises:
-        //   course dir given as parameter
-        //   working dir is course dir and no parameters
-        if (directories.contains(getCourseDirectory())
-                || (getCourseDirectory().equals(workdir) && directories.size() == 0)) {
-            exercises.addAll(allExercises);
-        } else if (workdir.startsWith(getCourseDirectory())
-                && !workdir.equals(getCourseDirectory())) {
-            // if workdir is an exercise directory, add it to directories
-            directories.add(workdir);
-        } else if (getCourseDirectory() == null) {
+        if (getCourseDirectory() == null) {
             // if we still don't have a course directory, return an empty list
             return new ArrayList<>();
         }
 
+        List<Exercise> allExercises = courseinfo.getExercises();
+        List<Exercise> exercises = new ArrayList<>();
+        List<String> locallyTested = courseinfo.getLocalCompletedExercises();
+
         for (Path dir : directories) {
             // convert path to a string relative to the course dir
             String exDir = getCourseDirectory().relativize(dir).toString();
+            exDir = exDir.replace(File.separator, "-");
+
             for (Exercise exercise : allExercises) {
-                if ((exercise.getName().startsWith(exDir.replace(File.separator, "-"))
-                        || exDir.replace(File.separator, "-").startsWith(exercise.getName()))
-                        && !exercises.contains(exercise)) {
-                    exercises.add(exercise);
+                if ((exercise.getName().startsWith(exDir)
+                        || exDir.startsWith(exercise.getName()))) {
+                    if (filterExercise(exercise, locallyTested, exists, onlyTested)) {
+                        exercises.add(exercise);
+                    }
                 }
             }
         }
 
-        for (Exercise exercise : exercises) {
-            if (filterExercise(exercise, locallyTested, exists, onlyTested)) {
-                filteredExerciseNames.add(exercise.getName());
-            }
-        }
-
-        return filteredExerciseNames;
+        return exercises;
     }
 
     private boolean filterExercise(Exercise exercise, List<String> tested,
@@ -172,32 +160,19 @@ public boolean addPath(Path path) {
             if (this.courseDirectory != null) {
                 this.configFile = this.courseDirectory.resolve(CourseInfoIo.COURSE_CONFIG);
                 return true;
-            } else {
-                return false;
             }
+            return false;
         }
         if (!this.directories.contains(path)) {
             this.directories.add(path);
         }
-        if (path.startsWith(this.courseDirectory)) {
-            return true;
-        }
-        return false;
+        return path.startsWith(this.courseDirectory);
     }
 
     public boolean addPath(String path) {
         return addPath(Paths.get(path));
     }
 
-    /**
-     * Same as addPath(Path path), but adds the current working directory.
-     * Note that workdir should ONLY be overridden in tests
-     * Actually this is kind of useless. Remove if it remains unused.
-     */
-    public boolean addPath() {
-        return addPath(workdir);
-    }
-
     public int directoryCount() {
         return this.directories.size();
     }

src/test/java/fi/helsinki/cs/tmc/cli/command/PasteCommandTest.java

@@ -47,7 +47,7 @@ public class PasteCommandTest {
     private TestIo io;
     private TmcCore mockCore;
     private WorkDir workDir;
-    private ArrayList<String> exerciseNames;
+    private ArrayList<Exercise> exercises;
     private Exercise exercise;
 
     private final URI pasteUri;
@@ -64,10 +64,10 @@ public void setup() throws URISyntaxException {
         workDir = mock(WorkDir.class);
         when(workDir.getCourseDirectory()).thenReturn(tempDir);
         when(workDir.getConfigFile()).thenReturn((tempDir.resolve(CourseInfoIo.COURSE_CONFIG)));
-        exerciseNames = new ArrayList<>();
-        exerciseNames.add("paste-exercise");
-        when(workDir.getExerciseNames()).thenReturn(exerciseNames);
-        when(workDir.addPath()).thenReturn(true);
+        exercise = new Exercise("paste-exercise");
+        exercises = new ArrayList<>();
+        exercises.add(exercise);
+        when(workDir.getExercises()).thenReturn(exercises);
         when(workDir.addPath(anyString())).thenReturn(true);
 
         mockCore = mock(TmcCore.class);
@@ -76,7 +76,6 @@ public void setup() throws URISyntaxException {
         app = new Application(ctx);
 
         CourseInfo mockCourseInfo = mock(CourseInfo.class);
-        exercise = new Exercise("paste-exercise");
         when(mockCourseInfo.getExercise("paste-exercise")).thenReturn(exercise);
 
         mockStatic(TmcUtil.class);
@@ -208,8 +207,7 @@ public void handlesExceptionWhenCallableFails() {
 
     @Test
     public void failsWithNoExercise() {
-        Mockito.when(workDir.getExerciseNames()).thenReturn(new ArrayList<String>());
-        Mockito.when(workDir.addPath()).thenReturn(false);
+        Mockito.when(workDir.getExercises()).thenReturn(new ArrayList<Exercise>());
         Mockito.when(workDir.addPath(anyString())).thenReturn(false);
         app.run(new String[] {"paste", "-m", "This is a message given as an argument"});
 

src/test/java/fi/helsinki/cs/tmc/cli/command/RunTestsCommandTest.java

@@ -100,7 +100,7 @@ public void givesAnErrorMessageIfNotInCourseDirectory() {
         workDir.setWorkdir(Paths.get(System.getProperty("java.io.tmpdir")));
         String[] args = {"test"};
         app.run(args);
-        io.assertContains("You have to be in a course directory");
+        io.assertContains("No exercises specified");
     }
 
     @Test