hardpy 0.10.1__py3-none-any.whl → 0.11.1__py3-none-any.whl

hardpy/__init__.py

@@ -1,7 +1,7 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from hardpy.common.stand_cloud import StandCloudError
+from hardpy.common.stand_cloud import StandCloudConnector, StandCloudError
 from hardpy.pytest_hardpy.pytest_call import (
     clear_operator_message,
     get_current_attempt,
@@ -20,7 +20,11 @@ from hardpy.pytest_hardpy.pytest_call import (
     set_stand_location,
     set_stand_name,
 )
-from hardpy.pytest_hardpy.result import CouchdbLoader, StandCloudLoader
+from hardpy.pytest_hardpy.result import (
+    CouchdbLoader,
+    StandCloudLoader,
+    StandCloudReader,
+)
 from hardpy.pytest_hardpy.result.couchdb_config import CouchdbConfig
 from hardpy.pytest_hardpy.utils import (
     BaseWidget,
@@ -30,6 +34,7 @@ from hardpy.pytest_hardpy.utils import (
     DuplicateSerialNumberError,
     DuplicateTestStandLocationError,
     DuplicateTestStandNameError,
+    HTMLComponent,
     ImageComponent,
     MultistepWidget,
     NumericInputWidget,
@@ -48,12 +53,15 @@ __all__ = [
     "DuplicateSerialNumberError",
     "DuplicateTestStandLocationError",
     "DuplicateTestStandNameError",
+    "HTMLComponent",
     "ImageComponent",
     "MultistepWidget",
     "NumericInputWidget",
     "RadiobuttonWidget",
+    "StandCloudConnector",
     "StandCloudError",
     "StandCloudLoader",
+    "StandCloudReader",
     "StepWidget",
     "TextInputWidget",
     "clear_operator_message",

hardpy/cli/cli.py

@@ -6,11 +6,12 @@ import sys
 from pathlib import Path
 from typing import Annotated, Optional
 
+import requests
 import typer
 from uvicorn import run as uvicorn_run
 
 from hardpy.cli.template import TemplateGenerator
-from hardpy.common.config import ConfigManager
+from hardpy.common.config import ConfigManager, HardpyConfig
 from hardpy.common.stand_cloud import (
     StandCloudConnector,
     StandCloudError,
@@ -31,6 +32,10 @@ default_config = ConfigManager().get_config()
 @cli.command()
 def init(  # noqa: PLR0913
     tests_dir: Annotated[Optional[str], typer.Argument()] = None,
+    tests_name: str = typer.Option(
+        default="",
+        help="Specify a tests suite name.",
+    ),
     create_database: bool = typer.Option(
         default=True,
         help="Create CouchDB database.",
@@ -59,14 +64,6 @@ def init(  # noqa: PLR0913
         default=default_config.frontend.port,
         help="Specify a frontend port.",
     ),
-    socket_host: str = typer.Option(
-        default=default_config.socket.host,
-        help="Specify a socket host.",
-    ),
-    socket_port: int = typer.Option(
-        default=default_config.socket.port,
-        help="Specify a socket port.",
-    ),
     sc_address: str = typer.Option(
         default="",
         help="Specify a StandCloud address.",
@@ -80,6 +77,7 @@ def init(  # noqa: PLR0913
 
     Args:
         tests_dir (str | None): Tests directory. Current directory + `tests` by default
+        tests_name (str): Tests suite name, "Tests" by default
         create_database (bool): Flag to create database
         database_user (str): Database user name
         database_password (str): Database password
@@ -87,22 +85,20 @@ def init(  # noqa: PLR0913
         database_port (int): Database port
         frontend_host (str): Panel operator host
         frontend_port (int): Panel operator port
-        socket_host (str): Socket host
-        socket_port (int): Socket port
         sc_address (str): StandCloud address
         sc_connection_only (bool): Flag to check StandCloud service availability
     """
     _tests_dir = tests_dir if tests_dir else default_config.tests_dir
+    _tests_name = tests_name if tests_name else default_config.tests_name
     ConfigManager().init_config(
         tests_dir=str(_tests_dir),
+        tests_name=_tests_name,
         database_user=database_user,
         database_password=database_password,
         database_host=database_host,
         database_port=database_port,
         frontend_host=frontend_host,
         frontend_port=frontend_port,
-        socket_host=socket_host,
-        socket_port=socket_port,
         sc_address=sc_address,
         sc_connection_only=sc_connection_only,
     )
@@ -164,6 +160,48 @@ def run(tests_dir: Annotated[Optional[str], typer.Argument()] = None) -> None:
     )
 
 
+@cli.command()
+def start(tests_dir: Annotated[Optional[str], typer.Argument()] = None) -> None:
+    """Start HardPy tests.
+
+    Args:
+        tests_dir (Optional[str]): Test directory. Current directory by default
+    """
+    config = _get_config(tests_dir)
+    _check_config(config)
+
+    url = f"http://{config.frontend.host}:{config.frontend.port}/api/start"
+    _request_hardpy(url)
+
+
+@cli.command()
+def stop(tests_dir: Annotated[Optional[str], typer.Argument()] = None) -> None:
+    """Stop HardPy tests.
+
+    Args:
+        tests_dir (Optional[str]): Test directory. Current directory by default
+    """
+    config = _get_config(tests_dir)
+    _check_config(config)
+
+    url = f"http://{config.frontend.host}:{config.frontend.port}/api/stop"
+    _request_hardpy(url)
+
+
+@cli.command()
+def status(tests_dir: Annotated[Optional[str], typer.Argument()] = None) -> None:
+    """Get HardPy test launch status.
+
+    Args:
+        tests_dir (Optional[str]): Test directory. Current directory by default
+    """
+    config = _get_config(tests_dir)
+    _check_config(config)
+
+    url = f"http://{config.frontend.host}:{config.frontend.port}/api/status"
+    _request_hardpy(url)
+
+
 @cli.command()
 def sc_login(
     address: Annotated[str, typer.Argument()],
@@ -207,5 +245,45 @@ def sc_logout() -> None:
         print("HardPy logout failed")
 
 
+def _get_config(tests_dir: str | None = None) -> HardpyConfig:
+    dir_path = Path.cwd() / tests_dir if tests_dir else Path.cwd()
+    config = ConfigManager().read_config(dir_path)
+
+    if not config:
+        print(f"Config at path {dir_path} not found.")
+        sys.exit()
+
+    return config
+
+
+def _check_config(config: HardpyConfig) -> None:
+    url = f"http://{config.frontend.host}:{config.frontend.port}/api/hardpy_config"
+    error_msg = f"HardPy in directory {config.tests_dir} does not run."
+    try:
+        response = requests.get(url, timeout=2)
+    except Exception:
+        print(error_msg)
+        sys.exit()
+
+    running_config: dict = response.json()
+    if config.model_dump() != running_config:
+        print(error_msg)
+        sys.exit()
+
+
+def _request_hardpy(url: str) -> None:
+    try:
+        response = requests.get(url, timeout=2)
+    except Exception:
+        print("HardPy operator panel is not running.")
+        sys.exit()
+    try:
+        status: dict = response.json().get("status", "ERROR")
+    except ValueError:
+        print(f"Hardpy internal error: {response}.")
+        sys.exit()
+    print(f"HardPy status: {status}.")
+
+
 if __name__ == "__main__":
     cli()

hardpy/cli/template.py

@@ -138,8 +138,6 @@ log_cli_format = %%(asctime)s [%%(levelname)s] %%(message)s
 log_cli_date_format = %H:%M:%S
 addopts = --hardpy-pt
           --hardpy-db-url http://{}:{}@{}:{}/
-          --hardpy-sh {}
-          --hardpy-sp {}
 """
 
 test_1_py = """import pytest
@@ -207,8 +205,6 @@ class TemplateGenerator:
             self._config.database.password,
             self._config.database.host,
             self._config.database.port,
-            self._config.socket.host,
-            self._config.socket.port,
         )
 
     @property

hardpy/common/config.py

@@ -42,14 +42,6 @@ class FrontendConfig(BaseModel):
     port: int = 8000
 
 
-class SocketConfig(BaseModel):
-    """Socket configuration."""
-
-    model_config = ConfigDict(extra="forbid")
-
-    host: str = "localhost"
-    port: int = 6525
-
 class StandCloudConfig(BaseModel):
     """StandCloud configuration."""
 
@@ -58,16 +50,16 @@ class StandCloudConfig(BaseModel):
     address: str = ""
     connection_only: bool = False
 
-class HardpyConfig(BaseModel):
+class HardpyConfig(BaseModel, extra="allow"):
     """HardPy configuration."""
 
     model_config = ConfigDict(extra="forbid")
 
     title: str = "HardPy TOML config"
     tests_dir: str = "tests"
+    tests_name: str = ""
     database: DatabaseConfig = DatabaseConfig()
     frontend: FrontendConfig = FrontendConfig()
-    socket: SocketConfig = SocketConfig()
     stand_cloud: StandCloudConfig = StandCloudConfig()
 
 
@@ -81,14 +73,13 @@ class ConfigManager:
     def init_config(  # noqa: PLR0913
         cls,
         tests_dir: str,
+        tests_name: str,
         database_user: str,
         database_password: str,
         database_host: str,
         database_port: int,
         frontend_host: str,
         frontend_port: int,
-        socket_host: str,
-        socket_port: int,
         sc_address: str = "",
         sc_connection_only: bool = False,
     ) -> None:
@@ -96,26 +87,24 @@ class ConfigManager:
 
         Args:
             tests_dir (str): Tests directory.
+            tests_name (str): Tests suite name.
             database_user (str): Database user name.
             database_password (str): Database password.
             database_host (str): Database host.
             database_port (int): Database port.
             frontend_host (str): Operator panel host.
             frontend_port (int): Operator panel port.
-            socket_host (str): Socket host.
-            socket_port (int): Socket port.
             sc_address (str): StandCloud address.
             sc_connection_only (bool): StandCloud check availability.
         """
         cls.obj.tests_dir = str(tests_dir)
+        cls.obj.tests_name = tests_name
         cls.obj.database.user = database_user
         cls.obj.database.password = database_password
         cls.obj.database.host = database_host
         cls.obj.database.port = database_port
         cls.obj.frontend.host = frontend_host
         cls.obj.frontend.port = frontend_port
-        cls.obj.socket.host = socket_host
-        cls.obj.socket.port = socket_port
         cls.obj.stand_cloud.address = sc_address
         cls.obj.stand_cloud.connection_only = sc_connection_only
 
@@ -128,6 +117,8 @@ class ConfigManager:
         """
         if not cls.obj.stand_cloud.address:
             del cls.obj.stand_cloud
+        if not cls.obj.tests_name:
+            del cls.obj.tests_name
         config_str = tomli_w.dumps(cls.obj.model_dump())
         with Path.open(parent_dir / "hardpy.toml", "w") as file:
             file.write(config_str)
@@ -149,13 +140,18 @@ class ConfigManager:
             return None
         try:
             with Path.open(toml_path / "hardpy.toml", "rb") as f:
-                cls.obj = HardpyConfig(**tomli.load(f))
-            return cls.obj  # noqa: TRY300
-        except tomli.TOMLDecodeError:
-            logger.exception("Error parsing TOML")
+                toml_data = tomli.load(f)
+        except tomli.TOMLDecodeError as exc:
+            msg = f"Error parsing TOML: {exc}"
+            logger.exception(msg)
+            return None
+
+        try:
+            cls.obj = HardpyConfig(**toml_data)
         except ValidationError:
             logger.exception("Error parsing TOML")
-        return None
+            return None
+        return cls.obj
 
     @classmethod
     def get_config(cls) -> HardpyConfig:

hardpy/common/stand_cloud/__init__.py

@@ -1,11 +1,12 @@
 # Copyright (c) 2024 Everypin
 # GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-from hardpy.common.stand_cloud.connector import StandCloudConnector
+from hardpy.common.stand_cloud.connector import StandCloudAPIMode, StandCloudConnector
 from hardpy.common.stand_cloud.exception import StandCloudError
 from hardpy.common.stand_cloud.registration import login, logout
 
 __all__ = [
+    "StandCloudAPIMode",
     "StandCloudConnector",
     "StandCloudError",
     "login",

hardpy/common/stand_cloud/connector.py

@@ -4,19 +4,12 @@ from __future__ import annotations
 
 import json
 from datetime import datetime, timedelta, timezone
+from enum import Enum
 from logging import getLogger
 from typing import TYPE_CHECKING, NamedTuple
 
-from oauthlib.oauth2.rfc6749.errors import (
-    InvalidGrantError,
-    MissingTokenError,
-    TokenExpiredError,
-)
-from requests.exceptions import (
-    ConnectionError as RequestConnectionError,
-    HTTPError,
-    InvalidURL,
-)
+from oauthlib.oauth2.rfc6749.errors import OAuth2Error
+from requests.exceptions import RequestException
 from requests_oauth2client import ApiClient, BearerToken
 from requests_oauth2client.tokens import ExpiredAccessToken
 from requests_oauthlib import OAuth2Session
@@ -42,24 +35,41 @@ class StandCloudURL(NamedTuple):
     par: str
     auth: str
 
+
+class StandCloudAPIMode(str, Enum):
+    """StandCloud API mode.
+
+    HARDPY for test stand, integration for third-party service.
+    """
+
+    HARDPY = "hardpy"
+    INTEGRATION = "integration"
+
+
 class StandCloudConnector:
     """StandCloud API connector."""
 
     def __init__(
         self,
         addr: str,
+        api_mode: StandCloudAPIMode = StandCloudAPIMode.HARDPY,
+        api_version: int = 1,
     ) -> None:
         """Create StandCLoud loader.
 
         Args:
-            addr (str | None, optional): StandCloud address.
-            The option only for development and debug. Defaults to True.
+            addr (str): StandCloud service name.
+            api_mode (StandCloudAPIMode): StandCloud API mode,
+                hardpy for test stand, integration for third-party service.
+                Default: StandCloudAPIMode.HARDPY.
+            api_version (int): StandCloud API version.
+                Default: 1.
         """
         https_prefix = "https://"
         auth_addr = addr + "/auth"
 
         self._url: StandCloudURL = StandCloudURL(
-            api=https_prefix + addr + self._get_service_name(addr) + "/api/v1",
+            api=https_prefix + addr + f"/{api_mode}/api/v{api_version}",
             token=https_prefix + auth_addr + "/api/oidc/token",
             par=https_prefix + auth_addr + "/api/oidc/pushed-authorization-request",
             auth=https_prefix + auth_addr + "/api/oidc/authorization",
@@ -98,13 +108,11 @@ class StandCloudConnector:
         try:
             resp = api.get(verify=self._verify_ssl)
         except ExpiredAccessToken as exc:
-            raise StandCloudError(str(exc))
-        except TokenExpiredError as exc:
-            raise StandCloudError(exc.description)
-        except InvalidGrantError as exc:
-            raise StandCloudError(exc.description)
-        except HTTPError as exc:
-            raise StandCloudError(exc.strerror)  # type: ignore
+            raise StandCloudError(str(exc)) from exc
+        except OAuth2Error as exc:
+            raise StandCloudError(exc.description) from exc
+        except RequestException as exc:
+            raise StandCloudError(exc.strerror) from exc # type: ignore
 
         return resp
 
@@ -192,15 +200,10 @@ class StandCloudConnector:
                     verify=False,
                     **extra,
                 )
-            except InvalidGrantError as exc:
-                raise StandCloudError(exc.description)
-            except RequestConnectionError as exc:
-                raise StandCloudError(exc.strerror)  # type: ignore
-            except MissingTokenError as exc:
-                raise StandCloudError(exc.description)
-            except InvalidURL:
-                msg = "Authentication URL is not available"
-                raise StandCloudError(msg)
+            except OAuth2Error as exc:
+                raise StandCloudError(exc.description) from exc
+            except RequestException as exc:
+                raise StandCloudError(exc.strerror) from exc  # type: ignore
             self._token_update(ret)  # type: ignore
 
         return ApiClient(self._url.api + "/" + endpoint, session=session, timeout=10)
@@ -216,12 +219,3 @@ class StandCloudConnector:
             expires_at=expires_at,
             expires_in=expires_in,
         )
-
-    def _get_service_name(self, addr: str) -> str:
-        addr_parts = addr.split(".")
-        number_of_parts = 3
-        service_position_in_address = 1
-        if isinstance(addr_parts, list) and len(addr_parts) >= number_of_parts:
-            return "/" + addr_parts[service_position_in_address]
-        msg = f"Invalid StandCloud address: {addr}"
-        raise StandCloudError(msg)

hardpy/hardpy_panel/api.py

@@ -18,9 +18,9 @@ app.state.pytest_wrp = PyTestWrapper()
 
 
 class Status(str, Enum):
-    """Pytest run status.
+    """HardPy status.
 
-    Statuses, that can be returned by HardPy to frontend.
+    Statuses, that can be returned by HardPy API.
     """
 
     STOPPED = "stopped"
@@ -31,6 +31,16 @@ class Status(str, Enum):
     ERROR = "error"
 
 
+@app.get("/api/hardpy_config")
+def hardpy_config() -> dict:
+    """Get config of HardPy.
+
+    Returns:
+        dict: HardPy config
+    """
+    return app.state.pytest_wrp.get_config()
+
+
 @app.get("/api/start")
 def start_pytest() -> dict:
     """Start pytest subprocess.
@@ -68,6 +78,18 @@ def collect_pytest() -> dict:
     return {"status": Status.BUSY}
 
 
+@app.get("/api/status")
+def status() -> dict:
+    """Get pytest subprocess status.
+
+    Returns:
+        dict[str, RunStatus]: run status
+    """
+    is_running = app.state.pytest_wrp.is_running()
+    status = Status.BUSY if is_running else Status.READY
+    return {"status": status}
+
+
 @app.get("/api/couch")
 def couch_connection() -> dict:
     """Get couchdb connection string.

hardpy/hardpy_panel/frontend/dist/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "/static/css/main.e8a862f1.css",
-    "main.js": "/static/js/main.8a7d8f7d.js",
+    "main.js": "/static/js/main.fb8b84a3.js",
     "blueprint-icons-all-paths-loader.js": "/static/js/blueprint-icons-all-paths-loader.0aa89747.chunk.js",
     "blueprint-icons-split-paths-by-size-loader.js": "/static/js/blueprint-icons-split-paths-by-size-loader.52a072d3.chunk.js",
     "static/js/808.ce070002.chunk.js": "/static/js/808.ce070002.chunk.js",
@@ -21,7 +21,7 @@
     "static/media/logo_smol.png": "/static/media/logo_smol.5b16f92447a4a9e80331.png",
     "index.html": "/index.html",
     "main.e8a862f1.css.map": "/static/css/main.e8a862f1.css.map",
-    "main.8a7d8f7d.js.map": "/static/js/main.8a7d8f7d.js.map",
+    "main.fb8b84a3.js.map": "/static/js/main.fb8b84a3.js.map",
     "blueprint-icons-all-paths-loader.0aa89747.chunk.js.map": "/static/js/blueprint-icons-all-paths-loader.0aa89747.chunk.js.map",
     "blueprint-icons-split-paths-by-size-loader.52a072d3.chunk.js.map": "/static/js/blueprint-icons-split-paths-by-size-loader.52a072d3.chunk.js.map",
     "808.ce070002.chunk.js.map": "/static/js/808.ce070002.chunk.js.map",
@@ -31,6 +31,6 @@
   },
   "entrypoints": [
     "static/css/main.e8a862f1.css",
-    "static/js/main.8a7d8f7d.js"
+    "static/js/main.fb8b84a3.js"
   ]
 }

hardpy/hardpy_panel/frontend/dist/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>HardPy Operator Panel</title><script defer="defer" src="/static/js/main.8a7d8f7d.js"></script><link href="/static/css/main.e8a862f1.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>HardPy Operator Panel</title><script defer="defer" src="/static/js/main.fb8b84a3.js"></script><link href="/static/css/main.e8a862f1.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>