|
|
@@ -14,7 +14,28 @@ Test guidance will sometimes note specific issues to watch for. The common issue
|
|
|
1. Console log errors/warnings/spam
|
|
|
2. Asserts
|
|
|
|
|
|
-### Workflow 1: Editor launch, Level CRUD, Entity/Component CRUD
|
|
|
+## Documents and Common Terms
|
|
|
+* [Gems in Open 3D Engine](https://www.o3de.org/docs/user-guide/gems/)
|
|
|
+* [Adding and Removing Gems in a Project](https://www.o3de.org/docs/user-guide/project-config/add-remove-gems/)
|
|
|
+
|
|
|
+## Supported Graphical Configuration Variants
|
|
|
+
|
|
|
+### Resolutions
|
|
|
+
|
|
|
+* 1080p (1920x1080)
|
|
|
+* 4k (3840 x 2160)
|
|
|
+* WQD (3440x1440)
|
|
|
+* WQD+ (3840×1600)
|
|
|
+
|
|
|
+### Scaling
|
|
|
+
|
|
|
+* 100
|
|
|
+* 125
|
|
|
+* 150
|
|
|
+* 175
|
|
|
+* 200
|
|
|
+
|
|
|
+## Workflow 1: Editor launch, Level CRUD, Entity/Component CRUD
|
|
|
|
|
|
**Product:**
|
|
|
Saved and exported level with an interesting scene
|
|
|
@@ -24,14 +45,16 @@ Saved and exported level with an interesting scene
|
|
|
|
|
|
| Workflow | Requests | Things to Watch For |
|
|
|
|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
-| Launch Editor | | * Excessive load times<br>* Inaccurate splash screen/start screen art/text<br>* Asset Processor launch |
|
|
|
-| Create a new level/Open an existing level | | * Excessive load times |
|
|
|
-| Create several new entities | * Create some in Entity Outliner/some in Viewport<br>* Try duplicating/copy pasting entities to create new copies<br>* Drag in prefabs from Asset Browser<br>* Instantiate prefabs from context menu<br>* Undo/Redo | * Entity names |
|
|
|
-| Add/edit various components to entities to create an interesting scene | * As components are added to entities, position entities around Viewport using Transform/Rotate/Scale controls with snapping both enabled/disabled <br>* Make changes via Transform component as well<br>* Undo/Redo | * Component property control issues (Sliders/dropdowns/text boxes)<br>* Component dependencies<br>* Rendering changes reflected in Viewport<br>* Viewport controls |
|
|
|
+| Launch Editor | | <ul><li>Excessive load times.</li><li>Inaccurate splash screen/start screen art/text.</li><li>Asset Processor launch.</li></ul> |
|
|
|
+| Create a new level/Open an existing level | | <ul><li>Excessive load times.</li></ul> |
|
|
|
+| Create several new entities | <ol><li>Create some in Entity Outliner/some in Viewport.</li><li>Try duplicating/copy pasting entities to create new copies.</li><li>Drag in prefabs from Asset Browser.</li><li>Instantiate prefabs from context menu.</li><li>Undo/Redo.</li></ol>| <ul><li>Entity names.</li></ul> |
|
|
|
+| Add/edit various components to entities to create an interesting scene | <ol><li>As components are added to entities, position entities around Viewport using Transform/Rotate/Scale controls with snapping both enabled/disabled.</li><li>Make changes via Transform component as well.</li><li>Undo/Redo.</li></ol>| <ul><li>Component property control issues (Sliders/dropdowns/text boxes).</li><li>Component dependencies.</li><li>Rendering changes reflected in Viewport.</li><li>Viewport controls.</li></ul>|
|
|
|
| Enter Game Mode | | |
|
|
|
-| Save/Export level | | * Asset Processor errors with level processing |
|
|
|
+| Save/Export level | | <ul><li>Asset Processor errors with level processing.</li></ul> |
|
|
|
+| Resolution and Scaling | <ol><li>Launch the Editor and load any level.</li><li>Choose from the [Supported Graphical Configuration Variants](#supported-graphical-configuration-variants) three pairs of [Resolution](#resolutions) and [Scaling](#scaling).</li><li>Check the pairs configuration on your system.</li><li>Check each configuration with windowed and fullscreen Editor.</li></ol>| <ul><li>Restarting the editor after toggling full screen/windowed mode.</li><li>During full regression check all listed [Resolution](#resolutions) and [Scaling](#scaling) pairs.</li></ul>|
|
|
|
+---
|
|
|
|
|
|
-### Workflow 2: UI Layout Customization, Docking/Window Management
|
|
|
+## Workflow 2: UI Layout Customization, Docking/Window Management
|
|
|
|
|
|
**Product:**
|
|
|
Saved Editor UI Layout
|
|
|
@@ -41,14 +64,15 @@ Saved Editor UI Layout
|
|
|
|
|
|
| Workflow | Requests | Things to Watch For |
|
|
|
|------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
|
|
|
-| Reset to Default Editor Layout | | * Incorrectly sized/hidden windows |
|
|
|
-| Open several commonly used tools | * Use a mixture of hotkeys/tools menu | * Tools failing to open/opening offscreen |
|
|
|
-| Move some tools to secondary monitor | | * Scaling issues/windows popping offscreen/hiding |
|
|
|
-| Dock some tools together and leave some windows free floating/snapped to other windows to create a custom layout | * Dock side-by-side/create a tabbed group<br>* Use both monitors | * Unusable tools<br>* Hidden windows/panes<br>* Scaling issues |
|
|
|
+| Reset to Default Editor Layout | | <ul><li>Incorrectly sized/hidden windows.</li></ul> |
|
|
|
+| Open several commonly used tools | <ol><li>Use a mixture of hotkeys/tools menu.</li></ol> | <ul><li>Tools failing to open/opening offscreen.</li></ul> |
|
|
|
+| Move some tools to secondary monitor | | <ul><li>Scaling issues/windows popping offscreen/hiding.</li></ul> |
|
|
|
+| Dock some tools together and leave some windows free floating/snapped to other windows to create a custom layout | <ol><li>Dock side-by-side/create a tabbed group.</li><li>Use both monitors.</li></ol> | <ul><li>Unusable tools.</li><li>Hidden windows/panes.</li><li>Scaling issues.</li></ul>|
|
|
|
| Name and save the custom layout | | |
|
|
|
-| Load back and forth between a few different layouts | * Verify layouts load successfully with elements on both monitors<br>* Relaunch Editor while testing to ensure proper saves | * Missing tools/unsaved/unloaded changes |
|
|
|
+| Load back and forth between a few different layouts | <ol><li>Verify layouts load successfully with elements on both monitors.</li><li>Relaunch Editor while testing to ensure proper saves.</li></ol>| <ul><li>Missing tools/unsaved/unloaded changes.</li></ul>|
|
|
|
+---
|
|
|
|
|
|
-### Workflow 3: Prefab Editing Focus Mode
|
|
|
+## Workflow 3: Prefab Editing Focus Mode
|
|
|
|
|
|
**Product:**
|
|
|
No tangible product, this workflow covers updating/manipulating tangible products, but doesn't itself generate any
|
|
|
@@ -61,12 +85,13 @@ Create a Prefab with at least 2 entities underneath, each having a Mesh componen
|
|
|
|
|
|
| Workflow | Requests | Things to Watch For |
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
-| With the prefab instance closed for editing click the Mesh entities making up the prefab in the Viewport | | * Clicking the entities that are a part of the prefab in the Viewport should only select the prefab root entity<br>* It should not be possible to select the entities inside a prefab while it is not being edited, in any way, either through Viewport or Entity Outliner |
|
|
|
-| Enter Focus Mode to edit a prefab | * Utilize both double-clicking and right-click context menu's Edit Prefab option | * Entity Outliner should update and display the contents of the prefab being edited<br>* Color of the container should change to a lighter blue |
|
|
|
-| With the prefab instance opened for editing click entities outside of the prefab instance | * Try from within both the Viewport and the Entity Outliner<br>* Try to toggle Hide/Lock for entities outside of the prefab instance | * There should be clear a visual indication that entities outside of the focus tree are not selectable (WIP) |
|
|
|
-| With the prefab instance opened for editing verify the breadcrumb widget at the upper-left of the Viewport displays the currently focused prefab, and the path to it from the level root | * Add additional entities to the prefab hierarchy and click through the breadcrumb widget to ensure the mode changes as expected | |
|
|
|
+| With the prefab instance closed for editing click the Mesh entities making up the prefab in the Viewport | | <ul><li>Clicking the entities that are a part of the prefab in the Viewport should only select the prefab root entity.</li><li>It should not be possible to select the entities inside a prefab while it is not being edited, in any way, either through Viewport or Entity Outliner.</li></ul>|
|
|
|
+| Enter Focus Mode to edit a prefab | <ol><li>Utilize both double-clicking and `right-click` context menu's Edit Prefab option.</li></ol> | <ul><li>Entity Outliner should update and display the contents of the prefab being edited.</li><li>Color of the container should change to a lighter blue.</li></ul> |
|
|
|
+| With the prefab instance opened for editing click entities outside of the prefab instance | <ol><li>Try from within both the Viewport and the Entity Outliner.</li><li>Try to toggle Hide/Lock for entities outside of the prefab instance.</li></ol>| <ul><li>There should be clear a visual indication that entities outside of the focus tree are not selectable (WIP).</li></ul> |
|
|
|
+| With the prefab instance opened for editing verify the breadcrumb widget at the upper-left of the Viewport displays the currently focused prefab, and the path to it from the level root | <ol><li>Add additional entities to the prefab hierarchy and click through the breadcrumb widget to ensure the mode changes as expected.</li></ol>| |
|
|
|
+---
|
|
|
|
|
|
-### Workflow 4: Read-Only Entities
|
|
|
+## Workflow 4: Read-Only Entities
|
|
|
|
|
|
**Product:**
|
|
|
No tangible product, this workflow covers updating/manipulating tangible products, but doesn't itself generate any
|
|
|
@@ -77,13 +102,29 @@ No tangible product, this workflow covers updating/manipulating tangible product
|
|
|
**Setup:**
|
|
|
Instantiate a Procedural Prefab (Example Procedural Prefabs in AutomatedTesting: _Objects\\sphere\_5lods\_fbx.procprefab, multiple\_mesh\_one\_material\\multiple\_mesh\_one\_material\_fbx.procprefab_
|
|
|
|
|
|
-| Workflow | Requests | Things to Watch For |
|
|
|
-|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
-| Instantiate a Procedural Prefab | * Try via right-click context menu<br>* Try via drag-and-drop from the Asset Browser (Not Yet Implemented) | * Unusual delays in instantiation<br>* Console errors/asserts |
|
|
|
-| Entity Outliner:<br>Procedural Prefab container is distinct from normal Prefabs (currently Purple container color as opposed to Blue for normal prefabs) | * Enter Focus Mode on the Procedural Prefab container: | * Procedural Prefab container is distinct from normal Prefabs (currently Purple container color as opposed to Blue for normal prefabs) |
|
|
|
-| Entity Outliner:<br>Mouseover container entity | | * Tooltip reads, "Double-click to inspect"<br>* Container icon is unique with an eye icon in place of the normal pencil icon |
|
|
|
-| Entity Outliner:<br>Enter Focus Mode on the Procedural Prefab container | * Test via right-click context menu and double-clicking the container entity | * Hide/Lock functionality is disabled on the container and all child read-only entities<br>* Read-only entities have unique icon with a lock icon over the normal box icon |
|
|
|
-| Entity Outliner:<br>While in Focus Mode, attempt CRUD operations on read-only entities via context menu | * Try reparenting entities<br>* Try deleting entities<br>* Try Hiding/Locking entities<br>* Try parenting non-read-only entities to read-only entities and via the Transform component Parent entity reference in the Entity Inspector<br>* Try dragging an asset/prefab from the Asset Browser over the read-only entities | * Only options available to read-only entities are "Open pinned Inspector" and "Find in viewport"<br>* Read-only entities and their children cannot be reparented or deleted<br>* Non read-only entities cannot be parented to read-only entities via UI operations<br>* Selecting read-only entities in the Outliner selects the corresponding entity in the Viewport, but no manipulator gizmos are usable<br>* Selecting read-only entities in the Outliner displays the component information in the Entity Inspector:<br><ul>* Components should be greyed out<br>* Name field is not editable<br>* No new components can be added<br>* Existing components cannot be removed<br>* Components can be copied<br></ul>* Dragging an asset/prefab from the Asset Browser over the read-only entities is not allowed |
|
|
|
-| Entity Outliner:<br>Perform right-click context menu operations on the Procedural Prefab container | * Utilize hotkeys as well to perform actions where possible (e.g. Delete and Duplicate) | * Instantiate Prefab/Procedural Prefab is not allowed<br>* "Save Prefab to file" should result in an appropriate error message as changes cannot be saved<br>* "Create Prefab" should create a new normal prefab with the Procedural Prefab nested inside. |
|
|
|
-| Viewport:<br>Click the container entity in the Viewport should enable manipulator gizmos | | * Manipulator gizmos should be available for the container when not in Focus Mode |
|
|
|
-| Viewport:<br>Double-click the container entity in the Viewport to enter Focus Mode | | * Focus Mode is entered<br>* No manipulator gizmos are available on the container entity or child read-only entities<br>* Right-click context menus are limited to "Open pinned Inspector" and "Find in viewport"<br>* Selecting read-only entities in the Outliner displays the component information in the Entity Inspector:<br><ul>* Components should be greyed out<br>* Name field is not editable<br>* No new components can be added<br>* Existing components cannot be removed<br>* Components can be copied<br></ul>* Dragging an asset/prefab from the Asset Browser into the Viewport while a Procedural Prefab is focused is not allowed |
|
|
|
+| Workflow | Requests | Things to Watch For |
|
|
|
+|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
+| Instantiate a Procedural Prefab | <ol><li>Try via `right-click` context menu.</li><li>Try via drag-and-drop from the Asset Browser. (Not Yet Implemented)</li></ol> | <ul><li>Unusual delays in instantiation.</li><li>Console errors/asserts.</li></ul> |
|
|
|
+| Entity Outliner: Procedural Prefab container is distinct from normal Prefabs (currently Purple container color as opposed to Blue for normal prefabs) | <ol><li>Enter Focus Mode on the Procedural Prefab container:</li></ol> | <ul><li>Procedural Prefab container is distinct from normal Prefabs. (currently Purple container color as opposed to Blue for normal prefabs)</li></ul> |
|
|
|
+| Entity Outliner: Mouseover container entity | | <ul><li>Tooltip reads, "Double-click to inspect".</li><li>Container icon is unique with an eye icon in place of the normal pencil icon.</li></ul> |
|
|
|
+| Entity Outliner: Enter Focus Mode on the Procedural Prefab container | <ol><li>Test via `right-click` context menu and double-clicking the container entity.</li></ol> | <ul><li>Hide/Lock functionality is disabled on the container and all child read-only entities.</li><li>Read-only entities have unique icon with a lock icon over the normal box icon.</li></ul> |
|
|
|
+| Entity Outliner: While in Focus Mode, attempt CRUD operations on read-only entities via context menu | <ol><li>Try reparenting entities.</li><li>Try deleting entities.</li><li>Try Hiding/Locking entities.</li><li>Try parenting non-read-only entities to read-only entities and via the Transform component Parent entity reference in the Entity Inspector.</li><li>Try dragging an asset/prefab from the Asset Browser over the read-only entities.</li></ol>| <ul><li>Only options available to read-only entities are "Open pinned Inspector" and "Find in viewport".</li><li>Read-only entities and their children cannot be reparented or deleted.</li><li>Non read-only entities cannot be parented to read-only entities via UI operations.</li><li>Selecting read-only entities in the Outliner selects the corresponding entity in the Viewport, but no manipulator gizmos are usable.</li><li>Selecting read-only entities in the Outliner displays the component information in the Entity Inspector:</li><ul><li>Components should be greyed out.</li><li>Name field is not editable.</li><li>No new components can be added.</li><li>Existing components cannot be removed.</li><li>Components can be copied</li></ul><li>Dragging an asset/prefab from the Asset Browser over the read-only entities is not allowed.</li></ul>|
|
|
|
+| Entity Outliner: Perform right-click context menu operations on the Procedural Prefab container | <ol><li>Utilize hotkeys as well to perform actions where possible.(e.g. Delete and Duplicate)</li></ol> | <ul><li>Instantiate Prefab/Procedural Prefab is not allowed.</li><li>"Save Prefab to file" should result in an appropriate error message as changes cannot be saved.</li><li>"Create Prefab" should create a new normal prefab with the Procedural Prefab nested inside.</li></ul> |
|
|
|
+| Viewport: Click the container entity in the Viewport should enable manipulator gizmos | | <ul><li>Manipulator gizmos should be available for the container when not in Focus Mode.</li></ul> |
|
|
|
+| Viewport: Double-click the container entity in the Viewport to enter Focus Mode | | <ul><li>Focus Mode is entered.</li><li>No manipulator gizmos are available on the container entity or child read-only entities.</li><li>`Right-click` context menus are limited to "Open pinned Inspector" and "Find in viewport".</li><li>Selecting read-only entities in the Outliner displays the component information in the Entity Inspector:</li><ul><li>Components should be greyed out.</li><li>Name field is not editable.</li><li>No new components can be added.</li><li>Existing components cannot be removed.</li><li>Components can be copied.</li></ul><li>Dragging an asset/prefab from the Asset Browser into the Viewport while a Procedural Prefab is focused is not allowed.</li></ul> |
|
|
|
+---
|
|
|
+
|
|
|
+## Workflow 5: Gem dependencies
|
|
|
+
|
|
|
+**Product:**
|
|
|
+A project with the White Box and the Script Canvas gems activated.
|
|
|
+
|
|
|
+
|
|
|
+**Suggested Time Box:** 15 mins
|
|
|
+
|
|
|
+| Workflow | Requests | Things to Watch For |
|
|
|
+|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
+| White Box gem | <ol><li>Create an entity and add the White Box component to it.</li><li>Save the level and turn the Editor off.</li><li>In the Project Manager select the project's hamburger menu and select configure gems.</li><li>Search for the White Box gem, deactivate it and save.</li><li>Rebuild the project, launch it and open the previously created level.</li><li>Search for the White Box component in the "Add component" dropdown list.</li></ol>| <ul><li>Correct and informative error messages.</li><li>Component correctly deactivated and not selectable.</li></ul>|
|
|
|
+| Script Canvas gem | <ol><li>Verify that the Script Canvas tool is listed in the Tools menu.</li><li>Create an entity and add the Script Canvas component to it.</li><li>Save the project and turn it off.</li><li>In the Project Manager select the project's hamburger menu and select configure gems.</li><li>Search for the Script Canvas gem, deactivate it and save. (Confirm the popup informing of no longer needed dependencies)</li><li>Rebuild the project and open it.</li><li>Verify that the Script Canvas in not listed in the Tools menu.</li></ol>| <ul><li>Correct and informative error messages.</li><li>Prompt about no longer needed dependent gems.</li><li>Component correctly deactivated and not selectable.</li><li>Script Canvas removed from the Tools menu.</li></ul>|
|
|
|
+---
|
|
|
+
|
Jarosław Gawęda-Ścibior