Files
o3de/Code/Framework/AzFramework/Tests/AssetCatalog.cpp
T
lumberyard-employee-dm b3b646dad9 Moved the Asset Catalog loading from LmbrCentral to the AzFramework::Application (#4568)
* Moved the loading of the AssetCatalog from LmbrCentralSystemComponent to AzFramework Application

Modified the AssetCatalog::InitializeCatalog function to no longer rely on the TickBus to send out the `AssetCatalogEventBus::OnCatalogLoaded` event.
It now queues a function on the AssetCatalogRequestBus to send the OnCatalogLoaded event as soon as the dispatching for the AssetCatalogRequestBus has completed on the current thread.
This is done by updating the AssetCatalogRequestBus to use EBus ThreadDispatchPolicy to add a callback to invoke any queued function has soon a thread has finished dispatching and has released its DispatchMutex

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Updated the AssetCatalogRequestBus to add a custom DispatchLockGuard

The AssetCatalogRequestBus uses the custom lock guard to dispatch queued
events after it has unlocked it's context mutex for the current thread.

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Removed GetContext call from the
AssetCatalogRequests::PostThreadDispatchInvoker

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Updated the definition of FileTagQueryManager::GetDefaultFileTagFilePath
function to return a path

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Updated the AZ_CONSOLEFREEFUNC macro to actually use the _NAME

The _NAME parameter was not being used before, resulting in the Console
stringified name of the function being used.

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Removed CrySystem dependencies from the BundlingSystemComponent

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Moved the loading of the AssetCatalog from LmbrCentralSystemComponent to AzFramework Application

Modified the AssetCatalog::InitializeCatalog function to no longer rely on the TickBus to send out the `AssetCatalogEventBus::OnCatalogLoaded` event.
It now queues a function on the AssetCatalogRequestBus to send the OnCatalogLoaded event as soon as the dispatching for the AssetCatalogRequestBus has completed on the current thread.
This is done by updating the AssetCatalogRequestBus to use EBus ThreadDispatchPolicy to add a callback to invoke any queued function has soon a thread has finished dispatching and has released its DispatchMutex

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Updated the AssetCatalogRequestBus to add a custom DispatchLockGuard

The AssetCatalogRequestBus uses the custom lock guard to dispatch queued
events after it has unlocked it's context mutex for the current thread.

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Removed GetContext call from the
AssetCatalogRequests::PostThreadDispatchInvoker

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Updated the definition of FileTagQueryManager::GetDefaultFileTagFilePath
function to return a path

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Updated the AZ_CONSOLEFREEFUNC macro to actually use the _NAME

The _NAME parameter was not being used before, resulting in the Console
stringified name of the function being used.

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Removed CrySystem dependencies from the BundlingSystemComponent

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Addded missing template parameter to AssetCatalogRequests

The fixes the compile error.

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Adding AssetBus::MultiHandler::BusDisconnect call

The BlastSystemComponent was connecting to the Bus, but not
disconnecting from it, causing an assert to fire to it being a
multi-thread bus

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Added support for DataDrive lifecycle events to the ComponentApplication

The events are using the SettingsRegistry NotifyEvent to track when
certain keys are modified to signal handlers.

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Corrected invalid JSON creation in ModuleManager::DeactivateEntities

Resolved clang warning about used type alias

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Fix for dangling reference in lambda registered to the SettingsRegistry
Notifier event

This was causing the EditorPythonBinding tests to crash due to the
following circumstances.

First Python has created an instance of a SettingsRegistryProxy
Second the SettingsRegistry sends an event during the time when the
SettingsRegistryProxy exists.

This issue was exposed due to the ComponentApplication Lifecycle events
using the SettingsRegistry to dispatch during various times of the
application workflow.

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>
2021-10-26 10:31:31 -05:00

1147 lines
54 KiB
C++

/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#include <FileIOBaseTestTypes.h>
#include <AzCore/Asset/AssetManagerBus.h>
#include <AzCore/Asset/AssetTypeInfoBus.h>
#include <AzCore/Component/TickBus.h>
#include <AzCore/Interface/Interface.h>
#include <AzCore/IO/Streamer/Streamer.h>
#include <AzCore/IO/Streamer/StreamerComponent.h>
#include <AzCore/Jobs/JobManager.h>
#include <AzCore/Jobs/JobContext.h>
#include <AzCore/Math/Uuid.h>
#include <AzCore/Memory/Memory.h>
#include <AzCore/Memory/PoolAllocator.h>
#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
#include <AzCore/std/containers/vector.h>
#include <AzCore/UnitTest/TestTypes.h>
#include <AzCore/UserSettings/UserSettingsComponent.h>
#include <AzFramework/Asset/AssetCatalog.h>
#include <AzFramework/Asset/AssetProcessorMessages.h>
#include <AzFramework/Asset/GenericAssetHandler.h>
#include <AzFramework/Asset/NetworkAssetNotification_private.h>
#include <AzFramework/Application/Application.h>
#include <AzFramework/StringFunc/StringFunc.h>
#include "AZTestShared/Utils/Utils.h"
using namespace AZStd;
using namespace AZ::Data;
namespace UnitTest
{
namespace
{
AssetId asset1;
AssetId asset2;
AssetId asset3;
AssetId asset4;
AssetId asset5;
bool Search(const AZStd::vector<AZ::Data::ProductDependency>& dependencies, const AZ::Data::AssetId& assetId)
{
for (const auto& dependency : dependencies)
{
if (dependency.m_assetId == assetId)
{
return true;
}
}
return false;
}
}
class AssetCatalogDependencyTest
: public AllocatorsFixture
{
AzFramework::AssetCatalog* m_assetCatalog;
public:
const char* path1 = "SomeFolder/Asset1Path";
const char* path2 = "SomeFolder/Asset2Path";
const char* path3 = "OtherFolder/Asset3Path";
const char* path4 = "OtherFolder/Asset4Path";
const char* path5 = "OtherFolder/Asset5Path";
void SetUp() override
{
AllocatorsFixture::SetUp();
AZ::AllocatorInstance<AZ::PoolAllocator>::Create();
AZ::AllocatorInstance<AZ::ThreadPoolAllocator>::Create();
AZ::Data::AssetManager::Descriptor desc;
AZ::Data::AssetManager::Create(desc);
m_assetCatalog = aznew AzFramework::AssetCatalog();
m_assetCatalog->StartMonitoringAssets();
AzFramework::AssetSystem::NetworkAssetUpdateInterface* notificationInterface = AZ::Interface<AzFramework::AssetSystem::NetworkAssetUpdateInterface>::Get();
ASSERT_NE(notificationInterface, nullptr);
asset1 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset2 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset3 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset4 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset5 = AssetId(AZ::Uuid::CreateRandom(), 0);
AZ::Data::AssetInfo info1, info2, info3, info4, info5;
info1.m_relativePath = path1;
info1.m_sizeBytes = 1; // Need to initialize m_sizeBytes to non-zero number to avoid a FileIO call
info2.m_relativePath = path2;
info2.m_sizeBytes = 1;
info3.m_relativePath = path3;
info3.m_sizeBytes = 1;
info4.m_relativePath = path4;
info4.m_sizeBytes = 1;
info5.m_relativePath = path5;
info5.m_sizeBytes = 1;
// asset1 -> asset2 -> asset3 -> asset5
// --> asset4
{
m_assetCatalog->RegisterAsset(asset1, info1);
AzFramework::AssetSystem::AssetNotificationMessage message("test", AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset1;
message.m_dependencies.emplace_back(asset2, 0);
notificationInterface->AssetChanged(message);
}
{
m_assetCatalog->RegisterAsset(asset2, info2);
AzFramework::AssetSystem::AssetNotificationMessage message("test", AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset2;
message.m_dependencies.emplace_back(asset3, 0);
message.m_dependencies.emplace_back(asset4, 0);
notificationInterface->AssetChanged(message);
}
{
m_assetCatalog->RegisterAsset(asset3, info3);
AzFramework::AssetSystem::AssetNotificationMessage message("test", AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset3;
message.m_dependencies.emplace_back(asset5, 0);
notificationInterface->AssetChanged(message);
}
{
m_assetCatalog->RegisterAsset(asset4, info4);
AzFramework::AssetSystem::AssetNotificationMessage message("test", AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset4;
notificationInterface->AssetChanged(message);
}
{
m_assetCatalog->RegisterAsset(asset5, info5);
AzFramework::AssetSystem::AssetNotificationMessage message("test", AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset5;
notificationInterface->AssetChanged(message);
}
}
void TearDown() override
{
delete m_assetCatalog;
AzFramework::LegacyAssetEventBus::ClearQueuedEvents();
AZ::TickBus::ClearQueuedEvents();
AssetManager::Destroy();
AZ::AllocatorInstance<AZ::ThreadPoolAllocator>::Destroy();
AZ::AllocatorInstance<AZ::PoolAllocator>::Destroy();
AllocatorsFixture::TearDown();
}
void CheckDirectDependencies(AssetId assetId, AZStd::initializer_list<AssetId> expectedDependencies)
{
AZ::Outcome<AZStd::vector<AZ::Data::ProductDependency>, AZStd::string> result = AZ::Failure<AZStd::string>("No response");
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::GetDirectProductDependencies, assetId);
EXPECT_TRUE(result.IsSuccess());
auto& actualDependencies = result.GetValue();
EXPECT_TRUE(actualDependencies.size() == actualDependencies.size());
for (const auto& dependency : expectedDependencies)
{
EXPECT_TRUE(Search(actualDependencies, dependency));
}
}
void CheckAllDependencies(AssetId assetId, AZStd::initializer_list<AssetId> expectedDependencies)
{
AZ::Outcome<AZStd::vector<AZ::Data::ProductDependency>, AZStd::string> result = AZ::Failure<AZStd::string>("No response");
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::GetAllProductDependencies, assetId);
EXPECT_TRUE(result.IsSuccess());
auto& actualDependencies = result.GetValue();
EXPECT_TRUE(actualDependencies.size() == actualDependencies.size());
for (const auto& dependency : expectedDependencies)
{
EXPECT_TRUE(Search(actualDependencies, dependency));
}
}
void CheckAllDependenciesFilter(AssetId assetId, const AZStd::unordered_set<AssetId>& filterSet, const AZStd::vector<AZStd::string>& wildcardList, AZStd::initializer_list<AssetId> expectedDependencies)
{
AZ::Outcome<AZStd::vector<AZ::Data::ProductDependency>, AZStd::string> result = AZ::Failure<AZStd::string>("No response");
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::GetAllProductDependenciesFilter, assetId, filterSet, wildcardList);
EXPECT_TRUE(result.IsSuccess());
auto& actualDependencies = result.GetValue();
EXPECT_TRUE(actualDependencies.size() == actualDependencies.size());
for (const auto& dependency : expectedDependencies)
{
EXPECT_TRUE(Search(actualDependencies, dependency));
}
}
};
TEST_F(AssetCatalogDependencyTest, directDependencies)
{
CheckDirectDependencies(asset1, { asset2 });
CheckDirectDependencies(asset2, { asset3, asset4 });
CheckDirectDependencies(asset3, { asset5 });
CheckDirectDependencies(asset4, { });
CheckDirectDependencies(asset5, { });
}
TEST_F(AssetCatalogDependencyTest, allDependencies)
{
CheckAllDependencies(asset1, { asset2, asset3, asset4, asset5 });
CheckAllDependencies(asset2, { asset3, asset4, asset5 });
CheckAllDependencies(asset3, { asset5 });
CheckAllDependencies(asset4, {});
CheckAllDependencies(asset5, {});
}
TEST_F(AssetCatalogDependencyTest, allDependenciesFilter_AssetIdFilter)
{
CheckAllDependenciesFilter(asset1, { asset2 }, { }, { });
CheckAllDependenciesFilter(asset1, { asset3 }, { }, { asset2 });
CheckAllDependenciesFilter(asset1, { asset5 }, { }, { asset2, asset3, asset4 });
CheckAllDependenciesFilter(asset1, { asset4, asset5 }, { }, { asset2, asset3 });
}
TEST_F(AssetCatalogDependencyTest, allDependenciesFilter_WildcardFilter)
{
CheckAllDependenciesFilter(asset1, { }, { "*/*" }, { });
CheckAllDependenciesFilter(asset1, { }, { "*/Asset?Path" }, {});
CheckAllDependenciesFilter(asset1, { }, { "other*" }, { asset2 });
CheckAllDependenciesFilter(asset1, { }, { "*4*" }, { asset2, asset3, asset5 });
CheckAllDependenciesFilter(asset1, { }, { "*4*", "*5*" }, { asset2, asset3 });
}
TEST_F(AssetCatalogDependencyTest, allDependenciesFilter_AssetIdAndWildcardFilter)
{
CheckAllDependenciesFilter(asset1, { asset5 }, { "*4*" }, { asset2, asset3 });
}
TEST_F(AssetCatalogDependencyTest, unregisterTest)
{
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset4);
CheckDirectDependencies(asset2, { asset3 });
CheckAllDependencies(asset1, { asset2, asset3, asset5 });
}
class AssetCatalogDeltaTest :
public ::testing::Test
{
public:
const char* path1 = "Asset1Path";
const char* path2 = "Asset2Path";
const char* path3 = "Asset3Path";
const char* path4 = "Asset4Path";
const char* path5 = "Asset5Path";
const char* path6 = "Asset6Path";
char sourceCatalogPath1[AZ_MAX_PATH_LEN];
char sourceCatalogPath2[AZ_MAX_PATH_LEN];
char sourceCatalogPath3[AZ_MAX_PATH_LEN];
char baseCatalogPath[AZ_MAX_PATH_LEN];
char deltaCatalogPath[AZ_MAX_PATH_LEN];
char deltaCatalogPath2[AZ_MAX_PATH_LEN];
char deltaCatalogPath3[AZ_MAX_PATH_LEN];
AZStd::vector<AZStd::string> deltaCatalogFiles;
AZStd::vector<AZStd::string> deltaCatalogFiles2;
AZStd::vector<AZStd::string> deltaCatalogFiles3;
AZStd::shared_ptr<AzFramework::AssetRegistry> baseCatalog;
AZStd::shared_ptr<AzFramework::AssetRegistry> deltaCatalog;
AZStd::shared_ptr<AzFramework::AssetRegistry> deltaCatalog2;
AZStd::shared_ptr<AzFramework::AssetRegistry> deltaCatalog3;
AZStd::unique_ptr<AzFramework::Application> m_app;
void SetUp() override
{
AZ::AllocatorInstance<AZ::SystemAllocator>::Create();
m_app.reset(aznew AzFramework::Application());
AZ::ComponentApplication::Descriptor desc;
desc.m_useExistingAllocator = true;
AZ::SettingsRegistryInterface* registry = AZ::SettingsRegistry::Get();
auto projectPathKey =
AZ::SettingsRegistryInterface::FixedValueString(AZ::SettingsRegistryMergeUtils::BootstrapSettingsRootKey) + "/project_path";
registry->Set(projectPathKey, "AutomatedTesting");
AZ::SettingsRegistryMergeUtils::MergeSettingsToRegistry_AddRuntimeFilePaths(*registry);
AZ::ComponentApplication::StartupParameters startupParameters;
startupParameters.m_loadAssetCatalog = false;
m_app->Start(desc, startupParameters);
// Without this, the user settings component would attempt to save on finalize/shutdown. Since the file is
// shared across the whole engine, if multiple tests are run in parallel, the saving could cause a crash
// in the unit tests.
AZ::UserSettingsComponentRequestBus::Broadcast(&AZ::UserSettingsComponentRequests::DisableSaveOnFinalize);
asset1 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset2 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset3 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset4 = AssetId(AZ::Uuid::CreateRandom(), 0);
asset5 = AssetId(AZ::Uuid::CreateRandom(), 0);
azstrcpy(sourceCatalogPath1, AZ_MAX_PATH_LEN,(GetTestFolderPath() + "AssetCatalogSource1.xml").c_str());
azstrcpy(sourceCatalogPath2, AZ_MAX_PATH_LEN,(GetTestFolderPath() + "AssetCatalogSource2.xml").c_str());
azstrcpy(sourceCatalogPath3, AZ_MAX_PATH_LEN,(GetTestFolderPath() + "AssetCatalogSource3.xml").c_str());
azstrcpy(baseCatalogPath, AZ_MAX_PATH_LEN, (GetTestFolderPath() + "AssetCatalogBase.xml").c_str());
azstrcpy(deltaCatalogPath, AZ_MAX_PATH_LEN, (GetTestFolderPath() + "AssetCatalogDelta.xml").c_str());
azstrcpy(deltaCatalogPath2, AZ_MAX_PATH_LEN, (GetTestFolderPath() + "AssetCatalogDelta2.xml").c_str());
azstrcpy(deltaCatalogPath3, AZ_MAX_PATH_LEN, (GetTestFolderPath() + "AssetCatalogDelta3.xml").c_str());
AZ::Data::AssetInfo info1, info2, info3, info4, info5, info6;
info1.m_relativePath = path1;
info2.m_relativePath = path2;
info3.m_relativePath = path3;
info4.m_relativePath = path4;
info5.m_relativePath = path5;
info6.m_relativePath = path6;
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset1, info1);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset2, info2);
// baseCatalog - asset1 path1, asset2 path2
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::SaveCatalog, baseCatalogPath);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset1, info3);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset4, info4);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::StartMonitoringAssets);
AzFramework::AssetSystem::NetworkAssetUpdateInterface* notificationInterface = AZ::Interface<AzFramework::AssetSystem::NetworkAssetUpdateInterface>::Get();
ASSERT_NE(notificationInterface, nullptr);
{
AzFramework::AssetSystem::AssetNotificationMessage message(path3, AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset1;
message.m_dependencies.push_back(AZ::Data::ProductDependency(asset2, 0));
notificationInterface->AssetChanged(message);
}
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::StopMonitoringAssets);
// sourcecatalog1 - asset1 path3 (depends on asset 2), asset2 path2, asset4 path4
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::SaveCatalog, sourceCatalogPath1);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset2);
// deltacatalog - asset1 path3 (depends on asset 2), asset4 path4
deltaCatalogFiles.push_back(path3);
deltaCatalogFiles.push_back(path4);
// deltacatalog - asset1 path3, asset4 path4
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::SaveCatalog, deltaCatalogPath);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset2, info2);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset5, info5);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::StartMonitoringAssets);
{
AzFramework::AssetSystem::AssetNotificationMessage message(path5, AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset5;
message.m_dependencies.push_back(AZ::Data::ProductDependency(asset2, 0));
notificationInterface->AssetChanged(message);
}
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::StopMonitoringAssets);
// sourcecatalog2 - asset1 path3 (depends on asset 2), asset2 path2, asset4 path4, asset5 path5 (depends on asset 2)
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::SaveCatalog, sourceCatalogPath2);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset1);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset2);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset4);
// deltacatalog2 - asset5 path5 (depends on asset 2)
deltaCatalogFiles2.push_back(path5);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::SaveCatalog, deltaCatalogPath2);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset1, info6);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset2, info2);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RegisterAsset, asset5, info4);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::StartMonitoringAssets);
{
AzFramework::AssetSystem::AssetNotificationMessage message(path4, AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = asset5;
message.m_dependencies.push_back(AZ::Data::ProductDependency(asset2, 0));
notificationInterface->AssetChanged(message);
}
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::StopMonitoringAssets);
//sourcecatalog3 - asset1 path6, asset2 path2, asset5 path4 (depends on asset 2)
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::SaveCatalog, sourceCatalogPath3);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset2);
// deltacatalog3 - asset1 path6 asset5 path4 (depends on asset 2)
deltaCatalogFiles3.push_back(path6);
deltaCatalogFiles3.push_back(path4);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::SaveCatalog, deltaCatalogPath3);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset1);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::UnregisterAsset, asset5);
baseCatalog = AzFramework::AssetCatalog::LoadCatalogFromFile(baseCatalogPath);
deltaCatalog = AzFramework::AssetCatalog::LoadCatalogFromFile(deltaCatalogPath);
deltaCatalog2 = AzFramework::AssetCatalog::LoadCatalogFromFile(deltaCatalogPath2);
deltaCatalog3 = AzFramework::AssetCatalog::LoadCatalogFromFile(deltaCatalogPath3);
}
void TearDown() override
{
deltaCatalogFiles.set_capacity(0);
deltaCatalogFiles2.set_capacity(0);
deltaCatalogFiles3.set_capacity(0);
baseCatalog.reset();
deltaCatalog.reset();
deltaCatalog2.reset();
deltaCatalog3.reset();
m_app->Stop();
m_app.reset();
AZ::AllocatorInstance<AZ::SystemAllocator>::Destroy();
}
void CheckDirectDependencies(AssetId assetId, AZStd::initializer_list<AssetId> expectedDependencies)
{
AZ::Outcome<AZStd::vector<AZ::Data::ProductDependency>, AZStd::string> result = AZ::Failure<AZStd::string>("No response");
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::GetDirectProductDependencies, assetId);
EXPECT_TRUE(result.IsSuccess());
auto& actualDependencies = result.GetValue();
EXPECT_TRUE(actualDependencies.size() == actualDependencies.size());
for (const auto& dependency : expectedDependencies)
{
EXPECT_TRUE(Search(actualDependencies, dependency));
}
}
void CheckNoDependencies(AssetId assetId)
{
AZ::Outcome<AZStd::vector<AZ::Data::ProductDependency>, AZStd::string> result = AZ::Failure<AZStd::string>("No response");
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::GetDirectProductDependencies, assetId);
EXPECT_FALSE(result.IsSuccess());
}
};
TEST_F(AssetCatalogDeltaTest, LoadCatalog_AssetChangedCatalogLoaded_AssetStillKnown)
{
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::StartMonitoringAssets);
auto updatedAsset = AssetId(AZ::Uuid::CreateRandom(), 0);
AzFramework::AssetSystem::NetworkAssetUpdateInterface* notificationInterface = AZ::Interface<AzFramework::AssetSystem::NetworkAssetUpdateInterface>::Get();
ASSERT_NE(notificationInterface, nullptr);
{
AzFramework::AssetSystem::AssetNotificationMessage message("test", AzFramework::AssetSystem::AssetNotificationMessage::AssetChanged, AZ::Uuid::CreateRandom(), "");
message.m_assetId = updatedAsset;
message.m_dependencies.emplace_back(asset2, 0);
notificationInterface->AssetChanged(message);
}
AZ::Data::AssetInfo assetInfo;
AssetCatalogRequestBus::BroadcastResult(assetInfo, &AssetCatalogRequestBus::Events::GetAssetInfoById, updatedAsset);
EXPECT_TRUE(assetInfo.m_assetId.IsValid());
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, baseCatalogPath);
//Asset should still be known - the catalog should swap in the new catalog from disk
AssetCatalogRequestBus::BroadcastResult(assetInfo, &AssetCatalogRequestBus::Events::GetAssetInfoById, updatedAsset);
EXPECT_TRUE(assetInfo.m_assetId.IsValid());
}
TEST_F(AssetCatalogDeltaTest, DeltaCatalogTest)
{
AZStd::string assetPath;
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, "");
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, baseCatalogPath);
// Topmost should have precedence
// baseCatalog path1 path2
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path1);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
CheckNoDependencies(asset1);
CheckNoDependencies(asset2);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::AddDeltaCatalog, deltaCatalog);
// deltacatalog path3 path4
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::AddDeltaCatalog, deltaCatalog2);
// deltacatalog2 path5
// deltacatalog path3 path4
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RemoveDeltaCatalog, deltaCatalog);
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path1);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset3);
EXPECT_EQ(assetPath, "");
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckNoDependencies(asset1);
CheckNoDependencies(asset2);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::AddDeltaCatalog, deltaCatalog);
// deltacatalog path3 path4
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::InsertDeltaCatalog, deltaCatalog3, 0);
// deltacatalog path3 path4
// deltacatalog2 path5
// deltacatalog3 path6 path4
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RemoveDeltaCatalog, deltaCatalog3);
// deltacatalog path3 path4
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::InsertDeltaCatalog, deltaCatalog3, 1);
// deltacatalog path3 path4
// deltacatalog3 path6 path4
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path4);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RemoveDeltaCatalog, baseCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::InsertDeltaCatalog, baseCatalog, 3);
/// baseCatalog path1 path2
// deltacatalog path3 path4
// deltacatalog3 path6 path4
// deltacatalog2 path5
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path1);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset3);
EXPECT_EQ(assetPath, "");
CheckNoDependencies(asset1);
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
}
TEST_F(AssetCatalogDeltaTest, DeltaCatalogTest_AddDeltaCatalogNext_Success)
{
AZStd::string assetPath;
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, "");
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, baseCatalogPath);
// Topmost should have precedence
// baseCatalog path1 path2
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path1);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
CheckNoDependencies(asset1);
CheckNoDependencies(asset2);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::AddDeltaCatalog, deltaCatalog);
// deltacatalog path3 path4
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::AddDeltaCatalog, deltaCatalog2);
// deltacatalog2 path5
// deltacatalog path3 path4
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RemoveDeltaCatalog, deltaCatalog);
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path1);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset3);
EXPECT_EQ(assetPath, "");
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckNoDependencies(asset1);
CheckNoDependencies(asset2);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::AddDeltaCatalog, deltaCatalog);
// deltacatalog path3 path4
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::InsertDeltaCatalogBefore, deltaCatalog3, deltaCatalog2);
// deltacatalog path3 path4
// deltacatalog2 path5
// deltacatalog3 path6 path4
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RemoveDeltaCatalog, deltaCatalog3);
// deltacatalog path3 path4
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::InsertDeltaCatalogBefore, deltaCatalog3, deltaCatalog);
// deltacatalog path3 path4
// deltacatalog3 path6 path4
// deltacatalog2 path5
/// baseCatalog path1 path2
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path4);
CheckDirectDependencies(asset1, { asset2 });
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::RemoveDeltaCatalog, baseCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::AddDeltaCatalog, baseCatalog);
/// baseCatalog path1 path2
// deltacatalog path3 path4
// deltacatalog3 path6 path4
// deltacatalog2 path5
/// asset1 asset2 asset3 asset4 asset5
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path1);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, path2);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset3);
EXPECT_EQ(assetPath, "");
CheckNoDependencies(asset1);
CheckNoDependencies(asset2);
CheckNoDependencies(asset4);
CheckDirectDependencies(asset5, { asset2 });
}
TEST_F(AssetCatalogDeltaTest, DeltaCatalogCreationTest)
{
bool result = false;
AZStd::string assetPath;
// load source catalog 1
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, sourceCatalogPath1);
// generate delta catalog 1
AZStd::string testDeltaCatalogPath1 = GetTestFolderPath() + "TestAssetCatalogDelta.xml";
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::CreateDeltaCatalog, deltaCatalogFiles, testDeltaCatalogPath1);
EXPECT_TRUE(result);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, testDeltaCatalogPath1.c_str());
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path3);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset4);
EXPECT_EQ(assetPath, path4);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, "");
// check against depenency info
CheckDirectDependencies(asset1, { asset2 });
// load source catalog 2
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, sourceCatalogPath2);
// generate delta catalog 3
AZStd::string testDeltaCatalogPath2 = GetTestFolderPath() + "TestAssetCatalogDelta2.xml";
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::CreateDeltaCatalog, deltaCatalogFiles2, testDeltaCatalogPath2);
EXPECT_TRUE(result);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, testDeltaCatalogPath2.c_str());
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path5);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, "");
// check against dependency info
CheckDirectDependencies(asset5, { asset2 });
// load source catalog 3
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, sourceCatalogPath3);
// generate delta catalog 3
AZStd::string testDeltaCatalogPath3 = GetTestFolderPath() + "TestAssetCatalogDelta3.xml";
AssetCatalogRequestBus::BroadcastResult(result, &AssetCatalogRequestBus::Events::CreateDeltaCatalog, deltaCatalogFiles3, testDeltaCatalogPath3);
EXPECT_TRUE(result);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::ClearCatalog);
AssetCatalogRequestBus::Broadcast(&AssetCatalogRequestBus::Events::LoadCatalog, testDeltaCatalogPath3.c_str());
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset1);
EXPECT_EQ(assetPath, path6);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset5);
EXPECT_EQ(assetPath, path4);
AssetCatalogRequestBus::BroadcastResult(assetPath, &AssetCatalogRequestBus::Events::GetAssetPathById, asset2);
EXPECT_EQ(assetPath, "");
// check against dependency info
CheckDirectDependencies(asset5, { asset2 });
CheckNoDependencies(asset1);
}
class AssetCatalogAPITest
: public AllocatorsFixture
{
public:
void SetUp() override
{
using namespace AZ::Data;
AllocatorsFixture::SetUp();
m_application = new AzFramework::Application();
m_assetRoot = UnitTest::GetTestFolderPath();
m_application->NormalizePathKeepCase(m_assetRoot);
m_assetCatalog = aznew AzFramework::AssetCatalog();
m_firstAssetId = AssetId(AZ::Uuid::CreateRandom(), 0);
AssetInfo assetInfo;
assetInfo.m_assetId = m_firstAssetId;
assetInfo.m_relativePath = "AssetA.txt";
assetInfo.m_sizeBytes = 1; //any non zero value
m_assetCatalog->RegisterAsset(m_firstAssetId, assetInfo);
m_secondAssetId = AssetId(AZ::Uuid::CreateRandom(), 0);
assetInfo.m_assetId = m_secondAssetId;
assetInfo.m_relativePath = "Foo/AssetA.txt";
assetInfo.m_sizeBytes = 1; //any non zero value
m_assetCatalog->RegisterAsset(m_secondAssetId, assetInfo);
}
void TearDown() override
{
delete m_assetCatalog;
delete m_application;
AllocatorsFixture::TearDown();
}
AzFramework::Application* m_application;
AzFramework::AssetCatalog* m_assetCatalog;
AZ::Data::AssetId m_firstAssetId;
AZ::Data::AssetId m_secondAssetId;
AZStd::string m_assetRoot;
};
TEST_F(AssetCatalogAPITest, GetAssetPathById_AbsolutePath_Valid)
{
AZStd::string absPath;
AzFramework::StringFunc::Path::Join(m_assetRoot.c_str(), "AssetA.txt", absPath);
EXPECT_EQ(m_firstAssetId, m_assetCatalog->GetAssetIdByPath(absPath.c_str(), AZ::Data::s_invalidAssetType, false));
}
TEST_F(AssetCatalogAPITest, GetAssetPathById_AbsolutePathWithSubFolder_Valid)
{
AZStd::string absPath;
AzFramework::StringFunc::Path::Join(m_assetRoot.c_str(), "Foo/AssetA.txt", absPath);
EXPECT_EQ(m_secondAssetId, m_assetCatalog->GetAssetIdByPath(absPath.c_str(), AZ::Data::s_invalidAssetType, false));
}
TEST_F(AssetCatalogAPITest, GetAssetPathById_RelPath_Valid)
{
EXPECT_EQ(m_firstAssetId, m_assetCatalog->GetAssetIdByPath("AssetA.txt", AZ::Data::s_invalidAssetType, false));
}
TEST_F(AssetCatalogAPITest, GetAssetPathById_RelPathWithSubFolders_Valid)
{
EXPECT_EQ(m_secondAssetId, m_assetCatalog->GetAssetIdByPath("Foo/AssetA.txt", AZ::Data::s_invalidAssetType, false));
}
TEST_F(AssetCatalogAPITest, GetAssetPathById_RelPathWithSeparators_Valid)
{
EXPECT_EQ(m_firstAssetId, m_assetCatalog->GetAssetIdByPath("//AssetA.txt", AZ::Data::s_invalidAssetType, false));
}
TEST_F(AssetCatalogAPITest, GetRegisteredAssetPaths_TwoAssetsRegistered_RetrieveAssetPaths)
{
AZStd::vector<AZStd::string> assetPaths = m_assetCatalog->GetRegisteredAssetPaths();
EXPECT_EQ(assetPaths.size(), 2);
ASSERT_THAT(assetPaths, testing::ElementsAre(
"AssetA.txt",
"Foo/AssetA.txt"));
}
TEST_F(AssetCatalogAPITest, DoesAssetIdMatchWildcardPattern_Matches)
{
EXPECT_TRUE(m_assetCatalog->DoesAssetIdMatchWildcardPattern(m_firstAssetId, "*.txt"));
EXPECT_TRUE(m_assetCatalog->DoesAssetIdMatchWildcardPattern(m_firstAssetId, "asset?.txt"));
}
TEST_F(AssetCatalogAPITest, DoesAssetIdMatchWildcardPattern_DoesNotMatch)
{
EXPECT_FALSE(m_assetCatalog->DoesAssetIdMatchWildcardPattern(AssetId(), "*.txt"));
EXPECT_FALSE(m_assetCatalog->DoesAssetIdMatchWildcardPattern(m_firstAssetId, "*.xml"));
EXPECT_FALSE(m_assetCatalog->DoesAssetIdMatchWildcardPattern(m_firstAssetId, ""));
}
class AssetType1
: public AssetData
{
public:
AZ_CLASS_ALLOCATOR(AssetType1, AZ::SystemAllocator, 0);
AZ_RTTI(AssetType1, "{64ECE3AE-2BEB-4502-9243-D17425249E08}", AssetData);
AssetType1()
: m_data(nullptr)
{
}
explicit AssetType1(const AZ::Data::AssetId& assetId, const AZ::Data::AssetData::AssetStatus assetStatus = AZ::Data::AssetData::AssetStatus::NotLoaded)
: AssetData(assetId, assetStatus)
, m_data(nullptr)
{
}
~AssetType1() override
{
if (m_data)
{
azfree(m_data);
}
}
char* m_data;
};
class AssetType2
: public AssetData
{
public:
AZ_CLASS_ALLOCATOR(AssetType2, AZ::SystemAllocator, 0);
AZ_RTTI(AssetType2, "{F5EDAAAB-2398-4967-A2C7-6B7C9421C1CE}", AssetData);
AssetType2()
: m_data(nullptr)
{
}
explicit AssetType2(const AZ::Data::AssetId& assetId, const AZ::Data::AssetData::AssetStatus assetStatus = AZ::Data::AssetData::AssetStatus::NotLoaded)
: AssetData(assetId, assetStatus)
, m_data(nullptr)
{
}
~AssetType2() override
{
if (m_data)
{
azfree(m_data);
}
}
char* m_data;
};
class AssetCatalogDisplayNameTest
: public AllocatorsFixture
{
virtual AZ::IO::IStreamer* CreateStreamer() { return aznew AZ::IO::Streamer(AZStd::thread_desc{}, AZ::StreamerComponent::CreateStreamerStack()); }
virtual void DestroyStreamer(AZ::IO::IStreamer* streamer) { delete streamer; }
AZ::IO::FileIOBase* m_prevFileIO{
nullptr
};
TestFileIOBase m_fileIO;
AZ::IO::IStreamer* m_streamer{ nullptr };
AzFramework::AssetCatalog* m_assetCatalog;
public:
void SetUp() override
{
AllocatorsFixture::SetUp();
AZ::AllocatorInstance<AZ::PoolAllocator>::Create();
AZ::AllocatorInstance<AZ::ThreadPoolAllocator>::Create();
m_prevFileIO = AZ::IO::FileIOBase::GetInstance();
AZ::IO::FileIOBase::SetInstance(&m_fileIO);
m_streamer = CreateStreamer();
if (m_streamer)
{
AZ::Interface<AZ::IO::IStreamer>::Register(m_streamer);
}
// create the database
AssetManager::Descriptor desc;
AssetManager::Create(desc);
m_assetCatalog = aznew AzFramework::AssetCatalog();
}
void TearDown() override
{
delete m_assetCatalog;
// destroy the database
AssetManager::Destroy();
if (m_streamer)
{
AZ::Interface<AZ::IO::IStreamer>::Unregister(m_streamer);
}
DestroyStreamer(m_streamer);
AZ::IO::FileIOBase::SetInstance(m_prevFileIO);
AZ::AllocatorInstance<AZ::ThreadPoolAllocator>::Destroy();
AZ::AllocatorInstance<AZ::PoolAllocator>::Destroy();
AllocatorsFixture::TearDown();
}
};
TEST_F(AssetCatalogDisplayNameTest, GetAssetTypeByDisplayName_GetRegistered)
{
// Register an asset type
AZ::TypeId assetTypeId = AZ::AzTypeInfo<AssetType1>::Uuid();
AZStd::string assetTypeName = "Test Asset Type";
auto handler = aznew AzFramework::GenericAssetHandler<AssetType1>(assetTypeName.data(), "SomeGroup", "someextension", assetTypeId);
handler->Register();
{
// Get the Asset Type from the Display Name
AssetType id;
AssetCatalogRequestBus::BroadcastResult(id, &AssetCatalogRequestBus::Events::GetAssetTypeByDisplayName, assetTypeName);
EXPECT_EQ(id, assetTypeId);
}
// Delete the handler
handler->Unregister();
delete handler;
}
TEST_F(AssetCatalogDisplayNameTest, GetAssetTypeByDisplayName_GetNotRegistered)
{
// Register an asset type
AZ::TypeId assetTypeId = AZ::AzTypeInfo<AssetType1>::Uuid();
AZStd::string assetTypeName = "Test Asset Type";
auto handler = aznew AzFramework::GenericAssetHandler<AssetType1>(assetTypeName.data(), "SomeGroup", "someextension", assetTypeId);
handler->Register();
{
// Try to get an Asset Type with a Display Name that was never registered
AssetType id;
AssetCatalogRequestBus::BroadcastResult(id, &AssetCatalogRequestBus::Events::GetAssetTypeByDisplayName, "Some Asset Type We Did Not Register");
EXPECT_EQ(id, AssetType::CreateNull());
}
// Delete the handler
handler->Unregister();
delete handler;
}
TEST_F(AssetCatalogDisplayNameTest, GetAssetTypeByDisplayName_GetWrongCasing)
{
// Register an asset type
AZ::TypeId assetTypeId = AZ::AzTypeInfo<AssetType1>::Uuid();
AZStd::string assetTypeName = "Test Asset Type";
auto handler = aznew AzFramework::GenericAssetHandler<AssetType1>(assetTypeName.data(), "SomeGroup", "someextension", assetTypeId);
handler->Register();
{
// Try to get the Asset Type we registered, but with a lowercase Display Name
AssetType id;
AssetCatalogRequestBus::BroadcastResult(id, &AssetCatalogRequestBus::Events::GetAssetTypeByDisplayName, "test asset type");
EXPECT_EQ(id, AssetType::CreateNull());
}
// Delete the handler
handler->Unregister();
delete handler;
}
TEST_F(AssetCatalogDisplayNameTest, GetAssetTypeByDisplayName_NoRegisteredType)
{
// Get the Asset Type from a Display Name we did not register
AssetType id;
AssetCatalogRequestBus::BroadcastResult(id, &AssetCatalogRequestBus::Events::GetAssetTypeByDisplayName, "Some Asset Type We Did Not Register");
EXPECT_EQ(id, AssetType::CreateNull());
}
TEST_F(AssetCatalogDisplayNameTest, GetAssetTypeByDisplayName_MultiRegisteredType_SameDisplayName)
{
AZStd::string assetTypeName = "Test Asset Type";
// Register an asset type
AZ::TypeId asset1TypeId = AZ::AzTypeInfo<AssetType1>::Uuid();
auto handler1 = aznew AzFramework::GenericAssetHandler<AssetType1>(assetTypeName.data(), "SomeGroup", "someextension", asset1TypeId);
handler1->Register();
// Register a different type handler with the same Display Name
AZ::TypeId asset2TypeId = AZ::AzTypeInfo<AssetType2>::Uuid();
auto handler2 = aznew AzFramework::GenericAssetHandler<AssetType2>(assetTypeName.data(), "SomeGroup", "someextension", asset2TypeId);
handler2->Register();
// Verify one of the types is returned.
// Note that we have no control over which one is returned as it's an implementation detail of the AssetCatalog
{
AssetType id;
AssetCatalogRequestBus::BroadcastResult(id, &AssetCatalogRequestBus::Events::GetAssetTypeByDisplayName, assetTypeName);
EXPECT_TRUE((id == asset1TypeId) || (id == asset2TypeId));
}
// Delete both handlers
handler1->Unregister();
handler2->Unregister();
delete handler1;
delete handler2;
}
}