feat: added support to set variables in tester agent

xavidop · xavidop · commit 59630a50c545 · 2026-01-23T11:24:27.000+01:00
diff --git a/docs/docs/static/conversationsuite.json b/docs/docs/static/conversationsuite.json
@@ -329,6 +329,9 @@
 							},
 							"apiKey": {
 								"type": "string"
+							},
+							"variables": {
+								"type": "object"
 							}
 						},
 						"additionalProperties": false,
diff --git a/docs/docs/static/conversationtest.json b/docs/docs/static/conversationtest.json
@@ -265,6 +265,9 @@
 					},
 					"apiKey": {
 						"type": "string"
+					},
+					"variables": {
+						"type": "object"
 					}
 				},
 				"additionalProperties": false,
diff --git a/docs/docs/static/swagger.json b/docs/docs/static/swagger.json
@@ -517,6 +517,10 @@
                 },
                 "environmentName": {
                     "type": "string"
+                },
+                "variables": {
+                    "type": "object",
+                    "additionalProperties": true
                 }
             }
         }
diff --git a/docs/docs/static/swagger.yaml b/docs/docs/static/swagger.yaml
@@ -245,6 +245,9 @@ definitions:
         type: string
       environmentName:
         type: string
+      variables:
+        additionalProperties: true
+        type: object
     type: object
 host: localhost:8080
 info:
diff --git a/docs/docs/tests/agent-to-agent-tests.md b/docs/docs/tests/agent-to-agent-tests.md
@@ -150,11 +150,13 @@ Configures a Voiceflow agent to act as the tester instead of using OpenAI. When
 
 - `environmentName`: The environment name of the tester Voiceflow agent (e.g., "production", "development")
 - `apiKey`: The API key for the tester Voiceflow agent (format: `VF.DM.xxxxx.xxxxx`)
+- `variables` (Optional): A map of variables to set in the tester agent after the launch event. These variables will be set using the [Voiceflow State Variables API](https://docs.voiceflow.com/reference/updatestatevariables-1) after launching the tester agent.
 
 **Important Notes:**
 
 - When using Voiceflow agent testing, the `persona` and `userInformation` properties are ignored
 - The tester agent should be pre-configured with appropriate conversation logic and any required user data
+- Variables are set immediately after the launch event, allowing you to initialize the tester agent's state for each test
 - OpenAI is still used for goal evaluation even when using Voiceflow agent testing
 
 **Example:**
@@ -181,6 +183,12 @@ agent:
   voiceflowAgentTesterConfig:
     environmentName: "production"
     apiKey: "VF.DM.your-tester-agent-key"
+    # Optional: Set variables in the tester agent
+    variables:
+      user_name: "John Doe"
+      user_id: "12345"
+      booking_type: "hotel"
+      check_in_date: "2026-02-15"
 ```
 
 ## Choosing Between Testing Methods
@@ -288,7 +296,8 @@ tests:
 ✅ **Best Practices:**
 
 - Design the tester agent with clear conversation flows
-- Include appropriate user information within the agent
+- Include appropriate user information within the agent or use the `variables` property to set dynamic values
+- Use the `variables` property to initialize agent state for different test scenarios
 - Test the tester agent independently before using in tests
 - Use meaningful environment names and secure API keys
 
diff --git a/examples/tests/test_3.yaml b/examples/tests/test_3.yaml
@@ -11,6 +11,12 @@ agent:
   voiceflowAgentTesterConfig:
     environmentName: "production"
     apiKey: "VF.DM.my.key"
+    # Optional: Variables to set in the tester agent after launch
+    # These variables will be set using the Voiceflow State API after the launch event
+    variables:
+      user_name: "John Doe"
+      user_address: "12345"
+      subscription_tier: "premium"
   # Note: This test type does not use userInformation since the tester is a Voiceflow agent
 
 # yaml-language-server: $schema=https://voiceflow.xavidop.me/static/conversationtest.json
diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.24.0
 
 require (
 	github.com/pkg/errors v0.9.1
-	github.com/sirupsen/logrus v1.9.3
+	github.com/sirupsen/logrus v1.9.4
 	github.com/spf13/cobra v1.10.2
 )
 
diff --git a/go.sum b/go.sum
@@ -131,8 +131,8 @@ github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjR
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/sirupsen/logrus v1.9.4 h1:TsZE7l11zFCLZnZ+teH4Umoq5BhEIfIzfRDZ1Uzql2w=
+github.com/sirupsen/logrus v1.9.4/go.mod h1:ftWc9WdOfJ0a92nsE2jF5u5ZwH8Bv2zdeOC42RjbV2g=
 github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
 github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
 github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
@@ -142,7 +142,6 @@ github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSS
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
@@ -190,7 +189,6 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210420072515-93ed5bcd2bfe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
diff --git a/internal/types/tests/testTypes.go b/internal/types/tests/testTypes.go
@@ -19,8 +19,9 @@ type AgentTest struct {
 
 // VoiceflowAgentTesterConfig defines configuration for using a Voiceflow agent as the tester
 type VoiceflowAgentTesterConfig struct {
-	EnvironmentName string `yaml:"environmentName" json:"environmentName"`
-	APIKey          string `yaml:"apiKey" json:"apiKey"`
+	EnvironmentName string                 `yaml:"environmentName" json:"environmentName"`
+	APIKey          string                 `yaml:"apiKey" json:"apiKey"`
+	Variables       map[string]interface{} `yaml:"variables,omitempty" json:"variables,omitempty"`
 }
 
 // UserInfo represents information that the agent can use when requested
diff --git a/pkg/test/voiceflow-agent-runner.go b/pkg/test/voiceflow-agent-runner.go
@@ -6,6 +6,7 @@ import (
 	"github.com/xavidop/voiceflow-cli/internal/global"
 	"github.com/xavidop/voiceflow-cli/internal/types/tests"
 	"github.com/xavidop/voiceflow-cli/internal/types/voiceflow/interact"
+	"github.com/xavidop/voiceflow-cli/pkg/voiceflow"
 )
 
 // VoiceflowAgentTestRunner handles the execution of agent-to-agent tests using a Voiceflow agent as the tester
@@ -64,6 +65,22 @@ func (vatr *VoiceflowAgentTestRunner) ExecuteAgentTest(agentTest tests.AgentTest
 		return fmt.Errorf("failed to launch conversation with tester agent: %w", err)
 	}
 
+	// Update tester agent variables if provided
+	if len(agentTest.VoiceflowAgentTesterConfig.Variables) > 0 {
+		vatr.addLog(fmt.Sprintf("Setting %d variables in tester agent", len(agentTest.VoiceflowAgentTesterConfig.Variables)))
+		err = voiceflow.UpdateStateVariables(
+			vatr.testerEnvironmentName,
+			vatr.testerUserID,
+			agentTest.VoiceflowAgentTesterConfig.Variables,
+			vatr.testerAPIKey,
+			vatr.subdomainOverride,
+		)
+		if err != nil {
+			return fmt.Errorf("failed to update tester agent variables: %w", err)
+		}
+		vatr.addLog("Successfully updated tester agent variables")
+	}
+
 	// Launch the conversation with the target agent if newSessionPerTest is enabled
 	if newSessionPerTest {
 		vatr.addLog("Launching conversation with target Voiceflow agent (new session per test enabled)")
diff --git a/pkg/voiceflow/state.go b/pkg/voiceflow/state.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"strings"
 
 	"github.com/xavidop/voiceflow-cli/internal/global"
 	"github.com/xavidop/voiceflow-cli/internal/types/voiceflow/state"
@@ -65,3 +66,56 @@ func FetchStateWithOverrides(EnvironmentName, userID, apiKeyOverride, subdomainO
 
 	return stateResponse, nil
 }
+
+// UpdateStateVariables updates the variables in the user's state by merging with the provided properties
+func UpdateStateVariables(environmentName, userID string, variables map[string]interface{}, apiKeyOverride, subdomainOverride string) error {
+	// Use the provided subdomain override, or fall back to global if not provided
+	subdomain := global.VoiceflowSubdomain
+	if subdomainOverride != "" {
+		subdomain = subdomainOverride
+	}
+
+	// Add the dot prefix if subdomain is not empty
+	if subdomain != "" {
+		subdomain = "." + subdomain
+	}
+
+	url := fmt.Sprintf("https://general-runtime%s.voiceflow.com/state/user/%s/variables", subdomain, userID)
+
+	// Marshal variables to JSON
+	variablesJSON, err := json.Marshal(variables)
+	if err != nil {
+		return fmt.Errorf("error marshalling variables: %v", err)
+	}
+
+	payload := strings.NewReader(string(variablesJSON))
+
+	req, err := http.NewRequest("PATCH", url, payload)
+	if err != nil {
+		return fmt.Errorf("error creating request: %v", err)
+	}
+
+	req.Header.Add("accept", "application/json")
+	req.Header.Add("content-type", "application/json")
+
+	// Use the provided API key override, or fall back to global if not provided
+	apiKey := global.VoiceflowAPIKey
+	if apiKeyOverride != "" {
+		apiKey = apiKeyOverride
+	}
+	req.Header.Add("Authorization", apiKey)
+	req.Header.Add("versionID", environmentName)
+
+	res, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return fmt.Errorf("error calling API: %v", err)
+	}
+	defer utils.SafeClose(res.Body)
+
+	if res.StatusCode != http.StatusOK {
+		body, _ := io.ReadAll(res.Body)
+		return fmt.Errorf("error updating variables: status %d, body: %s", res.StatusCode, string(body))
+	}
+
+	return nil
+}
diff --git a/server/docs/docs.go b/server/docs/docs.go
@@ -523,6 +523,10 @@ const docTemplate = `{
                 },
                 "environmentName": {
                     "type": "string"
+                },
+                "variables": {
+                    "type": "object",
+                    "additionalProperties": true
                 }
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -517,6 +517,10 @@`
`517`	`517`	`},`
`518`	`518`	`"environmentName": {`
`519`	`519`	`"type": "string"`
	`520`	`+ },`
	`521`	`+ "variables": {`
	`522`	`+ "type": "object",`
	`523`	`+ "additionalProperties": true`
`520`	`524`	`}`
`521`	`525`	`}`
`522`	`526`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ go 1.24.0`
`4`	`4`
`5`	`5`	`require (`
`6`	`6`	`github.com/pkg/errors v0.9.1`
`7`		`- github.com/sirupsen/logrus v1.9.3`
	`7`	`+ github.com/sirupsen/logrus v1.9.4`
`8`	`8`	`github.com/spf13/cobra v1.10.2`
`9`	`9`	`)`
`10`	`10`