Do not list test scenarios in CLI help

Scenarios under `test/` subfolder are used for integration testing
or as samples. Skip them in CLI help and keep only production-ready.

Change-Id: I69a428480055c825aa3b590f02b4c09b346a6012

doc/source/catalog.rst

@@ -17,26 +17,6 @@ processes.
 To use this scenario specify parameter ``--scenario misc/instance_metadata``.
 Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/misc/instance_metadata.yaml
 
-.. _scenario_static_agents:
-
-Static agents
-^^^^^^^^^^^^^
-In this scenario Shaker runs tests on pre-deployed static agents. The scenario
-can be used for Shaker integration testing.
-
-To use this scenario specify parameter ``--scenario misc/static_agent``.
-Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/misc/static_agent.yaml
-
-.. _scenario_paired_static_agents:
-
-Paired static agents
-^^^^^^^^^^^^^^^^^^^^
-In this scenario Shaker runs tests on pre-deployed pair of static agents. The
-scenario can be used for Shaker integration testing.
-
-To use this scenario specify parameter ``--scenario misc/static_agents_pair``.
-Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/misc/static_agents_pair.yaml
-
 .. _scenario_openstack_l2_cross_az:
 
 OpenStack L2 Cross-AZ
@@ -422,6 +402,48 @@ overridden by command-line parameter, e.g. ``--matrix "{host: 172.10.1.2}"``.
 To use this scenario specify parameter ``--scenario spot/udp``.
 Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/spot/udp.yaml
 
+.. _scenario_sample_tcp_test_with_environment_file:
+
+Sample TCP Test with Environment File
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This test definition demonstrates the use of an environment file. In this
+scenario Shaker launches pairs of instances in the same tenant network. Every
+instance is hosted on a separate compute node, 1 compute node is utilized. The
+traffic goes within the tenant network (L2 domain)
+
+To use this scenario specify parameter ``--scenario test/sample_with_env``.
+Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/test/sample_with_env.yaml
+
+.. _scenario_static_agents:
+
+Static agents
+^^^^^^^^^^^^^
+In this scenario Shaker runs tests in spot mode. The scenario can be used for
+Shaker integration testing.
+
+To use this scenario specify parameter ``--scenario test/spot``.
+Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/test/spot.yaml
+
+.. _scenario_static_agents:
+
+Static agents
+^^^^^^^^^^^^^
+In this scenario Shaker runs tests on pre-deployed static agents. The scenario
+can be used for Shaker integration testing.
+
+To use this scenario specify parameter ``--scenario test/static_agent``.
+Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/test/static_agent.yaml
+
+.. _scenario_paired_static_agents:
+
+Paired static agents
+^^^^^^^^^^^^^^^^^^^^
+In this scenario Shaker runs tests on pre-deployed pair of static agents. The
+scenario can be used for Shaker integration testing.
+
+To use this scenario specify parameter ``--scenario test/static_agents_pair``.
+Scenario source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/test/static_agents_pair.yaml
+
 Heat Templates
 --------------
 
@@ -521,3 +543,13 @@ the same L2 domain.
 
 Template source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/openstack/qos/l2_qos.hot
 
+.. _template_test_l2_with_env:
+
+test/l2_with_env
+^^^^^^^^^^^^^^^^
+This Heat template creates a new Neutron network, a router to the external
+network and plugs instances into this new network. All instances are located in
+the same L2 domain.
+
+Template source is available at: https://github.com/openstack/shaker/blob/master/shaker/scenarios/test/l2_with_env.hot
+

doc/source/tools/shaker-all-in-one.txt

@@ -198,8 +198,7 @@ optional arguments:
                         "interactive".
   --scenario SCENARIO   Comma-separated list of scenarios to play. Each entity
                         can be a file name or one of aliases:
-                        "misc/instance_metadata", "misc/static_agent",
+                        "misc/instance_metadata",
-                        "misc/static_agents_pair",
                         "openstack/cross_az/full_l2",
                         "openstack/cross_az/full_l3_east_west",
                         "openstack/cross_az/full_l3_north_south",

doc/source/tools/shaker-spot.txt

@@ -77,8 +77,7 @@ optional arguments:
                         "interactive".
   --scenario SCENARIO   Comma-separated list of scenarios to play. Each entity
                         can be a file name or one of aliases:
-                        "misc/instance_metadata", "misc/static_agent",
+                        "misc/instance_metadata",
-                        "misc/static_agents_pair",
                         "openstack/cross_az/full_l2",
                         "openstack/cross_az/full_l3_east_west",
                         "openstack/cross_az/full_l3_north_south",

doc/source/tools/shaker.txt

@@ -158,8 +158,7 @@ optional arguments:
                         "interactive".
   --scenario SCENARIO   Comma-separated list of scenarios to play. Each entity
                         can be a file name or one of aliases:
-                        "misc/instance_metadata", "misc/static_agent",
+                        "misc/instance_metadata",
-                        "misc/static_agents_pair",
                         "openstack/cross_az/full_l2",
                         "openstack/cross_az/full_l3_east_west",
                         "openstack/cross_az/full_l3_north_south",

etc/shaker.conf

@@ -192,8 +192,7 @@
 #cleanup_on_error = true
 
 # Comma-separated list of scenarios to play. Each entity can be a file name or
-# one of aliases: "misc/instance_metadata", "misc/static_agent",
+# one of aliases: "misc/instance_metadata", "openstack/cross_az/full_l2",
-# "misc/static_agents_pair", "openstack/cross_az/full_l2",
 # "openstack/cross_az/full_l3_east_west",
 # "openstack/cross_az/full_l3_north_south", "openstack/cross_az/perf_l2",
 # "openstack/cross_az/perf_l3_east_west",

shaker/engine/config.py

@@ -190,7 +190,8 @@ SCENARIO_OPTS = [
                     'Comma-separated list of scenarios to play. Each entity '
                     'can be a file name or one of aliases: '
                     '%s. Defaults to env[SHAKER_SCENARIO].', SCENARIOS,
-                    type_filter=lambda x: x.endswith('.yaml'))),
+                    type_filter=lambda x: (x.endswith('.yaml')
+                                           and not x.startswith('test/')))),
     cfg.Opt('matrix',
             default=utils.env('SHAKER_MATRIX'),
             type=Yaml(),

shaker/engine/utils.py

@@ -193,11 +193,11 @@ def make_help_options(message, base, type_filter=None):
     files = itertools.chain.from_iterable(
         [map(functools.partial(os.path.join, root), files)
          for root, dirs, files in os.walk(path)])  # list of files in a tree
+    files = [os.path.relpath(f, start=path) for f in files]  # to relative
     if type_filter:
         files = (f for f in files if type_filter(f))  # filtered list
-    rel_files = map(functools.partial(os.path.relpath, start=path), files)
     return message % ', '.join('"%s"' % f.partition('.')[0]
-                               for f in sorted(rel_files))
+                               for f in sorted(files))
 
 
 def algebraic_product(**kwargs):