Merge pull request #327 from tmc-cli/feedback-jclc

feedback submission

Author: jclc

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

@@ -12,8 +12,6 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.Iterator;
-import java.util.List;
 
 @Command(name = "prop", desc = "Set/unset TMC-CLI properties")
 public class PropertiesCommand extends AbstractCommand {

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

@@ -12,19 +12,23 @@
 import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfo;
 import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfoIo;
 import fi.helsinki.cs.tmc.cli.tmcstuff.ExerciseUpdater;
+import fi.helsinki.cs.tmc.cli.tmcstuff.FeedbackHandler;
 import fi.helsinki.cs.tmc.cli.tmcstuff.TmcUtil;
 import fi.helsinki.cs.tmc.cli.tmcstuff.WorkDir;
 import fi.helsinki.cs.tmc.core.TmcCore;
 import fi.helsinki.cs.tmc.core.domain.Course;
 import fi.helsinki.cs.tmc.core.domain.Exercise;
+import fi.helsinki.cs.tmc.core.domain.submission.FeedbackQuestion;
 import fi.helsinki.cs.tmc.core.domain.submission.SubmissionResult;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Options;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.net.URI;
 import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.List;
 
 @Command(name = "submit", desc = "Submit exercises")
@@ -99,6 +103,10 @@ public void run(CommandLine args, Io io) {
         Color.AnsiColor color2 = app.getColor("testresults-right");
 
         List<Exercise> submitExercises = info.getExercises(exerciseNames);
+        List<List<FeedbackQuestion>> feedbackLists
+                = new ArrayList<List<FeedbackQuestion>>();
+        List<String> exercisesWithFeedback = new ArrayList<String>();
+        List<URI> feedbackUris = new ArrayList<URI>();
 
         for (Exercise exercise : submitExercises) {
             io.println(Color.colorString("Submitting: " + exercise.getName(),
@@ -118,6 +126,12 @@ public void run(CommandLine args, Io io) {
                     }
                     exercise.setCompleted(true);
                 }
+                List<FeedbackQuestion> feedback = result.getFeedbackQuestions();
+                if (feedback != null && feedback.size() > 0) {
+                    feedbackLists.add(feedback);
+                    exercisesWithFeedback.add(exercise.getName());
+                    feedbackUris.add(URI.create(result.getFeedbackAnswerUrl()));
+                }
             }
         }
         CourseInfoIo.save(info, workDir.getConfigFile());
@@ -128,8 +142,22 @@ public void run(CommandLine args, Io io) {
             io.println(TmcCliProgressObserver.getPassedTestsBar(passed, total, color1, color2));
         }
 
+        io.println("Updating " + CourseInfoIo.COURSE_CONFIG);
         updateCourseJson(core, submitExercises, info, workDir.getConfigFile());
         checkForExerciseUpdates(core, currentCourse);
+        for (int i = 0; i < exercisesWithFeedback.size(); i++) {
+            if (io.readConfirmation(
+                    "Send feedback for " + exercisesWithFeedback.get(i) + "?", true)) {
+                FeedbackHandler fbh = new FeedbackHandler(io);
+                Boolean success = fbh.sendFeedback(
+                        core, feedbackLists.get(i), feedbackUris.get(i));
+                if (success) {
+                    io.println("Feedback sent.");
+                } else {
+                    io.println("Failed to send feedback.");
+                }
+            }
+        }
     }
 
     protected void updateCourseJson(TmcCore core, List<Exercise> submittedExercises,

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

@@ -85,7 +85,7 @@ public void printSubmissionResult(SubmissionResult result, Boolean printProgress
             io.println(TmcCliProgressObserver.getPassedTestsBar(passed, total, color1, color2));
         }
         String msg = null;
-        switch (result.getTestResultStatus()) {
+        switch (    result.getTestResultStatus()) {
             case NONE_FAILED:
                 msg = "All tests passed on server!";
                 msg = Color.colorString(msg, Color.AnsiColor.ANSI_GREEN)

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

@@ -41,9 +41,11 @@ public Boolean readConfirmation(String prompt, Boolean defaultToYes) {
             logger.warn("Line could not be read.", e);
             return null;
         }
-        if (input.equals("y")) {
+        if (input.isEmpty()) {
+            return defaultToYes;
+        } else if (input.charAt(0) == 'y') {
             return true;
-        } else if (input.equals("n")) {
+        } else if (input.charAt(0) == 'n') {
             return false;
         }
         return defaultToYes;

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

@@ -3,9 +3,6 @@
 import fi.helsinki.cs.tmc.cli.Application;
 import fi.helsinki.cs.tmc.core.domain.ProgressObserver;
 
-/**
- * Created by jclakkis on 27.5.2016.
- */
 public class TmcCliProgressObserver extends ProgressObserver {
     protected static final char PIPCHAR = '█';
     protected static final char EMPTYCHAR = '░';

src/main/java/fi/helsinki/cs/tmc/cli/tmcstuff/FeedbackHandler.java

@@ -0,0 +1,74 @@
+package fi.helsinki.cs.tmc.cli.tmcstuff;
+
+import fi.helsinki.cs.tmc.cli.io.ExternalsUtil;
+import fi.helsinki.cs.tmc.cli.io.Io;
+import fi.helsinki.cs.tmc.cli.io.TmcCliProgressObserver;
+import fi.helsinki.cs.tmc.core.TmcCore;
+import fi.helsinki.cs.tmc.core.domain.submission.FeedbackAnswer;
+import fi.helsinki.cs.tmc.core.domain.submission.FeedbackQuestion;
+
+import org.apache.commons.lang3.text.WordUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.List;
+
+public class FeedbackHandler {
+    private List<FeedbackQuestion> questions;
+    private Io io;
+    private static final Logger logger = LoggerFactory.getLogger(FeedbackHandler.class);
+
+    public FeedbackHandler(Io io) {
+        this.io = io;
+    }
+
+    public Boolean sendFeedback(TmcCore core, List<FeedbackQuestion> questions,
+                             URI feedbackUri) {
+        this.questions = questions;
+        List<FeedbackAnswer> answers = new ArrayList<>();
+
+        for (FeedbackQuestion question : questions) {
+            answers.add(getAnswer(question));
+        }
+        try {
+            Boolean call = core.sendFeedback(
+                    new TmcCliProgressObserver(io), answers, feedbackUri).call();
+            return call;
+        } catch (Exception e) {
+            logger.error("Couldn't send feedback", e);
+        }
+        return false;
+    }
+
+    private FeedbackAnswer getAnswer(FeedbackQuestion question) {
+        if (question.isText()) {
+            String wrappedQuestion =
+                    "\n# " + WordUtils.wrap("Feedback question: "
+                            + question.getQuestion(), 77, "\n# ", true)
+                    + "\n#\n# Write your feedback in this file and save it."
+                    + "\n# Lines beginning with # are comments and will be ignored.";
+            String answer = ExternalsUtil.getUserEditedMessage(wrappedQuestion,
+                    "tmc-feedback", true);
+            return new FeedbackAnswer(question, answer);
+        } else if (question.isIntRange()) {
+            io.println("Feedback question: " + question.getQuestion());
+            int answer = Integer.MIN_VALUE;
+            while (!(question.getIntRangeMin() <= answer && question.getIntRangeMax() >= answer)) {
+                try {
+                    answer = Integer.parseInt(io.readLine(
+                            "[" + question.getIntRangeMin()
+                            + "-" + question.getIntRangeMax() + "] "));
+                } catch (Exception e) {
+                    logger.warn("Couldn't parse string as integer", e);
+                }
+            }
+            return new FeedbackAnswer(question, Integer.toString(answer));
+        } else {
+            io.println("Feedback question: " + question.getQuestion());
+            String answer = io.readLine("Answer: ");
+            return new FeedbackAnswer(question, answer);
+        }
+    }
+}

src/test/java/fi/helsinki/cs/tmc/cli/tmcstuff/FeedbackHandlerTest.java

@@ -0,0 +1,13 @@
+package fi.helsinki.cs.tmc.cli.tmcstuff;
+
+import fi.helsinki.cs.tmc.cli.io.ExternalsUtil;
+
+import org.junit.runner.RunWith;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
+
+@RunWith(PowerMockRunner.class)
+@PrepareForTest(ExternalsUtil.class)
+public class FeedbackHandlerTest {
+
+}