ts_base.py 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2022 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. ts_base.py: Base class for the test.py test suite
  20. """
  21. import os
  22. from mmgen.globalvars import g
  23. from mmgen.opts import opt
  24. from ..include.common import *
  25. from .common import *
  26. class TestSuiteBase(object):
  27. 'initializer class for the test.py test suite'
  28. base_passthru_opts = ('data_dir','skip_cfg_file')
  29. passthru_opts = ()
  30. extra_spawn_args = []
  31. networks = ()
  32. segwit_opts_ok = False
  33. color = False
  34. def __init__(self,trunner,cfgs,spawn):
  35. from mmgen.protocol import init_proto_from_opts
  36. self.proto = init_proto_from_opts()
  37. self.tr = trunner
  38. self.cfgs = cfgs
  39. self.spawn = spawn
  40. self.have_dfl_wallet = False
  41. self.usr_rand_chars = (5,30)[bool(opt.usr_random)]
  42. self.usr_rand_arg = f'-r{self.usr_rand_chars}'
  43. self.altcoin_pfx = '' if self.proto.base_coin == 'BTC' else '-'+self.proto.base_coin
  44. self.tn_ext = ('','.testnet')[self.proto.testnet]
  45. d = {'bch':'btc','btc':'btc','ltc':'ltc'}
  46. self.fork = d[self.proto.coin.lower()] if self.proto.coin.lower() in d else None
  47. if len(self.tmpdir_nums) == 1:
  48. self.tmpdir_num = self.tmpdir_nums[0]
  49. @property
  50. def tmpdir(self):
  51. return os.path.join('test','tmp{}{}'.format(self.tmpdir_num,'-α' if g.debug_utf8 else ''))
  52. @property
  53. def segwit_mmtype(self):
  54. return ('segwit','bech32')[bool(opt.bech32)] if self.segwit else None
  55. @property
  56. def segwit_arg(self):
  57. return ['--type=' + self.segwit_mmtype] if self.segwit_mmtype else []
  58. def get_file_with_ext(self,ext,**kwargs):
  59. return get_file_with_ext(self.tmpdir,ext,**kwargs)
  60. def read_from_tmpfile(self,fn,binary=False):
  61. return read_from_file(os.path.join(self.tmpdir,fn),binary=binary)
  62. def write_to_tmpfile(self,fn,data,binary=False):
  63. return write_to_file(os.path.join(self.tmpdir,fn),data,binary=binary)
  64. def skip_for_win(self):
  65. if g.platform == 'win':
  66. msg(f'Skipping test {self.test_name!r}: not supported on MSys2 platform')
  67. return True
  68. else:
  69. return False
  70. def spawn_chk(self,*args,**kwargs):
  71. """
  72. Drop-in replacement for spawn() + t.read() for tests that spawn more than one process.
  73. Ensures that test script execution stops when a spawned process fails.
  74. """
  75. t = self.spawn(*args,**kwargs)
  76. t.read()
  77. t.ok()
  78. t.skip_ok = True
  79. return t