quick comments and small fixes

RicYaben · RicYaben · commit b05ac66622b6 · 2022-06-20T10:26:41.000+02:00
diff --git a/internal/greeting/greeting.go b/internal/greeting/greeting.go
@@ -9,6 +9,8 @@ import (
 	"github.com/riotpot/internal/cli"
 )
 
+// TODO: Walktrhough is no longer something needed. The greeting should be something small and fast.
+
 type Greet struct {
 	// Indicates if this is the first time riotpot has been launched
 	Tutorial bool
@@ -30,6 +32,7 @@ func (g *Greet) Greeting() {
 }
 
 // Gives a walkthrough RiotPot
+
 func (g *Greet) walkthrough() {}
 
 // Throws a regular salute
diff --git a/pkg/models/models.go b/pkg/models/models.go
@@ -5,6 +5,8 @@ package models
 
 import "time"
 
+// TODO: This should be in the database package
+
 // schema for test cases
 type Test_model struct {
 	Timestamp string
diff --git a/templates/templated.go b/templates/templated.go
diff --git a/tools/environ/netcheck.go b/tools/environ/netcheck.go
@@ -4,37 +4,40 @@ Package environ provides functions used to interact with the environment
 package environ
 
 import (
-	"net"
 	"log"
+	"net"
 )
 
 /*
 	Check if the port on the host machine is busy or not
 	this is used for plugins to play on the host
 */
+// TODO: change the hardcoded address of the host. At the very least get it from the configuration
 func CheckPortBusy(protocol string, port string) bool {
+	// Whether we can connect to some port
 	conn, err := net.Listen(protocol, "localhost:"+port)
+	isbusy := err != nil
 
-	if err != nil {
-		return false
+	if isbusy {
+		conn.Close()
 	}
 
-	conn.Close()
-	return true
+	return isbusy
 }
 
 // check if the IP address is valid
 func CheckIPAddress(ip string) bool {
-    if net.ParseIP(ip) == nil {
-        log.Fatalf("IP Address: %s - Invalid\n", ip)
-        return false
-    } else {
-        return true
-    }
+	isvalid := net.ParseIP(ip) != nil
+
+	if !isvalid {
+		log.Fatalf("Invalid IP %s", ip)
+	}
+
+	return isvalid
 }
 
 // check if IP address is reachable via ping command
 func CheckIPConnection(IP string) {
 	path := GetPath("ping")
 	ExecuteCmd(path, IP, "-c", "2")
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ import (`
`9`	`9`	`"github.com/riotpot/internal/cli"`
`10`	`10`	`)`
`11`	`11`
	`12`	`+// TODO: Walktrhough is no longer something needed. The greeting should be something small and fast.`
	`13`	`+`
`12`	`14`	`type Greet struct {`
`13`	`15`	`// Indicates if this is the first time riotpot has been launched`
`14`	`16`	`Tutorial bool`
`@@ -30,6 +32,7 @@ func (g *Greet) Greeting() {`
`30`	`32`	`}`
`31`	`33`
`32`	`34`	`// Gives a walkthrough RiotPot`
	`35`	`+`
`33`	`36`	`func (g *Greet) walkthrough() {}`
`34`	`37`
`35`	`38`	`// Throws a regular salute`