Merge pull request #98 from aykhans/feat/config-yaml

✨ Add yaml file reader to config

Author: aykhans

Dockerfile

@@ -7,13 +7,11 @@ RUN go mod download
 COPY . .
 
 RUN go build -ldflags "-s -w" -o dodo
-RUN echo "{}" > config.json
 
 FROM gcr.io/distroless/static-debian12:latest
 
 WORKDIR /
 
 COPY --from=builder /src/dodo /dodo
-COPY --from=builder /src/config.json /config.json
 
-ENTRYPOINT ["./dodo", "-f", "/config.json"]
+ENTRYPOINT ["./dodo"]

README.md

@@ -3,36 +3,49 @@
 <img width="30%" height="30%" src="https://ftp.aykhans.me/web/client/pubshares/VzPtSHS7yPQT7ngoZzZSNU/browse?path=%2Fdodo.png">
 </p>
 
+## 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)
+- [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)
+- [Config Parameters Reference](#config-parameters-reference)
+
 ## Installation
 
 ### Using Docker (Recommended)
 
-Pull the Dodo image from Docker Hub:
+Pull the latest Dodo image from Docker Hub:
 
 ```sh
 docker pull aykhans/dodo:latest
 ```
 
-When using Dodo with Docker and a local config file, you must provide the config.json file as a volume to the Docker run command (not as the "-f config.json" argument):
+To use Dodo with Docker and a local config file, mount the config file as a volume and pass it as an argument:
 
 ```sh
-docker run -v /path/to/config.json:/config.json aykhans/dodo
+docker run -v /path/to/config.json:/config.json aykhans/dodo -f /config.json
 ```
 
-If you're using Dodo with Docker and providing a config file via URL, you don't need to set a volume:
+If you're using a remote config file via URL, you don't need to mount a volume:
 
 ```sh
-docker run aykhans/dodo -f https://raw.githubusercontent.com/aykhans/dodo/main/config.json
+docker run aykhans/dodo -f https://raw.githubusercontent.com/aykhans/dodo/main/config.yaml
 ```
 
-### Using Binary Files
+### Using Pre-built Binaries
 
-You can download pre-built binaries from the [releases](https://github.com/aykhans/dodo/releases) section.
+Download the latest binaries from the [releases](https://github.com/aykhans/dodo/releases) section.
 
 ### Building from Source
 
-To build Dodo from source, you need to have [Go 1.24+](https://golang.org/dl/) installed.
-Follow these steps:
+To build Dodo from source, ensure you have [Go 1.24+](https://golang.org/dl/) installed. Then follow these steps:
 
 1. **Clone the repository:**
 
@@ -56,9 +69,9 @@ This will generate an executable named `dodo` in the project directory.
 
 ## Usage
 
-You can use Dodo with CLI arguments, a JSON config file, or both. When using both, CLI arguments will override JSON config values if there's a conflict.
+Dodo supports CLI arguments, configuration files (JSON/YAML), or a combination of both. If both are used, CLI arguments take precedence.
 
-### 1. CLI
+### 1. CLI Usage
 
 Send 1000 GET requests to https://example.com with 10 parallel dodos (threads) and a timeout of 2 seconds:
 
@@ -72,7 +85,9 @@ With Docker:
 docker run --rm -i aykhans/dodo -u https://example.com -m GET -d 10 -r 1000 -t 2s
 ```
 
-### 2. JSON Config File
+### 2. Config File Usage
+
+#### 2.1 JSON Example
 
 Send 1000 GET requests to https://example.com with 10 parallel dodos (threads) and a timeout of 800 milliseconds:
 
@@ -152,21 +167,96 @@ docker run --rm -i -v /path/to/config.json:/config.json aykhans/dodo
 docker run --rm -i aykhans/dodo -f https://example.com/config.json
 ```
 
-### 3. Combined (CLI & JSON)
+#### 2.2 YAML/YML Example
+
+```yaml
+method: "GET"
+url: "https://example.com"
+yes: false
+timeout: "800ms"
+dodos: 10
+requests: 1000
+
+params:
+    # A random value will be selected from the list for first "key1" param on each request
+    # And always "value" for second "key1" param on each request
+    # e.g. "?key1=value2&key1=value"
+    - key1: ["value1", "value2", "value3", "value4"]
+    - key1: "value"
+
+    # A random value will be selected from the list for param "key2" on each request
+    # e.g. "?key2=value2"
+    - key2: ["value1", "value2"]
+
+headers:
+    # A random value will be selected from the list for first "key1" header on each request
+    # And always "value" for second "key1" header on each request
+    # e.g. "key1: value3", "key1: value"
+    - key1: ["value1", "value2", "value3", "value4"]
+    - key1: "value"
+
+    # A random value will be selected from the list for header "key2" on each request
+    # e.g. "key2: value2"
+    - key2: ["value1", "value2"]
+
+cookies:
+    # A random value will be selected from the list for first "key1" cookie on each request
+    # And always "value" for second "key1" cookie on each request
+    # e.g. "key1=value4; key1=value"
+    - key1: ["value1", "value2", "value3", "value4"]
+    - key1: "value"
+
+    # A random value will be selected from the list for cookie "key2" on each request
+    # e.g. "key2=value1"
+    - key2: ["value1", "value2"]
+
+body: "body-text"
+# OR
+# A random body value will be selected from the list for each request
+body:
+    - "body-text1"
+    - "body-text2"
+    - "body-text3"
+
+proxy: "http://example.com:8080"
+# OR
+# A random proxy will be selected from the list for each request
+proxy:
+    - "http://example.com:8080"
+    - "http://username:[email protected]:8080"
+    - "socks5://example.com:8080"
+    - "socks5h://example.com:8080"
+```
+
+```sh
+dodo -f /path/config.yaml
+# OR
+dodo -f https://example.com/config.yaml
+```
+
+With Docker:
+
+```sh
+docker run --rm -i -v /path/to/config.yaml:/config.yaml aykhans/dodo -f /config.yaml
+# OR
+docker run --rm -i aykhans/dodo -f https://example.com/config.yaml
+```
+
+### 3. CLI & Config File Combination
 
-Override the config file arguments with CLI arguments:
+CLI arguments override config file values:
 
 ```sh
-dodo -f /path/to/config.json -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 -t 5s
 ```
 
 With Docker:
 
 ```sh
-docker run --rm -i -v /path/to/config.json:/config.json aykhans/dodo -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 -t 5s
 ```
 
-## CLI and JSON Config Parameters
+## Config Parameters Reference
 
 If `Headers`, `Params`, `Cookies`, `Body`, or `Proxy` fields have multiple values, each request will choose a random value from the list.
 

config.yaml

@@ -1,11 +1,8 @@
-# YAML/YML config file option is not implemented yet.
-# This file is a example for future implementation.
-
 method: "GET"
 url: "https://example.com"
 yes: false
 timeout: "5s"
-dodos: 10
+dodos: 8
 requests: 1000
 
 params:
@@ -25,13 +22,15 @@ cookies:
 
 # body: "body-text"
 # OR
+# A random body value will be selected from the list for each request
 body:
     - "body-text1"
     - "body-text2"
     - "body-text3"
 
 # proxy: "http://example.com:8080"
 # OR
+# A random proxy will be selected from the list for each request
 proxy:
     - "http://example.com:8080"
     - "http://username:[email protected]:8080"

config/config.go

@@ -15,7 +15,7 @@ import (
 )
 
 const (
-	VERSION             string        = "0.6.0"
+	VERSION             string        = "0.6.1"
 	DefaultUserAgent    string        = "Dodo/" + VERSION
 	DefaultMethod       string        = "GET"
 	DefaultTimeout      time.Duration = time.Second * 10
@@ -27,17 +27,17 @@ const (
 var SupportedProxySchemes []string = []string{"http", "socks5", "socks5h"}
 
 type RequestConfig struct {
-	Method       string        `json:"method"`
-	URL          url.URL       `json:"url"`
-	Timeout      time.Duration `json:"timeout"`
-	DodosCount   uint          `json:"dodos"`
-	RequestCount uint          `json:"requests"`
-	Yes          bool          `json:"yes"`
-	Params       types.Params  `json:"params"`
-	Headers      types.Headers `json:"headers"`
-	Cookies      types.Cookies `json:"cookies"`
-	Body         types.Body    `json:"body"`
-	Proxies      types.Proxies `json:"proxies"`
+	Method       string
+	URL          url.URL
+	Timeout      time.Duration
+	DodosCount   uint
+	RequestCount uint
+	Yes          bool
+	Params       types.Params
+	Headers      types.Headers
+	Cookies      types.Cookies
+	Body         types.Body
+	Proxies      types.Proxies
 }
 
 func NewRequestConfig(conf *Config) *RequestConfig {
@@ -111,17 +111,17 @@ func (rc *RequestConfig) Print() {
 }
 
 type Config struct {
-	Method       *string           `json:"method"`
-	URL          *types.RequestURL `json:"url"`
-	Timeout      *types.Timeout    `json:"timeout"`
-	DodosCount   *uint             `json:"dodos"`
-	RequestCount *uint             `json:"requests"`
-	Yes          *bool             `json:"yes"`
-	Params       types.Params      `json:"params"`
-	Headers      types.Headers     `json:"headers"`
-	Cookies      types.Cookies     `json:"cookies"`
-	Body         types.Body        `json:"body"`
-	Proxies      types.Proxies     `json:"proxy"`
+	Method       *string           `json:"method" yaml:"method"`
+	URL          *types.RequestURL `json:"url" yaml:"url"`
+	Timeout      *types.Timeout    `json:"timeout" yaml:"timeout"`
+	DodosCount   *uint             `json:"dodos" yaml:"dodos"`
+	RequestCount *uint             `json:"requests" yaml:"requests"`
+	Yes          *bool             `json:"yes" yaml:"yes"`
+	Params       types.Params      `json:"params" yaml:"params"`
+	Headers      types.Headers     `json:"headers" yaml:"headers"`
+	Cookies      types.Cookies     `json:"cookies" yaml:"cookies"`
+	Body         types.Body        `json:"body" yaml:"body"`
+	Proxies      types.Proxies     `json:"proxy" yaml:"proxy"`
 }
 
 func NewConfig() *Config {

config/file.go

@@ -7,40 +7,54 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"slices"
+	"strings"
 	"time"
 
 	"github.com/aykhans/dodo/types"
+	"gopkg.in/yaml.v3"
 )
 
+var supportedFileTypes = []string{"json", "yaml", "yml"}
+
 func (config *Config) ReadFile(filePath types.ConfigFile) error {
 	var (
 		data []byte
 		err  error
 	)
 
-	if filePath.LocationType() == types.FileLocationTypeRemoteHTTP {
-		client := &http.Client{
-			Timeout: 10 * time.Second,
-		}
+	fileExt := filePath.Extension()
+	if slices.Contains(supportedFileTypes, fileExt) {
+		if filePath.LocationType() == types.FileLocationTypeRemoteHTTP {
+			client := &http.Client{
+				Timeout: 10 * time.Second,
+			}
 
-		resp, err := client.Get(filePath.String())
-		if err != nil {
-			return fmt.Errorf("failed to fetch config file from %s", filePath)
-		}
-		defer resp.Body.Close()
+			resp, err := client.Get(filePath.String())
+			if err != nil {
+				return fmt.Errorf("failed to fetch config file from %s", filePath)
+			}
+			defer resp.Body.Close()
 
-		data, err = io.ReadAll(io.Reader(resp.Body))
-		if err != nil {
-			return fmt.Errorf("failed to read config file from %s", filePath)
+			data, err = io.ReadAll(io.Reader(resp.Body))
+			if err != nil {
+				return fmt.Errorf("failed to read config file from %s", filePath)
+			}
+		} else {
+			data, err = os.ReadFile(filePath.String())
+			if err != nil {
+				return errors.New("failed to read config file from " + filePath.String())
+			}
 		}
-	} else {
-		data, err = os.ReadFile(filePath.String())
-		if err != nil {
-			return errors.New("failed to read config file from " + filePath.String())
+
+		if fileExt == "json" {
+			return parseJSONConfig(data, config)
+		} else if fileExt == "yml" || fileExt == "yaml" {
+			return parseYAMLConfig(data, config)
 		}
 	}
 
-	return parseJSONConfig(data, config)
+	return fmt.Errorf("unsupported config file type (supported types: %v)", strings.Join(supportedFileTypes, ", "))
 }
 
 func parseJSONConfig(data []byte, config *Config) error {
@@ -58,3 +72,12 @@ func parseJSONConfig(data []byte, config *Config) error {
 
 	return nil
 }
+
+func parseYAMLConfig(data []byte, config *Config) error {
+	err := yaml.Unmarshal(data, &config)
+	if err != nil {
+		return fmt.Errorf("YAML Config file: %s", err.Error())
+	}
+
+	return nil
+}

go.mod

@@ -5,6 +5,7 @@ go 1.24.0
 require (
 	github.com/jedib0t/go-pretty/v6 v6.6.7
 	github.com/valyala/fasthttp v1.59.0
+	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (

go.sum

@@ -29,5 +29,7 @@ golang.org/x/term v0.29.0 h1:L6pJp37ocefwRRtYPKSWOWzOtWSxVajvz2ldH/xi3iU=
 golang.org/x/term v0.29.0/go.mod h1:6bl4lRlvVuDgSf3179VpIxBF0o10JUpXWOnI7nErv7s=
 golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM=
 golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=