#!/usr/bin/env python # # Copyright 2018 - 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 acloud.public.actions.create_goldfish_actions.""" import uuid import unittest from unittest import mock from acloud.internal import constants from acloud.internal.lib import android_build_client from acloud.internal.lib import android_compute_client from acloud.internal.lib import auth from acloud.internal.lib import driver_test_lib from acloud.internal.lib import goldfish_compute_client from acloud.internal.lib import ssh from acloud.public.actions import create_goldfish_action class CreateGoldfishActionTest(driver_test_lib.BaseDriverTest): """Tests create_goldfish_action.""" IP = ssh.IP(external="127.0.0.1", internal="10.0.0.1") INSTANCE = "fake-instance" IMAGE = "fake-image" BUILD_TARGET = "fake-build-target" EMULATOR_BUILD_TARGET = "emu-fake-target" BUILD_ID = "12345" EMULATOR_BUILD_ID = "1234567" GPU = "nvidia-tesla-k80" BRANCH = "fake-branch" EMULATOR_BRANCH = "emu-fake-branch" KERNEL_BRANCH = "fake-kernel-branch" KERNEL_BUILD_ID = "54321" KERNEL_BUILD_TARGET = "kernel" GOLDFISH_HOST_IMAGE_NAME = "fake-stable-host-image-name" GOLDFISH_HOST_IMAGE_PROJECT = "fake-stable-host-image-project" EXTRA_DATA_DISK_GB = 4 EXTRA_SCOPES = None LAUNCH_ARGS = "fake-args" DEFAULT_ADB_PORT = 5555 def setUp(self): """Sets up the test.""" super().setUp() self.build_client = mock.MagicMock() self.Patch( android_build_client, "AndroidBuildClient", return_value=self.build_client) self.compute_client = mock.MagicMock() self.compute_client.openwrt = False self.compute_client.gce_hostname = None self.Patch( goldfish_compute_client, "GoldfishComputeClient", return_value=self.compute_client) self.Patch( android_compute_client, "AndroidComputeClient", return_value=self.compute_client) self.Patch(auth, "CreateCredentials", return_value=mock.MagicMock()) #Initialize new avd_spec self.avd_spec = mock.MagicMock() self.avd_spec.cfg = self._CreateCfg() self.avd_spec.remote_image = {constants.BUILD_ID: self.BUILD_ID, constants.BUILD_BRANCH: self.BRANCH, constants.BUILD_TARGET: self.BUILD_TARGET} self.avd_spec.emulator_build_id = self.EMULATOR_BUILD_ID self.avd_spec.gpu = self.GPU self.avd_spec.serial_log_file = None self.avd_spec.autoconnect = False def _CreateCfg(self): """A helper method that creates a mock configuration object.""" cfg = mock.MagicMock() cfg.service_account_name = "fake@service.com" cfg.service_account_private_key_path = "/fake/path/to/key" cfg.zone = "fake_zone" cfg.ssh_private_key_path = "" cfg.ssh_public_key_path = "" cfg.stable_goldfish_host_image_name = self.GOLDFISH_HOST_IMAGE_NAME cfg.stable_goldfish_host_image_project = self.GOLDFISH_HOST_IMAGE_PROJECT cfg.emulator_build_target = self.EMULATOR_BUILD_TARGET cfg.extra_data_disk_size_gb = self.EXTRA_DATA_DISK_GB cfg.extra_scopes = self.EXTRA_SCOPES cfg.launch_args = self.LAUNCH_ARGS return cfg def testCreateDevices(self): """Tests CreateDevices.""" cfg = self._CreateCfg() # Mock uuid fake_uuid = mock.MagicMock(hex="1234") self.Patch(uuid, "uuid4", return_value=fake_uuid) # Mock compute client methods self.compute_client.GetInstanceIP.return_value = self.IP self.compute_client.GenerateImageName.return_value = self.IMAGE self.compute_client.GenerateInstanceName.return_value = self.INSTANCE # Mock build client method self.build_client.GetBuildInfo.side_effect = [ android_build_client.BuildInfo( self.BRANCH, self.BUILD_ID, self.BUILD_TARGET, None), android_build_client.BuildInfo( self.EMULATOR_BRANCH, self.EMULATOR_BUILD_ID, self.EMULATOR_BUILD_TARGET, None), android_build_client.BuildInfo( self.KERNEL_BRANCH, self.KERNEL_BUILD_ID, self.KERNEL_BUILD_TARGET, None)] none_avd_spec = None # Call CreateDevices with avd_spec is None report = create_goldfish_action.CreateDevices( none_avd_spec, cfg, build_target=self.BUILD_TARGET, build_id=self.BUILD_ID, emulator_build_id=self.EMULATOR_BUILD_ID, gpu=self.GPU, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET) # Verify self.compute_client.CreateInstance.assert_called_with( instance=self.INSTANCE, blank_data_disk_size_gb=self.EXTRA_DATA_DISK_GB, image_name=self.GOLDFISH_HOST_IMAGE_NAME, image_project=self.GOLDFISH_HOST_IMAGE_PROJECT, build_target=self.BUILD_TARGET, branch=self.BRANCH, build_id=self.BUILD_ID, emulator_branch=self.EMULATOR_BRANCH, emulator_build_id=self.EMULATOR_BUILD_ID, emulator_build_target=self.EMULATOR_BUILD_TARGET, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET, gpu=self.GPU, avd_spec=none_avd_spec, extra_scopes=self.EXTRA_SCOPES, tags=None, launch_args=self.LAUNCH_ARGS) self.assertEqual(report.data, { "devices": [ { "instance_name": self.INSTANCE, "ip": self.IP.external + ":" + str(self.DEFAULT_ADB_PORT), "branch": self.BRANCH, "build_id": self.BUILD_ID, "build_target": self.BUILD_TARGET, "emulator_branch": self.EMULATOR_BRANCH, "emulator_build_id": self.EMULATOR_BUILD_ID, "emulator_build_target": self.EMULATOR_BUILD_TARGET, "kernel_branch": self.KERNEL_BRANCH, "kernel_build_id": self.KERNEL_BUILD_ID, "kernel_build_target": self.KERNEL_BUILD_TARGET, }, ], }) self.assertEqual(report.command, "create_gf") self.assertEqual(report.status, "SUCCESS") # Call CreateDevices with avd_spec self.build_client.GetBranch.side_effect = [ self.BRANCH, self.EMULATOR_BRANCH ] # TODO: Break out avd spec testing into its own testcase. # Mock build client method self.build_client.GetBuildInfo.side_effect = [ android_build_client.BuildInfo( self.BRANCH, self.BUILD_ID, self.BUILD_TARGET, None), android_build_client.BuildInfo( self.EMULATOR_BRANCH, self.EMULATOR_BUILD_ID, self.EMULATOR_BUILD_TARGET, None), android_build_client.BuildInfo( self.KERNEL_BRANCH, self.KERNEL_BUILD_ID, self.KERNEL_BUILD_TARGET, None)] report = create_goldfish_action.CreateDevices(avd_spec=self.avd_spec) # Verify self.compute_client.CreateInstance.assert_called_with( instance=self.INSTANCE, blank_data_disk_size_gb=self.EXTRA_DATA_DISK_GB, image_name=self.GOLDFISH_HOST_IMAGE_NAME, image_project=self.GOLDFISH_HOST_IMAGE_PROJECT, build_target=self.BUILD_TARGET, branch=self.BRANCH, build_id=self.BUILD_ID, emulator_branch=self.EMULATOR_BRANCH, emulator_build_id=self.EMULATOR_BUILD_ID, emulator_build_target=self.EMULATOR_BUILD_TARGET, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET, gpu=self.GPU, avd_spec=self.avd_spec, extra_scopes=self.EXTRA_SCOPES, tags=None, launch_args=self.LAUNCH_ARGS) def testCreateDevicesWithoutBuildId(self): """Test CreateDevices when emulator sysimage buildid is not provided.""" cfg = self._CreateCfg() # Mock uuid fake_uuid = mock.MagicMock(hex="1234") self.Patch(uuid, "uuid4", return_value=fake_uuid) # Mock compute client methods self.compute_client.GetInstanceIP.return_value = self.IP self.compute_client.GenerateImageName.return_value = self.IMAGE self.compute_client.GenerateInstanceName.return_value = self.INSTANCE # Mock build client method self.build_client.GetBuildInfo.side_effect = [ android_build_client.BuildInfo( self.BRANCH, self.BUILD_ID, self.BUILD_TARGET, None), android_build_client.BuildInfo( self.EMULATOR_BRANCH, self.EMULATOR_BUILD_ID, self.EMULATOR_BUILD_TARGET, None), android_build_client.BuildInfo( self.KERNEL_BRANCH, self.KERNEL_BUILD_ID, self.KERNEL_BUILD_TARGET, None)] # Mock _FetchBuildIdFromFile method self.Patch( create_goldfish_action, "_FetchBuildIdFromFile", return_value=self.BUILD_ID) none_avd_spec = None # Call CreateDevices with no avd_spec report = create_goldfish_action.CreateDevices( none_avd_spec, cfg, build_target=self.BUILD_TARGET, build_id=None, emulator_build_id=self.EMULATOR_BUILD_ID, emulator_branch=None, gpu=self.GPU, branch=None, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET) # Verify self.compute_client.CreateInstance.assert_called_with( instance=self.INSTANCE, blank_data_disk_size_gb=self.EXTRA_DATA_DISK_GB, image_name=self.GOLDFISH_HOST_IMAGE_NAME, image_project=self.GOLDFISH_HOST_IMAGE_PROJECT, build_target=self.BUILD_TARGET, branch=self.BRANCH, build_id=self.BUILD_ID, emulator_branch=self.EMULATOR_BRANCH, emulator_build_id=self.EMULATOR_BUILD_ID, emulator_build_target=self.EMULATOR_BUILD_TARGET, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET, gpu=self.GPU, avd_spec=none_avd_spec, extra_scopes=self.EXTRA_SCOPES, tags=None, launch_args=self.LAUNCH_ARGS) self.assertEqual(report.data, { "devices": [{ "instance_name": self.INSTANCE, "ip": self.IP.external + ":" + str(self.DEFAULT_ADB_PORT), "branch": self.BRANCH, "build_id": self.BUILD_ID, "build_target": self.BUILD_TARGET, "emulator_branch": self.EMULATOR_BRANCH, "emulator_build_id": self.EMULATOR_BUILD_ID, "emulator_build_target": self.EMULATOR_BUILD_TARGET, "kernel_branch": self.KERNEL_BRANCH, "kernel_build_id": self.KERNEL_BUILD_ID, "kernel_build_target": self.KERNEL_BUILD_TARGET, },], }) self.assertEqual(report.command, "create_gf") self.assertEqual(report.status, "SUCCESS") # Call CreateDevices with avd_spec self.build_client.GetBranch.side_effect = [ self.BRANCH, self.EMULATOR_BRANCH ] # TODO: Break out avd spec testing into its own testcase. # Mock build client method self.build_client.GetBuildInfo.side_effect = [ android_build_client.BuildInfo( self.BRANCH, self.BUILD_ID, self.BUILD_TARGET, None), android_build_client.BuildInfo( self.EMULATOR_BRANCH, self.EMULATOR_BUILD_ID, self.EMULATOR_BUILD_TARGET, None), android_build_client.BuildInfo( self.KERNEL_BRANCH, self.KERNEL_BUILD_ID, self.KERNEL_BUILD_TARGET, None)] report = create_goldfish_action.CreateDevices(avd_spec=self.avd_spec) # Verify self.compute_client.CreateInstance.assert_called_with( instance=self.INSTANCE, blank_data_disk_size_gb=self.EXTRA_DATA_DISK_GB, image_name=self.GOLDFISH_HOST_IMAGE_NAME, image_project=self.GOLDFISH_HOST_IMAGE_PROJECT, build_target=self.BUILD_TARGET, branch=self.BRANCH, build_id=self.BUILD_ID, emulator_branch=self.EMULATOR_BRANCH, emulator_build_id=self.EMULATOR_BUILD_ID, emulator_build_target=self.EMULATOR_BUILD_TARGET, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET, gpu=self.GPU, avd_spec=self.avd_spec, extra_scopes=self.EXTRA_SCOPES, tags=None, launch_args=self.LAUNCH_ARGS) #pylint: disable=invalid-name def testCreateDevicesWithoutEmulatorBuildId(self): """Test CreateDevices when emulator build id is not provided.""" cfg = self._CreateCfg() # Mock uuid fake_uuid = mock.MagicMock(hex="1234") self.Patch(uuid, "uuid4", return_value=fake_uuid) # Mock compute client methods self.compute_client.GetInstanceIP.return_value = self.IP self.compute_client.GenerateImageName.return_value = self.IMAGE self.compute_client.GenerateInstanceName.return_value = self.INSTANCE # Mock build client method self.build_client.GetBuildInfo.side_effect = [ android_build_client.BuildInfo( self.BRANCH, self.BUILD_ID, self.BUILD_TARGET, None), android_build_client.BuildInfo( self.EMULATOR_BRANCH, self.EMULATOR_BUILD_ID, self.EMULATOR_BUILD_TARGET, None), android_build_client.BuildInfo( self.KERNEL_BRANCH, self.KERNEL_BUILD_ID, self.KERNEL_BUILD_TARGET, None)] # Mock _FetchBuildIdFromFile method self.Patch( create_goldfish_action, "_FetchBuildIdFromFile", return_value=self.EMULATOR_BUILD_ID) none_avd_spec = None # Call CreateDevices report = create_goldfish_action.CreateDevices( none_avd_spec, cfg, build_target=self.BUILD_TARGET, build_id=self.BUILD_ID, emulator_build_id=None, gpu=self.GPU) # Verify self.compute_client.CreateInstance.assert_called_with( instance=self.INSTANCE, blank_data_disk_size_gb=self.EXTRA_DATA_DISK_GB, image_name=self.GOLDFISH_HOST_IMAGE_NAME, image_project=self.GOLDFISH_HOST_IMAGE_PROJECT, build_target=self.BUILD_TARGET, branch=self.BRANCH, build_id=self.BUILD_ID, emulator_branch=self.EMULATOR_BRANCH, emulator_build_id=self.EMULATOR_BUILD_ID, emulator_build_target=self.EMULATOR_BUILD_TARGET, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET, gpu=self.GPU, avd_spec=none_avd_spec, extra_scopes=self.EXTRA_SCOPES, tags=None, launch_args=self.LAUNCH_ARGS) self.assertEqual(report.data, { "devices": [{ "instance_name": self.INSTANCE, "ip": self.IP.external + ":" + str(self.DEFAULT_ADB_PORT), "branch": self.BRANCH, "build_id": self.BUILD_ID, "build_target": self.BUILD_TARGET, "emulator_branch": self.EMULATOR_BRANCH, "emulator_build_id": self.EMULATOR_BUILD_ID, "emulator_build_target": self.EMULATOR_BUILD_TARGET, "kernel_branch": self.KERNEL_BRANCH, "kernel_build_id": self.KERNEL_BUILD_ID, "kernel_build_target": self.KERNEL_BUILD_TARGET, },], }) self.assertEqual(report.command, "create_gf") self.assertEqual(report.status, "SUCCESS") # Call CreateDevices with avd_spec self.build_client.GetBranch.side_effect = [ self.BRANCH, self.EMULATOR_BRANCH ] # TODO: Break out avd spec testing into its own testcase. # Mock build client method self.build_client.GetBuildInfo.side_effect = [ android_build_client.BuildInfo( self.BRANCH, self.BUILD_ID, self.BUILD_TARGET, None), android_build_client.BuildInfo( self.EMULATOR_BRANCH, self.EMULATOR_BUILD_ID, self.EMULATOR_BUILD_TARGET, None), android_build_client.BuildInfo( self.KERNEL_BRANCH, self.KERNEL_BUILD_ID, self.KERNEL_BUILD_TARGET, None)] report = create_goldfish_action.CreateDevices(avd_spec=self.avd_spec) # Verify self.compute_client.CreateInstance.assert_called_with( instance=self.INSTANCE, blank_data_disk_size_gb=self.EXTRA_DATA_DISK_GB, image_name=self.GOLDFISH_HOST_IMAGE_NAME, image_project=self.GOLDFISH_HOST_IMAGE_PROJECT, build_target=self.BUILD_TARGET, branch=self.BRANCH, build_id=self.BUILD_ID, emulator_branch=self.EMULATOR_BRANCH, emulator_build_id=self.EMULATOR_BUILD_ID, emulator_build_target=self.EMULATOR_BUILD_TARGET, kernel_branch=self.KERNEL_BRANCH, kernel_build_id=self.KERNEL_BUILD_ID, kernel_build_target=self.KERNEL_BUILD_TARGET, gpu=self.GPU, avd_spec=self.avd_spec, extra_scopes=self.EXTRA_SCOPES, tags=None, launch_args=self.LAUNCH_ARGS) if __name__ == "__main__": unittest.main()