provider: Remove extraneous nil checks before d.Set()

[bflad]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

The (*schema.ResourceData).Set() receiver method automatically handles pointer types and nil values, so checking for nil beforehand is extraneous.

Example semgrep Rule

rules:
  - id: helper-schema-ResourceData-Set-extraneous-nil-check
    languages: [go]
    message: Nil value check before `d.Set()` is extraneous
    paths:
      include:
        - aws/
    patterns:
      - pattern-either:
        - pattern: |
            if $APIOBJECT != nil {
              d.Set($ATTRIBUTE, $APIOBJECT)
            }
        - pattern: |
            if $APIOBJECT != nil {
              if $ERROR := d.Set($ATTRIBUTE, $APIOBJECT); err != nil { $BODY }
            }
        - pattern: |
            if $APIOBJECT != nil {
              ...
              $ERROR := d.Set($ATTRIBUTE, $APIOBJECT)
              ...
            }
        - pattern: |
            if $APIOBJECT != nil {
              ...
              $ERROR = d.Set($ATTRIBUTE, $APIOBJECT)
              ...
            }
    severity: WARNING

Example Reports

aws/cloudfront_distribution_configuration_structure.go
severity:warning rule:helper-schema-ResourceData-Set-extraneous-nil-check: Nil value check before `d.Set()` is extraneous
98:	if distributionConfig.CallerReference != nil {
99:		d.Set("caller_reference", distributionConfig.CallerReference)
100:	}
106:	if distributionConfig.DefaultRootObject != nil {
107:		d.Set("default_root_object", distributionConfig.DefaultRootObject)
108:	}
109:	if distributionConfig.HttpVersion != nil {
110:		d.Set("http_version", distributionConfig.HttpVersion)
111:	}
112:	if distributionConfig.WebACLId != nil {
113:		d.Set("web_acl_id", distributionConfig.WebACLId)
114:	}

aws/data_source_aws_ami.go
severity:warning rule:helper-schema-ResourceData-Set-extraneous-nil-check: Nil value check before `d.Set()` is extraneous
258:	if image.Description != nil {
259:		d.Set("description", image.Description)
260:	}
264:	if image.ImageOwnerAlias != nil {
265:		d.Set("image_owner_alias", image.ImageOwnerAlias)
266:	}
268:	if image.KernelId != nil {
269:		d.Set("kernel_id", image.KernelId)
270:	}
273:	if image.Platform != nil {
274:		d.Set("platform", image.Platform)
275:	}
277:	if image.RamdiskId != nil {
278:		d.Set("ramdisk_id", image.RamdiskId)
279:	}
280:	if image.RootDeviceName != nil {
281:		d.Set("root_device_name", image.RootDeviceName)
282:	}
285:	if image.SriovNetSupport != nil {
286:		d.Set("sriov_net_support", image.SriovNetSupport)
287:	}

aws/data_source_aws_elasticache_cluster.go
severity:warning rule:helper-schema-ResourceData-Set-extraneous-nil-check: Nil value check before `d.Set()` is extraneous
192:	if cluster.ReplicationGroupId != nil {
193:		d.Set("replication_group_id", cluster.ReplicationGroupId)
194:	}

Affected Resources

TBD

Definition of Done

• Rule added to .semgrep.yml with no reports on main branch and CI passes

[ewbankkit]

Will this also handle extraneous calls to aws.xxxValue() functions?

d.Set("foo", aws.StringValue(thing.Foo))

vs.

d.Set("foo", thing.Foo)

[bflad]

Not as written, but could be handled in a separate rule. 👍

[bflad]

Created a separate issue for tracking: #16554 😄

[github-actions]

Marking this issue as stale due to inactivity. This helps our maintainers find and focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed. Maintainers can also remove the stale label.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thank you!

[github-actions]

This functionality has been released in v4.51.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

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 have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.