openstack
/
rally
Code Issues Proposed changes

Improve plugin sample and corresponding 'creating a plugin' tutorial 

The scenario_plugin.py was updated, however, the documentation still
has the old instruction for creating a plugin. Let's update that in-
struction. Let's also add 'required_services' and 'required_platform'
in the sample to make it more complete.

Change-Id: I6d36ea51a3ee32b94ab296c77195ee22652f40ec
This commit is contained in:
Amy Ge 2017-06-20 16:12:20 -07:00
parent e40e6e8537
commit 06cd90e39c
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/plugins/implementation/scenario_plugin.rst
View File

@ -24,18 +24,23 @@ Let's create a simple scenario plugin that list flavors.
Creation
^^^^^^^^
Inherit a class for your plugin from the base *Scenario* class and
Inherit a class for your plugin from the base *OpenStackScenario* class and
implement a scenario method inside it. In our scenario, we'll first
list flavors as an ordinary user, and then repeat the same using admin
clients:
.. code-block:: python
from rally import consts
from rally.plugins.openstack import scenario
from rally.task import atomic
from rally.task import scenario
from rally.task import validation
class ScenarioPlugin(scenario.Scenario):
@validation.add("required_services", services=[consts.Service.NOVA])
@validation.add("required_platform", platform="openstack", users=True)
@scenario.configure(name="ScenarioPlugin.list_flavors_useless")
class ListFlavors(scenario.OpenStackScenario):
"""Sample plugin which lists flavors."""
@atomic.action_timer("list_flavors")
@ -51,8 +56,7 @@ clients:
"""The same with admin clients"""
self.admin_clients("nova").flavors.list()
@scenario.configure()
def list_flavors(self):
def run(self):
"""List flavors."""
self._list_flavors()
self._list_flavors_as_admin()

4
samples/plugins/scenario/scenario_plugin.py
View File

@ -13,10 +13,14 @@
# License for the specific language governing permissions and limitations
# under the License.
from rally import consts
from rally.plugins.openstack import scenario
from rally.task import atomic
from rally.task import validation
@validation.add("required_services", services=[consts.Service.NOVA])
@validation.add("required_platform", platform="openstack", users=True)
@scenario.configure(name="ScenarioPlugin.list_flavors")
class ListFlavors(scenario.OpenStackScenario):