hardpy 0.5.1__tar.gz → 0.6.0__tar.gz

{hardpy-0.5.1 → hardpy-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hardpy
-Version: 0.5.1
+Version: 0.6.0
 Summary: HardPy library for device testing
 Project-URL: Homepage, https://github.com/everypinio/hardpy/
 Project-URL: Documentation, https://everypinio.github.io/hardpy/
@@ -28,7 +28,9 @@ Requires-Dist: glom>=23.3.0
 Requires-Dist: natsort>=8.4.0
 Requires-Dist: pycouchdb>=1.14.2
 Requires-Dist: pydantic>=2.4.0
-Requires-Dist: pytest<9,>7
+Requires-Dist: pytest<9,>=7
+Requires-Dist: rtoml~=0.11.0
+Requires-Dist: typer<1.0,>=0.12
 Requires-Dist: uvicorn>=0.23.2
 Provides-Extra: build
 Requires-Dist: build==1.0.3; extra == 'build'
@@ -74,71 +76,37 @@ HardPy allows you to:
 pip install hardpy
 ```
 
-## Examples
-
-Find examples of using the **HardPy** in the `examples` folder.
-
 ## Getting Started
 
-#### CouchDB
-
-This is a simple instruction for Linux.
-For Windows, follow the instructions from the
-[documentation](https://everypinio.github.io/hardpy/documentation/database/#couchdb-instance).
-
-Launch CouchDB with Docker.
-The Docker version must be 24.0.0 or higher.
-Create `couchdb.ini` file:
-
-```ini
-[chttpd]
-enable_cors=true
-
-[cors]
-origins = *
-methods = GET, PUT, POST, HEAD, DELETE
-credentials = true
-headers = accept, authorization, content-type, origin, referer, x-csrf-token
+1. Create your first test bench.
+```bash
+hardpy init
 ```
-
-Run the Docker container from folder with couchdb.ini file:
-
+2. Launch [CouchDB](https://couchdb.apache.org/) database via [docker compose](https://docs.docker.com/compose/) in the background.
 ```bash
-docker run --rm --name couchdb -p 5984:5984 -e COUCHDB_USER=dev -e COUCHDB_PASSWORD=dev -v ./couchdb.ini:/opt/couchdb/etc/local.ini couchdb:3.3
+cd tests
+docker compose up -d
 ```
-
-Command for Windows:
-
+3. Launch HardPy operator panel.
 ```bash
-docker run --rm --name couchdb -p 5984:5984 -e COUCHDB_USER=dev -e COUCHDB_PASSWORD=dev -v .\couchdb.ini:/opt/couchdb/etc/local.ini couchdb:3.3.2
+hardpy run
 ```
+4. View operator panel in browser: http://localhost:8000/
 
-#### Test steps
-
-Add simple test to `tests` folder
-
-```python
-# test_1.py
-import pytest
-
-def test_one():
-    assert True
-```
-#### Operator panel
+  <h1 align="center">
+      <img src="https://everypinio.github.io/hardpy/img/hardpy_operator_panel_hello_hardpy.png"
+      alt="hardpy operator panel" style="width:600px;">
+  </h1>
 
-Launch `hardpy-panel` from tests folder or launch `hardpy-panel tests` and open page http://localhost:8000/ in browser.
+5. View the latest test report: http://localhost:5984/_utils
 
-<h1 align="center">
-    <img src="https://everypinio.github.io/hardpy/img/hardpy_operator_panel_hello_hardpy.png"
-    alt="hardpy operator panel" style="width:600px;">
-</h1>
+    Login and password: **dev**, database - **runstore**, document - **current**.
 
-#### Test report
+  <h1 align="center">
+      <img src="https://everypinio.github.io/hardpy/img/runstore_hello_hardpy.png"
+      alt="hardpy runstore" style="width:500px;">
+  </h1>
 
-The last test report is stored in **runstore** database, document - **current**.
-You can view the CouchDB instance through Fauxton web interface: http://localhost:5984/_utils
+## Examples
 
-<h1 align="center">
-    <img src="https://everypinio.github.io/hardpy/img/runstore_hello_hardpy.png"
-    alt="hardpy runstore" style="width:600px;">
-</h1>
+Find more examples of using the **HardPy** in the [examples](https://github.com/everypinio/hardpy/tree/main/examples) folder.

hardpy-0.6.0/README.md

@@ -0,0 +1,70 @@
+<h1 align="center">
+    <img src="https://everypinio.github.io/hardpy/img/logo256.png" alt="HardPy" style="width:200px;">
+</h1>
+
+<h1 align="center">
+    <b>HardPy</b>
+</h1>
+
+<p align="center">
+HardPy is a python library for creating a test bench for devices.
+</p>
+
+---
+
+**Documentation**: <a href=https://everypinio.github.io/hardpy/ target="_blank">https://everypinio.github.io/hardpy/</a>
+
+**Source Code**: <a href=https://github.com/everypinio/hardpy target="_blank">https://github.com/everypinio/hardpy</a>
+
+**PyPi**: <a href=https://pypi.org/project/hardpy/ target="_blank">https://pypi.org/project/hardpy/</a>
+
+---
+
+## Overview
+
+HardPy allows you to:
+
+* Create test benches for devices using [pytest](https://docs.pytest.org/);
+* Use a browser to view, start, stop, and interact with tests;
+* Store test results in the [CouchDB](https://couchdb.apache.org/) database.
+
+## To Install
+
+```bash
+pip install hardpy
+```
+
+## Getting Started
+
+1. Create your first test bench.
+```bash
+hardpy init
+```
+2. Launch [CouchDB](https://couchdb.apache.org/) database via [docker compose](https://docs.docker.com/compose/) in the background.
+```bash
+cd tests
+docker compose up -d
+```
+3. Launch HardPy operator panel.
+```bash
+hardpy run
+```
+4. View operator panel in browser: http://localhost:8000/
+
+  <h1 align="center">
+      <img src="https://everypinio.github.io/hardpy/img/hardpy_operator_panel_hello_hardpy.png"
+      alt="hardpy operator panel" style="width:600px;">
+  </h1>
+
+5. View the latest test report: http://localhost:5984/_utils
+
+    Login and password: **dev**, database - **runstore**, document - **current**.
+
+  <h1 align="center">
+      <img src="https://everypinio.github.io/hardpy/img/runstore_hello_hardpy.png"
+      alt="hardpy runstore" style="width:500px;">
+  </h1>
+
+## Examples
+
+Find more examples of using the **HardPy** in the [examples](https://github.com/everypinio/hardpy/tree/main/examples) folder.

{hardpy-0.5.1 → hardpy-0.6.0}/hardpy/__init__.py

@@ -4,6 +4,8 @@
 from hardpy.pytest_hardpy.result import CouchdbLoader
 from hardpy.pytest_hardpy.utils import (
     DuplicateSerialNumberError,
+    DuplicatePartNumberError,
+    DuplicateTestStandNameError,
     DuplicateDialogBoxError,
 )
 from hardpy.pytest_hardpy.result.couchdb_config import CouchdbConfig
@@ -21,6 +23,8 @@ from hardpy.pytest_hardpy.pytest_call import (
     get_current_report,
     set_dut_info,
     set_dut_serial_number,
+    set_dut_part_number,
+    set_stand_name,
     set_stand_info,
     set_case_artifact,
     set_module_artifact,
@@ -28,6 +32,7 @@ from hardpy.pytest_hardpy.pytest_call import (
     set_message,
     set_driver_info,
     run_dialog_box,
+    set_operator_message,
 )
 
 __all__ = [
@@ -37,16 +42,21 @@ __all__ = [
     "get_current_report",
     # Errors
     "DuplicateSerialNumberError",
+    "DuplicatePartNumberError",
+    "DuplicateTestStandNameError",
     "DuplicateDialogBoxError",
     # Database info
     "set_dut_info",
     "set_dut_serial_number",
+    "set_dut_part_number",
+    "set_stand_name",
     "set_stand_info",
     "set_case_artifact",
     "set_module_artifact",
     "set_run_artifact",
     "set_message",
     "set_driver_info",
+    "set_operator_message",
     # Dialog boxes
     "run_dialog_box",
     "DialogBox",

hardpy-0.6.0/hardpy/cli/cli.py

@@ -0,0 +1,145 @@
+# Copyright (c) 2024 Everypin
+# GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+import os
+import sys
+from pathlib import Path
+from typing import Optional
+from typing_extensions import Annotated
+
+import typer
+from uvicorn import run as uvicorn_run
+
+from hardpy.cli.template import TemplateGenerator
+from hardpy.common.config import ConfigManager
+
+cli = typer.Typer(add_completion=False)
+default_config = ConfigManager().get_config()
+
+
+@cli.command()
+def init(  # noqa: WPS211
+    tests_dir: Annotated[Optional[str], typer.Argument()] = None,
+    create_database: bool = typer.Option(
+        True,
+        help="Create CouchDB database.",
+    ),
+    database_user: str = typer.Option(
+        default_config.database.user,
+        help="Specify a database user.",
+    ),
+    database_password: str = typer.Option(
+        default_config.database.password,
+        help="Specify a database user password.",
+    ),
+    database_host: str = typer.Option(
+        default_config.database.host,
+        help="Specify a database host.",
+    ),
+    database_port: int = typer.Option(
+        default_config.database.port,
+        help="Specify a database port.",
+    ),
+    frontend_host: str = typer.Option(
+        default_config.frontend.host,
+        help="Specify a frontend host.",
+    ),
+    frontend_port: int = typer.Option(
+        default_config.frontend.port,
+        help="Specify a frontend port.",
+    ),
+    socket_host: str = typer.Option(
+        default_config.socket.host,
+        help="Specify a socket host.",
+    ),
+    socket_port: int = typer.Option(
+        default_config.socket.port,
+        help="Specify a socket port.",
+    ),
+):
+    """Initialize HardPy tests directory.
+
+    Args:
+        tests_dir (str | None): Tests directory. Current directory + `tests` by default
+        create_database (bool): Flag to create database
+        database_user (str): Database user name
+        database_password (str): Database password
+        database_host (str): Database host
+        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
+    """
+    _tests_dir = tests_dir if tests_dir else default_config.tests_dir
+    ConfigManager().init_config(
+        tests_dir=str(_tests_dir),
+        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,
+    )
+    # create tests directory
+    dir_path = Path(Path.cwd() / _tests_dir)
+    os.makedirs(dir_path, exist_ok=True)
+
+    if create_database:
+        # create database directory
+        os.makedirs(dir_path / "database", exist_ok=True)
+
+    # create hardpy.toml
+    ConfigManager().create_config(dir_path)
+    config = ConfigManager().read_config(dir_path)
+    if not config:
+        print(f"hardpy.toml config by path {dir_path} not detected.")
+        sys.exit()
+
+    template = TemplateGenerator(config)
+
+    files = {}
+
+    if create_database:
+        files[Path(dir_path / "docker-compose.yaml")] = template.docker_compose_yaml
+        files[Path(dir_path / "database" / "couchdb.ini")] = template.couchdb_ini
+
+    files[Path(dir_path / "pytest.ini")] = template.pytest_ini
+    files[Path(dir_path / "test_1.py")] = template.test_1_py
+    files[Path(dir_path / "conftest.py")] = template.conftest_py
+
+    for key, value in files.items():
+        template.create_file(key, value)
+
+    print(f"HardPy project {dir_path.name} initialized successfully.")
+
+
+@cli.command()
+def run(tests_dir: Annotated[Optional[str], typer.Argument()] = None):
+    """Run HardPy server.
+
+    Args:
+        tests_dir (Optional[str]): Test directory. Current directory by default
+    """
+    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()
+
+    print("\nLaunch the HardPy operator panel...")
+    print(f"http://{config.frontend.host}:{config.frontend.port}\n")
+
+    uvicorn_run(
+        "hardpy.hardpy_panel.api:app",
+        host=config.frontend.host,
+        port=config.frontend.port,
+        log_level="critical",
+    )
+
+
+if __name__ == "__main__":
+    cli()

hardpy-0.6.0/hardpy/cli/template.py

@@ -0,0 +1,210 @@
+# Copyright (c) 2024 Everypin
+# GNU General Public License v3.0 (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from pathlib import Path
+
+from hardpy.common.config import HardpyConfig
+
+docker_compose_yaml = """version: "3.8"
+
+services:
+  couchserver:
+    image: couchdb:3.3.2
+    ports:
+      - "{}:5984"
+    environment:
+      COUCHDB_USER: {}
+      COUCHDB_PASSWORD: {}
+    volumes:
+      - ./database/dbdata:/opt/couchdb/data
+      - ./database/couchdb.ini:/opt/couchdb/etc/local.ini
+"""
+
+couchdb_ini = """; CouchDB Configuration Settings
+
+; Custom settings should be made in this file. They will override settings
+; in default.ini, but unlike changes made to default.ini, this file won't be
+; overwritten on server upgrade.
+
+[couchdb]
+;max_document_size = 4294967296 ; bytes
+;os_process_timeout = 5000
+
+[couch_peruser]
+; If enabled, couch_peruser ensures that a private per-user database
+; exists for each document in _users. These databases are writable only
+; by the corresponding user. Databases are in the following form:
+; userdb-{{hex encoded username}}
+;enable = true
+
+; If set to true and a user is deleted, the respective database gets
+; deleted as well.
+;delete_dbs = true
+
+; Set a default q value for peruser-created databases that is different from
+; cluster / q
+;q = 1
+
+[chttpd]
+;port = {}
+;bind_address = {}
+
+; Options for the MochiWeb HTTP server.
+;server_options = [{{backlog, 128}}, {{acceptor_pool_size, 16}}]
+
+; For more socket options, consult Erlang's module 'inet' man page.
+;socket_options = [{{sndbuf, 262144}}, {{nodelay, true}}]
+
+enable_cors=true
+
+[httpd]
+; NOTE that this only configures the "backend" node-local port, not the
+; "frontend" clustered port. You probably don't want to change anything in
+; this section.
+; Uncomment next line to trigger basic-auth popup on unauthorized requests.
+;WWW-Authenticate = Basic realm="administrator"
+
+; Uncomment next line to set the configuration modification whitelist. Only
+; whitelisted values may be changed via the /_config URLs. To allow the admin
+; to change this value over HTTP, remember to include {{httpd,config_whitelist}}
+; itself. Excluding it from the list would require editing this file to update
+; the whitelist.
+;config_whitelist = [{{httpd,config_whitelist}}, {{log,level}}, {{etc,etc}}]
+
+[cors]
+origins = *
+methods = GET, PUT, POST, HEAD, DELETE
+credentials = true
+headers = accept, authorization, content-type, origin, referer, x-csrf-token
+
+
+[ssl]
+;enable = true
+;cert_file = /full/path/to/server_cert.pem
+;key_file = /full/path/to/server_key.pem
+;password = somepassword
+
+; set to true to validate peer certificates
+;verify_ssl_certificates = false
+
+; Set to true to fail if the client does not send a certificate. Only used if verify_ssl_certificates is true.
+;fail_if_no_peer_cert = false
+
+; Path to file containing PEM encoded CA certificates (trusted
+; certificates used for verifying a peer certificate). May be omitted if
+; you do not want to verify the peer.
+;cacert_file = /full/path/to/cacertf
+
+; The verification fun (optional) if not specified, the default
+; verification fun will be used.
+;verify_fun = {{Module, VerifyFun}}
+
+; maximum peer certificate depth
+;ssl_certificate_max_depth = 1
+
+; Reject renegotiations that do not live up to RFC 5746.
+;secure_renegotiate = true
+
+; The cipher suites that should be supported.
+; Can be specified in erlang format "{{ecdhe_ecdsa,aes_128_cbc,sha256}}"
+; or in OpenSSL format "ECDHE-ECDSA-AES128-SHA256".
+;ciphers = ["ECDHE-ECDSA-AES128-SHA256", "ECDHE-ECDSA-AES128-SHA"]
+
+; The SSL/TLS versions to support
+;tls_versions = [tlsv1, 'tlsv1.1', 'tlsv1.2']
+
+; To enable Virtual Hosts in CouchDB, add a vhost = path directive. All requests to
+; the Virtual Host will be redirected to the path. In the example below all requests
+; to http://example.com/ are redirected to /database.
+; If you run CouchDB on a specific port, include the port number in the vhost:
+; example.com:5984 = /database
+[vhosts]
+;example.com = /database/
+
+; To create an admin account uncomment the '[admins]' section below and add a
+; line in the format 'username = password'. When you next start CouchDB, it
+; will change the password to a hash (so that your passwords don't linger
+; around in plain-text files). You can add more admin accounts with more
+; 'username = password' lines. Don't forget to restart CouchDB after
+; changing this.
+[admins]
+;admin = mysecretpassword
+"""
+
+pytest_ini = """[pytest]
+log_cli = true
+log_cli_level = INFO
+log_cli_format = %%(asctime)s [%%(levelname)s] %%(message)s
+log_cli_date_format = %H:%M:%S
+addopts = --hardpy-pt
+"""
+
+test_1_py = """import pytest
+import hardpy
+
+
+pytestmark = pytest.mark.module_name("HardPy template")
+
+
+@pytest.mark.case_name("Test 1")
+def test_one():
+    assert True
+"""
+
+conftest_py = """import pytest
+import hardpy
+
+
+def finish_executing():
+    print("Testing completed")
+
+
+@pytest.fixture(scope="session", autouse=True)
+def fill_actions_after_test(post_run_functions: list):
+    post_run_functions.append(finish_executing)
+    yield
+"""
+
+
+class TemplateGenerator:
+    """HardPy template files generator."""
+
+    def __init__(self, config: HardpyConfig):
+        self._config = config
+
+    def create_file(self, file_path: Path, content: str):
+        """Create HardPy template file.
+
+        Args:
+            file_path (Path): file path
+            content (str): file content
+        """
+        with open(file_path, "w") as file:
+            file.write(content)
+
+    @property
+    def docker_compose_yaml(self) -> str:
+        return docker_compose_yaml.format(
+            self._config.database.port,
+            self._config.database.user,
+            self._config.database.password,
+        )
+
+    @property
+    def couchdb_ini(self) -> str:
+        return couchdb_ini.format(
+            self._config.database.port,
+            self._config.database.host,
+        )
+
+    @property
+    def pytest_ini(self) -> str:
+        return pytest_ini
+
+    @property
+    def test_1_py(self) -> str:  # noqa: WPS114
+        return test_1_py
+
+    @property
+    def conftest_py(self) -> str:
+        return conftest_py