Add idempotency_key support to fixture request spec (#1009)

* Add idempotency_key support to fixture request spec

Also fix a bug in metadata that testing idempotency keys uncovered.

* Omit IdempotencyKey when empty

* Fix omitempty spelling

pkg/fixtures/fixtures.go

@@ -43,6 +43,7 @@ type FixtureRequest struct {
 	Path              string                 `json:"path"`
 	Method            string                 `json:"method"`
 	Params            map[string]interface{} `json:"params"`
+	IdempotencyKey    string                 `json:"idempotency_key,omitempty"`
 	Context           string                 `json:"context,omitempty"`
 }
 
@@ -297,19 +298,10 @@ func (fxt *Fixture) UpdateEnv() error {
 }
 
 func (fxt *Fixture) makeRequest(ctx context.Context, data FixtureRequest, apiVersion string) ([]byte, error) {
-	var rp requests.RequestParameters
-
-	if data.Method == "post" && !fxt.FixtureData.Meta.ExcludeMetadata {
-		now := time.Now().String()
-		metadata := fmt.Sprintf("metadata[_created_by_fixture]=%s", now)
-		rp.AppendData([]string{metadata})
-	}
-
 	req := requests.Base{
 		Method:         strings.ToUpper(data.Method),
 		SuppressOutput: true,
 		APIBaseURL:     fxt.BaseURL,
-		Parameters:     rp,
 	}
 
 	path, err := fxt.ParsePath(data)
@@ -319,11 +311,24 @@ func (fxt *Fixture) makeRequest(ctx context.Context, data FixtureRequest, apiVer
 	}
 
 	params, err := fxt.createParams(data.Params, apiVersion)
-
 	if err != nil {
 		return make([]byte, 0), err
 	}
 
+	if data.Method == "post" && !fxt.FixtureData.Meta.ExcludeMetadata {
+		now := time.Now().String()
+		metadata := fmt.Sprintf("metadata[_created_by_fixture]=%s", now)
+		params.AppendData([]string{metadata})
+	}
+
+	if data.IdempotencyKey != "" {
+		idempotencyKey, err := fxt.ParseQuery(data.IdempotencyKey)
+		if err != nil {
+			return nil, fmt.Errorf("error parsing idempotency_key field: %w", err)
+		}
+		params.SetIdempotency(idempotencyKey)
+	}
+
 	return req.MakeRequest(ctx, fxt.APIKey, path, params, true)
 }
 

pkg/fixtures/fixtures_test.go

@@ -28,6 +28,7 @@ const testFixture = `
 			"name": "cust_bender",
 			"path": "/v1/customers",
 			"method": "post",
+			"idempotency_key": "create_cust_bender",
 			"params": {
 				"name": "Bender Bending Rodriguez",
 				"email": "bender@planex.com",
@@ -90,6 +91,18 @@ func TestMakeRequest(t *testing.T) {
 	ts := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
 		switch url := req.URL.String(); url {
 		case customersPath:
+			if req.Header.Get("Idempotency-Key") == "" {
+				t.Errorf("Idempotency key not sent")
+			}
+
+			if err := req.ParseForm(); err != nil {
+				t.Error(err)
+			}
+
+			if req.Form.Get("metadata[_created_by_fixture]") == "" {
+				t.Error("Metadata not set")
+			}
+
 			res.Write([]byte(`{"id": "cust_12345", "foo": "bar"}`))
 		case chargePath:
 			res.Write([]byte(`{"charge": true, "id": "char_12345"}`))