hashicorp · bflad · Feb 2, 2022 · Jan 13, 2022 · Jan 20, 2022 · Jan 20, 2022
@@ -0,0 +1,3 @@
+```release-note:feature
+Added `tf6muxserver` package, a protocol version 6 compatible mux server
+```
@@ -37,7 +37,47 @@ Plugin SDK or higher to be able to be used with terraform-plugin-mux.
 
 ## Getting Started
 
-terraform-plugin-mux exposes a minimal interface:
+Functionality for a provider server is based on the protocol version. There are currently two main protocol versions in use today, protocol version 5 and protocol version 6, based on the development framework being used:
+
+- [terraform-plugin-framework](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework): Implements protocol version 6.
+- [terraform-plugin-sdk/v2](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2): Implements protocol version 5.
+- [terraform-plugin-go](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go): Implements either protocol version, based on whether the `tf5server` package (protocol version 5) or `tf6server` package (protocol version 6) is being used.
+
+To combine providers together, each must implement the same protocol version.
+
+### Protocol Version 6
+
+Protocol version 6 providers can be combined using the [`tf6muxserver.NewMuxServer` function](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-mux/tf6muxserver#NewMuxServer):
+
+```go
+func main() {
+	ctx := context.Background()
+	providers := []func() tfprotov6.ProviderServer{
+		// Example terraform-plugin-framework ProviderServer function
+		// frameworkprovider.Provider().ProviderServer,
+		//
+		// Example terraform-plugin-go ProviderServer function
+		// goprovider.Provider(),
+	}
+
+	muxServer, err := tf6muxserver.NewMuxServer(ctx, providers...)
+
+	if err != nil {
+		log.Fatalln(err.Error())
+	}
+
+	// Use the result to start a muxed provider
+	err = tf6server.Serve("registry.terraform.io/namespace/example", muxServer.ProviderServer)
+
+	if err != nil {
+		log.Fatalln(err.Error())
+	}
+}
+```
+
+### Protocol Version 5
+
+Protocol version 5 providers can be combined using the root package [`NewSchemaServerFactory()` function](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-mux#NewSchemaServerFactory):
 
 ```go
 func main() {

@@ -56,16 +56,22 @@ github.com/hashicorp/go-hclog v0.14.1/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39
 github.com/hashicorp/go-hclog v1.0.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ=
 github.com/hashicorp/go-hclog v1.1.0 h1:QsGcniKx5/LuX2eYoeL+Np3UKYPNaN7YKpTh29h8rbw=
 github.com/hashicorp/go-hclog v1.1.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ=
+github.com/hashicorp/go-plugin v1.4.3 h1:DXmvivbWD5qdiBts9TpBC7BYL1Aia5sxbRgQB+v6UZM=
 github.com/hashicorp/go-plugin v1.4.3/go.mod h1:5fGEH17QVwTTcR0zV7yhDPLLmFX9YSZ38b18Udy6vYQ=
+github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE=
 github.com/hashicorp/go-uuid v1.0.2/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
 github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
 github.com/hashicorp/terraform-plugin-go v0.7.0 h1:djd0aLO1uRr/VHaR12wryEFAPEFoHNIvRfCGkOrQqQI=
 github.com/hashicorp/terraform-plugin-go v0.7.0/go.mod h1:p+L2cRtja1Rr5A/S9flPLAzHyt2544MhIpAfwqnK7U0=
 github.com/hashicorp/terraform-plugin-log v0.2.1 h1:hl0G6ctSx7DRTE62VNsPWrq7d+JWy1kjk9ApOFrCq3I=
 github.com/hashicorp/terraform-plugin-log v0.2.1/go.mod h1:RW/n0x4dyITmenuirZ1ViPQGP5JQdPTZ4Wwc0rLKi94=
+github.com/hashicorp/terraform-registry-address v0.0.0-20210412075316-9b2996cce896 h1:1FGtlkJw87UsTMg5s8jrekrHmUPUJaMcu6ELiVhQrNw=
 github.com/hashicorp/terraform-registry-address v0.0.0-20210412075316-9b2996cce896/go.mod h1:bzBPnUIkI0RxauU8Dqo+2KrZZ28Cf48s8V6IHt3p4co=
+github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 h1:HKLsbzeOsfXmKNpr3GiT18XAblV0BjCbzL8KQAMZGa0=
 github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734/go.mod h1:kNDNcF7sN4DocDLBkQYz73HGKwN1ANB1blq4lIYLYvg=
+github.com/hashicorp/yamux v0.0.0-20180604194846-3520598351bb h1:b5rjCoWHc7eqmAS4/qyk21ZsHyb6Mxv/jykxvNTkU4M=
 github.com/hashicorp/yamux v0.0.0-20180604194846-3520598351bb/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM=
+github.com/jhump/protoreflect v1.6.0 h1:h5jfMVslIg6l29nsMs0D8Wj17RDVdNYti0vDN/PZZoE=
 github.com/jhump/protoreflect v1.6.0/go.mod h1:eaTn3RZAmMBcV0fifFvlm6VHNz3wSkYyXYWUh7ymB74=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
@@ -83,6 +89,7 @@ github.com/mitchellh/go-testing-interface v1.14.1 h1:jrgshOhYAUVNMAJiKbEu7EqAwgJ
 github.com/mitchellh/go-testing-interface v1.14.1/go.mod h1:gfgS7OtZj6MA4U1UrDRp04twqAjfvlZyCfX3sDjEym8=
 github.com/nsf/jsondiff v0.0.0-20200515183724-f29ed568f4ce h1:RPclfga2SEJmgMmz2k+Mg7cowZ8yv4Trqw9UsJby758=
 github.com/nsf/jsondiff v0.0.0-20200515183724-f29ed568f4ce/go.mod h1:uFMI8w+ref4v2r9jz+c9i1IfIttS/OkmLfrk1jne5hs=
+github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw=
 github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
@@ -140,6 +147,7 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
+golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
@@ -157,6 +165,7 @@ google.golang.org/genproto v0.0.0-20170818010345-ee236bd376b0/go.mod h1:JiN7NxoA
 google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
 google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc=
 google.golang.org/genproto v0.0.0-20200513103714-09dca8ec2884/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
+google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013 h1:+kGHl1aib/qcwaRi1CbqBZ1rk19r85MNUf8HaBghugY=
 google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo=
 google.golang.org/grpc v1.8.0/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw=
 google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
@@ -166,6 +175,7 @@ google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8
 google.golang.org/grpc v1.27.1/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
 google.golang.org/grpc v1.33.1/go.mod h1:fr5YgcSWrqhRRxogOsw7RzIpsmvOZ6IcH4kBYTpR3n0=
 google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU=
+google.golang.org/grpc v1.43.0 h1:Eeu7bZtDZ2DpRCsLhUlcrLnvYaMK1Gz86a+hMVvELmM=
 google.golang.org/grpc v1.43.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU=
 google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
 google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-log/tfsdklog"
 )
@@ -16,6 +17,15 @@ func InitContext(ctx context.Context) context.Context {
 	return ctx
 }
 
+// RpcContext injects the RPC name into logger contexts.
+func RpcContext(ctx context.Context, rpc string) context.Context {
+	ctx = tflog.With(ctx, KeyTfRpc, rpc)
+	ctx = tfsdklog.With(ctx, KeyTfRpc, rpc)
+	ctx = tfsdklog.SubsystemWith(ctx, SubsystemMux, KeyTfRpc, rpc)
+
+	return ctx
+}
+
 // Tfprotov5ProviderServerContext injects the chosen provider Go type
 func Tfprotov5ProviderServerContext(ctx context.Context, p tfprotov5.ProviderServer) context.Context {
 	providerType := fmt.Sprintf("%T", p)
@@ -25,3 +35,13 @@ func Tfprotov5ProviderServerContext(ctx context.Context, p tfprotov5.ProviderSer
 
 	return ctx
 }
+
+// Tfprotov6ProviderServerContext injects the chosen provider Go type
+func Tfprotov6ProviderServerContext(ctx context.Context, p tfprotov6.ProviderServer) context.Context {
+	providerType := fmt.Sprintf("%T", p)
+	ctx = tflog.With(ctx, KeyTfMuxProvider, providerType)
+	ctx = tfsdklog.With(ctx, KeyTfMuxProvider, providerType)
+	ctx = tfsdklog.SubsystemWith(ctx, SubsystemMux, KeyTfMuxProvider, providerType)
+
+	return ctx
+}
@@ -7,4 +7,7 @@ package logging
 const (
 	// Go type of the provider selected by mux.
 	KeyTfMuxProvider = "tf_mux_provider"
+
+	// The RPC being run, such as "ApplyResourceChange"
+	KeyTfRpc = "tf_rpc"
 )
@@ -0,0 +1,155 @@
+package tf6testserver
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
+)
+
+var _ tfprotov6.ProviderServer = &TestServer{}
+
+type TestServer struct {
+	DataSourceSchemas  map[string]*tfprotov6.Schema
+	ProviderMetaSchema *tfprotov6.Schema
+	ProviderSchema     *tfprotov6.Schema
+	ResourceSchemas    map[string]*tfprotov6.Schema
+
+	ApplyResourceChangeCalled map[string]bool
+
+	ConfigureProviderCalled bool
+
+	ImportResourceStateCalled map[string]bool
+
+	PlanResourceChangeCalled map[string]bool
+
+	ReadDataSourceCalled map[string]bool
+
+	ReadResourceCalled map[string]bool
+
+	StopProviderCalled bool
+	StopProviderError  string
+
+	UpgradeResourceStateCalled map[string]bool
+
+	ValidateDataResourceConfigCalled map[string]bool
+
+	ValidateProviderConfigCalled   bool
+	ValidateProviderConfigResponse *tfprotov6.ValidateProviderConfigResponse
+
+	ValidateResourceConfigCalled map[string]bool
+}
+
+func (s *TestServer) ProviderServer() tfprotov6.ProviderServer {
+	return s
+}
+
+func (s *TestServer) ApplyResourceChange(_ context.Context, req *tfprotov6.ApplyResourceChangeRequest) (*tfprotov6.ApplyResourceChangeResponse, error) {
+	if s.ApplyResourceChangeCalled == nil {
+		s.ApplyResourceChangeCalled = make(map[string]bool)
+	}
+
+	s.ApplyResourceChangeCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) ConfigureProvider(_ context.Context, _ *tfprotov6.ConfigureProviderRequest) (*tfprotov6.ConfigureProviderResponse, error) {
+	s.ConfigureProviderCalled = true
+	return &tfprotov6.ConfigureProviderResponse{}, nil
+}
+
+func (s *TestServer) GetProviderSchema(_ context.Context, _ *tfprotov6.GetProviderSchemaRequest) (*tfprotov6.GetProviderSchemaResponse, error) {
+	if s.DataSourceSchemas == nil {
+		s.DataSourceSchemas = make(map[string]*tfprotov6.Schema)
+	}
+
+	if s.ResourceSchemas == nil {
+		s.ResourceSchemas = make(map[string]*tfprotov6.Schema)
+	}
+
+	return &tfprotov6.GetProviderSchemaResponse{
+		Provider:          s.ProviderSchema,
+		ProviderMeta:      s.ProviderMetaSchema,
+		ResourceSchemas:   s.ResourceSchemas,
+		DataSourceSchemas: s.DataSourceSchemas,
+	}, nil
+}
+
+func (s *TestServer) ImportResourceState(_ context.Context, req *tfprotov6.ImportResourceStateRequest) (*tfprotov6.ImportResourceStateResponse, error) {
+	if s.ImportResourceStateCalled == nil {
+		s.ImportResourceStateCalled = make(map[string]bool)
+	}
+
+	s.ImportResourceStateCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) PlanResourceChange(_ context.Context, req *tfprotov6.PlanResourceChangeRequest) (*tfprotov6.PlanResourceChangeResponse, error) {
+	if s.PlanResourceChangeCalled == nil {
+		s.PlanResourceChangeCalled = make(map[string]bool)
+	}
+
+	s.PlanResourceChangeCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) ReadDataSource(_ context.Context, req *tfprotov6.ReadDataSourceRequest) (*tfprotov6.ReadDataSourceResponse, error) {
+	if s.ReadDataSourceCalled == nil {
+		s.ReadDataSourceCalled = make(map[string]bool)
+	}
+
+	s.ReadDataSourceCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) ReadResource(_ context.Context, req *tfprotov6.ReadResourceRequest) (*tfprotov6.ReadResourceResponse, error) {
+	if s.ReadResourceCalled == nil {
+		s.ReadResourceCalled = make(map[string]bool)
+	}
+
+	s.ReadResourceCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) StopProvider(_ context.Context, _ *tfprotov6.StopProviderRequest) (*tfprotov6.StopProviderResponse, error) {
+	s.StopProviderCalled = true
+
+	if s.StopProviderError != "" {
+		return &tfprotov6.StopProviderResponse{
+			Error: s.StopProviderError,
+		}, nil
+	}
+
+	return &tfprotov6.StopProviderResponse{}, nil
+}
+
+func (s *TestServer) UpgradeResourceState(_ context.Context, req *tfprotov6.UpgradeResourceStateRequest) (*tfprotov6.UpgradeResourceStateResponse, error) {
+	if s.UpgradeResourceStateCalled == nil {
+		s.UpgradeResourceStateCalled = make(map[string]bool)
+	}
+
+	s.UpgradeResourceStateCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) ValidateDataResourceConfig(_ context.Context, req *tfprotov6.ValidateDataResourceConfigRequest) (*tfprotov6.ValidateDataResourceConfigResponse, error) {
+	if s.ValidateDataResourceConfigCalled == nil {
+		s.ValidateDataResourceConfigCalled = make(map[string]bool)
+	}
+
+	s.ValidateDataResourceConfigCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) ValidateResourceConfig(_ context.Context, req *tfprotov6.ValidateResourceConfigRequest) (*tfprotov6.ValidateResourceConfigResponse, error) {
+	if s.ValidateResourceConfigCalled == nil {
+		s.ValidateResourceConfigCalled = make(map[string]bool)
+	}
+
+	s.ValidateResourceConfigCalled[req.TypeName] = true
+	return nil, nil
+}
+
+func (s *TestServer) ValidateProviderConfig(_ context.Context, req *tfprotov6.ValidateProviderConfigRequest) (*tfprotov6.ValidateProviderConfigResponse, error) {
+	s.ValidateProviderConfigCalled = true
+	return s.ValidateProviderConfigResponse, nil
+}