Merge pull request #376 from tmc-cli/external-util-tests-aleksi

External util tests

Author: jclc

docs/HACKING.md

@@ -20,6 +20,9 @@ Conceptually, there are three main parts in the program; the launch code, backen
 
 Tmc-cli itself is mostly just an command line interface for the backend libraries. All the heavy lifting is done by [tmc-core](https://github.com/testmycode/tmc-core) and [tmc-langs](https://github.com/testmycode/tmc-langs) libraries. Tmc-cli also requires the server-side component of TestMyCode aka. [tmc-server](https://github.com/testmycode/tmc-server).
 
+### Methods involved in program start up
+![Launch graph](https://rawgit.com/tmc-cli/tmc-cli/master/startup_control_flow.svg)
+
 ### Important classes
 
 The `CliContext` object contains some cached data and singleton objects that are commonly used by utility classes and commands. Most importantly, it has the `Io` object which handles all user interaction via terminal. Never print anything using System.out.print(), since tests use the `TestIo` class which is dependent on the `Io` interface.

scripts/autocompletion.sh

@@ -10,8 +10,6 @@ _tmc_opts()
 	local cur
 	local sub_command
 	local main_args
-	# Pointer to current completion word.
-	# By convention, it's named "cur" but this isn't strictly necessary.
 
 	COMPREPLY=()
 	cur="\${COMP_WORDS[COMP_CWORD]}"

scripts/stub.sh

@@ -2,9 +2,13 @@
 
 set -euo pipefail
 
+## Embeded binary magic
+
 MYSELF=$(which "$0" 2>/dev/null)
 [ $? -gt 0 ] && [ -f "$0" ] && MYSELF="./$0"
 
+## Find the java binary and correct version
+
 JAVA_BIN=java
 JAVA_HOME=${JAVA_HOME-}
 if [ -n "$JAVA_HOME" ]; then
@@ -22,21 +26,7 @@ if [ "$JAVA_VERSION" \< "1.7" ]; then
     exit 1
 fi
 
-AUTOCOMPLETE="$HOME/.tmc-autocomplete.sh"
-
-# this is used in autocompletion file
-SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-
-tmc_update_autocomplete() {
-	cat > "$AUTOCOMPLETE" <<- EOM
-TMC_AUTOCOMPLETE_SH
-EOM
-	chmod +x "$AUTOCOMPLETE"
-}
-
-tmc_update() {
-	tmc_update_autocomplete
-}
+## find the place for running the autocomplete/alias file
 
 tmc_detect_profile() {
 	local PROFILE_ENV
@@ -89,58 +79,104 @@ tmc_detect_profile() {
 	fi
 }
 
-if [ ! -f "$AUTOCOMPLETE" ]; then
-	tmc_update_autocomplete
+## Bash autocompletion script extraction
+
+# This is used in autocompletion file
+SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+tmc_autocomplete_file() {
+	echo "${TMC_AUTOCOMPLETE_FILE-$HOME/.tmc-autocomplete.sh}"
+}
+
+## Create the alias and autocompletion code if tmc alias not set
+tmc_update_autocomplete() {
+	local AUTOCOMPLETE_FILE
+	local PROFILE_FILE
+
+	AUTOCOMPLETE_FILE="$(tmc_autocomplete_file)"
+
+	cat > "$AUTOCOMPLETE_FILE" <<- EOM
+#EMBED_AUTOCOMPLETE_SH
+EOM
+	chmod +x "$AUTOCOMPLETE_FILE"
+
+	PROFILE_FILE=$(tmc_detect_profile)
+
+	# get the aliases
+	set +euo pipefail
+	source $PROFILE_FILE
+	set -euo pipefail
 
 	if type tmc &> /dev/null; then
-		# don't add new alias if it exists already
-		return
+		exit
 	fi
 
-	PROFILE_FILE=$(tmc_detect_profile)
 	if [ -z "$PROFILE_FILE" ]; then
-		echo "Profile file not found"
-		echo "Put the \"source $AUTOCOMPLETE\" line in somewhere where"
-		echo "it's run at terminal initialization."
+		echo "Profile file not found" >&2
+		echo "Put the \"source $AUTOCOMPLETE_FILE\" line in somewhere where" >&2
+		echo "it's run at terminal initialization." >&2
 	fi
-	echo "source $AUTOCOMPLETE" >> "$PROFILE_FILE"
-fi
+	echo "source $AUTOCOMPLETE_FILE" >> "$PROFILE_FILE"
 
-if [ "${1-}" == "++internal-update" ]; then
-	echo "Please report any error messages that may come up below."
+	echo "To use new autocompletion run the following on command line:" >&2
+	echo ". ~/.bashrc" >&2
+}
+
+## Auto update code
+
+##### If you MODIFY the install script then do the following:
+##### Enable the "THE INSTALL SCRIPT DEBUGGING LINE" at [Tmc]CliUpdater.java
+##### (It runs the dev script instead of the latest release script)
+##### And use the --force-update flag in application.
+
+tmc_update() {
+	tmc_update_autocomplete
+}
+
+tmc_install_update() {
+	echo "Please report any error messages that may come up below." >&2
 	if [ ! -f tmc.new ]; then
-		echo "Could not find the updated file."
+		echo "Could not find the updated file." >&2
 		exit 127
 	fi
 
-	echo "Moving the tmc files..."
-	if mv tmc tmc.orig; then
-		echo "Failed to backup the original tmc binary"
+	echo "Moving the tmc files..." >&2
+	if ! mv tmc tmc.orig; then
+		echo "Failed to backup the original tmc binary" >&2
 		exit 128
 	fi
-	if mv tmc.new tmc; then
-		echo "Failed to replace the original binary with new version"
-		echo "You can replace manually the $PWD/tmc with $PWD/tmc.new"
+	if ! mv tmc.new tmc; then
+		echo "Failed to replace the original binary with new version" >&2
+		echo "You can replace manually the $PWD/tmc with $PWD/tmc.new" >&2
 		exit 129
 	fi
 
 	rm tmc.orig &> /dev/null
-	echo "Running the new tmc update script..."
+	echo "Running the new tmc update script..." >&2
+	echo "" >&2
 	tmc_update
 
 	echo ""
 	if [ -f tmc ]; then
-		echo "Tmc cli installation was successful"
-		#echo ""
-		#echo "To use new autocompletion run the following on command line:"
-		#echo ". ~/.bashrc"
+		echo "Tmc cli installation was successful" >&2
 	else
-		echo "Tmc cli installation failed."
+		echo "Tmc cli installation failed." >&2
 		exit 127
 	fi
 	exit
+}
+
+if [ "${1-}" == "++internal-update" ]; then
+	tmc_install_update
 fi
 
+if [ ! -f "$(tmc_autocomplete_file)" ]; then
+	tmc_update_autocomplete
+	exit
+fi
+
+#EMBED_UNIT_TESTS_SH
+
 export COLUMNS=$(tput cols)
 exec "$JAVA_BIN" -jar "$MYSELF" "$@"
 

scripts/unit_tests.sh

@@ -0,0 +1,9 @@
+#TODO
+
+#backup the profile and the autocompletion if the exist
+
+#try out the functions with different parameters
+
+#restore the files
+
+exit

scripts/wrapper.sh

@@ -5,9 +5,23 @@ set -euo pipefail
 # find newest jar file
 jar_file=$(ls -t target/tmc-cli-*.jar | head -1)
 
-sed '/TMC_AUTOCOMPLETE_SH/ {
-	r scripts/autocompletion.sh
-d }' scripts/stub.sh > tmc
+quotePerlSubst() {
+	IFS= read -d '' -r < <(sed -e ':a' -e '$!{N;ba' -e '}' -e 's/[$/\]/\\&/g; s/\n/\\&/g' <<<"$1")
+	printf %s "${REPLY%$'\n'}"
+}
+
+content=$(cat scripts/stub.sh)
+
+ac_content=$(quotePerlSubst "$(cat scripts/autocompletion.sh)")
+content=$(echo "$content" | sed "s/\#EMBED_AUTOCOMPLETE_SH/$ac_content/g")
+
+if [ "${1-}" = "--with-unit-tests" ] ; then
+	ac_content=$(quotePerlSubst "$(cat scripts/unit_tests.sh)")
+	content=$(echo "$content" | \
+		sed "s/\#EMBED_UNIT_TESTS_SH/$ac_content/g")
+fi
+
+echo "$content" > tmc
 
 cat "$jar_file" >> tmc && chmod +x tmc
 

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

@@ -7,7 +7,6 @@
 import fi.helsinki.cs.tmc.cli.io.HelpGenerator;
 import fi.helsinki.cs.tmc.cli.io.Io;
 import fi.helsinki.cs.tmc.cli.io.ShutdownHandler;
-import fi.helsinki.cs.tmc.cli.tmcstuff.WorkDir;
 import fi.helsinki.cs.tmc.cli.updater.TmcCliUpdater;
 
 import org.apache.commons.cli.CommandLine;
@@ -49,6 +48,7 @@ public Application(CliContext context) {
 
         options.addOption("h", "help", false, "Display help information about tmc-cli");
         options.addOption("v", "version", false, "Give the version of the tmc-cli");
+        options.addOption("u", "force-update", false, "Force the auto-update");
 
         //TODO implement the inTests as context.property
         if (!context.inTests()) {
@@ -73,7 +73,6 @@ private String[] parseArgs(String[] args) {
         try {
             line = this.parser.parse(this.options, args, true);
         } catch (ParseException e) {
-            io.println("Invalid command line arguments.");
             io.println(e.getMessage());
             return null;
         }
@@ -90,7 +89,11 @@ private String[] parseArgs(String[] args) {
             return null;
         }
 
-        if (line.hasOption("h")) {
+        boolean showHelp = line.hasOption("h");
+        boolean showVersion = line.hasOption("v");
+        boolean forceUpdate = line.hasOption("u");
+
+        if (showHelp) {
             // don't run the help sub-command with -h switch
             if (commandName.equals("help")) {
                 runCommand("help", new String[0]);
@@ -99,10 +102,14 @@ private String[] parseArgs(String[] args) {
             runCommand(commandName, new String[]{"-h"});
             return null;
         }
-        if (line.hasOption("v")) {
+        if (showVersion) {
             io.println("TMC-CLI version " + EnvironmentUtil.getVersion());
             return null;
         }
+        if (forceUpdate) {
+            runAutoUpdate();
+            return null;
+        }
         return subArgs.toArray(new String[subArgs.size()]);
     }
 
@@ -113,12 +120,12 @@ public void printHelp(String description) {
     public void run(String[] args) {
         context.setApp(this);
 
-        if (!context.inTests() && versionCheck()) {
+        String[] commandArgs = parseArgs(args);
+        if (commandArgs == null) {
             return;
         }
 
-        String[] commandArgs = parseArgs(args);
-        if (commandArgs == null) {
+        if (!context.inTests() && versionCheck()) {
             return;
         }
 
@@ -156,8 +163,14 @@ private boolean versionCheck() {
             return false;
         }
 
-        TmcCliUpdater update = new TmcCliUpdater(io, EnvironmentUtil.getVersion(),
-                EnvironmentUtil.isWindows());
+        return runAutoUpdate();
+    }
+
+    public boolean runAutoUpdate() {
+        Map<String, String> properties = context.getProperties();
+        Date now = new Date();
+        TmcCliUpdater update = TmcCliUpdater.createUpdater(io,
+                EnvironmentUtil.getVersion(), EnvironmentUtil.isWindows());
         boolean updated = update.run();
 
         long timestamp = now.getTime();
@@ -167,7 +180,7 @@ private boolean versionCheck() {
         return updated;
     }
 
-    //TODO rename this as getColorProperty
+    //TODO rename this as getColorProperty and move it somewhere else
     public Color.AnsiColor getColor(String propertyName) {
         String propertyValue = context.getProperties().get(propertyName);
         Color.AnsiColor color = Color.getColor(propertyValue);

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

@@ -60,7 +60,7 @@ public CliContext(Io io, TmcCore core, WorkDir workDir) {
      * constructor.
      */
 
-    protected void setApp(Application app) {
+    public void setApp(Application app) {
         this.application = app;
     }
 

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

@@ -5,6 +5,7 @@
 
 import java.io.InputStream;
 import java.io.IOException;
+import java.util.Arrays;
 import java.util.Properties;
 
 public class EnvironmentUtil {
@@ -45,4 +46,50 @@ public static String getVersion() {
             return "n/a";
         }
     }
+
+    public static boolean runProcess(String[] args, boolean wait) {
+        if (EnvironmentUtil.isWindows()) {
+            logger.info("Launching external program " + Arrays.toString(args));
+            try {
+                Process proc = new ProcessBuilder(args).start();
+                if (wait) {
+                    logger.info("(Windows) Waiting for "
+                            + Arrays.toString(args) + " to finish executing");
+                    proc.waitFor();
+                }
+            } catch (Exception e) {
+                logger.error("(Windows) Exception when running external program "
+                        + Arrays.toString(args), e);
+                return false;
+            }
+        } else {
+
+            StringBuilder program = new StringBuilder();
+            for (int i = 0; i < args.length; i++) {
+                program.append(" " + args[i]);
+            }
+            String[] exec = {"sh", "-c", program.toString() + " </dev/tty >/dev/tty"};
+//            exec[0] = "sh";
+//            exec[1] = "-c";
+//            for (int i = 0; i < args.length; i++) {
+//                exec[2 + i] = args[i];
+//            }
+//            exec[args.length + 2] = " </dev/tty >/dev/tty";
+//            exec = {"sh -c "}
+            try {
+                Process proc = Runtime.getRuntime().exec(exec);
+                if (wait) {
+                    logger.info("(Unix) Waiting for "
+                            + Arrays.toString(exec) + " to finish executing");
+                    proc.waitFor();
+                }
+                return proc.exitValue() == 0;
+            } catch (Exception e) {
+                logger.error("(Unix) Exception when running external program "
+                        + Arrays.toString(exec), e);
+                return false;
+            }
+        }
+        return false;
+    }
 }