Skip to content

Add support for an env_str in mobly #1004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hongyu-wang wants to merge 2 commits into from
+41 −8
Closed

Add support for an env_str in mobly #1004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efc52b4
Snippet client
hongyu-wang Apr 29, 2026
f8e970d
Merge branch 'master' into environment-support
xpconanfan May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion mobly/controllers/android_device_lib/snippet_client_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

# The command template to start the snippet server
_LAUNCH_CMD = (
'{shell_cmd} am instrument {user} -w -e action start'
'{shell_cmd} {env_str} am instrument {user} -w -e action start'
' {instrument_options}'
f' {{snippet_package}}/{_INSTRUMENTATION_RUNNER_PACKAGE}'
)
Expand Down Expand Up @@ -111,12 +111,15 @@ class Config:
other purposes may not take effect and you should use snippet RPCs. This
is because Mobly snippet runner changes the subsequent instrumentation
process.
env: A string of prefix options (e.g., environment variables or command
Copy link
Copy Markdown
Collaborator

@mhaoli mhaoli May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also adjust the position of env in docstring.

wrappers) prepended before the `am instrument` command.
user_id: The user id under which to launch the snippet process.
"""

am_instrument_options: Dict[str, str] = dataclasses.field(
default_factory=dict
)
env: str = ''
Copy link
Copy Markdown
Collaborator

@mhaoli mhaoli May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please place the new arg env after the existing arg user_id to avoid breaking existing users.

user_id: Union[int, None] = None


Expand Down Expand Up @@ -308,8 +311,10 @@ def start_server(self):
_PROTOCOL_MINOR_VERSION,
)
option_str = self._get_instrument_options_str()
env_str = self._config.env.strip()
cmd = _LAUNCH_CMD.format(
shell_cmd=persists_shell_cmd,
env_str=env_str,
user=self._get_user_command_string(),
snippet_package=self.package,
instrument_options=option_str,
Expand Down
42 changes: 35 additions & 7 deletions tests/mobly/controllers/android_device_lib/snippet_client_v2_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ def test_start_server_with_user_id(self, mock_adb, mock_start_subprocess):
'adb',
'shell',
(
f'setsid am instrument --user {MOCK_USER_ID} -w -e action start '
f'setsid am instrument --user {MOCK_USER_ID} -w -e action start '
f'{MOCK_SERVER_PATH}'
),
]
Expand Down Expand Up @@ -540,7 +540,7 @@ def test_start_server_with_config_specific_user_id(
'adb',
'shell',
(
'setsid am instrument --user 42 -w -e action start '
'setsid am instrument --user 42 -w -e action start '
f'{MOCK_SERVER_PATH}'
),
]
Expand All @@ -563,7 +563,7 @@ def test_start_server_without_user_id(self, mock_adb, mock_start_subprocess):
start_cmd_list = [
'adb',
'shell',
f'setsid am instrument -w -e action start {MOCK_SERVER_PATH}',
f'setsid am instrument -w -e action start {MOCK_SERVER_PATH}',
]
self.assertListEqual(
mock_start_subprocess.call_args_list,
Expand Down Expand Up @@ -593,7 +593,7 @@ def test_start_server_without_persisting_commands(
'adb',
'shell',
(
f' am instrument --user {MOCK_USER_ID} -w -e action start '
f' am instrument --user {MOCK_USER_ID} -w -e action start '
f'{MOCK_SERVER_PATH}'
),
]
Expand Down Expand Up @@ -627,7 +627,7 @@ def _mocked_shell(arg):
'adb',
'shell',
(
f'nohup am instrument --user {MOCK_USER_ID} -w -e action start '
f'nohup am instrument --user {MOCK_USER_ID} -w -e action start '
f'{MOCK_SERVER_PATH}'
),
]
Expand Down Expand Up @@ -657,7 +657,7 @@ def _mocked_shell(arg):
'adb',
'shell',
(
f'setsid am instrument --user {MOCK_USER_ID} -w -e action start '
f'setsid am instrument --user {MOCK_USER_ID} -w -e action start '
f'{MOCK_SERVER_PATH}'
),
]
Expand Down Expand Up @@ -686,7 +686,7 @@ def test_start_server_with_instrument_options(self, mock_start_subprocess):
'adb',
'shell',
(
f' am instrument --user {MOCK_USER_ID} -w -e action start '
f' am instrument --user {MOCK_USER_ID} -w -e action start '
f'{instrument_options_str} {MOCK_SERVER_PATH}'
),
]
Expand All @@ -696,6 +696,34 @@ def test_start_server_with_instrument_options(self, mock_start_subprocess):
)
self.assertEqual(self.client.device_port, 1234)

@mock.patch(
'mobly.controllers.android_device_lib.snippet_client_v2.'
'utils.start_standing_subprocess'
)
def test_start_server_with_env(self, mock_start_subprocess):
"""Checks the starting server command with env options."""
config = snippet_client_v2.Config(
env='env CLASSPATH=foo',
)
self._make_client(config=config)
self._mock_server_process_starting_response(mock_start_subprocess)

self.client.start_server()

start_cmd_list = [
'adb',
'shell',
(
f' env CLASSPATH=foo am instrument --user {MOCK_USER_ID} -w -e'
f' action start {MOCK_SERVER_PATH}'
),
]
self.assertListEqual(
mock_start_subprocess.call_args_list,
[mock.call(start_cmd_list, shell=False)],
)
self.assertEqual(self.client.device_port, 1234)

@mock.patch(
'mobly.controllers.android_device_lib.snippet_client_v2.'
'utils.start_standing_subprocess'
Expand Down