rename

Author: sentrivana

scripts/populate_tox/dependencies.py

@@ -1,5 +1,7 @@
-# The DEPENDENCIES dictionary defines the test dependencies of each integration
-# test suite.
+# The TEST_SUITE_CONFIG dictionary defines, for each integration test suite,
+# the main package (framework, library) to test with; any additional test
+# dependencies, optionally gated behind specific conditions; and optionally
+# the Python versions to test on.
 #
 # The format is:
 # ```
@@ -8,14 +10,15 @@
 #     "deps": {
 #          rule1: [package1, package2, ...],
 #          rule2: [package3, package4, ...],
-#      }
+#      },
+#      "python": python_version_specifier,
 # }
 # ```
 #
 # The following can be set as a rule:
 #   - `*`: packages will be always installed
-#   - a version bound on the main package (e.g. `<=0.32`): packages will only be
-#     installed if the main package falls into the version bounds specified
+#   - a version specifier on the main package (e.g. `<=0.32`): packages will only
+#     be installed if the main package falls into the version bounds specified
 #   - specific Python version(s) in the form `py3.8,py3.9`: packages will only be
 #     installed if the Python version matches one from the list
 #
@@ -34,7 +37,7 @@
 # ````
 
 
-DEPENDENCIES = {
+TEST_SUITE_CONFIG = {
     "ariadne": {
         "package": "ariadne",
         "deps": {

scripts/populate_tox/populate_tox.py

@@ -16,7 +16,7 @@
 
 from sentry_sdk.integrations import _MIN_VERSIONS
 
-from dependencies import DEPENDENCIES
+from dependencies import TEST_SUITE_CONFIG
 from scripts.split_tox_gh_actions.split_tox_gh_actions import GROUPS
 
 
@@ -41,7 +41,8 @@
     #
     # This set should be getting smaller over time as we migrate more test
     # suites over to this script. Some entries will probably stay forever
-    # as they don't fit the mold (e.g. common, asgi).
+    # as they don't fit the mold (e.g. common, asgi, which don't have a 3rd party
+    # pypi package to install in different versions).
     "aiohttp",
     "anthropic",
     "asgi",
@@ -314,7 +315,7 @@ def _render_python_versions(python_versions: list[Version]) -> str:
 
 def _render_dependencies(integration: str, releases: list[Version]) -> list[str]:
     rendered = []
-    for constraint, deps in DEPENDENCIES[integration]["deps"].items():
+    for constraint, deps in TEST_SUITE_CONFIG[integration]["deps"].items():
         if constraint == "*":
             for dep in deps:
                 rendered.append(f"{integration}: {dep}")
@@ -376,7 +377,7 @@ def write_tox_file(packages: dict) -> None:
             print(f"Processing {integration}...")
 
             # Figure out the actual main package
-            package = DEPENDENCIES[integration]["package"]
+            package = TEST_SUITE_CONFIG[integration]["package"]
             extra = None
             if "[" in package:
                 extra = package[package.find("[") + 1 : package.find("]")]