Merge branch 'master' into feedback-jclc

Author: jclc

HACKING.md

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

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

@@ -26,69 +26,94 @@
 public class CourseInfoCommand extends AbstractCommand {
     private Course course;
     private Exercise exercise;
+    private CourseInfo info;
+    private WorkDir workDir;
     private Io io;
 
     @Override
     public void getOptions(Options options) {
-        options.addOption("a", false, "Show all info for a specific course");
+        options.addOption("a", false, "Show all information for a specific course");
+        options.addOption("i", false, "Get the information from the server");
     }
 
     @Override
     public void run(CommandLine args, Io io) {
         this.io = io;
-        TmcCore core = getApp().getTmcCore();
-        if (core == null) {
+        workDir = getApp().getWorkDir();
+
+        if (!args.hasOption("i")) {
+            printLocalCourseOrExercise(args);
             return;
         }
 
-        WorkDir workDir = getApp().getWorkDir();
         String[] stringArgs = args.getArgs();
-        if (stringArgs.length == 0 && workDir.getConfigFile() == null) {
-            io.println("You must give the course name as a parameter.");
+        if (stringArgs.length == 0) {
+            io.println("You must give a course as a parameter.");
             return;
         }
 
-        // if in course directory
+        TmcCore core = getApp().getTmcCore();
+        if (core == null) {
+            return;
+        }
+        course = TmcUtil.findCourse(core, stringArgs[0]);
+        if (course == null) {
+            io.println("The course " + stringArgs[0] + " doesn't exist on this server.");
+            return;
+        }
+        printCourse(args.hasOption("a"));
+    }
+
+    private void printLocalCourseOrExercise(CommandLine args) {
         if (workDir.getConfigFile() != null) {
-            CourseInfo info = CourseInfoIo.load(workDir.getConfigFile());
+            info = CourseInfoIo.load(workDir.getConfigFile());
             course = info.getCourse();
+            printCourseOrExercise(args);
+        } else {
+            this.io.println("You have to be in a course directory"
+                    + " or use the -i option with the course name "
+                    + "to get the information from the server.");
+        }
+    }
 
-            // if in exercise directory and no parameters given, print info for that exercise.
-            // else if exercise or course name given as a parameter, check which one it is and print info for that
-            if (workDir.getExerciseNames().size() == 1 && stringArgs.length == 0) {
-                String currentExercise = workDir.getExerciseNames().get(0);
-                exercise = info.getExercise(currentExercise);
-                printOneExercise(args.hasOption("a"));
-                return;
-
-            } else if (stringArgs.length != 0) {
-                if (info.getExercise(stringArgs[0]) != null) {
-                    exercise = info.getExercise(stringArgs[0]);
-                    printOneExercise(args.hasOption("a"));
-                    return;
-
-                } else {
-                    course = TmcUtil.findCourse(core, stringArgs[0]);
-                    if (course != null) {
-                        printCourse(args.hasOption("a"));
-                    } else {
-                        io.println("No such course or exercise.");
-                    }
-                    return;
-                }
-            }
-            printCourse(args.hasOption("a"));
+    private void printCourseOrExercise(CommandLine args) {
+        String[] stringArgs = args.getArgs();
+
+        // if in exercise directory and no parameters given, print info for that exercise.
+        if (workDir.getExerciseNames().size() == 1 && stringArgs.length == 0) {
+            String currentExercise = workDir.getExerciseNames().get(0);
+            exercise = info.getExercise(currentExercise);
+            printOneExercise(args.hasOption("a"));
             return;
         }
 
-        course = TmcUtil.findCourse(core, stringArgs[0]);
-        if (course == null) {
-            io.println("The course " + stringArgs[0] + " doesn't exist on this server.");
+        if (stringArgs.length != 0) {
+            printCourseOrExerciseFromParameters(args);
             return;
         }
         printCourse(args.hasOption("a"));
     }
 
+    private void printCourseOrExerciseFromParameters(CommandLine args) {
+        String[] stringArgs = args.getArgs();
+        // if parameter is given, check if it is an exercise or a course. If neither, print an error message.
+        if (info.getExercise(stringArgs[0]) != null) {
+            exercise = info.getExercise(stringArgs[0]);
+            printOneExercise(args.hasOption("a"));
+            return;
+
+        }
+        course = info.getCourse();
+        if (course != null && course.getName().equals(stringArgs[0])) {
+            printCourse(args.hasOption("a"));
+        } else {
+            this.io.println("Wrong course directory."
+                    + " Navigate to the correct course directory or"
+                    + " use the -i option with the course name"
+                    + " to get the information from the server.");
+        }
+    }
+
     private void printCourse(boolean showAll) {
         printCourseShort();
         if (showAll) {

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;
     }

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

@@ -5,16 +5,16 @@
 import fi.helsinki.cs.tmc.langs.domain.SpecialLogs;
 import fi.helsinki.cs.tmc.langs.domain.TestResult;
 
+import java.util.Arrays;
 import java.util.List;
 
 public class ResultPrinter {
 
     private static final String COMPILE_ERROR_MESSAGE
             = Color.colorString("Failed to compile project", Color.AnsiColor.ANSI_PURPLE);
-    private static final String FAIL = Color.colorString("Failed: ", Color.AnsiColor.ANSI_RED);
-    private static final String PASS = Color.colorString("Passed: ", Color.AnsiColor.ANSI_GREEN);
-    private static final String TAB = "        ";
-    private static final char LF = '\n';
+    private static final String FAIL_MESSAGE = "Failed: ";
+    private static final String PASS_MESSAGE = "Passed: ";
+    private final String tab;
 
     private final Io io;
 
@@ -27,6 +27,8 @@ public ResultPrinter(Io io, boolean showDetails, boolean showPassed) {
         this.io = io;
         this.showDetails = showDetails;
         this.showPassed = showPassed;
+
+        this.tab = createPaddingString(PASS_MESSAGE.length());
     }
 
     public boolean isShowDetails() {
@@ -155,9 +157,9 @@ public static int passedTests(List<TestResult> testResults) {
     private void printTestResults(List<TestResult> testResults) {
         for (TestResult testResult : testResults) {
             if (!testResult.isSuccessful()) {
-                io.println(createFailMessage(testResult));
+                printFailMessage(testResult);
             } else if (showPassed) {
-                io.println(createPassMessage(testResult));
+                printPassMessage(testResult);
             }
         }
         io.println("Test results: "
@@ -166,37 +168,45 @@ private void printTestResults(List<TestResult> testResults) {
 
     }
 
-    private String createFailMessage(TestResult testResult) {
-        StringBuilder sb = new StringBuilder();
-        sb.append(FAIL).append(testResult.getName()).append(LF);
-        sb.append(TAB).append(testResult.getMessage()).append(LF);
+    private void printFailMessage(TestResult testResult) {
+        io.print(Color.colorString(FAIL_MESSAGE, Color.AnsiColor.ANSI_RED));
+        io.println(testResult.getName());
+        io.println(this.tab + testResult.getMessage());
 
         if (showDetails) {
-            String details = listToString(testResult.getDetailedMessage(), LF);
+            String details = listToString(testResult.getDetailedMessage());
             if (details != null) {
-                sb.append(LF).append("Detailed message:").append(LF).append(details);
+                io.println("\nDetailed message:");
+                io.println(details);
             }
-            String exception = listToString(testResult.getException(), LF);
+
+            String exception = listToString(testResult.getException());
             if (exception != null) {
-                sb.append(LF).append("Exception:").append(LF).append(exception);
+                io.println("\nException:");
+                io.println(exception);
             }
         }
-        return sb.toString();
     }
 
-    private String createPassMessage(TestResult testResult) {
-        return PASS + testResult.getName() + LF;
+    private void printPassMessage(TestResult testResult) {
+        io.print(Color.colorString(PASS_MESSAGE, Color.AnsiColor.ANSI_GREEN));
+        io.println(testResult.getName());
     }
 
-    private String listToString(List<String> strings, char separator) {
+    private String listToString(List<String> strings) {
         if (strings == null || strings.isEmpty()) {
             return null;
         }
         StringBuilder sb = new StringBuilder();
         for (String string : strings) {
-            sb.append(string).append(separator);
+            sb.append(string).append("\n");
         }
         return sb.toString();
     }
 
-}
+    private String createPaddingString(int size) {
+        char[] charArray = new char[size];
+        Arrays.fill(charArray, ' ');
+        return new String(charArray);
+    }
+}