Script extract-jupyter-users-from-magpie-db: allow to customize the query (#530)

## Overview

Script `extract-jupyter-users-from-magpie-db`: allow to customize the
query

An example query is provided if we want to list all users, except if
they
  belong to some groups.

## Changes

**Non-breaking changes**
- `extract-jupyter-users-from-magpie-db`: allow to customize the query


## CI Operations

<!--
The test suite can be run using a different DACCS config with
``birdhouse_daccs_configs_branch: branch_name`` in the PR description.
To globally skip the test suite regardless of the commit message use
``birdhouse_skip_ci`` set to ``true`` in the PR description.

Using ``[<cmd>]`` (with the brackets) where ``<cmd> = skip ci`` in the
commit message will override ``birdhouse_skip_ci`` from the PR
description.
Such commit command can be used to override the PR description behavior
for a specific commit update.
However, a commit message cannot 'force run' a PR which the description
turns off the CI.
To run the CI, the PR should instead be updated with a ``true`` value,
and a running message can be posted in following PR comments to trigger
tests once again.
-->

birdhouse_daccs_configs_branch: master
birdhouse_skip_ci: false

Author: tlvu

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.13.4
+current_version = 2.13.5
 commit = True
 tag = False
 tag_name = {new_version}
@@ -30,11 +30,11 @@ search = {current_version}
 replace = {new_version}
 
 [bumpversion:file:RELEASE.txt]
-search = {current_version} 2025-05-05T13:04:34Z
+search = {current_version} 2025-05-08T17:20:00Z
 replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ}
 
 [bumpversion:part:releaseTime]
-values = 2025-05-05T13:04:34Z
+values = 2025-05-08T17:20:00Z
 
 [bumpversion:file(version):birdhouse/components/canarie-api/docker_configuration.py.template]
 search = 'version': '{current_version}'

CHANGES.md

@@ -17,6 +17,17 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[2.13.5](https://github.com/bird-house/birdhouse-deploy/tree/2.13.5) (2025-05-08)
+------------------------------------------------------------------------------------------------------------------
+
+## Changes
+
+- Script `extract-jupyter-users-from-magpie-db`: allow to customize the query
+
+  An example query is provided if we want to list all users, except if they
+  belong to some groups.
+
+
 [2.13.4](https://github.com/bird-house/birdhouse-deploy/tree/2.13.4) (2025-05-05)
 ------------------------------------------------------------------------------------------------------------------
 

Makefile

@@ -8,7 +8,7 @@ override BIRDHOUSE_MAKE_DIR := $(shell realpath -P $$(dirname $(BIRDHOUSE_MAKE_C
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 2.13.4
+override APP_VERSION := 2.13.5
 
 # utility to remove comments after value of an option variable
 override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g")

README.rst

@@ -18,13 +18,13 @@ for a full-fledged production platform.
     * - citation
       - | |citation|
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.13.4.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.13.5.svg
     :alt: Commits since latest release
-    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.13.4...master
+    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.13.5...master
 
-.. |latest-version| image:: https://img.shields.io/badge/tag-2.13.4-blue.svg?style=flat
+.. |latest-version| image:: https://img.shields.io/badge/tag-2.13.5-blue.svg?style=flat
     :alt: Latest Tag
-    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.13.4
+    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.13.5
 
 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
     :alt: ReadTheDocs Build Status (latest version)

RELEASE.txt

@@ -1 +1 @@
-2.13.4 2025-05-05T13:04:34Z
+2.13.5 2025-05-08T17:20:00Z

birdhouse/components/canarie-api/docker_configuration.py.template

@@ -108,8 +108,8 @@ SERVICES = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '2.13.4',
-            'releaseTime': '2025-05-05T13:04:34Z',
+            'version': '2.13.5',
+            'releaseTime': '2025-05-08T17:20:00Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',
@@ -141,8 +141,8 @@ PLATFORMS = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '2.13.4',
-            'releaseTime': '2025-05-05T13:04:34Z',
+            'version': '2.13.5',
+            'releaseTime': '2025-05-08T17:20:00Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',

birdhouse/scripts/extract-jupyter-users-from-magpie-db

@@ -3,6 +3,25 @@
 # Extract Jupyter users from Magpie DB so we can send announcements to all
 # Jupyter users.
 #
+# Environment variable EXTRACT_JUPYTER_USERS_FROM_MAGPIE_DB_QUERY can be set to
+# customize the query in env.local.
+#
+#   Example: list all users, except those in group1 and group2
+#
+#     EXTRACT_JUPYTER_USERS_FROM_MAGPIE_DB_QUERY="${EXTRACT_JUPYTER_USERS_FROM_MAGPIE_DB_QUERY:-"
+#     SELECT email,user_name
+#     FROM users
+#     WHERE id NOT IN
+#       (SELECT user_id
+#        FROM users_groups
+#        WHERE group_id IN
+#           (SELECT id FROM groups
+#            WHERE group_name IN ('group1', 'group2')
+#           )
+#       )
+#     ORDER BY email
+#     "}"
+#
 # Sample output:
 #
 # $ ./scripts/extract-jupyter-users-from-magpie-db  > /tmp/out
@@ -24,13 +43,17 @@ THIS_DIR="$(dirname "${THIS_FILE}")"
 COMPOSE_DIR="${COMPOSE_DIR:-$(dirname "${THIS_DIR}")}"
 
 if [ -f "${COMPOSE_DIR}/read-configs.include.sh" ]; then
+
+    # Silence warnings in this simple script.
+    export BIRDHOUSE_LOG_QUIET=True
+
     . "${COMPOSE_DIR}/read-configs.include.sh"
 
-    # Get POSTGRES_MAGPIE_USERNAME, MAGPIE_DB_NAME.
+    # Get EXTRACT_JUPYTER_USERS_FROM_MAGPIE_DB_QUERY
     read_configs
 fi
 
 set -x
 
-echo "SELECT email,user_name FROM users ORDER BY email" | \
-  docker exec -i postgres-magpie psql -U "${POSTGRES_MAGPIE_USERNAME}" "${MAGPIE_DB_NAME}"
+echo "${EXTRACT_JUPYTER_USERS_FROM_MAGPIE_DB_QUERY:="SELECT email,user_name FROM users ORDER BY email"}" | \
+  docker exec -i postgres-magpie sh -c 'psql -U "${POSTGRES_USER}" "${POSTGRES_DB}"'

docs/source/conf.py

@@ -69,9 +69,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.13.4'
+version = '2.13.5'
 # The full version, including alpha/beta/rc tags.
-release = '2.13.4'
+release = '2.13.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.