Merge branch 'main' into er/event-testing

.changes/unreleased/Features-20240131-152923.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Cache static objects between tests to accelerate integration runs.
+time: 2024-01-31T15:29:23.951857-05:00
+custom:
+  Author: peterallenwebb
+  Issue: "55"

.changes/unreleased/Features-20240201-101851.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Add dataclass utility `Mergeable`
+time: 2024-02-01T10:18:51.474231-08:00
+custom:
+  Author: QMalcolm
+  Issue: "58"

.changes/unreleased/Features-20240201-104437.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Added a new InvocationContext class for application context management.
+time: 2024-02-01T10:44:37.161298-05:00
+custom:
+  Author: peterallenwebb
+  Issue: "57"

.github/workflows/build.yml

@@ -19,6 +19,7 @@ on:
   merge_group:
     types: [checks_requested]
   workflow_dispatch:
+  workflow_call:
 
 permissions: read-all
 

.github/workflows/ci_dbt_core_testing.yml

@@ -2,52 +2,302 @@
 # Runs all tests in dbt-core with this branch of dbt-common to ensure nothing is broken
 
 # **why?**
-# Ensure dbt-common changes do nto break dbt-core
+# Ensure dbt-common changes do not break dbt-core
 
 # **when?**
 # This will run when trying to merge a PR into main.
 # It can also be manually triggered.
 
-##  TODO: This is a stub. It does nothing right now.
-# It will be updated in the future as part of https://github.com/dbt-labs/dbt-common/issues/18
+# This workflow can be skipped by adding the "Skip Core Testing" label to the PR.  This is
+# useful when making a change in both `dbt-core` and `dbt-common` where the changes are dependant
+# and cause the other repository to break.
 
-name: Test Against dbt-core
+name: "dbt-core Tests"
+run-name: >-
+  ${{ (github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_call')
+  && format('dbt-core@{0} with dbt-common@{1}', inputs.dbt-core-ref, inputs.dbt-common-ref)
+  || 'dbt-core@main with dbt-common branch' }}
 
 on:
   merge_group:
     types: [checks_requested]
+  pull_request:
   workflow_dispatch:
+    inputs:
+      dbt-core-ref:
+        description: "The branch of dbt-core to test against"
+        default: "main"
+      dbt-common-ref:
+        description: "The branch of dbt-common to test against"
+        default: "main"
+  workflow_call:
+    inputs:
+      dbt-core-ref:
+        description: "The branch of dbt-core to test against"
+        type: string
+        required: true
+        default: "main"
+      dbt-common-ref:
+        description: "The branch of dbt-common to test against"
+        type: string
+        required: true
+        default: "main"
 
 permissions: read-all
 
+# will cancel previous workflows triggered by the same event
+# and for the same ref for PRs/merges or same SHA otherwise
+# and for the same inputs on workflow_dispatch or workflow_call
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ contains(fromJson('["pull_request", "merge_group"]'), github.event_name) && github.event.pull_request.head.ref || github.sha }}-${{ contains(fromJson('["workflow_call", "workflow_dispatch"]'), github.event_name) && github.event.inputs.dbt-core-ref && github.event.inputs.dbt-common-ref || github.sha }}
+  cancel-in-progress: true
+
 defaults:
   run:
     shell: bash
 
+# top-level adjustments can be made here
+env:
+  # number of parallel processes to spawn for python integration testing
+  PYTHON_INTEGRATION_TEST_WORKERS: 5
+
 jobs:
