1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
|
#ifdef _GLIBCXX_DEBUG
// Workaround to allow randomly ordered tests. See
// https://github.com/catchorg/Catch2/issues/1384
// https://stackoverflow.com/questions/22915325/avoiding-self-assignment-in-stdshuffle/23691322
// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=85828
#include <iosfwd> // Any cheap-to-include stdlib header
#ifdef __GLIBCXX__
#include <debug/macros.h> // IWYU pragma: keep
#undef __glibcxx_check_self_move_assign
#define __glibcxx_check_self_move_assign(x)
#endif // __GLIBCXX__
#endif // _GLIBCXX_DEBUG
#define CATCH_CONFIG_RUNNER
#include <algorithm>
#include <cstring>
#include <chrono>
#include "catch/catch.hpp"
#include "debug.h"
#include "filesystem.h"
#include "game.h"
#include "loading_ui.h"
#include "map.h"
#include "mod_manager.h"
#include "overmap.h"
#include "overmapbuffer.h"
#include "path_info.h"
#include "pathfinding.h"
#include "player.h"
#include "worldfactory.h"
typedef std::pair<std::string, std::string> name_value_pair_t;
typedef std::vector<name_value_pair_t> option_overrides_t;
// If tag is found as a prefix of any argument in arg_vec, the argument is
// removed from arg_vec and the argument suffix after tag is returned.
// Otherwise, an empty string is returned and arg_vec is unchanged.
std::string extract_argument( std::vector<const char *> &arg_vec, const std::string &tag )
{
std::string arg_rest;
for( auto iter = arg_vec.begin(); iter != arg_vec.end(); iter++ ) {
if( strncmp( *iter, tag.c_str(), tag.length() ) == 0 ) {
arg_rest = std::string( &( *iter )[tag.length()] );
arg_vec.erase( iter );
break;
}
}
return arg_rest;
}
std::vector<mod_id> extract_mod_selection( std::vector<const char *> &arg_vec )
{
std::vector<mod_id> ret;
std::string mod_string = extract_argument( arg_vec, "--mods=" );
const char delim = ',';
size_t i = 0;
size_t pos = mod_string.find( delim );
if( pos == std::string::npos && !mod_string.empty() ) {
ret.emplace_back( mod_string );
}
while( pos != std::string::npos ) {
ret.emplace_back( mod_string.substr( i, pos - i ) );
i = ++pos;
pos = mod_string.find( delim, pos );
if( pos == std::string::npos ) {
ret.emplace_back( mod_string.substr( i, mod_string.length() ) );
}
}
return ret;
}
void init_global_game_state( const std::vector<mod_id> &mods,
option_overrides_t &option_overrides )
{
PATH_INFO::init_base_path( "" );
PATH_INFO::init_user_dir( "./" );
PATH_INFO::set_standard_filenames();
if( !assure_dir_exist( FILENAMES["config_dir"] ) ) {
assert( !"Unable to make config directory. Check permissions." );
}
if( !assure_dir_exist( FILENAMES["savedir"] ) ) {
assert( !"Unable to make save directory. Check permissions." );
}
if( !assure_dir_exist( FILENAMES["templatedir"] ) ) {
assert( !"Unable to make templates directory. Check permissions." );
}
get_options().init();
get_options().load();
// Apply command-line option overrides for test suite execution.
if( !option_overrides.empty() ) {
for( auto iter = option_overrides.begin(); iter != option_overrides.end(); ++iter ) {
name_value_pair_t option = *iter;
if( get_options().has_option( option.first ) ) {
options_manager::cOpt &opt = get_options().get_option( option.first );
opt.setValue( option.second );
}
}
}
init_colors();
g.reset( new game );
g->new_game = true;
g->load_static_data();
world_generator->set_active_world( NULL );
world_generator->init();
WORLDPTR test_world = world_generator->make_new_world( mods );
assert( test_world != NULL );
world_generator->set_active_world( test_world );
assert( world_generator->active_world != NULL );
loading_ui ui( false );
g->load_core_data( ui );
g->load_world_modfiles( ui );
g->u = player();
g->u.create( PLTYPE_NOW );
g->m = map( get_option<bool>( "ZLEVELS" ) );
overmap_special_batch empty_specials( { 0, 0 } );
overmap_buffer.create_custom_overmap( 0, 0, empty_specials );
g->m.load( g->get_levx(), g->get_levy(), g->get_levz(), false );
}
// Checks if any of the flags are in container, removes them all
bool check_remove_flags( std::vector<const char *> &cont, const std::vector<const char *> &flags )
{
bool has_any = false;
auto iter = flags.begin();
while( iter != flags.end() ) {
auto found = std::find_if( cont.begin(), cont.end(),
[iter]( const char *c ) {
return strcmp( c, *iter ) == 0;
} );
if( found == cont.end() ) {
iter++;
} else {
cont.erase( found );
has_any = true;
}
}
return has_any;
}
// Split s on separator sep, returning parts as a pair. Returns empty string as
// second value if no separator found.
name_value_pair_t split_pair( const std::string &s, const char sep )
{
const size_t pos = s.find( sep );
if( pos != std::string::npos ) {
return name_value_pair_t( s.substr( 0, pos ), s.substr( pos + 1 ) );
} else {
return name_value_pair_t( s, "" );
}
}
option_overrides_t extract_option_overrides( std::vector<const char *> &arg_vec )
{
option_overrides_t ret;
std::string option_overrides_string = extract_argument( arg_vec, "--option_overrides=" );
if( option_overrides_string.empty() ) {
return ret;
}
const char delim = ',';
const char sep = ':';
size_t i = 0;
size_t pos = option_overrides_string.find( delim );
while( pos != std::string::npos ) {
std::string part = option_overrides_string.substr( i, pos );
ret.emplace_back( split_pair( part, sep ) );
i = ++pos;
pos = option_overrides_string.find( delim, pos );
}
// Handle last part
const std::string part = option_overrides_string.substr( i );
ret.emplace_back( split_pair( part, sep ) );
return ret;
}
struct CataReporter : Catch::ConsoleReporter {
using ConsoleReporter::ConsoleReporter;
static std::string getDescription() {
return "As console reporter, but with backtrace support if enabled at build time "
"and seeding the Cataclysm RNG before each test";
}
virtual void sectionStarting( Catch::SectionInfo const §ionInfo ) override {
ConsoleReporter::sectionStarting( sectionInfo );
// Initialize the cata RNG with the Catch seed for reproducible tests
rng_set_engine_seed( m_config->rngSeed() );
}
bool assertionEnded( Catch::AssertionStats const &assertionStats ) override {
const auto r = ConsoleReporter::assertionEnded( assertionStats );
#ifdef BACKTRACE
Catch::AssertionResult const &result = assertionStats.assertionResult;
if( result.getResultType() == Catch::ResultWas::FatalErrorCondition ) {
// We are in a signal handler for a fatal error condition, so print a
// backtrace
stream << "Stack trace at fatal error:\n";
debug_write_backtrace( stream );
}
#endif
return r;
}
};
CATCH_REGISTER_REPORTER( "cata", CataReporter )
int main( int argc, const char *argv[] )
{
Catch::Session session;
std::vector<const char *> arg_vec( argv, argv + argc );
std::vector<mod_id> mods = extract_mod_selection( arg_vec );
if( std::find( mods.begin(), mods.end(), mod_id( "dda" ) ) == mods.end() ) {
mods.insert( mods.begin(), mod_id( "dda" ) ); // @todo move unit test items to core
}
option_overrides_t option_overrides_for_test_suite = extract_option_overrides( arg_vec );
const bool dont_save = check_remove_flags( arg_vec, { "-D", "--drop-world" } );
// Note: this must not be invoked before all DDA-specific flags are stripped from arg_vec!
int result = session.applyCommandLine( arg_vec.size(), &arg_vec[0] );
if( result != 0 || session.configData().showHelp ) {
printf( "CataclysmDDA specific options:\n" );
printf( " --mods=<mod1,mod2,...> Loads the list of mods before executing tests.\n" );
printf( " -D, --drop-world Don't save the world on test failure.\n" );
printf( " --option_overrides=n:v[,...] Name-value pairs of game options for tests.\n" );
printf( " (overrides config/options.json values)\n" );
return result;
}
test_mode = true;
setupDebug( DebugOutput::std_err );
// Set the seed for mapgen (the seed will also be reset before each test)
const unsigned int seed = session.config().rngSeed();
if( seed ) {
srand( seed );
rng_set_engine_seed( seed );
}
try {
// TODO: Only init game if we're running tests that need it.
init_global_game_state( mods, option_overrides_for_test_suite );
} catch( const std::exception &err ) {
fprintf( stderr, "Terminated: %s\n", err.what() );
fprintf( stderr,
"Make sure that you're in the correct working directory and your data isn't corrupted.\n" );
return EXIT_FAILURE;
}
const auto start = std::chrono::system_clock::now();
std::time_t start_time = std::chrono::system_clock::to_time_t( start );
// Leading newline in case there were debug messages during
// initialization.
printf( "\nStarting the actual test at %s", std::ctime( &start_time ) );
result = session.run();
const auto end = std::chrono::system_clock::now();
std::time_t end_time = std::chrono::system_clock::to_time_t( end );
auto world_name = world_generator->active_world->world_name;
if( result == 0 || dont_save ) {
world_generator->delete_world( world_name, true );
} else {
printf( "Test world \"%s\" left for inspection.\n", world_name.c_str() );
}
std::chrono::duration<double> elapsed_seconds = end - start;
printf( "Ended test at %sThe test took %.3f seconds\n", std::ctime( &end_time ),
elapsed_seconds.count() );
return result;
}
|