pydocks 0.0.1__tar.gz

pydocks-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,53 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 10
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+      - name: Extract version from tag
+        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+      - name: Use uv with Python version
+        run: uv venv --python 3.12
+      - run: make install
+      - run: make build
+      - run: make test
+      - name: mint API token
+        id: mint-token
+        run: |
+          # retrieve the ambient OIDC token
+          resp=$(curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \
+            "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=pypi")
+          oidc_token=$(jq -r '.value' <<< "${resp}")
+
+          # exchange the OIDC token for an API token
+          resp=$(curl -X POST https://pypi.org/_/oidc/mint-token -d "{\"token\": \"${oidc_token}\"}")
+          api_token=$(jq -r '.token' <<< "${resp}")
+
+          # mask the newly minted API token, so that we don't accidentally leak it
+          echo "::add-mask::${api_token}"
+
+          # see the next step in the workflow for an example of using this step output
+          echo "api-token=${api_token}" >> "${GITHUB_OUTPUT}"
+      - name: publish
+        # gh-action-pypi-publish uses TWINE_PASSWORD automatically
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ steps.mint-token.outputs.api-token }}
+  

pydocks-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+        matrix:
+          python-version: ['3.9', '3.10', '3.11', '3.12']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+    - name: Use uv with Python version
+      run: uv venv --python ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: make install
+    - name: Build
+      run: VERSION=0.0.1 make build
+    - name: Run tests
+      run: make test

pydocks-0.0.1/.gitignore

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

pydocks-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12

pydocks-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 PyDocks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pydocks-0.0.1/Makefile

