fc2292b230
The contextfilter decorator was deprecated in jinja2 3.0.0, and has been
dropped in 3.1.0. This results in the following warning, and failed
attempts to use filters:
[WARNING]: Skipping plugin (filters.py) as it seems to be invalid:
module 'jinja2' has no attribute 'contextfilter'
This change switches to use the pass_context decorator. The minimum
version of Jinja2 is raised to 3 to ensure pass_context is present.
Change-Id: I649dd6211d3ae72b9539bc44652ef8cf5d579777
99 lines
3.4 KiB
Python
99 lines
3.4 KiB
Python
# Copyright (c) 2019 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 jinja2
|
|
|
|
from kolla_ansible import exception
|
|
from kolla_ansible.helpers import _call_bool_filter
|
|
|
|
|
|
@jinja2.pass_context
|
|
def service_enabled(context, service):
|
|
"""Return whether a service is enabled.
|
|
|
|
:param context: Jinja2 Context object.
|
|
:param service: Service definition, dict.
|
|
:returns: A boolean.
|
|
"""
|
|
enabled = service.get('enabled')
|
|
if enabled is None:
|
|
raise exception.FilterError(
|
|
"Service definition for '%s' does not have an 'enabled' attribute"
|
|
% service.get("container_name", "<unknown>"))
|
|
return _call_bool_filter(context, enabled)
|
|
|
|
|
|
@jinja2.pass_context
|
|
def service_mapped_to_host(context, service):
|
|
"""Return whether a service is mapped to this host.
|
|
|
|
There are two ways to describe the service to host mapping. The most common
|
|
is via a 'group' attribute, where the service is mapped to all hosts in the
|
|
group. The second approach is via a 'host_in_groups' attribute, which is a
|
|
boolean expression which should be evaluated for every host. The latter
|
|
approach takes precedence over the first.
|
|
|
|
:param context: Jinja2 Context object.
|
|
:param service: Service definition, dict.
|
|
:returns: A boolean.
|
|
"""
|
|
host_in_groups = service.get("host_in_groups")
|
|
if host_in_groups is not None:
|
|
return _call_bool_filter(context, host_in_groups)
|
|
|
|
group = service.get("group")
|
|
if group is not None:
|
|
return group in context.get("group_names") or group == "all"
|
|
|
|
raise exception.FilterError(
|
|
"Service definition for '%s' does not have a 'group' or "
|
|
"'host_in_groups' attribute" %
|
|
service.get("container_name", "<unknown>"))
|
|
|
|
|
|
@jinja2.pass_context
|
|
def service_enabled_and_mapped_to_host(context, service):
|
|
"""Return whether a service is enabled and mapped to this host.
|
|
|
|
:param context: Jinja2 Context object.
|
|
:param service: Service definition, dict.
|
|
:returns: A boolean.
|
|
"""
|
|
return (service_enabled(context, service) and
|
|
service_mapped_to_host(context, service))
|
|
|
|
|
|
@jinja2.pass_context
|
|
def select_services_enabled_and_mapped_to_host(context, services):
|
|
"""Select services that are enabled and mapped to this host.
|
|
|
|
:param context: Jinja2 Context object.
|
|
:param services: Service definitions, dict.
|
|
:returns: A dict containing enabled services mapped to this host.
|
|
"""
|
|
return {service_name: service
|
|
for service_name, service in services.items()
|
|
if service_enabled_and_mapped_to_host(context, service)}
|
|
|
|
|
|
def get_filters():
|
|
return {
|
|
"service_enabled": service_enabled,
|
|
"service_mapped_to_host": service_mapped_to_host,
|
|
"service_enabled_and_mapped_to_host": (
|
|
service_enabled_and_mapped_to_host),
|
|
"select_services_enabled_and_mapped_to_host": (
|
|
select_services_enabled_and_mapped_to_host),
|
|
}
|