test_battle_wait.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453
  1. import pytest
  2. from tasks.Component.GeneralBattle.battle_wait import (
  3. BattleWait,
  4. BattleWaitPlan,
  5. HookSignal,
  6. runtime,
  7. battle_wait_options,
  8. battle_wait_strategy,
  9. _DEFAULT_PER_BATTLE,
  10. )
  11. @pytest.fixture(autouse=True)
  12. def reset_battle_wait_plan(monkeypatch):
  13. monkeypatch.setattr(battle_wait_strategy, 'battle_wait_plan', None)
  14. monkeypatch.setattr(battle_wait_options, 'options', None)
  15. runtime.task_owner = None
  16. runtime.pub_ctx = None
  17. runtime.pri_ctx = {}
  18. def test_default_plan_contains_default_hooks_and_sequence():
  19. plan = BattleWaitPlan()
  20. assert tuple(getattr(plan, hook) for hook in BattleWaitPlan.HOOKS_DEFAULT) == (
  21. 'default',
  22. 'default',
  23. 'default',
  24. 'default',
  25. 'default',
  26. 'default',
  27. )
  28. assert plan.sequence == 'completion>interrupt>success>failure>idle'
  29. assert plan.function_setup_name == '_bw_setup_default'
  30. def test_decorator_passes_its_plan_to_the_wrapped_function():
  31. strategy = battle_wait_strategy('reserve_default', 'idle_default', failure='custom')
  32. @strategy
  33. def battle_wait(owner, *, battle_wait_plan, options=None):
  34. return battle_wait_plan
  35. plan = battle_wait(object())
  36. assert plan.reserve == 'default'
  37. assert plan.idle == 'default'
  38. assert plan.failure == 'custom'
  39. def test_with_context_uses_a_temporary_plan_and_restores_the_default_plan():
  40. strategy = battle_wait_strategy('success_default')
  41. @strategy
  42. def battle_wait(owner, *, battle_wait_plan, options=None):
  43. return battle_wait_plan
  44. default_plan = battle_wait_strategy.battle_wait_plan
  45. with battle_wait_strategy('success_default', failure='custom'):
  46. temporary_plan = battle_wait(object())
  47. assert temporary_plan.failure == 'custom'
  48. assert battle_wait_strategy.battle_wait_plan is default_plan
  49. assert battle_wait(object()) is default_plan
  50. def test_event_and_strategy_can_be_configured_with_both_supported_forms():
  51. plan = BattleWaitPlan('yyy_default', abcd='edf')
  52. assert plan.yyy == 'default'
  53. assert plan.abcd == 'edf'
  54. assert plan.sequence_function_names()[4:6] == [
  55. '_bw_yyy_default',
  56. '_bw_abcd_edf',
  57. ]
  58. def test_an_event_cannot_be_configured_with_two_strategies():
  59. with pytest.raises(ValueError, match="configured more than once"):
  60. BattleWaitPlan('success_default', success='custom')
  61. @pytest.mark.xfail(reason='battle_wait_with_strategy 尚未迁移到 runtime (runtime.current 已移除)', strict=False)
  62. def test_setup_runs_before_the_wait_loop():
  63. class OrderedBattleWait(BattleWait):
  64. def __init__(self):
  65. self.events = []
  66. def screenshot(self):
  67. self.events.append('screenshot')
  68. def _bw_setup_record(self, pub, pri):
  69. self.events.append('setup')
  70. return HookSignal.DONE
  71. def _bw_completion_finish(self, pub, pri):
  72. self.events.append('completion')
  73. pub.success = True
  74. return HookSignal.DONE
  75. battle_wait = OrderedBattleWait()
  76. plan = BattleWaitPlan('setup_record', 'completion_finish')
  77. assert battle_wait.battle_wait_with_strategy(battle_wait_plan=plan) is True
  78. assert battle_wait.events == ['setup', 'screenshot', 'completion']
  79. @pytest.mark.xfail(reason='battle_wait_with_strategy 尚未迁移到 runtime (runtime.current 已移除)', strict=False)
  80. def test_custom_hook_is_resolved_and_executed_in_the_configured_sequence():
  81. class CustomBattleWait(BattleWait):
  82. def __init__(self):
  83. self.events = []
  84. def screenshot(self):
  85. pass
  86. def _bw_setup_record(self, pub, pri):
  87. self.events.append('setup')
  88. return HookSignal.DONE
  89. def _bw_yyy_record(self, pub, pri):
  90. self.events.append('yyy')
  91. return HookSignal.CONTINUE
  92. def _bw_completion_finish(self, pub, pri):
  93. self.events.append('completion')
  94. pub.success = True
  95. return HookSignal.DONE
  96. battle_wait = CustomBattleWait()
  97. plan = BattleWaitPlan(
  98. 'setup_record',
  99. 'yyy_record',
  100. 'completion_finish',
  101. sequence='yyy > completion > interrupt > success > failure > idle',
  102. )
  103. assert battle_wait.battle_wait_with_strategy(battle_wait_plan=plan) is True
  104. assert battle_wait.events == ['setup', 'yyy', 'completion']
  105. def test_custom_sequence_controls_hook_order():
  106. plan = BattleWaitPlan(
  107. 'yyy_default',
  108. sequence='failure > yyy > completion > interrupt > success > idle',
  109. )
  110. assert plan.sequence_function_names() == [
  111. '_bw_failure_default',
  112. '_bw_yyy_default',
  113. '_bw_completion_default',
  114. '_bw_interrupt_default',
  115. '_bw_success_default',
  116. '_bw_idle_default',
  117. ]
  118. def test_custom_events_without_sequence_are_inserted_before_idle_in_argument_order():
  119. plan = BattleWaitPlan('yyy_default', 'abcd_edf')
  120. assert plan.sequence == 'completion>interrupt>success>failure>yyy>abcd>idle'
  121. def test_dynamic_override_does_not_modify_the_default_plan():
  122. strategy = battle_wait_strategy('success_default')
  123. @strategy
  124. def battle_wait(owner, *, battle_wait_plan, options=None):
  125. return battle_wait_plan
  126. default_plan = battle_wait_strategy.battle_wait_plan
  127. overridden_plan = battle_wait(object(), random_click_swipt_enable=True)
  128. assert overridden_plan is not default_plan
  129. assert overridden_plan.randomclick == 'default'
  130. assert not hasattr(default_plan, 'randomclick')
  131. assert battle_wait_strategy.battle_wait_plan is default_plan
  132. def test_dynamic_override_is_only_valid_for_the_current_call():
  133. strategy = battle_wait_strategy('success_default')
  134. @strategy
  135. def battle_wait(owner, *, battle_wait_plan, options=None):
  136. return battle_wait_plan
  137. battle_wait(object(), random_click_swipt_enable=True)
  138. plan_without_override = battle_wait(object(), random_click_swipt_enable=False)
  139. assert not hasattr(plan_without_override, 'randomclick')
  140. # options 与 plan 同语义: 装饰器覆盖全局, with 临时覆盖并在退出时还原。
  141. # 本测试锁定新拆分 API —— 策略装饰器只注入 plan, options 由 battle_wait_options
  142. # 各自负责(装饰器=整份覆盖并跨调用还原, with=进入时 merge、退出还原)。
  143. @pytest.mark.xfail(reason='battle_wait_with_strategy 尚未迁移到 runtime (runtime.current 已移除)', strict=False)
  144. def test_options_decorator_and_with_are_scoped_to_the_current_call():
  145. received = []
  146. decorator_options = {
  147. 'completion': {'source': 'decorator'},
  148. 'success': {'excludes': ['C_REWARD_1']},
  149. }
  150. context_options = {
  151. 'success': {'excludes': ['C_END_MESSAGE_RIGHT_TOP']},
  152. }
  153. strategy = battle_wait_strategy('setup_record', 'completion_record')
  154. class OptionBattleWait(BattleWait):
  155. def screenshot(self):
  156. pass
  157. def _bw_setup_record(self, pub, pri):
  158. return HookSignal.DONE
  159. def _bw_completion_record(self, pub, pri):
  160. received.append(pub.options)
  161. pub.success = True
  162. return HookSignal.DONE
  163. @strategy
  164. def battle_wait_plain(self, *args, **kwargs):
  165. return self.battle_wait_with_strategy(*args, **kwargs)
  166. battle_wait = object.__new__(OptionBattleWait)
  167. # ---- 场景 1: 装饰器 = 整份覆盖全局 ----
  168. opts_decorator = battle_wait_options(**decorator_options)
  169. class Decorated(OptionBattleWait):
  170. @opts_decorator
  171. @strategy
  172. def battle_wait(self, *args, **kwargs):
  173. return self.battle_wait_with_strategy(*args, **kwargs)
  174. decorated = object.__new__(Decorated)
  175. assert decorated.battle_wait() is True
  176. assert received[-1] == decorator_options
  177. # 跨调用还原: 槽位回到调用前的状态, 不残留到别处
  178. assert battle_wait_options.options is None
  179. # ---- 场景 2: with = 临时覆盖, 进入时与当前槽位 merge, 退出还原 ----
  180. with battle_wait_options(**context_options):
  181. assert battle_wait_options.options == context_options
  182. # 未装饰 options 的入口直接读当前槽位
  183. assert battle_wait.battle_wait_plain() is True
  184. assert received[-1] == context_options
  185. # 退出 with 后还原(需要 __exit__ 还原)
  186. assert battle_wait_options.options is None
  187. assert battle_wait.battle_wait_plain() is True
  188. assert received[-1] is None
  189. # 跨任务(两个任务各自独立声明策略+options)场景。复现 script.py 的调度时序:
  190. # 每个任务运行前用 load_module 重新执行自己的 script_task.py, 即"装饰器在任务
  191. # 运行时才生效, 后加载的任务覆盖前者"。
  192. # 契约: battle_wait_plan 与 options 都是全局槽位, 后加载装饰器整份覆盖;
  193. # 正在运行的任务拿到的正是自己模块装饰器声明的配置。
  194. def test_cross_task_decorators_switch_plan_and_keep_own_options():
  195. # 任务 A 的装饰器: 默认 success hook + 自己的 options
  196. strategy_a = battle_wait_strategy('success_default')
  197. opts_a = battle_wait_options(success={'market': 'task_a'})
  198. @opts_a
  199. @strategy_a
  200. def battle_wait_a(owner, *, battle_wait_plan, options=None):
  201. # 被装饰后 wrapper 会注入当前生效的 battle_wait_plan / options
  202. return battle_wait_plan, options
  203. # 任务 A 运行: 生效的应是它自己的 plan 和 options
  204. plan_a, options_a = battle_wait_a(object())
  205. assert options_a['success']['market'] == 'task_a'
  206. # A 装饰(模块加载)后, 全局生效 plan 是 A 的
  207. assert battle_wait_strategy.battle_wait_plan is plan_a
  208. # 任务 B 后加载并装饰: 不同 success hook + 不同的 options
  209. strategy_b = battle_wait_strategy(success='activity')
  210. opts_b = battle_wait_options(success={'market': 'task_b'})
  211. @opts_b
  212. @strategy_b
  213. def battle_wait_b(owner, *, battle_wait_plan, options=None):
  214. return battle_wait_plan, options
  215. # 核心断言: B 装饰(加载)后, 全局生效 plan 切成 B 自己的
  216. assert battle_wait_strategy.battle_wait_plan is not plan_a
  217. plan_b, options_b = battle_wait_b(object())
  218. assert plan_b.success == 'activity'
  219. assert battle_wait_strategy.battle_wait_plan is plan_b
  220. assert options_b['success']['market'] == 'task_b'
  221. assert options_b['success'] == {'market': 'task_b'}
  222. # 未声明 options 的任务不应继承上一个任务的 options —— 后加载者覆盖后,
  223. # 使用自己 options 装饰器的任务只拿自己声明的; 无 options 声明则回 None,
  224. # 避免任务链里的 options 漂移。
  225. def test_cross_task_options_do_not_leak_between_tasks():
  226. # 任务 A: 声明 options → 覆盖全局
  227. strategy_a = battle_wait_strategy('success_default')
  228. opts_a = battle_wait_options(success={'market': 'task_a'})
  229. @opts_a
  230. @strategy_a
  231. def battle_wait_a(owner, *, battle_wait_plan, options=None):
  232. return battle_wait_plan, options
  233. _, options_a = battle_wait_a(object())
  234. assert options_a['success']['market'] == 'task_a'
  235. # 任务 B: 声明自己的 options → 不残留 A 的任何键
  236. strategy_b = battle_wait_strategy(success='activity')
  237. opts_b = battle_wait_options(success={'market': 'task_b'})
  238. @opts_b
  239. @strategy_b
  240. def battle_wait_b(owner, *, battle_wait_plan, options=None):
  241. return battle_wait_plan, options
  242. plan_b, options_b = battle_wait_b(object())
  243. assert plan_b.success == 'activity'
  244. assert options_b['success'] == {'market': 'task_b'}
  245. # ------------------------------------------------------------------------------------------------------------------
  246. # runtime: 自动装饰 hook, 注入单例 pub_ctx / 每 hook 的 pri_ctx, 三档状态 + options 分发。
  247. # ------------------------------------------------------------------------------------------------------------------
  248. def _make_runtime_probe():
  249. class RuntimeProbe(BattleWait):
  250. def __init__(self):
  251. self.calls = []
  252. def _bw_setup_probe(self, pub, pri):
  253. self.calls.append(('setup', pub, pri))
  254. return HookSignal.DONE
  255. def _bw_completion_probe(self, pub, pri):
  256. self.calls.append(('completion', pub, pri))
  257. return HookSignal.DONE
  258. def _bw_success_probe(self, pub, pri):
  259. self.calls.append(('success', pub, pri))
  260. return HookSignal.DONE
  261. return RuntimeProbe()
  262. def test_runtime_injects_singleton_pub_and_per_hook_pri():
  263. battle_wait = _make_runtime_probe()
  264. getattr(battle_wait, '_bw_setup_probe')()
  265. getattr(battle_wait, '_bw_completion_probe')()
  266. _, setup_pub, setup_pri = battle_wait.calls[0]
  267. _, completion_pub, completion_pri = battle_wait.calls[1]
  268. # 所有 hook 共享同一个 pub_ctx
  269. assert setup_pub is runtime.pub_ctx
  270. assert completion_pub is runtime.pub_ctx
  271. # 每个 hook 持有自己的 pri_ctx, 互不共享
  272. assert setup_pri is runtime.pri_ctx['_bw_setup_probe']
  273. assert completion_pri is runtime.pri_ctx['_bw_completion_probe']
  274. assert setup_pri is not completion_pri
  275. def test_runtime_preserves_function_name_for_completion_detection():
  276. battle_wait = _make_runtime_probe()
  277. hook = getattr(battle_wait, '_bw_completion_probe')
  278. assert hook.__name__ == '_bw_completion_probe'
  279. def test_runtime_task_owner_switch_resets_per_task():
  280. battle_wait = _make_runtime_probe()
  281. getattr(battle_wait, '_bw_setup_probe')()
  282. runtime.pub_ctx.cross['keep'] = 1
  283. runtime.pub_ctx.per_task['drop'] = 1
  284. runtime.pri_ctx['_bw_setup_probe'].per_task['drop'] = 1
  285. # 换一个 owner 触发 reset_per_task: cross 保留, per_task 清空
  286. other = _make_runtime_probe()
  287. getattr(other, '_bw_setup_probe')()
  288. assert runtime.pub_ctx.cross == {'keep': 1}
  289. assert runtime.pub_ctx.per_task == {}
  290. assert runtime.pri_ctx['_bw_setup_probe'].per_task == {}
  291. def test_runtime_reset_per_battle_keeps_cross_and_per_task():
  292. battle_wait = _make_runtime_probe()
  293. getattr(battle_wait, '_bw_setup_probe')()
  294. runtime.pub_ctx.cross['c'] = 1
  295. runtime.pub_ctx.per_task['t'] = 1
  296. runtime.pub_ctx.per_battle['b'] = 1
  297. runtime.pri_ctx['_bw_setup_probe'].per_battle['b'] = 1
  298. runtime.reset_per_battle()
  299. assert runtime.pub_ctx.cross == {'c': 1}
  300. assert runtime.pub_ctx.per_task == {'t': 1}
  301. assert runtime.pub_ctx.per_battle == _DEFAULT_PER_BATTLE()
  302. assert 'b' not in runtime.pub_ctx.per_battle
  303. assert runtime.pri_ctx['_bw_setup_probe'].per_battle == {}
  304. def test_runtime_update_options_distributes_by_hook_event_name():
  305. battle_wait = _make_runtime_probe()
  306. getattr(battle_wait, '_bw_setup_probe')()
  307. getattr(battle_wait, '_bw_completion_probe')()
  308. getattr(battle_wait, '_bw_success_probe')()
  309. runtime.update_options({
  310. 'setup': {'x': 1},
  311. 'completion': {'y': 2},
  312. 'success': {'z': 3},
  313. })
  314. # pub 拿整份 options
  315. assert runtime.pub_ctx.options['setup'] == {'x': 1}
  316. # 每个 hook 的 pri 只拿自己事件名对应的 slice
  317. assert runtime.pri_ctx['_bw_setup_probe'].options == {'x': 1}
  318. assert runtime.pri_ctx['_bw_completion_probe'].options == {'y': 2}
  319. assert runtime.pri_ctx['_bw_success_probe'].options == {'z': 3}
  320. def test_runtime_update_options_none_clears_all_slices():
  321. battle_wait = _make_runtime_probe()
  322. getattr(battle_wait, '_bw_setup_probe')()
  323. runtime.update_options({'setup': {'x': 1}})
  324. assert runtime.pub_ctx.options['setup'] == {'x': 1}
  325. runtime.update_options(None)
  326. assert runtime.pub_ctx.options == {}
  327. assert runtime.pri_ctx['_bw_setup_probe'].options == {}
  328. def test_runtime_str_shows_hook_name_and_scope_keys():
  329. battle_wait = _make_runtime_probe()
  330. getattr(battle_wait, '_bw_setup_probe')()
  331. runtime.pub_ctx.per_task['stage'] = 1
  332. runtime.pri_ctx['_bw_setup_probe'].per_battle['clicked'] = True
  333. runtime.update_options({'setup': {'x': 1}})
  334. text = str(battle_wait.__class__._bw_setup_probe)
  335. assert '_bw_setup_probe' in text
  336. assert 'stage' in text
  337. assert 'clicked' in text
  338. assert 'setup' in text