QA

Author: veorq

README.md

@@ -2,6 +2,15 @@
 
 mqttinfo is a command-line utility to retrieve information on an MQTT broker.
 
+To get the mqttinfo utility, you may run:
+
+```
+go get -u -v github.com/Teserakt-io/mqttinfo/cmd/mqttinfo
+```
+
+Otherwise, clone this repository and run `./scripts/build.sh` to build
+mqttinfo, then run it from `./bin/mqttinfo`.
+
 Usage:
 
 ```

cmd/mqttinfo/main.go

@@ -55,20 +55,24 @@ func main() {
 	}
 
 	if len(gitTag) == 0 {
-		fmt.Printf("MQTTinfo – version %v-%v\n", buildDate, gitCommit[:4])
+		fmt.Printf("MQTTinfo – version %v-%v\n", buildDate, gitCommit)
 	} else {
-		fmt.Printf("MQTTinfo – version %s (%v-%v)\n", gitTag, buildDate, gitCommit[:4])
+		fmt.Printf("MQTTinfo – version %s (%v-%v)\n", gitTag, buildDate, gitCommit)
 	}
 
 	fmt.Println("Copyright (c) Teserakt AG, 2019")
 
 	// info will hold the results of the analysis
-	b := mqttinfo.NewBrokerInfo(*hostname, *port, *username, *password)
+	b, err := mqttinfo.NewBrokerInfo(*hostname, *port, *username, *password)
+	if err != nil {
+		fmt.Printf("BrokerInfo creation failed: %v\n", err)
+		b.Failed = true
+		b.Error = err.Error()
+		return
+	}
 
 	fmt.Printf("\nTarget: %v:%v\n", b.Host, b.Port)
 
-	var err error
-
 	// v3.1.1 tests
 	fmt.Printf("\nChecking %v broker interface...\n", v4)
 	err = b.CheckConnectionV4()

pkg/mqttinfolib/mqttinfolib.go

@@ -93,7 +93,7 @@ const (
 )
 
 // NewBrokerInfo creates a BrokerInfo with default values
-func NewBrokerInfo(hostname string, port int, username, password string) BrokerInfo {
+func NewBrokerInfo(hostname string, port int, username, password string) (*BrokerInfo, error) {
 	b := BrokerInfo{}
 	b.Host = hostname
 	b.Port = port
@@ -103,32 +103,15 @@ func NewBrokerInfo(hostname string, port int, username, password string) BrokerI
 	b.V4 = false
 	b.V5 = false
 
-	b.V4Anonymous = false
-	b.V4PublishSYS = false
 	b.V4FilterSYS = true
-	b.V4SubscribeAll = false
-	b.V4InvalidTopics = false
-	b.V4InvalidUTF8Topic = false
-	b.V4QoS1 = false
-	b.V4QoS2 = false
-	b.V4QoS3Response = false
-
-	b.V5Anonymous = false
-	b.V5PublishSYS = false
 	b.V5FilterSYS = true
-	b.V5SubscribeAll = false
-	b.V5InvalidTopics = false
-	b.V5InvalidUTF8Topic = false
-	b.V5QoS1 = false
-	b.V5QoS2 = false
-	b.V5QoS3Response = false
-
 	b.TypeGuessed = "unknown"
 
-	b.Failed = false
 	b.Error = ""
 
-	return b
+	// Boolean values default to false
+
+	return &b, nil
 }
 
 // varint encoding, this function copied from https://github.com/eclipse/paho.mqtt.golang
@@ -259,7 +242,10 @@ func (b *BrokerInfo) connectV5() (net.Conn, error) {
 		return nil, err
 	}
 
-	conn.Write(b.getConnectV5())
+	_, err = conn.Write(b.getConnectV5())
+	if err != nil {
+		return nil, fmt.Errorf("CONNACK read failed: %v", err)
+	}
 	connack := make([]byte, 100)
 	_, err = conn.Read(connack)
 	if err != nil {

scripts/build.sh

@@ -7,7 +7,7 @@ echo ""
 
 goimports -w cmd/$PROJECT
 
-GIT_COMMIT=$(git rev-list -1 HEAD)
+GIT_COMMIT=$(git rev-parse --short HEAD)
 GIT_TAG=$(git describe --exact-match HEAD)
 NOW=$(date "+%Y%m%d")