AltTester-Driver 2.0.2__tar.gz → 2.1.0__tar.gz

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/AltTester_Driver.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: AltTester-Driver
-Version: 2.0.2
-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.
+Version: 2.1.0
+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
 Author-email: contact@alttester.com
@@ -34,12 +34,16 @@ Classifier: Topic :: Software Development :: Testing :: Acceptance
 Classifier: Topic :: Software Development :: Testing :: Unit
 Requires-Python: >=3.4.0
 Description-Content-Type: text/markdown
+Requires-Dist: loguru
+Requires-Dist: deprecated
+Requires-Dist: websocket-client
+Requires-Dist: pure-python-adb
 
-# AltTester Python Bindings
+# AltTester® Python Bindings
 
-This package contains an library for adding Python language binding to the AltTester framework.
+This package contains an library for adding Python language binding to the AltTester® framework.
 
-AltTester Unity SDK is an open-source UI driven test automation tool that helps you find objects in your application and interacts with them using tests written in C#, Python or Java.
+AltTester® Unity SDK is an open-source UI driven test automation tool that helps you find objects in your application and interacts with them using tests written in C#, Python, Java or Robot Framework.
 
 You can run your tests on real devices (mobile, PCs, etc.) or inside the Unity Editor.
 

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/AltTester_Driver.egg-info/SOURCES.txt

@@ -91,7 +91,8 @@ tests/integration/conftest.py
 tests/integration/test_driver.py
 tests/integration/test_notifications.py
 tests/integration/test_reverse_port_forwarding.py
-tests/integration/test_scene01.py
+tests/integration/test_scene01_part1.py
+tests/integration/test_scene01_part2.py
 tests/integration/test_scene02.py
 tests/integration/test_scene03.py
 tests/integration/test_scene05.py

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: AltTester-Driver
-Version: 2.0.2
-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.
+Version: 2.1.0
+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
 Author-email: contact@alttester.com
@@ -34,12 +34,16 @@ Classifier: Topic :: Software Development :: Testing :: Acceptance
 Classifier: Topic :: Software Development :: Testing :: Unit
 Requires-Python: >=3.4.0
 Description-Content-Type: text/markdown
+Requires-Dist: loguru
+Requires-Dist: deprecated
+Requires-Dist: websocket-client
+Requires-Dist: pure-python-adb
 
-# AltTester Python Bindings
+# AltTester® Python Bindings
 
-This package contains an library for adding Python language binding to the AltTester framework.
+This package contains an library for adding Python language binding to the AltTester® framework.
 
-AltTester Unity SDK is an open-source UI driven test automation tool that helps you find objects in your application and interacts with them using tests written in C#, Python or Java.
+AltTester® Unity SDK is an open-source UI driven test automation tool that helps you find objects in your application and interacts with them using tests written in C#, Python, Java or Robot Framework.
 
 You can run your tests on real devices (mobile, PCs, etc.) or inside the Unity Editor.
 

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/README.md

@@ -1,8 +1,8 @@
-# AltTester Python Bindings
+# AltTester® Python Bindings
 
-This package contains an library for adding Python language binding to the AltTester framework.
+This package contains an library for adding Python language binding to the AltTester® framework.
 
-AltTester Unity SDK is an open-source UI driven test automation tool that helps you find objects in your application and interacts with them using tests written in C#, Python or Java.
+AltTester® Unity SDK is an open-source UI driven test automation tool that helps you find objects in your application and interacts with them using tests written in C#, Python, Java or Robot Framework.
 
 You can run your tests on real devices (mobile, PCs, etc.) or inside the Unity Editor.
 

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/alttester/__version__.py

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

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/alttester/_websocket.py

@@ -32,7 +32,7 @@ from .commands.Notifications.load_scene_mode import LoadSceneMode
 
 
 class Store:
-    """Stores the responses from AltServer."""
+    """Stores the responses from AltTester® Server."""
 
     def __init__(self, dict=None):
         self._store = dict or defaultdict(deque)
