Skip to content

Commit

Permalink
website: Replace interface{} with any (#1029)
Browse files Browse the repository at this point in the history 
Reference: #834

Updates the website documentation to use Go 1.18+ `any` instead of an empty interface (`interface{}`) as the latter can be confusing to those unfamiliar with Go.

Code updates within this Go module can be refactored at some other point, if necessary or desired.
  • Loading branch information
@bflad
bflad authored Aug 12, 2022
1 parent 7f4847b commit 1fdf154
Show file tree
Hide file tree
Showing 13 changed files with 61 additions and 61 deletions.
50 changes: 25 additions & 25 deletions website/docs/plugin/sdkv2/best-practices/deprecations.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
// ... other logic ...

existingAttribute := d.Get("existing_attribute").(string)
Expand All @@ -106,7 +106,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
return resourceExampleWidgetRead(d, meta)
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

d.Set("existing_attribute", /* ... */)
Expand All @@ -115,7 +115,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
return nil
}

func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
// ... other logic ...

existingAttribute := d.Get("existing_attribute").(string)
Expand Down Expand Up @@ -155,7 +155,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
// ... other logic ...

existingAttribute, existingAttributeOk := d.GetOk("existing_attribute")
Expand All @@ -173,7 +173,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
return resourceExampleWidgetRead(d, meta)
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

if _, ok := d.GetOk("existing_attribute"); ok {
Expand All @@ -186,7 +186,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
return nil
}

func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
// ... other logic ...

existingAttribute, existingAttributeOk := d.GetOk("existing_attribute")
Expand Down Expand Up @@ -227,7 +227,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
// ... other logic ...

newAttribute := d.Get("new_attribute").(string)
Expand All @@ -237,7 +237,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
return resourceExampleWidgetRead(d, meta)
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

d.Set("new_attribute", /* ... */)
Expand All @@ -246,7 +246,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
return nil
}

func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
// ... other logic ...

newAttribute := d.Get("new_attribute").(string)
Expand Down Expand Up @@ -304,7 +304,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
// ... other logic ...

if v, ok := d.GetOk("existing_attribute"); ok {
Expand All @@ -315,7 +315,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
return resourceExampleWidgetRead(d, meta)
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

d.Set("existing_attribute", /* ... */)
Expand All @@ -324,7 +324,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
return nil
}

func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
// ... other logic ...

