Files
OpenBB/cookiecutter/tests/test_template.py
dlee-bq 53d4dcc46d [Feature] Drop Python 3.10 and Resolve Open Dependabot Alerts (#7804)
* Drop Python 3.10 support

Python 3.10 reached end of life on 2026-10-01, and the patched releases of
Pillow (13.0.0) and filelock (>=4.2.1) require Python >=3.11, so the 3.10
resolution fork kept vulnerable versions in every lockfile.

- requires-python = ">=3.11,<4" in all pyproject.toml files, the
  cookiecutter template, and the CLI codegen project template
- CI: drop the ubuntu 3.10 matrix rows, move the macOS/Windows minimum
  rows and the lint jobs to 3.11, drop 3.10 from the nox sessions
- READMEs: state 3.11 as the minimum supported version

* Relock with patched certifi, filelock, virtualenv, Pillow, and fastmcp

Regenerate all 38 uv.lock files against requires-python >=3.11 and upgrade
only the packages with open Dependabot advisories:

- certifi 2026.7.22 -> 2026.10.23 (GHSA-6q48-6c7w-9gw2, compromised emSign CAs)
- virtualenv 21.14.7 -> 21.14.13
- filelock 4.1.0/4.2.0 -> 4.2.4
- Pillow 12.3.0 -> 13.0.0
- fastmcp / fastmcp-slim 4.1.0 -> 4.1.3

All other changes are removed Python 3.10-only resolution forks; no other
package changes version for Python 3.11+.

* desktop: bump zod, @hookform/resolvers, and vitest

- zod ^3.25.76 -> ^4.6.7 (GHSA-mrhx-c7xc-m3w5; no patched 3.x exists)
- @hookform/resolvers ^3.10.0 -> ^5.9.2 for zod 4 support
- vitest ^4.1.11 -> ^4.1.12 (@vitest/mocker GHSA-qxg6-89mg-rqv8,
  GHSA-xp26-3454-mjgp)
- override zod to the root version so @openbb/ui-pro, which declares
  zod ^3 but never imports it, does not pull in a second, vulnerable copy

* desktop: remove Python 3.10 from environment pickers

- version pickers in InstallComponents and AddExtensionSelector start at 3.11
- create_environment_from_requirements accepts 3.11 through 3.14 and falls
  back to 3.12 otherwise (previously 3.10 through 3.13)
- component tests select 3.11 instead of 3.10

* Remove Python 3.10 tomli fallbacks

With requires-python >=3.11, tomllib is always available, so the
version-conditional tomli imports are dead code.

- import tomllib directly in the cli and core config loaders, the
  mcp_server and platform_api config validators, dev_install.py, and
  the cli and cookiecutter tests; dev_install.py no longer pip-installs
  tomli on the fly
- drop the tomli>=2.0; python_version<'3.11' dependency from cli, core,
  mcp_server, and platform_api, plus platform_api's backport comment
- raise the fake-extension fixtures in cli/conftest.py,
  core/integration/conftest.py, and the charting test metadata to
  >=3.11
- relock cli, core, mcp_server, and platform_api; only the tomli
  requires-dist entry is removed and resolution markers are reordered,
  no package versions change

* Target Python 3.11 in ruff and ty for cli, core, mcp_server, platform_api, cookiecutter

With ruff target-version py310 and ty python-version 3.10, both tools
reject an unconditional `import tomllib`: ty reports it as unresolved
(exit 1) and ruff's isort classifies it as third-party. Raise the targets
in the projects that now import tomllib directly, and in the root
ruff.toml that governs dev_install.py.

- ruff target-version = "py311" and ty python-version = "3.11" in cli,
  core, mcp_server, platform_api, and cookiecutter; root ruff.toml
  target-version = "py311"
- UP042: OutputMode, ChartLifecycle, MCPType, and HTTPMethod become
  StrEnum; every consumer uses .value or == comparisons, so only str()
  and format() output change
- UP017: datetime.timezone.utc -> datetime.UTC (ruff autofix) in the cli
  dispatchers, the cli test generator, and a core test

* Fix ruff and ty failures in packages this PR touches

CI installs unpinned dependencies, so the lint jobs ran against
pandas 3.1.0, ruff 0.17.2, and ty 0.0.91.

- cli/conftest.py: guard the find_spec("openbb") lookup so ty no longer
  reports an Optional ModuleSpec/origin (failing Lint openbb-cli)
- quantitative: pandas 3.1 types Index.max() as object; cast max_date to
  Timestamp before period_start in attribution, factors, and
  risk_decomposition (failing ty)
- federal_reserve: use Series(...).dt.date instead of
  DatetimeIndex.date so neither pandas 3.0 nor 3.1 needs a ty: ignore
  (pandas 3.1 made the existing ignores unused, failing ty)
- core tests: type the filter_by_dates doubles as Data subclasses and
  cast the deliberate bad arguments in test_helpers.py; apply ruff format
  to test_docstring_generator_helpers.py
- platform_api README: apply ruff format to the Python code blocks

* Fix pandas 3.1 deprecations failing fred, sec, and eia tests

These suites turn warnings into errors, and pandas 3.1.0 adds
Pandas4Warning deprecations for several patterns they use. Every change
also passes with the locked pandas 3.0.6.

- fred, sec: replace inplace=True sort_values/reset_index/rename/
  set_index/drop with reassignment
- fred balance_of_payments, sec as_filed_widget: replace fillna with a
  string on float columns by astype(object).where(notna, ...)
- sec: build quarter start dates from ISO strings instead of parsing
  "2024Q2"-style strings; use the DataFrame constructor instead of
  DataFrame.from_records for column dicts; pad CIK lookup rows to two
  fields instead of constructing a ragged DataFrame
- eia: read EIA workbooks with the calamine engine (xlrd is deprecated);
  replace the xlrd dependency with python-calamine and relock; calamine
  workbooks are not safe for concurrent reads, so the petroleum status
  report serializes its sheet reads with a lock

* imf: fall back to the published catalog when the IMF API is unreachable

imf_cache.json.xz is generated at build time and is not committed, so
every CI build of openbb-imf needed a live api.imf.org. The only fallback
was actions/cache, and caches saved by pull_request runs are scoped to
that PR, so a new PR never had one. With api.imf.org returning
"503 no healthy upstream" during IMF's data portal maintenance window,
the build failed.

When live generation fails on a non-forced build, the hook now copies
imf_cache.json.xz from the latest openbb-imf wheel on PyPI, after
checking the wheel's sha256 against the digest PyPI publishes. Builds
with OPENBB_IMF_FORCE_CACHE_REBUILD=1, which the publish workflow sets,
still fail hard, so a release never ships a stale catalog.

---------

Co-authored-by: dlee-bq <325002271+dlee-bq@users.noreply.github.com>
2026-11-01 18:16:45 +00:00

210 lines
7.2 KiB
Python

"""Tests for the project template."""
import shutil
import subprocess
import sys
import tomllib
from pathlib import Path
import pytest
from cookiecutter.exceptions import FailedHookException
from cookiecutter.main import cookiecutter
from openbb_cookiecutter import get_template_path
PACKAGE = "extension_template"
def generate(tmp_path: Path, extension_types: str, **context: str) -> Path:
return Path(
cookiecutter(
str(get_template_path()),
output_dir=str(tmp_path),
no_input=True,
extra_context={"extension_types": extension_types, **context},
)
)
def files(project: Path) -> set[str]:
return {
p.relative_to(project).as_posix() for p in project.rglob("*") if p.is_file()
}
def entry_points(project: Path) -> dict:
return tomllib.loads((project / "pyproject.toml").read_text(encoding="utf-8"))[
"project"
].get("entry-points", {})
class TestGeneratedFiles:
"""Each extension type generates only its own modules and tests."""
@pytest.mark.parametrize(
("extension_types", "expected"),
[
(
"router",
{
f"{PACKAGE}/routers/template.py",
"tests/test_router.py",
},
),
(
"provider",
{
f"{PACKAGE}/providers/template/models/example.py",
f"{PACKAGE}/providers/template/models/equity_historical.py",
"tests/test_provider.py",
},
),
(
"obbject",
{
f"{PACKAGE}/obbject/template_ext/__init__.py",
"tests/test_obbject.py",
},
),
(
"on_command_output",
{
f"{PACKAGE}/obbject/template_ext/on_command_output.py",
"tests/test_on_command_output.py",
},
),
(
"charting",
{
f"{PACKAGE}/routers/template_views.py",
"tests/test_views.py",
},
),
],
)
def test_single_type(self, tmp_path, extension_types, expected):
generated = files(generate(tmp_path, extension_types))
optional = {
f"{PACKAGE}/routers/template.py",
f"{PACKAGE}/routers/template_views.py",
f"{PACKAGE}/providers/template/models/example.py",
f"{PACKAGE}/obbject/template_ext/on_command_output.py",
"tests/test_router.py",
"tests/test_views.py",
"tests/test_provider.py",
"tests/test_obbject.py",
"tests/test_on_command_output.py",
}
assert expected <= generated
assert not (optional - expected) & generated
def test_all_types(self, tmp_path):
generated = files(generate(tmp_path, "all"))
assert {
"pyproject.toml",
"README.md",
".gitignore",
f"{PACKAGE}/routers/template.py",
f"{PACKAGE}/routers/template_views.py",
f"{PACKAGE}/providers/template/__init__.py",
f"{PACKAGE}/obbject/template_ext/__init__.py",
f"{PACKAGE}/obbject/template_ext/on_command_output.py",
"tests/test_router.py",
"tests/test_views.py",
"tests/test_provider.py",
"tests/test_obbject.py",
"tests/test_on_command_output.py",
} <= generated
def test_local_artifacts_are_not_copied(self, tmp_path):
generated = files(generate(tmp_path, "all"))
artifacts = (".ruff_cache", ".ipynb_checkpoints", "__pycache__", ".DS_Store")
assert not [f for f in generated if any(a in f for a in artifacts)]
class TestPyproject:
"""The generated pyproject declares V5 packaging and entry points."""
def test_build_and_dependencies(self, tmp_path):
pyproject = tomllib.loads(
(generate(tmp_path, "all") / "pyproject.toml").read_text(encoding="utf-8")
)
assert pyproject["build-system"]["build-backend"] == "hatchling.build"
assert pyproject["project"]["dependencies"] == ["openbb-core[pandas]>=2.0.0"]
assert pyproject["project"]["optional-dependencies"] == {
"charting": ["openbb-charting>=3.0.0"]
}
assert "openbb-devtools>=2.0.1" in pyproject["dependency-groups"]["dev"]
def test_entry_points_for_all_types(self, tmp_path):
assert entry_points(generate(tmp_path, "all")) == {
"openbb_core_extension": {
"template": f"{PACKAGE}.routers.template:router",
},
"openbb_charting_extension": {
"template": f"{PACKAGE}.routers.template_views:TemplateViews",
},
"openbb_provider_extension": {
"template": f"{PACKAGE}.providers.template:template_provider",
},
"openbb_obbject_extension": {
"to_string": f"{PACKAGE}.obbject.template_ext:ext",
"template_ext": f"{PACKAGE}.obbject.template_ext:class_ext",
"nonblocking_plugin": (
f"{PACKAGE}.obbject.template_ext.on_command_output:nonblocking_plugin"
),
},
}
def test_entry_points_for_router_only(self, tmp_path):
assert entry_points(generate(tmp_path, "router")) == {
"openbb_core_extension": {
"template": f"{PACKAGE}.routers.template:router",
},
}
class TestHooks:
"""The post-generation hook validates names."""
def test_rejects_invalid_package_name(self, tmp_path):
with pytest.raises(FailedHookException):
generate(tmp_path, "router", package_name="1-bad")
def test_rejects_shared_provider_and_obbject_name(self, tmp_path):
with pytest.raises(FailedHookException):
generate(tmp_path, "all", obbject_name="template")
@pytest.mark.skipif(shutil.which("ruff") is None, reason="ruff is not installed")
class TestGeneratedCodeQuality:
"""Generated projects pass their own lint and type checks."""
@pytest.mark.parametrize(
"extension_types",
["router", "provider", "obbject", "on_command_output", "charting", "all"],
)
def test_ruff(self, tmp_path, extension_types):
project = generate(tmp_path, extension_types)
for command in (["format", "--check"], ["check", "--no-fix"]):
result = subprocess.run(
["ruff", *command, "--no-cache", "."],
cwd=project,
capture_output=True,
text=True,
check=False,
)
assert result.returncode == 0, result.stdout + result.stderr
@pytest.mark.skipif(shutil.which("ty") is None, reason="ty is not installed")
def test_ty(self, tmp_path):
project = generate(tmp_path, "all")
result = subprocess.run(
["ty", "check", "--python", sys.executable, PACKAGE],
cwd=project,
capture_output=True,
text=True,
check=False,
)
assert result.returncode == 0, result.stdout + result.stderr