godot-e2e 1.0.0__tar.gz

godot_e2e-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

godot_e2e-1.0.0/NOTICE

@@ -0,0 +1,14 @@
+godot-e2e
+Copyright 2026 LIU MINGJUN (RandallLiuXin)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

godot_e2e-1.0.0/PKG-INFO

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: godot-e2e
+Version: 1.0.0
+Summary: Out-of-process E2E testing tool for Godot
+Author: LIU MINGJUN
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/RandallLiuXin/godot-e2e
+Project-URL: Repository, https://github.com/RandallLiuXin/godot-e2e
+Project-URL: Documentation, https://github.com/RandallLiuXin/godot-e2e/tree/main/docs
+Project-URL: Issues, https://github.com/RandallLiuXin/godot-e2e/issues
+Project-URL: Changelog, https://github.com/RandallLiuXin/godot-e2e/blob/main/CHANGELOG.md
+Keywords: godot,e2e,testing,game,automation,pytest
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: Pytest
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pytest>=7.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+**English** | [中文](README.zh-CN.md)
+
+# godot-e2e
+
+[![CI](https://github.com/RandallLiuXin/godot-e2e/actions/workflows/ci.yml/badge.svg)](https://github.com/RandallLiuXin/godot-e2e/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/godot-e2e)](https://pypi.org/project/godot-e2e/)
+[![Python](https://img.shields.io/badge/Python-3.9%2B-blue?logo=python&logoColor=white)](https://pypi.org/project/godot-e2e/)
+[![Godot](https://img.shields.io/badge/Godot-4.x-blue?logo=godotengine)](https://godotengine.org/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-green)](LICENSE)
+
+Out-of-process E2E testing tool for Godot
+
+---
+
+## Quick Start
+
+**1. Install the addon**
+
+Copy `addons/godot_e2e/` into your Godot project's `addons/` directory. Add `AutomationServer`
+as an Autoload in your project settings:
+
+- Path: `*res://addons/godot_e2e/automation_server.gd`
+- Name: `AutomationServer`
+
+The `*` prefix means the script is used directly (not a scene). The server is completely dormant
+unless the game is launched with the `--e2e` flag, so it has no effect in production builds.
+
+**2. Install the Python package**
+
+```bash
+pip install godot-e2e
+```
+
+Or install from source:
+
+```bash
+pip install -e .
+```
+
+**3. Write a test**
+
+```python
+from godot_e2e import GodotE2E
+
+def test_player_moves(game):
+    initial_x = game.get_property("/root/Main/Player", "position:x")
+    game.press_action("move_right")
+    game.wait_physics_frames(10)
+    new_x = game.get_property("/root/Main/Player", "position:x")
+    assert new_x > initial_x
+```
+
+Run:
+
+```bash
+pytest tests/ -v
+```
+
+---
+
+## Features
+
+- **Out-of-process** — game runs in a separate process; crashes are isolated and timeouts are safe
+- **No engine modifications** — works with standard Godot 4.x binaries
+- **Synchronous Python API** — no async/await required in test code
+- **Input simulation** — keyboard, mouse clicks, named actions
+- **Node operations** — get/set properties, call methods, group lookup, node existence checks
+- **Frame synchronization** — wait for process frames, physics frames, or game time
+- **Scene management** — change scene, reload scene
+- **Screenshot capture** — manual or automatic on test failure (pytest integration)
+- **pytest fixtures** — built-in fixtures with configurable test isolation strategies
+
+---
+
+## How It Works
+
+Two processes communicate over a local TCP connection:
+
+1. **Python (pytest)** — sends JSON-encoded commands and waits for responses
+2. **Godot (AutomationServer)** — an Autoload that listens on a TCP port, executes commands on
+   the main thread, and sends back results
+
+The `AutomationServer` only opens its socket when the game is started with `--e2e` (and
+optionally `--e2e-port <port>`). In normal play or exported builds without that flag, the autoload
+does nothing.
+
+```
+pytest ──── TCP (localhost) ──── AutomationServer (Godot Autoload)
+  sends: {"cmd": "get_property", "path": "/root/Main/Player", "prop": "position:x"}
+  gets:  {"ok": true, "value": 400.0}
+```
+
+---
+
+## pytest Fixtures
+
+Three isolation strategies are available depending on your needs.
+
+### Strategy 1: reload_scene (default, fast)
+
+Reloads the current scene between each test. Cheap and usually sufficient.
+
+```python
+# conftest.py
+import pytest
+from godot_e2e import GodotE2E
+
+GODOT_PROJECT = "/path/to/your/project"
+
+@pytest.fixture(scope="module")
+def _game_process():
+    with GodotE2E.launch(GODOT_PROJECT) as game:
+        game.wait_for_node("/root/Main", timeout=10.0)
+        yield game
+
+@pytest.fixture(scope="function")
+def game(_game_process):
+    _game_process.reload_scene()
+    _game_process.wait_for_node("/root/Main", timeout=5.0)
+    yield _game_process
+```
+
+### Strategy 2: game_fresh (strongest isolation)
+
+Launches a brand new Godot process for each test. Slowest but fully isolated.
+
+```python
+@pytest.fixture(scope="function")
+def game_fresh():
+    with GodotE2E.launch(GODOT_PROJECT) as game:
+        game.wait_for_node("/root/Main", timeout=10.0)
+        yield game
+```
+
+### Strategy 3: Shared session (fastest)
+
+One process for the entire test session. Use when tests are carefully ordered and
+do not share mutable state.
+
+```python
+@pytest.fixture(scope="session")
+def game_session():
+    with GodotE2E.launch(GODOT_PROJECT) as game:
+        game.wait_for_node("/root/Main", timeout=10.0)
+        yield game
+```
+
+---
+
+## CI Configuration
+
+### Linux (GitHub Actions, headless via Xvfb)
+
+```yaml
+- name: Install Godot
+  run: |
+    wget -q https://github.com/godotengine/godot-builds/releases/download/4.4-stable/Godot_v4.4-stable_linux.x86_64.zip
+    unzip -q Godot_v4.4-stable_linux.x86_64.zip
+    sudo mv Godot_v4.4-stable_linux.x86_64 /usr/local/bin/godot
+
+- name: Run E2E tests
+  run: |
+    pip install -e .
+    xvfb-run --auto-servernum pytest tests/e2e/ -v
+```
+
+### Windows (GitHub Actions)
+
+```yaml
+- name: Install Godot
+  run: |
+    Invoke-WebRequest -Uri "https://github.com/godotengine/godot-builds/releases/download/4.4-stable/Godot_v4.4-stable_win64.exe.zip" -OutFile godot.zip
+    Expand-Archive godot.zip -DestinationPath C:\godot
+  shell: pwsh
+
+- name: Run E2E tests
+  run: |
+    pip install -e .
+    pytest tests/e2e/ -v
+  env:
+    GODOT_BIN: C:\godot\Godot_v4.4-stable_win64.exe
+```
+
+### macOS (GitHub Actions)
+
+```yaml
+- name: Install Godot
+  run: |
+    wget -q https://github.com/godotengine/godot-builds/releases/download/4.4-stable/Godot_v4.4-stable_macos.universal.zip
+    unzip -q Godot_v4.4-stable_macos.universal.zip
+    sudo mv "Godot.app" /Applications/Godot.app
+
+- name: Run E2E tests
+  run: |
+    pip install -e .
+    pytest tests/e2e/ -v
+  env:
+    GODOT_BIN: /Applications/Godot.app/Contents/MacOS/Godot
+```
+
+Set `GODOT_BIN` to override the default Godot executable path. The default search order is:
+`godot4`, `godot`, then platform-specific standard locations.
+
+---
+
+## API Reference
+
+### Launch / Lifecycle
+
+| Method | Description |
+|---|---|
+| `GodotE2E.launch(project_path, **kwargs)` | Context manager. Launches Godot and returns a connected `GodotE2E` instance. |
+| `game.close()` | Terminate the Godot process and close the connection. |
+
+### Node Operations
+
+| Method | Description |
+|---|---|
+| `game.node_exists(path)` | Returns `True` if the node at `path` exists in the scene tree. |
+| `game.wait_for_node(path, timeout=5.0)` | Blocks until the node exists or timeout is reached. |
+| `game.get_property(path, prop)` | Get a property value. Supports dotted paths like `"position:x"`. |
+| `game.set_property(path, prop, value)` | Set a property value on a node. |
+| `game.call_method(path, method, *args)` | Call a method on a node and return the result. |
+| `game.find_by_group(group)` | Return a list of node paths for all nodes in the given group. |
+
+### Input Simulation
+
+| Method | Description |
+|---|---|
+| `game.press_action(action)` | Press and immediately release a named input action. |
+| `game.input_action(action, pressed)` | Set a named input action pressed state. |
+| `game.key_press(scancode)` | Press and release a key by scancode. |
+| `game.mouse_click(x, y, button=1)` | Click a mouse button at the given screen coordinates. |
+
+### Frame Synchronization
+
+| Method | Description |
+|---|---|
+| `game.wait_frames(n)` | Wait for `n` process (`_process`) frames to complete. |
+| `game.wait_physics_frames(n)` | Wait for `n` physics (`_physics_process`) frames to complete. |
+| `game.wait_seconds(t)` | Wait for `t` in-game seconds (affected by `Engine.time_scale`). |
+
+### Scene Management
+
+| Method | Description |
+|---|---|
+| `game.change_scene(scene_path)` | Change to a scene by `res://` path. |
+| `game.reload_scene()` | Reload the current scene. |
+
+### Diagnostics
+
+| Method | Description |
+|---|---|
+| `game.screenshot(path=None)` | Capture a screenshot. Returns PNG bytes; saves to `path` if given. |
+
+---
+
+## Examples
+
+| Example | Description |
+|---|---|
+| [minimal](examples/minimal/) | Simplest setup — node checks, property reading, method calls (3 tests) |
+| [platformer](examples/platformer/) | Player movement, scoring, groups, scene reload (5 tests) |
+| [ui_testing](examples/ui_testing/) | Button clicks, label verification, scene navigation (5 tests) |
+
+Run any example:
+
+```bash
+cd examples/minimal
+pytest tests/e2e/ -v
+```
+
+---
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).