Merge pull request #384 from datacamp/jh/improve-run

Improve run

Author: hermansje

pythonwhat/local.py

@@ -205,16 +205,14 @@ def run_exercise(pec, sol_code, stu_code, sol_wd=None, stu_wd=None, **kwargs):
 #  e.g. `python -m project.run
 #  allow setting env vars? e.g. PYTHONPATH, could help running more complex setup
 #  allow prepending code? set_env? e.g. (automatically) setting __file__?
-def run(state, relative_working_dir="", solution_dir="solution"):
+def run(state, relative_working_dir=None, solution_dir="solution"):
     """Run the focused student and solution code in the specified location
 
     This function can be used after ``check_file`` to execute student and solution code.
-    The arguments allow setting the correct context for execution.
-    The ``solution_dir`` allows setting a different root of the solution context
-    so solution side effects don't conflict with those of the student.
+    The arguments allow configuring the correct context for execution.
 
     SCT functions chained after this one that execute pieces of code (custom expressions or the focused part of a file)
-    execute in the same location as the file.
+    execute in the same student and solution locations as the file.
 
     .. note::
 
@@ -235,6 +233,14 @@ def run(state, relative_working_dir="", solution_dir="solution"):
             that sets the root of the solution context, relative to that of the student execution context
         state (State): state as passed by the SCT chain. Don't specify this explicitly.
 
+    If ``relative_working_dir`` is not set, it will be the directory the file was loaded from by ``check_file``
+    and fall back to the root of the student execution context (the working directory pythonwhat runs in).
+
+    The ``solution_dir`` helps to prevent solution side effects from conflicting with those of the student.
+    If the set or derived value of ``relative_working_dir`` is an absolute path,
+    ``relative_working_dir`` will not be used to form the solution execution working directory:
+    the solution code will be executed in the root of the solution execution context.
+
     :Example:
 
         Suppose the student and solution have a file ``script.py`` in ``/home/repl/``::
@@ -254,10 +260,20 @@ def run(state, relative_working_dir="", solution_dir="solution"):
                 has_printout(0)
             )
     """
-    # todo: configure these arguments automatically based on check_file info?
-    # once that is implemented, look into executing the file itself
+    # todo:
+    # look into executing the file itself
     # and keeping the process alive to extract values
-    sol_wd = Path(os.getcwd(), solution_dir, relative_working_dir)
+    if relative_working_dir is None:
+        if getattr(state, "path", False):
+            relative_working_dir = state.path.parent
+        else:
+            relative_working_dir = ""
+
+    if not os.path.isabs(str(relative_working_dir)):
+        sol_wd = Path(os.getcwd(), solution_dir, relative_working_dir)
+    else:
+        sol_wd = Path(os.getcwd(), solution_dir)
+
     os.makedirs(str(sol_wd), exist_ok=True)
     stu_wd = Path(os.getcwd(), relative_working_dir)
     sol_process, stu_process, raw_stu_output, error = run_exercise(

requirements.txt

@@ -1,5 +1,5 @@
 # pythonwhat deps
-protowhat~=1.9.0
+protowhat~=1.10.0
 asttokens~=1.1.10
 dill~=0.2.7.1
 markdown2~=2.3.7

tests/helper.py

@@ -47,7 +47,7 @@ def wrapper(*args, **kwargs):
 def in_temp_dir():
     with tempfile.TemporaryDirectory() as d:
         with ChDir(d):
-            yield
+            yield d
 
 
 def run(data, run_code=True):

tests/test_local.py

@@ -1,5 +1,9 @@
+import os
+from pathlib import Path
+
 import pytest
 
+from pythonwhat.local import ChDir
 from pythonwhat.test_exercise import setup_state
 from tests.helper import verify_sct, in_temp_dir
 
@@ -50,7 +54,7 @@ def test_running_code_isolation_run(sol_code, stu_code):
                 asset
             ),
         )
-        * 2,
+        * 2
     ],
 )
 def test_urlretrieve_in_process(sol_code, stu_code):
@@ -77,7 +81,7 @@ def test_urlretrieve_in_process(sol_code, stu_code):
                 asset
             ),
         )
-        * 2,
+        * 2
     ],
 )
 def test_urlopen_in_process(sol_code, stu_code):
@@ -89,3 +93,97 @@ def test_urlopen_in_process(sol_code, stu_code):
 
         with verify_sct(True):
             chain.run()
+
+
+def write_file(path, name, content):
+    os.makedirs(path)
+    with ChDir(path):
+        with open(name, "w") as f:
+            f.write(content)
+
+
+def test_run_relative_working_dir():
+    stu_code = 'from pathlib import Path; c = Path("c").read_text(encoding="utf-8")'
+    sol_code = """c = 'c= Path("c").read_text(encoding="utf-8")'"""
+
+    file_dir = "a/b"
+    file_path = "a/b/c"
+
+    with in_temp_dir():
+
+        write_file(file_dir, "c", stu_code)
+
+        chain = setup_state("", "", pec="")
+
+        child = chain.check_file(file_path, solution_code=sol_code)
+
+        child.run(file_dir).check_object("c")
+        child.run().check_object("c")
+
+
+def test_run_solution_dir():
+    code = 'from pathlib import Path; c = Path("c").read_text(encoding="utf-8")'
+
+    file_dir = "a/b"
+    file_path = "a/b/c"
+    solution_location = "solution"
+
+    with in_temp_dir():
+        write_file(file_dir, "c", code)
+
+        os.makedirs(solution_location)
+        with ChDir(solution_location):
+            write_file(file_dir, "c", code)
+
+        chain = setup_state("", "", pec="")
+
+        child = chain.check_file(file_path, solution_code=code)
+
+        child.run(file_dir).check_object("c")
+        child.run().check_object("c")
+
+
+def test_run_with_absolute_dir():
+    code = 'from pathlib import Path; c = Path("c").read_text(encoding="utf-8")'
+
+    file_dir = "a/b"
+    solution_location = "solution"
+
+    with in_temp_dir():
+        os.makedirs(file_dir)
+        with ChDir(file_dir):
+            abs_dir = os.path.abspath(".")
+            abs_file_path = Path(abs_dir, "c")
+            with open("c", "w") as f:
+                f.write(code)
+
+        write_file(solution_location, "c", code)
+
+        chain = setup_state("", "", pec="")
+
+        child = chain.check_file(abs_file_path, solution_code=code)
+
+        child.run(abs_dir).check_object("c")
+        child.run().check_object("c")
+
+
+def test_run_custom_solution_dir():
+    code = 'from pathlib import Path; c = Path("c").read_text(encoding="utf-8")'
+
+    file_dir = "a/b"
+    file_path = "a/b/c"
+    custom_solution_location = "custom/solution/folder"
+
+    with in_temp_dir():
+        write_file(file_dir, "c", code)
+
+        os.makedirs(custom_solution_location)
+        with ChDir(custom_solution_location):
+            write_file(file_dir, "c", code)
+
+        chain = setup_state("", "", pec="")
+
+        child = chain.check_file(file_path, solution_code=code)
+
+        child.run(file_dir, solution_dir=custom_solution_location).check_object("c")
+        child.run(solution_dir=custom_solution_location).check_object("c")