From d57da3ed4ac9fcea66bd76e59d8b734b12a11116 Mon Sep 17 00:00:00 2001
From: Christian Schwarz <christian@neon.tech>
Date: Fri, 19 Jan 2024 17:37:21 +0000
Subject: [PATCH] add build step that provides a debug runner for reproducing
 the failures

---
 .github/workflows/build_and_test.yml | 161 +++++++++++++++++++++++++++
 1 file changed, 161 insertions(+)

diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
index e8feef98b9..79e669700b 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -181,6 +181,167 @@ jobs:
         if: ${{ !cancelled() }}
         run: cargo deny check --hide-inclusion-graph
 
+
+  debug-on-large-runner:
+    needs: [ check-permissions, tag, build-buildtools-image ]
+    runs-on: [ self-hosted, gen3, large ]
+    container:
+      image: 369495373322.dkr.ecr.eu-central-1.amazonaws.com/build-tools:${{ needs.build-buildtools-image.outputs.build-tools-tag }}
+      options: --init
+    strategy:
+      fail-fast: false
+      matrix:
+        build_type: [ debug, release ]
+    env:
+      BUILD_TYPE: ${{ matrix.build_type }}
+      GIT_VERSION: ${{ github.event.pull_request.head.sha || github.sha }}
+      BUILD_TAG: ${{ needs.tag.outputs.build-tag }}
+    steps:
+    - name: Fix git ownership
+      run: |
+        # Workaround for `fatal: detected dubious ownership in repository at ...`
+        #
+        # Use both ${{ github.workspace }} and ${GITHUB_WORKSPACE} because they're different on host and in containers
+        #   Ref https://github.com/actions/checkout/issues/785
+        #
+        git config --global --add safe.directory ${{ github.workspace }}
+        git config --global --add safe.directory ${GITHUB_WORKSPACE}
+        for r in 14 15 16; do
+          git config --global --add safe.directory "${{ github.workspace }}/vendor/postgres-v$r"
+          git config --global --add safe.directory "${GITHUB_WORKSPACE}/vendor/postgres-v$r"
+        done
+
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        submodules: true
+        fetch-depth: 1
+
+    - name: Check Postgres submodules revision
+      shell: bash -euo pipefail {0}
+      run: |
+        # This is a temporary solution to ensure that the Postgres submodules revision is correct (i.e. the updated intentionally).
+        # Eventually it will be replaced by a regression test https://github.com/neondatabase/neon/pull/4603
+
+        FAILED=false
+        for postgres in postgres-v14 postgres-v15 postgres-v16; do
+          expected=$(cat vendor/revisions.json | jq --raw-output '."'"${postgres}"'"')
+          actual=$(git rev-parse "HEAD:vendor/${postgres}")
+          if [ "${expected}" != "${actual}" ]; then
+            echo >&2 "Expected ${postgres} rev to be at '${expected}', but it is at '${actual}'"
+            FAILED=true
+          fi
+        done
+
+        if [ "${FAILED}" = "true" ]; then
+          echo >&2 "Please update vendors/revisions.json if these changes are intentional"
+          exit 1
+        fi
+
+    - name: Set pg 14 revision for caching
+      id: pg_v14_rev
+      run: echo pg_rev=$(git rev-parse HEAD:vendor/postgres-v14) >> $GITHUB_OUTPUT
+
+    - name: Set pg 15 revision for caching
+      id: pg_v15_rev
+      run: echo pg_rev=$(git rev-parse HEAD:vendor/postgres-v15) >> $GITHUB_OUTPUT
+
+    - name: Set pg 16 revision for caching
+      id: pg_v16_rev
+      run: echo pg_rev=$(git rev-parse HEAD:vendor/postgres-v16) >> $GITHUB_OUTPUT
+
+    # Set some environment variables used by all the steps.
+    #
+    # CARGO_FLAGS is extra options to pass to "cargo build", "cargo test" etc.
+    #   It also includes --features, if any
+    #
+    # CARGO_FEATURES is passed to "cargo metadata". It is separate from CARGO_FLAGS,
+    #   because "cargo metadata" doesn't accept --release or --debug options
+    #
+    # We run tests with addtional features, that are turned off by default (e.g. in release builds), see
+    # corresponding Cargo.toml files for their descriptions.
+    - name: Set env variables
+      run: |
+        CARGO_FEATURES="--features testing"
+        if [[ $BUILD_TYPE == "debug" ]]; then
+          cov_prefix="scripts/coverage --profraw-prefix=$GITHUB_JOB --dir=/tmp/coverage run"
+          CARGO_FLAGS="--locked"
+        elif [[ $BUILD_TYPE == "release" ]]; then
+          cov_prefix=""
+          CARGO_FLAGS="--locked --release"
+        fi
+        {
+          echo "cov_prefix=${cov_prefix}"
+          echo "CARGO_FEATURES=${CARGO_FEATURES}"
+          echo "CARGO_FLAGS=${CARGO_FLAGS}"
+          echo "CARGO_HOME=${GITHUB_WORKSPACE}/.cargo"
+        } >> $GITHUB_ENV
+
+    # Disabled for now
+    # Don't include the ~/.cargo/registry/src directory. It contains just
+    # uncompressed versions of the crates in ~/.cargo/registry/cache
+    # directory, and it's faster to let 'cargo' to rebuild it from the
+    # compressed crates.
+#      - name: Cache cargo deps
+#        id: cache_cargo
+#        uses: actions/cache@v3
+#        with:
+#          path: |
+#            ~/.cargo/registry/
+#            !~/.cargo/registry/src
+#            ~/.cargo/git/
+#            target/
+#          # Fall back to older versions of the key, if no cache for current Cargo.lock was found
+#          key: |
+#            v1-${{ runner.os }}-${{ matrix.build_type }}-cargo-${{ hashFiles('rust-toolchain.toml') }}-${{ hashFiles('Cargo.lock') }}
+#            v1-${{ runner.os }}-${{ matrix.build_type }}-cargo-${{ hashFiles('rust-toolchain.toml') }}-
+
+    - name: Cache postgres v14 build
+      id: cache_pg_14
+      uses: actions/cache@v3
+      with:
+        path: pg_install/v14
+        key: v1-${{ runner.os }}-${{ matrix.build_type }}-pg-${{ steps.pg_v14_rev.outputs.pg_rev }}-${{ hashFiles('Makefile') }}
+
+    - name: Cache postgres v15 build
+      id: cache_pg_15
+      uses: actions/cache@v3
+      with:
+        path: pg_install/v15
+        key: v1-${{ runner.os }}-${{ matrix.build_type }}-pg-${{ steps.pg_v15_rev.outputs.pg_rev }}-${{ hashFiles('Makefile') }}
+
+    - name: Cache postgres v16 build
+      id: cache_pg_16
+      uses: actions/cache@v3
+      with:
+        path: pg_install/v16
+        key: v1-${{ runner.os }}-${{ matrix.build_type }}-pg-${{ steps.pg_v16_rev.outputs.pg_rev }}-${{ hashFiles('Makefile') }}
+
+    - name: Build postgres v14
+      if: steps.cache_pg_14.outputs.cache-hit != 'true'
+      run: mold -run make postgres-v14 -j$(nproc)
+
+    - name: Build postgres v15
+      if: steps.cache_pg_15.outputs.cache-hit != 'true'
+      run: mold -run make postgres-v15 -j$(nproc)
+
+    - name: Build postgres v16
+      if: steps.cache_pg_16.outputs.cache-hit != 'true'
+      run: mold -run make postgres-v16 -j$(nproc)
+
+    - name: Build neon extensions
+      run: mold -run make neon-pg-ext -j$(nproc)
+
+    - name: Build walproposer-lib
+      run: mold -run make walproposer-lib -j$(nproc)
+
+    - name: Run cargo build
+      run: |
+        ${cov_prefix} mold -run cargo build $CARGO_FLAGS $CARGO_FEATURES --bins --tests
+
+    - name: Run sleep so Christian can connect to the machine and reproduce the issue
+      run: sleep 100000
+
   build-neon:
     needs: [ check-permissions, tag, build-buildtools-image ]
     runs-on: [ self-hosted, gen3, large ]