birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

{lyn7298} removing PythonBuilderRequestBus from PythonAssetBuilder (#6115)

Browse Source 
* {lyn7298} removing PythonBuilderRequestBus from PythonAssetBuilder

* PythonBuilderRequestBus is a depreciated event bus
* removing the unsupported API

Signed-off-by: Allen Jackson <23512001+jackalbe@users.noreply.github.com>

* removing the PythonBuilderRequestBus_Behavior_Exists test

Signed-off-by: Allen Jackson <23512001+jackalbe@users.noreply.github.com>
This commit is contained in:
Allen Jackson
2021-12-03 11:21:33 -06:00
committed by GitHub
parent 75c015b67e
commit 8186c268e3
7 changed files with 0 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Gems/PythonAssetBuilder/Code/Include/PythonAssetBuilder/PythonBuilderRequestBus.h
-38
View File
@@ -1,38 +0,0 @@
/*
* 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
*
*/
#pragma once
#include <AzCore/EBus/EBus.h>
#include <AzCore/Asset/AssetCommon.h>
namespace PythonAssetBuilder
{
//! A request bus to help produce Open 3D Engine asset data
class PythonBuilderRequests
: public AZ::EBusTraits
{
public:
//////////////////////////////////////////////////////////////////////////
// EBusTraits overrides
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
//////////////////////////////////////////////////////////////////////////
//! Creates an AZ::Entity populated with Editor components and a name
virtual AZ::Outcome<AZ::EntityId, AZStd::string> CreateEditorEntity(const AZStd::string& name) = 0;
//! Writes out a .SLICE file with a given list of entities; optionally can be set to dynamic
virtual AZ::Outcome<AZ::Data::AssetType, AZStd::string> WriteSliceFile(
AZStd::string_view filename,
AZStd::vector<AZ::EntityId> entityList,
bool makeDynamic) = 0;
};
using PythonBuilderRequestBus = AZ::EBus<PythonBuilderRequests>;
}
Gems/PythonAssetBuilder/Code/Source/PythonAssetBuilderSystemComponent.cpp
-116
View File
@@ -8,7 +8,6 @@
#include <PythonAssetBuilderSystemComponent.h>
#include <PythonAssetBuilder/PythonAssetBuilderBus.h>
#include <PythonAssetBuilder/PythonBuilderRequestBus.h>
#include <AzCore/IO/Path/Path.h>
#include <AzCore/Serialization/SerializeContext.h>
@@ -57,13 +56,6 @@ namespace PythonAssetBuilder
->Event("RegisterAssetBuilder", &PythonAssetBuilderRequestBus::Events::RegisterAssetBuilder)
->Event("GetExecutableFolder", &PythonAssetBuilderRequestBus::Events::GetExecutableFolder)
;
behaviorContext->EBus<PythonBuilderRequestBus>("PythonBuilderRequestBus")
->Attribute(AZ::Script::Attributes::Scope, AZ::Script::Attributes::ScopeFlags::Automation)
->Attribute(AZ::Script::Attributes::Module, "asset.entity")
->Event("WriteSliceFile", &PythonBuilderRequestBus::Events::WriteSliceFile)
->Event("CreateEditorEntity", &PythonBuilderRequestBus::Events::CreateEditorEntity)
;
}
}
@@ -97,13 +89,10 @@ namespace PythonAssetBuilder
{
pythonInterface->StartPython(true);
}
PythonBuilderRequestBus::Handler::BusConnect();
}
void PythonAssetBuilderSystemComponent::Deactivate()
{
PythonBuilderRequestBus::Handler::BusDisconnect();
m_messageSink.reset();
if (PythonAssetBuilderRequestBus::HasHandlers())
@@ -148,109 +137,4 @@ namespace PythonAssetBuilder
}
return AZ::Failure(AZStd::string("GetExecutableFolder access is missing."));
}
AZ::Outcome<AZ::EntityId, AZStd::string> PythonAssetBuilderSystemComponent::CreateEditorEntity(const AZStd::string& name)
{
AZ::EntityId entityId;
AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
entityId,
&AzToolsFramework::EditorEntityContextRequestBus::Events::CreateNewEditorEntity,
name.c_str());
if (entityId.IsValid() == false)
{
return AZ::Failure<AZStd::string>("Failed to CreateNewEditorEntity.");
}
AZ::Entity* entity = nullptr;
AZ::ComponentApplicationBus::BroadcastResult(entity, &AZ::ComponentApplicationRequests::FindEntity, entityId);
if (entity == nullptr)
{
return AZ::Failure<AZStd::string>(AZStd::string::format("Failed to find created entityId %s", entityId.ToString().c_str()));
}
entity->Deactivate();
AzToolsFramework::EditorEntityContextRequestBus::Broadcast(
&AzToolsFramework::EditorEntityContextRequestBus::Events::AddRequiredComponents,
*entity);
entity->Activate();
return AZ::Success(entityId);
}
AZ::Outcome<AZ::Data::AssetType, AZStd::string> PythonAssetBuilderSystemComponent::WriteSliceFile(
AZStd::string_view filename,
AZStd::vector<AZ::EntityId> entityList,
bool makeDynamic)
{
using namespace AzToolsFramework::SliceUtilities;
AZ::SerializeContext* serializeContext = nullptr;
AZ::ComponentApplicationBus::BroadcastResult(serializeContext, &AZ::ComponentApplicationBus::Events::GetSerializeContext);
if (serializeContext == nullptr)
{
return AZ::Failure<AZStd::string>("GetSerializeContext failed");
}
// transaction->Commit() requires the "@user@" alias
auto settingsRegistry = AZ::SettingsRegistry::Get();
auto ioBase = AZ::IO::FileIOBase::GetInstance();
if (ioBase->GetAlias("@user@") == nullptr)
{
if (AZ::IO::Path userPath; settingsRegistry->Get(userPath.Native(), AZ::SettingsRegistryMergeUtils::FilePathKey_ProjectUserPath))
{
userPath /= "AssetProcessorTemp";
ioBase->SetAlias("@user@", userPath.c_str());
}
}
// transaction->Commit() expects the file to exist and write-able
AZ::IO::HandleType fileHandle;
AZ::IO::LocalFileIO::GetInstance()->Open(filename.data(), AZ::IO::OpenMode::ModeWrite, fileHandle);
if (fileHandle == AZ::IO::InvalidHandle)
{
return AZ::Failure<AZStd::string>(
AZStd::string::format("Failed to create slice file %.*s", aznumeric_cast<int>(filename.size()), filename.data()));
}
AZ::IO::LocalFileIO::GetInstance()->Close(fileHandle);
AZ::u32 creationFlags = 0;
if (makeDynamic)
{
creationFlags |= SliceTransaction::CreateAsDynamic;
}
SliceTransaction::TransactionPtr transaction = SliceTransaction::BeginNewSlice(nullptr, serializeContext, creationFlags);
// add entities
for (const AZ::EntityId& entityId : entityList)
{
auto addResult = transaction->AddEntity(entityId, SliceTransaction::SliceAddEntityFlags::DiscardSliceAncestry);
if (!addResult)
{
return AZ::Failure<AZStd::string>(AZStd::string::format("Failed slice add entity: %s", addResult.GetError().c_str()));
}
}
// commit to a file
AZ::Data::AssetType sliceAssetType;
auto resultCommit = transaction->Commit(filename.data(), nullptr, [&sliceAssetType](
SliceTransaction::TransactionPtr transactionPtr,
[[maybe_unused]] const char* fullPath,
const SliceTransaction::SliceAssetPtr& sliceAssetPtr)
{
sliceAssetType = sliceAssetPtr->GetType();
return AZ::Success();
});
if (!resultCommit)
{
return AZ::Failure<AZStd::string>(AZStd::string::format("Failed commit slice: %s", resultCommit.GetError().c_str()));
}
return AZ::Success(sliceAssetType);
}
}
Gems/PythonAssetBuilder/Code/Source/PythonAssetBuilderSystemComponent.h
-9
View File
@@ -11,7 +11,6 @@
#include <AzCore/Component/Component.h>
#include <PythonAssetBuilder/PythonAssetBuilderBus.h>
#include <PythonAssetBuilder/PythonBuilderRequestBus.h>
namespace PythonAssetBuilder
{
@@ -21,7 +20,6 @@ namespace PythonAssetBuilder
class PythonAssetBuilderSystemComponent
: public AZ::Component
, protected PythonAssetBuilderRequestBus::Handler
, protected PythonBuilderRequestBus::Handler
{
public:
AZ_COMPONENT(PythonAssetBuilderSystemComponent, "{E2872C13-D103-4534-9A95-76A66C8DDB5D}");
@@ -42,13 +40,6 @@ namespace PythonAssetBuilder
AZ::Outcome<bool, AZStd::string> RegisterAssetBuilder(const AssetBuilderSDK::AssetBuilderDesc& desc) override;
AZ::Outcome<AZStd::string, AZStd::string> GetExecutableFolder() const override;
// PythonBuilderRequestBus
AZ::Outcome<AZ::EntityId, AZStd::string> CreateEditorEntity(const AZStd::string& name) override;
AZ::Outcome<AZ::Data::AssetType, AZStd::string> WriteSliceFile(
AZStd::string_view filename,
AZStd::vector<AZ::EntityId> entityList,
bool makeDynamic) override;
private:
using PythonBuilderWorkerPointer = AZStd::shared_ptr<PythonBuilderWorker>;
using PythonBuilderWorkerMap = AZStd::unordered_map<AZ::Uuid, PythonBuilderWorkerPointer>;
Gems/PythonAssetBuilder/Code/Tests/PythonAssetBuilderTest.cpp
-60
View File
@@ -14,7 +14,6 @@
#include "Source/PythonAssetBuilderSystemComponent.h"
#include <PythonAssetBuilder/PythonAssetBuilderBus.h>
#include <PythonAssetBuilder/PythonBuilderRequestBus.h>
#include <AzCore/Asset/AssetCommon.h>
#include <AssetBuilderSDK/AssetBuilderSDK.h>
@@ -87,65 +86,6 @@ namespace UnitTest
&PythonAssetBuilderRequestBus::Events::GetExecutableFolder);
EXPECT_TRUE(result.IsSuccess());
}
// test bus API exists
TEST_F(PythonAssetBuilderTest, PythonBuilderRequestBus_CreateEditorEntity_Exists)
{
using namespace PythonAssetBuilder;
EXPECT_FALSE(PythonBuilderRequestBus::HasHandlers());
// Some static tests to make sure the public API has not changed since that
// would break Python asset builders using this EBus
{
AZ::Outcome<AZ::EntityId, AZStd::string> result;
AZStd::string name;
PythonBuilderRequestBus::BroadcastResult(
result,
&PythonBuilderRequestBus::Events::CreateEditorEntity,
name);
EXPECT_FALSE(result.IsSuccess());
}
m_app->RegisterComponentDescriptor(PythonAssetBuilderSystemComponent::CreateDescriptor());
m_systemEntity->CreateComponent<PythonAssetBuilderSystemComponent>();
m_systemEntity->Init();
m_systemEntity->Activate();
EXPECT_TRUE(PythonBuilderRequestBus::HasHandlers());
}
TEST_F(PythonAssetBuilderTest, PythonBuilderRequestBus_WriteSliceFile_Exists)
{
using namespace PythonAssetBuilder;
EXPECT_FALSE(PythonBuilderRequestBus::HasHandlers());
// Some static tests to make sure the public API has not changed since that
// would break Python asset builders using this EBus
{
AZ::Outcome<AZ::Data::AssetType, AZStd::string> result;
AZStd::string_view filename;
AZStd::vector<AZ::EntityId> entities;
bool makeDynamic = {};
PythonBuilderRequestBus::BroadcastResult(
result,
&PythonBuilderRequestBus::Events::WriteSliceFile,
filename,
entities,
makeDynamic);
EXPECT_FALSE(result.IsSuccess());
}
m_app->RegisterComponentDescriptor(PythonAssetBuilderSystemComponent::CreateDescriptor());
m_systemEntity->CreateComponent<PythonAssetBuilderSystemComponent>();
m_systemEntity->Init();
m_systemEntity->Activate();
EXPECT_TRUE(PythonBuilderRequestBus::HasHandlers());
}
}
AZ_UNIT_TEST_HOOK(DEFAULT_UNIT_TEST_ENV);
Gems/PythonAssetBuilder/Code/Tests/PythonBuilderProcessJobTest.cpp
-13
View File
@@ -106,17 +106,4 @@ namespace UnitTest
PythonBuilderNotificationBus::Event(builderId, &PythonBuilderNotificationBus::Events::OnCancel);
EXPECT_EQ(1, mockJobHandler.m_onCancelCount);
}
TEST_F(PythonBuilderProcessJobTest, PythonBuilderRequestBus_Behavior_Exists)
{
using namespace PythonAssetBuilder;
using namespace AssetBuilderSDK;
RegisterAssetBuilder(m_app.get(), m_systemEntity);
auto entry = m_app->GetBehaviorContext()->m_ebuses.find("PythonBuilderRequestBus");
ASSERT_NE(m_app->GetBehaviorContext()->m_ebuses.end(), entry);
EXPECT_NE(entry->second->m_events.end(), entry->second->m_events.find("WriteSliceFile"));
EXPECT_NE(entry->second->m_events.end(), entry->second->m_events.find("CreateEditorEntity"));
}
}
Gems/PythonAssetBuilder/Code/pythonassetbuilder_common_files.cmake
-1
View File
@@ -9,7 +9,6 @@
set(FILES
Include/PythonAssetBuilder/PythonAssetBuilderBus.h
Include/PythonAssetBuilder/PythonBuilderNotificationBus.h
Include/PythonAssetBuilder/PythonBuilderRequestBus.h
Source/PythonAssetBuilderSystemComponent.cpp
Source/PythonAssetBuilderSystemComponent.h
Source/PythonBuilderMessageSink.cpp
Gems/PythonAssetBuilder/Code/pythonassetbuilder_editor_files.cmake
-1
View File
@@ -9,7 +9,6 @@
set(FILES
Include/PythonAssetBuilder/PythonAssetBuilderBus.h
Include/PythonAssetBuilder/PythonBuilderNotificationBus.h
Include/PythonAssetBuilder/PythonBuilderRequestBus.h
Source/PythonAssetBuilderSystemComponent.cpp
Source/PythonAssetBuilderSystemComponent.h
Source/PythonBuilderMessageSink.cpp