| # SPDX-License-Identifier: Apache-2.0 |
| # Copyright 2024 Meson project contributors |
| |
| from mesonbuild.options import * |
| |
| import unittest |
| |
| |
| def num_options(store: OptionStore) -> int: |
| return len(store.options) |
| |
| |
| class OptionTests(unittest.TestCase): |
| |
| def test_basic(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| default_value = 'somevalue' |
| new_value = 'new_value' |
| vo = UserStringOption(name, 'An option of some sort', default_value) |
| optstore.add_system_option(name, vo) |
| self.assertEqual(optstore.get_value_for(name), default_value) |
| optstore.set_option(OptionKey.from_string(name), new_value) |
| self.assertEqual(optstore.get_value_for(name), new_value) |
| |
| def test_toplevel_project(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| default_value = 'somevalue' |
| new_value = 'new_value' |
| k = OptionKey(name) |
| vo = UserStringOption(k.name, 'An option of some sort', default_value) |
| optstore.add_system_option(k.name, vo) |
| self.assertEqual(optstore.get_value_for(k), default_value) |
| optstore.initialize_from_top_level_project_call({OptionKey('someoption'): new_value}, {}, {}) |
| self.assertEqual(optstore.get_value_for(k), new_value) |
| |
| def test_machine_vs_project(self): |
| optstore = OptionStore(False) |
| name = 'backend' |
| default_value = 'ninja' |
| proj_value = 'xcode' |
| mfile_value = 'vs2010' |
| k = OptionKey(name) |
| prefix = UserStringOption('prefix', 'This is needed by OptionStore', '/usr') |
| optstore.add_system_option('prefix', prefix) |
| vo = UserStringOption(k.name, 'You know what this is', default_value) |
| optstore.add_system_option(k.name, vo) |
| self.assertEqual(optstore.get_value_for(k), default_value) |
| optstore.initialize_from_top_level_project_call({OptionKey(name): proj_value}, {}, |
| {OptionKey(name): mfile_value}) |
| self.assertEqual(optstore.get_value_for(k), mfile_value) |
| |
| def test_subproject_system_option(self): |
| """Test that subproject system options get their default value from the global |
| option (e.g. "sub:b_lto" can be initialized from "b_lto").""" |
| optstore = OptionStore(False) |
| name = 'b_lto' |
| default_value = 'false' |
| new_value = 'true' |
| k = OptionKey(name) |
| subk = k.evolve(subproject='sub') |
| optstore.initialize_from_top_level_project_call({}, {}, {OptionKey(name): new_value}) |
| vo = UserStringOption(k.name, 'An option of some sort', default_value) |
| optstore.add_system_option(subk, vo) |
| self.assertEqual(optstore.get_value_for(subk), new_value) |
| |
| def test_parsing(self): |
| with self.subTest('subproject'): |
| s1 = OptionKey.from_string('sub:optname') |
| s1_expected = OptionKey('optname', 'sub', MachineChoice.HOST) |
| self.assertEqual(s1, s1_expected) |
| self.assertEqual(str(s1), 'sub:optname') |
| |
| with self.subTest('plain name'): |
| s2 = OptionKey.from_string('optname') |
| s2_expected = OptionKey('optname', None, MachineChoice.HOST) |
| self.assertEqual(s2, s2_expected) |
| self.assertEqual(str(s2), 'optname') |
| |
| with self.subTest('root project'): |
| s3 = OptionKey.from_string(':optname') |
| s3_expected = OptionKey('optname', '', MachineChoice.HOST) |
| self.assertEqual(s3, s3_expected) |
| self.assertEqual(str(s3), ':optname') |
| |
| def test_subproject_for_system(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| default_value = 'somevalue' |
| vo = UserStringOption(name, 'An option of some sort', default_value) |
| optstore.add_system_option(name, vo) |
| self.assertEqual(optstore.get_value_for(name, 'somesubproject'), default_value) |
| |
| def test_reset(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| original_value = 'original' |
| reset_value = 'reset' |
| vo = UserStringOption(name, 'An option set twice', original_value) |
| optstore.add_system_option(name, vo) |
| self.assertEqual(optstore.get_value_for(name), original_value) |
| self.assertEqual(num_options(optstore), 1) |
| vo2 = UserStringOption(name, 'An option set twice', reset_value) |
| optstore.add_system_option(name, vo2) |
| self.assertEqual(optstore.get_value_for(name), original_value) |
| self.assertEqual(num_options(optstore), 1) |
| |
| def test_project_nonyielding(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| top_value = 'top' |
| sub_value = 'sub' |
| vo = UserStringOption(name, 'A top level option', top_value, False) |
| optstore.add_project_option(OptionKey(name, ''), vo) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value, False) |
| self.assertEqual(num_options(optstore), 1) |
| vo2 = UserStringOption(name, 'A subproject option', sub_value) |
| optstore.add_project_option(OptionKey(name, 'sub'), vo2) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value) |
| self.assertEqual(optstore.get_value_for(name, 'sub'), sub_value) |
| self.assertEqual(num_options(optstore), 2) |
| |
| def test_toplevel_project_yielding(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| top_value = 'top' |
| vo = UserStringOption(name, 'A top level option', top_value, True) |
| optstore.add_project_option(OptionKey(name, ''), vo) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value) |
| |
| def test_project_yielding(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| top_value = 'top' |
| sub_value = 'sub' |
| vo = UserStringOption(name, 'A top level option', top_value) |
| optstore.add_project_option(OptionKey(name, ''), vo) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value) |
| self.assertEqual(num_options(optstore), 1) |
| vo2 = UserStringOption(name, 'A subproject option', sub_value, True) |
| optstore.add_project_option(OptionKey(name, 'sub'), vo2) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value) |
| self.assertEqual(optstore.get_value_for(name, 'sub'), top_value) |
| self.assertEqual(num_options(optstore), 2) |
| |
| def test_project_yielding_not_defined_in_top_project(self): |
| optstore = OptionStore(False) |
| top_name = 'a_name' |
| top_value = 'top' |
| sub_name = 'different_name' |
| sub_value = 'sub' |
| vo = UserStringOption(top_name, 'A top level option', top_value) |
| optstore.add_project_option(OptionKey(top_name, ''), vo) |
| self.assertEqual(optstore.get_value_for(top_name, ''), top_value) |
| self.assertEqual(num_options(optstore), 1) |
| vo2 = UserStringOption(sub_name, 'A subproject option', sub_value, True) |
| optstore.add_project_option(OptionKey(sub_name, 'sub'), vo2) |
| self.assertEqual(optstore.get_value_for(top_name, ''), top_value) |
| self.assertEqual(optstore.get_value_for(sub_name, 'sub'), sub_value) |
| self.assertEqual(num_options(optstore), 2) |
| |
| def test_project_yielding_initialize(self): |
| optstore = OptionStore(False) |
| name = 'someoption' |
| top_value = 'top' |
| sub_value = 'sub' |
| subp = 'subp' |
| cmd_line = { OptionKey(name): top_value, OptionKey(name, subp): sub_value } |
| |
| vo = UserStringOption(name, 'A top level option', 'default1') |
| optstore.add_project_option(OptionKey(name, ''), vo) |
| optstore.initialize_from_top_level_project_call({}, cmd_line, {}) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value) |
| self.assertEqual(num_options(optstore), 1) |
| |
| vo2 = UserStringOption(name, 'A subproject option', 'default2', True) |
| optstore.add_project_option(OptionKey(name, 'subp'), vo2) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value) |
| self.assertEqual(optstore.get_value_for(name, subp), top_value) |
| self.assertEqual(num_options(optstore), 2) |
| |
| optstore.initialize_from_subproject_call(subp, {}, {}, cmd_line, {}) |
| self.assertEqual(optstore.get_value_for(name, ''), top_value) |
| self.assertEqual(optstore.get_value_for(name, subp), sub_value) |
| |
| def test_augments(self): |
| optstore = OptionStore(False) |
| name = 'cpp_std' |
| sub_name = 'sub' |
| sub2_name = 'sub2' |
| top_value = 'c++11' |
| aug_value = 'c++23' |
| |
| co = UserComboOption(name, |
| 'C++ language standard to use', |
| top_value, |
| choices=['c++98', 'c++11', 'c++14', 'c++17', 'c++20', 'c++23']) |
| optstore.add_system_option(name, co) |
| self.assertEqual(optstore.get_value_for(name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub_name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub2_name), top_value) |
| |
| # First augment a subproject |
| with self.subTest('set subproject override'): |
| optstore.set_from_configure_command({OptionKey.from_string(f'{sub_name}:{name}'): aug_value}) |
| self.assertEqual(optstore.get_value_for(name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub_name), aug_value) |
| self.assertEqual(optstore.get_value_for(name, sub2_name), top_value) |
| |
| with self.subTest('unset subproject override'): |
| optstore.set_from_configure_command({OptionKey.from_string(f'{sub_name}:{name}'): None}) |
| self.assertEqual(optstore.get_value_for(name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub_name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub2_name), top_value) |
| |
| # And now augment the top level option |
| optstore.set_from_configure_command({OptionKey.from_string(f':{name}'): aug_value}) |
| self.assertEqual(optstore.get_value_for(name, None), top_value) |
| self.assertEqual(optstore.get_value_for(name, ''), aug_value) |
| self.assertEqual(optstore.get_value_for(name, sub_name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub2_name), top_value) |
| |
| optstore.set_from_configure_command({OptionKey.from_string(f':{name}'): None}) |
| self.assertEqual(optstore.get_value_for(name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub_name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub2_name), top_value) |
| |
| def test_augment_set_sub(self): |
| optstore = OptionStore(False) |
| name = 'cpp_std' |
| sub_name = 'sub' |
| sub2_name = 'sub2' |
| top_value = 'c++11' |
| aug_value = 'c++23' |
| set_value = 'c++20' |
| |
| co = UserComboOption(name, |
| 'C++ language standard to use', |
| top_value, |
| choices=['c++98', 'c++11', 'c++14', 'c++17', 'c++20', 'c++23'], |
| ) |
| optstore.add_system_option(name, co) |
| optstore.set_from_configure_command({OptionKey.from_string(f'{sub_name}:{name}'): aug_value}) |
| optstore.set_from_configure_command({OptionKey.from_string(f'{sub_name}:{name}'): set_value}) |
| self.assertEqual(optstore.get_value_for(name), top_value) |
| self.assertEqual(optstore.get_value_for(name, sub_name), set_value) |
| |
| def test_build_to_host(self): |
| key = OptionKey('cpp_std') |
| def_value = 'c++98' |
| opt_value = 'c++17' |
| optstore = OptionStore(False) |
| co = UserComboOption(key.name, |
| 'C++ language standard to use', |
| def_value, |
| choices=['c++98', 'c++11', 'c++14', 'c++17', 'c++20', 'c++23'], |
| ) |
| optstore.add_compiler_option('cpp', key, co) |
| |
| cmd_line = {key: opt_value} |
| optstore.initialize_from_top_level_project_call({}, cmd_line, {}) |
| self.assertEqual(optstore.get_value_object_and_value_for(key.as_build())[1], opt_value) |
| self.assertEqual(optstore.get_value(key.as_build()), opt_value) |
| self.assertEqual(optstore.get_value_for(key.as_build()), opt_value) |
| |
| def test_build_to_host_subproject(self): |
| key = OptionKey('cpp_std') |
| def_value = 'c++98' |
| opt_value = 'c++17' |
| subp = 'subp' |
| optstore = OptionStore(False) |
| co = UserComboOption(key.name, |
| 'C++ language standard to use', |
| def_value, |
| choices=['c++98', 'c++11', 'c++14', 'c++17', 'c++20', 'c++23'], |
| ) |
| optstore.add_compiler_option('cpp', key, co) |
| |
| spcall = {key: opt_value} |
| optstore.initialize_from_top_level_project_call({}, {}, {}) |
| optstore.initialize_from_subproject_call(subp, spcall, {}, {}, {}) |
| self.assertEqual(optstore.get_value_object_and_value_for(key.evolve(subproject=subp, |
| machine=MachineChoice.BUILD))[1], opt_value) |
| self.assertEqual(optstore.get_value(key.evolve(subproject=subp, |
| machine=MachineChoice.BUILD)), opt_value) |
| self.assertEqual(optstore.get_value_for(key.evolve(subproject=subp, |
| machine=MachineChoice.BUILD)), opt_value) |
| |
| def test_build_to_host_cross(self): |
| key = OptionKey('cpp_std') |
| def_value = 'c++98' |
| opt_value = 'c++17' |
| optstore = OptionStore(True) |
| for k in [key, key.as_build()]: |
| co = UserComboOption(key.name, |
| 'C++ language standard to use', |
| def_value, |
| choices=['c++98', 'c++11', 'c++14', 'c++17', 'c++20', 'c++23'], |
| ) |
| optstore.add_compiler_option('cpp', k, co) |
| |
| cmd_line = {key: opt_value} |
| optstore.initialize_from_top_level_project_call({}, cmd_line, {}) |
| print(optstore.options) |
| |
| self.assertEqual(optstore.get_value_object_and_value_for(key)[1], opt_value) |
| self.assertEqual(optstore.get_value_object_and_value_for(key.as_build())[1], def_value) |
| self.assertEqual(optstore.get_value(key), opt_value) |
| self.assertEqual(optstore.get_value(key.as_build()), def_value) |
| self.assertEqual(optstore.get_value_for(key), opt_value) |
| self.assertEqual(optstore.get_value_for(key.as_build()), def_value) |
| |
| def test_b_default(self): |
| optstore = OptionStore(False) |
| value = optstore.get_default_for_b_option(OptionKey('b_vscrt')) |
| self.assertEqual(value, 'from_buildtype') |
| |
| def test_b_nonexistent(self): |
| optstore = OptionStore(False) |
| self.assertTrue(optstore.accept_as_pending_option(OptionKey('b_ndebug'))) |
| self.assertFalse(optstore.accept_as_pending_option(OptionKey('b_whatever'))) |
| |
| def test_backend_option_pending(self): |
| optstore = OptionStore(False) |
| # backend options are known after the first invocation |
| self.assertTrue(optstore.accept_as_pending_option(OptionKey('backend_whatever'), True)) |
| self.assertFalse(optstore.accept_as_pending_option(OptionKey('backend_whatever'), False)) |
| |
| def test_reconfigure_b_nonexistent(self): |
| optstore = OptionStore(False) |
| optstore.set_from_configure_command({OptionKey('b_ndebug'): True}) |
| |
| def test_unconfigure_nonexistent(self): |
| optstore = OptionStore(False) |
| with self.assertRaises(MesonException): |
| optstore.set_from_configure_command({OptionKey('nonexistent'): None}) |
| |
| def test_subproject_proj_opt_with_same_name(self): |
| name = 'tests' |
| subp = 'subp' |
| |
| optstore = OptionStore(False) |
| prefix = UserStringOption('prefix', 'This is needed by OptionStore', '/usr') |
| optstore.add_system_option('prefix', prefix) |
| o = UserBooleanOption(name, 'Tests', False) |
| optstore.add_project_option(OptionKey(name, subproject=''), o) |
| o = UserBooleanOption(name, 'Tests', True) |
| optstore.add_project_option(OptionKey(name, subproject=subp), o) |
| |
| cmd_line = {OptionKey(name): True} |
| spcall = {OptionKey(name): False} |
| |
| optstore.initialize_from_top_level_project_call({}, cmd_line, {}) |
| optstore.initialize_from_subproject_call(subp, spcall, {}, cmd_line, {}) |
| self.assertEqual(optstore.get_value_for(name, ''), True) |
| self.assertEqual(optstore.get_value_for(name, subp), False) |
| |
| def test_subproject_cmdline_override_global(self): |
| name = 'optimization' |
| subp = 'subp' |
| new_value = '0' |
| |
| optstore = OptionStore(False) |
| prefix = UserStringOption('prefix', 'This is needed by OptionStore', '/usr') |
| optstore.add_system_option('prefix', prefix) |
| o = UserComboOption(name, 'Optimization level', '0', choices=['plain', '0', 'g', '1', '2', '3', 's']) |
| optstore.add_system_option(name, o) |
| |
| toplevel_proj_default = {OptionKey(name): 's'} |
| subp_proj_default = {OptionKey(name): '3'} |
| cmd_line = {OptionKey(name): new_value} |
| |
| optstore.initialize_from_top_level_project_call(toplevel_proj_default, cmd_line, {}) |
| optstore.initialize_from_subproject_call(subp, {}, subp_proj_default, cmd_line, {}) |
| self.assertEqual(optstore.get_value_for(name, subp), new_value) |
| self.assertEqual(optstore.get_value_for(name), new_value) |
| |
| def test_subproject_parent_override_subp(self): |
| name = 'optimization' |
| subp = 'subp' |
| default_value = 's' |
| subp_value = '0' |
| |
| optstore = OptionStore(False) |
| prefix = UserStringOption('prefix', 'This is needed by OptionStore', '/usr') |
| optstore.add_system_option('prefix', prefix) |
| o = UserComboOption(name, 'Optimization level', '0', choices=['plain', '0', 'g', '1', '2', '3', 's']) |
| optstore.add_system_option(name, o) |
| |
| toplevel_proj_default = {OptionKey(name, subproject=subp): subp_value, OptionKey(name): default_value} |
| subp_proj_default = {OptionKey(name): '3'} |
| |
| optstore.initialize_from_top_level_project_call(toplevel_proj_default, {}, {}) |
| optstore.initialize_from_subproject_call(subp, {}, subp_proj_default, {}, {}) |
| self.assertEqual(optstore.get_value_for(name, subp), subp_value) |
| self.assertEqual(optstore.get_value_for(name), default_value) |
| |
| def test_subproject_cmdline_override_global_and_augment(self): |
| name = 'optimization' |
| subp = 'subp' |
| global_value = 's' |
| new_value = '0' |
| |
| optstore = OptionStore(False) |
| prefix = UserStringOption('prefix', 'This is needed by OptionStore', '/usr') |
| optstore.add_system_option('prefix', prefix) |
| o = UserComboOption(name, 'Optimization level', '0', choices=['plain', '0', 'g', '1', '2', '3', 's']) |
| optstore.add_system_option(name, o) |
| |
| toplevel_proj_default = {OptionKey(name): '1'} |
| subp_proj_default = {OptionKey(name): '3'} |
| cmd_line = {OptionKey(name): global_value, OptionKey(name, subproject=subp): new_value} |
| |
| optstore.initialize_from_top_level_project_call(toplevel_proj_default, cmd_line, {}) |
| optstore.initialize_from_subproject_call(subp, {}, subp_proj_default, cmd_line, {}) |
| self.assertEqual(optstore.get_value_for(name, subp), new_value) |
| self.assertEqual(optstore.get_value_for(name), global_value) |
| |
| def test_subproject_cmdline_override_toplevel(self): |
| name = 'default_library' |
| subp = 'subp' |
| toplevel_value = 'both' |
| subp_value = 'static' |
| |
| optstore = OptionStore(False) |
| prefix = UserStringOption('prefix', 'This is needed by OptionStore', '/usr') |
| optstore.add_system_option('prefix', prefix) |
| o = UserComboOption(name, 'Kind of library', 'both', choices=['shared', 'static', 'both']) |
| optstore.add_system_option(name, o) |
| |
| toplevel_proj_default = {OptionKey(name): 'shared'} |
| subp_proj_default = {OptionKey(name): subp_value} |
| cmd_line = {OptionKey(name, subproject=''): toplevel_value} |
| |
| optstore.initialize_from_top_level_project_call(toplevel_proj_default, cmd_line, {}) |
| optstore.initialize_from_subproject_call(subp, {}, subp_proj_default, cmd_line, {}) |
| self.assertEqual(optstore.get_value_for(name, subp), subp_value) |
| self.assertEqual(optstore.get_value_for(name, ''), toplevel_value) |
| |
| def test_subproject_buildtype(self): |
| subp = 'subp' |
| main1 = {OptionKey('buildtype'): 'release'} |
| main2 = {OptionKey('optimization'): '3', OptionKey('debug'): 'false'} |
| sub1 = {OptionKey('buildtype'): 'debug'} |
| sub2 = {OptionKey('optimization'): '0', OptionKey('debug'): 'true'} |
| |
| for mainopt, subopt in ((main1, sub1), |
| (main2, sub2), |
| ({**main1, **main2}, {**sub1, **sub2})): |
| optstore = OptionStore(False) |
| prefix = UserStringOption('prefix', 'This is needed by OptionStore', '/usr') |
| optstore.add_system_option('prefix', prefix) |
| o = UserComboOption('buildtype', 'Build type to use', 'debug', choices=['plain', 'debug', 'debugoptimized', 'release', 'minsize', 'custom']) |
| optstore.add_system_option(o.name, o) |
| o = UserComboOption('optimization', 'Optimization level', '0', choices=['plain', '0', 'g', '1', '2', '3', 's']) |
| optstore.add_system_option(o.name, o) |
| o = UserBooleanOption('debug', 'Enable debug symbols and other information', True) |
| optstore.add_system_option(o.name, o) |
| |
| optstore.initialize_from_top_level_project_call(mainopt, {}, {}) |
| optstore.initialize_from_subproject_call(subp, {}, subopt, {}, {}) |
| self.assertEqual(optstore.get_value_for('buildtype', subp), 'debug') |
| self.assertEqual(optstore.get_value_for('optimization', subp), '0') |
| self.assertEqual(optstore.get_value_for('debug', subp), True) |
| |
| def test_deprecated_nonstring_value(self): |
| # TODO: add a lot more deprecated option tests |
| optstore = OptionStore(False) |
| name = 'deprecated' |
| do = UserStringOption(name, 'An option with some deprecation', '0', |
| deprecated={'true': '1'}) |
| optstore.add_system_option(name, do) |
| optstore.set_option(OptionKey(name), True) |
| value = optstore.get_value(name) |
| self.assertEqual(value, '1') |
