Merge branch 'pgadmin-org:master' into master

Author: anilsahoo20

.github/workflows/run-feature-tests-pg.yml

@@ -32,6 +32,18 @@ jobs:
           sudo sh -c 'echo "deb https://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
           wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
 
+      - name: Uninstall PostgreSQL if already present
+        run: |
+          if [ -n "$(ls /etc/postgresql/*/*/postgresql.conf 2>/dev/null)" ]; then
+            # Extract the major version from pg_config
+            installed_pg_version=$( pg_config --version | cut -d ' ' -f 2 | cut -d '.' -f 1 )
+            echo "Installed PostgreSQL version: $installed_pg_version"
+            if [ $installed_pg_version != ${{ matrix.pgver }} ]; then
+              sudo pg_dropcluster $installed_pg_version main --stop
+              sudo apt-get -y remove "postgresql-${installed_pg_version}"
+            fi
+          fi
+
       - name: Install platform dependencies
         run: |
           sudo apt update
@@ -119,7 +131,7 @@ jobs:
                 "comment": "PostgreSQL ${{ matrix.pgver }} Server",
                 "db_username": "postgres",
                 "host": "/var/run/postgresql",
-                "db_password": "postgres",
+                "db_password": "",
                 "db_port": 59${{ matrix.pgver }},
                 "maintenance_db": "postgres",
                 "sslmode": "prefer",

.github/workflows/run-python-tests-epas.yml

@@ -48,7 +48,7 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-22.04' }}
         run: |
           sudo apt update
-          sudo apt install -y libpq-dev libffi-dev libssl-dev libkrb5-dev zlib1g-dev edb-as${{ matrix.pgver }}-server edb-as${{ matrix.pgver }}-server-pldebugger
+          sudo apt install -y libpq-dev libffi-dev libssl-dev libkrb5-dev zlib1g-dev edb-as${{ matrix.pgver }}-server edb-as${{ matrix.pgver }}-server-pldebugger edb-as${{ matrix.pgver }}-postgis34
 
       - name: Install pgagent on Linux
         if: ${{ matrix.os == 'ubuntu-22.04' &&  matrix.pgver <= 16 }}
@@ -105,6 +105,10 @@ jobs:
       - name: Create pgagent extension on Linux
         if: ${{ matrix.os == 'ubuntu-22.04' &&  matrix.pgver <= 16 }}
         run: psql -U enterprisedb -d postgres -p 58${{ matrix.pgver }} -c 'CREATE EXTENSION IF NOT EXISTS pgagent;'
+      
+      - name: Create postgis extension on Linux
+        if: ${{ matrix.os == 'ubuntu-22.04' }}
+        run: psql -U enterprisedb -d postgres -p 58${{ matrix.pgver }} -c 'CREATE EXTENSION IF NOT EXISTS postgis;'
 
       - name: Install Python dependencies on Linux
         if: ${{ matrix.os == 'ubuntu-22.04' }}

.github/workflows/run-python-tests-pg.yml

@@ -34,19 +34,32 @@ jobs:
           sudo sh -c 'echo "deb https://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
           wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
 
+      - name: Uninstall PostgreSQL if already present on linux
+        if: ${{ matrix.os == 'ubuntu-22.04' }}
+        run: |
+          if [ -n "$(ls /etc/postgresql/*/*/postgresql.conf 2>/dev/null)" ]; then
+            # Extract the major version from pg_config
+            installed_pg_version=$( pg_config --version | cut -d ' ' -f 2 | cut -d '.' -f 1 )
+            echo "Installed PostgreSQL version: $installed_pg_version"
+            if [ $installed_pg_version != ${{ matrix.pgver }} ]; then
+              sudo pg_dropcluster $installed_pg_version main --stop
+              sudo apt-get -y remove "postgresql-${installed_pg_version}"
+            fi
+          fi
+
       - name: Install platform dependencies on Linux
         if: ${{ matrix.os == 'ubuntu-22.04' }}
         run: |
           sudo apt update
