PackageHasRetryRule.py

# Copyright (c) 2016, Will Thames and contributors
# Copyright (c) 2018, Ansible Project

from ansiblelint import AnsibleLintRule


class PackageHasRetryRule(AnsibleLintRule):
    id = '405'
    shortdesc = 'Remote package tasks should have a retry'
    description = ('Package operations are unreliable as they require'
                   'network communication and the availability of remote'
                   'servers. To mitigate the potential problems, retries '
                   'should be used.')
    tags = ['module', 'reliability']

    # module list generated with:
    # find lib/ansible/modules/packaging/ -type f -printf '%f\n' \
    #   | sort | awk -F '/' \
    #   '/__|dpkg|_repo|_facts|_sub|_chan/{next} {split($NF, words, ".");
    #   print "\""words[1]"\","}'
    package_modules = [
        "apk",
        "apt_key",
        "apt",
        "apt_rpm",
        "bower",
        "bundler",
        "composer",
        "cpanm",
        "dnf",
        "easy_install",
        "flatpak",
        "flatpak_remote",
        "gem",
        "homebrew_cask",
        "homebrew",
        "homebrew_tap",
        "layman",
        "macports",
        "maven_artifact",
        "npm",
        "openbsd_pkg",
        "opkg",
        "package",
        "pacman",
        "pear",
        "pip",
        "pkg5_publisher",
        "pkg5",
        "pkgin",
        "pkgng",
        "pkgutil",
        "portage",
        "portinstall",
        "rhn_register",
        "rpm_key",
        "slackpkg",
        "snap",
        "sorcery",
        "svr4pkg",
        "swdepot",
        "swupd",
        "urpmi",
        "xbps",
        "yarn",
        "yum",
        "zypper",
    ]

    def matchtask(self, file, task):
        return (task['action']['__ansible_module__'] in self.package_modules
                and 'until' not in task)