Add an example action

Author: SBGoods

docs/actions/example.md

@@ -0,0 +1,39 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "scaffolding_example Action - scaffolding"
+subcategory: ""
+description: |-
+  Example action
+---
+
+# scaffolding_example (Action)
+
+Example action
+
+## Example Usage
+
+```terraform
+resource "terraform_data" "example" {
+  input = "fake-string"
+
+  lifecycle {
+    action_trigger {
+      events  = [before_create]
+      actions = [action.scaffolding_example.example]
+    }
+  }
+}
+
+action "scaffolding_example" "example" {
+  config {
+    configurable_attribute = "some-value"
+  }
+}
+```
+
+<!-- action schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `configurable_attribute` (String) Example configurable attribute

examples/actions/scaffolding_example/action.tf

@@ -0,0 +1,16 @@
+resource "terraform_data" "example" {
+  input = "fake-string"
+
+  lifecycle {
+    action_trigger {
+      events  = [before_create]
+      actions = [action.scaffolding_example.example]
+    }
+  }
+}
+
+action "scaffolding_example" "example" {
+  config {
+    configurable_attribute = "some-value"
+  }
+}

internal/provider/example_action.go

@@ -0,0 +1,104 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package provider
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	"github.com/hashicorp/terraform-plugin-framework/action"
+	"github.com/hashicorp/terraform-plugin-framework/action/schema"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+)
+
+// Ensure provider defined types fully satisfy framework interfaces.
+var _ action.Action = &ExampleAction{}
+var _ action.ActionWithConfigure = &ExampleAction{}
+
+func NewExampleAction() action.Action {
+	return &ExampleAction{}
+}
+
+// ExampleAction defines the action implementation.
+type ExampleAction struct {
+	client *http.Client
+}
+
+// ExampleActionModel describes the action data model.
+type ExampleActionModel struct {
+	ConfigurableAttribute types.String `tfsdk:"configurable_attribute"`
+}
+
+func (e *ExampleAction) Metadata(ctx context.Context, req action.MetadataRequest, resp *action.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_example"
+}
+
+func (e *ExampleAction) Schema(ctx context.Context, req action.SchemaRequest, resp *action.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		// This description is used by the documentation generator and the language server.
+		MarkdownDescription: "Example action",
+
+		Attributes: map[string]schema.Attribute{
+			"configurable_attribute": schema.StringAttribute{
+				MarkdownDescription: "Example configurable attribute",
+				Optional:            true,
+			},
+		},
+	}
+}
+
+func (e *ExampleAction) Configure(ctx context.Context, req action.ConfigureRequest, resp *action.ConfigureResponse) {
+	// Prevent panic if the provider has not been configured.
+	if req.ProviderData == nil {
+		return
+	}
+
+	client, ok := req.ProviderData.(*http.Client)
+
+	if !ok {
+		resp.Diagnostics.AddError(
+			"Unexpected Data Source Configure Type",
+			fmt.Sprintf("Expected *http.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData),
+		)
+
+		return
+	}
+
+	e.client = client
+}
+
+func (e *ExampleAction) Invoke(ctx context.Context, req action.InvokeRequest, resp *action.InvokeResponse) {
+	// Send a progress message back to Terraform
+	resp.SendProgress = func(event action.InvokeProgressEvent) {
+		event.Message = "starting action invocation"
+	}
+
+	var data ExampleActionModel
+
+	// Read Terraform configuration data into the model
+	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// If applicable, this is a great opportunity to initialize any necessary
+	// provider client data and make a call using it.
+	// httpResp, err := d.client.Do(httpReq)
+	// if err != nil {
+	//     resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read example, got error: %s", err))
+	//     return
+	// }
+
+	// Write logs using the tflog package
+	// Documentation: https://terraform.io/plugin/log
+	tflog.Trace(ctx, "invoke an action")
+
+	// Send a progress message back to Terraform
+	resp.SendProgress = func(event action.InvokeProgressEvent) {
+		event.Message = "finished action invocation"
+	}
+}

internal/provider/provider.go

@@ -7,6 +7,7 @@ import (
 	"context"
 	"net/http"
 
+	"github.com/hashicorp/terraform-plugin-framework/action"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/ephemeral"
 	"github.com/hashicorp/terraform-plugin-framework/function"
@@ -20,6 +21,7 @@ import (
 var _ provider.Provider = &ScaffoldingProvider{}
 var _ provider.ProviderWithFunctions = &ScaffoldingProvider{}
 var _ provider.ProviderWithEphemeralResources = &ScaffoldingProvider{}
+var _ provider.ProviderWithActions = &ScaffoldingProvider{}
 
 // ScaffoldingProvider defines the provider implementation.
 type ScaffoldingProvider struct {
@@ -92,6 +94,12 @@ func (p *ScaffoldingProvider) Functions(ctx context.Context) []func() function.F
 	}
 }
 
+func (p *ScaffoldingProvider) Actions(ctx context.Context) []func() action.Action {
+	return []func() action.Action{
+		NewExampleAction,
+	}
+}
+
 func New(version string) func() provider.Provider {
 	return func() provider.Provider {
 		return &ScaffoldingProvider{