fly/flightgear
1
0
Fork 0
Code Activity

Tests: Add some unit tests for submodels

Browse source 
Tests:
- loading XML submodels file, using just about every documented tag.
- submodel release trigger
- initial submodel position and velocity
This commit is contained in:
Colin Geniet 2021-01-18 10:59:03 +01:00 • committed by James Turner
parent 4f4a81d12b
commit b738058945
5 changed files with 398 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
test_suite/test_data/Aircraft/Test/submodels.xml Normal file
View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="UTF-8"?>
<PropertyList>
<submodel n="0">
<name>testLoadXML</name>
<model>Models/Geometry/null.ac</model>
<trigger>ai/submodels/submodel[0]/trigger</trigger>
<speed>100</speed>
<speed-prop>ai/submodels/submodel[0]/speed</speed-prop>
<count>42</count>
<repeat>true</repeat>
<delay>0.5</delay>
<offsets>
<x-m>2</x-m>
<y-m>0</y-m>
<z-m>0</z-m>
<heading-deg>90</heading-deg>
<pitch-deg>45</pitch-deg>
</offsets>
<life>1</life>
<buoyancy>10</buoyancy>
<wind>true</wind>
<weight>3</weight>
<contents>ai/submodels/submodel[0]/content</contents>
<cd>0.2</cd>
<eda>0.1</eda>
<aero-stabilized>false</aero-stabilized>
<external-force>true</external-force>
<force-path>ai/submodels/submodel[0]/force</force-path>
<force-stabilized>true</force-stabilized>
<no-roll>true</no-roll>
<random>true</random>
<randomness>
<azimuth>5</azimuth>
<elevation>5</elevation>
<cd>0.1</cd>
<life>0.2</life>
</randomness>
<collision>true</collision>
<fuze-range>1</fuze-range>
<impact>true</impact>
<expiry>true</expiry>
<impact-reports>ai/submodels/submodel[0]/report</impact-reports>
<slaved>true</slaved>
</submodel>
<submodel n="1">
<name>testRelease</name>
<model>Models/Geometry/null.ac</model>
<trigger>ai/submodels/submodel[1]/trigger</trigger>
<count>-1</count>
<repeat>false</repeat>
<delay>1</delay>
<life>10</life>
</submodel>
<submodel n="2">
<name>testInitialState</name>
<model>Models/Geometry/null.ac</model>
<trigger>ai/submodels/submodel[2]/trigger</trigger>
<speed>100</speed>
<repeat>false</repeat>
<delay>-1</delay>
<count>-1</count>
<aero-stabilised>false</aero-stabilised>
<wind>true</wind>
<offsets>
<x-m>10</x-m>
<y-m>6</y-m>
<z-m>1</z-m>
<heading-deg>30</heading-deg>
<pitch-deg>50</pitch-deg>
</offsets>
<life>10</life>
</submodel>
</PropertyList>

2
test_suite/unit_tests/AI/CMakeLists.txt
View file

@ -4,6 +4,7 @@ set(TESTSUITE_SOURCES
${CMAKE_CURRENT_SOURCE_DIR}/TestSuite.cxx
${CMAKE_CURRENT_SOURCE_DIR}/test_AIManager.cxx
${CMAKE_CURRENT_SOURCE_DIR}/test_traffic.cxx
${CMAKE_CURRENT_SOURCE_DIR}/test_submodels.cxx
PARENT_SCOPE
)
@ -11,5 +12,6 @@ set(TESTSUITE_HEADERS
${TESTSUITE_HEADERS}
${CMAKE_CURRENT_SOURCE_DIR}/test_AIManager.hxx
${CMAKE_CURRENT_SOURCE_DIR}/test_traffic.hxx
${CMAKE_CURRENT_SOURCE_DIR}/test_submodels.hxx
PARENT_SCOPE
)

4
test_suite/unit_tests/AI/TestSuite.cxx
View file

@ -19,6 +19,8 @@
#include "test_AIManager.hxx"
#include "test_traffic.hxx"
#include "test_submodels.hxx"
CPPUNIT_TEST_SUITE_NAMED_REGISTRATION(AIManagerTests, "Unit tests");
CPPUNIT_TEST_SUITE_NAMED_REGISTRATION(TrafficTests, "Unit tests");
CPPUNIT_TEST_SUITE_NAMED_REGISTRATION(TrafficTests, "Unit tests");
CPPUNIT_TEST_SUITE_NAMED_REGISTRATION(SubmodelsTests, "Unit tests");

