Browse Source

Merge pull request #107 from LB-JakubSkorupka/testbranch

Adding python scripting workflow
Fuzzy Carter 2 years ago
parent
commit
f6d8f67ecb

BIN
testing-guidance/workflow-tests/scripting/images/Python_Scripts_Tool.png


+ 39 - 0
testing-guidance/workflow-tests/scripting/script-python-tests.md

@@ -0,0 +1,39 @@
+# Python Scripts Workflow Tests
+
+Testing in this area should focus on the functionality of executing python scripts.
+
+## Common Issues to Watch For
+
+Test guidance will sometimes note specific issues to watch for. The common issues below should be watched for through all testing, even if unrelated to the current workflow being tested.
+1. Asset processor errors when importing/executing python scripts
+2. Warnings or errors that appear in the Editor console
+3. Unresponsive UI elements 
+
+### Platforms:
+
+- Windows
+- Linux
+
+### Documents and Common Terms
+
+[O3DE Documentation: Editor Python Bindings Gem](https://www.o3de.org/docs/user-guide/gems/reference/script/python/editor-python-bindings/)
+
+**Python Scripts**: Tool that lists python script samples and allows to execute those scripts.
+
+## Area: Opening Python Scripts tool and executing sample scripts
+
+### Project Requirements
+
+ - Any project can be used, the Editor Python Bindings gem and its gem dependencies are required.
+ - White box Gem is required to visualize easily the script execution as it includes a python scripts that create various entities with meshes.
+
+
+**Product:** 
+Visible and responsive Python Script tool.
+
+**Suggested Time Box:** 
+15 minutes
+
+| Workflow                                                            | Requests                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Things to Watch For                                                                                                                                                                                                                               |
+|---------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|Executing python script samples| <ul><li>Open Python Scripts tool via Tools -> Other -> Python Scripts</li><li>Select a script to execute (e. g. Sphere, Staircase)![Python Scripts Tool](images/Python_Scripts_Tool.png)</li><li>Execute selected script using dedicated Execution button.</li></ul>|<ul> <li> Script executes without errors/warnings in the console.</li><li>Entity with mesh component is created and visible in Viewport.</li></ul>