@@ -57,7 +57,7 @@ class Store:
 
 
 class NotificationHandler:
-    """Handles the parsing of the notification messages from AltServer."""
+    """Handles the parsing of the notification messages from AltTester® Server."""
 
     def __init__(self):
         self._notification_callbacks = defaultdict(list)
@@ -104,7 +104,7 @@ class NotificationHandler:
 
 
 class CommandHandler:
-    """Handles the parsing of command messages from AltServer."""
+    """Handles the parsing of command messages from AltTester® Server."""
 
     def __init__(self):
         self._store = Store()
@@ -116,7 +116,8 @@ class CommandHandler:
         return "{}()".format(self.__class__.__name__)
 
     def set_current_command(self, message):
-        self._current_command = (message.get("messageId"), message.get("commandName"))
+        self._current_command = (message.get(
+            "messageId"), message.get("commandName"))
 
     def get_current_command(self):
         return self._current_command
@@ -143,7 +144,7 @@ class CommandHandler:
 
 
 class WebsocketConnection:
-    """Handles the websocket connection with AltServer.
+    """Handles the websocket connection with AltTester® Server.
 
     Args:
         host (:obj:`str`, optional): The host to connect to. Defaults to ``127.0.0.1``.
@@ -161,7 +162,8 @@ class WebsocketConnection:
         self.path = path
         self.params = params or {}
 
-        self.url = urlunparse(["ws", "{}:{}".format(self.host, self.port), self.path, "", urlencode(self.params), ""])
+        self.url = urlunparse(["ws", "{}:{}".format(
+            self.host, self.port), self.path, "", urlencode(self.params), ""])
 
         self.timeout = timeout
         self.command_timeout = 60
@@ -176,6 +178,7 @@ class WebsocketConnection:
 
         self._command_handler = command_handler
         self._notification_handler = notification_handler
+        self._driver_registered_called = False
 
     def __repr__(self):
         return "{}({!r}, {!r}, {!r}, {!r}, {!r})".format(
@@ -198,20 +201,28 @@ class WebsocketConnection:
             on_error=self._on_error,
             on_close=self._on_close
         )
-        self._thread = Thread(target=self._websocket.run_forever, daemon=True).start()
+        self._thread = Thread(
+            target=self._websocket.run_forever, daemon=True).start()
 
-    def _check_close_message(self):
-        if self._close_message:
-            reason = self._close_message[1]
+    def _check_close_message(self, close_message):
+        if close_message:
+            reason = close_message[1]
 
-            if self._close_message[0] == 4001:
+            if close_message[0] == 4001:
                 raise exceptions.NoAppConnected(reason)
-            if self._close_message[0] == 4002:
+            if close_message[0] == 4002:
                 raise exceptions.AppDisconnectedError(reason)
-            if self._close_message[0] == 4005:
-                raise exceptions.AppDisconnectedError(reason)
-
-            raise exceptions.ConnectionError("Connection closed by AltServer with reason: {}.".format(reason))
+            if close_message[0] == 4005:
+                raise exceptions.MultipleDriverError(reason)
+            if close_message[0] == 4007:
+                raise exceptions.MultipleDriversTryingToConnectException(
+                    reason)
+            if close_message[0] == 4009:
+                raise exceptions.MaxNoOfConnectionsDriversExceeded(
+                    reason)
+
+            raise exceptions.ConnectionError(
+                "Connection closed by AltTester® Server with reason: {}.".format(reason))
 
     def _check_errors(self):
         if self._errors:
@@ -220,12 +231,13 @@ class WebsocketConnection:
             raise exceptions.ConnectionError(error)
 
     def _ensure_connection_is_open(self):
-        self._check_close_message()
+        self._check_close_message(self._close_message)
         self._check_errors()
 
         if self._websocket is None or not self._is_open:
             self.close()
