Merge pull request #370 from hashicorp/restore-func-naming

Restore original function names in schema.Provider

Author: appilon

helper/schema/provider.go

@@ -210,13 +210,13 @@ func (p *Provider) ValidateResource(
 	return r.Validate(c)
 }
 
-// ConfigureContext configures the provider itself with the configuration
+// Configure configures the provider itself with the configuration
 // given. This is useful for setting things like access keys.
 //
 // This won't be called at all if no provider configuration is given.
 //
 // Configure returns an error if it occurred.
-func (p *Provider) ConfigureContext(ctx context.Context, c *terraform.ResourceConfig) error {
+func (p *Provider) Configure(ctx context.Context, c *terraform.ResourceConfig) error {
 	// No configuration
 	if p.ConfigureFunc == nil && p.ConfigureContextFunc == nil {
 		return nil
@@ -282,7 +282,7 @@ func (p *Provider) Resources() []terraform.ResourceType {
 	return result
 }
 
-// ImportStateContext requests that the given resource be imported.
+// ImportState requests that the given resource be imported.
 //
 // The returned InstanceState only requires ID be set. Importing
 // will always call Refresh after the state to complete it.
@@ -296,7 +296,7 @@ func (p *Provider) Resources() []terraform.ResourceType {
 // to multiple. For example, an AWS security group may contain many rules.
 // Each rule is represented by a separate resource in Terraform,
 // therefore multiple states are returned.
-func (p *Provider) ImportStateContext(
+func (p *Provider) ImportState(
 	ctx context.Context,
 	info *terraform.InstanceInfo,
 	id string) ([]*terraform.InstanceState, error) {

helper/schema/provider_test.go

@@ -177,7 +177,7 @@ func TestProviderConfigure(t *testing.T) {
 
 	for i, tc := range cases {
 		c := terraform.NewResourceConfigRaw(tc.Config)
-		err := tc.P.ConfigureContext(context.Background(), c)
+		err := tc.P.Configure(context.Background(), c)
 		if err != nil != tc.Err {
 			t.Fatalf("%d: %s", i, err)
 		}
@@ -411,7 +411,7 @@ func TestProviderImportState_default(t *testing.T) {
 		},
 	}
 
-	states, err := p.ImportStateContext(context.Background(), &terraform.InstanceInfo{
+	states, err := p.ImportState(context.Background(), &terraform.InstanceInfo{
 		Type: "foo",
 	}, "bar")
 	if err != nil {
@@ -443,7 +443,7 @@ func TestProviderImportState_setsId(t *testing.T) {
 		},
 	}
 
-	_, err := p.ImportStateContext(context.Background(), &terraform.InstanceInfo{
+	_, err := p.ImportState(context.Background(), &terraform.InstanceInfo{
 		Type: "foo",
 	}, "bar")
 	if err != nil {
@@ -473,7 +473,7 @@ func TestProviderImportState_setsType(t *testing.T) {
 		},
 	}
 
-	_, err := p.ImportStateContext(context.Background(), &terraform.InstanceInfo{
+	_, err := p.ImportState(context.Background(), &terraform.InstanceInfo{
 		Type: "foo",
 	}, "bar")
 	if err != nil {

helper/schema/resource.go

@@ -541,130 +541,6 @@ func (r *Resource) RefreshWithoutUpgrade(
 	return r.recordCurrentSchemaVersion(state), err
 }
 
-// Refresh refreshes the state of the resource.
-func (r *Resource) Refresh(
-	ctx context.Context,
-	s *terraform.InstanceState,
-	meta interface{}) (*terraform.InstanceState, error) {
-	// If the ID is already somehow blank, it doesn't exist
-	if s.ID == "" {
-		return nil, nil
-	}
-
-	rt := ResourceTimeout{}
-	if _, ok := s.Meta[TimeoutKey]; ok {
-		if err := rt.StateDecode(s); err != nil {
-			log.Printf("[ERR] Error decoding ResourceTimeout: %s", err)
-		}
-	}
-
-	if r.existsFuncSet() {
-		// Make a copy of data so that if it is modified it doesn't
-		// affect our Read later.
-		data, err := schemaMap(r.Schema).Data(s, nil)
-		data.timeouts = &rt
-
-		if err != nil {
-			return s, err
-		}
-
-		exists, err := r.exists(ctx, data, meta)
-
-		if err != nil {
-			return s, err
-		}
-		if !exists {
-			return nil, nil
-		}
-	}
-
-	// there may be new StateUpgraders that need to be run
-	s, err := r.upgradeState(ctx, s, meta)
-	if err != nil {
-		return s, err
-	}
-
-	data, err := schemaMap(r.Schema).Data(s, nil)
-	data.timeouts = &rt
-	if err != nil {
-		return s, err
-	}
-
-	err = r.read(ctx, data, meta)
-
-	state := data.State()
-	if state != nil && state.ID == "" {
-		state = nil
-	}
-
-	return r.recordCurrentSchemaVersion(state), err
-}
-
-func (r *Resource) upgradeState(ctx context.Context, s *terraform.InstanceState, meta interface{}) (*terraform.InstanceState, error) {
-	var err error
-
-	needsMigration, stateSchemaVersion := r.checkSchemaVersion(s)
-	migrate := needsMigration && r.MigrateState != nil
-
-	if migrate {
-		s, err = r.MigrateState(stateSchemaVersion, s, meta)
-		if err != nil {
-			return s, err
-		}
-	}
-
-	if len(r.StateUpgraders) == 0 {
-		return s, nil
-	}
-
-	// If we ran MigrateState, then the stateSchemaVersion value is no longer
-	// correct. We can expect the first upgrade function to be the correct
-	// schema type version.
-	if migrate {
-		stateSchemaVersion = r.StateUpgraders[0].Version
-	}
-
-	schemaType := r.CoreConfigSchema().ImpliedType()
-	// find the expected type to convert the state
-	for _, upgrader := range r.StateUpgraders {
-		if stateSchemaVersion == upgrader.Version {
-			schemaType = upgrader.Type
-		}
-	}
-
-	// StateUpgraders only operate on the new JSON format state, so the state
-	// need to be converted.
-	stateVal, err := StateValueFromInstanceState(s, schemaType)
-	if err != nil {
-		return nil, err
-	}
-
-	jsonState, err := StateValueToJSONMap(stateVal, schemaType)
-	if err != nil {
-		return nil, err
-	}
-
-	for _, upgrader := range r.StateUpgraders {
-		if stateSchemaVersion != upgrader.Version {
-			continue
-		}
-
-		jsonState, err = upgrader.Upgrade(ctx, jsonState, meta)
-		if err != nil {
-			return nil, err
-		}
-		stateSchemaVersion++
-	}
-
-	// now we need to re-flatmap the new state
-	stateVal, err = JSONMapToStateValue(jsonState, r.CoreConfigSchema())
-	if err != nil {
-		return nil, err
-	}
-
-	return r.ShimInstanceStateFromValue(stateVal)
-}
-
 func (r *Resource) createFuncSet() bool {
 	return (r.Create != nil || r.CreateContext != nil)
 }
@@ -895,36 +771,6 @@ func (r *Resource) isTopLevel() bool {
 	return (r.createFuncSet() || r.readFuncSet())
 }
 
-// Determines if a given InstanceState needs to be migrated by checking the
-// stored version number with the current SchemaVersion
-func (r *Resource) checkSchemaVersion(is *terraform.InstanceState) (bool, int) {
-	// Get the raw interface{} value for the schema version. If it doesn't
-	// exist or is nil then set it to zero.
-	raw := is.Meta["schema_version"]
-	if raw == nil {
-		raw = "0"
-	}
-
-	// Try to convert it to a string. If it isn't a string then we pretend
-	// that it isn't set at all. It should never not be a string unless it
-	// was manually tampered with.
-	rawString, ok := raw.(string)
-	if !ok {
-		rawString = "0"
-	}
-
-	stateSchemaVersion, _ := strconv.Atoi(rawString)
-
-	// Don't run MigrateState if the version is handled by a StateUpgrader,
-	// since StateMigrateFuncs are not required to handle unknown versions
-	maxVersion := r.SchemaVersion
-	if len(r.StateUpgraders) > 0 {
-		maxVersion = r.StateUpgraders[0].Version
-	}
-
-	return stateSchemaVersion < maxVersion, stateSchemaVersion
-}
-
 func (r *Resource) recordCurrentSchemaVersion(
 	state *terraform.InstanceState) *terraform.InstanceState {
 	if state != nil && r.SchemaVersion > 0 {

helper/schema/resource_importer.go

@@ -62,7 +62,7 @@ func (r *ResourceImporter) InternalValidate() error {
 	return nil
 }
 
-// ImportStatePassthrough is an implementation of StateContextFunc that can be
+// ImportStatePassthrough is an implementation of StateFunc that can be
 // used to simply pass the ID directly through.
 //
 // Deprecated: Please use the context aware ImportStatePassthroughContext instead