Migrate Android Java E2E tests from App Center to Browserstack #22117
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| import argparse | ||
|
||
| import json | ||
| import time | ||
|
|
||
| import requests | ||
|
|
||
| parser = argparse.ArgumentParser("Upload and run BrowserStack tests") | ||
|
There was a problem hiding this comment. we usually want to put the script logic to execute inside the check more details here: https://docs.python.org/3/library/__main__.html |
||
|
|
||
| parser.add_argument("--id", type=str, help="BrowserStack user ID") | ||
| parser.add_argument("--token", type=str, help="BrowserStack token") | ||
|
There was a problem hiding this comment. is this value secret? passing it on the command line might be fine in the context of a CI pipeline where it is redacted from logs, but command line arguments are generally not hidden. e.g., when running locally, the command line arguments will be visible to other processes and also in the command history. some alternatives are to pass the secret value via stdin or in an environment variable. if we don't expect to run this script much locally, this is less of a concern. |
||
| parser.add_argument("--test_platform", type=str, help="Testing platform, i.e., XCUITest or Espresso") | ||
|
There was a problem hiding this comment. if there are two valid options, can we just constrain them here to catch typos earlier and with an obvious error message? |
||
| parser.add_argument("--app_apk_path", type=str, help="Path to the app APK") | ||
| parser.add_argument("--test_apk_path", type=str, help="Path to the test suite APK") | ||
| parser.add_argument("--devices", type=str, nargs="+", help="List of devices to run the tests on. For more info, " + | ||
|
||
| "see https://www.browserstack.com/docs/app-automate/espresso/specify-devices") | ||
|
|
||
| args = parser.parse_args() | ||
|
|
||
| def post_response_to_json(response): | ||
|
There was a problem hiding this comment. nit: the name is |
||
| if len(response) == 0: | ||
| raise Exception("No response from BrowserStack") | ||
| try: | ||
| json_response = json.loads(response) | ||
| print("JSON response: ", json.dumps(json_response, indent=2)) | ||
| if "error" in json_response: | ||
| raise Exception(json_response["error"]) | ||
|
Comment on lines
+31
to
+32
There was a problem hiding this comment. Are there specific json properties we can check for 'error' instead of matching across the entire response? |
||
| return json_response | ||
| except Exception as e: | ||
| print("response received: ", response) | ||
| raise Exception("Invalid JSON response from BrowserStack") from e | ||
|
|
||
|
|
||
| def upload_apk_parse_json(post_url, apk_path): | ||
| with open(apk_path, "rb") as apk_file: | ||
| response = requests.post(post_url, files={"file": apk_file}, auth=(args.id, args.token)) | ||
|
There was a problem hiding this comment. Should we configure specific timeouts based on the operation? I can imagine apk upload may take longer than what the default timeout (assuming there is one) allows for. |
||
| return post_response_to_json(response.text) | ||
|
There was a problem hiding this comment. should we also check There was a problem hiding this comment. there's also a response method for parsing json which may simplify things: |
||
|
|
||
|
|
||
| upload_app_json = upload_apk_parse_json( | ||
| "https://api-cloud.browserstack.com/app-automate/{test_platform}/v2/app".format(test_platform = args.test_platform), args.app_apk_path | ||
|
||
| ) | ||
| upload_test_json = upload_apk_parse_json( | ||
| "https://api-cloud.browserstack.com/app-automate/{test_platform}/v2/test-suite".format(test_platform = args.test_platform), args.test_apk_path | ||
|
||
| ) | ||
|
|
||
| headers = {} | ||
|
|
||
| json_data = { | ||
| "devices": args.devices, | ||
| "app": upload_app_json["app_url"], | ||
| "testSuite": upload_test_json["test_suite_url"], | ||
| } | ||
|
|
||
| build_response = requests.post( | ||
| "https://api-cloud.browserstack.com/app-automate/" + args.test_platform + "/v2/build", | ||
| headers=headers, | ||
| json=json_data, | ||
| auth=(args.id, args.token), | ||
| ) | ||
|
|
||
| build_response_json = post_response_to_json(build_response.text) | ||
|
|
||
| # GET TEST RESULTS | ||
|
|
||
| tests_status = "running" | ||
|
|
||
| while tests_status == "running": | ||
| time.sleep(30) | ||
|
Comment on lines
+73
to
+74
There was a problem hiding this comment. Should we have an overall timeout for this loop? |
||
| test_response = requests.get( | ||
| "https://api-cloud.browserstack.com/app-automate/{test_platform}/v2/builds/{build_id}".format( | ||
| test_platform = args.test_platform, | ||
| build_id=build_response_json["build_id"] | ||
| ), | ||
| auth=(args.id, args.token), | ||
| ) | ||
|
|
||
| test_response_json = post_response_to_json(test_response.text) | ||
|
|
||
| tests_status = test_response_json["status"] | ||
|
|
||
| print("=" * 30) | ||
| print( | ||
| "Test suite details: ", | ||
| "https://app-automate.browserstack.com/dashboard/v2/builds/" + build_response_json["build_id"], | ||
| ) | ||
| print("=" * 30) | ||
| if tests_status != "passed": | ||
| raise Exception("Tests failed. Go to the link above for more details.") | ||
|
There was a problem hiding this comment. nit: include the link directly as there could (in theory) be other output when the CI runs that makes 'above' unclear. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there WIP documentation somewhere that provides the high level details of how this all works and where these values are defined so that we know how to update them in the future?