-          sudo apt install -y libpq-dev libffi-dev libssl-dev libkrb5-dev zlib1g-dev postgresql-${{ matrix.pgver }} postgresql-${{ matrix.pgver }}-pldebugger pgagent
+          sudo apt install -y libpq-dev libffi-dev libssl-dev libkrb5-dev zlib1g-dev postgresql-${{ matrix.pgver }} postgresql-${{ matrix.pgver }}-pldebugger pgagent postgresql-${{ matrix.pgver }}-postgis-3
 
       - name: Install platform dependencies on macOS
         if: ${{ matrix.os == 'macos-latest' }}
         run: |
           brew install postgresql@${{ matrix.pgver }}
           echo "/opt/homebrew/opt/postgresql@${{ matrix.pgver }}/bin" >> $GITHUB_PATH
 
-      - name: Uninstall PostgreSQL if already present
+      - name: Uninstall PostgreSQL if already present on windows
         if: ${{ matrix.os == 'windows-latest' }}
         run: |
           if exist "C:\Program Files\PostgreSQL\{{ matrix.pgver }}\uninstall-postgresql.exe" (
@@ -100,6 +113,7 @@ jobs:
 
           psql -U postgres -p 59${{ matrix.pgver }} -c 'CREATE EXTENSION pgagent;'
           psql -U postgres -p 59${{ matrix.pgver }} -c 'CREATE EXTENSION pldbgapi;'
+          psql -U postgres -p 59${{ matrix.pgver }} -c 'CREATE EXTENSION postgis;'
 
       - name: Start PostgreSQL on macOS
         if: ${{ matrix.os == 'macos-latest' }}

.python-version

@@ -208,7 +208,7 @@ RUN apk add --no-cache \
         libedit \
         libldap \
         libcap && \
-    /venv/bin/python3 -m pip install --no-cache-dir gunicorn==22.0.0 && \
+    /venv/bin/python3 -m pip install --no-cache-dir gunicorn==23.0.0 && \
     find / -type d -name '__pycache__' -exec rm -rf {} + && \
     useradd -r -u 5050 -g root -s /sbin/nologin pgadmin && \
     mkdir -p /run/pgadmin /var/lib/pgadmin && \
@@ -222,7 +222,7 @@ RUN apk add --no-cache \
     echo "pgadmin ALL = NOPASSWD: /usr/sbin/postfix start" > /etc/sudoers.d/postfix && \
     echo "pgadminr ALL = NOPASSWD: /usr/sbin/postfix start" >> /etc/sudoers.d/postfix
 
-USER pgadmin
+USER 5050
 
 # Finish up
 VOLUME /var/lib/pgadmin

Dockerfile

@@ -52,7 +52,7 @@ REM Main build sequence Ends
 
 :SET_ENVIRONMENT
     ECHO Configuring the environment...
-    IF "%PGADMIN_PYTHON_DIR%" == ""   SET "PGADMIN_PYTHON_DIR=C:\Python312"
+    IF "%PGADMIN_PYTHON_DIR%" == ""   SET "PGADMIN_PYTHON_DIR=C:\Python313"
     IF "%PGADMIN_KRB5_DIR%" == ""     SET "PGADMIN_KRB5_DIR=C:\Program Files\MIT\Kerberos"
     IF "%PGADMIN_POSTGRES_DIR%" == "" SET "PGADMIN_POSTGRES_DIR=C:\Program Files\PostgreSQL\17"
     IF "%PGADMIN_INNOTOOL_DIR%" == "" SET "PGADMIN_INNOTOOL_DIR=C:\Program Files (x86)\Inno Setup 6"
@@ -164,7 +164,7 @@ REM Main build sequence Ends
     CALL "%TMPDIR%\venv\Scripts\activate" || EXIT /B 1
 
     ECHO Installing dependencies...
-    CALL python -m pip install --upgrade pip || EXIT /B 1
+    CALL python -m pip install --upgrade pip==24.2 || EXIT /B 1
     CALL pip install --only-binary=cryptography -r "%WD%\requirements.txt" || EXIT /B 1
 
     CD %WD%

Make.bat

@@ -15,33 +15,51 @@ and ReactJS, HTML5 with CSS for the client side processing and UI.
 Although developed using web technologies, pgAdmin 4 can be deployed either on
 a web server using a browser, or standalone on a workstation. The runtime/
 subdirectory contains an Electron based runtime application intended to allow this,
-which will execute the Python server and display the UI.
+which will fork a Python server process and display the UI.
 
-## Building the Runtime
-
-To build the runtime, the following packages must be installed:
+## Prerequisites
+1. Install Node.js 20 and above (https://nodejs.org/en/download)
+2. yarn (https://yarnpkg.com/getting-started/install)
+3. Python 3.8 and above (https://www.python.org/downloads/)
+4. PostgreSQL server (https://www.postgresql.org/download)
 
-* NodeJS 16+
-* Yarn
+Start by enabling Corepack, if it isn't already;
+this will add the yarn binary to your PATH:
+```bash
+corepack enable
+```
 
-Change into the runtime directory, and run *yarn install*. This will install the
-dependencies required.
+# Building the Web Assets
 
-In order to use the runtime in a development environment, you'll need to copy
-*dev_config.json.in* file to *dev_config.json*, and edit the paths to the Python
-executable and *pgAdmin.py* file, otherwise the runtime will use the default
-paths it would expect to find in the standard package for your platform.
+pgAdmin is dependent on a number of third party Javascript libraries. These,
+along with it's own Javascript code, CSS code and images must be
+compiled into a "bundle" which is transferred to the browser for execution
+and rendering. This is far more efficient than simply requesting each
+asset as it's needed by the client.
 
-You can then execute the runtime by running something like:
+To create the bundle, you will need the 'yarn' package management tool to be
+installed. Then, you can run the following commands on a *nix system to
+download the required packages and build the bundle:
 
 ```bash
-yarn run start
+$ cd $PGADMIN4_SRC
+$ make install-node
+$ make bundle
+```
+
+On Windows systems (where "make" is not available), the following commands
+can be used:
+
+```
+C:\> cd $PGADMIN4_SRC\web
+C:\$PGADMIN4_SRC\web> yarn install
+C:\$PGADMIN4_SRC\web> yarn run bundle
 ```
 
 # Configuring the Python Environment
 
 In order to run the Python code, a suitable runtime environment is required.
-Python version 3.7 and later are currently supported. It is recommended that a
+Python version 3.8 and later are currently supported. It is recommended that a
 Python Virtual Environment is setup for this purpose, rather than using the
 system Python environment. On Linux and Mac systems, the process is fairly
 simple - adapt as required for your distribution:
@@ -63,7 +81,7 @@ simple - adapt as required for your distribution:
    so update that to the latest:
 
    ```bash
-   $ pip install --upgrade pip
+   (venv) $ pip install --upgrade pip
    ```
 
 4. Ensure that a PostgreSQL installation's bin/ directory is in the path (so
@@ -88,36 +106,44 @@ simple - adapt as required for your distribution:
    configuration may look like:
 
     ```python
-    from config import *
-
-    # Debug mode
-    DEBUG = True
-
-    # App mode
-    SERVER_MODE = True
-
-    # Enable the test module
-    MODULE_BLACKLIST.remove('test')
-
-    # Log
-    CONSOLE_LOG_LEVEL = DEBUG
-    FILE_LOG_LEVEL = DEBUG
-
-    DEFAULT_SERVER = '127.0.0.1'
-
-    UPGRADE_CHECK_ENABLED = True
-
-    # Use a different config DB for each server mode.
-    if SERVER_MODE == False:
-        SQLITE_PATH = os.path.join(
-            DATA_DIR,
-            'pgadmin4-desktop.db'
-        )
-    else:
-        SQLITE_PATH = os.path.join(
-            DATA_DIR,
-            'pgadmin4-server.db'
-        )
+   import os
+   import logging
+
+   # Change pgAdmin data directory
+   DATA_DIR = '/Users/myuser/.pgadmin_dev'
+
+   #Change pgAdmin server and port
+   DEFAULT_SERVER = '127.0.0.1'
+   DEFAULT_SERVER_PORT = 5051
+
+   # Switch between server and desktop mode
+   SERVER_MODE = True
+
+   #Change pgAdmin config DB path in case external DB is used.
+   CONFIG_DATABASE_URI="postgresql://postgres:postgres@localhost:5436/pgadmin"
+
+   #Setup SMTP
+   MAIL_SERVER = 'smtp.gmail.com'
+   MAIL_PORT = 465
+   MAIL_USE_SSL = True
+   MAIL_USERNAME = 'user@gmail.com'
+   MAIL_PASSWORD = 'xxxxxxxxxx'
+
+   # Change log level
+   CONSOLE_LOG_LEVEL = logging.INFO
+   FILE_LOG_LEVEL = logging.INFO
+
+   # Use a different config DB for each server mode.
+   if SERVER_MODE == False:
+     SQLITE_PATH = os.path.join(
+         DATA_DIR,
+         'pgadmin4-desktop.db'
+     )
+   else:
+     SQLITE_PATH = os.path.join(
+         DATA_DIR,
+         'pgadmin4-server.db'
+     )
    ```
 
    This configuration allows easy switching between server and desktop modes
@@ -137,9 +163,9 @@ simple - adapt as required for your distribution:
    (venv) $ python3 $PGADMIN4_SRC/web/pgAdmin4.py
    ```
 
-   Whilst it is possible to automatically run setup in desktop mode by running
-   the runtime, that will not work in server mode as the runtime doesn't allow
-   command line interaction with the setup program.
+Whilst it is possible to automatically run setup in desktop mode by running
+the runtime, that will not work in server mode as the runtime doesn't allow
+command line interaction with the setup program.
 
 At this point you will be able to run pgAdmin 4 from the command line in either
 server or desktop mode, and access it from a web browser using the URL shown in
@@ -148,49 +174,6 @@ the terminal once pgAdmin has started up.
 Setup of an environment on Windows is somewhat more complicated unfortunately,
 please see *pkg/win32/README.txt* for complete details.
 
-# Building the Web Assets
-
-pgAdmin is dependent on a number of third party Javascript libraries. These,
-along with it's own Javascript code, SCSS/CSS code and images must be
-compiled into a "bundle" which is transferred to the browser for execution
-and rendering. This is far more efficient than simply requesting each
-asset as it's needed by the client.
-
-To create the bundle, you will need the 'yarn' package management tool to be
-installed. Then, you can run the following commands on a *nix system to
-download the required packages and build the bundle:
-
-```bash
-(venv) $ cd $PGADMIN4_SRC
-(venv) $ make install-node
-(venv) $ make bundle
-```
-
-On Windows systems (where "make" is not available), the following commands
-can be used:
-
-```
-C:\> cd $PGADMIN4_SRC\web
-C:\$PGADMIN4_SRC\web> yarn install
-C:\$PGADMIN4_SRC\web> yarn run bundle
-```
-
-# Creating pgAdmin themes
-
-To create a pgAdmin theme, you need to create a directory under
-*web/pgadmin/static/scss/resources*.
-Copy the sample file *_theme.variables.scss.sample* to the new directory and
-rename it to *_theme.variables.scss*. Change the desired hexadecimal values of
-the colors and bundle pgAdmin. You can also add a preview image in the theme
-directory with the name as *\<dir name>_preview.png*. It is recommended that the
-preview image should not be larger in size as it may take time to load on slow
-networks. Run the *yarn run bundle* and you're good to go. No other changes are
-required, pgAdmin bundle will read the directory and create other required
-entries to make them available in preferences.
-
-The name of the theme is derived from the directory name. Underscores (_) and
-hyphens (-) will be replaced with spaces and the result will be camel cased.
-
 # Building the documentation
 
 In order to build the docs, an additional Python package is required in the
@@ -210,6 +193,21 @@ The docs can then be built using the Makefile in *$PGADMIN4_SRC*, e.g.
 
 The output can be found in *$PGADMIN4_SRC/docs/en_US/_build/html/index.html*
 
+## Building the Runtime
+Change into the runtime directory, and run *yarn install*. This will install the
+dependencies required.
+
+In order to use the runtime in a development environment, you'll need to copy
+*dev_config.json.in* file to *dev_config.json*, and edit the paths to the Python
+executable and *pgAdmin.py* file, otherwise the runtime will use the default
+paths it would expect to find in the standard package for your platform.
+
+You can then execute the runtime by running something like:
+
+```bash
+yarn run start
+```
+
 # Building packages
 
 Most packages can be built using the Makefile in $PGADMIN4_SRC, provided all