-            raise exceptions.ConnectionError("Connection closed. An unexpected error ocurred.")
+            raise exceptions.ConnectionError(
+                "Connection closed. An unexpected error ocurred.")
 
     def _on_message(self, ws, message):
         """A callback which is called when the connection receives data."""
@@ -234,7 +246,10 @@ class WebsocketConnection:
         response = json.loads(message)
 
         if response.get("isNotification"):
-            self._notification_handler.handle_notification(response)
+            if "driverRegistered" in message:
+                self._driver_registered_called = True
+            else:
+                self._notification_handler.handle_notification(response)
         else:
             self._command_handler.handle_command(response)
 
@@ -248,15 +263,17 @@ class WebsocketConnection:
         """A callback which is called when the connection is closed."""
 
         logger.debug(
-            "Connection to AltServer closed with status code: {} and message: '{}'.",
+            "Connection to AltTester® Server closed with status code: {} and message: '{}'.",
             close_status_code,
             close_msg
         )
 
         self._close_message = (close_status_code, close_msg)
-
+        self._driver_registered_called = False
         self._is_open = False
         self._websocket = None
+        if close_status_code == 4002:
+            self.connect()
 
     def _on_open(self, ws):
         """A callback which is called when the connection is opened."""
@@ -272,30 +289,34 @@ class WebsocketConnection:
 
     def connect(self):
         logger.info("Connecting to URL: '{}'.", self.url)
-
+        last_close_message = None
         elapsed_time = 0
-        self._create_connection()
-
-        while not self._is_open and (self.timeout is None or elapsed_time < self.timeout):
-            self._close_message = None
-            self._errors = []
-
-            if self._errors or self._close_message:
+        while self.timeout is None or elapsed_time < self.timeout:
+            self._create_connection()
+            wait_for_notification = 0
+            try:
+                while wait_for_notification < 5:
+                    if self._driver_registered_called:
+                        logger.debug("Connected to: '{0}'.".format(self.url))
+                        return
+                    time.sleep(self.delay)
+                    wait_for_notification += self.delay
+                    self._check_close_message(self._close_message)
+            except Exception:
+                last_close_message = self._close_message
                 self.close()
-                self._create_connection()
 
-            time.sleep(self.delay)
-            elapsed_time += self.delay
+            elapsed_time += wait_for_notification
 
-        self._check_close_message()
-        self._check_errors()
-
-        if not self._is_open:
-            self.close()
+            if self._is_open:  # Added this to be also backward compatible but it will be slower
+                return
 
-            raise exceptions.ConnectionTimeoutError(
-                "Failed to connect to AltServer host: {} port: {}.".format(self.host, self.port)
-            )
+        self._check_close_message(last_close_message)
+        self._check_errors()
+        raise exceptions.ConnectionTimeoutError(
+            "Failed to connect to AltTester® Server host: {} port: {}.".format(
+                self.host, self.port)
+        )
 
     def send(self, data):
         self._ensure_connection_is_open()
@@ -323,7 +344,8 @@ class WebsocketConnection:
             raise exceptions.CommandResponseTimeoutException()
 
     def close(self):
-        logger.info("Closing connection to AltServer on host: {} port: {}", self.host, self.port)
+        logger.info(
+            "Closing connection to AltTester® Server on host: {} port: {}", self.host, self.port)
 
         if self._websocket:
             self._websocket.close()
@@ -336,3 +358,4 @@ class WebsocketConnection:
         self._errors = []
         self._close_message = None
         self._is_open = False
+        self._driver_registered_called = False

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/alttester/altdriver.py

@@ -36,7 +36,7 @@ class AltDriver:
 
     When you instantiate an ``AltDriver`` object in your tests, you can use it to “drive” your application like one of
     your users would, by interacting with all the application objects, their properties and methods.  An ``AltDriver``
-    instance will connect to the AltServer.
+    instance will connect to the AltTester® Server.
 
     Args:
         host (:obj:`str`, optional): The host to connect to.
@@ -48,17 +48,32 @@ class AltDriver:
 
     """
 
-    def __init__(self, host="127.0.0.1", port=13000, app_name="__default__", enable_logging=False, timeout=60):
+    def __init__(
+        self,
+        host="127.0.0.1",
+        port=13000,
+        app_name="__default__",
+        enable_logging=False,
+        timeout=60,
+        platform="unknown",
+        platform_version="unknown",
+        device_instance_id="unknown",
+        app_id="unknown"
+    ):
         self.host = host
         self.port = port
         self.app_name = app_name
         self.enable_logging = enable_logging
         self.timeout = timeout
+        self.platform = platform
+        self.platform_version = platform_version
+        self.device_instance_id = device_instance_id
+        self.app_id = app_id
 
         self._config_logging(self.enable_logging)
 
         logger.debug(
-            "Connecting to AltTester on host: '{}', port: '{}' and app name: '{}'.",
+            "Connecting to AltTester® on host: '{}', port: '{}' and app name: '{}'.",
             self.host,
             self.port,
             self.app_name
@@ -71,7 +86,14 @@ class AltDriver:
             port=self.port,
             timeout=self.timeout,
             path="altws",
-            params={"appName": self.app_name},
+            params={
+                "appName": self.app_name,
+                "platform": self.platform,
+                "platformVersion": self.platform_version,
+                "deviceInstanceId": self.device_instance_id,
+                "appId": self.app_id,
+                "driverType": "SDK"
+            },
             command_handler=self._command_handler,
             notification_handler=self._notification_handler
         )
@@ -109,13 +131,13 @@ class AltDriver:
 
     def _check_server_version(self):
         server_version = commands.GetServerVersion.run(self._connection)
-        logger.info("Connection established with instrumented Unity app. AltTester Version: {}", server_version)
+        logger.info("Connection established with instrumented Unity app. AltTester® Version: {}", server_version)
 
         major_server, minor_server = self._split_version(server_version)
         major_driver, minor_driver = self._split_version(VERSION)
 
         if major_server != major_driver or minor_server != minor_driver:
-            message = "Version mismatch. AltDriver version is {}. AltTester version is {}.".format(
+            message = "Version mismatch. AltDriver version is {}. AltTester® version is {}.".format(
                 VERSION,
                 server_version
             )
@@ -164,7 +186,7 @@ class AltDriver:
         self._connection.close()
 
     def get_command_response_timeout(self):
-        """Gets the current command response timeout for the AltTester connection.
+        """Gets the current command response timeout for the AltTester® connection.
 
         Return:
             int or float: The current command response time.
@@ -174,7 +196,7 @@ class AltDriver:
         return self._connection.set_command_timeout()
 
     def set_command_response_timeout(self, timeout):
-        """Sets the command response timeout for the AltTester connection.
+        """Sets the command response timeout for the AltTester® connection.
 
         Args:
             timeout (:obj:`int` or :obj:`float`): The new command response timeout in seconds.

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/alttester/commands/FindObjects/wait_for_component_property.py

@@ -18,12 +18,20 @@
 import time
 from loguru import logger
 from alttester.commands.base_command import Command
-from alttester.exceptions import NotFoundException, WaitTimeOutException
+from alttester.exceptions import WaitTimeOutException
 
 
 class WaitForComponentProperty(Command):
-    def __init__(self, component_name, property_name,
-                 property_value, assembly, altObject, timeout=20, interval=0.5):
+    def __init__(
+        self,
+        component_name,
+        property_name,
+        property_value,
+        assembly,
+        altObject,
+        timeout=20,
+        interval=0.5,
+    ):
         self.component_name = component_name
         self.property_name = property_name
         self.property_value = property_value
@@ -34,20 +42,29 @@ class WaitForComponentProperty(Command):
 
     def execute(self):
         t = 0
-        while (t <= self.timeout):
+        exception = None
+        property_found = None
+        while t <= self.timeout:
             try:
                 property_found = self.altObject.get_component_property(
-                    self.component_name, self.property_name, self.assembly)
-                if (property_found == self.property_value):
-                    break
-            except NotFoundException:
-                logger.debug("Waiting for property {}...", self.property_name)
-                time.sleep(self.interval)
-                t += self.interval
-
-        if t >= self.timeout:
-            raise WaitTimeOutException("Property {} not found after {} seconds"
-                                       .format(
-                                           self.property_name, self.timeout))
-
-        return property_found
+                    self.component_name, self.property_name, self.assembly
+                )
+                if property_found == self.property_value:
+                    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 component: {} and property {}".format(
+                    self.timeout, exception, self.component_name, 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.0.2 → alttester_driver-2.1.0}/alttester/commands/base_command.py

@@ -203,7 +203,7 @@ class BaseCommand(Command):
             raise exceptions.AltTesterInvalidServerResponse(expected, received)
 
     def send(self):
-        """Send a command to the AltTester and return the response."""
+        """Send a command to the AltTester® and return the response."""
 
         self.connection.send(self._parameters)
         response = self.connection.recv()

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/alttester/exceptions.py

@@ -38,6 +38,20 @@ class AppDisconnectedError(ConnectionError):
     """Raised when the app closed the connection or unexpectedly disconnected."""
 
 
+class MultipleDriverError(ConnectionError):
+    """ Raised when the client tries to connect to a server with a driver already connected.
+      Free accounts are limited to a single driver connection at a time."""
+
+
+class MultipleDriversTryingToConnectException(ConnectionError):
+    """Raised when the client tries to connect to a server at the same time with another driver"""
+
+
+class MaxNoOfConnectionsDriversExceededException(ConnectionError):
+    """Raised when the client tries to connect to a server but the limit of drivers connected
+        is exceeded"""
+
+
 class AltTesterInvalidServerResponse(AltException):
     """Raised when the server responds with an invalid response."""
 
@@ -49,11 +63,13 @@ class InvalidParameterTypeException(TypeError, AltException):
     """Raised when an function or method receives an parameter that has the inappropriate type."""
 
     def __init__(self, parameter_name, expected_types, received_type):
-        expected_types = [expected_type.__name__ for expected_type in expected_types]
+        expected_types = [
+            expected_type.__name__ for expected_type in expected_types]
         expected_types = ", ".join(expected_types)
 
         super().__init__(
-            "TypeError: {} must be {}; not {}.".format(parameter_name, expected_types, received_type.__name__)
+            "TypeError: {} must be {}; not {}.".format(
+                parameter_name, expected_types, received_type.__name__)
         )
 
 
@@ -102,7 +118,7 @@ class CouldNotPerformOperationException(AltException):
 
 
 class CouldNotParseJsonStringException(AltException):
-    """Raised when AltTester could not parse an JSON command."""
+    """Raised when AltTester® could not parse an JSON command."""
 
 
 class NullReferenceException(AltException):

alttester_driver-2.1.0/requirements-dev.txt

@@ -0,0 +1,28 @@
+# Deploy
+setuptools>=38.6.0
+wheel>=0.31.0
+twine>=1.11.0
+
+# Lint
+flake8
+
+# Tests
+pytest
+pytest-cov
+pytest-rerunfailures
+pytest-xdist
+
+#browserstack
+jsonmerge
+multiprocess
+paver
+selenium==4.6.0
+psutil
+pytest-variables
+Appium-Python-Client
+py
+Appium-Python-Client
+
+# Allure
+allure-pytest
+allure-combine

{AltTester-Driver-2.0.2 → alttester_driver-2.1.0}/setup.py

@@ -19,7 +19,7 @@ from setuptools import setup, find_packages
 
 
 NAME = 'AltTester-Driver'
-DESCRIPTION = "Python bindings for the AltTester framework. AltTester is an open-source UI driven test " \
+DESCRIPTION = "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."
 URL = 'https://alttester.com/docs/sdk/latest/'
 EMAIL = 'contact@alttester.com'