Page MenuHomeSoftware Heritage
Differential D7188

Make get_sql_for_package() return pathlib.Path objects
ClosedPublic
Actions

Authored by douardda on Feb 16 2022, 1:24 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Commits
rDCORE25fee94847d3: Make get_sql_for_package() return pathlib.Path objects
rDCORE84b63d5b1da7: Replace mock_package_sql by a mock_import_swhmodule fixture
Summary

and replace mock_package_sql by a mock_import_swhmodule fixture in favor
of using the stock get_sql_for_package() function (on the mock module
returned by mock_import_swhmodule).

This also comes with a change in expected test data structure for sql
script; the tests/data/<mod> is now expected to store the sql script
files in a dedicated sql/ sub directory instead of having them
directly in the <mod> directory so that the get_sql_for_package() can
be used in tests unmocked.

Depends on D7155

Diff Detail

Repository
rDCORE Foundations and core functionalities
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

douardda created this revision.Feb 16 2022, 1:24 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptFeb 16 2022, 1:24 PM
swh-public-ci added a comment.Feb 16 2022, 1:26 PM

Build is green

Patch application report for D7188 (id=26035)

Could not rebase; Attempt merge onto 3139d3344e...

Updating 3139d33..a06d92f
Fast-forward
 MANIFEST.in                                        |   2 +
 swh/core/cli/db.py                                 | 200 +++++++++++++-
 swh/core/db/db_utils.py                            | 293 +++++++++++++++++++--
 swh/core/db/pytest_plugin.py                       | 213 ++++++++++-----
 swh/core/db/sql/35-dbversion.sql                   |  18 ++
 swh/core/db/sql/36-dbmodule.sql                    |  15 ++
 swh/core/db/tests/conftest.py                      |  50 ++++
 .../tests/data/cli/{ => sql}/0-superuser-init.sql  |   0
 .../data/cli/{1-schema.sql => sql/30-schema.sql}   |   2 +-
 .../data/cli/{3-func.sql => sql/40-funcs.sql}      |   0
 .../tests/data/cli/{4-data.sql => sql/50-data.sql} |   2 +-
 .../db/tests/data/cli_new/sql/0-superuser-init.sql |   1 +
 swh/core/db/tests/data/cli_new/sql/30-schema.sql   |   6 +
 swh/core/db/tests/data/cli_new/sql/40-funcs.sql    |   6 +
 swh/core/db/tests/data/cli_new/sql/50-data.sql     |   2 +
 .../db/tests/data/cli_new/sql/upgrades/001.sql     |   5 +
 .../db/tests/data/cli_new/sql/upgrades/002.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/003.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/004.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/005.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/006.sql     |   7 +
 .../db/tests/pytest_plugin/test_pytest_plugin.py   |  26 +-
 swh/core/db/tests/test_cli.py                      | 214 +++++++++++----
 swh/core/db/tests/test_db_utils.py                 | 181 +++++++++++++
 swh/core/tests/test_utils.py                       |   5 +
 swh/core/utils.py                                  |   5 +
 26 files changed, 1123 insertions(+), 146 deletions(-)
 create mode 100644 swh/core/db/sql/35-dbversion.sql
 create mode 100644 swh/core/db/sql/36-dbmodule.sql
 rename swh/core/db/tests/data/cli/{ => sql}/0-superuser-init.sql (100%)
 rename swh/core/db/tests/data/cli/{1-schema.sql => sql/30-schema.sql} (87%)
 rename swh/core/db/tests/data/cli/{3-func.sql => sql/40-funcs.sql} (100%)
 rename swh/core/db/tests/data/cli/{4-data.sql => sql/50-data.sql} (73%)
 create mode 100644 swh/core/db/tests/data/cli_new/sql/0-superuser-init.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/30-schema.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/40-funcs.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/50-data.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/001.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/002.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/003.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/004.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/005.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/006.sql
 create mode 100644 swh/core/db/tests/test_db_utils.py
Changes applied before test
commit a06d92f6b608df9b057f27e2c59fc1b9785779a0
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 12:37:07 2022 +0100

    Make get_sql_for_package() return pathlib.Path objects
    
    and replace mock_package_sql by a mock_import_swhmodule fixture in favor
    of using the stock get_sql_for_package() function (on the mock module
    returned by mock_import_swhmodule).
    
    This also comes with a change in expected test data structure for sql
    script; the `tests/data/<mod>` is now expected to store the sql script
    files in a dedicated `sql/` sub directory instead of having them
    directly in the `<mod>` directory so that the get_sql_for_package() can
    be used in tests unmocked.

commit d187e7e4574bb190a3af8254ec116a89a59e34bf
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Feb 7 15:46:48 2022 +0100

    Refactor swh.core.db.pytest_plugin
    
    update the postgresql_fact fixture to be able to use new-ish
    pytest_postgresql ability to recreate databases between tests from a
    template database.
    
    The ides is to stop using the fragile and confusing "reset" of the
    database between tests, which means de facto keep a stateful database
    between tests, which make tests result depend on de facto order of
    execution of these tests.
    
    For example, test_smoke_test_people_db_up_and_reset cannot be executed
    alone, since it depends on the fact test_smoke_test_people_db_up has
    been executed before so that the people's db has been reset as a result
    of the test setup done by the fixture, which will happen if and only if
    the database already exists (thus if another test using this db has been
    executed before in this test session).
    
    The old table truncate based behavior has been kept (using a no_db_drop
    flag argument) in this diff for bw compatibility reasons, and also because
    the new drop-and-create-from-template beahvior remains a bit slower,
    which might be a problem for some test cases.
    
    Tests for dependencies (swh-storage, etc.) should still pass with this
    refactoring, but will be significantly slower.
    
    A series of revisions for these dependencies is about to be proposed to
    adapt them to the new db metadata (version, module, flavor) handling
    feature coming with swh.core 2, as well as updating their tests to take
    advantage of the template-based db creation in tests, which should bring
    back test execution time to almost the same as before this refactoring.
    
    This is needed to be able to implement and test support for the new 'swh
    db upgrade' all this is actually about.

commit dfa01610264a925ba02e33c6f2401d34fd34ec18
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 15:43:09 2022 +0100

    Add a 'swh db upgrade' command
    
    this new command allows to handle the database migration from the
    current version to the latest version advertized but the backend
    datastore.
    
    Thie feature is only working for "new style" swh.core.db based
    datastores.

commit 544e184045403c735c33e6029f8bb7fa1a4df5cb
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 14:51:43 2022 +0100

    Make 'swh db init' fill the dbversion table
    
    for this feature to work properly, the backend datastore package must
    provide the 'get_datastore' factory function in its root namespace and
    the datastore instance must provide a 'get_current_version()' method.
    
    This also means the canonical cli usage for the `swh db init` is now
    using the config file (via `--config-file` or `SWH_CONFIG_FILENAME`)
    instead of giving only the db cnx string (`--db-name`), so that the
    backend datastore class can be instanciated using the `get_datastore()`
    factory function.
    
    However a '--initial-version' cli option has been added to 'swh db init'
    to make it easier, especially for unit tests.

commit adeb54f770209284f0924a7e4d5bd5977a567527
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 17:54:01 2022 +0100

    Use a standard postgresql db fixture in test_cli
    
    instead of a custom 'test_db' (which did not truncate dbversion and
    origin tables, not sure what the intent was for this).

