ct_base.py 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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.cmdtest_py_d.ct_base: Base class for the cmdtest.py test suite
  20. """
  21. import sys,os
  22. from mmgen.util import msg
  23. from ..include.common import cfg,write_to_file,read_from_file
  24. from .common import get_file_with_ext
  25. class CmdTestBase:
  26. 'initializer class for the cmdtest.py test suite'
  27. base_passthru_opts = ('data_dir','skip_cfg_file')
  28. passthru_opts = ()
  29. extra_spawn_args = []
  30. networks = ()
  31. segwit_opts_ok = False
  32. color = False
  33. need_daemon = False
  34. win_skip = False
  35. def __init__(self,trunner,cfgs,spawn):
  36. if hasattr(self,'name'): # init will be called multiple times for classes with multiple inheritance
  37. return
  38. self.name = type(self).__name__
  39. self.proto = cfg._proto
  40. self.tr = trunner
  41. self.cfgs = cfgs
  42. self.spawn = spawn
  43. self.have_dfl_wallet = False
  44. self.usr_rand_chars = (5,30)[bool(cfg.usr_random)]
  45. self.usr_rand_arg = f'-r{self.usr_rand_chars}'
  46. self.altcoin_pfx = '' if self.proto.base_coin == 'BTC' else '-'+self.proto.base_coin
  47. self.tn_ext = ('','.testnet')[self.proto.testnet]
  48. d = {'bch':'btc','btc':'btc','ltc':'ltc'}
  49. self.fork = d[self.proto.coin.lower()] if self.proto.coin.lower() in d else None
  50. if len(self.tmpdir_nums) == 1:
  51. self.tmpdir_num = self.tmpdir_nums[0]
  52. if self.tr:
  53. self.spawn_env = dict(self.tr.spawn_env)
  54. self.spawn_env['MMGEN_TEST_SUITE_ENABLE_COLOR'] = '1' if self.color else ''
  55. else:
  56. self.spawn_env = {} # placeholder
  57. @property
  58. def tmpdir(self):
  59. return os.path.join('test','tmp','{}{}'.format(self.tmpdir_num,'-α' if cfg.debug_utf8 else ''))
  60. @property
  61. def segwit_mmtype(self):
  62. return ('segwit','bech32')[bool(cfg.bech32)] if self.segwit else None
  63. @property
  64. def segwit_arg(self):
  65. return ['--type=' + self.segwit_mmtype] if self.segwit_mmtype else []
  66. def get_file_with_ext(self,ext,**kwargs):
  67. return get_file_with_ext(self.tmpdir,ext,**kwargs)
  68. def read_from_tmpfile(self,fn,binary=False):
  69. return read_from_file(os.path.join(self.tmpdir,fn),binary=binary)
  70. def write_to_tmpfile(self,fn,data,binary=False):
  71. return write_to_file(os.path.join(self.tmpdir,fn),data,binary=binary)
  72. def delete_tmpfile(self,fn):
  73. fn = os.path.join(self.tmpdir,fn)
  74. try:
  75. return os.unlink(fn)
  76. except:
  77. msg(f'{fn}: file does not exist or could not be deleted')
  78. def skip_for_win(self):
  79. if sys.platform == 'win32':
  80. msg(f'Skipping test {self.test_name!r}: not supported on MSys2 platform')
  81. return True
  82. else:
  83. return False
  84. def spawn_chk(self,*args,**kwargs):
  85. """
  86. Drop-in replacement for spawn() + t.read() for tests that spawn more than one process.
  87. Ensures that test script execution stops when a spawned process fails.
  88. """
  89. t = self.spawn(*args,**kwargs)
  90. t.read()
  91. t.ok()
  92. t.skip_ok = True
  93. return t