Fix and enable tfproviderlint S018 check: Use TypeList and MaxItems: 1 - Githubissues

hashicorp / terraform-provider-aws

The AWS Provider enables Terraform to manage AWS resources.

https://registry.terraform.io/providers/hashicorp/aws

Mozilla Public License 2.0

9.82k stars 9.16k forks source link

Fix and enable tfproviderlint S018 check: Use TypeList and MaxItems: 1 #9956

Closed ryndaniels closed 4 years ago

ryndaniels commented 5 years ago

Description

As per tfproviderlint check S018, we want to make sure that schemas use Type: TypeList and MaxItems: 1 if possible.

Failing example:

&schema.Schema{
    MaxItems: 1,
    Type:     schema.TypeSet,
}

Should become:

&schema.Schema{
    MaxItems: 1,
    Type:     schema.TypeList,
}

Affected Files

[x] GNUMakefile
[x] aws/provider.go
[x] aws/resource_aws_api_gateway_usage_plan.go
[x] aws/resource_aws_api_gateway_usage_plan_test.go
[x] aws/resource_aws_api_gateway_vpc_link.go
[x] aws/resource_aws_appmesh_virtual_node.go
[x] aws/resource_aws_appmesh_virtual_router.go
[x] aws/resource_aws_cloudfront_distribution.go
[x] aws/resource_aws_codebuild_project_test.go
[x] aws/resource_aws_ecs_service.go
[x] aws/resource_aws_eks_node_group.go
[x] aws/resource_aws_elastic_transcoder_pipeline.go
[x] aws/resource_aws_elastic_transcoder_preset.go
[x] aws/resource_aws_fsx_lustre_file_system.go
[x] aws/resource_aws_fsx_windows_file_system.go
[x] aws/resource_aws_kinesis_firehose_delivery_stream.go
[x] aws/resource_aws_s3_bucket.go
[x] aws/resource_aws_s3_bucket_test.go
[x] aws/resource_aws_ses_event_destination.go
[x] aws/resource_aws_vpc_peering_connection.go
[x] aws/resource_aws_vpc_peering_connection_test.go
[x] aws/resource_aws_waf_sql_injection_match_set.go
[x] aws/resource_aws_waf_sql_injection_match_set_test.go
[x] aws/resource_aws_waf_web_acl.go
[x] aws/resource_aws_waf_web_acl_test.go
[x] aws/waf_helpers.go
[x] aws/resource_aws_waf_byte_match_set.go
[x] aws/resource_aws_waf_byte_match_set_test.go

Definition of Done

In GNUmakefile, add -S018 to tfproviderlint command under lint target and have TravisCI testing pass

ewbankkit commented 4 years ago

Related:

https://github.com/terraform-providers/terraform-provider-aws/issues/6427

ghost commented 4 years ago

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!