test/upload_tests.py at master · vayyala/test · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
import os
import sys
import requests
# install by 'pip install codePost'. Documentation can be found at https://github.com/codepost-io/codePost-python
import codePost

api_key = os.environ["cp_api_key"] # set API key via %env cp_api_key = <API KEY>
course_name = 'New course'
course_period = '2019'
student_email = sys.argv[1]
assignment_name = sys.argv[2]
test_output = sys.argv[3]

test_output_file_name = "test_output.txt" # NOTE: THIS SHOULD BE EDITED BY USER BASED ON DESIRED BEHAVIOR. File name for codePost

def upload_test_output(api_key, course_name, course_period, student_email, assignment_name, test_output):
    # Find Assignment
    assn = codePost.get_assignment_info_by_name(api_key, course_name, course_period, assignment_name)
    if(not assn):
        raise Exception("No Assignment found with the given name and course info. Please check to make sure the names are correct.")
    # Find Submission for student
    sub = codePost.get_assignment_submissions(api_key, assn['id'], student=student_email)
    if(len(sub) != 1):
        raise Exception("No submission found for this student and assignment.")
    # Parse the test output to the format desired to upload to codePost
    test_output_to_be_uploaded = parse_test_output(test_output)
    # Upload test output to codePost
    new_file = codePost.post_file(api_key, sub[0]['id'], test_output_file_name, str(test_output_to_be_uploaded), "txt")
    print("Test output successfully updated. Check it out on codePost at www.codepost.io/grade/{sub}".format(sub=sub[0]['id']))
    # Add comments to file
    add_comments(api_key, test_output, new_file)
    print("Comments succesfully added. Check it out on codePost at www.codepost.io/grade/{sub}".format(sub=sub[0]['id']))

def parse_test_output(test_output):
    """
    Given a test output file and returns the file to be uploaded to codePost
    NOTE: THIS FUNCTION SHOULD BE EDITED BASED ON DESIRED USER BEHAVIOR
    """
    # example: returns full test output
    return test_output

def add_comments(api_key, test_output, file):
    """
    Adds comments to a codePost file, given an API Key, output to parse for comments, and a file object
    NOTE: THIS FUNCTION SHOULD BE EDITED BASED ON DESIRED USER BEHAVIOR
    """
    # example: posts a single comment
    # syntax: post_comment(api_key, file, text, pointDelta, startChar, endChar, startLine, endLine, rubricComment=None)
    # pointDelta is parsed as a negative. e.g., a pointDelta of 1 is -1 on codePost
    codePost.post_comment(api_key, file, "Final grade", 10, 0, 1, 0, 0)

if __name__ == "__main__":
    upload_test_output(api_key, course_name, course_period, student_email, assignment_name, test_output)