Can't accept Zero int value

rohit-myali · November 6, 2024, 6:24am

Hello Team,

We have terraform provider for one of our products, terraform-provider-citrixadc. We are using terraform SDK v1.

There are some attributes under some resource that accept 0 values, and they are of type int. But whenever the user gives 0 value in the configuration, it doesn’t appear in the payload, meaning sdk doesn’t detect the 0 values and doesn’t proceed to add it to payload.

Initailly, I was using the go lang, struct(json struct in golang) to refer to all the attributes but it wasn’t possible with that, because if I remove omitempty from json struct tag, it would add 0 to every request for that attribute, irrespective if the user is set or not. So, I used map[string]interface{} for payload, and validating each attribute from user configuration.

I’m using GetOk() to check whether the value is set by user or not, it is considering 0 as not set and not processing the if part, but on the other hand if I use GetOkExist() it is able to detect 0 and consider it. but GetOkExist() has a deprecated message.
Please refer here for example:

github.com

citrix/terraform-provider-citrixadc/blob/master/citrixadc/resource_citrixadc_snmpalarm.go#L83


      
          	}
          	if v, ok := d.GetOk("severity"); ok {
          		snmpalarm["severity"] = v.(string)
          	}
          	if v, ok := d.GetOk("state"); ok {
          		snmpalarm["state"] = v.(string)
          	}
          	if v, ok := d.GetOk("thresholdvalue"); ok {
          		snmpalarm["thresholdvalue"] = v.(int)
          	}
          	if v, ok := d.GetOk("time"); ok {
          		snmpalarm["time"] = v.(int)
          	}
          	if v, ok := d.GetOk("trapname"); ok {
          		snmpalarm["trapname"] = v.(string)
          	}
          
          	err := client.UpdateUnnamedResource(service.Snmpalarm.Type(), &snmpalarm)
          	if err != nil {
          		return err
          	}

How can I handle this?

Thanks in advance

jbardin · November 6, 2024, 12:49pm

There is no way to work around the problem, because the type system in the legacy SDK cannot differentiate between zero and unset values. While basically the same underneath, the SDKv2 was release 4 years ago and has some additional GetRaw helpers and updated protocol which can give you access to the actual values coming from Terraform to help work around issues like this. It is however fundamentally still the same SDK, so there are still going to be some problems which can’t be fully resolved.

New providers should be using the Terraform Plugin Framework, an updated SDK which implements the current protocols and has a type system fully compatible with that of Terraform core.

Topic		Replies	Views
Explicit zero values in provider schemas Terraform Providers	1	469	December 14, 2020
Is it possible to differentiate between a zero value and a removed property in the Terraform Provider SDK? Plugin Development	2	893	August 17, 2022
Detecting undefined keys in terraform config files from custom provider code Plugin Development	1	855	February 6, 2020
Normalization vs config drift. Again Plugin Development	8	342	August 22, 2023
Unsupported Field Type for Resource Plugin Development	0	318	June 5, 2023

Can't accept Zero int value

Related topics