pyrelukko 0.2.0__tar.gz → 0.4.0__tar.gz

pyrelukko-0.4.0/.gitlab-ci.yml

@@ -0,0 +1,173 @@
+variables:
+  FF_TIMESTAMPS: true
+  BUILD_IMAGE:
+    description: Used in rules, if "true" and web triggered it builds the image!
+    value: "false"
+    options:
+    - "false"
+    - "true"
+  IMAGE_NAME: py-rf-image
+  IMAGE_TAG:
+    description: >-
+      The "tag" added to the image name for the test / lint image.
+      Remove this when you trigger by hand an image build and want it to use
+      the new built image with Git short sha tag (X icon on the right)!
+    value: "latest"
+  RUN_PYTEST:
+    description: Used in rules, if "true" and web triggered run the pytests.
+    value: "false"
+    options:
+    - "false"
+    - "true"
+  RELUKKO_HOSTNAME: relukko
+  RELUKKO_BIND_PORT: 3000
+  RELUKKO_API_KEY: "somerandomkey"
+  POSTGRES_USER: relukko
+  POSTGRES_PASSWORD: okkuler
+  POSTGRES_DB: relukko
+  POSTGRES_HOSTNAME: postgres
+#  RUN_DOCS_PUBLISH:
+#    description: >-
+#      Used in rules, if "true" and web triggered it generates the docs and
+#      publishes them!
+#    value: "false"
+#    options:
+#    - "false"
+#    - "true"
+
+
+build-py-rf-image:
+  stage: build
+  image: docker:25
+  services:
+    - name: docker:25-dind
+      alias: docker
+  before_script:
+    - docker info
+  before_script:
+    - echo "Login to Gitlab container registry"
+    - echo "$CI_REGISTRY_PASSWORD" | docker login --username $CI_REGISTRY_USER --password-stdin $CI_REGISTRY
+  script:
+    - echo "Build container image..."
+    - ./cicd/build-py-rf-image.sh
+    - echo "Export IMAGE_TAG var to next stage!"
+    - echo "IMAGE_TAG=${CI_COMMIT_SHORT_SHA}" > image_tag.env
+    - echo "Build complete."
+  artifacts:
+    reports:
+      dotenv: image_tag.env
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      changes:
+        - .gitlab-ci.yml
+        - cicd/build-py-rf-image.sh
+        - container/**/*
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
+      changes:
+        - .gitlab-ci.yml
+        - cicd/build-py-rf-image.sh
+        - container/**/*
+    - if: $CI_PIPELINE_SOURCE == "web" && $BUILD_IMAGE == "true"
+      when: always
+
+
+run-pylint:
+  stage: test
+  image: "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:${IMAGE_TAG}"
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
+      changes:
+        - src/**/*.py
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      changes:
+        - src/**/*.py
+  before_script:
+    - echo "Running PyLint."
+  script:
+    - ./cicd/run_pylint.sh
+  artifacts:
+    when: always
+    expire_in: 2 week
+    paths:
+      - pylint.out.*
+
+
+run-pytest:
+  stage: test
+  services:
+    - name: postgres:16
+      alias: postgres
+    - name: registry.gitlab.com/relukko/relukko:latest
+      alias: relukko
+      variables:
+        DATABASE_URL: "postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}"
+        RELUKKO_USER: "relukko"
+        RELUKKO_PASSWORD: "relukko"
+        RELUKKO_BIND_ADDR: "0.0.0.0"
+        HEALTHCHECK_TCP_PORT: "${RELUKKO_BIND_PORT}"
+  variables:
+    FF_NETWORK_PER_BUILD: 1
+    CI_HAS_RELUKKO: true
+    CI_RELUKKO_BASE_URL: "http://${RELUKKO_HOSTNAME}:${RELUKKO_BIND_PORT}"
+    CI_RELUKKO_API_KEY: "${RELUKKO_API_KEY}"
+  parallel:
+    matrix:
+      - PIPELINE_PY_VERSION: ['3.11', '3.12', '3.13']
+  image: "registry.gitlab.com/relukko/py-tox-images/py-$PIPELINE_PY_VERSION-tox"
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
+      changes:
+        - src/**/*.py
+        - tests/test_*.py
+        - tests/conftest.py
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      changes:
+        - src/**/*.py
+        - tests/test_*.py
+        - tests/conftest.py
+    - if: $CI_PIPELINE_SOURCE == "web" && $RUN_PYTEST == "true"
+      when: always
+  before_script:
+    - echo "Running PyTest."
+  script:
+    - ./cicd/run_pytest.sh
+  artifacts:
+    when: always
+    expire_in: 2 week
+    paths:
+      - pytest-junit.xml
+    reports:
+      junit: pytest-junit.xml
+
+ 
+run-shellcheck:
+  stage: test
+  image: "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:${IMAGE_TAG}"
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
+      changes:
+        - cicd/*.sh
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      changes:
+        - cicd/*.sh
+  before_script:
+    - echo "Running ShellCheck."
+  script:
+    - ./cicd/run_shellcheck.sh
+ 
+# pages:
+#   stage: deploy
+#   image: "${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:${IMAGE_TAG}"
+#   rules:
+#     - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+#       changes:
+#         - src/**/*.py
+#     - if: $CI_PIPELINE_SOURCE == "web" && $RUN_DOCS_PUBLISH == "true"
+#       when: always
+#   before_script:
+#     - echo "Running Docs generation and publishing..."
+#   script:
+#     - ./cicd/run_docs_pages.sh
+#   artifacts:
+#     paths:
+#       - public

{pyrelukko-0.2.0 → pyrelukko-0.4.0}/PKG-INFO

@@ -1,16 +1,21 @@
 Metadata-Version: 2.3
 Name: pyrelukko
-Version: 0.2.0
+Version: 0.4.0
 Summary: Relukko client.
 Author-email: Reto Zingg <g.d0b3rm4n@gmail.com>
-Requires-Python: >=3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: requests >=2.32.3
+Requires-Dist: websockets >= 13.1
 Project-URL: Homepage, https://gitlab.com/relukko/pyrelukko
 Project-URL: Issues, https://gitlab.com/relukko/pyrelukko/-/issues
 

pyrelukko-0.4.0/cicd/build-py-rf-image.sh

@@ -0,0 +1,48 @@
+#!/bin/sh
+
+set -e
+
+SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
+REPO_DIR="${SCRIPT_DIR}/.."
+CONTAINER_DIR="${REPO_DIR}/container"
+CONTAINER_CMD="docker"
+
+# IMAGE_NAME should normally come from .gitlab-ci.yml file,
+# set default for local usage.
+if [ -z "${IMAGE_NAME+x}" ]; then
+    IMAGE_NAME=py-rf-image-local
+fi
+
+cd "${CONTAINER_DIR}" || exit
+
+${CONTAINER_CMD} build -t "${IMAGE_NAME}:latest" --file Containerfile .
+
+${CONTAINER_CMD} images
+
+if [ -n "${CI_REGISTRY_IMAGE}" ]; then
+    # In Gitlab
+
+    # Tag with Git commit short sha and push
+    IMAGE_WITH_GIT_SHA="${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:${CI_COMMIT_SHORT_SHA}"
+    echo "IMAGE_WITH_GIT_SHA: ${IMAGE_WITH_GIT_SHA}"
+
+    ${CONTAINER_CMD} tag "${IMAGE_NAME}:latest" "${IMAGE_WITH_GIT_SHA}"
+    ${CONTAINER_CMD} push "${IMAGE_WITH_GIT_SHA}"
+
+    if [ "${CI_COMMIT_BRANCH}" = "${CI_DEFAULT_BRANCH}" ]; then
+        # We run in default branch, also tag with latest
+        # Tag with "latest" (overwrites last 'latest' in registry) and push
+        IMAGE_WITH_LATEST="${CI_REGISTRY_IMAGE}/${IMAGE_NAME}:latest"
+
+        echo "Tag image with as 'latest': ${IMAGE_WITH_LATEST}"
+
+        ${CONTAINER_CMD} tag "${IMAGE_NAME}:latest" "${IMAGE_WITH_LATEST}"
+        ${CONTAINER_CMD} push "${IMAGE_WITH_LATEST}"
+    fi
+else
+    echo "Runs locally, no pushing!"
+fi
+
+cd -
+
+# vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:

pyrelukko-0.4.0/cicd/run_docs_pages.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
+REPO_DIR="${SCRIPT_DIR}/.."
+PUBLIC_DIR="${REPO_DIR}/public"
+
+# Main script execution
+main() {
+    mkdir -p "${PUBLIC_DIR}"
+    # libdoc --pythonpath ./src  Relukko  "${PUBLIC_DIR}/index.html"
+    echo "Not Implemented yet"
+}
+
+# Execute the main function
+main
+
+# vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:

pyrelukko-0.4.0/cicd/run_pylint.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
+REPO_DIR="${SCRIPT_DIR}/.."
+
+# Main script execution
+main() {
+    pylint --verbose \
+            --rcfile "${REPO_DIR}/pyproject.toml" \
+            --output-format=json:pylint.out.json,parseable:pylint.out.txt,text \
+            "${REPO_DIR}"
+    pylint_exit_code=$?
+
+    pylint-json2html \
+        -o "${REPO_DIR}/pylint.out.html" \
+        "${REPO_DIR}/pylint.out.json"
+
+    return ${pylint_exit_code}
+}
+
+# Execute the main function
+main
+
+# vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:

pyrelukko-0.4.0/cicd/run_pytest.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
+# REPO_DIR="${SCRIPT_DIR}/.."
+
+# Main script execution
+main() {
+    # pytest --junit-xml "${REPO_DIR}/pytest-junit.xml"
+    tox run --skip-missing-interpreters
+}
+
+# Execute the main function
+main
+
+# vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:

pyrelukko-0.4.0/cicd/run_shellcheck.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
+REPO_DIR="${SCRIPT_DIR}/.."
+
+# Main script execution
+main() {
+    shellcheck "${REPO_DIR}"/cicd/*.sh   
+}
+
+# Execute the main function
+main
+
+# vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:

pyrelukko-0.4.0/container/Containerfile

@@ -0,0 +1,5 @@
+FROM python:3.13-alpine
+
+RUN apk add --no-cache bash shellcheck
+COPY requirements.txt /opt/requirements.txt
+RUN pip install --no-cache-dir -r /opt/requirements.txt

pyrelukko-0.4.0/container/requirements.txt

@@ -0,0 +1,5 @@
+pylint==3.3.1
+pylint-json2html==0.5.0
+pytest==8.3.3
+requests==2.32.3
+websockets==13.1

pyrelukko-0.4.0/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "pyrelukko"
+authors = [
+    {name = "Reto Zingg", email = "g.d0b3rm4n@gmail.com"},
+]
+readme = "README.md"
+
+# https://pypi.org/pypi?%3Aaction=list_classifiers
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+requires-python = ">=3.10"
+dynamic = ["version", "description"]
+dependencies = [
+    "requests >=2.32.3",
+    "websockets >= 13.1",
+]
+
+[tool.flit.sdist]
+exclude = [".gitignore", "demo.py"]
+
+[project.urls]
+Homepage = "https://gitlab.com/relukko/pyrelukko"
+Issues = "https://gitlab.com/relukko/pyrelukko/-/issues"
+
+[build-system]
+requires = ["flit_core >=3.2,<4", "semantic-version >= 2.10"]
+build-backend = "flit_core.buildapi"
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+pythonpath = [
+    "src",
+]
+
+[tool.tox]
+requires = ["tox>=4.23"]
+env_list = ["3.11", "3.12", "3.13"]
+
+[tool.tox.env_run_base]
+description = "Run test under {base_python}"
+commands = [["pytest", "--junit-xml", "pytest-junit.xml"]]
+deps = ["httpx", "pytest", "testcontainers"]
+# set_env = { VIRTUALENV_DISCOVERY = "pyenv" }
+pass_env = [ "TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE", "DOCKER_HOST", "CI_HAS_RELUKKO", "CI_RELUKKO_*" ]
+
+[tool.pylint.main]
+# Files or directories to be skipped. They should be base names, not paths.
+ignore = ["LICENSE", "pyproject.toml", "version.py",
+          "README.md", "demo.py", "conftest.py", ".tox"]
+
+# Files or directories matching the regular expression patterns are skipped. The
+# regex matches against base names, not paths. The default value ignores Emacs
+# file locks
+ignore-patterns = ["^\\.#", "^test_"]

{pyrelukko-0.2.0 → pyrelukko-0.4.0}/src/pyrelukko/pyrelukko.py

@@ -33,9 +33,18 @@ RETRY_KWARGS = [
     'delay',
     'backoff',
     'max_delay',
-    'exceptions'
+    'exceptions',
 ]
 
+OWN_KWARGS = [
+    'acquire_wait_for_timeout',
+    'acquire_modulo',
+    'ws_ping_interval',
+    'ws_ping_timeout',
+    'ws_wait_for_timeout',
+]
+OWN_KWARGS.extend(RETRY_KWARGS)
+
 logger = logging.getLogger(__name__)
 
 
@@ -66,7 +75,12 @@ class RelukkoClient:
         )
         self._setup_session(api_key, **kwargs)
         self._setup_http_adapters_retry(**kwargs)
-        self._setup_pyrelukko_retry(**kwargs)
+        self.ws_wait_for_timeout = 2
+        self.ws_ping_interval = 60
+        self.ws_ping_timeout = 20
+        self.acquire_wait_for_timeout = 2
+        self.acquire_modulo = 100
+        self._setup_pyrelukko_kwargs(**kwargs)
 
         self.base_url = self._setup_base_url(base_url)
         self.ws_url = self._setup_ws_url(str(self.base_url))
@@ -90,10 +104,10 @@ class RelukkoClient:
         self.base_url = self._setup_base_url(base_url or self.base_url)
         self.ws_url = self._setup_ws_url(str(self.base_url))
         self._setup_ssl_ctx(**kwargs)
-        self._setup_pyrelukko_retry(**kwargs)
+        self._setup_pyrelukko_kwargs(**kwargs)
 
-    def _setup_pyrelukko_retry(self, **kwargs):
-        for kwarg in RETRY_KWARGS:
+    def _setup_pyrelukko_kwargs(self, **kwargs):
+        for kwarg in OWN_KWARGS:
             setattr(
                 self,
                 kwarg,
@@ -151,7 +165,7 @@ class RelukkoClient:
 
     def _setup_ws_url(self, ws_url: str) -> Url:
         url = ws_url.replace("http", "ws", 1)
-        return parse_url(f"{url}/deletions")
+        return parse_url(f"{url}/ws/broadcast")
 
     def _setup_base_url(self, base_url: Union[Url, str]) -> Url:
         if isinstance(base_url, str):
@@ -174,14 +188,17 @@ class RelukkoClient:
             additional_headers=additional_headers,
             ssl=self.ssl_ctx,
             logger=logger,
+            ping_interval=self.ws_ping_interval,
+            ping_timeout=self.ws_ping_timeout,
         ) as websocket:
             while self.ws_running.is_set():
                 try:
-                    ws_message = await asyncio.wait_for(websocket.recv(), timeout=2)
+                    ws_message = await asyncio.wait_for(
+                        websocket.recv(), timeout=self.ws_wait_for_timeout)
                     if ws_message:
                         logger.debug("Received message: '%s'", ws_message)
                         msg: Dict = json.loads(ws_message)
-                        if msg.get('deletions'):
+                        if msg.get('deleted'):
                             # Signal the HTTP thread to wake up
                             self.message_received.set()
                 except TimeoutError:
@@ -199,19 +216,25 @@ class RelukkoClient:
         """
 
         start_time = time.time()
-
+        loop_counter = 0
+        got_message = False
+        res = None
         while True:
             elapsed_time = time.time() - start_time
             if elapsed_time > max_run_time:
                 self.ws_running.clear()
                 _thread_store.insert(0, None)
                 return
-
-            res = self._make_request(
-                url=url, method="POST", payload=payload)
+            # If self.message_recieved is True try to get lock ASAP!
+            # Otherwise only in every Xth run in case websocket broke.
+            if got_message or loop_counter % self.acquire_modulo == 0:
+                res = self._make_request(
+                    url=url, method="POST", payload=payload)
+            loop_counter += 1
             if res is None:
                 # Conflict 409
-                self.message_received.wait(timeout=30)
+                got_message = self.message_received.wait(
+                    timeout=self.acquire_wait_for_timeout)
                 self.message_received.clear()
             else:
                 _thread_store.insert(0, res)
@@ -277,7 +300,8 @@ class RelukkoClient:
 
         thread_store = []
         http_thread = threading.Thread(
-            target=self._acquire_relukko, args=(url, max_run_time, payload, thread_store))
+            target=self._acquire_relukko,
+            args=(url, max_run_time, payload, thread_store))
         http_thread.start()
         http_thread.join()
         self.ws_listener.join()

pyrelukko-0.2.0/tests/conftest.py → pyrelukko-0.4.0/src/pyrelukko/testcontainers.py

@@ -1,24 +1,30 @@
+# pylint: skip-file
+"""
+Testcontainers to be used in PyTests, for a fixture see tests/conftest.py
+(relukko_backend):
+
+@pytest.fixture(scope="session")
+def relukko_backend():
+    with Network() as rl_net:
+        with RelukkoDbContainer(net=rl_net,
+            image="postgres:16", hostname="relukkodb") as _db:
+            db_url = "postgresql://relukko:relukko@relukkodb/relukko"
+            with RelukkoContainer(rl_net, db_url=db_url) as backend:
+                relukko = RelukkoClient(
+                    base_url=backend.get_api_url(), api_key="somekey")
+                yield relukko, backend
+"""
 import socket
-import ssl
-import threading
-from pathlib import Path
-from typing import List
 
-import pytest
 from testcontainers.core.network import Network
 from testcontainers.core.waiting_utils import wait_container_is_ready
 from testcontainers.generic import ServerContainer
 from testcontainers.postgres import PostgresContainer
 
-from pyrelukko import RelukkoClient
-
-SCRIPT_DIR = Path(__file__).parent.absolute()
-INITDB_DIR = SCRIPT_DIR / "initdb.d"
-
 
 class RelukkoContainer(ServerContainer):
     def __init__(self, net: Network,
-                 image="registry.gitlab.com/relukko/relukko:0.9.0", db_url=None):
+                 image="registry.gitlab.com/relukko/relukko:latest", db_url=None):
         self.db_url = db_url
         self.net = net
         super(RelukkoContainer, self).__init__(image=image, port=3000)
@@ -39,12 +45,19 @@ class RelukkoContainer(ServerContainer):
 
 
 class RelukkoDbContainer(PostgresContainer):
-    def __init__(self, net: Network, image: str = "postgres:latest", port: int = 5432, username: str | None = None, password: str | None = None, dbname: str | None = None, driver: str | None = "psycopg2", **kwargs) -> None:
+    def __init__(
+            self, net: Network,
+            image: str = "postgres:latest",
+            port: int = 5432,
+            username: str | None = None,
+            password: str | None = None,
+            dbname: str | None = None,
+            driver: str | None = "psycopg2",
+            **kwargs) -> None:
         self.net = net
         super().__init__(image, port, username, password, dbname, driver, **kwargs)
 
     def _configure(self) -> None:
-        self.with_volume_mapping(INITDB_DIR, "/docker-entrypoint-initdb.d", "Z")
         self.with_env("POSTGRES_USER", "relukko")
         self.with_env("POSTGRES_PASSWORD", "relukko")
         self.with_env("POSTGRES_DB", "relukko")
@@ -71,59 +84,3 @@ class RelukkoDbContainer(PostgresContainer):
             buf = sock.recv(40)
             if len(buf) == 0 and "SCRAM-SHA" not in buf:
                 raise ConnectionError
-
-
-@pytest.fixture(scope="session")
-def relukko_backend():
-    with Network() as rl_net:
-        with RelukkoDbContainer(net=rl_net,
-            image="postgres:16", hostname="relukkodb") as _db:
-            db_url = "postgresql://relukko:relukko@relukkodb/relukko"
-            with RelukkoContainer(rl_net, db_url=db_url) as backend:
-                relukko = RelukkoClient(
-                    base_url=backend.get_api_url(), api_key="somekey")
-                yield relukko, backend
-
-@pytest.fixture(scope="function")
-def tls_listener():
-
-    certfile = SCRIPT_DIR / "cert" / "relukko.crt"
-    keyfile = SCRIPT_DIR / "cert" / "relukko.key"
-
-    def run_server(port_info: List, keep_running: threading.Event):
-        # Create a TCP socket
-        with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
-            sock.bind(("127.0.0.1", 0))
-            sock.listen(5)  # Listen for incoming connections
-
-            _, assigned_port = sock.getsockname()
-            port_info.append(assigned_port)
-
-            # Wrap the socket with TLS
-            context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
-            context.load_cert_chain(certfile=certfile, keyfile=keyfile)
-            with context.wrap_socket(sock, server_side=True) as ssock:
-
-                ssock.settimeout(1)
-
-                while keep_running.is_set():
-                    try:
-                        client_socket, _ = ssock.accept()
-                        client_socket.sendall(b"Hello, TLS Client!")
-                        client_socket.close()
-                    except Exception as _:
-                        continue
-
-    port_info = []
-    keep_running = threading.Event()
-    keep_running.set()
-    thread = threading.Thread(target=run_server, args=(port_info, keep_running))
-    thread.start()
-
-    while not port_info:
-        pass
-
-    yield thread, port_info[0]
-
-    keep_running.clear()
-    thread.join()

{pyrelukko-0.2.0 → pyrelukko-0.4.0}/src/pyrelukko/version.py

@@ -1,2 +1,2 @@
 # pylint: disable=all
-__version__ = "0.2.0"
+__version__ = "0.4.0"

pyrelukko-0.4.0/tests/cert/README.md

@@ -0,0 +1,11 @@
+# How To
+```
+openssl req -subj '/CN=Relukko CA' -x509 -sha256 -days 7300 -noenc -newkey rsa:2048 -keyout rootCA.key -out rootCA.crt -addext keyUsage=critical,cRLSign,digitalSignature,keyCertSign
+
+ln -s rootCA.crt "$(openssl x509 -hash -noout -in rootCA.crt).0"
+
+openssl req -subj '/CN=relukko' -newkey rsa:2048 -noenc -keyout relukko.key -out relukko.csr -addext keyUsage=critical,digitalSignature,keyEncipherment,keyAgreement -addext extendedKeyUsage=critical,serverAuth
+
+openssl x509 -req -CA rootCA.crt -CAkey rootCA.key -in relukko.csr -out relukko.crt -days 7299 -CAcreateserial
+openssl x509 -inform PEM -in rootCA.crt  -outform DER -out rootCA.der
+```

pyrelukko-0.4.0/tests/cert/relukko.crt

@@ -0,0 +1,18 @@
+-----BEGIN CERTIFICATE-----
+MIIC9zCCAd+gAwIBAgIUXFQN+AOO7KFdiVNVFman8BLkRfkwDQYJKoZIhvcNAQEL
+BQAwFTETMBEGA1UEAwwKUmVsdWtrbyBDQTAeFw0yNDExMTYyMTM5MTNaFw00NDEx
+MTAyMTM5MTNaMBIxEDAOBgNVBAMMB3JlbHVra28wggEiMA0GCSqGSIb3DQEBAQUA
+A4IBDwAwggEKAoIBAQCljry3blOWFJRdinzcH4XzRnvKlhhofBhtRsPH+pvjmrHO
+v52rXj1XeHqXaEBevhNiN7lP5eg2UgOrs0KAVXYR2Na9Mxrh8ACX+IqeEJF9BKgO
+4t2RvItDU3SWxV3dIYMasBhe/iDXDKKZd/jVOiluL9zuxo9ltDagZxc72jWMnvrO
+lvlnZVEtH4n9i+hnx1daWRZG87DjO6d8I8F8nX6NTqJgBlrRm8jlcq2N/G8eHTFq
+OrLY4xk4CF+aVExpJrEGprfhNkbE025tJIbGNM9Xv+W0sI/nhEwJdv4ifEP/b+44
+n+KHrAurOboFYmRcoZ9Vn4C1KuYBvDOpgkwOs1wtAgMBAAGjQjBAMB0GA1UdDgQW
+BBSy6DZz/N1PW1mkQY7HUj3Fz6yZOjAfBgNVHSMEGDAWgBT+sHazfmyczKb0BV6r
+Z1JQ8Sfx9zANBgkqhkiG9w0BAQsFAAOCAQEAL1c1l3Azna1mh86haErurYk3EsiH
+KDGprRubdB5qfpa2GdAkhitp9juKYdKGdw877eOl5z7AMeMWAA8WXQ3z7jkQkUhU
+9wsZxNyHQajq6Lo9KsRxZiRKZX/fxagcnDem+4xTvzSlJoAT5p/CO5E31odwWkZN
+bg79I36nk87opISXzNAbMBcbQEV5R8l4PzNGs/DcrLzTC66FKxHHzyih4mlBF5mS
+/sMY5l9QNaJHKPK7fKZ5yxohkda7tDwtb5p0bbEUQlMeZIQ8r/go1b7/ppXXM5ei
+mTDcwKgeOBgVujqhvgGXOKtcHVfkrqcID+qgDMxYd7XXE/icGF3zmnHwDQ==
+-----END CERTIFICATE-----

pyrelukko-0.4.0/tests/cert/relukko.csr

@@ -0,0 +1,16 @@
+-----BEGIN CERTIFICATE REQUEST-----
+MIICkDCCAXgCAQAwEjEQMA4GA1UEAwwHcmVsdWtrbzCCASIwDQYJKoZIhvcNAQEB
+BQADggEPADCCAQoCggEBAKWOvLduU5YUlF2KfNwfhfNGe8qWGGh8GG1Gw8f6m+Oa
+sc6/natePVd4epdoQF6+E2I3uU/l6DZSA6uzQoBVdhHY1r0zGuHwAJf4ip4QkX0E
+qA7i3ZG8i0NTdJbFXd0hgxqwGF7+INcMopl3+NU6KW4v3O7Gj2W0NqBnFzvaNYye
++s6W+WdlUS0fif2L6GfHV1pZFkbzsOM7p3wjwXydfo1OomAGWtGbyOVyrY38bx4d
+MWo6stjjGTgIX5pUTGkmsQamt+E2RsTTbm0khsY0z1e/5bSwj+eETAl2/iJ8Q/9v
+7jif4oesC6s5ugViZFyhn1WfgLUq5gG8M6mCTA6zXC0CAwEAAaA5MDcGCSqGSIb3
+DQEJDjEqMCgwDgYDVR0PAQH/BAQDAgOoMBYGA1UdJQEB/wQMMAoGCCsGAQUFBwMB
+MA0GCSqGSIb3DQEBCwUAA4IBAQBfEyjmGQtITqSsmoAQXEb11Cm/olsL5w6kEzgr
+/0K8ASvDvW+3yJ3U9OBngvgh6iQCJjYaixb8NtQS7yVWYEqJoaA0Hp1q0QDmRS/l
+MDLe2cILgbLQUKOf1jLtYsLG93Lb74HSGztjIIEoi3Wgrm5LLGc/cd28q8yw5c/j
+s1EntUHeNWCYAUIRvwmt+1UPcc8EBHH2DugGz2verzARdvLWAajL5r9ZIJkkU0kY
+fh5gnmVb6I6RtIXhWcXMUL9nBwzPCyJMd4cC/fueC+HxzLNhGldvVxj3cg7W57vR
+QnbG/qcJYN5WGhoHrWIiI90GufG4jifVvyQeBC/vQcymRlAL
+-----END CERTIFICATE REQUEST-----

pyrelukko-0.4.0/tests/cert/relukko.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCljry3blOWFJRd
+inzcH4XzRnvKlhhofBhtRsPH+pvjmrHOv52rXj1XeHqXaEBevhNiN7lP5eg2UgOr
+s0KAVXYR2Na9Mxrh8ACX+IqeEJF9BKgO4t2RvItDU3SWxV3dIYMasBhe/iDXDKKZ
+d/jVOiluL9zuxo9ltDagZxc72jWMnvrOlvlnZVEtH4n9i+hnx1daWRZG87DjO6d8
+I8F8nX6NTqJgBlrRm8jlcq2N/G8eHTFqOrLY4xk4CF+aVExpJrEGprfhNkbE025t
+JIbGNM9Xv+W0sI/nhEwJdv4ifEP/b+44n+KHrAurOboFYmRcoZ9Vn4C1KuYBvDOp
+gkwOs1wtAgMBAAECggEAAlGzzikAoqYfc7wywBDXLkXjClhpN2t6zYStTbhlvyQ4
+9rgdJA9CC9JI+1gVqlrkyB5j0IOPg27i+y1PBblMwF0mf7t+/KiOEl+3R2J2VODZ
+q6Dp110KB8bCdLGg/TqqZld02/D/S98ZY83eezqUZbH/cqVu6rVbaSQdWyeh7Bow
+0rfnMV2537JpZVXzmVDGhlhKcgKjJFkzdW4Zv34lMSOCAAeByrIJtPEoQrJ7MQOj
+9WpwYN+JN4YeP1FWXIG3Ah7ivFsCMZN9MEvXWMcEnAqSHhXXyRzJnJh4jBrigfM1
+JeqDWgiMlCLP5Z2CwA8ahTnJZAYBJUfeFiNHBYC1sQKBgQDjoTCIlCr7UyLkxaJr
++IY65tl0jjWiEEvSZ9E+fqqesAsABGE8Po1ZEA7VZNViFf+4ttuBZLngmm/YVBvV
+Ok+hf1HSDsvNhon7oIIa7cxlYGKH2Lf6tq8ovtt7IXRknInbbxh6+CoMm5Yc1KXp
+XRCApfeBEoQdM2N2TRLUL+pPkQKBgQC6MQ9L3zMEr2yXrkyi2wmqBMMaSHCM5Zuh
+ifQSFjJfkarh2y0KN7I73HR6KJVMVRVSmARi/QgN8tEvaXjCvVN67re4mDiZ5rC+
+uIx903tkuKR4ruC1DE96NtsM1VNh1mUa2ndPULztpqPXhMCPspMltH4KbJHLo/iv
+MaRHu2Ps3QKBgDGluIYxeuZyDYxEJtbRz8UNEKTBV6VPVJpBlnvA+Mm/r8aDLgoL
+wpyIShP0+C16itno2Btysq/wPzC5t5BcNX4N3PSp0X20OGgva/EfqJL74MGsXQRL
+0AxdBFXoyBAhrFe19WrssY8qaCVFpCIv8Cd/C2qVdUdBLBJjYRXylXJhAoGBAIPX
+z5QTReYwbj3uD5hWcD5zRtBqsUAkKpM1w523GA5ycMWj1P3iOJSI4/XInQfDS+kD
+ej+6GyT9Z0Eid3+2XtGzDmdpatMX9tnmhp1mzn6g/N30P2wUfob1JyGsQXILRebB
+AjEo48+I64XmHBDlC6tsZr/s50SDJMqx5TliKT0FAoGAeqqC57jD2bj8Srs1Xa9p
+JDZdS1DU/HthIngHTlud/rvOs2koVbIKRAHqxoBn2TCii6srFf7nHgLZ4iDOiyHF
+eOb52GaYYKQNiSF77LUV0wdxmwwhm3h6hRYgt52nT1JVHH6rilZ64e2mevPX5H1T
+CVvlmUZTRqXOidoSGMkO3sQ=
+-----END PRIVATE KEY-----

pyrelukko-0.4.0/tests/cert/rootCA.crt

@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE-----
+MIIDGzCCAgOgAwIBAgIURXOBbBP+BSnq15fqso3+0Wkwt2swDQYJKoZIhvcNAQEL
+BQAwFTETMBEGA1UEAwwKUmVsdWtrbyBDQTAeFw0yNDExMTYyMTM4MDVaFw00NDEx
+MTEyMTM4MDVaMBUxEzARBgNVBAMMClJlbHVra28gQ0EwggEiMA0GCSqGSIb3DQEB
+AQUAA4IBDwAwggEKAoIBAQDSDxl9hWmwLjTwJTHTH55HwNFKDMHXjiMmig2SMVCE
+Y9fRYNms46CU+ulGGr8TMqXExb3J1ywE/HB8PBYoPKvAmPBHrquXT03A64fXl30q
+IcnRHsJymxmUQV7yQxyfIXHT57NGUBauRhYSG8enbTNPbwByAdDAK6z0/41mMPbz
+NFSXR89+ZkYf0CfKkvi/lPGdC80rS9LokLvDniVT50ir4CurhzndBP/U82nTMxvr
++Q2/TQmxbzeHOpa4ZCD2OBAHNXAGgV1qltnhvmbn+zYEK+vt9ZSb6lRUXWBWUvkn
+TRCy3lMHu27q5h8Gzzxvi0Ct2lJ02poZG98QlXoAto+RAgMBAAGjYzBhMB0GA1Ud
+DgQWBBT+sHazfmyczKb0BV6rZ1JQ8Sfx9zAfBgNVHSMEGDAWgBT+sHazfmyczKb0
+BV6rZ1JQ8Sfx9zAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBhjANBgkq
+hkiG9w0BAQsFAAOCAQEAASuRdyC8zk+FD3DO8vO3bpxiewqjSjQ0cE/t2XU3floV
+r6Lp1bS+IjpeKIYzTg3+DdIMGub8piCh7JcU5ru1Ef0/xwtmCCUB/rOcYwfa2nHj
+w7sc+njSnmdpISCyUV9Yxsqs+b2eQOMj/D28R5c2vf7QIYQMJivqa44TrMy57mJP
+Tu+Y4stHZnfrnlggScfjn+dKjT58awyI0UVPr80YWZuSIDx26CREP41X8SJ5qRMN
+K6KFXxN/PJhl/Y5axV/k/omRXd1FusUaC8yGk5E4zCs7cvbhG830FVIM19zbVSKg
+SF6Dvx3mEWraHyBls9e+FYQIxB5FEJz9KGZdsOSjcQ==
+-----END CERTIFICATE-----

pyrelukko-0.4.0/tests/cert/rootCA.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDSDxl9hWmwLjTw
+JTHTH55HwNFKDMHXjiMmig2SMVCEY9fRYNms46CU+ulGGr8TMqXExb3J1ywE/HB8
+PBYoPKvAmPBHrquXT03A64fXl30qIcnRHsJymxmUQV7yQxyfIXHT57NGUBauRhYS
+G8enbTNPbwByAdDAK6z0/41mMPbzNFSXR89+ZkYf0CfKkvi/lPGdC80rS9LokLvD
+niVT50ir4CurhzndBP/U82nTMxvr+Q2/TQmxbzeHOpa4ZCD2OBAHNXAGgV1qltnh
+vmbn+zYEK+vt9ZSb6lRUXWBWUvknTRCy3lMHu27q5h8Gzzxvi0Ct2lJ02poZG98Q
+lXoAto+RAgMBAAECggEAMnh7TOv5xWGMyah+LLZ7nszm3G5tQr/9lRx1f0tHB9A/
+gijNlFtK8ZDJ7NSvVUsFhl5mp/EBvB71XfxH7JoLQGbe0LJYuy3MRk6xIG1fHvjo
+V00XNlcq0bLVP8s9PMTZ5yrUKdBDatMfKXGwSnuT6QGIL1xdTlcQIvul+0hHhY58
++QGhB1HJASChg13OjLFwDhjiUqH1rkr8WjFspZZIm+SrwXUZTr6PYkF4E1cBcsWT
+4PLCYKTZTKKr3D0UVa5ipOkp/ZIgWqRk1SACn84G1/AkmBpgv+0XgZz8kZ0Ju+9W
+sPQV/fxXYpvnM/cvkHBAnvWDp4N3VX648zez7t+f2wKBgQD7guX7G5LdtLB/Crlx
+uyAhkJyvc8Ttt11HCf2T/k6oqhATt9014NlJYQY2pVlyoyEQEb1Pe919ei+UpVVt
+Ahaanw5xveOeGdjc2YJIqQV4mqc/daEXFfyLU+3dCzTKB4AXaIT09If5mna46Ou/
+q1UW96cH/SqLC5Z3CyUhqwIvfwKBgQDVztB2P1KBH45lOT1oP/vPxYklUSokA/g+
+VRw3pB8Wmm86fSxQ1lEvMViVf/tyrc+dpvNS+7quNzc0U/2+vpMcLjBkS9EpxAMy
+hPDwZPnPXHKHnC/ET9WWO+wVaCTienGSVaTDTToeKo71Oesi1etHkLl0aWEMp8vo
+gYGPM+/I7wKBgF0dNhXEPJhWF+3Aw60mcRvcFRYjzymO9DqjqTzMLsTkyTTzojMb
+PnabNBixGK+HU2tGlgbCPdsBjHIEz96eok22Szuy6H0U5qPE5yYNZVgkMX0eCHiq
+jCfs96gZSP7uze5cpLSnf1vaYs/Mc9MvFD5/i1g60zBNJvSFrMaNMC7zAoGBANNp
+y+GQ3aEGNgRLZDgIRJN/DQyURCoWrsnb2KoAJClyjZd1HHPWZ7JVhfVV9qm/yjJm
+WeXtOft4Z6LbhmWtBcPwvDMAcRNuWYcDw0bBYe6zyB/lxanFEzqZh+jm8MntLw32
+l5PycgxQIsnC+omYoyxBo8/DP46HAO6n2Bdk0K6LAoGACP/UfrAg4Hyqi0jJcusl
+Led0R3Fl0dw5i2N9PB++PUajt5LFhXXGHeOQnTlYbeJ/ioJgRS/k6W7MH43zP0me
+wIYrVmazCewXwcIZiRv3ees73OsAVrn/yl17+u4KkVlXi0me8Opljl4/MS8026rE
+iKMsJnco7XH/vaS9MrrrOvE=
+-----END PRIVATE KEY-----

pyrelukko-0.4.0/tests/cert/rootCA.srl

@@ -0,0 +1 @@
+5C540DF8038EECA15D8953551666A7F012E445F9

pyrelukko-0.4.0/tests/conftest.py

@@ -0,0 +1,79 @@
+import os
+import socket
+import ssl
+import threading
+from pathlib import Path
+from typing import List
+
+import pytest
+from testcontainers.core.network import Network
+
+from pyrelukko import RelukkoClient
+from pyrelukko.testcontainers import RelukkoContainer, RelukkoDbContainer
+
+SCRIPT_DIR = Path(__file__).parent.absolute()
+
+
+@pytest.fixture(scope="session")
+def relukko_backend():
+    if os.environ.get("CI_HAS_RELUKKO"):
+        # Gitlab does not allow DinD networks, so Relukko runs as a service
+        # in the background of the job.
+        relukko = RelukkoClient(
+            base_url=os.environ['CI_RELUKKO_BASE_URL'],
+            api_key=os.environ['CI_RELUKKO_API_KEY']
+        )
+        yield relukko, None
+    else:
+        with Network() as rl_net:
+            with RelukkoDbContainer(net=rl_net,
+                image="postgres:16", hostname="relukkodb") as _db:
+                db_url = "postgresql://relukko:relukko@relukkodb/relukko"
+                with RelukkoContainer(rl_net, db_url=db_url) as backend:
+                    relukko = RelukkoClient(
+                        base_url=backend.get_api_url(), api_key="somekey")
+                    yield relukko, backend
+
+@pytest.fixture(scope="function")
+def tls_listener():
+
+    certfile = SCRIPT_DIR / "cert" / "relukko.crt"
+    keyfile = SCRIPT_DIR / "cert" / "relukko.key"
+
+    def run_server(port_info: List, keep_running: threading.Event):
+        # Create a TCP socket
+        with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
+            sock.bind(("127.0.0.1", 0))
+            sock.listen(5)  # Listen for incoming connections
+
+            _, assigned_port = sock.getsockname()
+            port_info.append(assigned_port)
+
+            # Wrap the socket with TLS
+            context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
+            context.load_cert_chain(certfile=certfile, keyfile=keyfile)
+            with context.wrap_socket(sock, server_side=True) as ssock:
+
+                ssock.settimeout(1)
+
+                while keep_running.is_set():
+                    try:
+                        client_socket, _ = ssock.accept()
+                        client_socket.sendall(b"Hello, TLS Client!")
+                        client_socket.close()
+                    except Exception as _:
+                        continue
+
+    port_info = []
+    keep_running = threading.Event()
+    keep_running.set()
+    thread = threading.Thread(target=run_server, args=(port_info, keep_running))
+    thread.start()
+
+    while not port_info:
+        pass
+
+    yield thread, port_info[0]
+
+    keep_running.clear()
+    thread.join()

{pyrelukko-0.2.0 → pyrelukko-0.4.0}/tests/test_relukko.py

@@ -2,7 +2,7 @@ import logging
 import time
 import ssl
 import socket
-from datetime import datetime, timezone
+from datetime import datetime, timedelta, timezone
 from pathlib import Path
 from typing import Dict
 
@@ -32,7 +32,7 @@ def _check_tls(ssl_ctx: ssl.SSLContext, port):
 
 def _check_has_serial_no(ssl_ctx: ssl.SSLContext):
     serial_numbers = [x["serialNumber"] for x in ssl_ctx.get_ca_certs()]
-    assert "78B4E1E498136651B475BC2D0880A28E4835316C" in serial_numbers
+    assert "4573816C13FE0529EAD797EAB28DFED16930B76B" in serial_numbers
 
 
 def test_init_relukko_client():
@@ -59,6 +59,11 @@ def test_init_relukko_client():
     assert relukko.backoff == 2.0
     assert relukko.max_delay is None
     assert relukko.exceptions == (requests.ConnectionError, RelukkoDoRetry)
+    assert relukko.ws_wait_for_timeout == 2
+    assert relukko.ws_ping_interval == 60
+    assert relukko.ws_ping_timeout == 20
+    assert relukko.acquire_wait_for_timeout == 2
+    assert relukko.acquire_modulo == 100
 
     with pytest.raises(ValueError):
         RelukkoClient(base_url=1000, api_key="")
@@ -152,7 +157,7 @@ def test_reconfigure_relukko_client():
         "https://relukko", api_key="secret-key")
 
     assert relukko.base_url == parse_url("https://relukko")
-    assert relukko.ws_url == parse_url("wss://relukko/deletions")
+    assert relukko.ws_url == parse_url("wss://relukko/ws/broadcast")
     assert relukko.session.headers['X-api-Key'] == "secret-key"
 
     default_ctx = ssl.create_default_context()
@@ -169,6 +174,11 @@ def test_reconfigure_relukko_client():
     assert relukko.backoff == 2.0
     assert relukko.max_delay is None
     assert relukko.exceptions == (requests.ConnectionError, RelukkoDoRetry)
+    assert relukko.ws_wait_for_timeout == 2
+    assert relukko.ws_ping_interval == 60
+    assert relukko.ws_ping_timeout == 20
+    assert relukko.acquire_wait_for_timeout == 2
+    assert relukko.acquire_modulo == 100
 
 
 def test_reconfigure_relukko_client_extended():
@@ -178,6 +188,11 @@ def test_reconfigure_relukko_client_extended():
     verify_mode = ssl.VerifyMode.CERT_NONE
     verify_flags = ssl.VerifyFlags.VERIFY_DEFAULT
     options = ssl.Options.OP_ALL
+    ws_wait_for_timeout = 27
+    ws_ping_interval = 600
+    ws_ping_timeout = 23
+    acquire_wait_for_timeout = 22
+    acquire_modulo = 202
 
     relukko.reconfigure_relukko(
         base_url="https://relukko", api_key="my-API-key", trust_env=False,
@@ -185,13 +200,16 @@ def test_reconfigure_relukko_client_extended():
         status=96, other=95, backoff_factor=94, backoff_max=1000,
         backoff_jitter=93, raise_on_redirect=False, raise_on_status=False,
         check_hostname=False, hostname_checks_common_name=False,
-        verify_mode=verify_mode, verify_flags=verify_flags, options=options
+        verify_mode=verify_mode, verify_flags=verify_flags, options=options,
+        ws_wait_for_timeout=ws_wait_for_timeout, acquire_modulo=acquire_modulo,
+        ws_ping_interval=ws_ping_interval, ws_ping_timeout=ws_ping_timeout,
+        acquire_wait_for_timeout=acquire_wait_for_timeout,
     )
 
     assert relukko.session.trust_env == False
     assert relukko.session.cookies == cookies
     assert relukko.base_url == parse_url("https://relukko")
-    assert relukko.ws_url == parse_url("wss://relukko/deletions")
+    assert relukko.ws_url == parse_url("wss://relukko/ws/broadcast")
     assert relukko.session.headers['X-api-Key'] == "my-API-key"
     http_adapter: HTTPAdapter = relukko.session.adapters.get("http://")
     assert http_adapter.max_retries.total == 100
@@ -218,22 +236,35 @@ def test_reconfigure_relukko_client_extended():
     assert relukko.backoff == 2.0
     assert relukko.max_delay is None
     assert relukko.exceptions == (requests.ConnectionError, RelukkoDoRetry)
+    assert relukko.ws_wait_for_timeout == ws_wait_for_timeout
+    assert relukko.ws_ping_interval == ws_ping_interval
+    assert relukko.ws_ping_timeout == ws_ping_timeout
+    assert relukko.acquire_wait_for_timeout == acquire_wait_for_timeout
+    assert relukko.acquire_modulo == acquire_modulo
 
 
 def test_init_relukko_client_extented():
     cookies = cookiejar_from_dict({"cookie1": "value1"})
+    ws_wait_for_timeout = 27
+    ws_ping_interval = 600
+    ws_ping_timeout = 23
+    acquire_wait_for_timeout = 22
+    acquire_modulo = 202
 
     relukko = RelukkoClient(
         base_url="http://relukko", api_key="my-API-key", trust_env=False,
         cookies=cookies, total=100, connect=99, read=98, redirect=97,
         status=96, other=95, backoff_factor=94, backoff_max=1000,
         backoff_jitter=93, raise_on_redirect=False, raise_on_status=False,
+        ws_wait_for_timeout=ws_wait_for_timeout, acquire_modulo=acquire_modulo,
+        ws_ping_interval=ws_ping_interval, ws_ping_timeout=ws_ping_timeout,
+        acquire_wait_for_timeout=acquire_wait_for_timeout,
     )
 
     assert relukko.session.trust_env == False
     assert relukko.session.cookies == cookies
     assert relukko.base_url == parse_url("http://relukko")
-    assert relukko.ws_url == parse_url("ws://relukko/deletions")
+    assert relukko.ws_url == parse_url("ws://relukko/ws/broadcast")
     assert relukko.session.headers['X-api-Key'] == "my-API-key"
     assert relukko.ssl_ctx is None
     http_adapter: HTTPAdapter = relukko.session.adapters.get("http://")
@@ -253,6 +284,11 @@ def test_init_relukko_client_extented():
     assert relukko.backoff == 2.0
     assert relukko.max_delay is None
     assert relukko.exceptions == (requests.ConnectionError, RelukkoDoRetry)
+    assert relukko.ws_wait_for_timeout == ws_wait_for_timeout
+    assert relukko.ws_ping_interval == ws_ping_interval
+    assert relukko.ws_ping_timeout == ws_ping_timeout
+    assert relukko.acquire_wait_for_timeout == acquire_wait_for_timeout
+    assert relukko.acquire_modulo == acquire_modulo
 
 
 def test_init_relukko_client_ssl_ctx():
@@ -351,7 +387,25 @@ def test_acquire_relukko(relukko_backend):
     lock = relukko.acquire_relukko("pylock", "pytest", 30)
     end_time = time.time()
     assert lock is None
-    assert 29 < end_time - start_time < 34
+    assert 29 < end_time - start_time < 45
+
+
+def test_acquire_relukko_with_del(relukko_backend):
+    relukko, _ = relukko_backend
+    lock = relukko.acquire_relukko("Pylock", "pytest", 10)
+    id = lock['id']
+
+    expires_at = datetime.now(timezone.utc) - timedelta(minutes=2, seconds=45)
+    upd_lock = relukko.update_relukko(id, expires_at=expires_at)
+    assert id == upd_lock['id']
+
+    start_time = time.time()
+    lock = relukko.acquire_relukko("Pylock", "pytest", 90)
+    end_time = time.time()
+
+    assert lock is not None
+    assert upd_lock['id'] != lock['id']
+    assert 29 < end_time - start_time < 50
 
 
 def test_delete_relukko(relukko_backend):

pyrelukko-0.2.0/.pylintrc.toml

@@ -1,9 +0,0 @@
-[tool.pylint.main]
-# Files or directories to be skipped. They should be base names, not paths.
-ignore = ["LICENSE", "pyproject.toml", "version.py",
-          "README.md", "demo.py", "conftest.py"]
-
-# Files or directories matching the regular expression patterns are skipped. The
-# regex matches against base names, not paths. The default value ignores Emacs
-# file locks
-ignore-patterns = ["^\\.#", "^test_"]

pyrelukko-0.2.0/pyproject.toml

@@ -1,39 +0,0 @@
-[project]
-name = "pyrelukko"
-authors = [
-    {name = "Reto Zingg", email = "g.d0b3rm4n@gmail.com"},
-]
-readme = "README.md"
-
-# https://pypi.org/pypi?%3Aaction=list_classifiers
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
-    "Topic :: Internet :: WWW/HTTP",
-    "Topic :: Software Development :: Libraries :: Python Modules",
-]
-requires-python = ">=3.12"
-dynamic = ["version", "description"]
-dependencies = [
-    "requests >=2.32.3",
-]
-
-[tool.flit.sdist]
-exclude = [".gitignore", "demo.py"]
-
-[project.urls]
-Homepage = "https://gitlab.com/relukko/pyrelukko"
-Issues = "https://gitlab.com/relukko/pyrelukko/-/issues"
-
-[build-system]
-requires = ["flit_core >=3.2,<4", "semantic-version >= 2.10"]
-build-backend = "flit_core.buildapi"
-
-[tool.pytest.ini_options]
-testpaths = [
-    "tests",
-]
-pythonpath = [
-    "src",
-]

pyrelukko-0.2.0/tests/cert/README.md

@@ -1,8 +0,0 @@
-# How To
-```
-openssl req -x509 -sha256 -days 7300 -noenc -newkey rsa:2048 -keyout rootCA.key -out rootCA.crt
-ln -s rootCA.crt "$(openssl x509 -hash -noout -in rootCA.crt)"
-openssl req -newkey rsa:2048 -noenc -keyout relukko.key -out relukko.csr
-openssl x509 -req -CA rootCA.crt -CAkey rootCA.key -in relukko.csr -out relukko.crt -days 7299 -CAcreateserial
-openssl x509 -inform PEM -in rootCA.crt  -outform DER -out rootCA.der
-```

pyrelukko-0.2.0/tests/cert/relukko.crt

@@ -1,21 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDeDCCAmCgAwIBAgIUIG2mO1IxfM3wqiLLFCO+6ubGdHswDQYJKoZIhvcNAQEL
-BQAwVDELMAkGA1UEBhMCWFgxFTATBgNVBAcMDERlZmF1bHQgQ2l0eTEcMBoGA1UE
-CgwTRGVmYXVsdCBDb21wYW55IEx0ZDEQMA4GA1UEAwwHUmVsdWtrbzAeFw0yNDEx
-MTMxNTQxNTdaFw00NDExMDcxNTQxNTdaMFQxCzAJBgNVBAYTAlhYMRUwEwYDVQQH
-DAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQgQ29tcGFueSBMdGQxEDAO
-BgNVBAMMB3JlbHVra28wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCr
-89++zNQs+MG5opoCTWq/QxAJsr9Uul598XoQFXn1N/d/JOeSosy8BNvb1RXsr5sp
-sNJbJEun6OPFtUoVczUtivS99XNchWPjEQ18w22aiLcwl/uOrdfxWj04yEfKmejN
-ZXFrShhAWRGfc3fi2hD0Y5mtbS7T5iqaYzm4U5UDVFizVPnSgPFXMAiat/VQGvBF
-cv5IpBjXOJGkLZTzmFlW61T6m+MJGXF59CLC6vL6QJCqQpSUWG9UM00R8L2pQ1b8
-HLKYUuJ+vp4WVYwYyz769BNG4OG3IkdqIHKDFWBXFVmKaUkX9aAul4BOitKy4XFc
-8eu653lbkVnRHb01RaP7AgMBAAGjQjBAMB0GA1UdDgQWBBSEFybZBM4O7khSofZl
-0oAT+CSXEjAfBgNVHSMEGDAWgBRAo64Da82emF0q53wCdj4wbFTmMDANBgkqhkiG
-9w0BAQsFAAOCAQEAs+zaKt8VqLoVT0OT24Oxyzc+/A0h4BYq3kYD11BaUJ6oKqQu
-57FRKi0ZWxNSNCbzrwi6W+qNgIXtvSHWk4+BKxzqDVG6LCIuNn4bbvlQMGuTWctY
-ndArPxdKvN9AXeCvam+5XKcA5OJY/naoho7fSoGh2Zgkq9HS7DlKxfBW2GEY0mp8
-jeuxvBvh4xw/YuESVFbKedglaoNFf+aP44zL47Wn9QJcLqByGpTV472j238ObUFi
-k47o+v4Qt7nkJDOcx7ic//uLTcb/1rv1SppYpKr3YJ5fLspzMMPpTQbkt2H8hLiZ
-+1jj5GIoDgLi+/uxBgYQs78jEOIKkWO6EjwGUw==
------END CERTIFICATE-----

pyrelukko-0.2.0/tests/cert/relukko.csr

@@ -1,16 +0,0 @@
------BEGIN CERTIFICATE REQUEST-----
-MIICmTCCAYECAQAwVDELMAkGA1UEBhMCWFgxFTATBgNVBAcMDERlZmF1bHQgQ2l0
-eTEcMBoGA1UECgwTRGVmYXVsdCBDb21wYW55IEx0ZDEQMA4GA1UEAwwHcmVsdWtr
-bzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKvz377M1Cz4wbmimgJN
-ar9DEAmyv1S6Xn3xehAVefU3938k55KizLwE29vVFeyvmymw0lskS6fo48W1ShVz
-NS2K9L31c1yFY+MRDXzDbZqItzCX+46t1/FaPTjIR8qZ6M1lcWtKGEBZEZ9zd+La
-EPRjma1tLtPmKppjObhTlQNUWLNU+dKA8VcwCJq39VAa8EVy/kikGNc4kaQtlPOY
-WVbrVPqb4wkZcXn0IsLq8vpAkKpClJRYb1QzTRHwvalDVvwcsphS4n6+nhZVjBjL
-Pvr0E0bg4bciR2ogcoMVYFcVWYppSRf1oC6XgE6K0rLhcVzx67rneVuRWdEdvTVF
-o/sCAwEAAaAAMA0GCSqGSIb3DQEBCwUAA4IBAQCHkmw8bBBI9pOrlCrJ2u3sGdlx
-3ZbW/+kGdsQ8Odb/pIHkLLKpu5yNLEey/U4EZyWSNewYDUKfS2FIyMN2c38QAex6
-1Y9qPK74RzUB68ki7XKtp+GAGqVb0axxRe0IuBwc9d5jl6zjltcpdutAIIgXcJgg
-8QPnfpz7Skhjjm/duTVp0rurWsPztQdDpkrcY3c49vuTLA5uKwfa//cPAOmVGwqq
-TMICj+0M2S+bgg9Ksph1IsDxxuIm1aa2EFnF5XRbJn9aOSdyfBkKoZz9ttgu1hP4
-+hPe8S3ekUyJiZAglSI1qJOkpyw14EDIhwJvE9FG5eN/mU8wS1/GU+vhZWKN
------END CERTIFICATE REQUEST-----

pyrelukko-0.2.0/tests/cert/relukko.key

@@ -1,28 +0,0 @@
------BEGIN PRIVATE KEY-----
-MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQCr89++zNQs+MG5
-opoCTWq/QxAJsr9Uul598XoQFXn1N/d/JOeSosy8BNvb1RXsr5spsNJbJEun6OPF
-tUoVczUtivS99XNchWPjEQ18w22aiLcwl/uOrdfxWj04yEfKmejNZXFrShhAWRGf
-c3fi2hD0Y5mtbS7T5iqaYzm4U5UDVFizVPnSgPFXMAiat/VQGvBFcv5IpBjXOJGk
-LZTzmFlW61T6m+MJGXF59CLC6vL6QJCqQpSUWG9UM00R8L2pQ1b8HLKYUuJ+vp4W
-VYwYyz769BNG4OG3IkdqIHKDFWBXFVmKaUkX9aAul4BOitKy4XFc8eu653lbkVnR
-Hb01RaP7AgMBAAECggEAF22KShjmkwavf7HfnDmyYMMWhSO//XTJBA1/DSrylg5d
-NQsGVsxslZ9vLyP4sT9PJjPWbUmO2fPuo1TVy6y0jZ3K8Qi8rNnrEphpBzB/Qe38
-+5dxfu6WUebIGZucFca42SdITTm9VSMYNhU0O98XLp0AEV4jYlvlPmoPhrAzSM50
-lEIuriNhqHuqZhXN0jPYI1jZDS5JVi2PlbgyO1125BBMsCMLfhW+wcme/Y/VAySc
-pNkvK3aHeWJUXEeVKuNfn5878PqeD6ZPjl9Hyq3lj6yOauIO/PCdIwm+2qjzrYsy
-IBhjFFEoMGofgz+KV7olZu9by38ZzhW7nZGGe+zbgQKBgQDmFyzzxz3/BF7FKTXL
-v6uVNkGpMGH8EQE1H+YJXTiSaqf/3ZrsXyBsbA6YBanKBXcY/F0PhQ7e/rjtqaGU
-OtekNTHSgosdbJgVX88EjfIa4/rbZPUsX6qRJBuDVOCcCZC1PyFBT2ehKYlIPHS0
-klbXo57pYzgDnzrYPr6UWbCZewKBgQC/UMGNvqJXszYZe3hjd9Ek9oSJMThfpfXn
-opNhCNHKZ8+xqry602TqIwyStYc7elB57R547ZR4kttT8iM1E7ZOoLRPP0r/FjOS
-scpCAk5ouVG9RZaUvTIbvzdEifEOt1Vf0RgIG3Y4DBqtotNoymqyT5wzuxyJQm1E
-683UVIbXgQKBgQCLPJ0UTI7kwtVCxIRsbum7WuDzLHcvHW84obwIEKSKXgaaHJWC
-0rIBSoauUkcEHLiMozMBkEiGg2iPUaaY197k3NfwhtT+kleaH6dcHzXSNgH5QCfp
-mV7ThCEuIW/mnRc3xyMtrYqNiWAtGYCaQTBSQA6LN2KPNo1ajOWxSnFG/wKBgQC2
-9rBksq/nV4ihjidwWSI3S1stKVlUgA9QW3a/EgQwol9K9pJPyeN019gqZljSVQOp
-10+RLwUS2r/O5H8vP47WW3KVZ1593emsnUNlJXd/R9wYOvjrfpTxXEmqzpEvFb4c
-SIfHGRxSNaE99b5hNVQc+23TO1rrGhAOHcVXDw92AQKBgQDCMEcIcwHx+ahVZbEb
-bAyWLwYxQFRStmYKbYBtEMFW39atRmc0wdAG0my/0cUyHUIfWbHvP5oTfyAthV9G
-8G0qBk5fPhh6hfNRFMb2j1AqnZ3CadoBZq2HelTTUqt4UgU9Y4iDco+4ew34Uw76
-2ki1bKXiJKkJYlk14AMrzckDUQ==
------END PRIVATE KEY-----

pyrelukko-0.2.0/tests/cert/rootCA.crt

@@ -1,21 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDiTCCAnGgAwIBAgIUeLTh5JgTZlG0dbwtCICijkg1MWwwDQYJKoZIhvcNAQEL
-BQAwVDELMAkGA1UEBhMCWFgxFTATBgNVBAcMDERlZmF1bHQgQ2l0eTEcMBoGA1UE
-CgwTRGVmYXVsdCBDb21wYW55IEx0ZDEQMA4GA1UEAwwHUmVsdWtrbzAeFw0yNDEx
-MTMxNTM3MDBaFw00NDExMDgxNTM3MDBaMFQxCzAJBgNVBAYTAlhYMRUwEwYDVQQH
-DAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQgQ29tcGFueSBMdGQxEDAO
-BgNVBAMMB1JlbHVra28wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD4
-PWQPjCCXOvZYUDpYhZHR4Nw0ErkZEZWtPMyoBnyGkYwqK1SrHCcIYQL8C22dN1rn
-VdFvCVH13fQHz1SJ/v3jkS+9IiOUDenXpZP/G0pprTbLGh33aaQU53EqvO1T2CAA
-zIAVdme0cihOB+KL2A5bDzP9fu+c0ddn+N++ZgcqBHMYmZKIGJv5QZ+i+/1xrGqQ
-/znwV7RuBGms8fxA3x4Y4ELUzIHMpbXbQn95qC9u7ee4odQ5KjR1M0oocPKOYBGa
-/Dqnhd3Wx0lHR3No8HgC4TBfxruhs+NZtRyInOTFr99TWbBx+zrDvxecM/5j/AnH
-WHka8xMQSxJUeoXtlFT/AgMBAAGjUzBRMB0GA1UdDgQWBBRAo64Da82emF0q53wC
-dj4wbFTmMDAfBgNVHSMEGDAWgBRAo64Da82emF0q53wCdj4wbFTmMDAPBgNVHRMB
-Af8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQACdVeJ/CnXpY4t568bQRxIr+t3
-IqeIqJVg1nt6OaB/EJPJil/lvJD8bjO5W5uXAnbkv26i0Q89KFZH3xKFHRmL/zR+
-0YPcbi3LmQ+NY6LtH1GtBlRiobROfSp8/GxTrGxqMGHHxBdY+v8lPiK1LHTE99ik
-cl8qF+DQMGeliPQcg9rLgXagymEc9oS3OgxjL7Al4/P8bLkdC/hxk+cEUFCXUX4v
-z/PAFnHwEeJPiiNYG+hpQQRloVncynEwhBr/pGGMdLGaFBje41kn9Ss2anc+YaiW
-DyoDLuQkCcRrUvc2dCGMZs0KaCv8i61QWGNy8suGq6nrXW9A57JhS7ak8xg9
------END CERTIFICATE-----

pyrelukko-0.2.0/tests/cert/rootCA.key

@@ -1,28 +0,0 @@
------BEGIN PRIVATE KEY-----
-MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQD4PWQPjCCXOvZY
-UDpYhZHR4Nw0ErkZEZWtPMyoBnyGkYwqK1SrHCcIYQL8C22dN1rnVdFvCVH13fQH
-z1SJ/v3jkS+9IiOUDenXpZP/G0pprTbLGh33aaQU53EqvO1T2CAAzIAVdme0cihO
-B+KL2A5bDzP9fu+c0ddn+N++ZgcqBHMYmZKIGJv5QZ+i+/1xrGqQ/znwV7RuBGms
-8fxA3x4Y4ELUzIHMpbXbQn95qC9u7ee4odQ5KjR1M0oocPKOYBGa/Dqnhd3Wx0lH
-R3No8HgC4TBfxruhs+NZtRyInOTFr99TWbBx+zrDvxecM/5j/AnHWHka8xMQSxJU
-eoXtlFT/AgMBAAECggEAeQhprIDsdP/dE4MOZ5G8XsHNa6BDWlsuCLivqi77cRsu
-5XKaBhGkYFv4eg5SZAiUzF0Vz5cSPJf6vwISHHRUsqtbxNIL2ciM3sVO6t+SAQNg
-x1cVDEgYJc8QaL+T0UD7nZgXzR8dgif0ydLjXL67hR9dAHhu+J2BcqKv6KPTU2LB
-KWbCcLkY4PdCGwSNuvyPokc3Fo8U40Lm8tcWQ6sFV/+bv6+ShWhsb5Dx7sfVoijf
-YikzFc7sEHb//nH2+C/FoCqneDPYl8lVH9zKYis4xWcA68bNwyfWpaQLXo32DKYq
-rZxnwnawtU5b+t+TVp1DcCjOM3vaodeKI3Gqq5SjBQKBgQD/Sy33WOK+qelkvJxb
-IcyP3U/ijNpWP3UidYGmmpTBP5UdaXyObX1G4nmfQjDad080jPpP/r350Tr0Xi2s
-6wZBw0HoTZrZw5MQQKRQyh0Hg5VHHoHbD97UuLGGZ+Yc/hSWWfuDQHeV5Ami+VXD
-TCYZGhtsjY9lUfUWYcsdcOA1fQKBgQD47TcVSC+3/8zKd2AAJeYrpx6wL/5X/4Zn
-U0VeBxfF6MjQlu3avnwi6MxjkuB4KJAgWVHvJspJaS8ilIJN5qBsivphtfD0RV+d
-UW9DCzoDUlU/AmNMD+stylgziSWoG9rzcY7P71izRE1tGGsgOXvZS5xUHzqWBwg6
-MtYB4EQNKwKBgQCTUBVpKmBE9xTXbUKoD5vT1Df5mZ+PrzRvOvEiawa1cHQiMbGP
-Gjz0/1CBBpfcKIaK42K5cFy9X++t/P5MTp4gqoRIgSd+yyz8buCiQc54fIRSMpdq
-CgFiLGU8Eo4lYrQMgkXw2e1nj9vDsC698B331CnI/PKm26EaVjn3dh/anQKBgGxB
-FWRu+TmmyBQA6EIIOVogmqr6pDz2xienQhKLOR57huGX0acAkhHIdiKTnIUE9vDq
-h0Re9TgJw1LhjO1976RkqFDYBArnJJbQ9HcOqdMJ+kKlsjNA9QD773GyIitCueyH
-JRluuH91o8pfBS+FcEPmqvy2fA8EzeIpe4JjWpTzAoGAQHoipuzDbhb02XMqioc+
-UCsa6erj3kGrBUiFcvNutTG+oVq3qXOebOc9bCZcGHwsm0fgX5zk1XgY+IRfCWJY
-X14DQfLMBi/vObDXH9BaoVvc50EPSBW0V5k2aXavJ6XelbBXSI33bzGb+5wAltI/
-CFKf5ePEAi3jE69yYnTwbdc=
------END PRIVATE KEY-----

pyrelukko-0.2.0/tests/cert/rootCA.srl

@@ -1 +0,0 @@
-206DA63B52317CCDF0AA22CB1423BEEAE6C6747B

pyrelukko-0.2.0/tests/initdb.d/20240930160154_init.up.sql

@@ -1,19 +0,0 @@
--- Add up migration script here
-CREATE EXTENSION moddatetime;
-
-CREATE TABLE locks (
-    id uuid DEFAULT gen_random_uuid(),
-    lock_name VARCHAR NOT NULL,
-    creator VARCHAR,
-    ip INET,
-    expires_at TIMESTAMPTZ NOT NULL DEFAULT NOW() + (10 ||' minutes')::interval ,
-    created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
-    updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
-    PRIMARY KEY (id),
-    UNIQUE(lock_name)
-);
-
-CREATE TRIGGER locks_moddatetime
-    BEFORE UPDATE ON locks
-    FOR EACH ROW
-    EXECUTE PROCEDURE moddatetime (updated_at);