-  test-dbt-core:
-    name: "This does nothing right now - always passes"
+  job-prep:
+    # This allow us to run the workflow on pull_requests as well so we can always run unit tests
+    # and only run integration tests on merge for time purposes
+    name: Setup Repo Refs
+    runs-on: ubuntu-latest
+    outputs:
+      dbt-core-ref: ${{ steps.core-ref.outputs.ref }}
+      dbt-common-ref: ${{ steps.common-ref.outputs.ref }}
+
+    steps:
+      - name: "Input Refs"
+        id: job-inputs
+        run: |
+          echo "inputs.dbt-core-ref=${{ inputs.dbt-core-ref }}"
+          echo "inputs.dbt-common-ref=${{ inputs.dbt-common-ref }}"
+
+      - name: "Determine dbt-core ref"
+        id: core-ref
+        run: |
+          if [[ -z "${{ inputs.dbt-core-ref }}" ]]; then
+            REF="main"
+          else
+            REF=${{ inputs.dbt-core-ref }}
+          fi
+          echo "ref=$REF" >> $GITHUB_OUTPUT
+
+      - name: "Determine dbt-common ref"
+        id: common-ref
+        run: |
+          if [[ -z "${{ inputs.dbt-common-ref }}" ]]; then
+            # these will be commits instead of branches
+            if [[ "${{ github.event_name }}" == "merge_group" ]]; then
+              REF=${{ github.event.pull_request.merge_commit_sha }}
+            else
+              REF=${{ github.event.pull_request.base.sha }}
+            fi
+          else
+            REF=${{ inputs.dbt-common-ref }}
+          fi
+          echo "ref=$REF" >> $GITHUB_OUTPUT
+
+      - name: "Final Refs"
+        run: |
+          echo "dbt-core-ref=${{ steps.core-ref.outputs.ref }}"
+          echo "dbt-common-ref=${{ steps.common-ref.outputs.ref }}"
+
+  dbt-core-unit-test:
+    name: "dbt-core unit tests"
+    needs: [job-prep]
 
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
     steps:
-      - name: "Check out dbt-core"
+      - name: "Check out dbt-core@${{ needs.job-prep.outputs.dbt-core-ref }}"
         uses: actions/checkout@v4
+        with:
+          repository: dbt-labs/dbt-core
+          ref: ${{ needs.job-prep.outputs.dbt-core-ref }}
 
       - name: "Set up Python 3.11"
         uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
