test: Import integrations with empty shadow modules #5150
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -163,6 +163,7 @@ | |
| "trytond", | ||
| "typer", | ||
| "integration_deactivation", | ||
| "shadowed_module", | ||
| ], | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| import sys | ||
| import ast | ||
| import types | ||
| import pkgutil | ||
| import importlib | ||
| import pathlib | ||
| import pytest | ||
|
|
||
| from sentry_sdk import integrations | ||
| from sentry_sdk.integrations import _DEFAULT_INTEGRATIONS, Integration | ||
|
|
||
|
|
||
| def pytest_generate_tests(metafunc): | ||
| """ | ||
| All submodules of sentry_sdk.integrations are picked up, so modules | ||
| without a subclass of sentry_sdk.integrations.Integration are also tested | ||
| for poorly gated imports. | ||
|
|
||
| This approach was chosen to keep the implementation simple. | ||
| """ | ||
| if "integration_submodule_name" in metafunc.fixturenames: | ||
| submodule_names = { | ||
| submodule_name | ||
| for _, submodule_name, _ in pkgutil.walk_packages(integrations.__path__) | ||
| } | ||
|
|
||
| metafunc.parametrize( | ||
| "integration_submodule_name", | ||
| # Temporarily skip some integrations | ||
| submodule_names | ||
| - { | ||
| "clickhouse_driver", | ||
| "grpc", | ||
| "litellm", | ||
| "opentelemetry", | ||
| "pure_eval", | ||
| "ray", | ||
| "trytond", | ||
| "typer", | ||
| }, | ||
| ) | ||
|
|
||
|
|
||
| def find_unrecognized_dependencies(tree): | ||
| """ | ||
| Finds unrecognized imports in the AST for a Python module. In an empty | ||
| environment the set of non-standard library modules is returned. | ||
| """ | ||
| unrecognized_dependencies = set() | ||
| package_name = lambda name: name.split(".")[0] | ||
|
|
||
| for node in ast.walk(tree): | ||
| if isinstance(node, ast.Import): | ||
| for alias in node.names: | ||
| root = package_name(alias.name) | ||
|
|
||
| try: | ||
| if not importlib.util.find_spec(root): | ||
| unrecognized_dependencies.add(root) | ||
| except ValueError: | ||
| continue | ||
|
|
||
| elif isinstance(node, ast.ImportFrom): | ||
| # if node.level is not 0 the import is relative | ||
| if node.level > 0 or node.module is None: | ||
| continue | ||
|
|
||
| root = package_name(node.module) | ||
|
|
||
| try: | ||
| if not importlib.util.find_spec(root): | ||
| unrecognized_dependencies.add(root) | ||
| except ValueError: | ||
| continue | ||
|
|
||
| return unrecognized_dependencies | ||
|
|
||
|
|
||
| @pytest.mark.skipif( | ||
| sys.version_info < (3, 7), reason="asyncpg imports __future__.annotations" | ||
| ) | ||
| def test_shadowed_modules_when_importing_integrations( | ||
|
Contributor
There was a problem hiding this comment. I think I understand what's going on here, but it takes some effort to grasp. Maybe a good case for additional comments in the function to better explain what's happening step-by-step?
Contributor
Author
There was a problem hiding this comment. yes, that's a good call! Added a few comments. |
||
| sentry_init, integration_submodule_name | ||
| ): | ||
| """ | ||
| Check that importing integrations for third-party module raises an | ||
| DidNotEnable exception when the associated module is shadowed by an empty | ||
| module. | ||
|
|
||
| An integration is determined to be for a third-party module if it cannot | ||
| be imported in the environment in which the tests run. | ||
| """ | ||
| module_path = f"sentry_sdk.integrations.{integration_submodule_name}" | ||
| try: | ||
| # If importing the integration succeeds in the current environment, assume | ||
| # that the integration has no non-standard imports. | ||
| importlib.import_module(module_path) | ||
| return | ||
| except integrations.DidNotEnable: | ||
| spec = importlib.util.find_spec(module_path) | ||
| source = pathlib.Path(spec.origin).read_text(encoding="utf-8") | ||
| tree = ast.parse(source, filename=spec.origin) | ||
| integration_dependencies = find_unrecognized_dependencies(tree) | ||
|
|
||
| # For each non-standard import, create an empty shadow module to | ||
| # emulate an empty "agents.py" or analogous local module that | ||
| # shadows the package. | ||
| for dependency in integration_dependencies: | ||
| sys.modules[dependency] = types.ModuleType(dependency) | ||
|
|
||
| # Importing the integration must raise DidNotEnable, since the | ||
| # SDK catches the exception type when attempting to activate | ||
| # auto-enabling integrations. | ||
| with pytest.raises(integrations.DidNotEnable): | ||
| importlib.import_module(module_path) | ||
|
|
||
| for dependency in integration_dependencies: | ||
| del sys.modules[dependency] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What determines what ends up in the ignore list here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are packages for which the test fails. I've taken a brief look at all of them and there's no false positives.