Initial commit for POC of Appium app-based testing in a python object oriented structure

Author: alyshakt

README.md

@@ -1 +1,4 @@
-# mobile-appium-framework-py
+# mobile-appium-framework-py
+Make sure all requirements are installed by running `pip install -r requirements.txt`
+
+To run the example test, enter `pytest --is_headless=False tests/ios_ui/test_filelist.py -s` in command line.

android_objects/__init__.py

@@ -0,0 +1,43 @@
+"""Created December 29th, 2020 by Alysha Kester-Terry
+    This Base Page object locator strategy was gleaned with much gratitude from 
+    http://elementalselenium.com/tips/9-use-a-base-page-object
+"""
+
+
+class BasePageLocators(object):
+    """Initializes the driver for use on all other pages and defines objects that are on almost every page"""
+
+    def __init__(self, driver):
+        self.driver = driver
+
+    def alert_type_box(self):
+        return self.driver.find_element_by_class_name("XCUIElementTypeAlert")
+
+    def alert_box(self):
+        return self.driver.find_element_by_class_name("XCUIElementTypeScrollView")
+
+
+class IosMemberListPageLocators(BasePageLocators):
+    """iOS Member List Page Locators"""
+
+    def member_list_page_title(self):
+        return self.driver.find_element_by_name('D+D Members')
+
+    def member_list(self):
+        return self.driver.find_elements_by_name('Picture')
+
+
+class IosMemberDetailPageLocators(BasePageLocators):
+    """iOS Member Detail Page Locators"""
+
+    def phone_number(self):
+        return self.driver.find_element_by_name('Phone')
+
+    def profile_image(self):
+        return self.driver.find_element_by_name('Profile image')
+
+    def email(self):
+        return self.driver.find_element_by_name('Email')
+
+    def bio(self):
+        return self.driver.find_element_by_name('Bio')

ios_objects/__init__.py

@@ -0,0 +1,148 @@
+"""Created December 15th, 2020 by Alysha Kester-Terry """
+
+import datetime
+
+import pytest
+from appium.webdriver.common.touch_action import TouchAction
+from selenium.common.exceptions import NoSuchElementException
+from selenium.webdriver.support import expected_conditions
+from selenium.webdriver.support.wait import WebDriverWait
+
+from ios_objects import ios_page_locators
+from setup_helpers import driver_setup
+from tests import conftest
+
+created_date = str(datetime.datetime.utcnow().strftime("%m-%d-%H%M"))
+file_name = 'test-reports/screenshots/ios/' + created_date
+default_wait = 15
+
+
+class BasePage(object):
+    """Base class to initialize the page class that will be called from all pages"""
+
+    def __init__(self, driver):
+        self.driver = driver
+
+    # Functional/Interaction with Page Elements
+
+    def take_screenshot(self, name=None):
+        """Takes a screenshot and saves it to test-reports"""
+        if name is None:
+            name = 'screenshot'
+        screenshot = self.driver.get_screenshot_as_png()
+        screenshot_file = open(file_name + name + '.png', "wb")
+        screenshot_file.write(screenshot)
+        screenshot_file.close()
+
+    def enter_text(self, element, text_to_enter):
+        element.clear()
+        element.send_keys(text_to_enter)
+
+    def get_element_text(self, element):
+        return element.text
+
+    def tap_element(self, element):
+        element.click()
+        self.wait_for_seconds(2)
+
+    def wait_for_seconds(self, seconds=3):
+        conftest.max_sleep(seconds)
+
+    def wait_for_element(self, element):
+        try:
+            print('Waiting for element...')
+            WebDriverWait(driver=self.driver,
+                          timeout=default_wait,
+                          poll_frequency=2).until(
+                expected_conditions.visibility_of(element))
+            print('The element is found? {}'.format(element.is_displayed()))
+        except NoSuchElementException as n:
+            print('Element was not found: {}'.format(element), n)
+        exists = self.element_exists(element)
+        print('The element exists? {}'.format(exists))
+        assert exists
+
+    def wait_for_invisibility(self, element):
+        print('Waiting for invisibility of element...')
+        WebDriverWait(driver=self.driver,
+                      timeout=default_wait,
+                      poll_frequency=2).until(
+            expected_conditions.invisibility_of_element(element))
+        exists = self.element_exists(element)
+        print('The element exists? {}'.format(exists))
+        assert exists is False
+
+    def element_exists(self, element):
+        return element.is_displayed()
+
+    def swipe_up(self):
+        print('Trying to swipe up!')
+        actions = TouchAction(self.driver)
+        actions.long_press(x=180, y=510).move_to(x=150, y=250).release().perform()
+
+    def get_page_src_info(self):
+        source_hierarchy = self.driver.page_source
+        print(source_hierarchy)
+
+    def process_failure(self, error):
+        self.get_page_src_info()
+        pytest.fail('The test failed. {}'.format(error), True)
+
+    def tear_down(self, failure):
+        if failure is None:
+            self.take_screenshot('Pass')
+        else:
+            self.take_screenshot('Failed')
+        self.driver.quit()
+        driver_setup.tear_down()
+
+
+class IosMemberListPage(BasePage):
+    """Member List Page Action Methods"""
+
+    def wait_for_load_complete(self):
+        self.wait_for_seconds(2)
+        title = self.member_list_title_exists()
+        self.take_screenshot('MemberListScreen')
+        while title is False:
+            print('List page is initiated? {}'.format(title) + ' waiting...')
+            self.wait_for_seconds(1)
+        print('is page is initiated? {}'.format(title))
+
+    def member_list_title_exists(self):
+        element = ios_page_locators.IosMemberListPageLocators.member_list_page_title(self)
+        return self.element_exists(element)
+
+    def get_member_list_title(self):
+        element = ios_page_locators.IosMemberListPageLocators.member_list_page_title(self)
+        return self.get_element_text(element)
+
+    def tap_member_name(self, member_name):
+        member_element_list = ios_page_locators.IosMemberListPageLocators.member_list(self)
+        for member_element in member_element_list:
+            this_member = self.get_element_text(member_element).lower()
+            if member_name.lower() in this_member:
+                print('Found member: {}'.format(this_member))
+                self.tap_element(member_element)
+                break
+
+
+class IosMemberDetailPage(BasePage):
+    """Member Detail Page Action Methods"""
+
+    def wait_for_load_complete(self):
+        initiated = self.member_bio_exists()
+        print('Member detail page is initiated? {}'.format(initiated))
+        self.take_screenshot('MemberDetailScreen')
+
+    def member_picture_exists(self):
+        element = ios_page_locators.IosMemberDetailPageLocators.profile_image(self)
+        return self.element_exists(element)
+
+    def member_bio_exists(self):
+        element = ios_page_locators.IosMemberDetailPageLocators.bio(self)
+        return self.element_exists(element)
+
+    def get_member_bio(self):
+        element = ios_page_locators.IosMemberDetailPageLocators.bio(self)
+        return self.get_element_text(element)

ios_objects/ios_page_locators.py

@@ -0,0 +1,7 @@
+nodejs
+datetime~=4.3
+pytest~=6.0.1
+Appium-Python-Client~=1.0.2
+Pillow
+pybase64
+selenium~=3.141.0

ios_objects/ios_pages.py

@@ -0,0 +1,8 @@
+"""To define the platform type"""
+import enum
+
+
+class PlatformType(enum.Enum):
+    """To define a standardized platform type"""
+    ios = 1
+    android = 2

requirements.txt

