Rally tests plugins for Heat

This patch demonstrate way how to use rally plugins in Heat repository.
Current patch contains 4 new scenario:
 - output-show for old algorithm
 - output-show for new algorithm
 - output-list for old algorithm
 - output-list for new algorithm

All new plugins use simple template with ResourceGroup resource,
which contains simple OS::Heat::TestResource with custom value of
timeout_attr property.

Change-Id: Ia960ab5bd59ca0f6fc0fa3aff069c34c67a89354

3 files changed, 246 insertions, 0 deletions

diff --git a/rally-scenarios/extra/rg_template_with_outputs.yaml b/rally-scenarios/extra/rg_template_with_outputs.yaml
new file mode 100644
index 000000000..b7abfcbcb
--- /dev/null
+++ b/rally-scenarios/extra/rg_template_with_outputs.yaml
@@ -0,0 +1,37 @@
+heat_template_version: 2013-05-23
+parameters:
+  attr_wait_secs:
+    type: number
+    default: 0.5
+
+resources:
+  rg:
+    type: OS::Heat::ResourceGroup
+    properties:
+      count: 10
+      resource_def:
+        type: OS::Heat::TestResource
+        properties:
+          attr_wait_secs: {get_param: attr_wait_secs}
+
+outputs:
+  val1:
+    value: {get_attr: [rg, resource.0.output]}
+  val2:
+    value: {get_attr: [rg, resource.1.output]}
+  val3:
+    value: {get_attr: [rg, resource.2.output]}
+  val4:
+    value: {get_attr: [rg, resource.3.output]}
+  val5:
+    value: {get_attr: [rg, resource.4.output]}
+  val6:
+    value: {get_attr: [rg, resource.5.output]}
+  val7:
+    value: {get_attr: [rg, resource.6.output]}
+  val8:
+    value: {get_attr: [rg, resource.7.output]}
+  val9:
+    value: {get_attr: [rg, resource.8.output]}
+  val10:
+    value: {get_attr: [rg, resource.9.output]}
diff --git a/rally-scenarios/heat-fakevirt.yaml b/rally-scenarios/heat-fakevirt.yaml
index 420b13793..782c3e7bf 100644
--- a/rally-scenarios/heat-fakevirt.yaml
+++ b/rally-scenarios/heat-fakevirt.yaml
@@ -36,3 +36,40 @@
         users:
           tenants: 1
           users_per_tenant: 1
