Merge "Add ngs-stress test script"

Author: Zuul

releasenotes/notes/ngs-stress-78f9e993e62e2e36.yaml

@@ -0,0 +1,5 @@
+---
+other:
+  - |
+    Adds a stress testing script, ``ngs-stress.py``, in the
+    ``tools/ngs-stress`` directory of the source code repository.

tools/ngs-stress/README.rst

@@ -0,0 +1,79 @@
+=====================================
+Networking-generic-switch Stress Test
+=====================================
+
+Stress test for the OpenStack Neutron networking-generic-switch (genericswitch)
+ML2 mechanism driver.
+
+This script can stress a switch using the genericswitch driver.  It does not
+require an OpenStack or Neutron installation, and can operate in isolation.
+There are two modes of operation:
+
+network
+    Create and delete a number of networks in parallel.
+port
+    Create and delete a number of ports in parallel.
+
+It is possible to use an existing genericswitch configuration file containing
+switch configuration.
+
+Installation
+============
+
+To install dependencies in a virtualenv::
+
+    python3 -m venv venv
+    source venv/bin/activate
+    pip install -U pip
+    pip install -c https://releases.openstack.org/constraints/upper/<release> networking-generic-switch
+
+If you want to use etcd for coordination, install the ``etcd3gw`` package::
+
+    pip install -c https://releases.openstack.org/constraints/upper/<release> etcd3gw
+
+The Bitnami ``Etcd`` container can be used in a standalone mode::
+
+    docker run --detach -it -e ALLOW_NONE_AUTHENTICATION=yes --name Etcd --net=host bitnami/etcd
+
+Configuration
+=============
+
+A configuration file is required to provide details of switch devices, as well
+as any other NGS config options necessary. For example, to use the Fake device
+driver for testing:
+
+.. code-block:: ini
+
+   [genericswitch:fake]
+   device_type = netmiko_fake
+
+Other drivers will typically require further configuration.
+
+If you want to use etcd for coordination, add the following:
+
+.. code-block:: ini
+
+   [ngs_coordination]
+   backend_url = etcd3+http://localhost:2379?api_version=v3
+
+Usage
+=====
+
+To run the stress test in network mode::
+
+    venv/bin/python /path/to/ngs/tools/ngs-stress/ngs_stress.py \
+    --config-file /path/to/ngs-stress.conf \
+    --mode network \
+    --switch <switch name> \
+    --vlan-range <min>:<max>
+
+To run the stress test in port mode::
+
+    venv/bin/python /path/to/ngs/tools/ngs-stress/ngs_stress.py \
+    --config-file /path/to/ngs-stress.conf \
+    --mode port \
+    --switch <switch name> \
+    --vlan-range <vlan>:<vlan+1> \
+    --ports <port1,port2...>
+
+Other arguments are available, see ``--help``.

tools/ngs-stress/ngs_stress.py

