Merge pull request #52 from jr-frazier/master

"added ability to output curl command to multiple files"

Author: jr-frazier

.gitignore

@@ -2,6 +2,7 @@
 release
 .vscode
 .idea
+.history
 
 # Created by https://www.gitignore.io
 

cmd/curl.go

@@ -35,14 +35,15 @@ var (
 			if err != nil {
 				return err
 			}
-			return chkRunError(runCurl(c, args[0], curlHead, curlInsecure, curlHTTP2, from, nodeIDs, curlLimit))
+			return chkRunError(runCurl(c, args[0], curlHead, curlInsecure, curlHTTP2, from, nodeIDs, curlLimit, fileOut))
 		},
 	}
 
 	curlHead     bool
 	curlInsecure bool
 	curlHTTP2    bool
 	curlLimit    int
+	fileOut      string
 )
 
 func initCurlCmd(parentCmd *cobra.Command) {
@@ -52,11 +53,13 @@ func initCurlCmd(parentCmd *cobra.Command) {
 	curlCmd.Flags().BoolVarP(&curlInsecure, "insecure", "k", false, "Allow curl to proceed for server connections considered insecure")
 	curlCmd.Flags().BoolVarP(&curlHTTP2, "http2", "", false, "Use HTTP version 2")
 	curlCmd.Flags().IntVarP(&curlLimit, "limit", "L", 1, "The maximum number of nodes to use")
+	curlCmd.Flags().StringVarP(&fileOut, "file", "f", "", "output to file")
 
 	parentCmd.AddCommand(curlCmd)
 }
 
-func runCurl(c *perfops.Client, target string, head, insecure, http2 bool, from string, nodeIDs []int, limit int) error {
+func runCurl(c *perfops.Client, target string, head, insecure, http2 bool, from string, nodeIDs []int, limit int, fileOut string) error {
+
 	ctx := context.Background()
 	curlReq := &perfops.CurlRequest{
 		Target:   target,
@@ -100,6 +103,7 @@ func runCurl(c *perfops.Client, target string, head, insecure, http2 bool, from
 		if o, err = res.Output(); err != nil {
 			return err
 		}
+
 		if !outputJSON && o != nil {
 			f.StopSpinner()
 			internal.PrintOutput(f, o)
@@ -108,6 +112,10 @@ func runCurl(c *perfops.Client, target string, head, insecure, http2 bool, from
 			break
 		}
 	}
+	if len(fileOut) > 0 {
+		f.StopSpinner()
+		internal.OutputToFile(f, o, fileOut)
+	}
 	if outputJSON {
 		f.StopSpinner()
 		internal.PrintOutputJSON(o)

cmd/curl_test.go

@@ -26,6 +26,7 @@ func TestInitCurlCmd(t *testing.T) {
 		gotexp func() (interface{}, interface{})
 	}{
 		// Common flags
+		"file":   {[]string{"--file", "file.txt"}, func() (interface{}, interface{}) { return fileOut, "file.txt" }},
 		"from":   {[]string{"--from", "Europe"}, func() (interface{}, interface{}) { return from, "Europe" }},
 		"nodeid": {[]string{"--nodeid", "1,2,3"}, func() (interface{}, interface{}) { return nodeIDs, []int{1, 2, 3} }},
 		"json":   {[]string{"--json"}, func() (interface{}, interface{}) { return outputJSON, true }},
@@ -49,7 +50,7 @@ func TestInitCurlCmd(t *testing.T) {
 				t.Fatal("expected flag; got nil")
 			}
 
-			got, exp := tc.gotexp();
+			got, exp := tc.gotexp()
 			if reflect.DeepEqual(got, exp) == false {
 				t.Fatalf("expected %v; got %v", exp, got)
 			}
@@ -81,7 +82,7 @@ func TestRunCurlResolve(t *testing.T) {
 	}
 	for name, tc := range testCases {
 		t.Run(name, func(t *testing.T) {
-			runCurl(c, "example.com", tc.head, tc.insecure, tc.http2, tc.from, tc.nodeIDs, 12)
+			runCurl(c, "example.com", tc.head, tc.insecure, tc.http2, tc.from, tc.nodeIDs, 12, "file.txt")
 			if got, exp := tr.req.URL.Path, "/run/curl"; got != exp {
 				t.Fatalf("expected %v; got %v", exp, got)
 			}

cmd/internal/runtest.go

@@ -14,11 +14,13 @@
 package internal
 
 import (
+	"bufio"
 	"bytes"
 	"context"
 	"encoding/json"
 	"fmt"
 	"io"
+	"os"
 	"strings"
 	"sync"
 	"time"
@@ -55,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,
@@ -110,6 +112,98 @@ 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, ".")
+
+	n := split[len(split)-2]
+	split[len(split)-2] = fmt.Sprintf("%v-%x", n, index+1)
+
+	return strings.Join(split, ".")
+
+}
+
+// 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)
+	}
+	spinner := f.s.Step()
+	if !output.IsFinished() {
+		f.Printf("%s", spinner)
+		if len(output.Items) > 1 {
+			finished := 0
+			for _, item := range output.Items {
+				if item.Result.IsFinished() {
+					finished++
+				}
+			}
+			f.Printf(" %d/%d", finished, len(output.Items))
+		}
+		f.Printf("\n")
+	}
+	for i, item := range output.Items {
+		r := item.Result
+		n := r.Node
+		if item.Result.Message == "" {
+			o := r.Output
+			if o == "-2" {
+				o = "The command timed-out. It either took too long to execute or we could not connect to your target at all."
+			} else if a, ok := o.([]interface{}); ok {
+				sb := strings.Builder{}
+				for _, i := range a {
+					sb.WriteString(fmt.Sprintf("%s\n", i))
+				}
+				s := sb.String()
+				o = s[:len(s)-1]
+			}
+
+			fileName := ""
+
+			if len(output.Items) > 1 {
+				fileName = formatFileName(fileOut, i)
+			} else {
+				fileName = fileOut
+			}
+
+			file, _ := os.Create(fileName)
+			defer file.Close()
+
+			w := bufio.NewWriter(file)
+
+			fmt.Fprintf(w, "Node%d, AS%d, %s, %s\n%s\n", n.ID, n.AsNumber, n.City, n.Country.Name, o)
+
+			err := w.Flush()
+
+			if err != nil {
+				return
+			}
+
+		} else if r.Message != "NO DATA" {
+			fileName := ""
+
+			if len(output.Items) > 1 {
+				fileName = formatFileName(fileOut, i)
+			} else {
+				fileName = fileOut
+			}
+
+			file, _ := os.Create(fileName)
+			defer file.Close()
+
+			w := bufio.NewWriter(file)
+
+			fmt.Fprintf(w, "Node%d, AS%d, %s, %s\n%s\n", n.ID, n.AsNumber, n.City, n.Country.Name, r.Message)
+
+			w.Flush()
+		}
+		if !item.Result.IsFinished() {
+			f.Printf("%s\n", spinner)
+		}
+	}
+	f.Flush(!output.IsFinished())
+}
+
 // PrintOutput prints run items that have been data.
 func PrintOutput(f *Formatter, output *perfops.RunOutput) {
 	if f.printID {
@@ -144,6 +238,9 @@ func PrintOutput(f *Formatter, output *perfops.RunOutput) {
 				s := sb.String()
 				o = s[:len(s)-1]
 			}
+			if len(output.Items) > 1 {
+				fmt.Println("Greater Than One")
+			}
 			f.Printf("Node%d, AS%d, %s, %s\n%s\n", n.ID, n.AsNumber, n.City, n.Country.Name, o)
 		} else if r.Message != "NO DATA" {
 			f.Printf("Node%d, AS%d, %s, %s\n%s\n", n.ID, n.AsNumber, n.City, n.Country.Name, r.Message)

cmd/internal/runtest_test.go

@@ -19,6 +19,7 @@ import (
 	"encoding/json"
 	"errors"
 	"io"
+	"os"
 	"testing"
 
 	"github.com/ProspectOne/perfops-cli/perfops"
@@ -60,6 +61,7 @@ func TestRunTest(t *testing.T) {
 			nil,
 		},
 	}
+
 	ctx := context.Background()
 	for name, tc := range testCases {
 		t.Run(name, func(t *testing.T) {
@@ -116,6 +118,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
+)