Add custom event send function support to check_memorial

Author: harakka

tests/memorial_test.cpp

@@ -15,6 +15,7 @@
 #include "event.h"
 #include "event_bus.h"
 #include "filesystem.h"
+#include "map_helpers.h"
 #include "memorial_logger.h"
 #include "mutation.h"
 #include "player_helpers.h"
@@ -33,13 +34,18 @@ static const spell_id spell_pain_damage( "pain_damage" );
 
 static const trap_str_id tr_pit( "tr_pit" );
 
-template<event_type Type, typename... Args>
-void check_memorial( memorial_logger &m, event_bus &b, const std::string &ref, Args... args )
+// Requires a custom sender for eg. using event types that need to be sent differently for EOCS to work
+template<event_type Type, typename Sender>
+void check_memorial_custom_sender(
+    memorial_logger &m,
+    const std::string &ref,
+    Sender &&sender
+)
 {
     CAPTURE( io::enum_to_string( Type ) );
     CAPTURE( ref );
     m.clear();
-    b.send( cata::event::make<Type>( args... ) );
+    sender();
 
     std::string result = m.dump();
     CAPTURE( result );
@@ -67,6 +73,21 @@ void check_memorial( memorial_logger &m, event_bus &b, const std::string &ref, A
     CHECK( ref_lines.empty() );
 }
 
+// Send the event via event_bus::send as a sane default
+template<event_type Type, typename... Args>
+void check_memorial(
+    memorial_logger &m,
+    const std::string &ref,
+    Args... args
+)
+{
+    check_memorial_custom_sender<Type>(
+        m,
+        ref,
+        [&] { get_event_bus().send( cata::event::make<Type>( args... ) ); }
+    );
+}
+
 TEST_CASE( "memorials", "[memorial]" )
 {
     memorial_logger &m = get_memorial();
@@ -75,15 +96,15 @@ TEST_CASE( "memorials", "[memorial]" )
     get_stats().clear();
     get_achievements().clear();
 
-    event_bus &b = get_event_bus();
-
     avatar &player_character = get_avatar();
     player_character.male = false;
     character_id ch = player_character.getID();
     std::string u_name = player_character.name;
     character_id ch2 = character_id( ch.get_value() + 1 );
     mutagen_technique mutagen = mutagen_technique::injected_purifier;
     mtype_id mon( "mon_zombie_kevlar_2" );
+    tripoint_bub_ms loc = get_avatar().pos_bub() + tripoint::east;
+    monster &dummy_monster = spawn_test_monster( "mon_dragon_dummy", loc );
     efftype_id eff( "onfire" );
     itype_id it( "marloss_seed" );
     trait_id mut( "CARNIVORE" );
@@ -93,201 +114,205 @@ TEST_CASE( "memorials", "[memorial]" )
     proficiency_id prof( "prof_wound_care" );
 
     check_memorial<event_type::activates_artifact>(
-        m, b, "Activated the art_name.", ch, "art_name" );
+        m, "Activated the art_name.", ch, "art_name" );
 
     check_memorial<event_type::activates_mininuke>(
-        m, b, "Activated a mininuke.", ch );
+        m, "Activated a mininuke.", ch );
 
     check_memorial<event_type::administers_mutagen>(
-        m, b, "Injected purifier.", ch, mutagen );
+        m,  "Injected purifier.", ch, mutagen );
 
     check_memorial<event_type::angers_amigara_horrors>(
-        m, b, "Angered a group of amigara horrors!" );
+        m,  "Angered a group of amigara horrors!" );
 
     check_memorial<event_type::awakes_dark_wyrms>(
-        m, b, "Awoke a group of dark wyrms!" );
+        m,  "Awoke a group of dark wyrms!" );
 
     check_memorial<event_type::becomes_wanted>(
-        m, b, "Became wanted by the police!", ch );
+        m,  "Became wanted by the police!", ch );
 
     check_memorial<event_type::broken_bone>(
-        m, b, "Broke her right arm.", ch, bodypart_id( "arm_r" ) );
+        m,  "Broke her right arm.", ch, bodypart_id( "arm_r" ) );
 
     check_memorial<event_type::broken_bone_mends>(
-        m, b, "Broken right arm began to mend.", ch, bodypart_id( "arm_r" ) );
+        m,  "Broken right arm began to mend.", ch, bodypart_id( "arm_r" ) );
 
     check_memorial<event_type::buries_corpse>(
-        m, b, "You buried monster_name.", ch, mon, "monster_name" );
+        m,  "You buried monster_name.", ch, mon, "monster_name" );
 
     check_memorial<event_type::causes_resonance_cascade>(
-        m, b, "Caused a resonance cascade." );
+        m,  "Caused a resonance cascade." );
 
     check_memorial<event_type::character_gains_effect>(
-        m, b, "Caught on fire.", ch, bodypart_id( "arm_r" ), eff, 1 );
+        m,  "Caught on fire.", ch, bodypart_id( "arm_r" ), eff, 1 );
 
     check_memorial<event_type::character_kills_character>(
-        m, b, "Killed an innocent person, victim_name, in cold blood and felt terrible "
+        m,  "Killed an innocent person, victim_name, in cold blood and felt terrible "
         "afterwards.", ch, ch2, "victim_name" );
 
