Tests: support multi test envs

.devcontainer/devcontainer.json

@@ -4,7 +4,7 @@
   "features": {
     "ghcr.io/devcontainers-contrib/features/poetry:2": {}
   },
-  "postCreateCommand": "poetry config virtualenvs.in-project true && poetry install -E all && poetry run pre-commit install",
+  "postCreateCommand": "./scripts/setup-envs.sh",
   "customizations": {
     "vscode": {
       "settings": {

.github/actions/setup-poetry/action.yml

@@ -0,0 +1,9 @@
+name: Setup Poetry
+description: Setup Poetry
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install poetry
+      run: pipx install poetry
+      shell: bash

.github/actions/setup-python/action.yml

@@ -6,19 +6,34 @@ inputs:
     description: Python version
     required: false
     default: "3.10"
+  env-dir:
+    description: Environment directory
+    required: true
+  no-root:
+    description: Do not install package in the environment
+    required: false
+    default: "false"
 
 runs:
   using: "composite"
   steps:
     - name: Install poetry
-      run: pipx install poetry
-      shell: bash
+      uses: ./.github/actions/setup-poetry
 
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
         architecture: "x64"
         cache: "poetry"
+        cache-dependency-path: |
+          ./poetry.lock
+          ${{ inputs.env-dir }}/poetry.lock
 
-    - run: poetry install --all-extras
+    - run: |
+        cd ${{ inputs.env-dir }}
+        if [ "${{ inputs.no-root }}" = "true" ]; then
+          poetry install --all-extras --no-root
+        else
+          poetry install --all-extras
+        fi
       shell: bash

.github/workflows/codecov.yml

@@ -6,8 +6,10 @@ on:
       - master
   pull_request:
     paths:
+      - "envs/**"
       - "githubkit/**"
       - "tests/**"
+      - ".github/actions/setup-poetry/**"
       - ".github/actions/setup-python/**"
       - ".github/workflows/codecov.yml"
       - "pyproject.toml"
@@ -24,10 +26,12 @@ jobs:
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
         os: [ubuntu-latest, windows-latest, macos-latest]
+        env: [pydantic-v2]
       fail-fast: false
     env:
       OS: ${{ matrix.os }}
       PYTHON_VERSION: ${{ matrix.python-version }}
+      PYDANTIC_VERSION: ${{ matrix.env }}
 
     steps:
       - uses: actions/checkout@v4
@@ -36,15 +40,19 @@ jobs:
         uses: ./.github/actions/setup-python
         with:
           python-version: ${{ matrix.python-version }}
+          env-dir: ./envs/${{ matrix.env }}
+          no-root: true
 
       - name: Run Pytest
-        run: poetry run pytest -n auto --cov-report xml
+        run: |
+          cd ./envs/${{ matrix.env }}
+          poetry run bash "../../scripts/run-tests.sh"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Upload coverage report
         uses: codecov/codecov-action@v3
         with:
-          env_vars: OS,PYTHON_VERSION
+          env_vars: OS,PYTHON_VERSION,PYDANTIC_VERSION
           files: ./coverage.xml
           flags: unittests

.github/workflows/release.yml

@@ -14,8 +14,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup Python environment
-        uses: ./.github/actions/setup-python
+      - name: Setup Poetry
+        uses: ./.github/actions/setup-poetry
 
       - name: Get Version
         id: version

envs/pydantic-v2/pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "githubkit-pydantic-v2"
+version = "0.1.0"
+description = "Private pydantic v2 test env for githubkit"
+authors = ["yanyongyu <yyy@yyydl.top>"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+[tool.poetry.group.dev.dependencies]
+pydantic = "^2.0.0"
+githubkit-test = { path = "../test/", develop = false }
+githubkit = { path = "../../", extras = ["all"], develop = true }
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

envs/test/githubkit-test.py

@@ -0,0 +1 @@
+# fake file to make project installable

envs/test/pyproject.toml

@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "githubkit-test"
+version = "0.1.0"
+description = "Private test env for githubkit"
+authors = ["yanyongyu <yyy@yyydl.top>"]
+license = "MIT"
+packages = [{ include = "githubkit-test.py" }]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+anyio = "*"
+pytest = "^7.4.3"
+pytest-cov = "^4.1.0"
+pytest-xdist = "^3.5.0"
+coverage-conditional-plugin = "^0.9.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -32,11 +32,7 @@ openapi-pydantic = "^0.4.0"
 tomli = { version = "^2.0.1", python = "<3.11" }
 
 [tool.poetry.group.test.dependencies]
-anyio = "*"
-pytest = "^7.4.3"
-pytest-cov = "^4.1.0"
-pytest-xdist = "^3.5.0"
-coverage-conditional-plugin = "^0.9.0"
+githubkit-test = { path = "./envs/test", develop = false }
 
 [tool.poetry.extras]
 jwt = ["PyJWT"]

scripts/run-tests.sh

@@ -0,0 +1,7 @@
+#! /usr/bin/env bash
+
+# cd to the root of the project
+cd "$(dirname "$0")/.."
+
+# Run the tests
+pytest -n auto --cov-report xml tests

scripts/setup-envs.sh

@@ -0,0 +1,10 @@
+#! /usr/bin/env bash
+
+# config poetry to install env in project
+poetry config virtualenvs.in-project true
+
+# setup dev environment
+poetry install --all-extras && poetry run pre-commit install
+
+# setup pydantic v2 test environment
+(cd envs/pydantic-v2 && poetry install --no-root)