• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/env python
2#
3# Copyright 2016 - The Android Open Source Project
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9#     http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17"""Tests for acloud.public.config."""
18import unittest
19import os
20import tempfile
21
22from unittest import mock
23
24# pylint: disable=no-name-in-module,import-error
25from acloud import errors
26from acloud.internal.proto import internal_config_pb2
27from acloud.internal.proto import user_config_pb2
28from acloud.public import config
29
30
31class AcloudConfigManagerTest(unittest.TestCase):
32    """Test acloud configuration manager."""
33
34    USER_CONFIG = """
35service_account_name: "fake@developer.gserviceaccount.com"
36service_account_private_key_path: "/path/to/service/account/key"
37service_account_json_private_key_path: "/path/to/service/account/json_key"
38project: "fake-project"
39zone: "us-central1-f"
40machine_type: "n1-standard-1"
41network: "default"
42ssh_private_key_path: "/path/to/ssh/key"
43storage_bucket_name: "fake_bucket"
44orientation: "portrait"
45resolution: "1200x1200x1200x1200"
46client_id: "fake_client_id"
47client_secret: "fake_client_secret"
48extra_args_ssh_tunnel: "fake_extra_args_ssh_tunnel"
49metadata_variable {
50    key: "metadata_1"
51    value: "metadata_value_1"
52}
53hw_property: "cpu:3,resolution:1080x1920,dpi:480,memory:4g,disk:10g"
54extra_scopes: "scope1"
55extra_scopes: "scope2"
56betty_image: "fake_betty_image"
57"""
58
59    INTERNAL_CONFIG = """
60min_machine_size: "n1-standard-1"
61disk_image_name: "avd-system.tar.gz"
62disk_image_mime_type: "application/x-tar"
63disk_image_extension: ".tar.gz"
64disk_raw_image_name: "disk.raw"
65disk_raw_image_extension: ".img"
66creds_cache_file: ".fake_oauth2.dat"
67user_agent: "fake_user_agent"
68kernel_build_target: "kernel"
69emulator_build_target: "emulator-linux_x64_nolocationui"
70
71default_usr_cfg {
72    machine_type: "n1-standard-1"
73    network: "default"
74    stable_host_image_name: "fake_stable_host_image_name"
75    stable_host_image_project: "fake_stable_host_image_project"
76    stable_goldfish_host_image_name: "fake_stable_goldfish_host_image_name"
77    stable_goldfish_host_image_project: "fake_stable_goldfish_host_image_project"
78    instance_name_pattern: "fake_instance_name_pattern"
79    stable_cheeps_host_image_name: "fake_stable_cheeps_host_image_name"
80    stable_cheeps_host_image_project: "fake_stable_cheeps_host_image_project"
81    metadata_variable {
82        key: "metadata_1"
83        value: "metadata_value_1"
84    }
85
86    metadata_variable {
87        key: "metadata_2"
88        value: "metadata_value_2"
89    }
90}
91
92device_resolution_map {
93    key: "nexus5"
94    value: "1080x1920x32x480"
95}
96
97device_default_orientation_map {
98    key: "nexus5"
99    value: "portrait"
100}
101
102valid_branch_and_min_build_id {
103    key: "aosp-master"
104    value: 0
105}
106
107common_hw_property_map {
108  key: "phone"
109  value: "cpu:2,resolution:1080x1920,dpi:420,memory:4g,disk:8g"
110}
111
112common_hw_property_map {
113  key: "auto"
114  value: "cpu:4,resolution:1280x800,dpi:160,memory:4g"
115}
116"""
117
118    def setUp(self):
119        self.config_file = mock.MagicMock()
120        # initial config with test config.
121        self.config_file.read.return_value = self.INTERNAL_CONFIG
122        internal_cfg = config.AcloudConfigManager.LoadConfigFromProtocolBuffer(
123            self.config_file, internal_config_pb2.InternalConfig)
124        self.config_file.read.return_value = self.USER_CONFIG
125        usr_cfg = config.AcloudConfigManager.LoadConfigFromProtocolBuffer(
126            self.config_file, user_config_pb2.UserConfig)
127        self.cfg = config.AcloudConfig(usr_cfg, internal_cfg)
128
129    # pylint: disable=no-member
130    def testLoadUserConfig(self):
131        """Test loading user config."""
132        self.config_file.read.return_value = self.USER_CONFIG
133        cfg = config.AcloudConfigManager.LoadConfigFromProtocolBuffer(
134            self.config_file, user_config_pb2.UserConfig)
135        self.assertEqual(cfg.service_account_name,
136                         "fake@developer.gserviceaccount.com")
137        self.assertEqual(cfg.service_account_private_key_path,
138                         "/path/to/service/account/key")
139        self.assertEqual(cfg.service_account_json_private_key_path,
140                         "/path/to/service/account/json_key")
141        self.assertEqual(cfg.project, "fake-project")
142        self.assertEqual(cfg.zone, "us-central1-f")
143        self.assertEqual(cfg.machine_type, "n1-standard-1")
144        self.assertEqual(cfg.network, "default")
145        self.assertEqual(cfg.ssh_private_key_path, "/path/to/ssh/key")
146        self.assertEqual(cfg.storage_bucket_name, "fake_bucket")
147        self.assertEqual(cfg.orientation, "portrait")
148        self.assertEqual(cfg.resolution, "1200x1200x1200x1200")
149        self.assertEqual(cfg.client_id, "fake_client_id")
150        self.assertEqual(cfg.client_secret, "fake_client_secret")
151        self.assertEqual(cfg.extra_args_ssh_tunnel, "fake_extra_args_ssh_tunnel")
152        self.assertEqual(
153            dict(cfg.metadata_variable.items()),
154            {"metadata_1": "metadata_value_1"})
155        self.assertEqual(cfg.hw_property,
156                         "cpu:3,resolution:1080x1920,dpi:480,memory:4g,"
157                         "disk:10g")
158        self.assertEqual(cfg.extra_scopes, ["scope1", "scope2"])
159        self.assertEqual(cfg.betty_image, "fake_betty_image")
160
161    # pylint: disable=protected-access
162    @mock.patch("os.makedirs")
163    @mock.patch("os.path.exists")
164    def testLoadUserConfigLogic(self, mock_file_exist, _mock_makedirs):
165        """Test load user config logic.
166
167        Load user config with some special design.
168        1. User specified user config:
169            If user config didn't exist: Raise exception.
170        2. User didn't specify user config, use default config:
171            If default config didn't exist: Initialize empty data.
172        """
173        config_specify = config.AcloudConfigManager(self.config_file)
174        self.config_file.read.return_value = self.USER_CONFIG
175        self.assertEqual(config_specify.user_config_path, self.config_file)
176        mock_file_exist.return_value = False
177        with self.assertRaises(errors.ConfigError):
178            config_specify.Load()
179        # Test default config
180        config_unspecify = config.AcloudConfigManager(None)
181        cfg = config_unspecify.Load()
182        self.assertEqual(config_unspecify.user_config_path,
183                         config.GetDefaultConfigFile())
184        self.assertEqual(cfg.project, "")
185        self.assertEqual(cfg.zone, "")
186
187        # Test default user config exist
188        mock_file_exist.return_value = True
189        # Write the config data into a tmp file and have GetDefaultConfigFile
190        # return that.
191        _, temp_cfg_file_path = tempfile.mkstemp()
192        with open(temp_cfg_file_path, "w") as cfg_file:
193            cfg_file.writelines(self.USER_CONFIG)
194        default_patcher = mock.patch.object(config, "GetDefaultConfigFile",
195                                            return_value=temp_cfg_file_path)
196        default_patcher.start()
197        try:
198            config_exist = config.AcloudConfigManager(None)
199            cfg = config_exist.Load()
200            self.assertEqual(cfg.project, "fake-project")
201            self.assertEqual(cfg.zone, "us-central1-f")
202            self.assertEqual(cfg.client_id, "fake_client_id")
203            self.assertEqual(cfg.client_secret, "fake_client_secret")
204        finally:
205            # Delete tmp file
206            os.remove(temp_cfg_file_path)
207            default_patcher.stop()
208
209    def testLoadInternalConfig(self):
210        """Test loading internal config."""
211        self.config_file.read.return_value = self.INTERNAL_CONFIG
212        cfg = config.AcloudConfigManager.LoadConfigFromProtocolBuffer(
213            self.config_file, internal_config_pb2.InternalConfig)
214        self.assertEqual(cfg.min_machine_size, "n1-standard-1")
215        self.assertEqual(cfg.disk_image_name, "avd-system.tar.gz")
216        self.assertEqual(cfg.disk_image_mime_type, "application/x-tar")
217        self.assertEqual(cfg.disk_image_extension, ".tar.gz")
218        self.assertEqual(cfg.disk_raw_image_name, "disk.raw")
219        self.assertEqual(cfg.disk_raw_image_extension, ".img")
220        self.assertEqual(cfg.creds_cache_file, ".fake_oauth2.dat")
221        self.assertEqual(cfg.user_agent, "fake_user_agent")
222        self.assertEqual(cfg.default_usr_cfg.machine_type, "n1-standard-1")
223        self.assertEqual(cfg.default_usr_cfg.network, "default")
224        self.assertEqual(
225            dict(cfg.default_usr_cfg.metadata_variable.items()),
226            {"metadata_1": "metadata_value_1",
227            "metadata_2": "metadata_value_2"})
228        self.assertEqual(
229            dict(cfg.device_resolution_map.items()),
230            {"nexus5": "1080x1920x32x480"})
231        self.assertEqual(
232            dict(cfg.device_default_orientation_map.items()),
233            {"nexus5": "portrait"})
234        self.assertEqual(
235            dict(cfg.valid_branch_and_min_build_id.items()),
236            {"aosp-master": 0})
237        self.assertEqual(cfg.default_usr_cfg.stable_host_image_name,
238                         "fake_stable_host_image_name")
239        self.assertEqual(cfg.default_usr_cfg.stable_host_image_project,
240                         "fake_stable_host_image_project")
241        self.assertEqual(cfg.kernel_build_target, "kernel")
242
243        # Emulator related
244        self.assertEqual(cfg.default_usr_cfg.stable_goldfish_host_image_name,
245                         "fake_stable_goldfish_host_image_name")
246        self.assertEqual(cfg.default_usr_cfg.stable_goldfish_host_image_project,
247                         "fake_stable_goldfish_host_image_project")
248        self.assertEqual(cfg.emulator_build_target, "emulator-linux_x64_nolocationui")
249        self.assertEqual(cfg.default_usr_cfg.instance_name_pattern,
250                         "fake_instance_name_pattern")
251
252        # Cheeps related
253        self.assertEqual(cfg.default_usr_cfg.stable_cheeps_host_image_name,
254                         "fake_stable_cheeps_host_image_name")
255        self.assertEqual(cfg.default_usr_cfg.stable_cheeps_host_image_project,
256                         "fake_stable_cheeps_host_image_project")
257
258        # hw property
259        self.assertEqual(
260            dict(cfg.common_hw_property_map.items()),
261            {"phone": "cpu:2,resolution:1080x1920,dpi:420,memory:4g,disk:8g",
262             "auto": "cpu:4,resolution:1280x800,dpi:160,memory:4g"})
263
264    def testLoadConfigFails(self):
265        """Test loading a bad file."""
266        self.config_file.read.return_value = "malformed text"
267        with self.assertRaises(errors.ConfigError):
268            config.AcloudConfigManager.LoadConfigFromProtocolBuffer(
269                self.config_file, internal_config_pb2.InternalConfig)
270
271    def testOverrideWithArgs(self):
272        """Test OverrideWithArgs."""
273        # test override zone.
274        self.cfg.zone = "us-central1-f"
275        args = mock.MagicMock()
276        args.which = "create"
277        args.flavor = "phone"
278        args.zone = "us-central1-b"
279        self.cfg.OverrideWithArgs(args)
280        self.assertEqual(self.cfg.zone, "us-central1-b")
281
282    def testGetDefaultHwProperty(self):
283        """Test GetDefaultHwProperty."""
284        # test with "phone" flavor
285        expected = "cpu:2,resolution:1080x1920,dpi:420,memory:4g,disk:8g"
286        self.assertEqual(expected, self.cfg.GetDefaultHwProperty("phone"))
287
288        # test with "auto" flavor
289        expected = "cpu:4,resolution:1280x800,dpi:160,memory:4g"
290        self.assertEqual(expected, self.cfg.GetDefaultHwProperty("auto"))
291
292    def testGetMissingFields(self):
293        """Test GetMissingFields."""
294        fields = ["project", "zone", "hw_property"]
295        self.cfg.hw_property = ""
296        expected = ["hw_property"]
297        self.assertEqual(expected, self.cfg.GetMissingFields(fields))
298
299
300if __name__ == "__main__":
301    unittest.main()
302