ApproachingLimitDescription.py

"""
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0
"""
from cfnlint.rules import CloudFormationLintRule
from cfnlint.rules import RuleMatch
from cfnlint.helpers import LIMITS


class LimitDescription(CloudFormationLintRule):
    """Check Template Description Size"""

    id = 'I1003'
    shortdesc = 'Template description limit'
    description = (
        'Check if the size of the template description is approaching the upper limit'
    )
    source_url = 'https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html'
    tags = ['description', 'limits']

    def match(self, cfn):
        matches = []
        description = cfn.template.get('Description', '')
        if (
            LIMITS['threshold'] * LIMITS['template']['description']
            < len(description)
            <= LIMITS['template']['description']
        ):
            message = 'The template description ({0} bytes) is approaching the limit ({1} bytes)'
            matches.append(
                RuleMatch(
                    ['Description'],
                    message.format(len(description), LIMITS['template']['description']),
                )
            )
        return matches