# Copyright (c) 2013-2014 Will Thames <will@thames.id.au> # # 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 os from ansiblelint.rules import AnsibleLintRule from ansiblelint.utils import get_first_cmd_arg try: from ansible.module_utils.parsing.convert_bool import boolean except ImportError: try: from ansible.utils.boolean import boolean except ImportError: try: from ansible.utils import boolean except ImportError: from ansible import constants boolean = constants.mk_boolean class CommandsInsteadOfModulesRule(AnsibleLintRule): id = '303' shortdesc = 'Using command rather than module' description = ( 'Executing a command when there is an Ansible module ' 'is generally a bad idea' ) severity = 'HIGH' tags = ['command-shell', 'resources', 'ANSIBLE0006'] version_added = 'historic' _commands = ['command', 'shell'] _modules = { 'apt-get': 'apt-get', 'chkconfig': 'service', 'curl': 'get_url or uri', 'git': 'git', 'hg': 'hg', 'letsencrypt': 'acme_certificate', 'mktemp': 'tempfile', 'mount': 'mount', 'patch': 'patch', 'rpm': 'yum or rpm_key', 'rsync': 'synchronize', 'sed': 'template, replace or lineinfile', 'service': 'service', 'supervisorctl': 'supervisorctl', 'svn': 'subversion', 'systemctl': 'systemd', 'tar': 'unarchive', 'unzip': 'unarchive', 'wget': 'get_url or uri', 'yum': 'yum', } def matchtask(self, file, task): if task['action']['__ansible_module__'] not in self._commands: return first_cmd_arg = get_first_cmd_arg(task) if not first_cmd_arg: return executable = os.path.basename(first_cmd_arg) if executable in self._modules and \ boolean(task['action'].get('warn', True)): message = '{0} used in place of {1} module' return message.format(executable, self._modules[executable])