def match(self, cfn: Template) -> List[RuleMatch]: matches = [] projects = cfn.get_resources(["AWS::CodeBuild::Project"]) log_groups = cfn.get_resources(["AWS::Logs::LogGroup"]) for resource_name, resource in projects.items(): properties = resource.get("Properties", {}) logs_config = properties.get("LogsConfig", {}) cloud_watch_logs = logs_config.get("CloudWatchLogs", {}) path = [ "Resources", resource_name, "Properties", "LogsConfig", "CloudWatchLogs", "GroupName", ] if cloud_watch_logs.get( "Status", "ENABLED" ) == "ENABLED" and not cloud_watch_logs.get("GroupName"): message = f"Property {'/'.join(path)} is missing. CodeBuild projects with cloudwatch logs enabled, should have a GroupName defined." matches.append(RuleMatch(path, message)) group_name = cloud_watch_logs.get("GroupName") if group_name and (not isinstance(group_name, dict) or not group_name.get("Ref") in log_groups.keys()): message = f"Property {'/'.join(path)} should be a Ref to a LogGroup." matches.append(RuleMatch(path, message)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] resources = cfn.get_resources(["AWS::ECS::Service"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) deployment_configuration = properties.get( "DeploymentConfiguration", {}) if not deployment_configuration: path = [ "Resources", resource_name, "Properties", "DeploymentConfiguration", ] message = ( f"{'/'.join(path)} Property DeploymentConfiguration is missing." ) matches.append(RuleMatch(path, message)) deployment_circuit_breaker = deployment_configuration.get( "DeploymentCircuitBreaker", {}) if not deployment_circuit_breaker: path = [ "Resources", resource_name, "Properties", "DeploymentConfiguration", "DeploymentCircuitBreaker", ] message = f"{'/'.join(path)} Property DeploymentConfiguration/DeploymentCircuitBreaker is missing." matches.append(RuleMatch(path, message)) if not deployment_circuit_breaker.get("Enable") is True: path = [ "Resources", resource_name, "Properties", "DeploymentConfiguration", "DeploymentCircuitBreaker", "Enable", ] message = f"{'/'.join(path)} Property DeploymentConfiguration/DeploymentCircuitBreaker/Enable should be true." matches.append(RuleMatch(path, message)) if not deployment_circuit_breaker.get("Rollback") is False: path = [ "Resources", resource_name, "Properties", "DeploymentConfiguration", "DeploymentCircuitBreaker", "Rollback", ] message = f"{'/'.join(path)} Property DeploymentConfiguration/DeploymentCircuitBreaker/Rollback should be false." matches.append(RuleMatch(path, message)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] resources = cfn.get_resources(["AWS::S3::Bucket"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) if not "BucketEncryption" in properties: path = ["Resources", resource_name, "Properties", "BucketEncryption"] message = f"Property {'/'.join(path)} is missing" matches.append(RuleMatch(path, message)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] resources = cfn.get_resources( ["AWS::CloudFront::ResponseHeadersPolicy"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) strict_transpost_security = (properties.get( "ResponseHeadersPolicyConfig", {}).get("SecurityHeadersConfig", {}).get("StrictTransportSecurity", {})) two_years = 2 * 365 * 24 * 60 * 60 # strict_transpost_security.get("AccessControlMaxAgeSec") >= two_years path = [ "Resources", resource_name, "ResponseHeadersPolicyConfig", "SecurityHeadersConfig", "StrictTransportSecurity", "AccessControlMaxAgeSec", ] access_control_max_age_sec = strict_transpost_security.get( "AccessControlMaxAgeSec") if (not isinstance(access_control_max_age_sec, int) or not access_control_max_age_sec >= two_years): message = f"Property {'/'.join(path)} should be an integer bigger or equal to 2 years ({two_years})." matches.append(RuleMatch(path, message)) path = [ "Resources", resource_name, "ResponseHeadersPolicyConfig", "SecurityHeadersConfig", "StrictTransportSecurity", "Override", ] if not strict_transpost_security.get("Override") == True: message = f"Property {'/'.join(path)} should be true." matches.append(RuleMatch(path, message)) strict_transpost_security.get("Override") == True return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] resources = cfn.get_resources(["AWS::CloudFront::Distribution"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) logging = properties.get("DistributionConfig", {}).get("Logging") path = [ "Resources", resource_name, "Properties", "DistributionConfig", "Logging", ] if not logging: message = f"Property {'/'.join(path)} is missing" matches.append(RuleMatch(path, message)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] valid_platform_versions = ["LATEST", "1.4.0"] resources = cfn.get_resources(["AWS::ECS::Service"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) platform_version = properties.get("PlatformVersion") if platform_version is None: continue if not platform_version in valid_platform_versions: path = [ "Resources", resource_name, "Properties", "PlatformVersion" ] message = f"{'/'.join(path)} {platform_version} is outdated. Set it to one of: {', '.join(valid_platform_versions)}" matches.append(RuleMatch(path, message)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] resources = cfn.get_resources(["AWS::CertificateManager::Certificate"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) tags = properties.get("Tags", []) path = [ "Resources", resource_name, "Properties", "Tags", ] for tag in tags: if tag.get("Key") == "Name": break else: message = f"Property {'/'.join(path)} is missing 'Name' tag" matches.append(RuleMatch(path, message)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] resources = cfn.get_resources(["AWS::CloudFront::Distribution"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) default_cache_behavior = properties.get( "DistributionConfig", {}).get("DefaultCacheBehavior", {}) path = [ "Resources", resource_name, "Properties", "DistributionConfig", "DefaultCacheBehavior", ] if not default_cache_behavior.get("ResponseHeadersPolicyId"): message = ( f"Property {'/'.join(path)}/ResponseHeadersPolicyId is missing" ) matches.append(RuleMatch(path, message)) for index, cache_behavior in enumerate( properties.get("DistributionConfig", {}).get("CacheBehaviors", [])): path = [ "Resources", resource_name, "Properties", "DistributionConfig", "CacheBehaviors", index, ] if not cache_behavior.get("ResponseHeadersPolicyId"): message = f"Property ResponseHeadersPolicyId missing at {'/'.join([str(p) for p in path])}" matches.append(RuleMatch(path, message)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches: List[RuleMatch] = [] template_metadata = cfn.template.get("Metadata", {}) if "AxChangesetAutoApprove" in template_metadata: template_ax_changeset_auto_approve = template_metadata[ "AxChangesetAutoApprove"] matches.extend( self.check_template_ax_changeset_auto_approve( template_ax_changeset_auto_approve)) for resource_name, resource in cfn.get_resources().items(): resource_metadata = resource.get("Metadata", {}) if "AxChangesetAutoApprove" not in resource_metadata: continue resource_ax_changeset_auto_approve = resource_metadata[ "AxChangesetAutoApprove"] matches.extend( self.check_resource_ax_changeset_auto_approve( resource_name, resource_ax_changeset_auto_approve)) return matches
def match(self, cfn: Template) -> List[RuleMatch]: matches = [] resources = cfn.get_resources(["AWS::S3::Bucket"]) for resource_name, resource in resources.items(): properties = resource.get("Properties", {}) public_access_block_configuration = properties.get( "PublicAccessBlockConfiguration" ) path = [ "Resources", resource_name, "Properties", "PublicAccessBlockConfiguration", ] if not public_access_block_configuration: message = f"Property {'/'.join(path)} is missing" matches.append(RuleMatch(path, message)) continue for key in [ "BlockPublicAcls", "BlockPublicPolicy", "IgnorePublicAcls", "RestrictPublicBuckets", ]: value = public_access_block_configuration.get(key) if value is None: detail_path = path + [key] message = f"Property {'/'.join(detail_path)} is missing and should be true" matches.append(RuleMatch(detail_path, message)) elif not (value is True or value == "true"): detail_path = path + [key] message = f"Property {'/'.join(detail_path)} should be true" matches.append(RuleMatch(detail_path, message)) return matches
class TestTemplate(BaseTestCase): """Test Template Class in cfnlint """ def setUp(self): """ SetUp template object""" filename = 'test/fixtures/templates/good/generic.yaml' template = self.load_template(filename) self.template = Template(filename, template) self.resource_names = [ 'IamPipeline', 'RootInstanceProfile', 'RolePolicies', 'MyEC2Instance', 'RootRole', 'mySnsTopic', 'MyEC2Instance1', 'ElasticLoadBalancer', 'MyModule' ] self.parameter_names = [ 'WebServerPort', 'Package', 'Package1', 'pIops' ] def test_build_graph(self): self.template.build_graph() dot = 'test/fixtures/templates/good/generic.yaml.dot' expected_content = """digraph "template" { RootRole [label="RootRole\\n<AWS::IAM::Role>"]; MyModule [label="MyModule\\n<My::Organization::Custom::MODULE>"]; RolePolicies [label="RolePolicies\\n<AWS::IAM::Policy>"]; RootInstanceProfile [label="RootInstanceProfile\\n<AWS::IAM::InstanceProfile>"]; MyEC2Instance [label="MyEC2Instance\\n<AWS::EC2::Instance>"]; mySnsTopic [label="mySnsTopic\\n<AWS::SNS::Topic>"]; MyEC2Instance1 [label="MyEC2Instance1\\n<AWS::EC2::Instance>"]; ElasticIP [label="ElasticIP\\n<AWS::EC2::EIP>"]; ElasticLoadBalancer [label="ElasticLoadBalancer\\n<AWS::ElasticLoadBalancing::LoadBalancer>"]; IamPipeline [label="IamPipeline\\n<AWS::CloudFormation::Stack>"]; CustomResource [label="CustomResource\\n<Custom::Function>"]; WaitCondition [label="WaitCondition\\n<AWS::CloudFormation::WaitCondition>"]; RolePolicies -> RootRole [key=0, label=Ref]; RootInstanceProfile -> RootRole [key=0, label=Ref]; MyEC2Instance -> RootInstanceProfile [key=0, label=Ref]; ElasticLoadBalancer -> MyEC2Instance [key=0, label=Ref]; } """.split('\n') assert os.path.exists(dot) with open(dot, 'r') as file: file_contents = file.read().split('\n') # doing set equality instead of string equality because python 2.7 and 3.8 produce the same graph but with different edge order assert len(file_contents) == len(expected_content) and sorted(file_contents) == sorted(expected_content) os.remove(dot) def test_get_resources_success(self): """Test Success on Get Resources""" valid_resource_count = 12 resources = self.template.get_resources() assert len(resources) == valid_resource_count, 'Expected {} resources, got {}'.format( valid_resource_count, len(resources)) def test_get_modules_success(self): """Test Success on Get Modules""" expected_modules_count = 1 actual_modules = self.template.get_modules() assert len(actual_modules) == expected_modules_count, 'Expected {} modules, got {}'.format( expected_modules_count, len(actual_modules)) def test_get_resources_bad(self): """Don't get resources that aren't properly configured""" template = { 'Resources': { 'Properties': { 'BucketName': "bucket_test" }, 'Type': "AWS::S3::Bucket" } } self.template = Template('test.yaml', template) resources = self.template.get_resources() assert resources == {} def test_get_resource_names(self): """ Test Resource Names""" resource_names = self.template.get_resource_names() assert bool(set(resource_names).intersection(self.resource_names)) def test_get_parameters(self): """ Test Get Parameters""" valid_parameter_count = 7 parameters = self.template.get_parameters() assert len(parameters) == valid_parameter_count, 'Expected {} parameters, got {}'.format( valid_parameter_count, len(parameters)) def test_get_parameter_names(self): """Test Get Parameter Names""" parameters = self.template.get_parameter_names() assert bool(set(parameters).intersection(self.parameter_names)) def test_get_valid_refs(self): """ Get Valid REFs""" valid_ref_count = 27 refs = self.template.get_valid_refs() assert len(refs) == valid_ref_count, 'Expected {} refs, got {}'.format( valid_ref_count, len(refs)) def test_conditions_return_object_success(self): """Test condition object response and nested IFs""" template = [ 'isProd', { 'Key': 'Environment1', 'Value': 'Prod' }, { 'Fn::If': [ 'isDev', { 'Key': 'Environment2', 'Value': 'Dev' }, { "Ref": "AWS::NoValue" } ] } ] results = self.template.get_condition_values(template, []) self.assertEqual(results, [ {'Path': [1], 'Value': {'Value': 'Prod', 'Key': 'Environment1'}}, {'Path': [2, 'Fn::If', 1], 'Value': {'Value': 'Dev', 'Key': 'Environment2'}} ]) def test_conditions_return_list_success(self): """Test condition list response""" template = [ 'PrimaryRegion', [ 'EN' ], [ 'BE', 'LU', 'NL' ] ] results = self.template.get_condition_values(template, []) self.assertEqual(results, [ {'Value': ['EN'], 'Path': [1]}, {'Value': ['BE', 'LU', 'NL'], 'Path': [2]} ]) def test_conditions_return_string_success(self): """Test condition object response and nested IFs""" template = [ 'isProd', { 'Ref': 'Sample' }, 'String' ] results = self.template.get_condition_values(template, []) self.assertEqual(results, [ {'Path': [1], 'Value': {'Ref': 'Sample'}}, {'Path': [2], 'Value': 'String'} ]) def test_is_resource_available(self): """ Test is resource available """ temp_obj = cfnlint.helpers.convert_dict({ 'Mappings': {'location': {'us-east-1': {'primary': 'True'}}}, 'Conditions': { 'isPrimary': {'Fn::Equals': ['True', {'Fn::FindInMap': ['location', {'Ref': 'AWS::Region'}, 'primary']}]}, }, 'Resources': { 'LambdaExecutionRole': { 'Condition': 'isPrimary', 'Type': 'AWS::IAM::Role', 'Properties': {} }, 'AMIIDLookup': { 'Type': 'AWS::Lambda::Function', 'Properties': { 'Handler': 'index.handler', 'Role': { 'Fn::If': ['isPrimary', {'Fn::GetAtt': 'LambdaExecutionRole.Arn'}, {'Ref': 'AWS::NoValue'}] } } } }, 'Outputs': { 'lambdaArn': { 'Condition': 'isPrimary', 'Value': {'Fn::GetAtt': 'LambdaExecutionRole.Arn'} } } }) template = Template('test.yaml', temp_obj) # Doesn't fail with a Fn::If based condition self.assertEqual( template.is_resource_available( ['Resources', 'AMIIDLookup', 'Properties', 'Role', 'Fn::If', 1, 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']], 'LambdaExecutionRole' ), [] ) # Doesn't fail when the Output has a Condition defined self.assertEqual( template.is_resource_available( ['Outputs', 'lambdaArn', 'Value', 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']], 'LambdaExecutionRole' ), [] ) # Doesn't fail when the Resource doesn't exist self.assertEqual( template.is_resource_available( ['Outputs', 'lambdaArn', 'Value', 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']], 'UnknownResource' ), [] ) def test_is_resource_not_available(self): """ Test is resource available """ temp_obj = cfnlint.helpers.convert_dict({ 'Mappings': {'location': {'us-east-1': {'primary': 'True'}}}, 'Conditions': { 'isPrimary': {'Fn::Equals': ['True', {'Fn::FindInMap': ['location', {'Ref': 'AWS::Region'}, 'primary']}]}, }, 'Resources': { 'LambdaExecutionRole': { 'Condition': 'isPrimary', 'Type': 'AWS::IAM::Role', 'Properties': {} }, 'AMIIDLookup': { 'Type': 'AWS::Lambda::Function', 'Properties': { 'Handler': 'index.handler', 'Role': {'Fn::GetAtt': 'LambdaExecutionRole.Arn'} } } }, 'Outputs': { 'lambdaArn': { 'Value': {'Fn::GetAtt': 'LambdaExecutionRole.Arn'} } } }) template = Template('test.yaml', temp_obj) self.assertEqual( template.is_resource_available( ['Resources', 'AMIIDLookup', 'Properties', 'Role', 'Fn::If', 1, 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']], 'LambdaExecutionRole' ), [{'isPrimary': False}] ) self.assertEqual( template.is_resource_available( ['Outputs', 'lambdaArn', 'Value', 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']], 'LambdaExecutionRole' ), [{'isPrimary': False}] ) # Doesn't fail when the Path doesn't exist. Still shows an error based on the fact there # are no conditions in the path that is workable self.assertEqual( template.is_resource_available( ['Resources', 'AMIIDLookup', 'Properties', 'BadProperty', 'Fn::If', 1, 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']], 'LambdaExecutionRole' ), [{'isPrimary': False}] ) # Gives appropriate response when there is no condition in path self.assertEqual( template.is_resource_available( ['Resources', 'AMIIDLookup', 'Properties', 'Handler'], 'LambdaExecutionRole' ), [{'isPrimary': False}] ) def test_get_conditions_from_path(self): """ Test is resource available """ temp_obj = cfnlint.helpers.convert_dict({ 'Resources': { 'AMIIDLookup': { 'Type': 'AWS::Lambda::Function', 'Properties': { 'Role': { 'Fn::If': ['isPrimary', {'Fn::GetAtt': 'LambdaExecutionRole.Arn'}, {'Ref': 'AWS::NoValue'}] } } }, 'InstanceProfile': { 'Condition': 'isPrimaryAndProduction', 'Type': 'AWS::IAM::InstanceProfile', 'Properties': { 'Path': '/', 'Roles': [{'Ref': 'LambdaExecutionRole'}] } } }, 'Outputs': { 'lambdaArn': { 'Condition': 'isPrimary', 'Value': {'Fn::GetAtt': 'LambdaExecutionRole.Arn'} } } }) template = Template('test.yaml', temp_obj) # Gets the condition when in the middle of the Path self.assertEqual( template.get_conditions_from_path( template.template, ['Resources', 'AMIIDLookup', 'Properties', 'Role', 'Fn::If', 1, 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']] ), {'isPrimary': {True}} ) self.assertEqual( template.get_conditions_from_path( template.template, ['Resources', 'AMIIDLookup', 'Properties', 'Role', 'Fn::If'] ), {'isPrimary': {True, False}} ) self.assertEqual( template.get_conditions_from_path( template.template, ['Outputs', 'lambdaArn', 'Value', 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']] ), {'isPrimary': {True}} ) self.assertEqual( template.get_conditions_from_path( template.template, ['Resources', 'InstanceProfile', 'Properties', 'Roles', 0, 'Ref', 'LambdaExecutionRole'] ), {'isPrimaryAndProduction': {True}} ) self.assertEqual( template.get_conditions_from_path( template.template, ['Resources', 'AMIIDLookup', 'Properties', 'Handler', 'Ref', 'LambdaHandler'] ), {} ) def test_failure_get_conditions_from_path(self): """ Test get conditions from path when things arne't formatted correctly """ temp_obj = cfnlint.helpers.convert_dict({ 'Resources': { 'AMIIDLookup': { 'Type': 'AWS::Lambda::Function', 'Properties': { 'Role': { 'Fn::If': ['isPrimary', {'Fn::GetAtt': 'LambdaExecutionRole.Arn'}] } } }, 'myInstance4': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'InstanceType': { 'Fn::If': { 'Fn::If': ['isPrimary', 't3.2xlarge', 't3.xlarge'] } } } } } }) template = Template('test.yaml', temp_obj) # Gets no condition names when it isn't a valid list self.assertEqual( template.get_conditions_from_path( template.template, ['Resources', 'AMIIDLookup', 'Properties', 'Role', 'Fn::If', 1, 'Fn::GetAtt', ['LambdaExecutionRole', 'Arn']] ), {} ) # Gets no condition names when it isn't really a list self.assertEqual( template.get_conditions_from_path( template.template, ['Resources', 'myInstance4', 'Properties', 'InstanceType', 'Fn::If', 'Fn::If', 0] ), {} ) def test_get_conditions_scenarios_from_object(self): """ Test Getting condition names in an object/list """ template = { 'Conditions': { 'isProduction': {'Fn::Equals': [{'Ref': 'myEnvironment'}, 'Prod']}, 'isPrimary': {'Fn::Equals': ['True', {'Fn::FindInMap': ['location', {'Ref': 'AWS::Region'}, 'primary']}]}, 'isPrimaryAndProduction': {'Fn::And': [{'Condition': 'isProduction'}, {'Condition': 'isPrimary'}]}, 'isDevelopment': {'Fn::Equals': [{'Ref': 'myEnvironment'}, 'Dev']} }, 'Resources': { 'myInstance1': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'Fn::If': [ 'isPrimaryAndProduction', { 'ImageId': 'ami-1234567', 'InstanceType': 't2.medium' }, { 'Fn::If': [ 'isDevelopment', { 'ImageId': 'ami-abcdefg', 'InstanceType': 't2.xlarge' }, { 'ImageId': 'ami-123abcd', 'InstanceType': 'm3.medium' } ] } ] } }, 'myInstance2': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'ImageId': { 'Fn::If': ['isProduction', 'ami-123456', 'ami-abcdef'] }, 'InstanceType': { 'Fn::If': [ 'isPrimaryAndProduction', { 'Fn::If': ['isPrimary', 't3.2xlarge', 't3.xlarge'] }, 't3.medium' ] } } } } } template = Template('test.yaml', template) # includes nested IFs self.assertEqualListOfDicts( template.get_conditions_scenarios_from_object( template.template.get('Resources', {}).get('myInstance2', {}).get('Properties', {}) ), [ {'isPrimary': True, 'isProduction': True, 'isPrimaryAndProduction': True}, {'isPrimary': True, 'isProduction': False, 'isPrimaryAndProduction': False}, {'isPrimary': False, 'isProduction': True, 'isPrimaryAndProduction': False}, {'isPrimary': False, 'isProduction': False, 'isPrimaryAndProduction': False} ] ) self.assertEqualListOfDicts( template.get_conditions_scenarios_from_object( template.template.get('Resources', {}).get('myInstance1', {}).get('Properties', {}) ), [ {'isPrimaryAndProduction': True, 'isDevelopment': False}, {'isPrimaryAndProduction': False, 'isDevelopment': True}, {'isPrimaryAndProduction': False, 'isDevelopment': False}, ] ) def test_get_object_without_conditions(self): """ Test Getting condition names in an object/list """ template = cfnlint.helpers.convert_dict({ 'Conditions': { 'useAmiId': {'Fn::Not': [{'Fn::Equals': [{'Ref': 'myAmiId'}, '']}]} }, 'Resources': { 'myInstance': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'ImageId': {'Fn::If': ['useAmiId', {'Ref': 'myAmiId'}, {'Ref': 'AWS::NoValue'}]}, 'LaunchConfiguration': {'Fn::If': ['useAmiId', {'Ref': 'AWS::NoValue'}, {'Ref': 'LaunchConfiguration'}]} } } } }) template = Template('test.yaml', template) results = template.get_object_without_conditions( template.template.get('Resources', {}).get('myInstance', {}).get('Properties', {}) ) for result in results: if result['Scenario'] == {'useAmiId': True}: self.assertDictEqual( result['Object'], { 'ImageId': {'Ref': 'myAmiId'} } ) elif result['Scenario'] == {'useAmiId': False}: self.assertDictEqual( result['Object'], { 'LaunchConfiguration': {'Ref': 'LaunchConfiguration'} } ) def test_get_object_without_conditions_no_value(self): """ Test Getting condition names in an object/list """ template = { 'Conditions': { 'CreateAppVolume': {'Fn::Equals': [{'Ref': 'myAppVolume'}, 'true']} }, 'Resources': { 'myInstance': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'ImageId': 'ami-123456', 'BlockDeviceMappings': [ { 'DeviceName': '/dev/hda1', 'Ebs': { 'DeleteOnTermination': True, 'VolumeType': 'gp2' } }, { 'Fn::If': [ 'CreateAppVolume', { 'DeviceName': '/dev/xvdf', 'Ebs': { 'DeleteOnTermination': True, 'VolumeType': 'gp2' } }, { 'Ref': 'AWS::NoValue' } ] } ] } } } } template = Template('test.yaml', template) results = template.get_object_without_conditions( template.template.get('Resources').get('myInstance').get( 'Properties').get('BlockDeviceMappings')[1].get('Fn::If')[2] ) self.assertEqual(results, []) results = template.get_object_without_conditions( template.template.get('Resources').get('myInstance').get( 'Properties').get('BlockDeviceMappings') ) # when item is a list return empty list self.assertEqual(results, []) # when item is a string return empty list self.assertEqual(template.get_object_without_conditions('String'), []) def test_get_object_without_conditions_for_list(self): """ Test Getting condition names in an object/list """ template = cfnlint.helpers.convert_dict({ 'Conditions': { 'CreateAppVolume': {'Fn::Equals': [{'Ref': 'CreateVolums'}, 'true']} }, 'Resources': { 'myInstance': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'ImageId': 'ami-123456', 'BlockDeviceMappings': { 'Fn::If': [ 'CreateAppVolume', [ { 'DeviceName': '/dev/hda1', 'Ebs': { 'DeleteOnTermination': True, 'VolumeType': 'gp2' } }, { 'DeviceName': '/dev/xvdf', 'Ebs': { 'DeleteOnTermination': True, 'VolumeType': 'gp2' } } ], { 'Ref': 'AWS::NoValue' } ] } } } } }) template = Template('test.yaml', template) results = template.get_object_without_conditions( template.template.get('Resources').get('myInstance').get( 'Properties').get('BlockDeviceMappings') ) # handles IFs for a list self.assertEqual( results, [ { 'Scenario': {'CreateAppVolume': True}, 'Object': [ {'DeviceName': '/dev/hda1', 'Ebs': {'DeleteOnTermination': True, 'VolumeType': 'gp2'}}, {'DeviceName': '/dev/xvdf', 'Ebs': {'DeleteOnTermination': True, 'VolumeType': 'gp2'}} ] } ] ) def test_get_object_without_conditions_for_bad_formats(self): """ Test Getting condition names in an object/list """ template = { 'Conditions': { 'CreateAppVolume': {'Fn::Equals': [{'Ref': 'CreateVolums'}, 'true']} }, 'Resources': { 'myInstance': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'ImageId': 'ami-123456', 'BlockDeviceMappings': { 'Fn::If': [ 'CreateAppVolume', { 'Ref': 'AWS::NoValue' } ] } } }, 'myInstance1': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'ImageId': 'ami-123456', 'BlockDeviceMappings': { 'Fn::If': [ 'CreateAppVolume' ] } } } } } template = Template('test.yaml', template) results = template.get_object_without_conditions( template.template.get('Resources').get('myInstance').get( 'Properties').get('BlockDeviceMappings') ) # There is no False here but it still passes the 1st item back self.assertEqual( results, [ { 'Object': {'Fn::If': ['CreateAppVolume', {'Ref': 'AWS::NoValue'}]}, 'Scenario': None } ] ) results = template.get_object_without_conditions( template.template.get('Resources').get('myInstance1').get( 'Properties').get('BlockDeviceMappings') ) # There is no False here but it still passes the 1st item back self.assertEqual( results, [{'Object': {'Fn::If': ['CreateAppVolume']}, 'Scenario': None}] ) def test_get_object_without_nested_conditions(self): """ Test Getting condition names in an object/list """ template = cfnlint.helpers.convert_dict({ 'Conditions': { 'isProduction': {'Fn::Equals': [{'Ref': 'myEnvironment'}, 'prod']}, 'isDevelopment': {'Fn::Equals': [{'Ref': 'myEnvironment'}, 'dev']} }, 'Resources': { 'myInstance': { 'Type': 'AWS::EC2::Instance', 'Properties': { 'ImageId': { 'Fn::If': [ 'isProduction', 'ami-prod1234', { 'Fn::If': [ 'isDevelopment', 'ami-dev1234', 'ami-lab1234' ] } ] } } } } }) template = Template('test.yaml', template) results = template.get_object_without_conditions( template.template.get('Resources', {}).get('myInstance', {}).get('Properties', {}) ) self.assertEqual(len(results), 3) for result in results: if result['Scenario']['isProduction'] and not result['Scenario']['isDevelopment']: self.assertDictEqual( result['Object'], { 'ImageId': 'ami-prod1234' } ) elif result['Scenario'] == {'isProduction': False, 'isDevelopment': True}: self.assertDictEqual( result['Object'], { 'ImageId': 'ami-dev1234' } ) elif result['Scenario'] == {'isProduction': False, 'isDevelopment': False}: self.assertDictEqual( result['Object'], { 'ImageId': 'ami-lab1234' } ) else: # Blanket assertion error self.assertDictEqual(result['Scenario'], {}) def test_get_object_without_nested_conditions_iam(self): """ Test Getting condition names in an object/list """ template = { 'Conditions': { 'isProduction': {'Fn::Equals': [{'Ref': 'myEnvironment'}, 'prod']}, 'isDevelopment': {'Fn::Equals': [{'Ref': 'myEnvironment'}, 'dev']} }, 'Resources': { 'Role': { 'Type': 'AWS::IAM::Role', 'Properties': { 'AssumeRolePolicyDocument': { 'Version': '2012-10-17', 'Statement': [ { 'Sid': '', 'Action': 'sts:AssumeRole', 'Effect': 'Allow', 'Principal': { 'AWS': { 'Fn::If': [ 'isProduction', '123456789012', '210987654321' ] } } } ] }, 'ManagedPolicyArns': [ 'arn:aws:iam::aws:policy/AdministratorAccess' ], 'Path': '/' } } } } template = Template('test.yaml', template) results = template.get_object_without_nested_conditions( template.template.get('Resources', {}).get('Role', {}).get( 'Properties', {}).get('AssumeRolePolicyDocument', {}), ['Resources', 'Role', 'Properties', 'AssumeRolePolicyDocument'] ) self.assertEqual(len(results), 2) for result in results: if not result['Scenario']['isProduction']: self.assertDictEqual( result['Object'], { 'Version': '2012-10-17', 'Statement': [ { 'Sid': '', 'Action': 'sts:AssumeRole', 'Effect': 'Allow', 'Principal': { 'AWS': '210987654321' } } ] } ) if result['Scenario']['isProduction']: self.assertDictEqual( result['Object'], { 'Version': '2012-10-17', 'Statement': [ { 'Sid': '', 'Action': 'sts:AssumeRole', 'Effect': 'Allow', 'Principal': { 'AWS': '123456789012' } } ] } ) def test_get_object_without_nested_conditions_basic(self): """ Test Getting condition names in an object/list """ template = { 'Resources': { 'Test': 'Test' } } template = Template('test.yaml', template) results = template.get_object_without_nested_conditions( template.template.get('Resources', {}).get('Test', {}), ['Resources', 'Test'] ) self.assertEqual(results, []) def test_get_object_without_nested_conditions_ref(self): """ Test Getting condition names in an object/list """ template = { 'Resources': { 'Test': { 'Ref': 'AWS::NoValue' } } } template = Template('test.yaml', template) results = template.get_object_without_nested_conditions( template.template.get('Resources', {}).get('Test', {}), ['Resources', 'Test'] ) self.assertEqual(results, []) results = template.get_object_without_nested_conditions( template.template.get('Resources', {}), ['Resources'] ) self.assertEqual(results, [{'Object': {'Test': {'Ref': 'AWS::NoValue'}}, 'Scenario': None}]) def test_get_condition_scenarios_below_path(self): """ Test Getting condition names in an object/list """ template = { 'Parameters': { 'Environment': { 'Type': 'String' } }, 'Conditions': { 'isPrimaryRegion': {'Fn::Equals': [{'Ref': 'AWS::Region'}, 'us-east-1']}, 'isProduction': {'Fn::Equals': [{'Ref': 'Environment'}, 'prod']}, }, 'Resources': { 'Role': { 'Type': 'AWS::IAM::Role', 'Properties': { 'AssumeRolePolicyDocument': { 'Version': '2012-10-17', 'Statement': [ { 'Sid': '', 'Action': 'sts:AssumeRole', 'Effect': 'Allow', 'Principal': { 'AWS': { 'Fn::If': [ 'isProduction', { 'Fn::Sub': [ '{account}', { 'account': { 'Fn::If': [ 'isPrimaryRegion', '123456789012', 'ABCDEFGHIJKL' ] } } ] }, '210987654321' ] } } } ] }, 'ManagedPolicyArns': [ 'arn:aws:iam::aws:policy/AdministratorAccess' ], 'Path': '/' } } } } template = Template('test.yaml', template) results = template.get_condition_scenarios_below_path( ['Resources', 'Role', 'Properties', 'AssumeRolePolicyDocument'] ) self.assertEqualListOfDicts( results, [{'isProduction': True}, {'isProduction': False}] ) results = template.get_condition_scenarios_below_path( ['Resources', 'Role', 'Properties', 'AssumeRolePolicyDocument'], True ) self.assertEqualListOfDicts( results, [ {'isPrimaryRegion': False, 'isProduction': False}, {'isPrimaryRegion': False, 'isProduction': True}, {'isPrimaryRegion': True, 'isProduction': False}, {'isPrimaryRegion': True, 'isProduction': True}, ] ) def test_get_directives(self): """ Test getting directives from a template """ template_yaml = { 'Resources': { 'Type': 'AWS::S3::Bucket', 'myBucket': { 'Properties': { 'BucketName': "bucket_test" }, 'Type': 'AWS::S3::Bucket' }, 'myBucket1': { 'Metadata': { 'cfn-lint': { 'config': { 'ignore_checks': [ 'E3012', 'I1001' ] } } }, 'Properties': {}, 'Type': 'AWS::S3::Bucket' }, 'myBucket2': { 'Metadata': { 'cfn-lint': { 'config': { 'ignore_checks': [ 'E3012', ] } } }, 'Properties': {}, 'Type': 'AWS::S3::Bucket' } } } template = Template( 'test.yaml', cfnlint.decode.cfn_yaml.loads( json.dumps( template_yaml, sort_keys=True, indent=4, separators=(',', ': ') ) ) ) directives = template.get_directives() expected_result = { 'E3012': [ {'end': (23, 10), 'start': (10, 9)}, {'end': (36, 10), 'start': (24, 9)} ], 'I1001': [ {'end': (23, 10), 'start': (10, 9)} ] } self.assertEqual(len(expected_result), len(directives)) for key, items in directives.items(): self.assertIn(key, expected_result) if key in expected_result: self.assertEqualListOfDicts(items, expected_result.get(key))
def initialize(self, cfn: Template) -> None: self.used_cloudformation_resource_types = { resource.get("Type") for resource in cfn.get_resources().values() }