feature_uacomment.py raw

   1  #!/usr/bin/env python3
   2  # Copyright (c) 2017-2019 The Limenka developers
   3  # Distributed under the MIT software license, see the accompanying
   4  # file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5  """Test the -uacomment option."""
   6  
   7  import re
   8  
   9  from test_framework.test_framework import LimenkaTestFramework
  10  from test_framework.test_node import ErrorMatch
  11  from test_framework.util import assert_equal
  12  
  13  
  14  class UacommentTest(LimenkaTestFramework):
  15      def set_test_params(self):
  16          self.num_nodes = 1
  17          self.setup_clean_chain = True
  18  
  19      def run_test(self):
  20          self.log.info("test multiple -uacomment")
  21          test_uacomment = self.nodes[0].getnetworkinfo()["subversion"]
  22          assert "(testnode0)" in test_uacomment
  23  
  24          self.restart_node(0, ["-uacomment=foo"])
  25          foo_uacomment = self.nodes[0].getnetworkinfo()["subversion"]
  26          assert "(testnode0; foo)" in foo_uacomment
  27          foo_uacomment_len = len(foo_uacomment)
  28  
  29          self.log.info("test -uacomment max length")
  30          self.stop_node(0)
  31          expected = r"Error: Total length of network version string \([0-9]+\) exceeds maximum length \(256\). Reduce the number or size of uacomments."
  32          self.nodes[0].assert_start_raises_init_error(["-uacomment=foo" + ('a' * (257 - foo_uacomment_len))], expected, match=ErrorMatch.FULL_REGEX)
  33  
  34          self.log.info("test -uacomment unsafe characters")
  35          for unsafe_char in ['/', ':', '(', ')', '₿', '🏃']:
  36              expected = r"Error: User Agent comment \(" + re.escape(unsafe_char) + r"\) contains unsafe characters."
  37              self.nodes[0].assert_start_raises_init_error(["-uacomment=" + unsafe_char], expected, match=ErrorMatch.FULL_REGEX)
  38  
  39          self.log.info("test -uaappend")
  40          self.restart_node(0, ["-uaappend=foo:0"])
  41          assert_equal(self.nodes[0].getnetworkinfo()["subversion"][-7:], '/foo:0/')
  42  
  43          self.restart_node(0, ["-uaappend=foo:9/"])
  44          assert_equal(self.nodes[0].getnetworkinfo()["subversion"][-7:], '/foo:9/')
  45  
  46          self.nodes[0].args.remove("-uacomment=testnode0")
  47  
  48          self.log.info("test -uaspoof")
  49          self.restart_node(0, ["-uaspoof=/foo:0/"])
  50          assert_equal(self.nodes[0].getnetworkinfo()["subversion"], '/foo:0/')
  51  
  52          exp_warning = "Specified uaspoof option is not in BIP 14 format. User-agent strings should look like '/Name:Version/Name:Version/.../'."
  53          with self.nodes[0].assert_debug_log(expected_msgs=[exp_warning]):
  54              self.restart_node(0, ["-uaspoof=foo:9"])
  55              assert_equal(self.nodes[0].getnetworkinfo()["subversion"], 'foo:9')
  56              self.stop_node(0, expected_stderr='Warning: ' + exp_warning)
  57  
  58          exp_warning = 'Both uaspoof and uacomment(s) are specified, but uacomment(s) are ignored when uaspoof is in use.'
  59          with self.nodes[0].assert_debug_log(expected_msgs=[exp_warning]):
  60              self.restart_node(0, ["-uaspoof=/foo:0/", "-uacomment=foo"])
  61              assert_equal(self.nodes[0].getnetworkinfo()["subversion"], '/foo:0/')
  62              self.stop_node(0, expected_stderr='Warning: ' + exp_warning)
  63  
  64          self.restart_node(0, ["-uaspoof=/foo:0/", "-uaappend=foo:9"])
  65          assert_equal(self.nodes[0].getnetworkinfo()["subversion"], '/foo:0/foo:9/')
  66  
  67  
  68  if __name__ == '__main__':
  69      UacommentTest(__file__).main()
  70