Added test, improved documentation.

Author: rosmo

docs/resources/counter.md

@@ -3,12 +3,18 @@
 page_title: "persistent_counter Resource - terraform-provider-persistent"
 subcategory: ""
 description: |-
-  Persistent counter
+  Persistent counter. Generates sequentially increasing number counters for the strings specified 
+          in the `keys` variable. As long as a specified key exist, it will always receive the same counter
+          value. No counter value is re-used even if a new key is added and counter values will only ever
+          increase.
 ---
 
 # persistent_counter (Resource)
 
-Persistent counter
+Persistent counter. Generates sequentially increasing number counters for the strings specified 
+			in the `keys` variable. As long as a specified key exist, it will always receive the same counter
+			value. No counter value is re-used even if a new key is added and counter values will only ever
+			increase.
 
 
 
@@ -17,16 +23,16 @@ Persistent counter
 
 ### Required
 
-- `keys` (List of String)
+- `keys` (List of String) List of keys to generate counters for.
 
 ### Optional
 
 - `initial_value` (Number) The initial value to use for the counter.
-- `values` (Map of Number) A map of strings that will cause a change to the counter when any of the values change.
+- `values` (Map of Number) A map of keys to counter values.
 
 ### Read-Only
 
-- `id` (String) Identifier
+- `id` (String) Identifier (always fixed)
 - `last_value` (Number) The last value that was used for the counter.
 
 

examples/resource/counter/resource.tf

@@ -0,0 +1,5 @@
+resource "persistent_counter" "example" {
+  initial_value = 5
+  keys          = ["a", "b", "d"]
+}
+# persistent_counter.example.values = { a = 5, b = 6, c = 7 }

internal/provider/counter_resource.go

@@ -39,18 +39,23 @@ func (r *PersistentCounterResource) Metadata(ctx context.Context, req resource.M
 
 func (r *PersistentCounterResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		// This description is used by the documentation generator and the language server.
-		MarkdownDescription: "Persistent counter",
+		MarkdownDescription: `
+			Persistent counter. Generates sequentially increasing number counters for the strings specified 
+			in the ` + "`keys`" + ` variable. As long as a specified key exist, it will always receive the same counter
+			value. No counter value is re-used even if a new key is added and counter values will only ever
+			increase.
+		`,
 
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
-				Computed:            true,
-				MarkdownDescription: "Identifier",
+				Computed:    true,
+				Description: "Identifier (always fixed)",
 				PlanModifiers: []planmodifier.String{
 					stringplanmodifier.UseStateForUnknown(),
 				},
 			},
 			"keys": schema.ListAttribute{
+				Description: "List of keys to generate counters for.",
 				ElementType: types.StringType,
 				Required:    true,
 			},
@@ -71,7 +76,7 @@ func (r *PersistentCounterResource) Schema(ctx context.Context, req resource.Sch
 				ElementType: types.Int64Type,
 				Optional:    true,
 				Computed:    true,
-				Description: "A map of strings that will cause a change to the counter when any of the values change.",
+				Description: "A map of keys to counter values.",
 			},
 		},
 	}

internal/provider/counter_resource_test.go

@@ -44,6 +44,17 @@ func TestAccPersistentCounterResource(t *testing.T) {
 					resource.TestCheckResourceAttr("persistent_counter.test", "values.e", "4"),
 				),
 			},
+			{
+				Config: testAccCounterInitialResourceConfig(),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("persistent_counter.initial-value", "initial_value", "5"),
+					resource.TestCheckResourceAttr("persistent_counter.initial-value", "last_value", "8"),
+					resource.TestCheckResourceAttr("persistent_counter.initial-value", "values.a", "5"),
+					resource.TestCheckResourceAttr("persistent_counter.initial-value", "values.b", "6"),
+					resource.TestCheckResourceAttr("persistent_counter.initial-value", "values.c", "7"),
+					resource.TestCheckResourceAttr("persistent_counter.initial-value", "values.d", "8"),
+				),
+			},
 		},
 	})
 }
@@ -74,3 +85,12 @@ resource "persistent_counter" "test" {
 }
 `
 }
+
+func testAccCounterInitialResourceConfig() string {
+	return `
+resource "persistent_counter" "initial-value" {
+  initial_value = 5
+  keys          = ["a", "b", "c", "d"]
+}
+`
+}