# Copyright (c) 2020 Gael Chamoulaud # Copyright (c) 2020 Sorin Sbarnea # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import re from pathlib import Path from typing import List from ansiblelint.rules import AnsibleLintRule from ansiblelint.utils import parse_yaml_from_file ROLE_NAME_REGEX = '^[a-z][a-z0-9_]+$' def _remove_prefix(text, prefix): return re.sub(r'^{0}'.format(re.escape(prefix)), '', text) class RoleNames(AnsibleLintRule): id = '106' shortdesc = ( "Role name {} does not match ``%s`` pattern" % ROLE_NAME_REGEX ) description = ( "Role names are now limited to contain only lowercase alphanumeric " "characters, plus '_' and start with an alpha character. See " "`developing collections `_" ) severity = 'HIGH' done: List[str] = [] # already noticed roles list tags = ['deprecated'] version_added = 'v4.3.0' ROLE_NAME_REGEXP = re.compile(ROLE_NAME_REGEX) def match(self, file, text): path = file['path'].split("/") if "tasks" in path: role_name = _remove_prefix(path[path.index("tasks") - 1], "ansible-role-") role_root = path[:path.index("tasks")] meta = Path("/".join(role_root)) / "meta" / "main.yml" if meta.is_file(): meta_data = parse_yaml_from_file(str(meta)) if meta_data: try: role_name = meta_data['galaxy_info']['role_name'] except KeyError: pass if role_name in self.done: return False self.done.append(role_name) if not re.match(self.ROLE_NAME_REGEXP, role_name): return self.shortdesc.format(role_name) return False