1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
|
import subprocess
from unittest.mock import ANY, MagicMock
import pytest
from briefcase.exceptions import BriefcaseCommandError
from briefcase.integrations.android_sdk import AndroidSDK
from briefcase.integrations.base import ToolCache
@pytest.fixture
def mock_tools(tmp_path, mock_tools) -> ToolCache:
# For default test purposes, assume we're on macOS x86_64
mock_tools.host_os = "Darwin"
mock_tools.host_arch = "x86_64"
return mock_tools
@pytest.fixture
def android_sdk(android_sdk) -> AndroidSDK:
# Mock some existing emulators
android_sdk.emulators = MagicMock(
return_value=[
"runningEmulator",
"idleEmulator",
]
)
return android_sdk
@pytest.mark.parametrize(
"host_os, host_arch, emulator_abi",
[
("Darwin", "x86_64", "x86_64"),
("Darwin", "arm64", "arm64-v8a"),
("Windows", "AMD64", "x86_64"),
("Linux", "x86_64", "x86_64"),
("Linux", "aarch64", "arm64-v8a"),
],
)
def test_create_emulator(
mock_tools,
android_sdk,
tmp_path,
host_os,
host_arch,
emulator_abi,
):
"""A new emulator can be created."""
# This test validates everything going well on first run.
# This means the skin will be downloaded and unpacked.
# Mock the hardware and operating system to specific values
mock_tools.host_os = host_os
mock_tools.host_arch = host_arch
# Mock system image and skin verification
android_sdk.verify_system_image = MagicMock()
android_sdk.verify_emulator_skin = MagicMock()
# Mock the initial output of an AVD config file.
avd_config_path = tmp_path / "home/.android/avd/new-emulator.avd/config.ini"
avd_config_path.parent.mkdir(parents=True)
with avd_config_path.open("w", encoding="utf-8") as f:
f.write("hw.device.name=pixel\n")
# Create the emulator
android_sdk._create_emulator(
avd="new-emulator",
device_type="slab",
skin="slab_skin",
system_image="system-images;android-42;default;gothic",
)
# The system image was verified
android_sdk.verify_system_image.assert_called_once_with(
"system-images;android-42;default;gothic"
)
# The emulator skin was verified
android_sdk.verify_emulator_skin.assert_called_once_with("slab_skin")
# avdmanager was invoked
mock_tools.subprocess.check_output.assert_called_once_with(
[
android_sdk.avdmanager_path,
"--verbose",
"create",
"avd",
"--name",
"new-emulator",
"--abi",
emulator_abi,
"--package",
"system-images;android-42;default;gothic",
"--device",
"slab",
],
env={
**android_sdk.env,
**{"XDG_CONFIG_HOME": None},
},
)
# Emulator configuration file has been appended.
with avd_config_path.open(encoding="utf-8") as f:
config = f.read().split("\n")
assert "hw.keyboard=yes" in config
assert "skin.name=slab_skin" in config
@pytest.mark.parametrize(
"host_os, host_arch, emulator_abi",
[
("Darwin", "x86_64", "x86_64"),
("Darwin", "arm64", "arm64-v8a"),
("Windows", "AMD64", "x86_64"),
("Linux", "x86_64", "x86_64"),
("Linux", "aarch64", "arm64-v8a"),
],
)
def test_create_emulator_with_defaults(
mock_tools,
android_sdk,
tmp_path,
host_os,
host_arch,
emulator_abi,
):
"""A new emulator can be created using default properties."""
# This test validates everything going well on first run.
# This means the skin will be downloaded and unpacked.
# Mock the hardware and operating system to specific values
mock_tools.host_os = host_os
mock_tools.host_arch = host_arch
# Mock system image and skin verification
android_sdk.verify_system_image = MagicMock()
android_sdk.verify_emulator_skin = MagicMock()
# Mock the initial output of an AVD config file.
avd_config_path = tmp_path / "home/.android/avd/new-emulator.avd/config.ini"
avd_config_path.parent.mkdir(parents=True)
with avd_config_path.open("w", encoding="utf-8") as f:
f.write("hw.device.name=pixel\n")
# Create the emulator using defaults
android_sdk._create_emulator(avd="new-emulator")
# The system image was verified
android_sdk.verify_system_image.assert_called_once_with(
f"system-images;android-31;default;{emulator_abi}"
)
# The emulator skin was verified
android_sdk.verify_emulator_skin.assert_called_once_with("pixel_7_pro")
# avdmanager was invoked
mock_tools.subprocess.check_output.assert_called_once_with(
[
android_sdk.avdmanager_path,
"--verbose",
"create",
"avd",
"--name",
"new-emulator",
"--abi",
emulator_abi,
"--package",
f"system-images;android-31;default;{emulator_abi}",
"--device",
"pixel",
],
env={
**android_sdk.env,
**{"XDG_CONFIG_HOME": None},
},
)
# Emulator configuration file has been appended.
with avd_config_path.open(encoding="utf-8") as f:
config = f.read().split("\n")
assert "hw.keyboard=yes" in config
assert "skin.name=pixel_7_pro" in config
def test_create_failure(mock_tools, android_sdk):
"""If avdmanager fails, an error is raised."""
# Mock system image and skin verification
android_sdk.verify_system_image = MagicMock()
android_sdk.verify_emulator_skin = MagicMock()
# Mock an avdmanager failure.
mock_tools.subprocess.check_output.side_effect = subprocess.CalledProcessError(
returncode=1, cmd="avdmanager"
)
# Create the emulator
with pytest.raises(BriefcaseCommandError):
android_sdk._create_emulator(avd="new-emulator")
# The system image was verified
android_sdk.verify_system_image.assert_called_once_with(ANY)
# The emulator skin was verified
android_sdk.verify_emulator_skin.assert_called_once_with("pixel_7_pro")
# avdmanager was invoked
mock_tools.subprocess.check_output.assert_called_once_with(
[
android_sdk.avdmanager_path,
"--verbose",
"create",
"avd",
"--name",
"new-emulator",
"--abi",
"x86_64",
"--package",
"system-images;android-31;default;x86_64",
"--device",
"pixel",
],
env={
**android_sdk.env,
**{"XDG_CONFIG_HOME": None},
},
)
def test_default_name(mock_tools, android_sdk, tmp_path):
"""A new emulator can be created with the default name."""
# This test doesn't validate most of the test process;
# it only checks that the emulator is created with the default name.
# User provides no input; default name will be used
mock_tools.console.values = [""]
# Mock the initial output of an AVD config file.
avd_config_path = tmp_path / "home/.android/avd/beePhone.avd/config.ini"
avd_config_path.parent.mkdir(parents=True)
with avd_config_path.open("w", encoding="utf-8") as f:
f.write("hw.device.name=pixel\n")
# Create the emulator
avd = android_sdk.create_emulator()
# The expected device AVD was created.
assert avd == "beePhone"
def test_default_name_with_collisions(mock_tools, android_sdk, tmp_path):
"""The default name will avoid collisions with existing emulators."""
# This test doesn't validate most of the test process;
# it only checks that the emulator is created with the default name.
# Create some existing emulators that will collide with the default name.
android_sdk.emulators = MagicMock(
return_value=[
"beePhone2",
"runningEmulator",
"beePhone",
]
)
# User provides no input; default name will be used
mock_tools.console.values = [""]
# Mock the initial output of an AVD config file.
avd_config_path = tmp_path / "home/.android/avd/beePhone3.avd/config.ini"
avd_config_path.parent.mkdir(parents=True)
with avd_config_path.open("w", encoding="utf-8") as f:
f.write("hw.device.name=pixel\n")
# Create the emulator
avd = android_sdk.create_emulator()
# The expected device AVD was created.
assert avd == "beePhone3"
|