Upload 4 files

openbb_platform/tests/conftest.py

@@ -0,0 +1,12 @@
+"""Configuration for pytest."""
+
+# TODO: See if we can dynamically import the test modules under the openbb_platform
+
+# TODO: Add global fixture for headers here
+
+import os
+
+
+def pytest_configure():
+    """Set environment variables for testing."""
+    os.environ["OPENBB_AUTO_BUILD"] = "false"

openbb_platform/tests/test_auto_build.py

@@ -0,0 +1,33 @@
+"""Test the auto_build feature."""
+
+import importlib
+import sys
+from unittest.mock import patch
+
+import pytest
+
+# pylint: disable=redefined-outer-name, unused-import, import-outside-toplevel
+
+
+@pytest.fixture(autouse=True)
+def setup_mocks():
+    """Set up mocks for the test."""
+    with patch("openbb._PackageBuilder.auto_build") as mock_auto_build:
+        mock_auto_build.return_value = None
+        yield mock_auto_build
+
+
+@pytest.fixture
+def openbb_module(setup_mocks):
+    """Reload the openbb module."""
+    if "openbb" in sys.modules:
+        importlib.reload(sys.modules["openbb"])
+    else:
+        pass
+    return setup_mocks
+
+
+@pytest.mark.integration
+def test_autobuild_called(openbb_module):
+    """Test that auto_build is called upon importing openbb."""
+    openbb_module.assert_called_once()

openbb_platform/tests/test_extension_map.py

@@ -0,0 +1,59 @@
+"""Test the extension map."""
+
+import json
+from pathlib import Path
+from typing import Dict
+
+from poetry.core.constraints.version import Version, VersionConstraint, parse_constraint
+from poetry.core.pyproject.toml import PyProjectTOML
+
+
+def create_ext_map(extensions: dict) -> Dict[str, Version]:
+    """Create the extension map from extension."""
+    ext_map = {}
+    for _, v in extensions.items():
+        for value in v:
+            name, version = value.split("@")
+            ext_map[name] = Version.parse(version)
+    return ext_map
+
+
+def load_req_ext(file: Path) -> Dict[str, VersionConstraint]:
+    """Load the required extensions from pyproject.toml."""
+    pyproject = PyProjectTOML(file)
+    deps = pyproject.data["tool"]["poetry"]["dependencies"]
+    req_ext = {}
+    for k, v in deps.items():
+        if k.startswith("openbb-") and k not in ("openbb-core"):
+            name = k[7:].replace("-", "_")
+            if isinstance(v, str):
+                req_ext[name] = parse_constraint(v)
+            elif isinstance(v, dict) and not v.get("optional", False):
+                req_ext[name] = parse_constraint(v["version"])
+    return req_ext
+
+
+def test_extension_map():
+    """Ensure only required extensions are built and versions respect pyproject.toml"""
+    this_dir = Path(__file__).parent
+    with open(Path(this_dir, "..", "openbb", "assets", "reference.json")) as f:
+        reference = json.load(f)
+    ext_map = create_ext_map(reference.get("info", {}).get("extensions", {}))
+    req_ext = load_req_ext(Path(this_dir, "..", "pyproject.toml"))
+
+    for ext in req_ext:
+        if ext != "platform_api":
+            assert ext in ext_map, (
+                f"Extension '{ext}' is required in pyproject.toml but is not built, install"
+                " it and rebuild or remove it from mandatory requirements in pyproject.toml"
+            )
+
+    for name, version in ext_map.items():
+        assert name in req_ext, (
+            f"'{name}' is not a required extension in pyproject.toml, uninstall it and"
+            " rebuild, or add it to pyproject.toml"
+        )
+        assert req_ext[name].allows(version), (
+            f"Version '{version}' of extension '{name}' is not compatible with the"
+            f" version '{req_ext[name]}' constraint in pyproject.toml"
+        )

openbb_platform/tests/test_pyproject_toml.py

@@ -0,0 +1,68 @@
+"""Test the pyproject.toml file for consistency and its dependencies."""
+
+import glob
+import os
+from pathlib import Path
+
+from tomlkit import load
+
+ROOT_DIR = Path(__file__).parent.parent
+
+
+def test_optional_packages():
+    """Ensure only required extensions are built and versions respect pyproject.toml"""
+    with open(ROOT_DIR / "pyproject.toml") as f:
+        data = load(f)
+    dependencies = data["tool"]["poetry"]["dependencies"]
+    extras = data["tool"]["poetry"]["extras"]
+    all_packages = extras["all"]
+
+    default_packages = []
+    optional_packages = []
+
+    for package, details in dependencies.items():
+        if isinstance(details, dict) and details.get("optional") is True:
+            optional_packages.append(package)
+        else:
+            default_packages.append(package)
+
+    # check that optional packages have the same content as all_packages and extras
+    assert sorted(optional_packages) == sorted(all_packages)
+    assert sorted(optional_packages) == sorted(extras["all"])
+
+    # assert that there is no overlap between default and optional packages
+    assert set(default_packages).isdisjoint(set(optional_packages))
+
+
+def test_default_package_files():
+    """Ensure only required extensions are built and versions respect pyproject.toml"""
+    with open(ROOT_DIR / "pyproject.toml") as f:
+        data = load(f)
+    dependencies = data["tool"]["poetry"]["dependencies"]
+    package_files = glob.glob("openbb_platform/openbb/package/*.py")
+
+    invalid_packages = []
+    default_packages = []
+
+    for package, details in dependencies.items():
+        if isinstance(details, dict) is False:
+            default_packages.append(package)
+
+    for file_path in package_files:
+        package_name = os.path.basename(file_path).replace(".py", "")
+        if package_name.startswith("_"):
+            continue
+        if "_" in package_name:
+            base_package = package_name.split("_")[0]
+            if "openbb-" + base_package not in default_packages:
+                invalid_packages.append(package_name)
+        elif "openbb-" + package_name not in default_packages:
+            invalid_packages.append(package_name)
+
+    assert not invalid_packages, (
+        f"If not making a PR, ignore this error -> "
+        f"Found non-required extension static assets: {invalid_packages}. "
+        f"Only required packages should be committed."
+        f"Please create a new environment with only required extensions, "
+        f"rebuild the static assets, and commit the changes."
+    )