ci: add testing workflow

Author: ashenBlade

.github/workflows/testing.yml

@@ -0,0 +1,40 @@
+name: Run tests
+on: [push, pull_request]
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix: 
+        pgversion: ['17', '16', '15', '14', '13', '12', '11', '10', '9.6']
+    steps:
+    - name: Setup repository
+      uses: actions/checkout@v4    
+    - name: Setup NodeJS
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        cache: 'npm'
+    - name: Setup environment
+      run: |
+        sudo apt-get install -y build-essential wget gdb lldb libpq5
+        npm install --save-dev
+    - name: Build extension
+      run: npm run compile
+    - name: Setup sources
+      run: ./src/test/setup.sh -j 4 --pg-version=${{ matrix.pgversion }}
+    - name: Run tests
+      run: ./src/test/test.sh --no-gui --pg-versions=${{ matrix.pgversion }}
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      if: failure()
+      with:
+        name: postgresql-logs-${{ matrix.pgversion }}
+        retention-days: 3
+        path: |
+          pgsrc/${{ matrix.pgversion }}/data/postgresql.log
+          src/test/log

src/test/README.md

@@ -28,7 +28,7 @@ Example usage:
 ./src/test/setup.sh --pg-version=17.4
 ```
 
-After that, source code, binaries and database will be installed in `./pgsrc`, `./pgsrc/build` and `./pgsrc/data` accordingly (starting from extension directory root).
+After that, source code, binaries and database will be installed in `./pgsrc/VERSION`, `./pgsrc/VERSION/build` and `./pgsrc/VERSION/data` accordingly (starting from extension directory root), where `VERSION` - is a major version of PostgreSQL.
 
 To run tests use `./src/test/test.sh` script:
 

src/test/run.sh

@@ -57,7 +57,7 @@ source "$ENV_FILE"
 if [ "$RUN_DB" ]; then
     # Not 0 exit code can mean DB already running.
     # For tests this is valid
-    pg_ctl start -o '-k ""' -l ./postgresql.log -w || true
+    pg_ctl start -l "$PGDATA/postgresql.log" -w || true
 fi
 
 if [ "$STOP_DB" ]; then

src/test/runTests.ts

@@ -5,20 +5,40 @@ import { downloadAndUnzipVSCode,
          resolveCliArgsFromVSCodeExecutablePath,
          runTests } from '@vscode/test-electron';
 
-function getDebuggerExtensionId() {
-    const debuggerType = process.env.PGHH_DEBUGGER;
-    if (!debuggerType || debuggerType === 'cppdbg') {
+function getDebuggerExtensionId(debuggerType: string) {
+    if (debuggerType === 'cppdbg') {
         return 'ms-vscode.cpptools';
-    } else if (debuggerType == 'lldb') {
-        return 'vadimcn.vscode-lldb';
     } else {
-        throw new Error(`Unknown debugger type: ${debuggerType}`);
+        return 'vadimcn.vscode-lldb';
     }
 }
 
+function getPgsrcDir(extPath: string, version: string) {
+    return path.join(extPath, 'pgsrc', version);
+}
+
+function getTestEnv() {
+    const pgVersion = process.env.PGHH_PG_VERSION;
+    const debuggerType = process.env.PGHH_DEBUGGER ?? 'cppdbg';
+    const vscodeVersion = process.env.PGHH_VSCODE_VERSION ?? 'stable';
+
+    if (!pgVersion) {
+        throw new Error('PGHH_PG_VERSION env variable is not set');
+    }
+    
+    if (!debuggerType) {
+        throw new Error('PGHH_DEBUGGER env variable is not set');
+    }
+
+    if (!['cppdbg', 'lldb'].includes(debuggerType)) {
+        throw new Error(`Debugger ${debuggerType} is not supported`);
+    }
+
+    return {pgVersion, debuggerType, vscodeVersion};
+}
+
 async function main() {
-    let error = false;
-    /* 
+    /*
      * The folder containing the Extension Manifest package.json.
      * Passed to `--extensionDevelopmentPath` 
      */
@@ -28,28 +48,29 @@ async function main() {
      * Passed to --extensionTestsPath
      */
     const extensionTestsPath = path.resolve(__dirname, './suite/index');
+
+    const testEnv = getTestEnv();
+
     /*
      * The path to source code of PostgreSQL we are testing now
      */
-    const pgsrcDir = path.resolve(extensionDevelopmentPath, './pgsrc');
+    const pgsrcDir = getPgsrcDir(extensionDevelopmentPath, testEnv.pgVersion);
+    const vscodeExecutablePath = await downloadAndUnzipVSCode(testEnv.vscodeVersion);
+    const [cliPath, ...args] = resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath);
 
+    /* Install required debugger extension */
+    const dbgExtId = getDebuggerExtensionId(testEnv.debuggerType);
+    cp.spawnSync(cliPath, [...args, '--install-extension', dbgExtId],
+        { encoding: 'utf-8', stdio: 'inherit'});
+    
+    /* Run PostgreSQL */
+    cp.spawnSync('/bin/bash', ['./run.sh', '--run'], {
+        cwd: pgsrcDir,
+        stdio: 'inherit',
+        encoding: 'utf-8',
+    });
+    
     try {
-        const vscodeVersion = process.env.PGHH_VSCODE_VERSION ?? 'stable';
-        const vscodeExecutablePath = await downloadAndUnzipVSCode(vscodeVersion);
-        const [cliPath, ...args] = resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath);
-
-        /* Install required debugger extension */
-        const dbgExtId = getDebuggerExtensionId();
-        cp.spawnSync(cliPath, [...args, '--install-extension', dbgExtId],
-                     { encoding: 'utf-8', stdio: 'inherit'});
-
-        /* Run PostgreSQL */
-        cp.spawnSync('/bin/bash', ['./run.sh', '--run'], {
-            cwd: pgsrcDir,
-            stdio: 'inherit',
-            encoding: 'utf-8',
-        });
-
         /* Start tests */
         await runTests({ 
             extensionDevelopmentPath,
@@ -62,21 +83,19 @@ async function main() {
                '--enable-proposed-api', dbgExtId,
             ],
         });
-    } catch (err) {
-        console.error(err);
-        console.error('Failed to run tests');
-        error = true;
-    }
-    
-    cp.spawnSync('/bin/bash', ['./run.sh', '--stop'], {
-        cwd: pgsrcDir,
-        stdio: 'inherit',
-        encoding: 'utf-8',
-    });
-
-    if (error) {
-        process.exit(1);
+    } finally {
+        cp.spawnSync('/bin/bash', ['./run.sh', '--stop'], {
+            cwd: pgsrcDir,
+            stdio: 'inherit',
+            encoding: 'utf-8',
+        });
     }
 }
 
-main();
+try {
+    main();
+} catch (err) {
+    console.error(err);
+    console.error('Failed to run tests');
+    process.exit(1);
+}

src/test/setup.sh

@@ -4,14 +4,15 @@ function print_help {
     cat <<EOM 
 Setup environment for PostgreSQL Hacker Helper extension testing.
 This script downloads specified PostgreSQL version (source code), applies patch, runs build and setups database (initdb + initial schema).
-Source code is installed to EXT_SRC/pgsrc, where EXT_SRC - root directory of extension.
+Source code is installed to EXT_SRC/pgsrc/PG_VERSION, where EXT_SRC - root directory of extension and PG_VERSION - major PostgreSQL version.
 
 Usage: $0 --pg-version=17
 
 Options:
     -h, --help              Print this help message
     --pg-version            Major version of PostgreSQL to install.
     --threads               Number of threads to use during build
+    --force                 Remove old installation if it exists.
 
 Supported PG versions from 17 to 9.6 inclusive.
 
@@ -21,17 +22,21 @@ Example:
 EOM
 }
 
-ARG_PG_VERSION=""
+MAJOR_PG_VERSION=""
 THREADS="1"
+FORCE=""
 while [ "$1" ]; do
     ARG="$1"
     case "$ARG" in
     --pg-version=*)
-        ARG_PG_VERSION="${ARG#*=}"
+        MAJOR_PG_VERSION="${ARG#*=}"
         ;;
     --threads=*)
         THREADS="${ARG#*=}"
         ;;
+    --force)
+        FORCE="1"
+        ;;
     -j)
         shift
         THREADS="$1"
@@ -51,13 +56,13 @@ done
 # Exit on error
 set -e -o pipefail
 
-if [[ -z "$ARG_PG_VERSION" ]]; then
+if [[ -z "$MAJOR_PG_VERSION" ]]; then
     echo "--pg-version is not set - specify PostgreSQL version"
     exit 1
 fi
 
 PG_VERSION=""
-case "$ARG_PG_VERSION" in
+case "$MAJOR_PG_VERSION" in
     '17')
         PG_VERSION='17.4'
         ;;
@@ -86,7 +91,7 @@ case "$ARG_PG_VERSION" in
         PG_VERSION='9.6.24'
         ;;
     *)
-        echo "Version $ARG_PG_VERSION is not supported"
+        echo "Version $MAJOR_PG_VERSION is not supported"
         echo "Supported version from 17 to 9.6 inclusive"
         exit 1
         ;;
@@ -96,28 +101,37 @@ esac
 cd "$(dirname ${BASH_SOURCE[0]:-$0})/../.."
 EXT_ROOT_DIR="$PWD"
 
-CFLAGS="-O0 -g $CFLAGS"
-CPPFLAGS="-O0 -g $CPPFLAGS"
 PATCH_FILE="$EXT_ROOT_DIR/src/test/patches/pg${PG_VERSION}.patch"
 PG_SRC_DOWNLOAD_URL="https://ftp.postgresql.org/pub/source/v${PG_VERSION}/postgresql-${PG_VERSION}.tar.gz"
-CACHEDIR="$PWD/src/test/cache"
+CACHEDIR="$EXT_ROOT_DIR/src/test/cache"
 TARFILE="$CACHEDIR/postgresql-${PG_VERSION}.tar.gz"
-SRC_PATH="$EXT_ROOT_DIR/pgsrc"
-INSTALL_PATH="$EXT_ROOT_DIR/pgsrc/build"
-LOGDIR="$PWD/src/test/log"
+SRC_PATH="$EXT_ROOT_DIR/pgsrc/$MAJOR_PG_VERSION"
+INSTALL_PATH="$SRC_PATH/build"
+LOGDIR="$EXT_ROOT_DIR/src/test/log"
 LOGFILE="$LOGDIR/setup_$(date +%Y%m%d%H%M).log"
+
+set -e -o pipefail
 mkdir -p "$LOGDIR"
 
-# Download PostgreSQL source code into it's directory and apply patch
 {
-set -e -o pipefail
-rm -rf "$SRC_PATH"
+
+if [[ -d "$SRC_PATH" ]]; then
+    if [[ -z "$FORCE" ]]; then
+        echo "Installation already exists. Use --force to remove old src dir"
+        exit 0
+    else
+        rm -rf "$SRC_PATH"
+    fi
+fi
+
+
+# Download PostgreSQL source code into it's directory and apply patch
 mkdir -p "$SRC_PATH"
 mkdir -p "$CACHEDIR"
 if [[ ! -f "$TARFILE" ]]; then
-    wget "$PG_SRC_DOWNLOAD_URL" -O "$TARFILE"
+    wget -q "$PG_SRC_DOWNLOAD_URL" -O "$TARFILE"
 fi
-tar -xvzf "$TARFILE" -C "$SRC_PATH" --strip-components=1
+tar -xvzf "$TARFILE" -C "$SRC_PATH" --strip-components=1 1>/dev/null
 cd "$SRC_PATH"
 patch -p1 -i "$PATCH_FILE"
 
@@ -127,15 +141,29 @@ patch -p1 -i "$PATCH_FILE"
             --enable-debug \
             --enable-cassert \
             --without-openssl \
-            CFLAGS="$CFLAGS" \
-            CPPFLAGS="$CPPFLAGS"
+            --without-readline \
+            --without-python \
+            --without-tcl \
+            --without-pam \
+            --without-selinux \
+            --without-icu \
+            --without-ldap \
+            --without-libxml \
+            --without-libxslt \
+            --without-bonjour \
+            --without-lz4 \
+            --without-zstd \
+            --without-llvm \
+            --without-zlib \
+            CFLAGS="-O0 -g3 $CFLAGS" \
+            CPPFLAGS="-O0 -g3 $CPPFLAGS"
 
 # Setup special file with 
 ENV_PATH="${PWD}/env.sh"
 cat <<EOF >"$ENV_PATH"
 export PGINSTDIR="$INSTALL_PATH"
 export PGDATA="$SRC_PATH/data"
-export PGHOST="localhost"
+export PGHOST="$SRC_PATH/data"
 export PGPORT="5432"
 export PGUSER="postgres"
 export PGDATABASE="postgres"
@@ -153,7 +181,14 @@ make install-world-bin
 
 # Create database and setup schema
 initdb -U "$PGUSER"
-pg_ctl start -l ./postgresql.log -o '-k ""' -w
+cat <<EOF >>"$PGDATA/postgresql.conf"
+unix_socket_directories='$PGDATA'
+listen_addresses=''
+port=5432
+log_min_messages=DEBUG1
+EOF
+
+pg_ctl start -l "$PGDATA/postgresql.log" -w
 psql -c "CREATE TABLE t1(x int, y int);"
 psql -c "CREATE TABLE t2(x int, y int);"
 pg_ctl stop -w