mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-02 07:18:25 +01:00
Saugat Pachhai
b5f31daab0
Before, we used to set it during initialization. But this made it hard to test using capsys as capsys changes the reference to sys.stdout and sys.stderr with the mocked one during the test. But since we are using dvc.ui globally and setting it to a real sys.stdout and sys.stderr before capsys comes into effect, testing was not possible with it. Now, by using property hack, we will be using the values of sys.stdout and sys.stderr during the time of write, so the mocking would work and would be easier to test.
148 lines
4.0 KiB
Python
148 lines
4.0 KiB
Python
import os
|
|
from contextlib import suppress
|
|
|
|
import pytest
|
|
|
|
from .dir_helpers import * # noqa, pylint: disable=wildcard-import
|
|
from .remotes import * # noqa, pylint: disable=wildcard-import
|
|
|
|
# Prevent updater and analytics from running their processes
|
|
os.environ["DVC_TEST"] = "true"
|
|
# Ensure progress output even when not outputting to raw sys.stderr console
|
|
os.environ["DVC_IGNORE_ISATTY"] = "true"
|
|
|
|
REMOTES = {
|
|
# remote: enabled_by_default?
|
|
"azure": False,
|
|
"gdrive": False,
|
|
"gs": False,
|
|
"hdfs": False,
|
|
"http": True,
|
|
"oss": False,
|
|
"s3": True,
|
|
"ssh": True,
|
|
"webdav": True,
|
|
}
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def reset_loglevel(request, caplog):
|
|
"""
|
|
Use it to ensure log level at the start of each test
|
|
regardless of dvc.logger.setup(), Repo configs or whatever.
|
|
"""
|
|
ini_opt = None
|
|
with suppress(ValueError):
|
|
ini_opt = request.config.getini("log_level")
|
|
|
|
level = request.config.getoption("--log-level") or ini_opt
|
|
if level:
|
|
with caplog.at_level(level.upper(), logger="dvc"):
|
|
yield
|
|
else:
|
|
yield
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def enable_ui():
|
|
from dvc.ui import ui
|
|
|
|
ui.enable()
|
|
|
|
|
|
@pytest.fixture(scope="session", autouse=True)
|
|
def _close_pools():
|
|
from dvc.fs.pool import close_pools
|
|
|
|
yield
|
|
close_pools()
|
|
|
|
|
|
def _get_opt(remote_name, action):
|
|
return f"--{action}-{remote_name}"
|
|
|
|
|
|
def pytest_addoption(parser):
|
|
"""Adds remote-related flags to selectively disable/enable for tests
|
|
Eg: If some remotes, eg: ssh is enabled to be tested for by default
|
|
(see above `REMOTES`), then, `--disable-ssh` flag is added. If remotes
|
|
like `hdfs` are disabled by default, `--enable-hdfs` is added to make them
|
|
run.
|
|
|
|
You can also make everything run-by-default with `--all` flag, which takes
|
|
precedence on all previous `--enable-*`/`--disable-*` flags.
|
|
"""
|
|
parser.addoption(
|
|
"--all",
|
|
action="store_true",
|
|
default=False,
|
|
help="Test all of the remotes, unless other flags also supplied",
|
|
)
|
|
for remote_name in REMOTES:
|
|
for action in ("enable", "disable"):
|
|
opt = _get_opt(remote_name, action)
|
|
parser.addoption(
|
|
opt,
|
|
action="store_true",
|
|
default=None,
|
|
help=f"{action} tests for {remote_name}",
|
|
)
|
|
|
|
|
|
class DVCTestConfig:
|
|
def __init__(self):
|
|
self.enabled_remotes = set()
|
|
|
|
def requires(self, remote_name):
|
|
if remote_name not in REMOTES or remote_name in self.enabled_remotes:
|
|
return
|
|
|
|
pytest.skip(f"{remote_name} tests not enabled through CLI")
|
|
|
|
def apply_marker(self, marker):
|
|
self.requires(marker.name)
|
|
|
|
|
|
def pytest_runtest_setup(item):
|
|
# Apply test markers to skip tests selectively
|
|
# NOTE: this only works on individual tests,
|
|
# for fixture, use `test_config` fixture and
|
|
# run `test_config.requires(remote_name)`.
|
|
for marker in item.iter_markers():
|
|
item.config.dvc_config.apply_marker(marker)
|
|
|
|
|
|
@pytest.fixture(scope="session")
|
|
def test_config(request):
|
|
return request.config.dvc_config
|
|
|
|
|
|
def pytest_configure(config):
|
|
config.dvc_config = DVCTestConfig()
|
|
|
|
for remote_name in REMOTES:
|
|
config.addinivalue_line(
|
|
"markers", f"{remote_name}: mark test as requiring {remote_name}"
|
|
)
|
|
|
|
enabled_remotes = config.dvc_config.enabled_remotes
|
|
if config.getoption("--all"):
|
|
enabled_remotes.update(REMOTES)
|
|
else:
|
|
default_enabled = {k for k, v in REMOTES.items() if v}
|
|
enabled_remotes.update(default_enabled)
|
|
|
|
for remote_name in REMOTES:
|
|
enabled_opt = _get_opt(remote_name, "enable")
|
|
disabled_opt = _get_opt(remote_name, "disable")
|
|
|
|
enabled = config.getoption(enabled_opt)
|
|
disabled = config.getoption(disabled_opt)
|
|
if disabled and enabled:
|
|
continue # default behavior if both flags are supplied
|
|
|
|
if disabled:
|
|
enabled_remotes.discard(remote_name)
|
|
if enabled:
|
|
enabled_remotes.add(remote_name)
|