# Copyright 2022 - The Android Open Source Project # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Tests for cvd_utils.""" import os import subprocess import tempfile import unittest from unittest import mock from acloud import errors from acloud.create import create_common from acloud.internal import constants from acloud.internal.lib import cvd_utils from acloud.internal.lib import driver_test_lib # pylint: disable=too-many-public-methods class CvdUtilsTest(driver_test_lib.BaseDriverTest): """Test the functions in cvd_utils.""" # Remote host instance name. _PRODUCT_NAME = "aosp_cf_x86_64_phone" _BUILD_ID = "2263051" _REMOTE_HOST_IP = "192.0.2.1" _REMOTE_HOST_INSTANCE_NAME_1 = ( "host-192.0.2.1-1-2263051-aosp_cf_x86_64_phone") _REMOTE_HOST_INSTANCE_NAME_2 = ( "host-192.0.2.1-2-2263051-aosp_cf_x86_64_phone") def testGetAdbPorts(self): """Test GetAdbPorts.""" self.assertEqual([6520], cvd_utils.GetAdbPorts(None, None)) self.assertEqual([6520], cvd_utils.GetAdbPorts(1, 1)) self.assertEqual([6521, 6522], cvd_utils.GetAdbPorts(2, 2)) def testGetFastbootPorts(self): """Test GetFastbootPorts.""" self.assertEqual([7520], cvd_utils.GetFastbootPorts(None, None)) self.assertEqual([7520], cvd_utils.GetFastbootPorts(1, 1)) self.assertEqual([7521, 7522], cvd_utils.GetFastbootPorts(2, 2)) def testGetVncPorts(self): """Test GetVncPorts.""" self.assertEqual([6444], cvd_utils.GetVncPorts(None, None)) self.assertEqual([6444], cvd_utils.GetVncPorts(1, 1)) self.assertEqual([6445, 6446], cvd_utils.GetVncPorts(2, 2)) @staticmethod @mock.patch("acloud.internal.lib.cvd_utils.os.path.isdir", return_value=False) def testUploadImageZip(_mock_isdir): """Test UploadArtifacts with image zip.""" mock_ssh = mock.Mock() cvd_utils.UploadArtifacts(mock_ssh, "dir", "/mock/img.zip", "/mock/cvd.tar.gz") mock_ssh.Run.assert_any_call("/usr/bin/install_zip.sh dir < " "/mock/img.zip") mock_ssh.Run.assert_any_call("tar -xzf - -C dir < /mock/cvd.tar.gz") @staticmethod @mock.patch("acloud.internal.lib.cvd_utils.glob") @mock.patch("acloud.internal.lib.cvd_utils.os.path.isdir", return_value=True) @mock.patch("acloud.internal.lib.cvd_utils.ssh.ShellCmdWithRetry") def testUploadImageDir(mock_shell, _mock_isdir, mock_glob): """Test UploadArtifacts with image directory.""" mock_ssh = mock.Mock() mock_ssh.GetBaseCmd.return_value = "/mock/ssh" expected_image_shell_cmd = ("tar -cf - --lzop -S -C local/dir " "super.img bootloader kernel android-info.txt | " "/mock/ssh -- " "tar -xf - --lzop -S -C remote/dir") expected_cvd_tar_ssh_cmd = "tar -xzf - -C remote/dir < /mock/cvd.tar.gz" expected_cvd_dir_shell_cmd = ("tar -cf - --lzop -S -C /mock/cvd . | " "/mock/ssh -- " "tar -xf - --lzop -S -C remote/dir") # Test with cvd directory. mock_open = mock.mock_open(read_data="super.img\nbootloader\nkernel") with mock.patch("acloud.internal.lib.cvd_utils.open", mock_open): cvd_utils.UploadArtifacts(mock_ssh, "remote/dir","local/dir", "/mock/cvd") mock_open.assert_called_with("local/dir/required_images", "r", encoding="utf-8") mock_glob.glob.assert_not_called() mock_shell.assert_has_calls([mock.call(expected_image_shell_cmd), mock.call(expected_cvd_dir_shell_cmd)]) # Test with required_images file. mock_ssh.reset_mock() mock_shell.reset_mock() mock_open = mock.mock_open(read_data="super.img\nbootloader\nkernel") with mock.patch("acloud.internal.lib.cvd_utils.open", mock_open): cvd_utils.UploadArtifacts(mock_ssh, "remote/dir","local/dir", "/mock/cvd.tar.gz") mock_open.assert_called_with("local/dir/required_images", "r", encoding="utf-8") mock_glob.glob.assert_not_called() mock_shell.assert_called_with(expected_image_shell_cmd) mock_ssh.Run.assert_called_with(expected_cvd_tar_ssh_cmd) # Test with glob. mock_ssh.reset_mock() mock_shell.reset_mock() mock_glob.glob.side_effect = ( lambda path: [path.replace("*", "super")]) with mock.patch("acloud.internal.lib.cvd_utils.open", side_effect=IOError("file does not exist")): cvd_utils.UploadArtifacts(mock_ssh, "remote/dir", "local/dir", "/mock/cvd.tar.gz") mock_glob.glob.assert_called() mock_shell.assert_called_with(expected_image_shell_cmd) mock_ssh.Run.assert_called_with(expected_cvd_tar_ssh_cmd) @mock.patch("acloud.internal.lib.cvd_utils.create_common") def testUploadBootImages(self, mock_create_common): """Test FindBootImages and UploadExtraImages.""" mock_ssh = mock.Mock() with tempfile.TemporaryDirectory(prefix="cvd_utils") as image_dir: mock_create_common.FindBootImage.return_value = "boot.img" self.CreateFile(os.path.join(image_dir, "vendor_boot.img")) mock_avd_spec = mock.Mock(local_kernel_image="boot.img", local_vendor_image=None) args = cvd_utils.UploadExtraImages(mock_ssh, "dir", mock_avd_spec) self.assertEqual(["-boot_image", "dir/acloud_image/boot.img"], args) mock_ssh.Run.assert_called_once_with("mkdir -p dir/acloud_image") mock_ssh.ScpPushFile.assert_called_once_with( "boot.img", "dir/acloud_image/boot.img") mock_ssh.reset_mock() mock_avd_spec.local_kernel_image = image_dir mock_avd_spec.local_vendor_image = None args = cvd_utils.UploadExtraImages(mock_ssh, "dir", mock_avd_spec) self.assertEqual( ["-boot_image", "dir/acloud_image/boot.img", "-vendor_boot_image", "dir/acloud_image/vendor_boot.img"], args) mock_ssh.Run.assert_called_once() self.assertEqual(2, mock_ssh.ScpPushFile.call_count) def testUploadKernelImages(self): """Test FindKernelImages and UploadExtraImages.""" mock_ssh = mock.Mock() with tempfile.TemporaryDirectory(prefix="cvd_utils") as image_dir: kernel_image_path = os.path.join(image_dir, "Image") self.CreateFile(kernel_image_path) self.CreateFile(os.path.join(image_dir, "initramfs.img")) self.CreateFile(os.path.join(image_dir, "boot.img")) mock_avd_spec = mock.Mock(local_kernel_image=kernel_image_path, local_vendor_image=None) with self.assertRaises(errors.GetLocalImageError): cvd_utils.UploadExtraImages(mock_ssh, "dir", mock_avd_spec) mock_ssh.reset_mock() mock_avd_spec.local_kernel_image = image_dir mock_avd_spec.local_vendor_image = None args = cvd_utils.UploadExtraImages(mock_ssh, "dir", mock_avd_spec) self.assertEqual( ["-kernel_path", "dir/acloud_image/kernel", "-initramfs_path", "dir/acloud_image/initramfs.img"], args) mock_ssh.Run.assert_called_once() self.assertEqual(2, mock_ssh.ScpPushFile.call_count) @mock.patch("acloud.internal.lib.ota_tools.FindOtaTools") def testUploadVbmetaImages(self, mock_find_ota_tools): """Test UploadExtraImages.""" self.Patch(create_common, "GetNonEmptyEnvVars", return_value=[]) mock_ssh = mock.Mock() mock_ota_tools_object = mock.Mock() mock_find_ota_tools.return_value = mock_ota_tools_object mock_avd_spec = mock.Mock( local_kernel_image=None, local_vendor_image="vendor.img", local_tool_dirs=[]) args = cvd_utils.UploadExtraImages(mock_ssh, "dir", mock_avd_spec) self.assertEqual( ["-vbmeta_image", "dir/acloud_image/vbmeta.img"], args) mock_ssh.Run.assert_called_once() mock_ssh.ScpPushFile.assert_called_once() mock_find_ota_tools.assert_called_once_with([]) mock_ota_tools_object.MakeDisabledVbmetaImage.assert_called_once() @mock.patch("acloud.internal.lib.cvd_utils.ssh.ShellCmdWithRetry") def testUploadSuperImage(self, mock_shell_cmd_with_retry): """Test UploadSuperImage.""" mock_ssh = mock.Mock() self.assertEqual( ["-super_image", "/remote/cvd/dir/acloud_image/super_image_dir/super.img"], cvd_utils.UploadSuperImage(mock_ssh, "/remote/cvd/dir", "/local/path/to/super.img")) mock_shell_cmd_with_retry.assert_called_once() args = mock_shell_cmd_with_retry.call_args[0] self.assertEqual(1, len(args)) self.assertIn("/local/path/to", args[0]) self.assertIn("super.img", args[0]) self.assertIn("/remote/cvd/dir/acloud_image/super_image_dir", args[0]) def testCleanUpRemoteCvd(self): """Test CleanUpRemoteCvd.""" mock_ssh = mock.Mock() cvd_utils.CleanUpRemoteCvd(mock_ssh, "dir", raise_error=True) mock_ssh.Run.assert_any_call("'HOME=$HOME/dir dir/bin/stop_cvd'") mock_ssh.Run.assert_any_call("'rm -rf dir/*'") mock_ssh.reset_mock() mock_ssh.Run.side_effect = [ subprocess.CalledProcessError(cmd="should raise", returncode=1)] with self.assertRaises(subprocess.CalledProcessError): cvd_utils.CleanUpRemoteCvd(mock_ssh, "dir", raise_error=True) mock_ssh.reset_mock() mock_ssh.Run.side_effect = [ subprocess.CalledProcessError(cmd="should ignore", returncode=1), None] cvd_utils.CleanUpRemoteCvd(mock_ssh, "dir", raise_error=False) mock_ssh.Run.assert_any_call("'HOME=$HOME/dir dir/bin/stop_cvd'", retry=0) mock_ssh.Run.assert_any_call("'rm -rf dir/*'") def testGetRemoteHostBaseDir(self): """Test GetRemoteHostBaseDir.""" self.assertEqual("acloud_cf_1", cvd_utils.GetRemoteHostBaseDir(None)) self.assertEqual("acloud_cf_2", cvd_utils.GetRemoteHostBaseDir(2)) def testFormatRemoteHostInstanceName(self): """Test FormatRemoteHostInstanceName.""" name = cvd_utils.FormatRemoteHostInstanceName( self._REMOTE_HOST_IP, None, self._BUILD_ID, self._PRODUCT_NAME) self.assertEqual(name, self._REMOTE_HOST_INSTANCE_NAME_1) name = cvd_utils.FormatRemoteHostInstanceName( self._REMOTE_HOST_IP, 2, self._BUILD_ID, self._PRODUCT_NAME) self.assertEqual(name, self._REMOTE_HOST_INSTANCE_NAME_2) def testParseRemoteHostAddress(self): """Test ParseRemoteHostAddress.""" result = cvd_utils.ParseRemoteHostAddress( self._REMOTE_HOST_INSTANCE_NAME_1) self.assertEqual(result, (self._REMOTE_HOST_IP, "acloud_cf_1")) result = cvd_utils.ParseRemoteHostAddress( self._REMOTE_HOST_INSTANCE_NAME_2) self.assertEqual(result, (self._REMOTE_HOST_IP, "acloud_cf_2")) result = cvd_utils.ParseRemoteHostAddress( "host-goldfish-192.0.2.1-5554-123456-sdk_x86_64-sdk") self.assertIsNone(result) def testGetLaunchCvdArgs(self): """Test GetLaunchCvdArgs.""" # Minimum arguments mock_cfg = mock.Mock(extra_data_disk_size_gb=0) hw_property = { constants.HW_X_RES: "1080", constants.HW_Y_RES: "1920", constants.HW_ALIAS_DPI: "240"} mock_avd_spec = mock.Mock( spec=[], cfg=mock_cfg, hw_customize=False, hw_property=hw_property, connect_webrtc=False, connect_vnc=False, openwrt=False, num_avds_per_instance=1, base_instance_num=0, launch_args="") expected_args = [ "-x_res=1080", "-y_res=1920", "-dpi=240", "-undefok=report_anonymous_usage_stats,config", "-report_anonymous_usage_stats=y"] launch_cvd_args = cvd_utils.GetLaunchCvdArgs(mock_avd_spec) self.assertEqual(launch_cvd_args, expected_args) # All arguments. mock_cfg = mock.Mock(extra_data_disk_size_gb=20) hw_property = { constants.HW_X_RES: "1080", constants.HW_Y_RES: "1920", constants.HW_ALIAS_DPI: "240", constants.HW_ALIAS_DISK: "10240", constants.HW_ALIAS_CPUS: "2", constants.HW_ALIAS_MEMORY: "4096"} mock_avd_spec = mock.Mock( spec=[], cfg=mock_cfg, hw_customize=True, hw_property=hw_property, connect_webrtc=True, webrtc_device_id="pet-name", connect_vnc=True, openwrt=True, num_avds_per_instance=2, base_instance_num=3, launch_args="--setupwizard_mode=REQUIRED") expected_args = [ "-data_policy=create_if_missing", "-blank_data_image_mb=20480", "-config=phone", "-x_res=1080", "-y_res=1920", "-dpi=240", "-data_policy=always_create", "-blank_data_image_mb=10240", "-cpus=2", "-memory_mb=4096", "--start_webrtc", "--vm_manager=crosvm", "--webrtc_device_id=pet-name", "--start_vnc_server=true", "-console=true", "-num_instances=2", "--base-instance-num=3", "--setupwizard_mode=REQUIRED", "-undefok=report_anonymous_usage_stats,config", "-report_anonymous_usage_stats=y"] launch_cvd_args = cvd_utils.GetLaunchCvdArgs( mock_avd_spec, config="phone") self.assertEqual(launch_cvd_args, expected_args) def testGetRemoteFetcherConfigJson(self): """Test GetRemoteFetcherConfigJson.""" expected_log = {"path": "dir/fetcher_config.json", "type": constants.LOG_TYPE_CUTTLEFISH_LOG} self.assertEqual(expected_log, cvd_utils.GetRemoteFetcherConfigJson("dir")) @mock.patch("acloud.internal.lib.cvd_utils.utils") def testFindRemoteLogs(self, mock_utils): """Test FindRemoteLogs with the runtime directories in Android 13.""" mock_ssh = mock.Mock() mock_utils.FindRemoteFiles.return_value = [ "/kernel.log", "/logcat", "/launcher.log", "/access-kregistry", "/cuttlefish_config.json"] logs = cvd_utils.FindRemoteLogs(mock_ssh, "dir", None, None) mock_ssh.Run.assert_called_with( "test -d dir/cuttlefish/instances/cvd-1", retry=0) mock_utils.FindRemoteFiles.assert_called_with( mock_ssh, ["dir/cuttlefish/instances/cvd-1"]) expected_logs = [ { "path": "/kernel.log", "type": constants.LOG_TYPE_KERNEL_LOG, "name": "kernel.log" }, { "path": "/logcat", "type": constants.LOG_TYPE_LOGCAT, "name": "full_gce_logcat" }, { "path": "/launcher.log", "type": constants.LOG_TYPE_CUTTLEFISH_LOG, "name": "launcher.log" }, { "path": "/cuttlefish_config.json", "type": constants.LOG_TYPE_CUTTLEFISH_LOG, "name": "cuttlefish_config.json" }, { "path": "dir/cuttlefish/instances/cvd-1/tombstones", "type": constants.LOG_TYPE_DIR, "name": "tombstones-zip" }, ] self.assertEqual(expected_logs, logs) @mock.patch("acloud.internal.lib.cvd_utils.utils") def testFindRemoteLogsWithLegacyDirs(self, mock_utils): """Test FindRemoteLogs with the runtime directories in Android 11.""" mock_ssh = mock.Mock() mock_ssh.Run.side_effect = subprocess.CalledProcessError( cmd="test", returncode=1) mock_utils.FindRemoteFiles.return_value = [ "dir/cuttlefish_runtime/kernel.log", "dir/cuttlefish_runtime.4/kernel.log", ] logs = cvd_utils.FindRemoteLogs(mock_ssh, "dir", 3, 2) mock_ssh.Run.assert_called_with( "test -d dir/cuttlefish/instances/cvd-3", retry=0) mock_utils.FindRemoteFiles.assert_called_with( mock_ssh, ["dir/cuttlefish_runtime", "dir/cuttlefish_runtime.4"]) expected_logs = [ { "path": "dir/cuttlefish_runtime/kernel.log", "type": constants.LOG_TYPE_KERNEL_LOG, "name": "kernel.log" }, { "path": "dir/cuttlefish_runtime.4/kernel.log", "type": constants.LOG_TYPE_KERNEL_LOG, "name": "kernel.1.log" }, { "path": "dir/cuttlefish_runtime/tombstones", "type": constants.LOG_TYPE_DIR, "name": "tombstones-zip" }, { "path": "dir/cuttlefish_runtime.4/tombstones", "type": constants.LOG_TYPE_DIR, "name": "tombstones-zip.1" }, ] self.assertEqual(expected_logs, logs) def testFindLocalLogs(self): """Test FindLocalLogs with the runtime directory in Android 13.""" with tempfile.TemporaryDirectory() as temp_dir: log_dir = os.path.join(temp_dir, "instances", "cvd-2", "logs") kernel_log = os.path.join(os.path.join(log_dir, "kernel.log")) launcher_log = os.path.join(os.path.join(log_dir, "launcher.log")) logcat = os.path.join(os.path.join(log_dir, "logcat")) self.CreateFile(kernel_log) self.CreateFile(launcher_log) self.CreateFile(logcat) self.CreateFile(os.path.join(temp_dir, "legacy.log")) self.CreateFile(os.path.join(log_dir, "log.txt")) os.symlink(os.path.join(log_dir, "launcher.log"), os.path.join(log_dir, "link.log")) logs = cvd_utils.FindLocalLogs(temp_dir, 2) expected_logs = [ { "path": kernel_log, "type": constants.LOG_TYPE_KERNEL_LOG, }, { "path": launcher_log, "type": constants.LOG_TYPE_CUTTLEFISH_LOG, }, { "path": logcat, "type": constants.LOG_TYPE_LOGCAT, }, ] self.assertEqual(expected_logs, sorted(logs, key=lambda log: log["path"])) def testFindLocalLogsWithLegacyDir(self): """Test FindLocalLogs with the runtime directory in Android 11.""" with tempfile.TemporaryDirectory() as temp_dir: log_dir = os.path.join(temp_dir, "cuttlefish_runtime.2") log_dir_link = os.path.join(temp_dir, "cuttlefish_runtime") os.mkdir(log_dir) os.symlink(log_dir, log_dir_link, target_is_directory=True) launcher_log = os.path.join(log_dir_link, "launcher.log") self.CreateFile(launcher_log) logs = cvd_utils.FindLocalLogs(log_dir_link, 2) expected_logs = [ { "path": launcher_log, "type": constants.LOG_TYPE_CUTTLEFISH_LOG, }, ] self.assertEqual(expected_logs, logs) def testGetRemoteBuildInfoDict(self): """Test GetRemoteBuildInfoDict.""" remote_image = { "branch": "aosp-android-12-gsi", "build_id": "100000", "build_target": "aosp_cf_x86_64_phone-userdebug"} mock_avd_spec = mock.Mock( spec=[], remote_image=remote_image, kernel_build_info={"build_target": "kernel"}, system_build_info={}, bootloader_build_info={}) self.assertEqual(remote_image, cvd_utils.GetRemoteBuildInfoDict(mock_avd_spec)) kernel_build_info = { "branch": "aosp_kernel-common-android12-5.10", "build_id": "200000", "build_target": "kernel_virt_x86_64"} system_build_info = { "branch": "aosp-android-12-gsi", "build_id": "300000", "build_target": "aosp_x86_64-userdebug"} bootloader_build_info = { "branch": "aosp_u-boot-mainline", "build_id": "400000", "build_target": "u-boot_crosvm_x86_64"} all_build_info = { "kernel_branch": "aosp_kernel-common-android12-5.10", "kernel_build_id": "200000", "kernel_build_target": "kernel_virt_x86_64", "system_branch": "aosp-android-12-gsi", "system_build_id": "300000", "system_build_target": "aosp_x86_64-userdebug", "bootloader_branch": "aosp_u-boot-mainline", "bootloader_build_id": "400000", "bootloader_build_target": "u-boot_crosvm_x86_64"} all_build_info.update(remote_image) mock_avd_spec = mock.Mock( spec=[], remote_image=remote_image, kernel_build_info=kernel_build_info, system_build_info=system_build_info, bootloader_build_info=bootloader_build_info) self.assertEqual(all_build_info, cvd_utils.GetRemoteBuildInfoDict(mock_avd_spec)) def testFindMiscInfo(self): """Test FindMiscInfo.""" with tempfile.TemporaryDirectory() as temp_dir: with self.assertRaises(errors.CheckPathError): cvd_utils.FindMiscInfo(temp_dir) misc_info_path = os.path.join(temp_dir, "META", "misc_info.txt") self.CreateFile(misc_info_path, b"key=value") self.assertEqual(misc_info_path, cvd_utils.FindMiscInfo(temp_dir)) def testFindImageDir(self): """Test FindImageDir.""" with tempfile.TemporaryDirectory() as temp_dir: with self.assertRaises(errors.GetLocalImageError): cvd_utils.FindImageDir(temp_dir) image_dir = os.path.join(temp_dir, "IMAGES") self.CreateFile(os.path.join(image_dir, "super.img")) self.assertEqual(image_dir, cvd_utils.FindImageDir(temp_dir)) if __name__ == "__main__": unittest.main()