add proto files gen for stacks plugin, & regenerate protofiles

add tests

update changelog

Author: Uk1288

CHANGELOG.md

@@ -7,6 +7,7 @@ Experiments are only enabled in alpha releases of Terraform CLI. The following f
 
 - The new command `terraform rpcapi` exposes some Terraform Core functionality through an RPC interface compatible with [`go-plugin`](https://github.com/hashicorp/go-plugin). The exact RPC API exposed here is currently subject to change at any time, because it's here primarily as a vehicle to support the [Terraform Stacks](https://www.hashicorp.com/blog/terraform-stacks-explained) private preview and so will be broken if necessary to respond to feedback from private preview participants, or possibly for other reasons. Do not use this mechanism yet outside of Terraform Stacks private preview.
 - The experimental "deferred actions" feature, enabled by passing the `-allow-deferral` option to `terraform plan`, permits `count` and `for_each` arguments in `module`, `resource`, and `data` blocks to have unknown values and allows providers to react more flexibly to unknown values. This experiment is under active development, and so it's not yet useful to participate in this experiment
+- The new command `terraform stacks` exposes some [Terraform Stack](https://www.hashicorp.com/blog/terraform-stacks-explained) operations through the cli. The available subcommands depend on the stacks plugin implementation. Use `terraform stacks -help` to see available commands.
 
 ## Previous Releases
 

internal/command/stacks.go

@@ -131,6 +131,7 @@ func (c *StacksCommand) realRun(args []string, stdout, stderr io.Writer) int {
 func (c *StacksCommand) discoverAndConfigure() tfdiags.Diagnostics {
 	var diags tfdiags.Diagnostics
 
+	// using the current terraform path for the plugin binary path
 	tfBinaryPath, err := os.Executable()
 	if err != nil {
 		return diags.Append(tfdiags.Sourceless(
@@ -219,7 +220,7 @@ func (c *StacksCommand) discoverAndConfigure() tfdiags.Diagnostics {
 	}
 	c.pluginService = pluginService
 
-	tfeService, err := cb.ServicesHost.ServiceURL(tfeServiceID)
+	tfeService, err := cb.ServicesHost.ServiceURL(tfeStacksServiceID)
 	if err != nil {
 		return diags.Append(tfdiags.Sourceless(
 			tfdiags.Error,
@@ -228,13 +229,21 @@ func (c *StacksCommand) discoverAndConfigure() tfdiags.Diagnostics {
 		))
 	}
 
+	// optional env values
+	orgName := os.Getenv("TF_STACKS_ORGANIZATION_NAME")
+	projectName := os.Getenv("TF_STACKS_PROJECT_NAME")
+	stackName := os.Getenv("TF_STACKS_STACK_NAME")
+
 	// config to be passed to the plugin later.
 	c.pluginConfig = StacksPluginConfig{
 		Address:             tfeService.String(),
 		BasePath:            tfeService.Path,
 		DisplayHostname:     displayHostname,
 		Token:               token,
 		TerraformBinaryPath: tfBinaryPath,
+		OrganizationName:    orgName,
+		ProjectName:         projectName,
+		StackName:           stackName,
 	}
 
 	return diags
@@ -334,6 +343,9 @@ type StacksPluginConfig struct {
 	DisplayHostname     string `md:"tfc-display-hostname"`
 	Token               string `md:"tfc-token"`
 	TerraformBinaryPath string `md:"terraform-binary-path"`
+	OrganizationName    string `md:"tfc-organization"`
+	ProjectName         string `md:"tfc-project"`
+	StackName           string `md:"tfc-stack"`
 }
 
 func (c StacksPluginConfig) ToMetadata() metadata.MD {
@@ -343,6 +355,9 @@ func (c StacksPluginConfig) ToMetadata() metadata.MD {
 		"tfc-display-hostname", c.DisplayHostname,
 		"tfc-token", c.Token,
 		"terraform-binary-path", c.TerraformBinaryPath,
+		"tfc-organization", c.OrganizationName,
+		"tfc-project", c.ProjectName,
+		"tfc-stack", c.StackName,
 	)
 	return md
 }

internal/command/stacks_test.go

@@ -0,0 +1,38 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package command
+
+import (
+	"reflect"
+	"testing"
+
+	"google.golang.org/grpc/metadata"
+)
+
+func TestStacksPluginConfig_ToMetadata(t *testing.T) {
+	expected := metadata.Pairs(
+		"tfc-address", "https://app.staging.terraform.io",
+		"tfc-base-path", "/api/v2/",
+		"tfc-display-hostname", "app.staging.terraform.io",
+		"tfc-token", "not-a-legit-token",
+		"tfc-organization", "example-corp",
+		"tfc-project", "example-project",
+		"tfc-stack", "example-stack",
+		"terraform-binary-path", "",
+	)
+	inputStruct := StacksPluginConfig{
+		Address:             "https://app.staging.terraform.io",
+		BasePath:            "/api/v2/",
+		DisplayHostname:     "app.staging.terraform.io",
+		Token:               "not-a-legit-token",
+		OrganizationName:    "example-corp",
+		ProjectName:         "example-project",
+		StackName:           "example-stack",
+		TerraformBinaryPath: "",
+	}
+	result := inputStruct.ToMetadata()
+	if !reflect.DeepEqual(expected, result) {
+		t.Fatalf("Expected: %#v\nGot: %#v\n", expected, result)
+	}
+}

internal/pluginshared/cloudclient.go

@@ -12,10 +12,6 @@ import (
 	"github.com/hashicorp/terraform/internal/logging"
 )
 
-// type CloudPluginClient struct {
-// 	BasePluginClient
-// }
-
 // NewCloudPluginClient creates a new client for downloading and verifying
 // terraform-cloudplugin archives
 func NewCloudPluginClient(ctx context.Context, serviceURL *url.URL) (*BasePluginClient, error) {
@@ -34,7 +30,5 @@ func NewCloudPluginClient(ctx context.Context, serviceURL *url.URL) (*BasePlugin
 		httpClient: retryableClient,
 		pluginName: "cloudplugin",
 	}
-
-	// return &CloudPluginClient{BasePluginClient: client}, nil
 	return &client, nil
 }

internal/pluginshared/stacksclient.go

@@ -12,10 +12,6 @@ import (
 	"github.com/hashicorp/terraform/internal/logging"
 )
 
-// type StacksPluginClient struct {
-// 	BasePluginClient
-// }
-
 // NewStacksPluginClient creates a new client for downloading and verifying
 // terraform-stacks plugin archives
 func NewStacksPluginClient(ctx context.Context, serviceURL *url.URL) (*BasePluginClient, error) {
@@ -34,7 +30,5 @@ func NewStacksPluginClient(ctx context.Context, serviceURL *url.URL) (*BasePlugi
 		httpClient: retryableClient,
 		pluginName: "stacksplugin",
 	}
-
-	// return &StacksPluginClient{BasePluginClient: client}, nil
 	return &client, nil
 }

internal/cloudplugin/testdata/archives/terraform-cloudplugin_0.1.0_SHA256SUMS renamed to internal/pluginshared/testdata/archives/terraform-cloudplugin_0.1.0_SHA256SUMS

@@ -12,12 +12,12 @@ import (
 	"github.com/hashicorp/go-plugin"
 	"github.com/hashicorp/terraform-svchost/disco"
 	"github.com/hashicorp/terraform/internal/pluginshared"
+
 	"github.com/hashicorp/terraform/internal/rpcapi/dynrpcserver"
 	"github.com/hashicorp/terraform/internal/rpcapi/terraform1/dependencies"
 	"github.com/hashicorp/terraform/internal/rpcapi/terraform1/packages"
 	"github.com/hashicorp/terraform/internal/rpcapi/terraform1/stacks"
 	"github.com/hashicorp/terraform/internal/stacksplugin/stacksproto1"
-
 	"google.golang.org/grpc"
 )
 
@@ -32,9 +32,15 @@ type GRPCStacksClient struct {
 // Proof that GRPCStacksClient fulfills the go-plugin interface
 var _ pluginshared.CustomPluginClient = GRPCStacksClient{}
 
-// Execute sends the client Execute request and waits for the plugin to return
-// an exit code response before returning
-func (c GRPCStacksClient) Execute(args []string, stdout, stderr io.Writer) int {
+type brokerIDs struct {
+	packagesBrokerID     uint32
+	dependenciesBrokerID uint32
+	stacksBrokerID       uint32
+}
+
+// registerBrokers starts the GRPC servers for the dependencies, packages, and stacks
+// services and returns the broker IDs for each.
+func (c GRPCStacksClient) registerBrokers(stdout, stderr io.Writer) brokerIDs {
 	handles := newHandleTable()
 
 	dependenciesServer := dynrpcserver.NewDependenciesStub()
@@ -75,10 +81,20 @@ func (c GRPCStacksClient) Execute(args []string, stdout, stderr io.Writer) int {
 	stacksBrokerID := c.Broker.NextId()
 	go c.Broker.AcceptAndServe(stacksBrokerID, stacksServerFunc)
 
+	return brokerIDs{
+		dependenciesBrokerID: dependenciesBrokerID,
+		packagesBrokerID:     packagesBrokerID,
+		stacksBrokerID:       stacksBrokerID,
+	}
+}
+
+// Execute sends the client Execute request and waits for the plugin to return
+// an exit code response before returning
+func (c GRPCStacksClient) executeWithBrokers(brokerIDs brokerIDs, args []string, stdout, stderr io.Writer) int {
 	client, err := c.Client.Execute(c.Context, &stacksproto1.CommandRequest{
-		DependenciesServer: dependenciesBrokerID,
-		PackagesServer:     packagesBrokerID,
-		StacksServer:       stacksBrokerID,
+		DependenciesServer: brokerIDs.dependenciesBrokerID,
+		PackagesServer:     brokerIDs.packagesBrokerID,
+		StacksServer:       brokerIDs.stacksBrokerID,
 		Args:               args,
 	})
 
@@ -132,3 +148,10 @@ func (c GRPCStacksClient) Execute(args []string, stdout, stderr io.Writer) int {
 	fmt.Fprint(stderr, "stacksplugin exited without responding with an error code")
 	return 1
 }
+
+// Execute sends the client Execute request and waits for the plugin to return
+// an exit code response before returning
+func (c GRPCStacksClient) Execute(args []string, stdout, stderr io.Writer) int {
+	brokerIDs := c.registerBrokers(stdout, stderr)
+	return c.executeWithBrokers(brokerIDs, args, stdout, stderr)
+}