Log warnings for deprecated functions

tests for setting of both context and noncontext functions

Author: appilon

helper/resource/state.go

@@ -276,5 +276,6 @@ func (conf *StateChangeConf) WaitForStateContext(ctx context.Context) (interface
 //
 // Deprecated: Please use WaitForStateContext to ensure proper plugin shutdown
 func (conf *StateChangeConf) WaitForState() (interface{}, error) {
+	log.Printf("[WARN] WaitForState is deprecated, please use WaitForStateContext")
 	return conf.WaitForStateContext(context.Background())
 }

helper/resource/wait.go

@@ -3,6 +3,7 @@ package resource
 import (
 	"context"
 	"errors"
+	"log"
 	"sync"
 	"time"
 )
@@ -65,6 +66,7 @@ func RetryContext(ctx context.Context, timeout time.Duration, f RetryFunc) error
 //
 // Deprecated: Please use RetryContext to ensure proper plugin shutdown
 func Retry(timeout time.Duration, f RetryFunc) error {
+	log.Printf("[WARN] Retry is deprecated, please use RetryContext")
 	return RetryContext(context.Background(), timeout, f)
 }
 

helper/schema/provider.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"log"
 	"sort"
 
 	"github.com/hashicorp/go-multierror"
@@ -89,6 +90,10 @@ func (p *Provider) InternalValidate() error {
 		return errors.New("provider is nil")
 	}
 
+	if p.ConfigureFunc != nil && p.ConfigureContextFunc != nil {
+		return errors.New("ConfigureFunc and ConfigureContextFunc must not both be set")
+	}
+
 	var validationErrors error
 	sm := schemaMap(p.Schema)
 	if err := sm.InternalValidate(sm); err != nil {
@@ -114,6 +119,11 @@ func (p *Provider) InternalValidate() error {
 		}
 	}
 
+	// Warn of deprecations
+	if p.ConfigureFunc != nil && p.ConfigureContextFunc == nil {
+		log.Printf("[WARN] ConfigureFunc is deprecated, please use ConfigureContextFunc")
+	}
+
 	return validationErrors
 }
 

helper/schema/provider_test.go

@@ -540,6 +540,23 @@ func TestProvider_InternalValidate(t *testing.T) {
 			},
 			ExpectedErr: fmt.Errorf("%s is a reserved field name for a provider", "alias"),
 		},
+		{ // ConfigureFunc and ConfigureContext cannot both be set
+			P: &Provider{
+				Schema: map[string]*Schema{
+					"foo": {
+						Type:     TypeString,
+						Optional: true,
+					},
+				},
+				ConfigureFunc: func(d *ResourceData) (interface{}, error) {
+					return nil, nil
+				},
+				ConfigureContextFunc: func(ctx context.Context, d *ResourceData) (interface{}, error) {
+					return nil, nil
+				},
+			},
+			ExpectedErr: fmt.Errorf("ConfigureFunc and ConfigureContextFunc must not both be set"),
+		},
 	}
 
 	for i, tc := range cases {

helper/schema/resource.go

@@ -673,6 +673,26 @@ func (r *Resource) InternalValidate(topSchemaMap schemaMap, writable bool) error
 		return fmt.Errorf("DeleteContext and Delete should not both be set")
 	}
 
+	// Warn of deprecations
+	if r.Exists != nil {
+		log.Printf("[WARN] Exists is deprecated, please encapsulate the logic in ReadContext")
+	}
+	if r.Create != nil && r.CreateContext == nil {
+		log.Printf("[WARN] Create is deprecated, please use CreateContext")
+	}
+	if r.Read != nil && r.ReadContext == nil {
+		log.Printf("[WARN] Read is deprecated, please use ReadContext")
+	}
+	if r.Update != nil && r.UpdateContext == nil {
+		log.Printf("[WARN] Update is deprecated, please use UpdateContext")
+	}
+	if r.Delete != nil && r.DeleteContext == nil {
+		log.Printf("[WARN] Delete is deprecated, please use DeleteContext")
+	}
+	if r.MigrateState != nil {
+		log.Printf("[WARN] MigrateState is deprecated, please use StateUpgraders")
+	}
+
 	return schemaMap(r.Schema).InternalValidate(tsm)
 }
 

helper/schema/resource_importer.go

@@ -3,6 +3,7 @@ package schema
 import (
 	"context"
 	"errors"
+	"log"
 )
 
 // ResourceImporter defines how a resource is imported in Terraform. This
@@ -59,6 +60,9 @@ func (r *ResourceImporter) InternalValidate() error {
 	if r.State != nil && r.StateContext != nil {
 		return errors.New("Both State and StateContext cannot be set.")
 	}
+	if r.State != nil && r.StateContext == nil {
+		log.Printf("[WARN] State is deprecated, please use StateContext")
+	}
 	return nil
 }
 
@@ -67,6 +71,7 @@ func (r *ResourceImporter) InternalValidate() error {
 //
 // Deprecated: Please use the context aware ImportStatePassthroughContext instead
 func ImportStatePassthrough(d *ResourceData, m interface{}) ([]*ResourceData, error) {
+	log.Printf("[WARN] ImportStatePassthrough is deprecated, please use ImportStatePassthroughContext")
 	return []*ResourceData{d}, nil
 }
 

helper/schema/resource_importer_test.go

@@ -0,0 +1,13 @@
+package schema
+
+import "testing"
+
+func TestInternalValidate(t *testing.T) {
+	r := &ResourceImporter{
+		State:        ImportStatePassthrough,
+		StateContext: ImportStatePassthroughContext,
+	}
+	if err := r.InternalValidate(); err == nil {
+		t.Fatal("ResourceImporter should not allow State and StateContext to be set")
+	}
+}

internal/helper/plugin/grpc_provider.go

@@ -360,7 +360,6 @@ func (s *GRPCProviderServer) upgradeFlatmapState(ctx context.Context, version in
 				"schema_version": strconv.Itoa(version),
 			},
 		}
-
 		is, err := res.MigrateState(version, is, s.provider.Meta())
 		if err != nil {
 			return nil, 0, err