Import test (#30)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.github/workflows/build.yml

@@ -234,6 +234,24 @@ jobs:
           activate-environment: pyodide-env
           use-mamba: true
 
+      - name: Get Date
+        id: get-date
+        run: echo "today=$(/bin/date -u '+%Y%m%d')" >> $GITHUB_OUTPUT
+        shell: bash
+
+      - name: Cache Conda env
+        id: conda-cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.CONDA }}/envs
+          key:
+            conda-${{ runner.os }}-${{ steps.get-date.outputs.today }}-${{ hashFiles('environment.yml') }}-${{ env.CONDA_CACHE_NUMBER }}
+
+      - name: Update environment if cache miss
+        run:
+          mamba env update -n pyodide-env -f environment.yml
+        if: steps.conda-cache.outputs.cache-hit != 'true'
+
       - name: Download latest Pyodide
         shell: bash -l {0}
         run: |
@@ -258,8 +276,10 @@ jobs:
           cp ./repodata/* ./dist/
 
       - name: Install test dependencies
+        shell: bash -l {0}
         run: |
-          pip install -r requirements.txt
+          which python
+          echo y | python -m pip install -r requirements.txt
 
       - name: Run tests
         shell: bash -l {0}

packages/test_packages_common.py

@@ -0,0 +1,120 @@
+import functools
+import os
+import time
+from typing import Any
+from pathlib import Path
+
+from pytest_pyodide.runner import _BrowserBaseRunner
+from pytest_pyodide.utils import package_is_built as _package_is_built
+import pytest
+
+from conftest import package_is_built
+from pyodide_build.io import MetaConfig
+
+PKG_DIR = Path(__file__).parent
+
+UNSUPPORTED_PACKAGES: dict[str, list[str]] = {
+    "chrome": [],
+    "firefox": [],
+    "safari": [],
+    "node": ["cmyt", "yt", "galpy"],
+}
+if "CI" in os.environ:
+    UNSUPPORTED_PACKAGES["chrome"].extend(["statsmodels"])
+
+XFAIL_PACKAGES: dict[str, str] = {
+    "soupsieve": "Importing soupsieve without installing beautifulsoup4 fails.",
+}
+
+
+@functools.cache
+def registered_packages() -> list[str]:
+    """Returns a list of registered package names"""
+    packages = []
+    for name in os.listdir(PKG_DIR):
+        if (PKG_DIR / name).is_dir() and (PKG_DIR / name / "meta.yaml").exists():
+            packages.append(name)
+
+    return packages
+
+
+def package_is_built(package_name):
+    return _package_is_built(package_name, pytest.pyodide_dist_dir)
+
+
+@pytest.mark.parametrize("name", registered_packages())
+def test_parse_package(name: str) -> None:
+    # check that we can parse the meta.yaml
+    meta = MetaConfig.from_yaml(PKG_DIR / name / "meta.yaml")
+
+    sharedlibrary = meta.build.package_type == "shared_library"
+    if name == "sharedlib-test":
+        assert sharedlibrary is True
+    elif name == "sharedlib-test-py":
+        assert sharedlibrary is False
+
+
+@pytest.mark.skip_refcount_check
+@pytest.mark.driver_timeout(120)
+@pytest.mark.parametrize("name", registered_packages())
+@pytest.mark.benchmark(
+    max_time=3,
+    min_rounds=1,
+    timer=time.perf_counter,
+)
+def test_import(
+    name: str, selenium_standalone: _BrowserBaseRunner, benchmark: Any
+) -> None:
+    if not package_is_built(name):
+        raise AssertionError(
+            "Implementation error. Test for an unbuilt package "
+            "should have been skipped in selenium_standalone fixture"
+        )
+
+    if name in XFAIL_PACKAGES:
+        pytest.xfail(XFAIL_PACKAGES[name])
+
+    meta = MetaConfig.from_yaml(PKG_DIR / name / "meta.yaml")
+
+    if name in UNSUPPORTED_PACKAGES[selenium_standalone.browser]:
+        pytest.xfail(
+            "{} fails to load and is not supported on {}.".format(
+                name, selenium_standalone.browser
+            )
+        )
+
+    selenium_standalone.run("import glob, os, site")
+
+    def _get_file_count(expr):
+        return selenium_standalone.run(
+            f"""
+            len(list(glob.glob(
+                site.getsitepackages()[0] + '{expr}',
+                recursive=True)
+            ))
+            """
+        )
+
+    import_names = meta.test.imports
+    if not import_names:
+        import_names = meta.package.top_level
+
+    if not import_names:
+        # Nothing to test
+        return
+
+    def _import_pkg():
+        for import_name in import_names:
+            selenium_standalone.run_async("import %s" % import_name)
+
+    benchmark(_import_pkg)
+
+    # Make sure that after importing, either .py or .pyc are present but not
+    # both
+    pyc_count = sum(_get_file_count(f"/{key}/**/*.pyc") for key in import_names)
+    py_count = sum(_get_file_count(f"/{key}/**/*.py") for key in import_names)
+
+    assert not ((py_count > 0) and (pyc_count > 0))
+
+    # Make sure no exe files were loaded!
+    assert _get_file_count("/**/*.exe") == 0

requirements.txt

@@ -1,5 +1,9 @@
 pytest
 pytest-pyodide==0.58.3
 pytest-httpserver
+pytest-benchmark
 auditwheel-emscripten
 pytest-asyncio
+pyodide-build
+zstandard
+brotli