Skip to content

Improved comments for godoc #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bengadbois merged 1 commit into from
Apr 5, 2017
Merged

Improved comments for godoc #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/printer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
color "github.com/fatih/color"
)

//creates nice readable summary of entire stress test
//CreateTextSummary creates a human friendly summary of entire stress test
func CreateTextSummary(reqStatSummary requestStatSummary) string {
summary := "\n"

Expand Down
2 changes: 1 addition & 1 deletion lib/stats.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type requestStatSummary struct {
totalDataTransferred int //bytes
}

//create statistical summary of all requests
//CreateRequestsStats creates a statistical summary out of the individual RequestStats
func CreateRequestsStats(requestStats []RequestStat) requestStatSummary {
if len(requestStats) == 0 {
return requestStatSummary{}
Expand Down
34 changes: 21 additions & 13 deletions lib/stress.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ var writeLock sync.Mutex

type workerDone struct{}

//RequestStat is the saved information about an individual completed HTTP request
type RequestStat struct {
Proto string
URL string
Expand All @@ -37,7 +38,7 @@ type RequestStat struct {
}

type (
//Stress is the top level struct that contains the configuration of stress test
//Stress is the top level struct that contains the configuration for a stress test
StressConfig struct {
Targets []Target
Verbose bool
Expand All @@ -61,14 +62,22 @@ type (
KeepAlive bool
FollowRedirects bool
}
//Target is location to send the HTTP request.
Target struct {
URL string
RegexURL bool
Count int //how many total requests to make
Concurrency int
Timeout string
Method string
Body string
URL string
//Whether or not to interpret the URL as a regular expression string
//and generate actual target URLs from that
RegexURL bool
//How many total requests to make
Count int
//How many requests can be happening simultaneously for this Target
Concurrency int
Timeout string
//A valid HTTP method: GET, HEAD, POST, etc.
Method string
//String that is the content of the HTTP body. Empty string is no body.
Body string
//A location on disk to read the HTTP body from. Empty string means it will not be read.
BodyFilename string
Headers string
Cookies string
Expand All @@ -80,10 +89,8 @@ type (
}
)

//defaults
var DefaultURL = "http://localhost"

const (
DefaultURL = "http://localhost"
DefaultCount = 10
DefaultConcurrency = 1
DefaultTimeout = "10s"
Expand All @@ -92,7 +99,7 @@ const (
)

//NewStress creates a new Stress object
//with reasonable defaults, but needs URL set
//with reasonable defaults
func NewStressConfig() (s *StressConfig) {
s = &StressConfig{
Targets: []Target{
Expand All @@ -110,7 +117,8 @@ func NewStressConfig() (s *StressConfig) {
return
}

//RunStress starts the stress tests
//RunStress starts the stress tests with the provided StressConfig.
//Throughout the test, data is sent to w, useful for live updates.
func RunStress(s StressConfig, w io.Writer) ([][]RequestStat, error) {
if w == nil {
return nil, errors.New("nil writer")
Expand Down