Merge pull request #46 from datacamp/feat/ide_exercise

[CX-844] Add basic run functionality

Author: TimSangster

shellwhat/checks/__init__.py

@@ -6,6 +6,8 @@
     has_expr_exit_code,
 )
 
+from shellwhat.run_file import run
+
 from protowhat.checks.check_logic import fail, multi, check_not, check_or, check_correct
 from protowhat.checks.check_simple import has_chosen, success_msg
 from protowhat.checks.check_files import check_file, has_dir

shellwhat/run_file.py

@@ -0,0 +1,50 @@
+import subprocess
+
+from shellwhat.reporter import Reporter
+
+
+def run(state):
+    """Run the student file focused by ``check_file``.
+
+    Args:
+        state (State): state as passed by the SCT chain. Don't specify this explicitly.
+
+    :Example:
+
+        Suppose the student has a file ``script.sh`` in ``/home/repl/``::
+
+            echo 'test'
+
+        We can check if the file runs with this SCT::
+
+            Ex().check_file(
+                "script.sh"
+            ).run()
+    """
+    student_result, error = run_file(state.path)
+    return state.to_child(
+        student_result=student_result,
+        reporter=Reporter(state.reporter, errors=[error] if error else []),
+    )
+
+
+def run_file(path):
+    output, exception = None, None
+    try:
+        output = subprocess.check_output(path.__str__(), stderr=subprocess.PIPE)
+    except subprocess.CalledProcessError as e:
+        exception = (
+            "returned non-zero exit status "
+            + str(e.returncode)
+            + " "
+            + str(e.stderr, "utf-8")
+        )
+    except PermissionError:
+        exception = "{} is not executable".format(path)
+
+    try:
+        output = str(output, "utf-8")
+    except TypeError:
+        pass
+
+    return output, exception

tests/test_run.py

@@ -0,0 +1,136 @@
+import pytest
+import os
+import subprocess
+from pexpect import replwrap
+from tempfile import TemporaryDirectory
+from pathlib import Path
+
+from shellwhat.reporter import Reporter
+from shellwhat.State import State
+from shellwhat.run_file import run
+
+
+@pytest.fixture
+def state():
+    state = State(
+        student_code="some code\x1b[39;49m",
+        solution_code="some code",
+        pre_exercise_code="",
+        student_conn=replwrap.bash(),
+        solution_conn=None,
+        student_result="stdout stuff",
+        solution_result=None,
+        reporter=Reporter(),
+    )
+    state.root_state = state
+    return state
+
+
+@pytest.fixture(scope="function")
+def tempdir():
+    cwd = os.getcwd()
+    with TemporaryDirectory() as tmp:
+        os.chdir(tmp)
+        yield tmp
+        os.chdir(cwd)
+
+
+def test_run_student_code_is_run(state, tempdir):
+    # Given
+    state.student_code = "touch testfile.sh\n"
+    state.solution_code = ""
+
+    filedir = tempdir + "/myscript.sh"
+    with open(filedir, "w+") as f:
+        f.write("#!/bin/bash\n")
+        f.write(state.student_code)
+
+    subprocess.run(["chmod", "+x", filedir])
+    state.path = Path(filedir)
+
+    # When
+    run(state)
+
+    # Then
+    assert os.path.exists(filedir)
+
+
+def test_run_student_code_output(state, tempdir):
+    # Given
+    state.student_code = "echo 'test'\n"
+    state.solution_code = ""
+
+    filedir = tempdir + "/myscript.sh"
+    with open(filedir, "w+") as f:
+        f.write("#!/bin/bash\n")
+        f.write(state.student_code)
+
+    subprocess.run(["chmod", "+x", filedir])
+    state.path = Path(filedir)
+
+    # When
+    state = run(state)
+
+    # Then
+    assert state.student_result == "test\n"
+
+
+def test_run_student_code_env_var_access(state, tempdir):
+    # Given
+    os.environ["ENVVARTEST"] = "envtest"
+    state.student_code = "echo $ENVVARTEST\n"
+    state.solution_code = ""
+
+    filedir = tempdir + "/myscript.sh"
+    with open(filedir, "w+") as f:
+        f.write("#!/bin/bash\n")
+        f.write(state.student_code)
+
+    subprocess.run(["chmod", "+x", filedir])
+    state.path = Path(filedir)
+
+    # When
+    state = run(state)
+
+    # Then
+    assert state.student_result == "envtest\n"
+
+
+def test_run_student_code_error(state, tempdir):
+    # Given
+    state.student_code = '>&2 echo "Noooo!"\nexit 5\n'
+    state.solution_code = ""
+
+    filedir = tempdir + "/myscript.sh"
+    with open(filedir, "w+") as f:
+        f.write("#!/bin/bash\n")
+        f.write(state.student_code)
+
+    subprocess.run(["chmod", "+x", filedir])
+    state.path = Path(filedir)
+
+    # When
+    state = run(state)
+
+    # Then
+    assert state.reporter.errors == ["returned non-zero exit status 5 Noooo!\n"]
+
+
+def test_run_student_not_executable(state, tempdir):
+    # Given
+    state.student_code = "echo 'test'\n"
+    state.solution_code = ""
+
+    filedir = tempdir + "/myscript.sh"
+    with open(filedir, "w+") as f:
+        f.write("#!/bin/bash\n")
+        f.write(state.student_code)
+
+    subprocess.run(["chmod", "-x", filedir])
+    state.path = Path(filedir)
+
+    # When
+    state = run(state)
+
+    # Then
+    assert state.reporter.errors == [filedir + " is not executable"]