commit d50695c3feb57b1e21d93e78364a943232fe91ff
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 15:02:51 2022 +0100

    Add support for dbversion and dbmodule handling in swh db init
    
    for now, managing the dbversion table (storing the db schema upgrade
    history) is partially the responsibility of the swh modules implementing
    a datastore (swh-storage etc.), and the actual swh module was not stored
    in the database.
    
    This adds support for both the dbversion and dbmodule tables management
    in swh.core.db.
    
    The `swh db init` command now creates both these tables and initialize
    their values if possible.
    For this, it introduces a new common "API" for swh.core.db based datastores:
    
    - a swh module implementing a datastore is expected to have a
      `get_datastore` function in its top namespace; this function is
      typically the actual `get_storage`, `get_scheduler` etc. functions
    - this factory function is expected to use the "postgresql" cls for the
      datastore based on swh.core.db,
    - the datastore instance (eg. instance of the swh.storage.postgresql.Storage
      class) is expected to have a `get_current_version()` method (returning
      an int).
    
    This revision also provides a new `swh db version` command displaying
    the current (code) version (if available), the db version (possibly the whole
    version history) and flavor (if any) for the datastore given as argument.
    
    It should be backward compatible with existing swh datastore modules (i.e.
    not yet adapted to this new API).

commit b1e449fd91ebcc403966a79fd62d449921fcf550
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 16:00:43 2022 +0100

    Refactor the mock_package_sql fixture to allow multiple sql script set
    
    will be used to implement several test scenarios in following commits.
    Also rename existing sql scripts with a "legit" numbering scheme.

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/326/ for more details.

Harbormaster completed remote builds in B26904: Diff 26035.Feb 16 2022, 1:26 PM
douardda requested review of this revision.Feb 16 2022, 1:26 PM
douardda added a child revision: D7159: Add a documentation section for swh.core.db.Feb 16 2022, 1:26 PM
douardda updated this revision to Diff 26042.Feb 16 2022, 2:03 PM

rebase

douardda mentioned this in D7064: Add a 'swh db upgrade' command.Feb 16 2022, 2:05 PM
swh-public-ci added a comment.Feb 16 2022, 2:05 PM

Build is green

Patch application report for D7188 (id=26042)

Could not rebase; Attempt merge onto 3139d3344e...

Updating 3139d33..ef48c77
Fast-forward
 MANIFEST.in                                        |   2 +
 swh/core/cli/db.py                                 | 200 +++++++++++++-
 swh/core/db/db_utils.py                            | 298 +++++++++++++++++++--
 swh/core/db/pytest_plugin.py                       | 213 ++++++++++-----
 swh/core/db/sql/35-dbversion.sql                   |  18 ++
 swh/core/db/sql/36-dbmodule.sql                    |  15 ++
 swh/core/db/tests/conftest.py                      |  50 ++++
 .../tests/data/cli/{ => sql}/0-superuser-init.sql  |   0
 .../data/cli/{1-schema.sql => sql/30-schema.sql}   |   2 +-
 .../data/cli/{3-func.sql => sql/40-funcs.sql}      |   0
 .../tests/data/cli/{4-data.sql => sql/50-data.sql} |   2 +-
 .../db/tests/data/cli_new/sql/0-superuser-init.sql |   1 +
 swh/core/db/tests/data/cli_new/sql/30-schema.sql   |   6 +
 swh/core/db/tests/data/cli_new/sql/40-funcs.sql    |   6 +
 swh/core/db/tests/data/cli_new/sql/50-data.sql     |   2 +
 .../db/tests/data/cli_new/sql/upgrades/001.sql     |   5 +
 .../db/tests/data/cli_new/sql/upgrades/002.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/003.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/004.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/005.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/006.sql     |   7 +
 .../db/tests/pytest_plugin/test_pytest_plugin.py   |  26 +-
 swh/core/db/tests/test_cli.py                      | 214 +++++++++++----
 swh/core/db/tests/test_db_utils.py                 | 181 +++++++++++++
 swh/core/tests/test_utils.py                       |   5 +
 swh/core/utils.py                                  |   5 +
 26 files changed, 1128 insertions(+), 146 deletions(-)
 create mode 100644 swh/core/db/sql/35-dbversion.sql
 create mode 100644 swh/core/db/sql/36-dbmodule.sql
 rename swh/core/db/tests/data/cli/{ => sql}/0-superuser-init.sql (100%)
 rename swh/core/db/tests/data/cli/{1-schema.sql => sql/30-schema.sql} (87%)
 rename swh/core/db/tests/data/cli/{3-func.sql => sql/40-funcs.sql} (100%)
 rename swh/core/db/tests/data/cli/{4-data.sql => sql/50-data.sql} (73%)
 create mode 100644 swh/core/db/tests/data/cli_new/sql/0-superuser-init.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/30-schema.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/40-funcs.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/50-data.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/001.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/002.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/003.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/004.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/005.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/006.sql
 create mode 100644 swh/core/db/tests/test_db_utils.py
Changes applied before test
commit ef48c771fe9ef7f797ecc49672e4aa470b1e3a1f
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 12:37:07 2022 +0100

    Make get_sql_for_package() return pathlib.Path objects
    
    and replace mock_package_sql by a mock_import_swhmodule fixture in favor
    of using the stock get_sql_for_package() function (on the mock module
    returned by mock_import_swhmodule).
    
    This also comes with a change in expected test data structure for sql
    script; the `tests/data/<mod>` is now expected to store the sql script
    files in a dedicated `sql/` sub directory instead of having them
    directly in the `<mod>` directory so that the get_sql_for_package() can
    be used in tests unmocked.

commit 9e599f03076f85b44ac0eb5d001ff6367a930276
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Feb 7 15:46:48 2022 +0100

    Refactor swh.core.db.pytest_plugin
    
    update the postgresql_fact fixture to be able to use new-ish
    pytest_postgresql ability to recreate databases between tests from a
    template database.
    
    The ides is to stop using the fragile and confusing "reset" of the
    database between tests, which means de facto keep a stateful database
    between tests, which make tests result depend on de facto order of
    execution of these tests.
    
    For example, test_smoke_test_people_db_up_and_reset cannot be executed
    alone, since it depends on the fact test_smoke_test_people_db_up has
    been executed before so that the people's db has been reset as a result
    of the test setup done by the fixture, which will happen if and only if
    the database already exists (thus if another test using this db has been
    executed before in this test session).
    
    The old table truncate based behavior has been kept (using a no_db_drop
    flag argument) in this diff for bw compatibility reasons, and also because
    the new drop-and-create-from-template beahvior remains a bit slower,
    which might be a problem for some test cases.
    
    Tests for dependencies (swh-storage, etc.) should still pass with this
    refactoring, but will be significantly slower.
    
    A series of revisions for these dependencies is about to be proposed to
    adapt them to the new db metadata (version, module, flavor) handling
    feature coming with swh.core 2, as well as updating their tests to take
    advantage of the template-based db creation in tests, which should bring
    back test execution time to almost the same as before this refactoring.
    
    This is needed to be able to implement and test support for the new 'swh
    db upgrade' all this is actually about.

commit 1a187ca7787503d41ac13b2678b29f332d8fd200
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 15:43:09 2022 +0100

    Add a 'swh db upgrade' command
    
    this new command allows to handle the database migration from the
    current version to the latest version advertized but the backend
    datastore.
    
    Thie feature is only working for "new style" swh.core.db based
    datastores.

commit 544e184045403c735c33e6029f8bb7fa1a4df5cb
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 14:51:43 2022 +0100

    Make 'swh db init' fill the dbversion table
    
    for this feature to work properly, the backend datastore package must
    provide the 'get_datastore' factory function in its root namespace and
    the datastore instance must provide a 'get_current_version()' method.
    
    This also means the canonical cli usage for the `swh db init` is now
    using the config file (via `--config-file` or `SWH_CONFIG_FILENAME`)
    instead of giving only the db cnx string (`--db-name`), so that the
    backend datastore class can be instanciated using the `get_datastore()`
    factory function.
    
    However a '--initial-version' cli option has been added to 'swh db init'
    to make it easier, especially for unit tests.

