Introduce a Message type (#506)

test/MessageTest.cpp

@@ -0,0 +1,139 @@
+/*
+ * Copyright (C) 2004-2015 ZNC, see the NOTICE file for details.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <gtest/gtest.h>
+#include <znc/ZNCString.h>
+#include <znc/Message.h>
+
+TEST(MessageTest, SetParam) {
+	CMessage msg;
+
+	msg.SetParam(1, "bar");
+	msg.SetParam(0, "foo");
+
+	VCString params = {"foo", "bar"};
+	EXPECT_EQ(params, msg.GetParams());
+
+	msg.SetParam(3, "baz");
+
+	params = {"foo", "bar", "", "baz"};
+	EXPECT_EQ(params, msg.GetParams());
+}
+
+TEST(MessageTest, ToString) {
+	EXPECT_EQ("CMD", CMessage("CMD").ToString());
+	EXPECT_EQ("CMD p1", CMessage("CMD p1").ToString());
+	EXPECT_EQ("CMD p1 p2", CMessage("CMD p1 p2").ToString());
+	EXPECT_EQ("CMD :p p p", CMessage("CMD :p p p").ToString());
+	EXPECT_EQ(":irc.znc.in", CMessage(":irc.znc.in").ToString());
+	EXPECT_EQ(":irc.znc.in CMD", CMessage(":irc.znc.in CMD").ToString());
+	EXPECT_EQ(":irc.znc.in CMD p1", CMessage(":irc.znc.in CMD p1").ToString());
+	EXPECT_EQ(":irc.znc.in CMD p1 p2", CMessage(":irc.znc.in CMD p1 p2").ToString());
+	EXPECT_EQ(":irc.znc.in CMD :p p p", CMessage(":irc.znc.in CMD :p p p").ToString());
+}
+
+TEST(MessageTest, FormatFlags) {
+	const CString line = "@foo=bar :irc.example.com COMMAND param";
+
+	CMessage msg(line);
+	EXPECT_EQ(line, msg.ToString());
+	EXPECT_EQ(":irc.example.com COMMAND param", msg.ToString(CMessage::ExcludeTags));
+	EXPECT_EQ("@foo=bar COMMAND param", msg.ToString(CMessage::ExcludePrefix));
+	EXPECT_EQ("COMMAND param", msg.ToString(CMessage::ExcludePrefix|CMessage::ExcludeTags));
+}
+
+// The test data for MessageTest.Parse originates from https://github.com/SaberUK/ircparser
+//
+// IRCParser - Internet Relay Chat Message Parser
+//
+//   Copyright (C) 2015 Peter "SaberUK" Powell <petpow@saberuk.com>
+//
+// Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+// fee is hereby granted, provided that the above copyright notice and this permission notice appear
+// in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+// SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+// AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+// NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+// OF THIS SOFTWARE.
+
+// when checking a valid message with tags and a source
+TEST(MessageTest, ParseWithTags) {
+	const CString line = "@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 :irc.example.com COMMAND param1 param2 :param3 param3";
+
+	MCString tags;
+	tags["tag1"] = "value1";
+	tags["tag2"] = "";
+	tags["vendor1/tag3"] = "value2";
+	tags["vendor2/tag4"] = "";
+
+	VCString params = {"param1", "param2", "param3 param3"};
+
+	CMessage msg(line);
+	EXPECT_EQ(line, msg.ToString());
+	EXPECT_EQ(tags, msg.GetTags());
+	EXPECT_EQ("irc.example.com", msg.GetNick().GetNick());
+	EXPECT_EQ("COMMAND", msg.GetCommand());
+	EXPECT_EQ(params, msg.GetParams());
+}
+
+// when checking a valid message with a source but no tags
+TEST(MessageTest, ParseWithoutTags) {
+	const CString line = ":irc.example.com COMMAND param1 param2 :param3 param3";
+
+	VCString params = {"param1", "param2", "param3 param3"};
+
+	CMessage msg(line);
+	EXPECT_EQ(line, msg.ToString());
+	EXPECT_EQ(MCString(), msg.GetTags());
+	EXPECT_EQ("irc.example.com", msg.GetNick().GetNick());
+	EXPECT_EQ("COMMAND", msg.GetCommand());
+	EXPECT_EQ(params, msg.GetParams());
+}
+
+// when checking a valid message with tags but no source
+TEST(MessageTest, ParseWithoutSource) {
+	const CString line = "@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 COMMAND param1 param2 :param3 param3";
+
+	MCString tags;
+	tags["tag1"] = "value1";
+	tags["tag2"] = "";
+	tags["vendor1/tag3"] = "value2";
+	tags["vendor2/tag4"] = "";
+
+	VCString params = {"param1", "param2", "param3 param3"};
+
+	CMessage msg(line);
+	EXPECT_EQ(line, msg.ToString());
+	EXPECT_EQ(tags, msg.GetTags());
+	EXPECT_EQ("", msg.GetNick().GetNick());
+	EXPECT_EQ("COMMAND", msg.GetCommand());
+	EXPECT_EQ(params, msg.GetParams());
+}
+
+// when checking a valid message with no tags, source or parameters
+TEST(MessageTest, ParseWithoutSourceAndTags) {
+	const CString line = "COMMAND";
+
+	CMessage msg(line);
+	EXPECT_EQ(line, msg.ToString());
+	EXPECT_EQ(MCString(), msg.GetTags());
+	EXPECT_EQ("", msg.GetNick().GetNick());
+	EXPECT_EQ("COMMAND", msg.GetCommand());
+	EXPECT_EQ(VCString(), msg.GetParams());
+}