github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-06 13:18:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add pytest --only-extended and --only-core options (#4494)

Browse Source 
# Adds testing options to pytest

This PR adds the following options: 

* `--only-core` will skip all extended tests, running all core tests.
* `--only-extended` will skip all core tests. Forcing alll extended
tests to be run.

Running `py.test` without specifying either option will remain
unaffected. Run
all tests that can be run within the unit_tests direction. Extended
tests will
run if required packages are installed.

## Before submitting

## Who can review?
This commit is contained in:
Eugene Yurtsev 2023-05-12 11:35:22 -04:00 committed by GitHub
parent 5ad151ed44
commit a5371a0fa2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
tests/unit_tests/conftest.py
View File

@ -3,7 +3,21 @@ from importlib import util
from typing import Dict, Sequence from typing import Dict, Sequence
import pytest import pytest
from pytest import Config, Function from pytest import Config, Function, Parser
def pytest_addoption(parser: Parser) -> None:
"""Add custom command line options to pytest."""
parser.addoption(
"--only-extended",
action="store_true",
help="Only run extended tests. Does not allow skipping any extended tests.",
)
parser.addoption(
"--only-core",
action="store_true",
help="Only run core tests. Never runs any extended tests.",
)
def pytest_collection_modifyitems(config: Config, items: Sequence[Function]) -> None: def pytest_collection_modifyitems(config: Config, items: Sequence[Function]) -> None:
@ -26,9 +40,19 @@ def pytest_collection_modifyitems(config: Config, items: Sequence[Function]) ->
# Used to avoid repeated calls to `util.find_spec` # Used to avoid repeated calls to `util.find_spec`
required_pkgs_info: Dict[str, bool] = {} required_pkgs_info: Dict[str, bool] = {}
only_extended = config.getoption("--only-extended") or False
only_core = config.getoption("--only-core") or False
if only_extended and only_core:
raise ValueError("Cannot specify both `--only-extended` and `--only-core`.")
for item in items: for item in items:
requires_marker = item.get_closest_marker("requires") requires_marker = item.get_closest_marker("requires")
if requires_marker is not None: if requires_marker is not None:
if only_core:
item.add_marker(pytest.mark.skip(reason="Skipping not a core test."))
continue
# Iterate through the list of required packages # Iterate through the list of required packages
required_pkgs = requires_marker.args required_pkgs = requires_marker.args
for pkg in required_pkgs: for pkg in required_pkgs:
@ -38,7 +62,22 @@ def pytest_collection_modifyitems(config: Config, items: Sequence[Function]) ->
required_pkgs_info[pkg] = util.find_spec(pkg) is not None required_pkgs_info[pkg] = util.find_spec(pkg) is not None
if not required_pkgs_info[pkg]: if not required_pkgs_info[pkg]:
# If the package is not installed, we immediately break if only_extended:
# and mark the test as skipped. pytest.fail(
item.add_marker(pytest.mark.skip(reason=f"requires pkg: `{pkg}`")) f"Package `{pkg}` is not installed but is required for "
break f"extended tests. Please install the given package and "
f"try again.",
)
else:
# If the package is not installed, we immediately break
# and mark the test as skipped.
item.add_marker(
pytest.mark.skip(reason=f"Requires pkg: `{pkg}`")
)
break
else:
if only_extended:
item.add_marker(
pytest.mark.skip(reason="Skipping not an extended test.")
)