Add docker release to the full release process for final releases

.changes/unreleased/Under the Hood-20240405-184129.yaml

@@ -0,0 +1,6 @@
+kind: Under the Hood
+body: Automate the Docker release as part of the PyPI release
+time: 2024-04-05T18:41:29.303294-04:00
+custom:
+  Author: mikealfare
+  Issue: "51"

.github/dependabot.yml

@@ -10,3 +10,8 @@ updates:
     schedule:
       interval: "weekly"
     rebase-strategy: "disabled"
+  - package-ecosystem: "docker"
+    directory: "/docker"
+    schedule:
+      interval: "weekly"
+    rebase-strategy: "disabled"

.github/workflows/release.yml

@@ -27,6 +27,8 @@ jobs:
       url: ${{ vars.PYPI_PROJECT_URL }}
     permissions:
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    outputs:
+      version: ${{ steps.release-inputs.outputs.version }}
 
     steps:
       - name: Check out repository
@@ -43,6 +45,7 @@ jobs:
           version=$(hatch version)
           archive_name=dbt-postgres-$version-${{ inputs.deploy-to }}
           echo "archive-name=$archive_name" >> $GITHUB_OUTPUT
+          echo "version=version" >> $GITHUB_OUTPUT
 
       - name: Build `dbt-postgres`
         uses: dbt-labs/dbt-adapters/.github/actions/build-hatch@main
@@ -54,3 +57,15 @@ jobs:
         with:
           pypi-repository-url: ${{ vars.PYPI_REPOSITORY_URL }}
           archive-name: ${{ steps.release-inputs.outputs.archive-name }}
+
+  docker-release:
+    name: "Docker Release"
+    needs: [release]
+    if: ${{ !failure() && !cancelled() }}
+    permissions:
+      packages: write
+    uses: dbt-labs/dbt-release/.github/workflows/release-docker.yml@docker-release
+    with:
+      package: ${{ github.event.repository.name }}
+      version_number: ${{ needs.release.outputs.version }}
+      test_run: ${{ inputs.deploy-to == 'test' }}

dbt/adapters/postgres/relation.py

@@ -20,19 +20,23 @@
 
 @dataclass(frozen=True, eq=False, repr=False)
 class PostgresRelation(BaseRelation):
-    renameable_relations: FrozenSet[RelationType] = field(default_factory=lambda: frozenset(
-        {
-            RelationType.View,
-            RelationType.Table,
-            RelationType.MaterializedView,
-        }
-    ))
-    replaceable_relations: FrozenSet[RelationType] = field(default_factory=lambda: frozenset(
-        {
-            RelationType.View,
-            RelationType.Table,
-        }
-    ))
+    renameable_relations: FrozenSet[RelationType] = field(
+        default_factory=lambda: frozenset(
+            {
+                RelationType.View,
+                RelationType.Table,
+                RelationType.MaterializedView,
+            }
+        )
+    )
+    replaceable_relations: FrozenSet[RelationType] = field(
+        default_factory=lambda: frozenset(
+            {
+                RelationType.View,
+                RelationType.Table,
+            }
+        )
+    )
 
     def __post_init__(self):
         # Check for length of Postgres table/view names.

docker/Dockerfile

