summaryrefslogtreecommitdiffstats
path: root/lib/ansiblelint/rules/MetaChangeFromDefaultRule.py
blob: db52db30bd32b14bfac32e0793a5c5c6e2045b00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Copyright (c) 2018, Ansible Project

from ansiblelint.rules import AnsibleLintRule


class MetaChangeFromDefaultRule(AnsibleLintRule):
    id = '703'
    shortdesc = 'meta/main.yml default values should be changed'
    field_defaults = [
        ('author', 'your name'),
        ('description', 'your description'),
        ('company', 'your company (optional)'),
        ('license', 'license (GPLv2, CC-BY, etc)'),
        ('license', 'license (GPL-2.0-or-later, MIT, etc)'),
    ]
    description = (
        'meta/main.yml default values should be changed for: ``{}``'.format(
            ', '.join(f[0] for f in field_defaults)
        )
    )
    severity = 'HIGH'
    tags = ['metadata']
    version_added = 'v4.0.0'

    def matchplay(self, file, data):
        if file['type'] != 'meta':
            return False

        galaxy_info = data.get('galaxy_info', None)
        if not galaxy_info:
            return False

        results = []
        for field, default in self.field_defaults:
            value = galaxy_info.get(field, None)
            if value and value == default:
                results.append(({'meta/main.yml': data},
                                'Should change default metadata: %s' % field))

        return results