tests/unit_tests/runtime/library_asset_test.cpp

#include <rive/file.hpp>
#include <rive/node.hpp>
#include <rive/nested_artboard.hpp>
#include <rive/shapes/clipping_shape.hpp>
#include <rive/shapes/rectangle.hpp>
#include <rive/assets/image_asset.hpp>
#include <rive/assets/font_asset.hpp>
#include <rive/animation/nested_simple_animation.hpp>
#include <rive/animation/nested_state_machine.hpp>
#include <rive/relative_local_asset_loader.hpp>
#include <rive/shapes/image.hpp>
#include <utils/no_op_factory.hpp>
#include <utils/no_op_renderer.hpp>
#include "rive_file_reader.hpp"
#include <catch.hpp>
#include <cstdio>

TEST_CASE("File with library artboard loads", "[libraries]")
{
    // created by library_import_export_test.dart in rive_core.
    auto file = ReadRiveFile("assets/library_export_test.riv");

    // Libraries are always exported before host files.
    // In this file, the first artboard (id=0) is the Artboard in the library
    // file. The nested artboard that instances it is in the second Artboard.
    auto nestedArtboard =
        file->artboard(1)->find<rive::NestedArtboard>("The nested artboard");
    REQUIRE(nestedArtboard != nullptr);
    REQUIRE(nestedArtboard->name() == "The nested artboard");
    REQUIRE(nestedArtboard->x() == 1);
    REQUIRE(nestedArtboard->y() == 2);
    REQUIRE(nestedArtboard->artboardId() == 0);

    auto artboard = file->artboard(0);
    REQUIRE(artboard->name() == "Rocket");
    REQUIRE(artboard->width() == 512);
    REQUIRE(artboard->height() == 513);

    // The library asset is not exported to runtime.
    auto assets = file->assets();
    REQUIRE(assets.size() == 0);
}

TEST_CASE("File with library animation loads", "[libraries]")
{
    // created by library_import_export_test.dart in rive_core.
    auto file = ReadRiveFile("assets/library_export_animation_test.riv");

    auto nestedArtboard =
        file->artboard(1)->find<rive::NestedArtboard>("The nested artboard");
    REQUIRE(nestedArtboard != nullptr);
    REQUIRE(nestedArtboard->name() == "The nested artboard");
    REQUIRE(nestedArtboard->x() == 1);
    REQUIRE(nestedArtboard->y() == 2);

    REQUIRE(nestedArtboard->artboardId() == 0);
    REQUIRE(file->artboard(0)->animationCount() == 1);
    auto simpleAnimation = file->artboard(0)->firstAnimation();
    REQUIRE(simpleAnimation->name() == "LA Rocket");

    auto nestedAnimations = nestedArtboard->nestedAnimations();
    REQUIRE(nestedAnimations.size() == 1);
    auto nestedSimpleAnimation = nestedAnimations[0];
    REQUIRE(nestedSimpleAnimation->name() == "");

    REQUIRE(nestedSimpleAnimation->animationId() == 0);
    REQUIRE(nestedArtboard->nestedAnimations().size() == 1);

    // The library asset is not exported to runtime.
    auto assets = file->assets();
    REQUIRE(assets.size() == 0);
}

TEST_CASE("File with library state machine loads", "[libraries]")
{
    // created by library_import_export_test.dart in rive_core.
    auto file = ReadRiveFile("assets/library_export_state_machine_test.riv");

    auto nestedArtboard =
        file->artboard(1)->find<rive::NestedArtboard>("The nested artboard");
    REQUIRE(nestedArtboard != nullptr);
    REQUIRE(nestedArtboard->name() == "The nested artboard");
    REQUIRE(nestedArtboard->x() == 1);
    REQUIRE(nestedArtboard->y() == 2);

    REQUIRE(nestedArtboard->artboardId() == 0);
    REQUIRE(file->artboard(0)->stateMachineCount() == 1);
    auto stateMachine = file->artboard(0)->firstStateMachine();
    REQUIRE(stateMachine->name() == "SM Rocket");

    auto nestedAnimations = nestedArtboard->nestedAnimations();
    REQUIRE(nestedAnimations.size() == 1);
    auto nestedStateMachine = nestedAnimations[0];
    REQUIRE(nestedStateMachine->name() == "");

    REQUIRE(nestedStateMachine->animationId() == 0);
    REQUIRE(nestedArtboard->nestedAnimations().size() == 1);

    // time to find the library asset somewhere
    // make sure its loaded?
    auto assets = file->assets();
    REQUIRE(assets.size() == 0);
}

