Merge branch 'mr/TF-1450-policy-evaluation' into mr/TF-1450-policy-ov…

…erride

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Add OPA support to the Policy Set APIs by @mrinalirao [#575](https://github.com/hashicorp/go-tfe/pull/575)
 * Add OPA support to the Policy APIs by @mrinalirao [#579](https://github.com/hashicorp/go-tfe/pull/579)
+* Add Policy Evaluation and Policy Set Outcome APIs by @mrinalirao [#583](https://github.com/hashicorp/go-tfe/pull/583)
 
 # v1.12.0
 

helper_test.go

@@ -663,7 +663,8 @@ func createPolicyWithOptions(t *testing.T, client *Client, org *Organization, op
 		Enforce: []*EnforcementOptions{
 			{
 				Path: String(path),
-				Mode: opts.Enforce[0].Mode},
+				Mode: opts.Enforce[0].Mode,
+			},
 		},
 	}
 

policy_evaluation.go

@@ -10,6 +10,20 @@ import (
 // Compile-time proof of interface implementation.
 var _ PolicyEvaluations = (*policyEvaluation)(nil)
 
+// PolicyEvaluationStatus is an enum that represents all possible statuses for a policy evaluation
+type PolicyEvaluationStatus string
+
+const (
+	PolicyEvaluationPassed      PolicyEvaluationStatus = "passed"
+	PolicyEvaluationFailed      PolicyEvaluationStatus = "failed"
+	PolicyEvaluationPending     PolicyEvaluationStatus = "pending"
+	PolicyEvaluationRunning     PolicyEvaluationStatus = "running"
+	PolicyEvaluationUnreachable PolicyEvaluationStatus = "unreachable"
+	PolicyEvaluationOverridden  PolicyEvaluationStatus = "overridden"
+	PolicyEvaluationCanceled    PolicyEvaluationStatus = "canceled"
+	PolicyEvaluationErrored     PolicyEvaluationStatus = "errored"
+)
+
 // PolicyResultCount represents the count of the policy results
 type PolicyResultCount struct {
 	AdvisoryFailed  int `jsonapi:"attr,advisory-failed"`
@@ -24,15 +38,24 @@ type PolicyAttachable struct {
 	Type string `jsonapi:"attr,type"`
 }
 
+// PolicyEvaluationStatusTimestamps represents the set of timestamps recorded for a policy evaluation
+type PolicyEvaluationStatusTimestamps struct {
+	ErroredAt  time.Time `jsonapi:"attr,errored-at,rfc3339"`
+	RunningAt  time.Time `jsonapi:"attr,running-at,rfc3339"`
+	CanceledAt time.Time `jsonapi:"attr,canceled-at,rfc3339"`
+	FailedAt   time.Time `jsonapi:"attr,failed-at,rfc3339"`
+	PassedAt   time.Time `jsonapi:"attr,passed-at,rfc3339"`
+}
+
 // PolicyEvaluation represents the policy evaluations that are part of the task stage.
 type PolicyEvaluation struct {
-	ID               string                     `jsonapi:"primary,policy-evaluations"`
-	Status           TaskResultStatus           `jsonapi:"attr,status"`
-	PolicyKind       PolicyKind                 `jsonapi:"attr,policy-kind"`
-	StatusTimestamps TaskResultStatusTimestamps `jsonapi:"attr,status-timestamps"`
-	ResultCount      *PolicyResultCount         `jsonapi:"attr,result-count"`
-	CreatedAt        time.Time                  `jsonapi:"attr,created-at,iso8601"`
-	UpdatedAt        time.Time                  `jsonapi:"attr,updated-at,iso8601"`
+	ID               string                           `jsonapi:"primary,policy-evaluations"`
+	Status           PolicyEvaluationStatus           `jsonapi:"attr,status"`
+	PolicyKind       PolicyKind                       `jsonapi:"attr,policy-kind"`
+	StatusTimestamps PolicyEvaluationStatusTimestamps `jsonapi:"attr,status-timestamps"`
+	ResultCount      *PolicyResultCount               `jsonapi:"attr,result-count"`
+	CreatedAt        time.Time                        `jsonapi:"attr,created-at,iso8601"`
+	UpdatedAt        time.Time                        `jsonapi:"attr,updated-at,iso8601"`
 
 	// The task stage this evaluation belongs to
 	TaskStage *PolicyAttachable `jsonapi:"relation,policy-attachable"`
@@ -101,7 +124,7 @@ type PolicySetOutcomes interface {
 
 	// **Note: This method is still in BETA and subject to change.**
 	// Read a policy set outcome by its ID. Only available for OPA policies.
-	Read(ctx context.Context, policy_set_outcome_id string) (*PolicySetOutcome, error)
+	Read(ctx context.Context, policySetOutcomeID string) (*PolicySetOutcome, error)
 }
 
 // policySetOutcome implements PolicySetOutcomes.