fly/flightgear
1
0
Fork 0
Code Activity
flightgear/src/Add-ons/test_AddonManagement.cxx

250 lines
9 KiB
C++
Raw Normal View History

Improved infrastructure for add-ons: C++ classes, metadata file, Nasal interface This commit adds C++ classes for add-on management, most notably AddonManager, Addon and AddonVersion. The AddonManager is used to register add-ons. It relies on an std::map<std::string, AddonRef> to hold the metadata of each registered add-on (keys of the std::map are add-on identifiers, and AddonRef is currently SGSharedPtr<Addon>). Accessor methods are available for: - retrieving the list of registered or loaded add-ons (terminology explained in $FG_ROOT/Docs/README.add-ons); - checking if a particular add-on has already been registered or loaded; - for each add-on, obtaining an Addon instance which can be queried for its name, id, version, base path, the minimum and maximum FlightGear versions it requires, its base node in the Property Tree, its order in the load sequence, short and long description strings, home page, etc. The most important metadata is made accessible in the Property Tree under /addons/by-id/<addon-id> and the property /addons/by-id/<addon-id>/loaded can be checked or listened to, in order to determine when a particular add-on is loaded. There is also a Nasal interface to access add-on metadata in a convenient way. In order to provide this metadata, each add-on must from now on have in its base directory a file called 'addon-metadata.xml'. All this is documented in much more detail in $FG_ROOT/Docs/README.add-ons. Mailing-list discussion: https://sourceforge.net/p/flightgear/mailman/message/36146017/
2017-11-06 12:58:14 +00:00
// -*- coding: utf-8 -*-
//
// test_AddonManagement.cxx --- Automated tests for FlightGear classes dealing
// with add-ons
// Copyright (C) 2017 Florent Rougon
//
// 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, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#include "config.h"
#include "unitTestHelpers.hxx"
#include <sstream>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
#include <cassert>
#include <cstddef>
#include <simgear/misc/test_macros.hxx>
#include "Add-ons/Addon.hxx"
#include "Add-ons/AddonVersion.hxx"
using std::string;
using std::vector;
using namespace flightgear;
void testAddonVersionSuffix()
{
using AddonRelType = AddonVersionSuffixPrereleaseType;
fgtest::initTestGlobals("AddonVersion");
AddonVersionSuffix v1(AddonRelType::beta, 2, true, 5);
AddonVersionSuffix v1Copy(v1);
AddonVersionSuffix v1NonDev(AddonRelType::beta, 2, false);
SG_CHECK_EQUAL(v1, v1Copy);
SG_CHECK_EQUAL(v1, AddonVersionSuffix("b2.dev5"));
SG_CHECK_EQUAL_NOSTREAM(v1.makeTuple(),
std::make_tuple(AddonRelType::beta, 2, true, 5));
SG_CHECK_EQUAL(AddonVersionSuffix(), AddonVersionSuffix(""));
// A simple comparison
SG_CHECK_LT(v1, v1NonDev); // b2.dev5 < b2
// Check string representation with str()
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::none).str(), "");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::none, 0, true, 12).str(),
".dev12");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::alpha, 1).str(), "a1");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::alpha, 1, false).str(), "a1");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::alpha, 2, true, 4).str(),
"a2.dev4");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::beta, 1).str(), "b1");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::beta, 1, false).str(), "b1");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::beta, 2, true, 4).str(),
"b2.dev4");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::candidate, 1).str(), "rc1");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::candidate, 1, false).str(),
"rc1");
SG_CHECK_EQUAL(AddonVersionSuffix(AddonRelType::candidate, 2, true, 4).str(),
"rc2.dev4");
// Check stream output
std::ostringstream oss;
oss << AddonVersionSuffix(AddonRelType::candidate, 2, true, 4);
SG_CHECK_EQUAL(oss.str(), "rc2.dev4");
// Check ordering with all types of transitions, using operator<()
auto checkStrictOrdering = [](const vector<AddonVersionSuffix>& v) {
assert(v.size() > 1);
for (std::size_t i=0; i < v.size() - 1; i++) {
SG_CHECK_LT(v[i], v[i+1]);
}
};
checkStrictOrdering({
{AddonRelType::none, 0, true, 1},
{AddonRelType::none, 0, true, 2},
{AddonRelType::alpha, 1, true, 1},
{AddonRelType::alpha, 1, true, 2},
{AddonRelType::alpha, 1, true, 3},
{AddonRelType::alpha, 1, false},
{AddonRelType::alpha, 2, true, 1},
{AddonRelType::alpha, 2, true, 3},
{AddonRelType::alpha, 2, false},
{AddonRelType::beta, 1, true, 1},
{AddonRelType::beta, 1, true, 25},
{AddonRelType::beta, 1, false},
{AddonRelType::beta, 2, true, 1},
{AddonRelType::beta, 2, true, 2},
{AddonRelType::beta, 2, false},
{AddonRelType::candidate, 1, true, 1},
{AddonRelType::candidate, 1, true, 2},
{AddonRelType::candidate, 1, false},
{AddonRelType::candidate, 2, true, 1},
{AddonRelType::candidate, 2, true, 2},
{AddonRelType::candidate, 2, false},
{AddonRelType::candidate, 21, false},
{AddonRelType::none}
});
// Check operator>() and operator!=()
SG_CHECK_GT(AddonVersionSuffix(AddonRelType::none),
AddonVersionSuffix(AddonRelType::candidate, 21, false));
SG_CHECK_NE(AddonVersionSuffix(AddonRelType::none),
AddonVersionSuffix(AddonRelType::candidate, 21, false));
// Check operator<=() and operator>=()
SG_CHECK_LE(AddonVersionSuffix(AddonRelType::candidate, 2, false),
AddonVersionSuffix(AddonRelType::candidate, 2, false));
SG_CHECK_LE(AddonVersionSuffix(AddonRelType::candidate, 2, false),
AddonVersionSuffix(AddonRelType::none));
SG_CHECK_GE(AddonVersionSuffix(AddonRelType::none),
AddonVersionSuffix(AddonRelType::none));
SG_CHECK_GE(AddonVersionSuffix(AddonRelType::none),
AddonVersionSuffix(AddonRelType::candidate, 21, false));
fgtest::shutdownTestGlobals();
}
void testAddonVersion()
{
using AddonRelType = AddonVersionSuffixPrereleaseType;
fgtest::initTestGlobals("AddonVersion");
AddonVersionSuffix suffix(AddonRelType::beta, 2, true, 5);
AddonVersion v1(2017, 4, 7, suffix);
AddonVersion v1Copy(v1);
AddonVersion v2 = v1;
AddonVersion v3(std::move(v1Copy));
AddonVersion v4 = std::move(v2);
SG_CHECK_EQUAL(v1, AddonVersion("2017.4.7b2.dev5"));
SG_CHECK_EQUAL(v1, AddonVersion(std::make_tuple(2017, 4, 7, suffix)));
SG_CHECK_EQUAL(v1, v3);
SG_CHECK_EQUAL(v1, v4);
SG_CHECK_LT(v1, AddonVersion("2017.4.7b2"));
SG_CHECK_LE(v1, AddonVersion("2017.4.7b2"));
SG_CHECK_LE(v1, v1);
SG_CHECK_GT(AddonVersion("2017.4.7b2"), v1);
SG_CHECK_GE(AddonVersion("2017.4.7b2"), v1);
SG_CHECK_GE(v1, v1);
SG_CHECK_NE(v1, AddonVersion("2017.4.7b3"));
SG_CHECK_EQUAL(v1.majorNumber(), 2017);
SG_CHECK_EQUAL(v1.minorNumber(), 4);
SG_CHECK_EQUAL(v1.patchLevel(), 7);
SG_CHECK_EQUAL(v1.suffix(), suffix);
// Round-trips std::string <-> AddonVersion
SG_CHECK_EQUAL(AddonVersion("2017.4.7.dev13").str(), "2017.4.7.dev13");
SG_CHECK_EQUAL(AddonVersion("2017.4.7a2.dev8").str(), "2017.4.7a2.dev8");
SG_CHECK_EQUAL(AddonVersion("2017.4.7a2").str(), "2017.4.7a2");
SG_CHECK_EQUAL(AddonVersion("2017.4.7b2.dev5").str(), "2017.4.7b2.dev5");
SG_CHECK_EQUAL(AddonVersion("2017.4.7b2").str(), "2017.4.7b2");
SG_CHECK_EQUAL(AddonVersion("2017.4.7rc1.dev3").str(), "2017.4.7rc1.dev3");
SG_CHECK_EQUAL(AddonVersion("2017.4.7rc1").str(), "2017.4.7rc1");
SG_CHECK_EQUAL(AddonVersion("2017.4.7").str(), "2017.4.7");
// Check stream output
std::ostringstream oss;
oss << AddonVersion("2017.4.7b2.dev5");
SG_CHECK_EQUAL(oss.str(), "2017.4.7b2.dev5");
// Check ordering with all types of transitions, using operator<()
auto checkStrictOrdering = [](const vector<AddonVersion>& v) {
assert(v.size() > 1);
for (std::size_t i=0; i < v.size() - 1; i++) {
SG_CHECK_LT(v[i], v[i+1]);
}
};
checkStrictOrdering({
"3.12.8.dev1", "3.12.8.dev2", "3.12.8.dev12", "3.12.8a1.dev1",
"3.12.8a1.dev2", "3.12.8a1", "3.12.8a2", "3.12.8b1.dev1",
"3.12.8b1.dev2", "3.12.8b1", "3.12.8b2", "3.12.8b10",
"3.12.8rc1.dev1", "3.12.8rc1.dev2", "3.12.8rc1.dev3",
"3.12.8rc1", "3.12.8rc2", "3.12.8rc3", "3.12.8", "3.12.9.dev1",
"3.12.9", "3.13.0", "4.0.0.dev1", "4.0.0.dev10", "4.0.0a1", "4.0.0",
"2017.4.0", "2017.4.1", "2017.4.10", "2017.5.0", "2018.0.0"});
fgtest::shutdownTestGlobals();
}
void testAddon()
{
Addon m;
std::string addonId = "org.FlightGear.addons.MyGreatAddon";
m.setId(addonId);
m.setVersion(AddonVersion("2017.2.5rc3"));
m.setBasePath(SGPath("/path/to/MyGreatAddon"));
m.setMinFGVersionRequired("2017.4.1");
m.setMaxFGVersionRequired("none");
SG_CHECK_EQUAL(m.getId(), addonId);
SG_CHECK_EQUAL(*m.getVersion(), AddonVersion("2017.2.5rc3"));
SG_CHECK_EQUAL(m.getBasePath(), SGPath("/path/to/MyGreatAddon"));
SG_CHECK_EQUAL(m.getMinFGVersionRequired(), "2017.4.1");
const string refText = "addon '" + addonId + "' (version = 2017.2.5rc3, "
"base path = '/path/to/MyGreatAddon', "
"minFGVersionRequired = '2017.4.1', "
"maxFGVersionRequired = 'none')";
SG_CHECK_EQUAL(m.str(), refText);
// Check stream output
std::ostringstream oss;
oss << m;
SG_CHECK_EQUAL(oss.str(), refText);
// Set a max FG version and recheck
m.setMaxFGVersionRequired("2018.2.5");
const string refText2 = "addon '" + addonId + "' (version = 2017.2.5rc3, "
"base path = '/path/to/MyGreatAddon', "
"minFGVersionRequired = '2017.4.1', "
"maxFGVersionRequired = '2018.2.5')";
SG_CHECK_EQUAL(m.getMaxFGVersionRequired(), "2018.2.5");
SG_CHECK_EQUAL(m.str(), refText2);
}
int main(int argc, const char* const* argv)
{
testAddonVersionSuffix();
testAddonVersion();
testAddon();
return EXIT_SUCCESS;
}
Copy permalink