Add support to qualified command like /pass@lelerax_bot (#11)

* Add support to qualified command like /pass@lelerax_bot

I finally registered the bot commands via API, so we have autocomplete
on Telegram by using the bot. In groups using /pass or /kills would be
translated to /pass@lelerax_bot and /kills@lelerax_bot, but in v0.7.0
troll-shield version this is not supported.

This PR takes care to support this properly, giving attention to edge
cases like using /pass@anotherBotName (this will not work). /pass
/kill simplified syntax will always works, but can trigger multiple
bots if they implements the same command.

CHANGELOG:
- Add checkCommand which checks properly if is a valid command
- Add commandEvent which can be use to filter commands (performance)
- Add unit tests for both functions
- Rename /lelerax to /ping, which makes more sense.
- Add renan_r as admin.

* Remove funlen linter, too much annoying

Author: ryukinix

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Run linters
       run: |
         export PATH=$PATH:$(go env GOPATH)/bin
-        golangci-lint -E bodyclose,misspell,gocyclo,dupl,gofmt,golint,unconvert,goimports,depguard,gocritic,funlen,interfacer run
+        golangci-lint -E bodyclose,misspell,gocyclo,dupl,gofmt,golint,unconvert,goimports,depguard,gocritic,interfacer run
   test:
     strategy:
       matrix:

main.go

@@ -12,32 +12,35 @@ import (
 func main() {
 	setupLogging()
 	bot, botHidden, err := setupBots()
+	botUser := bot.Self.UserName
 	if err != nil {
 		log.Fatal(err.Error())
 	}
 	kills := loadKills(killsFile)
 	log.Printf("Currently kill state: %v", kills)
-
 	for update := range getUpdates(bot) {
 		if messageEvent(&update) {
-			if update.Message.Text == "/lelerax" {
+			// Exit automatically from group after the bot receive a message from it
+			for _, trollGroup := range trollGroups {
+				if fromChatEvent(&update, strings.TrimLeft(trollGroup, "@")) {
+					leaveChat(bot, &update, trollGroup)
+				}
+			}
+		}
+
+		if commandEvent(&update) {
+			msg := update.Message.Text
+			if checkCommand(botUser, msg, "/ping") {
 				reply(bot, &update, "Estou vivo.")
 			}
 
-			if update.Message.Text == "/kills" {
+			if checkCommand(botUser, msg, "/kills") {
 				reportKills(bot, &update, kills)
 			}
 
-			if strings.HasPrefix(update.Message.Text, "/pass ") && fromAdminEvent(&update) {
+			if checkCommand(botUser, msg, "/pass") && fromAdminEvent(&update) {
 				addPassList(bot, &update)
 			}
-
-			// Exit automatically from group after the bot receive a message from it
-			for _, trollGroup := range trollGroups {
-				if fromChatEvent(&update, strings.TrimLeft(trollGroup, "@")) {
-					leaveChat(bot, &update, trollGroup)
-				}
-			}
 		}
 
 		if newChatMemberEvent(&update) {

troll_shield.go

@@ -46,6 +46,7 @@ var admins = []string{
 	"lerax",
 	"luksamuk",
 	"perkunos",
+	"renan_r",
 }
 
 const logfile = "troll-shield.log"
@@ -334,6 +335,22 @@ func fromAdminEvent(update *telegram.Update) bool {
 // addPass to passList and send a message
 func addPassList(bot TrollShieldBot, update *telegram.Update) {
 	userName := extractPassUserName(update.Message.Text)
-	passList = append(passList, userName)
-	reply(bot, update, fmt.Sprintf("O passe para %q foi adicionado.", userName))
+	if len(userName) > 0 {
+		passList = append(passList, userName)
+		reply(bot, update, fmt.Sprintf("O passe para %q foi adicionado.", userName))
+	}
+}
+
+func commandEvent(update *telegram.Update) bool {
+	return messageEvent(update) && strings.HasPrefix(update.Message.Text, "/")
+}
+
+// check if a /command is valid
+func checkCommand(botUserName string, msg string, command string) bool {
+	isQualified := strings.Contains(msg, command+"@")
+	if isQualified {
+		qualifiedCommand := fmt.Sprintf("%v@%v", command, botUserName)
+		return strings.HasPrefix(msg, qualifiedCommand)
+	}
+	return strings.HasPrefix(msg, command)
 }

troll_shield_test.go

@@ -111,6 +111,7 @@ func TestEvents(t *testing.T) {
 		t.Errorf("newChatMemberEvent should return true when there is new members, got: %v", got)
 	}
 
+	// fromChatEvent
 	if got := fromChatEvent(&update, "commonlispbr"); got != false {
 		t.Errorf("fromChatEvent should return false when there is no new members, got: %v", got)
 	}
@@ -123,6 +124,16 @@ func TestEvents(t *testing.T) {
 		t.Errorf("fromChatEvent should return true when there is new members, got: %v", got)
 	}
 
+	// commandEvent
+	update.Message.Text = "pancadaria tiro e bomba"
+	if got := commandEvent(&update); got != false {
+		t.Errorf("commandEvent should return false when there is no prefix / on Message.Text, got: %v", got)
+	}
+	update.Message.Text = "/command"
+	if got := commandEvent(&update); got != true {
+		t.Errorf("commandEvent should return true when receives /command like message, got: %v", got)
+	}
+
 }
 
 func TestFindTrollHouses(t *testing.T) {
@@ -276,13 +287,20 @@ func TestExtractPassUserName(t *testing.T) {
 			"/pass First Name",
 			"First Name",
 		},
+		{
+			"/pass@lelerax_bot @tretanews_bot",
+			"@tretanews_bot",
+		},
+		{
+			"/pass",
+			"",
+		},
 	}
 
 	for _, test := range tableTest {
 		if got := extractPassUserName(test.input); got != test.expected {
 			t.Errorf("Expected %q, got %q", test.expected, got)
 		}
-
 	}
 }
 
@@ -327,3 +345,44 @@ func TestFromAdminEvent(t *testing.T) {
 		t.Errorf("delduca should not even being a member, neither admin.")
 	}
 }
+
+func TestCheckCommand(t *testing.T) {
+	tableTest := []struct {
+		botUserName string
+		msg         string
+		command     string
+		expected    bool
+	}{
+		{
+			"lelerax_bot",
+			"/kills@lelerax_bot",
+			"/kills",
+			true,
+		},
+		{
+			"botnilson",
+			"/pass @infeliz",
+			"/pass",
+			true,
+		},
+		{
+			"botsvaldo",
+			"/pass@lelerax_bot @username",
+			"/pass",
+			false,
+		},
+		{
+			"botsvaldo",
+			"/pass@botsvaldo @username",
+			"/pass",
+			true,
+		},
+	}
+
+	for i, test := range tableTest {
+		if got := checkCommand(test.botUserName, test.msg, test.command); got != test.expected {
+			t.Errorf("%d. Expected %v, got %v for %+v.", i+1, test.expected, got, test)
+		}
+	}
+
+}