docs for GetOkExists are misleading

[sophaskins]

Terraform Version

$ terraform -v
Terraform v0.12.18

Terraform Configuration Files

n/a

Debug Output

n/a

Crash Output

n/a

Expected Behavior

Documentation matches code behavior

Actual Behavior

The documentation for GetOkExists in the github.com/hashicorp/terraform/helper/schema package starts the same as the documentation for GetOk:

https://github.com/hashicorp/terraform/blob/f1237f816c5d00c59648d3170c7b8f4afe6d982d/helper/schema/resource_data.go#L111-L125

Notably:

GetOkExists returns the data for a given key and whether or not the key has been set to a non-zero value.

However, the implementation for GetOkExists (and the rest of its line comments!) indicate that it does not check if the key has been set to a non-zero value, and that indeed that's why it exists as a function in the first place!

Steps to Reproduce

n/a

Additional Context

I ran in to this debugging an issue in a plugin where I was unable to set a value of 0 kevholditch/terraform-provider-kong#93. It turned out that the field was being read with GetOk and thus, when it was 0, it was being turned by the plugin in to nil as if it hadn't been set.

When digging in the code, I was somewhat confused until I realized the line comments were not in line with the code.

I didn't just open this as a PR because my research also indicated that GetOk and GetOkExists have a somewhat complicated history, and it's possible there's some subtlety going on here that I do not understand.

References

hashicorp/terraform#15723
hashicorp/terraform#4936 (comment)

[paultyng]

@sophaskins thanks for reporting this, like many things in this SDK, there for sure is a complicated history. Most of us are also not original authors so its really hard to say original intent, but I think your observation seems correct to me, so can update the godoc for now as the existence and naming of this function of course implies different behavior!

[ghost]

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.