commit adeb54f770209284f0924a7e4d5bd5977a567527
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 17:54:01 2022 +0100

    Use a standard postgresql db fixture in test_cli
    
    instead of a custom 'test_db' (which did not truncate dbversion and
    origin tables, not sure what the intent was for this).

commit d50695c3feb57b1e21d93e78364a943232fe91ff
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 15:02:51 2022 +0100

    Add support for dbversion and dbmodule handling in swh db init
    
    for now, managing the dbversion table (storing the db schema upgrade
    history) is partially the responsibility of the swh modules implementing
    a datastore (swh-storage etc.), and the actual swh module was not stored
    in the database.
    
    This adds support for both the dbversion and dbmodule tables management
    in swh.core.db.
    
    The `swh db init` command now creates both these tables and initialize
    their values if possible.
    For this, it introduces a new common "API" for swh.core.db based datastores:
    
    - a swh module implementing a datastore is expected to have a
      `get_datastore` function in its top namespace; this function is
      typically the actual `get_storage`, `get_scheduler` etc. functions
    - this factory function is expected to use the "postgresql" cls for the
      datastore based on swh.core.db,
    - the datastore instance (eg. instance of the swh.storage.postgresql.Storage
      class) is expected to have a `get_current_version()` method (returning
      an int).
    
    This revision also provides a new `swh db version` command displaying
    the current (code) version (if available), the db version (possibly the whole
    version history) and flavor (if any) for the datastore given as argument.
    
    It should be backward compatible with existing swh datastore modules (i.e.
    not yet adapted to this new API).

commit b1e449fd91ebcc403966a79fd62d449921fcf550
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 16:00:43 2022 +0100

    Refactor the mock_package_sql fixture to allow multiple sql script set
    
    will be used to implement several test scenarios in following commits.
    Also rename existing sql scripts with a "legit" numbering scheme.

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/333/ for more details.

Harbormaster completed remote builds in B26911: Diff 26042.Feb 16 2022, 2:05 PM
vlorentz added a subscriber: vlorentz.Feb 16 2022, 2:16 PM

This also comes with a change in expected test data structure for sql script

please mention this in the first line of the commit msg (or ideally, in a separate commit)

vlorentz accepted this revision.Feb 16 2022, 2:17 PM

oh I missed that's only for test files. alright then. thanks!

This revision is now accepted and ready to land.Feb 16 2022, 2:17 PM
ardumont added a subscriber: ardumont.Feb 16 2022, 2:21 PM
ardumont added inline comments.
swh/core/db/db_utils.py
501
douardda updated this revision to Diff 26046.Feb 16 2022, 2:26 PM

rebase

swh-public-ci added a comment.Feb 16 2022, 2:29 PM

Build is green

Patch application report for D7188 (id=26046)

Could not rebase; Attempt merge onto 3139d3344e...

Updating 3139d33..9e6f8fd
Fast-forward
 MANIFEST.in                                        |   2 +
 swh/core/cli/db.py                                 | 200 +++++++++++++-
 swh/core/db/db_utils.py                            | 298 +++++++++++++++++++--
 swh/core/db/pytest_plugin.py                       | 230 +++++++++++-----
 swh/core/db/sql/35-dbversion.sql                   |  18 ++
 swh/core/db/sql/36-dbmodule.sql                    |  15 ++
 swh/core/db/tests/conftest.py                      |  50 ++++
 .../tests/data/cli/{ => sql}/0-superuser-init.sql  |   0
 .../data/cli/{1-schema.sql => sql/30-schema.sql}   |   2 +-
 .../data/cli/{3-func.sql => sql/40-funcs.sql}      |   0
 .../tests/data/cli/{4-data.sql => sql/50-data.sql} |   2 +-
 .../db/tests/data/cli_new/sql/0-superuser-init.sql |   1 +
 swh/core/db/tests/data/cli_new/sql/30-schema.sql   |   6 +
 swh/core/db/tests/data/cli_new/sql/40-funcs.sql    |   6 +
 swh/core/db/tests/data/cli_new/sql/50-data.sql     |   2 +
 .../db/tests/data/cli_new/sql/upgrades/001.sql     |   5 +
 .../db/tests/data/cli_new/sql/upgrades/002.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/003.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/004.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/005.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/006.sql     |   7 +
 .../db/tests/pytest_plugin/test_pytest_plugin.py   |  26 +-
 swh/core/db/tests/test_cli.py                      | 214 +++++++++++----
 swh/core/db/tests/test_db_utils.py                 | 181 +++++++++++++
 swh/core/tests/test_utils.py                       |   5 +
 swh/core/utils.py                                  |   5 +
 26 files changed, 1144 insertions(+), 147 deletions(-)
 create mode 100644 swh/core/db/sql/35-dbversion.sql
 create mode 100644 swh/core/db/sql/36-dbmodule.sql
 rename swh/core/db/tests/data/cli/{ => sql}/0-superuser-init.sql (100%)
 rename swh/core/db/tests/data/cli/{1-schema.sql => sql/30-schema.sql} (87%)
 rename swh/core/db/tests/data/cli/{3-func.sql => sql/40-funcs.sql} (100%)
 rename swh/core/db/tests/data/cli/{4-data.sql => sql/50-data.sql} (73%)
 create mode 100644 swh/core/db/tests/data/cli_new/sql/0-superuser-init.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/30-schema.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/40-funcs.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/50-data.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/001.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/002.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/003.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/004.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/005.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/006.sql
 create mode 100644 swh/core/db/tests/test_db_utils.py
Changes applied before test
commit 9e6f8fd036c86602be5f7c7d7df6c3836006aff5
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 12:37:07 2022 +0100

    Make get_sql_for_package() return pathlib.Path objects
    
    and replace mock_package_sql by a mock_import_swhmodule fixture in favor
    of using the stock get_sql_for_package() function (on the mock module
    returned by mock_import_swhmodule).
    
    This also comes with a change in expected test data structure for sql
    script; the `tests/data/<mod>` is now expected to store the sql script
    files in a dedicated `sql/` sub directory instead of having them
    directly in the `<mod>` directory so that the get_sql_for_package() can
    be used in tests unmocked.

commit 447027525f976aec9ef117a4502e6495da0628eb
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Feb 7 15:46:48 2022 +0100

    Refactor swh.core.db.pytest_plugin
    
    update the postgresql_fact fixture to be able to use new-ish
    pytest_postgresql ability to recreate databases between tests from a
    template database.
    
    The ides is to stop using the fragile and confusing "reset" of the
    database between tests, which means de facto keep a stateful database
    between tests, which make tests result depend on de facto order of
    execution of these tests.
    
    For example, test_smoke_test_people_db_up_and_reset cannot be executed
    alone, since it depends on the fact test_smoke_test_people_db_up has
    been executed before so that the people's db has been reset as a result
    of the test setup done by the fixture, which will happen if and only if
    the database already exists (thus if another test using this db has been
    executed before in this test session).
    
    The old table truncate based behavior has been kept (using a no_db_drop
    flag argument) in this diff for bw compatibility reasons, and also because
    the new drop-and-create-from-template beahvior remains a bit slower,
    which might be a problem for some test cases.
    
    Tests for dependencies (swh-storage, etc.) should still pass with this
    refactoring, but will be significantly slower.
    
    A series of revisions for these dependencies is about to be proposed to
    adapt them to the new db metadata (version, module, flavor) handling
    feature coming with swh.core 2, as well as updating their tests to take
    advantage of the template-based db creation in tests, which should bring
    back test execution time to almost the same as before this refactoring.
    
    This is needed to be able to implement and test support for the new 'swh
    db upgrade' all this is actually about.

