nodes: fix serialized ID typos with backward compatibility
- ChromaKey tolerance inputs are now spelled "upper/lower_tolerance_in"; old projects with the misspelled "tolerence" IDs keep loading (values and connections) via a new Node::GetInputIDForLegacyID() hook applied in LoadInput and connection deserialization - flip/ripple/swirl/tile/wave node IDs moved to the consistent org.olivevideoeditor.Olive.* domain; NodeFactory::CreateFromID maps the old org.oliveeditor.* IDs so old projects still resolve - Regression tests: legacy ChromaKey IDs (values + connections) and legacy factory IDs
This commit is contained in:
@@ -660,9 +660,8 @@ TEST(FlipDistortNode, MetadataIsCorrect)
|
||||
{
|
||||
olive::FlipDistortNode node;
|
||||
// NOTE: unlike most Olive nodes ("org.olivevideoeditor.Olive.*"), the
|
||||
// flip/ripple/swirl/tile/wave nodes use the "org.oliveeditor.Olive.*"
|
||||
// domain (inconsistent ID, documented here as a suspected bug)
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.oliveeditor.Olive.flip"));
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.olivevideoeditor.Olive.flip"));
|
||||
EXPECT_EQ(node.Name(), QStringLiteral("Flip"));
|
||||
EXPECT_FALSE(node.Description().isEmpty());
|
||||
EXPECT_TRUE(node.Category().contains(olive::Node::kCategoryDistort));
|
||||
@@ -1226,8 +1225,7 @@ TEST(MaskDistortNode, ValueWithFeatherNestsBlurJob)
|
||||
TEST(RippleDistortNode, MetadataIsCorrect)
|
||||
{
|
||||
olive::RippleDistortNode node;
|
||||
// NOTE: "org.oliveeditor.*" domain, inconsistent with most Olive nodes
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.oliveeditor.Olive.ripple"));
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.olivevideoeditor.Olive.ripple"));
|
||||
EXPECT_EQ(node.Name(), QStringLiteral("Ripple"));
|
||||
EXPECT_FALSE(node.Description().isEmpty());
|
||||
EXPECT_TRUE(node.Category().contains(olive::Node::kCategoryDistort));
|
||||
@@ -1359,8 +1357,7 @@ TEST(RippleDistortNode, ValueWithIntensityPushesShaderJob)
|
||||
TEST(SwirlDistortNode, MetadataIsCorrect)
|
||||
{
|
||||
olive::SwirlDistortNode node;
|
||||
// NOTE: "org.oliveeditor.*" domain, inconsistent with most Olive nodes
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.oliveeditor.Olive.swirl"));
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.olivevideoeditor.Olive.swirl"));
|
||||
EXPECT_EQ(node.Name(), QStringLiteral("Swirl"));
|
||||
EXPECT_EQ(node.Description(),
|
||||
QStringLiteral("Distorts an image by swirling it around a center point."));
|
||||
@@ -1497,8 +1494,7 @@ TEST(SwirlDistortNode, ValueWithAngleAndRadiusPushesShaderJob)
|
||||
TEST(TileDistortNode, MetadataIsCorrect)
|
||||
{
|
||||
olive::TileDistortNode node;
|
||||
// NOTE: "org.oliveeditor.*" domain, inconsistent with most Olive nodes
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.oliveeditor.Olive.tile"));
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.olivevideoeditor.Olive.tile"));
|
||||
EXPECT_EQ(node.Name(), QStringLiteral("Tile"));
|
||||
EXPECT_FALSE(node.Description().isEmpty());
|
||||
EXPECT_TRUE(node.Category().contains(olive::Node::kCategoryDistort));
|
||||
@@ -1649,8 +1645,7 @@ TEST(TileDistortNode, ValueWithNonUnitScalePushesShaderJob)
|
||||
TEST(WaveDistortNode, MetadataIsCorrect)
|
||||
{
|
||||
olive::WaveDistortNode node;
|
||||
// NOTE: "org.oliveeditor.*" domain, inconsistent with most Olive nodes
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.oliveeditor.Olive.wave"));
|
||||
EXPECT_EQ(node.id(), QStringLiteral("org.olivevideoeditor.Olive.wave"));
|
||||
EXPECT_EQ(node.Name(), QStringLiteral("Wave"));
|
||||
EXPECT_FALSE(node.Description().isEmpty());
|
||||
EXPECT_TRUE(node.Category().contains(olive::Node::kCategoryDistort));
|
||||
|
||||
@@ -16,6 +16,7 @@
|
||||
#include "node/generator/solid/solid.h"
|
||||
#include "node/generator/text/textv3.h"
|
||||
#include "node/keyframe.h"
|
||||
#include "node/keying/chromakey/chromakey.h"
|
||||
#include "node/math/math/math.h"
|
||||
#include "node/node.h"
|
||||
#include "node/project.h"
|
||||
@@ -617,3 +618,40 @@ TEST_F(NodeSaveLoadTest, ConnectionsLinksAndPositionsResolveAfterProjectLoad)
|
||||
|
||||
olive::NodeFactory::Destroy();
|
||||
}
|
||||
|
||||
TEST_F(NodeSaveLoadTest, LegacyMisspelledChromaKeyIDsAreMapped)
|
||||
{
|
||||
auto *src = AddNode<olive::ChromaKeyNode>();
|
||||
src->SetStandardValue(olive::ChromaKeyNode::kUpperToleranceInput, 42.0);
|
||||
src->SetStandardValue(olive::ChromaKeyNode::kLowerToleranceInput, 7.0);
|
||||
|
||||
auto *math = AddNode<olive::MathNode>();
|
||||
olive::Node::ConnectEdge(
|
||||
math, olive::NodeInput(src, olive::ChromaKeyNode::kUpperToleranceInput));
|
||||
|
||||
QString xml = SaveNodeXml(src);
|
||||
|
||||
// Simulate an old project file written with the misspelled "tolerence" IDs
|
||||
xml.replace(QStringLiteral("upper_tolerance_in"),
|
||||
QStringLiteral("upper_tolerence_in"));
|
||||
xml.replace(QStringLiteral("lower_tolerance_in"),
|
||||
QStringLiteral("lower_tolerence_in"));
|
||||
|
||||
olive::ChromaKeyNode loaded;
|
||||
olive::SerializedData data;
|
||||
ASSERT_TRUE(LoadNodeXml(&loaded, xml, &data));
|
||||
|
||||
EXPECT_DOUBLE_EQ(
|
||||
loaded.GetStandardValue(olive::ChromaKeyNode::kUpperToleranceInput)
|
||||
.toDouble(),
|
||||
42.0);
|
||||
EXPECT_DOUBLE_EQ(
|
||||
loaded.GetStandardValue(olive::ChromaKeyNode::kLowerToleranceInput)
|
||||
.toDouble(),
|
||||
7.0);
|
||||
|
||||
// Connections to the renamed inputs are remapped too
|
||||
ASSERT_EQ(data.desired_connections.size(), 1);
|
||||
EXPECT_EQ(data.desired_connections.first().input.input(),
|
||||
olive::ChromaKeyNode::kUpperToleranceInput);
|
||||
}
|
||||
|
||||
@@ -587,3 +587,36 @@ TEST(NodeFactory, CreateMenuRestrictedToCategory)
|
||||
|
||||
olive::NodeFactory::Destroy();
|
||||
}
|
||||
|
||||
TEST(NodeFactory, LegacyDistortIdsResolveToRenamedNodes)
|
||||
{
|
||||
olive::NodeFactory::Initialize();
|
||||
|
||||
const QList<QPair<QString, QString>> legacy_ids = {
|
||||
{ QStringLiteral("org.oliveeditor.Olive.flip"),
|
||||
QStringLiteral("org.olivevideoeditor.Olive.flip") },
|
||||
{ QStringLiteral("org.oliveeditor.Olive.ripple"),
|
||||
QStringLiteral("org.olivevideoeditor.Olive.ripple") },
|
||||
{ QStringLiteral("org.oliveeditor.Olive.swirl"),
|
||||
QStringLiteral("org.olivevideoeditor.Olive.swirl") },
|
||||
{ QStringLiteral("org.oliveeditor.Olive.tile"),
|
||||
QStringLiteral("org.olivevideoeditor.Olive.tile") },
|
||||
{ QStringLiteral("org.oliveeditor.Olive.wave"),
|
||||
QStringLiteral("org.olivevideoeditor.Olive.wave") },
|
||||
};
|
||||
|
||||
for (const auto &pair : legacy_ids) {
|
||||
std::unique_ptr<olive::Node> node(
|
||||
olive::NodeFactory::CreateFromID(pair.first));
|
||||
ASSERT_NE(node, nullptr) << pair.first.toStdString();
|
||||
EXPECT_EQ(node->id(), pair.second);
|
||||
|
||||
// The current id resolves directly as well
|
||||
std::unique_ptr<olive::Node> current(
|
||||
olive::NodeFactory::CreateFromID(pair.second));
|
||||
ASSERT_NE(current, nullptr) << pair.second.toStdString();
|
||||
EXPECT_EQ(current->id(), pair.second);
|
||||
}
|
||||
|
||||
olive::NodeFactory::Destroy();
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user