-      - name: "Update the version of dbt-common"
+      - name: "Upgrade pip"
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip --version
+
+      # tox takes care of installing the correct version of dbt-core dependencies but we need to
+      # install them first s that we can override the dbt-common branch
+      - name: "Manually install dbt-core dependencies"
+        run: |
+          python -m pip uninstall dbt-common -y
+          python -m pip install -r dev-requirements.txt -r editable-requirements.txt
+
+      # Since the dbt-common dependency is pinned in dev-requirements.txt we need to force update it
+      # Since tox installs dependencies but doesn't force update, it won't get overridden in the next
+      # step since the requirements will already be met
+      - name: "Force update the version of dbt-common@${{ needs.job-prep.outputs.dbt-common-ref }}"
+        run: |
+          python -m pip install pip install git+https://github.com/dbt-labs/dbt-common.git@${{ needs.job-prep.outputs.dbt-common-ref }} --force-reinstall
+
+      - name: "Run unit tests"
+        # Doing the check here instead of the top level because this is job a required check, the
+        # label just means we should skip the tests
+        if: ${{ !contains(github.event.label.name, 'Skip Core Testing')}}
+        run: tox
+        env:
+          TOXENV: unit
+
+      - name: "Check installed versions"
+        run: pip freeze
+
+  dbt-core-integration-metadata:
+    name: "integration test metadata generation"
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name != 'pull_request' && !contains(github.event.label.name, 'Skip Core Testing')}}
+    outputs:
+      split-groups: ${{ steps.generate-split-groups.outputs.split-groups }}
+      include: ${{ steps.generate-include.outputs.include }}
+
+    steps:
+      - name: "generate split-groups"
+        id: generate-split-groups
+        run: |
+          MATRIX_JSON="["
+          for B in $(seq 1 ${{ env.PYTHON_INTEGRATION_TEST_WORKERS }}); do
+              MATRIX_JSON+=$(sed 's/^/"/;s/$/"/' <<< "${B}")
+          done
+          MATRIX_JSON="${MATRIX_JSON//\"\"/\", \"}"
+          MATRIX_JSON+="]"
+          echo "split-groups=${MATRIX_JSON}"
+          echo "split-groups=${MATRIX_JSON}" >> $GITHUB_OUTPUT
+
+      - name: "generate include"
+        id: generate-include
+        run: |
+          INCLUDE=('"python-version":"3.8","os":"windows-latest"' '"python-version":"3.8","os":"macos-latest"' )
+          INCLUDE_GROUPS="["
+          for include in ${INCLUDE[@]}; do
+              for group in $(seq 1 ${{ env.PYTHON_INTEGRATION_TEST_WORKERS }}); do
+                  INCLUDE_GROUPS+=$(sed 's/$/, /' <<< "{\"split-group\":\"${group}\",${include}}")
+              done
+          done
+          INCLUDE_GROUPS=$(echo $INCLUDE_GROUPS | sed 's/,*$//g')
+          INCLUDE_GROUPS+="]"
+          echo "include=${INCLUDE_GROUPS}"
+          echo "include=${INCLUDE_GROUPS}" >> $GITHUB_OUTPUT
+
+  dbt-core-integration-tests:
+    name: "(${{ matrix.split-group }}) integration test / python ${{ matrix.python-version }} / ${{ matrix.os }}"
+    if: ${{ github.event_name != 'pull_request' && !contains(github.event.label.name, 'Skip Core Testing')}}
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 30
+    needs: [job-prep, dbt-core-integration-metadata]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        os: [ubuntu-20.04]
+        split-group: ${{ fromJson(needs.dbt-core-integration-metadata.outputs.split-groups) }}
+        include: ${{ fromJson(needs.dbt-core-integration-metadata.outputs.include) }}
+    env:
+      DBT_INVOCATION_ENV: github-actions
+      DBT_TEST_USER_1: dbt_test_user_1
+      DBT_TEST_USER_2: dbt_test_user_2
+      DBT_TEST_USER_3: dbt_test_user_3
+
+    steps:
+      - name: "Check out the repository@${{ needs.job-prep.outputs.dbt-core-ref }}"
+        uses: actions/checkout@v4
+        with:
+          repository: dbt-labs/dbt-core
+          ref: ${{ needs.job-prep.outputs.dbt-core-ref }}
+
+      - name: "Set up Python ${{ matrix.python-version }}"
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: "Set up postgres (linux)"
+        if: runner.os == 'Linux'
+        uses: ./.github/actions/setup-postgres-linux
+
+      - name: "Set up postgres (macos)"
+        if: runner.os == 'macOS'
+        uses: ./.github/actions/setup-postgres-macos
+
+      - name: "Set up postgres (windows)"
+        if: runner.os == 'Windows'
+        uses: ./.github/actions/setup-postgres-windows
+
+      - name: "Upgrade pip"
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip --version
+
+      # tox takes care of installing the correct version of dbt-core dependencies but we need to
+      # install them first s that we can override the dbt-common branch
+      - name: "Manually install dbt-core dependencies"
+        run: |
+          python -m pip install -r dev-requirements.txt -r editable-requirements.txt
+
+      # Since the dbt-common dependency is pinned in dev-requirements.txt we need to force update it
+      # Since tox installs dependencies but doesn't force update, it won't get overridden in the next
+      # step since the requirements will already be met
+      - name: "Force update the version of dbt-common@${{ needs.job-prep.outputs.dbt-common-ref }}"
+        run: |
+          python -m pip uninstall dbt-common -y
+          python -m pip install pip install git+https://github.com/dbt-labs/dbt-common.git@${{ needs.job-prep.outputs.dbt-common-ref }} --force-reinstall
+
+      - name: "Run Functional tests"
+        run: tox -- --ddtrace
+        env:
+          TOXENV: integration
+          DBT_INVOCATION_ENV: github-actions
+          DBT_TEST_USER_1: dbt_test_user_1
+          DBT_TEST_USER_2: dbt_test_user_2
+          DBT_TEST_USER_3: dbt_test_user_3
+          DD_CIVISIBILITY_AGENTLESS_ENABLED: true
+          DD_API_KEY: ${{ secrets.DATADOG_API_KEY }}
+          DD_SITE: datadoghq.com
+          DD_ENV: ci
+          DD_SERVICE: dbt-core
+          PYTEST_ADDOPTS: ${{ format('--splits {0} --group {1}', env.PYTHON_INTEGRATION_TEST_WORKERS, matrix.split-group) }}
+
+      - name: "Check installed versions"
+        run: pip freeze
+
+  integration-report:
+    if: ${{ always() }}
+    name: "dbt-core Integration Test Suite Report"
+    runs-on: ubuntu-latest
+    needs: [dbt-core-integration-tests]
+    steps:
+      - name: "Integration Tests Failed"
+        if: ${{ contains(needs.dbt-core-integration-tests.result, 'failure') || contains(needs.dbt-core-integration-tests.result, 'cancelled') }}
+        # when this is true the next step won't execute
+        run: |
+          echo "::notice title='Integration test suite failed'"
+          exit 1
+
+      - name: "Integration Tests Passed"
+        if: ${{ github.event_name != 'pull_request' }}
         run: |
