feat: Add unit tests and fix review comments

Author: MummanaSubramanya

appium/common/helper.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import base64
 from typing import Any, Dict
 
 from appium import version as appium_version
@@ -33,3 +34,8 @@ def library_version() -> str:
     """Return a version of this python library"""
 
     return appium_version.version
+
+def encode_file_to_base64(file_path: str) -> str:
+    """Return base64 encoded string for given file"""
+    with open(file_path, 'rb') as file:
+        return base64.b64encode(file.read()).decode('utf-8')

appium/options/flutter_integration/__init__.py

@@ -1 +1 @@
-from .base import FlutterOptions
+from .base import FlutterOptions

appium/options/flutter_integration/base.py

@@ -16,6 +16,7 @@
 # under the License.
 
 from typing import Dict
+
 from appium.options.common.automation_name_option import AUTOMATION_NAME
 from appium.options.common.base import AppiumOptions
 from appium.options.flutter_integration.flutter_element_wait_timeout_option import FlutterElementWaitTimeOutOption
@@ -29,12 +30,11 @@ class FlutterOptions(
     FlutterElementWaitTimeOutOption,
     FlutterEnableMockCameraOption,
     FlutterServerLaunchTimeOutOption,
-    FlutterSystemPortOption
+    FlutterSystemPortOption,
 ):
-    
+
     @property
     def default_capabilities(self) -> Dict:
         return {
             AUTOMATION_NAME: 'FlutterIntegration',
         }
-    

appium/options/flutter_integration/flutter_element_wait_timeout_option.py

@@ -17,19 +17,19 @@
 
 from datetime import timedelta
 from typing import Optional, Union
-from appium.options.common.supports_capabilities import SupportsCapabilities
 
+from appium.options.common.supports_capabilities import SupportsCapabilities
 
-FLUTTER_ELEMENT_WAIT_TIMEOUT= 'flutterElementWaitTimeout'
+FLUTTER_ELEMENT_WAIT_TIMEOUT = 'flutterElementWaitTimeout'
 
 
 class FlutterElementWaitTimeOutOption(SupportsCapabilities):
-    
+
     @property
     def flutter_element_wait_timeout(self) -> Optional[timedelta]:
         """
         Maximum timeout to wait for element for Flutter integration test
-        
+
         Returns:
             Optional[timedelta]: The timeout value as a `timedelta` object if set, or `None` if the timeout is not defined.
         """
@@ -46,6 +46,6 @@ def flutter_element_wait_timeout(self, value: Union[timedelta, int]) -> None:
                 If provided as a `timedelta`, it will be converted to milliseconds.
         """
         self.set_capability(
-            FLUTTER_ELEMENT_WAIT_TIMEOUT, 
+            FLUTTER_ELEMENT_WAIT_TIMEOUT,
             int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        )

appium/options/flutter_integration/flutter_enable_mock_camera_option.py

@@ -16,31 +16,31 @@
 # under the License.
 
 from typing import Optional
-from appium.options.common.supports_capabilities import SupportsCapabilities
 
+from appium.options.common.supports_capabilities import SupportsCapabilities
 
 FLUTTER_ENABLE_MOCK_CAMERA = 'flutterEnableMockCamera'
 
 
 class FlutterEnableMockCameraOption(SupportsCapabilities):
-    
+
     @property
     def flutter_enable_mock_camera(self) -> bool:
         """
         Get state of the mock camera for Flutter integration test
-        
+
         Returns:
             bool: A boolean indicating whether the mock camera is enabled (True) or disabled (False).
         """
         return self.get_capability(FLUTTER_ENABLE_MOCK_CAMERA)
 
     @flutter_enable_mock_camera.setter
     def flutter_enable_mock_camera(self, value: bool) -> None:
-        """        
+        """
         Setter method enable or disable the mock camera for Flutter integration test
         Default state is `False`
 
         Args:
             value (bool): A boolean value indicating whether to enable (True) or disable (False) the mock camera.
         """
-        self.set_capability(FLUTTER_ENABLE_MOCK_CAMERA, value)
+        self.set_capability(FLUTTER_ENABLE_MOCK_CAMERA, value)

appium/options/flutter_integration/flutter_server_launch_timeout_option.py

@@ -17,14 +17,14 @@
 
 from datetime import timedelta
 from typing import Optional, Union
-from appium.options.common.supports_capabilities import SupportsCapabilities
 
+from appium.options.common.supports_capabilities import SupportsCapabilities
 
-FLUTTER_SERVER_LAUNCH_TIMEOUT= 'flutterServerLaunchTimeout'
+FLUTTER_SERVER_LAUNCH_TIMEOUT = 'flutterServerLaunchTimeout'
 
 
 class FlutterServerLaunchTimeOutOption(SupportsCapabilities):
-    
+
     @property
     def flutter_server_launch_timeout(self) -> Optional[timedelta]:
         """
@@ -43,10 +43,10 @@ def flutter_server_launch_timeout(self, value: Union[timedelta, int]) -> None:
         Default timeout is 5000ms
 
         Args:
-            value (Union[timedelta, int]): The timeout value, either as a `timedelta` object or an integer in milliseconds. 
+            value (Union[timedelta, int]): The timeout value, either as a `timedelta` object or an integer in milliseconds.
                 If provided as a `timedelta`, it will be converted to milliseconds.
         """
         self.set_capability(
-            FLUTTER_SERVER_LAUNCH_TIMEOUT, 
+            FLUTTER_SERVER_LAUNCH_TIMEOUT,
             int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        )

appium/options/flutter_integration/flutter_system_port_option.py

@@ -16,19 +16,19 @@
 # under the License.
 
 from typing import Optional
-from appium.options.common.supports_capabilities import SupportsCapabilities
 
+from appium.options.common.supports_capabilities import SupportsCapabilities
 
 FLUTTER_SYSTEM_PORT = 'flutterSystemPort'
 
 
 class FlutterSystemPortOption(SupportsCapabilities):
-    
+
     @property
     def flutter_system_port(self) -> Optional[int]:
         """
         Get flutter system port for Flutter integration tests.
-        
+
         Returns:
             int: returns the port number
         """
@@ -43,4 +43,4 @@ def flutter_system_port(self, value: int) -> None:
         Args:
             value (int): The port number to be used for the Flutter server.
         """
-        self.set_capability(FLUTTER_SYSTEM_PORT, value)
+        self.set_capability(FLUTTER_SYSTEM_PORT, value)

appium/webdriver/common/appiumby.py

@@ -25,6 +25,8 @@ class AppiumBy(By):
     ACCESSIBILITY_ID = 'accessibility id'
     IMAGE = '-image'
     CUSTOM = '-custom'
+    
+    # For Flutter integration usage https://github.com/AppiumTestDistribution/appium-flutter-integration-driver/tree/main
     FLUTTER_INTEGRATION_SEMANTICS_LABEL = '-flutter semantics label'
     FLUTTER_INTEGRATION_TYPE = '-flutter type'
     FLUTTER_INTEGRATION_KEY = '-flutter key'