protocol4-make.lua

-- busted -e 'package.path="./?/init.lua;./?.lua;"..package.path' tests/spec/protocol4-make.lua
-- DOC: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html

describe("MQTT v3.1.1 protocol: making packets", function()
	local tools = require("mqtt.tools")
	local extract_hex = tools.extract_hex
	local protocol = require("mqtt.protocol")
	local protocol4 = require("mqtt.protocol4")

	it("CONNECT with minimum params", function()
		assert.are.equal(
			extract_hex[[
				10						-- packet type == 1 (CONNECT), flags == 0
				15						-- length == 0x15 == 21 bytes

											-- next is 21 bytes for variable header and payload:

					0004 4D515454			-- protocol name == "MQTT"
					04						-- protocol level (4 == v3.1.1)
					00						-- connect flags: clean=false, will_flag=false, will_qos=0, will_retain=false, password=false, username=false
					0000					-- keep alive == 0

												-- next is payload:

						0009 636C69656E742D6964	-- client id == "client-id"
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.CONNECT,
				id = "client-id",
			}))
		)
	end)

	it("CONNECT with full params", function()
		assert.are.equal(
			extract_hex[[
				10 						-- packet type == 1 (CONNECT), flags == 0
				48 						-- length == 0x48 == 72 bytes

											-- next is 72 bytes for variable header and payload:

					0004 4D515454 			-- protocol name == "MQTT"
					04 						-- protocol level (4 == v3.1.1)
					EE 						-- connect flags: 0xEE == 1110 1110:
												-- reserved == 0
												-- clean == 1 (true),
												-- will flag == 1
												-- will qos == 01 == 1
												-- will retain == 1 (true)
												-- password flag == 1
												-- username flag == 1
					001E 					-- keep alive == 30

												-- next is payload:

						0009 636C69656E742D6964 	-- client id == "client-id"
						0007 6F66666C696E65 		-- will topic == "offline"
						0014 636C69656E742D6964206973206F66666C696E65 	-- will payload == "client-id is offline"
						0007 54686555736572 		-- username == "TheUser"
						0009 546F70536563726574 	-- password == "TopSecret"
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.CONNECT,
				id = "client-id",
				clean = true,
				will = {
					payload = "client-id is offline",
					topic = "offline",
					qos = 1,
					retain = true,
				},
				username = "TheUser",
				password = "TopSecret",
				keep_alive = 30,
			}))
		)
	end)

	it("CONNACK sp=false, rc=0", function()
		assert.are.equal(
			extract_hex[[
				20 						-- packet type == 2 (CONNACK), flags == 0
				02						-- length == 0x02 == 2 bytes
				0000					-- variable header, session present flag == false, rc == 0
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.CONNACK,
				sp = false, rc = 0,
			}))
		)
	end)

	it("CONNACK sp=true, rc=0", function()
		assert.are.equal(
			extract_hex[[
				20 						-- packet type == 2 (CONNACK), flags == 0
				02						-- length == 0x02 == 2 bytes
				0100					-- variable header, session present flag == true, rc == 0
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.CONNACK,
				sp = true, rc = 0,
			}))
		)
	end)

	it("CONNACK sp=false, rc=2", function()
		assert.are.equal(
			extract_hex[[
				20 						-- packet type == 2 (CONNACK), flags == 0
				02						-- length == 0x02 == 2 bytes
				0002					-- variable header, session present flag == false, rc == 2
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.CONNACK,
				sp = false, rc = 2,
			}))
		)
	end)

	it("CONNACK sp=true, rc=2", function()
		assert.are.equal(
			extract_hex[[
				20 						-- packet type == 2 (CONNACK), flags == 0
				02						-- length == 0x02 == 2 bytes
				0102					-- variable header, session present flag == true, rc == 2
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.CONNACK,
				sp = true, rc = 2,
			}))
		)
	end)

	it("PUBLISH with full params", function()
		assert.are.equal(
			extract_hex[[
				3B 						-- packet type == 3 (PUBLISH), flags == 0xB == 1011 == DUP=1, QoS=1, RETAIN=1
				0F 						-- length == 0x0F == 15 bytes
					0004 736F6D65 			-- variable header: topic string "some"
					0001					-- packet id == 1
					7061796C6F6164			-- payload: "payload"
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBLISH,
				topic = "some",
				payload = "payload",
				qos = 1,
				retain = true,
				dup = true,
				packet_id = 1,
			}))
		)
	end)

	it("PUBLISH without payload", function()
		assert.are.equal(
			extract_hex[[
				3B 						-- packet type == 3 (PUBLISH), flags == 0xB == 1011 == DUP=1, QoS=1, RETAIN=1
				08 						-- length == 0x08 == 8 bytes
					0004 736F6D65 		-- variable header: topic string "some"
					0001				-- packet id == 1
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBLISH,
				topic = "some",
				qos = 1,
				retain = true,
				dup = true,
				packet_id = 1,
			}))
		)
	end)

	it("PUBLISH minimal", function()
		assert.are.equal(
			extract_hex[[
				30 						-- packet type == 3 (PUBLISH), flags == 0x0 == 0000 == DUP=0, QoS=0, RETAIN=0
				06 						-- length == 0x06 == 6 bytes
					0004 736F6D65 		-- variable header: topic string "some"
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBLISH,
				topic = "some",
				qos = 0,
				retain = false,
				dup = false,
			}))
		)
	end)

	it("PUBACK", function()
		assert.are.equal(
			extract_hex[[
				40 						-- packet type == 4 (PUBACK), flags == 0x0
				02 						-- length == 2 bytes
					0001 				-- variable header: Packet Identifier == 1
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBACK,
				packet_id = 1,
			}))
		)
		assert.are.equal(
			"40020002",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBACK,
				packet_id = 2,
			}))
		)
		assert.are.equal(
			"4002FFFF",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBACK,
				packet_id = 0xFFFF,
			}))
		)
		-- invalid Packet Identifier's:
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBACK,
				packet_id = 0,
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBACK,
				packet_id = 0xFFFF + 1,
			}
		end)
	end)

	it("PUBREC", function()
		assert.are.equal(
			extract_hex[[
				50 						-- packet type == 5 (PUBREC), flags == 0x0
				02 						-- length == 2 bytes
					0001 				-- variable header: Packet Identifier == 1
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBREC,
				packet_id = 1,
			}))
		)
		assert.are.equal(
			"50020002",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBREC,
				packet_id = 2,
			}))
		)
		assert.are.equal(
			"5002FFFF",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBREC,
				packet_id = 0xFFFF,
			}))
		)
		-- invalid Packet Identifier's:
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBREC,
				packet_id = 0,
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBREC,
				packet_id = 0xFFFF + 1,
			}
		end)
	end)

	it("PUBREL", function()
		assert.are.equal(
			extract_hex[[
				62 						-- packet type == 6 (PUBREL), flags == 0x2 (fixed value)
				02 						-- length == 2 bytes
					0001 				-- variable header: Packet Identifier == 1
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBREL,
				packet_id = 1,
			}))
		)
		assert.are.equal(
			"62020002",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBREL,
				packet_id = 2,
			}))
		)
		assert.are.equal(
			"6202FFFF",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBREL,
				packet_id = 0xFFFF,
			}))
		)
		-- invalid Packet Identifier's:
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBREL,
				packet_id = 0,
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBREL,
				packet_id = 0xFFFF + 1,
			}
		end)
	end)

	it("PUBCOMP", function()
		assert.are.equal(
			extract_hex[[
				70 						-- packet type == 7 (PUBCOMP), flags == 0x0
				02 						-- length == 2 bytes
					0001 				-- variable header: Packet Identifier == 1
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBCOMP,
				packet_id = 1,
			}))
		)
		assert.are.equal(
			"70020002",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBCOMP,
				packet_id = 2,
			}))
		)
		assert.are.equal(
			"7002FFFF",
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PUBCOMP,
				packet_id = 0xFFFF,
			}))
		)
		-- invalid Packet Identifier's:
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBCOMP,
				packet_id = 0,
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.PUBCOMP,
				packet_id = 0xFFFF + 1,
			}
		end)
	end)

	it("SUBSCRIBE", function()
		assert.are.equal(
			extract_hex[[
				82 						-- packet type == 8 (SUBSCRIBE), flags == 0x2 (fixed value)
				09 						-- length == 9 bytes
					0001 				-- variable header: Packet Identifier == 1
						0004 736F6D65 	-- topic filter #1 == string "some"
						00 				-- QoS #1 == 0
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 1,
				subscriptions = {
					{
						topic = "some",
						qos = 0,
					},
				},
			}))
		)
		assert.are.equal(
			extract_hex[[
				82 						-- packet type == 8 (SUBSCRIBE), flags == 0x2 (fixed value)
				21 						-- length == 0x21 == 33 bytes
					0002 				-- variable header: Packet Identifier == 2
						0006 736F6D652F23 						-- topic filter #1 == string "some/#"
						00 										-- QoS #1
						000F 6F746865722F2B2F746F7069632F23 	-- topic filter #2 == string "other/+/topic/#"
						01 										-- QoS #2
						0001 23 								-- topic filter #3 == string "#"
						02 										-- QoS #3
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 2,
				subscriptions = {
					{
						topic = "some/#",
						qos = 0,
					},
					{
						topic = "other/+/topic/#",
						qos = 1,
					},
					{
						topic = "#",
						qos = 2,
					},
				},
			}))
		)
		-- invalid calls:
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 0,
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 1,
				subscriptions = {},
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 1,
				subscriptions = {
					"invalid"
				},
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 1,
				subscriptions = {
					{}
				},
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 1,
				subscriptions = {
					{
						topic = false,
					}
				},
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 1,
				subscriptions = {
					{
						topic = "asdf",
						qos = 3,
					},
				},
			}
		end)
		assert.has.errors(function()
			protocol4.make_packet{
				type = protocol.packet_type.SUBSCRIBE,
				packet_id = 1,
				subscriptions = {
					{
						topic = "asdf",
						qos = 0,
					},
					{}
				},
			}
		end)
	end)

	it("SUBACK simple", function()
		assert.are.equal(
			extract_hex[[
				90 						-- packet type == 9 (SUBACK), flags == 0x0 (fixed value)
				03						-- length == 3 bytes
					0001				-- variable header: Packet Identifier == 1
						00				-- one SUBACK return code (0x00)
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBACK,
				packet_id = 1,
				rc = { 0 },
			}))
		)
		assert.are.equal(
			extract_hex[[
				90 						-- packet type == 9 (SUBACK), flags == 0x0 (fixed value)
				03						-- length == 3 bytes
					0010				-- variable header: Packet Identifier == 0x10 == 16
						00				-- one SUBACK return code (0x00)
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBACK,
				packet_id = 16,
				rc = { 0 },
			}))
		)
		assert.are.equal(
			extract_hex[[
				90 						-- packet type == 9 (SUBACK), flags == 0x0 (fixed value)
				03						-- length == 3 bytes
					0010				-- variable header: Packet Identifier == 0x10 == 16
						01				-- one SUBACK return code (0x01)
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBACK,
				packet_id = 16,
				rc = { 1 },
			}))
		)
		assert.are.equal(
			extract_hex[[
				90 						-- packet type == 9 (SUBACK), flags == 0x0 (fixed value)
				03						-- length == 3 bytes
					0010				-- variable header: Packet Identifier == 0x10 == 16
						02				-- one SUBACK return code (0x02)
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBACK,
				packet_id = 16,
				rc = { 2 },
			}))
		)
		assert.are.equal(
			extract_hex[[
				90 						-- packet type == 9 (SUBACK), flags == 0x0 (fixed value)
				03						-- length == 3 bytes
					0010				-- variable header: Packet Identifier == 0x10 == 16
						80				-- one SUBACK return code (0x80)
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBACK,
				packet_id = 16,
				rc = { 0x80 },
			}))
		)
	end)

	it("SUBACK several return codes", function()
		assert.are.equal(
			extract_hex[[
				90 						-- packet type == 9 (SUBACK), flags == 0x0 (fixed value)
				07						-- length == 7 bytes
					0001				-- variable header: Packet Identifier == 1
						00 01 02 03 80	-- several SUBACK return codes
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.SUBACK,
				packet_id = 1,
				rc = { 0, 1, 2, 3, 0x80 },
			}))
		)
	end)

	it("UNSUBSCRIBE", function()
		assert.are.equal(
			extract_hex[[
				A2 						-- packet type == 0xA == 10 (UNSUBSCRIBE), flags == 0x2 (fixed value)
				08 						-- length == 8 bytes
					0001 				-- variable header: Packet Identifier == 1
						0004 736F6D65 	-- topic filter #1 == string "some"
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.UNSUBSCRIBE,
				packet_id = 1,
				subscriptions = {
					"some"
				},
			}))
		)
		assert.are.equal(
			extract_hex[[
				A2 						-- packet type == 0xA == 10 (UNSUBSCRIBE), flags == 0x2 (fixed value)
				1E 						-- length == 0x1E == 30 bytes
					1234 				-- variable header: Packet Identifier == 0x1234
						0006 736F6D652F23 						-- topic filter #1 == string "some/#"
						000F 6F746865722F2B2F746F7069632F23 	-- topic filter #1 == string "other/+/topic/#"
						0001 23 								-- topic filter #1 == string "#"
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.UNSUBSCRIBE,
				packet_id = 0x1234,
				subscriptions = {
					"some/#",
					"other/+/topic/#",
					"#",
				},
			}))
		)
	end)

	it("UNSUBACK", function()
		assert.are.equal(
			extract_hex[[
				B0 						-- packet type == 0xB == 11 (UNSUBACK), flags == 0x0 (fixed value)
				02 						-- length == 2 bytes
					0001 				-- variable header: Packet Identifier == 1
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.UNSUBACK,
				packet_id = 1,
			}))
		)
		assert.are.equal(
			extract_hex[[
				B0 						-- packet type == 0xB == 11 (UNSUBACK), flags == 0x0 (fixed value)
				02 						-- length == 2 bytes
					00FF 				-- variable header: Packet Identifier == 255
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.UNSUBACK,
				packet_id = 255,
			}))
		)
	end)

	it("PINGREQ", function()
		assert.are.equal(
			extract_hex[[
				C0 						-- packet type == 12 (PINGREQ), flags == 0
				00 						-- length == 0
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PINGREQ
			}))
		)
	end)

	it("PINGRESP", function()
		assert.are.equal(
			extract_hex[[
				D0 						-- packet type == 13 (PINGRESP), flags == 0
				00 						-- length == 0
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.PINGRESP
			}))
		)
	end)

	it("DISCONNECT", function()
		assert.are.equal(
			extract_hex[[
				E0 						-- packet type == 14 (DISCONNECT), flags == 0
				00 						-- length == 0
			]],
			tools.hex(tostring(protocol4.make_packet{
				type = protocol.packet_type.DISCONNECT
			}))
		)
	end)
end)

-- vim: ts=4 sts=4 sw=4 noet ft=lua