Added test actions

Author: chandr-andr

.github/workflows/CI.yml .github/workflows/release.yml.github/workflows/CI.yml renamed to .github/workflows/release.yml

@@ -2,13 +2,8 @@ name: CI
 
 on:
   push:
-    branches:
-      - main
-      - master
     tags:
       - '*'
-  pull_request:
-  workflow_dispatch:
 
 permissions:
   contents: read

.github/workflows/test.yaml

@@ -0,0 +1,95 @@
+name: 'Testing package'
+
+on:
+  pull_request:
+
+jobs:
+  py-lint:
+    strategy:
+      matrix:
+        cmd:
+          - black
+          - isort
+          - ruff
+          - mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Run lint check
+        uses: pre-commit/action@v3.0.0
+        with:
+          extra_args: -a ${{ matrix.cmd }}
+  fmt:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        components: rustfmt
+        override: true
+    - name: Check code format
+      run: cargo fmt -- --check --config use_try_shorthand=true,imports_granularity=Crate
+
+  clippy:
+    permissions:
+      checks: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        components: clippy
+        override: true
+    - uses: actions-rs/clippy-check@v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        args: -p psqlpy --all-features -- -W clippy::all -W clippy::pedantic -D warnings
+  pytest:
+    name: ${{matrix.job.os}}-${{matrix.py_version}}
+    services:
+      scylla:
+        image: scylladb/scylla:5.2
+        options: >-
+          --health-cmd="cqlsh -e 'select * from system.local' "
+          --health-interval=5s
+          --health-timeout=5s
+          --health-retries=60
+        ports:
+          - 9042:9042
+    strategy:
+      matrix:
+        py_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        job:
+            - os: ubuntu-latest
+              ssl_cmd: sudo apt-get update && sudo apt-get install libssl-dev openssl
+    runs-on: ${{matrix.job.os}}
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ikalnytskyi/action-setup-postgres@v4
+      with:
+        username: postgres
+        password: postgres
+        database: psqlpy_test
+      id: postgres
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        components: clippy
+        override: true
+    - name: Setup OpenSSL
+      run: ${{matrix.job.ssl_cmd}}
+    - name: Setup python for test ${{ matrix.py_version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.py_version }}
+    - name: Install tox
+      run: pip install "tox-gh>=1.2,<2"
+    - name: Run pytest
+      run: tox -v
+

python/psqlpy/__init__.py

@@ -1,9 +1,17 @@
-from ._internal import IsolationLevel, PSQLPool, QueryResult, ReadVariant, Transaction
+from ._internal import (
+    Connection,
+    IsolationLevel,
+    PSQLPool,
+    QueryResult,
+    ReadVariant,
+    Transaction,
+)
 
 __all__ = [
     "PSQLPool",
     "QueryResult",
     "Transaction",
     "IsolationLevel",
     "ReadVariant",
+    "Connection",
 ]

python/tests/conftest.py

@@ -1,7 +1,13 @@
+import os
+import random
+from typing import AsyncGenerator
+
 import pytest
 
+from psqlpy import PSQLPool
+
 
-@pytest.fixture(scope="session")
+@pytest.fixture()
 def anyio_backend() -> str:
     """
     Anyio backend.
@@ -10,3 +16,83 @@ def anyio_backend() -> str:
     :return: backend name.
     """
     return "asyncio"
+
+
+def random_string(length: int = 10) -> str:
+    return "".join(random.choice("AbCdEfG") for _ in range(length))
+
+
+@pytest.fixture()
+def postgres_host() -> str:
+    return os.environ.get("POSTGRES_HOST", "localhost")
+
+
+@pytest.fixture()
+def postgres_user() -> str:
+    return os.environ.get("POSTGRES_USER", "postgres")
+
+
+@pytest.fixture()
+def postgres_password() -> str:
+    return os.environ.get("POSTGRES_PASSWORD", "postgres")
+
+
+@pytest.fixture()
+def postgres_port() -> int:
+    return int(os.environ.get("POSTGRES_PORT", 5432))
+
+
+@pytest.fixture()
+def postgres_dbname() -> str:
+    return os.environ.get("POSTGRES_DBNAME", "psqlpy_test")
+
+
+@pytest.fixture()
+def table_name() -> str:
+    return random_string()
+
+
+@pytest.fixture()
+def number_database_records() -> int:
+    return random.randint(10, 35)
+
+
+@pytest.fixture()
+async def psql_pool(
+    postgres_host: str,
+    postgres_user: str,
+    postgres_password: str,
+    postgres_port: int,
+    postgres_dbname: str,
+) -> AsyncGenerator[PSQLPool, None]:
+    pg_pool = PSQLPool(
+        username=postgres_user,
+        password=postgres_password,
+        host=postgres_host,
+        port=postgres_port,
+        db_name=postgres_dbname,
+    )
+    await pg_pool.startup()
+    yield pg_pool
+
+
+@pytest.fixture(autouse=True)
+async def create_deafult_data_for_tests(
+    psql_pool: PSQLPool,
+    table_name: str,
+    number_database_records: int,
+) -> AsyncGenerator[None, None]:
+    await psql_pool.execute(
+        f"CREATE TABLE {table_name} (id SERIAL, name VARCHAR(255))",
+    )
+
+    for table_id in range(1, number_database_records + 1):
+        new_name = random_string()
+        await psql_pool.execute(
+            querystring=f"INSERT INTO {table_name} VALUES ($1, $2)",
+            parameters=[table_id, new_name],
+        )
+    yield
+    await psql_pool.execute(
+        f"DROP TABLE {table_name}",
+    )

python/tests/test_connection_pool.py

@@ -0,0 +1,30 @@
+import pytest
+
+from psqlpy import Connection, PSQLPool, QueryResult
+
+
+@pytest.mark.anyio
+async def test_pool_execute(
+    psql_pool: PSQLPool,
+    table_name: str,
+    number_database_records: int,
+) -> None:
+    """Test that PSQLPool can execute queries."""
+    select_result = await psql_pool.execute(
+        f"SELECT * FROM {table_name}",
+    )
+
+    assert type(select_result) == QueryResult
+
+    inner_result = select_result.result()
+    assert isinstance(inner_result, list)
+    assert len(inner_result) == number_database_records
+
+
+@pytest.mark.anyio
+async def test_pool_connection(
+    psql_pool: PSQLPool,
+) -> None:
+    """Test that PSQLPool can return single connection from the pool."""
+    connection = await psql_pool.connection()
+    assert isinstance(connection, Connection)

tox.ini

@@ -0,0 +1,28 @@
+[tox]
+isolated_build = true
+env_list =
+    py312
+    py311
+    py310
+    py39
+    py38
+
+[gh]
+python =
+    3.12 = py312
+    3.11 = py311
+    3.10 = py310
+    3.9  = py39
+    3.8  = py38
+
+[testenv]
+skip_install = true
+deps =
+    pytest>=7,<8
+    anyio>=3,<4
+    maturin>=1,<2
+allowlist_externals = maturin
+commands_pre =
+    maturin develop
+commands =
+    pytest -vv