@@ -0,0 +1,65 @@
+SHELL:=/bin/bash
+
+# Git workflow commands
+.PHONY: wip
+wip:
+	git add .
+	git commit -m "WIP: Work in progress"
+	git push
+
+# Install command
+.PHONY: install
+install:
+	uv sync --all-extras --dev
+	
+# Build command
+.PHONY: build
+build: check-version
+	rm -rf dist/* || true
+#	ls -al
+	./scripts/version.sh "${VERSION}"
+	@cat pyproject.toml | grep version
+	@cat pydocks/__init__.py | grep version
+	uv build
+
+.PHONY: check-version
+check-version:
+	@if [ -z "${VERSION}" ]; then \
+		echo "VERSION is not set. Please set the VERSION environment variable."; \
+		exit 1; \
+	fi
+
+# Deploy command
+.PHONY: deploy
+deploy:
+	uvx twine upload dist/*
+
+# Install local build command
+.PHONY: install-local
+install-local:
+	pip3 install dist/*.whl
+
+# Test command
+.PHONY: test
+test:
+	uv run pytest -v --log-cli-level=INFO
+
+# Lint command
+.PHONY: lint
+lint:
+	uv run ruff check --fix
+	uv run ruff format
+	uv run ruff format --check
+
+# Display all available commands
+.PHONY: help
+help:
+	@echo "Available commands:"
+	@echo "  wip           - Commit and push work in progress"
+	@echo "  install       - Install dependencies"
+	@echo "  build         - Build the project"
+	@echo "  deploy        - Deploy the project"
+	@echo "  install-local - Install the build locally"
+	@echo "  test          - Run tests"
+	@echo "  lint          - Run linter"
+	@echo "  help          - Display this help message"

pydocks-0.0.1/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.3
+Name: pydocks
+Version: 0.0.1
+Summary: Pytest fixures for running tests with Docker containers
+Project-URL: homepage, https://github.com/sylvainmouquet/pydocks
+Project-URL: documentation, https://github.com/sylvainmouquet/pydocks
+Project-URL: repository, https://github.com/sylvainmouquet/ppydocks
+Project-URL: changelog, https://github.com/sylvainmouquet/pydocks/releases
+Author-email: Sylvain Mouquet <sylvain.mouquet@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: containers,docker,pydocks,pytest,test
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: asyncpg>=0.29.0
+Requires-Dist: uvloop>=0.20.0
+Description-Content-Type: text/markdown
+
+# PyDocks
+
+PyDocks is a group of pytest fixures for running tests with Docker containers
+
+### Demonstration:
+
+```python
+...
+```
+
+## Table of Contents
+
+- [PyDocks](#PyDocks)
+  - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [License](#license)
+  - [Contact](#contact)
+
+## Description
+
+PyDocks is a Python library that provides a set of pytest fixtures for running tests with Docker containers. It simplifies the process of setting up, managing, and tearing down Docker containers during test execution.
+
+Key features include:
+- Easy integration with pytest
+- Support for PostgreSQL containers
+- Automatic container cleanup
+- Configurable container settings
+- Reusable session-scoped containers for improved test performance
+
+PyDocks is designed to make testing with Docker containers more efficient and less error-prone, allowing developers to focus on writing tests rather than managing infrastructure.
+
+## Installation
+
+```bash
+# Install the dependency
+pip install pydocks
+uv add pydocks
+poetry add pydocks
+```
+
+## Usage
+
+```python
+from pydocks import pydocks
+
+```
+
+
+## License
+
+PyDocks is released under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contact
+
+For questions, suggestions, or issues related to ReAttempt, please open an issue on the GitHub repository.
+

pydocks-0.0.1/README.md

@@ -0,0 +1,58 @@
+# PyDocks
+
+PyDocks is a group of pytest fixures for running tests with Docker containers
+
+### Demonstration:
+
+```python
+...
+```
+
+## Table of Contents
+
+- [PyDocks](#PyDocks)
+  - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [License](#license)
+  - [Contact](#contact)
+
+## Description
+
+PyDocks is a Python library that provides a set of pytest fixtures for running tests with Docker containers. It simplifies the process of setting up, managing, and tearing down Docker containers during test execution.
+
+Key features include:
+- Easy integration with pytest
+- Support for PostgreSQL containers
+- Automatic container cleanup
+- Configurable container settings
+- Reusable session-scoped containers for improved test performance
+
+PyDocks is designed to make testing with Docker containers more efficient and less error-prone, allowing developers to focus on writing tests rather than managing infrastructure.
+
+## Installation
+
+```bash
+# Install the dependency
+pip install pydocks
+uv add pydocks
+poetry add pydocks
+```
+
+## Usage
+
+```python
+from pydocks import pydocks
+
+```
+
+
+## License
+
+PyDocks is released under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contact
+
+For questions, suggestions, or issues related to ReAttempt, please open an issue on the GitHub repository.
+

pydocks-0.0.1/pydocks/__init__.py

@@ -0,0 +1,16 @@
+__version__ = "0.0.1"
+__all__ = (
+    "__version__",
+    "postgresql_clean_all_containers",
+    "postgresql_container",
+    "postgresql_container_session",
+    "docker",
+)
+
+# pytest_plugins = ["pydocks.conftest"]
+from pydocks.plugin import docker
+from pydocks.postgresql import (
+    postgresql_clean_all_containers,
+    postgresql_container,
+    postgresql_container_session,
+)

pydocks-0.0.1/pydocks/nginx.py

@@ -0,0 +1,16 @@
+"""
+# https://hub.docker.com/r/nginx/tags
+TEST_NGINX_DOCKER_IMAGE: str = "docker.io/nginx:1.27.1-alpine"
+
+# https://hub.docker.com/r/hashicorp/terraform/tags
+TEST_TERRAFORM_DOCKER_IMAGE: str = "docker.io/hashicorp/terraform:1.5"
+
+# https://hub.docker.com/r/chainguard/opentofu/tags
+TEST_OPENTOFU_DOCKER_IMAGE: str = "docker.io/chainguard/opentofu:latest-dev"
+
+# https://hub.docker.com/_/redis/tags
+TEST_REDIS_DOCKER_IMAGE: str = "docker.io/redis:7.4.0"
+
+# https://hub.docker.com/r/hashicorp/vault/tags
+TEST_VAULT_DOCKER_IMAGE: str = "docker.io/hashicorp/vault:1.17.3"
+"""

pydocks-0.0.1/pydocks/plugin.py

@@ -0,0 +1,63 @@
+import pytest
+from pathlib import Path
+import os
+
+import socket
+
+# from asgi_lifespan import LifespanManager
+import anyio
+from python_on_whales import DockerClient
+from reattempt import reattempt
+import logging
+
+logger = logging.getLogger("pydocks")
+logger.addHandler(logging.NullHandler())
+
+
+@pytest.fixture(scope="session", autouse=True)
+def docker():
+    if "DOCKER_SOCK" in os.environ:
+        yield DockerClient(host=os.environ["DOCKER_SOCK"])
+    elif "CI" in os.environ:
+        # Github Actions, GitLab CI, ...
+        yield DockerClient()
+    else:
+        # local with colima
+        home: str = str(Path.home())
+        yield DockerClient(host=f"unix://{home}/.colima/default/docker.sock")
+
+
+@reattempt(max_retries=30, min_time=0.1, max_time=0.5)
+async def socket_test_connection(host, port):
+    s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    s.connect((host, port))
+    await anyio.wait_socket_writable(s)
+
+
+async def clean_containers(docker: DockerClient, name: str):
+    containers = docker.ps(all=True, filters={"name": f"^{name}"})
+
+    for container in containers:
+        if container.state.running:
+            docker.kill(container)
+        logger.info(f"remove container {container.name}")
+        docker.remove(container)
+
+
+async def wait_and_run_container(docker, container, name: str):
+    logger.debug(f"start {name}")
+    try:
+        yield container
+    finally:
+        logger.debug(f"kill container {name} and remove the docker container")
+        if container.state.status == "running":
+            logger.debug(f"container {name} is running")
+            docker.kill(container.id)
+            logger.debug(f"killed container {name}")
+        else:
+            logger.debug(f"container {name} is not running")
+
+        # keep the container id, to keep the docker images
+        # docker has a garbage collector, when all docker container are deleted the
+        # image related is deleted
+        # docker.remove(container.id)