90 lines
3.0 KiB
Python
Raw Normal View History

# Copyright 2014 Red Hat, Inc.
#
# 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 copy
import itertools
from oslo_messaging._drivers import amqp
from oslo_messaging._drivers.amqp1_driver import opts as amqp_opts
from oslo_messaging._drivers import base as drivers_base
from oslo_messaging._drivers import impl_rabbit
from oslo_messaging._drivers.kafka_driver import kafka_options
from oslo_messaging.notify import notifier
from oslo_messaging.rpc import client
from oslo_messaging import server
from oslo_messaging import transport
__all__ = [
'list_opts'
]
_global_opt_lists = [
drivers_base.base_opts,
server._pool_opts,
client._client_opts,
An initial implementation of an AMQP 1.0 based messaging driver The key driver interfaces are implemented in the ProtonDriver class in driver.py. The logic for interfacing with Pyngus in order to send/receive messages, manage AMQP connections and links, and handle protocol events is in controller.py. eventloop.py is a fairly generic socket connection and I/O processor which runs in its own thread. controller.py uses the eventloop.py thread to schedule subscription and message send requests from the driver, as well as handle all protocol event callbacks coming from Pyngus. Included in this patch are a set of functional tests that can be run under tox (tox -eamqp1). These tests fully exercise the new driver, from the driver API down to the 'wire' - nothing in the driver is mocked out. The functional tests implement a simple loopback test broker, which allows the driver to send and receive messages via the local network. All RPC call patterns, RPC timeouts, and even broker failover are verified by the included functional tests. This driver uses the Pyngus module, which is a pure-python client API built on the Proton AMQP 1.0 protocol engine library from the Apache Qpid project. Pyngus is available via pypi.python.org. This driver introduces a dependency on the Proton AMQP 1.0 protocol library, which is a platform-dependent library that must be installed in order to use this driver and run the functional tests. Change-Id: I871703e4cdc04cee3e6c214e911c9df464ede2ed Implements: blueprint amqp10-driver-implementation
2014-02-21 21:13:17 +00:00
transport._transport_opts,
]
_opts = [
(None, list(itertools.chain(*_global_opt_lists))),
('oslo_messaging_amqp', amqp_opts.amqp1_opts),
('oslo_messaging_notifications', notifier._notifier_opts),
('oslo_messaging_rabbit', list(
itertools.chain(amqp.amqp_opts, impl_rabbit.rabbit_opts))),
('oslo_messaging_kafka', kafka_options.KAFKA_OPTS),
]
def list_opts():
"""Return a list of oslo.config options available in the library.
The returned list includes all oslo.config options which may be registered
at runtime by the library.
Each element of the list is a tuple. The first element is the name of the
group under which the list of elements in the second element will be
registered. A group name of None corresponds to the [DEFAULT] group in
config files.
This function is also discoverable via the 'oslo_messaging' entry point
under the 'oslo.config.opts' namespace.
The purpose of this is to allow tools like the Oslo sample config file
generator to discover the options exposed to users by this library.
:returns: a list of (group_name, opts) tuples
"""
return [(g, copy.deepcopy(o)) for g, o in _opts]
def set_defaults(conf, executor_thread_pool_size=None):
"""Set defaults for configuration variables.
Overrides default options values.
:param conf: Config instance specified to set default options in it. Using
of instances instead of a global config object prevents conflicts between
options declaration.
:type conf: oslo.config.cfg.ConfigOpts instance.
:keyword executor_thread_pool_size: Size of executor thread pool.
:type executor_thread_pool_size: int
:default executor_thread_pool_size: None
"""
if executor_thread_pool_size is not None:
conf.set_default('executor_thread_pool_size',
executor_thread_pool_size)