// TODO reinstate, but right now we're missing fonts locally, need to get
// backend to uat to recreate this test. we are literally just loading files
// here. TEST_CASE("File with library", "[libraries]")
// {
//     TODO: create this file in the editor tests.
//     auto file = ReadRiveFile("assets/library_with_text_and_image.riv");

//     // library, image and text
//     auto assets = file->assets();
//     REQUIRE(assets.size() == 3);
//     auto libraryAsset = assets[0];
//     REQUIRE(libraryAsset->is<rive::LibraryAsset>());
//     REQUIRE(libraryAsset->name() == "library - Version 1");

//     auto fontAsset = assets[1];
//     REQUIRE(fontAsset->is<rive::FontAsset>());
//     REQUIRE(fontAsset->name() == "Inter");

//     auto imageAsset = assets[2];
//     REQUIRE(imageAsset->is<rive::ImageAsset>());
//     REQUIRE(imageAsset->name() == "tree");

//     // library, image and text
//     auto libraryAssets =
//         static_cast<rive::LibraryAsset*>(libraryAsset)->riveFile()->assets();
//     REQUIRE(libraryAssets.size() == 2);

//     auto librayFontAsset = libraryAssets[0];
//     REQUIRE(librayFontAsset->is<rive::FontAsset>());
//     REQUIRE(librayFontAsset->name() == "Inter");

//     auto libraryImageAsset = libraryAssets[1];
//     REQUIRE(libraryImageAsset->is<rive::ImageAsset>());
//     REQUIRE(libraryImageAsset->name() == "tree");
// }

// we are literally just loading files here.
TEST_CASE("File with library including image", "[libraries]")
{
    // created by library_import_export_test.dart in rive_core.
    auto file = ReadRiveFile("assets/library_with_image.riv");

    auto assets = file->assets();
    REQUIRE(assets.size() == 1);

    auto nestedArtboard =
        file->artboard(1)->find<rive::NestedArtboard>("The instance");
    REQUIRE(nestedArtboard != nullptr);

    auto sourceArtboard = nestedArtboard->sourceArtboard();
    REQUIRE(sourceArtboard != nullptr);

    auto images = sourceArtboard->find<rive::Image>();
    REQUIRE(images.size() == 1);
    REQUIRE(images[0]->assetId() == 0);
    REQUIRE(images[0]->imageAsset() != nullptr);
}

TEST_CASE("File with multiple libraries including image", "[libraries]")
{
    // created by library_import_export_test.dart in rive_core.
    auto file = ReadRiveFile("assets/double_library_with_image.riv");

    auto assets = file->assets();
    REQUIRE(assets.size() == 2);

    auto nestedArtboard1 =
        file->artboard(2)->find<rive::NestedArtboard>("The nested artboard");
    auto nestedArtboard2 = file->artboard(2)->find<rive::NestedArtboard>(
        "Another nested artboard");
    REQUIRE(nestedArtboard1 != nullptr);
    REQUIRE(nestedArtboard2 != nullptr);

    auto sourceArtboard1 = nestedArtboard1->sourceArtboard();
    REQUIRE(sourceArtboard1 != nullptr);
    auto images1 = sourceArtboard1->find<rive::Image>();
    REQUIRE(images1.size() == 1);
    REQUIRE(images1[0]->imageAsset() != nullptr);
    REQUIRE(images1[0]->imageAsset()->name() == "MyFirstImageAsset");

    auto sourceArtboard2 = nestedArtboard2->sourceArtboard();
    REQUIRE(sourceArtboard2 != nullptr);
    auto images2 = sourceArtboard2->find<rive::Image>();
    REQUIRE(images2.size() == 1);
    REQUIRE(images2[0]->imageAsset() != nullptr);
    REQUIRE(images2[0]->imageAsset()->name() == "MyOtherImageAsset");
}