|
| 1 | +""" |
| 2 | +Acceptance tests for holdouts functionality in /v1/decide endpoint. |
| 3 | +
|
| 4 | +These tests verify that Agent correctly handles holdout decisions through go-sdk v2.3.0+. |
| 5 | +Holdouts are evaluated internally by go-sdk and reflected in the ruleKey field. |
| 6 | +""" |
| 7 | +import json |
| 8 | +import pytest |
| 9 | + |
| 10 | +from tests.acceptance.helpers import ENDPOINT_DECIDE |
| 11 | +from tests.acceptance.helpers import create_and_validate_request_and_response |
| 12 | + |
| 13 | + |
| 14 | +@pytest.fixture(scope='function') |
| 15 | +def holdouts_session(session_obj): |
| 16 | + """ |
| 17 | + Create a session using the holdouts datafile. |
| 18 | + This SDK key points to a project with holdouts configured. |
| 19 | + """ |
| 20 | + # SDK key from holdouts_datafile.py |
| 21 | + session_obj.headers['X-Optimizely-SDK-Key'] = 'BLsSFScP7tSY5SCYuKn8c' |
| 22 | + return session_obj |
| 23 | + |
| 24 | + |
| 25 | +def test_decide_user_in_holdout(holdouts_session): |
| 26 | + """ |
| 27 | + Test that a user who qualifies for a holdout gets bucketed into it. |
| 28 | +
|
| 29 | + Expected behavior: |
| 30 | + - ruleKey should match the holdout key |
| 31 | + - enabled should be False |
| 32 | + - variationKey should be "off" |
| 33 | + """ |
| 34 | + request_body = json.dumps({ |
| 35 | + "userId": "test_user_holdout", |
| 36 | + "userAttributes": { |
| 37 | + "ho": 3, # Qualifies for holdout_3 |
| 38 | + "all": 2 # Satisfies the "all <= 3" condition |
| 39 | + } |
| 40 | + }) |
| 41 | + |
| 42 | + resp = create_and_validate_request_and_response( |
| 43 | + ENDPOINT_DECIDE, |
| 44 | + 'post', |
| 45 | + holdouts_session, |
| 46 | + params={'keys': 'flag1'}, |
| 47 | + payload=request_body |
| 48 | + ) |
| 49 | + |
| 50 | + assert resp.status_code == 200, f"Expected 200, got {resp.status_code}: {resp.text}" |
| 51 | + |
| 52 | + decision = resp.json() |
| 53 | + |
| 54 | + # Verify holdout decision structure |
| 55 | + assert decision['flagKey'] == 'flag1', f"Expected flagKey 'flag1', got {decision.get('flagKey')}" |
| 56 | + assert 'ruleKey' in decision, "Decision should have ruleKey field" |
| 57 | + assert 'enabled' in decision, "Decision should have enabled field" |
| 58 | + assert 'variationKey' in decision, "Decision should have variationKey field" |
| 59 | + |
| 60 | + # Log the actual decision for debugging |
| 61 | + print(f"\nDecision response: {json.dumps(decision, indent=2)}") |
| 62 | + |
| 63 | + # Check if user was bucketed into a holdout (ruleKey contains 'holdout') |
| 64 | + if 'holdout' in decision['ruleKey']: |
| 65 | + assert decision['enabled'] == False, "Holdout decisions should have enabled=False" |
| 66 | + assert decision['variationKey'] == 'off', "Holdout decisions should have variationKey='off'" |
| 67 | + print(f"✓ User successfully bucketed into holdout: {decision['ruleKey']}") |
| 68 | + else: |
| 69 | + print(f"✓ User got normal decision with rule: {decision['ruleKey']}") |
| 70 | + |
| 71 | + |
| 72 | +def test_decide_user_not_in_holdout_audience(holdouts_session): |
| 73 | + """ |
| 74 | + Test that a user who doesn't qualify for any holdout audience |
| 75 | + gets normal decision (experiment or rollout). |
| 76 | +
|
| 77 | + Expected behavior: |
| 78 | + - User should get normal flag evaluation |
| 79 | + - ruleKey should NOT contain 'holdout' |
| 80 | + """ |
| 81 | + request_body = json.dumps({ |
| 82 | + "userId": "test_user_no_holdout", |
| 83 | + "userAttributes": { |
| 84 | + "ho": 999, # Doesn't match any holdout audience |
| 85 | + "all": 999 # Doesn't satisfy any holdout condition |
| 86 | + } |
| 87 | + }) |
| 88 | + |
| 89 | + resp = create_and_validate_request_and_response( |
| 90 | + ENDPOINT_DECIDE, |
| 91 | + 'post', |
| 92 | + holdouts_session, |
| 93 | + params={'keys': 'flag1'}, |
| 94 | + payload=request_body |
| 95 | + ) |
| 96 | + |
| 97 | + assert resp.status_code == 200 |
| 98 | + decision = resp.json() |
| 99 | + |
| 100 | + print(f"\nDecision response: {json.dumps(decision, indent=2)}") |
| 101 | + |
| 102 | + # User should NOT be in holdout |
| 103 | + assert 'ruleKey' in decision, "Decision should have ruleKey" |
| 104 | + |
| 105 | + # Verify it's not a holdout decision |
| 106 | + is_holdout = 'holdout' in decision['ruleKey'].lower() |
| 107 | + print(f"✓ User correctly bypassed holdouts, got rule: {decision['ruleKey']} (is_holdout={is_holdout})") |
| 108 | + |
| 109 | + |
| 110 | +def test_decide_multiple_flags_with_holdouts(holdouts_session): |
| 111 | + """ |
| 112 | + Test DecideAll with multiple flags when holdouts are present. |
| 113 | +
|
| 114 | + Expected behavior: |
| 115 | + - Should return decisions for all flags |
| 116 | + - Some may be holdout decisions, others may be regular decisions |
| 117 | + - Each decision should have proper structure |
| 118 | + """ |
| 119 | + request_body = json.dumps({ |
| 120 | + "userId": "test_user_multi", |
| 121 | + "userAttributes": { |
| 122 | + "ho": 4, # Might qualify for holdout_4 |
| 123 | + "all": 3 |
| 124 | + } |
| 125 | + }) |
| 126 | + |
| 127 | + # Call without keys to get all flags |
| 128 | + resp = create_and_validate_request_and_response( |
| 129 | + ENDPOINT_DECIDE, |
| 130 | + 'post', |
| 131 | + holdouts_session, |
| 132 | + payload=request_body |
| 133 | + ) |
| 134 | + |
| 135 | + assert resp.status_code == 200 |
| 136 | + decisions = resp.json() |
| 137 | + |
| 138 | + assert isinstance(decisions, list), "DecideAll should return array of decisions" |
| 139 | + assert len(decisions) > 0, "Should have at least one decision" |
| 140 | + |
| 141 | + print(f"\nReceived {len(decisions)} decisions:") |
| 142 | + |
| 143 | + holdout_count = 0 |
| 144 | + for decision in decisions: |
| 145 | + assert 'flagKey' in decision |
| 146 | + assert 'ruleKey' in decision |
| 147 | + assert 'enabled' in decision |
| 148 | + assert 'variationKey' in decision |
| 149 | + |
| 150 | + is_holdout = 'holdout' in decision['ruleKey'].lower() |
| 151 | + print(f" - {decision['flagKey']}: rule={decision['ruleKey']}, enabled={decision['enabled']}") |
| 152 | + |
| 153 | + if is_holdout: |
| 154 | + holdout_count += 1 |
| 155 | + assert decision['enabled'] == False |
| 156 | + assert decision['variationKey'] == 'off' |
| 157 | + |
| 158 | + print(f"✓ Got {holdout_count} holdout decisions out of {len(decisions)} total decisions") |
| 159 | + |
| 160 | + |
| 161 | +def test_decide_holdout_with_forced_decision(holdouts_session): |
| 162 | + """ |
| 163 | + Test that forced decisions override holdout bucketing. |
| 164 | +
|
| 165 | + Expected behavior: |
| 166 | + - Forced decision should take precedence over holdout |
| 167 | + """ |
| 168 | + request_body = json.dumps({ |
| 169 | + "userId": "test_user_forced", |
| 170 | + "userAttributes": { |
| 171 | + "ho": 3, # Would normally qualify for holdout |
| 172 | + "all": 2 |
| 173 | + }, |
| 174 | + "forcedDecisions": [ |
| 175 | + { |
| 176 | + "flagKey": "flag1", |
| 177 | + "variationKey": "variation_1" |
| 178 | + } |
| 179 | + ] |
| 180 | + }) |
| 181 | + |
| 182 | + resp = create_and_validate_request_and_response( |
| 183 | + ENDPOINT_DECIDE, |
| 184 | + 'post', |
| 185 | + holdouts_session, |
| 186 | + params={'keys': 'flag1'}, |
| 187 | + payload=request_body |
| 188 | + ) |
| 189 | + |
| 190 | + assert resp.status_code == 200 |
| 191 | + decision = resp.json() |
| 192 | + |
| 193 | + print(f"\nDecision response: {json.dumps(decision, indent=2)}") |
| 194 | + |
| 195 | + # Forced decision should override holdout |
| 196 | + assert decision['variationKey'] == 'variation_1', "Forced decision should be respected" |
| 197 | + assert decision['enabled'] == True, "Forced decision should enable the flag" |
| 198 | + |
| 199 | + # Note: Agent's /v1/decide doesn't return detailed reasons |
| 200 | + # The presence of the forced variation proves it worked |
| 201 | + print("✓ Forced decision correctly overrode holdout bucketing") |
| 202 | + |
| 203 | + |
| 204 | +def test_decide_holdout_decision_reasons(holdouts_session): |
| 205 | + """ |
| 206 | + Test that holdout decisions include proper reasons. |
| 207 | +
|
| 208 | + Expected behavior: |
| 209 | + - reasons array should explain the decision |
| 210 | + """ |
| 211 | + request_body = json.dumps({ |
| 212 | + "userId": "test_user_reasons", |
| 213 | + "userAttributes": { |
| 214 | + "ho": 5, # Qualifies for holdout_5 |
| 215 | + "all": 4 |
| 216 | + } |
| 217 | + }) |
| 218 | + |
| 219 | + resp = create_and_validate_request_and_response( |
| 220 | + ENDPOINT_DECIDE, |
| 221 | + 'post', |
| 222 | + holdouts_session, |
| 223 | + params={'keys': 'flag1'}, |
| 224 | + payload=request_body |
| 225 | + ) |
| 226 | + |
| 227 | + assert resp.status_code == 200 |
| 228 | + decision = resp.json() |
| 229 | + |
| 230 | + assert 'reasons' in decision, "Decision should include reasons" |
| 231 | + assert isinstance(decision['reasons'], list), "Reasons should be an array" |
| 232 | + |
| 233 | + # Note: Agent's /v1/decide returns empty reasons array |
| 234 | + # The ruleKey and decision structure are what matter |
| 235 | + print(f"\nDecision reasons: {decision['reasons']}") |
| 236 | + print(f"Rule key: {decision['ruleKey']}") |
| 237 | + |
| 238 | + # Verify decision structure is correct |
| 239 | + is_holdout = 'holdout' in decision['ruleKey'].lower() |
| 240 | + if is_holdout: |
| 241 | + print(f"✓ Holdout decision structure is correct (rule: {decision['ruleKey']})") |
| 242 | + else: |
| 243 | + print(f"✓ Non-holdout decision structure is correct") |
| 244 | + |
| 245 | + |
| 246 | +def test_decide_holdout_impression_event(holdouts_session): |
| 247 | + """ |
| 248 | + Test that holdout decisions have all necessary fields for impression tracking. |
| 249 | +
|
| 250 | + Expected behavior: |
| 251 | + - Decision should have all necessary fields for impression tracking |
| 252 | + - ruleKey, variationKey, enabled should be present |
| 253 | + """ |
| 254 | + request_body = json.dumps({ |
| 255 | + "userId": "test_user_impression", |
| 256 | + "userAttributes": { |
| 257 | + "ho": 6, # Qualifies for holdout_6 |
| 258 | + "all": 5 |
| 259 | + } |
| 260 | + }) |
| 261 | + |
| 262 | + resp = create_and_validate_request_and_response( |
| 263 | + ENDPOINT_DECIDE, |
| 264 | + 'post', |
| 265 | + holdouts_session, |
| 266 | + params={'keys': 'flag1'}, |
| 267 | + payload=request_body |
| 268 | + ) |
| 269 | + |
| 270 | + assert resp.status_code == 200 |
| 271 | + decision = resp.json() |
| 272 | + |
| 273 | + # Verify decision has all fields needed for impression event |
| 274 | + required_fields = ['flagKey', 'variationKey', 'ruleKey', 'enabled', 'userContext'] |
| 275 | + for field in required_fields: |
| 276 | + assert field in decision, f"Decision missing required field: {field}" |
| 277 | + |
| 278 | + # Verify userContext is complete |
| 279 | + assert decision['userContext']['userId'] == 'test_user_impression' |
| 280 | + assert 'attributes' in decision['userContext'] |
| 281 | + |
| 282 | + print(f"\n✓ Decision has all fields needed for impression tracking:") |
| 283 | + print(f" - flagKey: {decision['flagKey']}") |
| 284 | + print(f" - ruleKey: {decision['ruleKey']}") |
| 285 | + print(f" - variationKey: {decision['variationKey']}") |
| 286 | + print(f" - enabled: {decision['enabled']}") |
| 287 | + |
| 288 | + |
| 289 | +def test_decide_flag2_with_holdouts(holdouts_session): |
| 290 | + """ |
| 291 | + Test decision for flag2 which also has holdouts configured. |
| 292 | +
|
| 293 | + Expected behavior: |
| 294 | + - User matching holdout criteria should get holdout decision |
| 295 | + - Decision should have correct structure |
| 296 | + """ |
| 297 | + request_body = json.dumps({ |
| 298 | + "userId": "test_user_flag2", |
| 299 | + "userAttributes": { |
| 300 | + "ho": 3, |
| 301 | + "all": 2 |
| 302 | + } |
| 303 | + }) |
| 304 | + |
| 305 | + resp = create_and_validate_request_and_response( |
| 306 | + ENDPOINT_DECIDE, |
| 307 | + 'post', |
| 308 | + holdouts_session, |
| 309 | + params={'keys': 'flag2'}, |
| 310 | + payload=request_body |
| 311 | + ) |
| 312 | + |
| 313 | + assert resp.status_code == 200 |
| 314 | + decision = resp.json() |
| 315 | + |
| 316 | + print(f"\nDecision for flag2: {json.dumps(decision, indent=2)}") |
| 317 | + |
| 318 | + assert decision['flagKey'] == 'flag2' |
| 319 | + assert 'ruleKey' in decision |
| 320 | + assert 'enabled' in decision |
| 321 | + assert 'variationKey' in decision |
| 322 | + |
| 323 | + # Check if holdout decision |
| 324 | + is_holdout = 'holdout' in decision['ruleKey'].lower() |
| 325 | + if is_holdout: |
| 326 | + print(f"✓ Flag2 holdout decision: {decision['ruleKey']}") |
| 327 | + else: |
| 328 | + print(f"✓ Flag2 normal decision: {decision['ruleKey']}") |
0 commit comments