Apple TV With Appium

Tutorial To Run Your First Test On LambdaTest

In this topic, you will learn how to configure and run your Apple TV automation testing scripts with Appium on LambdaTest Real Device Cloud platform.

Objective

By the end of this topic, you will be able to:

Set up an environment for testing your Apps using Apple TV with Appium.
Understand and configure the core capabilities required for your Appium test suite.
Explore the advanced features of LambdaTest.

Sample repo

All the code samples in this documentation can be found on LambdaTest's Github Repository. You can either download or clone the repository to quickly run your tests. View on GitHub

Prerequisites

Before you can start performing App automation testing with Appium, you would need to follow these steps:

You have access to LambdaTest username and accessKey. If you have not registered yet, you can do the same by visiting our website. You will be able to access the credentials in the LambdaTest Profile
Install the latest Python build from the official website. We recommend using the latest version.
Make sure pip is installed in your system. You can install pip from pip documentation.

Run your first test

1. Upload your application

Upload your Apple TV application (.ipa file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey in the cURL command for authentication. Make sure to add the path of the appFile in the cURL request. Here is an example cURL request to upload your app using our REST API:

Using App File from System:

curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/apple-tv-sample-app.ipa"" -F "name="appletv_app""

tip

If you do not have any .apk file, you can run your sample tests on LambdaTest by using our sample 🔗 AppleTV app.
Response of above cURL will be a JSON object containing the APP_URL of the format - lt://APP123456789123456789 and will be used in the next step.

2. Clone the sample project

Clone the LambdaTest’s LT-appium-appletv and navigate to the code directory as shown below:

git clone https://github.com/LambdaTest/LT-appium-appletv
cd LT-appium-appletv

3. Set up your authentication

Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest. To obtain your access credentials, purchase a plan or access the Automation Dashboard. Then, set LambdaTest Username and Access Key in environment variables with following commands.

Linux / MacOS
Windows

export LT_USERNAME=undefined \
export LT_ACCESS_KEY=undefined

set LT_USERNAME=undefined `
set LT_ACCESS_KEY=undefined

4. Write your automation script

An automation script for the sample application available above has been provided below. Ensure to update the APP_URL, username and accessKey in the code scripts before running the tests.

appletv.py
from appium import webdriver
import os
import time
from appium.webdriver.common.appiumby import AppiumBy

def getCaps():
    desired_caps = {
        "deviceName" : "Apple TV",
        "platformVersion" :  "16",
        "platform" : "tvos",
        "isRealMobile":True,
        "build": "Apple TV Testing",
        "video": True,
        "app":"APP_URL",     #Enter app url here
        "network": False,
        "geoLocation": "FR",
        "devicelog": True,
        "visual" : True
    }

    return desired_caps

def runTest():
    if os.environ.get("LT_USERNAME") is None:
        # Enter LT username below if environment variables have not been added
        username = "username"
    else:
        username = os.environ.get("LT_USERNAME")
    if os.environ.get("LT_ACCESS_KEY") is None:
        # Enter LT accesskey below if environment variables have not been added
        accesskey = "accesskey"
    else:
        accesskey = os.environ.get("LT_ACCESS_KEY")

    # grid url
    gridUrl = "mobile-hub-internal.lambdatest.com/wd/hub"

    # capabilities
    desired_cap = getCaps()
    url = "https://"+username+":"+accesskey+"@"+gridUrl

    print("Initiating remote driver on platform: "+desired_cap["deviceName"]+" browser: "+" version: "+desired_cap["platformVersion"])
    driver = webdriver.Remote(
        desired_capabilities=desired_cap,
        command_executor= url
    )

    # run test
    print(driver.session_id)

    element = driver.switch_to.active_element
    active = element.get_attribute('label')

    if active != "Keyboard":
      element = driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value="EnterWebsiteName")
      element.click()
      time.sleep(1) 

    element = driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value="EnterWebsiteName")
    element.clear()
    time.sleep(1)   

    element = driver.find_element(by=AppiumBy.CLASS_NAME, value="//XCUIElementTypeApplication[@name=\"chief.qaTvTestApp\"]/XCUIElementTypeWindow/XCUIElementTypeOther[2]/XCUIElementTypeOther/XCUIElementTypeOther[3]/XCUIElementTypeOther/XCUIElementTypeOther[2]/XCUIElementTypeOther/XCUIElementTypeOther[1]/XCUIElementTypeOther/XCUIElementTypeOther/XCUIElementTypeOther[2]/XCUIElementTypeTextView/XCUIElementTypeOther/XCUIElementTypeOther")
    element.send_keys("https://ifconfig.me")    

    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    driver.execute_script('mobile: pressButton', { 'name': 'Down' })
    driver.execute_script('mobile: pressButton', { 'name': 'Down' })
    driver.execute_script('mobile: pressButton', { 'name': 'Down' })    

    element = driver.switch_to.active_element
    element.click()
    time.sleep(1)   

    driver.execute_script('mobile: pressButton', { 'name': 'Right' })
    element = driver.switch_to.active_element
    element.click()
    time.sleep(3)   

    driver.quit()   

if __name__ == "__main__":
    runTest()

Configure the test capabilities

You can update your custom capabilities in test scripts. In this sample project, we are passing platform name, platform version, device name and app url (generated earlier) along with other capabilities like build name and test name via capabilities object. The capabilities object in the sample code are defined as:

Supported Model:

Device: "Apple TV" ; OS Version:"16"

Supported Capabilities: Same as iOS

Platform: "tvOS"

appletv.py
def getCaps():
    desired_caps = {
        "deviceName" : "Apple TV",
        "platformVersion" :  "16",
        "platform" : "tvos",
        "isRealMobile":True,
        "build": "Apple TV Testing",
        "video": True,
        "app":"APP_URL",     #Enter app url here
        "network": False,
        "geoLocation": "FR",
        "devicelog": True,
        "visual" : True
    }

Note

You must add the generated APP_URL to the "app" capability in the config file.
You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool.For more details, please refer to our guide on Desired Capabilities in Appium.

5. Execute your test case

Install the required packages from the cloned project directory:

pip install -r requirements.txt

Run the following command in the directory where your project has been saved to execute your build.

python appletv.py

tip

If you are unable to run the automation script with the above mentioned commands try 'python3' command except for 'python'.

Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on the LambdaTest App Automation Dashboard.

Apple TV With Appium

Tutorial To Run Your First Test On LambdaTest

Objective

Prerequisites

Run your first test

1. Upload your application

2. Clone the sample project

3. Set up your authentication

4. Write your automation script

Configure the test capabilities

5. Execute your test case

Additional Links

Test across 3000+ combinations of browsers, real devices & OS.

Help and Support

Do you find this helpful?

Still need help?

Related Articles

Tutorial To Run Your First Test On LambdaTest​

Objective​

Prerequisites​

Run your first test​

1. Upload your application​

2. Clone the sample project​

3. Set up your authentication​

4. Write your automation script​

Configure the test capabilities​

5. Execute your test case​

Additional Links​

Test across 3000+ combinations of browsers, real devices & OS.

Help and Support

Do you find this helpful?

Still need help?

Related Articles

Tutorial To Run Your First Test On LambdaTest

Objective

Prerequisites

Run your first test

1. Upload your application

2. Clone the sample project

3. Set up your authentication

4. Write your automation script

Configure the test capabilities

5. Execute your test case

Additional Links