add VCR-style HTTP recording/replay for integration tests

Author: vzickner

.gitignore

@@ -23,3 +23,6 @@ go.work.sum
 
 # env file
 .env
+
+.idea
+*.iml

flowable/rest_utils.go

@@ -8,7 +8,7 @@ import (
 
 // rest_utils.go centralizes HTTP helpers, default headers, and auth settings used by the package.
 
-// Package-level auth and header configuration
+// Package-level auth, header, and HTTP client configuration
 var (
 	AuthUser       = ""
 	AuthPass       = ""
@@ -17,8 +17,15 @@ var (
 		"Accept":       "application/json",
 		"Content-Type": "application/json",
 	}
+	HTTPClient *http.Client = &http.Client{}
 )
 
+// SetHTTPClient allows callers to override the HTTP client used for REST requests.
+// This is useful for injecting a VCR recorder transport for testing.
+func SetHTTPClient(c *http.Client) {
+	HTTPClient = c
+}
+
 // SetAuth allows callers to override the basic auth credentials used for REST requests.
 func SetAuth(user, pass string) {
 	AuthUser = user
@@ -51,15 +58,14 @@ func prepareRequest(req *http.Request) {
 
 // restGet performs a GET request to the provided full URL and returns status, body bytes, and error.
 func restGet(fullURL string) (status int, body []byte, err error) {
-	client := &http.Client{}
 	req, err := http.NewRequest("GET", fullURL, nil)
 	if err != nil {
 		return -1, nil, err
 	}
 
 	prepareRequest(req)
 
-	resp, err := client.Do(req)
+	resp, err := HTTPClient.Do(req)
 	if err != nil {
 		return -1, nil, err
 	}
@@ -73,15 +79,14 @@ func restGet(fullURL string) (status int, body []byte, err error) {
 
 // restPost performs a POST request to the provided full URL with the given JSON payload.
 func restPost(fullURL string, payload []byte) (status int, body []byte, err error) {
-	client := &http.Client{}
 	req, err := http.NewRequest("POST", fullURL, bytes.NewReader(payload))
 	if err != nil {
 		return -1, nil, err
 	}
 
 	prepareRequest(req)
 
-	resp, err := client.Do(req)
+	resp, err := HTTPClient.Do(req)
 	if err != nil {
 		return -1, nil, err
 	}

go.mod

@@ -1,3 +1,7 @@
 module github.com/flowable/flowable-external-client-golang
 
-go 1.23.4
+go 1.24
+
+require gopkg.in/dnaeon/go-vcr.v4 v4.0.6
+
+require go.yaml.in/yaml/v4 v4.0.0-rc.3 // indirect

go.sum

@@ -0,0 +1,4 @@
+go.yaml.in/yaml/v4 v4.0.0-rc.3 h1:3h1fjsh1CTAPjW7q/EMe+C8shx5d8ctzZTrLcs/j8Go=
+go.yaml.in/yaml/v4 v4.0.0-rc.3/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
+gopkg.in/dnaeon/go-vcr.v4 v4.0.6 h1:PiJkrakkmzc5s7EfBnZOnyiLwi7o7A9fwPzN0X2uwe0=
+gopkg.in/dnaeon/go-vcr.v4 v4.0.6/go.mod h1:sbq5oMEcM4PXngbcNbHhzfCP9OdZodLhrbRYoyg09HY=