Merge branch 'master' of github.com:tmc-cli/tmc-cli into update-dont-dl-completed-juha

Author: juvester

HACKING.md

@@ -31,3 +31,6 @@ public class ExampleCommand extends AbstractCommand {
 
 ## Architecture
 ...
+
+## Debugging
+### Logging

README.md

@@ -46,9 +46,9 @@ Now that you've installed tmc-cli, you can view all available commands by runnin
 Once installation is complete, you can log in using `tmc login`. This saves your TMC login information to a configuration file in ~/.config/tmc-cli/ (or %LOCALAPPDATA% on Windows) - you will only have to log in once.
 ```
 ~ $ tmc login
-username: my-username
-password:
 server address:
+username:
+password:
 Login successful.
 ```
 

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>fi.helsinki.cs.tmc.cli</groupId>
     <artifactId>tmc-cli</artifactId>
-    <version>0.5.2</version>
+    <version>0.6.0</version>
     <packaging>jar</packaging>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

src/main/java/fi/helsinki/cs/tmc/cli/Application.java

@@ -246,6 +246,10 @@ public void setWorkdir(WorkDir workDir) {
         this.workDir = workDir;
     }
 
+    public void setTmcProjectDirectory(Path path) {
+        this.settings.setTmcProjectDirectory(path);
+    }
+
     public HashMap<String, String> getProperties() {
         // Loads properties from the global configuration file in .config/tmc-cli/
         return this.properties;

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

@@ -1,7 +1,12 @@
 package fi.helsinki.cs.tmc.cli.command;
 
+import static fi.helsinki.cs.tmc.cli.io.Color.AnsiColor.ANSI_BLUE;
+import static fi.helsinki.cs.tmc.cli.io.Color.AnsiColor.ANSI_GREEN;
+import static fi.helsinki.cs.tmc.cli.io.Color.AnsiColor.ANSI_RED;
+
 import fi.helsinki.cs.tmc.cli.command.core.AbstractCommand;
 import fi.helsinki.cs.tmc.cli.command.core.Command;
+import fi.helsinki.cs.tmc.cli.io.Color;
 import fi.helsinki.cs.tmc.cli.io.Io;
 import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfo;
 import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfoIo;
@@ -53,13 +58,13 @@ public void run(CommandLine args, Io io) {
             if (workDir.getExerciseNames().size() == 1 && stringArgs.length == 0) {
                 String currentExercise = workDir.getExerciseNames().get(0);
                 exercise = info.getExercise(currentExercise);
-                printExerciseDetails();
+                printOneExercise(args.hasOption("a"));
                 return;
 
             } else if (stringArgs.length != 0) {
                 if (info.getExercise(stringArgs[0]) != null) {
                     exercise = info.getExercise(stringArgs[0]);
-                    printExerciseDetails();
+                    printOneExercise(args.hasOption("a"));
                     return;
 
                 } else {
@@ -109,11 +114,32 @@ private void printCourseDetails() {
         io.println("CometUrl: " + course.getCometUrl());
     }
 
-    private void printExerciseDetails() {
-        io.println(exercise.getName());
-        io.println("Completed: " + exercise.isCompleted());
-        io.println("Attempted: " + exercise.isAttempted());
-        io.println("Deadline: " + exercise.getDeadline());
+    private void printOneExercise(boolean showAll) {
+        if (showAll) {
+            printExercise(exercise);
+        } else {
+            printExerciseShort();
+        }
+    }
+
+    private void printExerciseShort() {
+        io.println("Exercise: " + exercise.getName());
+        io.println("Deadline: " + getDeadline(exercise));
+        io.println(formatString("completed", exercise.isCompleted()));
+        if (!exercise.isCompleted() && exercise.isAttempted()) {
+            io.println(Color.colorString("attempted", ANSI_BLUE));
+        }
+        if (exercise.requiresReview()) {
+            io.println(formatString("reviewed", exercise.isReviewed()));
+        }
+    }
+
+    private String formatString(String string, boolean color) {
+        if (color) {
+            return Color.colorString(string, ANSI_GREEN);
+        } else {
+            return Color.colorString("not " + string, ANSI_RED);
+        }
     }
 
     private void printExercises(boolean showAll) {
@@ -169,4 +195,13 @@ private void printExercise(Exercise exercise) {
         io.println("    Checksum: " + exercise.getChecksum());
         io.println("");
     }
+
+    private String getDeadline(Exercise exercise) {
+        String deadline = exercise.getDeadline();
+        if (deadline == null) {
+            return "not available";
+        }
+        deadline = deadline.substring(0, 19);
+        return deadline.replace("T", " at ");
+    }
 }

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

@@ -36,10 +36,10 @@ public void getOptions(Options options) {
     @Override
     public void run(CommandLine args, Io io) {
         this.io = io;
+        String serverAddress = getLoginInfo(args, "s", "server address: ");
         String username = getLoginInfo(args, "u", "username: ");
         String password = getLoginInfo(args, "p", "password: ");
-        String serverAddress = getLoginInfo(args, "s", "server address: ");
-
+        
         Settings settings = new Settings(serverAddress, username, password);
         if (loginPossible(settings) && saveLoginSettings(settings)) {
             io.println("Login successful.");

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

@@ -1,12 +1,15 @@
 package fi.helsinki.cs.tmc.cli.command;
 
+import static fi.helsinki.cs.tmc.langs.domain.RunResult.Status.PASSED;
+
 import fi.helsinki.cs.tmc.cli.Application;
 import fi.helsinki.cs.tmc.cli.command.core.AbstractCommand;
 import fi.helsinki.cs.tmc.cli.command.core.Command;
 import fi.helsinki.cs.tmc.cli.io.Color;
 import fi.helsinki.cs.tmc.cli.io.Io;
 import fi.helsinki.cs.tmc.cli.io.ResultPrinter;
 import fi.helsinki.cs.tmc.cli.io.TmcCliProgressObserver;
+import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfo;
 import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfoIo;
 import fi.helsinki.cs.tmc.cli.tmcstuff.Settings;
 import fi.helsinki.cs.tmc.cli.tmcstuff.WorkDir;
@@ -25,6 +28,7 @@
 import java.nio.file.Path;
 import java.util.List;
 
+
 @Command(name = "test", desc = "Run local exercise tests")
 public class RunTestsCommand extends AbstractCommand {
 
@@ -58,13 +62,13 @@ public void run(CommandLine args, Io io) {
                 return;
             }
         }
-        String courseName = getCourseName(workDir);
         List<String> exerciseNames = workDir.getExerciseNames();
 
         if (exerciseNames.isEmpty()) {
             io.println("You have to be in a course directory to run tests");
             return;
         }
+        CourseInfo info = CourseInfoIo.load(workDir.getConfigFile());
 
         // Local tests don't require login so make sure tmcCore is never null.
         app.createTmcCore(new Settings());
@@ -90,16 +94,30 @@ public void run(CommandLine args, Io io) {
 
                 io.println(Color.colorString("Testing: " + name, Color.AnsiColor.ANSI_YELLOW));
                 //name = name.replace("-", File.separator);
-                Exercise exercise = new Exercise(name, courseName);
+                Exercise exercise = info.getExercise(name);
+//                Exercise exercise = new Exercise(name, courseName);
 
                 // TmcCliProgressObserver progobs = new TmcCliProgressObserver(io);
                 runResult = core.runTests(ProgressObserver.NULL_OBSERVER, exercise).call();
                 // progobs.end(0);
 
-                resultPrinter.printRunResult(runResult, isOnlyExercise, color1, color2);
+                resultPrinter.printRunResult(runResult, exercise.isCompleted(),
+                        isOnlyExercise, color1, color2);
                 total += runResult.testResults.size();
                 passed += ResultPrinter.passedTests(runResult.testResults);
+                exercise.setAttempted(true);
+                if (runResult.status == PASSED && !exercise.isCompleted()) {
+                    // add exercise to locally tested exercises
+                    if (!info.getLocalCompletedExercises().contains(exercise.getName())) {
+                        info.getLocalCompletedExercises().add(exercise.getName());
+                    }
+                } else {
+                    if (info.getLocalCompletedExercises().contains(exercise.getName())) {
+                        info.getLocalCompletedExercises().remove(exercise.getName());
+                    }
+                }
             }
+            CourseInfoIo.save(info, workDir.getConfigFile());
             if (total > 0 && !isOnlyExercise) {
                 // Print a progress bar showing how the ratio of passed exercises
                 // But only if more than one exercise was tested
@@ -115,15 +133,6 @@ public void run(CommandLine args, Io io) {
         }
     }
 
-    private String getCourseName(WorkDir dirUtil) {
-        Path courseDir = dirUtil.getCourseDirectory();
-        try {
-            return courseDir.getName(courseDir.getNameCount() - 1).toString();
-        } catch (Exception e) {
-        }
-        return null;
-    }
-
     private String[] parseArgs(CommandLine args) {
         this.showPassed = args.hasOption("a");
         this.showDetails = args.hasOption("d");

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

@@ -1,5 +1,7 @@
 package fi.helsinki.cs.tmc.cli.command;
 
+import static fi.helsinki.cs.tmc.core.domain.submission.SubmissionResult.TestResultStatus.NONE_FAILED;
+
 import fi.helsinki.cs.tmc.cli.Application;
 import fi.helsinki.cs.tmc.cli.command.core.AbstractCommand;
 import fi.helsinki.cs.tmc.cli.command.core.Command;
@@ -38,6 +40,8 @@ public class SubmitCommand extends AbstractCommand {
     public void getOptions(Options options) {
         options.addOption("a", "all", false, "Show all test results");
         options.addOption("d", "details", false, "Show detailed error message");
+        options.addOption("c", "completed", false,
+                "Filter out exercises that haven't been locally tested");
     }
 
     @Override
@@ -58,14 +62,25 @@ public void run(CommandLine args, Io io) {
         WorkDir workDir = app.getWorkDir();
         for (String exercise : exercisesFromArgs) {
             if (!workDir.addPath(exercise)) {
-                io.println("Error: '" + exercise + "' is not a valid exercise.");
+                io.println("Error: " + exercise + " is not a valid exercise.");
                 return;
             }
         }
 
-        List<String> exerciseNames = workDir.getExerciseNames();
+        List<String> exerciseNames;
+        if (args.hasOption("c")) {
+            workDir.addPath(workDir.getCourseDirectory());
+            exerciseNames = workDir.getExerciseNames(true, true, false);
+        } else {
+            exerciseNames = workDir.getExerciseNames();
+        }
+
         if (exerciseNames.isEmpty()) {
-            io.println("You have to be in a course directory to submit");
+            if (args.hasOption("c") && workDir.getCourseDirectory() != null) {
+                io.println("No locally tested exercises.");
+                return;
+            }
+            io.println("No exercises specified.");
             return;
         }
 
@@ -95,8 +110,17 @@ public void run(CommandLine args, Io io) {
                 resultPrinter.printSubmissionResult(result, isOnlyExercise, color1, color2);
                 total += result.getTestCases().size();
                 passed += ResultPrinter.passedTests(result.getTestCases());
+
+                exercise.setAttempted(true);
+                if (result.getTestResultStatus() == NONE_FAILED) {
+                    if (info.getLocalCompletedExercises().contains(exercise.getName())) {
+                        info.getLocalCompletedExercises().remove(exercise.getName());
+                    }
+                    exercise.setCompleted(true);
+                }
             }
         }
+        CourseInfoIo.save(info, workDir.getConfigFile());
         if (total > 0 && !isOnlyExercise) {
             // Print a progress bar showing how the ratio of passed exercises
             io.println("");

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

@@ -2,6 +2,7 @@
 
 import fi.helsinki.cs.tmc.cli.command.core.AbstractCommand;
 import fi.helsinki.cs.tmc.cli.command.core.Command;
+import fi.helsinki.cs.tmc.cli.io.Color;
 import fi.helsinki.cs.tmc.cli.io.Io;
 import fi.helsinki.cs.tmc.cli.io.TmcCliProgressObserver;
 import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfo;
@@ -65,8 +66,10 @@ public void updateExercises(TmcCore core, CourseInfo info, Path configFile) {
         printExercises(exerciseUpdater.getUpdatedExercises(), "Modified exercises:");
         io.println("");
 
+        Color.AnsiColor color1 = getApp().getColor("progressbar-left");
+        Color.AnsiColor color2 = getApp().getColor("progressbar-right");
         List<Exercise> downloaded = exerciseUpdater.downloadUpdates(
-                new TmcCliProgressObserver(io));
+                new TmcCliProgressObserver(io, color1, color2));
         if (downloaded.isEmpty()) {
             io.println("Failed to download exercises");
             return;

src/main/java/fi/helsinki/cs/tmc/cli/command/core/CommandAnnotationProcessor.java

@@ -30,38 +30,32 @@ public class CommandAnnotationProcessor extends AbstractProcessor {
     private static final Logger logger = LoggerFactory.getLogger(CommandAnnotationProcessor.class);
 
     private static final String CLASS_NAME = "CommandList";
-    private static final String PACKAGE_NAME = "fi.helsinki.cs.tmc.cli.command";
+    private static final String PACKAGE_NAME = "fi.helsinki.cs.tmc.cli.command.core";
     private static final String TAB = "    ";
 
-    private ProcessingEnvironment processingEnv;
-
-    @Override
-    public void init(ProcessingEnvironment processingEnv) {
-        this.processingEnv = processingEnv;
-    }
-
     private void generateSourceFile(Map<String, String> map) throws IOException {
         JavaFileObject jfo = processingEnv.getFiler().createSourceFile(
-                PACKAGE_NAME + ".core." + CLASS_NAME);
+                PACKAGE_NAME + "." + CLASS_NAME);
 
         try (Writer writer = jfo.openWriter()) {
             BufferedWriter bwriter = new BufferedWriter(writer);
-            bwriter.append("package ");
-            bwriter.append(PACKAGE_NAME);
-            bwriter.append(".core;\n\n");
+            bwriter.append("package " + PACKAGE_NAME + ";\n\n");
+
+            // import the command classes
             bwriter.append("//CHECKSTYLE:OFF\n");
-            bwriter.append("import " + PACKAGE_NAME + ".core.CommandFactory;\n\n");
             for (Entry<String, String> entry : map.entrySet()) {
                 bwriter.append("import " + entry.getValue() + ";\n");
             }
             bwriter.append("//CHECKSTYLE:ON\n");
+
             bwriter.append("\npublic class " + CLASS_NAME + " {\n");
             bwriter.append(TAB + "static {\n");
             for (Entry<String, String> entry : map.entrySet()) {
                 String[] parts = entry.getValue().split("\\.");
                 if (parts.length == 0) {
                     continue;
                 }
+                // print out the lines that add the commands to the command factory.
                 String className = parts[parts.length - 1];
                 bwriter.append(TAB + TAB + "CommandFactory.addCommand(\""
                         + entry.getKey() + "\", "
@@ -76,15 +70,15 @@ private void generateSourceFile(Map<String, String> map) throws IOException {
     @Override
     public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
         Map<String, String> map = new HashMap<>();
-        Messager messager = processingEnv.getMessager();
 
         for (Element elem : roundEnv.getElementsAnnotatedWith(Command.class)) {
             if (elem.getKind() != ElementKind.CLASS) {
-                continue;
+                logger.warn("Element with command annotation is not class: " + elem.toString());
+                return false;
             }
             Command command = elem.getAnnotation(Command.class);
-            messager.printMessage(Diagnostic.Kind.NOTE, elem.toString());
-            messager.printMessage(Diagnostic.Kind.NOTE, elem.getClass().getCanonicalName());
+            logger.info("element with annotation: " + elem.toString());
+            logger.info("element name with annotation: " + elem.getClass().getCanonicalName());
 
             TypeElement classElement = (TypeElement) elem;
             map.put(command.name(), processingEnv.getElementUtils()
@@ -94,7 +88,7 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
         try {
             generateSourceFile(map);
         } catch (IOException ex) {
-            messager.printMessage(Diagnostic.Kind.NOTE, "Failed to create source file." + ex);
+            logger.warn("Failed to create source file." + ex);
         }
         return true;
     }