commit 1a187ca7787503d41ac13b2678b29f332d8fd200
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 15:43:09 2022 +0100

    Add a 'swh db upgrade' command
    
    this new command allows to handle the database migration from the
    current version to the latest version advertized but the backend
    datastore.
    
    Thie feature is only working for "new style" swh.core.db based
    datastores.

commit 544e184045403c735c33e6029f8bb7fa1a4df5cb
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 14:51:43 2022 +0100

    Make 'swh db init' fill the dbversion table
    
    for this feature to work properly, the backend datastore package must
    provide the 'get_datastore' factory function in its root namespace and
    the datastore instance must provide a 'get_current_version()' method.
    
    This also means the canonical cli usage for the `swh db init` is now
    using the config file (via `--config-file` or `SWH_CONFIG_FILENAME`)
    instead of giving only the db cnx string (`--db-name`), so that the
    backend datastore class can be instanciated using the `get_datastore()`
    factory function.
    
    However a '--initial-version' cli option has been added to 'swh db init'
    to make it easier, especially for unit tests.

commit adeb54f770209284f0924a7e4d5bd5977a567527
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 17:54:01 2022 +0100

    Use a standard postgresql db fixture in test_cli
    
    instead of a custom 'test_db' (which did not truncate dbversion and
    origin tables, not sure what the intent was for this).

commit d50695c3feb57b1e21d93e78364a943232fe91ff
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 15:02:51 2022 +0100

    Add support for dbversion and dbmodule handling in swh db init
    
    for now, managing the dbversion table (storing the db schema upgrade
    history) is partially the responsibility of the swh modules implementing
    a datastore (swh-storage etc.), and the actual swh module was not stored
    in the database.
    
    This adds support for both the dbversion and dbmodule tables management
    in swh.core.db.
    
    The `swh db init` command now creates both these tables and initialize
    their values if possible.
    For this, it introduces a new common "API" for swh.core.db based datastores:
    
    - a swh module implementing a datastore is expected to have a
      `get_datastore` function in its top namespace; this function is
      typically the actual `get_storage`, `get_scheduler` etc. functions
    - this factory function is expected to use the "postgresql" cls for the
      datastore based on swh.core.db,
    - the datastore instance (eg. instance of the swh.storage.postgresql.Storage
      class) is expected to have a `get_current_version()` method (returning
      an int).
    
    This revision also provides a new `swh db version` command displaying
    the current (code) version (if available), the db version (possibly the whole
    version history) and flavor (if any) for the datastore given as argument.
    
    It should be backward compatible with existing swh datastore modules (i.e.
    not yet adapted to this new API).

commit b1e449fd91ebcc403966a79fd62d449921fcf550
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 16:00:43 2022 +0100

    Refactor the mock_package_sql fixture to allow multiple sql script set
    
    will be used to implement several test scenarios in following commits.
    Also rename existing sql scripts with a "legit" numbering scheme.

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/337/ for more details.

Harbormaster completed remote builds in B26915: Diff 26046.Feb 16 2022, 2:29 PM
douardda updated this revision to Diff 26054.Feb 16 2022, 3:06 PM

rebase

swh-public-ci added a comment.Feb 16 2022, 3:08 PM

Build is green

Patch application report for D7188 (id=26054)

Could not rebase; Attempt merge onto 3139d3344e...

Updating 3139d33..106b227
Fast-forward
 MANIFEST.in                                        |   2 +
 swh/core/cli/db.py                                 | 202 +++++++++++++-
 swh/core/db/db_utils.py                            | 300 +++++++++++++++++++--
 swh/core/db/pytest_plugin.py                       | 230 +++++++++++-----
 swh/core/db/sql/35-dbversion.sql                   |  18 ++
 swh/core/db/sql/36-dbmodule.sql                    |  15 ++
 swh/core/db/tests/conftest.py                      |  55 ++++
 .../tests/data/cli/{ => sql}/0-superuser-init.sql  |   0
 .../data/cli/{1-schema.sql => sql/30-schema.sql}   |   2 +-
 .../data/cli/{3-func.sql => sql/40-funcs.sql}      |   0
 .../tests/data/cli/{4-data.sql => sql/50-data.sql} |   2 +-
 .../db/tests/data/cli_new/sql/0-superuser-init.sql |   1 +
 swh/core/db/tests/data/cli_new/sql/30-schema.sql   |   6 +
 swh/core/db/tests/data/cli_new/sql/40-funcs.sql    |   6 +
 swh/core/db/tests/data/cli_new/sql/50-data.sql     |   2 +
 .../db/tests/data/cli_new/sql/upgrades/001.sql     |   5 +
 .../db/tests/data/cli_new/sql/upgrades/002.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/003.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/004.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/005.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/006.sql     |   7 +
 .../db/tests/pytest_plugin/test_pytest_plugin.py   |  26 +-
 swh/core/db/tests/test_cli.py                      | 210 +++++++++++----
 swh/core/db/tests/test_db_utils.py                 | 189 +++++++++++++
 swh/core/tests/test_utils.py                       |   5 +
 swh/core/utils.py                                  |   5 +
 26 files changed, 1154 insertions(+), 150 deletions(-)
 create mode 100644 swh/core/db/sql/35-dbversion.sql
 create mode 100644 swh/core/db/sql/36-dbmodule.sql
 rename swh/core/db/tests/data/cli/{ => sql}/0-superuser-init.sql (100%)
 rename swh/core/db/tests/data/cli/{1-schema.sql => sql/30-schema.sql} (87%)
 rename swh/core/db/tests/data/cli/{3-func.sql => sql/40-funcs.sql} (100%)
 rename swh/core/db/tests/data/cli/{4-data.sql => sql/50-data.sql} (73%)
 create mode 100644 swh/core/db/tests/data/cli_new/sql/0-superuser-init.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/30-schema.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/40-funcs.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/50-data.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/001.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/002.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/003.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/004.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/005.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/006.sql
 create mode 100644 swh/core/db/tests/test_db_utils.py
Changes applied before test
commit 106b22771617808e72c9813b94b6153a6cffd12f
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 12:37:07 2022 +0100

    Make get_sql_for_package() return pathlib.Path objects
    
    and replace mock_package_sql by a mock_import_swhmodule fixture in favor
    of using the stock get_sql_for_package() function (on the mock module
    returned by mock_import_swhmodule).
    
    This also comes with a change in expected test data structure for sql
    script; the `tests/data/<mod>` is now expected to store the sql script
    files in a dedicated `sql/` sub directory instead of having them
    directly in the `<mod>` directory so that the get_sql_for_package() can
    be used in tests unmocked.

