Page MenuHomeSoftware Heritage
Create Task
Maniphest T2970

Make swh-journal tests not depend on swh-model any more
Closed, MigratedEdits Locked
Actions

Description

Currently, swh-journal actually depends on swh-model only for the definition of KeyType, really.
The model objects (BaseModel subclasses), are uses as an easy way to create dataset for the tests consisting in actual model objects.
However nowadays, the journal writer depends on the ValueProtocol only.

This dependency on swh-model and on the actual model declared in swh.model.model is a burden because any modification in this model will (probably) break tests in swh-journal for no good reason.

The real dependency link we want to break is this later one, but then the only remaining dependency of swh-journal to swh-model is the definition of KeyType. I'd rather live with this definition duplicated in swh-journal than having a dependency.

Revisions and Commits

rDJNL Journal infrastructure
D4951rDJNL9703864ef366 Remove tests' journal_data.py in favor of the version in swh-model
rDMOD Data model
D4950rDMODcad940dc8c07 Add swh-journal's model-related test data set in swh-model

Event Timeline

douardda triaged this task as Normal priority.Jan 13 2021, 4:48 PM
douardda created this task.
douardda added a comment.Jan 26 2021, 4:41 PM

Back on this, the plan is now to make swh-journal not depend on the actual model definition, which is currently mostly due to the presence of the journal_data.py in swh-journal. So the plan is to move this file in swh-model so it's kept up to date with swh-model, even if it's mostly used for testing other packages (like swh-journal).

So keeping the dependency on swh-model in swh-journal's tests, but move the "problematic" parts in swh-model. Doing so we should not have too many "when a butterfly moves a wing in swh-model it breaks swh-journal" kind of coupling problem.

It may still happen but I expect much less often.

douardda added a revision: D4950: Add swh-journal's model-related test data set in swh-model.Jan 26 2021, 4:45 PM
douardda added a revision: D4951: Remove tests' journal_data.py in favor of the version in swh-model.Jan 26 2021, 5:09 PM
douardda added a commit: rDMODcad940dc8c07: Add swh-journal's model-related test data set in swh-model.Jan 26 2021, 5:21 PM
douardda added a commit: rDJNL9703864ef366: Remove tests' journal_data.py in favor of the version in swh-model.Jan 27 2021, 3:38 PM
douardda closed this task as Resolved.Jan 27 2021, 3:47 PM
douardda claimed this task.

Let's consider it as done.

gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 4:33 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal