linux-build-and-test.yaml

name: Regression
"on":
  schedule:
    # run daily 0:00 on main branch
    # Since we use the date as a part of the cache key to ensure no
    # stale cache entries hiding build failures we need to make sure
    # we have a cache entry present before workflows that depend on cache
    # are run.
    - cron: '0 0 * * *'
  push:
    branches:
      - main
      - ?.*.x
      - prerelease_test
      - trigger/regression
  pull_request:
jobs:
  matrixbuilder:
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
    - name: Checkout source code
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

    - name: Build matrix
      id: set-matrix
      run: |
        if [[ "${{ github.event_name }}" == "pull_request" ]] ;
        then
          git fetch origin ${{ github.base_ref }}:base
          .github/gh_matrix_builder.py ${{ github.event_name }} base
        else
          .github/gh_matrix_builder.py ${{ github.event_name }}
        fi

  check_paths:
    runs-on: ubuntu-latest
    outputs:
      run_ci: >-
        ${{ github.event_name == 'push'
          || (steps.filter.outputs.src == 'true' && !contains(github.event.pull_request.labels.*.name, 'skip-ci'))
         }}
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d # v4.0.1
        id: filter
        with:
          filters: .github/filters.yaml

  regress:
    if: needs.check_paths.outputs.run_ci == 'true'
    # Change the JOB_NAME variable below when changing the name.
    name: PG${{ matrix.pg }}${{ matrix.snapshot }} ${{ matrix.name }} ${{ matrix.os }}
    needs: [matrixbuilder, check_paths]
    runs-on: ${{ matrix.os }}

    env:
      PG_SRC_DIR: pgbuild
      PG_INSTALL_DIR: postgresql
      CLANG: ${{ matrix.clang }}
      CC: ${{ matrix.cc }}
      CXX: ${{ matrix.cxx }}

      # For some reason, on PG <= 15 with faketime the client backends get the
      # modified time, and the background workers the unmodified time, so it
      # doesn't work.
      FAKETIME: |
        ${{ (contains(matrix.os, 'ubuntu')
               && !startsWith(matrix.pg, '14.')
               && !startsWith(matrix.pg, '15.')
            ) && 'faketime -f +379d' || '' }}

    strategy:
      matrix: ${{ fromJson(needs.matrixbuilder.outputs.matrix) }}
      fail-fast: false

    steps:
    - name: Install Linux Dependencies
      if: runner.os == 'Linux'
      timeout-minutes: 15
      run: |
        # Don't add ddebs here because the ddebs mirror is always 503 Service Unavailable.
        # If needed, install them before opening the core dump.
        sudo apt-get update
        sudo apt-get install flex bison lcov systemd-coredump gdb libipc-run-perl \
          libtest-most-perl pkgconf icu-devtools faketime jq ${{ matrix.extra_packages }}

    - name: Check macOS Build Dependencies
      if: runner.os == 'macOS'
      run: |
        # OpenSSL is supposed to be preinstalled, so just check its path here
        brew --prefix openssl@3

    - name: Install macOS Test Dependencies
      if: runner.os == 'macOS' && matrix.installcheck
      timeout-minutes: 15
      run: |
        # Disable the automatic dependency upgrade executed by `brew install`
        # https://docs.brew.sh/Manpage#install-options-formulacask-
        HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1 brew install gawk
        # Install perl modules after last Homebew call, since Homebrew can change the perl version
        sudo perl -MCPAN -e "CPAN::Shell->notest('install', 'IPC::Run')"
        sudo perl -MCPAN -e "CPAN::Shell->notest('install', 'Test::Most')"

    - name: Setup macOS coredump directory
      if: runner.os == 'macOS'
      run: sudo chmod 777 /cores

    - name: Checkout TimescaleDB
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

    # We are going to rebuild Postgres weekly, so that it doesn't suddenly break
    # ages after the original problem.
    - name: Get date for build caching
      id: get-date
      run: |
        echo "date=$(date +"%V")" >> $GITHUB_OUTPUT

    # on macOS the path used is depending on the runner version leading to cache failure
    # when the runner version changes so we extract runner version from path and add it
    # as cache suffix
    - name: Cache suffix
      if: runner.os == 'macOS'
      run: echo "CACHE_SUFFIX=-${ImageVersion}" >> $GITHUB_ENV

    # we cache the build directory instead of the install directory here
    # because extension installation will write files to install directory
    # leading to a tainted cache
    - name: Cache PostgreSQL ${{ matrix.pg }} ${{ matrix.build_type }}
      id: cache-postgresql
      if: matrix.snapshot != 'snapshot'
      uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
      with:
        path: ~/${{ env.PG_SRC_DIR }}
        key: "${{ matrix.os }}-postgresql-${{ matrix.pg }}-${{ matrix.cc }}-${{ steps.get-date.outputs.date }}-${{ hashFiles('.github/**') }}${{ env.CACHE_SUFFIX }}"

    - name: Build PostgreSQL ${{ matrix.pg }}${{ matrix.snapshot }}
      if: steps.cache-postgresql.outputs.cache-hit != 'true'
      run: |
        if [ "${{ matrix.snapshot }}" = "snapshot" ]; then
          wget -q -O postgresql.tar.bz2 \
            https://ftp.postgresql.org/pub/snapshot/${{ matrix.pg }}/postgresql-${{ matrix.pg }}-snapshot.tar.bz2
        else
          wget -q -O postgresql.tar.bz2 \
            https://ftp.postgresql.org/pub/source/v${{ matrix.pg }}/postgresql-${{ matrix.pg }}.tar.bz2
        fi
        mkdir -p ~/$PG_SRC_DIR
        tar --extract --file postgresql.tar.bz2 --directory ~/$PG_SRC_DIR --strip-components 1
        cd ~/$PG_SRC_DIR
        ./configure --prefix=$HOME/$PG_INSTALL_DIR --with-openssl \
          --without-readline --without-zlib --without-libxml ${{ matrix.pg_extra_args }}
        make -j $(getconf _NPROCESSORS_ONLN)
        for ext in ${{ matrix.pg_extensions }}; do
          make -j $(getconf _NPROCESSORS_ONLN) -C contrib/${ext}
        done

    - name: Install PostgreSQL ${{ matrix.pg }}
      run: |
        cd ~/$PG_SRC_DIR
        make install
        for ext in ${{ matrix.pg_extensions }}; do
          make -C contrib/${ext} install
        done
        echo "$HOME/$PG_INSTALL_DIR/bin" >> "${GITHUB_PATH}"

    - name: Upload config.log
      if: always() && steps.cache-postgresql.outputs.cache-hit != 'true'
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: config.log for PostgreSQL ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: ~/${{ env.PG_SRC_DIR }}/config.log

    - name: Test telemetry without OpenSSL
      if: github.event_name != 'pull_request' && runner.os == 'Linux' && matrix.build_type == 'Debug'
      run: |
        BUILD_DIR=nossl ./bootstrap -DCMAKE_BUILD_TYPE=Debug \
          -DPG_SOURCE_DIR=$HOME/$PG_SRC_DIR -DPG_PATH=$HOME/$PG_INSTALL_DIR \
          ${{ matrix.tsdb_build_args }} -DCODECOVERAGE=${{ matrix.coverage }} -DUSE_OPENSSL=OFF \
          -DTEST_PG_LOG_DIRECTORY="$(readlink -f .)"
        make -j $(getconf _NPROCESSORS_ONLN) -C nossl
        make -C nossl install
        make -C nossl regresscheck TESTS=telemetry

    - name: Build TimescaleDB
      run: |
        # Show the actual architecture this CI runner has
        "$CC" -march=native -E -v - </dev/null 2>&1 | grep cc1

        ./bootstrap -DCMAKE_BUILD_TYPE="${{ matrix.build_type }}" \
          -DPG_SOURCE_DIR=$HOME/$PG_SRC_DIR -DPG_PATH=$HOME/$PG_INSTALL_DIR \
          ${{ matrix.tsdb_build_args }} -DCODECOVERAGE=${{ matrix.coverage }} \
          -DREQUIRE_ALL_TESTS=${{ matrix.installcheck && 'ON' || 'OFF' }} \
          -DTEST_PG_LOG_DIRECTORY="$(readlink -f .)"
        make -j $(getconf _NPROCESSORS_ONLN) -C build
        make -C build install

    - name: Upload CMake Logs
      if: always()
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: CMake Logs ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: |
            build/CMakeCache.txt
            build/CMakeFiles/CMakeConfigureLog.yaml
            build/CMakeFiles/CMakeError.log
            build/CMakeFiles/CMakeOutput.log
            build/compile_commands.json

    - name: Check exported symbols
      run: ./build/scripts/export_prefix_check.sh

    - name: make installcheck
      if: matrix.installcheck
      run: |
        set -o pipefail
        make -k -C build installcheck IGNORES="${{ join(matrix.ignored_tests, ' ') }}" \
            SKIPS="${{ join(matrix.skipped_tests, ' ') }}" ${{ matrix.installcheck_args }} \
            | tee installcheck.log

    - name: pginstallcheck
      if: matrix.pginstallcheck
      run: make -C build pginstallcheck

    - name: coverage
      if: matrix.coverage
      run: make -j $(getconf _NPROCESSORS_ONLN) -k -C build coverage

    - name: Send coverage report to Codecov.io app
      if: matrix.coverage
      uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354 # v6.0.1
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        files: ./build/coverage/timescaledb-coverage.info
        fail_ci_if_error: ${{ github.event_name != 'pull_request' }}

    - name: Save LCOV coverage report
      if: matrix.coverage
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: LCOV coverage report ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: ./build/coverage/lcov-report

    - name: Show regression diffs
      if: always()
      id: collectlogs
      run: |
        find . -name regression.diffs -exec cat {} + > regression.log

        if [[ "${{ runner.os }}" == "Linux" ]] ; then
          # wait in case there are in-progress coredumps
          sleep 10
          if coredumpctl -q list >/dev/null; then echo "coredumps=true" >>$GITHUB_OUTPUT; fi
          # print OOM killer information
          sudo journalctl --system -q --facility=kern --grep "Killed process" || true
        elif [[ "${{ runner.os }}" == "macOS" ]] ; then
           if [ $(find /cores -type f | wc -l) -gt 0 ]; then echo "coredumps=true" >>$GITHUB_OUTPUT; fi
        fi
        if [[ -s regression.log ]]; then echo "regression_diff=true" >> $GITHUB_OUTPUT; fi
        grep -e 'FAILED' -e 'failed (ignored)' -e 'not ok' installcheck.log || true
        cat regression.log

    - name: Save regression diffs
      if: always() && steps.collectlogs.outputs.regression_diff == 'true'
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: Regression diff ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: |
          regression.log
          installcheck.log

    - name: Save PostgreSQL log
      if: always()
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: PostgreSQL log ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: postmaster.*

    - name: Stack trace Linux
      if: always() && steps.collectlogs.outputs.coredumps == 'true' && runner.os == 'Linux'
      run: |
        sudo coredumpctl debug --debugger=gdb --debugger-arguments='' <<<"
          set verbose on
          set trace-commands on
          show debug-file-directory
          printf "'"'"query = '%s'\n\n"'"'", debug_query_string
          bt full

          # We try to find ExceptionalCondition frame to print the failed condition
          # for searching in logs.
          frame function ExceptionalCondition
          printf "'"'"condition = '%s'\n"'"'", conditionName

          # Hopefully now we should be around the failed assertion, print where
          # we are.
          up 1
          list
          info args
          info locals
        " 2>&1 | tee -a stacktrace.log
        ./scripts/bundle_coredumps.sh

    - name: Stack trace macOS
      if: always() && steps.collectlogs.outputs.coredumps == 'true' && runner.os == 'macOS'
      run: |
        ~/$PG_SRC_DIR/src/tools/ci/cores_backtrace.sh macos /cores

    - name: Coredumps
      if: always() && steps.collectlogs.outputs.coredumps == 'true'
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: Coredumps ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: coredumps

    - name: Save stacktraces
      if: always() && steps.collectlogs.outputs.coredumps == 'true'
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: Stacktraces ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: stacktrace.log

    - name: Save TAP test logs
      if: always()
      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
      with:
        name: TAP test logs ${{ matrix.os }} ${{ matrix.name }} ${{ matrix.pg }}
        path: |
          build/test/tmp_check/log
          build/tsl/test/tmp_check/log

    - name: Check that no new internal program errors are introduced
      # We collect the same messages when uploading to the CI checks database,
      # but it runs on different conditions (not on forks and not on flaky check),
      # and requires different data (job date), so we do it separately here.
      # The jq --exit-code option is broken with select() on jq-1.6 which we see
      # on some machines, so we use grep instead (see https://github.com/jqlang/jq/issues/1139).
      if: always() && contains(matrix.name, 'Flaky')
      run: |
        ! jq 'select(
                (.state_code == "XX000" and .error_severity != "LOG" and (.message | test("TestFailure") | not))
                or (.message | test("resource was not closed"))
            ) | [.message, .func_name,  .statement] | @tsv
        ' -r postmaster.json | grep .

    - name: Upload test results to the database
      # Don't upload the results of the flaky check, because the db schema only
      # supports running one test once per job.
      if: always() && matrix.installcheck && (! contains(matrix.name, 'Flaky'))
      env:
        # GitHub Actions allow you neither to use the env context for the job name,
        # nor to access the job name from the step context, so we have to
        # duplicate it to work around this nonsense.
        JOB_NAME: PG${{ matrix.pg }}${{ matrix.snapshot }} ${{ matrix.name }} ${{ matrix.os }}
        CI_STATS_DB: ${{ secrets.CI_STATS_DB }}
        GITHUB_EVENT_NAME: ${{ github.event_name }}
        GITHUB_REF_NAME: ${{ github.ref_name }}
        GITHUB_REPOSITORY: ${{ github.repository }}
        GITHUB_RUN_ATTEMPT: ${{ github.run_attempt }}
        GITHUB_RUN_ID: ${{ github.run_id }}
        GITHUB_RUN_NUMBER: ${{ github.run_number }}
        JOB_STATUS: ${{ job.status }}
      run: |
        if [[ "${{ github.event_name }}" == "pull_request" ]] ;
        then
            GITHUB_PR_NUMBER="${{ github.event.number }}"
        else
            GITHUB_PR_NUMBER=0
        fi
        export GITHUB_PR_NUMBER
        scripts/upload_ci_stats.sh

  report_status:
    name: Regression summary
    needs: [check_paths, regress]
    if: always()
    runs-on: ubuntu-latest
    steps:
      - run: |
          # If the detector failed, or the matrix failed, exit with error
          if [[ "${{ needs.regress.result }}" == "failure" ]]; then
            exit 1
          fi
          echo "All checks passed or were safely skipped."