Enable integration testing with postgres and check in failing test with secondary relationship (#20)

* Adds postgres to .devcontainer/Dockerfile and to unit test setup.

* Postgres doesn't work on Windows on Github Actions, unfortunately, so tests are linux only for now.

Author: mattalbr

.devcontainer/Dockerfile

@@ -3,3 +3,27 @@ FROM mcr.microsoft.com/vscode/devcontainers/python:${VARIANT}
 
 RUN pip3 install poetry pre-commit
 RUN poetry config virtualenvs.in-project true
+ARG PGVERSION=14
+
+# Setup apt repo for Postgres
+RUN if [ "${PGVERSION}" != "none"  ]; then \
+    echo "deb [signed-by=/usr/share/keyrings/postgresql.gpg] http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main"  \
+    | tee /etc/apt/sources.list.d/pgdg.list \
+    && curl -fsSL https://www.postgresql.org/media/keys/ACCC4CF8.asc \
+    | gpg --dearmor --yes -o /usr/share/keyrings/postgresql.gpg; \
+    fi
+
+# Install Postgres packages
+ARG TARGETPLATFORM
+RUN --mount=type=cache,target=/var/cache/apt,id=apt-${TARGETPLATFORM} \
+    export DEBIAN_FRONTEND=noninteractive \
+    && export PGPACKAGES=$(if [ "${PGVERSION}" != "none" ]; then echo "postgresql-${PGVERSION} postgresql-client-${PGVERSION} postgresql-server-dev-${PGVERSION}"; fi) \
+    && apt-get remove man-db --purge -y \
+    && apt-get update \
+    && apt-get -y install --no-install-recommends ${PGPACKAGES}
+
+# Trust postgres connections from localhost and local port.
+RUN if [ "$PGVERSION" != "none" ]; then \
+        sed -i -E 's/local(\s+)all(\s+)postgres(\s+)peer/local\1all\2all\3trust/g' /etc/postgresql/${PGVERSION}/main/pg_hba.conf && \
+        sed -i -E 's/host(\s+)all(\s+)all(\s+)(\S+)(\s+)(\S+)/host\1all\2all\3\4\5trust/g' /etc/postgresql/${PGVERSION}/main/pg_hba.conf; \
+    fi

.devcontainer/devcontainer.json

@@ -23,4 +23,5 @@
 
   "extensions": ["ms-python.python", "ms-python.vscode-pylance", "eamodio.gitlens"],
   "postCreateCommand": "sh ./.devcontainer/post-install.sh",
+  "postStartCommand": "sh ./.devcontainer/post-start.sh",
 }

.devcontainer/post-start.sh

@@ -0,0 +1,6 @@
+service postgresql status
+if [ "$?" -eq "1" ]; then
+  echo "Postgres not installed. Postgres integration tests will fail for now."
+else
+  sudo service postgresql start
+fi

.github/workflows/test.yml

@@ -51,6 +51,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+      - uses: ikalnytskyi/action-setup-postgres@v4
       - uses: wntrblm/nox@main
         with:
           python-versions: "3.8, 3.9, 3.10, 3.11, 3.12"
@@ -97,11 +98,11 @@ jobs:
       - uses: actions/setup-python@v4
         id: setup-python
         with:
-          python-version: "3.12.0-beta.3"
+          python-version: "3.12.0-rc.2"
           architecture: x64
           cache: "poetry"
 
-      - run: poetry env use 3.12.0-beta.3
+      - run: poetry env use 3.12.0-rc.2
       - run: poetry run pip install --upgrade pip setuptools wheel
       - run: poetry install
         if: steps.setup-python.outputs.cache-hit != 'true'

README.md

@@ -222,6 +222,8 @@ Don't forget to tell your contributors to also install and use pre-commit.
 pip install -r requirements.txt
 ```
 
+Install [PostgreSQL 14+](https://www.postgresql.org/download/)
+
 ### Test
 
 ```bash

poetry.lock

@@ -51,6 +51,9 @@ importlib-metadata = "^4.11.1"
 mypy = "1.5.1"
 nox = "^2023.4.22"
 nox-poetry = "^1.0.2"
+packaging = ">=23.1"
+pg8000 = ">=1.30.1"
+psycopg2 = ">=2.9.7"
 pytest = "^7.2"
 pytest-asyncio = ">=0.20.3,<0.22.0"
 pytest-codspeed = "^2.0.1"
@@ -59,6 +62,7 @@ pytest-emoji = "^0.2.0"
 pytest-mypy-plugins = ">=1.10,<4.0"
 pytest-xdist = {extras = ["psutil"], version = "^3.1.0"}
 setuptools = ">=67.8.0"
+"testing.postgresql" = ">=1.3.0"
 
 [tool.black]
 line-length = 88

pyproject.toml

@@ -1,10 +1,77 @@
 """
-    Dummy conftest.py for strawberry_sqlalchemy_mapper.
+    conftest.py for strawberry_sqlalchemy_mapper.
 
     If you don't know what this is for, just leave it empty.
     Read more about conftest.py under:
     - https://docs.pytest.org/en/stable/fixture.html
     - https://docs.pytest.org/en/stable/writing_plugins.html
 """
 
-# import pytest
+import contextlib
+import logging
+import platform
+import socket
+
+import pytest
+import sqlalchemy
+from packaging import version
+from sqlalchemy import orm
+from sqlalchemy.engine import Engine
+from testing.postgresql import Postgresql, PostgresqlFactory
+
+SQLA_VERSION = version.parse(sqlalchemy.__version__)
+SQLA2 = SQLA_VERSION >= version.parse("2.0")
+
+
+def _pick_unused_port():
+    with contextlib.closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
+        s.bind(("", 0))
+        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        return s.getsockname()[1]
+
+
+@pytest.fixture(scope="session")
+def postgresql_factory() -> PostgresqlFactory:
+    factory = PostgresqlFactory(cache_initialized_db=True, port=_pick_unused_port())
+    yield factory
+    factory.clear_cache()
+
+
+@pytest.fixture
+def postgresql(postgresql_factory) -> Postgresql:
+    db = postgresql_factory()
+    yield db
+    db.stop()
+
+
+if platform.system() == "Windows":
+    # Our windows test pipeline doesn't play nice with postgres because
+    # Github Actions doesn't support containers on windows.
+    # It would probably be nicer if we chcked if postgres is installed
+    logging.info("Skipping postgresql tests on Windows OS")
+    SUPPORTED_DBS = []
+else:
+    SUPPORTED_DBS = ["postgresql"]  # TODO: Add sqlite and mysql.
+
+
+@pytest.fixture(params=SUPPORTED_DBS)
+def engine(request) -> Engine:
+    if request.param == "postgresql":
+        url = request.getfixturevalue("postgresql").url()
+    else:
+        raise ValueError("Unsupported database: %s", request.param)
+    kwargs = {}
+    if not SQLA2:
+        kwargs["future"] = True
+    engine = sqlalchemy.create_engine(url, **kwargs)
+    return engine
+
+
+@pytest.fixture
+def sessionmaker(engine) -> orm.sessionmaker:
+    return orm.sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+
+@pytest.fixture
+def Base():
+    return orm.declarative_base()