@@ -0,0 +1,184 @@
+# Copyright (c) 2023 StackHPC Ltd.
+#
+# 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.
+
+import contextlib
+import queue
+import sys
+import threading
+import uuid
+
+import eventlet
+from neutron_lib.utils import net
+from oslo_config import cfg
+import oslo_log.log as logging
+
+import networking_generic_switch.generic_switch_mech as generic_switch
+
+eventlet.monkey_patch()
+
+CONF = cfg.CONF
+LOG = logging.getLogger(__name__)
+
+
+OPTS = [
+    cfg.HostAddressOpt('host', default=net.get_hostname(),
+                       help="Hostname to be used by NGS"),
+    cfg.StrOpt('mode', choices=['network', 'port'], required=True,
+               help='Mode of operation / resource type to exercise'),
+    cfg.StrOpt('ports',
+               help='Comma-separated list of ports to create in port mode.'),
+    cfg.StrOpt('switch', required=True,
+               help='Name of switch to connect to'),
+    cfg.StrOpt('vlan-range', required=True,
+               help='Colon-separated range of vlan IDs to create in network '
+                    'mode. In port mode the first will be used'),
+    cfg.BoolOpt('create-net', default=True,
+                help='Whether to create and delete a network in port mode'),
+    cfg.StrOpt('net-id', required=False,
+               help='Network UUID when create-net is false in port mode'),
+    cfg.IntOpt('iterations', default=1,
+               help='Number of test iterations'),
+]
+
+
+class ErrorQueueingThread(threading.Thread):
+    """Thread subclass which pushes a raised exception onto a queue."""
+
+    def __init__(self, target=None, eq=None, *args, **kwargs):
+        def new_target(*t_args, **t_kwargs):
+            with self.exceptions_queued(eq):
+                return target(*t_args, **t_kwargs)
+        super(ErrorQueueingThread, self).__init__(*args, target=new_target,
+                                                  **kwargs)
+
+    @contextlib.contextmanager
+    def exceptions_queued(self, eq):
+        try:
+            yield
+        except Exception:
+            eq.put(sys.exc_info())
+            raise
+
+
+def _log_excs_and_reraise(eq, reraise=True):
+    """Log all exceptions in a Queue and reraise one."""
+    while not eq.empty():
+        e = eq.get()
+        LOG.error("Exception seen during test", exc_info=e)
+        if reraise and eq.empty():
+            raise e[0]
+
+
+def _run_threads(ts):
+    """Start a list of threads then wait for them to complete."""
+    for t in ts:
+        t.start()
+    for t in ts:
+        t.join()
+
+
+def _gen_net_id():
+    """Dell Force10 switches can't handle net names beginning with a letter."""
+    while True:
+        net_id = str(uuid.uuid4())
+        try:
+            int(net_id[0])
+        except ValueError:
+            return net_id
+
+
+def _create_net(switch, vlan, net_id):
+    LOG.info("Creating VLAN %d", vlan)
+    switch.add_network(vlan, net_id)
+
+
+def _delete_net(switch, vlan, net_id):
+    LOG.info("Deleting VLAN %d", vlan)
+    switch.del_network(vlan, net_id)
+
+
+def _create_delete_net(switch, vlan, net_id):
+    """Create and delete a VLAN."""
+    _create_net(switch, vlan, net_id)
+    _delete_net(switch, vlan, net_id)
+
+
+def _create_delete_nets(switch, vlans):
+    """Create and delete VLANs in parallel."""
+    ts = []
+    eq = queue.Queue()
+    for vlan in vlans:
+        args = (switch, vlan, _gen_net_id())
+        t = ErrorQueueingThread(target=_create_delete_net, args=args,
+                                name='vlan-%d' % vlan, eq=eq)
+        ts.append(t)
+    _run_threads(ts)
+    _log_excs_and_reraise(eq)
+
+
+def _add_remove_port(switch, port_id, vlan):
+    """Add and remove a port to/from a VLAN."""
+    LOG.info("Adding port %s to VLAN %d", port_id, vlan)
+    switch.plug_port_to_network(port_id, vlan)
+    LOG.info("Removing port %s from VLAN %d", port_id, vlan)
+    switch.delete_port(port_id, vlan)
+
+
+def _add_remove_ports(switch, ports, vlan):
+    """Add and remove ports to/from a VLAN in parallel."""
+    ts = []
+    eq = queue.Queue()
+    if CONF.create_net:
+        net_id = _gen_net_id()
+        _create_net(switch, vlan, net_id)
+    else:
+        net_id = CONF.net_id
+    for port_id in ports:
+        args = (switch, port_id, vlan)
+        t = ErrorQueueingThread(target=_add_remove_port, args=args,
+                                name='port-%s' % port_id, eq=eq)
+        ts.append(t)
+    _run_threads(ts)
+    if CONF.create_net:
+        _delete_net(switch, vlan, net_id)
+    _log_excs_and_reraise(eq, reraise=False)
+
+
+def _init():
+    logging.register_options(CONF)
+    CONF.register_cli_opts(OPTS)
+    CONF(sys.argv[1:])
+    logging.setup(CONF, 'ngs_stress')
+    LOG.info("Starting NGS stress test")
+
+
+def main():
+    _init()
+    gs = generic_switch.GenericSwitchDriver()
+    gs.initialize()
+    switch = gs.switches[CONF.switch]
+    vlans = range(*map(int, CONF.vlan_range.split(':')))
+    if CONF.mode == 'network':
+        for _ in range(CONF.iterations):
+            _create_delete_nets(switch, vlans)
+    else:
+        vlan = vlans[0]
+        ports = CONF.ports.split(',')
+        for _ in range(CONF.iterations):
+            _add_remove_ports(switch, ports, vlan)
+    LOG.info("NGS stress test complete")
+
+
+if __name__ == "__main__":
+    main()