Merge pull request #101 from aykhans/feat/add-duration

✨ Add duration

Author: aykhans

README.md

@@ -6,15 +6,15 @@
 ## Table of Contents
 
 - [Installation](#installation)
-  - [Using Docker (Recommended)](#using-docker-recommended)
-  - [Using Pre-built Binaries](#using-pre-built-binaries)
-  - [Building from Source](#building-from-source)
+    - [Using Docker (Recommended)](#using-docker-recommended)
+    - [Using Pre-built Binaries](#using-pre-built-binaries)
+    - [Building from Source](#building-from-source)
 - [Usage](#usage)
-  - [1. CLI Usage](#1-cli-usage)
-  - [2. Config File Usage](#2-config-file-usage)
-    - [2.1 JSON Example](#21-json-example)
-    - [2.2 YAML/YML Example](#22-yamlyml-example)
-  - [3. CLI & Config File Combination](#3-cli--config-file-combination)
+    - [1. CLI Usage](#1-cli-usage)
+    - [2. Config File Usage](#2-config-file-usage)
+        - [2.1 JSON Example](#21-json-example)
+        - [2.2 YAML/YML Example](#22-yamlyml-example)
+    - [3. CLI & Config File Combination](#3-cli--config-file-combination)
 - [Config Parameters Reference](#config-parameters-reference)
 
 ## Installation
@@ -46,6 +46,7 @@ Download the latest binaries from the [releases](https://github.com/aykhans/dodo
 ### Building from Source
 
 To build Dodo from source, ensure you have [Go 1.24+](https://golang.org/dl/) installed.
+
 ```sh
 go install -ldflags "-s -w" github.com/aykhans/dodo@latest
 ```
@@ -56,21 +57,21 @@ Dodo supports CLI arguments, configuration files (JSON/YAML), or a combination o
 
 ### 1. CLI Usage
 
-Send 1000 GET requests to https://example.com with 10 parallel dodos (threads) and a timeout of 2 seconds:
+Send 1000 GET requests to https://example.com with 10 parallel dodos (threads), each with a timeout of 2 seconds, within a maximum duration of 1 minute:
 
 ```sh
-dodo -u https://example.com -m GET -d 10 -r 1000 -t 2s
+dodo -u https://example.com -m GET -d 10 -r 1000 -o 1m -t 2s
 ```
 
 With Docker:
 
 ```sh
-docker run --rm -i aykhans/dodo -u https://example.com -m GET -d 10 -r 1000 -t 2s
+docker run --rm -i aykhans/dodo -u https://example.com -m GET -d 10 -r 1000 -o 1m -t 2s
 ```
 
 ### 2. Config File Usage
 
-Send 1000 GET requests to https://example.com with 10 parallel dodos (threads) and a timeout of 800 milliseconds:
+Send 1000 GET requests to https://example.com with 10 parallel dodos (threads), each with a timeout of 800 milliseconds, within a maximum duration of 250 seconds:
 
 #### 2.1 JSON Example
 
@@ -82,6 +83,7 @@ Send 1000 GET requests to https://example.com with 10 parallel dodos (threads) a
     "timeout": "800ms",
     "dodos": 10,
     "requests": 1000,
+    "duration": "250s",
 
     "params": [
         // A random value will be selected from the list for first "key1" param on each request
@@ -159,6 +161,7 @@ yes: false
 timeout: "800ms"
 dodos: 10
 requests: 1000
+duration: "250s"
 
 params:
     # A random value will be selected from the list for first "key1" param on each request
@@ -230,30 +233,31 @@ docker run --rm -i aykhans/dodo -f https://example.com/config.yaml
 CLI arguments override config file values:
 
 ```sh
-dodo -f /path/to/config.yaml -u https://example.com -m GET -d 10 -r 1000 -t 5s
+dodo -f /path/to/config.yaml -u https://example.com -m GET -d 10 -r 1000 -o 1m -t 5s
 ```
 
 With Docker:
 
 ```sh
-docker run --rm -i -v /path/to/config.json:/config.json aykhans/dodo -f /config.json -u https://example.com -m GET -d 10 -r 1000 -t 5s
+docker run --rm -i -v /path/to/config.json:/config.json aykhans/dodo -f /config.json -u https://example.com -m GET -d 10 -r 1000 -o 1m -t 5s
 ```
 
 ## Config Parameters Reference
 
 If `Headers`, `Params`, `Cookies`, `Body`, or `Proxy` fields have multiple values, each request will choose a random value from the list.
 
-| Parameter       | JSON config file | CLI Flag     | CLI Short Flag | Type                           | Description                                                     | Default |
-| --------------- | ---------------- | ------------ | -------------- | ------------------------------ | --------------------------------------------------------------- | ------- |
-| Config file     | -                | -config-file | -f             | String                         | Path to local config file or http(s) URL of the config file     | -       |
-| Yes             | yes              | -yes         | -y             | Boolean                        | Answer yes to all questions                                     | false   |
-| URL             | url              | -url         | -u             | String                         | URL to send the request to                                      | -       |
-| Method          | method           | -method      | -m             | String                         | HTTP method                                                     | GET     |
-| Requests        | requests         | -requests    | -r             | UnsignedInteger                | Total number of requests to send                                | 1000    |
-| Dodos (Threads) | dodos            | -dodos       | -d             | UnsignedInteger                | Number of dodos (threads) to send requests in parallel          | 1       |
-| Timeout         | timeout          | -timeout     | -t             | Duration                       | Timeout for canceling each request                              | 10s     |
-| Params          | params           | -param       | -p             | [{String: String OR [String]}] | Request parameters                                              | -       |
-| Headers         | headers          | -header      | -H             | [{String: String OR [String]}] | Request headers                                                 | -       |
-| Cookies         | cookies          | -cookie      | -c             | [{String: String OR [String]}] | Request cookies                                                 | -       |
-| Body            | body             | -body        | -b             | String OR [String]             | Request body or list of request bodies                          | -       |
-| Proxy           | proxies          | -proxy       | -x             | String OR [String]             | Proxy URL or list of proxy URLs                                 | -       |
+| Parameter       | config file | CLI Flag     | CLI Short Flag | Type                           | Description                                                 | Default |
+| --------------- | ----------- | ------------ | -------------- | ------------------------------ | ----------------------------------------------------------- | ------- |
+| Config file     | -           | -config-file | -f             | String                         | Path to local config file or http(s) URL of the config file | -       |
+| Yes             | yes         | -yes         | -y             | Boolean                        | Answer yes to all questions                                 | false   |
+| URL             | url         | -url         | -u             | String                         | URL to send the request to                                  | -       |
+| Method          | method      | -method      | -m             | String                         | HTTP method                                                 | GET     |
+| Dodos (Threads) | dodos       | -dodos       | -d             | UnsignedInteger                | Number of dodos (threads) to send requests in parallel      | 1       |
+| Requests        | requests    | -requests    | -r             | UnsignedInteger                | Total number of requests to send                            | -       |
+| Duration        | duration    | -duration    | -o             | Time                           | Maximum duration for the test                               | -       |
+| Timeout         | timeout     | -timeout     | -t             | Time                           | Timeout for canceling each request                          | 10s     |
+| Params          | params      | -param       | -p             | [{String: String OR [String]}] | Request parameters                                          | -       |
+| Headers         | headers     | -header      | -H             | [{String: String OR [String]}] | Request headers                                             | -       |
+| Cookies         | cookies     | -cookie      | -c             | [{String: String OR [String]}] | Request cookies                                             | -       |
+| Body            | body        | -body        | -b             | String OR [String]             | Request body or list of request bodies                      | -       |
+| Proxy           | proxies     | -proxy       | -x             | String OR [String]             | Proxy URL or list of proxy URLs                             | -       |

config.json

@@ -5,6 +5,7 @@
     "timeout": "5s",
     "dodos": 8,
     "requests": 1000,
+    "duration": "10s",
 
     "params": [
         { "key1": ["value1", "value2", "value3", "value4"] },

config.yaml

@@ -4,6 +4,7 @@ yes: false
 timeout: "5s"
 dodos: 8
 requests: 1000
+duration: "10s"
 
 params:
     - key1: ["value1", "value2", "value3", "value4"]

config/cli.go

@@ -16,16 +16,16 @@ const cliUsageText = `Usage:
 
 Examples:
 
-Simple usage only with URL:
-  dodo -u https://example.com
+Simple usage:
+  dodo -u https://example.com -o 1m
 
 Usage with config file:
   dodo -f /path/to/config/file/config.json
 
 Usage with all flags:
   dodo -f /path/to/config/file/config.json \
     -u https://example.com -m POST \
-    -d 10 -r 1000 -t 3s \
+    -d 10 -r 1000 -o 3m -t 3s \
     -b "body1" -body "body2" \
     -H "header1:value1" -header "header2:value2" \
     -p "param1=value1" -param "param2=value2" \
@@ -39,8 +39,9 @@ Flags:
   -y, -yes          bool      Answer yes to all questions (default %v)
   -f, -config-file  string    Path to the local config file or http(s) URL of the config file
   -d, -dodos        uint      Number of dodos(threads) (default %d)
-  -r, -requests     uint      Number of total requests (default %d)
-  -t, -timeout      Duration  Timeout for each request (e.g. 400ms, 15s, 1m10s) (default %v)
+  -r, -requests     uint      Number of total requests
+  -o, -duration     Time      Maximum duration for the test (e.g. 30s, 1m, 5h)
+  -t, -timeout      Time      Timeout for each request (e.g. 400ms, 15s, 1m10s) (default %v)
   -u, -url          string    URL for stress testing
   -m, -method       string    HTTP Method for the request (default %s)
   -b, -body         [string]  Body for the request (e.g. "body text")
@@ -55,7 +56,6 @@ func (config *Config) ReadCLI() (types.ConfigFile, error) {
 			cliUsageText+"\n",
 			DefaultYes,
 			DefaultDodosCount,
-			DefaultRequestCount,
 			DefaultTimeout,
 			DefaultMethod,
 		)
@@ -70,6 +70,7 @@ func (config *Config) ReadCLI() (types.ConfigFile, error) {
 		dodosCount   = uint(0)
 		requestCount = uint(0)
 		timeout      time.Duration
+		duration     time.Duration
 	)
 
 	{
@@ -94,6 +95,9 @@ func (config *Config) ReadCLI() (types.ConfigFile, error) {
 		flag.UintVar(&requestCount, "requests", 0, "Number of total requests")
 		flag.UintVar(&requestCount, "r", 0, "Number of total requests")
 
+		flag.DurationVar(&duration, "duration", 0, "Maximum duration of the test")
+		flag.DurationVar(&duration, "o", 0, "Maximum duration of the test")
+
 		flag.DurationVar(&timeout, "timeout", 0, "Timeout for each request (e.g. 400ms, 15s, 1m10s)")
 		flag.DurationVar(&timeout, "t", 0, "Timeout for each request (e.g. 400ms, 15s, 1m10s)")
 
@@ -139,6 +143,8 @@ func (config *Config) ReadCLI() (types.ConfigFile, error) {
 			config.DodosCount = utils.ToPtr(dodosCount)
 		case "requests", "r":
 			config.RequestCount = utils.ToPtr(requestCount)
+		case "duration", "o":
+			config.Duration = &types.Duration{Duration: duration}
 		case "timeout", "t":
 			config.Timeout = &types.Timeout{Duration: timeout}
 		case "yes", "y":

config/config.go

@@ -15,12 +15,13 @@ import (
 )
 
 const (
-	VERSION             string        = "0.6.1"
+	VERSION             string        = "0.6.2"
 	DefaultUserAgent    string        = "Dodo/" + VERSION
 	DefaultMethod       string        = "GET"
 	DefaultTimeout      time.Duration = time.Second * 10
 	DefaultDodosCount   uint          = 1
-	DefaultRequestCount uint          = 1
+	DefaultRequestCount uint          = 0
+	DefaultDuration     time.Duration = 0
 	DefaultYes          bool          = false
 )
 
@@ -32,6 +33,7 @@ type RequestConfig struct {
 	Timeout      time.Duration
 	DodosCount   uint
 	RequestCount uint
+	Duration     time.Duration
 	Yes          bool
 	Params       types.Params
 	Headers      types.Headers
@@ -47,6 +49,7 @@ func NewRequestConfig(conf *Config) *RequestConfig {
 		Timeout:      conf.Timeout.Duration,
 		DodosCount:   *conf.DodosCount,
 		RequestCount: *conf.RequestCount,
+		Duration:     conf.Duration.Duration,
 		Yes:          *conf.Yes,
 		Params:       conf.Params,
 		Headers:      conf.Headers,
@@ -57,6 +60,9 @@ func NewRequestConfig(conf *Config) *RequestConfig {
 }
 
 func (rc *RequestConfig) GetValidDodosCountForRequests() uint {
+	if rc.RequestCount == 0 {
+		return rc.DodosCount
+	}
 	return min(rc.DodosCount, rc.RequestCount)
 }
 
@@ -95,7 +101,17 @@ func (rc *RequestConfig) Print() {
 	t.AppendSeparator()
 	t.AppendRow(table.Row{"Dodos", rc.DodosCount})
 	t.AppendSeparator()
-	t.AppendRow(table.Row{"Requests", rc.RequestCount})
+	if rc.RequestCount > 0 {
+		t.AppendRow(table.Row{"Requests", rc.RequestCount})
+	} else {
+		t.AppendRow(table.Row{"Requests"})
+	}
+	t.AppendSeparator()
+	if rc.Duration > 0 {
+		t.AppendRow(table.Row{"Duration", rc.Duration})
+	} else {
+		t.AppendRow(table.Row{"Duration"})
+	}
 	t.AppendSeparator()
 	t.AppendRow(table.Row{"Params", rc.Params.String()})
 	t.AppendSeparator()
@@ -116,6 +132,7 @@ type Config struct {
 	Timeout      *types.Timeout    `json:"timeout" yaml:"timeout"`
 	DodosCount   *uint             `json:"dodos" yaml:"dodos"`
 	RequestCount *uint             `json:"requests" yaml:"requests"`
+	Duration     *types.Duration   `json:"duration" yaml:"duration"`
 	Yes          *bool             `json:"yes" yaml:"yes"`
 	Params       types.Params      `json:"params" yaml:"params"`
 	Headers      types.Headers     `json:"headers" yaml:"headers"`
@@ -162,8 +179,8 @@ func (c *Config) Validate() []error {
 	if utils.IsNilOrZero(c.DodosCount) {
 		errs = append(errs, errors.New("dodos count must be greater than 0"))
 	}
-	if utils.IsNilOrZero(c.RequestCount) {
-		errs = append(errs, errors.New("request count must be greater than 0"))
+	if utils.IsNilOrZero(c.Duration) && utils.IsNilOrZero(c.RequestCount) {
+		errs = append(errs, errors.New("you should provide at least one of duration or request count"))
 	}
 
 	for i, proxy := range c.Proxies {
@@ -197,6 +214,9 @@ func (config *Config) MergeConfig(newConfig *Config) {
 	if newConfig.RequestCount != nil {
 		config.RequestCount = newConfig.RequestCount
 	}
+	if newConfig.Duration != nil {
+		config.Duration = newConfig.Duration
+	}
 	if newConfig.Yes != nil {
 		config.Yes = newConfig.Yes
 	}
@@ -230,6 +250,9 @@ func (config *Config) SetDefaults() {
 	if config.RequestCount == nil {
 		config.RequestCount = utils.ToPtr(DefaultRequestCount)
 	}
+	if config.Duration == nil {
+		config.Duration = &types.Duration{Duration: DefaultDuration}
+	}
 	if config.Yes == nil {
 		config.Yes = utils.ToPtr(DefaultYes)
 	}

main.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"os/signal"
 	"syscall"
+	"time"
 
 	"github.com/aykhans/dodo/config"
 	"github.com/aykhans/dodo/requests"
@@ -49,6 +50,10 @@ func main() {
 	ctx, cancel := context.WithCancel(context.Background())
 	go listenForTermination(func() { cancel() })
 
+	if requestConf.Duration > 0 {
+		time.AfterFunc(requestConf.Duration, func() { cancel() })
+	}
+
 	responses, err := requests.Run(ctx, requestConf)
 	if err != nil {
 		if err == types.ErrInterrupt {

requests/helper.go

@@ -17,7 +17,7 @@ import (
 func streamProgress(
 	ctx context.Context,
 	wg *sync.WaitGroup,
-	total int64,
+	total uint,
 	message string,
 	increase <-chan int64,
 ) {
@@ -27,21 +27,26 @@ func streamProgress(
 	pw.SetStyle(progress.StyleBlocks)
 	pw.SetTrackerLength(40)
 	pw.SetUpdateFrequency(time.Millisecond * 250)
+	if total == 0 {
+		pw.Style().Visibility.Percentage = false
+	}
 	go pw.Render()
 	dodosTracker := progress.Tracker{
 		Message: message,
-		Total:   total,
+		Total:   int64(total),
 	}
 	pw.AppendTracker(&dodosTracker)
+
 	for {
 		select {
 		case <-ctx.Done():
-			if ctx.Err() != context.Canceled {
+			if err := ctx.Err(); err == context.Canceled || err == context.DeadlineExceeded {
+				dodosTracker.MarkAsDone()
+			} else {
 				dodosTracker.MarkAsErrored()
 			}
+			time.Sleep(time.Millisecond * 300)
 			fmt.Printf("\r")
-			time.Sleep(time.Millisecond * 500)
-			pw.Stop()
 			return
 
 		case value := <-increase: