| # Copyright 2024, 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 optimized_targets.py""" |
| |
| import json |
| import logging |
| import os |
| import pathlib |
| import re |
| import subprocess |
| import textwrap |
| import unittest |
| from unittest import mock |
| from build_context import BuildContext |
| import optimized_targets |
| from pyfakefs import fake_filesystem_unittest |
| import test_discovery_agent |
| |
| |
| class GeneralTestsOptimizerTest(fake_filesystem_unittest.TestCase): |
| |
| def setUp(self): |
| self.setUpPyfakefs() |
| |
| os_environ_patcher = mock.patch.dict('os.environ', {}) |
| self.addCleanup(os_environ_patcher.stop) |
| self.mock_os_environ = os_environ_patcher.start() |
| |
| self._setup_working_build_env() |
| test_mapping_dir = pathlib.Path('/project/path/file/path') |
| test_mapping_dir.mkdir(parents=True) |
| |
| def _setup_working_build_env(self): |
| self._write_soong_ui_file() |
| self._write_change_info_file() |
| self._host_out_testcases = pathlib.Path('/tmp/top/host_out_testcases') |
| self._host_out_testcases.mkdir(parents=True) |
| self._target_out_testcases = pathlib.Path('/tmp/top/target_out_testcases') |
| self._target_out_testcases.mkdir(parents=True) |
| self._product_out = pathlib.Path('/tmp/top/product_out') |
| self._product_out.mkdir(parents=True) |
| self._soong_host_out = pathlib.Path('/tmp/top/soong_host_out') |
| self._soong_host_out.mkdir(parents=True) |
| self._host_out = pathlib.Path('/tmp/top/host_out') |
| self._host_out.mkdir(parents=True) |
| self._write_general_tests_files_outputs() |
| |
| self._dist_dir = pathlib.Path('/tmp/top/out/dist') |
| self._dist_dir.mkdir(parents=True) |
| |
| self.mock_os_environ.update({ |
| 'TOP': '/tmp/top', |
| 'DIST_DIR': '/tmp/top/out/dist', |
| 'TMPDIR': '/tmp/', |
| 'CHANGE_INFO': '/tmp/top/change_info' |
| }) |
| |
| def _write_change_info_file(self): |
| change_info_path = pathlib.Path('/tmp/top/') |
| with open(os.path.join(change_info_path, 'change_info'), 'w') as f: |
| f.write(""" |
| { |
| "changes": [ |
| { |
| "projectPath": "build/ci", |
| "revisions": [ |
| { |
| "revisionNumber": 1, |
| "fileInfos": [ |
| { |
| "path": "src/main/java/com/example/MyClass.java", |
| "action": "MODIFIED" |
| }, |
| { |
| "path": "src/test/java/com/example/MyClassTest.java", |
| "action": "ADDED" |
| } |
| ] |
| }, |
| { |
| "revisionNumber": 2, |
| "fileInfos": [ |
| { |
| "path": "src/main/java/com/example/AnotherClass.java", |
| "action": "MODIFIED" |
| } |
| ] |
| } |
| ] |
| } |
| ] |
| } |
| """) |
| |
| def _write_soong_ui_file(self): |
| soong_path = pathlib.Path('/tmp/top/build/soong') |
| soong_path.mkdir(parents=True) |
| with open(os.path.join(soong_path, 'soong_ui.bash'), 'w') as f: |
| f.write(""" |
| #/bin/bash |
| echo PRODUCT_OUT='/tmp/top/product_out' |
| echo SOONG_HOST_OUT='/tmp/top/soong_host_out' |
| echo HOST_OUT='/tmp/top/host_out' |
| """) |
| os.chmod(os.path.join(soong_path, 'soong_ui.bash'), 0o666) |
| |
| def _write_general_tests_files_outputs(self): |
| with open(os.path.join(self._product_out, 'general-tests_files'), 'w') as f: |
| f.write(""" |
| path/to/module_1/general-tests-host-file |
| path/to/module_1/general-tests-host-file.config |
| path/to/module_1/general-tests-target-file |
| path/to/module_1/general-tests-target-file.config |
| path/to/module_2/general-tests-host-file |
| path/to/module_2/general-tests-host-file.config |
| path/to/module_2/general-tests-target-file |
| path/to/module_2/general-tests-target-file.config |
| path/to/module_1/general-tests-host-file |
| path/to/module_1/general-tests-host-file.config |
| path/to/module_1/general-tests-target-file |
| path/to/module_1/general-tests-target-file.config |
| """) |
| with open(os.path.join(self._product_out, 'general-tests_host_files'), 'w') as f: |
| f.write(""" |
| path/to/module_1/general-tests-host-file |
| path/to/module_1/general-tests-host-file.config |
| path/to/module_2/general-tests-host-file |
| path/to/module_2/general-tests-host-file.config |
| path/to/module_1/general-tests-host-file |
| path/to/module_1/general-tests-host-file.config |
| """) |
| with open(os.path.join(self._product_out, 'general-tests_target_files'), 'w') as f: |
| f.write(""" |
| path/to/module_1/general-tests-target-file |
| path/to/module_1/general-tests-target-file.config |
| path/to/module_2/general-tests-target-file |
| path/to/module_2/general-tests-target-file.config |
| path/to/module_1/general-tests-target-file |
| path/to/module_1/general-tests-target-file.config |
| """) |
| |
| |
| @mock.patch('subprocess.run') |
| @mock.patch.object(test_discovery_agent.TestDiscoveryAgent, 'discover_test_mapping_test_modules') |
| def test_general_tests_optimized(self, discover_modules, subprocess_run): |
| subprocess_run.return_value = self._get_soong_vars_output() |
| discover_modules.return_value = (['module_1'], ['dependency_1']) |
| |
| optimizer = self._create_general_tests_optimizer() |
| |
| build_targets = optimizer.get_build_targets() |
| |
| expected_build_targets = set( |
| optimized_targets.GeneralTestsOptimizer._REQUIRED_MODULES |
| ) |
| expected_build_targets.add('module_1') |
| |
| self.assertSetEqual(build_targets, expected_build_targets) |
| |
| @mock.patch('subprocess.run') |
| @mock.patch.object(test_discovery_agent.TestDiscoveryAgent, 'discover_test_mapping_test_modules') |
| def test_module_unused_module_not_built(self, discover_modules, subprocess_run): |
| subprocess_run.return_value = self._get_soong_vars_output() |
| discover_modules.return_value = (['no_module'], ['dependency_1']) |
| |
| optimizer = self._create_general_tests_optimizer() |
| |
| build_targets = optimizer.get_build_targets() |
| |
| expected_build_targets = set( |
| optimized_targets.GeneralTestsOptimizer._REQUIRED_MODULES |
| ) |
| self.assertSetEqual(build_targets, expected_build_targets) |
| |
| @mock.patch('subprocess.run') |
| @mock.patch.object(test_discovery_agent.TestDiscoveryAgent, 'discover_test_mapping_test_modules') |
| def test_packaging_outputs_success(self, discover_modules, subprocess_run): |
| subprocess_run.return_value = self._get_soong_vars_output() |
| discover_modules.return_value = (['module_1'], ['dependency_1']) |
| optimizer = self._create_general_tests_optimizer() |
| self._set_up_build_outputs(['test_mapping_module']) |
| |
| targets = optimizer.get_build_targets() |
| package_commands = optimizer.get_package_outputs_commands() |
| |
| self._verify_soong_zip_commands(package_commands, ['module_1']) |
| |
| @mock.patch('subprocess.run') |
| def test_get_soong_dumpvars_fails_raises(self, subprocess_run): |
| subprocess_run.return_value = self._get_soong_vars_output(return_code=-1) |
| optimizer = self._create_general_tests_optimizer() |
| self._set_up_build_outputs(['test_mapping_module']) |
| |
| with self.assertRaisesRegex(RuntimeError, 'Soong dumpvars failed!'): |
| targets = optimizer.get_build_targets() |
| |
| @mock.patch('subprocess.run') |
| def test_get_soong_dumpvars_bad_output_raises(self, subprocess_run): |
| subprocess_run.return_value = self._get_soong_vars_output( |
| stdout='This output is bad' |
| ) |
| optimizer = self._create_general_tests_optimizer() |
| self._set_up_build_outputs(['test_mapping_module']) |
| |
| with self.assertRaisesRegex( |
| RuntimeError, 'Error parsing soong dumpvars output' |
| ): |
| targets = optimizer.get_build_targets() |
| |
| def _create_general_tests_optimizer(self, build_context: BuildContext = None): |
| if not build_context: |
| build_context = self._create_build_context() |
| return optimized_targets.GeneralTestsOptimizer( |
| 'general-tests', build_context, None, build_context.test_infos |
| ) |
| |
| def _create_build_context( |
| self, |
| general_tests_optimized: bool = True, |
| test_context: dict[str, any] = None, |
| ) -> BuildContext: |
| if not test_context: |
| test_context = self._create_test_context() |
| build_context_dict = {} |
| build_context_dict['enabledBuildFeatures'] = [{'name': 'optimized_build'}] |
| if general_tests_optimized: |
| build_context_dict['enabledBuildFeatures'].append( |
| {'name': 'general_tests_optimized'} |
| ) |
| build_context_dict['testContext'] = test_context |
| return BuildContext(build_context_dict) |
| |
| def _create_test_context(self): |
| return { |
| 'testInfos': [ |
| { |
| 'name': 'atp_test', |
| 'target': 'test_target', |
| 'branch': 'branch', |
| 'extraOptions': [ |
| { |
| 'key': 'additional-files-filter', |
| 'values': ['general-tests.zip'], |
| }, |
| { |
| 'key': 'test-mapping-test-group', |
| 'values': ['test-mapping-group'], |
| }, |
| ], |
| 'command': '/tf/command', |
| 'extraBuildTargets': [ |
| 'extra_build_target', |
| ], |
| }, |
| ], |
| } |
| |
| def _get_soong_vars_output( |
| self, return_code: int = 0, stdout: str = '' |
| ) -> subprocess.CompletedProcess: |
| return_value = subprocess.CompletedProcess(args=[], returncode=return_code) |
| if not stdout: |
| stdout = textwrap.dedent(f"""\ |
| PRODUCT_OUT='{self._product_out}' |
| SOONG_HOST_OUT='{self._soong_host_out}' |
| HOST_OUT='{self._host_out}' |
| """) |
| |
| return_value.stdout = stdout |
| return return_value |
| |
| def _set_up_build_outputs(self, targets: list[str]): |
| for target in targets: |
| host_dir = self._host_out_testcases / target |
| host_dir.mkdir() |
| (host_dir / f'{target}.config').touch() |
| (host_dir / f'test_file').touch() |
| |
| target_dir = self._target_out_testcases / target |
| target_dir.mkdir() |
| (target_dir / f'{target}.config').touch() |
| (target_dir / f'test_file').touch() |
| |
| def _verify_soong_zip_commands(self, commands: list[str], targets: list[str]): |
| """Verify the structure of the zip commands. |
| |
| Zip commands have to start with the soong_zip binary path, then are followed |
| by a couple of options and the name of the file being zipped. Depending on |
| which zip we are creating look for a few essential items being added in |
| those zips. |
| |
| Args: |
| commands: list of command lists |
| targets: list of targets expected to be in general-tests.zip |
| """ |
| for command in commands: |
| self.assertEqual( |
| '/tmp/top/prebuilts/build-tools/linux-x86/bin/soong_zip', |
| command[0], |
| ) |
| self.assertEqual('-d', command[1]) |
| self.assertEqual('-o', command[2]) |
| match (command[3]): |
| case '/tmp/top/out/dist/general-tests_configs.zip': |
| self.assertIn(f'{self._host_out}/host_general-tests_list', command) |
| self.assertIn( |
| f'{self._product_out}/target_general-tests_list', command |
| ) |
| return |
| case '/tmp/top/out/dist/general-tests_list.zip': |
| self.assertIn('-f', command) |
| self.assertIn(f'{self._host_out}/general-tests_list', command) |
| return |
| case '/tmp/top/out/dist/general-tests.zip': |
| for target in targets: |
| self.assertIn(f'{self._host_out_testcases}/{target}', command) |
| self.assertIn(f'{self._target_out_testcases}/{target}', command) |
| self.assertIn( |
| f'{self._soong_host_out}/framework/cts-tradefed.jar', command |
| ) |
| self.assertIn( |
| f'{self._soong_host_out}/framework/compatibility-host-util.jar', |
| command, |
| ) |
| self.assertIn( |
| f'{self._soong_host_out}/framework/vts-tradefed.jar', command |
| ) |
| return |
| case _: |
| self.fail(f'malformed command: {command}') |
| |
| |
| if __name__ == '__main__': |
| # Setup logging to be silent so unit tests can pass through TF. |
| logging.disable(logging.ERROR) |
| unittest.main() |