文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 使用 Device Farm 的代码示例 AWS SDKs
以下代码示例向您展示了如何 AWS Device Farm 使用 AWS 软件开发套件 (SDK)。
*操作*是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。
*场景*是向您展示如何通过在一个服务中调用多个函数或与其他 AWS 服务服务结合来完成特定任务的代码示例。
**更多资源**
+ **[Device Farm 开发人员指南](https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html)**——有关 Device Farm 的更多信息。
+ **[Device Farm API 参考](https://docs.aws.amazon.com/devicefarm/latest/APIReference/Welcome.html)**——有关所有可用的 Device Farm 操作的详细信息。
+ **[AWS 开发者中心](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23device-farm)** — 您可以按类别或全文搜索筛选的代码示例。
+ **[AWS SDK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)** — 包含首选语言完整代码的 GitHub 存储库。包括有关设置和运行代码的说明。
**Contents**
+ [基本功能](device-farm_code_examples_basics.md)
+ [操作](device-farm_code_examples_actions.md)
+ [`CreateUpload`](device-farm_example_device-farm_CreateUpload_section.md)
+ [场景](device-farm_code_examples_scenarios.md)
+ [运行浏览器测试并截图](device-farm_example_device-farm_Scenario_BrowserTesting_section.md)
+ [上传和测试设备包](device-farm_example_device-farm_Scenario_DeviceTesting_section.md)
# 使用 Device Farm 的基本示例 AWS SDKs
以下代码示例说明如何使用 with 的基础 AWS Device Farm 知识 AWS SDKs。
**Contents**
+ [操作](device-farm_code_examples_actions.md)
+ [`CreateUpload`](device-farm_example_device-farm_CreateUpload_section.md)
# 使用 Device Farm 执行的操作 AWS SDKs
以下代码示例演示了如何使用执行各个 Device Farm 操作 AWS SDKs。每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关设置和运行代码的说明。
这些代码节选调用了 Device Farm API，是必须在上下文中运行的大型程序的代码节选。您可以在[Device Farm 使用的场景 AWS SDKs](device-farm_code_examples_scenarios.md)中结合上下文查看操作。
以下示例仅包括最常用的操作。有关完整列表，请参阅 [AWS Device Farm API 参考](https://docs.aws.amazon.com/devicefarm/latest/APIReference/Welcome.html)。
**Topics**
+ [`CreateUpload`](device-farm_example_device-farm_CreateUpload_section.md)
# 将 `CreateUpload` 与 CLI 配合使用
以下代码示例演示如何使用 `CreateUpload`。
操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：
+ [上传和测试设备包](device-farm_example_device-farm_Scenario_DeviceTesting_section.md)
------
#### [ CLI ]
**AWS CLI**
**创建上传**
以下命令为 Android 应用创建上传：
```
aws devicefarm create-upload --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" --name app.apk --type ANDROID_APP
```
您可以从 create-project 或 list-projects 的输出中获取项目 ARN。
输出：
```
{
"upload": {
"status": "INITIALIZED",
"name": "app.apk",
"created": 1503614408.769,
"url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f",
"type": "ANDROID_APP",
"arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514"
}
}
```
使用输出中的已签名 URL 将文件上传到 Device Farm：
```
curl -T app.apk "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f"
```
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[CreateUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-upload.html)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例为安卓应用创建 Dev AWS ice Farm 上传。您可以从 “新建列表” DFProject 或 “获取列表” 的输出中获取项目 ARN。DFProject使用新DFUpload 输出中的签名 URL 将文件上传到 Device Farm。**
```
New-DFUpload -ContentType "application/octet-stream" -ProjectArn "arn:aws:devicefarm:us-west-2:123456789012:project:EXAMPLEa-7ec1-4741-9c1f-d3e04EXAMPLE" -Name "app.apk" -Type ANDROID_APP
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [CreateUpload](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例为安卓应用创建 Dev AWS ice Farm 上传。您可以从 “新建列表” DFProject 或 “获取列表” 的输出中获取项目 ARN。DFProject使用新DFUpload 输出中的签名 URL 将文件上传到 Device Farm。**
```
New-DFUpload -ContentType "application/octet-stream" -ProjectArn "arn:aws:devicefarm:us-west-2:123456789012:project:EXAMPLEa-7ec1-4741-9c1f-d3e04EXAMPLE" -Name "app.apk" -Type ANDROID_APP
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [CreateUpload](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# Device Farm 使用的场景 AWS SDKs
以下代码示例向您展示了如何使用在 Device Farm 中实现常见场景 AWS SDKs。这些场景向您展示了如何通过调用 Device Farm 中的多个函数或与其他 AWS 服务结合来完成特定任务。每个场景都包含完整源代码的链接，您可以在其中找到有关如何设置和运行代码的说明。
场景以中等水平的经验为目标，可帮助您结合具体环境了解服务操作。
**Topics**
+ [运行浏览器测试并截图](device-farm_example_device-farm_Scenario_BrowserTesting_section.md)
+ [上传和测试设备包](device-farm_example_device-farm_Scenario_DeviceTesting_section.md)
# 使用 Device Farm 运行浏览器测试并使用 AWS SDK 截取屏幕截图
以下代码示例演示了如何通过 Device Farm 运行浏览器测试并截屏。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/devicefarm/browser_testing#code-examples)中查找完整示例，了解如何进行设置和运行。
使用 PyTest 和 Selenium 浏览指定网站、截取屏幕截图以及将实际网站内容与预期内容进行比较。
```
import datetime
import os
import subprocess
import boto3
import pytest
from selenium import webdriver
from selenium.webdriver import DesiredCapabilities
from selenium.webdriver.common.by import By
from selenium.webdriver.common.keys import Keys
from selenium.webdriver.support import expected_conditions
from selenium.webdriver.support.wait import WebDriverWait
def get_git_hash():
"""
Get the short Git hash of the current commit of the repository
"""
try:
return (
subprocess.check_output(["git", "rev-parse", "--short", "HEAD"])
.decode("utf-8")
.strip()
)
except:
return "norepo"
class TestHelloSuite:
"""
Our test suite.
This style of test suite allows us to use setup_method and teardown_method.
"""
def save_screenshot(self, name):
self.driver.save_screenshot(os.path.join(self.screenshot_path, name))
def setup_method(self, method):
"""
Set up a test.
This makes sure that the session for an individual test is ready.
The AWS credentials are read from the default ~/.aws/credentials or from the
command line by setting the AWS_ACCESS_KEY_ID and AWS_SECRET_KEY environment
variables.
The project Amazon Resource Name (ARN) is determined by the PROJECT_ARN
environment variable.
"""
devicefarm_client = boto3.client("devicefarm")
project_arn = os.environ.get("PROJECT_ARN", None)
if project_arn is None:
raise ValueError("Must set PROJECT_ARN")
# Request a driver hub URL for the Selenium client
testgrid_url_response = devicefarm_client.create_test_grid_url(
projectArn=project_arn, expiresInSeconds=300
)
# We want a directory to save our files into. We're going to make a directory
# in the current directory that holds our results.
self.screenshot_path = os.path.join(
".", "results", get_git_hash() + "-" + (datetime.date.today().isoformat())
)
if not os.path.exists(self.screenshot_path):
os.makedirs(self.screenshot_path, exist_ok=True)
# We want a Firefox instance on Windows
desired_cap = DesiredCapabilities.FIREFOX
desired_cap["platform"] = "windows"
desired_cap["BrowserVersion"] = "latest"
# Configure the webdriver with the appropriate remote endpoint.
self.driver = webdriver.Remote(testgrid_url_response["url"], desired_cap)
#
# Auto-Tagging
#
# In order to get the Session ARN, we need to look up the session by the
# Project ARN and session ID (from the driver).
testgrid_session_arn_response = devicefarm_client.get_test_grid_session(
projectArn=project_arn, sessionId=self.driver.session_id
)
# Save the session's ARN so we can tag the session.
self.session_arn = testgrid_session_arn_response["testGridSession"]["arn"]
# In order to tag it, we're going to use the resourcegroupstaggingapi client to
# add a tag to the session ARN that we just got.
tag_client = boto3.client("resourcegroupstaggingapi")
tag_client.tag_resources(
ResourceARNList=[self.session_arn],
Tags={"TestSuite": f"testsuite {method.__name__}", "GitId": get_git_hash()},
)
def teardown_method(self, method):
"""
Clean up resources used by each method.
"""
# End the Selenium session so we're off the clock.
self.driver.quit()
@pytest.mark.parametrize(
"query,leading",
[
pytest.param(
"Seattle",
"Seattle (/siˈætəl/ (listen) see-AT-əl) is a seaport city on the West Coast of the United States.",
),
pytest.param(
"Selenium",
"Selenium is a chemical element with the symbol Se and atomic number 34.",
),
pytest.param(
"Amazon Locker",
"Amazon Locker is a self-service package delivery service offered by online retailer Amazon.",
),
pytest.param(
"Kootenai Falls",
"Kootenai Falls is a waterfall on the Kootenay River located in Lincoln County, Montana, just off U.S. Route 2.",
),
pytest.param(
"Dorayaki",
"Dorayaki (どら焼き, どらやき, 銅鑼焼き, ドラ焼き) is a type of Japanese confection.",
),
pytest.param("Robot Face", "<|°_°|> (also known as Robot Face or Robot)"),
],
)
def test_first_paragraph_text(self, query, leading):
"""
This test looks at the first paragraph of a page on Wikipedia, comparing it to
a known leading sentence.
If the leading sentence matches, the test passes. A screenshot is taken before
the final assertion is made, letting us debug if something isn't right.
"""
# Open the main page of Wikipedia
self.driver.get("https://en.wikipedia.org/wiki/Main_Page")
# Find the search box, enter a query, and press enter
search_input = self.driver.find_element(By.ID, "searchInput")
search_input.click()
search_input.send_keys(query)
search_input.send_keys(Keys.ENTER)
# Wait for the search box to go stale -- This means we've navigated fully.
WebDriverWait(self.driver, 5).until(
expected_conditions.staleness_of(search_input)
)
# Get the leading paragraph of the article.
lead = leading.lower()
# Find the element...
lead_para = self.driver.find_element(
By.XPATH, "//div[@class='mw-parser-output']//p[not(@class)]"
)
# ... and copy out its text.
our_text = lead_para.text.lower()
our_text = our_text[: len(lead)]
# Take a screenshot and compare the strings.
self.save_screenshot(f"leadingpara_{query}.png")
assert our_text.startswith(lead)
@pytest.mark.parametrize(
"query,expected",
[
pytest.param("Automation Testing", "Test Automation"),
pytest.param("DevOps", "DevOps"),
pytest.param("Jackdaws Love My Big Sphinx Of Quartz", "Pangram"),
pytest.param("EarthBound", "EarthBound"),
pytest.param("Covered Bridges Today", "Covered Bridges Today"),
pytest.param("Kurt Godel", "Kurt Gödel"),
pytest.param("N//ng language", "Nǁng language"),
pytest.param(
"Who the Frick Is Jackson Pollock?", "Who the $&% Is Jackson Pollock?"
),
],
)
def test_redirect_titles(self, query, expected):
"""
A test comparing pages we expect to (or not to) redirect on Wikipedia.
This test checks to see that the page ("query") redirects (or doesn't) to the
"expected" page title. Several of these are common synonyms ("Jackdaws...")
while others are because of characters untypable by most keyboards ("Nǁng language")
A screenshot is taken just before the final assertion is made to aid in
debugging and verification.
"""
# Open the main page of Wikipedia
self.driver.get("https://en.wikipedia.org/wiki/Main_Page")
# Find the search box, enter some text into it, and send an enter key.
search_input = self.driver.find_element(By.ID, "searchInput")
search_input.click()
search_input.send_keys(query)
search_input.send_keys(Keys.ENTER)
# wait until the page has rolled over -- once the search input handle is stale,
# the browser has navigated.
WebDriverWait(self.driver, 5).until(
expected_conditions.staleness_of(search_input)
)
# Get the first heading & take a screenshot
our_text = self.driver.find_element(By.ID, "firstHeading").text.lower()
self.save_screenshot(f"redirect_{query}.png")
# did it match?
assert our_text == expected.lower()
```
+ 有关 API 详细信息，请参阅《AWS SDK for Python (Boto3) API Reference》**中的以下主题。
+ [CreateTestGridUrl](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateTestGridUrl)
+ [GetTestGridSession](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetTestGridSession)
------
# 使用 AWS SDK 在 Device Farm 中上传和测试移动设备包
以下代码示例演示了如何通过 Device Farm 上传和测试移动设备包。
------
#### [ Python ]
**适用于 Python 的 SDK（Boto3）**
还有更多相关信息 GitHub。在 [AWS 代码示例存储库](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/devicefarm/device_testing#code-examples)中查找完整示例，了解如何进行设置和运行。
将编译后的 Android 应用程序和测试包上传到 Device Farm，开始测试，等待测试完成，然后报告结果。
```
import boto3
import os
import requests
import string
import random
import datetime
import time
# Update this dict with your own values before you run the example:
config = {
# This is our app under test.
"appFilePath": "app-debug.apk",
"projectArn": "arn:aws:devicefarm:us-west-2:111222333444:project:581f5703-e040-4ac9-b7ae-0ba007bfb8e6",
# Since we care about the most popular devices, we'll use a curated pool.
"testSpecArn": "arn:aws:devicefarm:us-west-2::upload:20fcf771-eae3-4137-aa76-92e17fb3131b",
"poolArn": "arn:aws:devicefarm:us-west-2::devicepool:4a869d91-6f17-491f-9a95-0a601aee2406",
"namePrefix": "MyAppTest",
# This is our test package. This tutorial won't go into how to make these.
"testPackage": "tests.zip",
}
client = boto3.client("devicefarm")
unique = (
config["namePrefix"]
+ "-"
+ (datetime.date.today().isoformat())
+ ("".join(random.sample(string.ascii_letters, 8)))
)
print(
f"The unique identifier for this run is '{unique}'. All uploads will be prefixed "
f"with this."
)
def upload_df_file(filename, type_, mime="application/octet-stream"):
upload_response = client.create_upload(
projectArn=config["projectArn"],
name=unique + "_" + os.path.basename(filename),
type=type_,
contentType=mime,
)
upload_arn = upload_response["upload"]["arn"]
# Extract the URL of the upload and use Requests to upload it.
upload_url = upload_response["upload"]["url"]
with open(filename, "rb") as file_stream:
print(
f"Uploading {filename} to Device Farm as "
f"{upload_response['upload']['name']}... ",
end="",
)
put_req = requests.put(
upload_url, data=file_stream, headers={"content-type": mime}
)
print(" done")
if not put_req.ok:
raise Exception(f"Couldn't upload. Requests says: {put_req.reason}")
started = datetime.datetime.now()
while True:
print(
f"Upload of {filename} in state {upload_response['upload']['status']} "
f"after " + str(datetime.datetime.now() - started)
)
if upload_response["upload"]["status"] == "FAILED":
raise Exception(
f"The upload failed processing. Device Farm says the reason is: \n"
f"{+upload_response['upload']['message']}"
)
if upload_response["upload"]["status"] == "SUCCEEDED":
break
time.sleep(5)
upload_response = client.get_upload(arn=upload_arn)
print("")
return upload_arn
our_upload_arn = upload_df_file(config["appFilePath"], "ANDROID_APP")
our_test_package_arn = upload_df_file(
config["testPackage"], "APPIUM_PYTHON_TEST_PACKAGE"
)
print(our_upload_arn, our_test_package_arn)
response = client.schedule_run(
projectArn=config["projectArn"],
appArn=our_upload_arn,
devicePoolArn=config["poolArn"],
name=unique,
test={
"type": "APPIUM_PYTHON",
"testSpecArn": config["testSpecArn"],
"testPackageArn": our_test_package_arn,
},
)
run_arn = response["run"]["arn"]
start_time = datetime.datetime.now()
print(f"Run {unique} is scheduled as arn {run_arn} ")
state = "UNKNOWN"
try:
while True:
response = client.get_run(arn=run_arn)
state = response["run"]["status"]
if state == "COMPLETED" or state == "ERRORED":
break
else:
print(
f" Run {unique} in state {state}, total "
f"time {datetime.datetime.now() - start_time}"
)
time.sleep(10)
except:
client.stop_run(arn=run_arn)
exit(1)
print(f"Tests finished in state {state} after {datetime.datetime.now() - start_time}")
# Pull all the logs.
jobs_response = client.list_jobs(arn=run_arn)
# Save the output somewhere, using the unique value.
save_path = os.path.join(os.getcwd(), "results", unique)
os.mkdir(save_path)
# Save the last run information.
for job in jobs_response["jobs"]:
job_name = job["name"]
os.makedirs(os.path.join(save_path, job_name), exist_ok=True)
# Get each suite within the job.
suites = client.list_suites(arn=job["arn"])["suites"]
for suite in suites:
for test in client.list_tests(arn=suite["arn"])["tests"]:
# Get the artifacts.
for artifact_type in ["FILE", "SCREENSHOT", "LOG"]:
artifacts = client.list_artifacts(type=artifact_type, arn=test["arn"])[
"artifacts"
]
for artifact in artifacts:
# Replace `:` because it has a special meaning in Windows & macOS.
path_to = os.path.join(
save_path,
job_name,
suite["name"],
test["name"].replace(":", "_"),
)
os.makedirs(path_to, exist_ok=True)
filename = (
artifact["type"]
+ "_"
+ artifact["name"]
+ "."
+ artifact["extension"]
)
artifact_save_path = os.path.join(path_to, filename)
print(f"Downloading {artifact_save_path}")
with open(artifact_save_path, "wb") as fn:
with requests.get(
artifact["url"], allow_redirects=True
) as request:
fn.write(request.content)
print("Finished")
```
+ 有关 API 详细信息，请参阅《AWS SDK for Python (Boto3) API Reference》**中的以下主题。
+ [CreateUpload](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateUpload)
+ [GetRun](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetRun)
+ [GetUpload](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetUpload)
+ [ListArtifacts](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListArtifacts)
+ [ListJobs](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListJobs)
+ [ListSuites](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListSuites)
+ [ListTests](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTests)
+ [ScheduleRun](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ScheduleRun)
+ [StopRun](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopRun)
------