260
test_suite/unit_tests/AI/test_submodels.cxx Normal file
View file

@ -0,0 +1,260 @@
/*
* Copyright (C) 2021 Colin Geniet
*
* This file is part of the program FlightGear.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "test_submodels.hxx"
#include "test_suite/FGTestApi/NavDataCache.hxx"
#include "test_suite/FGTestApi/TestPilot.hxx"
#include "test_suite/FGTestApi/testGlobals.hxx"
#include <AIModel/AIAircraft.hxx>
#include <AIModel/AIManager.hxx>
#include <AIModel/submodel.hxx>
#include <Airports/airport.hxx>
#include <Main/fg_props.hxx>
#include <Main/globals.hxx>
#include <cmath>
using std::string;
/////////////////////////////////////////////////////////////////////////////
// Set up function for each test.
void SubmodelsTests::setUp()
{
FGTestApi::setUp::initTestGlobals("Submodels");
FGTestApi::setUp::initNavDataCache();
globals->append_aircraft_path(SGPath::fromUtf8(FG_TEST_SUITE_DATA) / "Aircraft");
auto props = globals->get_props();
props->setBoolValue("sim/ai/enabled", true);
props->setStringValue("sim/submodels/path", "Aircraft/Test/submodels.xml");
globals->add_new_subsystem<FGAIManager>();
globals->add_new_subsystem<FGSubmodelMgr>();
globals->get_subsystem_mgr()->bind();
globals->get_subsystem_mgr()->init();
globals->get_subsystem_mgr()->postinit();
}
// Clean up after each test.
void SubmodelsTests::tearDown()
{
FGTestApi::tearDown::shutdownTestGlobals();
}
void SubmodelsTests::testLoadXML()
{
auto props = globals->get_props();
auto sm_node = props->getNode("ai/submodels");
CPPUNIT_ASSERT(sm_node->hasChild("submodel", 0));
sm_node = sm_node->getChild("submodel", 0);
CPPUNIT_ASSERT_EQUAL(string{"testLoadXML"}, static_cast<string>(sm_node->getStringValue("name")));
CPPUNIT_ASSERT_EQUAL(0, sm_node->getIntValue("id"));
CPPUNIT_ASSERT_EQUAL(42, sm_node->getIntValue("count"));
CPPUNIT_ASSERT(sm_node->getBoolValue("serviceable"));
}
FGAIBase* SubmodelsTests::findAIModel(std::string &name) {
auto ai_list = globals->get_subsystem<FGAIManager>()->get_ai_list();
auto filter = [name](FGAIBase *model) { return model->_getName() == name; };
return *std::find_if(ai_list.begin(), ai_list.end(), filter);
}
int SubmodelsTests::countAIModels(std::string &name) {
auto ai_list = globals->get_subsystem<FGAIManager>()->get_ai_list();
auto filter = [name](FGAIBase *model) { return model->_getName() == name; };
return static_cast<int>(std::count_if(ai_list.begin(), ai_list.end(), filter));
}
void SubmodelsTests::testRelease()
{
auto props = globals->get_props();
auto sm_node = props->getNode("ai/submodels/submodel[1]");
std::string name = sm_node->getStringValue("name");
// Setup reasonable flight conditions.
auto bikf = FGAirport::findByIdent("BIKF");
auto pilot = SGSharedPtr<FGTestApi::TestPilot>(new FGTestApi::TestPilot);
FGTestApi::setPosition(bikf->geod());
pilot->resetAtPosition(bikf->geod());
pilot->setSpeedKts(0);
pilot->setCourseTrue(0.0);
pilot->setTargetAltitudeFtMSL(0);
// Sanity check
CPPUNIT_ASSERT_EQUAL(0, countAIModels(name));
// Don't release anything
FGTestApi::runForTime(10.0);
CPPUNIT_ASSERT_EQUAL(0, countAIModels(name));
// Release submodel
sm_node->setBoolValue("trigger", true);
FGTestApi::runForTime(1);
sm_node->setBoolValue("trigger", false);
FGTestApi::runForTime(1);
CPPUNIT_ASSERT_EQUAL(1, countAIModels(name));
// Check validity
auto sm = findAIModel(name);
CPPUNIT_ASSERT(sm->isValid());
CPPUNIT_ASSERT(!sm->getDie());
// Second time
sm_node->setBoolValue("trigger", true);
FGTestApi::runForTime(5);
sm_node->setBoolValue("trigger", false);
FGTestApi::runForTime(1);
CPPUNIT_ASSERT_EQUAL(2, countAIModels(name));
// Let submodels expire
FGTestApi::runForTime(20);
CPPUNIT_ASSERT_EQUAL(0, countAIModels(name));
// Switch to repeat release
sm_node->setBoolValue("repeat", true);
sm_node->setBoolValue("trigger", true);
FGTestApi::runForTime(4.2); // release interval is 1s
sm_node->setBoolValue("trigger", false);
CPPUNIT_ASSERT_EQUAL(4, countAIModels(name));
// Let submodels expire
FGTestApi::runForTime(20);
CPPUNIT_ASSERT_EQUAL(0, countAIModels(name));
// In repeat mode, release timer persists when trigger is false.
// Currently it is at ~0.2s, so this must not release anything.
sm_node->setBoolValue("trigger", true);
FGTestApi::runForTime(0.5);
sm_node->setBoolValue("trigger", false);
CPPUNIT_ASSERT_EQUAL(0, countAIModels(name));
// Set limited count
sm_node->setIntValue("count", 3);
sm_node->setBoolValue("trigger", true);
FGTestApi::runForTime(1);
CPPUNIT_ASSERT_EQUAL(2, sm_node->getIntValue("count"));
CPPUNIT_ASSERT_EQUAL(1, countAIModels(name));
FGTestApi::runForTime(5);
CPPUNIT_ASSERT_EQUAL(0, sm_node->getIntValue("count"));
CPPUNIT_ASSERT_EQUAL(3, countAIModels(name));
}
void SubmodelsTests::testInitialState()
{
auto props = globals->get_props();
auto sm_node = props->getNode("ai/submodels/submodel[2]");
std::string name = sm_node->getStringValue("name");
// Submodel parameters
double x_offset = 10, y_offset = 6, z_offset = 1, yaw_offset = 30, pitch_offset = 50, speed = 100;
// Setup reasonable flight conditions.
auto bikf = FGAirport::findByIdent("BIKF");
auto pilot = SGSharedPtr<FGTestApi::TestPilot>(new FGTestApi::TestPilot);
FGTestApi::setPosition(bikf->geod());
pilot->resetAtPosition(bikf->geod());
pilot->setSpeedKts(0);
pilot->setCourseTrue(90);
pilot->setTargetAltitudeFtMSL(0);
props->setDoubleValue("/orientation/pitch-deg", 0);
props->setDoubleValue("/orientation/roll-deg", 0);
FGTestApi::runForTime(1);
sm_node->setBoolValue("trigger", true);
// Run update loop with dt=0 to capture initial state.
globals->get_subsystem<FGSubmodelMgr>()->update(0);
globals->get_subsystem<FGAIManager>()->update(0);
sm_node->setBoolValue("trigger", false);
CPPUNIT_ASSERT_EQUAL(1, countAIModels(name));
auto sm = findAIModel(name);
auto sm_pos = sm->getCartPos();
auto ac_pos = globals->get_aircraft_position_cart(); //ac->getCartPosAt(SGVec3d(0, 0, 0));
double heading, pitch, roll;
globals->get_aircraft_orientation(heading, pitch, roll);
CPPUNIT_ASSERT_DOUBLES_EQUAL(90, heading, 0.1);
CPPUNIT_ASSERT_DOUBLES_EQUAL(0, pitch, 0.1);
CPPUNIT_ASSERT_DOUBLES_EQUAL(0, roll, 0.1);
// Submodel release point
// Submodels offsets are in x-back,y-right,z-up frame.
// Computation is in x-forward,y-irght,z-down frame.
SGVec3d offset(-x_offset, y_offset, -z_offset);
SGQuatd local_frame_rotation = SGQuatd::fromLonLat(globals->get_aircraft_position());
local_frame_rotation *= SGQuatd::fromYawPitchRollDeg(heading, pitch, roll);
offset = local_frame_rotation.backTransform(offset);
auto release_pos = ac_pos + offset;
CPPUNIT_ASSERT_DOUBLES_EQUAL(release_pos.x(), sm_pos.x(), 0.01);
CPPUNIT_ASSERT_DOUBLES_EQUAL(release_pos.y(), sm_pos.y(), 0.01);
CPPUNIT_ASSERT_DOUBLES_EQUAL(release_pos.z(), sm_pos.z(), 0.01);
CPPUNIT_ASSERT_DOUBLES_EQUAL(remainder(heading + yaw_offset, 360), remainder(sm->getTrueHeadingDeg(), 360), 0.1);
CPPUNIT_ASSERT_DOUBLES_EQUAL(pitch + pitch_offset, sm->_getPitch(), 0.1);
CPPUNIT_ASSERT_DOUBLES_EQUAL(speed, sm->_getSpeed() * SG_KT_TO_FPS, 0.1);
// Let submodels expire
FGTestApi::runForTime(20);
CPPUNIT_ASSERT_EQUAL(0, countAIModels(name));
// Second test for velocities
double speed_east = 100, wind_north = 20;
pilot->setSpeedKts(100 * SG_FPS_TO_KT);
props->setDoubleValue("/orientation/pitch-deg", 0);
props->setDoubleValue("/orientation/roll-deg", 0);
props->setDoubleValue("/velocities/speed-north-fps", 0);
props->setDoubleValue("/velocities/speed-east-fps", speed_east);
props->setDoubleValue("/velocities/speed-down-fps", 0);
props->setDoubleValue("/environment/wind-from-north-fps", wind_north);
props->setDoubleValue("/environment/wind-from-east-fps", 0);
FGTestApi::runForTime(1);
sm_node->setBoolValue("trigger", true);
// Run update loop with dt=0 to capture initial state.
globals->get_subsystem<FGSubmodelMgr>()->update(0);
globals->get_subsystem<FGAIManager>()->update(0);
sm_node->setBoolValue("trigger", false);
CPPUNIT_ASSERT_EQUAL(1, countAIModels(name));
sm = findAIModel(name);
// Check initial speeds.
// _get_speed_*_fps gives airspeed for submodels, which initially must be the vector
// parent_ground_velocity + opposed_wind_velocity + submodel_launch_velocity
CPPUNIT_ASSERT_DOUBLES_EQUAL(cos((heading + yaw_offset) * SG_DEGREES_TO_RADIANS)
* cos((pitch + pitch_offset) * SG_DEGREES_TO_RADIANS)
* speed
+ wind_north,
sm->_get_speed_north_fps(), 0.1);
CPPUNIT_ASSERT_DOUBLES_EQUAL(sin((heading + yaw_offset) * SG_DEGREES_TO_RADIANS)
* cos((pitch + pitch_offset) * SG_DEGREES_TO_RADIANS)
* speed
+ speed_east,
sm->_get_speed_east_fps(), 0.1);
// In AIBase, attribute 'vs' is in fpm, but AIBallistic uses it as fps?!
CPPUNIT_ASSERT_DOUBLES_EQUAL(sin((pitch + pitch_offset) * SG_DEGREES_TO_RADIANS) * speed,
sm->_getVS_fps() * 60, 0.1);
}

57
test_suite/unit_tests/AI/test_submodels.hxx Normal file
View file

@ -0,0 +1,57 @@
/*
* Copyright (C) 2021 Colin Geniet
*
* This file is part of the program FlightGear.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <cppunit/TestFixture.h>
#include <cppunit/extensions/HelperMacros.h>
#include <AIModel/AIBase.hxx>
#include <simgear/props/props.hxx>
class SGGeod;
// The flight plan unit tests.
class SubmodelsTests : public CppUnit::TestFixture
{
// Set up the test suite.
CPPUNIT_TEST_SUITE(SubmodelsTests);
CPPUNIT_TEST(testLoadXML);
CPPUNIT_TEST(testRelease);
CPPUNIT_TEST(testInitialState);
CPPUNIT_TEST_SUITE_END();
public:
// Set up function for each test.
void setUp();
// Clean up after each test.
void tearDown();
// The tests.
void testLoadXML();
void testRelease();
void testInitialState();
private:
FGAIBase* findAIModel(std::string &name);
int countAIModels(std::string &name);
};