Merge branch 'upstream/development' into genewalt/gitflow_210628
Signed-off-by: Gene Walters <genewalt@amazon.com>monroegm-disable-blank-issue-2
Gene Walters
5 years ago
commit
6fb2558e44
@ -0,0 +1,73 @@
|
||||
---
|
||||
name: RFC Feature request
|
||||
about: Create Feature RFC for this project
|
||||
title: Proposed RFC Feature =description=
|
||||
labels: 'rfc-feature'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# O3DE RFC Feature Template
|
||||
|
||||
### When using this template, you do not have to fill out every question below. The questions are there for guidance.
|
||||
|
||||
This RFC feature template should be used for any feature that is not a bug or a substantial reorganization of the O3DE product.
|
||||
|
||||
If you submit a pull request to implement a new feature without going through the RFC process, it may be closed with a polite request to submit an RFC first.
|
||||
|
||||
A hastily proposed RFC can hurt its chances of acceptance. Low-quality proposals, proposals for previously-rejected features, or those that don't fit into the near-term roadmap may be quickly rejected, demotivating the unprepared contributor. Laying some groundwork ahead of the RFC can make the process smoother.
|
||||
|
||||
Although there is no single way to prepare for submitting an RFC, it is generally a good idea to pursue feedback from other project developers beforehand to ascertain that the RFC may be desirable; having a consistent impact on the project requires concerted effort toward consensus-building.
|
||||
|
||||
The most common preparations for writing and submitting an RFC include:
|
||||
- Talking the idea over on our Discord server.
|
||||
- Discussing the topic on our GitHub RFCs discussions page.
|
||||
- Occasionally posting "pre-RFCs" on the GitHub RFCs discussion page.
|
||||
You may file issues in the RFCs repo for discussion, but these are not actively looked at by the teams.
|
||||
|
||||
As a rule of thumb, receiving encouraging feedback from long-standing project developers, and particularly members of the relevant sub-team, is a good indication that the RFC is worth pursuing.
|
||||
|
||||
# ----- DELETE EVERYTHING FROM THE TOP TO THE SUMMARY LINE BELOW WHEN USING TEMPLATE ----- #
|
||||
|
||||
### Summary:
|
||||
Single paragraph explanation of the feature
|
||||
|
||||
### What is the relevance of this feature?
|
||||
Why is this important? What are the use cases? What will it do once completed?
|
||||
|
||||
### Feature design description:
|
||||
- Explain the design of the feature with enough detail that someone familiar with the environment and framework can understand the concept and explain it to others.
|
||||
- It should include at least one end-to-end example of how a developer will use it along with specific details, including outlying use cases.
|
||||
|
||||
- If there is any new terminology, it should be defined here.
|
||||
|
||||
### Technical design description:
|
||||
- Explain the technical portion of the work in enough detail that members can implement the feature.
|
||||
|
||||
- Explain any API or process changes required to implement this feature
|
||||
|
||||
- This section should relate to the feature design description by reference and explain in greater detail how it makes the feature design examples work.
|
||||
|
||||
- This should also provide detailed information on compatibility with different hardware platforms.
|
||||
|
||||
|
||||
### What are the advantages of the feature?
|
||||
- Explain the advantages for someone to use this feature
|
||||
|
||||
### What are the disadvantages of the feature?
|
||||
- Explain any disadvantages for someone to use this feature
|
||||
|
||||
### How will this be implemented or integrated into the O3DE environment?
|
||||
- Explain how a developer will integrate this into the codebase of O3DE and provide any specific library or technical stack requirements.
|
||||
|
||||
### Are there any alternatives to this feature?
|
||||
- Provide any other designs that have been considered. Explain what the impact might be of not doing this.
|
||||
- If there is any prior art or approaches with other frameworks in the same domain, explain how they may have solved this problem or implemented this feature.
|
||||
|
||||
### How will users learn this feature?
|
||||
- Detail how it can be best presented and how it is used as an extension or a standalone tool used with O3DE.
|
||||
- Explain if and how it may change how individuals would use the platform and if any documentation must be changed or reorganized.
|
||||
- Explain how it would be taught to new and existing O3DE users.
|
||||
|
||||
### Are there any open questions?
|
||||
- What are some of the open questions and potential scenarios that should be considered?
|
||||
@ -0,0 +1,61 @@
|
||||
---
|
||||
name: RFC Suggestion request
|
||||
about: Create Suggestion RFC for this project
|
||||
title: Proposed RFC Suggestion =description=
|
||||
labels: 'rfc-suggestion'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# O3DE Suggestion RFC Template
|
||||
|
||||
### When using this template, you do not have to fill out every question below. The questions are there for guidance.
|
||||
|
||||
This RFC template should be used for any suggestion that is not based upon code or content related to the O3DE product itself. This template is for proposing new process models, approaches, or ideas to improve the O3DE community.
|
||||
|
||||
A hastily proposed RFC can hurt its chances of acceptance. Low-quality proposals, proposals for previously rejected features, or those that do not have any substantive value to the project may be quickly rejected, demotivating the unprepared contributor. Laying some groundwork with others in the community ahead of the RFC can make the process much smoother.
|
||||
|
||||
Although there is no single way to prepare for submitting an RFC, it is generally a good idea to pursue feedback from other project members beforehand. Keep in mind that you want other members to contribute and back your suggestion, which can drastically improve the chances of implementation.
|
||||
|
||||
The most common preparations for writing and submitting an RFC include:
|
||||
- Talking the idea over on our Discord server.
|
||||
- Creating a discussion on our GitHub RFCs discussions page.
|
||||
- Occasionally posting "pre-RFCs" on the GitHub RFCs discussion page.
|
||||
You may file issues in the RFCs repo for discussion, but these are not actively looked at by the teams.
|
||||
|
||||
As a rule of thumb, receiving encouraging feedback from long-standing community members is a good indication that the RFC is worth pursuing.
|
||||
|
||||
# ----- DELETE EVERYTHING FROM THE TOP TO THE SUMMARY LINE BELOW WHEN USING TEMPLATE ----- #
|
||||
|
||||
### Summary:
|
||||
Single paragraph explanation of the suggestion
|
||||
|
||||
### What is the motivation for this suggestion?
|
||||
Why is this important?
|
||||
What are the use cases for this suggestion?
|
||||
What should the outcome be if this suggestion is implemented?
|
||||
|
||||
### Suggestion design description:
|
||||
- Explain the suggestion with enough detail that someone familiar with the process and environment of the project can understand the suggestion and explain it to others.
|
||||
- It should include at least one end-to-end example of how the community will use it along with the specific details with outlying use cases.
|
||||
|
||||
- If there is any new terminology, it should be defined here.
|
||||
|
||||
### What are the advantages of the suggestion?
|
||||
- Explain the advantages of using this suggestion
|
||||
|
||||
### What are the disadvantages of the suggestion?
|
||||
- Explain any disadvantages or trade-offs to using this suggestion
|
||||
|
||||
### How will this be work within the O3DE project?
|
||||
- Explain how this suggestion will be work within the O3DE project.
|
||||
|
||||
### Are there any alternatives to this suggestion?
|
||||
- Provide any other alternative ways that have been considered.
|
||||
- Explain what the impact might be of not implementing this suggestion.
|
||||
- If there are other similar suggestions previously used, list them and explain which parts may have solved some or all of this problem.
|
||||
|
||||
### What is the strategy for adoption?
|
||||
- Explain how new and existing users will adopt this suggestion.
|
||||
- Point out any efforts needed if it requires coordination with multiple SIGs or other projects.
|
||||
- Explain how it would be taught to new and existing O3DE users.
|
||||
@ -0,0 +1,12 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
add_subdirectory(Code)
|
||||
@ -0,0 +1,62 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
ly_get_list_relative_pal_filename(pal_dir ${CMAKE_CURRENT_LIST_DIR}/Platform/${PAL_PLATFORM_NAME} ${o3de_gem_restricted_path} ${o3de_gem_path} ${o3de_gem_name})
|
||||
include(${pal_dir}/PAL_${PAL_PLATFORM_NAME_LOWERCASE}.cmake)
|
||||
|
||||
if(PAL_TRAIT_PYTHONCOVERAGE_SUPPORTED)
|
||||
if(PAL_TRAIT_BUILD_HOST_TOOLS)
|
||||
ly_add_target(
|
||||
NAME PythonCoverage.Editor.Static STATIC
|
||||
NAMESPACE Gem
|
||||
FILES_CMAKE
|
||||
pythoncoverage_editor_files.cmake
|
||||
INCLUDE_DIRECTORIES
|
||||
PRIVATE
|
||||
Source
|
||||
PUBLIC
|
||||
Include
|
||||
COMPILE_DEFINITIONS
|
||||
PUBLIC
|
||||
PYTHON_COVERAGE_EDITOR
|
||||
PRIVATE
|
||||
${LY_TEST_IMPACT_CONFIG_FILE_PATH_DEFINITION}
|
||||
BUILD_DEPENDENCIES
|
||||
PUBLIC
|
||||
AZ::AzToolsFramework
|
||||
RUNTIME_DEPENDENCIES
|
||||
Gem::EditorPythonBindings.Editor
|
||||
)
|
||||
|
||||
ly_add_target(
|
||||
NAME PythonCoverage.Editor GEM_MODULE
|
||||
NAMESPACE Gem
|
||||
AUTOMOC
|
||||
OUTPUT_NAME Gem.PythonCoverage.Editor
|
||||
FILES_CMAKE
|
||||
pythoncoverage_editor_shared_files.cmake
|
||||
COMPILE_DEFINITIONS
|
||||
PRIVATE
|
||||
PYTHON_COVERAGE_EDITOR
|
||||
INCLUDE_DIRECTORIES
|
||||
PRIVATE
|
||||
Source
|
||||
PUBLIC
|
||||
Include
|
||||
BUILD_DEPENDENCIES
|
||||
PUBLIC
|
||||
Gem::PythonCoverage.Editor.Static
|
||||
)
|
||||
|
||||
ly_create_alias(NAME PythonCoverage.Tools NAMESPACE Gem TARGETS Gem::PythonCoverage.Editor)
|
||||
ly_create_alias(NAME PythonCoverage.Builders NAMESPACE Gem TARGETS Gem::PythonCoverage.Editor)
|
||||
endif()
|
||||
endif()
|
||||
@ -0,0 +1,12 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
set(PAL_TRAIT_PYTHONCOVERAGE_SUPPORTED FALSE)
|
||||
@ -0,0 +1,12 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
set(PAL_TRAIT_PYTHONCOVERAGE_SUPPORTED FALSE)
|
||||
@ -0,0 +1,12 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
set(PAL_TRAIT_PYTHONCOVERAGE_SUPPORTED FALSE)
|
||||
@ -0,0 +1,12 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
set(PAL_TRAIT_PYTHONCOVERAGE_SUPPORTED TRUE)
|
||||
@ -0,0 +1,12 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
set(PAL_TRAIT_PYTHONCOVERAGE_SUPPORTED FALSE)
|
||||
@ -0,0 +1,38 @@
|
||||
/*
|
||||
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
* its licensors.
|
||||
*
|
||||
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||
* distribution (the "License"). All use of this software is governed by the License,
|
||||
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
*
|
||||
*/
|
||||
|
||||
#include "PythonCoverageEditorModule.h"
|
||||
#include "PythonCoverageEditorSystemComponent.h"
|
||||
|
||||
namespace PythonCoverage
|
||||
{
|
||||
AZ_CLASS_ALLOCATOR_IMPL(PythonCoverageEditorModule, AZ::SystemAllocator, 0)
|
||||
|
||||
PythonCoverageEditorModule::PythonCoverageEditorModule()
|
||||
{
|
||||
m_descriptors.insert(
|
||||
m_descriptors.end(),
|
||||
{
|
||||
PythonCoverageEditorSystemComponent::CreateDescriptor()
|
||||
});
|
||||
}
|
||||
|
||||
PythonCoverageEditorModule::~PythonCoverageEditorModule() = default;
|
||||
|
||||
AZ::ComponentTypeList PythonCoverageEditorModule::GetRequiredSystemComponents() const
|
||||
{
|
||||
// add required SystemComponents to the SystemEntity
|
||||
return AZ::ComponentTypeList{ azrtti_typeid<PythonCoverageEditorSystemComponent>() };
|
||||
}
|
||||
} // namespace PythonCoverage
|
||||
|
||||
AZ_DECLARE_MODULE_CLASS(Gem_PythonCoverageEditor, PythonCoverage::PythonCoverageEditorModule)
|
||||
@ -0,0 +1,33 @@
|
||||
/*
|
||||
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
* its licensors.
|
||||
*
|
||||
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||
* distribution (the "License"). All use of this software is governed by the License,
|
||||
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <AzCore/Memory/SystemAllocator.h>
|
||||
#include <AzCore/Module/Module.h>
|
||||
|
||||
namespace PythonCoverage
|
||||
{
|
||||
class PythonCoverageEditorModule
|
||||
: public AZ::Module
|
||||
{
|
||||
public:
|
||||
AZ_CLASS_ALLOCATOR_DECL
|
||||
AZ_RTTI(PythonCoverageEditorModule, "{32C0FFEA-09A7-460F-9257-5BDEF74FCD5B}", AZ::Module);
|
||||
|
||||
PythonCoverageEditorModule();
|
||||
~PythonCoverageEditorModule();
|
||||
|
||||
// PythonCoverageModule ...
|
||||
AZ::ComponentTypeList GetRequiredSystemComponents() const override;
|
||||
};
|
||||
} // namespace WhiteBox
|
||||
@ -0,0 +1,246 @@
|
||||
/*
|
||||
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
* its licensors.
|
||||
*
|
||||
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||
* distribution (the "License"). All use of this software is governed by the License,
|
||||
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
*
|
||||
*/
|
||||
|
||||
#include <AzCore/IO/Path/Path.h>
|
||||
#include <AzCore/JSON/document.h>
|
||||
#include <AzCore/Module/ModuleManagerBus.h>
|
||||
#include <AzCore/Module/Module.h>
|
||||
#include <AzCore/Module/DynamicModuleHandle.h>
|
||||
#include <AzCore/Serialization/SerializeContext.h>
|
||||
|
||||
#include <PythonCoverageEditorSystemComponent.h>
|
||||
|
||||
namespace PythonCoverage
|
||||
{
|
||||
static constexpr char* const LogCallSite = "PythonCoverageEditorSystemComponent";
|
||||
|
||||
void PythonCoverageEditorSystemComponent::Reflect(AZ::ReflectContext* context)
|
||||
{
|
||||
if (auto serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
|
||||
{
|
||||
serializeContext->Class<PythonCoverageEditorSystemComponent, AZ::Component>()->Version(1);
|
||||
}
|
||||
}
|
||||
|
||||
void PythonCoverageEditorSystemComponent::Activate()
|
||||
{
|
||||
AzToolsFramework::EditorPythonScriptNotificationsBus::Handler::BusConnect();
|
||||
AZ::EntitySystemBus::Handler::BusConnect();
|
||||
|
||||
// If no output directory discovered, coverage gathering will be disabled
|
||||
if (ParseCoverageOutputDirectory() == CoverageState::Disabled)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
EnumerateAllModuleComponents();
|
||||
}
|
||||
|
||||
void PythonCoverageEditorSystemComponent::Deactivate()
|
||||
{
|
||||
AZ::EntitySystemBus::Handler::BusDisconnect();
|
||||
AzToolsFramework::EditorPythonScriptNotificationsBus::Handler::BusDisconnect();
|
||||
}
|
||||
|
||||
void PythonCoverageEditorSystemComponent::OnEntityActivated(const AZ::EntityId& entityId)
|
||||
{
|
||||
if (m_coverageState == CoverageState::Disabled)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
EnumerateComponentsForEntity(entityId);
|
||||
|
||||
// There is currently no way to receive a graceful exit signal in order to properly handle the coverage end of life so
|
||||
// instead we have to serialize the data on-the-fly with blocking disk writes on the main thread... if this adversely
|
||||
// affects performance in a measurable way then this could potentially be put on a worker thread, although it remains to
|
||||
// be seen whether the asynchronous nature of such a thread results in queued up coverage being lost due to the hard exit
|
||||
if (m_coverageState == CoverageState::Gathering)
|
||||
{
|
||||
WriteCoverageFile();
|
||||
}
|
||||
}
|
||||
|
||||
PythonCoverageEditorSystemComponent::CoverageState PythonCoverageEditorSystemComponent::ParseCoverageOutputDirectory()
|
||||
{
|
||||
m_coverageState = CoverageState::Disabled;
|
||||
const AZStd::string configFilePath = LY_TEST_IMPACT_DEFAULT_CONFIG_FILE;
|
||||
|
||||
if (configFilePath.empty())
|
||||
{
|
||||
AZ_Warning(LogCallSite, false, "No test impact analysis framework config file specified.");
|
||||
return m_coverageState;
|
||||
}
|
||||
|
||||
const auto fileSize = AZ::IO::SystemFile::Length(configFilePath.c_str());
|
||||
if(!fileSize)
|
||||
{
|
||||
AZ_Error(LogCallSite, false, "Test impact analysis framework config file '%s' does not exist", configFilePath.c_str());
|
||||
return m_coverageState;
|
||||
}
|
||||
|
||||
AZStd::vector<char> buffer(fileSize + 1);
|
||||
buffer[fileSize] = '\0';
|
||||
if (!AZ::IO::SystemFile::Read(configFilePath.c_str(), buffer.data()))
|
||||
{
|
||||
AZ_Error(LogCallSite, false, "Could not read contents of test impact analysis framework config file '%s'", configFilePath.c_str());
|
||||
return m_coverageState;
|
||||
}
|
||||
|
||||
const AZStd::string configurationData = AZStd::string(buffer.begin(), buffer.end());
|
||||
rapidjson::Document configurationFile;
|
||||
if (configurationFile.Parse(configurationData.c_str()).HasParseError())
|
||||
{
|
||||
AZ_Error(LogCallSite, false, "Could not parse test impact analysis framework config file data, JSON has errors");
|
||||
return m_coverageState;
|
||||
}
|
||||
|
||||
const auto& tempConfig = configurationFile["workspace"]["temp"];
|
||||
|
||||
// Temp directory root path is absolute
|
||||
const AZ::IO::Path tempWorkspaceRootDir = tempConfig["root"].GetString();
|
||||
|
||||
// Artifact directory is relative to temp directory root
|
||||
const AZ::IO::Path artifactRelativeDir = tempConfig["relative_paths"]["artifact_dir"].GetString();
|
||||
m_coverageDir = tempWorkspaceRootDir / artifactRelativeDir;
|
||||
|
||||
// Everything is good to go, await the first python test case
|
||||
m_coverageState = CoverageState::Idle;
|
||||
return m_coverageState;
|
||||
}
|
||||
|
||||
void PythonCoverageEditorSystemComponent::WriteCoverageFile()
|
||||
{
|
||||
AZStd::string contents;
|
||||
|
||||
// Compile the coverage for all test cases in this script
|
||||
for (const auto& [testCase, entityComponents] : m_entityComponentMap)
|
||||
{
|
||||
const auto coveringModules = GetParentComponentModulesForAllActivatedEntities(entityComponents);
|
||||
if (coveringModules.empty())
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
contents = testCase + "\n";
|
||||
for (const auto& coveringModule : coveringModules)
|
||||
{
|
||||
contents += AZStd::string::format(" %s\n", coveringModule.c_str());
|
||||
}
|
||||
}
|
||||
|
||||
AZ::IO::SystemFile file;
|
||||
const AZStd::vector<char> bytes(contents.begin(), contents.end());
|
||||
if (!file.Open(
|
||||
m_coverageFile.c_str(),
|
||||
AZ::IO::SystemFile::SF_OPEN_CREATE | AZ::IO::SystemFile::SF_OPEN_CREATE_PATH | AZ::IO::SystemFile::SF_OPEN_WRITE_ONLY))
|
||||
{
|
||||
AZ_Error(LogCallSite, false, "Couldn't open file '%s' for writing", m_coverageFile.c_str());
|
||||
return;
|
||||
}
|
||||
|
||||
if (!file.Write(bytes.data(), bytes.size()))
|
||||
{
|
||||
AZ_Error(LogCallSite, false, "Couldn't write contents for file '%s'", m_coverageFile.c_str());
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
void PythonCoverageEditorSystemComponent::EnumerateAllModuleComponents()
|
||||
{
|
||||
AZ::ModuleManagerRequestBus::Broadcast(
|
||||
&AZ::ModuleManagerRequestBus::Events::EnumerateModules,
|
||||
[this](const AZ::ModuleData& moduleData)
|
||||
{
|
||||
// We can only enumerate shared libs, static libs are invisible to us
|
||||
if (moduleData.GetDynamicModuleHandle())
|
||||
{
|
||||
for (const auto* moduleComponentDescriptor : moduleData.GetModule()->GetComponentDescriptors())
|
||||
{
|
||||
m_moduleComponents[moduleComponentDescriptor->GetUuid()] = moduleData.GetDebugName();
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
void PythonCoverageEditorSystemComponent::EnumerateComponentsForEntity(const AZ::EntityId& entityId)
|
||||
{
|
||||
AZ::Entity* entity = nullptr;
|
||||
AZ::ComponentApplicationBus::BroadcastResult(entity, &AZ::ComponentApplicationBus::Events::FindEntity, AZ::EntityId(entityId));
|
||||
|
||||
if (entity)
|
||||
{
|
||||
auto& entityComponents = m_entityComponentMap[m_testCase];
|
||||
for (const auto& entityComponent : entity->GetComponents())
|
||||
{
|
||||
const auto componentTypeId = entityComponent->GetUnderlyingComponentType();
|
||||
AZ::ComponentDescriptor* componentDescriptor = nullptr;
|
||||
AZ::ComponentDescriptorBus::EventResult(
|
||||
componentDescriptor, componentTypeId, &AZ::ComponentDescriptorBus::Events::GetDescriptor);
|
||||
entityComponents[componentTypeId] = componentDescriptor;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
AZStd::unordered_set<AZStd::string> PythonCoverageEditorSystemComponent::GetParentComponentModulesForAllActivatedEntities(
|
||||
const AZStd::unordered_map<AZ::Uuid, AZ::ComponentDescriptor*>& entityComponents) const
|
||||
{
|
||||
AZStd::unordered_set<AZStd::string> coveringModuleOutputNames;
|
||||
for (const auto& [uuid, componentDescriptor] : entityComponents)
|
||||
{
|
||||
if (const auto moduleComponent = m_moduleComponents.find(uuid); moduleComponent != m_moduleComponents.end())
|
||||
{
|
||||
coveringModuleOutputNames.insert(moduleComponent->second);
|
||||
}
|
||||
}
|
||||
|
||||
return coveringModuleOutputNames;
|
||||
}
|
||||
|
||||
void PythonCoverageEditorSystemComponent::OnStartExecuteByFilenameAsTest(AZStd::string_view filename, AZStd::string_view testCase, [[maybe_unused]] const AZStd::vector<AZStd::string_view>& args)
|
||||
{
|
||||
if (m_coverageState == CoverageState::Disabled)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (m_coverageState == CoverageState::Gathering)
|
||||
{
|
||||
// Dump any existing coverage data to disk
|
||||
WriteCoverageFile();
|
||||
m_coverageState = CoverageState::Idle;
|
||||
}
|
||||
|
||||
if (testCase.empty())
|
||||
{
|
||||
// We need to be able to pinpoint the coverage data to the specific test case names otherwise we will not be able
|
||||
// to specify which specific tests should be run in the future (filename does not necessarily equate to test case name)
|
||||
AZ_Error(LogCallSite, false, "No test case specified, coverage data gathering will be disabled for this test");
|
||||
return;
|
||||
}
|
||||
|
||||
const AZStd::string scriptName = AZ::IO::Path(filename).Stem().Native();
|
||||
const auto coverageFile = m_coverageDir / AZStd::string::format("%s.pycoverage", scriptName.c_str());
|
||||
|
||||
// If this is a different python script we clear the existing entity components and start afresh
|
||||
if (m_coverageFile != coverageFile)
|
||||
{
|
||||
m_entityComponentMap.clear();
|
||||
m_coverageFile = coverageFile;
|
||||
}
|
||||
|
||||
m_testCase = testCase;
|
||||
m_coverageState = CoverageState::Gathering;
|
||||
}
|
||||
} // namespace PythonCoverage
|
||||
@ -0,0 +1,88 @@
|
||||
/*
|
||||
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
* its licensors.
|
||||
*
|
||||
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||
* distribution (the "License"). All use of this software is governed by the License,
|
||||
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <AzCore/Component/Component.h>
|
||||
#include <AzCore/Component/EntityBus.h>
|
||||
#include <AzCore/IO/Path/Path.h>
|
||||
#include <AzCore/std/optional.h>
|
||||
#include <AzToolsFramework/Entity/EditorEntityContextBus.h>
|
||||
#include <AzToolsFramework/API/EditorPythonScriptNotificationsBus.h>
|
||||
|
||||
namespace AZ
|
||||
{
|
||||
class ComponentDescriptor;
|
||||
}
|
||||
|
||||
namespace PythonCoverage
|
||||
{
|
||||
//! System component for PythonCoverage editor.
|
||||
class PythonCoverageEditorSystemComponent
|
||||
: public AZ::Component
|
||||
, private AZ::EntitySystemBus::Handler
|
||||
, private AzToolsFramework::EditorPythonScriptNotificationsBus::Handler
|
||||
{
|
||||
public:
|
||||
AZ_COMPONENT(PythonCoverageEditorSystemComponent, "{33370075-3aea-49c4-823d-476f8ac95b6f}");
|
||||
static void Reflect(AZ::ReflectContext* context);
|
||||
|
||||
PythonCoverageEditorSystemComponent() = default;
|
||||
|
||||
private:
|
||||
//! The coverage state for Python tests.
|
||||
enum class CoverageState : AZ::u8
|
||||
{
|
||||
Disabled, //!< Python coverage is disabled.
|
||||
Idle, //!< Python coverage is enabled but not actively gathering coverage data.
|
||||
Gathering //!< Python coverage is enabled and actively gathering coverage data.
|
||||
};
|
||||
|
||||
// AZ::Component overrides...
|
||||
void Activate() override;
|
||||
void Deactivate() override;
|
||||
|
||||
// AZ::EntitySystemBus overrides...
|
||||
void OnEntityActivated(const AZ::EntityId& entityId) override;
|
||||
|
||||
// AZ::EditorPythonScriptNotificationsBus ...
|
||||
void OnStartExecuteByFilenameAsTest(AZStd::string_view filename, AZStd::string_view testCase, const AZStd::vector<AZStd::string_view>& args) override;
|
||||
|
||||
//! Enumerates all of the loaded shared library modules and the component descriptors that belong to them.
|
||||
void EnumerateAllModuleComponents();
|
||||
|
||||
//! Enumerates all of the component descriptors for the specified entity.
|
||||
void EnumerateComponentsForEntity(const AZ::EntityId& entityId);
|
||||
|
||||
//! Attempts to parse the test impact analysis framework configuration file.
|
||||
//! If either the test impact analysis framework is disabled or the configuration file cannot be parsed, python coverage is disabled.
|
||||
//! @returns The coverage state after the parsing attempt.
|
||||
CoverageState ParseCoverageOutputDirectory();
|
||||
|
||||
//! Returns all of the shared library modules that parent the component descriptors of the specified set of activated entities.
|
||||
//! @note Entity component descriptors are still retrieved even if the entity in question has since been deactivated.
|
||||
//! @param entityComponents The set of activated entities and their component descriptors to get the parent modules for.
|
||||
AZStd::unordered_set<AZStd::string> GetParentComponentModulesForAllActivatedEntities(
|
||||
const AZStd::unordered_map<AZ::Uuid, AZ::ComponentDescriptor*>& entityComponents) const;
|
||||
|
||||
//! Writes the current coverage data snapshot to disk.
|
||||
void WriteCoverageFile();
|
||||
|
||||
CoverageState m_coverageState = CoverageState::Disabled; //!< Current coverage state.
|
||||
AZStd::unordered_map<AZStd::string, AZStd::unordered_map<AZ::Uuid, AZ::ComponentDescriptor*>> m_entityComponentMap; //!< Map of
|
||||
//!< component IDs to component descriptors for all activated entities, organized by test cases.
|
||||
AZStd::unordered_map<AZ::Uuid, AZStd::string> m_moduleComponents; //!< Map of component IDs to module names for all modules.
|
||||
AZ::IO::Path m_coverageDir; //!< Directory to write coverage data to.
|
||||
AZ::IO::Path m_coverageFile; //!< Full file path to write coverage data to.
|
||||
AZStd::string m_testCase; //!< Name of current test case that coverage data is being gathered for.
|
||||
};
|
||||
} // namespace PythonCoverage
|
||||
@ -0,0 +1,15 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
set(FILES
|
||||
Source/PythonCoverageEditorSystemComponent.cpp
|
||||
Source/PythonCoverageEditorSystemComponent.h
|
||||
)
|
||||
@ -0,0 +1,15 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
|
||||
set(FILES
|
||||
Source/PythonCoverageEditorModule.cpp
|
||||
Source/PythonCoverageEditorModule.h
|
||||
)
|
||||
@ -0,0 +1,13 @@
|
||||
{
|
||||
"gem_name": "PythonCoverage",
|
||||
"display_name": "PythonCoverage",
|
||||
"summary": "A tool for generating gem coverage for Python tests.",
|
||||
"canonical_tags": [
|
||||
"Gem"
|
||||
],
|
||||
"user_tags": [
|
||||
"PythonCoverage"
|
||||
],
|
||||
"icon_path": "preview.png",
|
||||
"restricted_name": "gems"
|
||||
}
|
||||
@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:6d6204c6730e5675791765ca194e9b1cbec282208e280507de830afc2805e5fa
|
||||
size 41127
|
||||
@ -0,0 +1,45 @@
|
||||
/*
|
||||
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
* its licensors.
|
||||
*
|
||||
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||
* distribution (the "License"). All use of this software is governed by the License,
|
||||
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
*
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <AzCore/EBus/EBus.h>
|
||||
#include <AzCore/std/string/string.h>
|
||||
|
||||
namespace AzToolsFramework
|
||||
{
|
||||
//! Provides a bus to notify when Python scripts are about to run.
|
||||
class EditorPythonScriptNotifications
|
||||
: public AZ::EBusTraits
|
||||
{
|
||||
public:
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
// EBusTraits overrides
|
||||
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple;
|
||||
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
|
||||
//! Notifies the start of execution of a Python script using a string.
|
||||
virtual void OnStartExecuteByString([[maybe_unused]] AZStd::string_view script) {}
|
||||
|
||||
//! Notifies the start of execution of a Python script using a filename.
|
||||
virtual void OnStartExecuteByFilename([[maybe_unused]] AZStd::string_view filename) {}
|
||||
|
||||
//! Notifies the start of execution of a Python script using a filename and args.
|
||||
virtual void OnStartExecuteByFilenameWithArgs(
|
||||
[[maybe_unused]] AZStd::string_view filename, [[maybe_unused]] const AZStd::vector<AZStd::string_view>& args) {}
|
||||
|
||||
//! Notifies the start of execution of a Python script as a test.
|
||||
virtual void OnStartExecuteByFilenameAsTest(
|
||||
[[maybe_unused]] AZStd::string_view filename, [[maybe_unused]] AZStd::string_view testCase, [[maybe_unused]] const AZStd::vector<AZStd::string_view>& args) {}
|
||||
};
|
||||
using EditorPythonScriptNotificationsBus = AZ::EBus<EditorPythonScriptNotifications>;
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"gems": {
|
||||
[
|
||||
${enumerated_gem_targets}
|
||||
]
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue