-
Notifications
You must be signed in to change notification settings - Fork 64
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for qmd #816
base: master
Are you sure you want to change the base?
Add support for qmd #816
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"lang": "r", | ||
"autograder_dir": "test/test_run/files/qmd-autograder" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
test = list( | ||
name = "q1", | ||
cases = list( | ||
ottr::TestCase$new( | ||
hidden = FALSE, | ||
name = NA, | ||
points = 1, | ||
code = { | ||
testthat::expect_true(is.numeric(x)) | ||
} | ||
), | ||
ottr::TestCase$new( | ||
hidden = FALSE, | ||
name = NA, | ||
points = 1, | ||
code = { | ||
testthat::expect_true(0 < x) | ||
testthat::expect_true(x < 100) | ||
} | ||
), | ||
ottr::TestCase$new( | ||
hidden = TRUE, | ||
name = NA, | ||
points = 1, | ||
code = { | ||
testthat::expect_equal(x, 2) | ||
} | ||
), | ||
ottr::TestCase$new( | ||
hidden = TRUE, | ||
name = "q1d", | ||
points = 2, | ||
success_message = "congrats", | ||
code = { | ||
testthat::expect_equal(as.character(x), "2") | ||
} | ||
) | ||
) | ||
) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: "Homework 1" | ||
format: pdf_document | ||
date: '2022-07-17' | ||
assignment_name: "hw01" | ||
--- | ||
|
||
**Question 1:** Assign `x` to the value `2`. | ||
|
||
```{r} | ||
x <- 2 | ||
``` | ||
|
||
```{r} | ||
. = ottr::check("tests/q1.R") | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -48,11 +48,20 @@ def cleanup_output(cleanup_enabled): | |
FILE_MANAGER.get_path("rmd-autograder/submission/tests"), | ||
FILE_MANAGER.get_path("rmd-autograder/submission/__init__.py"), | ||
FILE_MANAGER.get_path("rmd-autograder/submission/.OTTER_LOG"), | ||
FILE_MANAGER.get_path("qmd-autograder/results/results.json"), | ||
FILE_MANAGER.get_path("qmd-autograder/results/results.pkl"), | ||
FILE_MANAGER.get_path("qmd-autograder/__init__.py"), | ||
FILE_MANAGER.get_path("qmd-autograder/submission/test"), | ||
FILE_MANAGER.get_path("qmd-autograder/submission/tests"), | ||
FILE_MANAGER.get_path("qmd-autograder/submission/__init__.py"), | ||
FILE_MANAGER.get_path("qmd-autograder/submission/.OTTER_LOG"), | ||
]) | ||
with FILE_MANAGER.open("autograder/source/otter_config.json", "w") as f: | ||
f.write(cpy) | ||
with FILE_MANAGER.open("rmd-autograder/source/otter_config.json", "w") as f: | ||
f.write(crmd) | ||
with FILE_MANAGER.open("qmd-autograder/source/otter_config.json", "w") as f: | ||
f.write(cqmd) | ||
|
||
|
||
@pytest.fixture(autouse=True) | ||
|
@@ -139,6 +148,26 @@ def expected_rmd_results(): | |
], | ||
} | ||
|
||
@pytest.fixture(scope="module") | ||
def expected_qmd_results(): | ||
return { | ||
"tests": [ | ||
{ | ||
"name": "Public Tests", | ||
"output": "q1 results: All test cases passed!", | ||
"visibility": "visible", | ||
"status": "passed", | ||
}, | ||
{ | ||
"max_score": 5, | ||
"name": "q1", | ||
"output": "q1 results: All test cases passed!\nq1d message: congrats", | ||
"score": 5, | ||
"visibility": "hidden", | ||
}, | ||
], | ||
} | ||
|
||
|
||
@contextmanager | ||
def alternate_config(config_path, new_config): | ||
|
@@ -214,20 +243,26 @@ def make_empty_pdf(*args, **kwargs): | |
|
||
@pytest.fixture | ||
def get_config_path(): | ||
def do_get_config_path(rmd=False): | ||
dirname = "autograder" if not rmd else "rmd-autograder" | ||
def do_get_config_path(rmd=False, qmd=False): | ||
#dirname = "autograder" if not rmd else "rmd-autograder" | ||
if rmd == False & qmd == False: | ||
dirname = "autograder" | ||
if rmd == True & qmd == False: | ||
dirname = "rmd-autograder" | ||
if rmd == False & qmd == True: | ||
dirname = "rmd-autograder" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can this block of ifs to prefix = ""
if rmd: prefix = "rmd-"
if qmd: prefix = "qmd-"
dirname = f"{prefix}autograder" |
||
return FILE_MANAGER.get_path(f"{dirname}/source/otter_config.json") | ||
return do_get_config_path | ||
|
||
|
||
@pytest.fixture | ||
def load_config(get_config_path): | ||
def load_config_file(rmd=False): | ||
with open(get_config_path(rmd=rmd)) as f: | ||
def load_config_file(rmd=False, qmd=False): | ||
with open(get_config_path(rmd=rmd, qmd=False)) as f: | ||
return json.load(f) | ||
with open(get_config_path(rmd=False, qmd=qmd)) as f: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You don't need multiple |
||
return json.load(f) | ||
return load_config_file | ||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please add this blank line back -- style guide is two blank lines between top level |
||
def test_notebook(load_config, expected_results): | ||
config = load_config() | ||
run_autograder(config['autograder_dir']) | ||
|
@@ -399,7 +434,7 @@ def perform_test(nb, expected_results, error=None, **kwargs): | |
|
||
def test_rmd(load_config, expected_rmd_results): | ||
name = "hw01" | ||
config = load_config(True) | ||
config = load_config(rmd=True) | ||
rmd_path = FILE_MANAGER.get_path("rmd-autograder/submission/hw01.Rmd") | ||
with open(rmd_path) as f: | ||
orig_rmd = f.read() | ||
|
@@ -447,6 +482,55 @@ def perform_test(rmd, expected_results, error=None, **kwargs): | |
with open(rmd_path, "w+") as f: | ||
f.write(orig_rmd) | ||
|
||
def test_qmd(load_config, expected_qmd_results): | ||
name = "hw01" | ||
config = load_config(qmd=True) | ||
qmd_path = FILE_MANAGER.get_path("rmd-autograder/submission/hw01.qmd") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This path should start with |
||
with open(qmd_path) as f: | ||
orig_qmd = f.read() | ||
|
||
sub_name = lambda n: re.sub(r"assignment_name: \"\w+\"", f"assignment_name: \"{n}\"", orig_qmd) | ||
|
||
def perform_test(qmd, expected_results, error=None, **kwargs): | ||
with open(qmd_path, "w") as f: | ||
f.write(qmd) | ||
|
||
cm = pytest.raises(OtterRuntimeError, match=re.escape(error)) if error is not None \ | ||
else nullcontext() | ||
with cm: | ||
run_autograder(config["autograder_dir"], assignment_name = name, **kwargs) | ||
|
||
with FILE_MANAGER.open("qmd-autograder/results/results.json") as f: | ||
actual_results = json.load(f) | ||
|
||
assert actual_results == expected_results, \ | ||
f"Actual results did not matched expected:\n{actual_results}" | ||
|
||
error_message_template = "Received submission for assignment '{got}' (this is assignment " \ | ||
"'{want}')" | ||
|
||
try: | ||
# test with correct name | ||
perform_test(orig_qmd, expected_qmd_results) | ||
|
||
# test with wrong name | ||
bad_name = "lab01" | ||
error_message = error_message_template.format(got=bad_name, want=name) | ||
perform_test( | ||
sub_name(bad_name), get_expected_error_results(error_message), error=error_message) | ||
|
||
# test with no name in qmd | ||
error_message = error_message_template.format(got=None, want=name) | ||
perform_test( | ||
"\n".join([l for l in orig_qmd.split("\n") if not l.startswith("assignment_name: ")]), | ||
get_expected_error_results(error_message), | ||
error=error_message, | ||
) | ||
|
||
finally: | ||
delete_paths([qmd_path]) | ||
with open(qmd_path, "w+") as f: | ||
f.write(orig_qmd) | ||
|
||
@mock.patch.object(APIClient, "upload_pdf_submission") | ||
def test_token_sanitization(mocked_upload, get_config_path, load_config, expected_results): | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make sure to read the contents of this file and create the
cqmd
variable before theyield
statement above.