-            echo "Update the version of dbt-common ref'd in dbt-core"
+          echo "::notice title='Integration test suite passed'"
 
-      - name: "Install dbt-core"
+      - name: "Integration Tests Skipped on Pull Request"
+        if: ${{ github.event_name == 'pull_request' &&  !contains(github.event.label.name, 'Skip Core Testing')}}
         run: |
-            echo "Install dbt-core with updated dbt-common ref"
+          echo "::notice title='Integration test suite skipped on Pull Requests - they will run on merge'"
 
-      - name: "Run Tests"
+      - name: "Integration Tests Skipped by Label"
+        if: ${{ contains(github.event.label.name, 'Skip Core Testing')}}
         run: |
-          echo "Running tests in future versions."
+          echo "::notice title='dbt-core test suite skipped due to Skip Core Testing label'"

.github/workflows/ci_tests.yml

@@ -19,6 +19,7 @@ on:
   merge_group:
     types: [checks_requested]
   workflow_dispatch:
+  workflow_call:
 
 permissions: read-all
 
@@ -64,7 +65,7 @@ jobs:
 
       - name: Upload Unit Test Coverage to Codecov
         if: ${{ matrix.python-version == '3.11' }}
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           flags: unit

.github/workflows/scheduled_testing.yml

@@ -0,0 +1,36 @@
+# **what?**
+# The purpose of this workflow is to trigger CI to run for each
+# on a regular cadence. This will also test core + common to prevent breaks.
+# If the CI workflow fails, it will post to #dev-core-alerts to raise awareness.
+
+# **why?**
+# Ensures dbt-common is always shippable and not broken.
+# Also, can catch any dependencies shifting beneath us that might
+# introduce breaking changes (could also impact Cloud).
+
+# **when?**
+# Mainly on a schedule of 9:00, 13:00, 18:00 UTC everyday.
+# Manual trigger can also test on demand
+
+name: Scheduled Testing [ placeholders]
+
+on:
+  # schedule:
+  #   - cron: '0 9,13,18 * * *' # 9:00, 13:00, 18:00 UTC
+  workflow_dispatch: # for manual triggering
+
+
+# no special access is needed
+permissions: read-all
+
+jobs:
+  run_tests:
+    # uses: dbt-labs/actions/.github/workflows/release-branch-tests.yml@main
+    # with:
+    #   workflows_to_run: '["ci_tests.yml", "build.yml", "ci_dbt_core_testing.yml"]'
+    # secrets: inherit
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Placeholder
+        run: echo "This is a placeholder job"