@@ -0,0 +1,37 @@
+# this image gets published to GHCR for production use
+ARG py_version=3.10.7
+
+FROM python:$py_version-slim-bullseye as base
+
+RUN apt-get update \
+  && apt-get dist-upgrade -y \
+  && apt-get install -y --no-install-recommends \
+    build-essential=12.9 \
+    ca-certificates=20210119 \
+    git=1:2.30.2-1+deb11u2 \
+    libpq-dev=13.14-0+deb11u1 \
+    make=4.3-4.1 \
+    openssh-client=1:8.4p1-5+deb11u3 \
+    software-properties-common=0.96.20.2-2.1 \
+  && apt-get clean \
+  && rm -rf \
+    /var/lib/apt/lists/* \
+    /tmp/* \
+    /var/tmp/*
+
+ENV PYTHONIOENCODING=utf-8
+ENV LANG=C.UTF-8
+
+RUN python -m pip install --upgrade "pip==24.0" "setuptools==69.2.0" "wheel==0.43.0" --no-cache-dir
+
+
+FROM base as dbt-postgres
+
+ARG commit_ref=main
+
+HEALTHCHECK CMD dbt --version || exit 1
+
+WORKDIR /usr/app/dbt/
+ENTRYPOINT ["dbt"]
+
+RUN python -m pip install --no-cache-dir "dbt-postgres @ git+https://github.com/dbt-labs/dbt-postgres@${commit_ref}"

docker/README.md

@@ -0,0 +1,58 @@
+# Docker for dbt
+This docker file is suitable for building dbt Docker images locally or using with CI/CD to automate populating a container registry.
+
+
+## Building an image:
+This Dockerfile can create images for the following target: `dbt-postgres`
+
+In order to build a new image, run the following docker command.
+```shell
+docker build --tag <your_image_name> --target dbt-postgres <path/to/dockerfile>
+```
+---
+> **Note:**  Docker must be configured to use [BuildKit](https://docs.docker.com/develop/develop-images/build_enhancements/) in order for images to build properly!
+
+---
+
+By default the image will be populated with the latest version of `dbt-postgres` on `main`.
+If you need to use a different version you can specify it by git ref using the `--build-arg` flag:
+```shell
+docker build --tag <your_image_name> \
+  --target dbt-postgres \
+  --build-arg commit_ref=<commit_ref> \
+  <path/to/dockerfile>
+```
+
+### Examples:
+To build an image named "my-dbt" that supports Snowflake using the latest releases:
+```shell
+cd dbt-core/docker
+docker build --tag my-dbt --target dbt-postgres .
+```
+
+To build an image named "my-other-dbt" that supports Snowflake using the adapter version 1.0.0b1:
+```shell
+cd dbt-core/docker
+docker build \
+  --tag my-other-dbt \
+  --target dbt-postgres \
+  --build-arg commit_ref=v1.0.0b1 \
+ .
+```
+
+## Running an image in a container:
+The `ENTRYPOINT` for this Dockerfile is the command `dbt` so you can bind-mount your project to `/usr/app` and use dbt as normal:
+```shell
+docker run \
+  --network=host \
+  --mount type=bind,source=path/to/project,target=/usr/app \
+  --mount type=bind,source=path/to/profiles.yml,target=/root/.dbt/profiles.yml \
+  my-dbt \
+  ls
+```
+---
+**Notes:**
+* Bind-mount sources _must_ be an absolute path
+* You may need to make adjustments to the docker networking setting depending on the specifics of your data warehouse/database host.
+
+---

docker/dev.Dockerfile

@@ -0,0 +1,54 @@
+# this image does not get published, it is intended for local development only, see `Makefile` for usage
+FROM ubuntu:22.04 as base
+
+# prevent python installation from asking for time zone region
+ARG DEBIAN_FRONTEND=noninteractive
+
+# add python repository
+RUN apt-get update \
+  && apt-get install -y software-properties-common=0.99.22.9 \
+  && add-apt-repository -y ppa:deadsnakes/ppa \
+  && apt-get clean \
+  && rm -rf \
+    /var/lib/apt/lists/* \
+    /tmp/* \
+    /var/tmp/*
+
+# install python
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends \
+    build-essential=12.9ubuntu3 \
+    git-all=1:2.34.1-1ubuntu1.10 \
+    libpq-dev=14.11-0ubuntu0.22.04.1 \
+    python3.8=3.8.19-1+jammy1 \
+    python3.8-dev=3.8.19-1+jammy1 \
+    python3.8-distutils=3.8.19-1+jammy1 \
+    python3.8-venv=3.8.19-1+jammy1 \
+    python3-pip=22.0.2+dfsg-1ubuntu0.4 \
+    python3-wheel=0.37.1-2ubuntu0.22.04.1 \
+  && apt-get clean \
+  && rm -rf \
+    /var/lib/apt/lists/* \
+    /tmp/* \
+    /var/tmp/*
+
+# update the default system interpreter to the newly installed version
+RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.8 1
+
+# install python dependencies
+RUN python3 -m pip install --upgrade --no-cache-dir "hatch==1.9.1"
+
+
+FROM base as dbt-postgres-dev
+
+HEALTHCHECK CMD python3 --version || exit 1
+
+# send stdout/stderr to terminal
+ENV PYTHONUNBUFFERED=1
+
+# setup mount for local code
+WORKDIR /opt/code
+VOLUME /opt/code
+
+# create a virtual environment
+RUN python3 -m venv /opt/venv

docker/test.sh

@@ -0,0 +1,22 @@
+# - VERY rudimentary test script to run latest + specific branch image builds and test them all by running `--version`
+# TODO: create a real test suite
+
+clear \
+&& echo "\n\n"\
+"########################################\n"\
+"##### Testing dbt-postgres latest #####\n"\
+"########################################\n"\
+&& docker build --tag dbt-postgres \
+  --target dbt-postgres \
+  docker \
+&& docker run dbt-postgres --version \
+\
+&& echo "\n\n"\
+"#########################################\n"\
+"##### Testing dbt-postgres-1.0.0b1 #####\n"\
+"#########################################\n"\
+&& docker build --tag dbt-postgres-1.0.0b1 \
+  --target dbt-postgres \
+  --build-arg commit_ref=v1.0.0b1 \
+  docker \
+&& docker run dbt-postgres-1.0.0b1 --version

pyproject.toml

@@ -60,6 +60,12 @@ dependencies = [
     "dbt-adapters @ git+https://github.com/dbt-labs/dbt-adapters.git",
     "dbt-common @ git+https://github.com/dbt-labs/dbt-common.git",
 ]
+[tool.hatch.envs.default.scripts]
+docker-dev = [
+	"docker build -f docker/dev.Dockerfile -t dbt-postgres-dev .",
+	"docker run --rm -it --name dbt-postgres-dev -v $(pwd):/opt/code dbt-postgres-dev",
+]
+docker-prod = "docker build -f docker/Dockerfile -t dbt-postgres ."
 
 [tool.hatch.envs.lint]
 detached = true

tests/functional/shared_tests/test_hooks/test_hooks.py

@@ -2,6 +2,7 @@
 This file needs to be in its own directory because it uses a `data` directory.
 Placing this file in its own directory avoids collisions.
 """
+
 from dbt.tests.adapter.hooks.test_model_hooks import (
     BasePrePostModelHooks,
     BaseHookRefs,

tests/functional/shared_tests/test_simple_seed/test_simple_seed.py

@@ -2,6 +2,7 @@
 This file needs to be in its own directory because it creates a `data` directory at run time.
 Placing this file in its own directory avoids collisions.
 """
+
 from dbt.tests.adapter.simple_seed.test_seed import (
     BaseBasicSeedTests,
     BaseSeedConfigFullRefreshOn,

tests/unit/test_renamed_relations.py

@@ -9,8 +9,10 @@ def test_renameable_relation():
         identifier="my_table",
         type=RelationType.Table,
     )
-    assert relation.renameable_relations == frozenset({
-        RelationType.View,
-        RelationType.Table,
-        RelationType.MaterializedView,
-    })
+    assert relation.renameable_relations == frozenset(
+        {
+            RelationType.View,
+            RelationType.Table,
+            RelationType.MaterializedView,
+        }
+    )