@@ -0,0 +1,117 @@
+"""To set up the appium driver by Platform Type"""
+"""Created December 15th, 2020 by Alysha Kester-Terry """
+import os
+
+from appium import webdriver
+from appium.webdriver.appium_service import AppiumService
+
+appium_service = AppiumService()
+
+
+def get_app_type(PlatformType):
+    """To Define the platform type for your app"""
+    switcher = {
+        PlatformType.ios: 'iOS',
+        PlatformType.android: 'Android'
+    }
+    print(switcher.get(PlatformType), 'Invalid app type.')
+    return switcher.get(PlatformType)
+
+
+def get_desired_caps(PlatformType, is_headless=False, app_path=None, device_name=None):
+    """To Define the desired capabilities type for your app
+    :param PlatformType: iOS or Android
+    :param is_headless: whether to run headless
+    :param app_path: explicit path of app file
+    :param device_name: iPhone name or Android emulator name
+    """
+    platform_type = get_app_type(PlatformType)
+    lower_app_type = platform_type.lower()
+    if app_path is None:
+        app_path = get_app_path(PlatformType)
+        print('\nThe App Path we found: {}'.format(app_path))
+    desired_caps = None
+    if lower_app_type == 'ios':
+        if device_name is None:
+            device_name = 'iPhone 11'
+        desired_caps = dict(
+            platformName='iOS',
+            platformVersion='14.1',
+            deviceName=device_name,
+            automationName='XCUITest',
+            sendKeyStrategy='grouped',
+            app=app_path,
+            elementResponseAttributes=True,
+            isAutomationEnabled=True,
+            autoAcceptAlerts=False,
+            autoDismissAlerts=False,
+            connectHardwareKeyboard=True,
+            isHeadless=bool(is_headless),
+            showXcodeLog=True
+        )
+    elif lower_app_type == 'android':
+        if device_name is None:
+            device_name = 'S7 Edge API 29'
+        avd_name = device_name.replace(' ', '_')
+        desired_caps = dict(
+            platformName='Android',
+            deviceName=device_name,
+            avd=avd_name,
+            automationName='UIAutomator2',
+            autoGrantPermissions=False,
+            skipDeviceInitialization=False,
+            audioPlayback=False,
+            skipLogcatCapture=False,
+            app=app_path,
+            isHeadless=bool(is_headless)
+        )
+    print('DESIRED CAPABILITIES: {}'.format(desired_caps))
+    return desired_caps
+
+
+def __start_service():
+    appium_service.start()
+    print('Appium is running? {}'.format(appium_service.is_running))
+    print('Appium is listening? {}'.format(appium_service.is_listening))
+
+
+def get_driver(desired_caps):
+    running = appium_service.is_running
+    listening = appium_service.is_listening
+    print('Appium is running? {}'.format(running))
+    print('Appium is listening? {}'.format(listening))
+    if running or listening is False:
+        __start_service()
+    driver = webdriver.Remote(command_executor='http://127.0.0.1:4723/wd/hub',
+                              desired_capabilities=desired_caps)
+    return driver
+
+
+def get_app_path(PlatformType):
+    global file_path
+    platform_type = get_app_type(PlatformType)
+    print('The App Type is ... {}'.format(platform_type.lower()))
+    lower_platform_name = platform_type.lower()
+    print('\n Getting a dynamic app path')
+    directory_path = os.path.abspath("temp_app_files")
+    for root, dirs, files in os.walk(directory_path):
+        print(files)
+        for file in files:
+            print('This file is: {}'.format(file))
+            if 'ios' in lower_platform_name.lower():
+                if file.endswith('.zip') or file.endswith('.app'):
+                    file_path = directory_path + '/' + file
+                    print('Found file: {}'.format(file_path))
+                    break
+            else:
+                if file.endswith('.apk'):
+                    file_path = directory_path + '/' + file
+                    print('Found file: {}'.format(file_path))
+                    break
+        return os.path.abspath(file_path)
+
+
+def tear_down():
+    appium_service.stop()
+    print('Appium is running? {}'.format(appium_service.is_running))
+    print('Appium is listening? {}'.format(appium_service.is_listening))