commit 1c5c9f37155be12fe5589c5ba65bf894990e2103
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Feb 7 15:46:48 2022 +0100

    Refactor swh.core.db.pytest_plugin
    
    update the postgresql_fact fixture to be able to use new-ish
    pytest_postgresql ability to recreate databases between tests from a
    template database.
    
    The ides is to stop using the fragile and confusing "reset" of the
    database between tests, which means de facto keep a stateful database
    between tests, which make tests result depend on de facto order of
    execution of these tests.
    
    For example, test_smoke_test_people_db_up_and_reset cannot be executed
    alone, since it depends on the fact test_smoke_test_people_db_up has
    been executed before so that the people's db has been reset as a result
    of the test setup done by the fixture, which will happen if and only if
    the database already exists (thus if another test using this db has been
    executed before in this test session).
    
    The old table truncate based behavior has been kept (using a no_db_drop
    flag argument) in this diff for bw compatibility reasons, and also because
    the new drop-and-create-from-template beahvior remains a bit slower,
    which might be a problem for some test cases.
    
    Tests for dependencies (swh-storage, etc.) should still pass with this
    refactoring, but will be significantly slower.
    
    A series of revisions for these dependencies is about to be proposed to
    adapt them to the new db metadata (version, module, flavor) handling
    feature coming with swh.core 2, as well as updating their tests to take
    advantage of the template-based db creation in tests, which should bring
    back test execution time to almost the same as before this refactoring.
    
    This is needed to be able to implement and test support for the new 'swh
    db upgrade' all this is actually about.

commit c17d64f5884a148a3656c1b0993e3dcf30c4fb56
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 15:43:09 2022 +0100

    Add a 'swh db upgrade' command
    
    this new command allows to handle the database migration from the
    current version to the latest version advertized but the backend
    datastore.
    
    This feature is only working for "new style" swh.core.db based
    datastores.

commit 7e07b1f363269dc0bdcf3c1e7070ff0c0bacfdc6
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 14:51:43 2022 +0100

    Make 'swh db init' fill the dbversion table
    
    for this feature to work properly, the backend datastore package must
    provide the 'get_datastore' factory function in its root namespace and
    the datastore instance must provide a 'get_current_version()' method.
    
    This also means the canonical cli usage for the `swh db init` is now
    using the config file (via `--config-file` or `SWH_CONFIG_FILENAME`)
    instead of giving only the db cnx string (`--db-name`), so that the
    backend datastore class can be instanciated using the `get_datastore()`
    factory function.
    
    However a '--initial-version' cli option has been added to 'swh db init'
    to make it easier, especially for unit tests.

commit f8a07dfa0bf668905d66ad88b25b2e1f3f569177
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 17:54:01 2022 +0100

    Use a standard postgresql db fixture in test_cli
    
    instead of a custom 'test_db' (which did not truncate dbversion and
    origin tables, not sure what the intent was for this).

commit c4bd270c3000df52176dafbf5c7f16e283e918c8
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 15:02:51 2022 +0100

    Add support for dbversion and dbmodule handling in swh db init
    
    for now, managing the dbversion table (storing the db schema upgrade
    history) is partially the responsibility of the swh modules implementing
    a datastore (swh-storage etc.), and the actual swh module was not stored
    in the database.
    
    This adds support for both the dbversion and dbmodule tables management
    in swh.core.db.
    
    The `swh db init` command now creates both these tables and initialize
    their values if possible.
    For this, it introduces a new common "API" for swh.core.db based datastores:
    
    - a swh module implementing a datastore is expected to have a
      `get_datastore` function in its top namespace; this function is
      typically the actual `get_storage`, `get_scheduler` etc. functions
    - this factory function is expected to use the "postgresql" cls for the
      datastore based on swh.core.db,
    - the datastore instance (eg. instance of the swh.storage.postgresql.Storage
      class) is expected to have a `get_current_version()` method (returning
      an int).
    
    This revision also provides a new `swh db version` command displaying
    the current (code) version (if available), the db version (possibly the whole
    version history) and flavor (if any) for the datastore given as argument.
    
    It should be backward compatible with existing swh datastore modules (i.e.
    not yet adapted to this new API).

commit b1e449fd91ebcc403966a79fd62d449921fcf550
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 16:00:43 2022 +0100

    Refactor the mock_package_sql fixture to allow multiple sql script set
    
    will be used to implement several test scenarios in following commits.
    Also rename existing sql scripts with a "legit" numbering scheme.

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/345/ for more details.

Harbormaster completed remote builds in B26923: Diff 26054.Feb 16 2022, 3:08 PM
douardda added a comment.Feb 16 2022, 3:11 PM
In D7188#186977, @vlorentz wrote:

This also comes with a change in expected test data structure for sql script

please mention this in the first line of the commit msg (or ideally, in a separate commit)

