Go Docker API

README.md

@@ -36,7 +36,7 @@ Included with the xaqt library is a simple REST api server. Two endpoints are ex
 
  * GET `/languages/` : This will return a JSON list with the available target languages.
  * POST `/evaluate/` : This evaluates code, encoded in a JSON body of the following form:
- 
+
 ```
 {
     "language": "python",
@@ -46,3 +46,7 @@ Included with the xaqt library is a simple REST api server. Two endpoints are ex
 ```
 
    Returned is a JSON object that reports success or failure of evaluation, and for each element of `stdins`, what the code has printed to `stdout` for that element.
+
+## Development ##
+### Vendoring ##
+we currently use [`govendor`](https://github.com/kardianos/govendor) as our vendoring tool for external dependencies.

context.go

@@ -60,7 +60,9 @@ func (c *Context) Evaluate(language, code string, stdins []string) ([]string, Me
 // input is n test calls seperated by newlines
 // input and expected MUST end in newlines
 func (c *Context) run(language, code, stdinGlob string) (string, Message) {
-	log.Printf("sandbox launching sandbox...\nLanguage: %s\nStdin: %sCode: Hidden\n", language, stdinGlob)
+	log.Printf("launching new %s sandbox", language)
+	// log.Printf("launching sandbox...\nLanguage: %s\nStdin: %sCode: Hidden\n", language, stdinGlob)
+
 	lang, ok := c.compilers[strings.ToLower(language)]
 	if !ok || lang.Disabled == "true" {
 		return "", Message{"error", "language not supported"}
@@ -70,8 +72,13 @@ func (c *Context) run(language, code, stdinGlob string) (string, Message) {
 		return "", Message{"error", "no code submitted"}
 	}
 
-	sb := newSandbox(lang.ExecutionDetails, code, stdinGlob, c.options)
+	sb, err := newSandbox(lang.ExecutionDetails, code, stdinGlob, c.options)
+	if err != nil {
+		log.Printf("sandbox initialization error: %v", err)
+		return "", Message{"error", fmt.Sprintf("%s", err)}
+	}
 
+	// run the new sandbox
 	output, err := sb.run()
 	if err != nil {
 		log.Printf("sandbox run error: %v", err)

data/Payload/script.sh

@@ -38,22 +38,21 @@ addtionalArg=$4
 #	
 ########################################################################
 
+# redirect stdout --> logfile.txt & stderr --> errors
 exec  1> $"/usercode/logfile.txt"
 exec  2> $"/usercode/errors"
-#3>&1 4>&2 >
+
 
 START=$(date +%s.%2N)
 NL=$'\n'
 FIRST_LINE="TRUE"
+# the separator values below are also maintained in glob.go in project root dir...
 IN_SEP="*-BRK-*"
 OUT_SEP="*-BRK-*"
-#Branch 1
+
+# Branch 1: we are calling an interpreter (no compilation step)
 if [ "$runner" = "" ]; then
-    # while read p; do 
-    #     echo -n $p | $compiler /usercode/$file
-    # done < $"/usercode/inputFile"
-    # Reads until reaching $SEP and then runs command with that
-    # block of input
+        # Reads until reaching $SEP and then runs command with that block of input
 	while read p; do
 		if [ "$p" = "$IN_SEP" ]; then
 
@@ -84,7 +83,8 @@ if [ "$runner" = "" ]; then
 #Branch 2
 else  # runner was not blank
 	#In case of compile errors, redirect them to a file
-    $compiler /usercode/$file $addtionalArg > /dev/null #&> /usercode/errors.txt
+        $compiler /usercode/$file $addtionalArg > /dev/null #&> /usercode/errors.txt
+
 	#Branch 2a : exit code is zero aka success
 	if [ $? -eq 0 ];	then
 			while read p; do
@@ -118,7 +118,7 @@ else  # runner was not blank
 	else
 	    echo "Compilation Failed:"
 	    #if compilation fails, display the output file	
-	    cat /usercode/errors.txt
+	    cat /usercode/errors
 	fi
 fi
 

docs.md

@@ -0,0 +1,16 @@
+# XAQT Library
+*TODO (cw|4.28.2018) create godocs instead of this file...these are mostly notes for myself during development.*
+
+# Public Types
+* **`xaqt.Context`**: entrypoint into all functionality. TODO Propose renaming?
+* **`xaqt.Compilers`**: list of compilters. Propose re-typing to `[]Compiler`.
+* **`xaqt.Message`**: details on success or failure of execution
+
+# Public Methods
+
+``` go
+func NewContext(xaqt.Compilers, ...option) // option should be public!
+func (ctx *Context) ReadCompilers(string)
+func (ctw *Context) Languages([]string) // rename -> GetSupportedLanguages ?
+func (ctw *Context) Evaluate(string, string, []string)
+```