tests: scriptify function into module (#6619)

so that we can write tests having larger side-effects than
the run_copy that we use as a hack
This commit is contained in:
Saugat Pachhai
2021-09-15 22:01:10 +03:00
committed by GitHub
parent e049c4bab1
commit 198cdeec06
3 changed files with 52 additions and 8 deletions
+4
View File
@@ -5,6 +5,7 @@ import pytest
from .dir_helpers import * # noqa, pylint: disable=wildcard-import
from .remotes import * # noqa, pylint: disable=wildcard-import
from .utils.scriptify import scriptify
# Prevent updater and analytics from running their processes
os.environ["DVC_TEST"] = "true"
@@ -164,3 +165,6 @@ def custom_template(tmp_dir, dvc):
template = tmp_dir / "custom_template.json"
shutil.copy(tmp_dir / ".dvc" / "plots" / "default.json", template)
return template
scriptify_fixture = pytest.fixture(lambda: scriptify, name="scriptify")
+12 -8
View File
@@ -10,15 +10,16 @@ from dvc.exceptions import CyclicGraphError, ReproductionError
from dvc.main import main
from dvc.stage import PipelineStage
from tests.func import test_repro
from tests.utils.scriptify import scriptify
COPY_SCRIPT_FORMAT = dedent(
"""\
import sys
def copy_script(src, dest):
import shutil
shutil.copyfile({}, {})
"""
)
COPY_SCRIPT = COPY_SCRIPT_FORMAT.format("sys.argv[1]", "sys.argv[2]")
shutil.copyfile(src, dest)
COPY_SCRIPT, _ = scriptify(copy_script)
class MultiStageRun:
@@ -357,7 +358,10 @@ def test_repro_when_new_deps_is_moved(tmp_dir, dvc):
target = ":copy-file"
assert not dvc.reproduce(target)
tmp_dir.gen("copy.py", COPY_SCRIPT_FORMAT.format("'bar'", "'foobar'"))
# hardcode values in source code, ignore sys.argv
tmp_dir.gen(
"copy.py", COPY_SCRIPT.replace("func(*argv)", 'func("bar", "foobar")')
)
from shutil import move
move("foo", "bar")
+36
View File
@@ -0,0 +1,36 @@
import inspect
import sys
import textwrap
from pathlib import Path
SCRIPT_TEMPLATE = """\
#! {executable}
# AUTOGENERATED USING SCRIPTIFY FOR USE IN TESTS FOR DVC
{code}
if __name__ == "__main__":
import sys
_, *argv = sys.argv
func = {func!s}
func(*argv)
"""
def scriptify(func, path=None):
# you can use `breakpoint()` inside functions too
# just remember to run the test in `-s` mode.
code = textwrap.dedent(inspect.getsource(func))
executable = sys.executable
source = SCRIPT_TEMPLATE.format(
executable=executable, code=code, func=func.__name__
)
if not path:
return source, None
Path(path).write_text(source, encoding="utf-8")
return source, f"{executable} {path}"