ikr (but I'm a bit tired of this stack... and I might not be the only one :-) )

douardda marked an inline comment as done.Feb 16 2022, 3:14 PM
douardda updated this revision to Diff 26062.Feb 16 2022, 3:57 PM

split the git revision in 2

(but too lazy to also split the Diff... sorry)

swh-public-ci added a comment.Feb 16 2022, 3:59 PM

Build is green

Patch application report for D7188 (id=26062)

Could not rebase; Attempt merge onto 3139d3344e...

Updating 3139d33..9a0c069
Fast-forward
 MANIFEST.in                                        |   2 +
 swh/core/cli/db.py                                 | 202 +++++++++++++-
 swh/core/db/db_utils.py                            | 300 +++++++++++++++++++--
 swh/core/db/pytest_plugin.py                       | 230 +++++++++++-----
 swh/core/db/sql/35-dbversion.sql                   |  18 ++
 swh/core/db/sql/36-dbmodule.sql                    |  15 ++
 swh/core/db/tests/conftest.py                      |  55 ++++
 .../tests/data/cli/{ => sql}/0-superuser-init.sql  |   0
 .../data/cli/{1-schema.sql => sql/30-schema.sql}   |   2 +-
 .../data/cli/{3-func.sql => sql/40-funcs.sql}      |   0
 .../tests/data/cli/{4-data.sql => sql/50-data.sql} |   2 +-
 .../db/tests/data/cli_new/sql/0-superuser-init.sql |   1 +
 swh/core/db/tests/data/cli_new/sql/30-schema.sql   |   6 +
 swh/core/db/tests/data/cli_new/sql/40-funcs.sql    |   6 +
 swh/core/db/tests/data/cli_new/sql/50-data.sql     |   2 +
 .../db/tests/data/cli_new/sql/upgrades/001.sql     |   5 +
 .../db/tests/data/cli_new/sql/upgrades/002.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/003.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/004.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/005.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/006.sql     |   7 +
 .../db/tests/pytest_plugin/test_pytest_plugin.py   |  26 +-
 swh/core/db/tests/test_cli.py                      | 210 +++++++++++----
 swh/core/db/tests/test_db_utils.py                 | 189 +++++++++++++
 swh/core/tests/test_utils.py                       |   5 +
 swh/core/utils.py                                  |   5 +
 26 files changed, 1154 insertions(+), 150 deletions(-)
 create mode 100644 swh/core/db/sql/35-dbversion.sql
 create mode 100644 swh/core/db/sql/36-dbmodule.sql
 rename swh/core/db/tests/data/cli/{ => sql}/0-superuser-init.sql (100%)
 rename swh/core/db/tests/data/cli/{1-schema.sql => sql/30-schema.sql} (87%)
 rename swh/core/db/tests/data/cli/{3-func.sql => sql/40-funcs.sql} (100%)
 rename swh/core/db/tests/data/cli/{4-data.sql => sql/50-data.sql} (73%)
 create mode 100644 swh/core/db/tests/data/cli_new/sql/0-superuser-init.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/30-schema.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/40-funcs.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/50-data.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/001.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/002.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/003.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/004.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/005.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/006.sql
 create mode 100644 swh/core/db/tests/test_db_utils.py
Changes applied before test
commit 9a0c06981df822c9319e5e31cc32acac13425670
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 15:31:30 2022 +0100

    Replace mock_package_sql by a mock_import_swhmodule fixture
    
    in favor of using (and thus testing) the stock get_sql_for_package()
    function (on the mock module returned by mock_import_swhmodule).
    
    This comes with a change in expected test data structure for sql
    script; the `tests/data/<mod>` is now expected to store the sql script
    files in a dedicated `sql/` sub directory instead of having them
    directly in the `<mod>` directory so that the get_sql_for_package() can
    be used in tests unmocked.

commit b429a72c60984994b95e762f4bf3316ab466ced0
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 12:37:07 2022 +0100

    Make get_sql_for_package() return pathlib.Path objects

commit c11a4269ea967527c2e3424078288ab228b43eac
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Feb 7 15:46:48 2022 +0100

    Refactor swh.core.db.pytest_plugin
    
    update the postgresql_fact fixture to be able to use new-ish
    pytest_postgresql ability to recreate databases between tests from a
    template database.
    
    The ides is to stop using the fragile and confusing "reset" of the
    database between tests, which means de facto keep a stateful database
    between tests, which make tests result depend on de facto order of
    execution of these tests.
    
    For example, test_smoke_test_people_db_up_and_reset cannot be executed
    alone, since it depends on the fact test_smoke_test_people_db_up has
    been executed before so that the people's db has been reset as a result
    of the test setup done by the fixture, which will happen if and only if
    the database already exists (thus if another test using this db has been
    executed before in this test session).
    
    The old table truncate based behavior has been kept (using a no_db_drop
    flag argument) in this diff for bw compatibility reasons, and also because
    the new drop-and-create-from-template beahvior remains a bit slower,
    which might be a problem for some test cases.
    
    Tests for dependencies (swh-storage, etc.) should still pass with this
    refactoring, but will be significantly slower.
    
    A series of revisions for these dependencies is about to be proposed to
    adapt them to the new db metadata (version, module, flavor) handling
    feature coming with swh.core 2, as well as updating their tests to take
    advantage of the template-based db creation in tests, which should bring
    back test execution time to almost the same as before this refactoring.
    
    This is needed to be able to implement and test support for the new 'swh
    db upgrade' all this is actually about.

commit 16e2fd4992efa439f074e11be4198cf5b0053aff
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 15:43:09 2022 +0100

    Add a 'swh db upgrade' command
    
    this new command allows to handle the database migration from the
    current version to the latest version advertized but the backend
    datastore.
    
    This feature is only working for "new style" swh.core.db based
    datastores.

commit 7e07b1f363269dc0bdcf3c1e7070ff0c0bacfdc6
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 14:51:43 2022 +0100

    Make 'swh db init' fill the dbversion table
    
    for this feature to work properly, the backend datastore package must
    provide the 'get_datastore' factory function in its root namespace and
    the datastore instance must provide a 'get_current_version()' method.
    
    This also means the canonical cli usage for the `swh db init` is now
    using the config file (via `--config-file` or `SWH_CONFIG_FILENAME`)
    instead of giving only the db cnx string (`--db-name`), so that the
    backend datastore class can be instanciated using the `get_datastore()`
    factory function.
    
    However a '--initial-version' cli option has been added to 'swh db init'
    to make it easier, especially for unit tests.

commit f8a07dfa0bf668905d66ad88b25b2e1f3f569177
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 17:54:01 2022 +0100

    Use a standard postgresql db fixture in test_cli
    
    instead of a custom 'test_db' (which did not truncate dbversion and
    origin tables, not sure what the intent was for this).

commit c4bd270c3000df52176dafbf5c7f16e283e918c8
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 15:02:51 2022 +0100

    Add support for dbversion and dbmodule handling in swh db init
    
    for now, managing the dbversion table (storing the db schema upgrade
    history) is partially the responsibility of the swh modules implementing
    a datastore (swh-storage etc.), and the actual swh module was not stored
    in the database.
    
    This adds support for both the dbversion and dbmodule tables management
    in swh.core.db.
    
    The `swh db init` command now creates both these tables and initialize
    their values if possible.
    For this, it introduces a new common "API" for swh.core.db based datastores:
    
    - a swh module implementing a datastore is expected to have a
      `get_datastore` function in its top namespace; this function is
      typically the actual `get_storage`, `get_scheduler` etc. functions
    - this factory function is expected to use the "postgresql" cls for the
      datastore based on swh.core.db,
    - the datastore instance (eg. instance of the swh.storage.postgresql.Storage
      class) is expected to have a `get_current_version()` method (returning
      an int).
    
    This revision also provides a new `swh db version` command displaying
    the current (code) version (if available), the db version (possibly the whole
    version history) and flavor (if any) for the datastore given as argument.
    
    It should be backward compatible with existing swh datastore modules (i.e.
    not yet adapted to this new API).

commit b1e449fd91ebcc403966a79fd62d449921fcf550
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 16:00:43 2022 +0100

    Refactor the mock_package_sql fixture to allow multiple sql script set
    
    will be used to implement several test scenarios in following commits.
    Also rename existing sql scripts with a "legit" numbering scheme.

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/350/ for more details.

Harbormaster completed remote builds in B26930: Diff 26062.Feb 16 2022, 3:59 PM
douardda updated this revision to Diff 26066.Feb 16 2022, 4:07 PM

rebase

swh-public-ci added a comment.Feb 16 2022, 4:09 PM

Build is green

Patch application report for D7188 (id=26066)

Could not rebase; Attempt merge onto 3139d3344e...

Updating 3139d33..6a88f4d
Fast-forward
 MANIFEST.in                                        |   2 +
 swh/core/cli/db.py                                 | 202 +++++++++++++-
 swh/core/db/db_utils.py                            | 300 +++++++++++++++++++--
 swh/core/db/pytest_plugin.py                       | 230 +++++++++++-----
 swh/core/db/sql/35-dbversion.sql                   |  18 ++
 swh/core/db/sql/36-dbmodule.sql                    |  15 ++
 swh/core/db/tests/conftest.py                      |  55 ++++
 .../tests/data/cli/{ => sql}/0-superuser-init.sql  |   0
 .../data/cli/{1-schema.sql => sql/30-schema.sql}   |   2 +-
 .../data/cli/{3-func.sql => sql/40-funcs.sql}      |   0
 .../tests/data/cli/{4-data.sql => sql/50-data.sql} |   2 +-
 .../db/tests/data/cli_new/sql/0-superuser-init.sql |   1 +
 swh/core/db/tests/data/cli_new/sql/30-schema.sql   |   6 +
 swh/core/db/tests/data/cli_new/sql/40-funcs.sql    |   6 +
 swh/core/db/tests/data/cli_new/sql/50-data.sql     |   2 +
 .../db/tests/data/cli_new/sql/upgrades/001.sql     |   5 +
 .../db/tests/data/cli_new/sql/upgrades/002.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/003.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/004.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/005.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/006.sql     |   7 +
 .../db/tests/pytest_plugin/test_pytest_plugin.py   |  26 +-
 swh/core/db/tests/test_cli.py                      | 210 +++++++++++----
 swh/core/db/tests/test_db_utils.py                 | 189 +++++++++++++
 swh/core/tests/test_utils.py                       |   5 +
 swh/core/utils.py                                  |   5 +
 26 files changed, 1154 insertions(+), 150 deletions(-)
 create mode 100644 swh/core/db/sql/35-dbversion.sql
 create mode 100644 swh/core/db/sql/36-dbmodule.sql
 rename swh/core/db/tests/data/cli/{ => sql}/0-superuser-init.sql (100%)
 rename swh/core/db/tests/data/cli/{1-schema.sql => sql/30-schema.sql} (87%)
 rename swh/core/db/tests/data/cli/{3-func.sql => sql/40-funcs.sql} (100%)
 rename swh/core/db/tests/data/cli/{4-data.sql => sql/50-data.sql} (73%)
 create mode 100644 swh/core/db/tests/data/cli_new/sql/0-superuser-init.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/30-schema.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/40-funcs.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/50-data.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/001.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/002.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/003.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/004.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/005.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/006.sql
 create mode 100644 swh/core/db/tests/test_db_utils.py
Changes applied before test
commit 6a88f4d5caed35e838cc240c381b3397e5a74f5a
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 15:31:30 2022 +0100

    Replace mock_package_sql by a mock_import_swhmodule fixture
    
    in favor of using (and thus testing) the stock get_sql_for_package()
    function (on the mock module returned by mock_import_swhmodule).
    
    This comes with a change in expected test data structure for sql
    script; the `tests/data/<mod>` is now expected to store the sql script
    files in a dedicated `sql/` sub directory instead of having them
    directly in the `<mod>` directory so that the get_sql_for_package() can
    be used in tests unmocked.

commit 06ea2290c44551ba1c6edcb07844aecd23b92b62
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 12:37:07 2022 +0100

    Make get_sql_for_package() return pathlib.Path objects

commit 893c93a958b239dddb6b42db64635b0e210892cd
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Feb 7 15:46:48 2022 +0100

    Refactor swh.core.db.pytest_plugin
    
    update the postgresql_fact fixture to be able to use new-ish
    pytest_postgresql ability to recreate databases between tests from a
    template database.
    
    The ides is to stop using the fragile and confusing "reset" of the
    database between tests, which means de facto keep a stateful database
    between tests, which make tests result depend on de facto order of
    execution of these tests.
    
    For example, test_smoke_test_people_db_up_and_reset cannot be executed
    alone, since it depends on the fact test_smoke_test_people_db_up has
    been executed before so that the people's db has been reset as a result
    of the test setup done by the fixture, which will happen if and only if
    the database already exists (thus if another test using this db has been
    executed before in this test session).
    
    The old table truncate based behavior has been kept (using a no_db_drop
    flag argument) in this diff for bw compatibility reasons, and also because
    the new drop-and-create-from-template beahvior remains a bit slower,
    which might be a problem for some test cases.
    
    Tests for dependencies (swh-storage, etc.) should still pass with this
    refactoring, but will be significantly slower.
    
    A series of revisions for these dependencies is about to be proposed to
    adapt them to the new db metadata (version, module, flavor) handling
    feature coming with swh.core 2, as well as updating their tests to take
    advantage of the template-based db creation in tests, which should bring
    back test execution time to almost the same as before this refactoring.
    
    This is needed to be able to implement and test support for the new 'swh
    db upgrade' all this is actually about.

commit 16e2fd4992efa439f074e11be4198cf5b0053aff
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 15:43:09 2022 +0100

    Add a 'swh db upgrade' command
    
    this new command allows to handle the database migration from the
    current version to the latest version advertized but the backend
    datastore.
    
    This feature is only working for "new style" swh.core.db based
    datastores.

commit 7e07b1f363269dc0bdcf3c1e7070ff0c0bacfdc6
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 14:51:43 2022 +0100

    Make 'swh db init' fill the dbversion table
    
    for this feature to work properly, the backend datastore package must
    provide the 'get_datastore' factory function in its root namespace and
    the datastore instance must provide a 'get_current_version()' method.
    
    This also means the canonical cli usage for the `swh db init` is now
    using the config file (via `--config-file` or `SWH_CONFIG_FILENAME`)
    instead of giving only the db cnx string (`--db-name`), so that the
    backend datastore class can be instanciated using the `get_datastore()`
    factory function.
    
    However a '--initial-version' cli option has been added to 'swh db init'
    to make it easier, especially for unit tests.

commit f8a07dfa0bf668905d66ad88b25b2e1f3f569177
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 17:54:01 2022 +0100

    Use a standard postgresql db fixture in test_cli
    
    instead of a custom 'test_db' (which did not truncate dbversion and
    origin tables, not sure what the intent was for this).

commit c4bd270c3000df52176dafbf5c7f16e283e918c8
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 15:02:51 2022 +0100

    Add support for dbversion and dbmodule handling in swh db init
    
    for now, managing the dbversion table (storing the db schema upgrade
    history) is partially the responsibility of the swh modules implementing
    a datastore (swh-storage etc.), and the actual swh module was not stored
    in the database.
    
    This adds support for both the dbversion and dbmodule tables management
    in swh.core.db.
    
    The `swh db init` command now creates both these tables and initialize
    their values if possible.
    For this, it introduces a new common "API" for swh.core.db based datastores:
    
    - a swh module implementing a datastore is expected to have a
      `get_datastore` function in its top namespace; this function is
      typically the actual `get_storage`, `get_scheduler` etc. functions
    - this factory function is expected to use the "postgresql" cls for the
      datastore based on swh.core.db,
    - the datastore instance (eg. instance of the swh.storage.postgresql.Storage
      class) is expected to have a `get_current_version()` method (returning
      an int).
    
    This revision also provides a new `swh db version` command displaying
    the current (code) version (if available), the db version (possibly the whole
    version history) and flavor (if any) for the datastore given as argument.
    
    It should be backward compatible with existing swh datastore modules (i.e.
    not yet adapted to this new API).

commit b1e449fd91ebcc403966a79fd62d449921fcf550
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 16:00:43 2022 +0100

    Refactor the mock_package_sql fixture to allow multiple sql script set
    
    will be used to implement several test scenarios in following commits.
    Also rename existing sql scripts with a "legit" numbering scheme.

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/354/ for more details.

Harbormaster completed remote builds in B26935: Diff 26066.Feb 16 2022, 4:09 PM
douardda updated this revision to Diff 26085.Feb 17 2022, 1:49 PM

rebase

swh-public-ci added a comment.Feb 17 2022, 1:51 PM

Build is green

Patch application report for D7188 (id=26085)

Could not rebase; Attempt merge onto 3139d3344e...

Updating 3139d33..84b63d5
Fast-forward
 MANIFEST.in                                        |   2 +
 requirements-db-pytestplugin.txt                   |   2 +-
 swh/core/cli/db.py                                 | 202 +++++++++++++-
 swh/core/db/db_utils.py                            | 300 +++++++++++++++++++--
 swh/core/db/pytest_plugin.py                       | 230 +++++++++++-----
 swh/core/db/sql/35-dbversion.sql                   |  18 ++
 swh/core/db/sql/36-dbmodule.sql                    |  15 ++
 swh/core/db/tests/conftest.py                      |  55 ++++
 .../tests/data/cli/{ => sql}/0-superuser-init.sql  |   0
 .../data/cli/{1-schema.sql => sql/30-schema.sql}   |   2 +-
 .../data/cli/{3-func.sql => sql/40-funcs.sql}      |   0
 .../tests/data/cli/{4-data.sql => sql/50-data.sql} |   2 +-
 .../db/tests/data/cli_new/sql/0-superuser-init.sql |   1 +
 swh/core/db/tests/data/cli_new/sql/30-schema.sql   |   6 +
 swh/core/db/tests/data/cli_new/sql/40-funcs.sql    |   6 +
 swh/core/db/tests/data/cli_new/sql/50-data.sql     |   2 +
 .../db/tests/data/cli_new/sql/upgrades/001.sql     |   5 +
 .../db/tests/data/cli_new/sql/upgrades/002.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/003.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/004.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/005.sql     |   4 +
 .../db/tests/data/cli_new/sql/upgrades/006.sql     |   7 +
 .../db/tests/pytest_plugin/test_pytest_plugin.py   |  26 +-
 swh/core/db/tests/test_cli.py                      | 210 +++++++++++----
 swh/core/db/tests/test_db_utils.py                 | 189 +++++++++++++
 swh/core/tests/test_utils.py                       |   5 +
 swh/core/utils.py                                  |   5 +
 27 files changed, 1155 insertions(+), 151 deletions(-)
 create mode 100644 swh/core/db/sql/35-dbversion.sql
 create mode 100644 swh/core/db/sql/36-dbmodule.sql
 rename swh/core/db/tests/data/cli/{ => sql}/0-superuser-init.sql (100%)
 rename swh/core/db/tests/data/cli/{1-schema.sql => sql/30-schema.sql} (87%)
 rename swh/core/db/tests/data/cli/{3-func.sql => sql/40-funcs.sql} (100%)
 rename swh/core/db/tests/data/cli/{4-data.sql => sql/50-data.sql} (73%)
 create mode 100644 swh/core/db/tests/data/cli_new/sql/0-superuser-init.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/30-schema.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/40-funcs.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/50-data.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/001.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/002.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/003.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/004.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/005.sql
 create mode 100644 swh/core/db/tests/data/cli_new/sql/upgrades/006.sql
 create mode 100644 swh/core/db/tests/test_db_utils.py
Changes applied before test
commit 84b63d5b1da735b5ca4ad12023106f48bbcb07ee
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 15:31:30 2022 +0100

    Replace mock_package_sql by a mock_import_swhmodule fixture
    
    in favor of using (and thus testing) the stock get_sql_for_package()
    function (on the mock module returned by mock_import_swhmodule).
    
    This comes with a change in expected test data structure for sql
    script; the `tests/data/<mod>` is now expected to store the sql script
    files in a dedicated `sql/` sub directory instead of having them
    directly in the `<mod>` directory so that the get_sql_for_package() can
    be used in tests unmocked.

commit 25fee94847d3cb8de011cd34334eb4aac5628ce1
Author: David Douard <david.douard@sdfa3.org>
Date:   Wed Feb 16 12:37:07 2022 +0100

    Make get_sql_for_package() return pathlib.Path objects

commit 5822dab0ea427c11df68b5669bb60ac0d7e194f7
Author: David Douard <david.douard@sdfa3.org>
Date:   Mon Feb 7 15:46:48 2022 +0100

    Refactor swh.core.db.pytest_plugin
    
    update the postgresql_fact fixture to be able to use new-ish
    pytest_postgresql ability to recreate databases between tests from a
    template database.
    
    The ides is to stop using the fragile and confusing "reset" of the
    database between tests, which means de facto keep a stateful database
    between tests, which make tests result depend on de facto order of
    execution of these tests.
    
    For example, test_smoke_test_people_db_up_and_reset cannot be executed
    alone, since it depends on the fact test_smoke_test_people_db_up has
    been executed before so that the people's db has been reset as a result
    of the test setup done by the fixture, which will happen if and only if
    the database already exists (thus if another test using this db has been
    executed before in this test session).
    
    The old table truncate based behavior has been kept (using a no_db_drop
    flag argument) in this diff for bw compatibility reasons, and also because
    the new drop-and-create-from-template beahvior remains a bit slower,
    which might be a problem for some test cases.
    
    Tests for dependencies (swh-storage, etc.) should still pass with this
    refactoring, but will be significantly slower.
    
    A series of revisions for these dependencies is about to be proposed to
    adapt them to the new db metadata (version, module, flavor) handling
    feature coming with swh.core 2, as well as updating their tests to take
    advantage of the template-based db creation in tests, which should bring
    back test execution time to almost the same as before this refactoring.
    
    This is needed to be able to implement and test support for the new 'swh
    db upgrade' all this is actually about.

commit 16e2fd4992efa439f074e11be4198cf5b0053aff
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 15:43:09 2022 +0100

    Add a 'swh db upgrade' command
    
    this new command allows to handle the database migration from the
    current version to the latest version advertized but the backend
    datastore.
    
    This feature is only working for "new style" swh.core.db based
    datastores.

commit 7e07b1f363269dc0bdcf3c1e7070ff0c0bacfdc6
Author: David Douard <david.douard@sdfa3.org>
Date:   Tue Feb 1 14:51:43 2022 +0100

    Make 'swh db init' fill the dbversion table
    
    for this feature to work properly, the backend datastore package must
    provide the 'get_datastore' factory function in its root namespace and
    the datastore instance must provide a 'get_current_version()' method.
    
    This also means the canonical cli usage for the `swh db init` is now
    using the config file (via `--config-file` or `SWH_CONFIG_FILENAME`)
    instead of giving only the db cnx string (`--db-name`), so that the
    backend datastore class can be instanciated using the `get_datastore()`
    factory function.
    
    However a '--initial-version' cli option has been added to 'swh db init'
    to make it easier, especially for unit tests.

commit f8a07dfa0bf668905d66ad88b25b2e1f3f569177
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 17:54:01 2022 +0100

    Use a standard postgresql db fixture in test_cli
    
    instead of a custom 'test_db' (which did not truncate dbversion and
    origin tables, not sure what the intent was for this).

commit c4bd270c3000df52176dafbf5c7f16e283e918c8
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 15:02:51 2022 +0100

    Add support for dbversion and dbmodule handling in swh db init
    
    for now, managing the dbversion table (storing the db schema upgrade
    history) is partially the responsibility of the swh modules implementing
    a datastore (swh-storage etc.), and the actual swh module was not stored
    in the database.
    
    This adds support for both the dbversion and dbmodule tables management
    in swh.core.db.
    
    The `swh db init` command now creates both these tables and initialize
    their values if possible.
    For this, it introduces a new common "API" for swh.core.db based datastores:
    
    - a swh module implementing a datastore is expected to have a
      `get_datastore` function in its top namespace; this function is
      typically the actual `get_storage`, `get_scheduler` etc. functions
    - this factory function is expected to use the "postgresql" cls for the
      datastore based on swh.core.db,
    - the datastore instance (eg. instance of the swh.storage.postgresql.Storage
      class) is expected to have a `get_current_version()` method (returning
      an int).
    
    This revision also provides a new `swh db version` command displaying
    the current (code) version (if available), the db version (possibly the whole
    version history) and flavor (if any) for the datastore given as argument.
    
    It should be backward compatible with existing swh datastore modules (i.e.
    not yet adapted to this new API).

commit b1e449fd91ebcc403966a79fd62d449921fcf550
Author: David Douard <david.douard@sdfa3.org>
Date:   Fri Jan 28 16:00:43 2022 +0100

    Refactor the mock_package_sql fixture to allow multiple sql script set
    
    will be used to implement several test scenarios in following commits.
    Also rename existing sql scripts with a "legit" numbering scheme.

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/358/ for more details.

Harbormaster completed remote builds in B26954: Diff 26085.Feb 17 2022, 1:51 PM
Closed by commit rDCORE25fee94847d3: Make get_sql_for_package() return pathlib.Path objects (authored by douardda). · Explain WhyFeb 17 2022, 1:55 PM
This revision was automatically updated to reflect the committed changes.
douardda added a commit: rDCORE25fee94847d3: Make get_sql_for_package() return pathlib.Path objects.
douardda added a commit: rDCORE84b63d5b1da7: Replace mock_package_sql by a mock_import_swhmodule fixture.

Revision Contents
Changeset List

PathSize
swh/
core/
db/
37 lines
tests/
10 lines

Diff 26094

View Options

swh/core/db/db_utils.py

Loading...
View Options

swh/core/db/tests/conftest.py

Loading...
About · Developer information · Legal