pytest-bec-e2e 2.5.0__tar.gz

pytest_bec_e2e-2.5.0/.gitignore

@@ -0,0 +1,180 @@
+**/*_venv
+**/.idea
+*.log
+**/__pycache__
+**/.DS_Store
+**/out
+**/.vscode
+**/.pytest_cache
+**/*.egg*
+
+# recovery_config files
+recovery_config_*
+
+# file writer data
+**.h5
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/**/_build/
+docs/**/autodoc/
+docs/**/_autosummary/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+**.prof
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pytest_bec_e2e-2.5.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.3
+Name: pytest-bec-e2e
+Version: 2.5.0
+Summary: BEC pytest plugin for end-to-end tests
+Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec/issues
+Project-URL: Homepage, https://gitlab.psi.ch/bec/bec
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: bec-ipython-client
+Requires-Dist: bec-lib
+Requires-Dist: bec-server
+Requires-Dist: pytest
+Requires-Dist: pytest-redis

pytest_bec_e2e-2.5.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pytest-bec-e2e"
+version = "2.5.0"
+description = "BEC pytest plugin for end-to-end tests"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "bec_lib",
+    "bec_ipython_client",
+    "bec_server",
+    "pytest",
+    "pytest_redis",
+]
+
+[project.entry-points.pytest11]
+bec_end2end_fixtures = "pytest_bec_e2e.plugin"
+
+[project.urls]
+"Bug Tracker" = "https://gitlab.psi.ch/bec/bec/issues"
+Homepage = "https://gitlab.psi.ch/bec/bec"
+
+[tool.hatch.build.targets.wheel]
+include = ["*"]
+
+[tool.black]
+line-length = 100
+skip-magic-trailing-comma = true

pytest_bec_e2e-2.5.0/pytest_bec_e2e/plugin.py

