AltTester-Driver 2.2.2__tar.gz → 2.2.5__tar.gz

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/AltTester_Driver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: AltTester-Driver
-Version: 2.2.2
+Version: 2.2.5
 Summary: Python bindings for the AltTester® framework. AltTester® is an open-source UI driven test automation tool that helps you find objects in your game and interacts with them.
 Home-page: https://alttester.com/docs/sdk/latest/
 Author: Altom Consulting

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/AltTester_Driver.egg-info/SOURCES.txt

@@ -41,6 +41,7 @@ alttester/commands/FindObjects/wait_for_component_property.py
 alttester/commands/FindObjects/wait_for_object.py
 alttester/commands/FindObjects/wait_for_object_to_not_be_present.py
 alttester/commands/FindObjects/wait_for_object_which_contains.py
+alttester/commands/FindObjects/wait_for_visual_element_property.py
 alttester/commands/InputActions/__init__.py
 alttester/commands/InputActions/begin_touch.py
 alttester/commands/InputActions/click_coordinates.py
@@ -88,6 +89,7 @@ alttester/commands/UnityCommands/set_player_pref_key.py
 alttester/commands/UnityCommands/set_time_scale.py
 alttester/commands/UnityCommands/unload_scene.py
 alttester/commands/UnityCommands/wait_for_current_scene_to_be.py
+tests/test_rec.py
 tests/integration/__init__.py
 tests/integration/conftest.py
 tests/integration/test_driver.py

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: AltTester-Driver
-Version: 2.2.2
+Version: 2.2.5
 Summary: Python bindings for the AltTester® framework. AltTester® is an open-source UI driven test automation tool that helps you find objects in your game and interacts with them.
 Home-page: https://alttester.com/docs/sdk/latest/
 Author: Altom Consulting

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/alttester/__version__.py

@@ -15,4 +15,4 @@
     along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 
-VERSION = "2.2.2"
+VERSION = "2.2.5"

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/alttester/_websocket.py

@@ -179,6 +179,7 @@ class WebsocketConnection:
         self._command_handler = command_handler
         self._notification_handler = notification_handler
         self._driver_registered_called = False
+        self._implicit_timeout = -1
 
     def __repr__(self):
         return "{}({!r}, {!r}, {!r}, {!r}, {!r})".format(
@@ -287,6 +288,14 @@ class WebsocketConnection:
     def get_command_timeout(self):
         return self.command_timeout
 
+    def set_implicit_timeout(self, timeout):
+        if timeout < 0:
+            raise ValueError("Timeout cannot be negative")
+        self._implicit_timeout = timeout
+
+    def get_implicit_timeout(self):
+        return self._implicit_timeout
+
     def connect(self):
         logger.info("Connecting to URL: '{}'.", self.url)
         last_close_message = None
@@ -330,7 +339,7 @@ class WebsocketConnection:
     def recv(self):
         self._ensure_connection_is_open()
         elapsed_time = 0
-        delay = 0.1
+        delay = 0.01
 
         while elapsed_time <= self.command_timeout:
             if self._command_handler.has_response():

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/alttester/altdriver.py

@@ -147,6 +147,8 @@ class AltDriver:
         if not is_supported:
             message = "Version mismatch. AltDriver version is {}. AltTester(R) version is {}.".format(
                 VERSION, server_version)
+            if server_major == 1:
+                message += " Please update AltTester(R) to version 1.1."
             logger.warning(message)
 
     def _get_alt_object(self, data):
@@ -283,13 +285,13 @@ class AltDriver:
             scene_name, load_single
         )
 
-    def wait_for_current_scene_to_be(self, scene_name, timeout=30, interval=1):
+    def wait_for_current_scene_to_be(self, scene_name, timeout=20, interval=1):
         """Waits for the scene to be loaded for a specified amount of time.
 
         Args:
             scene_name (:obj:`str`): The name of the scene to wait for.
             timeout (obj:`int`, :obj:`float`, optional): The time measured in seconds to wait for the specified scene.
-                Defaults to ``30``.
+                Defaults to ``20``.
             interval (obj:`int`, :obj:`float`, optional): How often to check that the scene was loaded in the given
                 timeout. Defaults to ``1``.
 
@@ -297,7 +299,8 @@ class AltDriver:
             str: The name of the loaded scene.
 
         """
