18
0
mirror of https://github.com/MaSzyna-EU07/maszyna.git synced 2026-11-14 15:39:22 +01:00
Files
maszyna/simulation/simulationtest.h
jerrrrycho e5aafd154f feat(simulation): the pass and the standstill wait for the train under test only
Both waited for every vehicle of the scenery to stand still, so on a scenery
with AI traffic a test could pass only when the traffic happened to stand too,
and the standstill end hardly ever came.

A test scenery names the train under test with test.vehicle <name> in its
config block (once for each train, if several): the pass and the standstill wait
for the consists of these vehicles as they are at the moment, so a train the
tested one couples to counts with it. A name the scenery doesn't have ends the
test with the error code. Without test.vehicle every vehicle counts, as before.
A signal passed at danger counts for every train either way.

run.py puts the case's lead vehicle into test.vehicle. test_mode_standstill_traffic
has the train under test standing on track 2 of Stacja1 while AI traffic leaves
track 1 on the timetable: it ends on its 100 s standstill, where counting every
vehicle runs into the 300 s timeout. Physicslogs of the other trains of a case
(<something>_<vehicle>) are moved out of the game dir too.
2026-11-08 11:39:52 +01:00

77 lines
3.0 KiB
C++

/*
This Source Code Form is subject to the
terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not
distributed with this file, You can
obtain one at
http://mozilla.org/MPL/2.0/.
*/
#pragma once
#include "simulation/simulationtestrules.h"
#include <atomic>
#include <mutex>
#include <string_view>
#include <thread>
// integration test mode (eu07 --test -s <scenery>, eu07/maszyna#541): the scenery runs unattended in a tight
// fixed-step loop and the simulator quits with an exit code saying how the test went
namespace simulation {
class test_manager {
public:
// name of the memory cell a scenery reports its result to
static constexpr std::string_view result_cell { "__test.result" };
// fixed simulation time step of one frame in test mode [s]: 3 physics steps of 10 ms
static constexpr double frame_step { 0.03 };
// creates the result cell; called with the other scripting interface cells, before the scenery is read
void init_result_cell() const;
// the simulation is ready: start the clocks
void start();
// checks the end conditions after a simulation frame of Deltatime seconds
void update(double Deltatime);
// reported by a driver whose train went past a signal showing stop
void signal_passed_at_danger(std::string_view Vehicle, std::string_view Signal);
// ends the test with given result and closes the application; the first call wins
void finish(test_result Result, std::string_view Reason);
// ends the test with given result, without closing the application: for the ways out that close it anyway
// (a bad command line, a failed start, an exception). returns false if the test had already ended
bool conclude(test_result Result, std::string_view Reason);
// (re)sets the real time limit of the run [s] since the start of the simulator, 0 = none. the first limit
// starts the watchdog, which ends a run still going at the limit with the timeout code, whatever it's doing
void watch_wall_clock(double Limit);
bool finished() const { return m_finished; }
// exit code of the process: the result, or error while the test hasn't finished
int exit_code() const;
private:
// the watchdog's check, at Elapsed seconds of real time since the start of the simulator
void check_wall_clock(double Elapsed);
// every vehicle of the tested trains stands: the consists of test.vehicle, or every vehicle without it
bool tested_trains_at_rest() const;
// the watchdog may end the test from its own thread
mutable std::mutex m_lock;
bool m_started { false };
std::atomic<bool> m_finished { false };
test_result m_result { test_result::error };
test_progress m_progress;
std::atomic<double> m_walllimit { 0.0 }; // [s] since the start of the simulator, 0 = none
std::jthread m_watchdog;
};
// the test of the run
test_manager &test();
// the settings of the test mode, over whatever the settings files and the scenery say: applied once the command
// line is read, and again after each config block of the scenery, which could turn the sound, the network or the
// program run at the end back on
void apply_test_mode_settings();
} // namespace simulation