if v, ok := d.GetOk("existing_attribute"); ok {
Expand Down Expand Up @@ -365,7 +365,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
// ... other logic ...

if v, ok := d.GetOk("existing_attribute"); ok {
Expand All @@ -378,7 +378,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
return resourceExampleWidgetRead(d, meta)
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

if v, ok := d.GetOk("existing_attribute"); ok {
Expand All @@ -391,7 +391,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
return nil
}

func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
// ... other logic ...

if v, ok := d.GetOk("existing_attribute"); ok {
Expand Down Expand Up @@ -427,7 +427,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
// ... other logic ...

if v, ok := d.GetOk("new_attribute"); ok {
Expand All @@ -438,7 +438,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
return resourceExampleWidgetRead(d, meta)
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

d.Set("new_attribute", /* ... */)
Expand All @@ -447,7 +447,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
return nil
}

func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
// ... other logic ...

if v, ok := d.GetOk("new_attribute"); ok {
Expand Down Expand Up @@ -494,7 +494,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

d.Set("existing_attribute", /* ... */)
Expand Down Expand Up @@ -529,7 +529,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

d.Set("existing_attribute", /* ... */)
Expand Down Expand Up @@ -560,7 +560,7 @@ func resourceExampleWidget() *schema.Resource {
}
}

func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
// ... other logic ...

d.Set("new_attribute", /* ... */)
Expand Down Expand Up @@ -647,10 +647,10 @@ func resourceExampleWidget() *schema.Resource {
return &schema.Resource{
// ... other configuration ...

Create: func(d *schema.ResourceData, meta interface{}) error {
Create: func(d *schema.ResourceData, meta any) error {
return errors.New("use example_thing resource instead")
},
Read: func(d *schema.ResourceData, meta interface{}) error {
Read: func(d *schema.ResourceData, meta any) error {
return errors.New("use example_thing resource instead")
},
}
Expand Down Expand Up @@ -759,10 +759,10 @@ func resourceExampleExistingWidget() *schema.Resource {
return &schema.Resource{
// ... other configuration ...

Create: func(d *schema.ResourceData, meta interface{}) error {
Create: func(d *schema.ResourceData, meta any) error {
return errors.New("use example_new_widget resource instead")
},
Read: func(d *schema.ResourceData, meta interface{}) error {
Read: func(d *schema.ResourceData, meta any) error {
return errors.New("use example_new_widget resource instead")
},
}
Expand Down
8 changes: 4 additions & 4 deletions website/docs/plugin/sdkv2/best-practices/detecting-drift.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func resourceExampleSimple() *schema.Resource {
}
}

func resourceExampleSimpleRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleSimpleRead(d *schema.ResourceData, meta any) error {
client := meta.(*ProviderApi).client
resource, _ := client.GetResource(d.Id())
d.Set("name", resource.Name)
Expand Down Expand Up @@ -97,15 +97,15 @@ reconcile the diff. Because of this, it is standard practice to call `READ` at
the end of all modifications to synchronize immediately and avoid that diff.

```go
func resourceExampleSimpleRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleSimpleRead(d *schema.ResourceData, meta any) error {
client := meta.(*ProviderApi).client
resource, _ := client.GetResource(d.Id())
d.Set("name", resource.Name)
d.Set("type", resource.Type)
return nil
}

func resourceExampleSimpleCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleSimpleCreate(d *schema.ResourceData, meta any) error {
client := meta.(*ProviderApi).client
name := d.Get("name").(string)
client.CreateResource(name)
Expand Down Expand Up @@ -161,7 +161,7 @@ func resourceExampleSimple() *schema.Resource {
}
}

func resourceExampleSimpleRead(d *schema.ResourceData, meta interface{}) error {
func resourceExampleSimpleRead(d *schema.ResourceData, meta any) error {
client := meta.(*ProviderApi).client
resource, err := client.GetResource(d.Id())
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/plugin/sdkv2/guides/terraform-0.12-compatibility.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ each time certain other attributes are updated, you can use
to reflect that in the plan:

```go
CustomizeDiff: customdiff.ComputedIf("version", func(d *schema.ResourceDiff, meta interface{}) bool {
CustomizeDiff: customdiff.ComputedIf("version", func(d *schema.ResourceDiff, meta any) bool {
return d.HasChange("content") || d.HasChange("content_type")
})
```
Expand Down
6 changes: 3 additions & 3 deletions website/docs/plugin/sdkv2/guides/v2-upgrade-guide.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ context-aware versions (`helper/schema.CreateContextFunc`,
deprecated, and we recommend you upgrade to the context-aware versions to get
their improvements, but the old versions will continue working for now.
Upgrading involves changing your function signature from
`func(*helper/schema.ResourceData, interface{}) error` to
`func(context.Context, *helper/schema.ResourceData, interface{})
`func(*helper/schema.ResourceData, any) error` to
`func(context.Context, *helper/schema.ResourceData, any)
diag.Diagnostics`. (We’ll talk about `diag.Diagnostics` in the next section.)

Not everything could have this backwards compatibility, however; some functions
Expand All @@ -141,7 +141,7 @@ This exposes diagnostics support when creating, reading, updating, deleting,
and validating your resources.

```go
func Create(ctx context.Context, *schema.ResourceData, meta interface{}) diag.Diagnostics {
func Create(ctx context.Context, *schema.ResourceData, meta any) diag.Diagnostics {
// do some stuff
if err != nil {
// this is the standard way to convert a Go error to Diagnostics
Expand Down
2 changes: 1 addition & 1 deletion website/docs/plugin/sdkv2/logging/http-transport.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func New() (*schema.Provider, error) {
return &schema.Provider{
// omitting the rest of the schema definition

ConfigureContextFunc: func (ctx context.Context, rsc *schema.ResourceData) (interface{}, diag.Diagnostics) {
ConfigureContextFunc: func (ctx context.Context, rsc *schema.ResourceData) (any, diag.Diagnostics) {

// omitting provider-specific configuration logic

Expand Down
4 changes: 2 additions & 2 deletions website/docs/plugin/sdkv2/resources/customizing-differences.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func resourceExampleInstance() *schema.Resource {
},
},
CustomizeDiff: customdiff.All(
customdiff.ValidateChange("size", func (old, new, meta interface{}) error {
customdiff.ValidateChange("size", func (old, new, meta any) error {
// If we are increasing "size" then the new value must be
// a multiple of the old value.
if new.(int) <= old.(int) {
Expand All @@ -50,7 +50,7 @@ func resourceExampleInstance() *schema.Resource {
}
return nil
}),
customdiff.ForceNewIfChange("size", func (old, new, meta interface{}) bool {
customdiff.ForceNewIfChange("size", func (old, new, meta any) bool {
// "size" can only increase in-place, so we must create a new resource
// if it is decreased.
return new.(int) < old.(int)
Expand Down
4 changes: 2 additions & 2 deletions website/docs/plugin/sdkv2/resources/import.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ func resourceExampleThing() *schema.Resource {
return &schema.Resource{
/* ... other Resource functions ... */
Importer: &schema.ResourceImporter{
State: func(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
State: func(d *schema.ResourceData, meta any) ([]*schema.ResourceData, error) {
// d.Id() here is the last argument passed to the `terraform import RESOURCE_TYPE.RESOURCE_NAME RESOURCE_ID` command
// Here we use a function to parse the import ID (like the example above) to simplify our logic
attribute1, attribute2, err := resourceServiceThingExampleThingParseId(d.Id())
Expand Down Expand Up @@ -200,7 +200,7 @@ The Terraform import framework supports importing multiple resources from a sing
Given our fictitious example resource, if the API supported many associations with it, we could perform an API lookup during the resource import function to find those associations and add them to the Terraform state during import.
```go
func resourceExampleThingImportState(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
func resourceExampleThingImportState(d *schema.ResourceData, meta any) ([]*schema.ResourceData, error) {
// Perform API lookup using the import ID (d.Id()) and save those into a variable named associations

results := []*schema.ResourceData{d}
Expand Down
6 changes: 3 additions & 3 deletions website/docs/plugin/sdkv2/resources/retries-and-customizable-timeouts.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The retry helper takes a timeout and a retry function.
In the context of a `CREATE` function, once the backend responds with the desired state, invoke the `READ` function. If `READ` errors, return that error wrapped with `resource.NonRetryableError`. Otherwise, return `nil` (no error) from the retry function.

```go
func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleInstanceCreate(d *schema.ResourceData, meta any) error {
name := d.Get("name").(string)
client := meta.(*ExampleClient)
resp, err := client.CreateInstance(name)
Expand Down Expand Up @@ -120,7 +120,7 @@ func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) err
Use `resource.StateChangeConf` when your resource has multiple states to progress though, you require fine grained control of retry and delay timing, or you want to ensure a minimum number of occurrences of a target state is reached (this is very common when dealing with eventually consistent APIs, where a response can reply back with an old state between calls before becoming consistent).

```go
func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) error {
func resourceExampleInstanceCreate(d *schema.ResourceData, meta any) error {
name := d.Get("name").(string)
client := meta.(*ExampleClient)
resp, err := client.CreateInstance(name)
Expand All @@ -135,7 +135,7 @@ func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) err
Target: []string{
client.ExampleInstanceStateCreateComplete,
},
Refresh: func() (interface{}, string, error) {
Refresh: func() (any, string, error) {
resp, err := client.DescribeInstance(name)
if err != nil {
0, "", err
Expand Down
Loading

0 comments on commit 1fdf154

Please sign in to comment.