本项目是一个基于 XCTest 和 GCDAsyncSocket 的 iOS 自动化测试服务器，它允许客户端通过 HTTP 请求与 iOS 设备进行交互，执行各种自动化测试任务，如应用激活、终止、元素查找、屏幕截图、录制等。
使用以下命令将仓库克隆到本地：
git clone https://github.com/letmeNo1/IOSHierarchyDumper.git进入项目目录：
cd IOSHierarchyDumper使用以下命令打开项目：
open dump_hierarchy.xcodeproj或者，你也可以直接在文件资源管理器中双击 dump_hierarchy.xcodeproj 文件来打开项目。
在 Xcode 中配置项目的签名设置：
- 在项目导航栏中选择项目。
- 进入
Signing & Capabilities选项卡。 - 确保在
Signing下选择了有效的团队。
使用快捷键 Cmd + U 或通过 Product > Test 来编译并运行测试。
pip install py-iosios runwda --bundleid `nico.dump-hierarchyUITests.hank2.xctrunner` --testrunnerbundleid `nico.dump-hierarchyUITests.hank2.xctrunner` --xctestconfig=dump_hierarchyUITests.xctest --udid=00008140-001C7CD80202801C --env=USE_PORT=8200请将 nico.dump - hierarchyUITests.hank2.xctrunner 替换为实际的包名，USE_PORT 为可选参数，默认端口为 8200。
ios tunnel startios forward 本地端口 远程端口- 网络通信：使用 GCDAsyncSocket 监听指定端口，接收客户端的 HTTP 请求，并返回相应的结果。
- 应用管理：支持激活、终止指定的 iOS 应用。
- 元素操作：可以根据 XPath、索引、谓词等方式查找应用中的元素，并对元素执行点击、输入文本等操作。
- 屏幕操作：支持屏幕截图（PNG 和 JPG 格式）、屏幕录制功能。
- 设备信息：可以获取设备的屏幕尺寸、音频输出音量等信息。
- 错误处理：对各种异常情况进行了处理，如请求格式错误、参数缺失等，并返回相应的 HTTP 错误状态码。
以下是一些常见的客户端请求示例，假设服务器运行在 http://localhost:8200 上。
请求：
GET http://localhost:8200/check_status
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 13
server running
此请求用于检查服务器是否正常运行，若服务器正常，会返回 server running。
请求：
GET http://localhost:8200/dump_tree?bundle_id=com.example.app
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<应用界面结构的详细信息>
此请求用于获取指定 bundle_id 的应用的界面结构信息。
请求：
GET http://localhost:8200/activate_app?bundle_id=com.example.app
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 12
App activated
此请求用于激活指定 bundle_id 的应用。
请求：
GET http://localhost:8200/terminate_app?bundle_id=com.example.app
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 13
App terminated
此请求用于终止指定 bundle_id 的应用。
请求：
GET http://localhost:8200/start_recording
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 16
Recording started
此请求用于开始屏幕录制。
请求：
GET http://localhost:8200/stop_recording
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 16
Recording stopped
此请求用于停止屏幕录制。
请求：
GET http://localhost:8200/get_actual_wh
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<屏幕宽度>,<屏幕高度>
此请求用于获取设备屏幕的宽度和高度。
请求：
GET http://localhost:8200/get_png_pic
响应：
HTTP/1.1 200 OK
Content-Type: image/png
Content-Length: ...
<PNG 格式的屏幕截图二进制数据>
此请求用于获取设备屏幕的 PNG 格式截图。
请求：
GET http://localhost:8200/get_jpg_pic?compression_quality=0.8
响应：
HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Length: ...
<JPG 格式的屏幕截图二进制数据>
此请求用于获取设备屏幕的 JPG 格式截图，compression_quality 参数用于指定压缩质量。
根据查询条件查找元素的请求可通过 find_elements_by_query 或 find_element_by_query 接口实现，以下是详细说明：
此接口用于查找符合指定条件的所有元素。
请求：
GET http://localhost:8200/find_element_by_query?bundle_id=com.example.app&predicate=label == 'Button'
参数说明：
- bundle_id: 当前运行应用的 Bundle Identifier，例如 'com.example.app'(不要填错，否则会进入死循环)。
- predicate: 'label == 'Button'' 表示查找标签为 'Button' 的元素。
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<符合条件的元素信息，以逗号分隔>
示例响应：
<element1_json_info>,<element2_json_info>,<element3_json_info>
此接口用于查找符合指定条件的第一个元素。
请求：
GET http://localhost:8200/find_element_by_query?bundle_id=com.example.app&query_method=predicate&query_value=label == 'Button'
参数说明：
- bundle_id: 当前运行应用的 Bundle Identifier，例如 'com.example.app'(不要填错，否则会进入死循环)。
- query_method: 查询方法，支持 'xpath'、'index'、'predicate' 等。这里使用 'predicate' 表示使用谓词查询。
- query_value: 查询值，根据查询方法的不同而不同。当查询方法为 'predicate' 时，这里的 'label == 'Button'' 表示查找标签为 'Button' 的元素。
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<符合条件的第一个元素的 JSON 信息>
示例响应：
<element1_json_info>
请求：
GET http://localhost:8200/get_current_bundleIdentifier?bundle_ids=com.example.app1,com.example.app2
参数说明：
- bundle_ids: 当前手机上所有安装的应用包名
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<当前前台应用的 Bundle Identifier>
此请求用于获取当前前台运行的应用的 Bundle Identifier。
请求：
GET http://localhost:8200/coordinate_action?bundle_id=com.example.app&action=click&xPixel=100&yPixel=200&action_parms=
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 22
Coordinate action performed
此请求用于在指定应用的指定坐标处执行操作。
请求：
GET http://localhost:8200/device_action?action=home
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 20
Device action performed
此请求用于执行设备的物理操作，如按下 Home 键。
请求：
GET http://localhost:8200/device_info?value=get_output_volume
响应：
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<设备的音频输出音量信息>
此请求用于获取设备的相关信息，如音频输出音量。
- 权限问题：确保你的应用具有执行相应操作的权限，如屏幕截图、录制等。
- 异常处理：在使用过程中，可能会遇到各种异常情况，如网络连接失败、请求格式错误等，服务器会返回相应的 HTTP 错误状态码和错误信息。
- 资源管理：在长时间运行过程中，注意资源的释放和管理，避免内存泄漏等问题。
如果你发现了问题或有改进建议，请在项目的 GitHub 仓库中提交 Issue 或 Pull Request。我们欢迎任何形式的贡献！
本项目遵循 MIT 许可证，你可以自由使用、修改和分发本项目。
This project is an iOS automated testing server based on XCTest and GCDAsyncSocket, allowing clients to interact with iOS devices via HTTP requests for various automated testing tasks such as app activation, termination, element lookup, screenshots, screen recording, etc.
Use the following command to clone the repository locally:
git clone https://github.com/letmeNo1/IOSHierarchyDumper.gitNavigate to the project directory:
cd IOSHierarchyDumperOpen the project using:
open dump_hierarchy.xcodeprojAlternatively, double-click dump_hierarchy.xcodeproj in the file explorer.
In Xcode:
- Select the project in the navigator.
- Go to the
Signing & Capabilitiestab. - Ensure a valid team is selected under
Signing.
Use Cmd + U or Product > Test to compile and run the tests.
pip install py-iosios runwda --bundleid `nico.dump-hierarchyUITests.hank2.xctrunner` --testrunnerbundleid `nico.dump-hierarchyUITests.hank2.xctrunner` --xctestconfig=dump_hierarchyUITests.xctest --udid=00008140-001C7CD80202801C --env=USE_PORT=8200Replace nico.dump-hierarchyUITests.hank2.xctrunner with your actual bundle ID. USE_PORT is optional (default: 8200).
ios tunnel startios forward local_port remote_port- Network Communication: Uses GCDAsyncSocket to listen on specified ports, handling HTTP requests and returning results.
- App Management: Supports activating/terminating iOS apps.
- Element Operations: Find elements via XPath, index, predicate, etc., with click and text input capabilities.
- Screen Operations: Screenshots (PNG/JPG) and screen recording.
- Device Information: Retrieve screen dimensions, audio volume, etc.
- Error Handling: Returns HTTP error codes for invalid requests or exceptions.
Assume the server runs at http://localhost:8200.
Request:
GET http://localhost:8200/check_status
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 13
server running
Request:
GET http://localhost:8200/dump_tree?bundle_id=com.example.app
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<Detailed UI hierarchy information>
Request:
GET http://localhost:8200/activate_app?bundle_id=com.example.app
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 12
App activated
Request:
GET http://localhost:8200/terminate_app?bundle_id=com.example.app
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 13
App terminated
Request:
GET http://localhost:8200/start_recording
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 16
Recording started
Request:
GET http://localhost:8200/stop_recording
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 16
Recording stopped
Request:
GET http://localhost:8200/get_actual_wh
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<width>,<height>
Request:
GET http://localhost:8200/get_png_pic
Response:
HTTP/1.1 200 OK
Content-Type: image/png
Content-Length: ...
<PNG binary data>
Request:
GET http://localhost:8200/get_jpg_pic?compression_quality=0.8
Response:
HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Length: ...
<JPG binary data>
Finds all elements matching the query:
Request:
GET http://localhost:8200/find_element_by_query?bundle_id=com.example.app&predicate=label == 'Button'
Parameters:
- bundle_id: Target app's Bundle ID
- predicate: Predicate string (e.g., 'label == 'Button'')
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<element1_json>,<element2_json>,...
Finds the first matching element:
Request:
GET http://localhost:8200/find_element_by_query?bundle_id=com.example.app&query_method=predicate&query_value=label == 'Button'
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<element_json>
Request:
GET http://localhost:8200/get_current_bundleIdentifier?bundle_ids=com.example.app1,com.example.app2
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<Foreground app Bundle ID>
Request:
GET http://localhost:8200/coordinate_action?bundle_id=com.example.app&action=click&xPixel=100&yPixel=200&action_parms=
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 22
Coordinate action performed
Request:
GET http://localhost:8200/device_action?action=home
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 20
Device action performed
Request:
GET http://localhost:8200/device_info?value=get_output_volume
Response:
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: ...
<Audio output volume info>
- Permissions: Ensure proper permissions for actions like screenshots.
- Error Handling: Server returns HTTP error codes for invalid requests.
- Resource Management: Manage resources to avoid memory leaks during long-running tasks.
Submit issues or pull requests on the GitHub repository. Contributions are welcome!
This project is licensed under the MIT License. You may use, modify, and distribute it freely.