mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-09 14:50:02 -07:00
87969868d4
moved from the field attribute declaration and created a placeholder which then is resolved in the field attribute class. this is to avoid unwanted persistent of the defaults across objects which introduces stealth bugs when multiple objects of the same kind are used in succession while not overriding the default values.
97 lines
3.3 KiB
Python
97 lines
3.3 KiB
Python
# (c) 2014 Michael DeHaan, <michael@ansible.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from ansible.compat.six import iteritems, string_types
|
|
|
|
from ansible.errors import AnsibleParserError
|
|
from ansible.playbook.attribute import Attribute, FieldAttribute
|
|
from ansible.playbook.base import Base
|
|
from ansible.playbook.helpers import load_list_of_roles
|
|
from ansible.playbook.role.include import RoleInclude
|
|
|
|
|
|
__all__ = ['RoleMetadata']
|
|
|
|
|
|
class RoleMetadata(Base):
|
|
'''
|
|
This class wraps the parsing and validation of the optional metadata
|
|
within each Role (meta/main.yml).
|
|
'''
|
|
|
|
_allow_duplicates = FieldAttribute(isa='bool', default=False)
|
|
_dependencies = FieldAttribute(isa='list', default='_ansible_container')
|
|
_galaxy_info = FieldAttribute(isa='GalaxyInfo')
|
|
|
|
def __init__(self, owner=None):
|
|
self._owner = owner
|
|
super(RoleMetadata, self).__init__()
|
|
|
|
@staticmethod
|
|
def load(data, owner, variable_manager=None, loader=None):
|
|
'''
|
|
Returns a new RoleMetadata object based on the datastructure passed in.
|
|
'''
|
|
|
|
if not isinstance(data, dict):
|
|
raise AnsibleParserError("the 'meta/main.yml' for role %s is not a dictionary" % owner.get_name())
|
|
|
|
m = RoleMetadata(owner=owner).load_data(data, variable_manager=variable_manager, loader=loader)
|
|
return m
|
|
|
|
def _load_dependencies(self, attr, ds):
|
|
'''
|
|
This is a helper loading function for the dependencies list,
|
|
which returns a list of RoleInclude objects
|
|
'''
|
|
|
|
if ds is None:
|
|
ds = []
|
|
|
|
current_role_path = None
|
|
if self._owner:
|
|
current_role_path = os.path.dirname(self._owner._role_path)
|
|
|
|
try:
|
|
return load_list_of_roles(ds, play=self._owner._play, current_role_path=current_role_path, variable_manager=self._variable_manager, loader=self._loader)
|
|
except AssertionError:
|
|
raise AnsibleParserError("A malformed list of role dependencies was encountered.", obj=self._ds)
|
|
|
|
def _load_galaxy_info(self, attr, ds):
|
|
'''
|
|
This is a helper loading function for the galaxy info entry
|
|
in the metadata, which returns a GalaxyInfo object rather than
|
|
a simple dictionary.
|
|
'''
|
|
|
|
return ds
|
|
|
|
def serialize(self):
|
|
return dict(
|
|
allow_duplicates = self._allow_duplicates,
|
|
dependencies = self._dependencies,
|
|
)
|
|
|
|
def deserialize(self, data):
|
|
setattr(self, 'allow_duplicates', data.get('allow_duplicates', False))
|
|
setattr(self, 'dependencies', data.get('dependencies', []))
|