easyhaproxy 6.0.0__tar.gz

easyhaproxy-6.0.0/.dockerignore

@@ -0,0 +1,4 @@
+__pycache__
+.pytest_cache
+*.pyc
+.*

easyhaproxy-6.0.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: byjg

easyhaproxy-6.0.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/src"
+    schedule:
+      interval: "daily"

easyhaproxy-6.0.0/.github/workflows/build.yml

@@ -0,0 +1,333 @@
+name: Docker
+
+on:
+  # schedule:
+  #  - cron: '0 10 1 * *'
+  push:
+    branches: [ master ]
+    # Publish semver tags as releases.
+    tags: [ '*.*.*' ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:  # Allow manual trigger
+    inputs:
+      push:
+        description: 'Push image to registry'
+        required: false
+        default: 'false'
+        type: choice
+        options:
+          - 'false'
+          - 'true'
+
+env:
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: byjg/easy-haproxy
+
+
+jobs:
+  Test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Install dependencies
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv sync --group dev
+
+      - name: Run tests
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv run pytest -s tests/ -vv
+
+  Tests-E2E-Docker:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    needs: [Test]
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Install dependencies
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv sync --group dev
+
+      - name: Run Docker Compose E2E tests
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv run pytest tests_e2e/test_docker_compose.py -sv --tb=short
+
+  Tests-E2E-Kubernetes:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: [Test]
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Install dependencies
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv sync --group dev
+
+      - name: Run Kubernetes E2E tests
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv run pytest tests_e2e/test_kubernetes.py -sv --tb=short
+
+  Tests-E2E-Additional:
+    runs-on: ubuntu-latest
+    needs: [Test]
+    timeout-minutes: 20
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Install dependencies
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv sync --group dev
+
+      - name: Clean Docker build cache
+        run: docker builder prune -af
+
+      - name: Run Static E2E tests
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv run pytest tests_e2e/test_static.py -sv --tb=short
+
+      - name: Run Proxy Headers E2E tests
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv run pytest tests_e2e/test_proxy_headers.py -sv --tb=short
+
+  Tests-E2E-Swarm:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: [Test]
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Install dependencies
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv sync --group dev
+
+      - name: Clean Docker build cache
+        run: docker builder prune -af
+
+      - name: Build Docker image
+        env:
+          DOCKER_BUILDKIT: "0"
+        run: docker build -t byjg/easy-haproxy:local -f deploy/docker/Dockerfile .
+
+      - name: Run Swarm E2E tests
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv run pytest tests_e2e/test_swarm.py -sv --tb=short
+
+  Build:
+    runs-on: ubuntu-latest
+    needs: [Test, Tests-E2E-Docker, Tests-E2E-Kubernetes, Tests-E2E-Additional, Tests-E2E-Swarm]
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log into registry
+        if: github.event_name == 'push' || github.event.inputs.push == 'true'
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ secrets.DOCKER_REGISTRY }}
+          username: ${{ secrets.DOCKER_REGISTRY_USER }}
+          password: ${{ secrets.DOCKER_REGISTRY_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ secrets.DOCKER_REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - uses: actions/github-script@v6
+        id: tags
+        with:
+          script: |
+            tags = `${{ join(steps.meta.outputs.tags, ',') }}`
+            result = []
+            tags.split("\n").forEach(function (item) {
+              short_tag = item.trim().split(":")[1]; 
+              if (short_tag == "master" || short_tag == "main") {
+                result.push("latest");
+              } else if (short_tag != "latest") {
+                result.push(short_tag);
+              }
+            })
+            return result.join(",");
+          result-encoding: string
+
+      - name: Get Tags
+        run: |
+          echo "${{ steps.tags.outputs.result }}"
+
+      - uses: actions/github-script@v6
+        id: normalized
+        with:
+          script: |
+            tags = `${{ join(steps.meta.outputs.tags, ',') }}`
+            result = []
+            tags.split("\n").forEach(function (item) {
+              short_tag = item.trim().split(":")[1]; 
+              if (short_tag == "master" || short_tag == "main") {
+                result.push("${{ env.IMAGE_NAME }}:latest");
+              } else if (short_tag != "latest") {
+                result.push("${{ env.IMAGE_NAME }}:" + short_tag);
+              }
+            })
+            return result.join(",");
+          result-encoding: string
+
+      - name: Get Normalized Docker Image
+        run: |
+          echo "${{ steps.normalized.outputs.result }}"
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: deploy/docker/Dockerfile
+          build-args: |
+            RELEASE_VERSION_ARG="${{ steps.tags.outputs.result }}"
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name == 'push' || github.event.inputs.push == 'true' }}
+          tags: ${{ steps.normalized.outputs.result }}
+          labels: ${{ steps.meta.outputs.labels }}
+    
+    outputs:
+      tags: "${{ steps.tags.outputs.result }}"
+
+
+      # - name: Docker Hub Description
+      #   if: github.event_name == 'push' || github.event.inputs.push == 'true'
+      #   run: |
+      #     wget -q  https://github.com/christian-korneck/docker-pushrm/releases/download/v1.8.0/docker-pushrm_linux_amd64 -O $HOME/.docker/cli-plugins/docker-pushrm
+      #     chmod +x $HOME/.docker/cli-plugins/docker-pushrm
+      #     docker pushrm ${{ env.IMAGE_NAME }}
+
+  Publish-PyPI:
+    runs-on: ubuntu-latest
+    needs: [Test, Tests-E2E-Docker, Tests-E2E-Kubernetes, Tests-E2E-Additional, Tests-E2E-Swarm]
+    if: startsWith(github.ref, 'refs/tags/')
+    permissions:
+      contents: read
+      id-token: write  # Required for OIDC trusted publisher
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Build package
+        run: |
+          export PATH="$HOME/.local/bin:$PATH"
+          uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  Helm:
+    runs-on: 'ubuntu-latest'
+    needs: Build
+    if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
+    env:
+      DOC_GITHUB_TOKEN: '${{ secrets.DOC_TOKEN }}'
+    steps:
+      - uses: actions/checkout@v4
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          ref: master
+          
+      - uses: actions/checkout@v4
+        if: github.ref == 'refs/heads/master'
+
+      - name: Get result
+        run: echo "${{ needs.Build.outputs.tags }}"
+
+      - name: Verify versions are pre-bumped
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          TAG="${{ needs.Build.outputs.tags }}"
+          if [ "$TAG" = "latest" ]; then
+            echo "Skipping latest tag verification"
+            exit 0
+          fi
+          ./scripts/bump-version.sh --verify "$TAG"
+
+  HelmDeploy:
+    if: github.ref == 'refs/heads/master'
+    needs: Helm
+    uses: byjg/byjg.github.io/.github/workflows/add-helm.yaml@master
+    with:
+      repo: ${{ github.event.repository.name }}
+      folder: helm
+      project: easyhaproxy
+    secrets: inherit
+
+  Documentation:
+    if: github.ref == 'refs/heads/master'
+    needs: HelmDeploy
+    uses: byjg/byjg.github.io/.github/workflows/add-doc.yaml@master
+    with:
+      folder: devops
+      project: ${{ github.event.repository.name }}
+    secrets:
+      DOC_TOKEN: ${{ secrets.DOC_TOKEN }}

