From c4421629c86d030937f8aacbcac3936ce9eb225b Mon Sep 17 00:00:00 2001 From: Roland Dobai Date: Mon, 24 Feb 2020 11:57:48 +0100 Subject: [PATCH] Tools: Add tests for confgen.py --- tools/ci/config/host-test.yml | 6 + tools/ci/executable-list.txt | 1 + .../kconfig_new/test/confgen/test_confgen.py | 234 ++++++++++++++++++ 3 files changed, 241 insertions(+) create mode 100755 tools/kconfig_new/test/confgen/test_confgen.py diff --git a/tools/ci/config/host-test.yml b/tools/ci/config/host-test.yml index 64a1990cbc..79f19cc8f6 100644 --- a/tools/ci/config/host-test.yml +++ b/tools/ci/config/host-test.yml @@ -169,6 +169,12 @@ test_gen_kconfig_doc: - cd tools/kconfig_new/test/gen_kconfig_doc/ - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ./test_target_visibility.py +test_confgen: + extends: .host_test_template + script: + - cd tools/kconfig_new/test/confgen/ + - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ./test_confgen.py + test_idf_monitor: extends: .host_test_template artifacts: diff --git a/tools/ci/executable-list.txt b/tools/ci/executable-list.txt index 3d7e25e5d9..da7e50e018 100644 --- a/tools/ci/executable-list.txt +++ b/tools/ci/executable-list.txt @@ -75,6 +75,7 @@ tools/kconfig/merge_config.sh tools/kconfig/streamline_config.pl tools/kconfig_new/confgen.py tools/kconfig_new/confserver.py +tools/kconfig_new/test/confgen/test_confgen.py tools/kconfig_new/test/confserver/test_confserver.py tools/kconfig_new/test/gen_kconfig_doc/test_target_visibility.py tools/ldgen/ldgen.py diff --git a/tools/kconfig_new/test/confgen/test_confgen.py b/tools/kconfig_new/test/confgen/test_confgen.py new file mode 100755 index 0000000000..75ab30ca38 --- /dev/null +++ b/tools/kconfig_new/test/confgen/test_confgen.py @@ -0,0 +1,234 @@ +#!/usr/bin/env python + +from future.utils import iteritems +import os +import re +import subprocess +import sys +import tempfile +import textwrap +import unittest + + +class ConfgenBaseTestCase(unittest.TestCase): + @classmethod + def setUpClass(self): + self.args = dict() + self.functions = {'in': self.assertIn, + 'not in': self.assertNotIn, + 'equal': self.assertEqual, + 'not equal': self.assertNotEqual} + + try: + regex_func = self.assertRegex + except AttributeError: + # Python 2 fallback + regex_func = self.assertRegexpMatches + finally: + self.functions['regex'] = regex_func + + def setUp(self): + with tempfile.NamedTemporaryFile(prefix='test_confgen_', delete=False) as f: + self.output_file = f.name + self.addCleanup(os.remove, self.output_file) + + def invoke_confgen(self, args): + call_args = [sys.executable, '../../confgen.py'] + + for (k, v) in iteritems(args): + if k != 'output': + if isinstance(v, type('')): # easy Python 2/3 compatible str/unicode + call_args += ['--{}'.format(k), v] + else: + for i in v: + call_args += ['--{}'.format(k), i] + call_args += ['--output', args['output'], self.output_file] # these arguments belong together + + subprocess.check_call(call_args) + + def invoke_and_test(self, in_text, out_text, test='in'): + with tempfile.NamedTemporaryFile(mode='w+', prefix='test_confgen_', delete=False) as f: + self.addCleanup(os.remove, f.name) + f.write(textwrap.dedent(in_text)) + + self.args['kconfig'] = f.name + + self.invoke_confgen(self.args) + + with open(self.output_file) as f_result: + result = f_result.read() + + if test == 'regex': # need to reverse the argument order + self.functions[test](self, result, out_text) + else: + self.functions[test](self, textwrap.dedent(out_text), result) + + +class CmakeTestCase(ConfgenBaseTestCase): + @classmethod + def setUpClass(self): + super(CmakeTestCase, self).setUpClass() + self.args.update({'output': 'cmake'}) + + def testStringEscape(self): + self.invoke_and_test(""" + config PASSWORD + string "password" + default "\\\\~!@#$%^&*()\\\"" + """, 'set(CONFIG_PASSWORD "\\\\~!@#$%^&*()\\\"")') + + +class JsonTestCase(ConfgenBaseTestCase): + @classmethod + def setUpClass(self): + super(JsonTestCase, self).setUpClass() + self.args.update({'output': 'json'}) + + def testStringEscape(self): + self.invoke_and_test(""" + config PASSWORD + string "password" + default "\\\\~!@#$%^&*()\\\"" + """, '"PASSWORD": "\\\\~!@#$%^&*()\\\""') + + +class JsonMenuTestCase(ConfgenBaseTestCase): + @classmethod + def setUpClass(self): + super(JsonMenuTestCase, self).setUpClass() + self.args.update({'output': 'json_menus'}) + + def testMultipleRanges(self): + self.invoke_and_test(""" + config IDF_TARGET + string "IDF target" + default "esp32" + + config SOME_SETTING + int "setting for the chip" + range 0 100 if IDF_TARGET="esp32s0" + range 0 10 if IDF_TARGET="esp32" + range -10 1 if IDF_TARGET="esp32s2" + """, re.compile(r'"range":\s+\[\s+0,\s+10\s+\]'), 'regex') + + def testHexRanges(self): + self.invoke_and_test(""" + config SOME_SETTING + hex "setting for the chip" + range 0x0 0xaf if UNDEFINED + range 0x10 0xaf + """, r'"range":\s+\[\s+16,\s+175\s+\]', 'regex') + + +class ConfigTestCase(ConfgenBaseTestCase): + @classmethod + def setUpClass(self): + super(ConfigTestCase, self).setUpClass() + self.args.update({'output': 'config'}) + self.input = """ + config TEST + bool "test" + default "n" + """ + + def setUp(self): + super(ConfigTestCase, self).setUp() + with tempfile.NamedTemporaryFile(mode='w+', prefix='test_confgen_', delete=False) as f: + self.addCleanup(os.remove, f.name) + self.args.update({'config': f.name}) # this is input in contrast with {'output': 'config'} + f.write(textwrap.dedent(""" + CONFIG_TEST=y + CONFIG_UNKNOWN=y + """)) + + def testKeepSavedOption(self): + self.invoke_and_test(self.input, 'CONFIG_TEST=y') + + def testDiscardUnknownOption(self): + self.invoke_and_test(self.input, 'CONFIG_UNKNOWN', 'not in') + + +class MakefileTestCase(ConfgenBaseTestCase): + @classmethod + def setUpClass(self): + super(MakefileTestCase, self).setUpClass() + self.args.update({'output': 'makefile'}) + + def setUp(self): + super(MakefileTestCase, self).setUp() + with tempfile.NamedTemporaryFile(mode='w+', prefix='test_confgen_', delete=False) as f1: + self.addCleanup(os.remove, f1.name) + with tempfile.NamedTemporaryFile(mode='w+', prefix='test_confgen_', delete=False) as f2: + self.addCleanup(os.remove, f2.name) + self.args.update({'env': ['COMPONENT_KCONFIGS_PROJBUILD_SOURCE_FILE={}'.format(f1.name), + 'COMPONENT_KCONFIGS_SOURCE_FILE={}'.format(f2.name), + 'IDF_TARGET=esp32']}) + + def testTarget(self): + with open(os.path.join(os.environ['IDF_PATH'], 'Kconfig')) as f: + self.invoke_and_test(f.read(), 'CONFIG_IDF_TARGET="esp32"') + + +class HeaderTestCase(ConfgenBaseTestCase): + @classmethod + def setUpClass(self): + super(HeaderTestCase, self).setUpClass() + self.args.update({'output': 'header'}) + + def testStringEscape(self): + self.invoke_and_test(""" + config PASSWORD + string "password" + default "\\\\~!@#$%^&*()\\\"" + """, '#define CONFIG_PASSWORD "\\\\~!@#$%^&*()\\\""') + + +class DocsTestCase(ConfgenBaseTestCase): + @classmethod + def setUpClass(self): + super(DocsTestCase, self).setUpClass() + self.args.update({'output': 'docs', + 'env': 'IDF_TARGET=esp32'}) + + def testChoice(self): + self.invoke_and_test(""" + menu "TEST" + choice TYPES + prompt "types" + default TYPES_OP2 + help + Description of TYPES + + config TYPES_OP1 + bool "option 1" + config TYPES_OP2 + bool "option 2" + endchoice + endmenu + """, """ + TEST + ---- + + Contains: + + - :ref:`CONFIG_TYPES` + + .. _CONFIG_TYPES: + + CONFIG_TYPES + ^^^^^^^^^^^^ + + types + + :emphasis:`Found in:` :ref:`test` + + Description of TYPES + + Available options: + - option 1 (TYPES_OP1) + - option 2 (TYPES_OP2) + """) # this is more readable than regex + + +if __name__ == "__main__": + unittest.main()