-    check_memorial<event_type::character_kills_monster>(
-        m, b, "Killed a Kevlar hulk.", ch, mon, 0 );
+    check_memorial_custom_sender<event_type::character_kills_monster>(
+        m,  "Killed a Kevlar hulk.",
+    [&] {
+        const cata::event e = cata::event::make<event_type::character_kills_monster>( ch, mon, 0 );
+        get_event_bus().send_with_talker( player_character.as_character(), dummy_monster.as_monster(), e );
+    } );
 
     check_memorial<event_type::character_loses_effect>(
-        m, b, "Put out the fire.", ch, bodypart_id( "arm_r" ), eff );
+        m,  "Put out the fire.", ch, bodypart_id( "arm_r" ), eff );
 
     check_memorial<event_type::character_triggers_trap>(
-        m, b, "Fell in a pit.", ch, tr_pit );
+        m,  "Fell in a pit.", ch, tr_pit );
 
     check_memorial<event_type::consumes_marloss_item>(
-        m, b, "Consumed a Marloss seed.", ch, it );
+        m,  "Consumed a Marloss seed.", ch, it );
 
     check_memorial<event_type::crosses_marloss_threshold>(
-        m, b, "Opened the Marloss Gateway.", ch );
+        m,  "Opened the Marloss Gateway.", ch );
 
     check_memorial<event_type::crosses_mutation_threshold>(
-        m, b, "Became one with the bears.", ch, mutation_category_URSINE );
+        m,  "Became one with the bears.", ch, mutation_category_URSINE );
 
     check_memorial<event_type::crosses_mycus_threshold>(
-        m, b, "Became one with the Mycus.", ch );
+        m,  "Became one with the Mycus.", ch );
 
     check_memorial<event_type::dermatik_eggs_hatch>(
-        m, b, "Dermatik eggs hatched.", ch );
+        m,  "Dermatik eggs hatched.", ch );
 
     check_memorial<event_type::dermatik_eggs_injected>(
-        m, b, "Injected with dermatik eggs.", ch );
+        m,  "Injected with dermatik eggs.", ch );
 
     check_memorial<event_type::destroys_triffid_grove>(
-        m, b, "Destroyed a triffid grove." );
+        m,  "Destroyed a triffid grove." );
 
     check_memorial<event_type::dies_from_asthma_attack>(
-        m, b, "Succumbed to an asthma attack.", ch );
+        m,  "Succumbed to an asthma attack.", ch );
 
     check_memorial<event_type::dies_from_drug_overdose>(
-        m, b, "Died of a drug overdose.", ch, eff );
+        m,  "Died of a drug overdose.", ch, eff );
 
     check_memorial<event_type::dies_from_bleeding>(
-        m, b, "Bled to death.", ch );
+        m,  "Bled to death.", ch );
 
     check_memorial<event_type::dies_from_hypovolemia>(
-        m, b, "Died of hypovolemic shock.", ch );
+        m,  "Died of hypovolemic shock.", ch );
 
     check_memorial<event_type::dies_from_redcells_loss>(
-        m, b, "Died from loss of red blood cells.", ch );
+        m,  "Died from loss of red blood cells.", ch );
 
     check_memorial<event_type::dies_of_infection>(
-        m, b, "Succumbed to the infection.", ch );
+        m,  "Succumbed to the infection.", ch );
 
     check_memorial<event_type::dies_of_starvation>(
-        m, b, "Died of starvation.", ch );
+        m,  "Died of starvation.", ch );
 
     check_memorial<event_type::dies_of_thirst>(
-        m, b, "Died of thirst.", ch );
+        m,  "Died of thirst.", ch );
 
     check_memorial<event_type::digs_into_lava>(
-        m, b, "Dug a shaft into lava." );
+        m,  "Dug a shaft into lava." );
 
     check_memorial<event_type::disarms_nuke>(
-        m, b, "Disarmed a nuclear missile." );
+        m,  "Disarmed a nuclear missile." );
 
     check_memorial<event_type::eats_sewage>(
-        m, b, "Ate a sewage sample." );
+        m,  "Ate a sewage sample." );
 
     check_memorial<event_type::evolves_mutation>(
-        m, b, "'Carnivore' mutation turned into 'Saprophage'", ch, mut, mut2 );
+        m,  "'Carnivore' mutation turned into 'Saprophage'", ch, mut, mut2 );
 
     check_memorial<event_type::exhumes_grave>(
-        m, b, "Exhumed a grave.", ch );
+        m,  "Exhumed a grave.", ch );
 
     check_memorial<event_type::fails_to_install_cbm>(
-        m, b, "Failed install of bionic: Alarm System.", ch, cbm );
+        m,  "Failed install of bionic: Alarm System.", ch, cbm );
 
     check_memorial<event_type::fails_to_remove_cbm>(
-        m, b, "Failed to remove bionic: Alarm System.", ch, cbm );
+        m,  "Failed to remove bionic: Alarm System.", ch, cbm );
 
     check_memorial<event_type::falls_asleep_from_exhaustion>(
-        m, b, "Succumbed to lack of sleep.", ch );
+        m,  "Succumbed to lack of sleep.", ch );
 
     check_memorial<event_type::fuel_tank_explodes>(
-        m, b, "The fuel tank of the vehicle_name exploded!", "vehicle_name" );
+        m,  "The fuel tank of the vehicle_name exploded!", "vehicle_name" );
 
     check_memorial<event_type::gains_addiction>(
-        m, b, "Became addicted to alcohol.", ch, addiction_alcohol );
+        m,  "Became addicted to alcohol.", ch, addiction_alcohol );
 
     check_memorial<event_type::gains_mutation>(
-        m, b, "Gained the mutation 'Carnivore'.", ch, mut );
+        m,  "Gained the mutation 'Carnivore'.", ch, mut );
 
     check_memorial<event_type::gains_proficiency>(
-        m, b, "Gained the proficiency 'Wound Care'.", ch, prof );
+        m,  "Gained the proficiency 'Wound Care'.", ch, prof );
 
     check_memorial<event_type::gains_skill_level>(
-        m, b, "Reached skill level 8 in vehicles.", ch, skill_driving, 8 );
+        m,  "Reached skill level 8 in vehicles.", ch, skill_driving, 8 );
 
     check_memorial<event_type::game_avatar_death>(
-        m, b, u_name + " was killed.\nLast words: last_words", ch, u_name, false, "last_words" );
+        m,  u_name + " was killed.\nLast words: last_words", ch, u_name, false, "last_words" );
 
     check_memorial<event_type::game_avatar_new>(
-        m, b, u_name + " began their journey into the Cataclysm.", true, false, ch, u_name,
+        m,  u_name + " began their journey into the Cataclysm.", true, false, ch, u_name,
         player_character.custom_profession );
 
     check_memorial<event_type::installs_cbm>(
-        m, b, "Installed bionic: Alarm System.", ch, cbm );
+        m,  "Installed bionic: Alarm System.", ch, cbm );
 
     check_memorial<event_type::installs_faulty_cbm>(
-        m, b, "Installed bad bionic: Alarm System.", ch, cbm );
+        m,  "Installed bad bionic: Alarm System.", ch, cbm );
 
     check_memorial<event_type::learns_martial_art>(
-        m, b, "Learned Aikido.", ch, style_aikido );
+        m,  "Learned Aikido.", ch, style_aikido );
 
     check_memorial<event_type::loses_addiction>(
-        m, b, "Overcame addiction to alcohol.", ch, addiction_alcohol );
+        m,  "Overcame addiction to alcohol.", ch, addiction_alcohol );
 
     check_memorial<event_type::npc_becomes_hostile>(
-        m, b, "npc_name became hostile.", ch2, "npc_name" );
+        m,  "npc_name became hostile.", ch2, "npc_name" );
 
     check_memorial<event_type::opens_portal>(
-        m, b, "Opened a portal." );
+        m,  "Opened a portal." );
 
     check_memorial<event_type::opens_temple>(
-        m, b, "Opened a strange temple." );
+        m,  "Opened a strange temple." );
 
     check_memorial<event_type::character_forgets_spell>(
-        m, b, "Forgot the spell Pain.", ch, spell_pain_damage );
+        m,  "Forgot the spell Pain.", ch, spell_pain_damage );
 
     check_memorial<event_type::character_learns_spell>(
-        m, b, "Learned the spell Pain.", ch, spell_pain_damage );
+        m,  "Learned the spell Pain.", ch, spell_pain_damage );
 
     check_memorial<event_type::player_levels_spell>(
-        m, b, "Gained a spell level on Pain.", ch, spell_pain_damage, 5, mut3 );
+        m,  "Gained a spell level on Pain.", ch, spell_pain_damage, 5, mut3 );
 
     check_memorial<event_type::releases_subspace_specimens>(
-        m, b, "Released subspace specimens." );
+        m,  "Released subspace specimens." );
 
     check_memorial<event_type::removes_cbm>(
-        m, b, "Removed bionic: Alarm System.", ch, cbm );
+        m,  "Removed bionic: Alarm System.", ch, cbm );
 
     check_memorial<event_type::seals_hazardous_material_sarcophagus>(
-        m, b, "Sealed a Hazardous Material Sarcophagus." );
+        m,  "Sealed a Hazardous Material Sarcophagus." );
 
     check_memorial<event_type::telefrags_creature>(
-        m, b, "Telefragged a telefragged_name.", ch, "telefragged_name" );
+        m,  "Telefragged a telefragged_name.", ch, "telefragged_name" );
 
     check_memorial<event_type::teleglow_teleports>(
-        m, b, "Spontaneous teleport.", ch );
+        m,  "Spontaneous teleport.", ch );
 
     check_memorial<event_type::teleports_into_wall>(
-        m, b, "Teleported into a obstacle_name.", ch, "obstacle_name" );
+        m,  "Teleported into a obstacle_name.", ch, "obstacle_name" );
 
     check_memorial<event_type::terminates_subspace_specimens>(
-        m, b, "Terminated subspace specimens." );
+        m,  "Terminated subspace specimens." );
 
     check_memorial<event_type::throws_up>(
-        m, b, "Threw up.", ch );
+        m,  "Threw up.", ch );
 
     check_memorial<event_type::triggers_alarm>(
-        m, b, "Set off an alarm.", ch );
+        m,  "Set off an alarm.", ch );
 
     check_memorial<event_type::uses_debug_menu>(
-        m, b, "Used the debug menu (WISH).", debug_menu::debug_menu_index::WISH );
+        m,  "Used the debug menu (WISH).", debug_menu::debug_menu_index::WISH );
 }
 
 TEST_CASE( "convert_legacy_memorial_log", "[memorial]" )