-
+        if self._connection.get_implicit_timeout() != -1 and timeout == 20:
+            timeout = self._connection.get_implicit_timeout()
         return commands.WaitForCurrentSceneToBe.run(
             self._connection,
             scene_name, timeout, interval
@@ -518,6 +521,8 @@ class AltDriver:
 
         """
 
+        if self._connection.get_implicit_timeout() != -1 and timeout == 20:
+            timeout = self._connection.get_implicit_timeout()
         data = commands.WaitForObject.run(
             self._connection,
             by, value, camera_by, camera_value, timeout, interval, enabled
@@ -548,7 +553,8 @@ class AltDriver:
             AltObject: The object.
 
         """
-
+        if self._connection.get_implicit_timeout() != -1 and timeout == 20:
+            timeout = self._connection.get_implicit_timeout()
         data = commands.WaitForObjectWhichContains.run(
             self._connection,
             by, value, camera_by, camera_value, timeout, interval, enabled
@@ -577,7 +583,8 @@ class AltDriver:
                 ``False`` will match all objects. Defaults to ``True``.
 
         """
-
+        if self._connection.get_implicit_timeout() != -1 and timeout == 20:
+            timeout = self._connection.get_implicit_timeout()
         commands.WaitForObjectToNotBePresent.run(
             self._connection,
             by, value, camera_by, camera_value, timeout, interval, enabled
@@ -933,3 +940,14 @@ class AltDriver:
         """Clear all active input actions simulated by AltTester."""
 
         commands.ResetInput.run(self._connection)
+
+    def set_implicit_timeout(self, timeout):
+        """Sets an implicit timeout from tests for the AltTester commands using a timeout.
+        Args:
+            timeout (:obj:`int`): the new value of the timeout.
+        """
+        self._connection.set_implicit_timeout(timeout)
+
+    def get_implicit_timeout(self):
+        """Returns the implicit timeout used by AltTester commands."""
+        return self._connection.get_implicit_timeout()

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/alttester/altobject.py

@@ -201,6 +201,8 @@ class AltObject:
             str: The property value is serialized to a JSON string.
 
         """
+        if self._connection.get_implicit_timeout() != -1 and timeout == 20:
+            timeout = self._connection.get_implicit_timeout()
         return commands.WaitForComponentProperty.run(
             component_name, property_name, property_value,
             assembly, self, timeout, interval, get_property_as_string, max_depth
@@ -398,4 +400,31 @@ class AltObject:
         if self.type != "UIToolkit":
             raise exceptions.WrongAltObjectTypeException(
                 "This method is only available for VisualElement objects")
-        return commands.GetVisualElementProperty.run(self._connection,  property_name, self,)
+        return commands.GetVisualElementProperty.run(self._connection,  property_name, self)
+
+    def wait_for_visual_element_property(self, property_name,
+                                         property_value, timeout=20, interval=0.5,
+                                         get_property_as_string=False):
+        """Waits until a property of the current object has a specific value.
+
+        Args:
+            property_name (str): The name of the property of which value you want to get.
+            property_value (str): The value of the property expected.
+            timeout (int, optional): The number of seconds that it will wait for property. Defaults to 20.
+            interval (int, optional): Time in seconds before retrying. Defaults to 0.5.
+            get_property_as_string (bool, optional): A boolean value that makes the property_value
+                to be compared as a string with the property from the instrumented app. Defaults to False.
+
+        Returns:
+            The property value is serialized to a JSON string.
+
+        Raises:
+            WrongAltObjectTypeException: The method is called on an object that is not a VisualElement.
+        """
+        if self.type != "UIToolkit":
+            raise exceptions.WrongAltObjectTypeException(
+                "This method is only available for VisualElement objects")
+        if self._connection.get_implicit_timeout() != -1 and timeout == 20:
+            timeout = self._connection.get_implicit_timeout()
+        return commands.WaitForVisualElementProperty.run(
+            property_name, property_value, self, timeout, interval, get_property_as_string)

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/alttester/commands/FindObjects/__init__.py

@@ -24,3 +24,4 @@ from alttester.commands.FindObjects.wait_for_object_to_not_be_present import *
 from alttester.commands.FindObjects.wait_for_object_which_contains import *
 from alttester.commands.FindObjects.find_object_at_coordinates import *
 from alttester.commands.FindObjects.wait_for_component_property import *
+from alttester.commands.FindObjects.wait_for_visual_element_property import *

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/alttester/commands/FindObjects/wait_for_component_property.py

@@ -16,6 +16,7 @@
 """
 
 import time
+import json
 from loguru import logger
 from alttester.commands.base_command import Command
 from alttester.exceptions import WaitTimeOutException
@@ -55,8 +56,13 @@ class WaitForComponentProperty(Command):
                 )
                 if not self.get_property_as_string and property_found == self.property_value:
                     return property_found
-                if self.get_property_as_string and \
-                   str(property_found).replace(" ", "") == str(self.property_value).replace(" ", ""):
+                if (str(property_found) == "0.0" and str(self.property_value) == "0"):
+                    return property_found
+                if self.get_property_as_string and (
+                    str(property_found).replace(" ", "") == str(self.property_value).replace(" ", "") or
+                    str(json.dumps(property_found)).replace(" ", "") == str(
+                        self.property_value).replace(" ", "")
+                ):
                     return property_found
             except Exception as ex:
                 exception = ex

alttester_driver-2.2.5/alttester/commands/FindObjects/wait_for_visual_element_property.py

@@ -0,0 +1,79 @@
+"""
+    Copyright(C) 2025 Altom Consulting
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program. If not, see <https://www.gnu.org/licenses/>.
+"""
+
+import time
+import json
+from loguru import logger
+from alttester.commands.base_command import Command
+from alttester.exceptions import WaitTimeOutException
+
+
+class WaitForVisualElementProperty(Command):
+    def __init__(
+        self,
+        property_name,
+        property_value,
+        altObject,
+        timeout=20,
+        interval=0.5,
+        get_property_as_string=False,
+    ):
+        self.property_name = property_name
+        self.property_value = property_value
+        self.timeout = timeout
+        self.interval = interval
+        self.get_property_as_string = get_property_as_string
+        self.altObject = altObject
+
+    def execute(self):
+        t = 0
+        exception = None
+        property_found = None
+        while t <= self.timeout:
+            try:
+                property_found = self.altObject.get_visual_element_property(
+                    self.property_name
+                )
+                if not self.get_property_as_string and property_found == self.property_value:
+                    return property_found
+                if (str(property_found) == "0.0" and str(self.property_value) == "0"):
+                    return property_found
+                if self.get_property_as_string and \
+                   (
+                       str(property_found).replace(" ", "") == str(self.property_value).replace(" ", "") or
+                       str(json.dumps(property_found)).replace(" ", "") == str(
+                        self.property_value).replace(" ", "")
+                   ):
+
+                    return property_found
+            except Exception as ex:
+                exception = ex
+
+            logger.debug("Waiting for property {}...", self.property_name)
+            time.sleep(self.interval)
+            t += self.interval
+        if exception:
+            raise WaitTimeOutException(
+                "After {} seconds, exception was: {} for  property {}".format(
+                    self.timeout, exception, self.property_name
+                )
+            )
+        raise WaitTimeOutException(
+            "Property {} was {}, not {} as expected, after {} seconds".format(
+                self.property_name, property_found, self.property_value, self.timeout
+            )
+        )

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/alttester/commands/base_command.py

@@ -238,7 +238,6 @@ class BaseCommand(Command):
         response = self.connection.recv()
         self.handle_response(response)
         data = response.get("data")
-        time.sleep(0.1)
         if data is None:
             return data
         return json.loads(data)

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/conftest.py

@@ -32,6 +32,8 @@ sys.stdout = sys.stderr
 devices = [
     {"name": "Samsung Galaxy S23", "os": "android", "os_version": "13.0"},
     {"name": "Google Pixel 6 Pro", "os": "android", "os_version": "13.0"},
+    {"name": "iPhone 16", "os": "ios", "os_version": "18"},
+    {"name": "iPhone 15 Pro Max", "os": "ios", "os_version": "17"},
     {"name": "iPhone 14 Pro Max", "os": "ios", "os_version": "16"},
     {"name": "OnePlus 9", "os": "android", "os_version": "11.0"},
     {"name": "iPhone 13 Pro Max", "os": "ios", "os_version": "15"},
@@ -46,6 +48,8 @@ android_devices = [
 ]
 
 ios_devices = [
+    {"name": "iPhone 16", "os": "ios", "os_version": "18"},
+    {"name": "iPhone 15 Pro Max", "os": "ios", "os_version": "17"},
     {"name": "iPhone 14 Pro Max", "os": "ios", "os_version": "16"},
     {"name": "iPhone 13 Pro Max", "os": "ios", "os_version": "15"},
     {"name": "iPhone 12 Pro", "os": "ios", "os_version": "14"},

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene01_part1.py

@@ -27,6 +27,8 @@ class TestScene01Part1:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene01)
 
@@ -540,3 +542,21 @@ class TestScene01Part1:
         capsule = self.alt_driver.find_object(By.NAME, "Capsule")
         final_position = [capsule.worldX, capsule.worldY, capsule.worldZ]
         assert initial_position != final_position
+
+    def test_implicit_timeout(self):
+        self.alt_driver.set_implicit_timeout(1)
+        assert self.alt_driver.get_implicit_timeout() == 1
+        start_time = time.time()
+        try:
+            self.alt_driver.wait_for_object(By.NAME, "Capsulee")
+        except Exception:
+            pass
+        end_time = time.time()
+        elapsed_time = end_time - start_time
+        assert elapsed_time <= 2
+        self.alt_driver.set_implicit_timeout(20)
+
+    def test_implicit_timeout_out_of_range(self):
+        with pytest.raises(ValueError) as exc_info:
+            self.alt_driver.set_implicit_timeout(-5)
+        assert str(exc_info.value) == "Timeout cannot be negative"

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene01_part2.py

@@ -26,6 +26,8 @@ class TestScene01Part2:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene01)
 
@@ -502,7 +504,8 @@ class TestScene01Part2:
 
     def test_find_object_in_object_by_id(self):
         parent = self.alt_driver.find_object(By.NAME, "Canvas")
-        child = parent.find_object_from_object(By.ID, "049eccc5-b072-468b-83bf-119d868ca311")
+        child = parent.find_object_from_object(
+            By.ID, "049eccc5-b072-468b-83bf-119d868ca311")
         assert child.name == "Button"
 
     def test_find_object_in_object_by_text(self):

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene02.py

@@ -25,6 +25,8 @@ class TestScene02:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene02)
 

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene03.py

@@ -26,6 +26,8 @@ class TestScene03:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene03)
 
@@ -50,8 +52,10 @@ class TestScene03:
         self.alt_driver.multipoint_swipe(positions, duration, wait)
 
     def drop_image(self, drag_location_name, drop_location_name, duration, wait):
-        drag_location = self.alt_driver.find_object(By.NAME, drag_location_name)
-        drop_location = self.alt_driver.find_object(By.NAME, drop_location_name)
+        drag_location = self.alt_driver.find_object(
+            By.NAME, drag_location_name)
+        drop_location = self.alt_driver.find_object(
+            By.NAME, drop_location_name)
 
         self.alt_driver.swipe(drag_location.get_screen_position(
         ), drop_location.get_screen_position(), duration, wait)
@@ -122,7 +126,7 @@ class TestScene03:
         self.drop_image_with_multipoint_swipe(
             ["Drag Image1", "Drop Box1"],  1, False)
         self.drop_image_with_multipoint_swipe(
-            ["Drag Image2", "Drop Box1", "Drop Box2"],  1, False)
+            ["Drag Image2", "Drop Box1", "Drop Box2"],  1, True)
 
         image_source, image_source_drop_zone = self.get_sprite_name(
             "Drag Image1", "Drop Image")
@@ -148,6 +152,10 @@ class TestScene03:
         assert image_source == image_source_drop_zone
 
     def test_begin_move_end_touch(self):
+        green_pop_up = self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False)
+        if (green_pop_up.enabled):
+            green_pop_up.click()
         alt_object1 = self.alt_driver.find_object(By.NAME, "Drag Image1")
         alt_object2 = self.alt_driver.find_object(By.NAME, "Drop Box1")
 

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene05.py

@@ -27,6 +27,8 @@ class TestScene05:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene05)
 
@@ -131,15 +133,17 @@ class TestScene05:
 
     def test_key_down_and_key_up(self):
         self.alt_driver.key_down(AltKeyCode.A)
-
-        last_key_down = self.alt_driver.find_object(By.NAME, "LastKeyDownValue")
+        time.sleep(0.1)
+        self.alt_driver.key_up(AltKeyCode.A)
+        time.sleep(0.1)
+        last_key_down = self.alt_driver.find_object(
+            By.NAME, "LastKeyDownValue")
         last_key_press = self.alt_driver.find_object(
             By.NAME, "LastKeyPressedValue")
 
         assert last_key_down.get_text() == "97"
         assert last_key_press.get_text() == "97"
 
-        self.alt_driver.key_up(AltKeyCode.A)
         last_key_up = self.alt_driver.find_object(By.NAME, "LastKeyUpValue")
 
         assert last_key_up.get_text() == "97"

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene07.py

@@ -25,6 +25,8 @@ class TestScene07A:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene07A)
 
@@ -114,7 +116,7 @@ class TestScene07B:
         self.drop_image_with_multipoint_swipe(
             ["Drag Image1", "Drop Box1"], 1, False)
         self.drop_image_with_multipoint_swipe(
-            ["Drag Image2", "Drop Box1", "Drop Box2"], 1, False)
+            ["Drag Image2", "Drop Box1", "Drop Box2"], 1, True)
 
         image_source, image_source_drop_zone = self.get_sprite_name(
             "Drag Image1", "Drop Image")

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene09.py

@@ -25,6 +25,8 @@ class TestScene09:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene09)
 

{alttester_driver-2.2.2 → alttester_driver-2.2.5}/tests/integration/test_scene10.py

@@ -25,6 +25,8 @@ class TestScene10:
 
     @pytest.fixture(autouse=True)
     def setup(self):
+        self.alt_driver.find_object(
+            By.PATH, "/AltTesterPrefab//CloseButton", enabled=False).tap()
         self.alt_driver.reset_input()
         self.alt_driver.load_scene(Scenes.Scene10)
 

alttester_driver-2.2.5/tests/test_rec.py

@@ -0,0 +1,25 @@
+
+# For more info on the setup, check out our docs https://alttester.com/docs/sdk/latest/pages/get-started.html#write-and-execute-first-test-for-your-app
+import unittest
+from alttester import By, AltKeyCode, AltDriver
+import loguru
+
+
+class MyTests(unittest.TestCase):
+
+    sky_atmosphere_path = "/SkyAtmosphere"
+
+    @classmethod
+    def setUp(self):
+        self.alt_driver = AltDriver(
+            host="127.0.0.1", port=13000, app_name="__default__", enable_logging=True)
+        # You might want to load the scene here
+        # self.alt_driver.load_scene("Scene1", True)
+
+    @classmethod
+    def tearDown(self):
+        self.alt_driver.stop()
+
+    def test(self):
+        sky_atmosphere = self.alt_driver.wait_for_object(
+            By.PATH, self.sky_atmosphere_path, timeout=20)