RunJavaUtils.py

import shutil
import os
from shutil import move
from shutil import copyfile
import subprocess
import re
import tempfile
import io
import ExcelWriter
from unittest.test import test_result



def Create_Temp_Dir():
    return tempfile.mkdtemp()

def Clean_And_Remove_Temp_Dir(tempDir):
    shutil.rmtree(tempDir)

#
# We need the source lines to be surrounded by "    " in order for the
# display in the .csv to be correct
def Convert_Source_To_Excel_Compat_List(sourceName):
    try:
        sourceFile = open(sourceName, "r")
        result = sourceFile.readlines();
        sourceFile.close()
    except UnicodeDecodeError:
        result = ["File cannot be read as text"]
    return result

def Compare_Lines(goldenList, studentList):
    maxLen = len(goldenList)
    maxLen = max(len(studentList), maxLen)
    mismatch=[]
    anyMismatch=False
    for i in range(0, maxLen):
        if (i >= len(goldenList) or i >= len(studentList)):
            mismatch.append("->")
            anyMismatch=True
        elif (goldenList[i].strip() != studentList[i].strip()):
            mismatch.append("->")
            anyMismatch=True
        else:
            mismatch.append(" ")
    if (anyMismatch == False):
        mismatch=["Perfect Match"]
    return mismatch
#
# This is really cheesy.  It just grabs the first line with the word package & assumes
# that is the package name.
# same with the className
def Get_Java_Info(fileName):
    javaFile = io.open(fileName, "r", encoding="latin-1" )
    package = ""
    className = ""
    author = "Unknown"
    for line in javaFile:
        if package == "":
            m = re.match(r'\s*package\s+([a-zA-Z_]\w*)\s*;', line)
            if m is not None:
                package = m.group(1)
                continue
        if className == "":
            m = re.search(r'\bclass\s+([a-zA-Z_]\w*)\b', line)
            if m is not None:
                className = m.group(1)
                break
        m = re.search(r'@author\b(.*)$', line)
        if m is not None:
            author = m.group(1).strip()
    javaFile.close()
    return author, package, className



def Change_Binary_To_String_List(binary):
    result=[]
    tempStr = ""
    if (len(binary) > 0):
        for a in binary:
            if (isinstance(a, str)):
                tempStr = tempStr + a
            if (a > 8 and a < 127):
                c = chr(a)
                if (c != '\r'):
                    if (c == '\n'):
                        #remove trailing spaces, they are impossible to mark wrong since they are ambiguous in text
                        tempStr = tempStr.rstrip()
                        result.append(tempStr)
                        tempStr = ""
                    else:
                        tempStr = tempStr + str(c)
            else:
                tempStr = tempStr + "utf(" + str(a) + ")"
    if (len(tempStr) != 0):
        tempStr = tempStr.rstrip()
        result.append(tempStr)

    return result

#
# Runs the java file from the command line.  The output is in binary format (that is what subprocess returns
# If it doesn't run, output will be equal to a string.
# If we plan to keep using, probably worth fixing this so output is always a string
def Run_Java_File(destName, package, baseName):
    className = baseName + ".class"
    invokeName = baseName
    fullClassName = className
    success = True
    if (package != ""):
        os.mkdir(package)
        fullClassName = os.path.join(package, className)
        invokeName = package + "." + invokeName
    try:
        subprocess.check_output(["javac", destName])
    except subprocess.CalledProcessError as e:
        output = ["build error: " + str(e.output)]
        success = False
    if (success == True):
        try:
            if (package != ""):
                move(className, fullClassName)
            raw_output = subprocess.check_output(["java", invokeName], stderr=subprocess.STDOUT)
            output = raw_output.decode('utf-8', 'replace').splitlines()
        except subprocess.CalledProcessError as e:
            output = ["run error: " + str(e.output)]
            success = False
        if os.path.exists(fullClassName):
            os.remove(fullClassName)
    if (package != ""):
        os.rmdir(package)
    return (success, output)

def Copy_And_Run_Java_File(tempDir, source, classNameArg):
    (author, package, className) = Get_Java_Info(source)
    if (classNameArg != None):
        className = classNameArg
    destName = className + ".java"
    dest = os.path.join(tempDir, destName)
    print("copying " + source + " to " + dest)
    copyfile(source, dest)
    cwd = os.getcwd()
    os.chdir(tempDir)
    (success, output) = Run_Java_File(destName, package, className)
    os.chdir(cwd)
    os.remove(dest)
    return (success, author, package, className, output)


def Create_Header(excelWriter, addOutput, addFile, goldLines):
    fonts = ['Arial', 'Arial']
    header = [["Author"], ["Ran"]]
    if (len(goldLines) != 0):
        addOutput = True
        header.append(["Diff","Lines"])
        header.append(["Golden", "Output"])
        fonts.append('Courier New')
        fonts.append('Courier New')
    if (addOutput):
        header.append(["Output"])
        fonts.append('Courier New')
    if (addFile):
        header.append(["SourceFile"])
        fonts.append('Courier New')
    excelWriter.Add_Header(header, fonts, [0, 1])

def Append_Run_Data(successString, success, author, package, className, output, source, excelWriter, addOutput, addFile, goldLines):
        excelWriter.Next_Student(author)       
        excelWriter.Add_String(str(successString),0)
        stringLists=[]
        if (len(goldLines)):
            if (success):
                stringLists.append(Compare_Lines(goldLines, output))
                stringLists.append(goldLines)
            else:
                stringLists.append([""])
                stringLists.append([""])
        if (addOutput):
            stringLists.append(output)
        for stringList in stringLists:
            excelWriter.Add_String_Array(stringList, 8)
        if (addFile and source != ""):
            excelWriter.Add_String_Array(Convert_Source_To_Excel_Compat_List(source), 4)

# one by one, copy the files from the source dir to the temp dir, run them,
# and store off the results in a .csv
def Copy_And_Run_Files(sourceDir, files, tempDir, excelWriter, addOutput, addFile, goldLines):
    Create_Header( excelWriter, addOutput, addFile, goldLines)

    for file in files:
        source = os.path.join(sourceDir, file)
        (success, author, package, className, output) = Copy_And_Run_Java_File(tempDir, source, None)
        Append_Run_Data(str(success), success, author, package, className, output, source, excelWriter, addOutput, addFile, goldLines)