refactoring main / client package. adding docs

README-ZH.md

@@ -153,6 +153,7 @@ $ go mod init test && go get github.com/rogerwelin/cassowary/pkg/client
 package main
 
 import (
+        "encoding/json"
 	"fmt"
 
 	"github.com/rogerwelin/cassowary/pkg/client"

README.md

@@ -195,6 +195,7 @@ And below show a simple example on how to trigger a load test from your code and
 package main
 
 import (
+        "encoding/json"
 	"fmt"
 
 	"github.com/rogerwelin/cassowary/pkg/client"
@@ -225,6 +226,9 @@ func main() {
 }
 ```
 
+More library examples [can be found here](docs/LIBRARY.md)
+
+
 Versioning
 --------
 

cmd/cassowary/cli.go

@@ -4,7 +4,6 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"strconv"
 
@@ -67,14 +66,6 @@ func runLoadTest(c *client.Cassowary) error {
 	return nil
 }
 
-func readFile(file string) ([]byte, error) {
-	fileContent, err := ioutil.ReadFile(file)
-	if err != nil {
-		return []byte{}, err
-	}
-	return fileContent, nil
-}
-
 func validateCLI(c *cli.Context) error {
 
 	prometheusEnabled := false
@@ -167,9 +158,13 @@ func validateCLIFile(c *cli.Context) error {
 		}
 	}
 
+	urlSuffixes, err := readLocalRemoteFile(c.String("file"))
+	if err != nil {
+		return nil
+	}
+
 	cass := &client.Cassowary{
 		FileMode:          true,
-		InputFile:         c.String("file"),
 		BaseURL:           c.String("url"),
 		ConcurrencyLevel:  c.Int("concurrency"),
 		RequestHeader:     header,
@@ -180,6 +175,7 @@ func validateCLIFile(c *cli.Context) error {
 		DisableKeepAlive:  c.Bool("diable-keep-alive"),
 		Timeout:           c.Int("timeout"),
 		Requests:          c.Int("requests"),
+		URLPaths:          urlSuffixes,
 		HTTPMethod:        "GET",
 	}
 

pkg/client/fileops.go → cmd/cassowary/fileops.go

@@ -1,8 +1,9 @@
-package client
+package main
 
 import (
 	"bufio"
 	"io"
+	"io/ioutil"
 	"net/http"
 	"os"
 	"path/filepath"
@@ -36,7 +37,15 @@ func downloadPath(url string) (string, error) {
 	return binDir + "/load.txt", nil
 }
 
-func readFile(filePath string) ([]string, error) {
+func readFile(file string) ([]byte, error) {
+	fileContent, err := ioutil.ReadFile(file)
+	if err != nil {
+		return []byte{}, err
+	}
+	return fileContent, nil
+}
+
+func readLocalRemoteFile(filePath string) ([]string, error) {
 	var urlLines []string
 	var err error
 

docs/LIBRARY.md

@@ -0,0 +1,86 @@
+
+## Using Cassowary as an Library
+
+Cassowary can be imported and used as a module in your Go app. Start by fetching the dependency by using go mod:
+
+```bash
+$ go mod init test && go get github.com/rogerwelin/cassowary/pkg/client
+```
+
+**Example 1: Simple Load Test of an URL**  
+
+```go
+package main
+
+import (
+        "encoding/json"
+	"fmt"
+
+	cassowary "github.com/rogerwelin/cassowary/pkg/client"
+)
+
+func main() {
+	cass := &cassowary.Cassowary{
+		BaseURL:               "http://www.example.com",
+		ConcurrencyLevel:      1,
+		Requests:              10,
+		DisableTerminalOutput: true,
+	}
+	metrics, err := cass.Coordinate()
+	if err != nil {
+		panic(err)
+	}
+
+        // print results
+	fmt.Printf("%+v\n", metrics)
+
+        // or print as json
+	jsonMetrics, err := json.Marshal(metrics)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(string(jsonMetrics))
+}
+```
+
+**Example 2: Load Test an URL across multiple URL paths**  
+
+The following code will make 30 requests across the 3 URL paths declared in the URLPaths field:
+
+```go
+package main
+
+import (
+        "encoding/json"
+	"fmt"
+
+	cassowary "github.com/rogerwelin/cassowary/pkg/client"
+)
+
+func main() {
+	cass := &cassowary.Cassowary{
+		BaseURL:               "http://www.example.com",
+		ConcurrencyLevel:      2,
+		Requests:              30,
+		FileMode:	       true,
+		URLPaths:	       []string{"/accounts", "/orders", "/customers"}
+		DisableTerminalOutput: true,
+	}
+	metrics, err := cass.Coordinate()
+	if err != nil {
+		panic(err)
+	}
+
+        // print results
+	fmt.Printf("%+v\n", metrics)
+
+        // or print as json
+	jsonMetrics, err := json.Marshal(metrics)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(string(jsonMetrics))
+}
+```

pkg/client/load.go

@@ -145,28 +145,20 @@ func (c *Cassowary) Coordinate() (ResultMetrics, error) {
 	}
 	c.IsTLS = tls
 
-	var urlSuffixes []string
-
 	c.Client = &http.Client{
 		Timeout: time.Second * time.Duration(c.Timeout),
 		Transport: &http.Transport{
-			//MaxIdleConns:        300,
 			MaxIdleConnsPerHost: 10000,
-			//MaxConnsPerHost:     300,
-			DisableCompression: false,
-			DisableKeepAlives:  c.DisableKeepAlive,
+			DisableCompression:  false,
+			DisableKeepAlives:   c.DisableKeepAlive,
 		},
 	}
 
 	if c.FileMode {
-		urlSuffixes, err = readFile(c.InputFile)
-		if err != nil {
-			return ResultMetrics{}, err
-		}
-		if c.Requests > len(urlSuffixes) {
-			urlSuffixes = generateSuffixes(urlSuffixes, c.Requests)
+		if c.Requests > len(c.URLPaths) {
+			c.URLPaths = generateSuffixes(c.URLPaths, c.Requests)
 		}
-		c.Requests = len(urlSuffixes)
+		c.Requests = len(c.URLPaths)
 	}
 
 	c.Bar = progressbar.New(c.Requests)
@@ -191,7 +183,7 @@ func (c *Cassowary) Coordinate() (ResultMetrics, error) {
 	}
 
 	if c.FileMode {
-		for _, line := range urlSuffixes {
+		for _, line := range c.URLPaths {
 			workerChan <- line
 		}
 	} else {

pkg/client/load_test.go

@@ -7,7 +7,6 @@ import (
 )
 
 func TestLoadCoordinate(t *testing.T) {
-
 	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(200)
 		w.Write([]byte("ok"))
@@ -38,3 +37,39 @@ func TestLoadCoordinate(t *testing.T) {
 		t.Errorf("Wanted %d but got %d", 0, metrics.FailedRequests)
 	}
 }
+
+func TestLoadCoordinateURLPaths(t *testing.T) {
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+		w.Write([]byte("ok"))
+	}))
+	defer srv.Close()
+
+	cass := Cassowary{
+		BaseURL:               srv.URL,
+		ConcurrencyLevel:      1,
+		Requests:              30,
+		FileMode:              true,
+		URLPaths:              []string{"/get_user", "/get_accounts", "/get_orders"},
+		DisableTerminalOutput: true,
+	}
+	metrics, err := cass.Coordinate()
+	if err != nil {
+		t.Error(err)
+	}
+	if metrics.BaseURL != srv.URL {
+		t.Errorf("Wanted %s but got %s", srv.URL, metrics.BaseURL)
+	}
+
+	if metrics.TotalRequests != 30 {
+		t.Errorf("Wanted %d but got %d", 1, metrics.TotalRequests)
+	}
+
+	if metrics.FailedRequests != 0 {
+		t.Errorf("Wanted %d but got %d", 0, metrics.FailedRequests)
+	}
+
+	if len(cass.URLPaths) != 30 {
+		t.Errorf("Wanted %d but got %d", 30, len(cass.URLPaths))
+	}
+}

pkg/client/types.go

@@ -10,7 +10,6 @@ import (
 type Cassowary struct {
 	FileMode              bool
 	IsTLS                 bool
-	InputFile             string
 	BaseURL               string
 	ConcurrencyLevel      int
 	Requests              int
@@ -19,6 +18,7 @@ type Cassowary struct {
 	PromExport            bool
 	PromURL               string
 	RequestHeader         []string
+	URLPaths              []string
 	DisableTerminalOutput bool
 	DisableKeepAlive      bool
 	Client                *http.Client