@@ -0,0 +1,226 @@
+""" Fixtures for end-to-end tests """
+
+# pylint: skip-file
+import os
+import pathlib
+import platform
+import shutil
+import tempfile
+
+import pytest
+from pytest_redis import factories as pytest_redis_factories
+
+from bec_ipython_client import BECIPythonClient
+from bec_lib import BECClient, ConfigHelper, RedisConnector, ServiceConfig
+from bec_lib.tests.utils import wait_for_empty_queue
+
+
+@pytest.hookimpl
+def pytest_addoption(parser):
+    parser.addoption("--start-servers", action="store_true", default=False)
+    parser.addoption("--bec-redis-host", action="store", default="localhost")
+    parser.addoption("--bec-redis-cmd", action="store", default=None)
+    parser.addoption("--flush-redis", action="store_true", default=False)
+    parser.addoption("--files-path", action="store", default=None)
+
+
+redis_server_fixture = None
+bec_redis = None
+_start_servers = False
+bec_servers_scope = (
+    lambda fixture_name, config: config.getoption("--flush-redis") and "function" or "session"
+)
+
+services_config_template = """
+redis:
+  host: %(redis_host)s
+  port: %(redis_port)s
+mongodb:
+  host: "localhost"
+  port: 27017
+scibec:
+  host: http://localhost
+  port: 3030
+  beamline: TestBeamline
+service_config:
+  abort_on_ctrl_c: False
+  enforce_ACLs: False
+  file_writer:
+    plugin: default_NeXus_format
+    base_path: %(file_writer_base_path)s
+  log_writer:
+    base_path: %(file_writer_base_path)s
+"""
+
+
+def _check_path(file_path):
+    if os.path.exists(file_path):
+        return pathlib.Path(file_path)
+    else:
+        raise RuntimeError(
+            f"end2end tests: --files-path directory {repr(file_path)} does not exist"
+        )
+
+
+def _get_tmp_dir():
+    # on MacOS, gettempdir() returns path like /var/folders/nj/269977hs0_96bttwj2gs_jhhp48z54/T[...],
+    # and if building a Unix socket file (like pytest-redis does to connect to redis) it can
+    # exceed the 109 characters limit, so make a special case for MacOS
+    return pathlib.Path("/tmp" if platform.system() == "Darwin" else tempfile.gettempdir())
+
+
+@pytest.hookimpl
+def pytest_configure(config):
+    global redis_server_fixture
+    global bec_redis
+    global _start_servers
+    global _bec_servers_scope
+
+    if config.getoption("--start-servers"):
+        # configure 'datadir' == where redis Unix socket will go, and .rdb file (if any)
+        # try to use specified files path (hope it does not exceed 109 chars) or
+        # just use the normal tmp file directory except on MacOS where it must be enforced
+        # to /tmp
+        user_tmp_path = config.getoption("--files-path")
+        if user_tmp_path is not None:
+            datadir = _check_path(user_tmp_path)
+        else:
+            datadir = _get_tmp_dir()
+        # session-scoped fixture that starts redis using provided cmd
+        redis_server_fixture = pytest_redis_factories.proc.redis_proc(
+            executable=config.getoption("--bec-redis-cmd"), datadir=datadir
+        )
+
+        if config.getoption("--flush-redis"):
+            bec_redis = pytest_redis_factories.redisdb("redis_server_fixture")
+            _bec_servers_scope = "function"  # have to restart servers at each test
+        else:
+            bec_redis = redis_server_fixture
+    else:
+        # do not automatically start redis - bec_redis will use existing
+        # process, will wait for 3 seconds max (must be running already);
+        # there is no point checking if we want to flush redis
+        # since it would remove available scans which are only populated
+        # when scan server starts
+        redis_server_fixture = pytest_redis_factories.redis_noproc(
+            host=config.getoption("--bec-redis-host"), startup_timeout=3
+        )
+        bec_redis = redis_server_fixture
+
+    _start_servers = config.getoption("--start-servers")
+
+
+@pytest.fixture(scope=bec_servers_scope)
+def bec_files_path(request):
+    user_tmp_path = request.config.getoption("--files-path")
+    if user_tmp_path is not None:
+        yield _check_path(user_tmp_path)
+    else:
+        if request.config.getoption("--flush-redis"):
+            request.fixturenames.append("tmp_path")
+            yield request.getfixturevalue("tmp_path")
+        else:
+            request.fixturenames.append("tmp_path_factory")
+            yield request.getfixturevalue("tmp_path_factory").mktemp("bec_files")
+
+
+@pytest.fixture(scope=bec_servers_scope)
+def bec_services_config_file_path(bec_files_path):
+    return pathlib.Path(bec_files_path / "services_config.yaml")
+
+
+@pytest.fixture(scope=bec_servers_scope)
+def bec_test_config_file_path(bec_files_path):
+    return pathlib.Path(bec_files_path / "test_config.yaml")
+
+
+@pytest.fixture(scope=bec_servers_scope)
+def bec_servers(
+    test_config_yaml_file_path,
+    bec_services_config_file_path,
+    bec_test_config_file_path,
+    bec_files_path,
+    redis_server_fixture,
+):
+    # ensure configuration files are written where appropriate for tests,
+    # i.e. either in /tmp/pytest/... directory, or following user "--files-path"
+    # 1) test config (devices...)
+    shutil.copyfile(test_config_yaml_file_path, bec_test_config_file_path)
+    # 2) path where files are saved
+    file_writer_path = bec_services_config_file_path.parent  # / "writer_output"
+    # file_writer_path.mkdir(exist_ok=True)
+    # 3) services config
+    with open(bec_services_config_file_path, "w") as services_config_file:
+        services_config_file.write(
+            services_config_template
+            % {
+                "redis_host": redis_server_fixture.host,
+                "redis_port": redis_server_fixture.port,
+                "file_writer_base_path": file_writer_path,
+            }
+        )
+
+    if _start_servers:
+        from bec_server.bec_server_utils.service_handler import ServiceHandler
+
+        # Start all BEC servers, kill them at the end
+        # when no_tmux=True, 'bec_path' indicate the cwd
+        # for the process (working directory), i.e. where log files will go
+        service_handler = ServiceHandler(
+            bec_path=bec_files_path, config_path=bec_services_config_file_path, no_tmux=True
+        )
+        processes = service_handler.start()
+        try:
+            yield
+        finally:
+            for process in processes:
+                process.terminate()
+            for process in processes:
+                os.waitpid(process.pid, 0)
+    else:
+        # Nothing to do here: servers are supposed to be started externally.
+        yield
+
+
+@pytest.fixture
+def bec_ipython_client_with_demo_config(bec_redis, bec_services_config_file_path, bec_servers):
+    config = ServiceConfig(bec_services_config_file_path)
+    bec = BECIPythonClient(config, RedisConnector, forced=True)
+    bec.start()
+    ConfigHelper(bec._client.connector).load_demo_config()
+    try:
+        yield bec
+    finally:
+        bec.shutdown()
+        bec._client._reset_singleton()
+
+
+@pytest.fixture
+def bec_client_lib_with_demo_config(bec_redis, bec_services_config_file_path, bec_servers):
+    config = ServiceConfig(bec_services_config_file_path)
+    bec = BECClient(config, RedisConnector, forced=True, wait_for_server=True)
+    bec.start()
+    ConfigHelper(bec._client.connector).load_demo_config()
+    try:
+        yield bec
+    finally:
+        bec.shutdown()
+        bec._client._reset_singleton()
+
+
+@pytest.fixture
+def bec_ipython_client_fixture(bec_ipython_client_with_demo_config):
+    bec = bec_ipython_client_with_demo_config
+    bec.queue.request_queue_reset()
+    bec.queue.request_scan_continuation()
+    wait_for_empty_queue(bec)
+    yield bec
+
+
+@pytest.fixture
+def bec_client_lib(bec_client_lib_with_demo_config):
+    bec = bec_client_lib_with_demo_config
+    bec.queue.request_queue_reset()
+    bec.queue.request_scan_continuation()
+    wait_for_empty_queue(bec)
+    yield bec