From 11e1ec3f5aaa2489b2e0b2f9f69f6a13c6aaa7ff Mon Sep 17 00:00:00 2001 From: Frederick Muriuki Muriithi Date: Tue, 8 Nov 2022 13:50:03 +0300 Subject: Tests: Generalise testing 'CREATE TABLE' migrations * gn3/settings.py: Omit trailing slash * tests/unit/auth/test_create_table_migrations.py: Generalise testing migrations that create tables. * tests/unit/auth/test_create_user_credentials_table.py: delete * tests/unit/auth/test_migration_create_users_table.py: delete --- gn3/settings.py | 2 +- tests/unit/auth/test_create_table_migrations.py | 61 ++++++++++++++++++++++ .../auth/test_create_user_credentials_table.py | 47 ----------------- .../unit/auth/test_migration_create_users_table.py | 39 -------------- 4 files changed, 62 insertions(+), 87 deletions(-) create mode 100644 tests/unit/auth/test_create_table_migrations.py delete mode 100644 tests/unit/auth/test_create_user_credentials_table.py delete mode 100644 tests/unit/auth/test_migration_create_users_table.py diff --git a/gn3/settings.py b/gn3/settings.py index 062c1e6..5fec562 100644 --- a/gn3/settings.py +++ b/gn3/settings.py @@ -64,6 +64,6 @@ ROUND_TO = 10 MULTIPROCESSOR_PROCS = 6 # Number of processes to spawn -AUTH_MIGRATIONS = "migrations/auth/" +AUTH_MIGRATIONS = "migrations/auth" AUTH_DB = os.environ.get( "AUTH_DB", f"{os.environ.get('HOME')}/genenetwork/gn3_files/db/auth.db") diff --git a/tests/unit/auth/test_create_table_migrations.py b/tests/unit/auth/test_create_table_migrations.py new file mode 100644 index 0000000..8bc8fe1 --- /dev/null +++ b/tests/unit/auth/test_create_table_migrations.py @@ -0,0 +1,61 @@ +"""Test migrations that create tables""" +from contextlib import closing + +import pytest +import sqlite3 + +from gn3.migrations import get_migration, apply_migrations, rollback_migrations +from tests.unit.auth.conftest import ( + apply_single_migration, rollback_single_migration, migrations_up_to) + +migrations_and_tables = ( + ("20221103_01_js9ub-initialise-the-auth-entic-oris-ation-database.py", + "users"), + ("20221103_02_sGrIs-create-user-credentials-table.py", "user_credentials"), + ("20221108_01_CoxYh-create-the-groups-table.py", "groups")) + +@pytest.mark.unit_test +@pytest.mark.parametrize("migration_file,the_table", migrations_and_tables) +def test_create_table( + auth_testdb_path, auth_migrations_dir, backend, all_migrations, + migration_file, the_table): + """ + GIVEN: A database migration script to create table, `the_table` + WHEN: The migration is applied + THEN: Ensure that the table `the_table` is created + """ + migration_path=f"{auth_migrations_dir}/{migration_file}" + older_migrations = migrations_up_to(migration_path, auth_migrations_dir) + apply_migrations(backend, older_migrations) + with closing(sqlite3.connect(auth_testdb_path)) as conn, closing(conn.cursor()) as cursor: + cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") + result = cursor.fetchall() + assert the_table not in [row[0] for row in cursor.fetchall()] + apply_single_migration(auth_testdb_path, get_migration(migration_path)) + cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") + assert the_table in [row[0] for row in cursor.fetchall()] + + rollback_migrations(backend, older_migrations) + +@pytest.mark.unit_test +@pytest.mark.parametrize("migration_file,the_table", migrations_and_tables) +def test_rollback_create_table( + auth_testdb_path, auth_migrations_dir, backend, migration_file, + the_table): + """ + GIVEN: A database migration script to create the table `the_table` + WHEN: The migration is rolled back + THEN: Ensure that the table `the_table` no longer exists + """ + migration_path=f"{auth_migrations_dir}/{migration_file}" + older_migrations = migrations_up_to(migration_path, auth_migrations_dir) + apply_migrations(backend, older_migrations) + with closing(sqlite3.connect(auth_testdb_path)) as conn, closing(conn.cursor()) as cursor: + apply_single_migration(auth_testdb_path, get_migration(migration_path)) + cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") + assert the_table in [row[0] for row in cursor.fetchall()] + rollback_single_migration(auth_testdb_path, get_migration(migration_path)) + cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") + assert "the_table" not in [row[0] for row in cursor.fetchall()] + + rollback_migrations(backend, older_migrations) diff --git a/tests/unit/auth/test_create_user_credentials_table.py b/tests/unit/auth/test_create_user_credentials_table.py deleted file mode 100644 index 72b7dd7..0000000 --- a/tests/unit/auth/test_create_user_credentials_table.py +++ /dev/null @@ -1,47 +0,0 @@ -"""Test the auth database initialisation migration.""" -from contextlib import closing - -import pytest -import sqlite3 - -from gn3.migrations import get_migration, apply_migrations, rollback_migrations -from tests.unit.auth.conftest import ( - apply_single_migration, rollback_single_migration, migrations_up_to) - -migration_path = "migrations/auth/20221103_02_sGrIs-create-user-credentials-table.py" - -@pytest.mark.unit_test -def test_create_user_credentials_table(auth_testdb_path, backend, all_migrations): - """ - GIVEN: A database migration script to create the `user_credentials` table - WHEN: The migration is applied - THEN: Ensure that the table is created - """ - older_migrations = migrations_up_to(migration_path, "migrations/auth/") - apply_migrations(backend, older_migrations) - with closing(sqlite3.connect(auth_testdb_path)) as conn, closing(conn.cursor()) as cursor: - cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") - result = cursor.fetchall() - assert "users_credentials" not in [row[0] for row in cursor.fetchall()] - apply_single_migration(auth_testdb_path, get_migration(migration_path)) - cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") - assert "user_credentials" in [row[0] for row in cursor.fetchall()] - - rollback_migrations(backend, older_migrations) - -@pytest.mark.unit_test -def test_rollback_create_user_credentials_table(auth_testdb_path, backend): - """ - GIVEN: A database migration script to create the `user_credentials` table - WHEN: The migration is rolled back - THEN: Ensure that the `user_credentials` table no longer exists - """ - older_migrations = migrations_up_to(migration_path, "migrations/auth/") - apply_migrations(backend, older_migrations) - with closing(sqlite3.connect(auth_testdb_path)) as conn, closing(conn.cursor()) as cursor: - apply_single_migration(auth_testdb_path, get_migration(migration_path)) - rollback_single_migration(auth_testdb_path, get_migration(migration_path)) - cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") - assert "user_credentials" not in [row[0] for row in cursor.fetchall()] - - rollback_migrations(backend, older_migrations) diff --git a/tests/unit/auth/test_migration_create_users_table.py b/tests/unit/auth/test_migration_create_users_table.py deleted file mode 100644 index 74f2020..0000000 --- a/tests/unit/auth/test_migration_create_users_table.py +++ /dev/null @@ -1,39 +0,0 @@ -"""Test the auth database initialisation migration.""" -from contextlib import closing - -import pytest -import sqlite3 - -from gn3.migrations import get_migration, apply_migrations, rollback_migrations -from tests.unit.auth.conftest import ( - apply_single_migration, rollback_single_migration) - -migration_path = "migrations/auth/20221103_01_js9ub-initialise-the-auth-entic-oris-ation-database.py" - -@pytest.mark.unit_test -def test_create_users_table(auth_testdb_path): - """ - GIVEN: A database migration script to create the `users` table - WHEN: The migration is applied - THEN: Ensure that the table is created - """ - with closing(sqlite3.connect(auth_testdb_path)) as conn, closing(conn.cursor()) as cursor: - cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") - result = cursor.fetchall() - assert "users" not in [row[0] for row in cursor.fetchall()] - apply_single_migration(auth_testdb_path, get_migration(migration_path)) - cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") - assert "users" in [row[0] for row in cursor.fetchall()] - -@pytest.mark.unit_test -def test_rollback_create_users_table(auth_testdb_path): - """ - GIVEN: A database migration script to create the `users` table - WHEN: The migration is rolled back - THEN: Ensure that the `users` table no longer exists - """ - with closing(sqlite3.connect(auth_testdb_path)) as conn, closing(conn.cursor()) as cursor: - apply_single_migration(auth_testdb_path, get_migration(migration_path)) - rollback_single_migration(auth_testdb_path, get_migration(migration_path)) - cursor.execute("SELECT name FROM sqlite_schema WHERE type='table'") - assert "users" not in [row[0] for row in cursor.fetchall()] -- cgit v1.2.3