| Martin Kopec | 0b5a8a2 | 2020-11-26 19:58:35 +0000 | [diff] [blame] | 1 | --- |
| 2 | prelude: > |
| 3 | Tempest.scenario.manager is now a stable interface for Tempest plugins. |
| 4 | features: |
| 5 | - | |
| 6 | In this release, we made tempest/scenario/manager.py a stable interface |
| 7 | ready to be consumed by all tempest plugins. The effort was tracked in |
| 8 | the following etherpad [1], and the related review can be listed via [2]: |
| 9 | |
| 10 | * [1] https://etherpad.opendev.org/p/tempest-scenario-manager |
| 11 | * [2] https://review.opendev.org/#/q/topic:bp/tempest-scenario-manager-stable(status:open+OR+status:merged) |
| 12 | |
| 13 | Some time ago, tempest/scenario/manager.py got copied to most of the plugins |
| 14 | and therefore, it diverged - every plugin's copy had slight differences. |
| 15 | In this release, we pushed changes to unify the manager's methods and |
| 16 | improved their APIs in order to have them easier consumable: |
| 17 | |
| 18 | * we added implementations of methods that were often used in plugins' |
| 19 | manager.py however were not implemented in our manager |
| 20 | * we improved APIs by f.e. adding a kwargs argument so that the consumers |
| 21 | are more in control of the data that are passed to tempest clients |
| 22 | * we modified logic of a few methods so that it complies with the plugins' |
| 23 | manager versions in order to prepare for a situation when the plugins |
| 24 | can reuse Tempest manager as much as possible rather than keeping their |
| 25 | own copy |
| 26 | * we made methods consistent w.r.t. names and parameters |
| 27 | * we split the lengthy methods to have more readable code |
| 28 | * previously private methods which had a potential to be reused were |
| 29 | made public so that it's clear they are expected to be used in tempest |
| 30 | plugins |
| 31 | * missing docstrings have been added |