Add tests for alembic db script by SegiNyn · Pull Request #7234 · indico/indico

SegiNyn · 2025-12-19T13:13:41Z

Commands:
For indico: python bin/utils/db_test.py -v --nb-scripts 10
For a plugin: python bin/utils/db_test.py -v --nb-scripts 10 --plugin-dir <plugin-dir>

The script will be added to the ci

The script checks the following:

Revision history has one single head
No orphaned revision were found
Revision history files are properly sorted
Revision hash matches the one in the docstring
Downgrade and upgrade scripts are idempotent

Example Issues

One of the scripts was ordered incorrectly so this I just changed the file date to properly order it.
because functions were applied directly, the db_test script fails when it gets to the actual script introducing the function at 20250214_1136_c7d6c3641918_add_alternate_names_to_affiliations.py
in /20191111_1820_2496c4adc7e9_add_track_principal.py and /20191108_1713_4e459d27adab_add_tables_for_editing_revisions.py enum claasses were imported and used directly instead of creating one in the script to show the current state of the model
In the downgrade script at /20240307_1408_b37cbc4bb129_link_events_to_reservation_occurrences.py, index=True should have been included when adding back link_id. (This issue only shows up when the script gets to /20190118_1514_416f9c877300_add_reservationlink_table.py

OmeGak

First round of review.

OmeGak · 2026-01-22T10:17:11Z

+    configuration should be done using the various environment variables like
+    PGHOST, PGPORT and PGUSER) and your `.pgpass` file.
+    """
+    if plugin_dir and not plugin_dir.samefile(os.getcwd()):


If --plugin-dir is specified but it's different from the current directory, then, the script will fallback to running the test on Indico core. This seems a bug to me. Here's the pseudocode:

if not plugin_dir: # Run the tests on Indico core else: if plugin_dir.samefile(os.getcwd()): # Run the tests on plugin else: with _chdir(plugin_dir): # Run the tests on plugin

If --plugin-dir is specified but it's different from the current directory, then, the script will fallback to running the test on Indico core

No, it should fall back to running on indico if the plugin_dir is same as current directory. If the plugin directory is not the current indico directory then it should run on the plugin.

The logic that I'm applying now is that --plugin-dir instructs the script to be run for a plugin.

The problem that I was facing is the following.

My current working directory is the plugin directory.

I pass --plugin-dir .

Because plugin_dir is the same as the working directory, the script runs in Indico core mode, failing.

Now raising an exception if the indico directory is passed as the plugin_dir

Can be marked as resolved.

OmeGak · 2026-01-27T13:58:55Z

+        _run(['psql', DB_NAME, '-c', 'CREATE EXTENSION pg_trgm;'])
+        _run(['psql', DBDIFF_NAME, '-c', 'CREATE EXTENSION unaccent;'])
+        _run(['psql', DBDIFF_NAME, '-c', 'CREATE EXTENSION pg_trgm;'])
+        _run(['indico', 'db', 'prepare'])


Would there be a quicker way to prepare DB? Running indico command is very slow.

/cc @ThiefMaster

no, as it needs to import all the models etc which is what makes it slow

OmeGak · 2026-01-27T13:59:37Z

+    # TODO: Is this the best way to get the plugin name?
+    packages = [x.parent.name for x in plugin_dir.glob('*/__init__.py')]


Is this the best way to get the plugin name?

/cc @ThiefMaster

The most reliable way would be getting it from the pyproject.toml entry point definition. I've seen too many unofficial plugins where people don't care about following our usual plugin naming scheme...

Co-authored-by: Alejandro Avilés <alejandro.aviles@un.org>

github-actions Bot added the alembic Contains database changes label Dec 19, 2025

SegiNyn force-pushed the add-db-test branch 2 times, most recently from 823b2ff to 020617e Compare December 22, 2025 15:49

SegiNyn marked this pull request as ready for review December 22, 2025 15:50

OmeGak suggested changes Jan 22, 2026

View reviewed changes

OmeGak force-pushed the add-db-test branch 3 times, most recently from 58b4fdd to 31ab022 Compare January 26, 2026 19:32

SegiNyn force-pushed the add-db-test branch 2 times, most recently from bd00a95 to ff96572 Compare January 27, 2026 13:19

OmeGak reviewed Jan 27, 2026

View reviewed changes

SegiNyn force-pushed the add-db-test branch 2 times, most recently from 5c1ca47 to 5fb7456 Compare February 3, 2026 11:18

OmeGak force-pushed the add-db-test branch from efd5819 to 2b16d01 Compare February 11, 2026 14:25

SegiNyn and others added 16 commits February 11, 2026 15:26

Fix order of migration script

5f17f60

Move db_test script to core

80eb523

Co-authored-by: Alejandro Avilés <alejandro.aviles@un.org>

Make db util scripts executable

019fb2e

Uncomment script idempotence check for Indico core

446e5f2

Fix running DB checks from plugin directory

25a2980

Remove unnecessary ifs

d50fbe6

Reorganize functions

51fd8d5

Use Path objects throughout

ddd40af

Add more verbose outputs

479f2ad

Use Path objects throughout (continuation)

da9fd5b

Set test environment per run

1bfdedd

Small changes

22ee204

WIP Possible fixes for old scripts

b68eb65

Fix directory issues

8249680

Fix todos

890922b

fix todo

2b24aa7

Small changes

46cd90e

OmeGak force-pushed the add-db-test branch from 2b16d01 to 46cd90e Compare February 11, 2026 14:26

Fix linter

21369a3

		# TODO: Is this the best way to get the plugin name?
		packages = [x.parent.name for x in plugin_dir.glob('*/__init__.py')]

Conversation

SegiNyn commented Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OmeGak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OmeGak Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SegiNyn commented Dec 19, 2025 •

edited

Loading

OmeGak Jan 26, 2026 •

edited

Loading