easyhaproxy-6.0.0/.gitignore

@@ -0,0 +1,26 @@
+.idea
+*~
+venv
+.docker_data
+__pycache__
+.pytest_cache
+*.pyc
+.env
+
+# uv
+.venv/
+
+# Build artifacts
+dist/
+*.egg-info/
+
+/tests_e2e/static/conf/config.yml
+/tests_e2e/docker/certs/haproxy/.place_holder_cert.pem
+/tests_e2e/static/host1.local.pem
+/tests_e2e/swarm/certs/host1.local.pem
+/tests_e2e/docker/host2.local.pem
+/tests_e2e/swarm/certs/host2.local.pem
+/tests_e2e/docker/jwt_private.pem
+/tests_e2e/docker/jwt_pubkey.pem
+/tests_e2e/docker/cloudflare_ips.lst
+/tests_e2e/docker/pebble-ca.pem

easyhaproxy-6.0.0/.python-version

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

easyhaproxy-6.0.0/.run/pytest in tests.run.xml

@@ -0,0 +1,22 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="pytest in tests" type="tests" factoryName="py.test" nameIsGenerated="true">
+    <module name="docker-easy-haproxy" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <option name="SDK_HOME" value="" />
+    <option name="SDK_NAME" value="uv (docker-easy-haproxy)" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/src" />
+    <option name="IS_MODULE_SDK" value="false" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="RUN_TOOL" value="true" />
+    <option name="_new_keywords" value="&quot;&quot;" />
+    <option name="_new_parameters" value="&quot;&quot;" />
+    <option name="_new_additionalArguments" value="&quot;&quot;" />
+    <option name="_new_target" value="&quot;$PROJECT_DIR$/tests&quot;" />
+    <option name="_new_targetType" value="&quot;PATH&quot;" />
+    <method v="2" />
+  </configuration>
+</component>

