added comments/test for new code and added go.mod

Author: jr-frazier

cmd/internal/runtest.go

@@ -57,7 +57,7 @@ type (
 	runOutputFunc func(ctx context.Context, pingID perfops.TestID) (*perfops.RunOutput, error)
 )
 
-// RunTest runs an MTR or ping testm retrives its output and presents it to the user.
+// RunTest runs an MTR or ping test retrieves its output and presents it to the user.
 func RunTest(ctx context.Context, target, location string, nodeIDs []int, limit int, debug, outputJSON bool, runTest runFunc, runOutput runOutputFunc) error {
 	runReq := &perfops.RunRequest{
 		Target:   target,
@@ -112,6 +112,7 @@ func RunTest(ctx context.Context, target, location string, nodeIDs []int, limit
 	return nil
 }
 
+// formatFileName Returns a file name based on provided string and number
 func formatFileName(name string, index int) string {
 	split := strings.Split(name, ".")
 
@@ -122,7 +123,7 @@ func formatFileName(name string, index int) string {
 
 }
 
-// Outputs perfops response to a file
+// OutputToFile Outputs perfops response to a file or multiple files if more than one check is being ran.
 func OutputToFile(f *Formatter, output *perfops.RunOutput, fileOut string) {
 	if f.printID {
 		f.Printf("Test ID: %v\n", output.ID)
@@ -172,7 +173,11 @@ func OutputToFile(f *Formatter, output *perfops.RunOutput, fileOut string) {
 
 			fmt.Fprintf(w, "Node%d, AS%d, %s, %s\n%s\n", n.ID, n.AsNumber, n.City, n.Country.Name, o)
 
-			w.Flush()
+			err := w.Flush()
+
+			if err != nil {
+				return
+			}
 
 		} else if r.Message != "NO DATA" {
 			fileName := ""

cmd/internal/runtest_test.go

@@ -18,7 +18,9 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
+	"fmt"
 	"io"
+	"os"
 	"testing"
 
 	"github.com/ProspectOne/perfops-cli/perfops"
@@ -60,6 +62,8 @@ func TestRunTest(t *testing.T) {
 			nil,
 		},
 	}
+
+	fmt.Println("tests", testCases)
 	ctx := context.Background()
 	for name, tc := range testCases {
 		t.Run(name, func(t *testing.T) {
@@ -116,6 +120,52 @@ func TestPrintOutput(t *testing.T) {
 	}
 }
 
+func TestOutputToFile(t *testing.T) {
+	testCases := map[string]struct {
+		output func() *perfops.RunOutput
+		exp    []byte
+	}{
+		"all": {
+			func() *perfops.RunOutput {
+				var o *perfops.RunOutput
+				json.Unmarshal([]byte(`{"id":"706fc55e3377104da01f05569e35a30b","items":[{"id":"bba072473bd034d432df03730e116686","result":{"output":"121","finished": true,"node":{"id":27,"as_number":12345,"latitude":22.28512548314,"longitude":114.17507171631,"country":{"id":195,"name":"Hong Kong","continent":{"id":2,"name":"Asia","iso":"AS"},"iso":"HK","iso_numeric":"344"},"city":"Hong Kong","sub_region":"Eastern Asia"},"time":1508061924.088372}}],"requested":"sendergram.com","finished":true,"elapsedTime":0.66500000000000004}`), &o)
+				return o
+			},
+			[]byte("\x1b[200DNode27, AS12345, Hong Kong, Hong Kong\n121\n"),
+		},
+		"timeout": {
+			func() *perfops.RunOutput {
+				var o *perfops.RunOutput
+				json.Unmarshal([]byte(`{"id":"706fc55e3377104da01f05569e35a30b","items":[{"id":"bba072473bd034d432df03730e116686","result":{"output":"-2","finished": true,"node":{"id":27,"as_number":23456,"latitude":22.28512548314,"longitude":114.17507171631,"country":{"id":195,"name":"Hong Kong","continent":{"id":2,"name":"Asia","iso":"AS"},"iso":"HK","iso_numeric":"344"},"city":"Hong Kong","sub_region":"Eastern Asia"},"time":1508061924.088372}}],"requested":"sendergram.com","finished":true,"elapsedTime":0.66500000000000004}`), &o)
+				return o
+			},
+			[]byte("\x1b[200DNode27, AS23456, Hong Kong, Hong Kong\nThe command timed-out. It either took too long to execute or we could not connect to your target at all.\n"),
+		},
+		"array output": {
+			func() *perfops.RunOutput {
+				var o *perfops.RunOutput
+				json.Unmarshal([]byte(`{"id":"6e0c06f7445bb8c63949f84fcdbdae55","items":[{"id":"2bff5d6b3a4df8a268afca6c60977032","result":{"dnsServer":"","node":{"as_number":197328,"id":103,"latitude":41.030549854339,"longitude":28.987083435058,"country":{"id":93,"name":"Turkey","continent":{"id":2,"name":"Asia","iso":"AS"},"iso":"TR","iso_numeric":"792","is_eu":false},"city":"Istanbul","sub_region":"Western Asia"},"finished":true,"output":["header","  1 row", " 10 row"],"time":1539517079.937741}}],"requested":"ns2.no-ip.com","finished":true,"elapsedTime":2.21,"creditsWithdrawn":1}`), &o)
+				return o
+			},
+			[]byte("\x1b[200DNode103, AS197328, Istanbul, Turkey\nheader\n  1 row\n 10 row\n"),
+		},
+	}
+	var b bytes.Buffer
+	f := newTestFormatter(&b, false)
+	for name, tc := range testCases {
+		t.Run(name, func(t *testing.T) {
+			OutputToFile(f, tc.output(), "test.txt")
+			if _, err := os.Stat("test.txt"); err != nil {
+				t.Error("File was not created")
+			}
+			err := os.Remove("test.txt")
+			if err != nil {
+				return
+			}
+		})
+	}
+}
+
 type testTerminalWriter struct {
 	io.Writer
 }

go.mod

@@ -0,0 +1,15 @@
+module github.com/ProspectOne/perfops-cli
+
+go 1.19
+
+require (
+	github.com/gosuri/uilive v0.0.3
+	github.com/spf13/cobra v0.0.5
+	github.com/spf13/pflag v1.0.5
+)
+
+require (
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/mattn/go-isatty v0.0.9 // indirect
+	golang.org/x/sys v0.0.0-20191002091554-b397fe3ad8ed // indirect
+)