+
+  {% for s in ("create_stack_and_show_output_new", "create_stack_and_show_output_old") %}
+  CustomHeatBenchmark.{{s}}:
+    -
+      args:
+        template_path: "~/.rally/extra/rg_template_with_outputs.yaml"
+        output_key: "val1"
+      runner:
+        type: "constant"
+        times: 5
+        concurrency: 1
+      context:
+        users:
+          tenants: 1
+          users_per_tenant: 1
+      sla:
+        failure_rate:
+          max: 0
+  {% endfor %}
+
+  {% for s in ("create_stack_and_list_output_new", "create_stack_and_list_output_old") %}
+  CustomHeatBenchmark.{{s}}:
+    -
+      args:
+        template_path: "~/.rally/extra/rg_template_with_outputs.yaml"
+      runner:
+        type: "constant"
+        times: 5
+        concurrency: 1
+      context:
+        users:
+          tenants: 1
+          users_per_tenant: 1
+      sla:
+        failure_rate:
+          max: 0
+  {% endfor %}
diff --git a/rally-scenarios/plugins/stack_output.py b/rally-scenarios/plugins/stack_output.py
new file mode 100644
index 000000000..5d5727a6d
--- /dev/null
+++ b/rally-scenarios/plugins/stack_output.py
@@ -0,0 +1,172 @@
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from rally import consts
+from rally.plugins.openstack import scenario
+from rally.plugins.openstack.scenarios.heat import utils
+from rally.task import atomic
+from rally.task import types
+from rally.task import validation
+
+
+class CustomHeatBenchmark(utils.HeatScenario):
+    @atomic.action_timer("heat.show_output_new")
+    def _stack_show_output_new(self, stack, output_key):
+        """Execute output_show for specified 'output_key'.
+
+        This method uses new output API call.
+
+        :param stack: stack with output_key output.
+        :param output_key: The name of the output.
+        """
+        self.clients("heat").stacks.output_show(stack.id, output_key)
+
+    @atomic.action_timer("heat.show_output_old")
+    def _stack_show_output_old(self, stack, output_key):
+        """Execute output_show for specified 'output_key'.
+
+        This method uses old way for getting output value.
+        It gets whole stack object and then finds necessary 'output_key'.
+
+        :param stack: stack with output_key output.
+        :param output_key: The name of the output.
+        """
+        # this code copy-pasted and adopted for rally from old client version
+        # https://github.com/openstack/python-heatclient/blob/0.8.0/heatclient/
+        # v1/shell.py#L682-L699
+        stack = self.clients("heat").stacks.get(stack_id=stack.id)
+        for output in stack.to_dict().get('outputs', []):
+            if output['output_key'] == output_key:
+                break
+
+    @atomic.action_timer("heat.list_output_new")
+    def _stack_list_output_new(self, stack):
+        """Execute output_list for specified 'stack'.
+
+        This method uses new output API call.
+
+        :param stack: stack to call output-list.
+        """
+        self.clients("heat").stacks.output_list(stack.id)
+
+    @atomic.action_timer("heat.list_output_old")
+    def _stack_list_output_old(self, stack):
+        """Execute output_list for specified 'stack'.
+
+        This method uses old way for getting output value.
+        It gets whole stack object and then prints all outputs
+        belongs this stack.
+
+        :param stack: stack to call output-list.
+        """
+        # this code copy-pasted and adopted for rally from old client version
+        # https://github.com/openstack/python-heatclient/blob/0.8.0/heatclient/
+        # v1/shell.py#L649-L663
+        stack = self.clients("heat").stacks.get(stack_id=stack.id)
+        stack.to_dict()['outputs']
+
+    @types.set(template_path=types.FileType, files=types.FileTypeDict)
+    @validation.required_services(consts.Service.HEAT)
+    @validation.required_openstack(users=True)
+    @scenario.configure(context={"cleanup": ["heat"]})
+    def create_stack_and_show_output_old(self, template_path, output_key,
+                                         parameters=None, files=None,
+                                         environment=None):
+        """Create stack and show output by using old algorithm.
+
+        Measure performance of the following commands:
+        heat stack-create
+        heat output-show
+        heat stack-delete
+
+        :param template_path: path to stack template file
+        :param parameters: parameters to use in heat template
+        :param files: files used in template
+        :param environment: stack environment definition
+        """
+        stack = self._create_stack(
+            template_path, parameters, files, environment)
+        self._stack_show_output_old(stack, output_key)
+
+    @types.set(template_path=types.FileType, files=types.FileTypeDict)
+    @validation.required_services(consts.Service.HEAT)
+    @validation.required_openstack(users=True)
+    @scenario.configure(context={"cleanup": ["heat"]})
+    def create_stack_and_show_output_new(self, template_path, output_key,
+                                         parameters=None, files=None,
+                                         environment=None):
+        """Create stack and show output by using new algorithm.
+
+        Measure performance of the following commands:
+        heat stack-create
+        heat output-show
+        heat stack-delete
+
+        :param template_path: path to stack template file
+        :param output_key: the stack output key that corresponds to
+                           the scaling webhook
+        :param parameters: parameters to use in heat template
+        :param files: files used in template
+        :param environment: stack environment definition
+        """
+        stack = self._create_stack(
+            template_path, parameters, files, environment)
+        self._stack_show_output_new(stack, output_key)
+
+    @types.set(template_path=types.FileType, files=types.FileTypeDict)
+    @validation.required_services(consts.Service.HEAT)
+    @validation.required_openstack(users=True)
+    @scenario.configure(context={"cleanup": ["heat"]})
+    def create_stack_and_list_output_old(self, template_path,
+                                         parameters=None, files=None,
+                                         environment=None):
+        """Create stack and list outputs by using old algorithm.
+
+        Measure performance of the following commands:
+        heat stack-create
+        heat output-list
+        heat stack-delete
+
+        :param template_path: path to stack template file
+        :param parameters: parameters to use in heat template
+        :param files: files used in template
+        :param environment: stack environment definition
+        """
+        stack = self._create_stack(
+            template_path, parameters, files, environment)
+        self._stack_list_output_old(stack)
+
+    @types.set(template_path=types.FileType, files=types.FileTypeDict)
+    @validation.required_services(consts.Service.HEAT)
+    @validation.required_openstack(users=True)
+    @scenario.configure(context={"cleanup": ["heat"]})
+    def create_stack_and_list_output_new(self, template_path,
+                                         parameters=None, files=None,
+                                         environment=None):
+        """Create stack and list outputs by using new algorithm.
+
+        Measure performance of the following commands:
+        heat stack-create
+        heat output-list
+        heat stack-delete
+
+        :param template_path: path to stack template file
+        :param output_key: the stack output key that corresponds to
+                           the scaling webhook
+        :param parameters: parameters to use in heat template
+        :param files: files used in template
+        :param environment: stack environment definition
+        """
+        stack = self._create_stack(
+            template_path, parameters, files, environment)
+        self._stack_list_output_new(stack)