easyhaproxy-6.0.0/.vscode/launch.json

@@ -0,0 +1,35 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "PyTest Current File",
+            "type": "python",
+            "request": "launch",
+            "module": "pytest",
+            "justMyCode": true,
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}/src",
+            "args": [
+                "-vv",
+                "${file}"
+            ],
+            "env": {
+                "PYTHONPATH": "${cwd}/src"
+            }
+        },
+        {
+            "name": "Python: Current File",
+            "type": "python",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}/src",
+            "env": {
+                "PYTHONPATH": "${cwd}/src"
+            }
+        }
+    ]
+}

easyhaproxy-6.0.0/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "cSpell.words": [
+        "certonly",
+        "letsencrypt"
+    ]
+}

easyhaproxy-6.0.0/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing to byjg/docker-easy-haproxy
+
+First of all, thank you for taking the time to contribute!
+
+## How to Contribute
+
+### Issues
+
+If you encounter any issues, have questions, or need clarification, please open an issue on our [Issues page](https://github.com/your-repo/issues). This helps us track and prioritize bug fixes and enhancements.
+
+### Branches
+
+We have three main branches in this project:
+
+- **master**: Contains the latest code. It is generally stable, but we recommend using it with caution.
+- **a.b**: Use this branch for creating PRs. The naming convention follows `a.b`, where `a` is the major release and `b` is the minor release of the current version. For example, if the current release is 4.9.2, use the branch `4.9` for your PR. You can also use `4.9.x-dev` in your composer for development purposes.
+- **future release**: This branch is typically `(a+1).0`. For instance, if the current release is 4.9.2, the future release branch will be `5.0`.
+
+
+### Code Style and Guidelines
+
+- **Write Clear Commit Messages**: Use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+- **Documentation**: Update the documentation for any new features or changes.
+
+### Common Practices
+
+- **Keep Pull Requests Small**: Smaller PRs are easier to review and merge. Focus on one feature or fix per PR.
+- **Write Tests**: Ensure your changes are covered by tests. We aim for a high level of test coverage.
+- **Respect Reviewers' Time**: Be responsive to feedback and willing to make necessary changes.
+
+### Community
+
+- **Be Respectful**.
+- **Collaborate**: We encourage collaboration and open discussion. Don’t hesitate to ask for help or provide feedback.
+
+Thank you for contributing to byjg/docker-easy-haproxy! Your help is appreciated and makes a big difference.

easyhaproxy-6.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Joao Gilberto Magalhães
+
+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.

easyhaproxy-6.0.0/Makefile

@@ -0,0 +1,25 @@
+VERSION := $(shell git rev-parse --short HEAD)
+
+.PHONY: build
+build:
+	docker build -t byjg/easy-haproxy --build-arg RELEASE_VERSION_ARG="$(VERSION)" -t byjg/easy-haproxy:local -f deploy/docker/Dockerfile .
+
+.PHONY: test
+test:
+	uv run pytest tests/ -vv
+
+.PHONY: sync
+sync:
+	uv sync --dev
+
+.PHONY: lint
+lint:
+	uv run ruff check src/ tests/
+
+.PHONY: fix
+fix:
+	uv run ruff check --fix src/ tests/
+
+.PHONY: format
+format:
+	uv run ruff format src/ tests/