def test_linebased_channel_with_gmp_response(tc):
channel = Preprogrammed_gtp_channel("\x01\xa1\xa0\x80",
hangs_before_eof=True)
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(
GtpProtocolError, "appears to be speaking GMP", channel.get_response)
channel.close()
def test_linebased_channel_without_response(tc):
channel = Preprogrammed_gtp_channel("")
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(
GtpChannelClosed, "^engine has closed the response channel$",
channel.get_response)
channel.close()
def test_linebased_channel_with_broken_command_pipe(tc):
channel = Preprogrammed_gtp_channel(
"Usage: randomprogram [options]\n\nOptions:\n"
"--help show this help message and exit\n")
channel.break_command_stream()
tc.assertRaisesRegexp(
GtpChannelClosed, "^engine has closed the command channel$",
channel.send_command, "protocol_version", [])
channel.close()
def test_linebased_channel_hang(tc):
# Correct behaviour for a GTP controller here is to wait for a newline.
# (Would be nice to have a timeout.)
# This serves as a check that the hangs_before_eof modelling is working.
channel = Preprogrammed_gtp_channel("=prompt> ", hangs_before_eof=True)
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(
SupporterError, "this would hang", channel.get_response)
channel.close()
def test_linebased_channel_with_usage_message_response(tc):
channel = Preprogrammed_gtp_channel(
"Usage: randomprogram [options]\n\nOptions:\n"
"--help show this help message and exit\n")
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(
GtpProtocolError, "^engine isn't speaking GTP: first byte is 'U'$",
channel.get_response)
channel.close()
def test_linebased_channel_with_broken_response_pipe(tc):
channel = Preprogrammed_gtp_channel("= 2\n\n? unreached\n\n")
channel.send_command("protocol_version", [])
tc.assertEqual(channel.get_response(), (False, "2"))
channel.break_response_stream()
channel.send_command("list_commands", [])
tc.assertRaisesRegexp(
GtpChannelClosed, "^engine has closed the response channel$",
channel.get_response)
channel.close()
def test_linebased_channel_invalid_responses(tc):
channel = Preprogrammed_gtp_channel(
# good response first, to get past the "isn't speaking GTP" checking
"=\n\n"
"ERROR\n\n"
"# comments not allowed in responses\n\n")
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertRaisesRegexp(
GtpProtocolError, "^no success/failure indication from engine: "
"first line is `ERROR`$", channel.get_response)
tc.assertRaisesRegexp(
GtpProtocolError, "^no success/failure indication from engine: "
"first line is `#", channel.get_response)
def test_linebased_channel_responses(tc):
channel = Preprogrammed_gtp_channel(
"= 2\n\n"
# failure response
"? unknown command\n\n"
# final response with no newlines
"= ok")
channel.send_command("protocol_version", [])
tc.assertEqual(channel.get_response(), (False, "2"))
channel.send_command("xyzzy", ["1", "2"])
tc.assertEqual(channel.get_response(), (True, "unknown command"))
channel.send_command("quit", ["1", "2"])
tc.assertEqual(channel.get_response(), (False, "ok"))
def test_known_command_2(tc):
# Checking that known_command caches its responses
# and that it treats an error or unknown value the same as 'false'.
channel = Preprogrammed_gtp_channel(
"= true\n\n= absolutely not\n\n? error\n\n# unreached\n\n")
controller = Gtp_controller(channel, 'kc2 test')
tc.assertTrue(controller.known_command("one"))
tc.assertFalse(controller.known_command("two"))
tc.assertFalse(controller.known_command("three"))
tc.assertTrue(controller.known_command("one"))
tc.assertFalse(controller.known_command("two"))
tc.assertEqual(
channel.get_command_stream(),
"known_command one\nknown_command two\nknown_command three\n")
def test_linebased_channel_response_cleaning(tc):
channel = Preprogrammed_gtp_channel(
# empty response
"=\n\n"
# whitespace-only response
"= \n\n"
# ignores CRs (GTP spec)
"= 1abc\rde\r\n\r\n"
# ignores extra blank lines (GTP spec)
"= 2abcde\n\n\n\n"
# strips control characters (GTP spec)
"= 3a\x7fbc\x00d\x07e\n\x01\n"
# converts tabs to spaces (GTP spec)
"= 4abc\tde\n\n"
# strips leading whitespace (channel docs)
"= \t 5abcde\n\n"
# strips trailing whitepace (channel docs)
"= 6abcde \t \n\n"
# doesn't strip whitespace in the middle of a multiline response
"= 7aaa \n bbb\tccc\nddd \t \n\n"
# passes high characters through
"= 8ab\xc3\xa7de\n\n"
# all this at once, in a failure response
"? a\raa \r\n b\rbb\tcc\x01c\nddd \t \n\n")
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertEqual(channel.get_response(), (False, "1abcde"))
tc.assertEqual(channel.get_response(), (False, "2abcde"))
tc.assertEqual(channel.get_response(), (False, "3abcde"))
tc.assertEqual(channel.get_response(), (False, "4abc de"))
tc.assertEqual(channel.get_response(), (False, "5abcde"))
tc.assertEqual(channel.get_response(), (False, "6abcde"))
tc.assertEqual(channel.get_response(), (False, "7aaa \n bbb ccc\nddd"))
tc.assertEqual(channel.get_response(), (False, "8ab\xc3\xa7de"))
tc.assertEqual(channel.get_response(), (True, "aaa \n bbb ccc\nddd"))
def test_known_command_2(tc):
# Checking that known_command caches its responses
# and that it treats an error or unknown value the same as 'false'.
channel = Preprogrammed_gtp_channel(
"= true\n\n= absolutely not\n\n? error\n\n# unreached\n\n")
controller = Gtp_controller(channel, 'kc2 test')
tc.assertTrue(controller.known_command("one"))
tc.assertFalse(controller.known_command("two"))
tc.assertFalse(controller.known_command("three"))
tc.assertTrue(controller.known_command("one"))
tc.assertFalse(controller.known_command("two"))
tc.assertEqual(
channel.get_command_stream(),
"known_command one\nknown_command two\nknown_command three\n")
def test_linebased_channel_invalid_responses(tc):
channel = Preprogrammed_gtp_channel(
# good response first, to get past the "isn't speaking GTP" checking
"=\n\n"
"ERROR\n\n"
"# comments not allowed in responses\n\n"
)
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertRaisesRegexp(
GtpProtocolError, "^no success/failure indication from engine: "
"first line is `ERROR`$",
channel.get_response)
tc.assertRaisesRegexp(
GtpProtocolError, "^no success/failure indication from engine: "
"first line is `#",
channel.get_response)
def test_check_protocol_version_2(tc):
channel = Preprogrammed_gtp_channel("= 1\n\n? error\n\n# unreached\n\n")
controller = Gtp_controller(channel, 'pv2 test')
with tc.assertRaises(BadGtpResponse) as ar:
controller.check_protocol_version()
tc.assertEqual(str(ar.exception),
"pv2 test reports GTP protocol version 1")
tc.assertEqual(ar.exception.gtp_error_message, None)
# check error is not treated as a check failure
controller.check_protocol_version()
def test_channel_command_validation(tc):
channel = Preprogrammed_gtp_channel("\n\n")
# empty command
tc.assertRaises(ValueError, channel.send_command, "", [])
# space in command
tc.assertRaises(ValueError, channel.send_command, "play b a3", [])
# space after command
tc.assertRaises(ValueError, channel.send_command, "play ", ["b", "a3"])
# control character in command
tc.assertRaises(ValueError, channel.send_command, "pla\x01y", ["b", "a3"])
# unicode command
tc.assertRaises(ValueError, channel.send_command, u"protocol_version", [])
# space in argument
tc.assertRaises(ValueError, channel.send_command, "play", ["b a3"])
# unicode argument
tc.assertRaises(ValueError, channel.send_command, "play ", [u"b", "a3"])
# high characters
channel.send_command("pl\xc3\xa1y", ["b", "\xc3\xa13"])
tc.assertEqual(channel.get_command_stream(), "pl\xc3\xa1y b \xc3\xa13\n")
def test_channel_command_validation(tc):
channel = Preprogrammed_gtp_channel("\n\n")
# empty command
tc.assertRaises(ValueError, channel.send_command, "", [])
# space in command
tc.assertRaises(ValueError, channel.send_command, "play b a3", [])
# space after command
tc.assertRaises(ValueError, channel.send_command, "play ", ["b", "a3"])
# control character in command
tc.assertRaises(ValueError, channel.send_command, "pla\x01y", ["b", "a3"])
# unicode command
tc.assertRaises(ValueError, channel.send_command, u"protocol_version", [])
# space in argument
tc.assertRaises(ValueError, channel.send_command, "play", ["b a3"])
# unicode argument
tc.assertRaises(ValueError, channel.send_command, "play ", [u"b", "a3"])
# high characters
channel.send_command("pl\xc3\xa1y", ["b", "\xc3\xa13"])
tc.assertEqual(channel.get_command_stream(), "pl\xc3\xa1y b \xc3\xa13\n")
def test_linebased_channel_without_response(tc):
channel = Preprogrammed_gtp_channel("")
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(GtpChannelClosed,
"^engine has closed the response channel$",
channel.get_response)
channel.close()
def test_linebased_channel_with_gmp_response(tc):
channel = Preprogrammed_gtp_channel("\x01\xa1\xa0\x80",
hangs_before_eof=True)
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(GtpProtocolError, "appears to be speaking GMP",
channel.get_response)
channel.close()
def test_linebased_channel_with_usage_message_response(tc):
channel = Preprogrammed_gtp_channel(
"Usage: randomprogram [options]\n\nOptions:\n"
"--help show this help message and exit\n")
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(GtpProtocolError,
"^engine isn't speaking GTP: first byte is 'U'$",
channel.get_response)
channel.close()
def test_linebased_channel_with_broken_command_pipe(tc):
channel = Preprogrammed_gtp_channel(
"Usage: randomprogram [options]\n\nOptions:\n"
"--help show this help message and exit\n")
channel.break_command_stream()
tc.assertRaisesRegexp(GtpChannelClosed,
"^engine has closed the command channel$",
channel.send_command, "protocol_version", [])
channel.close()
def test_linebased_channel_hang(tc):
# Correct behaviour for a GTP controller here is to wait for a newline.
# (Would be nice to have a timeout.)
# This serves as a check that the hangs_before_eof modelling is working.
channel = Preprogrammed_gtp_channel("=prompt> ", hangs_before_eof=True)
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(SupporterError, "this would hang",
channel.get_response)
channel.close()
def test_linebased_channel_response_cleaning(tc):
channel = Preprogrammed_gtp_channel(
# empty response
"=\n\n"
# whitespace-only response
"= \n\n"
# ignores CRs (GTP spec)
"= 1abc\rde\r\n\r\n"
# ignores extra blank lines (GTP spec)
"= 2abcde\n\n\n\n"
# strips control characters (GTP spec)
"= 3a\x7fbc\x00d\x07e\n\x01\n"
# converts tabs to spaces (GTP spec)
"= 4abc\tde\n\n"
# strips leading whitespace (channel docs)
"= \t 5abcde\n\n"
# strips trailing whitepace (channel docs)
"= 6abcde \t \n\n"
# doesn't strip whitespace in the middle of a multiline response
"= 7aaa \n bbb\tccc\nddd \t \n\n"
# passes high characters through
"= 8ab\xc3\xa7de\n\n"
# all this at once, in a failure response
"? a\raa \r\n b\rbb\tcc\x01c\nddd \t \n\n"
)
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertEqual(channel.get_response(), (False, "1abcde"))
tc.assertEqual(channel.get_response(), (False, "2abcde"))
tc.assertEqual(channel.get_response(), (False, "3abcde"))
tc.assertEqual(channel.get_response(), (False, "4abc de"))
tc.assertEqual(channel.get_response(), (False, "5abcde"))
tc.assertEqual(channel.get_response(), (False, "6abcde"))
tc.assertEqual(channel.get_response(), (False, "7aaa \n bbb ccc\nddd"))
tc.assertEqual(channel.get_response(), (False, "8ab\xc3\xa7de"))
tc.assertEqual(channel.get_response(), (True, "aaa \n bbb ccc\nddd"))
def test_linebased_channel_with_interactive_response(tc):
channel = Preprogrammed_gtp_channel("prompt> \n", hangs_before_eof=True)
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(
GtpProtocolError, "^engine isn't speaking GTP", channel.get_response)
channel.close()
def test_linebased_channel_responses(tc):
channel = Preprogrammed_gtp_channel("= 2\n\n"
# failure response
"? unknown command\n\n"
# final response with no newlines
"= ok")
channel.send_command("protocol_version", [])
tc.assertEqual(channel.get_response(), (False, "2"))
channel.send_command("xyzzy", ["1", "2"])
tc.assertEqual(channel.get_response(), (True, "unknown command"))
channel.send_command("quit", ["1", "2"])
tc.assertEqual(channel.get_response(), (False, "ok"))
def test_linebased_channel(tc):
channel = Preprogrammed_gtp_channel("=\n\n=\n\n")
tc.assertEqual(channel.get_command_stream(), "")
channel.send_command("play", ["b", "a3"])
tc.assertEqual(channel.get_command_stream(), "play b a3\n")
tc.assertEqual(channel.get_response(), (False, ""))
channel.send_command("quit", [])
tc.assertEqual(channel.get_command_stream(), "play b a3\nquit\n")
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertRaisesRegexp(GtpChannelClosed,
"engine has closed the response channel",
channel.get_response)
channel.close()
def test_linebased_channel_with_interactive_response(tc):
channel = Preprogrammed_gtp_channel("prompt> \n", hangs_before_eof=True)
channel.send_command("protocol_version", [])
tc.assertRaisesRegexp(GtpProtocolError, "^engine isn't speaking GTP",
channel.get_response)
channel.close()
def test_linebased_channel_with_broken_response_pipe(tc):
channel = Preprogrammed_gtp_channel("= 2\n\n? unreached\n\n")
channel.send_command("protocol_version", [])
tc.assertEqual(channel.get_response(), (False, "2"))
channel.break_response_stream()
channel.send_command("list_commands", [])
tc.assertRaisesRegexp(GtpChannelClosed,
"^engine has closed the response channel$",
channel.get_response)
channel.close()
def test_linebased_channel(tc):
channel = Preprogrammed_gtp_channel("=\n\n=\n\n")
tc.assertEqual(channel.get_command_stream(), "")
channel.send_command("play", ["b", "a3"])
tc.assertEqual(channel.get_command_stream(), "play b a3\n")
tc.assertEqual(channel.get_response(), (False, ""))
channel.send_command("quit", [])
tc.assertEqual(channel.get_command_stream(), "play b a3\nquit\n")
tc.assertEqual(channel.get_response(), (False, ""))
tc.assertRaisesRegexp(
GtpChannelClosed, "engine has closed the response channel",
channel.get_response)
channel.close()
