scripts/run_bare_execution_tests.py - develop - vshmidt/streamlit

scripts/run_bare_execution_tests.py
124 строки4 KB
Ken McGrady
Update copyright header to 2026 (#13491)
02 янв 2026, 16:21
02 янв 2026, 16:21374540a
#!/usr/bin/env python

# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
Runs all the scripts in the e2e_playwright folder in "bare" mode - that is,
using `python [script]` as opposed to `streamlit run [script]`.

If any script exits with a non-zero status, this will also exit
with a non-zero status.
"""

from __future__ import annotations

import multiprocessing
import os
import subprocess
import sys
from multiprocessing import Lock
from multiprocessing.pool import ThreadPool
from typing import Final

import click

# Where we expect to find the example files.
E2E_DIRS: Final[list[str]] = [
    "e2e_playwright",
    "e2e_playwright/multipage_apps",
    "e2e_playwright/multipage_apps_v2",
]

# the hostframe_app.py script does not work because without a script_context
# the navigation function will raise an exception when trying some non-existing page properties.
EXCLUDED_FILENAMES: Final[set[str]] = {
    "compilation_error_dialog.py",
    "hostframe_app.py",
    "conftest.py",
}

# Since there is not DISPLAY set (and since Streamlit is not actually running
# and fixing Matplotlib in these tests), we set the MPL backend to something
# that doesn't require a display.
os.environ["MPLBACKEND"] = "Agg"


def _command_to_string(command: str | list[str]) -> str:
    return " ".join(command) if isinstance(command, list) else str(command)


def _get_filenames(folders: list[str]) -> list[str]:
    filenames = []

    for folder in folders:
        folder_path = os.path.abspath(folder)

        for filename in sorted(os.listdir(folder_path)):
            if (
                filename.endswith(".py")
                and not filename.endswith("_test.py")
                and filename not in EXCLUDED_FILENAMES
            ):
                filenames.append(os.path.join(folder_path, filename))

    return filenames


def run_commands(section_header: str, commands: list[str]) -> list[str]:
    """Run a list of commands, displaying them within the given section."""

    pool = ThreadPool(processes=max(1, multiprocessing.cpu_count() - 1))
    lock = Lock()
    failed_commands = []

    def process_command(arg: tuple[int, str]) -> None:
        i, command = arg

        # Display the status.
        click.secho(
            f"\nRunning {section_header} {i + 1}/{len(commands)} : {_command_to_string(command)}",
            bold=True,
        )

        # Run the command.
        result = subprocess.call(
            command.split(" "), stdout=subprocess.DEVNULL, stderr=None
        )
        if result != 0:
            with lock:
                failed_commands.append(command)

    pool.map(process_command, enumerate(commands))
    return failed_commands


def main() -> None:
    filenames = _get_filenames(E2E_DIRS)
    commands = [f"python {filename}" for filename in filenames]
    failed = run_commands("bare scripts", commands)

    if len(failed) == 0:
        click.secho("All scripts succeeded!", fg="green", bold=True)
        sys.exit(0)
    else:
        click.secho(
            "\n".join(_command_to_string(command) for command in failed), fg="red"
        )
        click.secho(f"\n{len(failed)} failed scripts: {failed}", fg="red", bold=True)
        sys.exit(-1)


if __name__ == "__main__":
    main()