refactor(gapic-generator): harmonize and deduplicate showcase nox test sessions
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 55/100
- Issue 類型
- 重構
- 描述清晰度
- 基本清楚
- 活躍度
- 活躍
- 技術堆疊
- python
研究方向
Read packages/gapic-generator/noxfile.py, focusing on showcase_library, run_showcase_unit_tests, and the showcase sessions around lines 397–629. Run the existing Showcase nox sessions before changing them, then verify that unified system and unit runners preserve each listed variant, options, paths, and pytest behavior.
由索引模型根據 Issue 內容生成。
描述
Problem Summary
In packages/gapic-generator/noxfile.py, the test suite for the Showcase client has grown into over 10 distinct showcase_* sessions across system tests and unit tests.
While proto compilation and client generation were previously consolidated into the with showcase_library(...) context manager, the test execution logic inside the context blocks has suffered from copy-paste sprawl:
-
System Tests Duplication:
The sessionsshowcase,showcase_w_rest_async,showcase_mtls, andshowcase_pqc(lines 397–535) each duplicate a ~25-line block of setup, dependency installation, path resolution, andpy.testexecution. There is no sharedrun_showcase_system_tests()helper. Adding a flag, environment override (such as local core installation), or pytest option requires touching 4 separate sessions. -
Unit Tests Session Explosion:
There are 6 distinct unit test sessions (showcase_unit,showcase_unit_w_rest_async,showcase_unit_alternative_templates,showcase_unit_add_iam_methods,showcase_unit_mixins,showcase_unit_alternative_templates_mixinsacross lines 566–629) that simply pass different template options or flags toshowcase_libraryand then callrun_showcase_unit_tests().
This proliferation leads to maintenance drift, inconsistencies in flags, and makes targeted testing harder.
Proposed Refactor
Consolidate the duplicated sessions into unified, maintainable runners using @nox.parametrize or shared helper functions.
1. System Tests Refactor (Consolidate 4+ sessions into 1)
Instead of 4 copy-pasted sessions:
# Before: 4 duplicate sessions (showcase, showcase_w_rest_async, showcase_mtls, showcase_pqc)
@nox.session(python=ALL_PYTHON)
def showcase(session):
with showcase_library(session):
session.install("pytest", "pytest-asyncio<1.0.0")
...
session.run("py.test", ...)
@nox.session(python=ALL_PYTHON)
def showcase_w_rest_async(session):
with showcase_library(session, rest_async_io_enabled=True):
session.install("pytest", "pytest-asyncio<1.0.0")
...
session.run("py.test", ...)
Consolidate into a single parameterized session with a shared runner:
# After: Single parameterized system test session
SYSTEM_VARIANTS = {
"grpc": {"rest_async": False, "extra_args": []},
"rest_async": {"rest_async": True, "extra_args": []},
"mtls": {"rest_async": False, "extra_args": ["--mtls"]},
"pqc": {"rest_async": False, "extra_args": ["--tls"], "test_path": "tests/system/test_pqc.py"},
}
@nox.session(python=ALL_PYTHON)
@nox.parametrize("variant", list(SYSTEM_VARIANTS.keys()))
def showcase_system(session, variant):
"""Run all Showcase system tests through a unified runner."""
config = SYSTEM_VARIANTS[variant]
with showcase_library(session, rest_async_io_enabled=config["rest_async"]):
session.install("pytest", "pytest-asyncio<1.0.0")
if variant == "pqc":
session.install("--upgrade", "grpcio>=1.83.0", "grpcio-status>=1.83.0")
test_path = config.get("test_path", "tests/system")
session.run("py.test", "--quiet", *config["extra_args"], *(session.posargs or [test_path]))
2. Unit Tests Refactor (Consolidate 6 sessions into 1)
Instead of 6 distinct sessions calling run_showcase_unit_tests(), parametrize the template and option configurations:
# After: Single parameterized unit test session
UNIT_CONFIGS = {
"default": {"templates": "DEFAULT", "other_opts": ()},
"rest_async": {"templates": "DEFAULT", "rest_async_io_enabled": True},
"ads_old_naming": {"templates": ADS_TEMPLATES, "other_opts": ("old-naming",)},
"add_iam_methods": {"other_opts": ("add-iam-methods",), "fail_under": 100},
"mixins": {"include_service_yaml": True},
"ads_mixins": {"templates": ADS_TEMPLATES, "other_opts": ("old-naming",), "include_service_yaml": True},
}
@nox.session(python=ALL_PYTHON)
@nox.parametrize("config_name", list(UNIT_CONFIGS.keys()))
def showcase_unit(session, config_name):
"""Run all Showcase unit tests across template configurations."""
cfg = UNIT_CONFIGS[config_name]
with showcase_library(
session,
templates=cfg.get("templates", "DEFAULT"),
other_opts=cfg.get("other_opts", ()),
rest_async_io_enabled=cfg.get("rest_async_io_enabled", False),
include_service_yaml=cfg.get("include_service_yaml", False),
) as lib:
session.chdir(lib)
run_showcase_unit_tests(session, fail_under=cfg.get("fail_under", 100))
Benefits
- Zero Drift: All test invocation logic, constraint handling, and pytest argument handling exist in single shared locations.
- Simplified CI Workflows: Matrix jobs in GitHub Actions can cleanly target
showcase_systemorshowcase_unitwith-k <variant>. - Easier Extensibility: Adding canaries, local dependency overrides, or new transport profiles requires modifying a config dictionary rather than copy-pasting an entire session.
- 主要語言
- Python
- 星號
- 5.4k
- 分支
- 1.8k
- 平均合併
- 2 天 7 小時
- 30 天內合併 PR
- 173
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
googleapis/google-cloud-python 的其他 Issue
-
firestore: field path with a quoted name ending in a backslash is misparsed可能已有人在做 @sebxt 於 25 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
googleapis/google-cloud-python#18771 ·
維護者通常 1 天內回覆
-
api: spanner type: feature request
難度 2/5 1-3 小時 新手友好度 68/100
googleapis/google-cloud-python#18584 ·
維護者通常 1 天內回覆
-
auth: `impersonated_credentials` loses `subject` on copy, so `with_scopes()` and `with_quota_project()` turn off domain wide delegation可能已有人在做 @Om-singhaI 於 55 天前認領。 未關閉auth priority: p2 type: bug
難度 2/5 1-3 小時 新手友好度 88/100
googleapis/google-cloud-python#18428 ·
維護者通常 1 天內回覆
-
A client called `run_in_transaction` be stuck if Spanner is down可能已有人在做 @founderinaction 於 7 天前認領。 未關閉priority: p2 type: bug
難度 2/5 1-3 小時 新手友好度 72/100
googleapis/google-cloud-python#18375 · 1 則留言 ·
維護者通常 1 天內回覆
-
ci: enable --strict flag in presubmit twine_check可能重新可做 @ohmayr 於 44 天前認領,目前沒有進行中的 PR。 未關閉
難度 1/5 1 小時以內 新手友好度 76/100
googleapis/google-cloud-python#18339 · 1 則留言 · 已指派 1 人 ·
維護者通常 1 天內回覆
查看 googleapis/google-cloud-python 的全部 Issue
相似的 Issue
-
plot_graph crashes when a mesh node has no m2m edge可能已有人在做 @tygvi 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
mllam/neural-lam#883 · 1 則留言 ·
維護者通常 2 天內回覆
-
enhancement possible-duplicate
難度 1/5 1-3 小時 新手友好度 78/100
AOSSIE-Org/PictoPy#1715 · 2 則留言 ·
維護者通常 6 天內回覆
-
SQLite connector omits generated columns from the catalog, and drops relationships sourced on them未關閉
難度 2/5 1-3 小時 新手友好度 72/100
NVIDIA/auto-ontology#511 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
ethereum/execution-specs#3996 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 62/100
cpp-best-practices/project_validator#267 ·
維護者通常 1 天內回覆