unit_tests.py 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2023 The MMGen Project <mmgen@tuta.io>
  5. #
  6. # This program is free software: you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License as published by
  8. # the Free Software Foundation, either version 3 of the License, or
  9. # (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18. """
  19. test/unit_tests.py: Unit tests for the MMGen suite
  20. """
  21. import sys,os,time,importlib,platform
  22. import include.test_init
  23. from mmgen.devinit import init_dev
  24. init_dev()
  25. from mmgen.common import *
  26. from test.include.common import set_globals,end_msg
  27. opts_data = {
  28. 'text': {
  29. 'desc': "Unit tests for the MMGen suite",
  30. 'usage':'[options] [test | test.subtest]...',
  31. 'options': """
  32. -h, --help Print this help message
  33. -a, --no-altcoin-deps Skip tests requiring altcoin daemons, libs or utils
  34. -A, --no-daemon-autostart Don't start and stop daemons automatically
  35. -D, --no-daemon-stop Don't stop auto-started daemons after running tests
  36. -f, --fast Speed up execution by reducing rounds on some tests
  37. -l, --list List available tests
  38. -L, --list-subtests List available tests and subtests
  39. -n, --names Print command names instead of descriptions
  40. -q, --quiet Produce quieter output
  41. -x, --exclude=T Exclude tests 'T' (comma-separated)
  42. -v, --verbose Produce more verbose output
  43. """,
  44. 'notes': """
  45. If no test is specified, all available tests are run
  46. """
  47. }
  48. }
  49. sys.argv.insert(1,'--skip-cfg-file')
  50. cfg = Config(opts_data=opts_data)
  51. type(cfg)._reset_ok += ('use_internal_keccak_module','debug_addrlist')
  52. set_globals(cfg)
  53. file_pfx = 'ut_'
  54. tests_d = os.path.join(include.test_init.repo_root,'test','unit_tests_d')
  55. all_tests = sorted(fn[len(file_pfx):-len('.py')] for fn in os.listdir(tests_d) if fn.startswith(file_pfx))
  56. exclude = cfg.exclude.split(',') if cfg.exclude else []
  57. for e in exclude:
  58. if e not in all_tests:
  59. die(1,f'{e!r}: invalid parameter for --exclude (no such test)')
  60. start_time = int(time.time())
  61. if cfg.list:
  62. Msg(' '.join(all_tests))
  63. sys.exit(0)
  64. if cfg.list_subtests:
  65. def gen():
  66. for test in all_tests:
  67. mod = importlib.import_module(f'test.unit_tests_d.{file_pfx}{test}')
  68. if hasattr(mod,'unit_tests'):
  69. t = getattr(mod,'unit_tests')
  70. subtests = [k for k,v in t.__dict__.items() if type(v).__name__ == 'function' and k[0] != '_']
  71. yield fs.format( test, ' '.join(f'{subtest}' for subtest in subtests) )
  72. else:
  73. yield test
  74. fs = '{:%s} {}' % max(len(t) for t in all_tests)
  75. Msg( fs.format('TEST','SUBTESTS') + '\n' + '\n'.join(gen()) )
  76. sys.exit(0)
  77. class UnitTestHelpers:
  78. def __init__(self,subtest_name):
  79. self.subtest_name = subtest_name
  80. def skip_msg(self,desc):
  81. cfg._util.qmsg(gray(f'Skipping subtest {self.subtest_name.replace("_","-")!r} for {desc}'))
  82. def process_bad_data(self,data):
  83. if os.getenv('PYTHONOPTIMIZE'):
  84. ymsg('PYTHONOPTIMIZE set, skipping error handling tests')
  85. return
  86. import re
  87. desc_w = max(len(e[0]) for e in data)
  88. exc_w = max(len(e[1]) for e in data)
  89. m_exc = '{!r}: incorrect exception type (expected {!r})'
  90. m_err = '{!r}: incorrect error msg (should match {!r}'
  91. m_noraise = "\nillegal action 'bad {}' failed to raise an exception (expected {!r})"
  92. for (desc,exc_chk,emsg_chk,func) in data:
  93. try:
  94. cfg._util.vmsg_r(' bad {:{w}}'.format( desc+':', w=desc_w+1 ))
  95. func()
  96. except Exception as e:
  97. exc = type(e).__name__
  98. emsg = e.args[0]
  99. cfg._util.vmsg(' {:{w}} [{}]'.format( exc, emsg, w=exc_w ))
  100. assert exc == exc_chk, m_exc.format(exc,exc_chk)
  101. assert re.search(emsg_chk,emsg), m_err.format(emsg,emsg_chk)
  102. else:
  103. die(4,m_noraise.format(desc,exc_chk))
  104. tests_seen = []
  105. def run_test(test,subtest=None):
  106. mod = importlib.import_module(f'test.unit_tests_d.{file_pfx}{test}')
  107. def run_subtest(subtest):
  108. subtest_disp = subtest.replace('_','-')
  109. msg(f'Running unit subtest {test}.{subtest_disp}')
  110. t = getattr(mod,'unit_tests')()
  111. if hasattr(t,'_pre_subtest'):
  112. getattr(t,'_pre_subtest')(test,subtest,UnitTestHelpers(subtest))
  113. ret = getattr(t,subtest.replace('-','_'))(test,UnitTestHelpers(subtest))
  114. if hasattr(t,'_post_subtest'):
  115. getattr(t,'_post_subtest')(test,subtest,UnitTestHelpers(subtest))
  116. if type(ret).__name__ == 'coroutine':
  117. ret = async_run(ret)
  118. if not ret:
  119. die(4,f'Unit subtest {subtest_disp!r} failed')
  120. if test not in tests_seen:
  121. gmsg(f'Running unit test {test}')
  122. tests_seen.append(test)
  123. if subtest:
  124. run_subtest(subtest)
  125. else:
  126. if hasattr(mod,'unit_tests'): # new class-based API
  127. t = getattr(mod,'unit_tests')
  128. altcoin_deps = getattr(t,'altcoin_deps',())
  129. win_skip = getattr(t,'win_skip',())
  130. arm_skip = getattr(t,'arm_skip',())
  131. subtests = [k for k,v in t.__dict__.items() if type(v).__name__ == 'function' and k[0] != '_']
  132. for subtest in subtests:
  133. subtest_disp = subtest.replace('_','-')
  134. if cfg.no_altcoin_deps and subtest in altcoin_deps:
  135. cfg._util.qmsg(gray(f'Invoked with --no-altcoin-deps, so skipping subtest {subtest_disp!r}'))
  136. continue
  137. if gc.platform == 'win' and subtest in win_skip:
  138. cfg._util.qmsg(gray(f'Skipping subtest {subtest_disp!r} for Windows platform'))
  139. continue
  140. elif platform.machine() == 'aarch64' and subtest in arm_skip:
  141. cfg._util.qmsg(gray(f'Skipping subtest {subtest_disp!r} for ARM platform'))
  142. continue
  143. run_subtest(subtest)
  144. else:
  145. if not mod.unit_test().run_test(test,UnitTestHelpers(test)):
  146. die(4,'Unit test {test!r} failed')
  147. try:
  148. for test in (cfg._args or all_tests):
  149. if '.' in test:
  150. test,subtest = test.split('.')
  151. else:
  152. subtest = None
  153. if test not in all_tests:
  154. die(1,f'{test!r}: test not recognized')
  155. if test not in exclude:
  156. run_test(test,subtest=subtest)
  157. end_msg(int(time.time()) - start_time)
  158. except KeyboardInterrupt:
  159. die(1,green('\nExiting at user request'))