Fix validation of run status; add unit test [issue 1061] (#1171)

* Fix validation of run status; add unit test [issue 1061]

validateAdminRunFilterParams in admin_run.go was using RunCostEstimate, a RunIncludeOpt.
It should be using RunCostEstimated, a RunStatus. Adds unit test.

Some of the RunStatus values were not accepted by validateAdminRunFilterParams - this PR assumes that was a mistake.
The validate function has been fixed to accept all status values.

* fix changelog

Author: KenCox-Hashicorp

CHANGELOG.md

@@ -3,6 +3,9 @@
 ## Enhancements
 * Adds support for `RegistryModule` VCS source_directory and tag_prefix options, by @jillrami [#1154] (https://github.com/hashicorp/go-tfe/pull/1154)
 
+## Bug Fixes
+* Fixes issue [1061](https://github.com/hashicorp/go-tfe/issues/1061), validation accepts all RunStatus including `"cost_estimated"` by @KenCox-Hashicorp [#1171](https://github.com/hashicorp/go-tfe/pull/1171)
+
 # v1.89.0
 
 ## Enhancements

admin_run.go

@@ -167,19 +167,31 @@ func validateAdminRunFilterParams(runStatus string) error {
 				string(RunApplying),
 				string(RunCanceled),
 				string(RunConfirmed),
-				string(RunCostEstimate),
+				string(RunCostEstimated),
 				string(RunCostEstimating),
 				string(RunDiscarded),
 				string(RunErrored),
+				string(RunFetching),
+				string(RunFetchingCompleted),
 				string(RunPending),
-				string(RunPlanQueued),
 				string(RunPlanned),
 				string(RunPlannedAndFinished),
+				string(RunPlannedAndSaved),
 				string(RunPlanning),
+				string(RunPlanQueued),
 				string(RunPolicyChecked),
 				string(RunPolicyChecking),
 				string(RunPolicyOverride),
 				string(RunPolicySoftFailed),
+				string(RunPostPlanAwaitingDecision),
+				string(RunPostPlanCompleted),
+				string(RunPostPlanRunning),
+				string(RunPreApplyRunning),
+				string(RunPreApplyCompleted),
+				string(RunPrePlanCompleted),
+				string(RunPrePlanRunning),
+				string(RunQueuing),
+				string(RunQueuingApply),
 				"":
 				// do nothing
 			default:

admin_run_test.go

@@ -0,0 +1,64 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package tfe
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func Test_validateAdminRunFilterParams(t *testing.T) {
+	// All RunStatus values - keep this in sync with run.go
+	validRunStatuses := []string{
+		"applied",
+		"applying",
+		"apply_queued",
+		"canceled",
+		"confirmed",
+		"cost_estimated",
+		"cost_estimating",
+		"discarded",
+		"errored",
+		"fetching",
+		"fetching_completed",
+		"pending",
+		"planned",
+		"planned_and_finished",
+		"planned_and_saved",
+		"planning",
+		"plan_queued",
+		"policy_checked",
+		"policy_checking",
+		"policy_override",
+		"policy_soft_failed",
+		"post_plan_awaiting_decision",
+		"post_plan_completed",
+		"post_plan_running",
+		"pre_apply_running",
+		"pre_apply_completed",
+		"pre_plan_completed",
+		"pre_plan_running",
+		"queuing",
+		"queuing_apply",
+	}
+	for _, v := range validRunStatuses {
+		t.Run(v, func(t *testing.T) {
+			require.NoError(t, validateAdminRunFilterParams(v), fmt.Sprintf("'%s' should be valid", v))
+		})
+	}
+
+	// empty string is allowed
+	require.NoError(t, validateAdminRunFilterParams(""), "empty string should be valid")
+
+	// comma-separated list, all valid
+	require.NoError(t, validateAdminRunFilterParams("applied,planned,canceled"), "'applied,planned,canceled' should be valid)")
+
+	// invalid values
+	require.Error(t, validateAdminRunFilterParams("cost_estimate"), "invalid value: cost_estimate")
+
+	// comma-separated list, some invalid
+	require.Error(t, validateAdminRunFilterParams("applied,not-planned,canceled"), "'applied,not-planned,canceled' should be invalid)")
+}