mirror of https://github.com/hashicorp/terraform
terraform test: implement mock providers (#34167)
Liam Cervante
3 years ago
committed by
GitHub
parent
05f877166d
commit
f435706bfc
@ -0,0 +1,231 @@
|
||||
// Copyright (c) HashiCorp, Inc.
|
||||
// SPDX-License-Identifier: BUSL-1.1
|
||||
|
||||
package providers
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/zclconf/go-cty/cty"
|
||||
|
||||
"github.com/hashicorp/terraform/internal/configs"
|
||||
"github.com/hashicorp/terraform/internal/moduletest/mocking"
|
||||
"github.com/hashicorp/terraform/internal/tfdiags"
|
||||
)
|
||||
|
||||
var _ Interface = (*Mock)(nil)
|
||||
|
||||
// Mock is a mock provider that can be used by Terraform authors during test
|
||||
// executions.
|
||||
//
|
||||
// The mock provider wraps an instance of an actual provider so it can return
|
||||
// the correct schema and validate the configuration accurately. But, it
|
||||
// intercepts calls to create resources or read data sources and instead reads
|
||||
// and write the data to/from the state directly instead of needing to
|
||||
// communicate with actual cloud providers.
|
||||
//
|
||||
// Callers can also specify the configs.MockData field to provide some preset
|
||||
// data to return for any computed fields within the provider schema. The
|
||||
// provider will make up random / junk data for any computed fields for which
|
||||
// preset data is not available.
|
||||
type Mock struct {
|
||||
Provider Interface
|
||||
Data *configs.MockData
|
||||
|
||||
schema *GetProviderSchemaResponse
|
||||
}
|
||||
|
||||
func (m *Mock) GetProviderSchema() GetProviderSchemaResponse {
|
||||
if m.schema == nil {
|
||||
// Cache the schema, it's not changing.
|
||||
schema := m.Provider.GetProviderSchema()
|
||||
m.schema = &schema
|
||||
}
|
||||
return *m.schema
|
||||
}
|
||||
|
||||
func (m *Mock) ValidateProviderConfig(request ValidateProviderConfigRequest) (response ValidateProviderConfigResponse) {
|
||||
// The config for the mocked providers is consistent, and validated when we
|
||||
// parse the HCL directly. So we'll just make no change here.
|
||||
return ValidateProviderConfigResponse{
|
||||
PreparedConfig: request.Config,
|
||||
}
|
||||
}
|
||||
|
||||
func (m *Mock) ValidateResourceConfig(request ValidateResourceConfigRequest) ValidateResourceConfigResponse {
|
||||
// We'll just pass this through to the underlying provider. The mock should
|
||||
// support the same resource syntax as the original provider.
|
||||
return m.Provider.ValidateResourceConfig(request)
|
||||
}
|
||||
|
||||
func (m *Mock) ValidateDataResourceConfig(request ValidateDataResourceConfigRequest) ValidateDataResourceConfigResponse {
|
||||
// We'll just pass this through to the underlying provider. The mock should
|
||||
// support the same data source syntax as the original provider.
|
||||
return m.Provider.ValidateDataResourceConfig(request)
|
||||
}
|
||||
|
||||
func (m *Mock) UpgradeResourceState(request UpgradeResourceStateRequest) UpgradeResourceStateResponse {
|
||||
// It's unlikely this will ever be called on a mocked provider, given they
|
||||
// can only execute from inside tests. But we don't need to anything special
|
||||
// here, let's just have the original provider handle it.
|
||||
return m.Provider.UpgradeResourceState(request)
|
||||
}
|
||||
|
||||
func (m *Mock) ConfigureProvider(request ConfigureProviderRequest) (response ConfigureProviderResponse) {
|
||||
// Do nothing here, we don't have anything to configure within the mocked
|
||||
// providers and we don't want to call the original providers from here as
|
||||
// they may try to talk to their underlying cloud providers.
|
||||
return response
|
||||
}
|
||||
|
||||
func (m *Mock) Stop() error {
|
||||
// Just stop the original resource.
|
||||
return m.Provider.Stop()
|
||||
}
|
||||
|
||||
func (m *Mock) ReadResource(request ReadResourceRequest) ReadResourceResponse {
|
||||
// For a mocked provider, reading a resource is just reading it from the
|
||||
// state. So we'll return what we have.
|
||||
// TODO(liamcervante): Can we do more than just say the state of resources
|
||||
// never changes? What if we recomputed the values, so we can have drift
|
||||
// if the value in the mocked data has changed?
|
||||
return ReadResourceResponse{
|
||||
NewState: request.PriorState,
|
||||
}
|
||||
}
|
||||
|
||||
func (m *Mock) PlanResourceChange(request PlanResourceChangeRequest) PlanResourceChangeResponse {
|
||||
if request.ProposedNewState.IsNull() {
|
||||
// Then we are deleting this resource - we don't need to do anything.
|
||||
return PlanResourceChangeResponse{
|
||||
PlannedState: request.ProposedNewState,
|
||||
PlannedPrivate: []byte("destroy"),
|
||||
}
|
||||
}
|
||||
|
||||
if request.PriorState.IsNull() {
|
||||
// Then we are creating this resource - we need to populate the computed
|
||||
// null fields with unknowns so Terraform will render them properly.
|
||||
|
||||
var response PlanResourceChangeResponse
|
||||
|
||||
schema := m.GetProviderSchema()
|
||||
response.Diagnostics = response.Diagnostics.Append(schema.Diagnostics)
|
||||
if schema.Diagnostics.HasErrors() {
|
||||
// We couldn't retrieve the schema for some reason, so the mock
|
||||
// provider can't really function.
|
||||
return response
|
||||
}
|
||||
|
||||
resource, exists := schema.ResourceTypes[request.TypeName]
|
||||
if !exists {
|
||||
// This means something has gone wrong much earlier, we should have
|
||||
// failed a validation somewhere if a resource type doesn't exist.
|
||||
panic(fmt.Errorf("failed to retrieve schema for resource %s", request.TypeName))
|
||||
}
|
||||
|
||||
value, diags := mocking.PlanComputedValuesForResource(request.ProposedNewState, resource.Block)
|
||||
response.Diagnostics = response.Diagnostics.Append(diags)
|
||||
response.PlannedState = value
|
||||
response.PlannedPrivate = []byte("create")
|
||||
return response
|
||||
}
|
||||
|
||||
// Otherwise, we're just doing a simple update and we don't need to populate
|
||||
// any values for that.
|
||||
return PlanResourceChangeResponse{
|
||||
PlannedState: request.ProposedNewState,
|
||||
PlannedPrivate: []byte("update"),
|
||||
}
|
||||
}
|
||||
|
||||
func (m *Mock) ApplyResourceChange(request ApplyResourceChangeRequest) ApplyResourceChangeResponse {
|
||||
switch string(request.PlannedPrivate) {
|
||||
case "create":
|
||||
// A new resource that we've created might have computed fields we need
|
||||
// to populate.
|
||||
|
||||
var response ApplyResourceChangeResponse
|
||||
|
||||
schema := m.GetProviderSchema()
|
||||
response.Diagnostics = response.Diagnostics.Append(schema.Diagnostics)
|
||||
if schema.Diagnostics.HasErrors() {
|
||||
// We couldn't retrieve the schema for some reason, so the mock
|
||||
// provider can't really function.
|
||||
return response
|
||||
}
|
||||
|
||||
resource, exists := schema.ResourceTypes[request.TypeName]
|
||||
if !exists {
|
||||
// This means something has gone wrong much earlier, we should have
|
||||
// failed a validation somewhere if a resource type doesn't exist.
|
||||
panic(fmt.Errorf("failed to retrieve schema for resource %s", request.TypeName))
|
||||
}
|
||||
|
||||
replacement := mocking.ReplacementValue{
|
||||
Value: cty.NilVal, // If we have no data then we use cty.NilVal.
|
||||
}
|
||||
if mockedResource, exists := m.Data.MockResources[request.TypeName]; exists {
|
||||
replacement.Value = mockedResource.Defaults
|
||||
replacement.Range = mockedResource.DefaultsRange
|
||||
}
|
||||
|
||||
value, diags := mocking.ApplyComputedValuesForResource(request.PlannedState, replacement, resource.Block)
|
||||
response.Diagnostics = response.Diagnostics.Append(diags)
|
||||
response.NewState = value
|
||||
return response
|
||||
|
||||
default:
|
||||
// For update or destroy operations, we don't have to create any values
|
||||
// so we'll just return the planned state directly.
|
||||
return ApplyResourceChangeResponse{
|
||||
NewState: request.PlannedState,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (m *Mock) ImportResourceState(request ImportResourceStateRequest) (response ImportResourceStateResponse) {
|
||||
// Given mock providers only execute from within the test framework and it
|
||||
// doesn't make a lot of sense why someone would want to import something
|
||||
// during a test, we just don't support this at the moment.
|
||||
// TODO(liamcervante): Find use cases for this? The existing syntax for
|
||||
// mocks does make this possible but let's find a reason to do it first.
|
||||
response.Diagnostics = response.Diagnostics.Append(tfdiags.Sourceless(tfdiags.Error, "Invalid import request", "Cannot import resources from mock providers."))
|
||||
return response
|
||||
}
|
||||
|
||||
func (m *Mock) ReadDataSource(request ReadDataSourceRequest) ReadDataSourceResponse {
|
||||
var response ReadDataSourceResponse
|
||||
|
||||
schema := m.GetProviderSchema()
|
||||
response.Diagnostics = response.Diagnostics.Append(schema.Diagnostics)
|
||||
if schema.Diagnostics.HasErrors() {
|
||||
// We couldn't retrieve the schema for some reason, so the mock
|
||||
// provider can't really function.
|
||||
return response
|
||||
}
|
||||
|
||||
datasource, exists := schema.DataSources[request.TypeName]
|
||||
if !exists {
|
||||
// This means something has gone wrong much earlier, we should have
|
||||
// failed a validation somewhere if a data source type doesn't exist.
|
||||
panic(fmt.Errorf("failed to retrieve schema for data source %s", request.TypeName))
|
||||
}
|
||||
|
||||
mockedData := mocking.ReplacementValue{
|
||||
Value: cty.NilVal, // If we have no mocked data we use cty.NilVal.
|
||||
}
|
||||
if mockedDataSource, exists := m.Data.MockDataSources[request.TypeName]; exists {
|
||||
mockedData.Value = mockedDataSource.Defaults
|
||||
mockedData.Range = mockedDataSource.DefaultsRange
|
||||
}
|
||||
|
||||
value, diags := mocking.ComputedValuesForDataSource(request.Config, mockedData, datasource.Block)
|
||||
response.Diagnostics = response.Diagnostics.Append(diags)
|
||||
response.State = value
|
||||
return response
|
||||
}
|
||||
|
||||
func (m *Mock) Close() error {
|
||||
return m.Provider.Close()
|
||||
}
|
||||
Loading…
Reference in new issue