From ab67dbcacddde4508de9cc8bcb32818f3f09fead Mon Sep 17 00:00:00 2001 From: "Roger A. Light" Date: Sat, 15 Jan 2022 23:41:12 +0000 Subject: [PATCH] More client tests, and an output format fix. --- ChangeLog.txt | 2 + client/sub_client_output.c | 1 - man/mosquitto_sub.1.xml | 1 + test/client/02-subscribe-argv-errors.py | 1 + test/client/02-subscribe-format.py | 123 ++++++++++++++++++++++++ test/client/02-subscribe-null.py | 73 ++++++++++++++ test/client/02-subscribe-qos1.py | 41 +++----- test/client/02-subscribe-verbose.py | 73 ++++++++++++++ test/client/03-publish-argv-errors.py | 2 + test/client/Makefile | 9 +- test/client/test.py | 20 ++++ 11 files changed, 316 insertions(+), 30 deletions(-) create mode 100755 test/client/02-subscribe-format.py create mode 100755 test/client/02-subscribe-null.py create mode 100755 test/client/02-subscribe-verbose.py create mode 100755 test/client/test.py diff --git a/ChangeLog.txt b/ChangeLog.txt index b85cfcd6..fb572ede 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -112,6 +112,8 @@ Client library: Clients: - Add `-W` timeout support to Windows. - The `--insecure` option now disables all server certificate verification. +- Fix incorrect output formatting in mosquitto_sub when using field widths + with `%x` and `%X` for printing the payload in hex. 2.0.14 - 2021-11-17 diff --git a/client/sub_client_output.c b/client/sub_client_output.c index 07530cba..d0c3ec0e 100644 --- a/client/sub_client_output.c +++ b/client/sub_client_output.c @@ -117,7 +117,6 @@ static void write_payload(const unsigned char *payload, int payloadlen, int hex, payloadlen = field_width; } if(hex > 0){ - payloadlen /= 2; padlen = field_width - payloadlen*2; }else{ padlen = field_width - payloadlen; diff --git a/man/mosquitto_sub.1.xml b/man/mosquitto_sub.1.xml index 2fa265e3..b4fd2260 100644 --- a/man/mosquitto_sub.1.xml +++ b/man/mosquitto_sub.1.xml @@ -1098,6 +1098,7 @@ mosquitto_sub -t 'bbc/#' -T bbc/bbc1 --remove-retained Subscribe + (Variable byte integer) (UTF-8 string pair) diff --git a/test/client/02-subscribe-argv-errors.py b/test/client/02-subscribe-argv-errors.py index d660d2f1..63a70e09 100755 --- a/test/client/02-subscribe-argv-errors.py +++ b/test/client/02-subscribe-argv-errors.py @@ -106,6 +106,7 @@ if __name__ == '__main__': do_test(['-V', '5', '-D', 'connect', 'session-expiry-interval', '4294967296'], "Error: Property value (4294967296) out of range for property session-expiry-interval.\n\n" + helps, 1) do_test(['-V', '5', '-D', 'subscribe', 'subscription-identifier', '-1'], "Error: Property value (-1) out of range for property subscription-identifier.\n\n" + helps, 1) do_test(['-V', '5', '-D', 'subscribe', 'subscription-identifier', '4294967296'], "Error: Property value (4294967296) out of range for property subscription-identifier.\n\n" + helps, 1) + do_test(['-V', '5', '-D', 'subscribe', 'topic-alias', '1'], "Error: topic-alias property not allowed for subscribe in --property argument.\n\n" + helps, 1) do_test(['-T', '++'], "Error: Invalid filter topic '++', are all '+' and '#' wildcards correct?\n" + helps, 1) do_test(['-U', '++'], "Error: Invalid unsubscribe topic '++', are all '+' and '#' wildcards correct?\n" + helps, 1) do_test(['-V', '0'], "Error: Invalid protocol version argument given.\n\n" + helps, 1) diff --git a/test/client/02-subscribe-format.py b/test/client/02-subscribe-format.py new file mode 100755 index 00000000..4856111f --- /dev/null +++ b/test/client/02-subscribe-format.py @@ -0,0 +1,123 @@ +#!/usr/bin/env python3 + +# + +from mosq_test_helper import * + +def do_test(format_str, expected_output, proto_ver=4): + rc = 1 + + port = mosq_test.get_port() + + if proto_ver == 5: + V = 'mqttv5' + elif proto_ver == 4: + V = 'mqttv311' + else: + V = 'mqttv31' + + env = { + 'LD_LIBRARY_PATH':'../../lib', + 'XDG_CONFIG_HOME':'/tmp/missing' + } + cmd = ['../../client/mosquitto_sub', + '-p', str(port), + '-q', '1', + '-t', '02/sub/format/test', + '-C', '1', + '-V', V, + '-F', format_str + ] + + if proto_ver == 5: + cmd += ['-D', 'subscribe', 'subscription-identifier', '56'] + + payload = "message" + props = mqtt5_props.gen_byte_prop(mqtt5_props.PROP_PAYLOAD_FORMAT_INDICATOR, 1) + props += mqtt5_props.gen_uint32_prop(mqtt5_props.PROP_MESSAGE_EXPIRY_INTERVAL, 3600) + props += mqtt5_props.gen_string_prop(mqtt5_props.PROP_CONTENT_TYPE, "plain/text") + props += mqtt5_props.gen_string_prop(mqtt5_props.PROP_RESPONSE_TOPIC, "/dev/null") + #props += mqtt5_props.gen_string_prop(mqtt5_props.PROP_CORRELATION_DATA, "2357289375902345") + props += mqtt5_props.gen_string_pair_prop(mqtt5_props.PROP_USER_PROPERTY, "name1", "value1") + props += mqtt5_props.gen_string_pair_prop(mqtt5_props.PROP_USER_PROPERTY, "name2", "value2") + props += mqtt5_props.gen_string_pair_prop(mqtt5_props.PROP_USER_PROPERTY, "name3", "value3") + props += mqtt5_props.gen_string_pair_prop(mqtt5_props.PROP_USER_PROPERTY, "name4", "value4") + if proto_ver == 5: + publish_packet = mosq_test.gen_publish("02/sub/format/test", qos=0, payload=payload, properties=props, proto_ver=proto_ver) + else: + publish_packet = mosq_test.gen_publish("02/sub/format/test", qos=0, payload=payload, proto_ver=proto_ver) + + broker = mosq_test.start_broker(filename=os.path.basename(__file__), port=port) + + try: + sock = mosq_test.pub_helper(port=port, proto_ver=proto_ver) + + sub = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env) + time.sleep(0.1) + sock.send(publish_packet) + sub.wait() + (stdo, stde) = sub.communicate() + if stdo.decode('utf-8') == expected_output: + rc = 0 + else: + print("expected: (%d) %s" % (len(expected_output), expected_output)) + print("actual: (%d) %s" % (len(stdo.decode('utf-8')), stdo.decode('utf-8'))) + sock.close() + except mosq_test.TestError: + pass + except Exception as e: + print(e) + finally: + broker.terminate() + broker.wait() + (stdo, stde) = broker.communicate() + if rc: + print(stde.decode('utf-8')) + exit(rc) + + +do_test('%%', '%\n') +do_test('%A', '\n') # missing +do_test('%C', '\n') # missing +do_test('%2C', ' \n') # missing +do_test('%C', 'plain/text\n', proto_ver=5) +do_test('%D', '\n') # missing +do_test('%E', '\n') # missing +do_test('%E', '3600\n', proto_ver=5) +do_test('%F', '\n') # missing +do_test('%F', '1\n', proto_ver=5) +do_test('%l', '7\n') # strlen("message") +do_test('%02l', '07\n') # strlen("message") +do_test('%2l', ' 7\n') # strlen("message") +do_test('%-2l', '7 \n') # strlen("message") +do_test('%m', '0\n') +do_test('%P', '\n') # missing +do_test('%P', 'name1:value1 name2:value2 name3:value3 name4:value4\n', proto_ver=5) +do_test('%p', 'message\n') +do_test('%-12p', 'message \n') +do_test('%q', '0\n') +do_test('%R', '\n') # missing +do_test('%r', '0\n') +do_test('%S', '\n') # missing +do_test('%S', '56\n', proto_ver=5) +do_test('%t', '02/sub/format/test\n') +do_test('%.20t', '02/sub/format/test\n') +do_test('%-.20t', '02/sub/format/test\n') +do_test('%20t', ' 02/sub/format/test\n') +do_test('%-20t', '02/sub/format/test \n') +do_test('%10.10t', '02/sub/for\n') +do_test('%20.10t', ' 02/sub/for\n') +do_test('%-20.10t', '02/sub/for \n') +do_test('%x', '6d657373616765\n') +do_test('%18x', ' 6d657373616765\n') +do_test('%-18x', '6d657373616765 \n') +do_test('%X', '6D657373616765\n') +do_test('\\\\', '\\\n') +do_test('\\a', '\a\n') +#do_test('\\e', '\e\n') +do_test('\\n', '\n\n') +do_test('\\r', '\r\n') +do_test('\\t', '\t\n') +do_test('\\v', '\v\n') +do_test('@@', '@\n') +do_test('text', 'text\n') diff --git a/test/client/02-subscribe-null.py b/test/client/02-subscribe-null.py new file mode 100755 index 00000000..63aba98d --- /dev/null +++ b/test/client/02-subscribe-null.py @@ -0,0 +1,73 @@ +#!/usr/bin/env python3 + +# + +from mosq_test_helper import * + +def do_test(proto_ver): + rc = 1 + + port = mosq_test.get_port() + + if proto_ver == 5: + V = 'mqttv5' + elif proto_ver == 4: + V = 'mqttv311' + else: + V = 'mqttv31' + + env = { + 'LD_LIBRARY_PATH':'../../lib', + 'XDG_CONFIG_HOME':'/tmp/missing' + } + cmd = ['../../client/mosquitto_sub', + '-p', str(port), + '-q', '1', + '-t', '02/sub/null/test', + '-V', V, + '-C', '1', + '-v' + ] + + topic = "02/sub/null/test" + payload = "" + publish_packet_s = mosq_test.gen_publish(topic, qos=1, mid=1, payload=payload, proto_ver=proto_ver) + publish_packet_r = mosq_test.gen_publish(topic, qos=1, mid=2, payload=payload, proto_ver=proto_ver) + puback_packet_s = mosq_test.gen_puback(1, proto_ver=proto_ver) + puback_packet_r = mosq_test.gen_puback(2, proto_ver=proto_ver) + + broker = mosq_test.start_broker(filename=os.path.basename(__file__), port=port) + + try: + sock = mosq_test.pub_helper(port=port, proto_ver=proto_ver) + + sub = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env) + time.sleep(0.1) + sock.send(publish_packet_s) + mosq_test.expect_packet(sock, "puback", puback_packet_s) + sub.wait() + (stdo, stde) = sub.communicate() + expected_output = topic + ' (null)\n' + if stdo.decode('utf-8') == expected_output: + rc = 0 + else: + print("expected: %s" % expected_output) + print("actual: %s" % stdo.decode('utf-8')) + sock.close() + except mosq_test.TestError: + pass + except Exception as e: + print(e) + finally: + broker.terminate() + broker.wait() + (stdo, stde) = broker.communicate() + if rc: + print(stde.decode('utf-8')) + print("proto_ver=%d" % (proto_ver)) + exit(rc) + + +do_test(proto_ver=3) +do_test(proto_ver=4) +do_test(proto_ver=5) diff --git a/test/client/02-subscribe-qos1.py b/test/client/02-subscribe-qos1.py index 0c47efb4..73d81c93 100755 --- a/test/client/02-subscribe-qos1.py +++ b/test/client/02-subscribe-qos1.py @@ -4,7 +4,7 @@ from mosq_test_helper import * -def do_test(start_broker, proto_ver): +def do_test(proto_ver): rc = 1 port = mosq_test.get_port() @@ -34,14 +34,13 @@ def do_test(start_broker, proto_ver): puback_packet_s = mosq_test.gen_puback(1, proto_ver=proto_ver) puback_packet_r = mosq_test.gen_puback(2, proto_ver=proto_ver) - if start_broker: - broker = mosq_test.start_broker(filename=os.path.basename(__file__), port=port) + broker = mosq_test.start_broker(filename=os.path.basename(__file__), port=port) try: sock = mosq_test.pub_helper(port=port, proto_ver=proto_ver) sub = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env) - time.sleep(0.5) + time.sleep(0.1) sock.send(publish_packet_s) mosq_test.expect_packet(sock, "puback", puback_packet_s) sub.wait() @@ -54,29 +53,15 @@ def do_test(start_broker, proto_ver): except Exception as e: print(e) finally: - if start_broker: - broker.terminate() - broker.wait() - (stdo, stde) = broker.communicate() - if rc: - print(stde.decode('utf-8')) - print("proto_ver=%d" % (proto_ver)) - exit(rc) - else: - return rc + broker.terminate() + broker.wait() + (stdo, stde) = broker.communicate() + if rc: + print(stde.decode('utf-8')) + print("proto_ver=%d" % (proto_ver)) + exit(rc) -def all_tests(start_broker=False): - rc = do_test(start_broker, proto_ver=3) - if rc: - return rc; - rc = do_test(start_broker, proto_ver=4) - if rc: - return rc; - rc = do_test(start_broker, proto_ver=5) - if rc: - return rc; - return 0 - -if __name__ == '__main__': - all_tests(True) +do_test(proto_ver=3) +do_test(proto_ver=4) +do_test(proto_ver=5) diff --git a/test/client/02-subscribe-verbose.py b/test/client/02-subscribe-verbose.py new file mode 100755 index 00000000..4b7aeeae --- /dev/null +++ b/test/client/02-subscribe-verbose.py @@ -0,0 +1,73 @@ +#!/usr/bin/env python3 + +# + +from mosq_test_helper import * + +def do_test(proto_ver): + rc = 1 + + port = mosq_test.get_port() + + if proto_ver == 5: + V = 'mqttv5' + elif proto_ver == 4: + V = 'mqttv311' + else: + V = 'mqttv31' + + env = { + 'LD_LIBRARY_PATH':'../../lib', + 'XDG_CONFIG_HOME':'/tmp/missing' + } + cmd = ['../../client/mosquitto_sub', + '-p', str(port), + '-q', '1', + '-t', '02/sub/verbose/test', + '-V', V, + '-C', '1', + '-v' + ] + + topic = "02/sub/verbose/test" + payload = "message" + publish_packet_s = mosq_test.gen_publish(topic, qos=1, mid=1, payload=payload, proto_ver=proto_ver) + publish_packet_r = mosq_test.gen_publish(topic, qos=1, mid=2, payload=payload, proto_ver=proto_ver) + puback_packet_s = mosq_test.gen_puback(1, proto_ver=proto_ver) + puback_packet_r = mosq_test.gen_puback(2, proto_ver=proto_ver) + + broker = mosq_test.start_broker(filename=os.path.basename(__file__), port=port) + + try: + sock = mosq_test.pub_helper(port=port, proto_ver=proto_ver) + + sub = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env) + time.sleep(0.1) + sock.send(publish_packet_s) + mosq_test.expect_packet(sock, "puback", puback_packet_s) + sub.wait() + (stdo, stde) = sub.communicate() + expected_output = topic + ' ' + payload + '\n' + if stdo.decode('utf-8') == expected_output: + rc = 0 + else: + print("expected: %s" % expected_output) + print("actual: %s" % stdo.decode('utf-8')) + sock.close() + except mosq_test.TestError: + pass + except Exception as e: + print(e) + finally: + broker.terminate() + broker.wait() + (stdo, stde) = broker.communicate() + if rc: + print(stde.decode('utf-8')) + print("proto_ver=%d" % (proto_ver)) + exit(rc) + + +do_test(proto_ver=3) +do_test(proto_ver=4) +do_test(proto_ver=5) diff --git a/test/client/03-publish-argv-errors.py b/test/client/03-publish-argv-errors.py index 8ed4e13e..2a31d1f4 100755 --- a/test/client/03-publish-argv-errors.py +++ b/test/client/03-publish-argv-errors.py @@ -100,6 +100,7 @@ if __name__ == '__main__': do_test(['-l', '-s'], "Error: Only one type of message can be sent at once.\n\n" + helps, 1) # Invalid values + do_test(['-t', 'topic', '-f', 'missing'], "Error: Unable to open file \"missing\".\nError loading input file \"missing\".\n", 1) do_test(['-k', '-1'], "Error: Invalid keepalive given, it must be between 5 and 65535 inclusive.\n\n" + helps, 1) do_test(['-k', '65536'], "Error: Invalid keepalive given, it must be between 5 and 65535 inclusive.\n\n" + helps, 1) do_test(['-M', '0'], "Error: Maximum inflight messages must be greater than 0.\n\n" + helps, 1) @@ -115,6 +116,7 @@ if __name__ == '__main__': do_test(['-V', '5', '-D', 'connect', 'receive-maximum', '65536'], "Error: Property value (65536) out of range for property receive-maximum.\n\n" + helps, 1) do_test(['-V', '5', '-D', 'connect', 'session-expiry-interval', '-1'], "Error: Property value (-1) out of range for property session-expiry-interval.\n\n" + helps, 1) do_test(['-V', '5', '-D', 'connect', 'session-expiry-interval', '4294967296'], "Error: Property value (4294967296) out of range for property session-expiry-interval.\n\n" + helps, 1) + do_test(['-V', '5', '-D', 'publish', 'subscription-identifier', '1'], "Error: subscription-identifier property not supported for publish in --property argument.\n\n" + helps, 1) # Unknown options do_test(['--unknown'], "Error: Unknown option '--unknown'.\n" + helps, 1) diff --git a/test/client/Makefile b/test/client/Makefile index 2cb1f376..1f51a879 100644 --- a/test/client/Makefile +++ b/test/client/Makefile @@ -3,7 +3,6 @@ all : check : test -ptest : test test : 02 03 ./test.sh #./test-ws.sh @@ -11,6 +10,9 @@ test : 02 03 02 : ./02-subscribe-argv-errors.py ./02-subscribe-qos1.py + ./02-subscribe-format.py + ./02-subscribe-null.py + ./02-subscribe-verbose.py 03 : ./03-publish-argv-errors.py @@ -18,4 +20,9 @@ test : 02 03 ./03-publish-qos1-properties.py ./03-publish-qos1.py +ptest : + ./test.sh + #./test-ws.sh + ./test.py + clean: diff --git a/test/client/test.py b/test/client/test.py new file mode 100755 index 00000000..6fdb419f --- /dev/null +++ b/test/client/test.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python3 + +import mosq_test_helper +import ptest + +tests = [ + #(ports required, 'path'), + (1, './02-subscribe-argv-errors.py'), + (1, './02-subscribe-format.py'), + (1, './02-subscribe-null.py'), + (1, './02-subscribe-qos1.py'), + (1, './02-subscribe-verbose.py'), + + (1, './03-publish-argv-errors.py'), + (1, './03-publish-qos0-empty.py'), + (1, './03-publish-qos1-properties.py'), + (1, './03-publish-qos1.py'), + ] + +ptest.run_tests(tests)